doc/README
author Greg Ward <greg-hg@gerg.ca>
Mon, 15 Jun 2009 20:35:19 -0400
changeset 8819 e93ab347c814
parent 5048 8db8e1100f3f
child 9172 bc1de09090bc
permissions -rw-r--r--
test-convert-cvsnt-mergepoints: ignore differences between CVS 1.11 and 1.12. - factor out cvsci function (similar to other test-convert-cvs* scripts) - add filterpath function (also similar to other scripts) - generally munge the output of CVS - add lots of output to make it easier to follow when things go wrong This doesn't make the test pass reliably under CVS 1.11; it just makes it behave the same as under CVS 1.12, i.e. sometimes it passes and sometimes it fails. Failure is more frequent with faster hardware.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
     1
Mercurial's documentation is currently kept in ASCIIDOC format, which
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
     2
is a simple plain text format that's easy to read and edit. It's also
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
     3
convertible to a variety of other formats including standard UNIX man
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
     4
page format and HTML.
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     5
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
     6
To do this, you'll need to install ASCIIDOC:
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     7
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
     8
 http://www.methods.co.nz/asciidoc/
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     9
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
    10
To generate the man page:
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    11
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
    12
 asciidoc -d manpage -b docbook hg.1.txt
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
    13
 xmlto man hg.1.xml
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    14
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
    15
To display:
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    16
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
    17
 groff -mandoc -Tascii hg.1 | more
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    18
453
7a3a3952c431 Clarify doc/README a bit
mpm@selenic.com
parents: 182
diff changeset
    19
To create the html page (without stylesheets):
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    20
5048
8db8e1100f3f Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents: 453
diff changeset
    21
 asciidoc -b html4 hg.1.txt
8db8e1100f3f Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents: 453
diff changeset
    22
8db8e1100f3f Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents: 453
diff changeset
    23
(older asciidoc may want html instead of html4 above)