view doc/README @ 2330:b30aa02c85e7

add 'uisetup' function to extension module protocol. if uisetup functin exists in extension, is called before cmdtable examined. called with ui object as parameter. lets module modify cmdtable before commands.py sees it.
author Vadim Gelfer <vadim.gelfer@gmail.com>
date Sun, 21 May 2006 22:14:11 -0700
parents 7a3a3952c431
children
line wrap: on
line source

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