doc/README
author Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
Tue, 05 Jul 2005 18:23:34 -0800
changeset 631 a287f6cd9c6b
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Update documentation of hg tag # HG changeset patch # User Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl> # Node ID 8fc9bfabae06cba91b05c265545bcce2654dab2f # Parent 7369ec5d93f2ffd490a43970edd9adf8d2bbe269 Update documentation of hg tag This updates the FAQ, manpage and adds hg tag to the list of commands in README. Index: hg/README ===================================================================

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