X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=best-pkging-practices.dbk;fp=best-pkging-practices.dbk;h=77ae40dc68a8995ff8831bb8b57a6c7ab37526c4;hb=af43b0c1cfb4cf5b37332212429aef34e914d2db;hp=1800e063165ff10b88f6b347fec337e6593d3c92;hpb=f81208222903239b23f392916c1fe194d395cddd;p=developers-reference.git diff --git a/best-pkging-practices.dbk b/best-pkging-practices.dbk index 1800e06..77ae40d 100644 --- a/best-pkging-practices.dbk +++ b/best-pkging-practices.dbk @@ -1484,6 +1484,20 @@ role="package">doc-base on installation. See the doc-base package documentation for more information. + +Debian policy (section 12.1) directs that manual pages should accompany every +program, utility, and function, and suggests them for other objects like +configuration files. If the work you are packaging does not have such manual +pages, consider writing them for inclusion in your package, and submitting them +upstream. + + +The manpages do not need to be written directly in the troff format. Popular +source formats are Docbook, POD and reST, which can be converted using +xsltproc, pod2man and +rst2man respectively. To a lesser extent, the +help2manprogram can also be used to write a stub. +