doc/README
author Edward Lee <edward.lee@engineering.uiuc.edu>
Fri, 07 Sep 2007 16:35:43 +0200
changeset 5288 18091102a633
parent 5048 8db8e1100f3f
permissions -rw-r--r--
interhg: allow more flexible pattern specification (fixes 2/3 of issue699) - something else than "pat" followed by a number can be used as key - something else than "/" can be used as delimiter - "ilmsux" flags (e.g. "i" for case insensitive) can be 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 html4 hg.1.txt

(older asciidoc may want html instead of html4 above)