README
23 lines
| 585 B
| text/plain
|
TextLexer
/ doc / README
mpm@selenic.com
|
r453 | Mercurial's documentation is currently kept in ASCIIDOC format, which | ||
is a simple plain text format that's easy to read and edit. It's also | ||||
convertible to a variety of other formats including standard UNIX man | ||||
page format and HTML. | ||||
jake@edge2.net
|
r177 | |||
mpm@selenic.com
|
r453 | To do this, you'll need to install ASCIIDOC: | ||
jake@edge2.net
|
r177 | |||
mpm@selenic.com
|
r453 | http://www.methods.co.nz/asciidoc/ | ||
jake@edge2.net
|
r177 | |||
mpm@selenic.com
|
r453 | To generate the man page: | ||
jake@edge2.net
|
r177 | |||
mpm@selenic.com
|
r453 | asciidoc -d manpage -b docbook hg.1.txt | ||
xmlto man hg.1.xml | ||||
jake@edge2.net
|
r177 | |||
mpm@selenic.com
|
r453 | To display: | ||
jake@edge2.net
|
r177 | |||
mpm@selenic.com
|
r453 | groff -mandoc -Tascii hg.1 | more | ||
jake@edge2.net
|
r177 | |||
mpm@selenic.com
|
r453 | To create the html page (without stylesheets): | ||
jake@edge2.net
|
r177 | |||
Brendan Cully
|
r5048 | asciidoc -b html4 hg.1.txt | ||
(older asciidoc may want html instead of html4 above) | ||||