view doc/README @ 5757:c5793dada959

Clarify some messages during commit: - use "branch 'foo'" to distinguish from "branch merge". - commit messags can be empty (to abort commits) - Added value for editor message: Tell about HG: lines like CVS does.
author Thomas Arendsen Hein <thomas@intevation.de>
date Fri, 28 Dec 2007 17:10:25 +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)