| author | Dirkjan Ochtman <dirkjan@ochtman.nl> |
| Mon, 21 Jul 2008 13:22:11 +0200 | |
| changeset 6845 | 835a01a0cdb3 |
| parent 5048 | 8db8e1100f3f |
| child 9172 | bc1de09090bc |
| permissions | -rw-r--r-- |
| 453 | 1 |
Mercurial's documentation is currently kept in ASCIIDOC format, which |
2 |
is a simple plain text format that's easy to read and edit. It's also |
|
3 |
convertible to a variety of other formats including standard UNIX man |
|
4 |
page format and HTML. |
|
| 177 | 5 |
|
| 453 | 6 |
To do this, you'll need to install ASCIIDOC: |
| 177 | 7 |
|
| 453 | 8 |
http://www.methods.co.nz/asciidoc/ |
| 177 | 9 |
|
| 453 | 10 |
To generate the man page: |
| 177 | 11 |
|
| 453 | 12 |
asciidoc -d manpage -b docbook hg.1.txt |
13 |
xmlto man hg.1.xml |
|
| 177 | 14 |
|
| 453 | 15 |
To display: |
| 177 | 16 |
|
| 453 | 17 |
groff -mandoc -Tascii hg.1 | more |
| 177 | 18 |
|
| 453 | 19 |
To create the html page (without stylesheets): |
| 177 | 20 |
|
|
5048
8db8e1100f3f
Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents:
453
diff
changeset
|
21 |
asciidoc -b html4 hg.1.txt |
|
8db8e1100f3f
Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents:
453
diff
changeset
|
22 |
|
|
8db8e1100f3f
Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents:
453
diff
changeset
|
23 |
(older asciidoc may want html instead of html4 above) |