upstream/mercurial-mirror Commit - r5048:8db8e110

1

Mercurial's documentation is currently kept in ASCIIDOC format, which

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

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

3

convertible to a variety of other formats including standard UNIX man

4

page format and HTML.

4

page format and HTML.

5

6

To do this, you'll need to install ASCIIDOC:

6

To do this, you'll need to install ASCIIDOC:

7

8

http://www.methods.co.nz/asciidoc/

8

http://www.methods.co.nz/asciidoc/

9

10

To generate the man page:

10

To generate the man page:

11

12

asciidoc -d manpage -b docbook hg.1.txt

12

asciidoc -d manpage -b docbook hg.1.txt

13

xmlto man hg.1.xml

13

xmlto man hg.1.xml

14

15

To display:

15

To display:

16

17

groff -mandoc -Tascii hg.1 | more

17

groff -mandoc -Tascii hg.1 | more

18

19

To create the html page (without stylesheets):

19

To create the html page (without stylesheets):

20

21

asciidoc -b html hg.1.txt

21

asciidoc -b html4 hg.1.txt

22

23

(older asciidoc may want html instead of html4 above)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             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
+             asciidoc -b html4 hg.1.txt
+            (older asciidoc may want html instead of html4 above)