updated the documentation on the statistics file format and moved it

to a less conspicuous place

diff --git a/doc/arm/Bv9ARM-book.xml b/doc/arm/Bv9ARM-book.xml
index c148b6f1c0a2065e6dd71b3e765b7d49a6f6cd1c..7c9c25781721346dab245ed1ba14b2e1b283adf1 100644 (file)
--- a/doc/arm/Bv9ARM-book.xml
+++ b/doc/arm/Bv9ARM-book.xml
@@ -2,7 +2,7 @@
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
                "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd">
 
-<!-- File: $Id: Bv9ARM-book.xml,v 1.60 2000/12/01 21:37:15 gson Exp $ -->
+<!-- File: $Id: Bv9ARM-book.xml,v 1.61 2000/12/02 00:14:23 gson Exp $ -->
 
 <book>
 
@@ -2592,7 +2592,10 @@ nameserver.</para></entry>
 <row rowsep = "0">
 <entry colname = "1"><para><command>statistics-file</command></para></entry>
 <entry colname = "2"><para>The pathname of the file the server appends statistics
-to. If not specified, the default is <filename>named.stats</filename>.</para></entry>
+to when instructed to do so using <command>rndc stats</command>.
+If not specified, the default is <filename>named.stats</filename> in the
+server's current directory.  The format of the file is described
+in <xref linkend="statsfile"/></para></entry>
 </row>
 <row rowsep = "0">
 <entry colname = "1"><para><command>port</command></para></entry>
@@ -2761,7 +2764,7 @@ answers. The default is <userinput>no</userinput>.</para>
 <entry colname = "2"><para>If <userinput>yes</userinput>, the server will, by default, collect
 statistical data on all zones in the server.  These statistics may be accessed
 using <command>rndc stats</command>, which will dump them to the file listed
-in the <command>statistics-file</command> option listed above.</para></entry>
+in the <command>statistics-file</command>.  See also <xref linkend="statsfile"/>.</para></entry>
 </row>
 <row rowsep = "0">
 <entry colname = "1"><para><command>treat-cr-as-space</command></para></entry>
@@ -3199,7 +3202,7 @@ that have gone away will be cleaned up.</para></entry>
 <entry colname = "2"><para>Nameserver statistics will be logged
 every <command>statistics-interval</command> minutes. The default is 
 60. If set to 0, no statistics will be logged.</para><note>
-                    <simpara>Not yet implemented in <acronym>BIND</acronym>9.</simpara></note></entry>
+<simpara>Not yet implemented in <acronym>BIND</acronym>9.</simpara></note></entry>
 </row>
 </tbody>
 </tgroup></informaltable></sect3>
@@ -3422,7 +3425,7 @@ to allow for a limited amount of clock skew.</para></entry>
 </row>
 </tbody>
 </tgroup></informaltable></sect3>
-      <sect3>
+<sect3>
         <title>Deprecated Features</title>
 
         <para><command>use-ixfr</command> is deprecated in <acronym>BIND</acronym> 9. If
@@ -3431,8 +3434,69 @@ to allow for a limited amount of clock skew.</para></entry>
         in <xref
         linkend="server_statement_definition_and_usage"/>. See also
         <xref linkend="incremental_zone_transfers"/>.</para>
+</sect3>
+
+<sect3 id="statsfile">
+        <title>The Statistics File</title>
+
+<para>The statistics file generated by <acronym>BIND</acronym> 9
+is similar, but not identical, to that
+generated by <acronym>BIND</acronym> 8.
+</para>
+<para>The statistics dump begins with the line <command>+++ Statistics Dump
++++ (973798949)</command>, where the number in parentheses is a standard
+Unix-style timestamp, measured as seconds since January 1, 1970.  Following
+that line are a series of lines containing a counter type, the value of the
+counter, optionally a zone name, and optionally a view name.
+The lines without view and zone listed are global statistics for the entire server.
+Lines with a zone and view name for the given view and zone (the view name is
+omitted for the default view).  The statistics dump ends
+with the line <command>--- Statistics Dump --- (973798949)</command>, where the
+number is identical to the number in the beginning line.</para>
+<para>The following statistics counters are maintained:</para>
+<informaltable
+    colsep = "0" rowsep = "0"><tgroup cols = "2"
+    colsep = "0" rowsep = "0" tgroupstyle = "4Level-table">
+<colspec colname = "1" colnum = "1" colsep = "0" colwidth = "1.150in"/>
+<colspec colname = "2" colnum = "2" colsep = "0" colwidth = "3.350in"/>
+<tbody>
+<row rowsep = "0">
+<entry colname = "1"><para><command>success</command></para></entry>
+<entry colname = "2"><para>The number of
+successful queries made to the server or zone.  A successful query
+is defined as query which returns a NOERROR response other than
+a referral response.</para></entry>
+</row>
+<row rowsep = "0">
+<entry colname = "1"><para><command>referral</command></para></entry>
+<entry colname = "2"><para>The number of queries which resulted
+in referral responses.</para></entry>
+</row>
+<row rowsep = "0">
+<entry colname = "1"><para><command>nxrrset</command></para></entry>
+<entry colname = "2"><para>The number of queries which resulted in
+NOERROR responses with no data.</para></entry>
+</row>
+<row rowsep = "0">
+<entry colname = "1"><para><command>nxdomain</command></para></entry>
+<entry colname = "2"><para>The number
+of queries which resulted in NXDOMAIN responses.</para></entry>
+</row>
+<row rowsep = "0">
+<entry colname = "1"><para><command>recursion</command></para></entry>
+<entry colname = "2"><para>The number of queries which caused the server
+to perform recursion in order to find the final answer.</para></entry>
+</row
+><row rowsep = "0">
+<entry colname = "1"><para><command>failure</command></para></entry>
+<entry colname = "2"><para>The number of queries which resulted in a
+failure response other than those above.</para></entry>
+</row>
+</tbody>
+</tgroup></informaltable>
+</sect3>
 
-</sect3></sect2>
+</sect2>
     <sect2 id="server_statement_grammar">
       <title><command>server</command>
 Statement Grammar</title>
@@ -3754,7 +3818,7 @@ master server, not the slaves.</para>
 
 <para>Note that enabling the update forwarding feature on a slave server
 may expose master servers relying on insecure IP address based
-access control to attacks; see <xref linkend="dynamic_update_security">
+access control to attacks; see <xref linkend="dynamic_update_security"/>
 for more details.</para>
 </entry>
               </row>
@@ -4616,7 +4680,7 @@ the <command>touch</command> utility (to change file access and
 modification times) or the <command>chown</command> utility (to
 set the user id and/or group id) on files to which you want <acronym>BIND</acronym>
 to write.</para></sect2></sect1>
-<sect1 id="dynamic_update_security"><title>Dynamic Updates</title> 
+<sect1 id="dynamic_update_security"><title>Dynamic Update Security</title> 
 <para>Access to the dynamic
 update facility should be strictly limited.  In earlier versions of
 <acronym>BIND</acronym> the only way to do this was based on the IP
@@ -5530,66 +5594,7 @@ after which they are deleted unless updated by their authors.
       </bibliography>
     </sect2>
   </sect1>
-  <sect1 id="statsfile">
-    <title>Format of statistics file</title>
-<para>The statistics file generated by <acronym>BIND</acronym> 9
-is similar in form to that
-generated by <acronym>BIND</acronym> 8, but is not identical, 
-due to differences in the counters
-currently implemented in <acronym>BIND</acronym> 9.
-</para>
-<para>The statistics dump begins with the line <command>+++ Statistics Dump
-+++ (973798949)</command>, where the number in parentheses is a standard
-Unix-style timestamp, measured as seconds since January 1, 1970.  Following
-that line are a series of lines containing a counter type, value of the
-counter, and possibly a view/zone pair.  The lines without view and zone
-listed are global counters for the entire server and the lines with view and
-zones specified are for the given view and zone.  The statistics dump ends
-with the line <command>--- Statistics Dump --- (973798949)</command>, where the
-number is identical to the number in the beginning line.</para>
-<para>The following counters are defined:</para>
-<informaltable
-    colsep = "0" rowsep = "0"><tgroup cols = "2"
-    colsep = "0" rowsep = "0" tgroupstyle = "4Level-table">
-<colspec colname = "1" colnum = "1" colsep = "0" colwidth = "1.150in"/>
-<colspec colname = "2" colnum = "2" colsep = "0" colwidth = "3.350in"/>
-<tbody>
-<row rowsep = "0">
-<entry colname = "1"><para><command>success</command></para></entry>
-<entry colname = "2"><para>This counter is used to track the number of
-successful queries made to the server or zone.  A successful query
-is defined as query which returns a NOERROR result other than
-delegation replies.</para></entry>
-</row>
-<row rowsep = "0">
-<entry colname = "1"><para><command>delegation</command></para></entry>
-<entry colname = "2"><para>This counter is used to track the number
-of queries which return delegations instead a final answer.</para></entry>
-</row>
-<row rowsep = "0">
-<entry colname = "1"><para><command>nxrrset</command></para></entry>
-<entry colname = "2"><para>This counter is used to track the number
-of queries made which return a result code of NXRRSET.</para></entry>
-</row>
-<row rowsep = "0">
-<entry colname = "1"><para><command>nxdomain</command></para></entry>
-<entry colname = "2"><para>This counter is used to track the number
-of queries made which return a result code of NXDOMAIN.</para></entry>
-</row>
-<row rowsep = "0">
-<entry colname = "1"><para><command>recursion</command></para></entry>
-<entry colname = "2"><para>This counter is used to track the number
-of queries made which resulted in recursion in order to find the final
-answer.</para></entry>
-</row
-><row rowsep = "0">
-<entry colname = "1"><para><command>failure</command></para></entry>
-<entry colname = "2"><para>This counter is used to track the number
-of queries resulted in a SERVFAIL reply.</para></entry>
-</row>
-</tbody>
-</tgroup></informaltable>
-</sect1>
+
 </appendix>
 
 </book>