view doc/README @ 470:0ab093b473c5

Fix up version module name and command conflict -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Fix up version module name and command conflict This unties the command name from the function name manifest hash: 926d097f75cbb5eb2464bb253e9a89050c6208bd -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCvRLnywK+sNU5EO8RAvryAJ9RU0PLFOXjjtQjs8UVyOC9wde69gCgrV+G 8jYfMyWwvwsmOM7wMblPGqM= =Acyk -----END PGP SIGNATURE-----
author mpm@selenic.com
date Sat, 25 Jun 2005 00:16:39 -0800
parents 7a3a3952c431
children 8db8e1100f3f
line wrap: on
line source

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