doc/README
author Peter Meerwald <pmeerw@pmeerw.net>
Fri, 17 Aug 2007 22:43:38 -0300
changeset 5193 942c0827dc5b
parent 5048 8db8e1100f3f
permissions -rw-r--r--
recognize user:password in URLs that include port numbers. when giving user/pwd in an URL, eg. hg pull http://user:pwd@host.com:666/hg/something, hg would still ask for user/pwd in interactive mode (or fail in non-interactive)

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)