doc/README
author Edouard Gomez <ed.gomez@free.fr>
Thu, 01 Sep 2005 07:41:32 -0700
changeset 1185 2ae9c319e6fe
parent 453 7a3a3952c431
child 5048 8db8e1100f3f
permissions -rw-r--r--
Output Content-encoding for tar.gz and tar.bz2 snapshots If the HTTP header 'Content-encoding' is missing for tar.gz snapshots, some gzip capable proxies can bork the tarball and serve unusable files to users. GZ tarballs are served using Content-encoding: gzip. BZ2 tarballs are served using Content-encoding: x-bzip2.

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