Mercurial > hg
changeset 453:7a3a3952c431
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 | a1e91c24dab5 |
| children | 58d57594b802 |
| files | doc/README |
| diffstat | 1 files changed, 13 insertions(+), 17 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/README Thu Jun 23 17:43:04 2005 -0800 +++ b/doc/README Thu Jun 23 17:51:03 2005 -0800 @@ -1,25 +1,21 @@ -Files in this directory: +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. -README - this file -hg.1.txt - asciidoc source for the files -hg.1 - groff man page for hg -hg.1.html - man page in html format +To do this, you'll need to install ASCIIDOC: -How to generate the man page and html files + http://www.methods.co.nz/asciidoc/ -For now we use asciidoc which is available at: - -http://www.methods.co.nz/asciidoc/ +To generate the man page: -the file hg.1.txt is the input file, to generate the man page: + asciidoc -d manpage -b docbook hg.1.txt + xmlto man hg.1.xml -asciidoc.py -d manpage -b docbook hg.1.txt -xmlto man hg.1.xml +To display: -to display: - -groff -mandoc -Tascii hg.1 | more + groff -mandoc -Tascii hg.1 | more -to create the html page (without stylesheets): +To create the html page (without stylesheets): -asciidoc.py -b html hg.1.txt + asciidoc -b html hg.1.txt