diff options
| author | W. Trevor King <wking@drexel.edu> | 2010-09-28 21:31:21 -0400 |
|---|---|---|
| committer | W. Trevor King <wking@drexel.edu> | 2010-09-28 21:31:21 -0400 |
| commit | 0a993be001ab5ff250fae4c5f20bab11f89e30cb (patch) | |
| tree | c9ce0b30672d653f46d0a2c269c468e8cffb9a97 | |
| parent | c293f2eaed1d3ebccd3e474c77557d2624e2ccc9 (diff) | |
| download | bugseverywhere-0a993be001ab5ff250fae4c5f20bab11f89e30cb.tar.gz | |
Add manpage/DocBook section to doc/doc.txt.
| -rw-r--r-- | doc/doc.txt | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/doc.txt b/doc/doc.txt index e1b7a3a..1b2b5aa 100644 --- a/doc/doc.txt +++ b/doc/doc.txt @@ -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 |