summaryrefslogtreecommitdiff
path: root/docs/docbook/docbook.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docbook/docbook.txt')
-rw-r--r--docs/docbook/docbook.txt64
1 files changed, 33 insertions, 31 deletions
diff --git a/docs/docbook/docbook.txt b/docs/docbook/docbook.txt
index 1d2f5ffbdf..dfce2fd61b 100644
--- a/docs/docbook/docbook.txt
+++ b/docs/docbook/docbook.txt
@@ -1,72 +1,74 @@
!==
-!== docbook.txt for Samba HEAD
+!== docbook.txt for Samba 3.0
!==
!== Author: David Bannon, D.Bannon@latrobe.edu.au November, 2000
!== Updates: Gerald (Jerry) Carter, jerry@samba.org, Feb. 2001
!== Updates: Jelmer Vernooij, jelmer@samba.org, Aug, 2002
+!== Updates: Jelmer Vernooij, jelmer@samba.org, Jun, 2003
What are DocBook documents doing in the Samba Distribution ?
-----------------------------------------------------------
-We are planning to convert all of the samba docs to SGML/DocBook V4.1
+We have converted all samba docs to XML/DocBook V4.2
in order to make them easier to maintain and produce a nicer looking
product.
This short note (strange isn't it how it always starts out as a short note
-and becomes a long one ?) will explain very briefly how and why we are
-doing this.
+and becomes a long one ?) will explain very briefly how and why we have
+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).
-If you are new to sgml, regard an sgml file as 'source code'. You don't
-read it directly, use it to create other formats (like the txt and html
-included in ../txt and ../html).
-
-Docbook is a particular SGML style, particularly suited to producing
-technical manuals. In the two documents I have produced so far I have used
-DocBook 4.1, it seems that products like RedHat Linux is still include only
-version 3.1, the differences are minor. The Linux Documentation Project is
-using a modified version of 3.1 but are really geared up to make multi
-paged documents, something we want to avoid for logistic reasons.
+Docbook is a particular XML style, particularly suited to producing
+technical manuals.
For more information on DocBook tags and format, see "DocBook: The
Definitive Guide" by Walsh and Muellner, (c) O'Reilly Publishing.
-This book covers DocBook V3.1 and is available on-line
+This book covers DocBook V4.2 and is available on-line
at http://www.docbook.org/
The Output
----------
-
-The current Samba CVS tree contains the SGML/DocBook source files as well
+The current Samba CVS tree contains the XML/DocBook source files as well
as the following autogenerated formats:
* man pages
* HTML
- * ASCII text (where appropriate)
* PDF
+The following formats are not available in CVS but can be generated by
+the build scripts:
+
+ * PostScript
+ * DVI
+ * LaTeX
+ * ASCII text
The Tools
---------
To generate the docs, you need to have the following packages installed:
-* docbook-utils
-* pdflatex
+ * docbook-utils
+ * xsltproc
+ * pngtopnm and pnmtops (from the netpbm utilities)
-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 (HTML,PDF versions).
+For generating PDF (thru LaTeX):
+ * pdflatex
-In order to be able to build some other (more rarely used) formats, you need:
+For generating PostScript (thru LaTeX):
+ * latex
+ * dvips
-- PostScript:
- * LaTeX
- * dvips
-- Text
- * xmlto
+For generating ASCII:
+ * xmlto
-Another good tool is 'xmllint' that can be used to check the syntax of
-XML files.
+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).