summaryrefslogtreecommitdiff
path: root/docs/docbook.txt
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2004-04-07 10:15:11 +0000
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:45:43 -0500
commit992f1e6b8f86b346fddd266b04d29cde69585633 (patch)
tree878573999a6831aa14cd6b8072263eb5d5910aa4 /docs/docbook.txt
parent65c0fd59203a3d9c4cb685e3a739f29f6f0c4fd6 (diff)
downloadsamba-992f1e6b8f86b346fddd266b04d29cde69585633.tar.gz
samba-992f1e6b8f86b346fddd266b04d29cde69585633.tar.bz2
samba-992f1e6b8f86b346fddd266b04d29cde69585633.zip
Add all the source files from the old CVS tree,
add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
Diffstat (limited to 'docs/docbook.txt')
-rw-r--r--docs/docbook.txt68
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/docbook.txt b/docs/docbook.txt
new file mode 100644
index 0000000000..e1e5881bd1
--- /dev/null
+++ b/docs/docbook.txt
@@ -0,0 +1,68 @@
+!==
+!== 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 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 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).
+
+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 V4.2 and is available on-line
+at http://www.docbook.org/
+
+The Output
+----------
+The current Samba CVS tree contains the XML/DocBook source files.
+
+A regularly generated version can be found at http://samba.org/samba/docs/.
+
+The Tools
+---------
+
+To generate the docs, you need to have the following packages installed:
+
+ * autoconf
+ * docbook-utils
+ * xsltproc
+ * pngtopnm and pnmtops (from the netpbm utilities)
+ * cvs2cl (for generating the changelog file for the HOWTO)
+
+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
+
+For generating PostScript (thru LaTeX):
+ * latex
+ * dvips
+
+For generating ASCII:
+ * xmlto
+
+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).