Product: Fedora
https://bugzilla.redhat.com/show_bug.cgi?id=890859
--- Comment #16 from Michael Schwendt <mschwendt(a)gmail.com> ---
There is just this, linked from the ReviewGuidelines page:
| SHOULD: your package should contain man pages for binaries/scripts.
| If it doesn't, work with upstream to add them where they make sense.
| [32]
It's a SHOULD, not a MUST, and the "where they make sense" is worth noting,
too. The guidelines are weak at trying to answer the _why_ or _when_:
| [32]
http://fedoraproject.org/wiki/Packaging/Guidelines#Man_pages
|
| Man pages are the traditional method of getting help on a unix system.
| Packages should contain man pages for all binaries/scripts. If it doesn't,
| work with upstream to add them. Sometimes, other distributions (notably
| Debian), have man pages for programs. You can use those as a starting point.
Does /usr/bin/scopy take any command-line options at all? Else the man page
might only mention few details, such as Author, Copyright/License and a brief
description of what the program does. Perhaps a pointer at the HTML
documentation and a hint that it is nothing like "scp". *grin* If
"better
than nothing" is the only goal, someone may call such a manual "helpful".
I
find it very unimportant. Sure, "man scopy" and "man 6 scopy" would
work then,
but if it were not available, that wouldn't be a big loss for a completely
optional game package.
IMO, a manual page for a game with a graphical user-interface, with
documentation in HTML, and with RPM package details (description, license, URL,
to name a few) doesn't make much sense.
Translating the Italian documentation into English could be a more useful
contribution to the Scopy project.
As with other work, a manual page requires somebody to create/contribute the
file(s) and keep them accurate during the life-time of the software/package.
--
You are receiving this mail because:
You are on the CC list for the bug.
Unsubscribe from this bug
https://bugzilla.redhat.com/token.cgi?t=NH4g9uRqen&a=cc_unsubscribe