Add new framework for smb.conf(5). Please read README before trying to compile.

I will commit more meta-information updates during week-end.
(This used to be commit 8d684dffab6a90b3d612a1aa2b2c457a2bc2e6ac)

11 files changed, 127 insertions, 0 deletions

diff --git a/docs/docbook/smbdotconf/logging/debughirestimestamp.xml b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml
new file mode 100644
index 0000000000..a5f40b73ca
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml
@@ -0,0 +1,14 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="DEBUGHIRESTIMESTAMP"/>debug hires timestamp (G)</term>
+		<listitem><para>Sometimes the timestamps in the log messages 
+		are needed with a resolution of higher that seconds, this 
+		boolean parameter adds microsecond resolution to the timestamp 
+		message header when turned on.</para>
+
+		<para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none">
+		debug timestamp</parameter></link> must be on for this to have an 
+		effect.</para>
+
+		<para>Default: <command moreinfo="none">debug hires timestamp = no</command></para>
+		</listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/debuglevel.xml b/docs/docbook/smbdotconf/logging/debuglevel.xml
new file mode 100644
index 0000000000..99153fa853
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/debuglevel.xml
@@ -0,0 +1,6 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="DEBUGLEVEL"/>debuglevel (G)</term>
+		<listitem><para>Synonym for <link linkend="LOGLEVEL"><parameter moreinfo="none">
+		log level</parameter></link>.</para>
+		</listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/debugpid.xml b/docs/docbook/smbdotconf/logging/debugpid.xml
new file mode 100644
index 0000000000..829e168412
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/debugpid.xml
@@ -0,0 +1,13 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="DEBUGPID"/>debug pid (G)</term>
+		<listitem><para>When using only one log file for more then one 
+		forked <ulink url="smbd.8.html">smbd</ulink>-process there may be hard to follow which process 
+		outputs which message. This boolean parameter is adds the process-id 
+		to the timestamp message headers in the logfile when turned on.</para>
+
+		<para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none">
+		debug timestamp</parameter></link> must be on for this to have an 
+		effect.</para>
+
+		<para>Default: <command moreinfo="none">debug pid = no</command></para></listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/debugtimestamp.xml b/docs/docbook/smbdotconf/logging/debugtimestamp.xml
new file mode 100644
index 0000000000..1265c1d21b
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/debugtimestamp.xml
@@ -0,0 +1,10 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="DEBUGTIMESTAMP"/>debug timestamp (G)</term>
+		<listitem><para>Samba debug log messages are timestamped 
+		by default. If you are running at a high <link linkend="DEBUGLEVEL">
+		<parameter moreinfo="none">debug level</parameter></link> these timestamps
+		can be distracting. This boolean parameter allows timestamping 
+		to be turned off.</para>
+
+		<para>Default: <command moreinfo="none">debug timestamp = yes</command></para></listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/debuguid.xml b/docs/docbook/smbdotconf/logging/debuguid.xml
new file mode 100644
index 0000000000..9b0786d6b3
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/debuguid.xml
@@ -0,0 +1,13 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="DEBUGUID"/>debug uid (G)</term>
+		<listitem><para>Samba is sometimes run as root and sometime 
+		run as the connected user, this boolean parameter inserts the 
+		current euid, egid, uid and gid to the timestamp message headers 
+		in the log file if turned on.</para>
+		
+		<para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none">
+		debug timestamp</parameter></link> must be on for this to have an 
+		effect.</para>
+
+		<para>Default: <command moreinfo="none">debug uid = no</command></para></listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/logfile.xml b/docs/docbook/smbdotconf/logging/logfile.xml
new file mode 100644
index 0000000000..6f176ef02b
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/logfile.xml
@@ -0,0 +1,11 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="LOGFILE"/>log file (G)</term>
+		<listitem><para>This option allows you to override the name 
+		of the Samba log file (also known as the debug file).</para>
+
+		<para>This option takes the standard substitutions, allowing 
+		you to have separate log files for each user or machine.</para>
+
+		<para>Example: <command moreinfo="none">log file = /usr/local/samba/var/log.%m
+		</command></para></listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/loglevel.xml b/docs/docbook/smbdotconf/logging/loglevel.xml
new file mode 100644
index 0000000000..610dc96812
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/loglevel.xml
@@ -0,0 +1,15 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="LOGLEVEL"/>log level (G)</term>
+		<listitem><para>The value of the parameter (a astring) allows 
+		the debug level (logging level) to be specified in the 
+		<filename moreinfo="none">smb.conf</filename> file. This parameter has been
+		extended since the 2.2.x series, now it allow to specify the debug
+		level for multiple debug classes. This is to give greater 
+		flexibility in the configuration of the system.</para>
+
+		<para>The default will be the log level specified on 
+		the command line or level zero if none was specified.</para>
+
+		<para>Example: <command moreinfo="none">log level = 3 passdb:5 auth:10 winbind:2
+		</command></para></listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/maxlogsize.xml b/docs/docbook/smbdotconf/logging/maxlogsize.xml
new file mode 100644
index 0000000000..117410b18c
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/maxlogsize.xml
@@ -0,0 +1,13 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="MAXLOGSIZE"/>max log size (G)</term>
+		<listitem><para>This option (an integer in kilobytes) specifies 
+		the max size the log file should grow to. Samba periodically checks 
+		the size and if it is exceeded it will rename the file, adding 
+		a <filename moreinfo="none">.old</filename> extension.</para>
+
+		<para>A size of 0 means no limit.</para>
+
+		<para>Default: <command moreinfo="none">max log size = 5000</command></para>
+		<para>Example: <command moreinfo="none">max log size = 1000</command></para>
+		</listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/syslog.xml b/docs/docbook/smbdotconf/logging/syslog.xml
new file mode 100644
index 0000000000..ac098e690a
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/syslog.xml
@@ -0,0 +1,17 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="SYSLOG"/>syslog (G)</term>
+		<listitem><para>This parameter maps how Samba debug messages 
+		are logged onto the system syslog logging levels. Samba debug 
+		level zero maps onto syslog <constant>LOG_ERR</constant>, debug 
+		level one maps onto <constant>LOG_WARNING</constant>, debug level 
+		two maps onto <constant>LOG_NOTICE</constant>, debug level three 
+		maps onto LOG_INFO. All higher levels are mapped to <constant>
+		LOG_DEBUG</constant>.</para>
+
+		<para>This parameter sets the threshold for sending messages 
+		to syslog.  Only messages with debug level less than this value 
+		will be sent to syslog.</para>
+
+		<para>Default: <command moreinfo="none">syslog = 1</command></para>
+		</listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/syslogonly.xml b/docs/docbook/smbdotconf/logging/syslogonly.xml
new file mode 100644
index 0000000000..a955306fe0
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/syslogonly.xml
@@ -0,0 +1,9 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="SYSLOGONLY"/>syslog only (G)</term>
+		<listitem><para>If this parameter is set then Samba debug 
+		messages are logged into the system syslog only, and not to 
+		the debug log files.</para>
+
+		<para>Default: <command moreinfo="none">syslog only = no</command></para>
+		</listitem>
+		</samba:parameter>
diff --git a/docs/docbook/smbdotconf/logging/timestamplogs.xml b/docs/docbook/smbdotconf/logging/timestamplogs.xml
new file mode 100644
index 0000000000..5f5f42d738
--- /dev/null
+++ b/docs/docbook/smbdotconf/logging/timestamplogs.xml
@@ -0,0 +1,6 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="TIMESTAMPLOGS"/>timestamp logs (G)</term>
+		<listitem><para>Synonym for <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none">
+		debug timestamp</parameter></link>.</para>
+		</listitem>
+		</samba:parameter>