BIND 10 trac1011, updated. 9351dbcc88ccdd6aa83d72f432f19a76c031124b [1011] little more docbook formatting
BIND 10 source code commits
bind10-changes at lists.isc.org
Mon Aug 8 15:14:19 UTC 2011
The branch, trac1011 has been updated
via 9351dbcc88ccdd6aa83d72f432f19a76c031124b (commit)
via 16e52275c4c9e355cf4e448a5b17136f24324d7a (commit)
via 61029d971895738ba353841d99f4ca07ecf792b7 (commit)
via 1c8043e5b50bd47d7734397a08d5015e3672b9ad (commit)
via 9819295a58b8b40ca6d95c84f1f1de08fb0eb707 (commit)
via dc3b856b460ff380feb68cdff551f334e6db5a27 (commit)
from 87a4f24037965ae88435ebe3f887750c500cbfde (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 9351dbcc88ccdd6aa83d72f432f19a76c031124b
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Mon Aug 8 10:14:06 2011 -0500
[1011] little more docbook formatting
commit 16e52275c4c9e355cf4e448a5b17136f24324d7a
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Mon Aug 1 16:56:57 2011 -0500
[trac1011] some docbook formatting for new content
This needs to be indented correctly still.
commit 61029d971895738ba353841d99f4ca07ecf792b7
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Mon Aug 1 16:31:32 2011 -0500
[trac1011] fix typo
commit 1c8043e5b50bd47d7734397a08d5015e3672b9ad
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Mon Aug 1 13:43:15 2011 -0500
[trac1011] fix my typo
commit 9819295a58b8b40ca6d95c84f1f1de08fb0eb707
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Mon Aug 1 13:42:26 2011 -0500
[trac1011] reformat some docbook
(no change to final result)
commit dc3b856b460ff380feb68cdff551f334e6db5a27
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Mon Aug 1 13:41:04 2011 -0500
[trac1011] add section title to logging message format section
also removed some tabs and spaces at end of lines
-----------------------------------------------------------------------
Summary of changes:
doc/guide/bind10-guide.xml | 370 +++++++++++++++++++++++---------------------
1 files changed, 196 insertions(+), 174 deletions(-)
-----------------------------------------------------------------------
diff --git a/doc/guide/bind10-guide.xml b/doc/guide/bind10-guide.xml
index 309c35d..5c8840b 100644
--- a/doc/guide/bind10-guide.xml
+++ b/doc/guide/bind10-guide.xml
@@ -146,7 +146,7 @@
The processes started by the <command>bind10</command>
command have names starting with "b10-", including:
</para>
-
+
<para>
<itemizedlist>
@@ -547,7 +547,7 @@ Debian and Ubuntu:
<varlistentry>
<term>--prefix</term>
<listitem>
- <simpara>Define the the installation location (the
+ <simpara>Define the installation location (the
default is <filename>/usr/local/</filename>).
</simpara>
</listitem>
@@ -1472,60 +1472,64 @@ then change those defaults with config set Resolver/forward_addresses[0]/address
<!-- TODO: how to configure logging, logging destinations etc. -->
- <para>
- Each message written by BIND 10 to the configured logging destinations
- comprises a number of components that identify the origin of the
- message and, if the message indicates a problem, information about the
- problem that may be useful in fixing it.
- </para>
+ <section>
+ <title>Logging Message Format</title>
- <para>
- Consider the message below logged to a file:
- <screen>2011-06-15 13:48:22.034 ERROR [b10-resolver.asiolink]
+ <para>
+ Each message written by BIND 10 to the configured logging
+ destinations comprises a number of components that identify
+ the origin of the message and, if the message indicates
+ a problem, information about the problem that may be
+ useful in fixing it.
+ </para>
+
+ <para>
+ Consider the message below logged to a file:
+ <screen>2011-06-15 13:48:22.034 ERROR [b10-resolver.asiolink]
ASIODNS_OPENSOCK error 111 opening TCP socket to 127.0.0.1(53)</screen>
- </para>
+ </para>
- <para>
- Note: the layout of messages written to the system logging
- file (syslog) may be slightly different. This message has
- been split across two lines here for display reasons; in the
- logging file, it will appear on one line.)
- </para>
+ <para>
+ Note: the layout of messages written to the system logging
+ file (syslog) may be slightly different. This message has
+ been split across two lines here for display reasons; in the
+ logging file, it will appear on one line.)
+ </para>
- <para>
- The log message comprises a number of components:
+ <para>
+ The log message comprises a number of components:
- <variablelist>
- <varlistentry>
- <term>2011-06-15 13:48:22.034</term>
+ <variablelist>
+ <varlistentry>
+ <term>2011-06-15 13:48:22.034</term>
<!-- TODO: timestamp repeated even if using syslog? -->
- <listitem><para>
- The date and time at which the message was generated.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>ERROR</term>
- <listitem><para>
- The severity of the message.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>[b10-resolver.asiolink]</term>
- <listitem><para>
- The source of the message. This comprises two components:
- the BIND 10 process generating the message (in this
- case, <command>b10-resolver</command>) and the module
- within the program from which the message originated
- (which in the example is the asynchronous I/O link
- module, asiolink).
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>ASIODNS_OPENSOCK</term>
- <listitem><para>
+ <listitem><para>
+ The date and time at which the message was generated.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>ERROR</term>
+ <listitem><para>
+ The severity of the message.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>[b10-resolver.asiolink]</term>
+ <listitem><para>
+ The source of the message. This comprises two components:
+ the BIND 10 process generating the message (in this
+ case, <command>b10-resolver</command>) and the module
+ within the program from which the message originated
+ (which in the example is the asynchronous I/O link
+ module, asiolink).
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>ASIODNS_OPENSOCK</term>
+ <listitem><para>
The message identification. Every message in BIND 10
has a unique identification, which can be used as an
index into the <ulink
@@ -1533,24 +1537,28 @@ then change those defaults with config set Resolver/forward_addresses[0]/address
Manual</citetitle></ulink> (<ulink
url="http://bind10.isc.org/docs/bind10-messages.html"
/>) from which more information can be obtained.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>error 111 opening TCP socket to 127.0.0.1(53)</term>
- <listitem><para>
- A brief description of the cause of the problem. Within this text,
- information relating to the condition that caused the message to
- be logged will be included. In this example, error number 111
- (an operating system-specific error number) was encountered when
- trying to open a TCP connection to port 53 on the local system
- (address 127.0.0.1). The next step would be to find out the reason
- for the failure by consulting your system's documentation to
- identify what error number 111 means.
- </para></listitem>
- </varlistentry>
- </variablelist>
- </para>
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>error 111 opening TCP socket to 127.0.0.1(53)</term>
+ <listitem><para>
+ A brief description of the cause of the problem.
+ Within this text, information relating to the condition
+ that caused the message to be logged will be included.
+ In this example, error number 111 (an operating
+ system-specific error number) was encountered when
+ trying to open a TCP connection to port 53 on the
+ local system (address 127.0.0.1). The next step
+ would be to find out the reason for the failure by
+ consulting your system's documentation to identify
+ what error number 111 means.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ </section>
<section>
<title>Logging configuration</title>
@@ -1595,25 +1603,20 @@ then change those defaults with config set Resolver/forward_addresses[0]/address
</para>
- <para>
-
-name (string)
-
- </para>
-
- <para>
+ <section>
+ <title>name (string)</title>
+ <para>
Each logger in the system has a name, the name being that
of the component using it to log messages. For instance,
if you want to configure logging for the resolver module,
you add an entry for a logger named 'Resolver'. This
configuration will then be used by the loggers in the
Resolver module, and all the libraries used by it.
+ </para>
<!-- TODO: how to know these names? -->
- </para>
-
<para>
If you want to specify logging for one specific library
@@ -1683,11 +1686,10 @@ name (string)
</para>
- <para>
+ </section>
-severity (string)
-
- </para>
+ <section>
+ <title>severity (string)</title>
<para>
@@ -1700,14 +1702,29 @@ severity (string)
Each message is logged with an associated severity which
may be one of the following (in descending order of
severity):
+ </para>
- FATAL
- ERROR
- WARN
- INFO
- DEBUG
+ <itemizedlist>
+ <listitem>
+ <simpara> FATAL </simpara>
+ </listitem>
- </para>
+ <listitem>
+ <simpara> ERROR </simpara>
+ </listitem>
+
+ <listitem>
+ <simpara> WARN </simpara>
+ </listitem>
+
+ <listitem>
+ <simpara> INFO </simpara>
+ </listitem>
+
+ <listitem>
+ <simpara> DEBUG </simpara>
+ </listitem>
+ </itemizedlist>
<para>
@@ -1721,11 +1738,10 @@ severity (string)
</para>
- <para>
+ </section>
-output_options (list)
-
- </para>
+ <section>
+ <title>output_options (list)</title>
<para>
@@ -1741,11 +1757,10 @@ output_options (list)
</para>
- <para>
-
-debuglevel (integer)
+ </section>
- </para>
+ <section>
+ <title>debuglevel (integer)</title>
<para>
@@ -1766,11 +1781,10 @@ debuglevel (integer)
</para>
- <para>
+ </section>
-additive (true or false)
-
- </para>
+ <section>
+ <title>additive (true or false)</title>
<para>
@@ -1788,6 +1802,8 @@ additive (true or false)
</section>
+ </section>
+
<section>
<title>Output Options</title>
@@ -1799,31 +1815,35 @@ additive (true or false)
</para>
- <para>
+ <section>
+ <title>destination (string)</title>
-destination (string)
-
- </para>
+ <para>
- <para>
+ The destination is the type of output. It can be one of:
- The destination is the type of output. It can be one of:
+ </para>
- </para>
+ <itemizedlist>
- <para>
+ <listitem>
+ <simpara> console </simpara>
+ </listitem>
- * console
- * file
- * syslog
+ <listitem>
+ <simpara> file </simpara>
+ </listitem>
- </para>
+ <listitem>
+ <simpara> syslog </simpara>
+ </listitem>
- <para>
+ </itemizedlist>
-output (string)
+ </section>
- </para>
+ <section>
+ <title>output (string)</title>
<para>
@@ -1832,30 +1852,41 @@ output (string)
</para>
- <para>
-
- * destination is 'console'
-
- 'output' must be one of 'stdout' (messages printed to standard output) or 'stderr' (messages printed to standard error).
-
- </para>
-
- <para>
-
- * destination is 'file'
-
- The value of output is interpreted as a file name; log messages will be appended to this file.
-
-
- </para>
+ <variablelist>
- <para>
+ <varlistentry>
+ <term>destination is 'console'</term>
+ <listitem>
+ <simpara>
+ The value of output must be one of 'stdout'
+ (messages printed to standard output) or 'stderr'
+ (messages printed to standard error).
+ </simpara>
+ </listitem>
+ </varlistentry>
- * destination is 'syslog'
+ <varlistentry>
+ <term>destination is 'file'</term>
+ <listitem>
+ <simpara>
+ The value of output is interpreted as a file name;
+ log messages will be appended to this file.
+ </simpara>
+ </listitem>
+ </varlistentry>
- The value of output is interpreted as the syslog facility (e.g. 'local0') that should be used for log messages.
+ <varlistentry>
+ <term>destination is 'syslog'</term>
+ <listitem>
+ <simpara>
+ The value of output is interpreted as the syslog
+ facility (e.g. 'local0') that should be used for
+ log messages.
+ </simpara>
+ </listitem>
+ </varlistentry>
- </para>
+ </variablelist>
<para>
@@ -1863,56 +1894,47 @@ output (string)
</para>
- <para>
+ <section>
+ <title>flush (true of false)</title>
-flush (true of false)
-
- </para>
-
- <para>
-
- Flush buffers after each log message. Doing this will
- reduce performance but will ensure that if the program
- terminates abnormally, all messages up to the point of
- termination are output.
-
- </para>
-
- <para>
-
-maxsize (integer)
-
- </para>
-
- <para>
-
- Only relevant when destination is file, this is maximum
- file size of output files in bytes. When the maximum size
- is reached, the file is renamed (a ".1" is appended to
- the name - if a ".1" file exists, it is renamed ".2"
- etc.) and a new file opened.
-
- </para>
+ <para>
+ Flush buffers after each log message. Doing this will
+ reduce performance but will ensure that if the program
+ terminates abnormally, all messages up to the point of
+ termination are output.
+ </para>
- <para>
+ </section>
- If this is 0, no maximum file size is used.
+ <section>
+ <title>maxsize (integer)</title>
- </para>
+ <para>
+ Only relevant when destination is file, this is maximum
+ file size of output files in bytes. When the maximum
+ size is reached, the file is renamed (a ".1" is appended
+ to the name - if a ".1" file exists, it is renamed ".2"
+ etc.) and a new file opened.
+ </para>
- <para>
+ <para>
+ If this is 0, no maximum file size is used.
+ </para>
-maxver (integer)
+ </section>
- </para>
+ <section>
+ <title>maxver (integer)</title>
- <para>
+ <para>
+ Maximum number of old log files to keep around when
+ rolling the output file. Only relevant when destination
+ if 'file'.
+ </para>
- Maximum number of old log files to keep around when
- rolling the output file. Only relevant when destination
- if 'file'.
+ </section>
- </para>
+ </section>
</section>
More information about the bind10-changes
mailing list