doc/README
author Thomas Arendsen Hein <thomas@intevation.de>
Fri, 07 Jul 2006 11:23:53 +0200
changeset 2576 6a961a54f953
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Changed default timeout for run-tests.py from 30 to 180 seconds. As e.g. test-http-proxy already takes quite some time (about a minute here) and tests usually should clean up after themselves, the timeout should only be hit in case of other problems.

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