[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Writing manpages

Le Thu, Nov 19, 2009 at 11:14:10AM +1100, Ben Finney a écrit :
> Now if only we can convince more package maintainers. Hopefully the
> ability to use these source formats, with steady evangelisation about
> the available rendering tools, can lower the resistance to following
> policy on providing manpages for all commands.

Dear all,

how about the followign patch to the developers's reference ?
(In § 6.7.3)

Index: best-pkging-practices.dbk
--- best-pkging-practices.dbk	(revision 6986)
+++ best-pkging-practices.dbk	(working copy)
@@ -1484,6 +1484,14 @@
 role="package">doc-base</systemitem> package documentation for more
+If the program you are packaging does not have a manpage, consider writing one
+and submiting it upstream. The manpage does not need to be written directly in
+the troff format. Popular intermediate formats are Docbook, POD and reST, which
+can be converted using <command>xsltproc</command>, <command>pod2man</command>
+and <command>rst2man</command> respectively. To a lesser extent, the <command>
+help2man</command>program can also be used to write a stub.
 <section id="bpp-other">

Have a nice day,

Charles Plessy
Tsurumi, Kanagawa, Japan

Reply to: