doc/README
author Alexis S. L. Carvalho <alexis@cecm.usp.br>
Wed, 04 Apr 2007 04:22:06 -0300
changeset 4304 702f48570eb3
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
change relglob: patterns to be consistent with glob: patterns With this change, you have to use "hg locate 'hgweb/**'" to locate all the files in directories named hgweb. OTOH, "hg locate '*l'" will locate only files that end with "l" - e.g. a file called "hg.py" will not be matched just because it's in a directory whose name ends with "l" (e.g. "mercurial").

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 html hg.1.txt