Re: Bug#39830: [AMENDMENT]: get rid of undocumented(7) symlinks
Manoj Srivastava <email@example.com> writes:
> + There should be a manual page at least for every program. If
> + no manual page is available, this is considered as a bug and
> + should be reported to the Debian Bug Tracking System (the
> + maintainer of the package is allowed to write this bug report
> + himself, too). Do not close the bug report until a proper
> + manpage is available.<footnote>
> + <p>
> + It is not very hard to write a man page. See the <url
> + id="http://www.schweikhardt.net/man_page_howto.html"
> + name="Man-Page-HOWTO">, <tt>man(7)</tt>, the examples
> + created by <tt>debmake</tt> or <tt>dh_make</tt>, or the
> + directory <file>/usr/share/doc/man-db/examples</file>.
> + </p>
> + </footnote>
> + </p>
Maybe mention help2man (if program understands --help and --version)
would be good too.
(I took a quick look at the bugreport, looks like noone said that
before. :) )
help2man is a good start for a manpage.
bye, Joerg Encrypted Mail preferred!
Registered Linux User #97793 @ http://counter.li.org