sapling/doc
2009-08-22 01:34:56 +02:00
..
ja change wiki/bts URLs to point to new hostname 2009-06-24 15:32:37 +02:00
gendoc.py gendoc: don't translate topic strings twice (issue1760) 2009-07-24 12:20:40 +02:00
hg.1.txt change wiki/bts URLs to point to new hostname 2009-06-24 15:32:37 +02:00
hgignore.5.txt hgignore.5: expanded description 2009-07-21 12:06:32 +02:00
hgrc.5.txt hgrc.5: document %include directive 2009-08-22 01:34:56 +02:00
Makefile doc: fix regexp for determining the man page section 2009-06-10 19:59:44 +02:00
README Update asciidoc instructions to suggest html4 for newer versions 2007-08-01 14:32:05 -07:00

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)