Add manpage/DocBook section to doc/doc.txt.
authorW. Trevor King <wking@drexel.edu>
Wed, 29 Sep 2010 01:31:21 +0000 (21:31 -0400)
committerW. Trevor King <wking@drexel.edu>
Wed, 29 Sep 2010 01:31:21 +0000 (21:31 -0400)
doc/doc.txt

index e1b7a3a63bfe98d44b6e99879616667496f19b70..1b2b5aa10e1d840c521dbb78a2b26764a7d97b0f 100644 (file)
@@ -21,3 +21,24 @@ syntax.
   http://docutils.sourceforge.net/docs/user/rst/quickref.html
 .. _NumPy/SciPy documentation guide:
   http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
+
+Man page
+========
+
+The man-page source :file:`be.1.xml` is writen in DocBook 5 [#DB5]_
+format.  The :file:`Makefile` converts it to :manpage:`roff(7)` format
+using an XSLT stylesheet.  See DocBook XSL [#DBXSL]_ for details.
+See :doc:`install` for suggestions on setting up a DocBook 5 toolchain
+in several distributions.
+
+The man page should conform to `Debian policy`_.
+
+.. [#DB5]
+   See Norman Walsh's `DocBook 5: The Definitive Guide
+   <http://www.docbook.org/>`_
+
+.. [#DBXSL]
+   See Bob Stayton's `DocBook XSL: The Complete Guide
+   <http://www.sagehill.net/book-description.html>`_
+
+.. _Debian policy: http://www.debian.org/doc/debian-policy/ch-docs.html#s12.1