Browse Source

[2884] update man docs

to add classname
Naoki Kambe 12 years ago
parent
commit
e9ac9994ee
2 changed files with 133 additions and 112 deletions
  1. 92 83
      src/bin/xfrin/b10-xfrin.xml
  2. 41 29
      src/bin/xfrout/b10-xfrout.xml

+ 92 - 83
src/bin/xfrin/b10-xfrin.xml

@@ -231,98 +231,107 @@ operation
           <variablelist>
 
             <varlistentry>
-              <term><replaceable>zonename</replaceable></term>
+              <term><replaceable>classname</replaceable></term>
               <listitem><simpara>
-                An actual zone name or special zone name
-                <quote>_SERVER_</quote> representing the entire server.
-                Zone classes (e.g. IN, CH, and HS) are mixed and counted so
-                far. But these will be distinguished in future release.
+                An actual class name of the zone, e.g. IN, CH, and HS
                 </simpara>
                 <variablelist>
 
                   <varlistentry>
-                    <term>soaoutv4</term>
+                    <term><replaceable>zonename</replaceable></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.
-                      These include the case where the zone turns
-                      out to be the latest as a result of an
-                      initial SOA query (and there is actually no
-                      AXFR or IXFR transaction).
-                    </simpara></listitem>
-                  </varlistentry>
-
-                  <varlistentry>
-                    <term>xfrfail</term>
-                    <listitem><simpara>
-                      Number of zone transfer requests failed
-                    </simpara></listitem>
-                  </varlistentry>
-
-                  <varlistentry>
-                    <term>last_axfr_duration</term>
-                    <listitem><simpara>
-                      Duration in seconds of the last successful AXFR.  0.0
-                      means no successful AXFR done or means a successful AXFR
-                      done in less than a microsecond.  If an AXFR is aborted
-                      due to some failure, this duration won't be updated.
-                    </simpara></listitem>
-                  </varlistentry>
-
-                  <varlistentry>
-                    <term>last_ixfr_duration</term>
-                    <listitem><simpara>
-                      Duration in seconds of the last successful IXFR.  0.0
-                      means no successful IXFR done or means a successful IXFR
-                      done in less than a microsecond.  If an IXFR is aborted
-                      due to some failure, this duration won't be updated.
-                    </simpara></listitem>
-                  </varlistentry>
+                      An actual zone name or special zone name
+                      <quote>_SERVER_</quote> representing the 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.
+                            These include the case where the zone turns
+                            out to be the latest as a result of an
+                            initial SOA query (and there is actually no
+                            AXFR or IXFR transaction).
+                          </simpara></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                          <term>xfrfail</term>
+                          <listitem><simpara>
+                            Number of zone transfer requests failed
+                          </simpara></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                          <term>last_axfr_duration</term>
+                          <listitem><simpara>
+                            Duration in seconds of the last successful AXFR.  0.0
+                            means no successful AXFR done or means a successful AXFR
+                            done in less than a microsecond.  If an AXFR is aborted
+                            due to some failure, this duration won't be updated.
+                          </simpara></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                          <term>last_ixfr_duration</term>
+                          <listitem><simpara>
+                            Duration in seconds of the last successful IXFR.  0.0
+                            means no successful IXFR done or means a successful IXFR
+                            done in less than a microsecond.  If an IXFR is aborted
+                            due to some failure, this duration won't be updated.
+                          </simpara></listitem>
+                        </varlistentry>
+
+                      </variablelist>
+                    </listitem>
+                  </varlistentry><!-- end of zonename -->
 
                 </variablelist>
               </listitem>
-            </varlistentry><!-- end of zonename -->
+            </varlistentry><!-- end of classname -->
 
           </variablelist>
         </listitem>

+ 41 - 29
src/bin/xfrout/b10-xfrout.xml

@@ -171,44 +171,56 @@
           <variablelist>
 
             <varlistentry>
-              <term><replaceable>zonename</replaceable></term>
+              <term><replaceable>classname</replaceable></term>
               <listitem><simpara>
-                A actual zone name or special zone name <quote>_SERVER_</quote>
-                representing an entire server
+                An actual class name of the zone, e.g. IN, CH, and HS
                 </simpara>
                 <variablelist>
 
                   <varlistentry>
-                    <term>notifyoutv4</term>
+                    <term><replaceable>zonename</replaceable></term>
                     <listitem><simpara>
-                      Number of IPv4 notifies per zone name sent out from Xfrout
-                    </simpara></listitem>
-                  </varlistentry>
-
-                  <varlistentry>
-                    <term>notifyoutv6</term>
-                    <listitem><simpara>
-                      Number of IPv6 notifies per zone name sent out from Xfrout
-                    </simpara></listitem>
-                  </varlistentry>
-
-                  <varlistentry>
-                    <term>xfrrej</term>
-                    <listitem><simpara>
-                      Number of XFR requests per zone name rejected by Xfrout
-                    </simpara></listitem>
-                  </varlistentry>
-
-                  <varlistentry>
-                    <term>xfrreqdone</term>
-                    <listitem><simpara>
-                      Number of requested zone transfers per zone name completed
-                    </simpara></listitem>
-                  </varlistentry>
+                      An actual zone name or special zone
+                      name <quote>_SERVER_</quote> representing an entire
+                      server
+                      </simpara>
+                      <variablelist>
+
+                        <varlistentry>
+                          <term>notifyoutv4</term>
+                          <listitem><simpara>
+                            Number of IPv4 notifies per zone name sent out from Xfrout
+                          </simpara></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                          <term>notifyoutv6</term>
+                          <listitem><simpara>
+                            Number of IPv6 notifies per zone name sent out from Xfrout
+                          </simpara></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                          <term>xfrrej</term>
+                          <listitem><simpara>
+                            Number of XFR requests per zone name rejected by Xfrout
+                          </simpara></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                          <term>xfrreqdone</term>
+                          <listitem><simpara>
+                            Number of requested zone transfers per zone name completed
+                          </simpara></listitem>
+                        </varlistentry>
+
+                      </variablelist>
+                    </listitem>
+                  </varlistentry><!-- end of zonename -->
 
                 </variablelist>
               </listitem>
-            </varlistentry><!-- end of zonename -->
+            </varlistentry><!-- end of classname -->
 
           </variablelist>
         </listitem>