diff options
Diffstat (limited to 'docs-xml/README')
| -rw-r--r-- | docs-xml/README | 38 |
1 files changed, 12 insertions, 26 deletions
diff --git a/docs-xml/README b/docs-xml/README index 64095ebf39..3b61435000 100644 --- a/docs-xml/README +++ b/docs-xml/README @@ -13,7 +13,11 @@ Quick start Run: -make all +$ make all + +or to see what is possible: + +$ make help What are DocBook documents doing in the Samba Distribution ? ----------------------------------------------------------- @@ -29,6 +33,7 @@ done this. The format ---------- + If you are new to xml, regard an xml file as 'source code'. You don't read it directly, but use it to create other formats (like the txt and html included in ../txtdocs and ../htmldocs). @@ -54,26 +59,15 @@ To generate the docs, you need to have the following packages installed: * GNU Make * GNU autoconf - * docbook-utils * xsltproc - * pngtopnm and pnmtops (from the netpbm utilities) * inkscape -For generating PDF (thru LaTeX): - * db2latex (from http://db2latex.sf.net/). Make sure to get CVS version - 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 PDF and PostScript (thru LaTeX): + * dblatex (from http://dblatex.sf.net/) For generating PDF (thru FO): * fop (http://xml.apache.org/fop/) -For generating PostScript (thru LaTeX): - * db2latex - * latex - * dvips - For generating ASCII: * html2text @@ -90,23 +84,17 @@ For validating: This directory now contains a ./configure script and Makefile to support the automated building of man pages (including HTML versions), and the building of the Samba-HOWTO-Collection and the -Samba Developers Guide (HTML,DVI,TeX,PDF,PS,Text versions). +Samba Developers Guide (HTML,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/"/> - For the Pearson DTD, add something like: <public publicId="-//Pearson//DTD Books//DE" uri="file:///home/jelmer/Xml_dtd_1.1/pearson.dtd"/> @@ -114,12 +102,10 @@ For the Pearson DTD, add something like: For the Samba DTD's, add something like: <rewriteURI uriStartString="http://www.samba.org/samba/DTD" rewritePrefix="file:///home/jelmer/samba-web/DTD"/> -(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. Windows Help files ---------- + http://htmlhelp.berlios.de/howto/mshh4wine.php |