Browse Source

[trac1011] add section title to logging message format section

also removed some tabs and spaces at end of lines
Jeremy C. Reed 13 years ago
parent
commit
dc3b856b46
1 changed files with 72 additions and 67 deletions
  1. 72 67
      doc/guide/bind10-guide.xml

+ 72 - 67
doc/guide/bind10-guide.xml

@@ -146,7 +146,7 @@
 	The processes started by the <command>bind10</command>
 	The processes started by the <command>bind10</command>
 	command have names starting with "b10-", including:
 	command have names starting with "b10-", including:
       </para>
       </para>
-      
+
       <para>
       <para>
 
 
         <itemizedlist>
         <itemizedlist>
@@ -1472,60 +1472,63 @@ then change those defaults with config set Resolver/forward_addresses[0]/address
 
 
 <!-- TODO: how to configure logging, logging destinations etc. -->
 <!-- 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 Formatn</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>
     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? -->
 <!-- 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
 	    The message identification.  Every message in BIND 10
 	    has a unique identification, which can be used as an
 	    has a unique identification, which can be used as an
 	    index into the <ulink
 	    index into the <ulink
@@ -1533,24 +1536,26 @@ then change those defaults with config set Resolver/forward_addresses[0]/address
 	    Manual</citetitle></ulink> (<ulink
 	    Manual</citetitle></ulink> (<ulink
 	    url="http://bind10.isc.org/docs/bind10-messages.html"
 	    url="http://bind10.isc.org/docs/bind10-messages.html"
 	    />) from which more information can be obtained.
 	    />) 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>
     <section>
       <title>Logging configuration</title>
       <title>Logging configuration</title>