doc/README
author Sean Dague <sean@dague.net>
Tue, 30 Jan 2007 10:35:25 -0500
changeset 4077 1305ba7dee88
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Prevent type exception on concatenation if diffstat returns None. This will most often occur if diffstat is not installed in the target platform, though may also happen in other cases where diffstat fails to execute. Signed-off-by: Sean Dague <sean@dague.net>

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