doc/README
author Bryan O'Sullivan <bos@serpentine.com>
Wed, 20 Jul 2005 03:23:12 -0800
changeset 733 1966c553f652
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Convert annotate over to walk interface. Add emptyok parameter to walk and matchpats, for commands that require at least one name.

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