annotate doc/README @ 396:62cb50c50976

Cosmetic updates to documentation; added warning pseudo op
author lost@l-w.ca
date Fri, 23 Jul 2010 17:08:57 -0600
parents ebff3a3e8fa6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
331
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
1 If there are no html files in the "manual" directory and there is no
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
2 "manual.html" file, it means that you have either checked out the source
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
3 repository on a non-release branch or the packager messed up.
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
4
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
5 In either case, if you have "docbook2html" installed, you should be able
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
6 to build the manual with one of the following:
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
7
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
8 docbook2html -o manual manual.docbook.sgml
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
9
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
10 or
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
11
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
12 docbook2html -u manual.docbook.sgml && mv manual.docbook.html manual/manual.html
ed3553296580 Port manual forward with corrections from Jason Law
lost
parents:
diff changeset
13
333
ebff3a3e8fa6 Updated internals to describe the multi-pass architecture
lost
parents: 331
diff changeset
14 PDF can be generated by doing:
ebff3a3e8fa6 Updated internals to describe the multi-pass architecture
lost
parents: 331
diff changeset
15
ebff3a3e8fa6 Updated internals to describe the multi-pass architecture
lost
parents: 331
diff changeset
16 docbook2pdf -u manual.docbook.sgml && mv manual.docbook.pdf manual/manual.pdf