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