doc/README
author mpm@selenic.com
Thu, 22 Sep 2005 09:47:03 -0700
changeset 1314 d37a46859acd
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Fix default clone destination The default clone wasn't working: $ hg clone hg abort: repository hg/.hg not found! This was because we were creating the destination directory from the default, then checking whether it existed to determine whether to expand the path.

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