doc/README
author mpm@selenic.com
Tue, 21 Jun 2005 21:04:49 -0800
changeset 429 688d03d6997a
parent 182 089594a5bbde
child 453 7a3a3952c431
permissions -rw-r--r--
Pull from TAH -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Pull from TAH manifest hash: 600d04efbd836d555d11a3bd9d821d1d8c0a9790 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCuPFxywK+sNU5EO8RAjfzAKC18Zc2EOkXhy1zcpgGnyPHnFMdmgCfW5Ut I5HSWqZMt8H0WJx1Or7ajNc= =27D5 -----END PGP SIGNATURE-----
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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