doc/README
author mpm@selenic.com
Tue, 28 Jun 2005 00:46:16 -0800
changeset 498 8cf3999b3d03
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Various doc clean-ups and spelling fixes -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Various doc clean-ups and spelling fixes manifest hash: 4115506709314aabfb4a66973ef2bc8f22f2225b -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCwQ5YywK+sNU5EO8RAkAlAJoCsXCgEQ1lmS58aSrUyPf+KIK99gCeLY/v Tg9JhygJjwsu5xocc9Nh04Y= =JTG4 -----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