Show More
@@ -1,23 +1,17 | |||
|
1 |
Mercurial's documentation is |
|
|
2 |
|
|
|
3 | convertible to a variety of other formats including standard UNIX man | |
|
4 | page format and HTML. | |
|
1 | Mercurial's documentation is kept in reStructuredText format, which is | |
|
2 | a simple plain text format that's easy to read and edit: | |
|
5 | 3 | |
|
6 | To do this, you'll need to install ASCIIDOC: | |
|
4 | http://docutils.sourceforge.net/rst.html | |
|
7 | 5 | |
|
8 | http://www.methods.co.nz/asciidoc/ | |
|
9 | ||
|
10 | To generate the man page: | |
|
6 | It's also convertible to a variety of other formats including standard | |
|
7 | UNIX man page format and HTML. | |
|
11 | 8 | |
|
12 | asciidoc -d manpage -b docbook hg.1.txt | |
|
13 | xmlto man hg.1.xml | |
|
9 | To do this, you'll need to install the rst2html and rst2man tools, | |
|
10 | which are part of Docutils: | |
|
14 | 11 | |
|
15 | To display: | |
|
12 | http://docutils.sourceforge.net/ | |
|
16 | 13 | |
|
17 | groff -mandoc -Tascii hg.1 | more | |
|
18 | ||
|
19 | To create the html page (without stylesheets): | |
|
14 | The rst2man tool is still in their so-called "sandbox". The above page | |
|
15 | has links to tarballs of both Docutils and their sandbox. | |
|
20 | 16 | |
|
21 | asciidoc -b html4 hg.1.txt | |
|
22 | ||
|
23 | (older asciidoc may want html instead of html4 above) | |
|
17 | Use the Makefile in this directory to generate the man and HTML pages. |
General Comments 0
You need to be logged in to leave comments.
Login now