Mercurial > hg > mercurial-crew-with-dirclash
annotate doc/README @ 2926:13cd2cdeff6a
hgext: more patchbomb documentation
+ Add a description of how to enable this extension
+ Note which command it provides (it's not very easy to guess
that "hgext.patchbomb" enables the "email" command, unless one
can read Python sources)
+ Expand the descriptions of the -n and -m options of "hg email".
+ Mention that formail is (commonly) part of the procmail package.
author | Giorgos Keramidas <keramida@ceid.upatras.gr> |
---|---|
date | Tue, 15 Aug 2006 23:37:37 +0300 |
parents | 7a3a3952c431 |
children | 8db8e1100f3f |
rev | line source |
---|---|
453 | 1 Mercurial's documentation is currently kept in ASCIIDOC format, which |
2 is a simple plain text format that's easy to read and edit. It's also | |
3 convertible to a variety of other formats including standard UNIX man | |
4 page format and HTML. | |
177 | 5 |
453 | 6 To do this, you'll need to install ASCIIDOC: |
177 | 7 |
453 | 8 http://www.methods.co.nz/asciidoc/ |
177 | 9 |
453 | 10 To generate the man page: |
177 | 11 |
453 | 12 asciidoc -d manpage -b docbook hg.1.txt |
13 xmlto man hg.1.xml | |
177 | 14 |
453 | 15 To display: |
177 | 16 |
453 | 17 groff -mandoc -Tascii hg.1 | more |
177 | 18 |
453 | 19 To create the html page (without stylesheets): |
177 | 20 |
453 | 21 asciidoc -b html hg.1.txt |