facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-07 07:17:55 +03:00
Code Issues Projects Releases Wiki Activity
63d0e7a57c
sapling/doc
History
Thomas Arendsen Hein d465810792 make clean now removes generated documentation.
2006-03-10 20:06:41 +01:00
..
ja Fixed to convert to man properly. 2005-11-03 11:56:51 +09:00
gendoc.py generate hg manpage from commands.py docstring 2006-02-28 00:48:49 +01:00
hg.1.txt generate hg manpage from commands.py docstring 2006-02-28 00:48:49 +01:00
hgmerge.1.txt Fix copyright symbol in docs 2005-09-23 18:59:16 -07:00
hgrc.5.txt change the default timeout to 600 seconds 2006-02-21 23:50:53 +01:00
Makefile make clean now removes generated documentation. 2006-03-10 20:06:41 +01:00
README Clarify doc/README a bit 2005-06-23 17:51:03 -08:00

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 html hg.1.txt