https://bugs.documentfoundation.org/show_bug.cgi?id=170716
Bug ID: 170716
Summary: At min add invariant text referring the reader of
libreoffice.1 manual page to the libreoffice --help
command line output
Product: LibreOffice
Version: unspecified
Hardware: All
OS: All
Status: UNCONFIRMED
Severity: normal
Priority: medium
Component: Documentation
Assignee: [email protected]
Reporter: [email protected]
CC: [email protected]
The problem: libreoffice --help output has more command line options than what
is documented at the libreoffice.1 manual page.
Summary 2: if incorporating all the information from the output of libreoffice
--help into the manual page libreoffice.1 and tracking that when the command
line options change is of low priority, do add invariant text to the manual
page, which states the output of libreoffice --help is likely more up to date,
and refers the reader of the manual page to look also at that output.
Explanation: The output of libreoffice --help is more up to date, and more
accurate, when compared to the content of libreoffice.1 manual page. For
example, the help text mentions the --cat option, where the manual does not.
Since usually the manual page is regarded more authoritative and comprehensive,
the manual page libreoffice.1 should, in my opinion, refer the reader to the
help text explicitly. For example, by adding a short explanation and a
reference to libreoffice --help command line at the SEE ALSO section. Or at a
new BUGS section. Or at the --help|-h|-? entry of the manual. That is, in case
updating the manual page of libreoffice.1 and tracking it is of low priority.
--
You are receiving this mail because:
You are the assignee for the bug.
