summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/logging
diff options
context:
space:
mode:
authorJohn Terpstra <jht@samba.org>2005-08-25 16:49:40 +0000
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:47:06 -0500
commit6c2e58987bcb3b5fe527f7f6743c549ed6c0c877 (patch)
tree700bab687907526be31f9dcadc1e826845562a7b /docs/smbdotconf/logging
parentcf596ff9a0e5e191cfdc5f219e57844ad35ba7a2 (diff)
downloadsamba-6c2e58987bcb3b5fe527f7f6743c549ed6c0c877.tar.gz
samba-6c2e58987bcb3b5fe527f7f6743c549ed6c0c877.tar.bz2
samba-6c2e58987bcb3b5fe527f7f6743c549ed6c0c877.zip
Formatting and other fixes to man pages.
(This used to be commit 411025ed0d6ba37ff00f4afc8ccdc9dae94b62e0)
Diffstat (limited to 'docs/smbdotconf/logging')
-rw-r--r--docs/smbdotconf/logging/debughirestimestamp.xml12
-rw-r--r--docs/smbdotconf/logging/debugpid.xml17
-rw-r--r--docs/smbdotconf/logging/debugtimestamp.xml11
-rw-r--r--docs/smbdotconf/logging/debuguid.xml13
-rw-r--r--docs/smbdotconf/logging/logfile.xml10
-rw-r--r--docs/smbdotconf/logging/loglevel.xml17
-rw-r--r--docs/smbdotconf/logging/maxlogsize.xml12
-rw-r--r--docs/smbdotconf/logging/syslog.xml20
-rw-r--r--docs/smbdotconf/logging/syslogonly.xml7
9 files changed, 64 insertions, 55 deletions
diff --git a/docs/smbdotconf/logging/debughirestimestamp.xml b/docs/smbdotconf/logging/debughirestimestamp.xml
index eef5af73f0..6f32bd593b 100644
--- a/docs/smbdotconf/logging/debughirestimestamp.xml
+++ b/docs/smbdotconf/logging/debughirestimestamp.xml
@@ -4,14 +4,14 @@
type="boolean"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<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>
+ 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 <smbconfoption name="debug timestamp"/> must be on for this to have an
- effect.</para>
+ Note that the parameter <smbconfoption name="debug timestamp"/> must be on for this to have an effect.
+ </para>
</description>
<value type="default">no</value>
diff --git a/docs/smbdotconf/logging/debugpid.xml b/docs/smbdotconf/logging/debugpid.xml
index 0d84eb5263..017d010940 100644
--- a/docs/smbdotconf/logging/debugpid.xml
+++ b/docs/smbdotconf/logging/debugpid.xml
@@ -4,15 +4,16 @@
developer="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<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>
+ 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 <smbconfoption name="debug timestamp"/> must be on for this to have an
- effect.</para>
+ <para>
+ Note that the parameter <smbconfoption name="debug timestamp"/> 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
index ac1ce7b09e..b335eba465 100644
--- a/docs/smbdotconf/logging/debugtimestamp.xml
+++ b/docs/smbdotconf/logging/debugtimestamp.xml
@@ -3,12 +3,13 @@
type="boolean"
developer="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
- <synonym>timestamp logs</synonym>
+<synonym>timestamp logs</synonym>
<description>
- <para>Samba debug log messages are timestamped
- by default. If you are running at a high <smbconfoption name="debug level"/> these timestamps
- can be distracting. This boolean parameter allows timestamping
- to be turned off.</para>
+ <para>
+ Samba debug log messages are timestamped by default. If you are running at a high
+ <smbconfoption name="debug level"/> 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
index 616128a581..5cfa541a45 100644
--- a/docs/smbdotconf/logging/debuguid.xml
+++ b/docs/smbdotconf/logging/debuguid.xml
@@ -4,13 +4,14 @@
developer="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<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>
+ 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 <smbconfoption name="debug timestamp"/> must be on for this to have an
- effect.</para>
+ <para>
+ Note that the parameter <smbconfoption name="debug timestamp"/> 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
index 202f987891..838d302b7b 100644
--- a/docs/smbdotconf/logging/logfile.xml
+++ b/docs/smbdotconf/logging/logfile.xml
@@ -4,11 +4,13 @@
developer="1" advanced="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<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 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>
</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
index aaf1f9e975..7abf10990c 100644
--- a/docs/smbdotconf/logging/loglevel.xml
+++ b/docs/smbdotconf/logging/loglevel.xml
@@ -5,15 +5,16 @@
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<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 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>
</description>
<value type="example">3 passdb:5 auth:10 winbind:2</value>
diff --git a/docs/smbdotconf/logging/maxlogsize.xml b/docs/smbdotconf/logging/maxlogsize.xml
index 673c3ff855..686185c70a 100644
--- a/docs/smbdotconf/logging/maxlogsize.xml
+++ b/docs/smbdotconf/logging/maxlogsize.xml
@@ -4,12 +4,14 @@
developer="1" advanced="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<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>
+ 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>
</description>
<value type="default">5000</value>
<value type="default">1000</value>
diff --git a/docs/smbdotconf/logging/syslog.xml b/docs/smbdotconf/logging/syslog.xml
index 1bc6bb79a0..1e968738e4 100644
--- a/docs/smbdotconf/logging/syslog.xml
+++ b/docs/smbdotconf/logging/syslog.xml
@@ -4,17 +4,17 @@
developer="1" advanced="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<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 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>
</description>
<value type="default">1</value>
</samba:parameter>
diff --git a/docs/smbdotconf/logging/syslogonly.xml b/docs/smbdotconf/logging/syslogonly.xml
index 1e6889d37d..e91970c6ff 100644
--- a/docs/smbdotconf/logging/syslogonly.xml
+++ b/docs/smbdotconf/logging/syslogonly.xml
@@ -4,9 +4,10 @@
developer="1" advanced="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<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>
+ <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>