view doc/README @ 671:efa4a7e2f322

Move hgrc documentation out to its own man page, hgrc(5). # HG changeset patch # User Bryan O'Sullivan <bos@serpentine.com> # Node ID 5076cf1fd6a1b8eb410e5e03cb004ca6a52a30f9 # Parent 7369ec5d93f2ffd490a43970edd9adf8d2bbe269 Move hgrc documentation out to its own man page, hgrc(5). The new man page expands on the existing documentation by describing the file format and the purpose of each section and field.
author Bryan O'Sullivan <bos@serpentine.com>
date Sun, 10 Jul 2005 16:14:06 -0800
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