doc/README
author mpm@selenic.com
Fri, 01 Jul 2005 08:54:52 -0800
changeset 557 b9fee419a1bd
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
recover: the journal is named 'journal' -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 recover: the journal is named 'journal' spotted by K Thananchayan <thananck@yahoo.com> manifest hash: a2ecfedb3d58011cdf5ef7741ff61aba15aa5885 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCxXVbywK+sNU5EO8RAmiBAKCgULQVAZ42xuPRyzb3Rrk794LtaACgoLdF TNtgK/MqF6+EjWNJ5mm2geE= =m5U3 -----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