doc/README
author Bryan O'Sullivan <bos@serpentine.com>
Sun, 14 Aug 2005 21:33:09 -0800
changeset 907 652507dc9fce
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Modify init command to take an optional directory to set up. If the directory does not exist, it is created. If no directory is given, the current directory is used.

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