summaryrefslogtreecommitdiff
path: root/docs/docbook/devdoc
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2003-04-28 13:07:29 +0000
committerJelmer Vernooij <jelmer@samba.org>2003-04-28 13:07:29 +0000
commitecde8fcf7a1cd692562bf75dd44cd8d063f0f8c4 (patch)
tree9ef609905ee6b4f39834795e30e408b42c043369 /docs/docbook/devdoc
parentdf91b5db2babb67eb2865ee8a0c441e8da2928c0 (diff)
downloadsamba-ecde8fcf7a1cd692562bf75dd44cd8d063f0f8c4.tar.gz
samba-ecde8fcf7a1cd692562bf75dd44cd8d063f0f8c4.tar.bz2
samba-ecde8fcf7a1cd692562bf75dd44cd8d063f0f8c4.zip
Use entities and add overview of directories
(This used to be commit 5957e3bf33e8992eda620a6ab0b4f8a1dbe8cb7a)
Diffstat (limited to 'docs/docbook/devdoc')
-rw-r--r--docs/docbook/devdoc/Tracing.sgml7
-rw-r--r--docs/docbook/devdoc/architecture.sgml53
-rw-r--r--docs/docbook/devdoc/dev-doc.sgml2
-rw-r--r--docs/docbook/devdoc/encryption.sgml11
-rw-r--r--docs/docbook/devdoc/gencache.sgml4
-rw-r--r--docs/docbook/devdoc/modules.sgml8
-rw-r--r--docs/docbook/devdoc/packagers.sgml4
-rw-r--r--docs/docbook/devdoc/printing.sgml4
-rw-r--r--docs/docbook/devdoc/rpc_plugin.sgml8
-rw-r--r--docs/docbook/devdoc/sam.sgml3
-rw-r--r--docs/docbook/devdoc/unix-smb.sgml4
-rw-r--r--docs/docbook/devdoc/wins.sgml4
12 files changed, 67 insertions, 45 deletions
diff --git a/docs/docbook/devdoc/Tracing.sgml b/docs/docbook/devdoc/Tracing.sgml
index ccf1e1c3c8..f55c47bc4e 100644
--- a/docs/docbook/devdoc/Tracing.sgml
+++ b/docs/docbook/devdoc/Tracing.sgml
@@ -1,11 +1,6 @@
<chapter id="tracing">
<chapterinfo>
- <author>
- <firstname>Andrew</firstname><surname>Tridgell</surname>
- <affiliation>
- <orgname>Samba Team</orgname>
- </affiliation>
- </author>
+ &author.tridge;
</chapterinfo>
<title>Tracing samba system calls</title>
diff --git a/docs/docbook/devdoc/architecture.sgml b/docs/docbook/devdoc/architecture.sgml
index 312a63af97..e05039054b 100644
--- a/docs/docbook/devdoc/architecture.sgml
+++ b/docs/docbook/devdoc/architecture.sgml
@@ -4,6 +4,7 @@
<firstname>Dan</firstname><surname>Shearer</surname>
</author>
<pubdate> November 1997</pubdate>
+ &author.jelmer;
</chapterinfo>
<title>Samba Architecture</title>
@@ -181,4 +182,56 @@ for browsing and WINS support.
</para>
</sect1>
+
+<sect1>
+<title>Samba's subsystems</title>
+
+<para>Samba's <filename>source/</filename> directory contains quite some directories. Here's a small explanation of what each of them contains.</para>
+
+<simplelist>
+<member>aparser - Obsolete</member>
+<member>auth - The authentication subsystem, maintained by Andrew Bartlett</member>
+<member>bin - Output directory for all the binary files</member>
+<member>client - Contains 'plain' SMB client sources: smbclient and
+some mount help utilities</member>
+<member>groupdb - Group database and mapping code</member>
+<member>include - All of samba's include files</member>
+<member>intl - Internationalization files. Not used at the moment.</member>
+<member>lib - General C helper functions. Not SMB-specific.</member>
+<member>libads - Library with ActiveDirectory related functions.</member>
+<member>libsmb - Library with SMB specific functions.</member>
+<member>locking - Locking functions!</member>
+<member>modules - Source files for various modules (VFS and charset).</member>
+<member>msdfs - DCE-DFS code</member>
+<member>nmbd - Code for the nmbd daemon</member>
+<member>nsswitch - Winbind source code</member>
+<member>pam_smbpass - Source code for pam module for authenticating against samba's passdb</member>
+<member>param - smb.conf parsing code</member>
+<member>passdb - User database(SAM) code with the various backends</member>
+<member>po - Internationalisation code - not used atm</member>
+<member>popt - Samba's internal copy of the popt library</member>
+<member>printing - Printing stuff</member>
+<member>profile - Profiling support</member>
+<member>python - Python bindings for various libsmb functions</member>
+<member>registry - Registry backend</member>
+<member>rpc_client - RPC Client library for making remote procedure calls</member>
+<member>rpc_parse - Functions for parsing RPC structures (???)</member>
+<member>rpc_server - Functions for being an RPC server</member>
+<member>rpcclient - Command-line client that is a basically a front-end to rpc_client/</member>
+<member>sam - Code for the new (but unused) SAM</member>
+<member>script - Various scripts</member>
+<member>smbd - Source code for the smbd daemon</member>
+<member>smbwrapper - Source code for library that overloads VFS function calls, for usage with LD_PRELOAD=...</member>
+<member>stf - Testsuite system?</member>
+<member>tdb - Source code of samba's Trivial Database (much like gdbm)</member>
+<member>tests - Source code for the larger tests used by configure</member>
+<member>torture - 'Torture' utilities, used for testing samba and other cifs servers</member>
+<member>ubiqx - The ubiqx library from Chris Hertel</member>
+<member>utils - Various small utilities(pdbedit, net, etc)</member>
+<member>web - SWAT sourcecode</member>
+<member>wrepld - Sourcecode of the WINS replication daemon</member>
+</simplelist>
+
+</sect1>
+
</chapter>
diff --git a/docs/docbook/devdoc/dev-doc.sgml b/docs/docbook/devdoc/dev-doc.sgml
index 5e1af3d3a0..ee2a40535d 100644
--- a/docs/docbook/devdoc/dev-doc.sgml
+++ b/docs/docbook/devdoc/dev-doc.sgml
@@ -1,4 +1,5 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
<!ENTITY NetBIOS SYSTEM "NetBIOS.sgml">
<!ENTITY Architecture SYSTEM "architecture.sgml">
<!ENTITY debug SYSTEM "debug.sgml">
@@ -26,6 +27,7 @@
<surname>SAMBA Team</surname>
</author>
<address><email>samba@samba.org</email></address>
+ <editor>&person.jelmer;</editor>
</bookinfo>
<dedication>
diff --git a/docs/docbook/devdoc/encryption.sgml b/docs/docbook/devdoc/encryption.sgml
index 3ca8aa109c..64ff4262cb 100644
--- a/docs/docbook/devdoc/encryption.sgml
+++ b/docs/docbook/devdoc/encryption.sgml
@@ -2,16 +2,7 @@
<chapterinfo>
- <author>
- <firstname>Jeremy</firstname><surname>Allison</surname>
- <affiliation>
- <orgname>Samba Team</orgname>
- <address>
- <email>samba@samba.org</email>
- </address>
- </affiliation>
- </author>
-
+ &author.jeremy;
<pubdate>19 Apr 1999</pubdate>
</chapterinfo>
diff --git a/docs/docbook/devdoc/gencache.sgml b/docs/docbook/devdoc/gencache.sgml
index 1ba2f77c9d..096bdce789 100644
--- a/docs/docbook/devdoc/gencache.sgml
+++ b/docs/docbook/devdoc/gencache.sgml
@@ -1,8 +1,6 @@
<chapter id="gencache">
<chapterinfo>
- <author>
- <firstname>Rafal</firstname><surname>Szczesniak</surname>
- </author>
+ &author.mimir;
<pubdate>April 2003</pubdate>
</chapterinfo>
diff --git a/docs/docbook/devdoc/modules.sgml b/docs/docbook/devdoc/modules.sgml
index 0bcdadc66c..c43e8a9118 100644
--- a/docs/docbook/devdoc/modules.sgml
+++ b/docs/docbook/devdoc/modules.sgml
@@ -1,12 +1,6 @@
<chapter id="modules">
<chapterinfo>
- <author>
- <firstname>Jelmer</firstname><surname>Vernooij</surname>
- <affiliation>
- <orgname>Samba Team</orgname>
- <address><email>jelmer@samba.org</email></address>
- </affiliation>
- </author>
+ &author.jelmer;
<pubdate> 19 March 2003 </pubdate>
</chapterinfo>
diff --git a/docs/docbook/devdoc/packagers.sgml b/docs/docbook/devdoc/packagers.sgml
index fb47c7305c..edc581cf05 100644
--- a/docs/docbook/devdoc/packagers.sgml
+++ b/docs/docbook/devdoc/packagers.sgml
@@ -1,8 +1,6 @@
<chapter id="Packaging">
<chapterinfo>
- <author>
- <firstname>Jelmer</firstname><surname>Vernooij</surname>
- </author>
+ &author.jelmer;
</chapterinfo>
<title>Notes to packagers</title>
diff --git a/docs/docbook/devdoc/printing.sgml b/docs/docbook/devdoc/printing.sgml
index 363b9fb6e5..150652ac37 100644
--- a/docs/docbook/devdoc/printing.sgml
+++ b/docs/docbook/devdoc/printing.sgml
@@ -1,8 +1,6 @@
<chapter id="printing">
<chapterinfo>
- <author>
- <firstname>Gerald</firstname><surname>Carter</surname>
- </author>
+ &author.jerry;
<pubdate>October 2002</pubdate>
</chapterinfo>
diff --git a/docs/docbook/devdoc/rpc_plugin.sgml b/docs/docbook/devdoc/rpc_plugin.sgml
index c83742a247..a2d1bd4c35 100644
--- a/docs/docbook/devdoc/rpc_plugin.sgml
+++ b/docs/docbook/devdoc/rpc_plugin.sgml
@@ -7,13 +7,7 @@
<address><email>aliguor@us.ibm.com</email></address>
</affiliation>
</author>
- <author>
- <firstname>Jelmer</firstname><surname>Vernooij</surname>
- <affiliation>
- <orgname>Samba Team</orgname>
- <address><email>jelmer@samba.org</email></address>
- </affiliation>
- </author>
+ &author.jelmer;
<pubdate>January 2003</pubdate>
</chapterinfo>
diff --git a/docs/docbook/devdoc/sam.sgml b/docs/docbook/devdoc/sam.sgml
index 84c17d65e2..d4c065ca21 100644
--- a/docs/docbook/devdoc/sam.sgml
+++ b/docs/docbook/devdoc/sam.sgml
@@ -9,6 +9,9 @@
<title>The Upcoming SAM System</title>
+<note><para>The design as described in this document is _NOT_ the design that
+made it into samba 3.0. </para></note>
+
<sect1>
<title>Security in the 'new SAM'</title>
diff --git a/docs/docbook/devdoc/unix-smb.sgml b/docs/docbook/devdoc/unix-smb.sgml
index d6a658089c..eea02012e0 100644
--- a/docs/docbook/devdoc/unix-smb.sgml
+++ b/docs/docbook/devdoc/unix-smb.sgml
@@ -1,8 +1,6 @@
<chapter id="unix-smb">
<chapterinfo>
- <author>
- <firstname>Andrew</firstname><surname>Tridgell</surname>
- </author>
+ &author.tridge;
<pubdate>April 1995</pubdate>
</chapterinfo>
diff --git a/docs/docbook/devdoc/wins.sgml b/docs/docbook/devdoc/wins.sgml
index 53410316c5..5cdf760406 100644
--- a/docs/docbook/devdoc/wins.sgml
+++ b/docs/docbook/devdoc/wins.sgml
@@ -1,8 +1,6 @@
<chapter id="wins">
<chapterinfo>
- <author>
- <firstname>Gerald</firstname><surname>Carter</surname>
- </author>
+ &author.jerry;
<pubdate>October 2002</pubdate>
</chapterinfo>