doc/README
author mpm@selenic.com
Mon, 27 Jun 2005 22:18:12 -0800
changeset 487 2ad41189bee5
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Add initial hook support -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Add initial hook support This adds the basic hook code as well as pre and post-commit hooks. Argument passing is by environment variable key/value pairs so that extra data can be passed over time. File lists will generally not be passed to hooks as these can be extremely long (>1M). manifest hash: 45cf9bab432782c391bc9c1c048c84cc75d52740 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCwOukywK+sNU5EO8RAsVsAJ9QipR2aKRSSvoRNo+3If6JddUDkwCgkZrM KEmZpUOxhNHqezFVrHDRTjE= =aedm -----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