view doc/README @ 614:6bff574d639f

Stop patch description import at diff -r -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Stop patch description import at diff -r manifest hash: cc269f69c26ad4fba1fdaeefe2dc8191a0669fe0 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCyZmyywK+sNU5EO8RAkODAJ9d/JYpBOZiOcQxlz0n2VtIPtK/IgCgl2Lj caGbq4yn4RxzBQqqIoQzOTQ= =9fHy -----END PGP SIGNATURE-----
author Matt Mackall <mpm@selenic.com>
date Mon, 04 Jul 2005 12:18:58 -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