view doc/README @ 9091:79a886bcf461

ignore: separate pattern extraction from match compilation hgignore files have slightly different syntax from match objects, e.g. syntax: foo headers, regexp: forms, and re being relre. Put conversion from hgignore syntax into match syntax into a standalone function so that it is easier to validate hgignore hunks externally.
author Brendan Cully <brendan@kublai.com>
date Thu, 09 Jul 2009 15:14:42 -0700
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)