1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-24 21:34:56 +03:00
samba-mirror/docs-xml
Garming Sam 5e18edeadd docs: include the type attribute for getwd cache
Signed-off-by: Garming Sam <garming@catalyst.net.nz>
Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Alexander Bokovoy <ab@samba.org>
2014-01-28 17:26:39 +13:00
..
archives
build docs: better document -e|--encrypt option globally. 2013-11-19 09:52:42 +01:00
manpages pam_winbind: Do not honour require_membership_of in the acct module parameters 2014-01-14 23:44:26 +01:00
registry
Samba3-ByExample doc: Remove documentation for obsolete ldapsam_compat. 2012-07-03 21:56:49 +02:00
Samba3-Developers-Guide docs: Do not encourage unix passwords, and remove reference to password level 2013-06-11 08:35:32 -04:00
Samba3-HOWTO Remove remaining references to "password level" in the tree 2013-06-11 16:25:54 +02:00
scripts tests: Convert find_missing_doc into a unit test. 2012-10-19 09:10:13 +02:00
smbdotconf docs: include the type attribute for getwd cache 2014-01-28 17:26:39 +13:00
templates
test
using_samba Remove remaining references to "password level" in the tree 2013-06-11 16:25:54 +02:00
xslt Revert "Remove XSLT script to generate image dependencies, instead rely on make" 2012-07-16 16:18:46 +02:00
.gitignore docs-xml/.gitignore: manpages-3 has been moved to manpages. 2013-05-30 10:57:39 +10:00
aclocal.m4
configure.ac docs: Rename htmlman3 -> htmlman. 2012-09-10 14:19:42 +02:00
gpl-3.0.xml
htmldocs.html html docs: Remove link to Using Samba. 2012-10-04 13:48:00 +02:00
Makefile tests: Convert find_missing_doc into a unit test. 2012-10-19 09:10:13 +02:00
Makefile.settings.in docs: Fix undocumented target to find smb.conf directives in the right place 2012-09-04 09:31:49 +10:00
README
Samba-EventLog-HOWTO.txt
Samba.desktop
structure.svg
wscript_build waf docs: build the new vfs worm man page 2013-12-12 12:50:21 -08:00

!==
!== 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
!== Updates:    Jelmer Vernooij, jelmer@samba.org,              May, 2005

Quick start
-----------

Run:

$ make all

or to see what is possible:

$ make help

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 Subversion 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:

 * GNU Make
 * GNU autoconf
 * xsltproc
 * inkscape

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 ASCII:
 * html2text

For generating Palm-viewable docs:
 * plucker-build

For generating texi files:
 * docbook2x-texi
 * makeinfo

For validating:
 * xmllint

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,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".

For the Pearson DTD, add something like:

  <public publicId="-//Pearson//DTD Books//DE" uri="file:///home/jelmer/Xml_dtd_1.1/pearson.dtd"/>

For the Samba DTD's, add something like:
  <rewriteURI uriStartString="http://www.samba.org/samba/DTD" rewritePrefix="file:///home/jelmer/samba-web/DTD"/>

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