Mercurial > hg

view doc/README @ 9406:a4b761751919

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/README: rst2man is now in Docutils proper
author Martin Geisler <mg@lazybytes.net>
date Fri, 28 Aug 2009 20:28:06 +0200
parents bc1de09090bc
children 3516a4e877c1
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 not yet in a stable Docutils release, you have to
install their snapshot, which is what they recommend you run anyway:

  http://docutils.sourceforge.net/docutils-snapshot.tgz

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