Moving docs tree to docs-xml to make room for generated docs in the release tarball.

(This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14)

13 files changed, 264 insertions, 0 deletions

diff --git a/docs-xml/smbdotconf/logging/debugclass.xml b/docs-xml/smbdotconf/logging/debugclass.xml
new file mode 100644
index 0000000000..cc4b84acd7
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/debugclass.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="debug class"
+                 context="G"
+		 type="boolean"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>
+    With this boolean parameter enabled, the debug class (DBGC_CLASS) 
+    will be displayed in the debug header.
+    </para>
+    <para>
+    For more information about currently available debug classes, see
+    section about <smbconfoption name="log level"/>.
+    </para>
+
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/debughirestimestamp.xml b/docs-xml/smbdotconf/logging/debughirestimestamp.xml
new file mode 100644
index 0000000000..6f32bd593b
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/debughirestimestamp.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="debug hires timestamp"
+                 context="G"
+                 developer="1"
+				 type="boolean"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <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 <smbconfoption name="debug timestamp"/> must be on for this to have an effect.
+    </para>
+
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/debugpid.xml b/docs-xml/smbdotconf/logging/debugpid.xml
new file mode 100644
index 0000000000..017d010940
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/debugpid.xml
@@ -0,0 +1,19 @@
+<samba:parameter name="debug pid"
+                 context="G"
+				 type="boolean"
+                 developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>
+    When using only one log file for more then one forked <citerefentry><refentrytitle>smbd</refentrytitle>
+    <manvolnum>8</manvolnum></citerefentry>-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 <smbconfoption name="debug timestamp"/> must be on for this to have an effect.
+    </para>
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/debugprefixtimestamp.xml b/docs-xml/smbdotconf/logging/debugprefixtimestamp.xml
new file mode 100644
index 0000000000..62a6574613
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/debugprefixtimestamp.xml
@@ -0,0 +1,19 @@
+<samba:parameter name="debug prefix timestamp"
+                 context="G"
+                 developer="1"
+				 type="boolean"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>
+    With this option enabled, the timestamp message header is prefixed to the debug message without the
+    filename and function information that is included with the <smbconfoption name="debug timestamp"/> 
+    parameter. This gives timestamps to the messages without adding an additional line.
+    </para>
+
+    <para>
+    Note that this parameter overrides the <smbconfoption name="debug timestamp"/> parameter.
+    </para>
+
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/debugtimestamp.xml b/docs-xml/smbdotconf/logging/debugtimestamp.xml
new file mode 100644
index 0000000000..b335eba465
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/debugtimestamp.xml
@@ -0,0 +1,15 @@
+<samba:parameter name="debug timestamp"
+                 context="G"
+				 type="boolean"
+                 developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<synonym>timestamp logs</synonym>
+<description>
+    <para>
+    Samba debug log messages are timestamped by default. If you are running at a high 
+    <smbconfoption name="debug level"/> these timestamps can be distracting. This 
+    boolean parameter allows timestamping to be turned off.
+	</para>
+</description>
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/debuguid.xml b/docs-xml/smbdotconf/logging/debuguid.xml
new file mode 100644
index 0000000000..5cfa541a45
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/debuguid.xml
@@ -0,0 +1,17 @@
+<samba:parameter name="debug uid"
+                 context="G"
+				 type="boolean"
+                 developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <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 <smbconfoption name="debug timestamp"/> must be on for this to have an effect.
+    </para>
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/ldapdebuglevel.xml b/docs-xml/smbdotconf/logging/ldapdebuglevel.xml
new file mode 100644
index 0000000000..fdb6d40f25
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/ldapdebuglevel.xml
@@ -0,0 +1,28 @@
+<samba:parameter name="ldap debug level"
+		 type="integer"
+		context="G"
+		developer="1" advanced="1"
+		xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>
+		This parameter controls the debug level of the LDAP library
+		calls. In the case of OpenLDAP, it is the same
+		bit-field as understood by the server and documented in the
+		 <citerefentry>
+			<refentrytitle>slapd.conf</refentrytitle>
+			<manvolnum>5</manvolnum>
+		</citerefentry>
+		manpage.
+		A typical useful value will be
+		 <emphasis>1</emphasis> for tracing function calls.
+	</para>
+	<para>
+		The debug ouput from the LDAP libraries appears with the
+		prefix [LDAP] in Samba's logging output.
+		The level at which LDAP logging is printed is controlled by the
+		parameter <parameter>ldap debug threshold</parameter>.
+	</para>
+</description>
+<value type="default">0</value>
+<value type="example">1</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/ldapdebugthreshold.xml b/docs-xml/smbdotconf/logging/ldapdebugthreshold.xml
new file mode 100644
index 0000000000..e023ff689b
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/ldapdebugthreshold.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="ldap debug threshold"
+		type="integer"
+		context="G"
+		developer="1" advanced="1"
+		xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>
+		This parameter controls the Samba debug level at which
+		the ldap library debug output is
+		printed in the Samba logs. See the description of
+		 <parameter>ldap debug level</parameter> for details.
+	</para>
+</description>
+<value type="default">10</value>
+<value type="example">5</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/logfile.xml b/docs-xml/smbdotconf/logging/logfile.xml
new file mode 100644
index 0000000000..838d302b7b
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/logfile.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="log file"
+                 context="G"
+				 type="string"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <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>
+</description>
+<value type="example">/usr/local/samba/var/log.%m</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/loglevel.xml b/docs-xml/smbdotconf/logging/loglevel.xml
new file mode 100644
index 0000000000..d5562f42bb
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/loglevel.xml
@@ -0,0 +1,45 @@
+<samba:parameter name="log level"
+				 type="string"
+                 context="G"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<synonym>debuglevel</synonym>
+<description>
+    <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. 
+    </para>
+
+    <para>This parameter has been extended since the 2.2.x 
+    series, now it allows to specify the debug level for multiple 
+    debug classes. This is to give greater flexibility in the configuration 
+    of the system. The following debug classes are currently implemented:
+    </para>
+
+    <itemizedlist>
+	<listitem><para><parameter moreinfo="none">all</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">tdb</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">printdrivers</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">lanman</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">smb</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">rpc_parse</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">rpc_srv</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">rpc_cli</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">passdb</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">sam</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">auth</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">winbind</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">vfs</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">idmap</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">quota</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">acls</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">locking</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">msdfs</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">dmapi</parameter></para></listitem>
+	<listitem><para><parameter moreinfo="none">registry</parameter></para></listitem>
+    </itemizedlist>
+    
+</description>
+<value type="default">0</value>
+<value type="example">3 passdb:5 auth:10 winbind:2</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/maxlogsize.xml b/docs-xml/smbdotconf/logging/maxlogsize.xml
new file mode 100644
index 0000000000..3d5239ccdf
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/maxlogsize.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="max log size"
+				 type="integer"
+                 context="G"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <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>
+</description>
+<value type="default">5000</value>
+<value type="example">1000</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/syslog.xml b/docs-xml/smbdotconf/logging/syslog.xml
new file mode 100644
index 0000000000..e4722d8164
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/syslog.xml
@@ -0,0 +1,21 @@
+<samba:parameter name="syslog"
+                 context="G"
+				 type="integer"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <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. There still will be some
+    logging to log.[sn]mbd even if <emphasis>syslog only</emphasis> is enabled.
+    </para>
+</description>
+<value type="default">1</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/logging/syslogonly.xml b/docs-xml/smbdotconf/logging/syslogonly.xml
new file mode 100644
index 0000000000..0fe74713e2
--- /dev/null
+++ b/docs-xml/smbdotconf/logging/syslogonly.xml
@@ -0,0 +1,14 @@
+<samba:parameter name="syslog only"
+                 context="G"
+				 type="boolean"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>
+    If this parameter is set then Samba debug messages are logged into the system 
+    syslog only, and not to the debug log files. There still will be some
+	logging to log.[sn]mbd even if <emphasis>syslog only</emphasis> is enabled.
+    </para>
+</description>
+<value type="default">no</value>
+</samba:parameter>