comparison doc/README @ 177:91055f795d88

adding doc directory and files
author jake@edge2.net
date Fri, 27 May 2005 07:16:58 -0700
parents
children b3bf5a0edd69
comparison
equal deleted inserted replaced
175:0eb6e2c9800d 177:91055f795d88
1 Files in this directory:
2
3 README - this file
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
8 How to generate the man page and html files
9
10 For now we use asciidoc which is available at:
11
12 http://www.methods.co.nz/asciidoc/
13
14 the file hg.1.txt is the input file, to generate the man page:
15
16 asciidoc.py -d manpage -b docbook hg.1.txt
17 xmlto man hg.1.xml
18
19 to display:
20
21 groff -mandoc -Tascii hg.1 | more
22
23 to create the html page (without stylesheets):
24
25 asciidoc.py -b html hg.1.txt