doc/README
author Dirkjan Ochtman <dirkjan@ochtman.nl>
Mon, 03 Nov 2008 20:05:03 +0100
changeset 7309 e74a9173c2d7
parent 5048 8db8e1100f3f
child 9172 bc1de09090bc
permissions -rw-r--r--
hgweb: use patch.diff() to make sensible diffs (issue1223, issue1258) This gets us git diffs when enabled and doesn't pick erratic file parents.

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)