mirror of
https://github.com/facebook/sapling.git
synced 2024-10-08 07:49:11 +03:00
25c277802b
The man page used to have lines longer than 80 characters, even though all lines in the hgrc.5.txt file were wrapped nicely. The problem turned out to be that the indented paragraphs started literal blocks instead of normal paragraphs. The literal blocks were of course not wrapped when displayed by man. In short, the asciidoc rules require lists to be formatted like this: foo:: Some description of foo. + Another paragraph in the description of foo. It *must* start flush left and the plus is necessary to indicate that this is a list item continuation. Lists with nested lists can be formatted correctly using something called "open blocks". These blocks are used to group the list items and are marked by a line above and below with two dashes. See the asciidoc user guide for the gory details... |
||
|---|---|---|
| .. | ||
| ja | ||
| gendoc.py | ||
| hg.1.txt | ||
| hgignore.5.txt | ||
| hgrc.5.txt | ||
| Makefile | ||
| README | ||
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. To do this, you'll need to install ASCIIDOC: http://www.methods.co.nz/asciidoc/ To generate the man page: asciidoc -d manpage -b docbook hg.1.txt xmlto man hg.1.xml To display: groff -mandoc -Tascii hg.1 | more To create the html page (without stylesheets): asciidoc -b html4 hg.1.txt (older asciidoc may want html instead of html4 above)