doc/README
author Giorgos Keramidas <keramida@ceid.upatras.gr>
Tue, 15 Aug 2006 20:59:55 +0300
changeset 2916 8ca608c1eb02
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
tests: new test for mq qdiff command `hg qdiff .' is supposed to work but it is currently broken. This test should help us verify when it gets fixed.

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