doc/README
author Thomas Arendsen Hein <thomas@intevation.de>
Sat, 09 Jun 2007 13:17:58 +0200
changeset 4532 c3a78a49d7f0
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Some small cleanups for convert extension: - repo doesn't need to be imported - util.Abort doesn't need \n - space after comma - long lines - spacing

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