Rename docbook.txt to README to give it some more attention.

(This used to be commit 10f6f81724be2cdcc61d63bbf8fff2b45af31d6f)

1 files changed, 80 insertions, 0 deletions

diff --git a/docs/README b/docs/README
new file mode 100644
index 0000000000..54a6d6ef8f
--- /dev/null
+++ b/docs/README
@@ -0,0 +1,80 @@
+!==
+!== 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
+!== Updates: 	Jelmer Vernooij, jelmer@samba.org,		May, 2004
+
+Quick start
+-----------
+
+Run:
+
+autoreconf
+./configure
+make all
+
+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)
+
+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).
+
+The configure script detects which of the required utilities are installed 
+and builds as much docs as it can using these tools.