view doc/README @ 709:cc2e8f3d4412

Fix synopsis: hg forget needs at least one file name. -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Fix synopsis: hg forget needs at least one file name. manifest hash: 1386189a11f9bc539ae2c4bf93333235931d8bc6 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.1 (GNU/Linux) iD8DBQFC14i7W7P1GVgWeRoRAj3OAKCBPkYzoxOHu0Xp/vZ6Myz6JGM4hACgimU+ Gw1Av4ESM2ivORd8ulHMdBc= =kDiv -----END PGP SIGNATURE-----
author Thomas Arendsen Hein <thomas@intevation.de>
date Fri, 15 Jul 2005 10:58:19 +0100
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