annotate doc/README @ 205:d255d99a7cbd

README: integrate some changes from Kevin Smith -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 README: integrate some changes from Kevin Smith manifest hash: 7e3ca4be07fe9df4348d21b42771696a357c23d8 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCnVhfywK+sNU5EO8RAtXvAJ4oclpYQm98YArUDbs7ZUfQspQpcACZAXf2 pMG7GKkquua+fS76uxpcCgs= =yPbJ -----END PGP SIGNATURE-----
author mpm@selenic.com
date Tue, 31 May 2005 22:40:31 -0800
parents 089594a5bbde
children 7a3a3952c431
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
1 Files in this directory:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
2
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
3 README - this file
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
4 hg.1.txt - asciidoc source for the files
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
5 hg.1 - groff man page for hg
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
6 hg.1.html - man page in html format
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
7
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
8 How to generate the man page and html files
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
9
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
10 For now we use asciidoc which is available at:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
11
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
12 http://www.methods.co.nz/asciidoc/
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
13
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
14 the file hg.1.txt is the input file, to generate the man page:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
15
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
16 asciidoc.py -d manpage -b docbook hg.1.txt
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
17 xmlto man hg.1.xml
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
18
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
19 to display:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
20
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
21 groff -mandoc -Tascii hg.1 | more
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
22
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
23 to create the html page (without stylesheets):
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
24
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
25 asciidoc.py -b html hg.1.txt