equal
deleted
inserted
replaced
1 Files in this directory: |
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. |
2 |
5 |
3 README - this file |
6 To do this, you'll need to install ASCIIDOC: |
4 hg.1.txt - asciidoc source for the files |
|
5 hg.1 - groff man page for hg |
|
6 hg.1.html - man page in html format |
|
7 |
7 |
8 How to generate the man page and html files |
8 http://www.methods.co.nz/asciidoc/ |
9 |
9 |
10 For now we use asciidoc which is available at: |
10 To generate the man page: |
11 |
11 |
12 http://www.methods.co.nz/asciidoc/ |
12 asciidoc -d manpage -b docbook hg.1.txt |
|
13 xmlto man hg.1.xml |
13 |
14 |
14 the file hg.1.txt is the input file, to generate the man page: |
15 To display: |
15 |
16 |
16 asciidoc.py -d manpage -b docbook hg.1.txt |
17 groff -mandoc -Tascii hg.1 | more |
17 xmlto man hg.1.xml |
|
18 |
18 |
19 to display: |
19 To create the html page (without stylesheets): |
20 |
20 |
21 groff -mandoc -Tascii hg.1 | more |
21 asciidoc -b html hg.1.txt |
22 |
|
23 to create the html page (without stylesheets): |
|
24 |
|
25 asciidoc.py -b html hg.1.txt |
|