Commit 64e656b8 authored by Jeremy C. Reed's avatar Jeremy C. Reed
Browse files

Document some configurations for the resolver.

For b10-resolver man page:  document  configurable settings and
shutdown command.  This is not completed yet.

Also regenerate man page from docbook.
parent ce5624a2
......@@ -2,12 +2,12 @@
.\" Title: b10-resolver
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: January 3, 2011
.\" Date: January 19, 2011
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-RESOLVER" "8" "January 3, 2011" "BIND10" "BIND10"
.TH "B10\-RESOLVER" "8" "January 19, 2011" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -38,7 +38,7 @@ C\-Channel connection\&. If this connection is not established,
will exit\&.
.PP
It also receives its configurations from
\fBb10-cfgmgr\fR(8)\&. Currently no configuration commands are defined\&.
\fBb10-cfgmgr\fR(8)\&.
.if n \{\
.sp
.\}
......@@ -73,9 +73,40 @@ 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 "FILES"
.SH "CONFIGURATION AND COMMANDS"
.PP
None\&.
The configurable settings are:
.PP
\fIforward_addresses\fR
defines the list of addresses and ports that
\fBb10\-resolver\fR
should forward queries to\&. Defining this enables forwarding\&.
.PP
\fIlisten_on\fR
is a list of addresses and ports for
\fBb10\-resolver\fR
to listen on\&. The list items are the
\fIaddress\fR
string and
\fIport\fR
number\&. The defaults are address ::1 port 5300 and address 127\&.0\&.0\&.1 port 5300\&.
.PP
\fIretries\fR
is the number of times to retry (resend query) after a timeout\&. The default is 0 (do not retry)\&.
.PP
\fItimeout\fR
is the number of milliseconds to wait for answer\&. If set to \-1, the timeout is disabled\&. The default is 2000\&.
.PP
The configuration command is:
.PP
\fBshutdown\fR
exits
\fBb10\-resolver\fR\&. (Note that the BIND 10 boss process will restart this service\&.)
.SH "SEE ALSO"
.PP
......@@ -88,7 +119,9 @@ BIND 10 Guide\&.
.PP
The
\fBb10\-resolver\fR
daemon was first coded in September 2010\&.
daemon was first coded in September 2010\&. The initial implementation only provided forwarding\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2010 Internet Systems Consortium, Inc. ("ISC")
......
......@@ -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>January 3, 2011</date>
<date>January 19, 2011</date>
</refentryinfo>
<refmeta>
......@@ -68,7 +68,6 @@
<para>
It also receives its configurations from
<citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
Currently no configuration commands are defined.
</para>
<note><para>
......@@ -111,13 +110,72 @@
</refsect1>
<refsect1>
<title>CONFIGURATION AND COMMANDS</title>
<para>
The configurable settings are:
</para>
<para>
<varname>forward_addresses</varname> defines the list of addresses
and ports that <command>b10-resolver</command> should forward
queries to.
Defining this enables forwarding.
<!-- TODO: list
address
::1
port
53
-->
</para>
<!-- trac386:
once that is merged you can for instance do 'config add Resolver/forward_addresses { "port": 123 } and it will fill in the rest (in this case ::1 for the address)
-->
<para>
<varname>listen_on</varname> is a list of addresses and ports for
<command>b10-resolver</command> to listen on.
The list items are the <varname>address</varname> string
and <varname>port</varname> number.
The defaults are address ::1 port 5300 and
address 127.0.0.1 port 5300.
</para>
<para>
<varname>retries</varname> is the number of times to retry
(resend query) after a timeout.
The default is 0 (do not retry).
</para>
<para>
<varname>timeout</varname> is the number of milliseconds to
wait for answer. If set to -1, the timeout is disabled.
The default is 2000.
</para>
<!-- TODO: formating -->
<para>
The configuration command is:
</para>
<para>
<command>shutdown</command> exits <command>b10-resolver</command>.
(Note that the BIND 10 boss process will restart this service.)
</para>
</refsect1>
<!--
<refsect1>
<title>FILES</title>
<para>
None.
</para>
<!-- TODO: this is not correct yet. -->
</refsect1>
-->
<refsect1>
<title>SEE ALSO</title>
......@@ -142,7 +200,11 @@
<title>HISTORY</title>
<para>
The <command>b10-resolver</command> daemon was first coded in
September 2010.
September 2010. The initial implementation only provided
forwarding.
<!-- TODO: document when caching was added -->
<!-- TODO: document when iteration was added -->
<!-- TODO: document when validation was added -->
</para>
</refsect1>
</refentry><!--
......
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