1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-24 21:34:56 +03:00
samba-mirror/docs-xml
Jeremy Allison 306783d6f5 lib: modules: Change XXX_init interface from XXX_init(void) to XXX_init(TALLOC_CTX *)
Not currently used - no logic changes inside.

This will make it possible to pass down a long-lived talloc
context from the loading function for modules to use instead
of having them internally all use talloc_autofree_context()
which is a hidden global.

Updated all known module interface numbers, and added a
WHATSNEW.

Signed-off-by: Jeremy Allison <jra@samba.org>
Signed-off-by: Ralph Böhme <slow@samba.org>

Autobuild-User(master): Jeremy Allison <jra@samba.org>
Autobuild-Date(master): Sat Apr 22 01:17:00 CEST 2017 on sn-devel-144
2017-04-22 01:17:00 +02:00
..
archives docs-xml: change http://samba.org to https://www.samba.org 2016-12-09 13:10:26 +01:00
build docs:smbdotconf: add param flag 'enumlist' to the DTD 2015-07-31 01:55:29 +02:00
manpages docs: Update idmap_rid manpage 2017-04-18 00:43:20 +02:00
registry docs: Fix Bug 6922: Add Registry patchfile for Win7 domain join. 2009-11-24 11:38:14 +01:00
Samba3-ByExample Correct "perfom" typos. 2017-02-22 08:26:22 +01:00
Samba3-Developers-Guide lib: modules: Change XXX_init interface from XXX_init(void) to XXX_init(TALLOC_CTX *) 2017-04-22 01:17:00 +02:00
Samba3-HOWTO fix spelling of 'unchangeable' 2017-02-22 12:21:51 +01:00
scripts docs: Remove find_missing_manpages replaced by docs.py and dependent on a Makefile.in file 2014-01-29 09:16:07 +01:00
smbdotconf param: Check for valid values of 'name resolve order' option 2017-04-13 11:26:28 +02:00
templates
test Move test image to test/images/, consistent with the other books. 2009-05-01 22:49:10 +02:00
using_samba Correct "hexidecimal" typos. 2017-02-22 08:26:23 +01:00
xslt Correct "formated" typos. 2017-02-22 08:26:22 +01:00
.gitignore docs: Remove unused parameters.global.xml and parameters.service.xml 2014-01-29 09:16:23 +01:00
aclocal.m4 Fix 'make undocumented' (by hardcoding the source path, now that the docs 2009-05-01 13:10:13 +02:00
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 docs: Remove unused parameters.global.xml and parameters.service.xml 2014-01-29 09:16:23 +01: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 docs-xml: change http://samba.org to https://www.samba.org 2016-12-09 13:10:26 +01:00
Samba-EventLog-HOWTO.txt
Samba.desktop
structure.svg
wscript_build s3/util: mvxattr, a tool to rename extended attributes 2017-02-10 22:24:59 +01: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 https://www.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