Commit 558ff500 authored by Jeremy C. Reed's avatar Jeremy C. Reed
Browse files

[master] regenerate docs to catch up on many changes

parent 9898bbb3
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
......@@ -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: May 16, 2012
.\" Date: June 20, 2012
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-AUTH" "8" "May 16, 2012" "BIND10" "BIND10"
.TH "B10\-AUTH" "8" "June 20, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -49,7 +49,7 @@ Do not cache answers in memory\&. The default is to use the cache for faster res
.PP
\fB\-v\fR
.RS 4
Enabled verbose mode\&. This enables diagnostic messages to STDERR\&.
Enable verbose logging mode\&. This enables logging of diagnostic messages at the maximum debug level\&.
.RE
.SH "CONFIGURATION AND COMMANDS"
.PP
......
......@@ -2,12 +2,12 @@
.\" Title: bindctl
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: December 23, 2010
.\" Date: June 20, 2012
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "BINDCTL" "1" "December 23, 2010" "BIND10" "BIND10"
.TH "BINDCTL" "1" "June 20, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -35,7 +35,7 @@ via its interactive command interpreter\&.
communicates over a HTTPS REST\-ful interface provided by
\fBb10-cmdctl\fR(8)\&. The
\fBb10-cfgmgr\fR(8)
daemon stores the configurations and defines the commands\&.
daemon stores the configurations\&.
.SH "ARGUMENTS"
.PP
The arguments are as follows:
......@@ -91,9 +91,9 @@ Display the version number and exit\&.
.SH "AUTHENTICATION"
.PP
The tool will authenticate using a username and password\&. On the first successful login, it will save the details to a comma\-separated\-value (CSV) file which will be used for later uses of
\fBbindctl\fR\&. The file name is
default_user\&.csv
located under the directory specified by the \-\-csv\-file\-dir option\&.
\fBbindctl\fR\&. The file name is "default_user\&.csv" located under the directory specified by the
\fB\-\-csv\-file\-dir\fR
option\&.
.SH "USAGE"
.PP
The
......@@ -115,8 +115,7 @@ keyword to receive usage assistance for a module or a module\'s command\&.
The
\fBquit\fR
command is used to exit
\fBbindctl\fR
(and doesn\'t stop the BIND 10 services)\&.
\fBbindctl\fR\&. (It doesn\'t stop the BIND 10 services\&.)
.PP
The following module is available by default:
\fBconfig\fR
......
......@@ -2,12 +2,12 @@
.\" Title: b10-cfgmgr
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: April 12, 2010
.\" Date: June 20, 2012
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-CFGMGR" "8" "April 12, 2010" "BIND10" "BIND10"
.TH "B10\-CFGMGR" "8" "June 20, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -42,10 +42,6 @@ C\-Channel connection\&. If this connection is not established,
will exit\&.
.PP
The daemon may be cleanly stopped by sending the SIGTERM signal to the process\&. This shutdown does not notify the subscribers\&.
.PP
When it exits, it saves its current configuration to
/usr/local/var/bind10\-devel/b10\-config\&.db\&.
.SH "ARGUMENTS"
.PP
The arguments are as follows:
......@@ -59,9 +55,7 @@ will use the default configurations\&. The name of the backup file can be found
.PP
\fB\-c\fR \fIconfig\-filename\fR, \fB\-\-config\-filename\fR \fIconfig\-filename\fR
.RS 4
The configuration database filename to use\&. Can be either absolute or relative to data path\&.
.sp
Defaults to b10\-config\&.db
The configuration database filename to use\&. Can be either absolute or relative to data path\&. It defaults to "b10\-config\&.db"\&.
.RE
.PP
\fB\-p\fR \fIdata\-path\fR, \fB\-\-data\-path\fR \fIdata\-path\fR
......
......@@ -2,21 +2,12 @@
.\" Title: b10-dbutil
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: March 20, 2012
.\" Date: June 20, 2012
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-DBUTIL" "8" "March 20, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH "B10\-DBUTIL" "8" "June 20, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -38,13 +29,14 @@ b10-dbutil \- Zone Database Maintenance Utility
.PP
The
\fBb10\-dbutil\fR
utility is a general administration utility for SQL databases\&. (Currently only SQLite is supported by BIND 10\&.) It can report the current verion of the schema, and upgrade an existing database to the latest version of the schema\&.
utility is a general administration utility for SQL databases for BIND 10\&. (Currently only SQLite is supported by BIND 10\&.) It can report the current verion of the schema, and upgrade an existing database to the latest version of the schema\&.
.PP
\fBb10\-dbutil\fR
operates in one of two modes, check mode or upgrade mode\&.
operates in one of two modesr: check mode or upgrade mode\&.
.PP
In check mode (\fBb10\-dbutil \-\-check\fR), the utility reads the version of the database schema from the database and prints it\&. It will tell you whether the schema is at the latest version supported by BIND 10\&. Exit status is 0 if the schema is at the correct version, 1 if the schema is at an older version, 2 if the schema is at a version not yet supported by this version of b10\-dbutil\&. Any higher value indicates an error during command\-line parsing or execution\&.
In check mode (\fBb10\-dbutil \-\-check\fR), the utility reads the version of the database schema from the database and prints it\&. It will tell you whether the schema is at the latest version supported by BIND 10\&. Exit status is 0 if the schema is at the correct version, 1 if the schema is at an older version, or 2 if the schema is at a version not yet supported by this version of
\fBb10\-dbutil\fR\&. Any higher value indicates an error during command\-line parsing or execution\&.
.PP
When the upgrade function is selected (\fBb10\-dbutil \-\-upgrade\fR), the utility takes a copy of the database, then upgrades it to the latest version of the schema\&. The contents of the database remain intact\&. (The backup file is a file in the same directory as the database file\&. It has the same name, with "\&.backup" appended to it\&. If a file of that name already exists, the file will have the suffix "\&.backup\-1"\&. If that exists, the file will be suffixed "\&.backup\-2", and so on)\&. Exit status is 0 if the upgrade is either succesful or aborted by the user, and non\-zero if there is an error\&.
.PP
......@@ -57,24 +49,29 @@ The arguments are as follows:
.PP
\fB\-\-check\fR
.RS 4
Selects the version check function, which reports the current version of the database\&. This is incompatible with the \-\-upgrade option\&.
Selects the version check function, which reports the current version of the database\&. This is mutually exclusive with the
\fB\-\-upgrade\fR
option\&.
.RE
.PP
\fB\-\-noconfirm\fR
.RS 4
Only valid with \-\-upgrade, this disables the prompt\&. Normally the utility will print a warning that an upgrade is about to take place and request that you type "Yes" to continue\&. If this switch is given on the command line, no prompt will be issued: the utility will just perform the upgrade\&.
Only valid with
\fB\-\-upgrade\fR, this disables the prompt\&. Normally the utility will print a warning that an upgrade is about to take place and request that you type "Yes" to continue\&. If this switch is given on the command line, no prompt will be issued and the utility will just perform the upgrade\&.
.RE
.PP
\fB\-\-upgrade\fR
.RS 4
Selects the upgrade function, which upgrades the database to the latest version of the schema\&. This is incompatible with the \-\-upgrade option\&.
Selects the upgrade function, which upgrades the database to the latest version of the schema\&. This is mutually exclusive with the
\fB\-\-check\fR
option\&.
.sp
The upgrade function will upgrade a BIND 10 database \- no matter how old the schema \- preserving all data\&. A backup file is created before the upgrade (with the same name as the database, but with "\&.backup" suffixed to it)\&. If the upgrade fails, this file can be copied back to restore the original database\&.
The upgrade function will upgrade a BIND 10 database \(em no matter how old the schema \(em preserving all data\&. A backup file is created before the upgrade (with the same name as the database, but with "\&.backup" suffixed to it)\&. If the upgrade fails, this file can be copied back to restore the original database\&.
.RE
.PP
\fB\-\-verbose\fR
.RS 4
Enable verbose mode\&. Each SQL command issued by the utility will be printed to stderr before it is executed\&.
Enable verbose mode\&. Each SQL command issued by the utility will be printed to STDERR before it is executed\&.
.RE
.PP
\fB\-\-quiet\fR
......@@ -84,7 +81,7 @@ Enable quiet mode\&. No output is printed, except errors during command\-line ar
.PP
\fB\fIdbfile\fR\fR
.RS 4
Name of the database file to check of upgrade\&.
Name of the database file to check or upgrade\&.
.RE
.SH "COPYRIGHT"
.br
......
'\" t
.\" Title: b10-ddns
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: February 28, 2012
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: June 18, 2012
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-DDNS" "8" "February 28, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH "B10\-DDNS" "8" "June 18, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -38,22 +29,18 @@ The
\fBb10\-ddns\fR
daemon provides the BIND 10 Dynamic Update (DDNS) service, as specified in RFC 2136\&. Normally it is started by the
\fBbind10\fR(8)
boss process\&. When the
\fBb10\-auth\fR
DNS server receives a DDNS update,
\fBb10\-ddns\fR
updates the zone in the BIND 10 zone data source\&.
boss process\&.
.PP
When the
\fBb10\-auth\fR
authoritative DNS server receives an UPDATE request, it internally forwards the request to
\fBb10\-ddns\fR, which handles the rest of request processing\&. When the process is completed
\fBb10\-ddns\fR, which handles the rest of the request processing\&. When the processing is completed
\fBb10\-ddns\fR
will send a response to the client with the processing result\&. If the zone has been changed as a result, it will internally notify
will send a response to the client with the RCODE set to the value as specified in RFC 2136\&. If the zone has been changed as a result, it will internally notify
\fBb10\-auth\fR
and
\fBb10\-xfrout\fR
so the new version of zone will be served, and other secondary servers will be notified via the DNS notify protocol\&.
so the new version of the zone will be served, and other secondary servers will be notified via the DNS notify protocol\&.
.PP
This daemon communicates with BIND 10 over a
\fBb10-msgq\fR(8)
......@@ -61,9 +48,9 @@ C\-Channel connection\&. If this connection is not established,
\fBb10\-ddns\fR
will exit\&. The
\fBb10\-ddns\fR
daemon depends on some other BIND 10 components:
\fBb10-auth\fR(8)
and
daemon also depends on some other BIND 10 components (either directly or indirectly):
\fBb10-auth\fR(8),
\fBb10-xfrout\fR(8), and
\fBb10-zonemgr\fR(8)\&.
.PP
......@@ -74,9 +61,16 @@ receives its configurations from
.PP
The arguments are as follows:
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print the command line arguments and exit\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
This value is ignored at this moment, but is provided for compatibility with the bind10 Boss process
This value is ignored at this moment, but is provided for compatibility with the
\fBbind10\fR
Boss process\&.
.RE
.SH "CONFIGURATION AND COMMANDS"
.PP
......@@ -88,9 +82,9 @@ The zones option is a list of configuration items for specific zones that can be
\fIorigin\fR
is a textual domain name of the zone;
\fIclass\fR
(text) is the RR class of the zone;
(text) is the RR class of the zone; and
\fIupdate_acl\fR
is a list of ACL that controls permission for updates\&. See the BIND 10 Guide for configuration details\&. Note that not listing a zone in this list does not directly mean update requests for the zone are rejected, but the end result is the same because the default ACL for updates is to deny all requests\&.
is an ACL that controls permission for updates\&. See the BIND 10 Guide for configuration details\&. Note that not listing a zone in this list does not directly mean update requests for the zone are rejected, but the end result is the same because the default ACL for updates is to deny all requests\&.
.PP
The module commands are:
.PP
......@@ -114,7 +108,7 @@ BIND 10 Guide\&.
.PP
The
\fBb10\-ddns\fR
daemon was first implemented in December 2011 for the ISC BIND 10 project\&.
daemon was first implemented in December 2011 for the ISC BIND 10 project\&. The first functional version was released in June 2012\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2011-2012 Internet Systems Consortium, Inc. ("ISC")
......
......@@ -27,8 +27,9 @@ b10-stats-httpd \- BIND 10 HTTP server for HTTP/XML interface of statistics
.PP
\fBb10\-stats\-httpd\fR
is a standalone HTTP server\&. It is intended for HTTP/XML interface for statistics module\&. This server process runs as a process separated from the process of the BIND 10 Stats daemon (\fBb10\-stats\fR)\&. The server is initially executed by the BIND 10 boss process (\fBbind10\fR) and eventually exited by it\&. The server is intended to be server requests by HTTP clients like web browsers and third\-party modules\&. When the server is asked, it requests BIND 10 statistics data or its schema from
\fBb10\-stats\fR, and it sends the data back in Python dictionary format and the server converts it into XML format\&. The server sends it to the HTTP client\&. The server can send three types of document, which are XML (Extensible Markup Language), XSD (XML Schema definition) and XSL (Extensible Stylesheet Language)\&. The XML document is the statistics data of BIND 10, The XSD document is the data schema of it, and The XSL document is the style sheet to be showed for the web browsers\&. There is different URL for each document\&. But please note that you would be redirected to the URL of XML document if you request the URL of the root document\&. For example, you would be redirected to http://127\&.0\&.0\&.1:8000/bind10/statistics/xml if you request http://127\&.0\&.0\&.1:8000/\&. Please see the manual and the spec file of
is a standalone HTTP server\&. It is intended for HTTP/XML interface for statistics module\&. This server process runs as a process separated from the process of the BIND 10 Stats daemon (\fBb10\-stats\fR)\&. The server is initially executed by the BIND 10 boss process (\fBbind10\fR) and eventually exited by it\&. The server is intended to serve requests by HTTP clients like web browsers and third\-party modules\&. When the server is asked, it requests BIND 10 statistics data or its schema from
\fBb10\-stats\fR
which sends the data back in Python dictionary format, and the server converts it into XML format\&. The server sends it to the HTTP client\&. The server can send three types of documents, which are XML (Extensible Markup Language), XSD (XML Schema definition) and XSL (Extensible Stylesheet Language)\&. The XML document is the statistics data of BIND 10, the XSD document is the data schema of it, and the XSL document is the style sheet to be showed for the web browsers\&. There is different URL for each document\&. But please note that you would be redirected to the URL of XML document if you request the URL of the root document\&. For example, you would be redirected to http://127\&.0\&.0\&.1:8000/bind10/statistics/xml if you request http://127\&.0\&.0\&.1:8000/\&. Please see the manual and the spec file of
\fBb10\-stats\fR
for more details about the items of BIND 10 statistics\&. The server uses CC session in communication with
\fBb10\-stats\fR\&. CC session is provided by
......
......@@ -2,12 +2,12 @@
.\" Title: b10-stats
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: March 1, 2012
.\" Date: June 20, 2012
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-STATS" "8" "March 1, 2012" "BIND10" "BIND10"
.TH "B10\-STATS" "8" "June 20, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -27,18 +27,21 @@ b10-stats \- BIND 10 statistics module
.PP
The
\fBb10\-stats\fR
is a daemon forked by
\fBbind10\fR\&. Stats module collects statistics data from each module and reports statistics information via
\fBbindctl\fR\&. It communicates by using the Command Channel by
daemon collects statistics data from each BIND 10 module\&. Its statistics information may be reported via
\fBbindctl\fR
or
\fBb10\-stats\-httpd\fR\&. It is started by
\fBbind10\fR
and communicates by using the Command Channel by
\fBb10\-msgq\fR
with other modules like
\fBbind10\fR,
\fBb10\-auth\fR
and so on\&. It waits for coming data from other modules, then other modules send data to stats module periodically\&. Other modules send stats data to stats module independently from implementation of stats module, so the frequency of sending data may not be constant\&. Stats module collects data and aggregates it\&.
and so on\&. It waits for coming data from other modules, then other modules send data to stats module periodically\&. Other modules send stats data to stats module independently from implementation of stats module, so the frequency of sending data may not be constant\&. The stats module collects data and aggregates it\&.
\fBb10\-stats\fR
invokes an internal command for
\fBbind10\fR
after its initial starting because it\'s sure to collect statistics data from
after its initial starting to make sure it collects statistics data from
\fBbind10\fR\&.
.SH "OPTIONS"
.PP
......@@ -46,9 +49,7 @@ The arguments are as follows:
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
This
\fBb10\-stats\fR
switches to verbose mode\&. It sends verbose messages to STDOUT\&.
This enables maximum debug logging\&.
.RE
.SH "CONFIGURATION AND COMMANDS"
.PP
......
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