Mercurial > hg

view doc/README @ 9373:b34184c046ac

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
log: fix traceback for log -k caused by 1ef630452e0b (issue1805)
author Dirkjan Ochtman <dirkjan@ochtman.nl>
date Fri, 21 Aug 2009 09:33:27 +0200
parents bc1de09090bc
children a4b761751919
line wrap: on
line source

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:

  http://docutils.sourceforge.net/rst.html

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 the rst2html and rst2man tools,
which are part of Docutils:

  http://docutils.sourceforge.net/

The rst2man tool is still in their so-called "sandbox". The above page
has links to tarballs of both Docutils and their sandbox.

Use the Makefile in this directory to generate the man and HTML pages.