doc/README
author mpm@selenic.com
Tue, 28 Jun 2005 02:18:23 -0800
changeset 504 a350c1cd3fc5
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Use $USERNAME as a fallback for commit -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Use $USERNAME as a fallback for commit Suggested by Giuseppe Bilotta <bilotta78@hotpop.com> manifest hash: 3f86a63aebaf6c30eaa3a2081e1e5f9caa20caa1 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCwSPvywK+sNU5EO8RAqpYAKCmwfTfeNGCTqy2wuBs/bmtxMKt1ACeIpRo /vencPT6Z/WNXW+6p9NlZRY= =jFZ/ -----END PGP SIGNATURE-----

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