diff options
Diffstat (limited to 'docs/docbook/smbdotconf/logging')
| -rw-r--r-- | docs/docbook/smbdotconf/logging/debughirestimestamp.xml | 27 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/debuglevel.xml | 15 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/debugpid.xml | 28 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/debugtimestamp.xml | 22 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/debuguid.xml | 26 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/logfile.xml | 21 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/loglevel.xml | 29 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/maxlogsize.xml | 26 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/syslog.xml | 33 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/syslogonly.xml | 19 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/logging/timestamplogs.xml | 15 |
11 files changed, 150 insertions, 111 deletions
diff --git a/docs/docbook/smbdotconf/logging/debughirestimestamp.xml b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml index a5f40b73ca..4e49b89ddb 100644 --- a/docs/docbook/smbdotconf/logging/debughirestimestamp.xml +++ b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml @@ -1,14 +1,17 @@ -<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> +<samba:parameter name="debug hires timestamp" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<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>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> + <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 index 99153fa853..8bd4b4e0b5 100644 --- a/docs/docbook/smbdotconf/logging/debuglevel.xml +++ b/docs/docbook/smbdotconf/logging/debuglevel.xml @@ -1,6 +1,9 @@ -<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> +<samba:parameter name="debug level" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<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 index 829e168412..ff393f5159 100644 --- a/docs/docbook/smbdotconf/logging/debugpid.xml +++ b/docs/docbook/smbdotconf/logging/debugpid.xml @@ -1,13 +1,19 @@ -<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> +<samba:parameter name="debug pid" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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 <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> - debug timestamp</parameter></link> must be on for this to have an - effect.</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> + <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 index 1265c1d21b..e337b5b8f2 100644 --- a/docs/docbook/smbdotconf/logging/debugtimestamp.xml +++ b/docs/docbook/smbdotconf/logging/debugtimestamp.xml @@ -1,10 +1,14 @@ -<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> +<samba:parameter name="debug timestamp" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<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> + <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 index 9b0786d6b3..bcacdf32c0 100644 --- a/docs/docbook/smbdotconf/logging/debuguid.xml +++ b/docs/docbook/smbdotconf/logging/debuguid.xml @@ -1,13 +1,17 @@ -<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> +<samba:parameter name="debug uid" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<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>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> + <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 index 6f176ef02b..8d3761a841 100644 --- a/docs/docbook/smbdotconf/logging/logfile.xml +++ b/docs/docbook/smbdotconf/logging/logfile.xml @@ -1,11 +1,14 @@ -<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> +<samba:parameter name="log file" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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>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> + <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 index 610dc96812..6f03fe80e9 100644 --- a/docs/docbook/smbdotconf/logging/loglevel.xml +++ b/docs/docbook/smbdotconf/logging/loglevel.xml @@ -1,15 +1,18 @@ -<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> +<samba:parameter name="log level" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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>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> + <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 index 117410b18c..6e0ec6735a 100644 --- a/docs/docbook/smbdotconf/logging/maxlogsize.xml +++ b/docs/docbook/smbdotconf/logging/maxlogsize.xml @@ -1,13 +1,17 @@ -<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> +<samba:parameter name="max log size" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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>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> + <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 index ac098e690a..0fdf070045 100644 --- a/docs/docbook/smbdotconf/logging/syslog.xml +++ b/docs/docbook/smbdotconf/logging/syslog.xml @@ -1,17 +1,20 @@ -<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> +<samba:parameter name="syslog" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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>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> + <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 index a955306fe0..2b584d8d6d 100644 --- a/docs/docbook/smbdotconf/logging/syslogonly.xml +++ b/docs/docbook/smbdotconf/logging/syslogonly.xml @@ -1,9 +1,12 @@ -<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> +<samba:parameter name="syslog only" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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> + <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 index 5f5f42d738..e744ce54c6 100644 --- a/docs/docbook/smbdotconf/logging/timestamplogs.xml +++ b/docs/docbook/smbdotconf/logging/timestamplogs.xml @@ -1,6 +1,9 @@ -<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> +<samba:parameter name="timestamp logs" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link>.</para> +</listitem> +</samba:parameter> |