[svn] commit: r1702 - in /trunk/src/bin/xfrin: b10-xfrin.8 b10-xfrin.xml
BIND 10 source code commits
bind10-changes at lists.isc.org
Fri Apr 9 23:45:36 UTC 2010
Author: jreed
Date: Fri Apr 9 23:45:35 2010
New Revision: 1702
Log:
Fix some problems in manpage. Clean up a little and add a little.
Regen man version.
Modified:
trunk/src/bin/xfrin/b10-xfrin.8
trunk/src/bin/xfrin/b10-xfrin.xml
Modified: trunk/src/bin/xfrin/b10-xfrin.8
==============================================================================
--- trunk/src/bin/xfrin/b10-xfrin.8 (original)
+++ trunk/src/bin/xfrin/b10-xfrin.8 Fri Apr 9 23:45:35 2010
@@ -29,9 +29,7 @@
\fBb10\-xfrin\fR
daemon provides the BIND 10 incoming DNS zone transfer service\&. Normally it is started by the
\fBbind10\fR(8)
-master process and communicates with the
-\fBb10-auth\fR(8)
-authoritative DNS server\&.
+boss process\&. When triggered it can request and receive a zone transfer and store the zone in a BIND 10 zone data store\&.
.if n \{\
.sp
.\}
@@ -49,20 +47,36 @@
.sp .5v
.RE
.PP
-This daemon communicates over a
+This daemon communicates with the BIND 10 over a
\fBmsgq\fR(8)
C\-Channel connection\&. If this connection is not established,
\fBb10\-xfrin\fR
will exit\&.
.PP
-It also receives its configurations from
-\fBb10-cfgmgr\fR(8)
-using the REST\-ful interface provided by
-\fBb10-cmdctl\fR(8)\&.
+
+\fBb10\-xfrin\fR
+receives its configurations from
+\fBb10-cfgmgr\fR(8)\&.
+.SH "CONFIGURATION AND COMMANDS"
.PP
-The configurable setting is transfers\-in which defines the maximum number of inbound zone transfers that can run concurrently\&. The default is 10\&.
+The configurable setting is
+\fItransfers\-in\fR
+which defines the maximum number of inbound zone transfers that can run concurrently\&. The default is 10\&.
.PP
-The configuration commands are: print_settings, shutdown, and retransfer (triggers the transfer in for a single zone without checking the zone\'s serial number)\&.
+The configuration commands are:
+.PP
+
+\fBshutdown\fR
+stops all incoming zone transfers and exits
+\fBb10\-xfrin\fR\&. (Note that the BIND 10 boss process will restart this service\&.)
+.PP
+
+\fBretransfer\fR
+triggers the transfer in for a single zone without checking the zone\'s serial number\&. It has the following arguments:
+\fIzone_name\fR
+to define the zone to request and
+\fImaster\fR
+to define the IP address of the authoritative server to transfer from\&.
.if n \{\
.sp
.\}
@@ -82,9 +96,7 @@
.SH "SEE ALSO"
.PP
-\fBb10-auth\fR(8),
\fBb10-cfgmgr\fR(8),
-\fBb10-cmdctl\fR(8),
\fBbind10\fR(8),
\fBmsgq\fR(8),
BIND 10 Guide\&.
Modified: trunk/src/bin/xfrin/b10-xfrin.xml
==============================================================================
--- trunk/src/bin/xfrin/b10-xfrin.xml (original)
+++ trunk/src/bin/xfrin/b10-xfrin.xml Fri Apr 9 23:45:35 2010
@@ -58,38 +58,35 @@
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.
+ boss process.
+ When triggered it can request and receive a zone transfer and store
+ the zone in a BIND 10 zone data store.
</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
+ <para>
+ This daemon communicates with the BIND 10 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.
+<!-- TODO what if connection closes later, will b10-xfrin exit? -->
+ </para>
+
+ <para>
+ <command>b10-xfrin</command> receives its configurations from
+<citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>CONFIGURATION AND COMMANDS</title>
+ <para>
+ The configurable setting is <varname>transfers-in</varname>
+ which defines the maximum number of inbound zone transfers
+ that can run concurrently. The default is 10.
</para>
<!-- TODO: formating -->
@@ -97,25 +94,30 @@
<!-- schedule immediate maintenance for a zone(check soa serial ) -->
<para>
The configuration commands are:
-print_settings,
-shutdown, and
-retransfer (triggers the transfer in for a single zone without checking
-the zone's serial number).
+ </para>
+ <para>
+ <command>shutdown</command> stops all incoming zone transfers
+ and exits <command>b10-xfrin</command>. (Note that the BIND 10
+ boss process will restart this service.)
+ </para>
+ <para>
+ <command>retransfer</command> triggers the transfer in for
+ a single zone without checking the zone's serial number.
+ It has the following arguments: <varname>zone_name</varname>
+ to define the zone to request and <varname>master</varname>
+ to define the IP address of the authoritative server to
+ transfer from.
</para>
-
-<!-- TODO:
-
-retransfer has the following arguments:
-zone_name
+<!-- TODO: later hostname for master? -->
+
+<!-- TODO:
+add a usage example of xfrin -->
+
+<!-- TODO:
+
port (defaults to 53)
-master
db_file (defaults to 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 :
@@ -129,16 +131,6 @@
4. Schedule zone maintenance for all zones.
-->
-
-<!-- TODO: reword -->
-<!-- TODO:
- <para>
- The administrator can send zone transfer-in command to xfrin
- module, or terminate all ongoing incoming transfers by sending
- the <quote>shutdown</quote> command to xfrin module.
- </para>
--->
-<!-- TODO: kills it and bind10 restarts? -->
<note><para>
This prototype version uses SQLite3 as its data source backend.
@@ -183,13 +175,7 @@
<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>
More information about the bind10-changes
mailing list