Commit 1b44409d authored by Jeremy C. Reed's avatar Jeremy C. Reed
Browse files

Update manual for auth and add some details on configurable settings.

Document configuration settings and commands for b10-auth.
Some man page cleanup.
Still more work to do here.

Also regen man page from xml.
parent 64e656b8
......@@ -2,12 +2,12 @@
.\" Title: b10-auth
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: July 29, 2010
.\" Date: January 19, 2011
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-AUTH" "8" "July 29, 2010" "BIND10" "BIND10"
.TH "B10\-AUTH" "8" "January 19, 2011" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -36,27 +36,8 @@ This daemon communicates with other BIND 10 components over a
C\-Channel connection\&. If this connection is not established,
\fBb10\-auth\fR
will exit\&.
.PP
It also receives its configurations from
\fBb10-cfgmgr\fR(8)\&. It will honor the
\fIdatabase_file\fR
configuration to point to the SQLite3 zone file\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
This prototype version uses SQLite3 as its data source backend\&. Future versions will be configurable, supporting multiple data storage types\&.
.sp .5v
.RE
It receives its configurations from
\fBb10-cfgmgr\fR(8)\&.
.SH "OPTIONS"
.PP
The arguments are as follows:
......@@ -123,10 +104,102 @@ must be either a valid numeric user ID or a valid user name\&. By default the da
.RS 4
Enabled verbose mode\&. This enables diagnostic messages to STDERR\&.
.RE
.SH "CONFIGURATION AND COMMANDS"
.PP
The configurable settings are:
.PP
\fIdatabase_file\fR
defines the path to the SQLite3 zone file when using the sqlite datasource\&. The default is
/usr/local/var/bind10\-devel/zone\&.sqlite3\&.
.PP
\fIdatasources\fR
configures data sources\&. The list items include:
\fItype\fR
to optionally choose the data source type (such as
\(lqmemory\(rq);
\fIclass\fR
to optionally select the class (it defaults to
\(lqIN\(rq); and
\fIzones\fR
to define the
\fIfile\fR
path name and the
\fIorigin\fR
(default domain)\&. By default, this is empty\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
In this development version, currently this is only used for the memory data source\&. Only the IN class is supported at this time\&. By default, the memory data source is disabled\&. Also, currently the zone file must be canonical such as generated by \fBnamed\-compilezone \-D\fR\&.
.sp .5v
.RE
.PP
\fIstatistics\-interval\fR
is the timer interval in seconds for
\fBb10\-auth\fR
to share its statistics information to
\fBb10-stats\fR(8)\&. Statistics updates can be disabled by setting this to 0\&. The default is 60\&.
.PP
The configuration commands are:
.PP
\fBloadzone\fR
tells
\fBb10\-auth\fR
to load or reload a zone file\&. The arguments include:
\fIclass\fR
which optionally defines the class (it defaults to
\(lqIN\(rq);
\fIorigin\fR
is the domain name of the zone; and
\fIdatasrc\fR
optionally defines the type of datasource (it defaults to
\(lqmemory\(rq)\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
In this development version, currently this only supports the IN class and the memory data source\&.
.sp .5v
.RE
.PP
\fBsendstats\fR
tells
\fBb10\-auth\fR
to send its statistics data to
\fBb10-stats\fR(8)
immediately\&.
.PP
\fBshutdown\fR
exits
\fBb10\-auth\fR\&. (Note that the BIND 10 boss process will restart this service\&.)
.SH "FILES"
.PP
/usr/local/var/db/zone\&.sqlite3
/usr/local/var/bind10\-devel/zone\&.sqlite3
\(em Location for the SQLite3 zone database when
\fIdatabase_file\fR
configuration is not defined\&.
......@@ -134,9 +207,9 @@ configuration is not defined\&.
.PP
\fBb10-cfgmgr\fR(8),
\fBb10-cmdctl\fR(8),
\fBb10-loadzone\fR(8),
\fBb10-msgq\fR(8),
\fBb10-stats\fR(8),
\fBb10-zonemgr\fR(8),
\fBbind10\fR(8),
BIND 10 Guide\&.
......
......@@ -2,7 +2,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]>
<!--
- Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
- Copyright (C) 2010-2011 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
......@@ -21,7 +21,7 @@
<refentry>
<refentryinfo>
<date>July 29, 2010</date>
<date>January 19, 2011</date>
</refentryinfo>
<refmeta>
......@@ -70,22 +70,13 @@
C-Channel connection. If this connection is not established,
<command>b10-auth</command> will exit.
<!-- TODO what if msgq connection closes later, will b10-auth exit? -->
</para>
<para>
It also receives its configurations from
It receives its configurations from
<citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
It will honor the <emphasis>database_file</emphasis> configuration
to point to the SQLite3 zone file.
<!-- TODO: data source -->
</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: mention xfrin, xfrout, zonemgr ? -->
</refsect1>
<refsect1>
......@@ -136,6 +127,7 @@
and negative) in memory for 30 seconds (instead of querying
the data source, such as SQLite3 database, each time).
</para></listitem>
<!-- TODO: this is SQLite3 only -->
</varlistentry>
<varlistentry>
......@@ -174,15 +166,95 @@
</refsect1>
<refsect1>
<title>CONFIGURATION AND COMMANDS</title>
<para>
The configurable settings are:
</para>
<para>
<varname>database_file</varname> defines the path to the
SQLite3 zone file when using the sqlite datasource.
The default is
<filename>/usr/local/var/bind10-devel/zone.sqlite3</filename>.
</para>
<para>
<varname>datasources</varname> configures data sources.
The list items include:
<varname>type</varname> to optionally choose the data source type
(such as <quote>memory</quote>);
<varname>class</varname> to optionally select the class
(it defaults to <quote>IN</quote>);
and
<varname>zones</varname> to define the
<varname>file</varname> path name and the
<varname>origin</varname> (default domain).
By default, this is empty.
<note><simpara>
In this development version, currently this is only used for the
memory data source.
Only the IN class is supported at this time.
By default, the memory data source is disabled.
Also, currently the zone file must be canonical such as
generated by <command>named-compilezone -D</command>.
</simpara></note>
</para>
<para>
<varname>statistics-interval</varname> is the timer interval
in seconds for <command>b10-auth</command> to share its
statistics information to
<citerefentry><refentrytitle>b10-stats</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
Statistics updates can be disabled by setting this to 0.
The default is 60.
</para>
<!-- TODO: formating -->
<para>
The configuration commands are:
</para>
<para>
<command>loadzone</command> tells <command>b10-auth</command>
to load or reload a zone file. The arguments include:
<varname>class</varname> which optionally defines the class
(it defaults to <quote>IN</quote>);
<varname>origin</varname> is the domain name of the zone;
and
<varname>datasrc</varname> optionally defines the type of datasource
(it defaults to <quote>memory</quote>).
<note><simpara>
In this development version, currently this only supports the
IN class and the memory data source.
</simpara></note>
</para>
<para>
<command>sendstats</command> tells <command>b10-auth</command>
to send its statistics data to
<citerefentry><refentrytitle>b10-stats</refentrytitle><manvolnum>8</manvolnum></citerefentry>
immediately.
</para>
<para>
<command>shutdown</command> exits <command>b10-auth</command>.
(Note that the BIND 10 boss process will restart this service.)
</para>
</refsect1>
<refsect1>
<title>FILES</title>
<para>
<filename>/usr/local/var/db/zone.sqlite3</filename>
<filename>/usr/local/var/bind10-devel/zone.sqlite3</filename>
&mdash; Location for the SQLite3 zone database
when <emphasis>database_file</emphasis> configuration is not
defined.
</para>
<!-- TODO: this is not correct yet. -->
</refsect1>
<refsect1>
......@@ -191,15 +263,15 @@
<citerefentry>
<refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>b10-loadzone</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>b10-stats</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment