doc/README
author Benoit Boissinot <benoit.boissinot@ens-lyon.org>
Mon, 20 Feb 2006 19:04:56 +0100
changeset 1755 a8f7791e3680
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
add 'debugrebuildstate' to rebuild the dirstate from a given revision - added and removed files will be lost while recreating the dirstate - modifications are not lost

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