view doc/README @ 453:7a3a3952c431

Clarify doc/README a bit -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Clarify doc/README a bit manifest hash: db94c24344b56655bea5123ff79db75c7fa2d44c -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCu2cHywK+sNU5EO8RAuh7AKCZu3ZyrLaCvwlUvc8yY49hNOr2FwCfeQ8w Rpnt3GiIZ5PN01SwFt0B5jE= =953M -----END PGP SIGNATURE-----
author mpm@selenic.com
date Thu, 23 Jun 2005 17:51:03 -0800
parents 089594a5bbde
children
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