Browse Source

[2252] update the man page according to b10-xfrout.xml

  - add zone and zonename, and make per-zone counters nested
  - quote _SERVER_
Naoki Kambe 12 years ago
parent
commit
fc40317d31
1 changed files with 93 additions and 70 deletions
  1. 93 70
      src/bin/xfrin/b10-xfrin.xml

+ 93 - 70
src/bin/xfrin/b10-xfrin.xml

@@ -224,81 +224,104 @@ operation
     <variablelist>
 
       <varlistentry>
-        <term>soaoutv4</term>
+        <term>zones</term>
         <listitem><simpara>
-          Number of IPv4 SOA queries sent from Xfrin
-        </simpara></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>soaoutv6</term>
-        <listitem><simpara>
-          Number of IPv6 SOA queries sent from Xfrin
-        </simpara></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>axfrreqv4</term>
-        <listitem><simpara>
-          Number of IPv4 AXFR requests sent from Xfrin
-        </simpara></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>axfrreqv6</term>
-        <listitem><simpara>
-          Number of IPv6 AXFR requests sent from Xfrin
-        </simpara></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>ixfrreqv4</term>
-        <listitem><simpara>
-          Number of IPv4 IXFR requests sent from Xfrin
-        </simpara></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>ixfrreqv6</term>
-        <listitem><simpara>
-          Number of IPv6 IXFR requests sent from Xfrin
-        </simpara></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>xfrsuccess</term>
-        <listitem><simpara>
-          Number of zone transfer requests succeeded
-        </simpara></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>xfrfail</term>
-        <listitem><simpara>
-          Number of zone transfer requests failed
-        </simpara></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>time_to_ixfr</term>
-        <listitem><simpara>
-          Elapsed time in second to do the last IXFR
-        </simpara></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>time_to_axfr</term>
-        <listitem><simpara>
-          Elapsed time in second to do the last AXFR
-        </simpara></listitem>
-      </varlistentry>
+          A directory name of per-zone statistics
+          </simpara>
+          <variablelist>
+
+            <varlistentry>
+              <term><replaceable>zonename</replaceable></term>
+              <listitem><simpara>
+                A actual zone name or special zone name <quote>_SERVER_</quote>
+                representing an entire server
+                </simpara>
+                <variablelist>
+
+                  <varlistentry>
+                    <term>soaoutv4</term>
+                    <listitem><simpara>
+                      Number of IPv4 SOA queries sent from Xfrin
+                    </simpara></listitem>
+                  </varlistentry>
+
+                  <varlistentry>
+                    <term>soaoutv6</term>
+                    <listitem><simpara>
+                      Number of IPv6 SOA queries sent from Xfrin
+                    </simpara></listitem>
+                  </varlistentry>
+
+                  <varlistentry>
+                    <term>axfrreqv4</term>
+                    <listitem><simpara>
+                      Number of IPv4 AXFR requests sent from Xfrin
+                    </simpara></listitem>
+                  </varlistentry>
+
+                  <varlistentry>
+                    <term>axfrreqv6</term>
+                    <listitem><simpara>
+                      Number of IPv6 AXFR requests sent from Xfrin
+                    </simpara></listitem>
+                  </varlistentry>
+
+                  <varlistentry>
+                    <term>ixfrreqv4</term>
+                    <listitem><simpara>
+                      Number of IPv4 IXFR requests sent from Xfrin
+                    </simpara></listitem>
+                  </varlistentry>
+
+                  <varlistentry>
+                    <term>ixfrreqv6</term>
+                    <listitem><simpara>
+                      Number of IPv6 IXFR requests sent from Xfrin
+                    </simpara></listitem>
+                  </varlistentry>
+
+                  <varlistentry>
+                    <term>xfrsuccess</term>
+                    <listitem><simpara>
+                      Number of zone transfer requests succeeded
+                    </simpara></listitem>
+                  </varlistentry>
+
+                  <varlistentry>
+                    <term>xfrfail</term>
+                    <listitem><simpara>
+                      Number of zone transfer requests failed
+                    </simpara></listitem>
+                  </varlistentry>
+
+                  <varlistentry>
+                    <term>time_to_ixfr</term>
+                    <listitem><simpara>
+                      Elapsed time in second to do the last IXFR
+                    </simpara></listitem>
+                  </varlistentry>
+
+                  <varlistentry>
+                    <term>time_to_axfr</term>
+                    <listitem><simpara>
+                      Elapsed time in second to do the last AXFR
+                    </simpara></listitem>
+                  </varlistentry>
+
+                </variablelist>
+              </listitem>
+            </varlistentry><!-- end of zonename -->
+
+          </variablelist>
+        </listitem>
+      </varlistentry><!-- end of zones -->
 
     </variablelist>
 
     <para>
-      In per-zone counters the special zone name '_SERVER_' exists. It doesn't
-      mean a specific zone. It represents an entire server and its value means
-      a total count of all zones.
+      In per-zone counters the special zone name <quote>_SERVER_</quote> exists.
+      It doesn't mean a specific zone. It represents an entire server and its
+      value means a total count of all zones.
     </para>
 
   </refsect1>