param: Add new 'logging' parameter
[kai/samba-autobuild/.git] / docs-xml / smbdotconf / logging / logging.xml
1 <samba:parameter name="logging"
2                  type="string"
3                  context="G"
4                  developer="1" advanced="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7
8   <para>This parameter configures logging backends backends. Multiple
9     backends can be specified at the same time, with different log
10     levels for each backend. The parameter is a list of backends,
11     where each backend is specified as backend[:option][@loglevel].</para>
12
13   <para>The 'option' parameter can be used to pass backend-specific
14     options.</para>
15
16   <para>The log level for a backend is optional, if it is not set for
17     a backend, all messages are sent to this backend. The parameter
18     <smbconfoption name="log level"/> determines overall log levels,
19     while the log levels specified here define what is sent to the
20     individual backends.</para>
21
22   <para>When <smbconfoption name="logging"/> is set, it overrides the
23     <smbconfoption  name="syslog"/>  and  <smbconfoption  name="syslog
24     only"/> parameters.</para>
25
26   <para>Some backends are only available when Samba has been compiled
27   with the additional libraries. The overall list of logging backends:</para>
28
29   <itemizedlist>
30     <listitem><para><parameter moreinfo="none">syslog</parameter></para></listitem>
31     <listitem><para><parameter moreinfo="none">file</parameter></para></listitem>
32   </itemizedlist>
33
34 </description>
35 <value type="default"></value>
36 <value type="example">syslog@1 file</value>
37 </samba:parameter>