doc/README
author Cédric Duval <cedricduval@free.fr>
Sat, 30 May 2009 19:18:29 +0200
changeset 8653 aa011d123f71
parent 5048 8db8e1100f3f
child 9172 bc1de09090bc
permissions -rw-r--r--
mq: initializing patchheader class directly from patch content The patch header needs only be read in order to instantiate the class, and as such it makes more sense to do it within the class.

Mercurial's documentation is currently kept in ASCIIDOC format, which
is a simple plain text format that's easy to read and edit. It's also
convertible to a variety of other formats including standard UNIX man
page format and HTML.

To do this, you'll need to install ASCIIDOC:

 http://www.methods.co.nz/asciidoc/

To generate the man page:

 asciidoc -d manpage -b docbook hg.1.txt
 xmlto man hg.1.xml

To display:

 groff -mandoc -Tascii hg.1 | more

To create the html page (without stylesheets):

 asciidoc -b html4 hg.1.txt

(older asciidoc may want html instead of html4 above)