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