view doc/README @ 5323:29be4228303b

verify: report first bad changeset - add linkrev and file arguments to err - track lowest reported linkrev in err - find linkrev in a couple cases - sort linkrevs when reporting a bunch of errors against a file - tidy up lots of messages - make more robust against damaged indexes - report first bad changeset if an error is encountered
author Matt Mackall <mpm@selenic.com>
date Fri, 21 Sep 2007 17:18:06 -0500
parents 8db8e1100f3f
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 html4 hg.1.txt

(older asciidoc may want html instead of html4 above)