doc/README
author Matt Mackall <mpm@selenic.com>
Mon, 02 Mar 2009 19:19:12 -0600
changeset 7815 bcd364b247ba
parent 5048 8db8e1100f3f
child 9172 bc1de09090bc
permissions -rw-r--r--
convert: change hg.saverev default to False This needlessly breaks changeset identifiers for the common case (cleaning history), which is sad.

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)