Mercurial > hg

view doc/README @ 465:f8cb8d082d40

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a doc makefile -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Add a doc makefile - From Vincent Danjean manifest hash: ef14a37f8bdee641148e705ba13ce386cf29316a -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCvQSmywK+sNU5EO8RAh/QAJoCDQVUKS8uYO5kcIqJBsrKYtj+FACgmSvI FnYSmWjUX5kLbDHdQqM6jls= =fPAM -----END PGP SIGNATURE-----
author mpm@selenic.com
date Fri, 24 Jun 2005 23:15:50 -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