doc/README
author mpm@selenic.com
Wed, 24 Aug 2005 00:32:10 -0700
changeset 1019 a9cca981c423
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Create helper functions for I/O to files in the working directory This simplifies some code and gives us a single place to add I/O filters.

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