doc/README
author Matt Mackall <mpm@selenic.com>
Mon, 04 Jul 2005 12:54:42 -0800
changeset 619 d96c1153b25d
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
update tests -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 update tests manifest hash: 70079385599132ca8f90582e1f9317ca46167532 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCyaISywK+sNU5EO8RApnGAJ0blIxE0tKPzcRQUDAHCLe5KmUSNgCgjGoA kV4Os9FG1NmGaCysPIsKwts= =Ee67 -----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