diff options
| author | Jelmer Vernooij <jelmer@samba.org> | 2004-06-14 13:47:11 +0000 |
|---|---|---|
| committer | Gerald W. Carter <jerry@samba.org> | 2008-04-23 08:45:54 -0500 |
| commit | cce465adf3417b190e7a3886d44b5bf46cec3563 (patch) | |
| tree | e4416989fca6a8a5a042f690250f58d1ab84a3af /docs/README | |
| parent | 7a9277ae52e22dca5b4d56f33a33355799654c84 (diff) | |
| download | samba-cce465adf3417b190e7a3886d44b5bf46cec3563.tar.gz samba-cce465adf3417b190e7a3886d44b5bf46cec3563.tar.bz2 samba-cce465adf3417b190e7a3886d44b5bf46cec3563.zip | |
- Add notes about using catalogs (speeds up the docs build!)
- Support building FO and Windows Help files (see:
http://samba.org/~jelmer/samba-chm.png
http://samba.org/~jelmer/samba-chm1.png
http://samba.org/~jelmer/Samba-HOWTO-Collection.chm
)
(This used to be commit 8669bca66c7d6dcd588542f975aba395b3476e09)
Diffstat (limited to 'docs/README')
| -rw-r--r-- | docs/README | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/docs/README b/docs/README index 54a6d6ef8f..3aa1090388 100644 --- a/docs/README +++ b/docs/README @@ -44,7 +44,7 @@ at http://www.docbook.org/ The Output ---------- -The current Samba CVS tree contains the XML/DocBook source files. +The current Samba Subversion tree contains the XML/DocBook source files. A regularly generated version can be found at http://samba.org/samba/docs/. @@ -63,13 +63,14 @@ For generating PDF (thru LaTeX): dated 20030622 -- it works best. Versions previous to 20030425 are known to have problems, as well as current (as of 20031210) snapshots. * pdflatex + * thumbpdf For generating PostScript (thru LaTeX): * latex * dvips For generating ASCII: - * xmlto + * html2text This directory now contains a ./configure script and Makefile to support the automated building of man pages (including HTML versions), and @@ -78,3 +79,21 @@ Samba Developers Guide (HTML,DVI,TeX,PDF,PS,Text versions). The configure script detects which of the required utilities are installed and builds as much docs as it can using these tools. + +Help! Building the docs generates a lot of HTTP traffic... +------------- +To be able to build the docs without an internet connection (or faster with +a slow internet connection), you need to set up "catalogs". + +A catalog contains a list of mappings to locally cached documents. E.g. : +http://db2latex.sf.net/xsl/ -> /usr/share/sgml/docbook/db2latex/xsl/ + +Add the following two lines to /etc/xml/catalog for db2latex: +<rewriteURI uriStartString="http://db2latex.sourceforge.net/xsl/" rewritePrefix="/export/user/me/source/docbook/db2latex/xsl/"/> +<rewriteURI uriStartString="http://docbook.sourceforge.net/release/xsl/current/" rewritePrefix="/export/user/me/source/docbook/docbook-xsl/"/> + +(of course, adapt /export/user/me/source/ to whatever path db2latex is + installed in...) + +catalog entries for the other DTD's and XSL scripts should be present on your +system already. |