Mercurial > hg > pyhgsh

comparison doc/README @ 453:7a3a3952c431

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clarify doc/README a bit -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Clarify doc/README a bit manifest hash: db94c24344b56655bea5123ff79db75c7fa2d44c -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCu2cHywK+sNU5EO8RAuh7AKCZu3ZyrLaCvwlUvc8yY49hNOr2FwCfeQ8w Rpnt3GiIZ5PN01SwFt0B5jE= =953M -----END PGP SIGNATURE-----
author mpm@selenic.com
date Thu, 23 Jun 2005 17:51:03 -0800
parents 089594a5bbde
children
comparison
equal deleted inserted replaced
452:a1e91c24dab5 453:7a3a3952c431
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