view doc/README @ 7769:8c06d4bf2c23

test-merge-tools: Don't use tac "tac" was a bad tool - is not available on all platforms. The test now only uses the "tools" true, false, head, echo, cat and /bin/cat
author Mads Kiilerich <mads@kiilerich.com>
date Tue, 10 Feb 2009 16:11:48 +0100
parents 8db8e1100f3f
children bc1de09090bc
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)