diff options
Diffstat (limited to 'docs/smbdotconf/logging')
-rw-r--r-- | docs/smbdotconf/logging/debughirestimestamp.xml | 18 | ||||
-rw-r--r-- | docs/smbdotconf/logging/debugpid.xml | 19 | ||||
-rw-r--r-- | docs/smbdotconf/logging/debugtimestamp.xml | 15 | ||||
-rw-r--r-- | docs/smbdotconf/logging/debuguid.xml | 17 | ||||
-rw-r--r-- | docs/smbdotconf/logging/logfile.xml | 14 | ||||
-rw-r--r-- | docs/smbdotconf/logging/loglevel.xml | 20 | ||||
-rw-r--r-- | docs/smbdotconf/logging/maxlogsize.xml | 16 | ||||
-rw-r--r-- | docs/smbdotconf/logging/syslog.xml | 20 | ||||
-rw-r--r-- | docs/smbdotconf/logging/syslogonly.xml | 12 |
9 files changed, 151 insertions, 0 deletions
diff --git a/docs/smbdotconf/logging/debughirestimestamp.xml b/docs/smbdotconf/logging/debughirestimestamp.xml new file mode 100644 index 0000000000..6be22a201a --- /dev/null +++ b/docs/smbdotconf/logging/debughirestimestamp.xml @@ -0,0 +1,18 @@ +<samba:parameter name="debug hires timestamp" + context="G" + developer="1" + type="boolean" + xmlns:samba="http://samba.org/common"> +<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 <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link> must be on for this to have an + effect.</para> + +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs/smbdotconf/logging/debugpid.xml b/docs/smbdotconf/logging/debugpid.xml new file mode 100644 index 0000000000..810aaa1260 --- /dev/null +++ b/docs/smbdotconf/logging/debugpid.xml @@ -0,0 +1,19 @@ +<samba:parameter name="debug pid" + context="G" + type="boolean" + developer="1" + xmlns:samba="http://samba.org/common"> +<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 <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link> must be on for this to have an + effect.</para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs/smbdotconf/logging/debugtimestamp.xml b/docs/smbdotconf/logging/debugtimestamp.xml new file mode 100644 index 0000000000..1c2f662573 --- /dev/null +++ b/docs/smbdotconf/logging/debugtimestamp.xml @@ -0,0 +1,15 @@ +<samba:parameter name="debug timestamp" + context="G" + type="boolean" + developer="1" + xmlns:samba="http://samba.org/common"> + <synonym>timestamp logs</synonym> +<description> + <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> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs/smbdotconf/logging/debuguid.xml b/docs/smbdotconf/logging/debuguid.xml new file mode 100644 index 0000000000..61155a4d70 --- /dev/null +++ b/docs/smbdotconf/logging/debuguid.xml @@ -0,0 +1,17 @@ +<samba:parameter name="debug uid" + context="G" + type="boolean" + developer="1" + xmlns:samba="http://samba.org/common"> +<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 <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link> must be on for this to have an + effect.</para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs/smbdotconf/logging/logfile.xml b/docs/smbdotconf/logging/logfile.xml new file mode 100644 index 0000000000..46cd728039 --- /dev/null +++ b/docs/smbdotconf/logging/logfile.xml @@ -0,0 +1,14 @@ +<samba:parameter name="log file" + context="G" + type="string" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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/smbdotconf/logging/loglevel.xml b/docs/smbdotconf/logging/loglevel.xml new file mode 100644 index 0000000000..c023a71c73 --- /dev/null +++ b/docs/smbdotconf/logging/loglevel.xml @@ -0,0 +1,20 @@ +<samba:parameter name="log level" + type="string" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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. 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> + +</description> +<value type="example">3 passdb:5 auth:10 winbind:2</value> +</samba:parameter> diff --git a/docs/smbdotconf/logging/maxlogsize.xml b/docs/smbdotconf/logging/maxlogsize.xml new file mode 100644 index 0000000000..e496980fa0 --- /dev/null +++ b/docs/smbdotconf/logging/maxlogsize.xml @@ -0,0 +1,16 @@ +<samba:parameter name="max log size" + type="integer" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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="default">1000</value> +</samba:parameter> diff --git a/docs/smbdotconf/logging/syslog.xml b/docs/smbdotconf/logging/syslog.xml new file mode 100644 index 0000000000..5f67a02c0f --- /dev/null +++ b/docs/smbdotconf/logging/syslog.xml @@ -0,0 +1,20 @@ +<samba:parameter name="syslog" + context="G" + type="integer" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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.</para> +</description> +<value type="default">1</value> +</samba:parameter> diff --git a/docs/smbdotconf/logging/syslogonly.xml b/docs/smbdotconf/logging/syslogonly.xml new file mode 100644 index 0000000000..0b255d4ca7 --- /dev/null +++ b/docs/smbdotconf/logging/syslogonly.xml @@ -0,0 +1,12 @@ +<samba:parameter name="syslog only" + context="G" + type="boolean" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<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.</para> +</description> +<value type="default">no</value> +</samba:parameter> |