doc/README
author Alexis S. L. Carvalho <alexis@cecm.usp.br>
Thu, 12 Oct 2006 14:04:11 -0300
changeset 3369 4bad632913d8
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
python2.5 PyArg_ParseTuple fix Python 2.5 doesn't like it when we mix str objects and the "t#" format in PyArg_ParseTuple. Change it to use "s#". Tested with python 2.3, 2.4 and 2.5.

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 html hg.1.txt