docs/README

   1 !==
   2 !== docbook.txt for Samba 3.0
   3 !==
   4 !== Author:     David Bannon, D.Bannon@latrobe.edu.au  November, 2000
   5 !== Updates:    Gerald (Jerry) Carter, jerry@samba.org, Feb. 2001
   6 !== Updates:    Jelmer Vernooij, jelmer@samba.org,              Aug, 2002
   7 !== Updates:    Jelmer Vernooij, jelmer@samba.org,              Jun, 2003
   8 !== Updates:    Jelmer Vernooij, jelmer@samba.org,              May, 2004
   9
  10 Quick start
  11 -----------
  12
  13 Run:
  14
  15 autoreconf
  16 ./configure
  17 make all
  18
  19 What are DocBook documents doing in the Samba Distribution ?
  20 -----------------------------------------------------------
  21
  22 We have converted all samba docs to XML/DocBook V4.2
  23 in order to make them easier to maintain and produce a nicer looking
  24 product.
  25
  26 This short note (strange isn't it how it always starts out as a short note
  27 and becomes a long one ?) will explain very briefly how and why we have
  28 done this.
  29
  30
  31 The format
  32 ----------
  33 If you are new to xml, regard an xml file as 'source code'. You don't
  34 read it directly, but use it to create other formats (like the txt and html
  35 included in ../txtdocs and ../htmldocs).
  36
  37 Docbook is a particular XML style, particularly suited to producing
  38 technical manuals.
  39
  40 For more information on DocBook tags and format, see "DocBook: The
  41 Definitive Guide" by Walsh and Muellner, (c) O'Reilly Publishing.
  42 This book covers DocBook V4.2 and is available on-line
  43 at http://www.docbook.org/
  44
  45 The Output
  46 ----------
  47 The current Samba Subversion tree contains the XML/DocBook source files.
  48
  49 A regularly generated version can be found at http://samba.org/samba/docs/.
  50
  51 The Tools
  52 ---------
  53
  54 To generate the docs, you need to have the following packages installed:
  55
  56  * autoconf
  57  * docbook-utils
  58  * xsltproc
  59  * pngtopnm and pnmtops (from the netpbm utilities)
  60
  61 For generating PDF (thru LaTeX):
  62  * db2latex (from http://db2latex.sf.net/). Make sure to get CVS version
  63    dated 20030622 -- it works best. Versions previous to 20030425 are known
  64    to have problems, as well as current (as of 20031210) snapshots.
  65  * pdflatex
  66  * thumbpdf
  67
  68 For generating PostScript (thru LaTeX):
  69  * latex
  70  * dvips
  71
  72 For generating ASCII:
  73  * html2text
  74
  75 This directory now contains a ./configure script and Makefile to
  76 support the automated building of man pages (including HTML versions), and
  77 the building of the Samba-HOWTO-Collection and the
  78 Samba Developers Guide (HTML,DVI,TeX,PDF,PS,Text versions).
  79
  80 The configure script detects which of the required utilities are installed
  81 and builds as much docs as it can using these tools.
  82
  83 Help! Building the docs generates a lot of HTTP traffic...
  84 -------------
  85 To be able to build the docs without an internet connection (or faster with
  86 a slow internet connection), you need to set up "catalogs".
  87
  88 A catalog contains a list of mappings to locally cached documents. E.g. :
  89 http://db2latex.sf.net/xsl/ -> /usr/share/sgml/docbook/db2latex/xsl/
  90
  91 Add the following two lines to /etc/xml/catalog for db2latex:
  92 <rewriteURI uriStartString="http://db2latex.sourceforge.net/xsl/" rewritePrefix="/export/user/me/source/docbook/db2latex/xsl/"/>
  93 <rewriteURI uriStartString="http://docbook.sourceforge.net/release/xsl/current/" rewritePrefix="/export/user/me/source/docbook/docbook-xsl/"/>
  94
  95 For the Pearson DTD, add something like:
  96
  97   <public publicId="-//Pearson//DTD Books//DE" uri="file:///home/jelmer/Xml_dtd_1.1/pearson.dtd"/>
  98
  99 (of course, adapt /export/user/me/source/ to whatever path db2latex is
 100  installed in...)
 101
 102 catalog entries for the other DTD's and XSL scripts should be present on your
 103 system already.
 104
 105 Windows Help files
 106 ----------
 107 http://htmlhelp.berlios.de/howto/mshh4wine.php