[PATCH] admin log documentation (smbdotconf)

[Michael Krax]

Jerry,

please find enclosed a patch to samba-doc documenting the admin log
configuration options.  Hopefully the average samba user will
understand the comments.

I did not succeed in building the documentation, but neither did I try
very toroughly.  The output is produced by svn diff.

Ciao,
Michael

-- 
Michael Krax
Phone +49(0)30.76765923  Mobile +49(0)163.7325923
-------------- next part --------------
Index: smbdotconf/logging/adminlogeventtypes.xml
===================================================================
--- smbdotconf/logging/adminlogeventtypes.xml	(Revision 0)
+++ smbdotconf/logging/adminlogeventtypes.xml	(Revision 0)
@@ -0,0 +1,23 @@
+<samba:parameter name="admin log event types"
+				 type="list"
+                 context="G"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>
+    Tells the administrative logging support which types of event 
+    should be logged.  Admin log uses the same list of events as 
+    the debug interface and can be extended.  Currently, the following 
+    event types are supported: tdb, printdrivers, lanman, smb, rpc_parse,
+    rpc_srv, rpc_cli, passdb, sam, auth, winbind, vfs, idmap, quota, acls,
+    locking, msdfs, dmapi, param.  The special value "all" selects all 
+    categories of events.
+    </para>
+
+    <para>
+    The default is to log all types.
+    </para>
+
+</description>
+<value type="example">passdb auth winbind</value>
+</samba:parameter>
Index: smbdotconf/logging/adminlogformat.xml
===================================================================
--- smbdotconf/logging/adminlogformat.xml	(Revision 0)
+++ smbdotconf/logging/adminlogformat.xml	(Revision 0)
@@ -0,0 +1,31 @@
+<samba:parameter name="admin log format"
+				 type="string"
+                 context="G"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>
+    The output of the administrative logging support can be formatted 
+    by changing this parameter in smb.conf.  You may use most of the 
+    macro replacement strings offered by samba (ie. %u or %U to get
+    the user name or %m to get the machine name).
+    </para>
+
+<para>
+    Additionally, admin log supports the following replacement strings:
+    %e for the event type and id (event type<<16|id),
+    %E for the event type as text,
+    %b for the event description (if available) and
+    %n for the NT status code description.
+</para>
+
+    <para>
+    The default is the empty string which leads to a special output format.
+    It looks like:
+    "0x03340003 \\MACHINE USER (Event-type-as-text) Description".
+    0x03340003 is the event type<<16|id, \\MACHINE may be omitted.
+    </para>
+
+</description>
+<value type="example">event type %e text %E desc %b ntcode %n user %u machine %m</value>
+</samba:parameter>
Index: smbdotconf/logging/adminloglevels.xml
===================================================================
--- smbdotconf/logging/adminloglevels.xml	(Revision 0)
+++ smbdotconf/logging/adminloglevels.xml	(Revision 0)
@@ -0,0 +1,20 @@
+<samba:parameter name="admin log levels"
+				 type="list"
+                 context="G"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>
+    Specifies how many events administrative logging support will 
+    be logging.  Possible values are "all", "error", "warning" and
+    "information".  They roughly correspond to the concepts used by 
+    syslog.
+    </para>
+
+    <para>
+    The default is to log only errors.
+    </para>
+
+</description>
+<value type="example"></value>
+</samba:parameter>
Index: smbdotconf/logging/adminlog.xml
===================================================================
--- smbdotconf/logging/adminlog.xml	(Revision 0)
+++ smbdotconf/logging/adminlog.xml	(Revision 0)
@@ -0,0 +1,21 @@
+<samba:parameter name="admin log"
+				 type="boolean"
+                 context="G"
+                 developer="1" advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>
+    Disables (default) or enables administrative logging support for Samba.
+  Administrative logging (admin log for short) is configured by
+ four options in the 
+    <filename moreinfo="none">smb.conf</filename> file.  It should help the Samba administrator to get some easily understandable information about
+some "typical" errors.  Output is written to syslog.
+</para>
+
+    <para>
+    This option is disabled be default.
+    </para>
+
+</description>
+<value type="example">Yes</value>
+</samba:parameter>