Start of xfrin manual (in docbook format). This needs lots of work.

git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@1498 e5f2f494-b856-4b98-b285-d166d9295462

src/bin/xfrin/b10-xfrin.xml

@@ -0,0 +1,210 @@
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
+	       [<!ENTITY mdash "&#8212;">]>
+<!--
+ - Copyright (C) 2010  Internet Systems Consortium, Inc. ("ISC")
+ -
+ - Permission to use, copy, modify, and/or distribute this software for any
+ - purpose with or without fee is hereby granted, provided that the above
+ - copyright notice and this permission notice appear in all copies.
+ -
+ - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+ - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+ - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+ - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ - PERFORMANCE OF THIS SOFTWARE.
+-->
+
+<!-- $Id$ -->
+<refentry>
+
+  <refentryinfo>
+    <date>March 17, 2010</date>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>b10-xfrin</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo>BIND10</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>b10-xfrin</refname>
+    <refpurpose>Incoming DNS zone transfer service</refpurpose>
+  </refnamediv>
+
+  <docinfo>
+    <copyright>
+      <year>2010</year>
+      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
+    </copyright>
+  </docinfo>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>b10-xfrin</command>
+<!--
+      <arg><option>-p <replaceable>number</replaceable></option></arg>
+      <arg><option>-v</option></arg>
+-->
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para>The <command>b10-xfrin</command> daemon provides the BIND 10
+      incoming DNS zone transfer service.
+      Normally it is started by the
+      <citerefentry><refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+      master process
+      and communicates with the
+      <citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+      authoritative DNS server.
+    </para>
+
+    <note><simpara>
+      The Y1 prototype release only supports AXFR. IXFR is not implemented.
+    </simpara></note>
+
+<!-- TODO:
+add a usage example of xfrin -->
+
+    <para>
+      This daemon communicates over a
+      <citerefentry><refentrytitle>msgq</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+      C-Channel connection.  If this connection is not established,
+      <command>b10-xfrin</command> will exit.
+<!-- TODO what if connection closes later, will b10-auth exit? -->
+    </para>
+
+    <para>
+     It also receives its configurations from
+<citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+      using the REST-ful interface provided by
+      <citerefentry><refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+    </para>
+
+    <para>
+      The configurable setting is transfers-in which defines
+      the maximum number of inbound zone transfers that can run
+      concurrently. The default is 10.
+    </para>
+
+    <para>
+      The configuration commands are:
+
+print_message
+print_settings
+shutdown
+<!-- TODO: refresh is code but not in spec -->
+<!-- schedule immediate maintenance for a zone(check soa serial ) -->
+
+retransfer triggers the transfer in for a single zone without checking
+the zone's serial number.
+retransfer has the following arguments:
+zone_name
+port (defaults to 53)
+master
+db_file (defaults to /tmp/zone.sqlite3 <!-- TODO: fix this -->
+
+
+<!--
+If the admin want to get the latest zone data from master, he can send the
+command "retransfer to xfrin."
+-->
+<!-- TODO:
+
+ later it will can be triggered by :
+1.  Notify message from auth server.
+2.  Schedule zone transfer (determined by Refresh/Expire time in SOA record)
+
+> - what is planned to add to or change for xfrin?
+1.  Support IXFR.
+2.  Add command "refresh"
+3.  Process zone NOTIFY message.
+4.  Schedule zone maintenance for all zones.
+
+-->
+
+<!-- TODO: reword -->
+      The administrator can send zone transfer-in command to xfrin
+      module, or terminate all going transfer in by sending shutdown
+      command to xfrin module.
+
+    </para>
+
+    <note><para>
+      This prototype version uses SQLite3 as its data source backend.
+      Future versions will be configurable, supporting multiple
+      data storage types.
+    </para></note>
+
+<!-- TODO:
+ it can handle more than one XFR in now, 
+but the problem is If SQLITE3 datasource part support multiple write
+operation
+-->
+
+  </refsect1>
+
+<!--
+  <refsect1>
+    <title>OPTIONS</title>
+
+    <para>The arguments are as follows:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option></option></term>
+        <listitem><para>
+        </para></listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+-->
+<!--
+  <refsect1>
+    <title>FILES</title>
+    <para>
+    </para>
+  </refsect1>
+-->
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>msgq</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citetitle>BIND 10 User Guide</citetitle>.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>HISTORY</title>
+    <para>
+      The <command>b10-xfrin</command> daemon was implemented in March 2010
+      by Zhang Likun of CNNIC for the ISC BIND 10 project.
+    </para>
+  </refsect1>
+</refentry><!--
+ - Local variables:
+ - mode: sgml
+ - End:
+-->