-Frequently Asked Questions about BIND 9
-
-Copyright © 2004-2010, 2013, 2014 Internet Systems Consortium, Inc.
+Copyright ? 2004-2010, 2013, 2014 Internet Systems Consortium, Inc.
("ISC")
-Copyright © 2000-2003 Internet Software Consortium.
+Copyright ? 2000-2003 Internet Software Consortium.
-----------------------------------------------------------------------
-1. Compilation and Installation Questions
-
Q: I'm trying to compile BIND 9, and "make" is failing due to files not
being found. Why?
answers to all these questions change how you configure even a caching
name server.
-2. Configuration and Setup Questions
-
Q: Why does named log the warning message "no TTL specified - using SOA
MINTTL instead"?
server fd81:ec6c:bd62::/48 { bogus no; }; // site ULA prefix
server ::/0 { bogus yes; };
-3. Operations Questions
-
Q: How to change the nameservers for a zone?
A: Step 1: Ensure all nameservers, new and old, are serving the same zone
Note: while it is possible to run the addition and removal stages
together it is not recommended.
-4. General Questions
-
Q: I keep getting log messages like the following. Why?
Dec 4 23:47:59 client 10.0.0.1#1355: updating zone 'example.com/IN':
records does not bring names into existence that do not exist in the
unsigned version of the zone.
-5. Operating-System Specific Questions
-
-5.1. HPUX
-
Q: I get the following error trying to configure BIND:
checking if unistd.h or sys/types.h defines fd_set... no
./configure CC=<compiler> ...
-5.2. Linux
-
Q: Why do I get the following errors:
general: errno2result.c:109: unexpected error:
proc /proc proc defaults 0 0
proc /var/named/proc proc defaults 0 0
-5.3. Windows
-
Q: Zone transfers from my BIND 9 master to my Windows 2000 slave fail.
Why?
Directory "C:\windows\dns\etc";
};
-5.4. FreeBSD
-
Q: I have FreeBSD 4.x and "rndc-confgen -a" just sits there.
A: /dev/random is not configured. Use rndcontrol(8) to tell the kernel to
See also <http://people.freebsd.org/~dougb/randomness.html>.
-5.5. Solaris
-
Q: How do I integrate BIND 9 and Solaris SMF
A: Sun has a blog entry describing how to do this.
<http://blogs.sun.com/roller/page/anay/Weblog?catname=%2FSolaris>
-5.6. Apple Mac OS X
-
Q: How do I run BIND 9 on Apple Mac OS X?
A: If you run Tiger(Mac OS 10.4) or later then this is all you need to do:
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<article xmlns="http://docbook.org/ns/docbook" version="5.0" class="faq">
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: named\-checkconf
+'\" t
+.\" Title: named-checkconf
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 10, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-01-10
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "NAMED\-CHECKCONF" "8" "January 10, 2014" "BIND9" "BIND9"
+.TH "NAMED\-CHECKCONF" "8" "2014\-01\-10" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-named\-checkconf \- named configuration file syntax checking tool
+named-checkconf \- named configuration file syntax checking tool
.SH "SYNOPSIS"
.HP 16
\fBnamed\-checkconf\fR [\fB\-h\fR] [\fB\-v\fR] [\fB\-j\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] {filename} [\fB\-p\fR] [\fB\-x\fR] [\fB\-z\fR]
\fBnamed\-checkconf\fR
checks the syntax, but not the semantics, of a
\fBnamed\fR
-configuration file. The file is parsed and checked for syntax errors, along with all files included by it. If no file is specified,
-\fI/etc/named.conf\fR
-is read by default.
+configuration file\&. The file is parsed and checked for syntax errors, along with all files included by it\&. If no file is specified,
+/etc/named\&.conf
+is read by default\&.
.PP
Note: files that
\fBnamed\fR
reads in separate parser contexts, such as
-\fIrndc.key\fR
+rndc\&.key
and
-\fIbind.keys\fR, are not automatically read by
-\fBnamed\-checkconf\fR. Configuration errors in these files may cause
+bind\&.keys, are not automatically read by
+\fBnamed\-checkconf\fR\&. Configuration errors in these files may cause
\fBnamed\fR
to fail to run, even if
\fBnamed\-checkconf\fR
-was successful.
+was successful\&.
\fBnamed\-checkconf\fR
-can be run on these files explicitly, however.
+can be run on these files explicitly, however\&.
.SH "OPTIONS"
.PP
\-h
.RS 4
-Print the usage summary and exit.
+Print the usage summary and exit\&.
.RE
.PP
\-t \fIdirectory\fR
.RS 4
Chroot to
-\fIdirectory\fR
+directory
so that include directives in the configuration file are processed as if run by a similarly chrooted
-\fBnamed\fR.
+\fBnamed\fR\&.
.RE
.PP
\-v
.RS 4
Print the version of the
\fBnamed\-checkconf\fR
-program and exit.
+program and exit\&.
.RE
.PP
\-p
.RS 4
Print out the
-\fInamed.conf\fR
-and included files in canonical form if no errors were detected.
+named\&.conf
+and included files in canonical form if no errors were detected\&.
.RE
.PP
\-x
.RS 4
-When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks ('?'). This allows the contents of
-\fInamed.conf\fR
-and related files to be shared \(em for example, when submitting bug reports \(em without compromising private data. This option cannot be used without
-\fB\-p\fR.
+When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks (\*(Aq?\*(Aq)\&. This allows the contents of
+named\&.conf
+and related files to be shared \(em for example, when submitting bug reports \(em without compromising private data\&. This option cannot be used without
+\fB\-p\fR\&.
.RE
.PP
\-z
.RS 4
Perform a test load of all master zones found in
-\fInamed.conf\fR.
+named\&.conf\&.
.RE
.PP
\-j
.RS 4
-When loading a zonefile read the journal if it exists.
+When loading a zonefile read the journal if it exists\&.
.RE
.PP
filename
.RS 4
-The name of the configuration file to be checked. If not specified, it defaults to
-\fI/etc/named.conf\fR.
+The name of the configuration file to be checked\&. If not specified, it defaults to
+/etc/named\&.conf\&.
.RE
.SH "RETURN VALUES"
.PP
\fBnamed\-checkconf\fR
-returns an exit status of 1 if errors were detected and 0 otherwise.
+returns an exit status of 1 if errors were detected and 0 otherwise\&.
.SH "SEE ALSO"
.PP
\fBnamed\fR(8),
-\fBnamed\-checkzone\fR(8),
-BIND 9 Administrator Reference Manual.
+\fBnamed-checkzone\fR(8),
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
.br
-Copyright \(co 2000\-2002 Internet Software Consortium.
+Copyright \(co 2000-2002 Internet Software Consortium.
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-checkconf</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="named-checkconf">
<a name="man.named-checkconf"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">named-checkconf</span> — named configuration file syntax checking tool</p>
+<p>
+ <span class="application">named-checkconf</span>
+ — named configuration file syntax checking tool
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">named-checkconf</code> [<code class="option">-h</code>] [<code class="option">-v</code>] [<code class="option">-j</code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] {filename} [<code class="option">-p</code>] [<code class="option">-x</code>] [<code class="option">-z</code>]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543414"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">named-checkconf</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">named-checkconf</code>
+ [<code class="option">-h</code>]
+ [<code class="option">-v</code>]
+ [<code class="option">-j</code>]
+ [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>]
+ {filename}
+ [<code class="option">-p</code>]
+ [<code class="option">-x</code>]
+ [<code class="option">-z</code>]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60924880"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>named-checkconf</strong></span>
checks the syntax, but not the semantics, of a
- <span><strong class="command">named</strong></span> configuration file. The file is parsed
+ <span class="command"><strong>named</strong></span> configuration file. The file is parsed
and checked for syntax errors, along with all files included by it.
If no file is specified, <code class="filename">/etc/named.conf</code> is read
by default.
</p>
-<p>
- Note: files that <span><strong class="command">named</strong></span> reads in separate
+ <p>
+ Note: files that <span class="command"><strong>named</strong></span> reads in separate
parser contexts, such as <code class="filename">rndc.key</code> and
<code class="filename">bind.keys</code>, are not automatically read
- by <span><strong class="command">named-checkconf</strong></span>. Configuration
- errors in these files may cause <span><strong class="command">named</strong></span> to
- fail to run, even if <span><strong class="command">named-checkconf</strong></span> was
- successful. <span><strong class="command">named-checkconf</strong></span> can be run
+ by <span class="command"><strong>named-checkconf</strong></span>. Configuration
+ errors in these files may cause <span class="command"><strong>named</strong></span> to
+ fail to run, even if <span class="command"><strong>named-checkconf</strong></span> was
+ successful. <span class="command"><strong>named-checkconf</strong></span> can be run
on these files explicitly, however.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543463"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60930384"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Print the usage summary and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Chroot to <code class="filename">directory</code> so that include
directives in the configuration file are processed as if
- run by a similarly chrooted <span><strong class="command">named</strong></span>.
- </p></dd>
+ run by a similarly chrooted <span class="command"><strong>named</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-v</span></dt>
-<dd><p>
- Print the version of the <span><strong class="command">named-checkconf</strong></span>
+<dd>
+ <p>
+ Print the version of the <span class="command"><strong>named-checkconf</strong></span>
program and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p</span></dt>
-<dd><p>
+<dd>
+ <p>
Print out the <code class="filename">named.conf</code> and included files
in canonical form if no errors were detected.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-x</span></dt>
-<dd><p>
+<dd>
+ <p>
When printing the configuration files in canonical
form, obscure shared secrets by replacing them with
strings of question marks ('?'). This allows the
files to be shared — for example, when submitting
bug reports — without compromising private data.
This option cannot be used without <code class="option">-p</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-z</span></dt>
-<dd><p>
+<dd>
+ <p>
Perform a test load of all master zones found in
<code class="filename">named.conf</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-j</span></dt>
-<dd><p>
+<dd>
+ <p>
When loading a zonefile read the journal if it exists.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">filename</span></dt>
-<dd><p>
+<dd>
+ <p>
The name of the configuration file to be checked. If not
specified, it defaults to <code class="filename">/etc/named.conf</code>.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543610"></a><h2>RETURN VALUES</h2>
-<p><span><strong class="command">named-checkconf</strong></span>
+
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60952016"></a><h2>RETURN VALUES</h2>
+
+ <p><span class="command"><strong>named-checkconf</strong></span>
returns an exit status of 1 if
errors were detected and 0 otherwise.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543622"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60953808"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named-checkzone</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543652"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: named\-checkzone
+'\" t
+.\" Title: named-checkzone
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: February 19, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-02-19
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "NAMED\-CHECKZONE" "8" "February 19, 2014" "BIND9" "BIND9"
+.TH "NAMED\-CHECKZONE" "8" "2014\-02\-19" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-named\-checkzone, named\-compilezone \- zone file validity checking or converting tool
+named-checkzone, named-compilezone \- zone file validity checking or converting tool
.SH "SYNOPSIS"
.HP 16
\fBnamed\-checkzone\fR [\fB\-d\fR] [\fB\-h\fR] [\fB\-j\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-f\ \fR\fB\fIformat\fR\fR] [\fB\-F\ \fR\fB\fIformat\fR\fR] [\fB\-J\ \fR\fB\fIfilename\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-M\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-l\ \fR\fB\fIttl\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-o\ \fR\fB\fIfilename\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-S\ \fR\fB\fImode\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {zonename} {filename}
.SH "DESCRIPTION"
.PP
\fBnamed\-checkzone\fR
-checks the syntax and integrity of a zone file. It performs the same checks as
+checks the syntax and integrity of a zone file\&. It performs the same checks as
\fBnamed\fR
-does when loading a zone. This makes
+does when loading a zone\&. This makes
\fBnamed\-checkzone\fR
-useful for checking zone files before configuring them into a name server.
+useful for checking zone files before configuring them into a name server\&.
.PP
\fBnamed\-compilezone\fR
is similar to
-\fBnamed\-checkzone\fR, but it always dumps the zone contents to a specified file in a specified format. Additionally, it applies stricter check levels by default, since the dump output will be used as an actual zone file loaded by
-\fBnamed\fR. When manually specified otherwise, the check levels must at least be as strict as those specified in the
+\fBnamed\-checkzone\fR, but it always dumps the zone contents to a specified file in a specified format\&. Additionally, it applies stricter check levels by default, since the dump output will be used as an actual zone file loaded by
+\fBnamed\fR\&. When manually specified otherwise, the check levels must at least be as strict as those specified in the
\fBnamed\fR
-configuration file.
+configuration file\&.
.SH "OPTIONS"
.PP
\-d
.RS 4
-Enable debugging.
+Enable debugging\&.
.RE
.PP
\-h
.RS 4
-Print the usage summary and exit.
+Print the usage summary and exit\&.
.RE
.PP
\-q
.RS 4
-Quiet mode \- exit code only.
+Quiet mode \- exit code only\&.
.RE
.PP
\-v
.RS 4
Print the version of the
\fBnamed\-checkzone\fR
-program and exit.
+program and exit\&.
.RE
.PP
\-j
.RS 4
-When loading a zone file, read the journal if it exists. The journal file name is assumed to be the zone file name appended with the string
-\fI.jnl\fR.
+When loading a zone file, read the journal if it exists\&. The journal file name is assumed to be the zone file name appended with the string
+\&.jnl\&.
.RE
.PP
\-J \fIfilename\fR
.RS 4
-When loading the zone file read the journal from the given file, if it exists. (Implies \-j.)
+When loading the zone file read the journal from the given file, if it exists\&. (Implies \-j\&.)
.RE
.PP
\-c \fIclass\fR
.RS 4
-Specify the class of the zone. If not specified, "IN" is assumed.
+Specify the class of the zone\&. If not specified, "IN" is assumed\&.
.RE
.PP
\-i \fImode\fR
.RS 4
-Perform post\-load zone integrity checks. Possible modes are
+Perform post\-load zone integrity checks\&. Possible modes are
\fB"full"\fR
(default),
\fB"full\-sibling"\fR,
\fB"local"\fR,
\fB"local\-sibling"\fR
and
-\fB"none"\fR.
+\fB"none"\fR\&.
.sp
Mode
\fB"full"\fR
-checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode
+checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. Mode
\fB"local"\fR
-only checks MX records which refer to in\-zone hostnames.
+only checks MX records which refer to in\-zone hostnames\&.
.sp
Mode
\fB"full"\fR
-checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode
+checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. Mode
\fB"local"\fR
-only checks SRV records which refer to in\-zone hostnames.
+only checks SRV records which refer to in\-zone hostnames\&.
.sp
Mode
\fB"full"\fR
-checks that delegation NS records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). It also checks that glue address records in the zone match those advertised by the child. Mode
+checks that delegation NS records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. It also checks that glue address records in the zone match those advertised by the child\&. Mode
\fB"local"\fR
-only checks NS records which refer to in\-zone hostnames or that some required glue exists, that is when the nameserver is in a child zone.
+only checks NS records which refer to in\-zone hostnames or that some required glue exists, that is when the nameserver is in a child zone\&.
.sp
Mode
\fB"full\-sibling"\fR
\fB"full"\fR
and
\fB"local"\fR
-respectively.
+respectively\&.
.sp
Mode
\fB"none"\fR
-disables the checks.
+disables the checks\&.
.RE
.PP
\-f \fIformat\fR
.RS 4
-Specify the format of the zone file. Possible formats are
+Specify the format of the zone file\&. Possible formats are
\fB"text"\fR
(default),
\fB"raw"\fR, and
-\fB"map"\fR.
+\fB"map"\fR\&.
.RE
.PP
\-F \fIformat\fR
.RS 4
-Specify the format of the output file specified. For
-\fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents.
+Specify the format of the output file specified\&. For
+\fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents\&.
.sp
Possible formats are
\fB"text"\fR
\fB"map"\fR,
\fB"raw"\fR, and
\fB"raw=N"\fR, which store the zone in a binary format for rapid loading by
-\fBnamed\fR.
+\fBnamed\fR\&.
\fB"raw=N"\fR
specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of
-\fBnamed\fR; if N is 1, the file can be read by release 9.9.0 or higher; the default is 1.
+\fBnamed\fR; if N is 1, the file can be read by release 9\&.9\&.0 or higher; the default is 1\&.
.RE
.PP
\-k \fImode\fR
.RS 4
Perform
\fB"check\-names"\fR
-checks with the specified failure mode. Possible modes are
+checks with the specified failure mode\&. Possible modes are
\fB"fail"\fR
(default for
\fBnamed\-compilezone\fR),
\fB"warn"\fR
(default for
\fBnamed\-checkzone\fR) and
-\fB"ignore"\fR.
+\fB"ignore"\fR\&.
.RE
.PP
\-l \fIttl\fR
.RS 4
-Sets a maximum permissible TTL for the input file. Any record with a TTL higher than this value will cause the zone to be rejected. This is similar to using the
+Sets a maximum permissible TTL for the input file\&. Any record with a TTL higher than this value will cause the zone to be rejected\&. This is similar to using the
\fBmax\-zone\-ttl\fR
option in
-\fInamed.conf\fR.
+named\&.conf\&.
.RE
.PP
\-L \fIserial\fR
.RS 4
-When compiling a zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.)
+When compiling a zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number\&. (This is expected to be used primarily for testing purposes\&.)
.RE
.PP
\-m \fImode\fR
.RS 4
-Specify whether MX records should be checked to see if they are addresses. Possible modes are
+Specify whether MX records should be checked to see if they are addresses\&. Possible modes are
\fB"fail"\fR,
\fB"warn"\fR
(default) and
-\fB"ignore"\fR.
+\fB"ignore"\fR\&.
.RE
.PP
\-M \fImode\fR
.RS 4
-Check if a MX record refers to a CNAME. Possible modes are
+Check if a MX record refers to a CNAME\&. Possible modes are
\fB"fail"\fR,
\fB"warn"\fR
(default) and
-\fB"ignore"\fR.
+\fB"ignore"\fR\&.
.RE
.PP
\-n \fImode\fR
.RS 4
-Specify whether NS records should be checked to see if they are addresses. Possible modes are
+Specify whether NS records should be checked to see if they are addresses\&. Possible modes are
\fB"fail"\fR
(default for
\fBnamed\-compilezone\fR),
\fB"warn"\fR
(default for
\fBnamed\-checkzone\fR) and
-\fB"ignore"\fR.
+\fB"ignore"\fR\&.
.RE
.PP
\-o \fIfilename\fR
.RS 4
Write zone output to
-\fIfilename\fR. If
-\fIfilename\fR
+filename\&. If
+filename
is
-\fI\-\fR
-then write to standard out. This is mandatory for
-\fBnamed\-compilezone\fR.
+\-
+then write to standard out\&. This is mandatory for
+\fBnamed\-compilezone\fR\&.
.RE
.PP
\-r \fImode\fR
.RS 4
-Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS. Possible modes are
+Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS\&. Possible modes are
\fB"fail"\fR,
\fB"warn"\fR
(default) and
-\fB"ignore"\fR.
+\fB"ignore"\fR\&.
.RE
.PP
\-s \fIstyle\fR
.RS 4
-Specify the style of the dumped zone file. Possible styles are
+Specify the style of the dumped zone file\&. Possible styles are
\fB"full"\fR
(default) and
-\fB"relative"\fR. The full format is most suitable for processing automatically by a separate script. On the other hand, the relative format is more human\-readable and is thus suitable for editing by hand. For
+\fB"relative"\fR\&. The full format is most suitable for processing automatically by a separate script\&. On the other hand, the relative format is more human\-readable and is thus suitable for editing by hand\&. For
\fBnamed\-checkzone\fR
-this does not cause any effects unless it dumps the zone contents. It also does not have any meaning if the output format is not text.
+this does not cause any effects unless it dumps the zone contents\&. It also does not have any meaning if the output format is not text\&.
.RE
.PP
\-S \fImode\fR
.RS 4
-Check if a SRV record refers to a CNAME. Possible modes are
+Check if a SRV record refers to a CNAME\&. Possible modes are
\fB"fail"\fR,
\fB"warn"\fR
(default) and
-\fB"ignore"\fR.
+\fB"ignore"\fR\&.
.RE
.PP
\-t \fIdirectory\fR
.RS 4
Chroot to
-\fIdirectory\fR
+directory
so that include directives in the configuration file are processed as if run by a similarly chrooted
-\fBnamed\fR.
+\fBnamed\fR\&.
.RE
.PP
\-T \fImode\fR
.RS 4
-Check if Sender Policy Framework (SPF) records exist and issues a warning if an SPF\-formatted TXT record is not also present. Possible modes are
+Check if Sender Policy Framework (SPF) records exist and issues a warning if an SPF\-formatted TXT record is not also present\&. Possible modes are
\fB"warn"\fR
(default),
-\fB"ignore"\fR.
+\fB"ignore"\fR\&.
.RE
.PP
\-w \fIdirectory\fR
.RS 4
chdir to
-\fIdirectory\fR
-so that relative filenames in master file $INCLUDE directives work. This is similar to the directory clause in
-\fInamed.conf\fR.
+directory
+so that relative filenames in master file $INCLUDE directives work\&. This is similar to the directory clause in
+named\&.conf\&.
.RE
.PP
\-D
.RS 4
-Dump zone file in canonical format. This is always enabled for
-\fBnamed\-compilezone\fR.
+Dump zone file in canonical format\&. This is always enabled for
+\fBnamed\-compilezone\fR\&.
.RE
.PP
\-W \fImode\fR
.RS 4
-Specify whether to check for non\-terminal wildcards. Non\-terminal wildcards are almost always the result of a failure to understand the wildcard matching algorithm (RFC 1034). Possible modes are
+Specify whether to check for non\-terminal wildcards\&. Non\-terminal wildcards are almost always the result of a failure to understand the wildcard matching algorithm (RFC 1034)\&. Possible modes are
\fB"warn"\fR
(default) and
-\fB"ignore"\fR.
+\fB"ignore"\fR\&.
.RE
.PP
zonename
.RS 4
-The domain name of the zone being checked.
+The domain name of the zone being checked\&.
.RE
.PP
filename
.RS 4
-The name of the zone file.
+The name of the zone file\&.
.RE
.SH "RETURN VALUES"
.PP
\fBnamed\-checkzone\fR
-returns an exit status of 1 if errors were detected and 0 otherwise.
+returns an exit status of 1 if errors were detected and 0 otherwise\&.
.SH "SEE ALSO"
.PP
\fBnamed\fR(8),
-\fBnamed\-checkconf\fR(8),
+\fBnamed-checkconf\fR(8),
RFC 1035,
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004\-2007, 2009\-2015 Internet Systems Consortium, Inc. ("ISC")
.br
-Copyright \(co 2000\-2002 Internet Software Consortium.
+Copyright \(co 2004-2007, 2009-2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2000-2002 Internet Software Consortium.
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-checkzone">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-checkzone</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="named-checkzone">
<a name="man.named-checkzone"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">named-checkzone</span>, <span class="application">named-compilezone</span> — zone file validity checking or converting tool</p>
+<p>
+ <span class="application">named-checkzone</span>,
+ <span class="application">named-compilezone</span>
+ — zone file validity checking or converting tool
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">named-checkzone</code> [<code class="option">-d</code>] [<code class="option">-h</code>] [<code class="option">-j</code>] [<code class="option">-q</code>] [<code class="option">-v</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-f <em class="replaceable"><code>format</code></em></code>] [<code class="option">-F <em class="replaceable"><code>format</code></em></code>] [<code class="option">-J <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-i <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-k <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-m <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-M <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-n <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-l <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>] [<code class="option">-o <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-r <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-s <em class="replaceable"><code>style</code></em></code>] [<code class="option">-S <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-T <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-w <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-D</code>] [<code class="option">-W <em class="replaceable"><code>mode</code></em></code>] {zonename} {filename}</p></div>
-<div class="cmdsynopsis"><p><code class="command">named-compilezone</code> [<code class="option">-d</code>] [<code class="option">-j</code>] [<code class="option">-q</code>] [<code class="option">-v</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-C <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-f <em class="replaceable"><code>format</code></em></code>] [<code class="option">-F <em class="replaceable"><code>format</code></em></code>] [<code class="option">-J <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-i <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-k <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-m <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-n <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-l <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>] [<code class="option">-r <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-s <em class="replaceable"><code>style</code></em></code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-T <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-w <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-D</code>] [<code class="option">-W <em class="replaceable"><code>mode</code></em></code>] {<code class="option">-o <em class="replaceable"><code>filename</code></em></code>} {zonename} {filename}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543787"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">named-checkzone</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">named-checkzone</code>
+ [<code class="option">-d</code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-j</code>]
+ [<code class="option">-q</code>]
+ [<code class="option">-v</code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>format</code></em></code>]
+ [<code class="option">-F <em class="replaceable"><code>format</code></em></code>]
+ [<code class="option">-J <em class="replaceable"><code>filename</code></em></code>]
+ [<code class="option">-i <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-k <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-m <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-M <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-n <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-l <em class="replaceable"><code>ttl</code></em></code>]
+ [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>]
+ [<code class="option">-o <em class="replaceable"><code>filename</code></em></code>]
+ [<code class="option">-r <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-s <em class="replaceable"><code>style</code></em></code>]
+ [<code class="option">-S <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-T <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-w <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-D</code>]
+ [<code class="option">-W <em class="replaceable"><code>mode</code></em></code>]
+ {zonename}
+ {filename}
+ </p></div>
+ <div class="cmdsynopsis"><p>
+ <code class="command">named-compilezone</code>
+ [<code class="option">-d</code>]
+ [<code class="option">-j</code>]
+ [<code class="option">-q</code>]
+ [<code class="option">-v</code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-C <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>format</code></em></code>]
+ [<code class="option">-F <em class="replaceable"><code>format</code></em></code>]
+ [<code class="option">-J <em class="replaceable"><code>filename</code></em></code>]
+ [<code class="option">-i <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-k <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-m <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-n <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-l <em class="replaceable"><code>ttl</code></em></code>]
+ [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>]
+ [<code class="option">-r <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-s <em class="replaceable"><code>style</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-T <em class="replaceable"><code>mode</code></em></code>]
+ [<code class="option">-w <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-D</code>]
+ [<code class="option">-W <em class="replaceable"><code>mode</code></em></code>]
+ {<code class="option">-o <em class="replaceable"><code>filename</code></em></code>}
+ {zonename}
+ {filename}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61131216"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>named-checkzone</strong></span>
checks the syntax and integrity of a zone file. It performs the
- same checks as <span><strong class="command">named</strong></span> does when loading a
- zone. This makes <span><strong class="command">named-checkzone</strong></span> useful for
+ same checks as <span class="command"><strong>named</strong></span> does when loading a
+ zone. This makes <span class="command"><strong>named-checkzone</strong></span> useful for
checking zone files before configuring them into a name server.
</p>
-<p>
- <span><strong class="command">named-compilezone</strong></span> is similar to
- <span><strong class="command">named-checkzone</strong></span>, but it always dumps the
+ <p>
+ <span class="command"><strong>named-compilezone</strong></span> is similar to
+ <span class="command"><strong>named-checkzone</strong></span>, but it always dumps the
zone contents to a specified file in a specified format.
Additionally, it applies stricter check levels by default,
since the dump output will be used as an actual zone file
- loaded by <span><strong class="command">named</strong></span>.
+ loaded by <span class="command"><strong>named</strong></span>.
When manually specified otherwise, the check levels must at
least be as strict as those specified in the
- <span><strong class="command">named</strong></span> configuration file.
+ <span class="command"><strong>named</strong></span> configuration file.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543822"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61135696"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-d</span></dt>
-<dd><p>
+<dd>
+ <p>
Enable debugging.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Print the usage summary and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-q</span></dt>
-<dd><p>
+<dd>
+ <p>
Quiet mode - exit code only.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v</span></dt>
-<dd><p>
- Print the version of the <span><strong class="command">named-checkzone</strong></span>
+<dd>
+ <p>
+ Print the version of the <span class="command"><strong>named-checkzone</strong></span>
program and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-j</span></dt>
-<dd><p>
+<dd>
+ <p>
When loading a zone file, read the journal if it exists.
The journal file name is assumed to be the zone file name
appended with the string <code class="filename">.jnl</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-J <em class="replaceable"><code>filename</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
When loading the zone file read the journal from the given
file, if it exists. (Implies -j.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify the class of the zone. If not specified, "IN" is assumed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-i <em class="replaceable"><code>mode</code></em></span></dt>
<dd>
-<p>
+ <p>
Perform post-load zone integrity checks. Possible modes are
- <span><strong class="command">"full"</strong></span> (default),
- <span><strong class="command">"full-sibling"</strong></span>,
- <span><strong class="command">"local"</strong></span>,
- <span><strong class="command">"local-sibling"</strong></span> and
- <span><strong class="command">"none"</strong></span>.
+ <span class="command"><strong>"full"</strong></span> (default),
+ <span class="command"><strong>"full-sibling"</strong></span>,
+ <span class="command"><strong>"local"</strong></span>,
+ <span class="command"><strong>"local-sibling"</strong></span> and
+ <span class="command"><strong>"none"</strong></span>.
</p>
-<p>
- Mode <span><strong class="command">"full"</strong></span> checks that MX records
+ <p>
+ Mode <span class="command"><strong>"full"</strong></span> checks that MX records
refer to A or AAAA record (both in-zone and out-of-zone
- hostnames). Mode <span><strong class="command">"local"</strong></span> only
+ hostnames). Mode <span class="command"><strong>"local"</strong></span> only
checks MX records which refer to in-zone hostnames.
</p>
-<p>
- Mode <span><strong class="command">"full"</strong></span> checks that SRV records
+ <p>
+ Mode <span class="command"><strong>"full"</strong></span> checks that SRV records
refer to A or AAAA record (both in-zone and out-of-zone
- hostnames). Mode <span><strong class="command">"local"</strong></span> only
+ hostnames). Mode <span class="command"><strong>"local"</strong></span> only
checks SRV records which refer to in-zone hostnames.
</p>
-<p>
- Mode <span><strong class="command">"full"</strong></span> checks that delegation NS
+ <p>
+ Mode <span class="command"><strong>"full"</strong></span> checks that delegation NS
records refer to A or AAAA record (both in-zone and out-of-zone
hostnames). It also checks that glue address records
in the zone match those advertised by the child.
- Mode <span><strong class="command">"local"</strong></span> only checks NS records which
+ Mode <span class="command"><strong>"local"</strong></span> only checks NS records which
refer to in-zone hostnames or that some required glue exists,
that is when the nameserver is in a child zone.
</p>
-<p>
- Mode <span><strong class="command">"full-sibling"</strong></span> and
- <span><strong class="command">"local-sibling"</strong></span> disable sibling glue
- checks but are otherwise the same as <span><strong class="command">"full"</strong></span>
- and <span><strong class="command">"local"</strong></span> respectively.
+ <p>
+ Mode <span class="command"><strong>"full-sibling"</strong></span> and
+ <span class="command"><strong>"local-sibling"</strong></span> disable sibling glue
+ checks but are otherwise the same as <span class="command"><strong>"full"</strong></span>
+ and <span class="command"><strong>"local"</strong></span> respectively.
</p>
-<p>
- Mode <span><strong class="command">"none"</strong></span> disables the checks.
+ <p>
+ Mode <span class="command"><strong>"none"</strong></span> disables the checks.
</p>
-</dd>
+ </dd>
<dt><span class="term">-f <em class="replaceable"><code>format</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify the format of the zone file.
- Possible formats are <span><strong class="command">"text"</strong></span> (default),
- <span><strong class="command">"raw"</strong></span>, and <span><strong class="command">"map"</strong></span>.
- </p></dd>
+ Possible formats are <span class="command"><strong>"text"</strong></span> (default),
+ <span class="command"><strong>"raw"</strong></span>, and <span class="command"><strong>"map"</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-F <em class="replaceable"><code>format</code></em></span></dt>
<dd>
-<p>
+ <p>
Specify the format of the output file specified.
- For <span><strong class="command">named-checkzone</strong></span>,
+ For <span class="command"><strong>named-checkzone</strong></span>,
this does not cause any effects unless it dumps the zone
contents.
</p>
-<p>
- Possible formats are <span><strong class="command">"text"</strong></span> (default),
+ <p>
+ Possible formats are <span class="command"><strong>"text"</strong></span> (default),
which is the standard textual representation of the zone,
- and <span><strong class="command">"map"</strong></span>, <span><strong class="command">"raw"</strong></span>,
- and <span><strong class="command">"raw=N"</strong></span>, which store the zone in a
- binary format for rapid loading by <span><strong class="command">named</strong></span>.
- <span><strong class="command">"raw=N"</strong></span> specifies the format version of
+ and <span class="command"><strong>"map"</strong></span>, <span class="command"><strong>"raw"</strong></span>,
+ and <span class="command"><strong>"raw=N"</strong></span>, which store the zone in a
+ binary format for rapid loading by <span class="command"><strong>named</strong></span>.
+ <span class="command"><strong>"raw=N"</strong></span> specifies the format version of
the raw zone file: if N is 0, the raw file can be read by
- any version of <span><strong class="command">named</strong></span>; if N is 1, the file
+ any version of <span class="command"><strong>named</strong></span>; if N is 1, the file
can be read by release 9.9.0 or higher; the default is 1.
</p>
-</dd>
+ </dd>
<dt><span class="term">-k <em class="replaceable"><code>mode</code></em></span></dt>
-<dd><p>
- Perform <span><strong class="command">"check-names"</strong></span> checks with the
+<dd>
+ <p>
+ Perform <span class="command"><strong>"check-names"</strong></span> checks with the
specified failure mode.
- Possible modes are <span><strong class="command">"fail"</strong></span>
- (default for <span><strong class="command">named-compilezone</strong></span>),
- <span><strong class="command">"warn"</strong></span>
- (default for <span><strong class="command">named-checkzone</strong></span>) and
- <span><strong class="command">"ignore"</strong></span>.
- </p></dd>
+ Possible modes are <span class="command"><strong>"fail"</strong></span>
+ (default for <span class="command"><strong>named-compilezone</strong></span>),
+ <span class="command"><strong>"warn"</strong></span>
+ (default for <span class="command"><strong>named-checkzone</strong></span>) and
+ <span class="command"><strong>"ignore"</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-l <em class="replaceable"><code>ttl</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets a maximum permissible TTL for the input file.
Any record with a TTL higher than this value will cause
the zone to be rejected. This is similar to using the
- <span><strong class="command">max-zone-ttl</strong></span> option in
+ <span class="command"><strong>max-zone-ttl</strong></span> option in
<code class="filename">named.conf</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-L <em class="replaceable"><code>serial</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
When compiling a zone to "raw" or "map" format, set the
"source serial" value in the header to the specified serial
number. (This is expected to be used primarily for testing
purposes.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-m <em class="replaceable"><code>mode</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify whether MX records should be checked to see if they
- are addresses. Possible modes are <span><strong class="command">"fail"</strong></span>,
- <span><strong class="command">"warn"</strong></span> (default) and
- <span><strong class="command">"ignore"</strong></span>.
- </p></dd>
+ are addresses. Possible modes are <span class="command"><strong>"fail"</strong></span>,
+ <span class="command"><strong>"warn"</strong></span> (default) and
+ <span class="command"><strong>"ignore"</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-M <em class="replaceable"><code>mode</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Check if a MX record refers to a CNAME.
- Possible modes are <span><strong class="command">"fail"</strong></span>,
- <span><strong class="command">"warn"</strong></span> (default) and
- <span><strong class="command">"ignore"</strong></span>.
- </p></dd>
+ Possible modes are <span class="command"><strong>"fail"</strong></span>,
+ <span class="command"><strong>"warn"</strong></span> (default) and
+ <span class="command"><strong>"ignore"</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-n <em class="replaceable"><code>mode</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify whether NS records should be checked to see if they
are addresses.
- Possible modes are <span><strong class="command">"fail"</strong></span>
- (default for <span><strong class="command">named-compilezone</strong></span>),
- <span><strong class="command">"warn"</strong></span>
- (default for <span><strong class="command">named-checkzone</strong></span>) and
- <span><strong class="command">"ignore"</strong></span>.
- </p></dd>
+ Possible modes are <span class="command"><strong>"fail"</strong></span>
+ (default for <span class="command"><strong>named-compilezone</strong></span>),
+ <span class="command"><strong>"warn"</strong></span>
+ (default for <span class="command"><strong>named-checkzone</strong></span>) and
+ <span class="command"><strong>"ignore"</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-o <em class="replaceable"><code>filename</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Write zone output to <code class="filename">filename</code>.
If <code class="filename">filename</code> is <code class="filename">-</code> then
write to standard out.
- This is mandatory for <span><strong class="command">named-compilezone</strong></span>.
- </p></dd>
+ This is mandatory for <span class="command"><strong>named-compilezone</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-r <em class="replaceable"><code>mode</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Check for records that are treated as different by DNSSEC but
are semantically equal in plain DNS.
- Possible modes are <span><strong class="command">"fail"</strong></span>,
- <span><strong class="command">"warn"</strong></span> (default) and
- <span><strong class="command">"ignore"</strong></span>.
- </p></dd>
+ Possible modes are <span class="command"><strong>"fail"</strong></span>,
+ <span class="command"><strong>"warn"</strong></span> (default) and
+ <span class="command"><strong>"ignore"</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-s <em class="replaceable"><code>style</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify the style of the dumped zone file.
- Possible styles are <span><strong class="command">"full"</strong></span> (default)
- and <span><strong class="command">"relative"</strong></span>.
+ Possible styles are <span class="command"><strong>"full"</strong></span> (default)
+ and <span class="command"><strong>"relative"</strong></span>.
The full format is most suitable for processing
automatically by a separate script.
On the other hand, the relative format is more
human-readable and is thus suitable for editing by hand.
- For <span><strong class="command">named-checkzone</strong></span>
+ For <span class="command"><strong>named-checkzone</strong></span>
this does not cause any effects unless it dumps the zone
contents.
It also does not have any meaning if the output format
is not text.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-S <em class="replaceable"><code>mode</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Check if a SRV record refers to a CNAME.
- Possible modes are <span><strong class="command">"fail"</strong></span>,
- <span><strong class="command">"warn"</strong></span> (default) and
- <span><strong class="command">"ignore"</strong></span>.
- </p></dd>
+ Possible modes are <span class="command"><strong>"fail"</strong></span>,
+ <span class="command"><strong>"warn"</strong></span> (default) and
+ <span class="command"><strong>"ignore"</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Chroot to <code class="filename">directory</code> so that
include
directives in the configuration file are processed as if
- run by a similarly chrooted <span><strong class="command">named</strong></span>.
- </p></dd>
+ run by a similarly chrooted <span class="command"><strong>named</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-T <em class="replaceable"><code>mode</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Check if Sender Policy Framework (SPF) records exist
and issues a warning if an SPF-formatted TXT record is
- not also present. Possible modes are <span><strong class="command">"warn"</strong></span>
- (default), <span><strong class="command">"ignore"</strong></span>.
- </p></dd>
+ not also present. Possible modes are <span class="command"><strong>"warn"</strong></span>
+ (default), <span class="command"><strong>"ignore"</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-w <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
chdir to <code class="filename">directory</code> so that
relative
filenames in master file $INCLUDE directives work. This
is similar to the directory clause in
<code class="filename">named.conf</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-D</span></dt>
-<dd><p>
+<dd>
+ <p>
Dump zone file in canonical format.
- This is always enabled for <span><strong class="command">named-compilezone</strong></span>.
- </p></dd>
+ This is always enabled for <span class="command"><strong>named-compilezone</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-W <em class="replaceable"><code>mode</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify whether to check for non-terminal wildcards.
Non-terminal wildcards are almost always the result of a
failure to understand the wildcard matching algorithm (RFC 1034).
- Possible modes are <span><strong class="command">"warn"</strong></span> (default)
+ Possible modes are <span class="command"><strong>"warn"</strong></span> (default)
and
- <span><strong class="command">"ignore"</strong></span>.
- </p></dd>
+ <span class="command"><strong>"ignore"</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">zonename</span></dt>
-<dd><p>
+<dd>
+ <p>
The domain name of the zone being checked.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">filename</span></dt>
-<dd><p>
+<dd>
+ <p>
The name of the zone file.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544716"></a><h2>RETURN VALUES</h2>
-<p><span><strong class="command">named-checkzone</strong></span>
+
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp61220944"></a><h2>RETURN VALUES</h2>
+
+ <p><span class="command"><strong>named-checkzone</strong></span>
returns an exit status of 1 if
errors were detected and 0 otherwise.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544728"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61222608"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named-checkconf</span>(8)
+ </span>,
<em class="citetitle">RFC 1035</em>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544761"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: ddns\-confgen
+'\" t
+.\" Title: ddns-confgen
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: March 6, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-03-06
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DDNS\-CONFGEN" "8" "March 6, 2014" "BIND9" "BIND9"
+.TH "DDNS\-CONFGEN" "8" "2014\-03\-06" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-ddns\-confgen \- ddns key generation tool
+ddns-confgen \- ddns key generation tool
.SH "SYNOPSIS"
.HP 12
\fBtsig\-keygen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [name]
\fBtsig\-keygen\fR
and
\fBddns\-confgen\fR
-are invocation methods for a utility that generates keys for use in TSIG signing. The resulting keys can be used, for example, to secure dynamic DNS updates to a zone or for the
+are invocation methods for a utility that generates keys for use in TSIG signing\&. The resulting keys can be used, for example, to secure dynamic DNS updates to a zone or for the
\fBrndc\fR
-command channel.
+command channel\&.
.PP
When run as
-\fBtsig\-keygen\fR, a domain name can be specified on the command line which will be used as the name of the generated key. If no name is specified, the default is
-\fBtsig\-key\fR.
+\fBtsig\-keygen\fR, a domain name can be specified on the command line which will be used as the name of the generated key\&. If no name is specified, the default is
+\fBtsig\-key\fR\&.
.PP
When run as
\fBddns\-confgen\fR, the generated key is accompanied by configuration text and instructions that can be used with
\fBnamed\fR
when setting up dynamic DNS, including an example
\fBupdate\-policy\fR
-statement. (This usage similar to the
+statement\&. (This usage similar to the
\fBrndc\-confgen\fR
-command for setting up command channel security.)
+command for setting up command channel security\&.)
.PP
Note that
\fBnamed\fR
itself can configure a local DDNS key for use with
\fBnsupdate \-l\fR: it does this when a zone is configured with
-\fBupdate\-policy local;\fR.
+\fBupdate\-policy local;\fR\&.
\fBddns\-confgen\fR
is only needed when a more elaborate configuration is required: for instance, if
\fBnsupdate\fR
-is to be used from a remote system.
+is to be used from a remote system\&.
.SH "OPTIONS"
.PP
\-a \fIalgorithm\fR
.RS 4
-Specifies the algorithm to use for the TSIG key. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512. The default is hmac\-sha256. Options are case\-insensitive, and the "hmac\-" prefix may be omitted.
+Specifies the algorithm to use for the TSIG key\&. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512\&. The default is hmac\-sha256\&. Options are case\-insensitive, and the "hmac\-" prefix may be omitted\&.
.RE
.PP
\-h
.RS 4
-Prints a short summary of options and arguments.
+Prints a short summary of options and arguments\&.
.RE
.PP
\-k \fIkeyname\fR
.RS 4
-Specifies the key name of the DDNS authentication key. The default is
+Specifies the key name of the DDNS authentication key\&. The default is
\fBddns\-key\fR
when neither the
\fB\-s\fR
\fB\-z\fR
option is specified; otherwise, the default is
\fBddns\-key\fR
-as a separate label followed by the argument of the option, e.g.,
-\fBddns\-key.example.com.\fR
-The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods.
+as a separate label followed by the argument of the option, e\&.g\&.,
+\fBddns\-key\&.example\&.com\&.\fR
+The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods\&.
.RE
.PP
\-q
.RS 4
(\fBddns\-confgen\fR
-only.) Quiet mode: Print only the key, with no explanatory text or usage examples; This is essentially identical to
-\fBtsig\-keygen\fR.
+only\&.) Quiet mode: Print only the key, with no explanatory text or usage examples; This is essentially identical to
+\fBtsig\-keygen\fR\&.
.RE
.PP
\-r \fIrandomfile\fR
.RS 4
-Specifies a source of random data for generating the authorization. If the operating system does not provide a
-\fI/dev/random\fR
-or equivalent device, the default source of randomness is keyboard input.
-\fIrandomdev\fR
-specifies the name of a character device or file containing random data to be used instead of the default. The special value
-\fIkeyboard\fR
-indicates that keyboard input should be used.
+Specifies a source of random data for generating the authorization\&. If the operating system does not provide a
+/dev/random
+or equivalent device, the default source of randomness is keyboard input\&.
+randomdev
+specifies the name of a character device or file containing random data to be used instead of the default\&. The special value
+keyboard
+indicates that keyboard input should be used\&.
.RE
.PP
\-s \fIname\fR
.RS 4
(\fBddns\-confgen\fR
-only.) Generate configuration example to allow dynamic updates of a single hostname. The example
-\fBnamed.conf\fR
+only\&.) Generate configuration example to allow dynamic updates of a single hostname\&. The example
+\fBnamed\&.conf\fR
text shows how to set an update policy for the specified
\fIname\fR
-using the "name" nametype. The default key name is ddns\-key.\fIname\fR. Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name. This option cannot be used with the
+using the "name" nametype\&. The default key name is ddns\-key\&.\fIname\fR\&. Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name\&. This option cannot be used with the
\fB\-z\fR
-option.
+option\&.
.RE
.PP
\-z \fIzone\fR
.RS 4
(\fBddns\-confgen\fR
-only.) Generate configuration example to allow dynamic updates of a zone: The example
-\fBnamed.conf\fR
+only\&.) Generate configuration example to allow dynamic updates of a zone: The example
+\fBnamed\&.conf\fR
text shows how to set an update policy for the specified
\fIzone\fR
using the "zonesub" nametype, allowing updates to all subdomain names within that
-\fIzone\fR. This option cannot be used with the
+\fIzone\fR\&. This option cannot be used with the
\fB\-s\fR
-option.
+option\&.
.RE
.SH "SEE ALSO"
.PP
\fBnsupdate\fR(1),
\fBnamed.conf\fR(5),
\fBnamed\fR(8),
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.ddns-confgen">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>ddns-confgen</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="ddns-confgen">
<a name="man.ddns-confgen"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
+<p>
+ <span class="application">ddns-confgen</span>
+ — ddns key generation tool
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">tsig-keygen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-h</code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [name]</p></div>
-<div class="cmdsynopsis"><p><code class="command">ddns-confgen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-q</code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [ -s <em class="replaceable"><code>name</code></em> | -z <em class="replaceable"><code>zone</code></em> ]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543434"></a><h2>DESCRIPTION</h2>
-<p>
- <span><strong class="command">tsig-keygen</strong></span> and <span><strong class="command">ddns-confgen</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">tsig-keygen</code>
+ [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>]
+ [name]
+ </p></div>
+ <div class="cmdsynopsis"><p>
+ <code class="command">ddns-confgen</code>
+ [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>]
+ [<code class="option">-q</code>]
+ [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>]
+ [
+ -s <em class="replaceable"><code>name</code></em>
+ | -z <em class="replaceable"><code>zone</code></em>
+ ]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60888272"></a><h2>DESCRIPTION</h2>
+
+ <p>
+ <span class="command"><strong>tsig-keygen</strong></span> and <span class="command"><strong>ddns-confgen</strong></span>
are invocation methods for a utility that generates keys for use
in TSIG signing. The resulting keys can be used, for example,
to secure dynamic DNS updates to a zone or for the
- <span><strong class="command">rndc</strong></span> command channel.
+ <span class="command"><strong>rndc</strong></span> command channel.
</p>
-<p>
- When run as <span><strong class="command">tsig-keygen</strong></span>, a domain name
+
+ <p>
+ When run as <span class="command"><strong>tsig-keygen</strong></span>, a domain name
can be specified on the command line which will be used as
the name of the generated key. If no name is specified,
the default is <code class="constant">tsig-key</code>.
</p>
-<p>
- When run as <span><strong class="command">ddns-confgen</strong></span>, the generated
+
+ <p>
+ When run as <span class="command"><strong>ddns-confgen</strong></span>, the generated
key is accompanied by configuration text and instructions
- that can be used with <span><strong class="command">nsupdate</strong></span> and
- <span><strong class="command">named</strong></span> when setting up dynamic DNS,
- including an example <span><strong class="command">update-policy</strong></span>
+ that can be used with <span class="command"><strong>nsupdate</strong></span> and
+ <span class="command"><strong>named</strong></span> when setting up dynamic DNS,
+ including an example <span class="command"><strong>update-policy</strong></span>
statement. (This usage similar to the
- <span><strong class="command">rndc-confgen</strong></span> command for setting
+ <span class="command"><strong>rndc-confgen</strong></span> command for setting
up command channel security.)
</p>
-<p>
- Note that <span><strong class="command">named</strong></span> itself can configure a
- local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>:
+
+ <p>
+ Note that <span class="command"><strong>named</strong></span> itself can configure a
+ local DDNS key for use with <span class="command"><strong>nsupdate -l</strong></span>:
it does this when a zone is configured with
- <span><strong class="command">update-policy local;</strong></span>.
- <span><strong class="command">ddns-confgen</strong></span> is only needed when a
+ <span class="command"><strong>update-policy local;</strong></span>.
+ <span class="command"><strong>ddns-confgen</strong></span> is only needed when a
more elaborate configuration is required: for instance,
- if <span><strong class="command">nsupdate</strong></span> is to be used from a remote
+ if <span class="command"><strong>nsupdate</strong></span> is to be used from a remote
system.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543508"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60900816"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the algorithm to use for the TSIG key. Available
choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
hmac-sha384 and hmac-sha512. The default is hmac-sha256.
Options are case-insensitive, and the "hmac-" prefix
may be omitted.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints a short summary of options and arguments.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the key name of the DDNS authentication key.
The default is <code class="constant">ddns-key</code> when neither
the <code class="option">-s</code> nor <code class="option">-z</code> option is
<code class="constant">ddns-key.example.com.</code>
The key name must have the format of a valid domain name,
consisting of letters, digits, hyphens and periods.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-q</span></dt>
-<dd><p>
- (<span><strong class="command">ddns-confgen</strong></span> only.) Quiet mode: Print
+<dd>
+ <p>
+ (<span class="command"><strong>ddns-confgen</strong></span> only.) Quiet mode: Print
only the key, with no explanatory text or usage examples;
- This is essentially identical to <span><strong class="command">tsig-keygen</strong></span>.
- </p></dd>
+ This is essentially identical to <span class="command"><strong>tsig-keygen</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies a source of random data for generating the
authorization. If the operating system does not provide a
<code class="filename">/dev/random</code> or equivalent device, the
instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard input
should be used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
-<dd><p>
- (<span><strong class="command">ddns-confgen</strong></span> only.)
+<dd>
+ <p>
+ (<span class="command"><strong>ddns-confgen</strong></span> only.)
Generate configuration example to allow dynamic updates
- of a single hostname. The example <span><strong class="command">named.conf</strong></span>
+ of a single hostname. The example <span class="command"><strong>named.conf</strong></span>
text shows how to set an update policy for the specified
<em class="replaceable"><code>name</code></em>
using the "name" nametype. The default key name is
Note that the "self" nametype cannot be used, since
the name to be updated may differ from the key name.
This option cannot be used with the <code class="option">-z</code> option.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
-<dd><p>
- (<span><strong class="command">ddns-confgen</strong></span> only.)
+<dd>
+ <p>
+ (<span class="command"><strong>ddns-confgen</strong></span> only.)
Generate configuration example to allow dynamic updates
- of a zone: The example <span><strong class="command">named.conf</strong></span> text
+ of a zone: The example <span class="command"><strong>named.conf</strong></span> text
shows how to set an update policy for the specified
<em class="replaceable"><code>zone</code></em>
using the "zonesub" nametype, allowing updates to
all subdomain names within that
<em class="replaceable"><code>zone</code></em>.
This option cannot be used with the <code class="option">-s</code> option.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543705"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
- <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60923856"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">nsupdate</span>(1)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named.conf</span>(5)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543744"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: rndc\-confgen
+'\" t
+.\" Title: rndc-confgen
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: March 14, 2013
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2013-03-14
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "RNDC\-CONFGEN" "8" "March 14, 2013" "BIND9" "BIND9"
+.TH "RNDC\-CONFGEN" "8" "2013\-03\-14" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-rndc\-confgen \- rndc key generation tool
+rndc-confgen \- rndc key generation tool
.SH "SYNOPSIS"
.HP 13
\fBrndc\-confgen\fR [\fB\-a\fR] [\fB\-A\ \fR\fB\fIalgorithm\fR\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-c\ \fR\fB\fIkeyfile\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\fB\-s\ \fR\fB\fIaddress\fR\fR] [\fB\-t\ \fR\fB\fIchrootdir\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR]
.PP
\fBrndc\-confgen\fR
generates configuration files for
-\fBrndc\fR. It can be used as a convenient alternative to writing the
-\fIrndc.conf\fR
+\fBrndc\fR\&. It can be used as a convenient alternative to writing the
+rndc\&.conf
file and the corresponding
\fBcontrols\fR
and
\fBkey\fR
statements in
-\fInamed.conf\fR
-by hand. Alternatively, it can be run with the
+named\&.conf
+by hand\&. Alternatively, it can be run with the
\fB\-a\fR
option to set up a
-\fIrndc.key\fR
+rndc\&.key
file and avoid the need for a
-\fIrndc.conf\fR
+rndc\&.conf
file and a
\fBcontrols\fR
-statement altogether.
+statement altogether\&.
.SH "OPTIONS"
.PP
\-a
.RS 4
Do automatic
\fBrndc\fR
-configuration. This creates a file
-\fIrndc.key\fR
+configuration\&. This creates a file
+rndc\&.key
in
-\fI/etc\fR
+/etc
(or whatever
\fIsysconfdir\fR
was specified as when
\fBrndc\fR
and
\fBnamed\fR
-on startup. The
-\fIrndc.key\fR
+on startup\&. The
+rndc\&.key
file defines a default command channel and authentication key allowing
\fBrndc\fR
to communicate with
\fBnamed\fR
-on the local host with no further configuration.
+on the local host with no further configuration\&.
.sp
Running
\fBrndc\-confgen \-a\fR
\fBrndc\fR
to be used as drop\-in replacements for BIND 8 and
\fBndc\fR, with no changes to the existing BIND 8
-\fInamed.conf\fR
-file.
+named\&.conf
+file\&.
.sp
If a more elaborate configuration than that generated by
\fBrndc\-confgen \-a\fR
without the
\fB\-a\fR
option and set up a
-\fIrndc.conf\fR
+rndc\&.conf
and
-\fInamed.conf\fR
-as directed.
+named\&.conf
+as directed\&.
.RE
.PP
\-A \fIalgorithm\fR
.RS 4
-Specifies the algorithm to use for the TSIG key. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512. The default is hmac\-md5.
+Specifies the algorithm to use for the TSIG key\&. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512\&. The default is hmac\-md5\&.
.RE
.PP
\-b \fIkeysize\fR
.RS 4
-Specifies the size of the authentication key in bits. Must be between 1 and 512 bits; the default is the hash size.
+Specifies the size of the authentication key in bits\&. Must be between 1 and 512 bits; the default is the hash size\&.
.RE
.PP
\-c \fIkeyfile\fR
Used with the
\fB\-a\fR
option to specify an alternate location for
-\fIrndc.key\fR.
+rndc\&.key\&.
.RE
.PP
\-h
.RS 4
Prints a short summary of the options and arguments to
-\fBrndc\-confgen\fR.
+\fBrndc\-confgen\fR\&.
.RE
.PP
\-k \fIkeyname\fR
.RS 4
-Specifies the key name of the rndc authentication key. This must be a valid domain name. The default is
-\fBrndc\-key\fR.
+Specifies the key name of the rndc authentication key\&. This must be a valid domain name\&. The default is
+\fBrndc\-key\fR\&.
.RE
.PP
\-p \fIport\fR
Specifies the command channel port where
\fBnamed\fR
listens for connections from
-\fBrndc\fR. The default is 953.
+\fBrndc\fR\&. The default is 953\&.
.RE
.PP
\-r \fIrandomfile\fR
.RS 4
-Specifies a source of random data for generating the authorization. If the operating system does not provide a
-\fI/dev/random\fR
-or equivalent device, the default source of randomness is keyboard input.
-\fIrandomdev\fR
-specifies the name of a character device or file containing random data to be used instead of the default. The special value
-\fIkeyboard\fR
-indicates that keyboard input should be used.
+Specifies a source of random data for generating the authorization\&. If the operating system does not provide a
+/dev/random
+or equivalent device, the default source of randomness is keyboard input\&.
+randomdev
+specifies the name of a character device or file containing random data to be used instead of the default\&. The special value
+keyboard
+indicates that keyboard input should be used\&.
.RE
.PP
\-s \fIaddress\fR
Specifies the IP address where
\fBnamed\fR
listens for command channel connections from
-\fBrndc\fR. The default is the loopback address 127.0.0.1.
+\fBrndc\fR\&. The default is the loopback address 127\&.0\&.0\&.1\&.
.RE
.PP
\-t \fIchrootdir\fR
\fB\-a\fR
option to specify a directory where
\fBnamed\fR
-will run chrooted. An additional copy of the
-\fIrndc.key\fR
+will run chrooted\&. An additional copy of the
+rndc\&.key
will be written relative to this directory so that it will be found by the chrooted
-\fBnamed\fR.
+\fBnamed\fR\&.
.RE
.PP
\-u \fIuser\fR
Used with the
\fB\-a\fR
option to set the owner of the
-\fIrndc.key\fR
-file generated. If
+rndc\&.key
+file generated\&. If
\fB\-t\fR
-is also specified only the file in the chroot area has its owner changed.
+is also specified only the file in the chroot area has its owner changed\&.
.RE
.SH "EXAMPLES"
.PP
\fBrndc\-confgen \-a\fR
.PP
To print a sample
-\fIrndc.conf\fR
+rndc\&.conf
file and corresponding
\fBcontrols\fR
and
\fBkey\fR
statements to be manually inserted into
-\fInamed.conf\fR, run
+named\&.conf, run
.PP
\fBrndc\-confgen\fR
.SH "SEE ALSO"
\fBrndc\fR(8),
\fBrndc.conf\fR(5),
\fBnamed\fR(8),
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2009, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2001, 2003 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.rndc-confgen">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>rndc-confgen</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="rndc-confgen">
<a name="man.rndc-confgen"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
+<p>
+ <span class="application">rndc-confgen</span>
+ — rndc key generation tool
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">rndc-confgen</code> [<code class="option">-a</code>] [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [<code class="option">-s <em class="replaceable"><code>address</code></em></code>] [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543456"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">rndc-confgen</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">rndc-confgen</code>
+ [<code class="option">-a</code>]
+ [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></code>]
+ [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>]
+ [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>]
+ [<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
+ [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>]
+ [<code class="option">-s <em class="replaceable"><code>address</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>]
+ [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60934224"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>rndc-confgen</strong></span>
generates configuration files
- for <span><strong class="command">rndc</strong></span>. It can be used as a
+ for <span class="command"><strong>rndc</strong></span>. It can be used as a
convenient alternative to writing the
<code class="filename">rndc.conf</code> file
- and the corresponding <span><strong class="command">controls</strong></span>
- and <span><strong class="command">key</strong></span>
+ and the corresponding <span class="command"><strong>controls</strong></span>
+ and <span class="command"><strong>key</strong></span>
statements in <code class="filename">named.conf</code> by hand.
- Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
+ Alternatively, it can be run with the <span class="command"><strong>-a</strong></span>
option to set up a <code class="filename">rndc.key</code> file and
avoid the need for a <code class="filename">rndc.conf</code> file
- and a <span><strong class="command">controls</strong></span> statement altogether.
+ and a <span class="command"><strong>controls</strong></span> statement altogether.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543500"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60939344"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-a</span></dt>
<dd>
-<p>
- Do automatic <span><strong class="command">rndc</strong></span> configuration.
+ <p>
+ Do automatic <span class="command"><strong>rndc</strong></span> configuration.
This creates a file <code class="filename">rndc.key</code>
in <code class="filename">/etc</code> (or whatever
<code class="varname">sysconfdir</code>
was specified as when <acronym class="acronym">BIND</acronym> was
built)
- that is read by both <span><strong class="command">rndc</strong></span>
- and <span><strong class="command">named</strong></span> on startup. The
+ that is read by both <span class="command"><strong>rndc</strong></span>
+ and <span class="command"><strong>named</strong></span> on startup. The
<code class="filename">rndc.key</code> file defines a default
command channel and authentication key allowing
- <span><strong class="command">rndc</strong></span> to communicate with
- <span><strong class="command">named</strong></span> on the local host
+ <span class="command"><strong>rndc</strong></span> to communicate with
+ <span class="command"><strong>named</strong></span> on the local host
with no further configuration.
</p>
-<p>
- Running <span><strong class="command">rndc-confgen -a</strong></span> allows
- BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
+ <p>
+ Running <span class="command"><strong>rndc-confgen -a</strong></span> allows
+ BIND 9 and <span class="command"><strong>rndc</strong></span> to be used as
drop-in
- replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
+ replacements for BIND 8 and <span class="command"><strong>ndc</strong></span>,
with no changes to the existing BIND 8
<code class="filename">named.conf</code> file.
</p>
-<p>
+ <p>
If a more elaborate configuration than that
- generated by <span><strong class="command">rndc-confgen -a</strong></span>
+ generated by <span class="command"><strong>rndc-confgen -a</strong></span>
is required, for example if rndc is to be used remotely,
- you should run <span><strong class="command">rndc-confgen</strong></span> without
+ you should run <span class="command"><strong>rndc-confgen</strong></span> without
the
- <span><strong class="command">-a</strong></span> option and set up a
+ <span class="command"><strong>-a</strong></span> option and set up a
<code class="filename">rndc.conf</code> and
<code class="filename">named.conf</code>
as directed.
</p>
-</dd>
+ </dd>
<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the algorithm to use for the TSIG key. Available
choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
hmac-sha384 and hmac-sha512. The default is hmac-md5.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the size of the authentication key in bits.
Must be between 1 and 512 bits; the default is the
hash size.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
-<dd><p>
- Used with the <span><strong class="command">-a</strong></span> option to specify
+<dd>
+ <p>
+ Used with the <span class="command"><strong>-a</strong></span> option to specify
an alternate location for <code class="filename">rndc.key</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints a short summary of the options and arguments to
- <span><strong class="command">rndc-confgen</strong></span>.
- </p></dd>
+ <span class="command"><strong>rndc-confgen</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the key name of the rndc authentication key.
This must be a valid domain name.
The default is <code class="constant">rndc-key</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
-<dd><p>
- Specifies the command channel port where <span><strong class="command">named</strong></span>
- listens for connections from <span><strong class="command">rndc</strong></span>.
+<dd>
+ <p>
+ Specifies the command channel port where <span class="command"><strong>named</strong></span>
+ listens for connections from <span class="command"><strong>rndc</strong></span>.
The default is 953.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies a source of random data for generating the
authorization. If the operating
system does not provide a <code class="filename">/dev/random</code>
data to be used instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard
input should be used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
-<dd><p>
- Specifies the IP address where <span><strong class="command">named</strong></span>
+<dd>
+ <p>
+ Specifies the IP address where <span class="command"><strong>named</strong></span>
listens for command channel connections from
- <span><strong class="command">rndc</strong></span>. The default is the loopback
+ <span class="command"><strong>rndc</strong></span>. The default is the loopback
address 127.0.0.1.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
-<dd><p>
- Used with the <span><strong class="command">-a</strong></span> option to specify
- a directory where <span><strong class="command">named</strong></span> will run
+<dd>
+ <p>
+ Used with the <span class="command"><strong>-a</strong></span> option to specify
+ a directory where <span class="command"><strong>named</strong></span> will run
chrooted. An additional copy of the <code class="filename">rndc.key</code>
will be written relative to this directory so that
- it will be found by the chrooted <span><strong class="command">named</strong></span>.
- </p></dd>
+ it will be found by the chrooted <span class="command"><strong>named</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
-<dd><p>
- Used with the <span><strong class="command">-a</strong></span> option to set the
+<dd>
+ <p>
+ Used with the <span class="command"><strong>-a</strong></span> option to set the
owner
of the <code class="filename">rndc.key</code> file generated.
If
- <span><strong class="command">-t</strong></span> is also specified only the file
+ <span class="command"><strong>-t</strong></span> is also specified only the file
in
the chroot area has its owner changed.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543831"></a><h2>EXAMPLES</h2>
-<p>
- To allow <span><strong class="command">rndc</strong></span> to be used with
+ </div>
+
+ <div class="refsection" title="EXAMPLES">
+<a name="idp61021776"></a><h2>EXAMPLES</h2>
+
+ <p>
+ To allow <span class="command"><strong>rndc</strong></span> to be used with
no manual configuration, run
</p>
-<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
+ <p><strong class="userinput"><code>rndc-confgen -a</code></strong>
</p>
-<p>
+ <p>
To print a sample <code class="filename">rndc.conf</code> file and
- corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
+ corresponding <span class="command"><strong>controls</strong></span> and <span class="command"><strong>key</strong></span>
statements to be manually inserted into <code class="filename">named.conf</code>,
run
</p>
-<p><strong class="userinput"><code>rndc-confgen</code></strong>
+ <p><strong class="userinput"><code>rndc-confgen</code></strong>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543873"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61026896"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">rndc</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">rndc.conf</span>(5)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543911"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: delv
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: April 23, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-04-23
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DELV" "1" "April 23, 2014" "BIND9" "BIND9"
+.TH "DELV" "1" "2014\-04\-23" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
delv \- DNS lookup and validation utility
.SH "SYNOPSIS"
.PP
\fBdelv\fR
(Domain Entity Lookup & Validation) is a tool for sending DNS queries and validating the results, using the same internal resolver and validator logic as
-\fBnamed\fR.
+\fBnamed\fR\&.
.PP
\fBdelv\fR
-will send to a specified name server all queries needed to fetch and validate the requested data; this includes the original requested query, subsequent queries to follow CNAME or DNAME chains, and queries for DNSKEY, DS and DLV records to establish a chain of trust for DNSSEC validation. It does not perform iterative resolution, but simulates the behavior of a name server configured for DNSSEC validating and forwarding.
+will send to a specified name server all queries needed to fetch and validate the requested data; this includes the original requested query, subsequent queries to follow CNAME or DNAME chains, and queries for DNSKEY, DS and DLV records to establish a chain of trust for DNSSEC validation\&. It does not perform iterative resolution, but simulates the behavior of a name server configured for DNSSEC validating and forwarding\&.
.PP
-By default, responses are validated using built\-in DNSSEC trust anchors for the root zone (".") and for the ISC DNSSEC lookaside validation zone ("dlv.isc.org"). Records returned by
+By default, responses are validated using built\-in DNSSEC trust anchors for the root zone ("\&.") and for the ISC DNSSEC lookaside validation zone ("dlv\&.isc\&.org")\&. Records returned by
\fBdelv\fR
-are either fully validated or were not signed. If validation fails, an explanation of the failure is included in the output; the validation process can be traced in detail. Because
+are either fully validated or were not signed\&. If validation fails, an explanation of the failure is included in the output; the validation process can be traced in detail\&. Because
\fBdelv\fR
-does not rely on an external server to carry out validation, it can be used to check the validity of DNS responses in environments where local name servers may not be trustworthy.
+does not rely on an external server to carry out validation, it can be used to check the validity of DNS responses in environments where local name servers may not be trustworthy\&.
.PP
Unless it is told to query a specific name server,
\fBdelv\fR
will try each of the servers listed in
-\fI/etc/resolv.conf\fR. If no usable server addresses are found,
+/etc/resolv\&.conf\&. If no usable server addresses are found,
\fBdelv\fR
-will send queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6).
+will send queries to the localhost addresses (127\&.0\&.0\&.1 for IPv4, ::1 for IPv6)\&.
.PP
When no command line arguments or options are given,
\fBdelv\fR
-will perform an NS query for "." (the root zone).
+will perform an NS query for "\&." (the root zone)\&.
.SH "SIMPLE USAGE"
.PP
A typical invocation of
\fBdelv\fR
looks like:
.sp
+.if n \{\
.RS 4
+.\}
.nf
delv @server name type
.fi
+.if n \{\
.RE
+.\}
.sp
where:
.PP
\fBserver\fR
.RS 4
-is the name or IP address of the name server to query. This can be an IPv4 address in dotted\-decimal notation or an IPv6 address in colon\-delimited notation. When the supplied
+is the name or IP address of the name server to query\&. This can be an IPv4 address in dotted\-decimal notation or an IPv6 address in colon\-delimited notation\&. When the supplied
\fIserver\fR
argument is a hostname,
\fBdelv\fR
resolves that name before querying that name server (note, however, that this initial lookup is
\fInot\fR
-validated by DNSSEC).
+validated by DNSSEC)\&.
.sp
If no
\fIserver\fR
argument is provided,
\fBdelv\fR
consults
-\fI/etc/resolv.conf\fR; if an address is found there, it queries the name server at that address. If either of the
+/etc/resolv\&.conf; if an address is found there, it queries the name server at that address\&. If either of the
\fB\-4\fR
or
\fB\-6\fR
-options are in use, then only addresses for the corresponding transport will be tried. If no usable addresses are found,
+options are in use, then only addresses for the corresponding transport will be tried\&. If no usable addresses are found,
\fBdelv\fR
-will send queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6).
+will send queries to the localhost addresses (127\&.0\&.0\&.1 for IPv4, ::1 for IPv6)\&.
.RE
.PP
\fBname\fR
.RS 4
-is the domain name to be looked up.
+is the domain name to be looked up\&.
.RE
.PP
\fBtype\fR
.RS 4
-indicates what type of query is required \(em ANY, A, MX, etc.
+indicates what type of query is required \(em ANY, A, MX, etc\&.
\fItype\fR
-can be any valid query type. If no
+can be any valid query type\&. If no
\fItype\fR
argument is supplied,
\fBdelv\fR
-will perform a lookup for an A record.
+will perform a lookup for an A record\&.
.RE
.SH "OPTIONS"
.PP
\-a \fIanchor\-file\fR
.RS 4
-Specifies a file from which to read DNSSEC trust anchors. The default is
-\fI/etc/bind.keys\fR, which is included with
+Specifies a file from which to read DNSSEC trust anchors\&. The default is
+/etc/bind\&.keys, which is included with
BIND
-9 and contains trust anchors for the root zone (".") and for the ISC DNSSEC lookaside validation zone ("dlv.isc.org").
+9 and contains trust anchors for the root zone ("\&.") and for the ISC DNSSEC lookaside validation zone ("dlv\&.isc\&.org")\&.
.sp
Keys that do not match the root or DLV trust\-anchor names are ignored; these key names can be overridden using the
\fB+dlv=NAME\fR
or
\fB+root=NAME\fR
-options.
+options\&.
.sp
Note: When reading the trust anchor file,
\fBdelv\fR
\fBmanaged\-keys\fR
statements and
\fBtrusted\-keys\fR
-statements identically. That is, for a managed key, it is the
+statements identically\&. That is, for a managed key, it is the
\fIinitial\fR
-key that is trusted; RFC 5011 key management is not supported.
+key that is trusted; RFC 5011 key management is not supported\&.
\fBdelv\fR
will not consult the managed\-keys database maintained by
-\fBnamed\fR. This means that if either of the keys in
-\fI/etc/bind.keys\fR
+\fBnamed\fR\&. This means that if either of the keys in
+/etc/bind\&.keys
is revoked and rolled over, it will be necessary to update
-\fI/etc/bind.keys\fR
+/etc/bind\&.keys
to use DNSSEC validation in
-\fBdelv\fR.
+\fBdelv\fR\&.
.RE
.PP
\-b \fIaddress\fR
.RS 4
Sets the source IP address of the query to
-\fIaddress\fR. This must be a valid address on one of the host's network interfaces or "0.0.0.0" or "::". An optional source port may be specified by appending "#<port>"
+\fIaddress\fR\&. This must be a valid address on one of the host\*(Aqs network interfaces or "0\&.0\&.0\&.0" or "::"\&. An optional source port may be specified by appending "#<port>"
.RE
.PP
\-c \fIclass\fR
.RS 4
-Sets the query class for the requested data. Currently, only class "IN" is supported in
+Sets the query class for the requested data\&. Currently, only class "IN" is supported in
\fBdelv\fR
-and any other value is ignored.
+and any other value is ignored\&.
.RE
.PP
\-d \fIlevel\fR
.RS 4
Set the systemwide debug level to
-\fBlevel\fR. The allowed range is from 0 to 99. The default is 0 (no debugging). Debugging traces from
+\fBlevel\fR\&. The allowed range is from 0 to 99\&. The default is 0 (no debugging)\&. Debugging traces from
\fBdelv\fR
-become more verbose as the debug level increases. See the
+become more verbose as the debug level increases\&. See the
\fB+mtrace\fR,
\fB+rtrace\fR, and
\fB+vtrace\fR
-options below for additional debugging details.
+options below for additional debugging details\&.
.RE
.PP
\-h
.RS 4
Display the
\fBdelv\fR
-help usage output and exit.
+help usage output and exit\&.
.RE
.PP
\-i
.RS 4
-Insecure mode. This disables internal DNSSEC validation. (Note, however, this does not set the CD bit on upstream queries. If the server being queried is performing DNSSEC validation, then it will not return invalid data; this can cause
+Insecure mode\&. This disables internal DNSSEC validation\&. (Note, however, this does not set the CD bit on upstream queries\&. If the server being queried is performing DNSSEC validation, then it will not return invalid data; this can cause
\fBdelv\fR
-to time out. When it is necessary to examine invalid data to debug a DNSSEC problem, use
-\fBdig +cd\fR.)
+to time out\&. When it is necessary to examine invalid data to debug a DNSSEC problem, use
+\fBdig +cd\fR\&.)
.RE
.PP
\-m
.RS 4
-Enables memory usage debugging.
+Enables memory usage debugging\&.
.RE
.PP
\-p \fIport#\fR
.RS 4
-Specifies a destination port to use for queries instead of the standard DNS port number 53. This option would be used with a name server that has been configured to listen for queries on a non\-standard port number.
+Specifies a destination port to use for queries instead of the standard DNS port number 53\&. This option would be used with a name server that has been configured to listen for queries on a non\-standard port number\&.
.RE
.PP
\-q \fIname\fR
.RS 4
Sets the query name to
-\fIname\fR. While the query name can be specified without using the
-\fB\-q\fR, it is sometimes necessary to disambiguate names from types or classes (for example, when looking up the name "ns", which could be misinterpreted as the type NS, or "ch", which could be misinterpreted as class CH).
+\fIname\fR\&. While the query name can be specified without using the
+\fB\-q\fR, it is sometimes necessary to disambiguate names from types or classes (for example, when looking up the name "ns", which could be misinterpreted as the type NS, or "ch", which could be misinterpreted as class CH)\&.
.RE
.PP
\-t \fItype\fR
.RS 4
Sets the query type to
-\fItype\fR, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR. As with
-\fB\-q\fR, this is useful to distinguish query name type or class when they are ambiguous. it is sometimes necessary to disambiguate names from types.
+\fItype\fR, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR\&. As with
+\fB\-q\fR, this is useful to distinguish query name type or class when they are ambiguous\&. it is sometimes necessary to disambiguate names from types\&.
.sp
The default query type is "A", unless the
\fB\-x\fR
-option is supplied to indicate a reverse lookup, in which case it is "PTR".
+option is supplied to indicate a reverse lookup, in which case it is "PTR"\&.
.RE
.PP
\-v
.RS 4
Print the
\fBdelv\fR
-version and exit.
+version and exit\&.
.RE
.PP
\-x \fIaddr\fR
.RS 4
-Performs a reverse lookup, mapping an addresses to a name.
+Performs a reverse lookup, mapping an addresses to a name\&.
\fIaddr\fR
-is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address. When
+is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&. When
\fB\-x\fR
is used, there is no need to provide the
\fIname\fR
or
\fItype\fR
-arguments.
+arguments\&.
\fBdelv\fR
automatically performs a lookup for a name like
-11.12.13.10.in\-addr.arpa
-and sets the query type to PTR. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain.
+11\&.12\&.13\&.10\&.in\-addr\&.arpa
+and sets the query type to PTR\&. IPv6 addresses are looked up using nibble format under the IP6\&.ARPA domain\&.
.RE
.PP
\-4
.RS 4
Forces
\fBdelv\fR
-to only use IPv4.
+to only use IPv4\&.
.RE
.PP
\-6
.RS 4
Forces
\fBdelv\fR
-to only use IPv6.
+to only use IPv6\&.
.RE
.SH "QUERY OPTIONS"
.PP
\fBdelv\fR
-provides a number of query options which affect the way results are displayed, and in some cases the way lookups are performed.
+provides a number of query options which affect the way results are displayed, and in some cases the way lookups are performed\&.
.PP
-Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded by the string
+Each query option is identified by a keyword preceded by a plus sign (+)\&. Some keywords set or reset an option\&. These may be preceded by the string
no
-to negate the meaning of that keyword. Other keywords assign values to options like the timeout interval. They have the form
-\fB+keyword=value\fR. The query options are:
+to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form
+\fB+keyword=value\fR\&. The query options are:
.PP
\fB+[no]cdflag\fR
.RS 4
Controls whether to set the CD (checking disabled) bit in queries sent by
-\fBdelv\fR. This may be useful when troubleshooting DNSSEC problems from behind a validating resolver. A validating resolver will block invalid responses, making it difficult to retrieve them for analysis. Setting the CD flag on queries will cause the resolver to return invalid responses, which
+\fBdelv\fR\&. This may be useful when troubleshooting DNSSEC problems from behind a validating resolver\&. A validating resolver will block invalid responses, making it difficult to retrieve them for analysis\&. Setting the CD flag on queries will cause the resolver to return invalid responses, which
\fBdelv\fR
-can then validate internally and report the errors in detail.
+can then validate internally and report the errors in detail\&.
.RE
.PP
\fB+[no]class\fR
.RS 4
-Controls whether to display the CLASS when printing a record. The default is to display the CLASS.
+Controls whether to display the CLASS when printing a record\&. The default is to display the CLASS\&.
.RE
.PP
\fB+[no]ttl\fR
.RS 4
-Controls whether to display the TTL when printing a record. The default is to display the TTL.
+Controls whether to display the TTL when printing a record\&. The default is to display the TTL\&.
.RE
.PP
\fB+[no]rtrace\fR
.RS 4
-Toggle resolver fetch logging. This reports the name and type of each query sent by
+Toggle resolver fetch logging\&. This reports the name and type of each query sent by
\fBdelv\fR
-in the process of carrying out the resolution and validation process: this includes including the original query and all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation.
+in the process of carrying out the resolution and validation process: this includes including the original query and all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation\&.
.sp
-This is equivalent to setting the debug level to 1 in the "resolver" logging category. Setting the systemwide debug level to 1 using the
+This is equivalent to setting the debug level to 1 in the "resolver" logging category\&. Setting the systemwide debug level to 1 using the
\fB\-d\fR
-option will product the same output (but will affect other logging categories as well).
+option will product the same output (but will affect other logging categories as well)\&.
.RE
.PP
\fB+[no]mtrace\fR
.RS 4
-Toggle message logging. This produces a detailed dump of the responses received by
+Toggle message logging\&. This produces a detailed dump of the responses received by
\fBdelv\fR
-in the process of carrying out the resolution and validation process.
+in the process of carrying out the resolution and validation process\&.
.sp
-This is equivalent to setting the debug level to 10 for the "packets" module of the "resolver" logging category. Setting the systemwide debug level to 10 using the
+This is equivalent to setting the debug level to 10 for the "packets" module of the "resolver" logging category\&. Setting the systemwide debug level to 10 using the
\fB\-d\fR
-option will produce the same output (but will affect other logging categories as well).
+option will produce the same output (but will affect other logging categories as well)\&.
.RE
.PP
\fB+[no]vtrace\fR
.RS 4
-Toggle validation logging. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid.
+Toggle validation logging\&. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid\&.
.sp
-This is equivalent to setting the debug level to 3 for the "validator" module of the "dnssec" logging category. Setting the systemwide debug level to 3 using the
+This is equivalent to setting the debug level to 3 for the "validator" module of the "dnssec" logging category\&. Setting the systemwide debug level to 3 using the
\fB\-d\fR
-option will produce the same output (but will affect other logging categories as well).
+option will produce the same output (but will affect other logging categories as well)\&.
.RE
.PP
\fB+[no]short\fR
.RS 4
-Provide a terse answer. The default is to print the answer in a verbose form.
+Provide a terse answer\&. The default is to print the answer in a verbose form\&.
.RE
.PP
\fB+[no]comments\fR
.RS 4
-Toggle the display of comment lines in the output. The default is to print comments.
+Toggle the display of comment lines in the output\&. The default is to print comments\&.
.RE
.PP
\fB+[no]rrcomments\fR
.RS 4
-Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records). The default is to print per\-record comments.
+Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records)\&. The default is to print per\-record comments\&.
.RE
.PP
\fB+[no]crypto\fR
.RS 4
-Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures. The default is to display the fields. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]".
+Toggle the display of cryptographic fields in DNSSEC records\&. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures\&. The default is to display the fields\&. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e\&.g\&. "[ key id = value ]"\&.
.RE
.PP
\fB+[no]trust\fR
.RS 4
-Controls whether to display the trust level when printing a record. The default is to display the trust level.
+Controls whether to display the trust level when printing a record\&. The default is to display the trust level\&.
.RE
.PP
\fB+[no]split[=W]\fR
\fIW\fR
characters (where
\fIW\fR
-is rounded up to the nearest multiple of 4).
+is rounded up to the nearest multiple of 4)\&.
\fI+nosplit\fR
or
\fI+split=0\fR
-causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active.
+causes fields not to be split at all\&. The default is 56 characters, or 44 characters when multiline mode is active\&.
.RE
.PP
\fB+[no]all\fR
\fB+[no]comments\fR,
\fB+[no]rrcomments\fR, and
\fB+[no]trust\fR
-as a group.
+as a group\&.
.RE
.PP
\fB+[no]multiline\fR
.RS 4
-Print long records (such as RRSIG, DNSKEY, and SOA records) in a verbose multi\-line format with human\-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the
+Print long records (such as RRSIG, DNSKEY, and SOA records) in a verbose multi\-line format with human\-readable comments\&. The default is to print each record on a single line, to facilitate machine parsing of the
\fBdelv\fR
-output.
+output\&.
.RE
.PP
\fB+[no]dnssec\fR
.RS 4
Indicates whether to display RRSIG records in the
\fBdelv\fR
-output. The default is to do so. Note that (unlike in
+output\&. The default is to do so\&. Note that (unlike in
\fBdig\fR) this does
\fInot\fR
-control whether to request DNSSEC records or whether to validate them. DNSSEC records are always requested, and validation will always occur unless suppressed by the use of
+control whether to request DNSSEC records or whether to validate them\&. DNSSEC records are always requested, and validation will always occur unless suppressed by the use of
\fB\-i\fR
or
\fB+noroot\fR
and
-\fB+nodlv\fR.
+\fB+nodlv\fR\&.
.RE
.PP
\fB+[no]root[=ROOT]\fR
.RS 4
-Indicates whether to perform conventional (non\-lookaside) DNSSEC validation, and if so, specifies the name of a trust anchor. The default is to validate using a trust anchor of "." (the root zone), for which there is a built\-in key. If specifying a different trust anchor, then
+Indicates whether to perform conventional (non\-lookaside) DNSSEC validation, and if so, specifies the name of a trust anchor\&. The default is to validate using a trust anchor of "\&." (the root zone), for which there is a built\-in key\&. If specifying a different trust anchor, then
\fB\-a\fR
-must be used to specify a file containing the key.
+must be used to specify a file containing the key\&.
.RE
.PP
\fB+[no]dlv[=DLV]\fR
.RS 4
-Indicates whether to perform DNSSEC lookaside validation, and if so, specifies the name of the DLV trust anchor. The default is to perform lookaside validation using a trust anchor of "dlv.isc.org", for which there is a built\-in key. If specifying a different name, then
+Indicates whether to perform DNSSEC lookaside validation, and if so, specifies the name of the DLV trust anchor\&. The default is to perform lookaside validation using a trust anchor of "dlv\&.isc\&.org", for which there is a built\-in key\&. If specifying a different name, then
\fB\-a\fR
-must be used to specify a file containing the DLV key.
+must be used to specify a file containing the DLV key\&.
.RE
.PP
\fB+[no]tcp\fR
.RS 4
-Controls whether to use TCP when sending queries. The default is to use UDP unless a truncated response has been received.
+Controls whether to use TCP when sending queries\&. The default is to use UDP unless a truncated response has been received\&.
.RE
.SH "FILES"
.PP
-\fI/etc/bind.keys\fR
+/etc/bind\&.keys
.PP
-\fI/etc/resolv.conf\fR
+/etc/resolv\&.conf
.SH "SEE ALSO"
.PP
\fBdig\fR(1),
RFC4035,
RFC4431,
RFC5074,
-RFC5155.
+RFC5155\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
.br
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>delv</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="delv">
<a name="man.delv"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>delv — DNS lookup and validation utility</p>
+<p>
+ delv
+ — DNS lookup and validation utility
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">delv</code> [@server] [<code class="option">-4</code>] [<code class="option">-6</code>] [<code class="option">-a <em class="replaceable"><code>anchor-file</code></em></code>] [<code class="option">-b <em class="replaceable"><code>address</code></em></code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-d <em class="replaceable"><code>level</code></em></code>] [<code class="option">-i</code>] [<code class="option">-m</code>] [<code class="option">-p <em class="replaceable"><code>port#</code></em></code>] [<code class="option">-q <em class="replaceable"><code>name</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-x <em class="replaceable"><code>addr</code></em></code>] [name] [type] [class] [queryopt...]</p></div>
-<div class="cmdsynopsis"><p><code class="command">delv</code> [<code class="option">-h</code>]</p></div>
-<div class="cmdsynopsis"><p><code class="command">delv</code> [<code class="option">-v</code>]</p></div>
-<div class="cmdsynopsis"><p><code class="command">delv</code> [queryopt...] [query...]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543500"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">delv</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">delv</code>
+ [@server]
+ [<code class="option">-4</code>]
+ [<code class="option">-6</code>]
+ [<code class="option">-a <em class="replaceable"><code>anchor-file</code></em></code>]
+ [<code class="option">-b <em class="replaceable"><code>address</code></em></code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-d <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-i</code>]
+ [<code class="option">-m</code>]
+ [<code class="option">-p <em class="replaceable"><code>port#</code></em></code>]
+ [<code class="option">-q <em class="replaceable"><code>name</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>type</code></em></code>]
+ [<code class="option">-x <em class="replaceable"><code>addr</code></em></code>]
+ [name]
+ [type]
+ [class]
+ [queryopt...]
+ </p></div>
+
+ <div class="cmdsynopsis"><p>
+ <code class="command">delv</code>
+ [<code class="option">-h</code>]
+ </p></div>
+
+ <div class="cmdsynopsis"><p>
+ <code class="command">delv</code>
+ [<code class="option">-v</code>]
+ </p></div>
+
+ <div class="cmdsynopsis"><p>
+ <code class="command">delv</code>
+ [queryopt...]
+ [query...]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61043408"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>delv</strong></span>
(Domain Entity Lookup & Validation) is a tool for sending
DNS queries and validating the results, using the same internal
- resolver and validator logic as <span><strong class="command">named</strong></span>.
+ resolver and validator logic as <span class="command"><strong>named</strong></span>.
</p>
-<p>
- <span><strong class="command">delv</strong></span> will send to a specified name server all
+ <p>
+ <span class="command"><strong>delv</strong></span> will send to a specified name server all
queries needed to fetch and validate the requested data; this
includes the original requested query, subsequent queries to follow
CNAME or DNAME chains, and queries for DNSKEY, DS and DLV records
behavior of a name server configured for DNSSEC validating and
forwarding.
</p>
-<p>
+ <p>
By default, responses are validated using built-in DNSSEC trust
anchors for the root zone (".") and for the ISC DNSSEC lookaside
validation zone ("dlv.isc.org"). Records returned by
- <span><strong class="command">delv</strong></span> are either fully validated or
+ <span class="command"><strong>delv</strong></span> are either fully validated or
were not signed. If validation fails, an explanation of
the failure is included in the output; the validation process
- can be traced in detail. Because <span><strong class="command">delv</strong></span> does
+ can be traced in detail. Because <span class="command"><strong>delv</strong></span> does
not rely on an external server to carry out validation, it can
be used to check the validity of DNS responses in environments
where local name servers may not be trustworthy.
</p>
-<p>
+ <p>
Unless it is told to query a specific name server,
- <span><strong class="command">delv</strong></span> will try each of the servers listed in
+ <span class="command"><strong>delv</strong></span> will try each of the servers listed in
<code class="filename">/etc/resolv.conf</code>. If no usable server
- addresses are found, <span><strong class="command">delv</strong></span> will send
+ addresses are found, <span class="command"><strong>delv</strong></span> will send
queries to the localhost addresses (127.0.0.1 for IPv4, ::1
for IPv6).
</p>
-<p>
+ <p>
When no command line arguments or options are given,
- <span><strong class="command">delv</strong></span> will perform an NS query for "."
+ <span class="command"><strong>delv</strong></span> will perform an NS query for "."
(the root zone).
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543554"></a><h2>SIMPLE USAGE</h2>
-<p>
- A typical invocation of <span><strong class="command">delv</strong></span> looks like:
+ </div>
+
+ <div class="refsection" title="SIMPLE USAGE">
+<a name="idp61049680"></a><h2>SIMPLE USAGE</h2>
+
+
+ <p>
+ A typical invocation of <span class="command"><strong>delv</strong></span> looks like:
</p>
<pre class="programlisting"> delv @server name type </pre>
<p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">server</code></span></dt>
<dd>
-<p>
+ <p>
is the name or IP address of the name server to query. This
can be an IPv4 address in dotted-decimal notation or an IPv6
address in colon-delimited notation. When the supplied
<em class="parameter"><code>server</code></em> argument is a hostname,
- <span><strong class="command">delv</strong></span> resolves that name before
+ <span class="command"><strong>delv</strong></span> resolves that name before
querying that name server (note, however, that this
initial lookup is <span class="emphasis"><em>not</em></span> validated
by DNSSEC).
</p>
-<p>
+ <p>
If no <em class="parameter"><code>server</code></em> argument is
- provided, <span><strong class="command">delv</strong></span> consults
+ provided, <span class="command"><strong>delv</strong></span> consults
<code class="filename">/etc/resolv.conf</code>; if an
address is found there, it queries the name server at
that address. If either of the <code class="option">-4</code> or
<code class="option">-6</code> options are in use, then
only addresses for the corresponding transport
will be tried. If no usable addresses are found,
- <span><strong class="command">delv</strong></span> will send queries to
+ <span class="command"><strong>delv</strong></span> will send queries to
the localhost addresses (127.0.0.1 for IPv4,
::1 for IPv6).
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">name</code></span></dt>
-<dd><p>
+<dd>
+ <p>
is the domain name to be looked up.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">type</code></span></dt>
-<dd><p>
+<dd>
+ <p>
indicates what type of query is required —
ANY, A, MX, etc.
<em class="parameter"><code>type</code></em> can be any valid query
type. If no
<em class="parameter"><code>type</code></em> argument is supplied,
- <span><strong class="command">delv</strong></span> will perform a lookup for an
+ <span class="command"><strong>delv</strong></span> will perform a lookup for an
A record.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543662"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61062480"></a><h2>OPTIONS</h2>
+
+ <div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>anchor-file</code></em></span></dt>
<dd>
-<p>
+ <p>
Specifies a file from which to read DNSSEC trust anchors.
The default is <code class="filename">/etc/bind.keys</code>, which
is included with <acronym class="acronym">BIND</acronym> 9 and contains
trust anchors for the root zone (".") and for the ISC
DNSSEC lookaside validation zone ("dlv.isc.org").
</p>
-<p>
+ <p>
Keys that do not match the root or DLV trust-anchor
names are ignored; these key names can be overridden
using the <code class="option">+dlv=NAME</code> or
<code class="option">+root=NAME</code> options.
</p>
-<p>
+ <p>
Note: When reading the trust anchor file,
- <span><strong class="command">delv</strong></span> treats <code class="option">managed-keys</code>
+ <span class="command"><strong>delv</strong></span> treats <code class="option">managed-keys</code>
statements and <code class="option">trusted-keys</code> statements
identically. That is, for a managed key, it is the
<span class="emphasis"><em>initial</em></span> key that is trusted; RFC 5011
- key management is not supported. <span><strong class="command">delv</strong></span>
+ key management is not supported. <span class="command"><strong>delv</strong></span>
will not consult the managed-keys database maintained by
- <span><strong class="command">named</strong></span>. This means that if either of the
+ <span class="command"><strong>named</strong></span>. This means that if either of the
keys in <code class="filename">/etc/bind.keys</code> is revoked
and rolled over, it will be necessary to update
<code class="filename">/etc/bind.keys</code> to use DNSSEC
- validation in <span><strong class="command">delv</strong></span>.
+ validation in <span class="command"><strong>delv</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term">-b <em class="replaceable"><code>address</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the source IP address of the query to
<em class="parameter"><code>address</code></em>. This must be a valid address
on one of the host's network interfaces or "0.0.0.0" or "::".
An optional source port may be specified by appending
"#<port>"
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the query class for the requested data. Currently,
- only class "IN" is supported in <span><strong class="command">delv</strong></span>
+ only class "IN" is supported in <span class="command"><strong>delv</strong></span>
and any other value is ignored.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-d <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the systemwide debug level to <code class="option">level</code>.
The allowed range is from 0 to 99.
The default is 0 (no debugging).
- Debugging traces from <span><strong class="command">delv</strong></span> become
+ Debugging traces from <span class="command"><strong>delv</strong></span> become
more verbose as the debug level increases.
See the <code class="option">+mtrace</code>, <code class="option">+rtrace</code>,
and <code class="option">+vtrace</code> options below for additional
debugging details.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
- Display the <span><strong class="command">delv</strong></span> help usage output and exit.
- </p></dd>
+<dd>
+ <p>
+ Display the <span class="command"><strong>delv</strong></span> help usage output and exit.
+ </p>
+ </dd>
<dt><span class="term">-i</span></dt>
-<dd><p>
+<dd>
+ <p>
Insecure mode. This disables internal DNSSEC validation.
(Note, however, this does not set the CD bit on upstream
queries. If the server being queried is performing DNSSEC
validation, then it will not return invalid data; this
- can cause <span><strong class="command">delv</strong></span> to time out. When it
+ can cause <span class="command"><strong>delv</strong></span> to time out. When it
is necessary to examine invalid data to debug a DNSSEC
- problem, use <span><strong class="command">dig +cd</strong></span>.)
- </p></dd>
+ problem, use <span class="command"><strong>dig +cd</strong></span>.)
+ </p>
+ </dd>
<dt><span class="term">-m</span></dt>
-<dd><p>
+<dd>
+ <p>
Enables memory usage debugging.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>port#</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies a destination port to use for queries instead of
the standard DNS port number 53. This option would be used
with a name server that has been configured to listen
for queries on a non-standard port number.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-q <em class="replaceable"><code>name</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the query name to <em class="parameter"><code>name</code></em>.
While the query name can be specified without using the
<code class="option">-q</code>, it is sometimes necessary to disambiguate
names from types or classes (for example, when looking up the
name "ns", which could be misinterpreted as the type NS,
or "ch", which could be misinterpreted as class CH).
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
<dd>
-<p>
+ <p>
Sets the query type to <em class="parameter"><code>type</code></em>, which
can be any valid query type supported in BIND 9 except
for zone transfer types AXFR and IXFR. As with
query name type or class when they are ambiguous.
it is sometimes necessary to disambiguate names from types.
</p>
-<p>
+ <p>
The default query type is "A", unless the <code class="option">-x</code>
option is supplied to indicate a reverse lookup, in which case
it is "PTR".
</p>
-</dd>
+ </dd>
<dt><span class="term">-v</span></dt>
-<dd><p>
- Print the <span><strong class="command">delv</strong></span> version and exit.
- </p></dd>
+<dd>
+ <p>
+ Print the <span class="command"><strong>delv</strong></span> version and exit.
+ </p>
+ </dd>
<dt><span class="term">-x <em class="replaceable"><code>addr</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Performs a reverse lookup, mapping an addresses to
a name. <em class="parameter"><code>addr</code></em> is an IPv4 address in
dotted-decimal notation, or a colon-delimited IPv6 address.
When <code class="option">-x</code> is used, there is no need to provide
the <em class="parameter"><code>name</code></em> or <em class="parameter"><code>type</code></em>
- arguments. <span><strong class="command">delv</strong></span> automatically performs a
+ arguments. <span class="command"><strong>delv</strong></span> automatically performs a
lookup for a name like <code class="literal">11.12.13.10.in-addr.arpa</code>
and sets the query type to PTR. IPv6 addresses are looked up
using nibble format under the IP6.ARPA domain.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-4</span></dt>
-<dd><p>
- Forces <span><strong class="command">delv</strong></span> to only use IPv4.
- </p></dd>
+<dd>
+ <p>
+ Forces <span class="command"><strong>delv</strong></span> to only use IPv4.
+ </p>
+ </dd>
<dt><span class="term">-6</span></dt>
-<dd><p>
- Forces <span><strong class="command">delv</strong></span> to only use IPv6.
- </p></dd>
+<dd>
+ <p>
+ Forces <span class="command"><strong>delv</strong></span> to only use IPv6.
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544163"></a><h2>QUERY OPTIONS</h2>
-<p><span><strong class="command">delv</strong></span>
+ </div>
+
+ <div class="refsection" title="QUERY OPTIONS">
+<a name="idp61104720"></a><h2>QUERY OPTIONS</h2>
+
+
+ <p><span class="command"><strong>delv</strong></span>
provides a number of query options which affect the way results are
displayed, and in some cases the way lookups are performed.
</p>
-<p>
+
+ <p>
Each query option is identified by a keyword preceded by a plus sign
(<code class="literal">+</code>). Some keywords set or reset an
option. These may be preceded by the string
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="option">+[no]cdflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Controls whether to set the CD (checking disabled) bit in
- queries sent by <span><strong class="command">delv</strong></span>. This may be useful
+ queries sent by <span class="command"><strong>delv</strong></span>. This may be useful
when troubleshooting DNSSEC problems from behind a validating
resolver. A validating resolver will block invalid responses,
making it difficult to retrieve them for analysis. Setting
the CD flag on queries will cause the resolver to return
- invalid responses, which <span><strong class="command">delv</strong></span> can then
+ invalid responses, which <span class="command"><strong>delv</strong></span> can then
validate internally and report the errors in detail.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]class</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Controls whether to display the CLASS when printing
a record. The default is to display the CLASS.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ttl</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Controls whether to display the TTL when printing
a record. The default is to display the TTL.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]rtrace</code></span></dt>
<dd>
-<p>
+ <p>
Toggle resolver fetch logging. This reports the
- name and type of each query sent by <span><strong class="command">delv</strong></span>
+ name and type of each query sent by <span class="command"><strong>delv</strong></span>
in the process of carrying out the resolution and validation
process: this includes including the original query and
all subsequent queries to follow CNAMEs and to establish a
chain of trust for DNSSEC validation.
</p>
-<p>
+ <p>
This is equivalent to setting the debug level to 1 in
the "resolver" logging category. Setting the systemwide
debug level to 1 using the <code class="option">-d</code> option will
product the same output (but will affect other logging
categories as well).
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="option">+[no]mtrace</code></span></dt>
<dd>
-<p>
+ <p>
Toggle message logging. This produces a detailed dump of
- the responses received by <span><strong class="command">delv</strong></span> in the
+ the responses received by <span class="command"><strong>delv</strong></span> in the
process of carrying out the resolution and validation process.
</p>
-<p>
+ <p>
This is equivalent to setting the debug level to 10
for the "packets" module of the "resolver" logging
category. Setting the systemwide debug level to 10 using
the <code class="option">-d</code> option will produce the same output
(but will affect other logging categories as well).
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="option">+[no]vtrace</code></span></dt>
<dd>
-<p>
+ <p>
Toggle validation logging. This shows the internal
process of the validator as it determines whether an
answer is validly signed, unsigned, or invalid.
</p>
-<p>
+ <p>
This is equivalent to setting the debug level to 3
for the "validator" module of the "dnssec" logging
category. Setting the systemwide debug level to 3 using
the <code class="option">-d</code> option will produce the same output
(but will affect other logging categories as well).
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="option">+[no]short</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Provide a terse answer. The default is to print the answer in a
verbose form.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]comments</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the display of comment lines in the output. The default
is to print comments.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]rrcomments</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the display of per-record comments in the output (for
example, human-readable key information about DNSKEY records).
The default is to print per-record comments.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]crypto</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the display of cryptographic fields in DNSSEC records.
The contents of these field are unnecessary to debug most DNSSEC
validation failures and removing them makes it easier to see
When omitted they are replaced by the string "[omitted]" or
in the DNSKEY case the key id is displayed as the replacement,
e.g. "[ key id = value ]".
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]trust</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Controls whether to display the trust level when printing
a record. The default is to display the trust level.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]split[=W]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Split long hex- or base64-formatted fields in resource
records into chunks of <em class="parameter"><code>W</code></em> characters
(where <em class="parameter"><code>W</code></em> is rounded up to the nearest
<em class="parameter"><code>+split=0</code></em> causes fields not to be
split at all. The default is 56 characters, or 44 characters
when multiline mode is active.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]all</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set or clear the display options
<code class="option">+[no]comments</code>,
<code class="option">+[no]rrcomments</code>, and
<code class="option">+[no]trust</code> as a group.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]multiline</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Print long records (such as RRSIG, DNSKEY, and SOA records)
in a verbose multi-line format with human-readable comments.
The default is to print each record on a single line, to
- facilitate machine parsing of the <span><strong class="command">delv</strong></span>
+ facilitate machine parsing of the <span class="command"><strong>delv</strong></span>
output.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]dnssec</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Indicates whether to display RRSIG records in the
- <span><strong class="command">delv</strong></span> output. The default is to
- do so. Note that (unlike in <span><strong class="command">dig</strong></span>)
+ <span class="command"><strong>delv</strong></span> output. The default is to
+ do so. Note that (unlike in <span class="command"><strong>dig</strong></span>)
this does <span class="emphasis"><em>not</em></span> control whether to
request DNSSEC records or whether to validate them.
DNSSEC records are always requested, and validation
will always occur unless suppressed by the use of
<code class="option">-i</code> or <code class="option">+noroot</code> and
<code class="option">+nodlv</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]root[=ROOT]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Indicates whether to perform conventional (non-lookaside)
DNSSEC validation, and if so, specifies the
name of a trust anchor. The default is to validate using
a built-in key. If specifying a different trust anchor,
then <code class="option">-a</code> must be used to specify a file
containing the key.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]dlv[=DLV]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Indicates whether to perform DNSSEC lookaside validation,
and if so, specifies the name of the DLV trust anchor.
The default is to perform lookaside validation using
built-in key. If specifying a different name, then
<code class="option">-a</code> must be used to specify a file
containing the DLV key.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]tcp</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Controls whether to use TCP when sending queries.
The default is to use UDP unless a truncated
response has been received.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544663"></a><h2>FILES</h2>
-<p><code class="filename">/etc/bind.keys</code></p>
-<p><code class="filename">/etc/resolv.conf</code></p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544678"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dig</span>(1)</span>,
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp61153232"></a><h2>FILES</h2>
+
+ <p><code class="filename">/etc/bind.keys</code></p>
+ <p><code class="filename">/etc/resolv.conf</code></p>
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61155408"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dig</span>(1)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
<em class="citetitle">RFC4034</em>,
<em class="citetitle">RFC4035</em>,
<em class="citetitle">RFC4431</em>,
<em class="citetitle">RFC5074</em>,
<em class="citetitle">RFC5155</em>.
</p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: dig
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: February 19, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-02-19
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DIG" "1" "February 19, 2014" "BIND9" "BIND9"
+.TH "DIG" "1" "2014\-02\-19" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
dig \- DNS lookup utility
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBdig\fR
-(domain information groper) is a flexible tool for interrogating DNS name servers. It performs DNS lookups and displays the answers that are returned from the name server(s) that were queried. Most DNS administrators use
+(domain information groper) is a flexible tool for interrogating DNS name servers\&. It performs DNS lookups and displays the answers that are returned from the name server(s) that were queried\&. Most DNS administrators use
\fBdig\fR
-to troubleshoot DNS problems because of its flexibility, ease of use and clarity of output. Other lookup tools tend to have less functionality than
-\fBdig\fR.
+to troubleshoot DNS problems because of its flexibility, ease of use and clarity of output\&. Other lookup tools tend to have less functionality than
+\fBdig\fR\&.
.PP
Although
\fBdig\fR
-is normally used with command\-line arguments, it also has a batch mode of operation for reading lookup requests from a file. A brief summary of its command\-line arguments and options is printed when the
+is normally used with command\-line arguments, it also has a batch mode of operation for reading lookup requests from a file\&. A brief summary of its command\-line arguments and options is printed when the
\fB\-h\fR
-option is given. Unlike earlier versions, the BIND 9 implementation of
+option is given\&. Unlike earlier versions, the BIND 9 implementation of
\fBdig\fR
-allows multiple lookups to be issued from the command line.
+allows multiple lookups to be issued from the command line\&.
.PP
Unless it is told to query a specific name server,
\fBdig\fR
will try each of the servers listed in
-\fI/etc/resolv.conf\fR. If no usable server addresses are found,
+/etc/resolv\&.conf\&. If no usable server addresses are found,
\fBdig\fR
-will send the query to the local host.
+will send the query to the local host\&.
.PP
When no command line arguments or options are given,
\fBdig\fR
-will perform an NS query for "." (the root).
+will perform an NS query for "\&." (the root)\&.
.PP
It is possible to set per\-user defaults for
\fBdig\fR
via
-\fI${HOME}/.digrc\fR. This file is read and any options in it are applied before the command line arguments.
+${HOME}/\&.digrc\&. This file is read and any options in it are applied before the command line arguments\&.
.PP
-The IN and CH class names overlap with the IN and CH top level domain names. Either use the
+The IN and CH class names overlap with the IN and CH top level domain names\&. Either use the
\fB\-t\fR
and
\fB\-c\fR
options to specify the type and class, use the
\fB\-q\fR
-the specify the domain name, or use "IN." and "CH." when looking up these top level domains.
+the specify the domain name, or use "IN\&." and "CH\&." when looking up these top level domains\&.
.SH "SIMPLE USAGE"
.PP
A typical invocation of
\fBdig\fR
looks like:
.sp
+.if n \{\
.RS 4
+.\}
.nf
dig @server name type
.fi
+.if n \{\
.RE
+.\}
.sp
where:
.PP
\fBserver\fR
.RS 4
-is the name or IP address of the name server to query. This can be an IPv4 address in dotted\-decimal notation or an IPv6 address in colon\-delimited notation. When the supplied
+is the name or IP address of the name server to query\&. This can be an IPv4 address in dotted\-decimal notation or an IPv6 address in colon\-delimited notation\&. When the supplied
\fIserver\fR
argument is a hostname,
\fBdig\fR
-resolves that name before querying that name server.
+resolves that name before querying that name server\&.
.sp
If no
\fIserver\fR
argument is provided,
\fBdig\fR
consults
-\fI/etc/resolv.conf\fR; if an address is found there, it queries the name server at that address. If either of the
+/etc/resolv\&.conf; if an address is found there, it queries the name server at that address\&. If either of the
\fB\-4\fR
or
\fB\-6\fR
-options are in use, then only addresses for the corresponding transport will be tried. If no usable addresses are found,
+options are in use, then only addresses for the corresponding transport will be tried\&. If no usable addresses are found,
\fBdig\fR
-will send the query to the local host. The reply from the name server that responds is displayed.
+will send the query to the local host\&. The reply from the name server that responds is displayed\&.
.RE
.PP
\fBname\fR
.RS 4
-is the name of the resource record that is to be looked up.
+is the name of the resource record that is to be looked up\&.
.RE
.PP
\fBtype\fR
.RS 4
-indicates what type of query is required \(em ANY, A, MX, SIG, etc.
+indicates what type of query is required \(em ANY, A, MX, SIG, etc\&.
\fItype\fR
-can be any valid query type. If no
+can be any valid query type\&. If no
\fItype\fR
argument is supplied,
\fBdig\fR
-will perform a lookup for an A record.
+will perform a lookup for an A record\&.
.RE
.SH "OPTIONS"
.PP
\-4
.RS 4
-Use IPv4 only.
+Use IPv4 only\&.
.RE
.PP
\-6
.RS 4
-Use IPv6 only.
+Use IPv6 only\&.
.RE
.PP
\-b \fIaddress\fR\fI[#port]\fR
.RS 4
-Set the source IP address of the query. The
+Set the source IP address of the query\&. The
\fIaddress\fR
-must be a valid address on one of the host's network interfaces, or "0.0.0.0" or "::". An optional port may be specified by appending "#<port>"
+must be a valid address on one of the host\*(Aqs network interfaces, or "0\&.0\&.0\&.0" or "::"\&. An optional port may be specified by appending "#<port>"
.RE
.PP
\-c \fIclass\fR
.RS 4
-Set the query class. The default
+Set the query class\&. The default
\fIclass\fR
-is IN; other classes are HS for Hesiod records or CH for Chaosnet records.
+is IN; other classes are HS for Hesiod records or CH for Chaosnet records\&.
.RE
.PP
\-f \fIfile\fR
Batch mode:
\fBdig\fR
reads a list of lookup requests to process from the given
-\fIfile\fR. Each line in the file should be organized in the same way they would be presented as queries to
+\fIfile\fR\&. Each line in the file should be organized in the same way they would be presented as queries to
\fBdig\fR
-using the command\-line interface.
+using the command\-line interface\&.
.RE
.PP
\-i
.RS 4
-Do reverse IPv6 lookups using the obsolete RFC1886 IP6.INT domain, which is no longer in use. Obsolete bit string label queries (RFC2874) are not attempted.
+Do reverse IPv6 lookups using the obsolete RFC1886 IP6\&.INT domain, which is no longer in use\&. Obsolete bit string label queries (RFC2874) are not attempted\&.
.RE
.PP
\-k \fIkeyfile\fR
.RS 4
-Sign queries using TSIG using a key read from the given file. Key files can be generated using
-\fBtsig\-keygen\fR(8). When using TSIG authentication with
-\fBdig\fR, the name server that is queried needs to know the key and algorithm that is being used. In BIND, this is done by providing appropriate
+Sign queries using TSIG using a key read from the given file\&. Key files can be generated using
+\fBtsig-keygen\fR(8)\&. When using TSIG authentication with
+\fBdig\fR, the name server that is queried needs to know the key and algorithm that is being used\&. In BIND, this is done by providing appropriate
\fBkey\fR
and
\fBserver\fR
statements in
-\fInamed.conf\fR.
+named\&.conf\&.
.RE
.PP
\-m
.RS 4
-Enable memory usage debugging.
+Enable memory usage debugging\&.
.RE
.PP
\-p \fIport\fR
.RS 4
-Send the query to a non\-standard port on the server, instead of the defaut port 53. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number.
+Send the query to a non\-standard port on the server, instead of the defaut port 53\&. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number\&.
.RE
.PP
\-q \fIname\fR
.RS 4
-The domain name to query. This is useful to distinguish the
+The domain name to query\&. This is useful to distinguish the
\fIname\fR
-from other arguments.
+from other arguments\&.
.RE
.PP
\-t \fItype\fR
.RS 4
-The resource record type to query. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the
+The resource record type to query\&. It can be any valid query type which is supported in BIND 9\&. The default query type is "A", unless the
\fB\-x\fR
-option is supplied to indicate a reverse lookup. A zone transfer can be requested by specifying a type of AXFR. When an incremental zone transfer (IXFR) is required, set the
+option is supplied to indicate a reverse lookup\&. A zone transfer can be requested by specifying a type of AXFR\&. When an incremental zone transfer (IXFR) is required, set the
\fItype\fR
to
-ixfr=N. The incremental zone transfer will contain the changes made to the zone since the serial number in the zone's SOA record was
-\fIN\fR.
+ixfr=N\&. The incremental zone transfer will contain the changes made to the zone since the serial number in the zone\*(Aqs SOA record was
+\fIN\fR\&.
.RE
.PP
\-v
.RS 4
-Print the version number and exit.
+Print the version number and exit\&.
.RE
.PP
\-x \fIaddr\fR
.RS 4
-Simplified reverse lookups, for mapping addresses to names. The
+Simplified reverse lookups, for mapping addresses to names\&. The
\fIaddr\fR
-is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address. When the
+is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&. When the
\fB\-x\fR
is used, there is no need to provide the
\fIname\fR,
\fIclass\fR
and
\fItype\fR
-arguments.
+arguments\&.
\fBdig\fR
automatically performs a lookup for a name like
-94.2.0.192.in\-addr.arpa
-and sets the query type and class to PTR and IN respectively. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain (but see also the
+94\&.2\&.0\&.192\&.in\-addr\&.arpa
+and sets the query type and class to PTR and IN respectively\&. IPv6 addresses are looked up using nibble format under the IP6\&.ARPA domain (but see also the
\fB\-i\fR
-option).
+option)\&.
.RE
.PP
\-y \fI[hmac:]\fR\fIkeyname:secret\fR
.RS 4
-Sign queries using TSIG with the given authentication key.
+Sign queries using TSIG with the given authentication key\&.
\fIkeyname\fR
is the name of the key, and
\fIsecret\fR
-is the base64 encoded shared secret.
+is the base64 encoded shared secret\&.
\fIhmac\fR
is the name of the key algorithm; valid choices are
hmac\-md5,
hmac\-sha224,
hmac\-sha256,
hmac\-sha384, or
-hmac\-sha512. If
+hmac\-sha512\&. If
\fIhmac\fR
is not specified, the default is
-hmac\-md5.
+hmac\-md5\&.
.sp
NOTE: You should use the
\fB\-k\fR
\fB\-y\fR
option, because with
\fB\-y\fR
-the shared secret is supplied as a command line argument in clear text. This may be visible in the output from
+the shared secret is supplied as a command line argument in clear text\&. This may be visible in the output from
\fBps\fR(1)
-or in a history file maintained by the user's shell.
+or in a history file maintained by the user\*(Aqs shell\&.
.RE
.SH "QUERY OPTIONS"
.PP
\fBdig\fR
-provides a number of query options which affect the way in which lookups are made and the results displayed. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies.
+provides a number of query options which affect the way in which lookups are made and the results displayed\&. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies\&.
.PP
-Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded by the string
+Each query option is identified by a keyword preceded by a plus sign (+)\&. Some keywords set or reset an option\&. These may be preceded by the string
no
-to negate the meaning of that keyword. Other keywords assign values to options like the timeout interval. They have the form
-\fB+keyword=value\fR. Keywords may be abbreviated, provided the abbreviation is unambiguous; for example,
+to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form
+\fB+keyword=value\fR\&. Keywords may be abbreviated, provided the abbreviation is unambiguous; for example,
+cd
is equivalent to
-+cdflag. The query options are:
++cdflag\&. The query options are:
.PP
\fB+[no]aaflag\fR
.RS 4
A synonym for
-\fI+[no]aaonly\fR.
+\fI+[no]aaonly\fR\&.
.RE
.PP
\fB+[no]aaonly\fR
.RS 4
-Sets the "aa" flag in the query.
+Sets the "aa" flag in the query\&.
.RE
.PP
\fB+[no]additional\fR
.RS 4
-Display [do not display] the additional section of a reply. The default is to display it.
+Display [do not display] the additional section of a reply\&. The default is to display it\&.
.RE
.PP
\fB+[no]adflag\fR
.RS 4
-Set [do not set] the AD (authentic data) bit in the query. This requests the server to return whether all of the answer and authority sections have all been validated as secure according to the security policy of the server. AD=1 indicates that all records have been validated as secure and the answer is not from a OPT\-OUT range. AD=0 indicate that some part of the answer was insecure or not validated. This bit is set by default.
+Set [do not set] the AD (authentic data) bit in the query\&. This requests the server to return whether all of the answer and authority sections have all been validated as secure according to the security policy of the server\&. AD=1 indicates that all records have been validated as secure and the answer is not from a OPT\-OUT range\&. AD=0 indicate that some part of the answer was insecure or not validated\&. This bit is set by default\&.
.RE
.PP
\fB+[no]all\fR
.RS 4
-Set or clear all display flags.
+Set or clear all display flags\&.
.RE
.PP
\fB+[no]answer\fR
.RS 4
-Display [do not display] the answer section of a reply. The default is to display it.
+Display [do not display] the answer section of a reply\&. The default is to display it\&.
.RE
.PP
\fB+[no]authority\fR
.RS 4
-Display [do not display] the authority section of a reply. The default is to display it.
+Display [do not display] the authority section of a reply\&. The default is to display it\&.
.RE
.PP
\fB+[no]badcookie\fR
.RS 4
-Retry lookup with the new server cookie if a BADCOOKIE response is received.
+Retry lookup with the new server cookie if a BADCOOKIE response is received\&.
.RE
.PP
\fB+[no]besteffort\fR
.RS 4
-Attempt to display the contents of messages which are malformed. The default is to not display malformed answers.
+Attempt to display the contents of messages which are malformed\&. The default is to not display malformed answers\&.
.RE
.PP
\fB+bufsize=B\fR
.RS 4
Set the UDP message buffer size advertised using EDNS0 to
\fIB\fR
-bytes. The maximum and minimum sizes of this buffer are 65535 and 0 respectively. Values outside this range are rounded up or down appropriately. Values other than zero will cause a EDNS query to be sent.
+bytes\&. The maximum and minimum sizes of this buffer are 65535 and 0 respectively\&. Values outside this range are rounded up or down appropriately\&. Values other than zero will cause a EDNS query to be sent\&.
.RE
.PP
\fB+[no]cdflag\fR
.RS 4
-Set [do not set] the CD (checking disabled) bit in the query. This requests the server to not perform DNSSEC validation of responses.
+Set [do not set] the CD (checking disabled) bit in the query\&. This requests the server to not perform DNSSEC validation of responses\&.
.RE
.PP
\fB+[no]class\fR
.RS 4
-Display [do not display] the CLASS when printing the record.
+Display [do not display] the CLASS when printing the record\&.
.RE
.PP
\fB+[no]cmd\fR
.RS 4
Toggles the printing of the initial comment in the output identifying the version of
\fBdig\fR
-and the query options that have been applied. This comment is printed by default.
+and the query options that have been applied\&. This comment is printed by default\&.
.RE
.PP
\fB+[no]comments\fR
.RS 4
-Toggle the display of comment lines in the output. The default is to print comments.
+Toggle the display of comment lines in the output\&. The default is to print comments\&.
.RE
.PP
\fB+[no]cookie\fR\fB[=####]\fR
.RS 4
-Send a COOKIE EDNS option, with optional value. Replaying a COOKIE from a previous response will allow the server to identify a previous client. The default is
-\fB+cookie\fR.
+Send a COOKIE EDNS option, with optional value\&. Replaying a COOKIE from a previous response will allow the server to identify a previous client\&. The default is
+\fB+cookie\fR\&.
.sp
\fB+cookie\fR
-is also set when +trace is set to better emulate the default queries from a nameserver.
+is also set when +trace is set to better emulate the default queries from a nameserver\&.
.RE
.PP
\fB+[no]crypto\fR
.RS 4
-Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures. The default is to display the fields. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]".
+Toggle the display of cryptographic fields in DNSSEC records\&. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures\&. The default is to display the fields\&. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e\&.g\&. "[ key id = value ]"\&.
.RE
.PP
\fB+[no]defname\fR
.PP
\fB+[no]dnssec\fR
.RS 4
-Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query.
+Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query\&.
.RE
.PP
\fB+domain=somename\fR
\fIsomename\fR, as if specified in a
\fBdomain\fR
directive in
-\fI/etc/resolv.conf\fR, and enable search list processing as if the
+/etc/resolv\&.conf, and enable search list processing as if the
\fI+search\fR
-option were given.
+option were given\&.
.RE
.PP
\fB+dscp=value\fR
.RS 4
-Set the DSCP code point to be used when sending the query. Valid DSCP code points are in the range [0..63]. By default no code point is explicitly set.
+Set the DSCP code point to be used when sending the query\&. Valid DSCP code points are in the range [0\&.\&.63]\&. By default no code point is explicitly set\&.
.RE
.PP
\fB+[no]edns[=#]\fR
.RS 4
-Specify the EDNS version to query with. Valid values are 0 to 255. Setting the EDNS version will cause a EDNS query to be sent.
+Specify the EDNS version to query with\&. Valid values are 0 to 255\&. Setting the EDNS version will cause a EDNS query to be sent\&.
\fB+noedns\fR
-clears the remembered EDNS version. EDNS is set to 0 by default.
+clears the remembered EDNS version\&. EDNS is set to 0 by default\&.
.RE
.PP
\fB+[no]ednsflags[=#]\fR
.RS 4
-Set the must\-be\-zero EDNS flags bits (Z bits) to the specified value. Decimal, hex and octal encodings are accepted. Setting a named flag (e.g. DO) will silently be ignored. By default, no Z bits are set.
+Set the must\-be\-zero EDNS flags bits (Z bits) to the specified value\&. Decimal, hex and octal encodings are accepted\&. Setting a named flag (e\&.g\&. DO) will silently be ignored\&. By default, no Z bits are set\&.
.RE
.PP
\fB+[no]ednsnegotiation\fR
.RS 4
-Enable / disable EDNS version negotiation. By default EDNS version negotiation is enabled.
+Enable / disable EDNS version negotiation\&. By default EDNS version negotiation is enabled\&.
.RE
.PP
\fB+[no]ednsopt[=code[:value]]\fR
\fBcode\fR
and optionally payload of
\fBvalue\fR
-as a hexadecimal string.
+as a hexadecimal string\&.
\fB+noednsopt\fR
-clears the EDNS options to be sent.
+clears the EDNS options to be sent\&.
.RE
.PP
\fB+[no]expire\fR
.RS 4
-Send an EDNS Expire option.
+Send an EDNS Expire option\&.
.RE
.PP
\fB+[no]fail\fR
.RS 4
-Do not try the next server if you receive a SERVFAIL. The default is to not try the next server which is the reverse of normal stub resolver behavior.
+Do not try the next server if you receive a SERVFAIL\&. The default is to not try the next server which is the reverse of normal stub resolver behavior\&.
.RE
.PP
\fB+[no]header\-only\fR
.RS 4
-Send a query with a DNS header without a question section. The default is to add a question section. The query type and query name are ignored when this is set.
+Send a query with a DNS header without a question section\&. The default is to add a question section\&. The query type and query name are ignored when this is set\&.
.RE
.PP
\fB+[no]identify\fR
.RS 4
Show [or do not show] the IP address and port number that supplied the answer when the
\fI+short\fR
-option is enabled. If short form answers are requested, the default is not to show the source address and port number of the server that provided the answer.
+option is enabled\&. If short form answers are requested, the default is not to show the source address and port number of the server that provided the answer\&.
.RE
.PP
\fB+[no]ignore\fR
.RS 4
-Ignore truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed.
+Ignore truncation in UDP responses instead of retrying with TCP\&. By default, TCP retries are performed\&.
.RE
.PP
\fB+[no]keepopen\fR
.RS 4
-Keep the TCP socket open between queries and reuse it rather than creating a new TCP socket for each lookup. The default is
-\fB+nokeepopen\fR.
+Keep the TCP socket open between queries and reuse it rather than creating a new TCP socket for each lookup\&. The default is
+\fB+nokeepopen\fR\&.
.RE
.PP
\fB+[no]multiline\fR
.RS 4
-Print records like the SOA records in a verbose multi\-line format with human\-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the
+Print records like the SOA records in a verbose multi\-line format with human\-readable comments\&. The default is to print each record on a single line, to facilitate machine parsing of the
\fBdig\fR
-output.
+output\&.
.RE
.PP
\fB+ndots=D\fR
\fIname\fR
to
\fID\fR
-for it to be considered absolute. The default value is that defined using the ndots statement in
-\fI/etc/resolv.conf\fR, or 1 if no ndots statement is present. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the
+for it to be considered absolute\&. The default value is that defined using the ndots statement in
+/etc/resolv\&.conf, or 1 if no ndots statement is present\&. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the
\fBsearch\fR
or
\fBdomain\fR
directive in
-\fI/etc/resolv.conf\fR
+/etc/resolv\&.conf
if
\fB+search\fR
-is set.
+is set\&.
.RE
.PP
\fB+[no]nsid\fR
.RS 4
-Include an EDNS name server ID request when sending a query.
+Include an EDNS name server ID request when sending a query\&.
.RE
.PP
\fB+[no]nssearch\fR
.RS 4
When this option is set,
\fBdig\fR
-attempts to find the authoritative name servers for the zone containing the name being looked up and display the SOA record that each name server has for the zone.
+attempts to find the authoritative name servers for the zone containing the name being looked up and display the SOA record that each name server has for the zone\&.
.RE
.PP
\fB+[no]onesoa\fR
.RS 4
-Print only one (starting) SOA record when performing an AXFR. The default is to print both the starting and ending SOA records.
+Print only one (starting) SOA record when performing an AXFR\&. The default is to print both the starting and ending SOA records\&.
.RE
.PP
\fB+[no]opcode=value\fR
.RS 4
-Set [restore] the DNS message opcode to the specified value. The default value is QUERY (0).
+Set [restore] the DNS message opcode to the specified value\&. The default value is QUERY (0)\&.
.RE
.PP
\fB+[no]qr\fR
.RS 4
-Print [do not print] the query as it is sent. By default, the query is not printed.
+Print [do not print] the query as it is sent\&. By default, the query is not printed\&.
.RE
.PP
\fB+[no]question\fR
.RS 4
-Print [do not print] the question section of a query when an answer is returned. The default is to print the question section as a comment.
+Print [do not print] the question section of a query when an answer is returned\&. The default is to print the question section as a comment\&.
.RE
.PP
\fB+[no]rdflag\fR
.RS 4
A synonym for
-\fI+[no]recurse\fR.
+\fI+[no]recurse\fR\&.
.RE
.PP
\fB+[no]recurse\fR
.RS 4
-Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means
+Toggle the setting of the RD (recursion desired) bit in the query\&. This bit is set by default, which means
\fBdig\fR
-normally sends recursive queries. Recursion is automatically disabled when the
+normally sends recursive queries\&. Recursion is automatically disabled when the
\fI+nssearch\fR
or
\fI+trace\fR
-query options are used.
+query options are used\&.
.RE
.PP
\fB+retry=T\fR
.RS 4
Sets the number of times to retry UDP queries to server to
\fIT\fR
-instead of the default, 2. Unlike
-\fI+tries\fR, this does not include the initial query.
+instead of the default, 2\&. Unlike
+\fI+tries\fR, this does not include the initial query\&.
.RE
.PP
\fB+[no]rrcomments\fR
.RS 4
-Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records). The default is not to print record comments unless multiline mode is active.
+Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records)\&. The default is not to print record comments unless multiline mode is active\&.
.RE
.PP
\fB+[no]search\fR
.RS 4
Use [do not use] the search list defined by the searchlist or domain directive in
-\fIresolv.conf\fR
-(if any). The search list is not used by default.
+resolv\&.conf
+(if any)\&. The search list is not used by default\&.
.sp
-\'ndots' from
-\fIresolv.conf\fR
+\*(Aqndots\*(Aq from
+resolv\&.conf
(default 1) which may be overridden by
\fI+ndots\fR
-determines if the name will be treated as relative or not and hence whether a search is eventually performed or not.
+determines if the name will be treated as relative or not and hence whether a search is eventually performed or not\&.
.RE
.PP
\fB+[no]short\fR
.RS 4
-Provide a terse answer. The default is to print the answer in a verbose form.
+Provide a terse answer\&. The default is to print the answer in a verbose form\&.
.RE
.PP
\fB+[no]showsearch\fR
.RS 4
-Perform [do not perform] a search showing intermediate results.
+Perform [do not perform] a search showing intermediate results\&.
.RE
.PP
\fB+[no]sigchase\fR
.RS 4
-Chase DNSSEC signature chains. Requires dig be compiled with \-DDIG_SIGCHASE.
+Chase DNSSEC signature chains\&. Requires dig be compiled with \-DDIG_SIGCHASE\&.
.RE
.PP
\fB+split=W\fR
\fIW\fR
characters (where
\fIW\fR
-is rounded up to the nearest multiple of 4).
+is rounded up to the nearest multiple of 4)\&.
\fI+nosplit\fR
or
\fI+split=0\fR
-causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active.
+causes fields not to be split at all\&. The default is 56 characters, or 44 characters when multiline mode is active\&.
.RE
.PP
\fB+[no]stats\fR
.RS 4
-This query option toggles the printing of statistics: when the query was made, the size of the reply and so on. The default behavior is to print the query statistics.
+This query option toggles the printing of statistics: when the query was made, the size of the reply and so on\&. The default behavior is to print the query statistics\&.
.RE
.PP
\fB+[no]subnet=addr/prefix\fR
.RS 4
-Send an EDNS Client Subnet option with the specified IP address or network prefix.
+Send an EDNS Client Subnet option with the specified IP address or network prefix\&.
.RE
.PP
\fB+[no]tcp\fR
.RS 4
-Use [do not use] TCP when querying name servers. The default behavior is to use UDP unless an
+Use [do not use] TCP when querying name servers\&. The default behavior is to use UDP unless an
ixfr=N
-query is requested, in which case the default is TCP. AXFR queries always use TCP.
+query is requested, in which case the default is TCP\&. AXFR queries always use TCP\&.
.RE
.PP
\fB+timeout=T\fR
.RS 4
Sets the timeout for a query to
\fIT\fR
-seconds. The default timeout is 5 seconds. An attempt to set
+seconds\&. The default timeout is 5 seconds\&. An attempt to set
\fIT\fR
-to less than 1 will result in a query timeout of 1 second being applied.
+to less than 1 will result in a query timeout of 1 second being applied\&.
.RE
.PP
\fB+[no]topdown\fR
.RS 4
-When chasing DNSSEC signature chains perform a top\-down validation. Requires dig be compiled with \-DDIG_SIGCHASE.
+When chasing DNSSEC signature chains perform a top\-down validation\&. Requires dig be compiled with \-DDIG_SIGCHASE\&.
.RE
.PP
\fB+[no]trace\fR
.RS 4
-Toggle tracing of the delegation path from the root name servers for the name being looked up. Tracing is disabled by default. When tracing is enabled,
+Toggle tracing of the delegation path from the root name servers for the name being looked up\&. Tracing is disabled by default\&. When tracing is enabled,
\fBdig\fR
-makes iterative queries to resolve the name being looked up. It will follow referrals from the root servers, showing the answer from each server that was used to resolve the lookup.
+makes iterative queries to resolve the name being looked up\&. It will follow referrals from the root servers, showing the answer from each server that was used to resolve the lookup\&.
.sp
-If @server is also specified, it affects only the initial query for the root zone name servers.
+If @server is also specified, it affects only the initial query for the root zone name servers\&.
.sp
\fB+dnssec\fR
-is also set when +trace is set to better emulate the default queries from a nameserver.
+is also set when +trace is set to better emulate the default queries from a nameserver\&.
.RE
.PP
\fB+tries=T\fR
.RS 4
Sets the number of times to try UDP queries to server to
\fIT\fR
-instead of the default, 3. If
+instead of the default, 3\&. If
\fIT\fR
-is less than or equal to zero, the number of tries is silently rounded up to 1.
+is less than or equal to zero, the number of tries is silently rounded up to 1\&.
.RE
.PP
\fB+trusted\-key=####\fR
.RS 4
Specifies a file containing trusted keys to be used with
-\fB+sigchase\fR. Each DNSKEY record must be on its own line.
+\fB+sigchase\fR\&. Each DNSKEY record must be on its own line\&.
.sp
If not specified,
\fBdig\fR
will look for
-\fI/etc/trusted\-key.key\fR
+/etc/trusted\-key\&.key
then
-\fItrusted\-key.key\fR
-in the current directory.
+trusted\-key\&.key
+in the current directory\&.
.sp
-Requires dig be compiled with \-DDIG_SIGCHASE.
+Requires dig be compiled with \-DDIG_SIGCHASE\&.
.RE
.PP
\fB+[no]ttlid\fR
.RS 4
-Display [do not display] the TTL when printing the record.
+Display [do not display] the TTL when printing the record\&.
.RE
.PP
\fB+[no]ttlunits\fR
.RS 4
-Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks. Implies +ttlid.
+Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks\&. Implies +ttlid\&.
.RE
.PP
\fB+[no]vc\fR
.RS 4
-Use [do not use] TCP when querying name servers. This alternate syntax to
+Use [do not use] TCP when querying name servers\&. This alternate syntax to
\fI+[no]tcp\fR
-is provided for backwards compatibility. The "vc" stands for "virtual circuit".
+is provided for backwards compatibility\&. The "vc" stands for "virtual circuit"\&.
.RE
.PP
\fB+[no]zflag\fR
.RS 4
-Set [do not set] the last unassigned DNS header flag in a DNS query. This flag is off by default.
+Set [do not set] the last unassigned DNS header flag in a DNS query\&. This flag is off by default\&.
.RE
.SH "MULTIPLE QUERIES"
.PP
\fBdig \fR
supports specifying multiple queries on the command line (in addition to supporting the
\fB\-f\fR
-batch file option). Each of those queries can be supplied with its own set of flags, options and query options.
+batch file option)\&. Each of those queries can be supplied with its own set of flags, options and query options\&.
.PP
In this case, each
\fIquery\fR
-argument represent an individual query in the command\-line syntax described above. Each consists of any of the standard options and flags, the name to be looked up, an optional query type and class and any query options that should be applied to that query.
+argument represent an individual query in the command\-line syntax described above\&. Each consists of any of the standard options and flags, the name to be looked up, an optional query type and class and any query options that should be applied to that query\&.
.PP
-A global set of query options, which should be applied to all queries, can also be supplied. These global query options must precede the first tuple of name, class, type, options, flags, and query options supplied on the command line. Any global query options (except the
+A global set of query options, which should be applied to all queries, can also be supplied\&. These global query options must precede the first tuple of name, class, type, options, flags, and query options supplied on the command line\&. Any global query options (except the
\fB+[no]cmd\fR
-option) can be overridden by a query\-specific set of query options. For example:
+option) can be overridden by a query\-specific set of query options\&. For example:
.sp
+.if n \{\
.RS 4
+.\}
.nf
-dig +qr www.isc.org any \-x 127.0.0.1 isc.org ns +noqr
+dig +qr www\&.isc\&.org any \-x 127\&.0\&.0\&.1 isc\&.org ns +noqr
.fi
+.if n \{\
.RE
+.\}
.sp
shows how
\fBdig\fR
could be used from the command line to make three lookups: an ANY query for
-www.isc.org, a reverse lookup of 127.0.0.1 and a query for the NS records of
-isc.org. A global query option of
+www\&.isc\&.org, a reverse lookup of 127\&.0\&.0\&.1 and a query for the NS records of
+isc\&.org\&. A global query option of
\fI+qr\fR
is applied, so that
\fBdig\fR
-shows the initial query it made for each lookup. The final query has a local query option of
+shows the initial query it made for each lookup\&. The final query has a local query option of
\fI+noqr\fR
which means that
\fBdig\fR
will not print the initial query when it looks up the NS records for
-isc.org.
+isc\&.org\&.
.SH "IDN SUPPORT"
.PP
If
\fBdig\fR
-has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names.
+has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names\&.
\fBdig\fR
-appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the
+appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server\&. If you\*(Aqd like to turn off the IDN support for some reason, defines the
\fBIDN_DISABLE\fR
-environment variable. The IDN support is disabled if the variable is set when
+environment variable\&. The IDN support is disabled if the variable is set when
\fBdig\fR
-runs.
+runs\&.
.SH "FILES"
.PP
-\fI/etc/resolv.conf\fR
+/etc/resolv\&.conf
.PP
-\fI${HOME}/.digrc\fR
+${HOME}/\&.digrc
.SH "SEE ALSO"
.PP
\fBhost\fR(1),
\fBnamed\fR(8),
-\fBdnssec\-keygen\fR(8),
-RFC1035.
+\fBdnssec-keygen\fR(8),
+RFC1035\&.
.SH "BUGS"
.PP
-There are probably too many query options.
+There are probably too many query options\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004\-2011, 2013\-2015 Internet Systems Consortium, Inc. ("ISC")
.br
-Copyright \(co 2000\-2003 Internet Software Consortium.
+Copyright \(co 2004-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2000-2003 Internet Software Consortium.
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dig</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dig">
<a name="man.dig"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>dig — DNS lookup utility</p>
+<p>
+ dig
+ — DNS lookup utility
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dig</code> [@server] [<code class="option">-b <em class="replaceable"><code>address</code></em></code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-f <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-k <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-m</code>] [<code class="option">-p <em class="replaceable"><code>port#</code></em></code>] [<code class="option">-q <em class="replaceable"><code>name</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v</code>] [<code class="option">-x <em class="replaceable"><code>addr</code></em></code>] [<code class="option">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]name:key</code></em></code>] [<code class="option">-4</code>] [<code class="option">-6</code>] [name] [type] [class] [queryopt...]</p></div>
-<div class="cmdsynopsis"><p><code class="command">dig</code> [<code class="option">-h</code>]</p></div>
-<div class="cmdsynopsis"><p><code class="command">dig</code> [global-queryopt...] [query...]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543547"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dig</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dig</code>
+ [@server]
+ [<code class="option">-b <em class="replaceable"><code>address</code></em></code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>filename</code></em></code>]
+ [<code class="option">-k <em class="replaceable"><code>filename</code></em></code>]
+ [<code class="option">-m</code>]
+ [<code class="option">-p <em class="replaceable"><code>port#</code></em></code>]
+ [<code class="option">-q <em class="replaceable"><code>name</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>type</code></em></code>]
+ [<code class="option">-v</code>]
+ [<code class="option">-x <em class="replaceable"><code>addr</code></em></code>]
+ [<code class="option">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]name:key</code></em></code>]
+ [<code class="option">-4</code>]
+ [<code class="option">-6</code>]
+ [name]
+ [type]
+ [class]
+ [queryopt...]
+ </p></div>
+
+ <div class="cmdsynopsis"><p>
+ <code class="command">dig</code>
+ [<code class="option">-h</code>]
+ </p></div>
+
+ <div class="cmdsynopsis"><p>
+ <code class="command">dig</code>
+ [global-queryopt...]
+ [query...]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61017296"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dig</strong></span>
(domain information groper) is a flexible tool
for interrogating DNS name servers. It performs DNS lookups and
displays the answers that are returned from the name server(s) that
- were queried. Most DNS administrators use <span><strong class="command">dig</strong></span> to
+ were queried. Most DNS administrators use <span class="command"><strong>dig</strong></span> to
troubleshoot DNS problems because of its flexibility, ease of use and
clarity of output. Other lookup tools tend to have less functionality
- than <span><strong class="command">dig</strong></span>.
+ than <span class="command"><strong>dig</strong></span>.
</p>
-<p>
- Although <span><strong class="command">dig</strong></span> is normally used with
+
+ <p>
+ Although <span class="command"><strong>dig</strong></span> is normally used with
command-line
arguments, it also has a batch mode of operation for reading lookup
requests from a file. A brief summary of its command-line arguments
and options is printed when the <code class="option">-h</code> option is given.
Unlike earlier versions, the BIND 9 implementation of
- <span><strong class="command">dig</strong></span> allows multiple lookups to be issued
+ <span class="command"><strong>dig</strong></span> allows multiple lookups to be issued
from the
command line.
</p>
-<p>
+
+ <p>
Unless it is told to query a specific name server,
- <span><strong class="command">dig</strong></span> will try each of the servers listed in
+ <span class="command"><strong>dig</strong></span> will try each of the servers listed in
<code class="filename">/etc/resolv.conf</code>. If no usable server addresses
- are found, <span><strong class="command">dig</strong></span> will send the query to the local
+ are found, <span class="command"><strong>dig</strong></span> will send the query to the local
host.
</p>
-<p>
+
+ <p>
When no command line arguments or options are given,
- <span><strong class="command">dig</strong></span> will perform an NS query for "." (the root).
+ <span class="command"><strong>dig</strong></span> will perform an NS query for "." (the root).
</p>
-<p>
- It is possible to set per-user defaults for <span><strong class="command">dig</strong></span> via
+
+ <p>
+ It is possible to set per-user defaults for <span class="command"><strong>dig</strong></span> via
<code class="filename">${HOME}/.digrc</code>. This file is read and
any options in it
are applied before the command line arguments.
</p>
-<p>
+
+ <p>
The IN and CH class names overlap with the IN and CH top level
domain names. Either use the <code class="option">-t</code> and
<code class="option">-c</code> options to specify the type and class,
use the <code class="option">-q</code> the specify the domain name, or
use "IN." and "CH." when looking up these top level domains.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543626"></a><h2>SIMPLE USAGE</h2>
-<p>
- A typical invocation of <span><strong class="command">dig</strong></span> looks like:
+
+ </div>
+
+ <div class="refsection" title="SIMPLE USAGE">
+<a name="idp61026384"></a><h2>SIMPLE USAGE</h2>
+
+
+ <p>
+ A typical invocation of <span class="command"><strong>dig</strong></span> looks like:
</p>
<pre class="programlisting"> dig @server name type </pre>
<p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">server</code></span></dt>
<dd>
-<p>
+ <p>
is the name or IP address of the name server to query. This
can be an IPv4 address in dotted-decimal notation or an IPv6
address in colon-delimited notation. When the supplied
<em class="parameter"><code>server</code></em> argument is a hostname,
- <span><strong class="command">dig</strong></span> resolves that name before querying
+ <span class="command"><strong>dig</strong></span> resolves that name before querying
that name server.
</p>
-<p>
+ <p>
If no <em class="parameter"><code>server</code></em> argument is
- provided, <span><strong class="command">dig</strong></span> consults
+ provided, <span class="command"><strong>dig</strong></span> consults
<code class="filename">/etc/resolv.conf</code>; if an
address is found there, it queries the name server at
that address. If either of the <code class="option">-4</code> or
<code class="option">-6</code> options are in use, then
only addresses for the corresponding transport
will be tried. If no usable addresses are found,
- <span><strong class="command">dig</strong></span> will send the query to the
+ <span class="command"><strong>dig</strong></span> will send the query to the
local host. The reply from the name server that
responds is displayed.
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">name</code></span></dt>
-<dd><p>
+<dd>
+ <p>
is the name of the resource record that is to be looked up.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">type</code></span></dt>
-<dd><p>
+<dd>
+ <p>
indicates what type of query is required —
ANY, A, MX, SIG, etc.
<em class="parameter"><code>type</code></em> can be any valid query
type. If no
<em class="parameter"><code>type</code></em> argument is supplied,
- <span><strong class="command">dig</strong></span> will perform a lookup for an
+ <span class="command"><strong>dig</strong></span> will perform a lookup for an
A record.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543730"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61092048"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-4</span></dt>
-<dd><p>
+<dd>
+ <p>
Use IPv4 only.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-6</span></dt>
-<dd><p>
+<dd>
+ <p>
Use IPv6 only.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-b <em class="replaceable"><code>address[<span class="optional">#port</span>]</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the source IP address of the query.
The <em class="parameter"><code>address</code></em> must be a valid address on
one of the host's network interfaces, or "0.0.0.0" or "::". An
optional port may be specified by appending "#<port>"
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the query class. The
default <em class="parameter"><code>class</code></em> is IN; other classes
are HS for Hesiod records or CH for Chaosnet records.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
-<dd><p>
- Batch mode: <span><strong class="command">dig</strong></span> reads a list of lookup
+<dd>
+ <p>
+ Batch mode: <span class="command"><strong>dig</strong></span> reads a list of lookup
requests to process from the
given <em class="parameter"><code>file</code></em>. Each line in the file
should be organized in the same way they would be
presented as queries to
- <span><strong class="command">dig</strong></span> using the command-line interface.
- </p></dd>
+ <span class="command"><strong>dig</strong></span> using the command-line interface.
+ </p>
+ </dd>
<dt><span class="term">-i</span></dt>
-<dd><p>
+<dd>
+ <p>
Do reverse IPv6 lookups using the obsolete RFC1886 IP6.INT
domain, which is no longer in use. Obsolete bit string
label queries (RFC2874) are not attempted.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-k <em class="replaceable"><code>keyfile</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sign queries using TSIG using a key read from the given file.
Key files can be generated using
- <span class="citerefentry"><span class="refentrytitle">tsig-keygen</span>(8)</span>.
- When using TSIG authentication with <span><strong class="command">dig</strong></span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">tsig-keygen</span>(8)
+ </span>.
+ When using TSIG authentication with <span class="command"><strong>dig</strong></span>,
the name server that is queried needs to know the key and
algorithm that is being used. In BIND, this is done by
- providing appropriate <span><strong class="command">key</strong></span>
- and <span><strong class="command">server</strong></span> statements in
+ providing appropriate <span class="command"><strong>key</strong></span>
+ and <span class="command"><strong>server</strong></span> statements in
<code class="filename">named.conf</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-m</span></dt>
-<dd><p>
+<dd>
+ <p>
Enable memory usage debugging.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Send the query to a non-standard port on the server,
instead of the defaut port 53. This option would be used
to test a name server that has been configured to listen
for queries on a non-standard port number.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-q <em class="replaceable"><code>name</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The domain name to query. This is useful to distinguish
the <em class="parameter"><code>name</code></em> from other arguments.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The resource record type to query. It can be any valid query type
which is
supported in BIND 9. The default query type is "A", unless the
made to the zone since the serial number in the zone's SOA
record was
<em class="parameter"><code>N</code></em>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v</span></dt>
-<dd><p>
+<dd>
+ <p>
Print the version number and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-x <em class="replaceable"><code>addr</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Simplified reverse lookups, for mapping addresses to
names. The <em class="parameter"><code>addr</code></em> is an IPv4 address
in dotted-decimal notation, or a colon-delimited IPv6
need to provide
the <em class="parameter"><code>name</code></em>, <em class="parameter"><code>class</code></em>
and <em class="parameter"><code>type</code></em>
- arguments. <span><strong class="command">dig</strong></span> automatically performs a
+ arguments. <span class="command"><strong>dig</strong></span> automatically performs a
lookup for a name like
<code class="literal">94.2.0.192.in-addr.arpa</code> and sets the
query type and class to PTR and IN respectively. IPv6
addresses are looked up using nibble format under the
IP6.ARPA domain (but see also the <code class="option">-i</code>
option).
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></span></dt>
<dd>
-<p>
+ <p>
Sign queries using TSIG with the given authentication key.
<em class="parameter"><code>keyname</code></em> is the name of the key, and
<em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
<code class="literal">hmac-sha512</code>. If <em class="parameter"><code>hmac</code></em>
is not specified, the default is <code class="literal">hmac-md5</code>.
</p>
-<p>
+ <p>
NOTE: You should use the <code class="option">-k</code> option and
avoid the <code class="option">-y</code> option, because
with <code class="option">-y</code> the shared secret is supplied as
a command line argument in clear text. This may be visible
in the output from
- <span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">ps</span>(1)
+ </span>
or in a history file maintained by the user's shell.
</p>
-</dd>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544181"></a><h2>QUERY OPTIONS</h2>
-<p><span><strong class="command">dig</strong></span>
+ </div>
+
+ <div class="refsection" title="QUERY OPTIONS">
+<a name="idp61136464"></a><h2>QUERY OPTIONS</h2>
+
+
+ <p><span class="command"><strong>dig</strong></span>
provides a number of query options which affect
the way in which lookups are made and the results displayed. Some of
these set or reset flag bits in the query header, some determine which
sections of the answer get printed, and others determine the timeout
and retry strategies.
</p>
-<p>
+
+ <p>
Each query option is identified by a keyword preceded by a plus sign
(<code class="literal">+</code>). Some keywords set or reset an
option. These may be preceded
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="option">+[no]aaflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A synonym for <em class="parameter"><code>+[no]aaonly</code></em>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]aaonly</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the "aa" flag in the query.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]additional</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the additional section of a
reply. The default is to display it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]adflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set [do not set] the AD (authentic data) bit in the
query. This requests the server to return whether
all of the answer and authority sections have all
from a OPT-OUT range. AD=0 indicate that some part
of the answer was insecure or not validated. This
bit is set by default.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]all</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set or clear all display flags.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]answer</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the answer section of a
reply. The default is to display it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]authority</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the authority section of a
reply. The default is to display it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]badcookie</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Retry lookup with the new server cookie if a
BADCOOKIE response is received.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]besteffort</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Attempt to display the contents of messages which are
malformed. The default is to not display malformed
answers.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+bufsize=B</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the UDP message buffer size advertised using EDNS0
to <em class="parameter"><code>B</code></em> bytes. The maximum and
minimum sizes of this buffer are 65535 and 0 respectively.
Values outside this range are rounded up or down
appropriately. Values other than zero will cause a
EDNS query to be sent.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]cdflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set [do not set] the CD (checking disabled) bit in
the query. This requests the server to not perform
DNSSEC validation of responses.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]class</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the CLASS when printing the
record.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]cmd</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggles the printing of the initial comment in the
- output identifying the version of <span><strong class="command">dig</strong></span>
+ output identifying the version of <span class="command"><strong>dig</strong></span>
and the query options that have been applied. This
comment is printed by default.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]comments</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the display of comment lines in the output.
The default is to print comments.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]cookie[<span class="optional">=####</span>]</code></span></dt>
<dd>
-<p>
+ <p>
Send a COOKIE EDNS option, with optional
value. Replaying a COOKIE from a previous response will
allow the server to identify a previous client. The
default is <code class="option">+cookie</code>.
</p>
-<p>
- <span><strong class="command">+cookie</strong></span> is also set when +trace
+ <p>
+ <span class="command"><strong>+cookie</strong></span> is also set when +trace
is set to better emulate the default queries from a
nameserver.
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="option">+[no]crypto</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the display of cryptographic fields in DNSSEC
records. The contents of these field are unnecessary
to debug most DNSSEC validation failures and removing
are replaced by the string "[omitted]" or in the
DNSKEY case the key id is displayed as the replacement,
e.g. "[ key id = value ]".
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]defname</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Deprecated, treated as a synonym for
<em class="parameter"><code>+[no]search</code></em>
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]dnssec</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Requests DNSSEC records be sent by setting the DNSSEC
OK bit (DO) in the OPT record in the additional section
of the query.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+domain=somename</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the search list to contain the single domain
<em class="parameter"><code>somename</code></em>, as if specified in
- a <span><strong class="command">domain</strong></span> directive in
+ a <span class="command"><strong>domain</strong></span> directive in
<code class="filename">/etc/resolv.conf</code>, and enable
search list processing as if the
<em class="parameter"><code>+search</code></em> option were given.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+dscp=value</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the DSCP code point to be used when sending the
query. Valid DSCP code points are in the range
[0..63]. By default no code point is explicitly set.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]edns[=#]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify the EDNS version to query with. Valid values
are 0 to 255. Setting the EDNS version will cause
a EDNS query to be sent. <code class="option">+noedns</code>
clears the remembered EDNS version. EDNS is set to
0 by default.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ednsflags[=#]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the must-be-zero EDNS flags bits (Z bits) to the
specified value. Decimal, hex and octal encodings are
accepted. Setting a named flag (e.g. DO) will silently be
ignored. By default, no Z bits are set.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ednsnegotiation</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Enable / disable EDNS version negotiation. By default
EDNS version negotiation is enabled.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ednsopt[=code[:value]]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify EDNS option with code point <code class="option">code</code>
and optionally payload of <code class="option">value</code> as a
hexadecimal string. <code class="option">+noednsopt</code>
clears the EDNS options to be sent.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]expire</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Send an EDNS Expire option.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]fail</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Do not try the next server if you receive a SERVFAIL.
The default is to not try the next server which is
the reverse of normal stub resolver behavior.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]header-only</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Send a query with a DNS header without a question section.
The default is to add a question section. The query type
and query name are ignored when this is set.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]identify</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Show [or do not show] the IP address and port number
that supplied the answer when the
<em class="parameter"><code>+short</code></em> option is enabled. If
short form answers are requested, the default is not
to show the source address and port number of the
server that provided the answer.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ignore</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Ignore truncation in UDP responses instead of retrying
with TCP. By default, TCP retries are performed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]keepopen</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Keep the TCP socket open between queries and reuse
it rather than creating a new TCP socket for each
lookup. The default is <code class="option">+nokeepopen</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]multiline</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Print records like the SOA records in a verbose
multi-line format with human-readable comments. The
default is to print each record on a single line, to
- facilitate machine parsing of the <span><strong class="command">dig</strong></span>
+ facilitate machine parsing of the <span class="command"><strong>dig</strong></span>
output.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+ndots=D</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the number of dots that have to appear in
<em class="parameter"><code>name</code></em> to <em class="parameter"><code>D</code></em>
for it to be considered absolute. The default value
or <code class="option">domain</code> directive in
<code class="filename">/etc/resolv.conf</code> if
<code class="option">+search</code> is set.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]nsid</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Include an EDNS name server ID request when sending
a query.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]nssearch</code></span></dt>
-<dd><p>
- When this option is set, <span><strong class="command">dig</strong></span>
+<dd>
+ <p>
+ When this option is set, <span class="command"><strong>dig</strong></span>
attempts to find the authoritative name servers for
the zone containing the name being looked up and
display the SOA record that each name server has for
the zone.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]onesoa</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Print only one (starting) SOA record when performing
an AXFR. The default is to print both the starting
and ending SOA records.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]opcode=value</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set [restore] the DNS message opcode to the specified
value. The default value is QUERY (0).
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]qr</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Print [do not print] the query as it is sent. By
default, the query is not printed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]question</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Print [do not print] the question section of a query
when an answer is returned. The default is to print
the question section as a comment.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]rdflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A synonym for <em class="parameter"><code>+[no]recurse</code></em>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]recurse</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the setting of the RD (recursion desired) bit
in the query. This bit is set by default, which means
- <span><strong class="command">dig</strong></span> normally sends recursive
+ <span class="command"><strong>dig</strong></span> normally sends recursive
queries. Recursion is automatically disabled when
the <em class="parameter"><code>+nssearch</code></em> or
<em class="parameter"><code>+trace</code></em> query options are used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+retry=T</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the number of times to retry UDP queries to
server to <em class="parameter"><code>T</code></em> instead of the
default, 2. Unlike <em class="parameter"><code>+tries</code></em>,
this does not include the initial query.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]rrcomments</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the display of per-record comments in the
output (for example, human-readable key information
about DNSKEY records). The default is not to print
record comments unless multiline mode is active.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]search</code></span></dt>
<dd>
-<p>
+ <p>
Use [do not use] the search list defined by the
searchlist or domain directive in
<code class="filename">resolv.conf</code> (if any). The search
list is not used by default.
</p>
-<p>
+ <p>
'ndots' from <code class="filename">resolv.conf</code> (default 1)
which may be overridden by <em class="parameter"><code>+ndots</code></em>
determines if the name will be treated as relative
or not and hence whether a search is eventually
performed or not.
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="option">+[no]short</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Provide a terse answer. The default is to print the
answer in a verbose form.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]showsearch</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Perform [do not perform] a search showing intermediate
results.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]sigchase</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Chase DNSSEC signature chains. Requires dig be
compiled with -DDIG_SIGCHASE.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+split=W</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Split long hex- or base64-formatted fields in resource
records into chunks of <em class="parameter"><code>W</code></em>
characters (where <em class="parameter"><code>W</code></em> is rounded
<em class="parameter"><code>+split=0</code></em> causes fields not to
be split at all. The default is 56 characters, or
44 characters when multiline mode is active.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]stats</code></span></dt>
-<dd><p>
+<dd>
+ <p>
This query option toggles the printing of statistics:
when the query was made, the size of the reply and
so on. The default behavior is to print the query
statistics.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]subnet=addr/prefix</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Send an EDNS Client Subnet option with the specified
IP address or network prefix.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]tcp</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Use [do not use] TCP when querying name servers. The
default behavior is to use UDP unless an
<code class="literal">ixfr=N</code> query is requested, in which
case the default is TCP. AXFR queries always use
TCP.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+timeout=T</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the timeout for a query to
<em class="parameter"><code>T</code></em> seconds. The default
An attempt to set <em class="parameter"><code>T</code></em> to less
than 1 will result
in a query timeout of 1 second being applied.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]topdown</code></span></dt>
-<dd><p>
+<dd>
+ <p>
When chasing DNSSEC signature chains perform a top-down
validation. Requires dig be compiled with -DDIG_SIGCHASE.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]trace</code></span></dt>
<dd>
-<p>
+ <p>
Toggle tracing of the delegation path from the root
name servers for the name being looked up. Tracing
is disabled by default. When tracing is enabled,
- <span><strong class="command">dig</strong></span> makes iterative queries to
+ <span class="command"><strong>dig</strong></span> makes iterative queries to
resolve the name being looked up. It will follow
referrals from the root servers, showing the answer
from each server that was used to resolve the lookup.
- </p>
-<p>
+ </p> <p>
If @server is also specified, it affects only the
initial query for the root zone name servers.
- </p>
-<p>
- <span><strong class="command">+dnssec</strong></span> is also set when +trace
+ </p> <p>
+ <span class="command"><strong>+dnssec</strong></span> is also set when +trace
is set to better emulate the default queries from a
nameserver.
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="option">+tries=T</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the number of times to try UDP queries to server
to <em class="parameter"><code>T</code></em> instead of the default,
3. If <em class="parameter"><code>T</code></em> is less than or equal
to zero, the number of tries is silently rounded up
to 1.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+trusted-key=####</code></span></dt>
<dd>
-<p>
+ <p>
Specifies a file containing trusted keys to be used
with <code class="option">+sigchase</code>. Each DNSKEY record
must be on its own line.
- </p>
-<p>
- If not specified, <span><strong class="command">dig</strong></span> will look
+ </p> <p>
+ If not specified, <span class="command"><strong>dig</strong></span> will look
for <code class="filename">/etc/trusted-key.key</code> then
<code class="filename">trusted-key.key</code> in the current
directory.
- </p>
-<p>
+ </p> <p>
Requires dig be compiled with -DDIG_SIGCHASE.
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="option">+[no]ttlid</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the TTL when printing the
record.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ttlunits</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the TTL in friendly human-readable
time units of "s", "m", "h", "d", and "w", representing
seconds, minutes, hours, days and weeks. Implies +ttlid.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]vc</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Use [do not use] TCP when querying name servers. This
alternate syntax to <em class="parameter"><code>+[no]tcp</code></em>
is provided for backwards compatibility. The "vc"
stands for "virtual circuit".
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]zflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set [do not set] the last unassigned DNS header flag in a
DNS query. This flag is off by default.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545578"></a><h2>MULTIPLE QUERIES</h2>
-<p>
- The BIND 9 implementation of <span><strong class="command">dig </strong></span>
+ </div>
+
+ <div class="refsection" title="MULTIPLE QUERIES">
+<a name="idp61267536"></a><h2>MULTIPLE QUERIES</h2>
+
+
+ <p>
+ The BIND 9 implementation of <span class="command"><strong>dig </strong></span>
supports
specifying multiple queries on the command line (in addition to
supporting the <code class="option">-f</code> batch file option). Each of those
queries can be supplied with its own set of flags, options and query
options.
</p>
-<p>
+
+ <p>
In this case, each <em class="parameter"><code>query</code></em> argument
represent an
individual query in the command-line syntax described above. Each
looked up, an optional query type and class and any query options that
should be applied to that query.
</p>
-<p>
+
+ <p>
A global set of query options, which should be applied to all queries,
can also be supplied. These global query options must precede the
first tuple of name, class, type, options, flags, and query options
dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr
</pre>
<p>
- shows how <span><strong class="command">dig</strong></span> could be used from the
+ shows how <span class="command"><strong>dig</strong></span> could be used from the
command line
to make three lookups: an ANY query for <code class="literal">www.isc.org</code>, a
reverse lookup of 127.0.0.1 and a query for the NS records of
A global query option of <em class="parameter"><code>+qr</code></em> is
applied, so
- that <span><strong class="command">dig</strong></span> shows the initial query it made
+ that <span class="command"><strong>dig</strong></span> shows the initial query it made
for each
lookup. The final query has a local query option of
- <em class="parameter"><code>+noqr</code></em> which means that <span><strong class="command">dig</strong></span>
+ <em class="parameter"><code>+noqr</code></em> which means that <span class="command"><strong>dig</strong></span>
will not print the initial query when it looks up the NS records for
<code class="literal">isc.org</code>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545640"></a><h2>IDN SUPPORT</h2>
-<p>
- If <span><strong class="command">dig</strong></span> has been built with IDN (internationalized
+
+ </div>
+
+ <div class="refsection" title="IDN SUPPORT">
+<a name="idp61279056"></a><h2>IDN SUPPORT</h2>
+
+ <p>
+ If <span class="command"><strong>dig</strong></span> has been built with IDN (internationalized
domain name) support, it can accept and display non-ASCII domain names.
- <span><strong class="command">dig</strong></span> appropriately converts character encoding of
+ <span class="command"><strong>dig</strong></span> appropriately converts character encoding of
domain name before sending a request to DNS server or displaying a
reply from the server.
If you'd like to turn off the IDN support for some reason, defines
the <code class="envar">IDN_DISABLE</code> environment variable.
The IDN support is disabled if the variable is set when
- <span><strong class="command">dig</strong></span> runs.
+ <span class="command"><strong>dig</strong></span> runs.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545662"></a><h2>FILES</h2>
-<p><code class="filename">/etc/resolv.conf</code>
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp61294416"></a><h2>FILES</h2>
+
+ <p><code class="filename">/etc/resolv.conf</code>
</p>
-<p><code class="filename">${HOME}/.digrc</code>
+ <p><code class="filename">${HOME}/.digrc</code>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545748"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">host</span>(1)</span>,
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61296720"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">host</span>(1)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>,
<em class="citetitle">RFC1035</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545785"></a><h2>BUGS</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="BUGS">
+<a name="idp61301584"></a><h2>BUGS</h2>
+
+ <p>
There are probably too many query options.
</p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: host
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 20, 2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2009-01-20
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "HOST" "1" "January 20, 2009" "BIND9" "BIND9"
+.TH "HOST" "1" "2009\-01\-20" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
host \- DNS lookup utility
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBhost\fR
-is a simple utility for performing DNS lookups. It is normally used to convert names to IP addresses and vice versa. When no arguments or options are given,
+is a simple utility for performing DNS lookups\&. It is normally used to convert names to IP addresses and vice versa\&. When no arguments or options are given,
\fBhost\fR
-prints a short summary of its command line arguments and options.
+prints a short summary of its command line arguments and options\&.
.PP
\fIname\fR
-is the domain name that is to be looked up. It can also be a dotted\-decimal IPv4 address or a colon\-delimited IPv6 address, in which case
+is the domain name that is to be looked up\&. It can also be a dotted\-decimal IPv4 address or a colon\-delimited IPv6 address, in which case
\fBhost\fR
-will by default perform a reverse lookup for that address.
+will by default perform a reverse lookup for that address\&.
\fIserver\fR
is an optional argument which is either the name or IP address of the name server that
\fBhost\fR
should query instead of the server or servers listed in
-\fI/etc/resolv.conf\fR.
+/etc/resolv\&.conf\&.
.PP
The
\fB\-a\fR
\fB\-v\fR
option and asking
\fBhost\fR
-to make a query of type ANY.
+to make a query of type ANY\&.
.PP
When the
\fB\-C\fR
\fBhost\fR
will attempt to display the SOA records for zone
\fIname\fR
-from all the listed authoritative name servers for that zone. The list of name servers is defined by the NS records that are found for the zone.
+from all the listed authoritative name servers for that zone\&. The list of name servers is defined by the NS records that are found for the zone\&.
.PP
The
\fB\-c\fR
option instructs to make a DNS query of class
-\fIclass\fR. This can be used to lookup Hesiod or Chaosnet class resource records. The default class is IN (Internet).
+\fIclass\fR\&. This can be used to lookup Hesiod or Chaosnet class resource records\&. The default class is IN (Internet)\&.
.PP
Verbose output is generated by
\fBhost\fR
\fB\-d\fR
or
\fB\-v\fR
-option is used. The two options are equivalent. They have been provided for backwards compatibility. In previous versions, the
+option is used\&. The two options are equivalent\&. They have been provided for backwards compatibility\&. In previous versions, the
\fB\-d\fR
option switched on debugging traces and
\fB\-v\fR
-enabled verbose output. Verbose output can also be enabled by setting the
+enabled verbose output\&. Verbose output can also be enabled by setting the
\fIdebug\fR
option in
-\fI/etc/resolv.conf\fR.
+/etc/resolv\&.conf\&.
.PP
List mode is selected by the
\fB\-l\fR
-option. This makes
+option\&. This makes
\fBhost\fR
perform a zone transfer for zone
-\fIname\fR. Transfer the zone printing out the NS, PTR and address records (A/AAAA). If combined with
+\fIname\fR\&. Transfer the zone printing out the NS, PTR and address records (A/AAAA)\&. If combined with
\fB\-a\fR
-all records will be printed.
+all records will be printed\&.
.PP
The
\fB\-i\fR
-option specifies that reverse lookups of IPv6 addresses should use the IP6.INT domain as defined in RFC1886. The default is to use IP6.ARPA.
+option specifies that reverse lookups of IPv6 addresses should use the IP6\&.INT domain as defined in RFC1886\&. The default is to use IP6\&.ARPA\&.
.PP
The
\fB\-N\fR
option sets the number of dots that have to be in
\fIname\fR
-for it to be considered absolute. The default value is that defined using the ndots statement in
-\fI/etc/resolv.conf\fR, or 1 if no ndots statement is present. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the
+for it to be considered absolute\&. The default value is that defined using the ndots statement in
+/etc/resolv\&.conf, or 1 if no ndots statement is present\&. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the
\fBsearch\fR
or
\fBdomain\fR
directive in
-\fI/etc/resolv.conf\fR.
+/etc/resolv\&.conf\&.
.PP
The number of UDP retries for a lookup can be changed with the
\fB\-R\fR
-option.
+option\&.
\fInumber\fR
indicates how many times
\fBhost\fR
-will repeat a query that does not get answered. If
+will repeat a query that does not get answered\&. If
\fInumber\fR
-is negative or zero, the number of retries will default to 1. The default value is 1, or the value of the
+is negative or zero, the number of retries will default to 1\&. The default value is 1, or the value of the
\fIattempts\fR
option in
-\fI/etc/resolv.conf\fR, if set.
+/etc/resolv\&.conf, if set\&.
.PP
Non\-recursive queries can be made via the
\fB\-r\fR
-option. Setting this option clears the
+option\&. Setting this option clears the
\fBRD\fR
\(em recursion desired \(em bit in the query which
\fBhost\fR
-makes. This should mean that the name server receiving the query will not attempt to resolve
-\fIname\fR. The
+makes\&. This should mean that the name server receiving the query will not attempt to resolve
+\fIname\fR\&. The
\fB\-r\fR
option enables
\fBhost\fR
-to mimic the behavior of a name server by making non\-recursive queries and expecting to receive answers to those queries that are usually referrals to other name servers.
+to mimic the behavior of a name server by making non\-recursive queries and expecting to receive answers to those queries that are usually referrals to other name servers\&.
.PP
By default,
\fBhost\fR
-uses UDP when making queries. The
+uses UDP when making queries\&. The
\fB\-T\fR
-option makes it use a TCP connection when querying the name server. TCP will be automatically selected for queries that require it, such as zone transfer (AXFR) requests.
+option makes it use a TCP connection when querying the name server\&. TCP will be automatically selected for queries that require it, such as zone transfer (AXFR) requests\&.
.PP
The
\fB\-4\fR
option forces
\fBhost\fR
-to only use IPv4 query transport. The
+to only use IPv4 query transport\&. The
\fB\-6\fR
option forces
\fBhost\fR
-to only use IPv6 query transport.
+to only use IPv6 query transport\&.
.PP
The
\fB\-t\fR
-option is used to select the query type.
+option is used to select the query type\&.
\fItype\fR
-can be any recognized query type: CNAME, NS, SOA, SIG, KEY, AXFR, etc. When no query type is specified,
+can be any recognized query type: CNAME, NS, SOA, SIG, KEY, AXFR, etc\&. When no query type is specified,
\fBhost\fR
-automatically selects an appropriate query type. By default, it looks for A, AAAA, and MX records, but if the
+automatically selects an appropriate query type\&. By default, it looks for A, AAAA, and MX records, but if the
\fB\-C\fR
option was given, queries will be made for SOA records, and if
\fIname\fR
is a dotted\-decimal IPv4 address or colon\-delimited IPv6 address,
\fBhost\fR
-will query for PTR records. If a query type of IXFR is chosen the starting serial number can be specified by appending an equal followed by the starting serial number (e.g. \-t IXFR=12345678).
+will query for PTR records\&. If a query type of IXFR is chosen the starting serial number can be specified by appending an equal followed by the starting serial number (e\&.g\&. \-t IXFR=12345678)\&.
.PP
The time to wait for a reply can be controlled through the
\fB\-W\fR
and
\fB\-w\fR
-options. The
+options\&. The
\fB\-W\fR
option makes
\fBhost\fR
wait for
\fIwait\fR
-seconds. If
+seconds\&. If
\fIwait\fR
-is less than one, the wait interval is set to one second. When the
+is less than one, the wait interval is set to one second\&. When the
\fB\-w\fR
option is used,
\fBhost\fR
-will effectively wait forever for a reply. The time to wait for a response will be set to the number of seconds given by the hardware's maximum value for an integer quantity. By default,
+will effectively wait forever for a reply\&. The time to wait for a response will be set to the number of seconds given by the hardware\*(Aqs maximum value for an integer quantity\&. By default,
\fBhost\fR
-will wait for 5 seconds for UDP responses and 10 seconds for TCP connections. These defaults can be overridden by the
+will wait for 5 seconds for UDP responses and 10 seconds for TCP connections\&. These defaults can be overridden by the
\fItimeout\fR
option in
-\fI/etc/resolv.conf\fR.
+/etc/resolv\&.conf\&.
.PP
The
\fB\-s\fR
option tells
\fBhost\fR
\fInot\fR
-to send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior.
+to send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior\&.
.PP
The
\fB\-m\fR
\fIrecord\fR,
\fIusage\fR
and
-\fItrace\fR.
+\fItrace\fR\&.
.PP
The
\fB\-V\fR
option causes
\fBhost\fR
-to print the version number and exit.
+to print the version number and exit\&.
.SH "IDN SUPPORT"
.PP
If
\fBhost\fR
-has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names.
+has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names\&.
\fBhost\fR
-appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the
+appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server\&. If you\*(Aqd like to turn off the IDN support for some reason, defines the
\fBIDN_DISABLE\fR
-environment variable. The IDN support is disabled if the variable is set when
+environment variable\&. The IDN support is disabled if the variable is set when
\fBhost\fR
-runs.
+runs\&.
.SH "FILES"
.PP
-\fI/etc/resolv.conf\fR
+/etc/resolv\&.conf
.SH "SEE ALSO"
.PP
\fBdig\fR(1),
-\fBnamed\fR(8).
+\fBnamed\fR(8)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004, 2005, 2007\-2009, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
-Copyright \(co 2000\-2002 Internet Software Consortium.
+Copyright \(co 2004, 2005, 2007-2009, 2014 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2000-2002 Internet Software Consortium.
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>host</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="host">
<a name="man.host"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>host — DNS lookup utility</p>
+<p>
+ host
+ — DNS lookup utility
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">host</code> [<code class="option">-aCdlnrsTwv</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-N <em class="replaceable"><code>ndots</code></em></code>] [<code class="option">-R <em class="replaceable"><code>number</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-W <em class="replaceable"><code>wait</code></em></code>] [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-4</code>] [<code class="option">-6</code>] [<code class="option">-v</code>] [<code class="option">-V</code>] {name} [server]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543454"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">host</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">host</code>
+ [<code class="option">-aCdlnrsTwv</code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-N <em class="replaceable"><code>ndots</code></em></code>]
+ [<code class="option">-R <em class="replaceable"><code>number</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>type</code></em></code>]
+ [<code class="option">-W <em class="replaceable"><code>wait</code></em></code>]
+ [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>]
+ [<code class="option">-4</code>]
+ [<code class="option">-6</code>]
+ [<code class="option">-v</code>]
+ [<code class="option">-V</code>]
+ {name}
+ [server]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60793808"></a><h2>DESCRIPTION</h2>
+
+
+ <p><span class="command"><strong>host</strong></span>
is a simple utility for performing DNS lookups.
It is normally used to convert names to IP addresses and vice versa.
When no arguments or options are given,
- <span><strong class="command">host</strong></span>
+ <span class="command"><strong>host</strong></span>
prints a short summary of its command line arguments and options.
</p>
-<p><em class="parameter"><code>name</code></em> is the domain name that is to be
+
+ <p><em class="parameter"><code>name</code></em> is the domain name that is to be
looked
up. It can also be a dotted-decimal IPv4 address or a colon-delimited
- IPv6 address, in which case <span><strong class="command">host</strong></span> will by
+ IPv6 address, in which case <span class="command"><strong>host</strong></span> will by
default
perform a reverse lookup for that address.
<em class="parameter"><code>server</code></em> is an optional argument which
is either
- the name or IP address of the name server that <span><strong class="command">host</strong></span>
+ the name or IP address of the name server that <span class="command"><strong>host</strong></span>
should query instead of the server or servers listed in
<code class="filename">/etc/resolv.conf</code>.
</p>
-<p>
+
+ <p>
The <code class="option">-a</code> (all) option is equivalent to setting the
- <code class="option">-v</code> option and asking <span><strong class="command">host</strong></span> to make
+ <code class="option">-v</code> option and asking <span class="command"><strong>host</strong></span> to make
a query of type ANY.
</p>
-<p>
- When the <code class="option">-C</code> option is used, <span><strong class="command">host</strong></span>
+
+ <p>
+ When the <code class="option">-C</code> option is used, <span class="command"><strong>host</strong></span>
will attempt to display the SOA records for zone
<em class="parameter"><code>name</code></em> from all the listed
authoritative name
servers for that zone. The list of name servers is defined by the NS
records that are found for the zone.
</p>
-<p>
+
+ <p>
The <code class="option">-c</code> option instructs to make a DNS query of class
<em class="parameter"><code>class</code></em>. This can be used to lookup
Hesiod or
Chaosnet class resource records. The default class is IN (Internet).
</p>
-<p>
- Verbose output is generated by <span><strong class="command">host</strong></span> when
+
+ <p>
+ Verbose output is generated by <span class="command"><strong>host</strong></span> when
the
<code class="option">-d</code> or <code class="option">-v</code> option is used. The two
options are equivalent. They have been provided for backwards
<em class="parameter"><code>debug</code></em> option in
<code class="filename">/etc/resolv.conf</code>.
</p>
-<p>
+
+ <p>
List mode is selected by the <code class="option">-l</code> option. This makes
- <span><strong class="command">host</strong></span> perform a zone transfer for zone
+ <span class="command"><strong>host</strong></span> perform a zone transfer for zone
<em class="parameter"><code>name</code></em>. Transfer the zone printing out
the NS, PTR
and address records (A/AAAA). If combined with <code class="option">-a</code>
all records will be printed.
</p>
-<p>
+
+ <p>
The <code class="option">-i</code>
option specifies that reverse lookups of IPv6 addresses should
use the IP6.INT domain as defined in RFC1886.
The default is to use IP6.ARPA.
</p>
-<p>
+
+ <p>
The <code class="option">-N</code> option sets the number of dots that have to be
in <em class="parameter"><code>name</code></em> for it to be considered
absolute. The
or <span class="type">domain</span> directive in
<code class="filename">/etc/resolv.conf</code>.
</p>
-<p>
+
+ <p>
The number of UDP retries for a lookup can be changed with the
<code class="option">-R</code> option. <em class="parameter"><code>number</code></em>
indicates
- how many times <span><strong class="command">host</strong></span> will repeat a query
+ how many times <span class="command"><strong>host</strong></span> will repeat a query
that does
not get answered. If
<em class="parameter"><code>number</code></em> is negative or zero, the
the value of the <em class="parameter"><code>attempts</code></em> option in
<code class="filename">/etc/resolv.conf</code>, if set.
</p>
-<p>
+
+ <p>
Non-recursive queries can be made via the <code class="option">-r</code> option.
Setting this option clears the <span class="type">RD</span> — recursion
- desired — bit in the query which <span><strong class="command">host</strong></span> makes.
+ desired — bit in the query which <span class="command"><strong>host</strong></span> makes.
This should mean that the name server receiving the query will not
attempt to resolve <em class="parameter"><code>name</code></em>. The
- <code class="option">-r</code> option enables <span><strong class="command">host</strong></span>
+ <code class="option">-r</code> option enables <span class="command"><strong>host</strong></span>
to mimic
the behavior of a name server by making non-recursive queries and
expecting to receive answers to those queries that are usually
referrals to other name servers.
</p>
-<p>
- By default, <span><strong class="command">host</strong></span> uses UDP when making
+
+ <p>
+ By default, <span class="command"><strong>host</strong></span> uses UDP when making
queries. The
<code class="option">-T</code> option makes it use a TCP connection when querying
the name server. TCP will be automatically selected for queries that
require it, such as zone transfer (AXFR) requests.
</p>
-<p>
- The <code class="option">-4</code> option forces <span><strong class="command">host</strong></span> to only
+
+ <p>
+ The <code class="option">-4</code> option forces <span class="command"><strong>host</strong></span> to only
use IPv4 query transport. The <code class="option">-6</code> option forces
- <span><strong class="command">host</strong></span> to only use IPv6 query transport.
+ <span class="command"><strong>host</strong></span> to only use IPv6 query transport.
</p>
-<p>
+
+ <p>
The <code class="option">-t</code> option is used to select the query type.
<em class="parameter"><code>type</code></em> can be any recognized query
type: CNAME,
NS, SOA, SIG, KEY, AXFR, etc. When no query type is specified,
- <span><strong class="command">host</strong></span> automatically selects an appropriate
+ <span class="command"><strong>host</strong></span> automatically selects an appropriate
query
type. By default, it looks for A, AAAA, and MX records, but if the
<code class="option">-C</code> option was given, queries will be made for SOA
records, and if <em class="parameter"><code>name</code></em> is a
dotted-decimal IPv4
- address or colon-delimited IPv6 address, <span><strong class="command">host</strong></span> will
+ address or colon-delimited IPv6 address, <span class="command"><strong>host</strong></span> will
query for PTR records. If a query type of IXFR is chosen the starting
serial number can be specified by appending an equal followed by the
starting serial number (e.g. -t IXFR=12345678).
</p>
-<p>
+
+ <p>
The time to wait for a reply can be controlled through the
<code class="option">-W</code> and <code class="option">-w</code> options. The
- <code class="option">-W</code> option makes <span><strong class="command">host</strong></span>
+ <code class="option">-W</code> option makes <span class="command"><strong>host</strong></span>
wait for
<em class="parameter"><code>wait</code></em> seconds. If <em class="parameter"><code>wait</code></em>
is less than one, the wait interval is set to one second. When the
- <code class="option">-w</code> option is used, <span><strong class="command">host</strong></span>
+ <code class="option">-w</code> option is used, <span class="command"><strong>host</strong></span>
will
effectively wait forever for a reply. The time to wait for a response
will be set to the number of seconds given by the hardware's maximum
- value for an integer quantity. By default, <span><strong class="command">host</strong></span>
+ value for an integer quantity. By default, <span class="command"><strong>host</strong></span>
will wait for 5 seconds for UDP responses and 10 seconds for TCP
connections. These defaults can be overridden by the
<em class="parameter"><code>timeout</code></em> option in
<code class="filename">/etc/resolv.conf</code>.
</p>
-<p>
- The <code class="option">-s</code> option tells <span><strong class="command">host</strong></span>
+
+ <p>
+ The <code class="option">-s</code> option tells <span class="command"><strong>host</strong></span>
<span class="emphasis"><em>not</em></span> to send the query to the next nameserver
if any server responds with a SERVFAIL response, which is the
reverse of normal stub resolver behavior.
</p>
-<p>
+
+ <p>
The <code class="option">-m</code> can be used to set the memory usage debugging
flags
<em class="parameter"><code>record</code></em>, <em class="parameter"><code>usage</code></em> and
<em class="parameter"><code>trace</code></em>.
</p>
-<p>
- The <code class="option">-V</code> option causes <span><strong class="command">host</strong></span>
+
+ <p>
+ The <code class="option">-V</code> option causes <span class="command"><strong>host</strong></span>
to print the version number and exit.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543852"></a><h2>IDN SUPPORT</h2>
-<p>
- If <span><strong class="command">host</strong></span> has been built with IDN (internationalized
+ </div>
+
+ <div class="refsection" title="IDN SUPPORT">
+<a name="idp60873168"></a><h2>IDN SUPPORT</h2>
+
+ <p>
+ If <span class="command"><strong>host</strong></span> has been built with IDN (internationalized
domain name) support, it can accept and display non-ASCII domain names.
- <span><strong class="command">host</strong></span> appropriately converts character encoding of
+ <span class="command"><strong>host</strong></span> appropriately converts character encoding of
domain name before sending a request to DNS server or displaying a
reply from the server.
If you'd like to turn off the IDN support for some reason, defines
the <code class="envar">IDN_DISABLE</code> environment variable.
The IDN support is disabled if the variable is set when
- <span><strong class="command">host</strong></span> runs.
+ <span class="command"><strong>host</strong></span> runs.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543875"></a><h2>FILES</h2>
-<p><code class="filename">/etc/resolv.conf</code>
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp60876112"></a><h2>FILES</h2>
+
+ <p><code class="filename">/etc/resolv.conf</code>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543886"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dig</span>(1)</span>,
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>.
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60877776"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dig</span>(1)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>.
</p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: nslookup
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 24, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-01-24
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "NSLOOKUP" "1" "January 24, 2014" "BIND9" "BIND9"
+.TH "NSLOOKUP" "1" "2014\-01\-24" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
nslookup \- query Internet name servers interactively
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBNslookup\fR
-is a program to query Internet domain name servers.
+is a program to query Internet domain name servers\&.
\fBNslookup\fR
-has two modes: interactive and non\-interactive. Interactive mode allows the user to query name servers for information about various hosts and domains or to print a list of hosts in a domain. Non\-interactive mode is used to print just the name and requested information for a host or domain.
+has two modes: interactive and non\-interactive\&. Interactive mode allows the user to query name servers for information about various hosts and domains or to print a list of hosts in a domain\&. Non\-interactive mode is used to print just the name and requested information for a host or domain\&.
.SH "ARGUMENTS"
.PP
Interactive mode is entered in the following cases:
-.TP 4
-1.
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 1.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 1." 4.2
+.\}
when no arguments are given (the default name server will be used)
-.TP 4
-2.
-when the first argument is a hyphen (\-) and the second argument is the host name or Internet address of a name server.
+.RE
.sp
+.RS 4
+.ie n \{\
+\h'-04' 2.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 2." 4.2
+.\}
+when the first argument is a hyphen (\-) and the second argument is the host name or Internet address of a name server\&.
.RE
.PP
-Non\-interactive mode is used when the name or Internet address of the host to be looked up is given as the first argument. The optional second argument specifies the host name or address of a name server.
+Non\-interactive mode is used when the name or Internet address of the host to be looked up is given as the first argument\&. The optional second argument specifies the host name or address of a name server\&.
.PP
-Options can also be specified on the command line if they precede the arguments and are prefixed with a hyphen. For example, to change the default query type to host information, and the initial timeout to 10 seconds, type:
+Options can also be specified on the command line if they precede the arguments and are prefixed with a hyphen\&. For example, to change the default query type to host information, and the initial timeout to 10 seconds, type:
.sp
+.if n \{\
.RS 4
+.\}
.nf
nslookup \-query=hinfo \-timeout=10
.fi
+.if n \{\
.RE
+.\}
.sp
.PP
The
\fB\-version\fR
option causes
\fBnslookup\fR
-to print the version number and immediately exits.
+to print the version number and immediately exits\&.
.SH "INTERACTIVE COMMANDS"
.PP
\fBhost\fR [server]
.RS 4
-Look up information for host using the current default server or using server, if specified. If host is an Internet address and the query type is A or PTR, the name of the host is returned. If host is a name and does not have a trailing period, the search list is used to qualify the name.
+Look up information for host using the current default server or using server, if specified\&. If host is an Internet address and the query type is A or PTR, the name of the host is returned\&. If host is a name and does not have a trailing period, the search list is used to qualify the name\&.
.sp
-To look up a host not in the current domain, append a period to the name.
+To look up a host not in the current domain, append a period to the name\&.
.RE
.PP
\fBserver\fR \fIdomain\fR
uses the initial server to look up information about
\fIdomain\fR, while
\fBserver\fR
-uses the current default server. If an authoritative answer can't be found, the names of servers that might have the answer are returned.
+uses the current default server\&. If an authoritative answer can\*(Aqt be found, the names of servers that might have the answer are returned\&.
.RE
.PP
\fBroot\fR
.PP
\fBexit\fR
.RS 4
-Exits the program.
+Exits the program\&.
.RE
.PP
\fBset\fR \fIkeyword\fR\fI[=value]\fR
.RS 4
-This command is used to change state information that affects the lookups. Valid keywords are:
-.RS 4
+This command is used to change state information that affects the lookups\&. Valid keywords are:
.PP
\fBall\fR
.RS 4
Prints the current values of the frequently used options to
-\fBset\fR. Information about the current default server and host is also printed.
+\fBset\fR\&. Information about the current default server and host is also printed\&.
.RE
.PP
\fBclass=\fR\fIvalue\fR
.RS 4
Change the query class to one of:
-.RS 4
.PP
\fBIN\fR
.RS 4
.RS 4
wildcard
.RE
-.RE
-.IP "" 4
-The class specifies the protocol group of the information.
+.sp
+The class specifies the protocol group of the information\&.
.sp
(Default = IN; abbreviation = cl)
.RE
.PP
\fB \fR\fB\fI[no]\fR\fR\fBdebug\fR
.RS 4
-Turn on or off the display of the full response packet and any intermediate response packets when searching.
+Turn on or off the display of the full response packet and any intermediate response packets when searching\&.
.sp
(Default = nodebug; abbreviation =
[no]deb)
.PP
\fB \fR\fB\fI[no]\fR\fR\fBd2\fR
.RS 4
-Turn debugging mode on or off. This displays more about what nslookup is doing.
+Turn debugging mode on or off\&. This displays more about what nslookup is doing\&.
.sp
(Default = nod2)
.RE
\fBdomain=\fR\fIname\fR
.RS 4
Sets the search list to
-\fIname\fR.
+\fIname\fR\&.
.RE
.PP
\fB \fR\fB\fI[no]\fR\fR\fBsearch\fR
.RS 4
-If the lookup request contains at least one period but doesn't end with a trailing period, append the domain names in the domain search list to the request until an answer is received.
+If the lookup request contains at least one period but doesn\*(Aqt end with a trailing period, append the domain names in the domain search list to the request until an answer is received\&.
.sp
(Default = search)
.RE
\fBport=\fR\fIvalue\fR
.RS 4
Change the default TCP/UDP name server port to
-\fIvalue\fR.
+\fIvalue\fR\&.
.sp
(Default = 53; abbreviation = po)
.RE
.PP
\fBtype=\fR\fIvalue\fR
.RS 4
-Change the type of the information query.
+Change the type of the information query\&.
.sp
(Default = A; abbreviations = q, ty)
.RE
.PP
\fB \fR\fB\fI[no]\fR\fR\fBrecurse\fR
.RS 4
-Tell the name server to query other servers if it does not have the information.
+Tell the name server to query other servers if it does not have the information\&.
.sp
(Default = recurse; abbreviation = [no]rec)
.RE
.PP
\fBndots=\fR\fInumber\fR
.RS 4
-Set the number of dots (label separators) in a domain that will disable searching. Absolute names always stop searching.
+Set the number of dots (label separators) in a domain that will disable searching\&. Absolute names always stop searching\&.
.RE
.PP
\fBretry=\fR\fInumber\fR
.RS 4
-Set the number of retries to number.
+Set the number of retries to number\&.
.RE
.PP
\fBtimeout=\fR\fInumber\fR
.RS 4
-Change the initial timeout interval for waiting for a reply to number seconds.
+Change the initial timeout interval for waiting for a reply to number seconds\&.
.RE
.PP
\fB \fR\fB\fI[no]\fR\fR\fBvc\fR
.RS 4
-Always use a virtual circuit when sending requests to the server.
+Always use a virtual circuit when sending requests to the server\&.
.sp
(Default = novc)
.RE
.PP
\fB \fR\fB\fI[no]\fR\fR\fBfail\fR
.RS 4
-Try the next nameserver if a nameserver responds with SERVFAIL or a referral (nofail) or terminate query (fail) on such a response.
+Try the next nameserver if a nameserver responds with SERVFAIL or a referral (nofail) or terminate query (fail) on such a response\&.
.sp
(Default = nofail)
.RE
-.RE
-.IP "" 4
+.sp
.RE
.SH "FILES"
.PP
-\fI/etc/resolv.conf\fR
+/etc/resolv\&.conf
.SH "SEE ALSO"
.PP
\fBdig\fR(1),
\fBhost\fR(1),
-\fBnamed\fR(8).
+\fBnamed\fR(8)\&.
.SH "AUTHOR"
.PP
-Andrew Cherenson
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004\-2007, 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2004-2007, 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>nslookup</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476283"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="nslookup">
+<a name="idp60870864"></a><div class="titlepage"></div>
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>nslookup — query Internet name servers interactively</p>
+<p>
+ nslookup
+ — query Internet name servers interactively
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">nslookup</code> [<code class="option">-option</code>] [name | -] [server]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543442"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">Nslookup</strong></span>
- is a program to query Internet domain name servers. <span><strong class="command">Nslookup</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">nslookup</code>
+ [<code class="option">-option</code>]
+ [name | -]
+ [server]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60924112"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>Nslookup</strong></span>
+ is a program to query Internet domain name servers. <span class="command"><strong>Nslookup</strong></span>
has two modes: interactive and non-interactive. Interactive mode allows
the user to query name servers for information about various hosts and
domains or to print a list of hosts in a domain. Non-interactive mode
used to print just the name and requested information for a host or
domain.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543458"></a><h2>ARGUMENTS</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="ARGUMENTS">
+<a name="idp60938576"></a><h2>ARGUMENTS</h2>
+
+ <p>
Interactive mode is entered in the following cases:
</p>
-<div class="orderedlist"><ol type="a">
-<li><p>
+<div class="orderedlist"><ol class="orderedlist" type="a">
+<li class="listitem">
+ <p>
when no arguments are given (the default name server will be used)
- </p></li>
-<li><p>
+ </p>
+ </li>
+<li class="listitem">
+ <p>
when the first argument is a hyphen (-) and the second argument is
the host name or Internet address of a name server.
- </p></li>
+ </p>
+ </li>
</ol></div>
<p>
</p>
-<p>
+
+ <p>
Non-interactive mode is used when the name or Internet address of the
host to be looked up is given as the first argument. The optional second
argument specifies the host name or address of a name server.
</p>
-<p>
+
+ <p>
Options can also be specified on the command line if they precede the
arguments and are prefixed with a hyphen. For example, to
change the default query type to host information, and the initial
<p>
</p>
-<p>
+ <p>
The <code class="option">-version</code> option causes
- <span><strong class="command">nslookup</strong></span> to print the version
+ <span class="command"><strong>nslookup</strong></span> to print the version
number and immediately exits.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543512"></a><h2>INTERACTIVE COMMANDS</h2>
-<div class="variablelist"><dl>
+
+ </div>
+
+ <div class="refsection" title="INTERACTIVE COMMANDS">
+<a name="idp60945232"></a><h2>INTERACTIVE COMMANDS</h2>
+
+ <div class="variablelist"><dl>
<dt><span class="term"><code class="constant">host</code> [<span class="optional">server</span>]</span></dt>
<dd>
-<p>
+ <p>
Look up information for host using the current default server or
using server, if specified. If host is an Internet address and
the query type is A or PTR, the name of the host is returned.
If host is a name and does not have a trailing period, the
search list is used to qualify the name.
</p>
-<p>
+
+ <p>
To look up a host not in the current domain, append a period to
the name.
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">server</code> <em class="replaceable"><code>domain</code></em></span></dt>
-<dd><p></p></dd>
+<dd>
+ <p></p>
+ </dd>
<dt><span class="term"><code class="constant">lserver</code> <em class="replaceable"><code>domain</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Change the default server to <em class="replaceable"><code>domain</code></em>; <code class="constant">lserver</code> uses the initial
server to look up information about <em class="replaceable"><code>domain</code></em>, while <code class="constant">server</code> uses
the current default server. If an authoritative answer can't be
found, the names of servers that might have the answer are
returned.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">root</code></span></dt>
-<dd><p>
+<dd>
+ <p>
not implemented
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">finger</code></span></dt>
-<dd><p>
+<dd>
+ <p>
not implemented
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">ls</code></span></dt>
-<dd><p>
+<dd>
+ <p>
not implemented
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">view</code></span></dt>
-<dd><p>
+<dd>
+ <p>
not implemented
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">help</code></span></dt>
-<dd><p>
+<dd>
+ <p>
not implemented
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">?</code></span></dt>
-<dd><p>
+<dd>
+ <p>
not implemented
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">exit</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Exits the program.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">set</code>
<em class="replaceable"><code>keyword[<span class="optional">=value</span>]</code></em></span></dt>
<dd>
-<p>
+ <p>
This command is used to change state information that affects
the lookups. Valid keywords are:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">all</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Prints the current values of the frequently used
- options to <span><strong class="command">set</strong></span>.
+ options to <span class="command"><strong>set</strong></span>.
Information about the current default
server and host is also printed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">class=</code><em class="replaceable"><code>value</code></em></span></dt>
<dd>
-<p>
+ <p>
Change the query class to one of:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">IN</code></span></dt>
-<dd><p>
+<dd>
+ <p>
the Internet class
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">CH</code></span></dt>
-<dd><p>
+<dd>
+ <p>
the Chaos class
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">HS</code></span></dt>
-<dd><p>
+<dd>
+ <p>
the Hesiod class
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">ANY</code></span></dt>
-<dd><p>
+<dd>
+ <p>
wildcard
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
The class specifies the protocol group of the information.
</p>
-<p>
+ <p>
(Default = IN; abbreviation = cl)
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>debug</code></span></dt>
<dd>
-<p>
+ <p>
Turn on or off the display of the full response packet and
any intermediate response packets when searching.
</p>
-<p>
+ <p>
(Default = nodebug; abbreviation = [<span class="optional">no</span>]deb)
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>d2</code></span></dt>
<dd>
-<p>
+ <p>
Turn debugging mode on or off. This displays more about
what nslookup is doing.
</p>
-<p>
+ <p>
(Default = nod2)
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">domain=</code><em class="replaceable"><code>name</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the search list to <em class="replaceable"><code>name</code></em>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>search</code></span></dt>
<dd>
-<p>
+ <p>
If the lookup request contains at least one period but
doesn't end with a trailing period, append the domain
names in the domain search list to the request until an
answer is received.
</p>
-<p>
+ <p>
(Default = search)
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">port=</code><em class="replaceable"><code>value</code></em></span></dt>
<dd>
-<p>
+ <p>
Change the default TCP/UDP name server port to <em class="replaceable"><code>value</code></em>.
</p>
-<p>
+ <p>
(Default = 53; abbreviation = po)
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">querytype=</code><em class="replaceable"><code>value</code></em></span></dt>
-<dd><p></p></dd>
+<dd>
+ <p></p>
+ </dd>
<dt><span class="term"><code class="constant">type=</code><em class="replaceable"><code>value</code></em></span></dt>
<dd>
-<p>
+ <p>
Change the type of the information query.
</p>
-<p>
+ <p>
(Default = A; abbreviations = q, ty)
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>recurse</code></span></dt>
<dd>
-<p>
+ <p>
Tell the name server to query other servers if it does not
have the
information.
</p>
-<p>
+ <p>
(Default = recurse; abbreviation = [no]rec)
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">ndots=</code><em class="replaceable"><code>number</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the number of dots (label separators) in a domain
that will disable searching. Absolute names always
stop searching.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">retry=</code><em class="replaceable"><code>number</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the number of retries to number.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">timeout=</code><em class="replaceable"><code>number</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Change the initial timeout interval for waiting for a
reply to number seconds.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>vc</code></span></dt>
<dd>
-<p>
+ <p>
Always use a virtual circuit when sending requests to the
server.
</p>
-<p>
+ <p>
(Default = novc)
</p>
-</dd>
+ </dd>
<dt><span class="term"><code class="constant">
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>fail</code></span></dt>
<dd>
-<p>
+ <p>
Try the next nameserver if a nameserver responds with
SERVFAIL or a referral (nofail) or terminate query
(fail) on such a response.
</p>
-<p>
+ <p>
(Default = nofail)
</p>
-</dd>
+ </dd>
</dl></div>
<p>
</p>
-</dd>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2546326"></a><h2>FILES</h2>
-<p><code class="filename">/etc/resolv.conf</code>
- </p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2546338"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dig</span>(1)</span>,
- <span class="citerefentry"><span class="refentrytitle">host</span>(1)</span>,
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>.
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp61049168"></a><h2>FILES</h2>
+
+ <p><code class="filename">/etc/resolv.conf</code>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2546372"></a><h2>Author</h2>
-<p>
- Andrew Cherenson
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61050832"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dig</span>(1)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">host</span>(1)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-dsfromkey
+'\" t
+.\" Title: dnssec-dsfromkey
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: May 02, 2012
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2012-05-02
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-DSFROMKEY" "8" "May 02, 2012" "BIND9" "BIND9"
+.TH "DNSSEC\-DSFROMKEY" "8" "2012\-05\-02" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-dsfromkey \- DNSSEC DS RR generation tool
+dnssec-dsfromkey \- DNSSEC DS RR generation tool
.SH "SYNOPSIS"
.HP 17
\fBdnssec\-dsfromkey\fR [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-1\fR] [\fB\-2\fR] [\fB\-a\ \fR\fB\fIalg\fR\fR] [\fB\-C\fR] [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-T\ \fR\fB\fITTL\fR\fR] {keyfile}
.SH "DESCRIPTION"
.PP
\fBdnssec\-dsfromkey\fR
-outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s).
+outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s)\&.
.SH "OPTIONS"
.PP
\-1
.RS 4
-Use SHA\-1 as the digest algorithm (the default is to use both SHA\-1 and SHA\-256).
+Use SHA\-1 as the digest algorithm (the default is to use both SHA\-1 and SHA\-256)\&.
.RE
.PP
\-2
.RS 4
-Use SHA\-256 as the digest algorithm.
+Use SHA\-256 as the digest algorithm\&.
.RE
.PP
\-a \fIalgorithm\fR
.RS 4
-Select the digest algorithm. The value of
+Select the digest algorithm\&. The value of
\fBalgorithm\fR
-must be one of SHA\-1 (SHA1), SHA\-256 (SHA256), GOST or SHA\-384 (SHA384). These values are case insensitive.
+must be one of SHA\-1 (SHA1), SHA\-256 (SHA256), GOST or SHA\-384 (SHA384)\&. These values are case insensitive\&.
.RE
.PP
\-C
.RS 4
-Generate CDS records rather than DS records. This is mutually exclusive with generating lookaside records.
+Generate CDS records rather than DS records\&. This is mutually exclusive with generating lookaside records\&.
.RE
.PP
\-T \fITTL\fR
.RS 4
-Specifies the TTL of the DS records.
+Specifies the TTL of the DS records\&.
.RE
.PP
\-K \fIdirectory\fR
.RS 4
Look for key files (or, in keyset mode,
-\fIkeyset\-\fR
+keyset\-
files) in
-\fBdirectory\fR.
+\fBdirectory\fR\&.
.RE
.PP
\-f \fIfile\fR
.RS 4
Zone file mode: in place of the keyfile name, the argument is the DNS domain name of a zone master file, which can be read from
-\fBfile\fR. If the zone name is the same as
-\fBfile\fR, then it may be omitted.
+\fBfile\fR\&. If the zone name is the same as
+\fBfile\fR, then it may be omitted\&.
.sp
If
\fBfile\fR
is set to
-"\-", then the zone data is read from the standard input. This makes it possible to use the output of the
+"\-", then the zone data is read from the standard input\&. This makes it possible to use the output of the
\fBdig\fR
command as input, as in:
.sp
-\fBdig dnskey example.com | dnssec\-dsfromkey \-f \- example.com\fR
+\fBdig dnskey example\&.com | dnssec\-dsfromkey \-f \- example\&.com\fR
.RE
.PP
\-A
.RS 4
-Include ZSKs when generating DS records. Without this option, only keys which have the KSK flag set will be converted to DS records and printed. Useful only in zone file mode.
+Include ZSKs when generating DS records\&. Without this option, only keys which have the KSK flag set will be converted to DS records and printed\&. Useful only in zone file mode\&.
.RE
.PP
\-l \fIdomain\fR
.RS 4
-Generate a DLV set instead of a DS set. The specified
+Generate a DLV set instead of a DS set\&. The specified
\fBdomain\fR
-is appended to the name for each record in the set. The DNSSEC Lookaside Validation (DLV) RR is described in RFC 4431. This is mutually exclusive with generating CDS records.
+is appended to the name for each record in the set\&. The DNSSEC Lookaside Validation (DLV) RR is described in RFC 4431\&. This is mutually exclusive with generating CDS records\&.
.RE
.PP
\-s
.RS 4
-Keyset mode: in place of the keyfile name, the argument is the DNS domain name of a keyset file.
+Keyset mode: in place of the keyfile name, the argument is the DNS domain name of a keyset file\&.
.RE
.PP
\-c \fIclass\fR
.RS 4
-Specifies the DNS class (default is IN). Useful only in keyset or zone file mode.
+Specifies the DNS class (default is IN)\&. Useful only in keyset or zone file mode\&.
.RE
.PP
\-v \fIlevel\fR
.RS 4
-Sets the debugging level.
+Sets the debugging level\&.
.RE
.PP
\-h
.RS 4
-Prints usage information.
+Prints usage information\&.
.RE
.PP
\-V
.RS 4
-Prints version information.
+Prints version information\&.
.RE
.SH "EXAMPLE"
.PP
To build the SHA\-256 DS RR from the
-\fBKexample.com.+003+26160\fR
+\fBKexample\&.com\&.+003+26160\fR
keyfile name, the following command would be issued:
.PP
-\fBdnssec\-dsfromkey \-2 Kexample.com.+003+26160\fR
+\fBdnssec\-dsfromkey \-2 Kexample\&.com\&.+003+26160\fR
.PP
The command would print something like:
.PP
-\fBexample.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94\fR
+\fBexample\&.com\&. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94\fR
.SH "FILES"
.PP
The keyfile can be designed by the key identification
-\fIKnnnn.+aaa+iiiii\fR
+Knnnn\&.+aaa+iiiii
or the full file name
-\fIKnnnn.+aaa+iiiii.key\fR
+Knnnn\&.+aaa+iiiii\&.key
as generated by
-dnssec\-keygen(8).
+dnssec\-keygen(8)\&.
.PP
The keyset file name is built from the
\fBdirectory\fR, the string
-\fIkeyset\-\fR
+keyset\-
and the
-\fBdnsname\fR.
+\fBdnsname\fR\&.
.SH "CAVEAT"
.PP
-A keyfile error can give a "file not found" even if the file exists.
+A keyfile error can give a "file not found" even if the file exists\&.
.SH "SEE ALSO"
.PP
-\fBdnssec\-keygen\fR(8),
-\fBdnssec\-signzone\fR(8),
+\fBdnssec-keygen\fR(8),
+\fBdnssec-signzone\fR(8),
BIND 9 Administrator Reference Manual,
RFC 3658,
-RFC 4431.
-RFC 4509.
+RFC 4431\&.
+RFC 4509\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2008\-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-dsfromkey">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-dsfromkey</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-dsfromkey">
<a name="man.dnssec-dsfromkey"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-dsfromkey</span> — DNSSEC DS RR generation tool</p>
+<p>
+ <span class="application">dnssec-dsfromkey</span>
+ — DNSSEC DS RR generation tool
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code> [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-1</code>] [<code class="option">-2</code>] [<code class="option">-a <em class="replaceable"><code>alg</code></em></code>] [<code class="option">-C</code>] [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-T <em class="replaceable"><code>TTL</code></em></code>] {keyfile}</p></div>
-<div class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code> {-s} [<code class="option">-1</code>] [<code class="option">-2</code>] [<code class="option">-a <em class="replaceable"><code>alg</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-s</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-T <em class="replaceable"><code>TTL</code></em></code>] [<code class="option">-f <em class="replaceable"><code>file</code></em></code>] [<code class="option">-A</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] {dnsname}</p></div>
-<div class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code> [<code class="option">-h</code>] [<code class="option">-V</code>]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543522"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-dsfromkey</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-dsfromkey</code>
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-1</code>]
+ [<code class="option">-2</code>]
+ [<code class="option">-a <em class="replaceable"><code>alg</code></em></code>]
+ [<code class="option">-C</code>]
+ [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>]
+ [<code class="option">-T <em class="replaceable"><code>TTL</code></em></code>]
+ {keyfile}
+ </p></div>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-dsfromkey</code>
+ {-s}
+ [<code class="option">-1</code>]
+ [<code class="option">-2</code>]
+ [<code class="option">-a <em class="replaceable"><code>alg</code></em></code>]
+ [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>]
+ [<code class="option">-s</code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-T <em class="replaceable"><code>TTL</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>file</code></em></code>]
+ [<code class="option">-A</code>]
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ {dnsname}
+ </p></div>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-dsfromkey</code>
+ [<code class="option">-h</code>]
+ [<code class="option">-V</code>]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60945104"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-dsfromkey</strong></span>
outputs the Delegation Signer (DS) resource record (RR), as defined in
RFC 3658 and RFC 4509, for the given key(s).
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543533"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60946768"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-1</span></dt>
-<dd><p>
+<dd>
+ <p>
Use SHA-1 as the digest algorithm (the default is to use
both SHA-1 and SHA-256).
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-2</span></dt>
-<dd><p>
+<dd>
+ <p>
Use SHA-256 as the digest algorithm.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Select the digest algorithm. The value of
<code class="option">algorithm</code> must be one of SHA-1 (SHA1),
SHA-256 (SHA256), GOST or SHA-384 (SHA384).
These values are case insensitive.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-C</span></dt>
-<dd><p>
+<dd>
+ <p>
Generate CDS records rather than DS records. This is mutually
exclusive with generating lookaside records.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-T <em class="replaceable"><code>TTL</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the TTL of the DS records.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Look for key files (or, in keyset mode,
<code class="filename">keyset-</code> files) in
<code class="option">directory</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
<dd>
-<p>
+ <p>
Zone file mode: in place of the keyfile name, the argument is
the DNS domain name of a zone master file, which can be read
from <code class="option">file</code>. If the zone name is the same as
<code class="option">file</code>, then it may be omitted.
</p>
-<p>
+ <p>
If <code class="option">file</code> is set to <code class="literal">"-"</code>, then
the zone data is read from the standard input. This makes it
- possible to use the output of the <span><strong class="command">dig</strong></span>
+ possible to use the output of the <span class="command"><strong>dig</strong></span>
command as input, as in:
</p>
-<p>
+ <p>
<strong class="userinput"><code>dig dnskey example.com | dnssec-dsfromkey -f - example.com</code></strong>
</p>
-</dd>
+ </dd>
<dt><span class="term">-A</span></dt>
-<dd><p>
+<dd>
+ <p>
Include ZSKs when generating DS records. Without this option,
only keys which have the KSK flag set will be converted to DS
records and printed. Useful only in zone file mode.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Generate a DLV set instead of a DS set. The specified
<code class="option">domain</code> is appended to the name for each
record in the set.
The DNSSEC Lookaside Validation (DLV) RR is described
in RFC 4431. This is mutually exclusive with generating
CDS records.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-s</span></dt>
-<dd><p>
+<dd>
+ <p>
Keyset mode: in place of the keyfile name, the argument is
the DNS domain name of a keyset file.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the DNS class (default is IN). Useful only
in keyset or zone file mode.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the debugging level.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints usage information.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints version information.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543800"></a><h2>EXAMPLE</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="EXAMPLE">
+<a name="idp60969680"></a><h2>EXAMPLE</h2>
+
+ <p>
To build the SHA-256 DS RR from the
<strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
keyfile name, the following command would be issued:
</p>
-<p><strong class="userinput"><code>dnssec-dsfromkey -2 Kexample.com.+003+26160</code></strong>
+ <p><strong class="userinput"><code>dnssec-dsfromkey -2 Kexample.com.+003+26160</code></strong>
</p>
-<p>
+ <p>
The command would print something like:
</p>
-<p><strong class="userinput"><code>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</code></strong>
+ <p><strong class="userinput"><code>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</code></strong>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543830"></a><h2>FILES</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp60973136"></a><h2>FILES</h2>
+
+ <p>
The keyfile can be designed by the key identification
<code class="filename">Knnnn.+aaa+iiiii</code> or the full file name
<code class="filename">Knnnn.+aaa+iiiii.key</code> as generated by
<span class="refentrytitle">dnssec-keygen</span>(8).
</p>
-<p>
+ <p>
The keyset file name is built from the <code class="option">directory</code>,
the string <code class="filename">keyset-</code> and the
<code class="option">dnsname</code>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543865"></a><h2>CAVEAT</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="CAVEAT">
+<a name="idp60977488"></a><h2>CAVEAT</h2>
+
+ <p>
A keyfile error can give a "file not found" even if the file exists.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543875"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60983120"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-signzone</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 3658</em>,
<em class="citetitle">RFC 4431</em>.
<em class="citetitle">RFC 4509</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543914"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-importkey
+'\" t
+.\" Title: dnssec-importkey
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: February 20, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-02-20
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-IMPORTKEY" "8" "February 20, 2014" "BIND9" "BIND9"
+.TH "DNSSEC\-IMPORTKEY" "8" "2014\-02\-20" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-importkey \- Import DNSKEY records from external systems so they can be managed.
+dnssec-importkey \- Import DNSKEY records from external systems so they can be managed\&.
.SH "SYNOPSIS"
.HP 17
\fBdnssec\-importkey\fR [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-h\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] {\fBkeyfile\fR}
.SH "DESCRIPTION"
.PP
\fBdnssec\-importkey\fR
-reads a public DNSKEY record and generates a pair of .key/.private files. The DNSKEY record may be read from an existing .key file, in which case a corresponding .private file will be generated, or it may be read from any other file or from the standard input, in which case both .key and .private files will be generated.
+reads a public DNSKEY record and generates a pair of \&.key/\&.private files\&. The DNSKEY record may be read from an existing \&.key file, in which case a corresponding \&.private file will be generated, or it may be read from any other file or from the standard input, in which case both \&.key and \&.private files will be generated\&.
.PP
-The newly\-created .private file does
+The newly\-created \&.private file does
\fInot\fR
-contain private key data, and cannot be used for signing. However, having a .private file makes it possible to set publication (\fB\-P\fR) and deletion (\fB\-D\fR) times for the key, which means the public key can be added to and removed from the DNSKEY RRset on schedule even if the true private key is stored offline.
+contain private key data, and cannot be used for signing\&. However, having a \&.private file makes it possible to set publication (\fB\-P\fR) and deletion (\fB\-D\fR) times for the key, which means the public key can be added to and removed from the DNSKEY RRset on schedule even if the true private key is stored offline\&.
.SH "OPTIONS"
.PP
\-f \fIfilename\fR
.RS 4
Zone file mode: instead of a public keyfile name, the argument is the DNS domain name of a zone master file, which can be read from
-\fBfile\fR. If the domain name is the same as
-\fBfile\fR, then it may be omitted.
+\fBfile\fR\&. If the domain name is the same as
+\fBfile\fR, then it may be omitted\&.
.sp
If
\fBfile\fR
is set to
-"\-", then the zone data is read from the standard input.
+"\-", then the zone data is read from the standard input\&.
.RE
.PP
\-K \fIdirectory\fR
.RS 4
-Sets the directory in which the key files are to reside.
+Sets the directory in which the key files are to reside\&.
.RE
.PP
\-L \fIttl\fR
.RS 4
-Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. Setting the default TTL to
+Sets the default TTL to use for this key when it is converted into a DNSKEY RR\&. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence\&. Setting the default TTL to
0
or
none
-removes it.
+removes it\&.
.RE
.PP
\-h
.RS 4
-Emit usage message and exit.
+Emit usage message and exit\&.
.RE
.PP
\-v \fIlevel\fR
.RS 4
-Sets the debugging level.
+Sets the debugging level\&.
.RE
.PP
\-V
.RS 4
-Prints version information.
+Prints version information\&.
.RE
.SH "TIMING OPTIONS"
.PP
-Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.
+Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To explicitly prevent a date from being set, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&.
.PP
\-P \fIdate/offset\fR
.RS 4
-Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it.
+Sets the date on which a key is to be published to the zone\&. After that date, the key will be included in the zone but will not be used to sign it\&.
.RE
.PP
\-D \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.)
+Sets the date on which the key is to be deleted\&. After that date, the key will no longer be included in the zone\&. (It may remain in the key repository, however\&.)
.RE
.SH "FILES"
.PP
A keyfile can be designed by the key identification
-\fIKnnnn.+aaa+iiiii\fR
+Knnnn\&.+aaa+iiiii
or the full file name
-\fIKnnnn.+aaa+iiiii.key\fR
+Knnnn\&.+aaa+iiiii\&.key
as generated by
-dnssec\-keygen(8).
+dnssec\-keygen(8)\&.
.SH "SEE ALSO"
.PP
-\fBdnssec\-keygen\fR(8),
-\fBdnssec\-signzone\fR(8),
+\fBdnssec-keygen\fR(8),
+\fBdnssec-signzone\fR(8),
BIND 9 Administrator Reference Manual,
-RFC 5011.
+RFC 5011\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-importkey">
<info>
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-importkey</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-importkey">
<a name="man.dnssec-importkey"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-importkey</span> — Import DNSKEY records from external systems so they can be managed.</p>
+<p>
+ <span class="application">dnssec-importkey</span>
+ — Import DNSKEY records from external systems so they can be managed.
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-importkey</code> [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] {<code class="option">keyfile</code>}</p></div>
-<div class="cmdsynopsis"><p><code class="command">dnssec-importkey</code> {<code class="option">-f <em class="replaceable"><code>filename</code></em></code>} [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">dnsname</code>]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543475"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-importkey</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-importkey</code>
+ [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
+ [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-V</code>]
+ {<code class="option">keyfile</code>}
+ </p></div>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-importkey</code>
+ {<code class="option">-f <em class="replaceable"><code>filename</code></em></code>}
+ [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
+ [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-V</code>]
+ [<code class="option">dnsname</code>]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60951888"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-importkey</strong></span>
reads a public DNSKEY record and generates a pair of
.key/.private files. The DNSKEY record may be read from an
existing .key file, in which case a corresponding .private file
from the standard input, in which case both .key and .private
files will be generated.
</p>
-<p>
+ <p>
The newly-created .private file does <span class="emphasis"><em>not</em></span>
contain private key data, and cannot be used for signing.
However, having a .private file makes it possible to set
public key can be added to and removed from the DNSKEY RRset
on schedule even if the true private key is stored offline.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543500"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60955088"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-f <em class="replaceable"><code>filename</code></em></span></dt>
<dd>
-<p>
+ <p>
Zone file mode: instead of a public keyfile name, the argument
is the DNS domain name of a zone master file, which can be read
from <code class="option">file</code>. If the domain name is the same as
<code class="option">file</code>, then it may be omitted.
</p>
-<p>
+ <p>
If <code class="option">file</code> is set to <code class="literal">"-"</code>, then
the zone data is read from the standard input.
</p>
-</dd>
+ </dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the directory in which the key files are to reside.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the default TTL to use for this key when it is converted
into a DNSKEY RR. If the key is imported into a zone,
this is the TTL that will be used for it, unless there was
already a DNSKEY RRset in place, in which case the existing TTL
would take precedence. Setting the default TTL to
<code class="literal">0</code> or <code class="literal">none</code> removes it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Emit usage message and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the debugging level.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints version information.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543632"></a><h2>TIMING OPTIONS</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="TIMING OPTIONS">
+<a name="idp60982480"></a><h2>TIMING OPTIONS</h2>
+
+ <p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
If the argument begins with a '+' or '-', it is interpreted as
an offset from the present time. For convenience, if such an offset
is computed in seconds. To explicitly prevent a date from being
set, use 'none' or 'never'.
</p>
-<div class="variablelist"><dl>
+
+ <div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which a key is to be published to the zone.
After that date, the key will be included in the zone but will
not be used to sign it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be deleted. After that
date, the key will no longer be included in the zone. (It
may remain in the key repository, however.)
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543678"></a><h2>FILES</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp60988240"></a><h2>FILES</h2>
+
+ <p>
A keyfile can be designed by the key identification
<code class="filename">Knnnn.+aaa+iiiii</code> or the full file name
<code class="filename">Knnnn.+aaa+iiiii.key</code> as generated by
<span class="refentrytitle">dnssec-keygen</span>(8).
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543700"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60991056"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-signzone</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 5011</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543733"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-keyfromlabel
+'\" t
+.\" Title: dnssec-keyfromlabel
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: February 27, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-02-27
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-KEYFROMLABEL" "8" "February 27, 2014" "BIND9" "BIND9"
+.TH "DNSSEC\-KEYFROMLABEL" "8" "2014\-02\-27" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-keyfromlabel \- DNSSEC key generation tool
+dnssec-keyfromlabel \- DNSSEC key generation tool
.SH "SYNOPSIS"
.HP 20
\fBdnssec\-keyfromlabel\fR {\-l\ \fIlabel\fR} [\fB\-3\fR] [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\ \fR\fB\fIflag\fR\fR] [\fB\-G\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-k\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-p\ \fR\fB\fIprotocol\fR\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-S\ \fR\fB\fIkey\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-y\fR] {name}
.SH "DESCRIPTION"
.PP
\fBdnssec\-keyfromlabel\fR
-generates a key pair of files that referencing a key object stored in a cryptographic hardware service module (HSM). The private key file can be used for DNSSEC signing of zone data as if it were a conventional signing key created by
-\fBdnssec\-keygen\fR, but the key material is stored within the HSM, and the actual signing takes place there.
+generates a key pair of files that referencing a key object stored in a cryptographic hardware service module (HSM)\&. The private key file can be used for DNSSEC signing of zone data as if it were a conventional signing key created by
+\fBdnssec\-keygen\fR, but the key material is stored within the HSM, and the actual signing takes place there\&.
.PP
The
\fBname\fR
-of the key is specified on the command line. This must match the name of the zone for which the key is being generated.
+of the key is specified on the command line\&. This must match the name of the zone for which the key is being generated\&.
.SH "OPTIONS"
.PP
\-a \fIalgorithm\fR
.RS 4
-Selects the cryptographic algorithm. The value of
+Selects the cryptographic algorithm\&. The value of
\fBalgorithm\fR
-must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. These values are case insensitive.
+must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384\&. These values are case insensitive\&.
.sp
If no algorithm is specified, then RSASHA1 will be used by default, unless the
\fB\-3\fR
-option is specified, in which case NSEC3RSASHA1 will be used instead. (If
+option is specified, in which case NSEC3RSASHA1 will be used instead\&. (If
\fB\-3\fR
-is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)
+is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3\&.)
.sp
-Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended.
+Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended\&.
.sp
-Note 2: DH automatically sets the \-k flag.
+Note 2: DH automatically sets the \-k flag\&.
.RE
.PP
\-3
.RS 4
-Use an NSEC3\-capable algorithm to generate a DNSSEC key. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default.
+Use an NSEC3\-capable algorithm to generate a DNSSEC key\&. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default\&.
.RE
.PP
\-E \fIengine\fR
.RS 4
-Specifies the cryptographic hardware to use.
+Specifies the cryptographic hardware to use\&.
.sp
-When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11".
+When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&.
.RE
.PP
\-l \fIlabel\fR
.RS 4
-Specifies the label for a key pair in the crypto hardware.
+Specifies the label for a key pair in the crypto hardware\&.
.sp
When
BIND
-9 is built with OpenSSL\-based PKCS#11 support, the label is an arbitrary string that identifies a particular key. It may be preceded by an optional OpenSSL engine name, followed by a colon, as in "pkcs11:\fIkeylabel\fR".
+9 is built with OpenSSL\-based PKCS#11 support, the label is an arbitrary string that identifies a particular key\&. It may be preceded by an optional OpenSSL engine name, followed by a colon, as in "pkcs11:\fIkeylabel\fR"\&.
.sp
When
BIND
-9 is built with native PKCS#11 support, the label is a PKCS#11 URI string in the format "pkcs11:\fBkeyword\fR=\fIvalue\fR[;\fBkeyword\fR=\fIvalue\fR;...]" Keywords include "token", which identifies the HSM; "object", which identifies the key; and "pin\-source", which identifies a file from which the HSM's PIN code can be obtained. The label will be stored in the on\-disk "private" file.
+9 is built with native PKCS#11 support, the label is a PKCS#11 URI string in the format "pkcs11:\fBkeyword\fR=\fIvalue\fR[;\fBkeyword\fR=\fIvalue\fR;\&.\&.\&.]" Keywords include "token", which identifies the HSM; "object", which identifies the key; and "pin\-source", which identifies a file from which the HSM\*(Aqs PIN code can be obtained\&. The label will be stored in the on\-disk "private" file\&.
.sp
If the label contains a
\fBpin\-source\fR
-field, tools using the generated key files will be able to use the HSM for signing and other operations without any need for an operator to manually enter a PIN. Note: Making the HSM's PIN accessible in this manner may reduce the security advantage of using an HSM; be sure this is what you want to do before making use of this feature.
+field, tools using the generated key files will be able to use the HSM for signing and other operations without any need for an operator to manually enter a PIN\&. Note: Making the HSM\*(Aqs PIN accessible in this manner may reduce the security advantage of using an HSM; be sure this is what you want to do before making use of this feature\&.
.RE
.PP
\-n \fInametype\fR
.RS 4
-Specifies the owner type of the key. The value of
+Specifies the owner type of the key\&. The value of
\fBnametype\fR
-must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive.
+must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY)\&. These values are case insensitive\&.
.RE
.PP
\-C
.RS 4
-Compatibility mode: generates an old\-style key, without any metadata. By default,
+Compatibility mode: generates an old\-style key, without any metadata\&. By default,
\fBdnssec\-keyfromlabel\fR
-will include the key's creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc). Keys that include this data may be incompatible with older versions of BIND; the
+will include the key\*(Aqs creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc)\&. Keys that include this data may be incompatible with older versions of BIND; the
\fB\-C\fR
-option suppresses them.
+option suppresses them\&.
.RE
.PP
\-c \fIclass\fR
.RS 4
-Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used.
+Indicates that the DNS record containing the key should have the specified class\&. If not specified, class IN is used\&.
.RE
.PP
\-f \fIflag\fR
.RS 4
-Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE.
+Set the specified flag in the flag field of the KEY/DNSKEY record\&. The only recognized flags are KSK (Key Signing Key) and REVOKE\&.
.RE
.PP
\-G
.RS 4
-Generate a key, but do not publish it or sign with it. This option is incompatible with \-P and \-A.
+Generate a key, but do not publish it or sign with it\&. This option is incompatible with \-P and \-A\&.
.RE
.PP
\-h
.RS 4
Prints a short summary of the options and arguments to
-\fBdnssec\-keyfromlabel\fR.
+\fBdnssec\-keyfromlabel\fR\&.
.RE
.PP
\-K \fIdirectory\fR
.RS 4
-Sets the directory in which the key files are to be written.
+Sets the directory in which the key files are to be written\&.
.RE
.PP
\-k
.RS 4
-Generate KEY records rather than DNSKEY records.
+Generate KEY records rather than DNSKEY records\&.
.RE
.PP
\-L \fIttl\fR
.RS 4
-Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. Setting the default TTL to
+Sets the default TTL to use for this key when it is converted into a DNSKEY RR\&. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence\&. Setting the default TTL to
0
or
none
-removes it.
+removes it\&.
.RE
.PP
\-p \fIprotocol\fR
.RS 4
-Sets the protocol value for the key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors.
+Sets the protocol value for the key\&. The protocol is a number between 0 and 255\&. The default is 3 (DNSSEC)\&. Other possible values for this argument are listed in RFC 2535 and its successors\&.
.RE
.PP
\-S \fIkey\fR
.RS 4
-Generate a key as an explicit successor to an existing key. The name, algorithm, size, and type of the key will be set to match the predecessor. The activation date of the new key will be set to the inactivation date of the existing one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days.
+Generate a key as an explicit successor to an existing key\&. The name, algorithm, size, and type of the key will be set to match the predecessor\&. The activation date of the new key will be set to the inactivation date of the existing one\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&.
.RE
.PP
\-t \fItype\fR
.RS 4
-Indicates the use of the key.
+Indicates the use of the key\&.
\fBtype\fR
-must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data.
+must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF\&. The default is AUTHCONF\&. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data\&.
.RE
.PP
\-v \fIlevel\fR
.RS 4
-Sets the debugging level.
+Sets the debugging level\&.
.RE
.PP
\-V
.RS 4
-Prints version information.
+Prints version information\&.
.RE
.PP
\-y
.RS 4
-Allows DNSSEC key files to be generated even if the key ID would collide with that of an existing key, in the event of either key being revoked. (This is only safe to use if you are sure you won't be using RFC 5011 trust anchor maintenance with either of the keys involved.)
+Allows DNSSEC key files to be generated even if the key ID would collide with that of an existing key, in the event of either key being revoked\&. (This is only safe to use if you are sure you won\*(Aqt be using RFC 5011 trust anchor maintenance with either of the keys involved\&.)
.RE
.SH "TIMING OPTIONS"
.PP
-Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.
+Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To explicitly prevent a date from being set, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&.
.PP
\-P \fIdate/offset\fR
.RS 4
-Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. If not set, and if the \-G option has not been used, the default is "now".
+Sets the date on which a key is to be published to the zone\&. After that date, the key will be included in the zone but will not be used to sign it\&. If not set, and if the \-G option has not been used, the default is "now"\&.
.RE
.PP
\-A \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. If not set, and if the \-G option has not been used, the default is "now".
+Sets the date on which the key is to be activated\&. After that date, the key will be included in the zone and used to sign it\&. If not set, and if the \-G option has not been used, the default is "now"\&.
.RE
.PP
\-R \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it.
+Sets the date on which the key is to be revoked\&. After that date, the key will be flagged as revoked\&. It will be included in the zone and will be used to sign it\&.
.RE
.PP
\-I \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it.
+Sets the date on which the key is to be retired\&. After that date, the key will still be included in the zone, but it will not be used to sign it\&.
.RE
.PP
\-D \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.)
+Sets the date on which the key is to be deleted\&. After that date, the key will no longer be included in the zone\&. (It may remain in the key repository, however\&.)
.RE
.PP
\-i \fIinterval\fR
.RS 4
-Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the publication date isn't, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn't, then activation will be set to this much time after publication.
+Sets the prepublication interval for a key\&. If set, then the publication and activation dates must be separated by at least this much time\&. If the activation date is specified but the publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&.
.sp
-If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.
+If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero\&.
.sp
-As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.
+As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&.
.RE
.SH "GENERATED KEY FILES"
.PP
When
\fBdnssec\-keyfromlabel\fR
completes successfully, it prints a string of the form
-\fIKnnnn.+aaa+iiiii\fR
-to the standard output. This is an identification string for the key files it has generated.
-.TP 4
-\(bu
-\fInnnn\fR
-is the key name.
-.TP 4
-\(bu
-\fIaaa\fR
-is the numeric representation of the algorithm.
-.TP 4
-\(bu
-\fIiiiii\fR
-is the key identifier (or footprint).
+Knnnn\&.+aaa+iiiii
+to the standard output\&. This is an identification string for the key files it has generated\&.
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+nnnn
+is the key name\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+aaa
+is the numeric representation of the algorithm\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+iiiii
+is the key identifier (or footprint)\&.
+.RE
.PP
\fBdnssec\-keyfromlabel\fR
-creates two files, with names based on the printed string.
-\fIKnnnn.+aaa+iiiii.key\fR
+creates two files, with names based on the printed string\&.
+Knnnn\&.+aaa+iiiii\&.key
contains the public key, and
-\fIKnnnn.+aaa+iiiii.private\fR
-contains the private key.
+Knnnn\&.+aaa+iiiii\&.private
+contains the private key\&.
.PP
The
-\fI.key\fR
-file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).
+\&.key
+file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement)\&.
.PP
The
-\fI.private\fR
-file contains algorithm\-specific fields. For obvious security reasons, this file does not have general read permission.
+\&.private
+file contains algorithm\-specific fields\&. For obvious security reasons, this file does not have general read permission\&.
.SH "SEE ALSO"
.PP
-\fBdnssec\-keygen\fR(8),
-\fBdnssec\-signzone\fR(8),
+\fBdnssec-keygen\fR(8),
+\fBdnssec-signzone\fR(8),
BIND 9 Administrator Reference Manual,
RFC 4034,
-The PKCS#11 URI Scheme (draft\-pechanec\-pkcs11uri\-13).
+The PKCS#11 URI Scheme (draft\-pechanec\-pkcs11uri\-13)\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2008\-2012, 2014 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2008-2012, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-keyfromlabel">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-keyfromlabel</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-keyfromlabel">
<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
+<p>
+ <span class="application">dnssec-keyfromlabel</span>
+ — DNSSEC key generation tool
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-keyfromlabel</code> {-l <em class="replaceable"><code>label</code></em>} [<code class="option">-3</code>] [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-k</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-S <em class="replaceable"><code>key</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-y</code>] {name}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543539"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-keyfromlabel</code>
+ {-l <em class="replaceable"><code>label</code></em>}
+ [<code class="option">-3</code>]
+ [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>]
+ [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>]
+ [<code class="option">-G</code>]
+ [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>]
+ [<code class="option">-k</code>]
+ [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
+ [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>]
+ [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>]
+ [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-S <em class="replaceable"><code>key</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>type</code></em></code>]
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-V</code>]
+ [<code class="option">-y</code>]
+ {name}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60985680"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-keyfromlabel</strong></span>
generates a key pair of files that referencing a key object stored
in a cryptographic hardware service module (HSM). The private key
file can be used for DNSSEC signing of zone data as if it were a
- conventional signing key created by <span><strong class="command">dnssec-keygen</strong></span>,
+ conventional signing key created by <span class="command"><strong>dnssec-keygen</strong></span>,
but the key material is stored within the HSM, and the actual signing
takes place there.
</p>
-<p>
+ <p>
The <code class="option">name</code> of the key is specified on the command
line. This must match the name of the zone for which the key is
being generated.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543560"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60988624"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
<dd>
-<p>
+ <p>
Selects the cryptographic algorithm. The value of
<code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
ECDSAP256SHA256 or ECDSAP384SHA384.
These values are case insensitive.
</p>
-<p>
+ <p>
If no algorithm is specified, then RSASHA1 will be used by
default, unless the <code class="option">-3</code> option is specified,
in which case NSEC3RSASHA1 will be used instead. (If
<code class="option">-3</code> is used and an algorithm is specified,
that algorithm will be checked for compatibility with NSEC3.)
</p>
-<p>
+ <p>
Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
algorithm, and DSA is recommended.
</p>
-<p>
+ <p>
Note 2: DH automatically sets the -k flag.
</p>
-</dd>
+ </dd>
<dt><span class="term">-3</span></dt>
-<dd><p>
+<dd>
+ <p>
Use an NSEC3-capable algorithm to generate a DNSSEC key.
If this option is used and no algorithm is explicitly
set on the command line, NSEC3RSASHA1 will be used by
default.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
<dd>
-<p>
+ <p>
Specifies the cryptographic hardware to use.
</p>
-<p>
+ <p>
When BIND is built with OpenSSL PKCS#11 support, this defaults
to the string "pkcs11", which identifies an OpenSSL engine
that can drive a cryptographic accelerator or hardware service
(--enable-native-pkcs11), it defaults to the path of the PKCS#11
provider library specified via "--with-pkcs11".
</p>
-</dd>
+ </dd>
<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
<dd>
-<p>
+ <p>
Specifies the label for a key pair in the crypto hardware.
</p>
-<p>
+ <p>
When <acronym class="acronym">BIND</acronym> 9 is built with OpenSSL-based
PKCS#11 support, the label is an arbitrary string that
identifies a particular key. It may be preceded by an
optional OpenSSL engine name, followed by a colon, as in
"pkcs11:<em class="replaceable"><code>keylabel</code></em>".
</p>
-<p>
+ <p>
When <acronym class="acronym">BIND</acronym> 9 is built with native PKCS#11
support, the label is a PKCS#11 URI string in the format
"pkcs11:<code class="option">keyword</code>=<em class="replaceable"><code>value</code></em>[<span class="optional">;<code class="option">keyword</code>=<em class="replaceable"><code>value</code></em>;...</span>]"
which the HSM's PIN code can be obtained. The label will be
stored in the on-disk "private" file.
</p>
-<p>
+ <p>
If the label contains a
<code class="option">pin-source</code> field, tools using the generated
key files will be able to use the HSM for signing and other
may reduce the security advantage of using an HSM; be sure
this is what you want to do before making use of this feature.
</p>
-</dd>
+ </dd>
<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the owner type of the key. The value of
<code class="option">nametype</code> must either be ZONE (for a DNSSEC
zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
a host (KEY)),
USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
These values are case insensitive.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-C</span></dt>
-<dd><p>
+<dd>
+ <p>
Compatibility mode: generates an old-style key, without
- any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
+ any metadata. By default, <span class="command"><strong>dnssec-keyfromlabel</strong></span>
will include the key's creation date in the metadata stored
with the private key, and other dates may be set there as well
(publication date, activation date, etc). Keys that include
this data may be incompatible with older versions of BIND; the
<code class="option">-C</code> option suppresses them.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Indicates that the DNS record containing the key should have
the specified class. If not specified, class IN is used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the specified flag in the flag field of the KEY/DNSKEY record.
The only recognized flags are KSK (Key Signing Key) and REVOKE.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-G</span></dt>
-<dd><p>
+<dd>
+ <p>
Generate a key, but do not publish it or sign with it. This
option is incompatible with -P and -A.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints a short summary of the options and arguments to
- <span><strong class="command">dnssec-keyfromlabel</strong></span>.
- </p></dd>
+ <span class="command"><strong>dnssec-keyfromlabel</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the directory in which the key files are to be written.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-k</span></dt>
-<dd><p>
+<dd>
+ <p>
Generate KEY records rather than DNSKEY records.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the default TTL to use for this key when it is converted
into a DNSKEY RR. If the key is imported into a zone,
this is the TTL that will be used for it, unless there was
already a DNSKEY RRset in place, in which case the existing TTL
would take precedence. Setting the default TTL to
<code class="literal">0</code> or <code class="literal">none</code> removes it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the protocol value for the key. The protocol
is a number between 0 and 255. The default is 3 (DNSSEC).
Other possible values for this argument are listed in
RFC 2535 and its successors.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Generate a key as an explicit successor to an existing key.
The name, algorithm, size, and type of the key will be set
to match the predecessor. The activation date of the new
one. The publication date will be set to the activation
date minus the prepublication interval, which defaults to
30 days.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Indicates the use of the key. <code class="option">type</code> must be
one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
is AUTHCONF. AUTH refers to the ability to authenticate
data, and CONF the ability to encrypt data.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the debugging level.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints version information.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-y</span></dt>
-<dd><p>
+<dd>
+ <p>
Allows DNSSEC key files to be generated even if the key ID
would collide with that of an existing key, in the event of
either key being revoked. (This is only safe to use if you
are sure you won't be using RFC 5011 trust anchor maintenance
with either of the keys involved.)
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544020"></a><h2>TIMING OPTIONS</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="TIMING OPTIONS">
+<a name="idp61038672"></a><h2>TIMING OPTIONS</h2>
+
+
+ <p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
If the argument begins with a '+' or '-', it is interpreted as
an offset from the present time. For convenience, if such an offset
is computed in seconds. To explicitly prevent a date from being
set, use 'none' or 'never'.
</p>
-<div class="variablelist"><dl>
+
+ <div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which a key is to be published to the zone.
After that date, the key will be included in the zone but will
not be used to sign it. If not set, and if the -G option has
not been used, the default is "now".
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be activated. After that
date, the key will be included in the zone and used to sign
it. If not set, and if the -G option has not been used, the
default is "now".
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be revoked. After that
date, the key will be flagged as revoked. It will be included
in the zone and will be used to sign it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be retired. After that
date, the key will still be included in the zone, but it
will not be used to sign it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be deleted. After that
date, the key will no longer be included in the zone. (It
may remain in the key repository, however.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
<dd>
-<p>
+ <p>
Sets the prepublication interval for a key. If set, then
the publication and activation dates must be separated by at least
this much time. If the activation date is specified but the
the publication date is specified but activation date isn't,
then activation will be set to this much time after publication.
</p>
-<p>
+ <p>
If the key is being created as an explicit successor to another
key, then the default prepublication interval is 30 days;
otherwise it is zero.
</p>
-<p>
+ <p>
As with date offsets, if the argument is followed by one of
the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
interval is measured in years, months, weeks, days, hours,
or minutes, respectively. Without a suffix, the interval is
measured in seconds.
</p>
-</dd>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544278"></a><h2>GENERATED KEY FILES</h2>
-<p>
- When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
+ </div>
+
+ <div class="refsection" title="GENERATED KEY FILES">
+<a name="idp61093968"></a><h2>GENERATED KEY FILES</h2>
+
+ <p>
+ When <span class="command"><strong>dnssec-keyfromlabel</strong></span> completes
successfully,
it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
to the standard output. This is an identification string for
the key files it has generated.
</p>
-<div class="itemizedlist"><ul type="disc">
-<li><p><code class="filename">nnnn</code> is the key name.
- </p></li>
-<li><p><code class="filename">aaa</code> is the numeric representation
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <p><code class="filename">nnnn</code> is the key name.
+ </p>
+ </li>
+<li class="listitem">
+ <p><code class="filename">aaa</code> is the numeric representation
of the algorithm.
- </p></li>
-<li><p><code class="filename">iiiii</code> is the key identifier (or
+ </p>
+ </li>
+<li class="listitem">
+ <p><code class="filename">iiiii</code> is the key identifier (or
footprint).
- </p></li>
+ </p>
+ </li>
</ul></div>
-<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
+ <p><span class="command"><strong>dnssec-keyfromlabel</strong></span>
creates two files, with names based
on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
contains the public key, and
<code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
private key.
</p>
-<p>
+ <p>
The <code class="filename">.key</code> file contains a DNS KEY record
that
can be inserted into a zone file (directly or with a $INCLUDE
statement).
</p>
-<p>
+ <p>
The <code class="filename">.private</code> file contains
algorithm-specific
fields. For obvious security reasons, this file does not have
general read permission.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544350"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61106768"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-signzone</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 4034</em>,
<em class="citetitle">The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13)</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544388"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-keygen
+'\" t
+.\" Title: dnssec-keygen
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: February 06, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-02-06
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-KEYGEN" "8" "February 06, 2014" "BIND9" "BIND9"
+.TH "DNSSEC\-KEYGEN" "8" "2014\-02\-06" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-keygen \- DNSSEC key generation tool
+dnssec-keygen \- DNSSEC key generation tool
.SH "SYNOPSIS"
.HP 14
\fBdnssec\-keygen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-3\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-C\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\ \fR\fB\fIflag\fR\fR] [\fB\-G\fR] [\fB\-g\ \fR\fB\fIgenerator\fR\fR] [\fB\-h\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-k\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-p\ \fR\fB\fIprotocol\fR\fR] [\fB\-q\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] [\fB\-S\ \fR\fB\fIkey\fR\fR] [\fB\-s\ \fR\fB\fIstrength\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-z\fR] {name}
.SH "DESCRIPTION"
.PP
\fBdnssec\-keygen\fR
-generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034. It can also generate keys for use with TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY (Transaction Key) as defined in RFC 2930.
+generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034\&. It can also generate keys for use with TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY (Transaction Key) as defined in RFC 2930\&.
.PP
The
\fBname\fR
-of the key is specified on the command line. For DNSSEC keys, this must match the name of the zone for which the key is being generated.
+of the key is specified on the command line\&. For DNSSEC keys, this must match the name of the zone for which the key is being generated\&.
.SH "OPTIONS"
.PP
\-a \fIalgorithm\fR
.RS 4
-Selects the cryptographic algorithm. For DNSSEC keys, the value of
+Selects the cryptographic algorithm\&. For DNSSEC keys, the value of
\fBalgorithm\fR
-must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. For TSIG/TKEY, the value must be DH (Diffie Hellman), HMAC\-MD5, HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256, HMAC\-SHA384, or HMAC\-SHA512. These values are case insensitive.
+must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384\&. For TSIG/TKEY, the value must be DH (Diffie Hellman), HMAC\-MD5, HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256, HMAC\-SHA384, or HMAC\-SHA512\&. These values are case insensitive\&.
.sp
If no algorithm is specified, then RSASHA1 will be used by default, unless the
\fB\-3\fR
-option is specified, in which case NSEC3RSASHA1 will be used instead. (If
+option is specified, in which case NSEC3RSASHA1 will be used instead\&. (If
\fB\-3\fR
-is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)
+is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3\&.)
.sp
-Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended. For TSIG, HMAC\-MD5 is mandatory.
+Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended\&. For TSIG, HMAC\-MD5 is mandatory\&.
.sp
-Note 2: DH, HMAC\-MD5, and HMAC\-SHA1 through HMAC\-SHA512 automatically set the \-T KEY option.
+Note 2: DH, HMAC\-MD5, and HMAC\-SHA1 through HMAC\-SHA512 automatically set the \-T KEY option\&.
.RE
.PP
\-b \fIkeysize\fR
.RS 4
-Specifies the number of bits in the key. The choice of key size depends on the algorithm used. RSA keys must be between 512 and 2048 bits. Diffie Hellman keys must be between 128 and 4096 bits. DSA keys must be between 512 and 1024 bits and an exact multiple of 64. HMAC keys must be between 1 and 512 bits. Elliptic curve algorithms don't need this parameter.
+Specifies the number of bits in the key\&. The choice of key size depends on the algorithm used\&. RSA keys must be between 512 and 2048 bits\&. Diffie Hellman keys must be between 128 and 4096 bits\&. DSA keys must be between 512 and 1024 bits and an exact multiple of 64\&. HMAC keys must be between 1 and 512 bits\&. Elliptic curve algorithms don\*(Aqt need this parameter\&.
.sp
-The key size does not need to be specified if using a default algorithm. The default key size is 1024 bits for zone signing keys (ZSKs) and 2048 bits for key signing keys (KSKs, generated with
-\fB\-f KSK\fR). However, if an algorithm is explicitly specified with the
+The key size does not need to be specified if using a default algorithm\&. The default key size is 1024 bits for zone signing keys (ZSKs) and 2048 bits for key signing keys (KSKs, generated with
+\fB\-f KSK\fR)\&. However, if an algorithm is explicitly specified with the
\fB\-a\fR, then there is no default key size, and the
\fB\-b\fR
-must be used.
+must be used\&.
.RE
.PP
\-n \fInametype\fR
.RS 4
-Specifies the owner type of the key. The value of
+Specifies the owner type of the key\&. The value of
\fBnametype\fR
-must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive. Defaults to ZONE for DNSKEY generation.
+must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY)\&. These values are case insensitive\&. Defaults to ZONE for DNSKEY generation\&.
.RE
.PP
\-3
.RS 4
-Use an NSEC3\-capable algorithm to generate a DNSSEC key. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default. Note that RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 and ECDSAP384SHA384 algorithms are NSEC3\-capable.
+Use an NSEC3\-capable algorithm to generate a DNSSEC key\&. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default\&. Note that RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 and ECDSAP384SHA384 algorithms are NSEC3\-capable\&.
.RE
.PP
\-C
.RS 4
-Compatibility mode: generates an old\-style key, without any metadata. By default,
+Compatibility mode: generates an old\-style key, without any metadata\&. By default,
\fBdnssec\-keygen\fR
-will include the key's creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc). Keys that include this data may be incompatible with older versions of BIND; the
+will include the key\*(Aqs creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc)\&. Keys that include this data may be incompatible with older versions of BIND; the
\fB\-C\fR
-option suppresses them.
+option suppresses them\&.
.RE
.PP
\-c \fIclass\fR
.RS 4
-Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used.
+Indicates that the DNS record containing the key should have the specified class\&. If not specified, class IN is used\&.
.RE
.PP
\-E \fIengine\fR
.RS 4
-Specifies the cryptographic hardware to use, when applicable.
+Specifies the cryptographic hardware to use, when applicable\&.
.sp
-When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11".
+When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&.
.RE
.PP
\-f \fIflag\fR
.RS 4
-Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE.
+Set the specified flag in the flag field of the KEY/DNSKEY record\&. The only recognized flags are KSK (Key Signing Key) and REVOKE\&.
.RE
.PP
\-G
.RS 4
-Generate a key, but do not publish it or sign with it. This option is incompatible with \-P and \-A.
+Generate a key, but do not publish it or sign with it\&. This option is incompatible with \-P and \-A\&.
.RE
.PP
\-g \fIgenerator\fR
.RS 4
-If generating a Diffie Hellman key, use this generator. Allowed values are 2 and 5. If no generator is specified, a known prime from RFC 2539 will be used if possible; otherwise the default is 2.
+If generating a Diffie Hellman key, use this generator\&. Allowed values are 2 and 5\&. If no generator is specified, a known prime from RFC 2539 will be used if possible; otherwise the default is 2\&.
.RE
.PP
\-h
.RS 4
Prints a short summary of the options and arguments to
-\fBdnssec\-keygen\fR.
+\fBdnssec\-keygen\fR\&.
.RE
.PP
\-K \fIdirectory\fR
.RS 4
-Sets the directory in which the key files are to be written.
+Sets the directory in which the key files are to be written\&.
.RE
.PP
\-k
.RS 4
-Deprecated in favor of \-T KEY.
+Deprecated in favor of \-T KEY\&.
.RE
.PP
\-L \fIttl\fR
.RS 4
-Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to
+Sets the default TTL to use for this key when it is converted into a DNSKEY RR\&. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence\&. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL\&. Setting the default TTL to
0
or
none
-is the same as leaving it unset.
+is the same as leaving it unset\&.
.RE
.PP
\-p \fIprotocol\fR
.RS 4
-Sets the protocol value for the generated key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors.
+Sets the protocol value for the generated key\&. The protocol is a number between 0 and 255\&. The default is 3 (DNSSEC)\&. Other possible values for this argument are listed in RFC 2535 and its successors\&.
.RE
.PP
\-q
.RS 4
-Quiet mode: Suppresses unnecessary output, including progress indication. Without this option, when
+Quiet mode: Suppresses unnecessary output, including progress indication\&. Without this option, when
\fBdnssec\-keygen\fR
is run interactively to generate an RSA or DSA key pair, it will print a string of symbols to
-\fIstderr\fR
-indicating the progress of the key generation. A '.' indicates that a random number has been found which passed an initial sieve test; '+' means a number has passed a single round of the Miller\-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key.
+stderr
+indicating the progress of the key generation\&. A \*(Aq\&.\*(Aq indicates that a random number has been found which passed an initial sieve test; \*(Aq+\*(Aq means a number has passed a single round of the Miller\-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key\&.
.RE
.PP
\-r \fIrandomdev\fR
.RS 4
-Specifies the source of randomness. If the operating system does not provide a
-\fI/dev/random\fR
-or equivalent device, the default source of randomness is keyboard input.
-\fIrandomdev\fR
-specifies the name of a character device or file containing random data to be used instead of the default. The special value
-\fIkeyboard\fR
-indicates that keyboard input should be used.
+Specifies the source of randomness\&. If the operating system does not provide a
+/dev/random
+or equivalent device, the default source of randomness is keyboard input\&.
+randomdev
+specifies the name of a character device or file containing random data to be used instead of the default\&. The special value
+keyboard
+indicates that keyboard input should be used\&.
.RE
.PP
\-S \fIkey\fR
.RS 4
-Create a new key which is an explicit successor to an existing key. The name, algorithm, size, and type of the key will be set to match the existing key. The activation date of the new key will be set to the inactivation date of the existing one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days.
+Create a new key which is an explicit successor to an existing key\&. The name, algorithm, size, and type of the key will be set to match the existing key\&. The activation date of the new key will be set to the inactivation date of the existing one\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&.
.RE
.PP
\-s \fIstrength\fR
.RS 4
-Specifies the strength value of the key. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC.
+Specifies the strength value of the key\&. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC\&.
.RE
.PP
\-T \fIrrtype\fR
.RS 4
-Specifies the resource record type to use for the key.
+Specifies the resource record type to use for the key\&.
\fBrrtype\fR
-must be either DNSKEY or KEY. The default is DNSKEY when using a DNSSEC algorithm, but it can be overridden to KEY for use with SIG(0).
-Using any TSIG algorithm (HMAC\-* or DH) forces this option to KEY.
+must be either DNSKEY or KEY\&. The default is DNSKEY when using a DNSSEC algorithm, but it can be overridden to KEY for use with SIG(0)\&.
+Using any TSIG algorithm (HMAC\-* or DH) forces this option to KEY\&.
.RE
.PP
\-t \fItype\fR
.RS 4
-Indicates the use of the key.
+Indicates the use of the key\&.
\fBtype\fR
-must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data.
+must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF\&. The default is AUTHCONF\&. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data\&.
.RE
.PP
\-v \fIlevel\fR
.RS 4
-Sets the debugging level.
+Sets the debugging level\&.
.RE
.PP
\-V
.RS 4
-Prints version information.
+Prints version information\&.
.RE
.SH "TIMING OPTIONS"
.PP
-Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.
+Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To explicitly prevent a date from being set, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&.
.PP
\-P \fIdate/offset\fR
.RS 4
-Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. If not set, and if the \-G option has not been used, the default is "now".
+Sets the date on which a key is to be published to the zone\&. After that date, the key will be included in the zone but will not be used to sign it\&. If not set, and if the \-G option has not been used, the default is "now"\&.
.RE
.PP
\-A \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. If not set, and if the \-G option has not been used, the default is "now". If set, if and \-P is not set, then the publication date will be set to the activation date minus the prepublication interval.
+Sets the date on which the key is to be activated\&. After that date, the key will be included in the zone and used to sign it\&. If not set, and if the \-G option has not been used, the default is "now"\&. If set, if and \-P is not set, then the publication date will be set to the activation date minus the prepublication interval\&.
.RE
.PP
\-R \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it.
+Sets the date on which the key is to be revoked\&. After that date, the key will be flagged as revoked\&. It will be included in the zone and will be used to sign it\&.
.RE
.PP
\-I \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it.
+Sets the date on which the key is to be retired\&. After that date, the key will still be included in the zone, but it will not be used to sign it\&.
.RE
.PP
\-D \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.)
+Sets the date on which the key is to be deleted\&. After that date, the key will no longer be included in the zone\&. (It may remain in the key repository, however\&.)
.RE
.PP
\-i \fIinterval\fR
.RS 4
-Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the publication date isn't, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn't, then activation will be set to this much time after publication.
+Sets the prepublication interval for a key\&. If set, then the publication and activation dates must be separated by at least this much time\&. If the activation date is specified but the publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&.
.sp
-If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.
+If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero\&.
.sp
-As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.
+As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&.
.RE
.SH "GENERATED KEYS"
.PP
When
\fBdnssec\-keygen\fR
completes successfully, it prints a string of the form
-\fIKnnnn.+aaa+iiiii\fR
-to the standard output. This is an identification string for the key it has generated.
-.TP 4
-\(bu
-\fInnnn\fR
-is the key name.
-.TP 4
-\(bu
-\fIaaa\fR
-is the numeric representation of the algorithm.
-.TP 4
-\(bu
-\fIiiiii\fR
-is the key identifier (or footprint).
+Knnnn\&.+aaa+iiiii
+to the standard output\&. This is an identification string for the key it has generated\&.
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+nnnn
+is the key name\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+aaa
+is the numeric representation of the algorithm\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+iiiii
+is the key identifier (or footprint)\&.
+.RE
.PP
\fBdnssec\-keygen\fR
-creates two files, with names based on the printed string.
-\fIKnnnn.+aaa+iiiii.key\fR
+creates two files, with names based on the printed string\&.
+Knnnn\&.+aaa+iiiii\&.key
contains the public key, and
-\fIKnnnn.+aaa+iiiii.private\fR
-contains the private key.
+Knnnn\&.+aaa+iiiii\&.private
+contains the private key\&.
.PP
The
-\fI.key\fR
-file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).
+\&.key
+file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement)\&.
.PP
The
-\fI.private\fR
-file contains algorithm\-specific fields. For obvious security reasons, this file does not have general read permission.
+\&.private
+file contains algorithm\-specific fields\&. For obvious security reasons, this file does not have general read permission\&.
.PP
Both
-\fI.key\fR
+\&.key
and
-\fI.private\fR
-files are generated for symmetric encryption algorithms such as HMAC\-MD5, even though the public and private key are equivalent.
+\&.private
+files are generated for symmetric encryption algorithms such as HMAC\-MD5, even though the public and private key are equivalent\&.
.SH "EXAMPLE"
.PP
To generate a 768\-bit DSA key for the domain
-\fBexample.com\fR, the following command would be issued:
+\fBexample\&.com\fR, the following command would be issued:
.PP
-\fBdnssec\-keygen \-a DSA \-b 768 \-n ZONE example.com\fR
+\fBdnssec\-keygen \-a DSA \-b 768 \-n ZONE example\&.com\fR
.PP
The command would print a string of the form:
.PP
-\fBKexample.com.+003+26160\fR
+\fBKexample\&.com\&.+003+26160\fR
.PP
In this example,
\fBdnssec\-keygen\fR
creates the files
-\fIKexample.com.+003+26160.key\fR
+Kexample\&.com\&.+003+26160\&.key
and
-\fIKexample.com.+003+26160.private\fR.
+Kexample\&.com\&.+003+26160\&.private\&.
.SH "SEE ALSO"
.PP
-\fBdnssec\-signzone\fR(8),
+\fBdnssec-signzone\fR(8),
BIND 9 Administrator Reference Manual,
RFC 2539,
RFC 2845,
-RFC 4034.
+RFC 4034\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004, 2005, 2007\-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
.br
-Copyright \(co 2000\-2003 Internet Software Consortium.
+Copyright \(co 2004, 2005, 2007-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2000-2003 Internet Software Consortium.
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-keygen">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-keygen</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-keygen">
<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-keygen</span> — DNSSEC key generation tool</p>
+<p>
+ <span class="application">dnssec-keygen</span>
+ — DNSSEC key generation tool
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-keygen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-3</code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-C</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-k</code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-q</code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S <em class="replaceable"><code>key</code></em></code>] [<code class="option">-s <em class="replaceable"><code>strength</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-z</code>] {name}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543608"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-keygen</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-keygen</code>
+ [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>]
+ [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>]
+ [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>]
+ [<code class="option">-3</code>]
+ [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-C</code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>]
+ [<code class="option">-G</code>]
+ [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>]
+ [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
+ [<code class="option">-k</code>]
+ [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>]
+ [<code class="option">-q</code>]
+ [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>]
+ [<code class="option">-S <em class="replaceable"><code>key</code></em></code>]
+ [<code class="option">-s <em class="replaceable"><code>strength</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>type</code></em></code>]
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-V</code>]
+ [<code class="option">-z</code>]
+ {name}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61001552"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-keygen</strong></span>
generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
and RFC 4034. It can also generate keys for use with
TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
(Transaction Key) as defined in RFC 2930.
</p>
-<p>
+ <p>
The <code class="option">name</code> of the key is specified on the command
line. For DNSSEC keys, this must match the name of the zone for
which the key is being generated.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543626"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61016400"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
<dd>
-<p>
+ <p>
Selects the cryptographic algorithm. For DNSSEC keys, the value
of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
case insensitive.
</p>
-<p>
+ <p>
If no algorithm is specified, then RSASHA1 will be used by
default, unless the <code class="option">-3</code> option is specified,
in which case NSEC3RSASHA1 will be used instead. (If
<code class="option">-3</code> is used and an algorithm is specified,
that algorithm will be checked for compatibility with NSEC3.)
</p>
-<p>
+ <p>
Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
mandatory.
</p>
-<p>
+ <p>
Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
automatically set the -T KEY option.
</p>
-</dd>
+ </dd>
<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
<dd>
-<p>
+ <p>
Specifies the number of bits in the key. The choice of key
size depends on the algorithm used. RSA keys must be
between 512 and 2048 bits. Diffie Hellman keys must be between
between 1 and 512 bits. Elliptic curve algorithms don't need
this parameter.
</p>
-<p>
+ <p>
The key size does not need to be specified if using a default
algorithm. The default key size is 1024 bits for zone signing
keys (ZSKs) and 2048 bits for key signing keys (KSKs,
then there is no default key size, and the <code class="option">-b</code>
must be used.
</p>
-</dd>
+ </dd>
<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the owner type of the key. The value of
<code class="option">nametype</code> must either be ZONE (for a DNSSEC
zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
These values are case insensitive. Defaults to ZONE for DNSKEY
generation.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-3</span></dt>
-<dd><p>
+<dd>
+ <p>
Use an NSEC3-capable algorithm to generate a DNSSEC key.
If this option is used and no algorithm is explicitly
set on the command line, NSEC3RSASHA1 will be used by
default. Note that RSASHA256, RSASHA512, ECCGOST,
ECDSAP256SHA256 and ECDSAP384SHA384 algorithms
are NSEC3-capable.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-C</span></dt>
-<dd><p>
+<dd>
+ <p>
Compatibility mode: generates an old-style key, without
- any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span>
+ any metadata. By default, <span class="command"><strong>dnssec-keygen</strong></span>
will include the key's creation date in the metadata stored
with the private key, and other dates may be set there as well
(publication date, activation date, etc). Keys that include
this data may be incompatible with older versions of BIND; the
<code class="option">-C</code> option suppresses them.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Indicates that the DNS record containing the key should have
the specified class. If not specified, class IN is used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
<dd>
-<p>
+ <p>
Specifies the cryptographic hardware to use, when applicable.
</p>
-<p>
+ <p>
When BIND is built with OpenSSL PKCS#11 support, this defaults
to the string "pkcs11", which identifies an OpenSSL engine
that can drive a cryptographic accelerator or hardware service
(--enable-native-pkcs11), it defaults to the path of the PKCS#11
provider library specified via "--with-pkcs11".
</p>
-</dd>
+ </dd>
<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the specified flag in the flag field of the KEY/DNSKEY record.
The only recognized flags are KSK (Key Signing Key) and REVOKE.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-G</span></dt>
-<dd><p>
+<dd>
+ <p>
Generate a key, but do not publish it or sign with it. This
option is incompatible with -P and -A.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
If generating a Diffie Hellman key, use this generator.
Allowed values are 2 and 5. If no generator
is specified, a known prime from RFC 2539 will be used
if possible; otherwise the default is 2.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints a short summary of the options and arguments to
- <span><strong class="command">dnssec-keygen</strong></span>.
- </p></dd>
+ <span class="command"><strong>dnssec-keygen</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the directory in which the key files are to be written.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-k</span></dt>
-<dd><p>
+<dd>
+ <p>
Deprecated in favor of -T KEY.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the default TTL to use for this key when it is converted
into a DNSKEY RR. If the key is imported into a zone,
this is the TTL that will be used for it, unless there was
is no existing DNSKEY RRset, the TTL will default to the
SOA TTL. Setting the default TTL to <code class="literal">0</code>
or <code class="literal">none</code> is the same as leaving it unset.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the protocol value for the generated key. The protocol
is a number between 0 and 255. The default is 3 (DNSSEC).
Other possible values for this argument are listed in
RFC 2535 and its successors.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-q</span></dt>
-<dd><p>
+<dd>
+ <p>
Quiet mode: Suppresses unnecessary output, including
progress indication. Without this option, when
- <span><strong class="command">dnssec-keygen</strong></span> is run interactively
+ <span class="command"><strong>dnssec-keygen</strong></span> is run interactively
to generate an RSA or DSA key pair, it will print a string
of symbols to <code class="filename">stderr</code> indicating the
progress of the key generation. A '.' indicates that a
round of the Miller-Rabin primality test; a space
means that the number has passed all the tests and is
a satisfactory key.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the source of randomness. If the operating
system does not provide a <code class="filename">/dev/random</code>
or equivalent device, the default source of randomness
data to be used instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard
input should be used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Create a new key which is an explicit successor to an
existing key. The name, algorithm, size, and type of the
key will be set to match the existing key. The activation
the existing one. The publication date will be set to the
activation date minus the prepublication interval, which
defaults to 30 days.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the strength value of the key. The strength is
a number between 0 and 15, and currently has no defined
purpose in DNSSEC.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
<dd>
-<p>
+ <p>
Specifies the resource record type to use for the key.
<code class="option">rrtype</code> must be either DNSKEY or KEY. The
default is DNSKEY when using a DNSSEC algorithm, but it can be
Using any TSIG algorithm (HMAC-* or DH) forces this option
to KEY.
</p>
-</dd>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Indicates the use of the key. <code class="option">type</code> must be
one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
is AUTHCONF. AUTH refers to the ability to authenticate
data, and CONF the ability to encrypt data.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the debugging level.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints version information.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544292"></a><h2>TIMING OPTIONS</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="TIMING OPTIONS">
+<a name="idp61119056"></a><h2>TIMING OPTIONS</h2>
+
+
+ <p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
If the argument begins with a '+' or '-', it is interpreted as
an offset from the present time. For convenience, if such an offset
is computed in seconds. To explicitly prevent a date from being
set, use 'none' or 'never'.
</p>
-<div class="variablelist"><dl>
+
+ <div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which a key is to be published to the zone.
After that date, the key will be included in the zone but will
not be used to sign it. If not set, and if the -G option has
not been used, the default is "now".
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be activated. After that
date, the key will be included in the zone and used to sign
it. If not set, and if the -G option has not been used, the
default is "now". If set, if and -P is not set, then
the publication date will be set to the activation date
minus the prepublication interval.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be revoked. After that
date, the key will be flagged as revoked. It will be included
in the zone and will be used to sign it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be retired. After that
date, the key will still be included in the zone, but it
will not be used to sign it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be deleted. After that
date, the key will no longer be included in the zone. (It
may remain in the key repository, however.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
<dd>
-<p>
+ <p>
Sets the prepublication interval for a key. If set, then
the publication and activation dates must be separated by at least
this much time. If the activation date is specified but the
the publication date is specified but activation date isn't,
then activation will be set to this much time after publication.
</p>
-<p>
+ <p>
If the key is being created as an explicit successor to another
key, then the default prepublication interval is 30 days;
otherwise it is zero.
</p>
-<p>
+ <p>
As with date offsets, if the argument is followed by one of
the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
interval is measured in years, months, weeks, days, hours,
or minutes, respectively. Without a suffix, the interval is
measured in seconds.
</p>
-</dd>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544413"></a><h2>GENERATED KEYS</h2>
-<p>
- When <span><strong class="command">dnssec-keygen</strong></span> completes
+ </div>
+
+
+ <div class="refsection" title="GENERATED KEYS">
+<a name="idp61137488"></a><h2>GENERATED KEYS</h2>
+
+ <p>
+ When <span class="command"><strong>dnssec-keygen</strong></span> completes
successfully,
it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
to the standard output. This is an identification string for
the key it has generated.
</p>
-<div class="itemizedlist"><ul type="disc">
-<li><p><code class="filename">nnnn</code> is the key name.
- </p></li>
-<li><p><code class="filename">aaa</code> is the numeric representation
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <p><code class="filename">nnnn</code> is the key name.
+ </p>
+ </li>
+<li class="listitem">
+ <p><code class="filename">aaa</code> is the numeric representation
of the
algorithm.
- </p></li>
-<li><p><code class="filename">iiiii</code> is the key identifier (or
+ </p>
+ </li>
+<li class="listitem">
+ <p><code class="filename">iiiii</code> is the key identifier (or
footprint).
- </p></li>
+ </p>
+ </li>
</ul></div>
-<p><span><strong class="command">dnssec-keygen</strong></span>
+ <p><span class="command"><strong>dnssec-keygen</strong></span>
creates two files, with names based
on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
contains the public key, and
private
key.
</p>
-<p>
+ <p>
The <code class="filename">.key</code> file contains a DNS KEY record
that
can be inserted into a zone file (directly or with a $INCLUDE
statement).
</p>
-<p>
+ <p>
The <code class="filename">.private</code> file contains
algorithm-specific
fields. For obvious security reasons, this file does not have
general read permission.
</p>
-<p>
+ <p>
Both <code class="filename">.key</code> and <code class="filename">.private</code>
files are generated for symmetric encryption algorithms such as
HMAC-MD5, even though the public and private key are equivalent.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544496"></a><h2>EXAMPLE</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="EXAMPLE">
+<a name="idp61147344"></a><h2>EXAMPLE</h2>
+
+ <p>
To generate a 768-bit DSA key for the domain
<strong class="userinput"><code>example.com</code></strong>, the following command would be
issued:
</p>
-<p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
+ <p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
</p>
-<p>
+ <p>
The command would print a string of the form:
</p>
-<p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
+ <p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
</p>
-<p>
- In this example, <span><strong class="command">dnssec-keygen</strong></span> creates
+ <p>
+ In this example, <span class="command"><strong>dnssec-keygen</strong></span> creates
the files <code class="filename">Kexample.com.+003+26160.key</code>
and
<code class="filename">Kexample.com.+003+26160.private</code>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544608"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61152464"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dnssec-signzone</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 2539</em>,
<em class="citetitle">RFC 2845</em>,
<em class="citetitle">RFC 4034</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544638"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-revoke
+'\" t
+.\" Title: dnssec-revoke
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 15, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-01-15
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-REVOKE" "8" "January 15, 2014" "BIND9" "BIND9"
+.TH "DNSSEC\-REVOKE" "8" "2014\-01\-15" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-revoke \- Set the REVOKED bit on a DNSSEC key
+dnssec-revoke \- Set the REVOKED bit on a DNSSEC key
.SH "SYNOPSIS"
.HP 14
\fBdnssec\-revoke\fR [\fB\-hr\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\fR] [\fB\-R\fR] {keyfile}
.SH "DESCRIPTION"
.PP
\fBdnssec\-revoke\fR
-reads a DNSSEC key file, sets the REVOKED bit on the key as defined in RFC 5011, and creates a new pair of key files containing the now\-revoked key.
+reads a DNSSEC key file, sets the REVOKED bit on the key as defined in RFC 5011, and creates a new pair of key files containing the now\-revoked key\&.
.SH "OPTIONS"
.PP
\-h
.RS 4
-Emit usage message and exit.
+Emit usage message and exit\&.
.RE
.PP
\-K \fIdirectory\fR
.RS 4
-Sets the directory in which the key files are to reside.
+Sets the directory in which the key files are to reside\&.
.RE
.PP
\-r
.RS 4
-After writing the new keyset files remove the original keyset files.
+After writing the new keyset files remove the original keyset files\&.
.RE
.PP
\-v \fIlevel\fR
.RS 4
-Sets the debugging level.
+Sets the debugging level\&.
.RE
.PP
\-V
.RS 4
-Prints version information.
+Prints version information\&.
.RE
.PP
\-E \fIengine\fR
.RS 4
-Specifies the cryptographic hardware to use, when applicable.
+Specifies the cryptographic hardware to use, when applicable\&.
.sp
-When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11".
+When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&.
.RE
.PP
\-f
.RS 4
Force overwrite: Causes
\fBdnssec\-revoke\fR
-to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key.
+to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key\&.
.RE
.PP
\-R
.RS 4
-Print the key tag of the key with the REVOKE bit set but do not revoke the key.
+Print the key tag of the key with the REVOKE bit set but do not revoke the key\&.
.RE
.SH "SEE ALSO"
.PP
-\fBdnssec\-keygen\fR(8),
+\fBdnssec-keygen\fR(8),
BIND 9 Administrator Reference Manual,
-RFC 5011.
+RFC 5011\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2009, 2011, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-revoke">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-revoke</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-revoke">
<a name="man.dnssec-revoke"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-revoke</span> — Set the REVOKED bit on a DNSSEC key</p>
+<p>
+ <span class="application">dnssec-revoke</span>
+ — Set the REVOKED bit on a DNSSEC key
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-revoke</code> [<code class="option">-hr</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f</code>] [<code class="option">-R</code>] {keyfile}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543397"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-revoke</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-revoke</code>
+ [<code class="option">-hr</code>]
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-V</code>]
+ [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>]
+ [<code class="option">-f</code>]
+ [<code class="option">-R</code>]
+ {keyfile}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60879440"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-revoke</strong></span>
reads a DNSSEC key file, sets the REVOKED bit on the key as defined
in RFC 5011, and creates a new pair of key files containing the
now-revoked key.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543409"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60881104"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Emit usage message and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the directory in which the key files are to reside.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-r</span></dt>
-<dd><p>
+<dd>
+ <p>
After writing the new keyset files remove the original keyset
files.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the debugging level.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints version information.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
<dd>
-<p>
+ <p>
Specifies the cryptographic hardware to use, when applicable.
</p>
-<p>
+ <p>
When BIND is built with OpenSSL PKCS#11 support, this defaults
to the string "pkcs11", which identifies an OpenSSL engine
that can drive a cryptographic accelerator or hardware service
(--enable-native-pkcs11), it defaults to the path of the PKCS#11
provider library specified via "--with-pkcs11".
</p>
-</dd>
+ </dd>
<dt><span class="term">-f</span></dt>
-<dd><p>
- Force overwrite: Causes <span><strong class="command">dnssec-revoke</strong></span> to
+<dd>
+ <p>
+ Force overwrite: Causes <span class="command"><strong>dnssec-revoke</strong></span> to
write the new key pair even if a file already exists matching
the algorithm and key ID of the revoked key.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-R</span></dt>
-<dd><p>
+<dd>
+ <p>
Print the key tag of the key with the REVOKE bit set but do
not revoke the key.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543544"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60909264"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 5011</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543569"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-settime
+'\" t
+.\" Title: dnssec-settime
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: February 06, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-02-06
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-SETTIME" "8" "February 06, 2014" "BIND9" "BIND9"
+.TH "DNSSEC\-SETTIME" "8" "2014\-02\-06" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-settime \- Set the key timing metadata for a DNSSEC key
+dnssec-settime \- Set the key timing metadata for a DNSSEC key
.SH "SYNOPSIS"
.HP 15
\fBdnssec\-settime\fR [\fB\-f\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-h\fR] [\fB\-V\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] {keyfile}
\fB\-R\fR,
\fB\-I\fR, and
\fB\-D\fR
-options. The metadata can then be used by
+options\&. The metadata can then be used by
\fBdnssec\-signzone\fR
-or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc.
+or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc\&.
.PP
If none of these options is set on the command line, then
\fBdnssec\-settime\fR
-simply prints the key timing metadata already stored in the key.
+simply prints the key timing metadata already stored in the key\&.
.PP
-When key metadata fields are changed, both files of a key pair (\fIKnnnn.+aaa+iiiii.key\fR
+When key metadata fields are changed, both files of a key pair (Knnnn\&.+aaa+iiiii\&.key
and
-\fIKnnnn.+aaa+iiiii.private\fR) are regenerated. Metadata fields are stored in the private file. A human\-readable description of the metadata is also placed in comments in the key file. The private file's permissions are always set to be inaccessible to anyone other than the owner (mode 0600).
+Knnnn\&.+aaa+iiiii\&.private) are regenerated\&. Metadata fields are stored in the private file\&. A human\-readable description of the metadata is also placed in comments in the key file\&. The private file\*(Aqs permissions are always set to be inaccessible to anyone other than the owner (mode 0600)\&.
.SH "OPTIONS"
.PP
\-f
.RS 4
-Force an update of an old\-format key with no metadata fields. Without this option,
+Force an update of an old\-format key with no metadata fields\&. Without this option,
\fBdnssec\-settime\fR
-will fail when attempting to update a legacy key. With this option, the key will be recreated in the new format, but with the original key data retained. The key's creation date will be set to the present time. If no other values are specified, then the key's publication and activation dates will also be set to the present time.
+will fail when attempting to update a legacy key\&. With this option, the key will be recreated in the new format, but with the original key data retained\&. The key\*(Aqs creation date will be set to the present time\&. If no other values are specified, then the key\*(Aqs publication and activation dates will also be set to the present time\&.
.RE
.PP
\-K \fIdirectory\fR
.RS 4
-Sets the directory in which the key files are to reside.
+Sets the directory in which the key files are to reside\&.
.RE
.PP
\-L \fIttl\fR
.RS 4
-Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to
+Sets the default TTL to use for this key when it is converted into a DNSKEY RR\&. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence\&. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL\&. Setting the default TTL to
0
or
none
-removes it from the key.
+removes it from the key\&.
.RE
.PP
\-h
.RS 4
-Emit usage message and exit.
+Emit usage message and exit\&.
.RE
.PP
\-V
.RS 4
-Prints version information.
+Prints version information\&.
.RE
.PP
\-v \fIlevel\fR
.RS 4
-Sets the debugging level.
+Sets the debugging level\&.
.RE
.PP
\-E \fIengine\fR
.RS 4
-Specifies the cryptographic hardware to use, when applicable.
+Specifies the cryptographic hardware to use, when applicable\&.
.sp
-When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11".
+When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&.
.RE
.SH "TIMING OPTIONS"
.PP
-Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To unset a date, use 'none' or 'never'.
+Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To unset a date, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&.
.PP
\-P \fIdate/offset\fR
.RS 4
-Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it.
+Sets the date on which a key is to be published to the zone\&. After that date, the key will be included in the zone but will not be used to sign it\&.
.RE
.PP
\-A \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it.
+Sets the date on which the key is to be activated\&. After that date, the key will be included in the zone and used to sign it\&.
.RE
.PP
\-R \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it.
+Sets the date on which the key is to be revoked\&. After that date, the key will be flagged as revoked\&. It will be included in the zone and will be used to sign it\&.
.RE
.PP
\-I \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it.
+Sets the date on which the key is to be retired\&. After that date, the key will still be included in the zone, but it will not be used to sign it\&.
.RE
.PP
\-D \fIdate/offset\fR
.RS 4
-Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.)
+Sets the date on which the key is to be deleted\&. After that date, the key will no longer be included in the zone\&. (It may remain in the key repository, however\&.)
.RE
.PP
\-S \fIpredecessor key\fR
.RS 4
-Select a key for which the key being modified will be an explicit successor. The name, algorithm, size, and type of the predecessor key must exactly match those of the key being modified. The activation date of the successor key will be set to the inactivation date of the predecessor. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days.
+Select a key for which the key being modified will be an explicit successor\&. The name, algorithm, size, and type of the predecessor key must exactly match those of the key being modified\&. The activation date of the successor key will be set to the inactivation date of the predecessor\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&.
.RE
.PP
\-i \fIinterval\fR
.RS 4
-Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the publication date isn't, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn't, then activation will be set to this much time after publication.
+Sets the prepublication interval for a key\&. If set, then the publication and activation dates must be separated by at least this much time\&. If the activation date is specified but the publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&.
.sp
-If the key is being set to be an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.
+If the key is being set to be an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero\&.
.sp
-As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.
+As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&.
.RE
.SH "PRINTING OPTIONS"
.PP
\fBdnssec\-settime\fR
-can also be used to print the timing metadata associated with a key.
+can also be used to print the timing metadata associated with a key\&.
.PP
\-u
.RS 4
-Print times in UNIX epoch format.
+Print times in UNIX epoch format\&.
.RE
.PP
\-p \fIC/P/A/R/I/D/all\fR
.RS 4
-Print a specific metadata value or set of metadata values. The
+Print a specific metadata value or set of metadata values\&. The
\fB\-p\fR
option may be followed by one or more of the following letters to indicate which value or values to print:
\fBC\fR
\fBI\fR
for the inactivation date, or
\fBD\fR
-for the deletion date. To print all of the metadata, use
-\fB\-p all\fR.
+for the deletion date\&. To print all of the metadata, use
+\fB\-p all\fR\&.
.RE
.SH "SEE ALSO"
.PP
-\fBdnssec\-keygen\fR(8),
-\fBdnssec\-signzone\fR(8),
+\fBdnssec-keygen\fR(8),
+\fBdnssec-signzone\fR(8),
BIND 9 Administrator Reference Manual,
-RFC 5011.
+RFC 5011\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2009\-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2009-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-settime">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-settime</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-settime">
<a name="man.dnssec-settime"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-settime</span> — Set the key timing metadata for a DNSSEC key</p>
+<p>
+ <span class="application">dnssec-settime</span>
+ — Set the key timing metadata for a DNSSEC key
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-settime</code> [<code class="option">-f</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-V</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] {keyfile}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543450"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-settime</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-settime</code>
+ [<code class="option">-f</code>]
+ [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
+ [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-V</code>]
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>]
+ {keyfile}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60914768"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-settime</strong></span>
reads a DNSSEC private key file and sets the key timing metadata
as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
<code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
options. The metadata can then be used by
- <span><strong class="command">dnssec-signzone</strong></span> or other signing software to
+ <span class="command"><strong>dnssec-signzone</strong></span> or other signing software to
determine when a key is to be published, whether it should be
used for signing a zone, etc.
</p>
-<p>
+ <p>
If none of these options is set on the command line,
- then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing
+ then <span class="command"><strong>dnssec-settime</strong></span> simply prints the key timing
metadata already stored in the key.
</p>
-<p>
+ <p>
When key metadata fields are changed, both files of a key
pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
<code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
file. The private file's permissions are always set to be
inaccessible to anyone other than the owner (mode 0600).
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543498"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60924880"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-f</span></dt>
-<dd><p>
+<dd>
+ <p>
Force an update of an old-format key with no metadata fields.
- Without this option, <span><strong class="command">dnssec-settime</strong></span> will
+ Without this option, <span class="command"><strong>dnssec-settime</strong></span> will
fail when attempting to update a legacy key. With this option,
the key will be recreated in the new format, but with the
original key data retained. The key's creation date will be
set to the present time. If no other values are specified,
then the key's publication and activation dates will also
be set to the present time.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the directory in which the key files are to reside.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the default TTL to use for this key when it is converted
into a DNSKEY RR. If the key is imported into a zone,
this is the TTL that will be used for it, unless there was
is no existing DNSKEY RRset, the TTL will default to the
SOA TTL. Setting the default TTL to <code class="literal">0</code>
or <code class="literal">none</code> removes it from the key.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Emit usage message and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints version information.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the debugging level.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
<dd>
-<p>
+ <p>
Specifies the cryptographic hardware to use, when applicable.
</p>
-<p>
+ <p>
When BIND is built with OpenSSL PKCS#11 support, this defaults
to the string "pkcs11", which identifies an OpenSSL engine
that can drive a cryptographic accelerator or hardware service
(--enable-native-pkcs11), it defaults to the path of the PKCS#11
provider library specified via "--with-pkcs11".
</p>
-</dd>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543700"></a><h2>TIMING OPTIONS</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="TIMING OPTIONS">
+<a name="idp60940368"></a><h2>TIMING OPTIONS</h2>
+
+ <p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
If the argument begins with a '+' or '-', it is interpreted as
an offset from the present time. For convenience, if such an offset
days, hours, or minutes, respectively. Without a suffix, the offset
is computed in seconds. To unset a date, use 'none' or 'never'.
</p>
-<div class="variablelist"><dl>
+
+ <div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which a key is to be published to the zone.
After that date, the key will be included in the zone but will
not be used to sign it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be activated. After that
date, the key will be included in the zone and used to sign
it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be revoked. After that
date, the key will be flagged as revoked. It will be included
in the zone and will be used to sign it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be retired. After that
date, the key will still be included in the zone, but it
will not be used to sign it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the date on which the key is to be deleted. After that
date, the key will no longer be included in the zone. (It
may remain in the key repository, however.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Select a key for which the key being modified will be an
explicit successor. The name, algorithm, size, and type of the
predecessor key must exactly match those of the key being
to the inactivation date of the predecessor. The publication
date will be set to the activation date minus the prepublication
interval, which defaults to 30 days.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
<dd>
-<p>
+ <p>
Sets the prepublication interval for a key. If set, then
the publication and activation dates must be separated by at least
this much time. If the activation date is specified but the
the publication date is specified but activation date isn't,
then activation will be set to this much time after publication.
</p>
-<p>
+ <p>
If the key is being set to be an explicit successor to another
key, then the default prepublication interval is 30 days;
otherwise it is zero.
</p>
-<p>
+ <p>
As with date offsets, if the argument is followed by one of
the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
interval is measured in years, months, weeks, days, hours,
or minutes, respectively. Without a suffix, the interval is
measured in seconds.
</p>
-</dd>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543838"></a><h2>PRINTING OPTIONS</h2>
-<p>
- <span><strong class="command">dnssec-settime</strong></span> can also be used to print the
+ </div>
+
+ <div class="refsection" title="PRINTING OPTIONS">
+<a name="idp60964816"></a><h2>PRINTING OPTIONS</h2>
+
+ <p>
+ <span class="command"><strong>dnssec-settime</strong></span> can also be used to print the
timing metadata associated with a key.
</p>
-<div class="variablelist"><dl>
+
+ <div class="variablelist"><dl>
<dt><span class="term">-u</span></dt>
-<dd><p>
+<dd>
+ <p>
Print times in UNIX epoch format.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Print a specific metadata value or set of metadata values.
The <code class="option">-p</code> option may be followed by one or more
of the following letters to indicate which value or values to print:
<code class="option">I</code> for the inactivation date, or
<code class="option">D</code> for the deletion date.
To print all of the metadata, use <code class="option">-p all</code>.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543916"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60973648"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-signzone</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 5011</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543949"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-signzone
+'\" t
+.\" Title: dnssec-signzone
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: February 18, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-02-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-SIGNZONE" "8" "February 18, 2014" "BIND9" "BIND9"
+.TH "DNSSEC\-SIGNZONE" "8" "2014\-02\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-signzone \- DNSSEC zone signing tool
+dnssec-signzone \- DNSSEC zone signing tool
.SH "SYNOPSIS"
.HP 16
\fBdnssec\-signzone\fR [\fB\-a\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-d\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-e\ \fR\fB\fIend\-time\fR\fR] [\fB\-f\ \fR\fB\fIoutput\-file\fR\fR] [\fB\-g\fR] [\fB\-h\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-k\ \fR\fB\fIkey\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-M\ \fR\fB\fIdomain\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] [\fB\-j\ \fR\fB\fIjitter\fR\fR] [\fB\-N\ \fR\fB\fIsoa\-serial\-format\fR\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-O\ \fR\fB\fIoutput\-format\fR\fR] [\fB\-P\fR] [\fB\-p\fR] [\fB\-Q\fR] [\fB\-R\fR] [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] [\fB\-S\fR] [\fB\-s\ \fR\fB\fIstart\-time\fR\fR] [\fB\-T\ \fR\fB\fIttl\fR\fR] [\fB\-t\fR] [\fB\-u\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-X\ \fR\fB\fIextended\ end\-time\fR\fR] [\fB\-x\fR] [\fB\-z\fR] [\fB\-3\ \fR\fB\fIsalt\fR\fR] [\fB\-H\ \fR\fB\fIiterations\fR\fR] [\fB\-A\fR] {zonefile} [key...]
.SH "DESCRIPTION"
.PP
\fBdnssec\-signzone\fR
-signs a zone. It generates NSEC and RRSIG records and produces a signed version of the zone. The security status of delegations from the signed zone (that is, whether the child zones are secure or not) is determined by the presence or absence of a
-\fIkeyset\fR
-file for each child zone.
+signs a zone\&. It generates NSEC and RRSIG records and produces a signed version of the zone\&. The security status of delegations from the signed zone (that is, whether the child zones are secure or not) is determined by the presence or absence of a
+keyset
+file for each child zone\&.
.SH "OPTIONS"
.PP
\-a
.RS 4
-Verify all generated signatures.
+Verify all generated signatures\&.
.RE
.PP
\-c \fIclass\fR
.RS 4
-Specifies the DNS class of the zone.
+Specifies the DNS class of the zone\&.
.RE
.PP
\-C
.RS 4
Compatibility mode: Generate a
-\fIkeyset\-\fR\fI\fIzonename\fR\fR
+keyset\-\fIzonename\fR
file in addition to
-\fIdsset\-\fR\fI\fIzonename\fR\fR
+dsset\-\fIzonename\fR
when signing a zone, for use by older versions of
-\fBdnssec\-signzone\fR.
+\fBdnssec\-signzone\fR\&.
.RE
.PP
\-d \fIdirectory\fR
.RS 4
Look for
-\fIdsset\-\fR
+dsset\-
or
-\fIkeyset\-\fR
+keyset\-
files in
-\fBdirectory\fR.
+\fBdirectory\fR\&.
.RE
.PP
\-D
.RS 4
Output only those record types automatically managed by
-\fBdnssec\-signzone\fR, i.e. RRSIG, NSEC, NSEC3 and NSEC3PARAM records. If smart signing (\fB\-S\fR) is used, DNSKEY records are also included. The resulting file can be included in the original zone file with
-\fB$INCLUDE\fR. This option cannot be combined with
+\fBdnssec\-signzone\fR, i\&.e\&. RRSIG, NSEC, NSEC3 and NSEC3PARAM records\&. If smart signing (\fB\-S\fR) is used, DNSKEY records are also included\&. The resulting file can be included in the original zone file with
+\fB$INCLUDE\fR\&. This option cannot be combined with
\fB\-O raw\fR,
-\fB\-O map\fR, or serial number updating.
+\fB\-O map\fR, or serial number updating\&.
.RE
.PP
\-E \fIengine\fR
.RS 4
-When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing.
+When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing\&.
.sp
-When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11".
+When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&.
.RE
.PP
\-g
.RS 4
Generate DS records for child zones from
-\fIdsset\-\fR
+dsset\-
or
-\fIkeyset\-\fR
-file. Existing DS records will be removed.
+keyset\-
+file\&. Existing DS records will be removed\&.
.RE
.PP
\-K \fIdirectory\fR
.RS 4
-Key repository: Specify a directory to search for DNSSEC keys. If not specified, defaults to the current directory.
+Key repository: Specify a directory to search for DNSSEC keys\&. If not specified, defaults to the current directory\&.
.RE
.PP
\-k \fIkey\fR
.RS 4
-Treat specified key as a key signing key ignoring any key flags. This option may be specified multiple times.
+Treat specified key as a key signing key ignoring any key flags\&. This option may be specified multiple times\&.
.RE
.PP
\-l \fIdomain\fR
.RS 4
-Generate a DLV set in addition to the key (DNSKEY) and DS sets. The domain is appended to the name of the records.
+Generate a DLV set in addition to the key (DNSKEY) and DS sets\&. The domain is appended to the name of the records\&.
.RE
.PP
\-M \fImaxttl\fR
.RS 4
-Sets the maximum TTL for the signed zone. Any TTL higher than
+Sets the maximum TTL for the signed zone\&. Any TTL higher than
\fImaxttl\fR
in the input zone will be reduced to
\fImaxttl\fR
-in the output. This provides certainty as to the largest possible TTL in the signed zone, which is useful to know when rolling keys because it is the longest possible time before signatures that have been retrieved by resolvers will expire from resolver caches. Zones that are signed with this option should be configured to use a matching
+in the output\&. This provides certainty as to the largest possible TTL in the signed zone, which is useful to know when rolling keys because it is the longest possible time before signatures that have been retrieved by resolvers will expire from resolver caches\&. Zones that are signed with this option should be configured to use a matching
\fBmax\-zone\-ttl\fR
in
-\fInamed.conf\fR. (Note: This option is incompatible with
-\fB\-D\fR, because it modifies non\-DNSSEC data in the output zone.)
+named\&.conf\&. (Note: This option is incompatible with
+\fB\-D\fR, because it modifies non\-DNSSEC data in the output zone\&.)
.RE
.PP
\-s \fIstart\-time\fR
.RS 4
-Specify the date and time when the generated RRSIG records become valid. This can be either an absolute or relative time. An absolute start time is indicated by a number in YYYYMMDDHHMMSS notation; 20000530144500 denotes 14:45:00 UTC on May 30th, 2000. A relative start time is indicated by +N, which is N seconds from the current time. If no
+Specify the date and time when the generated RRSIG records become valid\&. This can be either an absolute or relative time\&. An absolute start time is indicated by a number in YYYYMMDDHHMMSS notation; 20000530144500 denotes 14:45:00 UTC on May 30th, 2000\&. A relative start time is indicated by +N, which is N seconds from the current time\&. If no
\fBstart\-time\fR
-is specified, the current time minus 1 hour (to allow for clock skew) is used.
+is specified, the current time minus 1 hour (to allow for clock skew) is used\&.
.RE
.PP
\-e \fIend\-time\fR
.RS 4
-Specify the date and time when the generated RRSIG records expire. As with
-\fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative to the start time is indicated with +N, which is N seconds from the start time. A time relative to the current time is indicated with now+N. If no
+Specify the date and time when the generated RRSIG records expire\&. As with
+\fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation\&. A time relative to the start time is indicated with +N, which is N seconds from the start time\&. A time relative to the current time is indicated with now+N\&. If no
\fBend\-time\fR
-is specified, 30 days from the start time is used as a default.
+is specified, 30 days from the start time is used as a default\&.
\fBend\-time\fR
must be later than
-\fBstart\-time\fR.
+\fBstart\-time\fR\&.
.RE
.PP
\-X \fIextended end\-time\fR
.RS 4
-Specify the date and time when the generated RRSIG records for the DNSKEY RRset will expire. This is to be used in cases when the DNSKEY signatures need to persist longer than signatures on other records; e.g., when the private component of the KSK is kept offline and the KSK signature is to be refreshed manually.
+Specify the date and time when the generated RRSIG records for the DNSKEY RRset will expire\&. This is to be used in cases when the DNSKEY signatures need to persist longer than signatures on other records; e\&.g\&., when the private component of the KSK is kept offline and the KSK signature is to be refreshed manually\&.
.sp
As with
-\fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative to the start time is indicated with +N, which is N seconds from the start time. A time relative to the current time is indicated with now+N. If no
+\fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation\&. A time relative to the start time is indicated with +N, which is N seconds from the start time\&. A time relative to the current time is indicated with now+N\&. If no
\fBextended end\-time\fR
is specified, the value of
\fBend\-time\fR
-is used as the default. (\fBend\-time\fR, in turn, defaults to 30 days from the start time.)
+is used as the default\&. (\fBend\-time\fR, in turn, defaults to 30 days from the start time\&.)
\fBextended end\-time\fR
must be later than
-\fBstart\-time\fR.
+\fBstart\-time\fR\&.
.RE
.PP
\-f \fIoutput\-file\fR
.RS 4
-The name of the output file containing the signed zone. The default is to append
-\fI.signed\fR
-to the input filename. If
+The name of the output file containing the signed zone\&. The default is to append
+\&.signed
+to the input filename\&. If
\fBoutput\-file\fR
is set to
-"\-", then the signed zone is written to the standard output, with a default output format of "full".
+"\-", then the signed zone is written to the standard output, with a default output format of "full"\&.
.RE
.PP
\-h
.RS 4
Prints a short summary of the options and arguments to
-\fBdnssec\-signzone\fR.
+\fBdnssec\-signzone\fR\&.
.RE
.PP
\-V
.RS 4
-Prints version information.
+Prints version information\&.
.RE
.PP
\-i \fIinterval\fR
.RS 4
-When a previously\-signed zone is passed as input, records may be resigned. The
+When a previously\-signed zone is passed as input, records may be resigned\&. The
\fBinterval\fR
-option specifies the cycle interval as an offset from the current time (in seconds). If a RRSIG record expires after the cycle interval, it is retained. Otherwise, it is considered to be expiring soon, and it will be replaced.
+option specifies the cycle interval as an offset from the current time (in seconds)\&. If a RRSIG record expires after the cycle interval, it is retained\&. Otherwise, it is considered to be expiring soon, and it will be replaced\&.
.sp
-The default cycle interval is one quarter of the difference between the signature end and start times. So if neither
+The default cycle interval is one quarter of the difference between the signature end and start times\&. So if neither
\fBend\-time\fR
or
\fBstart\-time\fR
are specified,
\fBdnssec\-signzone\fR
-generates signatures that are valid for 30 days, with a cycle interval of 7.5 days. Therefore, if any existing RRSIG records are due to expire in less than 7.5 days, they would be replaced.
+generates signatures that are valid for 30 days, with a cycle interval of 7\&.5 days\&. Therefore, if any existing RRSIG records are due to expire in less than 7\&.5 days, they would be replaced\&.
.RE
.PP
\-I \fIinput\-format\fR
.RS 4
-The format of the input zone file. Possible formats are
+The format of the input zone file\&. Possible formats are
\fB"text"\fR
(default),
\fB"raw"\fR, and
-\fB"map"\fR. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be signed directly. The use of this option does not make much sense for non\-dynamic zones.
+\fB"map"\fR\&. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be signed directly\&. The use of this option does not make much sense for non\-dynamic zones\&.
.RE
.PP
\-j \fIjitter\fR
.RS 4
-When signing a zone with a fixed signature lifetime, all RRSIG records issued at the time of signing expires simultaneously. If the zone is incrementally signed, i.e. a previously\-signed zone is passed as input to the signer, all expired signatures have to be regenerated at about the same time. The
+When signing a zone with a fixed signature lifetime, all RRSIG records issued at the time of signing expires simultaneously\&. If the zone is incrementally signed, i\&.e\&. a previously\-signed zone is passed as input to the signer, all expired signatures have to be regenerated at about the same time\&. The
\fBjitter\fR
-option specifies a jitter window that will be used to randomize the signature expire time, thus spreading incremental signature regeneration over time.
+option specifies a jitter window that will be used to randomize the signature expire time, thus spreading incremental signature regeneration over time\&.
.sp
-Signature lifetime jitter also to some extent benefits validators and servers by spreading out cache expiration, i.e. if large numbers of RRSIGs don't expire at the same time from all caches there will be less congestion than if all validators need to refetch at mostly the same time.
+Signature lifetime jitter also to some extent benefits validators and servers by spreading out cache expiration, i\&.e\&. if large numbers of RRSIGs don\*(Aqt expire at the same time from all caches there will be less congestion than if all validators need to refetch at mostly the same time\&.
.RE
.PP
\-L \fIserial\fR
.RS 4
-When writing a signed zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.)
+When writing a signed zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number\&. (This is expected to be used primarily for testing purposes\&.)
.RE
.PP
\-n \fIncpus\fR
.RS 4
-Specifies the number of threads to use. By default, one thread is started for each detected CPU.
+Specifies the number of threads to use\&. By default, one thread is started for each detected CPU\&.
.RE
.PP
\-N \fIsoa\-serial\-format\fR
.RS 4
-The SOA serial number format of the signed zone. Possible formats are
+The SOA serial number format of the signed zone\&. Possible formats are
\fB"keep"\fR
(default),
\fB"increment"\fR,
\fB"unixtime"\fR, and
-\fB"date"\fR.
-.RS 4
+\fB"date"\fR\&.
.PP
\fB"keep"\fR
.RS 4
-Do not modify the SOA serial number.
+Do not modify the SOA serial number\&.
.RE
.PP
\fB"increment"\fR
.RS 4
-Increment the SOA serial number using RFC 1982 arithmetics.
+Increment the SOA serial number using RFC 1982 arithmetics\&.
.RE
.PP
\fB"unixtime"\fR
.RS 4
-Set the SOA serial number to the number of seconds since epoch.
+Set the SOA serial number to the number of seconds since epoch\&.
.RE
.PP
\fB"date"\fR
.RS 4
-Set the SOA serial number to today's date in YYYYMMDDNN format.
-.RE
+Set the SOA serial number to today\*(Aqs date in YYYYMMDDNN format\&.
.RE
.RE
.PP
\-o \fIorigin\fR
.RS 4
-The zone origin. If not specified, the name of the zone file is assumed to be the origin.
+The zone origin\&. If not specified, the name of the zone file is assumed to be the origin\&.
.RE
.PP
\-O \fIoutput\-format\fR
.RS 4
-The format of the output file containing the signed zone. Possible formats are
+The format of the output file containing the signed zone\&. Possible formats are
\fB"text"\fR
(default), which is the standard textual representation of the zone;
\fB"full"\fR, which is text output in a format suitable for processing by external scripts; and
\fB"map"\fR,
\fB"raw"\fR, and
\fB"raw=N"\fR, which store the zone in binary formats for rapid loading by
-\fBnamed\fR.
+\fBnamed\fR\&.
\fB"raw=N"\fR
specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of
-\fBnamed\fR; if N is 1, the file can be read by release 9.9.0 or higher; the default is 1.
+\fBnamed\fR; if N is 1, the file can be read by release 9\&.9\&.0 or higher; the default is 1\&.
.RE
.PP
\-p
.RS 4
-Use pseudo\-random data when signing the zone. This is faster, but less secure, than using real random data. This option may be useful when signing large zones or when the entropy source is limited.
+Use pseudo\-random data when signing the zone\&. This is faster, but less secure, than using real random data\&. This option may be useful when signing large zones or when the entropy source is limited\&.
.RE
.PP
\-P
.RS 4
-Disable post sign verification tests.
+Disable post sign verification tests\&.
.sp
-The post sign verification test ensures that for each algorithm in use there is at least one non revoked self signed KSK key, that all revoked KSK keys are self signed, and that all records in the zone are signed by the algorithm. This option skips these tests.
+The post sign verification test ensures that for each algorithm in use there is at least one non revoked self signed KSK key, that all revoked KSK keys are self signed, and that all records in the zone are signed by the algorithm\&. This option skips these tests\&.
.RE
.PP
\-Q
.RS 4
-Remove signatures from keys that are no longer active.
+Remove signatures from keys that are no longer active\&.
.sp
-Normally, when a previously\-signed zone is passed as input to the signer, and a DNSKEY record has been removed and replaced with a new one, signatures from the old key that are still within their validity period are retained. This allows the zone to continue to validate with cached copies of the old DNSKEY RRset. The
+Normally, when a previously\-signed zone is passed as input to the signer, and a DNSKEY record has been removed and replaced with a new one, signatures from the old key that are still within their validity period are retained\&. This allows the zone to continue to validate with cached copies of the old DNSKEY RRset\&. The
\fB\-Q\fR
forces
\fBdnssec\-signzone\fR
-to remove signatures from keys that are no longer active. This enables ZSK rollover using the procedure described in RFC 4641, section 4.2.1.1 ("Pre\-Publish Key Rollover").
+to remove signatures from keys that are no longer active\&. This enables ZSK rollover using the procedure described in RFC 4641, section 4\&.2\&.1\&.1 ("Pre\-Publish Key Rollover")\&.
.RE
.PP
\-R
.RS 4
-Remove signatures from keys that are no longer published.
+Remove signatures from keys that are no longer published\&.
.sp
This option is similar to
\fB\-Q\fR, except it forces
\fBdnssec\-signzone\fR
-to signatures from keys that are no longer published. This enables ZSK rollover using the procedure described in RFC 4641, section 4.2.1.2 ("Double Signature Zone Signing Key Rollover").
+to signatures from keys that are no longer published\&. This enables ZSK rollover using the procedure described in RFC 4641, section 4\&.2\&.1\&.2 ("Double Signature Zone Signing Key Rollover")\&.
.RE
.PP
\-r \fIrandomdev\fR
.RS 4
-Specifies the source of randomness. If the operating system does not provide a
-\fI/dev/random\fR
-or equivalent device, the default source of randomness is keyboard input.
-\fIrandomdev\fR
-specifies the name of a character device or file containing random data to be used instead of the default. The special value
-\fIkeyboard\fR
-indicates that keyboard input should be used.
+Specifies the source of randomness\&. If the operating system does not provide a
+/dev/random
+or equivalent device, the default source of randomness is keyboard input\&.
+randomdev
+specifies the name of a character device or file containing random data to be used instead of the default\&. The special value
+keyboard
+indicates that keyboard input should be used\&.
.RE
.PP
\-S
.RS 4
Smart signing: Instructs
\fBdnssec\-signzone\fR
-to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate.
+to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate\&.
.sp
-When a key is found, its timing metadata is examined to determine how it should be used, according to the following rules. Each successive rule takes priority over the prior ones:
-.RS 4
+When a key is found, its timing metadata is examined to determine how it should be used, according to the following rules\&. Each successive rule takes priority over the prior ones:
.PP
.RS 4
-If no timing metadata has been set for the key, the key is published in the zone and used to sign the zone.
+If no timing metadata has been set for the key, the key is published in the zone and used to sign the zone\&.
.RE
.PP
.RS 4
-If the key's publication date is set and is in the past, the key is published in the zone.
+If the key\*(Aqs publication date is set and is in the past, the key is published in the zone\&.
.RE
.PP
.RS 4
-If the key's activation date is set and in the past, the key is published (regardless of publication date) and used to sign the zone.
+If the key\*(Aqs activation date is set and in the past, the key is published (regardless of publication date) and used to sign the zone\&.
.RE
.PP
.RS 4
-If the key's revocation date is set and in the past, and the key is published, then the key is revoked, and the revoked key is used to sign the zone.
+If the key\*(Aqs revocation date is set and in the past, and the key is published, then the key is revoked, and the revoked key is used to sign the zone\&.
.RE
.PP
.RS 4
-If either of the key's unpublication or deletion dates are set and in the past, the key is NOT published or used to sign the zone, regardless of any other metadata.
-.RE
+If either of the key\*(Aqs unpublication or deletion dates are set and in the past, the key is NOT published or used to sign the zone, regardless of any other metadata\&.
.RE
.RE
.PP
\-T \fIttl\fR
.RS 4
-Specifies a TTL to be used for new DNSKEY records imported into the zone from the key repository. If not specified, the default is the TTL value from the zone's SOA record. This option is ignored when signing without
-\fB\-S\fR, since DNSKEY records are not imported from the key repository in that case. It is also ignored if there are any pre\-existing DNSKEY records at the zone apex, in which case new records' TTL values will be set to match them, or if any of the imported DNSKEY records had a default TTL value. In the event of a a conflict between TTL values in imported keys, the shortest one is used.
+Specifies a TTL to be used for new DNSKEY records imported into the zone from the key repository\&. If not specified, the default is the TTL value from the zone\*(Aqs SOA record\&. This option is ignored when signing without
+\fB\-S\fR, since DNSKEY records are not imported from the key repository in that case\&. It is also ignored if there are any pre\-existing DNSKEY records at the zone apex, in which case new records\*(Aq TTL values will be set to match them, or if any of the imported DNSKEY records had a default TTL value\&. In the event of a a conflict between TTL values in imported keys, the shortest one is used\&.
.RE
.PP
\-t
.RS 4
-Print statistics at completion.
+Print statistics at completion\&.
.RE
.PP
\-u
.RS 4
-Update NSEC/NSEC3 chain when re\-signing a previously signed zone. With this option, a zone signed with NSEC can be switched to NSEC3, or a zone signed with NSEC3 can be switch to NSEC or to NSEC3 with different parameters. Without this option,
+Update NSEC/NSEC3 chain when re\-signing a previously signed zone\&. With this option, a zone signed with NSEC can be switched to NSEC3, or a zone signed with NSEC3 can be switch to NSEC or to NSEC3 with different parameters\&. Without this option,
\fBdnssec\-signzone\fR
-will retain the existing chain when re\-signing.
+will retain the existing chain when re\-signing\&.
.RE
.PP
\-v \fIlevel\fR
.RS 4
-Sets the debugging level.
+Sets the debugging level\&.
.RE
.PP
\-x
.RS 4
-Only sign the DNSKEY RRset with key\-signing keys, and omit signatures from zone\-signing keys. (This is similar to the
+Only sign the DNSKEY RRset with key\-signing keys, and omit signatures from zone\-signing keys\&. (This is similar to the
\fBdnssec\-dnskey\-kskonly yes;\fR
zone option in
-\fBnamed\fR.)
+\fBnamed\fR\&.)
.RE
.PP
\-z
.RS 4
-Ignore KSK flag on key when determining what to sign. This causes KSK\-flagged keys to sign all records, not just the DNSKEY RRset. (This is similar to the
+Ignore KSK flag on key when determining what to sign\&. This causes KSK\-flagged keys to sign all records, not just the DNSKEY RRset\&. (This is similar to the
\fBupdate\-check\-ksk no;\fR
zone option in
-\fBnamed\fR.)
+\fBnamed\fR\&.)
.RE
.PP
\-3 \fIsalt\fR
.RS 4
-Generate an NSEC3 chain with the given hex encoded salt. A dash (\fIsalt\fR) can be used to indicate that no salt is to be used when generating the NSEC3 chain.
+Generate an NSEC3 chain with the given hex encoded salt\&. A dash (\fIsalt\fR) can be used to indicate that no salt is to be used when generating the NSEC3 chain\&.
.RE
.PP
\-H \fIiterations\fR
.RS 4
-When generating an NSEC3 chain, use this many iterations. The default is 10.
+When generating an NSEC3 chain, use this many iterations\&. The default is 10\&.
.RE
.PP
\-A
.RS 4
-When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations.
+When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations\&.
.sp
-Using this option twice (i.e.,
-\fB\-AA\fR) turns the OPTOUT flag off for all records. This is useful when using the
+Using this option twice (i\&.e\&.,
+\fB\-AA\fR) turns the OPTOUT flag off for all records\&. This is useful when using the
\fB\-u\fR
-option to modify an NSEC3 chain which previously had OPTOUT set.
+option to modify an NSEC3 chain which previously had OPTOUT set\&.
.RE
.PP
zonefile
.RS 4
-The file containing the zone to be signed.
+The file containing the zone to be signed\&.
.RE
.PP
key
.RS 4
-Specify which keys should be used to sign the zone. If no keys are specified, then the zone will be examined for DNSKEY records at the zone apex. If these are found and there are matching private keys, in the current directory, then these will be used for signing.
+Specify which keys should be used to sign the zone\&. If no keys are specified, then the zone will be examined for DNSKEY records at the zone apex\&. If these are found and there are matching private keys, in the current directory, then these will be used for signing\&.
.RE
.SH "EXAMPLE"
.PP
The following command signs the
-\fBexample.com\fR
+\fBexample\&.com\fR
zone with the DSA key generated by
\fBdnssec\-keygen\fR
-(Kexample.com.+003+17247). Because the
+(Kexample\&.com\&.+003+17247)\&. Because the
\fB\-S\fR
-option is not being used, the zone's keys must be in the master file (\fIdb.example.com\fR). This invocation looks for
-\fIdsset\fR
-files, in the current directory, so that DS records can be imported from them (\fB\-g\fR).
+option is not being used, the zone\*(Aqs keys must be in the master file (db\&.example\&.com)\&. This invocation looks for
+dsset
+files, in the current directory, so that DS records can be imported from them (\fB\-g\fR)\&.
.sp
+.if n \{\
.RS 4
+.\}
.nf
-% dnssec\-signzone \-g \-o example.com db.example.com \\
-Kexample.com.+003+17247
-db.example.com.signed
+% dnssec\-signzone \-g \-o example\&.com db\&.example\&.com \e
+Kexample\&.com\&.+003+17247
+db\&.example\&.com\&.signed
%
.fi
+.if n \{\
.RE
+.\}
.PP
In the above example,
\fBdnssec\-signzone\fR
creates the file
-\fIdb.example.com.signed\fR. This file should be referenced in a zone statement in a
-\fInamed.conf\fR
-file.
+db\&.example\&.com\&.signed\&. This file should be referenced in a zone statement in a
+named\&.conf
+file\&.
.PP
-This example re\-signs a previously signed zone with default parameters. The private keys are assumed to be in the current directory.
+This example re\-signs a previously signed zone with default parameters\&. The private keys are assumed to be in the current directory\&.
.sp
+.if n \{\
.RS 4
+.\}
.nf
-% cp db.example.com.signed db.example.com
-% dnssec\-signzone \-o example.com db.example.com
-db.example.com.signed
+% cp db\&.example\&.com\&.signed db\&.example\&.com
+% dnssec\-signzone \-o example\&.com db\&.example\&.com
+db\&.example\&.com\&.signed
%
.fi
+.if n \{\
.RE
+.\}
.SH "SEE ALSO"
.PP
-\fBdnssec\-keygen\fR(8),
+\fBdnssec-keygen\fR(8),
BIND 9 Administrator Reference Manual,
RFC 4033,
-RFC 4641.
+RFC 4641\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004\-2009, 2011\-2014 Internet Systems Consortium, Inc. ("ISC")
.br
-Copyright \(co 2000\-2003 Internet Software Consortium.
+Copyright \(co 2004-2009, 2011-2014 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2000-2003 Internet Software Consortium.
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-signzone">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-signzone</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-signzone">
<a name="man.dnssec-signzone"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-signzone</span> — DNSSEC zone signing tool</p>
+<p>
+ <span class="application">dnssec-signzone</span>
+ — DNSSEC zone signing tool
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-signzone</code> [<code class="option">-a</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-d <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-D</code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-e <em class="replaceable"><code>end-time</code></em></code>] [<code class="option">-f <em class="replaceable"><code>output-file</code></em></code>] [<code class="option">-g</code>] [<code class="option">-h</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-k <em class="replaceable"><code>key</code></em></code>] [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>] [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-M <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-I <em class="replaceable"><code>input-format</code></em></code>] [<code class="option">-j <em class="replaceable"><code>jitter</code></em></code>] [<code class="option">-N <em class="replaceable"><code>soa-serial-format</code></em></code>] [<code class="option">-o <em class="replaceable"><code>origin</code></em></code>] [<code class="option">-O <em class="replaceable"><code>output-format</code></em></code>] [<code class="option">-P</code>] [<code class="option">-p</code>] [<code class="option">-Q</code>] [<code class="option">-R</code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S</code>] [<code class="option">-s <em class="replaceable"><code>start-time</code></em></code>] [<code class="option">-T <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-t</code>] [<code class="option">-u</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-X <em class="replaceable"><code>extended end-time</code></em></code>] [<code class="option">-x</code>] [<code class="option">-z</code>] [<code class="option">-3 <em class="replaceable"><code>salt</code></em></code>] [<code class="option">-H <em class="replaceable"><code>iterations</code></em></code>] [<code class="option">-A</code>] {zonefile} [key...]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543660"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-signzone</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-signzone</code>
+ [<code class="option">-a</code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-d <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-D</code>]
+ [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>]
+ [<code class="option">-e <em class="replaceable"><code>end-time</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>output-file</code></em></code>]
+ [<code class="option">-g</code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-k <em class="replaceable"><code>key</code></em></code>]
+ [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>]
+ [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>]
+ [<code class="option">-M <em class="replaceable"><code>domain</code></em></code>]
+ [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>]
+ [<code class="option">-I <em class="replaceable"><code>input-format</code></em></code>]
+ [<code class="option">-j <em class="replaceable"><code>jitter</code></em></code>]
+ [<code class="option">-N <em class="replaceable"><code>soa-serial-format</code></em></code>]
+ [<code class="option">-o <em class="replaceable"><code>origin</code></em></code>]
+ [<code class="option">-O <em class="replaceable"><code>output-format</code></em></code>]
+ [<code class="option">-P</code>]
+ [<code class="option">-p</code>]
+ [<code class="option">-Q</code>]
+ [<code class="option">-R</code>]
+ [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>]
+ [<code class="option">-S</code>]
+ [<code class="option">-s <em class="replaceable"><code>start-time</code></em></code>]
+ [<code class="option">-T <em class="replaceable"><code>ttl</code></em></code>]
+ [<code class="option">-t</code>]
+ [<code class="option">-u</code>]
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-V</code>]
+ [<code class="option">-X <em class="replaceable"><code>extended end-time</code></em></code>]
+ [<code class="option">-x</code>]
+ [<code class="option">-z</code>]
+ [<code class="option">-3 <em class="replaceable"><code>salt</code></em></code>]
+ [<code class="option">-H <em class="replaceable"><code>iterations</code></em></code>]
+ [<code class="option">-A</code>]
+ {zonefile}
+ [key...]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61133136"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-signzone</strong></span>
signs a zone. It generates
NSEC and RRSIG records and produces a signed version of the
zone. The security status of delegations from the signed zone
determined by the presence or absence of a
<code class="filename">keyset</code> file for each child zone.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543675"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61135184"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-a</span></dt>
-<dd><p>
+<dd>
+ <p>
Verify all generated signatures.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the DNS class of the zone.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-C</span></dt>
-<dd><p>
+<dd>
+ <p>
Compatibility mode: Generate a
<code class="filename">keyset-<em class="replaceable"><code>zonename</code></em></code>
file in addition to
<code class="filename">dsset-<em class="replaceable"><code>zonename</code></em></code>
when signing a zone, for use by older versions of
- <span><strong class="command">dnssec-signzone</strong></span>.
- </p></dd>
+ <span class="command"><strong>dnssec-signzone</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-d <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Look for <code class="filename">dsset-</code> or
<code class="filename">keyset-</code> files in <code class="option">directory</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-D</span></dt>
-<dd><p>
+<dd>
+ <p>
Output only those record types automatically managed by
- <span><strong class="command">dnssec-signzone</strong></span>, i.e. RRSIG, NSEC,
+ <span class="command"><strong>dnssec-signzone</strong></span>, i.e. RRSIG, NSEC,
NSEC3 and NSEC3PARAM records. If smart signing
(<code class="option">-S</code>) is used, DNSKEY records are also
included. The resulting file can be included in the original
- zone file with <span><strong class="command">$INCLUDE</strong></span>. This option
+ zone file with <span class="command"><strong>$INCLUDE</strong></span>. This option
cannot be combined with <code class="option">-O raw</code>,
<code class="option">-O map</code>, or serial number updating.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
<dd>
-<p>
+ <p>
When applicable, specifies the hardware to use for
cryptographic operations, such as a secure key store used
for signing.
</p>
-<p>
+ <p>
When BIND is built with OpenSSL PKCS#11 support, this defaults
to the string "pkcs11", which identifies an OpenSSL engine
that can drive a cryptographic accelerator or hardware service
(--enable-native-pkcs11), it defaults to the path of the PKCS#11
provider library specified via "--with-pkcs11".
</p>
-</dd>
+ </dd>
<dt><span class="term">-g</span></dt>
-<dd><p>
+<dd>
+ <p>
Generate DS records for child zones from
<code class="filename">dsset-</code> or <code class="filename">keyset-</code>
file. Existing DS records will be removed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Key repository: Specify a directory to search for DNSSEC keys.
If not specified, defaults to the current directory.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-k <em class="replaceable"><code>key</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Treat specified key as a key signing key ignoring any
key flags. This option may be specified multiple times.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Generate a DLV set in addition to the key (DNSKEY) and DS sets.
The domain is appended to the name of the records.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-M <em class="replaceable"><code>maxttl</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the maximum TTL for the signed zone.
Any TTL higher than <em class="replaceable"><code>maxttl</code></em> in the
input zone will be reduced to <em class="replaceable"><code>maxttl</code></em>
<code class="option">max-zone-ttl</code> in <code class="filename">named.conf</code>.
(Note: This option is incompatible with <code class="option">-D</code>,
because it modifies non-DNSSEC data in the output zone.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-s <em class="replaceable"><code>start-time</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify the date and time when the generated RRSIG records
become valid. This can be either an absolute or relative
time. An absolute start time is indicated by a number
indicated by +N, which is N seconds from the current time.
If no <code class="option">start-time</code> is specified, the current
time minus 1 hour (to allow for clock skew) is used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-e <em class="replaceable"><code>end-time</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify the date and time when the generated RRSIG records
expire. As with <code class="option">start-time</code>, an absolute
time is indicated in YYYYMMDDHHMMSS notation. A time relative
specified, 30 days from the start time is used as a default.
<code class="option">end-time</code> must be later than
<code class="option">start-time</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-X <em class="replaceable"><code>extended end-time</code></em></span></dt>
<dd>
-<p>
+ <p>
Specify the date and time when the generated RRSIG records
for the DNSKEY RRset will expire. This is to be used in cases
when the DNSKEY signatures need to persist longer than
of the KSK is kept offline and the KSK signature is to be
refreshed manually.
</p>
-<p>
+ <p>
As with <code class="option">start-time</code>, an absolute
time is indicated in YYYYMMDDHHMMSS notation. A time relative
to the start time is indicated with +N, which is N seconds from
30 days from the start time.) <code class="option">extended end-time</code>
must be later than <code class="option">start-time</code>.
</p>
-</dd>
+ </dd>
<dt><span class="term">-f <em class="replaceable"><code>output-file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The name of the output file containing the signed zone. The
default is to append <code class="filename">.signed</code> to
the input filename. If <code class="option">output-file</code> is
set to <code class="literal">"-"</code>, then the signed zone is
written to the standard output, with a default output
format of "full".
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-h</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints a short summary of the options and arguments to
- <span><strong class="command">dnssec-signzone</strong></span>.
- </p></dd>
+ <span class="command"><strong>dnssec-signzone</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints version information.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
<dd>
-<p>
+ <p>
When a previously-signed zone is passed as input, records
may be resigned. The <code class="option">interval</code> option
specifies the cycle interval as an offset from the current
cycle interval, it is retained. Otherwise, it is considered
to be expiring soon, and it will be replaced.
</p>
-<p>
+ <p>
The default cycle interval is one quarter of the difference
between the signature end and start times. So if neither
<code class="option">end-time</code> or <code class="option">start-time</code>
- are specified, <span><strong class="command">dnssec-signzone</strong></span>
+ are specified, <span class="command"><strong>dnssec-signzone</strong></span>
generates
signatures that are valid for 30 days, with a cycle
interval of 7.5 days. Therefore, if any existing RRSIG records
are due to expire in less than 7.5 days, they would be
replaced.
</p>
-</dd>
+ </dd>
<dt><span class="term">-I <em class="replaceable"><code>input-format</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The format of the input zone file.
- Possible formats are <span><strong class="command">"text"</strong></span> (default),
- <span><strong class="command">"raw"</strong></span>, and <span><strong class="command">"map"</strong></span>.
+ Possible formats are <span class="command"><strong>"text"</strong></span> (default),
+ <span class="command"><strong>"raw"</strong></span>, and <span class="command"><strong>"map"</strong></span>.
This option is primarily intended to be used for dynamic
signed zones so that the dumped zone file in a non-text
format containing updates can be signed directly.
The use of this option does not make much sense for
non-dynamic zones.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-j <em class="replaceable"><code>jitter</code></em></span></dt>
<dd>
-<p>
+ <p>
When signing a zone with a fixed signature lifetime, all
RRSIG records issued at the time of signing expires
simultaneously. If the zone is incrementally signed, i.e.
expire time, thus spreading incremental signature
regeneration over time.
</p>
-<p>
+ <p>
Signature lifetime jitter also to some extent benefits
validators and servers by spreading out cache expiration,
i.e. if large numbers of RRSIGs don't expire at the same time
from all caches there will be less congestion than if all
validators need to refetch at mostly the same time.
</p>
-</dd>
+ </dd>
<dt><span class="term">-L <em class="replaceable"><code>serial</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
When writing a signed zone to "raw" or "map" format, set the
"source serial" value in the header to the specified serial
number. (This is expected to be used primarily for testing
purposes.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-n <em class="replaceable"><code>ncpus</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the number of threads to use. By default, one
thread is started for each detected CPU.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-N <em class="replaceable"><code>soa-serial-format</code></em></span></dt>
<dd>
-<p>
+ <p>
The SOA serial number format of the signed zone.
- Possible formats are <span><strong class="command">"keep"</strong></span> (default),
- <span><strong class="command">"increment"</strong></span>, <span><strong class="command">"unixtime"</strong></span>,
- and <span><strong class="command">"date"</strong></span>.
- </p>
-<div class="variablelist"><dl>
-<dt><span class="term"><span><strong class="command">"keep"</strong></span></span></dt>
-<dd><p>Do not modify the SOA serial number.</p></dd>
-<dt><span class="term"><span><strong class="command">"increment"</strong></span></span></dt>
-<dd><p>Increment the SOA serial number using RFC 1982
- arithmetics.</p></dd>
-<dt><span class="term"><span><strong class="command">"unixtime"</strong></span></span></dt>
-<dd><p>Set the SOA serial number to the number of seconds
- since epoch.</p></dd>
-<dt><span class="term"><span><strong class="command">"date"</strong></span></span></dt>
-<dd><p>Set the SOA serial number to today's date in
- YYYYMMDDNN format.</p></dd>
+ Possible formats are <span class="command"><strong>"keep"</strong></span> (default),
+ <span class="command"><strong>"increment"</strong></span>, <span class="command"><strong>"unixtime"</strong></span>,
+ and <span class="command"><strong>"date"</strong></span>.
+ </p>
+
+ <div class="variablelist"><dl>
+<dt><span class="term"><span class="command"><strong>"keep"</strong></span></span></dt>
+<dd>
+ <p>Do not modify the SOA serial number.</p>
+ </dd>
+<dt><span class="term"><span class="command"><strong>"increment"</strong></span></span></dt>
+<dd>
+ <p>Increment the SOA serial number using RFC 1982
+ arithmetics.</p>
+ </dd>
+<dt><span class="term"><span class="command"><strong>"unixtime"</strong></span></span></dt>
+<dd>
+ <p>Set the SOA serial number to the number of seconds
+ since epoch.</p>
+ </dd>
+<dt><span class="term"><span class="command"><strong>"date"</strong></span></span></dt>
+<dd>
+ <p>Set the SOA serial number to today's date in
+ YYYYMMDDNN format.</p>
+ </dd>
</dl></div>
-</dd>
+
+ </dd>
<dt><span class="term">-o <em class="replaceable"><code>origin</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The zone origin. If not specified, the name of the zone file
is assumed to be the origin.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-O <em class="replaceable"><code>output-format</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The format of the output file containing the signed zone.
- Possible formats are <span><strong class="command">"text"</strong></span> (default),
+ Possible formats are <span class="command"><strong>"text"</strong></span> (default),
which is the standard textual representation of the zone;
- <span><strong class="command">"full"</strong></span>, which is text output in a
+ <span class="command"><strong>"full"</strong></span>, which is text output in a
format suitable for processing by external scripts;
- and <span><strong class="command">"map"</strong></span>, <span><strong class="command">"raw"</strong></span>,
- and <span><strong class="command">"raw=N"</strong></span>, which store the zone in
- binary formats for rapid loading by <span><strong class="command">named</strong></span>.
- <span><strong class="command">"raw=N"</strong></span> specifies the format version of
+ and <span class="command"><strong>"map"</strong></span>, <span class="command"><strong>"raw"</strong></span>,
+ and <span class="command"><strong>"raw=N"</strong></span>, which store the zone in
+ binary formats for rapid loading by <span class="command"><strong>named</strong></span>.
+ <span class="command"><strong>"raw=N"</strong></span> specifies the format version of
the raw zone file: if N is 0, the raw file can be read by
- any version of <span><strong class="command">named</strong></span>; if N is 1, the file
+ any version of <span class="command"><strong>named</strong></span>; if N is 1, the file
can be read by release 9.9.0 or higher; the default is 1.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p</span></dt>
-<dd><p>
+<dd>
+ <p>
Use pseudo-random data when signing the zone. This is faster,
but less secure, than using real random data. This option
may be useful when signing large zones or when the entropy
source is limited.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-P</span></dt>
<dd>
-<p>
+ <p>
Disable post sign verification tests.
</p>
-<p>
+ <p>
The post sign verification test ensures that for each algorithm
in use there is at least one non revoked self signed KSK key,
that all revoked KSK keys are self signed, and that all records
in the zone are signed by the algorithm.
This option skips these tests.
</p>
-</dd>
+ </dd>
<dt><span class="term">-Q</span></dt>
<dd>
-<p>
+ <p>
Remove signatures from keys that are no longer active.
</p>
-<p>
+ <p>
Normally, when a previously-signed zone is passed as input
to the signer, and a DNSKEY record has been removed and
replaced with a new one, signatures from the old key
that are still within their validity period are retained.
This allows the zone to continue to validate with cached
copies of the old DNSKEY RRset. The <code class="option">-Q</code>
- forces <span><strong class="command">dnssec-signzone</strong></span> to remove
+ forces <span class="command"><strong>dnssec-signzone</strong></span> to remove
signatures from keys that are no longer active. This
enables ZSK rollover using the procedure described in
RFC 4641, section 4.2.1.1 ("Pre-Publish Key Rollover").
</p>
-</dd>
+ </dd>
<dt><span class="term">-R</span></dt>
<dd>
-<p>
+ <p>
Remove signatures from keys that are no longer published.
</p>
-<p>
+ <p>
This option is similar to <code class="option">-Q</code>, except it
- forces <span><strong class="command">dnssec-signzone</strong></span> to signatures from
+ forces <span class="command"><strong>dnssec-signzone</strong></span> to signatures from
keys that are no longer published. This enables ZSK rollover
using the procedure described in RFC 4641, section 4.2.1.2
("Double Signature Zone Signing Key Rollover").
</p>
-</dd>
+ </dd>
<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the source of randomness. If the operating
system does not provide a <code class="filename">/dev/random</code>
or equivalent device, the default source of randomness
data to be used instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard
input should be used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-S</span></dt>
<dd>
-<p>
- Smart signing: Instructs <span><strong class="command">dnssec-signzone</strong></span> to
+ <p>
+ Smart signing: Instructs <span class="command"><strong>dnssec-signzone</strong></span> to
search the key repository for keys that match the zone being
signed, and to include them in the zone if appropriate.
</p>
-<p>
+ <p>
When a key is found, its timing metadata is examined to
determine how it should be used, according to the following
rules. Each successive rule takes priority over the prior
ones:
</p>
-<div class="variablelist"><dl>
+ <div class="variablelist"><dl>
<dt></dt>
-<dd><p>
+<dd>
+ <p>
If no timing metadata has been set for the key, the key is
published in the zone and used to sign the zone.
- </p></dd>
+ </p>
+ </dd>
<dt></dt>
-<dd><p>
+<dd>
+ <p>
If the key's publication date is set and is in the past, the
key is published in the zone.
- </p></dd>
+ </p>
+ </dd>
<dt></dt>
-<dd><p>
+<dd>
+ <p>
If the key's activation date is set and in the past, the
key is published (regardless of publication date) and
used to sign the zone.
- </p></dd>
+ </p>
+ </dd>
<dt></dt>
-<dd><p>
+<dd>
+ <p>
If the key's revocation date is set and in the past, and the
key is published, then the key is revoked, and the revoked key
is used to sign the zone.
- </p></dd>
+ </p>
+ </dd>
<dt></dt>
-<dd><p>
+<dd>
+ <p>
If either of the key's unpublication or deletion dates are set
and in the past, the key is NOT published or used to sign the
zone, regardless of any other metadata.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</dd>
+ </dd>
<dt><span class="term">-T <em class="replaceable"><code>ttl</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies a TTL to be used for new DNSKEY records imported
into the zone from the key repository. If not
specified, the default is the TTL value from the zone's SOA
them, or if any of the imported DNSKEY records had a default
TTL value. In the event of a a conflict between TTL values in
imported keys, the shortest one is used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-t</span></dt>
-<dd><p>
+<dd>
+ <p>
Print statistics at completion.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-u</span></dt>
-<dd><p>
+<dd>
+ <p>
Update NSEC/NSEC3 chain when re-signing a previously signed
zone. With this option, a zone signed with NSEC can be
switched to NSEC3, or a zone signed with NSEC3 can
be switch to NSEC or to NSEC3 with different parameters.
- Without this option, <span><strong class="command">dnssec-signzone</strong></span> will
+ Without this option, <span class="command"><strong>dnssec-signzone</strong></span> will
retain the existing chain when re-signing.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the debugging level.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-x</span></dt>
-<dd><p>
+<dd>
+ <p>
Only sign the DNSKEY RRset with key-signing keys, and omit
signatures from zone-signing keys. (This is similar to the
- <span><strong class="command">dnssec-dnskey-kskonly yes;</strong></span> zone option in
- <span><strong class="command">named</strong></span>.)
- </p></dd>
+ <span class="command"><strong>dnssec-dnskey-kskonly yes;</strong></span> zone option in
+ <span class="command"><strong>named</strong></span>.)
+ </p>
+ </dd>
<dt><span class="term">-z</span></dt>
-<dd><p>
+<dd>
+ <p>
Ignore KSK flag on key when determining what to sign. This
causes KSK-flagged keys to sign all records, not just the
DNSKEY RRset. (This is similar to the
- <span><strong class="command">update-check-ksk no;</strong></span> zone option in
- <span><strong class="command">named</strong></span>.)
- </p></dd>
+ <span class="command"><strong>update-check-ksk no;</strong></span> zone option in
+ <span class="command"><strong>named</strong></span>.)
+ </p>
+ </dd>
<dt><span class="term">-3 <em class="replaceable"><code>salt</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Generate an NSEC3 chain with the given hex encoded salt.
A dash (<em class="replaceable"><code>salt</code></em>) can
be used to indicate that no salt is to be used when generating the NSEC3 chain.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-H <em class="replaceable"><code>iterations</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
When generating an NSEC3 chain, use this many iterations. The
default is 10.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-A</span></dt>
<dd>
-<p>
+ <p>
When generating an NSEC3 chain set the OPTOUT flag on all
NSEC3 records and do not generate NSEC3 records for insecure
delegations.
</p>
-<p>
+ <p>
Using this option twice (i.e., <code class="option">-AA</code>)
turns the OPTOUT flag off for all records. This is useful
when using the <code class="option">-u</code> option to modify an NSEC3
chain which previously had OPTOUT set.
</p>
-</dd>
+ </dd>
<dt><span class="term">zonefile</span></dt>
-<dd><p>
+<dd>
+ <p>
The file containing the zone to be signed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">key</span></dt>
-<dd><p>
+<dd>
+ <p>
Specify which keys should be used to sign the zone. If
no keys are specified, then the zone will be examined
for DNSKEY records at the zone apex. If these are found and
there are matching private keys, in the current directory,
then these will be used for signing.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545262"></a><h2>EXAMPLE</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="EXAMPLE">
+<a name="idp61268944"></a><h2>EXAMPLE</h2>
+
+ <p>
The following command signs the <strong class="userinput"><code>example.com</code></strong>
- zone with the DSA key generated by <span><strong class="command">dnssec-keygen</strong></span>
- (Kexample.com.+003+17247). Because the <span><strong class="command">-S</strong></span> option
+ zone with the DSA key generated by <span class="command"><strong>dnssec-keygen</strong></span>
+ (Kexample.com.+003+17247). Because the <span class="command"><strong>-S</strong></span> option
is not being used, the zone's keys must be in the master file
(<code class="filename">db.example.com</code>). This invocation looks
for <code class="filename">dsset</code> files, in the current directory,
- so that DS records can be imported from them (<span><strong class="command">-g</strong></span>).
+ so that DS records can be imported from them (<span class="command"><strong>-g</strong></span>).
</p>
<pre class="programlisting">% dnssec-signzone -g -o example.com db.example.com \
Kexample.com.+003+17247
db.example.com.signed
%</pre>
-<p>
- In the above example, <span><strong class="command">dnssec-signzone</strong></span> creates
+ <p>
+ In the above example, <span class="command"><strong>dnssec-signzone</strong></span> creates
the file <code class="filename">db.example.com.signed</code>. This
file should be referenced in a zone statement in a
<code class="filename">named.conf</code> file.
</p>
-<p>
+ <p>
This example re-signs a previously signed zone with default parameters.
The private keys are assumed to be in the current directory.
</p>
% dnssec-signzone -o example.com db.example.com
db.example.com.signed
%</pre>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545318"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61279696"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 4033</em>, <em class="citetitle">RFC 4641</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545414"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-verify
+'\" t
+.\" Title: dnssec-verify
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 15, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-01-15
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-VERIFY" "8" "January 15, 2014" "BIND9" "BIND9"
+.TH "DNSSEC\-VERIFY" "8" "2014\-01\-15" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-verify \- DNSSEC zone verification tool
+dnssec-verify \- DNSSEC zone verification tool
.SH "SYNOPSIS"
.HP 14
\fBdnssec\-verify\fR [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-x\fR] [\fB\-z\fR] {zonefile}
.SH "DESCRIPTION"
.PP
\fBdnssec\-verify\fR
-verifies that a zone is fully signed for each algorithm found in the DNSKEY RRset for the zone, and that the NSEC / NSEC3 chains are complete.
+verifies that a zone is fully signed for each algorithm found in the DNSKEY RRset for the zone, and that the NSEC / NSEC3 chains are complete\&.
.SH "OPTIONS"
.PP
\-c \fIclass\fR
.RS 4
-Specifies the DNS class of the zone.
+Specifies the DNS class of the zone\&.
.RE
.PP
\-E \fIengine\fR
.RS 4
-Specifies the cryptographic hardware to use, when applicable.
+Specifies the cryptographic hardware to use, when applicable\&.
.sp
-When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11".
+When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&.
.RE
.PP
\-I \fIinput\-format\fR
.RS 4
-The format of the input zone file. Possible formats are
+The format of the input zone file\&. Possible formats are
\fB"text"\fR
(default) and
-\fB"raw"\fR. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be verified independently. The use of this option does not make much sense for non\-dynamic zones.
+\fB"raw"\fR\&. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be verified independently\&. The use of this option does not make much sense for non\-dynamic zones\&.
.RE
.PP
\-o \fIorigin\fR
.RS 4
-The zone origin. If not specified, the name of the zone file is assumed to be the origin.
+The zone origin\&. If not specified, the name of the zone file is assumed to be the origin\&.
.RE
.PP
\-v \fIlevel\fR
.RS 4
-Sets the debugging level.
+Sets the debugging level\&.
.RE
.PP
\-V
.RS 4
-Prints version information.
+Prints version information\&.
.RE
.PP
\-x
.RS 4
-Only verify that the DNSKEY RRset is signed with key\-signing keys. Without this flag, it is assumed that the DNSKEY RRset will be signed by all active keys. When this flag is set, it will not be an error if the DNSKEY RRset is not signed by zone\-signing keys. This corresponds to the
+Only verify that the DNSKEY RRset is signed with key\-signing keys\&. Without this flag, it is assumed that the DNSKEY RRset will be signed by all active keys\&. When this flag is set, it will not be an error if the DNSKEY RRset is not signed by zone\-signing keys\&. This corresponds to the
\fB\-x\fR
option in
-\fBdnssec\-signzone\fR.
+\fBdnssec\-signzone\fR\&.
.RE
.PP
\-z
.RS 4
-Ignore the KSK flag on the keys when determining whether the zone if correctly signed. Without this flag it is assumed that there will be a non\-revoked, self\-signed DNSKEY with the KSK flag set for each algorithm and that RRsets other than DNSKEY RRset will be signed with a different DNSKEY without the KSK flag set.
+Ignore the KSK flag on the keys when determining whether the zone if correctly signed\&. Without this flag it is assumed that there will be a non\-revoked, self\-signed DNSKEY with the KSK flag set for each algorithm and that RRsets other than DNSKEY RRset will be signed with a different DNSKEY without the KSK flag set\&.
.sp
-With this flag set, we only require that for each algorithm, there will be at least one non\-revoked, self\-signed DNSKEY, regardless of the KSK flag state, and that other RRsets will be signed by a non\-revoked key for the same algorithm that includes the self\-signed key; the same key may be used for both purposes. This corresponds to the
+With this flag set, we only require that for each algorithm, there will be at least one non\-revoked, self\-signed DNSKEY, regardless of the KSK flag state, and that other RRsets will be signed by a non\-revoked key for the same algorithm that includes the self\-signed key; the same key may be used for both purposes\&. This corresponds to the
\fB\-z\fR
option in
-\fBdnssec\-signzone\fR.
+\fBdnssec\-signzone\fR\&.
.RE
.PP
zonefile
.RS 4
-The file containing the zone to be signed.
+The file containing the zone to be signed\&.
.RE
.SH "SEE ALSO"
.PP
-\fBdnssec\-signzone\fR(8),
+\fBdnssec-signzone\fR(8),
BIND 9 Administrator Reference Manual,
-RFC 4033.
+RFC 4033\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2012, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-verify">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-verify</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-verify">
<a name="man.dnssec-verify"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-verify</span> — DNSSEC zone verification tool</p>
+<p>
+ <span class="application">dnssec-verify</span>
+ — DNSSEC zone verification tool
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-verify</code> [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-I <em class="replaceable"><code>input-format</code></em></code>] [<code class="option">-o <em class="replaceable"><code>origin</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-x</code>] [<code class="option">-z</code>] {zonefile}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543405"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-verify</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-verify</code>
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>]
+ [<code class="option">-I <em class="replaceable"><code>input-format</code></em></code>]
+ [<code class="option">-o <em class="replaceable"><code>origin</code></em></code>]
+ [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
+ [<code class="option">-V</code>]
+ [<code class="option">-x</code>]
+ [<code class="option">-z</code>]
+ {zonefile}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60927696"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-verify</strong></span>
verifies that a zone is fully signed for each algorithm found
in the DNSKEY RRset for the zone, and that the NSEC / NSEC3
chains are complete.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543417"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60929360"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies the DNS class of the zone.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
<dd>
-<p>
+ <p>
Specifies the cryptographic hardware to use, when applicable.
</p>
-<p>
+ <p>
When BIND is built with OpenSSL PKCS#11 support, this defaults
to the string "pkcs11", which identifies an OpenSSL engine
that can drive a cryptographic accelerator or hardware service
(--enable-native-pkcs11), it defaults to the path of the PKCS#11
provider library specified via "--with-pkcs11".
</p>
-</dd>
+ </dd>
<dt><span class="term">-I <em class="replaceable"><code>input-format</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The format of the input zone file.
- Possible formats are <span><strong class="command">"text"</strong></span> (default)
- and <span><strong class="command">"raw"</strong></span>.
+ Possible formats are <span class="command"><strong>"text"</strong></span> (default)
+ and <span class="command"><strong>"raw"</strong></span>.
This option is primarily intended to be used for dynamic
signed zones so that the dumped zone file in a non-text
format containing updates can be verified independently.
The use of this option does not make much sense for
non-dynamic zones.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-o <em class="replaceable"><code>origin</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The zone origin. If not specified, the name of the zone file
is assumed to be the origin.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the debugging level.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints version information.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-x</span></dt>
-<dd><p>
+<dd>
+ <p>
Only verify that the DNSKEY RRset is signed with key-signing
keys. Without this flag, it is assumed that the DNSKEY RRset
will be signed by all active keys. When this flag is set,
it will not be an error if the DNSKEY RRset is not signed
by zone-signing keys. This corresponds to the <code class="option">-x</code>
- option in <span><strong class="command">dnssec-signzone</strong></span>.
- </p></dd>
+ option in <span class="command"><strong>dnssec-signzone</strong></span>.
+ </p>
+ </dd>
<dt><span class="term">-z</span></dt>
<dd>
-<p>
+ <p>
Ignore the KSK flag on the keys when determining whether
the zone if correctly signed. Without this flag it is
assumed that there will be a non-revoked, self-signed
that RRsets other than DNSKEY RRset will be signed with
a different DNSKEY without the KSK flag set.
</p>
-<p>
+ <p>
With this flag set, we only require that for each algorithm,
there will be at least one non-revoked, self-signed DNSKEY,
regardless of the KSK flag state, and that other RRsets
will be signed by a non-revoked key for the same algorithm
that includes the self-signed key; the same key may be used
for both purposes. This corresponds to the <code class="option">-z</code>
- option in <span><strong class="command">dnssec-signzone</strong></span>.
+ option in <span class="command"><strong>dnssec-signzone</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term">zonefile</span></dt>
-<dd><p>
+<dd>
+ <p>
The file containing the zone to be signed.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543660"></a><h2>SEE ALSO</h2>
-<p>
- <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60954192"></a><h2>SEE ALSO</h2>
+
+ <p>
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-signzone</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 4033</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543686"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwresd
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 20, 2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2009-01-20
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRESD" "8" "January 20, 2009" "BIND9" "BIND9"
+.TH "LWRESD" "8" "2009\-01\-20" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwresd \- lightweight resolver daemon
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBlwresd\fR
-is the daemon providing name lookup services to clients that use the BIND 9 lightweight resolver library. It is essentially a stripped\-down, caching\-only name server that answers queries using the BIND 9 lightweight resolver protocol rather than the DNS protocol.
+is the daemon providing name lookup services to clients that use the BIND 9 lightweight resolver library\&. It is essentially a stripped\-down, caching\-only name server that answers queries using the BIND 9 lightweight resolver protocol rather than the DNS protocol\&.
.PP
\fBlwresd\fR
-listens for resolver queries on a UDP port on the IPv4 loopback interface, 127.0.0.1. This means that
+listens for resolver queries on a UDP port on the IPv4 loopback interface, 127\&.0\&.0\&.1\&. This means that
\fBlwresd\fR
-can only be used by processes running on the local machine. By default, UDP port number 921 is used for lightweight resolver requests and responses.
+can only be used by processes running on the local machine\&. By default, UDP port number 921 is used for lightweight resolver requests and responses\&.
.PP
-Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol. When the DNS lookup completes,
+Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol\&. When the DNS lookup completes,
\fBlwresd\fR
-encodes the answers in the lightweight resolver format and returns them to the client that made the request.
+encodes the answers in the lightweight resolver format and returns them to the client that made the request\&.
.PP
If
-\fI/etc/resolv.conf\fR
+/etc/resolv\&.conf
contains any
\fBnameserver\fR
entries,
\fBlwresd\fR
-sends recursive DNS queries to those servers. This is similar to the use of forwarders in a caching name server. If no
+sends recursive DNS queries to those servers\&. This is similar to the use of forwarders in a caching name server\&. If no
\fBnameserver\fR
entries are present, or if forwarding fails,
\fBlwresd\fR
-resolves the queries autonomously starting at the root name servers, using a built\-in list of root server hints.
+resolves the queries autonomously starting at the root name servers, using a built\-in list of root server hints\&.
.SH "OPTIONS"
.PP
\-4
.RS 4
-Use IPv4 only even if the host machine is capable of IPv6.
+Use IPv4 only even if the host machine is capable of IPv6\&.
\fB\-4\fR
and
\fB\-6\fR
-are mutually exclusive.
+are mutually exclusive\&.
.RE
.PP
\-6
.RS 4
-Use IPv6 only even if the host machine is capable of IPv4.
+Use IPv6 only even if the host machine is capable of IPv4\&.
\fB\-4\fR
and
\fB\-6\fR
-are mutually exclusive.
+are mutually exclusive\&.
.RE
.PP
\-c \fIconfig\-file\fR
Use
\fIconfig\-file\fR
as the configuration file instead of the default,
-\fI/etc/lwresd.conf\fR.
+/etc/lwresd\&.conf\&.
\fB\-c\fR
can not be used with
-\fB\-C\fR.
+\fB\-C\fR\&.
.RE
.PP
\-C \fIconfig\-file\fR
Use
\fIconfig\-file\fR
as the configuration file instead of the default,
-\fI/etc/resolv.conf\fR.
+/etc/resolv\&.conf\&.
\fB\-C\fR
can not be used with
-\fB\-c\fR.
+\fB\-c\fR\&.
.RE
.PP
\-d \fIdebug\-level\fR
.RS 4
-Set the daemon's debug level to
-\fIdebug\-level\fR. Debugging traces from
+Set the daemon\*(Aqs debug level to
+\fIdebug\-level\fR\&. Debugging traces from
\fBlwresd\fR
-become more verbose as the debug level increases.
+become more verbose as the debug level increases\&.
.RE
.PP
\-f
.RS 4
-Run the server in the foreground (i.e. do not daemonize).
+Run the server in the foreground (i\&.e\&. do not daemonize)\&.
.RE
.PP
\-g
.RS 4
Run the server in the foreground and force all logging to
-\fIstderr\fR.
+stderr\&.
.RE
.PP
\-i \fIpid\-file\fR
Use
\fIpid\-file\fR
as the PID file instead of the default,
-\fI/var/run/lwresd/lwresd.pid\fR.
+/var/run/lwresd/lwresd\&.pid\&.
.RE
.PP
\-m \fIflag\fR
.RS 4
-Turn on memory usage debugging flags. Possible flags are
+Turn on memory usage debugging flags\&. Possible flags are
\fIusage\fR,
\fItrace\fR,
\fIrecord\fR,
\fIsize\fR, and
-\fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in
-\fI<isc/mem.h>\fR.
+\fImctx\fR\&. These correspond to the ISC_MEM_DEBUGXXXX flags described in
+<isc/mem\&.h>\&.
.RE
.PP
\-n \fI#cpus\fR
.RS 4
Create
\fI#cpus\fR
-worker threads to take advantage of multiple CPUs. If not specified,
+worker threads to take advantage of multiple CPUs\&. If not specified,
\fBlwresd\fR
-will try to determine the number of CPUs present and create one thread per CPU. If it is unable to determine the number of CPUs, a single worker thread will be created.
+will try to determine the number of CPUs present and create one thread per CPU\&. If it is unable to determine the number of CPUs, a single worker thread will be created\&.
.RE
.PP
\-P \fIport\fR
.RS 4
Listen for lightweight resolver queries on port
-\fIport\fR. If not specified, the default is port 921.
+\fIport\fR\&. If not specified, the default is port 921\&.
.RE
.PP
\-p \fIport\fR
.RS 4
Send DNS lookups to port
-\fIport\fR. If not specified, the default is port 53. This provides a way of testing the lightweight resolver daemon with a name server that listens for queries on a non\-standard port number.
+\fIport\fR\&. If not specified, the default is port 53\&. This provides a way of testing the lightweight resolver daemon with a name server that listens for queries on a non\-standard port number\&.
.RE
.PP
\-s
.RS 4
Write memory usage statistics to
-\fIstdout\fR
-on exit.
+stdout
+on exit\&.
.RS
.B "Note:"
-This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
+This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&.
.RE
.RE
.PP
.RS 4
Chroot to
\fIdirectory\fR
-after processing the command line arguments, but before reading the configuration file.
+after processing the command line arguments, but before reading the configuration file\&.
.RS
.B "Warning:"
This option should be used in conjunction with the
\fB\-u\fR
-option, as chrooting a process running as root doesn't enhance security on most systems; the way
+option, as chrooting a process running as root doesn\*(Aqt enhance security on most systems; the way
\fBchroot(2)\fR
-is defined allows a process with root privileges to escape a chroot jail.
+is defined allows a process with root privileges to escape a chroot jail\&.
.RE
.RE
.PP
.RS 4
Setuid to
\fIuser\fR
-after completing privileged operations, such as creating sockets that listen on privileged ports.
+after completing privileged operations, such as creating sockets that listen on privileged ports\&.
.RE
.PP
\-v
.RS 4
-Report the version number and exit.
+Report the version number and exit\&.
.RE
.SH "FILES"
.PP
-\fI/etc/resolv.conf\fR
+/etc/resolv\&.conf
.RS 4
-The default configuration file.
+The default configuration file\&.
.RE
.PP
-\fI/var/run/lwresd.pid\fR
+/var/run/lwresd\&.pid
.RS 4
-The default process\-id file.
+The default process\-id file\&.
.RE
.SH "SEE ALSO"
.PP
\fBnamed\fR(8),
\fBlwres\fR(3),
-\fBresolver\fR(5).
+\fBresolver\fR(5)\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004, 2005, 2007\-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2004, 2005, 2007-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.lwresd">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwresd</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwresd">
<a name="man.lwresd"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">lwresd</span> — lightweight resolver daemon</p>
+<p>
+ <span class="application">lwresd</span>
+ — lightweight resolver daemon
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">lwresd</code> [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-C <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>debug-level</code></em></code>] [<code class="option">-f</code>] [<code class="option">-g</code>] [<code class="option">-i <em class="replaceable"><code>pid-file</code></em></code>] [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-n <em class="replaceable"><code>#cpus</code></em></code>] [<code class="option">-P <em class="replaceable"><code>port</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-s</code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>] [<code class="option">-v</code>] [<code class="option">-4</code>] [<code class="option">-6</code>]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543484"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">lwresd</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">lwresd</code>
+ [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>]
+ [<code class="option">-C <em class="replaceable"><code>config-file</code></em></code>]
+ [<code class="option">-d <em class="replaceable"><code>debug-level</code></em></code>]
+ [<code class="option">-f</code>]
+ [<code class="option">-g</code>]
+ [<code class="option">-i <em class="replaceable"><code>pid-file</code></em></code>]
+ [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>]
+ [<code class="option">-n <em class="replaceable"><code>#cpus</code></em></code>]
+ [<code class="option">-P <em class="replaceable"><code>port</code></em></code>]
+ [<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
+ [<code class="option">-s</code>]
+ [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]
+ [<code class="option">-v</code>]
+ [<code class="option">-4</code>]
+ [<code class="option">-6</code>]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60990416"></a><h2>DESCRIPTION</h2>
+
+
+ <p><span class="command"><strong>lwresd</strong></span>
is the daemon providing name lookup
services to clients that use the BIND 9 lightweight resolver
library. It is essentially a stripped-down, caching-only name
server that answers queries using the BIND 9 lightweight
resolver protocol rather than the DNS protocol.
</p>
-<p><span><strong class="command">lwresd</strong></span>
+
+ <p><span class="command"><strong>lwresd</strong></span>
listens for resolver queries on a
UDP port on the IPv4 loopback interface, 127.0.0.1. This
- means that <span><strong class="command">lwresd</strong></span> can only be used by
+ means that <span class="command"><strong>lwresd</strong></span> can only be used by
processes running on the local machine. By default, UDP port
number 921 is used for lightweight resolver requests and
responses.
</p>
-<p>
+ <p>
Incoming lightweight resolver requests are decoded by the
server which then resolves them using the DNS protocol. When
- the DNS lookup completes, <span><strong class="command">lwresd</strong></span> encodes
+ the DNS lookup completes, <span class="command"><strong>lwresd</strong></span> encodes
the answers in the lightweight resolver format and returns
them to the client that made the request.
</p>
-<p>
+ <p>
If <code class="filename">/etc/resolv.conf</code> contains any
- <code class="option">nameserver</code> entries, <span><strong class="command">lwresd</strong></span>
+ <code class="option">nameserver</code> entries, <span class="command"><strong>lwresd</strong></span>
sends recursive DNS queries to those servers. This is similar
to the use of forwarders in a caching name server. If no
<code class="option">nameserver</code> entries are present, or if
- forwarding fails, <span><strong class="command">lwresd</strong></span> resolves the
+ forwarding fails, <span class="command"><strong>lwresd</strong></span> resolves the
queries autonomously starting at the root name servers, using
a built-in list of root server hints.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543531"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61000656"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-4</span></dt>
-<dd><p>
+<dd>
+ <p>
Use IPv4 only even if the host machine is capable of IPv6.
<code class="option">-4</code> and <code class="option">-6</code> are mutually
exclusive.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-6</span></dt>
-<dd><p>
+<dd>
+ <p>
Use IPv6 only even if the host machine is capable of IPv4.
<code class="option">-4</code> and <code class="option">-6</code> are mutually
exclusive.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Use <em class="replaceable"><code>config-file</code></em> as the
configuration file instead of the default,
<code class="filename">/etc/lwresd.conf</code>.
<code class="option">-c</code> can not be used with <code class="option">-C</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-C <em class="replaceable"><code>config-file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Use <em class="replaceable"><code>config-file</code></em> as the
configuration file instead of the default,
<code class="filename">/etc/resolv.conf</code>.
<code class="option">-C</code> can not be used with <code class="option">-c</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>.
- Debugging traces from <span><strong class="command">lwresd</strong></span> become
+ Debugging traces from <span class="command"><strong>lwresd</strong></span> become
more verbose as the debug level increases.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-f</span></dt>
-<dd><p>
+<dd>
+ <p>
Run the server in the foreground (i.e. do not daemonize).
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-g</span></dt>
-<dd><p>
+<dd>
+ <p>
Run the server in the foreground and force all logging
to <code class="filename">stderr</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-i <em class="replaceable"><code>pid-file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Use <em class="replaceable"><code>pid-file</code></em> as the
PID file instead of the default,
<code class="filename">/var/run/lwresd/lwresd.pid</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-m <em class="replaceable"><code>flag</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Turn on memory usage debugging flags. Possible flags are
<em class="replaceable"><code>usage</code></em>,
<em class="replaceable"><code>trace</code></em>,
<em class="replaceable"><code>mctx</code></em>.
These correspond to the ISC_MEM_DEBUGXXXX flags described in
<code class="filename"><isc/mem.h></code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Create <em class="replaceable"><code>#cpus</code></em> worker threads
to take advantage of multiple CPUs. If not specified,
- <span><strong class="command">lwresd</strong></span> will try to determine the
+ <span class="command"><strong>lwresd</strong></span> will try to determine the
number of CPUs present and create one thread per CPU.
If it is unable to determine the number of CPUs, a
single worker thread will be created.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-P <em class="replaceable"><code>port</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Listen for lightweight resolver queries on port
<em class="replaceable"><code>port</code></em>. If
not specified, the default is port 921.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Send DNS lookups to port <em class="replaceable"><code>port</code></em>. If not
specified, the default is port 53. This provides a
way of testing the lightweight resolver daemon with a
name server that listens for queries on a non-standard
port number.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-s</span></dt>
<dd>
-<p>
+ <p>
Write memory usage statistics to <code class="filename">stdout</code>
on exit.
</p>
-<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-<p>
+ <p>
This option is mainly of interest to BIND 9 developers
and may be removed or changed in a future release.
</p>
-</div>
-</dd>
+ </div>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
<dd>
-<p>Chroot
+ <p>Chroot
to <em class="replaceable"><code>directory</code></em> after
processing the command line arguments, but before
reading the configuration file.
</p>
-<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
-<p>
+ <p>
This option should be used in conjunction with the
<code class="option">-u</code> option, as chrooting a process
running as root doesn't enhance security on most
defined allows a process with root privileges to
escape a chroot jail.
</p>
-</div>
-</dd>
+ </div>
+ </dd>
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
-<dd><p>Setuid
+<dd>
+ <p>Setuid
to <em class="replaceable"><code>user</code></em> after completing
privileged operations, such as creating sockets that
listen on privileged ports.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v</span></dt>
-<dd><p>
+<dd>
+ <p>
Report the version number and exit.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543948"></a><h2>FILES</h2>
-<div class="variablelist"><dl>
+
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp61047760"></a><h2>FILES</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term"><code class="filename">/etc/resolv.conf</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The default configuration file.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="filename">/var/run/lwresd.pid</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The default process-id file.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543988"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>,
- <span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>.
+
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61052496"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres</span>(3)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">resolver</span>(5)
+ </span>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544022"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: named
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: February 19, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-02-19
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "NAMED" "8" "February 19, 2014" "BIND9" "BIND9"
+.TH "NAMED" "8" "2014\-02\-19" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
named \- Internet domain name server
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBnamed\fR
-is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC. For more information on the DNS, see RFCs 1033, 1034, and 1035.
+is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC\&. For more information on the DNS, see RFCs 1033, 1034, and 1035\&.
.PP
When invoked without arguments,
\fBnamed\fR
will read the default configuration file
-\fI/etc/named.conf\fR, read any initial data, and listen for queries.
+/etc/named\&.conf, read any initial data, and listen for queries\&.
.SH "OPTIONS"
.PP
\-4
.RS 4
-Use IPv4 only even if the host machine is capable of IPv6.
+Use IPv4 only even if the host machine is capable of IPv6\&.
\fB\-4\fR
and
\fB\-6\fR
-are mutually exclusive.
+are mutually exclusive\&.
.RE
.PP
\-6
.RS 4
-Use IPv6 only even if the host machine is capable of IPv4.
+Use IPv6 only even if the host machine is capable of IPv4\&.
\fB\-4\fR
and
\fB\-6\fR
-are mutually exclusive.
+are mutually exclusive\&.
.RE
.PP
\-c \fIconfig\-file\fR
Use
\fIconfig\-file\fR
as the configuration file instead of the default,
-\fI/etc/named.conf\fR. To ensure that reloading the configuration file continues to work after the server has changed its working directory due to to a possible
+/etc/named\&.conf\&. To ensure that reloading the configuration file continues to work after the server has changed its working directory due to to a possible
\fBdirectory\fR
option in the configuration file,
\fIconfig\-file\fR
-should be an absolute pathname.
+should be an absolute pathname\&.
.RE
.PP
\-d \fIdebug\-level\fR
.RS 4
-Set the daemon's debug level to
-\fIdebug\-level\fR. Debugging traces from
+Set the daemon\*(Aqs debug level to
+\fIdebug\-level\fR\&. Debugging traces from
\fBnamed\fR
-become more verbose as the debug level increases.
+become more verbose as the debug level increases\&.
.RE
.PP
\-D \fIstring\fR
.RS 4
Specifies a string that is used to identify a instance of
\fBnamed\fR
-in a process listing. The contents of
+in a process listing\&. The contents of
\fIstring\fR
-are not examined.
+are not examined\&.
.RE
.PP
\-E \fIengine\-name\fR
.RS 4
-When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing.
+When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing\&.
.sp
-When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11".
+When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&.
.RE
.PP
\-f
.RS 4
-Run the server in the foreground (i.e. do not daemonize).
+Run the server in the foreground (i\&.e\&. do not daemonize)\&.
.RE
.PP
\-g
.RS 4
Run the server in the foreground and force all logging to
-\fIstderr\fR.
+stderr\&.
.RE
.PP
\-L \fIlogfile\fR
.RS 4
Log to the file
\fBlogfile\fR
-by default instead of the system log.
+by default instead of the system log\&.
.RE
.PP
\-M \fIoption\fR
.RS 4
-Sets the default memory context options. Currently the only supported option is
-\fIexternal\fR, which causes the internal memory manager to be bypassed in favor of system\-provided memory allocation functions.
+Sets the default memory context options\&. Currently the only supported option is
+\fIexternal\fR, which causes the internal memory manager to be bypassed in favor of system\-provided memory allocation functions\&.
.RE
.PP
\-m \fIflag\fR
.RS 4
-Turn on memory usage debugging flags. Possible flags are
+Turn on memory usage debugging flags\&. Possible flags are
\fIusage\fR,
\fItrace\fR,
\fIrecord\fR,
\fIsize\fR, and
-\fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in
-\fI<isc/mem.h>\fR.
+\fImctx\fR\&. These correspond to the ISC_MEM_DEBUGXXXX flags described in
+<isc/mem\&.h>\&.
.RE
.PP
\-n \fI#cpus\fR
.RS 4
Create
\fI#cpus\fR
-worker threads to take advantage of multiple CPUs. If not specified,
+worker threads to take advantage of multiple CPUs\&. If not specified,
\fBnamed\fR
-will try to determine the number of CPUs present and create one thread per CPU. If it is unable to determine the number of CPUs, a single worker thread will be created.
+will try to determine the number of CPUs present and create one thread per CPU\&. If it is unable to determine the number of CPUs, a single worker thread will be created\&.
.RE
.PP
\-p \fIport\fR
.RS 4
Listen for queries on port
-\fIport\fR. If not specified, the default is port 53.
+\fIport\fR\&. If not specified, the default is port 53\&.
.RE
.PP
\-s
.RS 4
Write memory usage statistics to
-\fIstdout\fR
-on exit.
+stdout
+on exit\&.
.RS
.B "Note:"
-This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
+This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&.
.RE
.RE
.PP
\fBnamed\fR
to use up to
\fI#max\-socks\fR
-sockets. The default value is 4096 on systems built with default configuration options, and 21000 on systems built with "configure \-\-with\-tuning=large".
+sockets\&. The default value is 4096 on systems built with default configuration options, and 21000 on systems built with "configure \-\-with\-tuning=large"\&.
.RS
.B "Warning:"
-This option should be unnecessary for the vast majority of users. The use of this option could even be harmful because the specified value may exceed the limitation of the underlying system API. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets. Note also that the actual maximum number is normally a little fewer than the specified value because
+This option should be unnecessary for the vast majority of users\&. The use of this option could even be harmful because the specified value may exceed the limitation of the underlying system API\&. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets\&. Note also that the actual maximum number is normally a little fewer than the specified value because
\fBnamed\fR
-reserves some file descriptors for its internal use.
+reserves some file descriptors for its internal use\&.
.RE
.RE
.PP
.RS 4
Chroot to
\fIdirectory\fR
-after processing the command line arguments, but before reading the configuration file.
+after processing the command line arguments, but before reading the configuration file\&.
.RS
.B "Warning:"
This option should be used in conjunction with the
\fB\-u\fR
-option, as chrooting a process running as root doesn't enhance security on most systems; the way
+option, as chrooting a process running as root doesn\*(Aqt enhance security on most systems; the way
\fBchroot(2)\fR
-is defined allows a process with root privileges to escape a chroot jail.
+is defined allows a process with root privileges to escape a chroot jail\&.
.RE
.RE
.PP
.RS 4
Use
\fI#listeners\fR
-worker threads to listen for incoming UDP packets on each address. If not specified,
+worker threads to listen for incoming UDP packets on each address\&. If not specified,
\fBnamed\fR
-will calculate a default value based on the number of detected CPUs: 1 for 1 CPU, 2 for 2\-4 CPUs, and the number of detected CPUs divided by 2 for values higher than 4. If
+will calculate a default value based on the number of detected CPUs: 1 for 1 CPU, and the number of detected CPUs minus one for machines with more than 1 CPU\&. This cannot be increased to a value higher than the number of CPUs\&. If
\fB\-n\fR
has been set to a higher value than the number of detected CPUs, then
\fB\-U\fR
-may be increased as high as that value, but no higher.
+may be increased as high as that value, but no higher\&. On Windows, the number of UDP listeners is hardwired to 1 and this option has no effect\&.
.RE
.PP
\-u \fIuser\fR
.RS 4
Setuid to
\fIuser\fR
-after completing privileged operations, such as creating sockets that listen on privileged ports.
+after completing privileged operations, such as creating sockets that listen on privileged ports\&.
.RS
.B "Note:"
On Linux,
\fBnamed\fR
-uses the kernel's capability mechanism to drop all root privileges except the ability to
+uses the kernel\*(Aqs capability mechanism to drop all root privileges except the ability to
\fBbind(2)\fR
-to a privileged port and set process resource limits. Unfortunately, this means that the
+to a privileged port and set process resource limits\&. Unfortunately, this means that the
\fB\-u\fR
option only works when
\fBnamed\fR
-is run on kernel 2.2.18 or later, or kernel 2.3.99\-pre3 or later, since previous kernels did not allow privileges to be retained after
-\fBsetuid(2)\fR.
+is run on kernel 2\&.2\&.18 or later, or kernel 2\&.3\&.99\-pre3 or later, since previous kernels did not allow privileges to be retained after
+\fBsetuid(2)\fR\&.
.RE
.RE
.PP
\-v
.RS 4
-Report the version number and exit.
+Report the version number and exit\&.
.RE
.PP
\-V
.RS 4
-Report the version number and build options, and exit.
+Report the version number and build options, and exit\&.
.RE
.PP
\-X \fIlock\-file\fR
.RS 4
Acquire a lock on the specified file at runtime; this helps to prevent duplicate
\fBnamed\fR
-instances from running simultaneously. Use of this option overrides the
+instances from running simultaneously\&. Use of this option overrides the
\fBlock\-file\fR
option in
-\fInamed.conf\fR. If set to
-none, the lock file check is disabled.
+named\&.conf\&. If set to
+none, the lock file check is disabled\&.
.RE
.PP
\-x \fIcache\-file\fR
.RS 4
Load data from
\fIcache\-file\fR
-into the cache of the default view.
+into the cache of the default view\&.
.RS
.B "Warning:"
-This option must not be used. It is only of interest to BIND 9 developers and may be removed or changed in a future release.
+This option must not be used\&. It is only of interest to BIND 9 developers and may be removed or changed in a future release\&.
.RE
.RE
.SH "SIGNALS"
.PP
In routine operation, signals should not be used to control the nameserver;
\fBrndc\fR
-should be used instead.
+should be used instead\&.
.PP
SIGHUP
.RS 4
-Force a reload of the server.
+Force a reload of the server\&.
.RE
.PP
SIGINT, SIGTERM
.RS 4
-Shut down the server.
+Shut down the server\&.
.RE
.PP
-The result of sending any other signals to the server is undefined.
+The result of sending any other signals to the server is undefined\&.
.SH "CONFIGURATION"
.PP
The
\fBnamed\fR
-configuration file is too complex to describe in detail here. A complete description is provided in the
-BIND 9 Administrator Reference Manual.
+configuration file is too complex to describe in detail here\&. A complete description is provided in the
+BIND 9 Administrator Reference Manual\&.
.PP
\fBnamed\fR
inherits the
\fBumask\fR
-(file creation mode mask) from the parent process. If files created by
+(file creation mode mask) from the parent process\&. If files created by
\fBnamed\fR, such as journal files, need to have custom permissions, the
\fBumask\fR
should be set explicitly in the script used to start the
\fBnamed\fR
-process.
+process\&.
.SH "FILES"
.PP
-\fI/etc/named.conf\fR
+/etc/named\&.conf
.RS 4
-The default configuration file.
+The default configuration file\&.
.RE
.PP
-\fI/var/run/named/named.pid\fR
+/var/run/named/named\&.pid
.RS 4
-The default process\-id file.
+The default process\-id file\&.
.RE
.SH "SEE ALSO"
.PP
RFC 1033,
RFC 1034,
RFC 1035,
-\fBnamed\-checkconf\fR(8),
-\fBnamed\-checkzone\fR(8),
+\fBnamed-checkconf\fR(8),
+\fBnamed-checkzone\fR(8),
\fBrndc\fR(8),
\fBlwresd\fR(8),
\fBnamed.conf\fR(5),
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004\-2009, 2011, 2013\-2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2004-2009, 2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
.br
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: \fInamed.conf\fR
+'\" t
+.\" Title: named.conf
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 08, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-01-08
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "\fINAMED.CONF\fR" "5" "January 08, 2014" "BIND9" "BIND9"
+.TH "NAMED\&.CONF" "5" "2014\-01\-08" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-named.conf \- configuration file for named
+named.conf \- configuration file for \fBnamed\fR
.SH "SYNOPSIS"
.HP 11
-\fBnamed.conf\fR
+\fBnamed\&.conf\fR
.SH "DESCRIPTION"
.PP
-\fInamed.conf\fR
+named\&.conf
is the configuration file for
-\fBnamed\fR. Statements are enclosed in braces and terminated with a semi\-colon. Clauses in the statements are also semi\-colon terminated. The usual comment styles are supported:
+\fBnamed\fR\&. Statements are enclosed in braces and terminated with a semi\-colon\&. Clauses in the statements are also semi\-colon terminated\&. The usual comment styles are supported:
.PP
C style: /* */
.PP
Unix style: # to end of line
.SH "ACL"
.sp
+.if n \{\
.RS 4
+.\}
.nf
-acl \fIstring\fR { \fIaddress_match_element\fR; ... };
+acl \fIstring\fR { \fIaddress_match_element\fR; \&.\&.\&. };
.fi
+.if n \{\
.RE
+.\}
.SH "KEY"
.sp
+.if n \{\
.RS 4
+.\}
.nf
key \fIdomain_name\fR {
algorithm \fIstring\fR;
secret \fIstring\fR;
};
.fi
+.if n \{\
.RE
+.\}
.SH "MASTERS"
.sp
+.if n \{\
.RS 4
+.\}
.nf
masters \fIstring\fR [ port \fIinteger\fR ] {
( \fImasters\fR | \fIipv4_address\fR [port \fIinteger\fR] |
- \fIipv6_address\fR [port \fIinteger\fR] ) [ key \fIstring\fR ]; ...
+ \fIipv6_address\fR [port \fIinteger\fR] ) [ key \fIstring\fR ]; \&.\&.\&.
};
.fi
+.if n \{\
.RE
+.\}
.SH "SERVER"
.sp
+.if n \{\
.RS 4
+.\}
.nf
server ( \fIipv4_address\fR\fI[/prefixlen]\fR | \fIipv6_address\fR\fI[/prefixlen]\fR ) {
bogus \fIboolean\fR;
support\-ixfr \fIboolean\fR; // obsolete
};
.fi
+.if n \{\
.RE
-.SH "TRUSTED\-KEYS"
+.\}
+.SH "TRUSTED-KEYS"
.sp
+.if n \{\
.RS 4
+.\}
.nf
trusted\-keys {
- \fIdomain_name\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; ...
+ \fIdomain_name\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; \&.\&.\&.
};
.fi
+.if n \{\
.RE
-.SH "MANAGED\-KEYS"
+.\}
+.SH "MANAGED-KEYS"
.sp
+.if n \{\
.RS 4
+.\}
.nf
managed\-keys {
- \fIdomain_name\fR \fBinitial\-key\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; ...
+ \fIdomain_name\fR \fBinitial\-key\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; \&.\&.\&.
};
.fi
+.if n \{\
.RE
+.\}
.SH "CONTROLS"
.sp
+.if n \{\
.RS 4
+.\}
.nf
controls {
inet ( \fIipv4_address\fR | \fIipv6_address\fR | * )
[ port ( \fIinteger\fR | * ) ]
- allow { \fIaddress_match_element\fR; ... }
- [ keys { \fIstring\fR; ... } ];
+ allow { \fIaddress_match_element\fR; \&.\&.\&. }
+ [ keys { \fIstring\fR; \&.\&.\&. } ];
unix \fIunsupported\fR; // not implemented
};
.fi
+.if n \{\
.RE
+.\}
.SH "LOGGING"
.sp
+.if n \{\
.RS 4
+.\}
.nf
logging {
channel \fIstring\fR {
print\-severity \fIboolean\fR;
print\-category \fIboolean\fR;
};
- category \fIstring\fR { \fIstring\fR; ... };
+ category \fIstring\fR { \fIstring\fR; \&.\&.\&. };
};
.fi
+.if n \{\
.RE
+.\}
.SH "LWRES"
.sp
+.if n \{\
.RS 4
+.\}
.nf
lwres {
listen\-on [ port \fIinteger\fR ] {
- ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ...
+ ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&.
};
view \fIstring\fR \fIoptional_class\fR;
- search { \fIstring\fR; ... };
+ search { \fIstring\fR; \&.\&.\&. };
ndots \fIinteger\fR;
lwres\-tasks \fIinteger\fR;
lwres\-clients \fIinteger\fR;
};
.fi
+.if n \{\
.RE
+.\}
.SH "OPTIONS"
.sp
+.if n \{\
.RS 4
+.\}
.nf
options {
- avoid\-v4\-udp\-ports { \fIport\fR; ... };
- avoid\-v6\-udp\-ports { \fIport\fR; ... };
- blackhole { \fIaddress_match_element\fR; ... };
+ avoid\-v4\-udp\-ports { \fIport\fR; \&.\&.\&. };
+ avoid\-v6\-udp\-ports { \fIport\fR; \&.\&.\&. };
+ blackhole { \fIaddress_match_element\fR; \&.\&.\&. };
coresize \fIsize\fR;
datasize \fIsize\fR;
directory \fIquoted_string\fR;
host\-statistics\-max \fInumber\fR; // not implemented
hostname ( \fIquoted_string\fR | none );
interface\-interval \fIinteger\fR;
- keep\-response\-order { \fIaddress_match_element\fR; ... };
- listen\-on [ port \fIinteger\fR ] { \fIaddress_match_element\fR; ... };
- listen\-on\-v6 [ port \fIinteger\fR ] { \fIaddress_match_element\fR; ... };
+ keep\-response\-order { \fIaddress_match_element\fR; \&.\&.\&. };
+ listen\-on [ port \fIinteger\fR ] { \fIaddress_match_element\fR; \&.\&.\&. };
+ listen\-on\-v6 [ port \fIinteger\fR ] { \fIaddress_match_element\fR; \&.\&.\&. };
match\-mapped\-addresses \fIboolean\fR;
memstatistics\-file \fIquoted_string\fR;
pid\-file ( \fIquoted_string\fR | none );
transfers\-out \fIinteger\fR;
use\-ixfr \fIboolean\fR;
version ( \fIquoted_string\fR | none );
- allow\-recursion { \fIaddress_match_element\fR; ... };
- allow\-recursion\-on { \fIaddress_match_element\fR; ... };
- sortlist { \fIaddress_match_element\fR; ... };
- topology { \fIaddress_match_element\fR; ... }; // not implemented
+ allow\-recursion { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-recursion\-on { \fIaddress_match_element\fR; \&.\&.\&. };
+ sortlist { \fIaddress_match_element\fR; \&.\&.\&. };
+ topology { \fIaddress_match_element\fR; \&.\&.\&. }; // not implemented
auth\-nxdomain \fIboolean\fR; // default changed
minimal\-responses \fIboolean\fR;
recursion \fIboolean\fR;
rrset\-order {
[ class \fIstring\fR ] [ type \fIstring\fR ]
- [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; ...
+ [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; \&.\&.\&.
};
provide\-ixfr \fIboolean\fR;
request\-ixfr \fIboolean\fR;
dual\-stack\-servers [ port \fIinteger\fR ] {
( \fIquoted_string\fR [port \fIinteger\fR] |
\fIipv4_address\fR [port \fIinteger\fR] |
- \fIipv6_address\fR [port \fIinteger\fR] ); ...
+ \fIipv6_address\fR [port \fIinteger\fR] ); \&.\&.\&.
};
edns\-udp\-size \fIinteger\fR;
max\-udp\-size \fIinteger\fR;
- root\-delegation\-only [ exclude { \fIquoted_string\fR; ... } ];
- disable\-algorithms \fIstring\fR { \fIstring\fR; ... };
- disable\-ds\-digests \fIstring\fR { \fIstring\fR; ... };
+ root\-delegation\-only [ exclude { \fIquoted_string\fR; \&.\&.\&. } ];
+ disable\-algorithms \fIstring\fR { \fIstring\fR; \&.\&.\&. };
+ disable\-ds\-digests \fIstring\fR { \fIstring\fR; \&.\&.\&. };
dnssec\-enable \fIboolean\fR;
dnssec\-validation \fIboolean\fR;
dnssec\-lookaside ( \fIauto\fR | \fIno\fR | \fIdomain\fR trust\-anchor \fIdomain\fR );
disable\-empty\-zone \fIstring\fR;
dialup \fIdialuptype\fR;
ixfr\-from\-differences \fIixfrdiff\fR;
- allow\-query { \fIaddress_match_element\fR; ... };
- allow\-query\-on { \fIaddress_match_element\fR; ... };
- allow\-query\-cache { \fIaddress_match_element\fR; ... };
- allow\-query\-cache\-on { \fIaddress_match_element\fR; ... };
- allow\-transfer { \fIaddress_match_element\fR; ... };
- allow\-update { \fIaddress_match_element\fR; ... };
- allow\-update\-forwarding { \fIaddress_match_element\fR; ... };
+ allow\-query { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-query\-on { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-query\-cache { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-query\-cache\-on { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-transfer { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-update { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-update\-forwarding { \fIaddress_match_element\fR; \&.\&.\&. };
update\-check\-ksk \fIboolean\fR;
dnssec\-dnskey\-kskonly \fIboolean\fR;
masterfile\-format ( text | raw | map );
notify\-delay \fIseconds\fR;
notify\-to\-soa \fIboolean\fR;
also\-notify [ port \fIinteger\fR ] { ( \fIipv4_address\fR | \fIipv6_address\fR )
- [ port \fIinteger\fR ]; ...
- [ key \fIkeyname\fR ] ... };
- allow\-notify { \fIaddress_match_element\fR; ... };
+ [ port \fIinteger\fR ]; \&.\&.\&.
+ [ key \fIkeyname\fR ] \&.\&.\&. };
+ allow\-notify { \fIaddress_match_element\fR; \&.\&.\&. };
forward ( first | only );
forwarders [ port \fIinteger\fR ] {
- ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ...
+ ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&.
};
max\-journal\-size \fIsize_no_default\fR;
max\-transfer\-time\-in \fIinteger\fR;
\fInamelist\fR
} [ except\-from { \fInamelist\fR } ];
nsec3\-test\-zone \fIboolean\fR; // testing only
- allow\-v6\-synthesis { \fIaddress_match_element\fR; ... }; // obsolete
+ allow\-v6\-synthesis { \fIaddress_match_element\fR; \&.\&.\&. }; // obsolete
deallocate\-on\-exit \fIboolean\fR; // obsolete
fake\-iquery \fIboolean\fR; // obsolete
fetch\-glue \fIboolean\fR; // obsolete
use\-id\-pool \fIboolean\fR; // obsolete
};
.fi
+.if n \{\
.RE
+.\}
.SH "VIEW"
.sp
+.if n \{\
.RS 4
+.\}
.nf
view \fIstring\fR \fIoptional_class\fR {
- match\-clients { \fIaddress_match_element\fR; ... };
- match\-destinations { \fIaddress_match_element\fR; ... };
+ match\-clients { \fIaddress_match_element\fR; \&.\&.\&. };
+ match\-destinations { \fIaddress_match_element\fR; \&.\&.\&. };
match\-recursive\-only \fIboolean\fR;
key \fIstring\fR {
algorithm \fIstring\fR;
secret \fIstring\fR;
};
zone \fIstring\fR \fIoptional_class\fR {
- ...
+ \&.\&.\&.
};
server ( \fIipv4_address\fR\fI[/prefixlen]\fR | \fIipv6_address\fR\fI[/prefixlen]\fR ) {
- ...
+ \&.\&.\&.
};
trusted\-keys {
\fIstring\fR \fIinteger\fR \fIinteger\fR \fIinteger\fR \fIquoted_string\fR;
- [...]
+ [\&.\&.\&.]
};
- allow\-recursion { \fIaddress_match_element\fR; ... };
- allow\-recursion\-on { \fIaddress_match_element\fR; ... };
- sortlist { \fIaddress_match_element\fR; ... };
- topology { \fIaddress_match_element\fR; ... }; // not implemented
+ allow\-recursion { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-recursion\-on { \fIaddress_match_element\fR; \&.\&.\&. };
+ sortlist { \fIaddress_match_element\fR; \&.\&.\&. };
+ topology { \fIaddress_match_element\fR; \&.\&.\&. }; // not implemented
auth\-nxdomain \fIboolean\fR; // default changed
minimal\-responses \fIboolean\fR;
recursion \fIboolean\fR;
rrset\-order {
[ class \fIstring\fR ] [ type \fIstring\fR ]
- [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; ...
+ [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; \&.\&.\&.
};
provide\-ixfr \fIboolean\fR;
request\-ixfr \fIboolean\fR;
dual\-stack\-servers [ port \fIinteger\fR ] {
( \fIquoted_string\fR [port \fIinteger\fR] |
\fIipv4_address\fR [port \fIinteger\fR] |
- \fIipv6_address\fR [port \fIinteger\fR] ); ...
+ \fIipv6_address\fR [port \fIinteger\fR] ); \&.\&.\&.
};
edns\-udp\-size \fIinteger\fR;
max\-udp\-size \fIinteger\fR;
- root\-delegation\-only [ exclude { \fIquoted_string\fR; ... } ];
- disable\-algorithms \fIstring\fR { \fIstring\fR; ... };
- disable\-ds\-digests \fIstring\fR { \fIstring\fR; ... };
+ root\-delegation\-only [ exclude { \fIquoted_string\fR; \&.\&.\&. } ];
+ disable\-algorithms \fIstring\fR { \fIstring\fR; \&.\&.\&. };
+ disable\-ds\-digests \fIstring\fR { \fIstring\fR; \&.\&.\&. };
dnssec\-enable \fIboolean\fR;
dnssec\-validation \fIboolean\fR;
dnssec\-lookaside ( \fIauto\fR | \fIno\fR | \fIdomain\fR trust\-anchor \fIdomain\fR );
disable\-empty\-zone \fIstring\fR;
dialup \fIdialuptype\fR;
ixfr\-from\-differences \fIixfrdiff\fR;
- allow\-query { \fIaddress_match_element\fR; ... };
- allow\-query\-on { \fIaddress_match_element\fR; ... };
- allow\-query\-cache { \fIaddress_match_element\fR; ... };
- allow\-query\-cache\-on { \fIaddress_match_element\fR; ... };
- allow\-transfer { \fIaddress_match_element\fR; ... };
- allow\-update { \fIaddress_match_element\fR; ... };
- allow\-update\-forwarding { \fIaddress_match_element\fR; ... };
+ allow\-query { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-query\-on { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-query\-cache { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-query\-cache\-on { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-transfer { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-update { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-update\-forwarding { \fIaddress_match_element\fR; \&.\&.\&. };
update\-check\-ksk \fIboolean\fR;
dnssec\-dnskey\-kskonly \fIboolean\fR;
masterfile\-format ( text | raw | map );
notify\-delay \fIseconds\fR;
notify\-to\-soa \fIboolean\fR;
also\-notify [ port \fIinteger\fR ] { ( \fIipv4_address\fR | \fIipv6_address\fR )
- [ port \fIinteger\fR ]; ...
- [ key \fIkeyname\fR ] ... };
- allow\-notify { \fIaddress_match_element\fR; ... };
+ [ port \fIinteger\fR ]; \&.\&.\&.
+ [ key \fIkeyname\fR ] \&.\&.\&. };
+ allow\-notify { \fIaddress_match_element\fR; \&.\&.\&. };
forward ( first | only );
forwarders [ port \fIinteger\fR ] {
- ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ...
+ ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&.
};
max\-journal\-size \fIsize_no_default\fR;
max\-transfer\-time\-in \fIinteger\fR;
require\-server\-cookie \fIboolean\fR;
send\-cookie \fIboolean\fR;
nocookie\-udp\-size \fIinteger\fR;
- allow\-v6\-synthesis { \fIaddress_match_element\fR; ... }; // obsolete
+ allow\-v6\-synthesis { \fIaddress_match_element\fR; \&.\&.\&. }; // obsolete
fetch\-glue \fIboolean\fR; // obsolete
maintain\-ixfr\-base \fIboolean\fR; // obsolete
max\-ixfr\-log\-size \fIsize\fR; // obsolete
};
.fi
+.if n \{\
.RE
+.\}
.SH "ZONE"
.sp
+.if n \{\
.RS 4
+.\}
.nf
zone \fIstring\fR \fIoptional_class\fR {
type ( master | slave | stub | hint | redirect |
masters [ port \fIinteger\fR ] {
( \fImasters\fR |
\fIipv4_address\fR [port \fIinteger\fR] |
- \fIipv6_address\fR [ port \fIinteger\fR ] ) [ key \fIstring\fR ]; ...
+ \fIipv6_address\fR [ port \fIinteger\fR ] ) [ key \fIstring\fR ]; \&.\&.\&.
};
database \fIstring\fR;
delegation\-only \fIboolean\fR;
journal \fIquoted_string\fR;
zero\-no\-soa\-ttl \fIboolean\fR;
dnssec\-secure\-to\-insecure \fIboolean\fR;
- allow\-query { \fIaddress_match_element\fR; ... };
- allow\-query\-on { \fIaddress_match_element\fR; ... };
- allow\-transfer { \fIaddress_match_element\fR; ... };
- allow\-update { \fIaddress_match_element\fR; ... };
- allow\-update\-forwarding { \fIaddress_match_element\fR; ... };
+ allow\-query { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-query\-on { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-transfer { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-update { \fIaddress_match_element\fR; \&.\&.\&. };
+ allow\-update\-forwarding { \fIaddress_match_element\fR; \&.\&.\&. };
update\-policy \fIlocal\fR | \fI {
( grant | deny ) \fR\fI\fIstring\fR\fR\fI
( name | subdomain | wildcard | self | selfsub | selfwild |
krb5\-self | ms\-self | krb5\-subdomain | ms\-subdomain |
tcp\-self | zonesub | 6to4\-self ) \fR\fI\fIstring\fR\fR\fI
\fR\fI\fIrrtypelist\fR\fR\fI;
- \fR\fI[...]\fR\fI
+ \fR\fI[\&.\&.\&.]\fR\fI
}\fR;
update\-check\-ksk \fIboolean\fR;
dnssec\-dnskey\-kskonly \fIboolean\fR;
notify\-delay \fIseconds\fR;
notify\-to\-soa \fIboolean\fR;
also\-notify [ port \fIinteger\fR ] { ( \fIipv4_address\fR | \fIipv6_address\fR )
- [ port \fIinteger\fR ]; ...
- [ key \fIkeyname\fR ] ... };
- allow\-notify { \fIaddress_match_element\fR; ... };
+ [ port \fIinteger\fR ]; \&.\&.\&.
+ [ key \fIkeyname\fR ] \&.\&.\&. };
+ allow\-notify { \fIaddress_match_element\fR; \&.\&.\&. };
forward ( first | only );
forwarders [ port \fIinteger\fR ] {
- ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ...
+ ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&.
};
max\-journal\-size \fIsize_no_default\fR;
max\-transfer\-time\-in \fIinteger\fR;
pubkey \fIinteger\fR \fIinteger\fR \fIinteger\fR \fIquoted_string\fR; // obsolete
};
.fi
+.if n \{\
.RE
+.\}
.SH "FILES"
.PP
-\fI/etc/named.conf\fR
+/etc/named\&.conf
.SH "SEE ALSO"
.PP
\fBnamed\fR(8),
-\fBnamed\-checkconf\fR(8),
+\fBnamed-checkconf\fR(8),
\fBrndc\fR(8),
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004\-2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2004-2015 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named.conf">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named.conf</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="named.conf">
<a name="man.named.conf"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><code class="filename">named.conf</code> — configuration file for <span><strong class="command">named</strong></span></p>
+<p>
+ <code class="filename">named.conf</code>
+ — configuration file for <span class="command"><strong>named</strong></span>
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">named.conf</code> </p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543379"></a><h2>DESCRIPTION</h2>
-<p><code class="filename">named.conf</code> is the configuration file
+ <div class="cmdsynopsis"><p>
+ <code class="command">named.conf</code>
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61083728"></a><h2>DESCRIPTION</h2>
+
+ <p><code class="filename">named.conf</code> is the configuration file
for
- <span><strong class="command">named</strong></span>. Statements are enclosed
+ <span class="command"><strong>named</strong></span>. Statements are enclosed
in braces and terminated with a semi-colon. Clauses in
the statements are also semi-colon terminated. The usual
comment styles are supported:
</p>
-<p>
+ <p>
C style: /* */
</p>
-<p>
+ <p>
C++ style: // to end of line
</p>
-<p>
+ <p>
Unix style: # to end of line
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543406"></a><h2>ACL</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="ACL">
+<a name="idp61091152"></a><h2>ACL</h2>
+
+ <div class="literallayout"><p><br>
acl <em class="replaceable"><code>string</code></em> { <em class="replaceable"><code>address_match_element</code></em>; ... };<br>
<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543422"></a><h2>KEY</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="KEY">
+<a name="idp61093456"></a><h2>KEY</h2>
+
+ <div class="literallayout"><p><br>
key <em class="replaceable"><code>domain_name</code></em> {<br>
algorithm <em class="replaceable"><code>string</code></em>;<br>
secret <em class="replaceable"><code>string</code></em>;<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543442"></a><h2>MASTERS</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="MASTERS">
+<a name="idp61096144"></a><h2>MASTERS</h2>
+
+ <div class="literallayout"><p><br>
masters <em class="replaceable"><code>string</code></em> [<span class="optional"> port <em class="replaceable"><code>integer</code></em> </span>] {<br>
( <em class="replaceable"><code>masters</code></em> | <em class="replaceable"><code>ipv4_address</code></em> [<span class="optional">port <em class="replaceable"><code>integer</code></em></span>] |<br>
<em class="replaceable"><code>ipv6_address</code></em> [<span class="optional">port <em class="replaceable"><code>integer</code></em></span>] ) [<span class="optional"> key <em class="replaceable"><code>string</code></em> </span>]; ...<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543488"></a><h2>SERVER</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="SERVER">
+<a name="idp61102160"></a><h2>SERVER</h2>
+
+ <div class="literallayout"><p><br>
server ( <em class="replaceable"><code>ipv4_address[<span class="optional">/prefixlen</span>]</code></em> | <em class="replaceable"><code>ipv6_address[<span class="optional">/prefixlen</span>]</code></em> ) {<br>
bogus <em class="replaceable"><code>boolean</code></em>;<br>
edns <em class="replaceable"><code>boolean</code></em>;<br>
support-ixfr <em class="replaceable"><code>boolean</code></em>; // obsolete<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543559"></a><h2>TRUSTED-KEYS</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="TRUSTED-KEYS">
+<a name="idp61115344"></a><h2>TRUSTED-KEYS</h2>
+
+ <div class="literallayout"><p><br>
trusted-keys {<br>
<em class="replaceable"><code>domain_name</code></em> <em class="replaceable"><code>flags</code></em> <em class="replaceable"><code>protocol</code></em> <em class="replaceable"><code>algorithm</code></em> <em class="replaceable"><code>key</code></em>; ...<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543585"></a><h2>MANAGED-KEYS</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="MANAGED-KEYS">
+<a name="idp61123024"></a><h2>MANAGED-KEYS</h2>
+
+ <div class="literallayout"><p><br>
managed-keys {<br>
<em class="replaceable"><code>domain_name</code></em> <code class="constant">initial-key</code> <em class="replaceable"><code>flags</code></em> <em class="replaceable"><code>protocol</code></em> <em class="replaceable"><code>algorithm</code></em> <em class="replaceable"><code>key</code></em>; ...<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543613"></a><h2>CONTROLS</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="CONTROLS">
+<a name="idp61126864"></a><h2>CONTROLS</h2>
+
+ <div class="literallayout"><p><br>
controls {<br>
inet ( <em class="replaceable"><code>ipv4_address</code></em> | <em class="replaceable"><code>ipv6_address</code></em> | * )<br>
[<span class="optional"> port ( <em class="replaceable"><code>integer</code></em> | * ) </span>]<br>
unix <em class="replaceable"><code>unsupported</code></em>; // not implemented<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543649"></a><h2>LOGGING</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="LOGGING">
+<a name="idp61131600"></a><h2>LOGGING</h2>
+
+ <div class="literallayout"><p><br>
logging {<br>
channel <em class="replaceable"><code>string</code></em> {<br>
file <em class="replaceable"><code>log_file</code></em>;<br>
category <em class="replaceable"><code>string</code></em> { <em class="replaceable"><code>string</code></em>; ... };<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543687"></a><h2>LWRES</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="LWRES">
+<a name="idp61136592"></a><h2>LWRES</h2>
+
+ <div class="literallayout"><p><br>
lwres {<br>
listen-on [<span class="optional"> port <em class="replaceable"><code>integer</code></em> </span>] {<br>
( <em class="replaceable"><code>ipv4_address</code></em> | <em class="replaceable"><code>ipv6_address</code></em> ) [<span class="optional"> port <em class="replaceable"><code>integer</code></em> </span>]; ...<br>
lwres-clients <em class="replaceable"><code>integer</code></em>;<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543735"></a><h2>OPTIONS</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61142864"></a><h2>OPTIONS</h2>
+
+ <div class="literallayout"><p><br>
options {<br>
avoid-v4-udp-ports { <em class="replaceable"><code>port</code></em>; ... };<br>
avoid-v6-udp-ports { <em class="replaceable"><code>port</code></em>; ... };<br>
use-id-pool <em class="replaceable"><code>boolean</code></em>; // obsolete<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544714"></a><h2>VIEW</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="VIEW">
+<a name="idp61247312"></a><h2>VIEW</h2>
+
+ <div class="literallayout"><p><br>
view <em class="replaceable"><code>string</code></em> <em class="replaceable"><code>optional_class</code></em> {<br>
match-clients { <em class="replaceable"><code>address_match_element</code></em>; ... };<br>
match-destinations { <em class="replaceable"><code>address_match_element</code></em>; ... };<br>
max-ixfr-log-size <em class="replaceable"><code>size</code></em>; // obsolete<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545378"></a><h2>ZONE</h2>
-<div class="literallayout"><p><br>
+ </div>
+
+ <div class="refsection" title="ZONE">
+<a name="idp61310416"></a><h2>ZONE</h2>
+
+ <div class="literallayout"><p><br>
zone <em class="replaceable"><code>string</code></em> <em class="replaceable"><code>optional_class</code></em> {<br>
type ( master | slave | stub | hint | redirect |<br>
forward | delegation-only );<br>
pubkey <em class="replaceable"><code>integer</code></em> <em class="replaceable"><code>integer</code></em> <em class="replaceable"><code>integer</code></em> <em class="replaceable"><code>quoted_string</code></em>; // obsolete<br>
};<br>
</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545767"></a><h2>FILES</h2>
-<p><code class="filename">/etc/named.conf</code>
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp61357520"></a><h2>FILES</h2>
+
+ <p><code class="filename">/etc/named.conf</code>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545779"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61359184"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named-checkconf</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">rndc</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
+ </div>
+
</div></body>
</html>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="named">
<a name="man.named"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">named</span> — Internet domain name server</p>
+<p>
+ <span class="application">named</span>
+ — Internet domain name server
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">named</code> [<code class="option">-4</code>] [<code class="option">-6</code>] [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>debug-level</code></em></code>] [<code class="option">-D <em class="replaceable"><code>string</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine-name</code></em></code>] [<code class="option">-f</code>] [<code class="option">-g</code>] [<code class="option">-L <em class="replaceable"><code>logfile</code></em></code>] [<code class="option">-M <em class="replaceable"><code>option</code></em></code>] [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-n <em class="replaceable"><code>#cpus</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-s</code>] [<code class="option">-S <em class="replaceable"><code>#max-socks</code></em></code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-U <em class="replaceable"><code>#listeners</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>] [<code class="option">-v</code>] [<code class="option">-V</code>] [<code class="option">-X <em class="replaceable"><code>lock-file</code></em></code>] [<code class="option">-x <em class="replaceable"><code>cache-file</code></em></code>]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543544"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">named</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">named</code>
+ [<code class="option">-4</code>]
+ [<code class="option">-6</code>]
+ [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>]
+ [<code class="option">-d <em class="replaceable"><code>debug-level</code></em></code>]
+ [<code class="option">-D <em class="replaceable"><code>string</code></em></code>]
+ [<code class="option">-E <em class="replaceable"><code>engine-name</code></em></code>]
+ [<code class="option">-f</code>]
+ [<code class="option">-g</code>]
+ [<code class="option">-L <em class="replaceable"><code>logfile</code></em></code>]
+ [<code class="option">-M <em class="replaceable"><code>option</code></em></code>]
+ [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>]
+ [<code class="option">-n <em class="replaceable"><code>#cpus</code></em></code>]
+ [<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
+ [<code class="option">-s</code>]
+ [<code class="option">-S <em class="replaceable"><code>#max-socks</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-U <em class="replaceable"><code>#listeners</code></em></code>]
+ [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]
+ [<code class="option">-v</code>]
+ [<code class="option">-V</code>]
+ [<code class="option">-X <em class="replaceable"><code>lock-file</code></em></code>]
+ [<code class="option">-x <em class="replaceable"><code>cache-file</code></em></code>]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61065936"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>named</strong></span>
is a Domain Name System (DNS) server,
part of the BIND 9 distribution from ISC. For more
information on the DNS, see RFCs 1033, 1034, and 1035.
</p>
-<p>
- When invoked without arguments, <span><strong class="command">named</strong></span>
+ <p>
+ When invoked without arguments, <span class="command"><strong>named</strong></span>
will
read the default configuration file
<code class="filename">/etc/named.conf</code>, read any initial
data, and listen for queries.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543569"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61068752"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-4</span></dt>
-<dd><p>
+<dd>
+ <p>
Use IPv4 only even if the host machine is capable of IPv6.
<code class="option">-4</code> and <code class="option">-6</code> are mutually
exclusive.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-6</span></dt>
-<dd><p>
+<dd>
+ <p>
Use IPv6 only even if the host machine is capable of IPv4.
<code class="option">-4</code> and <code class="option">-6</code> are mutually
exclusive.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Use <em class="replaceable"><code>config-file</code></em> as the
configuration file instead of the default,
<code class="filename">/etc/named.conf</code>. To
<code class="option">directory</code> option in the configuration
file, <em class="replaceable"><code>config-file</code></em> should be
an absolute pathname.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>.
- Debugging traces from <span><strong class="command">named</strong></span> become
+ Debugging traces from <span class="command"><strong>named</strong></span> become
more verbose as the debug level increases.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-D <em class="replaceable"><code>string</code></em></span></dt>
-<dd><p>
- Specifies a string that is used to identify a instance of
- <span><strong class="command">named</strong></span> in a process listing. The contents
- of <em class="replaceable"><code>string</code></em> are
- not examined.
- </p></dd>
+<dd>
+ <p>
+ Specifies a string that is used to identify a instance of
+ <span class="command"><strong>named</strong></span> in a process listing. The contents
+ of <em class="replaceable"><code>string</code></em> are
+ not examined.
+ </p>
+ </dd>
<dt><span class="term">-E <em class="replaceable"><code>engine-name</code></em></span></dt>
<dd>
-<p>
+ <p>
When applicable, specifies the hardware to use for
cryptographic operations, such as a secure key store used
for signing.
</p>
-<p>
+ <p>
When BIND is built with OpenSSL PKCS#11 support, this defaults
to the string "pkcs11", which identifies an OpenSSL engine
that can drive a cryptographic accelerator or hardware service
(--enable-native-pkcs11), it defaults to the path of the PKCS#11
provider library specified via "--with-pkcs11".
</p>
-</dd>
+ </dd>
<dt><span class="term">-f</span></dt>
-<dd><p>
+<dd>
+ <p>
Run the server in the foreground (i.e. do not daemonize).
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-g</span></dt>
-<dd><p>
+<dd>
+ <p>
Run the server in the foreground and force all logging
to <code class="filename">stderr</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-L <em class="replaceable"><code>logfile</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Log to the file <code class="option">logfile</code> by default
instead of the system log.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-M <em class="replaceable"><code>option</code></em></span></dt>
-<dd><p>
- Sets the default memory context options. Currently
- the only supported option is
- <em class="replaceable"><code>external</code></em>,
- which causes the internal memory manager to be bypassed
- in favor of system-provided memory allocation functions.
- </p></dd>
+<dd>
+ <p>
+ Sets the default memory context options. Currently
+ the only supported option is
+ <em class="replaceable"><code>external</code></em>,
+ which causes the internal memory manager to be bypassed
+ in favor of system-provided memory allocation functions.
+ </p>
+ </dd>
<dt><span class="term">-m <em class="replaceable"><code>flag</code></em></span></dt>
-<dd><p>
- Turn on memory usage debugging flags. Possible flags are
- <em class="replaceable"><code>usage</code></em>,
- <em class="replaceable"><code>trace</code></em>,
- <em class="replaceable"><code>record</code></em>,
- <em class="replaceable"><code>size</code></em>, and
- <em class="replaceable"><code>mctx</code></em>.
- These correspond to the ISC_MEM_DEBUGXXXX flags described in
- <code class="filename"><isc/mem.h></code>.
- </p></dd>
+<dd>
+ <p>
+ Turn on memory usage debugging flags. Possible flags are
+ <em class="replaceable"><code>usage</code></em>,
+ <em class="replaceable"><code>trace</code></em>,
+ <em class="replaceable"><code>record</code></em>,
+ <em class="replaceable"><code>size</code></em>, and
+ <em class="replaceable"><code>mctx</code></em>.
+ These correspond to the ISC_MEM_DEBUGXXXX flags described in
+ <code class="filename"><isc/mem.h></code>.
+ </p>
+ </dd>
<dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Create <em class="replaceable"><code>#cpus</code></em> worker threads
to take advantage of multiple CPUs. If not specified,
- <span><strong class="command">named</strong></span> will try to determine the
+ <span class="command"><strong>named</strong></span> will try to determine the
number of CPUs present and create one thread per CPU.
If it is unable to determine the number of CPUs, a
single worker thread will be created.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Listen for queries on port <em class="replaceable"><code>port</code></em>. If not
specified, the default is port 53.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-s</span></dt>
<dd>
-<p>
+ <p>
Write memory usage statistics to <code class="filename">stdout</code> on exit.
</p>
-<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-<p>
+ <p>
This option is mainly of interest to BIND 9 developers
and may be removed or changed in a future release.
</p>
-</div>
-</dd>
+ </div>
+ </dd>
<dt><span class="term">-S <em class="replaceable"><code>#max-socks</code></em></span></dt>
<dd>
-<p>
- Allow <span><strong class="command">named</strong></span> to use up to
- <em class="replaceable"><code>#max-socks</code></em> sockets.
+ <p>
+ Allow <span class="command"><strong>named</strong></span> to use up to
+ <em class="replaceable"><code>#max-socks</code></em> sockets.
The default value is 4096 on systems built with default
configuration options, and 21000 on systems built with
"configure --with-tuning=large".
- </p>
-<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ </p>
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
-<p>
+ <p>
This option should be unnecessary for the vast majority
of users.
- The use of this option could even be harmful because the
+ The use of this option could even be harmful because the
specified value may exceed the limitation of the
underlying system API.
- It is therefore set only when the default configuration
+ It is therefore set only when the default configuration
causes exhaustion of file descriptors and the
operational environment is known to support the
specified number of sockets.
- Note also that the actual maximum number is normally a little
+ Note also that the actual maximum number is normally a little
fewer than the specified value because
- <span><strong class="command">named</strong></span> reserves some file descriptors
- for its internal use.
+ <span class="command"><strong>named</strong></span> reserves some file descriptors
+ for its internal use.
</p>
-</div>
-</dd>
+ </div>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
<dd>
-<p>Chroot
- to <em class="replaceable"><code>directory</code></em> after
+ <p>Chroot
+ to <em class="replaceable"><code>directory</code></em> after
processing the command line arguments, but before
reading the configuration file.
</p>
-<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
-<p>
+ <p>
This option should be used in conjunction with the
<code class="option">-u</code> option, as chrooting a process
running as root doesn't enhance security on most
defined allows a process with root privileges to
escape a chroot jail.
</p>
-</div>
-</dd>
+ </div>
+ </dd>
<dt><span class="term">-U <em class="replaceable"><code>#listeners</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Use <em class="replaceable"><code>#listeners</code></em>
worker threads to listen for incoming UDP packets on each
- address. If not specified, <span><strong class="command">named</strong></span> will
+ address. If not specified, <span class="command"><strong>named</strong></span> will
calculate a default value based on the number of detected
- CPUs: 1 for 1 CPU, 2 for 2-4 CPUs, and the number of
- detected CPUs divided by 2 for values higher than 4.
+ CPUs: 1 for 1 CPU, and the number of detected CPUs
+ minus one for machines with more than 1 CPU. This cannot
+ be increased to a value higher than the number of CPUs.
If <code class="option">-n</code> has been set to a higher value than
the number of detected CPUs, then <code class="option">-U</code> may
be increased as high as that value, but no higher.
- </p></dd>
+ On Windows, the number of UDP listeners is hardwired to 1
+ and this option has no effect.
+ </p>
+ </dd>
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
<dd>
-<p>Setuid
- to <em class="replaceable"><code>user</code></em> after completing
+ <p>Setuid
+ to <em class="replaceable"><code>user</code></em> after completing
privileged operations, such as creating sockets that
listen on privileged ports.
</p>
-<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-<p>
- On Linux, <span><strong class="command">named</strong></span> uses the kernel's
- capability mechanism to drop all root privileges
+ <p>
+ On Linux, <span class="command"><strong>named</strong></span> uses the kernel's
+ capability mechanism to drop all root privileges
except the ability to <code class="function">bind(2)</code> to
a
privileged port and set process resource limits.
Unfortunately, this means that the <code class="option">-u</code>
- option only works when <span><strong class="command">named</strong></span> is
+ option only works when <span class="command"><strong>named</strong></span> is
run
on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
later, since previous kernels did not allow privileges
to be retained after <code class="function">setuid(2)</code>.
</p>
-</div>
-</dd>
+ </div>
+ </dd>
<dt><span class="term">-v</span></dt>
-<dd><p>
+<dd>
+ <p>
Report the version number and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Report the version number and build options, and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-X <em class="replaceable"><code>lock-file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Acquire a lock on the specified file at runtime; this
- helps to prevent duplicate <span><strong class="command">named</strong></span> instances
+ helps to prevent duplicate <span class="command"><strong>named</strong></span> instances
from running simultaneously.
- Use of this option overrides the <span><strong class="command">lock-file</strong></span>
+ Use of this option overrides the <span class="command"><strong>lock-file</strong></span>
option in <code class="filename">named.conf</code>.
If set to <code class="literal">none</code>, the lock file check
is disabled.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-x <em class="replaceable"><code>cache-file</code></em></span></dt>
<dd>
-<p>
+ <p>
Load data from <em class="replaceable"><code>cache-file</code></em> into the
cache of the default view.
</p>
-<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
-<p>
+ <p>
This option must not be used. It is only of interest
to BIND 9 developers and may be removed or changed in a
future release.
</p>
-</div>
-</dd>
+ </div>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544295"></a><h2>SIGNALS</h2>
-<p>
+
+ </div>
+
+ <div class="refsection" title="SIGNALS">
+<a name="idp61143504"></a><h2>SIGNALS</h2>
+
+ <p>
In routine operation, signals should not be used to control
- the nameserver; <span><strong class="command">rndc</strong></span> should be used
+ the nameserver; <span class="command"><strong>rndc</strong></span> should be used
instead.
</p>
-<div class="variablelist"><dl>
+
+ <div class="variablelist"><dl>
<dt><span class="term">SIGHUP</span></dt>
-<dd><p>
+<dd>
+ <p>
Force a reload of the server.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">SIGINT, SIGTERM</span></dt>
-<dd><p>
+<dd>
+ <p>
Shut down the server.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-<p>
+
+ <p>
The result of sending any other signals to the server is undefined.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544411"></a><h2>CONFIGURATION</h2>
-<p>
- The <span><strong class="command">named</strong></span> configuration file is too complex
+
+ </div>
+
+ <div class="refsection" title="CONFIGURATION">
+<a name="idp61026384"></a><h2>CONFIGURATION</h2>
+
+ <p>
+ The <span class="command"><strong>named</strong></span> configuration file is too complex
to describe in detail here. A complete description is provided
in the
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-<p>
- <span><strong class="command">named</strong></span> inherits the <code class="function">umask</code>
+
+ <p>
+ <span class="command"><strong>named</strong></span> inherits the <code class="function">umask</code>
(file creation mode mask) from the parent process. If files
- created by <span><strong class="command">named</strong></span>, such as journal files,
+ created by <span class="command"><strong>named</strong></span>, such as journal files,
need to have custom permissions, the <code class="function">umask</code>
should be set explicitly in the script used to start the
- <span><strong class="command">named</strong></span> process.
+ <span class="command"><strong>named</strong></span> process.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544448"></a><h2>FILES</h2>
-<div class="variablelist"><dl>
+
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp61149904"></a><h2>FILES</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term"><code class="filename">/etc/named.conf</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The default configuration file.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="filename">/var/run/named/named.pid</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The default process-id file.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544487"></a><h2>SEE ALSO</h2>
-<p><em class="citetitle">RFC 1033</em>,
+
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61154640"></a><h2>SEE ALSO</h2>
+
+ <p><em class="citetitle">RFC 1033</em>,
<em class="citetitle">RFC 1034</em>,
<em class="citetitle">RFC 1035</em>,
- <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">lwresd</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named-checkconf</span>
+ (8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named-checkzone</span>
+ (8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">rndc</span>
+ (8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwresd</span>
+ (8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named.conf</span>
+ (5)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544557"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: nsupdate
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: April 18, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-04-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "NSUPDATE" "1" "April 18, 2014" "BIND9" "BIND9"
+.TH "NSUPDATE" "1" "2014\-04\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
nsupdate \- Dynamic DNS update utility
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBnsupdate\fR
-is used to submit Dynamic DNS Update requests as defined in RFC 2136 to a name server. This allows resource records to be added or removed from a zone without manually editing the zone file. A single update request can contain requests to add or remove more than one resource record.
+is used to submit Dynamic DNS Update requests as defined in RFC 2136 to a name server\&. This allows resource records to be added or removed from a zone without manually editing the zone file\&. A single update request can contain requests to add or remove more than one resource record\&.
.PP
Zones that are under dynamic control via
\fBnsupdate\fR
-or a DHCP server should not be edited by hand. Manual edits could conflict with dynamic updates and cause data to be lost.
+or a DHCP server should not be edited by hand\&. Manual edits could conflict with dynamic updates and cause data to be lost\&.
.PP
The resource records that are dynamically added or removed with
\fBnsupdate\fR
-have to be in the same zone. Requests are sent to the zone's master server. This is identified by the MNAME field of the zone's SOA record.
+have to be in the same zone\&. Requests are sent to the zone\*(Aqs master server\&. This is identified by the MNAME field of the zone\*(Aqs SOA record\&.
.PP
-Transaction signatures can be used to authenticate the Dynamic DNS updates. These use the TSIG resource record type described in RFC 2845 or the SIG(0) record described in RFC 2535 and RFC 2931 or GSS\-TSIG as described in RFC 3645.
+Transaction signatures can be used to authenticate the Dynamic DNS updates\&. These use the TSIG resource record type described in RFC 2845 or the SIG(0) record described in RFC 2535 and RFC 2931 or GSS\-TSIG as described in RFC 3645\&.
.PP
TSIG relies on a shared secret that should only be known to
\fBnsupdate\fR
-and the name server. For instance, suitable
+and the name server\&. For instance, suitable
\fBkey\fR
and
\fBserver\fR
statements would be added to
-\fI/etc/named.conf\fR
-so that the name server can associate the appropriate secret key and algorithm with the IP address of the client application that will be using TSIG authentication. You can use
+/etc/named\&.conf
+so that the name server can associate the appropriate secret key and algorithm with the IP address of the client application that will be using TSIG authentication\&. You can use
\fBddns\-confgen\fR
-to generate suitable configuration fragments.
+to generate suitable configuration fragments\&.
\fBnsupdate\fR
uses the
\fB\-y\fR
or
\fB\-k\fR
-options to provide the TSIG shared secret. These options are mutually exclusive.
+options to provide the TSIG shared secret\&. These options are mutually exclusive\&.
.PP
-SIG(0) uses public key cryptography. To use a SIG(0) key, the public key must be stored in a KEY record in a zone served by the name server.
+SIG(0) uses public key cryptography\&. To use a SIG(0) key, the public key must be stored in a KEY record in a zone served by the name server\&.
.PP
-GSS\-TSIG uses Kerberos credentials. Standard GSS\-TSIG mode is switched on with the
+GSS\-TSIG uses Kerberos credentials\&. Standard GSS\-TSIG mode is switched on with the
\fB\-g\fR
-flag. A non\-standards\-compliant variant of GSS\-TSIG used by Windows 2000 can be switched on with the
+flag\&. A non\-standards\-compliant variant of GSS\-TSIG used by Windows 2000 can be switched on with the
\fB\-o\fR
-flag.
+flag\&.
.SH "OPTIONS"
.PP
\-d
.RS 4
-Debug mode. This provides tracing information about the update requests that are made and the replies received from the name server.
+Debug mode\&. This provides tracing information about the update requests that are made and the replies received from the name server\&.
.RE
.PP
\-D
.RS 4
-Extra debug mode.
+Extra debug mode\&.
.RE
.PP
\-k \fIkeyfile\fR
.RS 4
-The file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing a
-\fInamed.conf\fR\-format
+The file containing the TSIG authentication key\&. Keyfiles may be in two formats: a single file containing a
+named\&.conf\-format
\fBkey\fR
statement, which may be generated automatically by
\fBddns\-confgen\fR, or a pair of files whose names are of the format
-\fIK{name}.+157.+{random}.key\fR
+K{name}\&.+157\&.+{random}\&.key
and
-\fIK{name}.+157.+{random}.private\fR, which can be generated by
-\fBdnssec\-keygen\fR. The
+K{name}\&.+157\&.+{random}\&.private, which can be generated by
+\fBdnssec\-keygen\fR\&. The
\fB\-k\fR
-may also be used to specify a SIG(0) key used to authenticate Dynamic DNS update requests. In this case, the key specified is not an HMAC\-MD5 key.
+may also be used to specify a SIG(0) key used to authenticate Dynamic DNS update requests\&. In this case, the key specified is not an HMAC\-MD5 key\&.
.RE
.PP
\-l
.RS 4
-Local\-host only mode. This sets the server address to localhost (disabling the
+Local\-host only mode\&. This sets the server address to localhost (disabling the
\fBserver\fR
-so that the server address cannot be overridden). Connections to the local server will use a TSIG key found in
-\fI/var/run/named/session.key\fR, which is automatically generated by
+so that the server address cannot be overridden)\&. Connections to the local server will use a TSIG key found in
+/var/run/named/session\&.key, which is automatically generated by
\fBnamed\fR
if any local master zone has set
\fBupdate\-policy\fR
to
-\fBlocal\fR. The location of this key file can be overridden with the
+\fBlocal\fR\&. The location of this key file can be overridden with the
\fB\-k\fR
-option.
+option\&.
.RE
.PP
\-L \fIlevel\fR
.RS 4
-Set the logging debug level. If zero, logging is disabled.
+Set the logging debug level\&. If zero, logging is disabled\&.
.RE
.PP
\-p \fIport\fR
.RS 4
-Set the port to use for connections to a name server. The default is 53.
+Set the port to use for connections to a name server\&. The default is 53\&.
.RE
.PP
\-P
.RS 4
Print the list of private BIND\-specific resource record types whose format is understood by
-\fBnsupdate\fR. See also the
+\fBnsupdate\fR\&. See also the
\fB\-T\fR
-option.
+option\&.
.RE
.PP
\-r \fIudpretries\fR
.RS 4
-The number of UDP retries. The default is 3. If zero, only one update request will be made.
+The number of UDP retries\&. The default is 3\&. If zero, only one update request will be made\&.
.RE
.PP
\-R \fIrandomdev\fR
.RS 4
-Where to obtain randomness. If the operating system does not provide a
-\fI/dev/random\fR
-or equivalent device, the default source of randomness is keyboard input.
-\fIrandomdev\fR
-specifies the name of a character device or file containing random data to be used instead of the default. The special value
-\fIkeyboard\fR
-indicates that keyboard input should be used. This option may be specified multiple times.
+Where to obtain randomness\&. If the operating system does not provide a
+/dev/random
+or equivalent device, the default source of randomness is keyboard input\&.
+randomdev
+specifies the name of a character device or file containing random data to be used instead of the default\&. The special value
+keyboard
+indicates that keyboard input should be used\&. This option may be specified multiple times\&.
.RE
.PP
\-t \fItimeout\fR
.RS 4
-The maximum time an update request can take before it is aborted. The default is 300 seconds. Zero can be used to disable the timeout.
+The maximum time an update request can take before it is aborted\&. The default is 300 seconds\&. Zero can be used to disable the timeout\&.
.RE
.PP
\-T
.RS 4
Print the list of IANA standard resource record types whose format is understood by
-\fBnsupdate\fR.
+\fBnsupdate\fR\&.
\fBnsupdate\fR
-will exit after the lists are printed. The
+will exit after the lists are printed\&. The
\fB\-T\fR
option can be combined with the
\fB\-P\fR
-option.
+option\&.
.sp
-Other types can be entered using "TYPEXXXXX" where "XXXXX" is the decimal value of the type with no leading zeros. The rdata, if present, will be parsed using the UNKNOWN rdata format, (<backslash> <hash> <space> <length> <space> <hexstring>).
+Other types can be entered using "TYPEXXXXX" where "XXXXX" is the decimal value of the type with no leading zeros\&. The rdata, if present, will be parsed using the UNKNOWN rdata format, (<backslash> <hash> <space> <length> <space> <hexstring>)\&.
.RE
.PP
\-u \fIudptimeout\fR
.RS 4
-The UDP retry interval. The default is 3 seconds. If zero, the interval will be computed from the timeout interval and number of UDP retries.
+The UDP retry interval\&. The default is 3 seconds\&. If zero, the interval will be computed from the timeout interval and number of UDP retries\&.
.RE
.PP
\-v
.RS 4
-Use TCP even for small update requests. By default,
+Use TCP even for small update requests\&. By default,
\fBnsupdate\fR
-uses UDP to send update requests to the name server unless they are too large to fit in a UDP request in which case TCP will be used. TCP may be preferable when a batch of update requests is made.
+uses UDP to send update requests to the name server unless they are too large to fit in a UDP request in which case TCP will be used\&. TCP may be preferable when a batch of update requests is made\&.
.RE
.PP
\-V
.RS 4
-Print the version number and exit.
+Print the version number and exit\&.
.RE
.PP
\-y \fI[hmac:]\fR\fIkeyname:secret\fR
.RS 4
-Literal TSIG authentication key.
+Literal TSIG authentication key\&.
\fIkeyname\fR
is the name of the key, and
\fIsecret\fR
-is the base64 encoded shared secret.
+is the base64 encoded shared secret\&.
\fIhmac\fR
is the name of the key algorithm; valid choices are
hmac\-md5,
hmac\-sha224,
hmac\-sha256,
hmac\-sha384, or
-hmac\-sha512. If
+hmac\-sha512\&. If
\fIhmac\fR
is not specified, the default is
-hmac\-md5.
+hmac\-md5\&.
.sp
NOTE: Use of the
\fB\-y\fR
-option is discouraged because the shared secret is supplied as a command line argument in clear text. This may be visible in the output from
+option is discouraged because the shared secret is supplied as a command line argument in clear text\&. This may be visible in the output from
\fBps\fR(1)
-or in a history file maintained by the user's shell.
+or in a history file maintained by the user\*(Aqs shell\&.
.RE
.SH "INPUT FORMAT"
.PP
\fBnsupdate\fR
reads input from
\fIfilename\fR
-or standard input. Each command is supplied on exactly one line of input. Some commands are for administrative purposes. The others are either update instructions or prerequisite checks on the contents of the zone. These checks set conditions that some name or set of resource records (RRset) either exists or is absent from the zone. These conditions must be met if the entire update request is to succeed. Updates will be rejected if the tests for the prerequisite conditions fail.
+or standard input\&. Each command is supplied on exactly one line of input\&. Some commands are for administrative purposes\&. The others are either update instructions or prerequisite checks on the contents of the zone\&. These checks set conditions that some name or set of resource records (RRset) either exists or is absent from the zone\&. These conditions must be met if the entire update request is to succeed\&. Updates will be rejected if the tests for the prerequisite conditions fail\&.
.PP
-Every update request consists of zero or more prerequisites and zero or more updates. This allows a suitably authenticated update request to proceed if some specified resource records are present or missing from the zone. A blank input line (or the
+Every update request consists of zero or more prerequisites and zero or more updates\&. This allows a suitably authenticated update request to proceed if some specified resource records are present or missing from the zone\&. A blank input line (or the
\fBsend\fR
-command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server.
+command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server\&.
.PP
The command formats and their meaning are as follows:
.PP
\fBserver\fR {servername} [port]
.RS 4
Sends all dynamic update requests to the name server
-\fIservername\fR. When no server statement is provided,
+\fIservername\fR\&. When no server statement is provided,
\fBnsupdate\fR
-will send updates to the master server of the correct zone. The MNAME field of that zone's SOA record will identify the master server for that zone.
+will send updates to the master server of the correct zone\&. The MNAME field of that zone\*(Aqs SOA record will identify the master server for that zone\&.
\fIport\fR
is the port number on
\fIservername\fR
-where the dynamic update requests get sent. If no port number is specified, the default DNS port number of 53 is used.
+where the dynamic update requests get sent\&. If no port number is specified, the default DNS port number of 53 is used\&.
.RE
.PP
\fBlocal\fR {address} [port]
.RS 4
Sends all dynamic update requests using the local
-\fIaddress\fR. When no local statement is provided,
+\fIaddress\fR\&. When no local statement is provided,
\fBnsupdate\fR
-will send updates using an address and port chosen by the system.
+will send updates using an address and port chosen by the system\&.
\fIport\fR
-can additionally be used to make requests come from a specific port. If no port number is specified, the system will assign one.
+can additionally be used to make requests come from a specific port\&. If no port number is specified, the system will assign one\&.
.RE
.PP
\fBzone\fR {zonename}
.RS 4
Specifies that all updates are to be made to the zone
-\fIzonename\fR. If no
+\fIzonename\fR\&. If no
\fIzone\fR
statement is provided,
\fBnsupdate\fR
-will attempt determine the correct zone to update based on the rest of the input.
+will attempt determine the correct zone to update based on the rest of the input\&.
.RE
.PP
\fBclass\fR {classname}
.RS 4
-Specify the default class. If no
+Specify the default class\&. If no
\fIclass\fR
is specified, the default class is
-\fIIN\fR.
+\fIIN\fR\&.
.RE
.PP
\fBttl\fR {seconds}
.RS 4
-Specify the default time to live for records to be added. The value
+Specify the default time to live for records to be added\&. The value
\fInone\fR
-will clear the default ttl.
+will clear the default ttl\&.
.RE
.PP
\fBkey\fR [hmac:] {keyname} {secret}
Specifies that all updates are to be TSIG\-signed using the
\fIkeyname\fR
\fIsecret\fR
-pair. If
+pair\&. If
\fIhmac\fR
is specified, then it sets the signing algorithm in use; the default is
-hmac\-md5. The
+hmac\-md5\&. The
\fBkey\fR
command overrides any key specified on the command line via
\fB\-y\fR
or
-\fB\-k\fR.
+\fB\-k\fR\&.
.RE
.PP
\fBgsstsig\fR
.RS 4
-Use GSS\-TSIG to sign the updated. This is equivalent to specifying
+Use GSS\-TSIG to sign the updated\&. This is equivalent to specifying
\fB\-g\fR
-on the command line.
+on the command line\&.
.RE
.PP
\fBoldgsstsig\fR
.RS 4
-Use the Windows 2000 version of GSS\-TSIG to sign the updated. This is equivalent to specifying
+Use the Windows 2000 version of GSS\-TSIG to sign the updated\&. This is equivalent to specifying
\fB\-o\fR
-on the command line.
+on the command line\&.
.RE
.PP
\fBrealm\fR {[realm_name]}
When using GSS\-TSIG use
\fIrealm_name\fR
rather than the default realm in
-\fIkrb5.conf\fR. If no realm is specified the saved realm is cleared.
+krb5\&.conf\&. If no realm is specified the saved realm is cleared\&.
.RE
.PP
\fBcheck\-names\fR {[yes_or_no]}
.RS 4
-Turn on or off check\-names processing on records to be added. Check\-names has no effect on prerequisites or records to be deleted. By default check\-names processing is on. If check\-names processing fails the record will not be added to the UPDATE message.
+Turn on or off check\-names processing on records to be added\&. Check\-names has no effect on prerequisites or records to be deleted\&. By default check\-names processing is on\&. If check\-names processing fails the record will not be added to the UPDATE message\&.
.RE
.PP
\fB[prereq]\fR\fB nxdomain\fR {domain\-name}
.RS 4
Requires that no resource record of any type exists with name
-\fIdomain\-name\fR.
+\fIdomain\-name\fR\&.
.RE
.PP
\fB[prereq]\fR\fB yxdomain\fR {domain\-name}
.RS 4
Requires that
\fIdomain\-name\fR
-exists (has as at least one resource record, of any type).
+exists (has as at least one resource record, of any type)\&.
.RE
.PP
\fB[prereq]\fR\fB nxrrset\fR {domain\-name} [class] {type}
\fItype\fR,
\fIclass\fR
and
-\fIdomain\-name\fR. If
+\fIdomain\-name\fR\&. If
\fIclass\fR
-is omitted, IN (internet) is assumed.
+is omitted, IN (internet) is assumed\&.
.RE
.PP
\fB[prereq]\fR\fB yxrrset\fR {domain\-name} [class] {type}
\fIclass\fR
and
\fIdomain\-name\fR
-must exist. If
+must exist\&. If
\fIclass\fR
-is omitted, IN (internet) is assumed.
+is omitted, IN (internet) is assumed\&.
.RE
.PP
\fB[prereq]\fR\fB yxrrset\fR {domain\-name} [class] {type} {data...}
\fItype\fR,
\fIclass\fR, and
\fIdomain\-name\fR
-are combined to form a set of RRs. This set of RRs must exactly match the set of RRs existing in the zone at the given
+are combined to form a set of RRs\&. This set of RRs must exactly match the set of RRs existing in the zone at the given
\fItype\fR,
\fIclass\fR, and
-\fIdomain\-name\fR. The
+\fIdomain\-name\fR\&. The
\fIdata\fR
-are written in the standard text representation of the resource record's RDATA.
+are written in the standard text representation of the resource record\*(Aqs RDATA\&.
.RE
.PP
\fB[update]\fR\fB del\fR\fB[ete]\fR {domain\-name} [ttl] [class] [type\ [data...]]
.RS 4
Deletes any resource records named
-\fIdomain\-name\fR. If
+\fIdomain\-name\fR\&. If
\fItype\fR
and
\fIdata\fR
-is provided, only matching resource records will be removed. The internet class is assumed if
+is provided, only matching resource records will be removed\&. The internet class is assumed if
\fIclass\fR
-is not supplied. The
+is not supplied\&. The
\fIttl\fR
-is ignored, and is only allowed for compatibility.
+is ignored, and is only allowed for compatibility\&.
.RE
.PP
\fB[update]\fR\fB add\fR {domain\-name} {ttl} [class] {type} {data...}
\fIttl\fR,
\fIclass\fR
and
-\fIdata\fR.
+\fIdata\fR\&.
.RE
.PP
\fBshow\fR
.RS 4
-Displays the current message, containing all of the prerequisites and updates specified since the last send.
+Displays the current message, containing all of the prerequisites and updates specified since the last send\&.
.RE
.PP
\fBsend\fR
.RS 4
-Sends the current message. This is equivalent to entering a blank line.
+Sends the current message\&. This is equivalent to entering a blank line\&.
.RE
.PP
\fBanswer\fR
.RS 4
-Displays the answer.
+Displays the answer\&.
.RE
.PP
\fBdebug\fR
.RS 4
-Turn on debugging.
+Turn on debugging\&.
.RE
.PP
\fBversion\fR
.RS 4
-Print version number.
+Print version number\&.
.RE
.PP
\fBhelp\fR
.RS 4
-Print a list of commands.
+Print a list of commands\&.
.RE
.PP
-Lines beginning with a semicolon are comments and are ignored.
+Lines beginning with a semicolon are comments and are ignored\&.
.SH "EXAMPLES"
.PP
The examples below show how
\fBnsupdate\fR
could be used to insert and delete resource records from the
-\fBexample.com\fR
-zone. Notice that the input in each example contains a trailing blank line so that a group of commands are sent as one dynamic update request to the master name server for
-\fBexample.com\fR.
+\fBexample\&.com\fR
+zone\&. Notice that the input in each example contains a trailing blank line so that a group of commands are sent as one dynamic update request to the master name server for
+\fBexample\&.com\fR\&.
.sp
+.if n \{\
.RS 4
+.\}
.nf
# nsupdate
-> update delete oldhost.example.com A
-> update add newhost.example.com 86400 A 172.16.1.1
+> update delete oldhost\&.example\&.com A
+> update add newhost\&.example\&.com 86400 A 172\&.16\&.1\&.1
> send
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
Any A records for
-\fBoldhost.example.com\fR
-are deleted. And an A record for
-\fBnewhost.example.com\fR
-with IP address 172.16.1.1 is added. The newly\-added record has a 1 day TTL (86400 seconds).
+\fBoldhost\&.example\&.com\fR
+are deleted\&. And an A record for
+\fBnewhost\&.example\&.com\fR
+with IP address 172\&.16\&.1\&.1 is added\&. The newly\-added record has a 1 day TTL (86400 seconds)\&.
.sp
+.if n \{\
.RS 4
+.\}
.nf
# nsupdate
-> prereq nxdomain nickname.example.com
-> update add nickname.example.com 86400 CNAME somehost.example.com
+> prereq nxdomain nickname\&.example\&.com
+> update add nickname\&.example\&.com 86400 CNAME somehost\&.example\&.com
> send
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
The prerequisite condition gets the name server to check that there are no resource records of any type for
-\fBnickname.example.com\fR. If there are, the update request fails. If this name does not exist, a CNAME for it is added. This ensures that when the CNAME is added, it cannot conflict with the long\-standing rule in RFC 1034 that a name must not exist as any other record type if it exists as a CNAME. (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have RRSIG, DNSKEY and NSEC records.)
+\fBnickname\&.example\&.com\fR\&. If there are, the update request fails\&. If this name does not exist, a CNAME for it is added\&. This ensures that when the CNAME is added, it cannot conflict with the long\-standing rule in RFC 1034 that a name must not exist as any other record type if it exists as a CNAME\&. (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have RRSIG, DNSKEY and NSEC records\&.)
.SH "FILES"
.PP
-\fB/etc/resolv.conf\fR
+\fB/etc/resolv\&.conf\fR
.RS 4
used to identify default name server
.RE
.PP
-\fB/var/run/named/session.key\fR
+\fB/var/run/named/session\&.key\fR
.RS 4
sets the default TSIG key for use in local\-only mode
.RE
.PP
-\fBK{name}.+157.+{random}.key\fR
+\fBK{name}\&.+157\&.+{random}\&.key\fR
.RS 4
base\-64 encoding of HMAC\-MD5 key created by
-\fBdnssec\-keygen\fR(8).
+\fBdnssec-keygen\fR(8)\&.
.RE
.PP
-\fBK{name}.+157.+{random}.private\fR
+\fBK{name}\&.+157\&.+{random}\&.private\fR
.RS 4
base\-64 encoding of HMAC\-MD5 key created by
-\fBdnssec\-keygen\fR(8).
+\fBdnssec-keygen\fR(8)\&.
.RE
.SH "SEE ALSO"
.PP
RFC 2535,
RFC 2931,
\fBnamed\fR(8),
-\fBddns\-confgen\fR(8),
-\fBdnssec\-keygen\fR(8).
+\fBddns-confgen\fR(8),
+\fBdnssec-keygen\fR(8)\&.
.SH "BUGS"
.PP
-The TSIG key is redundantly stored in two separate files. This is a consequence of nsupdate using the DST library for its cryptographic operations, and may change in future releases.
+The TSIG key is redundantly stored in two separate files\&. This is a consequence of nsupdate using the DST library for its cryptographic operations, and may change in future releases\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004\-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
.br
-Copyright \(co 2000\-2003 Internet Software Consortium.
+Copyright \(co 2004-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2000-2003 Internet Software Consortium.
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.nsupdate">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>nsupdate</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="nsupdate">
<a name="man.nsupdate"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">nsupdate</span> — Dynamic DNS update utility</p>
+<p>
+ <span class="application">nsupdate</span>
+ — Dynamic DNS update utility
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">nsupdate</code> [<code class="option">-d</code>] [<code class="option">-D</code>] [<code class="option">-L <em class="replaceable"><code>level</code></em></code>] [[<code class="option">-g</code>] | [<code class="option">-o</code>] | [<code class="option">-l</code>] | [<code class="option">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></code>] | [<code class="option">-k <em class="replaceable"><code>keyfile</code></em></code>]] [<code class="option">-t <em class="replaceable"><code>timeout</code></em></code>] [<code class="option">-u <em class="replaceable"><code>udptimeout</code></em></code>] [<code class="option">-r <em class="replaceable"><code>udpretries</code></em></code>] [<code class="option">-R <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-v</code>] [<code class="option">-T</code>] [<code class="option">-P</code>] [<code class="option">-V</code>] [filename]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543499"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">nsupdate</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">nsupdate</code>
+ [<code class="option">-d</code>]
+ [<code class="option">-D</code>]
+ [<code class="option">-L <em class="replaceable"><code>level</code></em></code>]
+ [
+ [<code class="option">-g</code>]
+ | [<code class="option">-o</code>]
+ | [<code class="option">-l</code>]
+ | [<code class="option">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></code>]
+ | [<code class="option">-k <em class="replaceable"><code>keyfile</code></em></code>]
+ ]
+ [<code class="option">-t <em class="replaceable"><code>timeout</code></em></code>]
+ [<code class="option">-u <em class="replaceable"><code>udptimeout</code></em></code>]
+ [<code class="option">-r <em class="replaceable"><code>udpretries</code></em></code>]
+ [<code class="option">-R <em class="replaceable"><code>randomdev</code></em></code>]
+ [<code class="option">-v</code>]
+ [<code class="option">-T</code>]
+ [<code class="option">-P</code>]
+ [<code class="option">-V</code>]
+ [filename]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61049552"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>nsupdate</strong></span>
is used to submit Dynamic DNS Update requests as defined in RFC 2136
to a name server.
This allows resource records to be added or removed from a zone
one
resource record.
</p>
-<p>
+ <p>
Zones that are under dynamic control via
- <span><strong class="command">nsupdate</strong></span>
+ <span class="command"><strong>nsupdate</strong></span>
or a DHCP server should not be edited by hand.
Manual edits could
conflict with dynamic updates and cause data to be lost.
</p>
-<p>
+ <p>
The resource records that are dynamically added or removed with
- <span><strong class="command">nsupdate</strong></span>
+ <span class="command"><strong>nsupdate</strong></span>
have to be in the same zone.
Requests are sent to the zone's master server.
This is identified by the MNAME field of the zone's SOA record.
</p>
-<p>
+ <p>
Transaction signatures can be used to authenticate the Dynamic
DNS updates. These use the TSIG resource record type described
in RFC 2845 or the SIG(0) record described in RFC 2535 and
RFC 2931 or GSS-TSIG as described in RFC 3645.
</p>
-<p>
+ <p>
TSIG relies on
a shared secret that should only be known to
- <span><strong class="command">nsupdate</strong></span> and the name server.
+ <span class="command"><strong>nsupdate</strong></span> and the name server.
For instance, suitable <span class="type">key</span> and
<span class="type">server</span> statements would be added to
<code class="filename">/etc/named.conf</code> so that the name server
can associate the appropriate secret key and algorithm with
the IP address of the client application that will be using
- TSIG authentication. You can use <span><strong class="command">ddns-confgen</strong></span>
+ TSIG authentication. You can use <span class="command"><strong>ddns-confgen</strong></span>
to generate suitable configuration fragments.
- <span><strong class="command">nsupdate</strong></span>
+ <span class="command"><strong>nsupdate</strong></span>
uses the <code class="option">-y</code> or <code class="option">-k</code> options
to provide the TSIG shared secret. These options are mutually exclusive.
</p>
-<p>
+ <p>
SIG(0) uses public key cryptography.
To use a SIG(0) key, the public key must be stored in a KEY
record in a zone served by the name server.
</p>
-<p>
+ <p>
GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode
is switched on with the <code class="option">-g</code> flag. A
non-standards-compliant variant of GSS-TSIG used by Windows
2000 can be switched on with the <code class="option">-o</code> flag.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543573"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61062480"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-d</span></dt>
-<dd><p>
+<dd>
+ <p>
Debug mode. This provides tracing information about the
update requests that are made and the replies received
from the name server.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-D</span></dt>
-<dd><p>
+<dd>
+ <p>
Extra debug mode.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-k <em class="replaceable"><code>keyfile</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The file containing the TSIG authentication key.
Keyfiles may be in two formats: a single file containing
- a <code class="filename">named.conf</code>-format <span><strong class="command">key</strong></span>
+ a <code class="filename">named.conf</code>-format <span class="command"><strong>key</strong></span>
statement, which may be generated automatically by
- <span><strong class="command">ddns-confgen</strong></span>, or a pair of files whose names are
+ <span class="command"><strong>ddns-confgen</strong></span>, or a pair of files whose names are
of the format <code class="filename">K{name}.+157.+{random}.key</code> and
<code class="filename">K{name}.+157.+{random}.private</code>, which can be
- generated by <span><strong class="command">dnssec-keygen</strong></span>.
+ generated by <span class="command"><strong>dnssec-keygen</strong></span>.
The <code class="option">-k</code> may also be used to specify a SIG(0) key used
to authenticate Dynamic DNS update requests. In this case, the key
specified is not an HMAC-MD5 key.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-l</span></dt>
-<dd><p>
+<dd>
+ <p>
Local-host only mode. This sets the server address to
- localhost (disabling the <span><strong class="command">server</strong></span> so that the server
+ localhost (disabling the <span class="command"><strong>server</strong></span> so that the server
address cannot be overridden). Connections to the local server will
use a TSIG key found in <code class="filename">/var/run/named/session.key</code>,
- which is automatically generated by <span><strong class="command">named</strong></span> if any
- local master zone has set <span><strong class="command">update-policy</strong></span> to
- <span><strong class="command">local</strong></span>. The location of this key file can be
+ which is automatically generated by <span class="command"><strong>named</strong></span> if any
+ local master zone has set <span class="command"><strong>update-policy</strong></span> to
+ <span class="command"><strong>local</strong></span>. The location of this key file can be
overridden with the <code class="option">-k</code> option.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-L <em class="replaceable"><code>level</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the logging debug level. If zero, logging is disabled.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the port to use for connections to a name server. The
default is 53.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-P</span></dt>
-<dd><p>
+<dd>
+ <p>
Print the list of private BIND-specific resource record
types whose format is understood
- by <span><strong class="command">nsupdate</strong></span>. See also
+ by <span class="command"><strong>nsupdate</strong></span>. See also
the <code class="option">-T</code> option.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-r <em class="replaceable"><code>udpretries</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The number of UDP retries. The default is 3. If zero, only
one update request will be made.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-R <em class="replaceable"><code>randomdev</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Where to obtain randomness. If the operating system
does not provide a <code class="filename">/dev/random</code> or
equivalent device, the default source of randomness is keyboard
instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard input
should be used. This option may be specified multiple times.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-t <em class="replaceable"><code>timeout</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The maximum time an update request can take before it is
aborted. The default is 300 seconds. Zero can be used to
disable the timeout.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-T</span></dt>
<dd>
-<p>
+ <p>
Print the list of IANA standard resource record types
- whose format is understood by <span><strong class="command">nsupdate</strong></span>.
- <span><strong class="command">nsupdate</strong></span> will exit after the lists are
+ whose format is understood by <span class="command"><strong>nsupdate</strong></span>.
+ <span class="command"><strong>nsupdate</strong></span> will exit after the lists are
printed. The <code class="option">-T</code> option can be combined
with the <code class="option">-P</code> option.
</p>
-<p>
+ <p>
Other types can be entered using "TYPEXXXXX" where "XXXXX" is the
decimal value of the type with no leading zeros. The rdata,
if present, will be parsed using the UNKNOWN rdata format,
(<backslash> <hash> <space> <length>
<space> <hexstring>).
</p>
-</dd>
+ </dd>
<dt><span class="term">-u <em class="replaceable"><code>udptimeout</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
The UDP retry interval. The default is 3 seconds. If zero,
the interval will be computed from the timeout interval and
number of UDP retries.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-v</span></dt>
-<dd><p>
+<dd>
+ <p>
Use TCP even for small update requests.
- By default, <span><strong class="command">nsupdate</strong></span>
+ By default, <span class="command"><strong>nsupdate</strong></span>
uses UDP to send update requests to the name server unless they are too
large to fit in a UDP request in which case TCP will be used.
TCP may be preferable when a batch of update requests is made.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Print the version number and exit.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></span></dt>
<dd>
-<p>
+ <p>
Literal TSIG authentication key.
<em class="parameter"><code>keyname</code></em> is the name of the key, and
<em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
<code class="literal">hmac-sha512</code>. If <em class="parameter"><code>hmac</code></em>
is not specified, the default is <code class="literal">hmac-md5</code>.
</p>
-<p>
+ <p>
NOTE: Use of the <code class="option">-y</code> option is discouraged because the
shared secret is supplied as a command line argument in clear text.
This may be visible in the output from
- <span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">ps</span>(1)
+ </span>
or in a history file maintained by the user's shell.
</p>
-</dd>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544090"></a><h2>INPUT FORMAT</h2>
-<p><span><strong class="command">nsupdate</strong></span>
+ </div>
+
+ <div class="refsection" title="INPUT FORMAT">
+<a name="idp61114576"></a><h2>INPUT FORMAT</h2>
+
+ <p><span class="command"><strong>nsupdate</strong></span>
reads input from
<em class="parameter"><code>filename</code></em>
or standard input.
Updates will be rejected if the tests for the prerequisite conditions
fail.
</p>
-<p>
+ <p>
Every update request consists of zero or more prerequisites
and zero or more updates.
This allows a suitably authenticated update request to proceed if some
specified resource records are present or missing from the zone.
- A blank input line (or the <span><strong class="command">send</strong></span> command)
+ A blank input line (or the <span class="command"><strong>send</strong></span> command)
causes the
accumulated commands to be sent as one Dynamic DNS update request to the
name server.
</p>
-<p>
+ <p>
The command formats and their meaning are as follows:
</p>
<div class="variablelist"><dl>
<dt><span class="term">
- <span><strong class="command">server</strong></span>
+ <span class="command"><strong>server</strong></span>
{servername}
[port]
</span></dt>
-<dd><p>
+<dd>
+ <p>
Sends all dynamic update requests to the name server
<em class="parameter"><code>servername</code></em>.
When no server statement is provided,
- <span><strong class="command">nsupdate</strong></span>
+ <span class="command"><strong>nsupdate</strong></span>
will send updates to the master server of the correct zone.
The MNAME field of that zone's SOA record will identify the
master
If no port number is specified, the default DNS port number of
53 is
used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">local</strong></span>
+ <span class="command"><strong>local</strong></span>
{address}
[port]
</span></dt>
-<dd><p>
+<dd>
+ <p>
Sends all dynamic update requests using the local
<em class="parameter"><code>address</code></em>.
When no local statement is provided,
- <span><strong class="command">nsupdate</strong></span>
+ <span class="command"><strong>nsupdate</strong></span>
will send updates using an address and port chosen by the
system.
<em class="parameter"><code>port</code></em>
can additionally be used to make requests come from a specific
port.
If no port number is specified, the system will assign one.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">zone</strong></span>
+ <span class="command"><strong>zone</strong></span>
{zonename}
</span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies that all updates are to be made to the zone
<em class="parameter"><code>zonename</code></em>.
If no
<em class="parameter"><code>zone</code></em>
statement is provided,
- <span><strong class="command">nsupdate</strong></span>
+ <span class="command"><strong>nsupdate</strong></span>
will attempt determine the correct zone to update based on the
rest of the input.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">class</strong></span>
+ <span class="command"><strong>class</strong></span>
{classname}
</span></dt>
-<dd><p>
+<dd>
+ <p>
Specify the default class.
If no <em class="parameter"><code>class</code></em> is specified, the
default class is
<em class="parameter"><code>IN</code></em>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">ttl</strong></span>
+ <span class="command"><strong>ttl</strong></span>
{seconds}
</span></dt>
-<dd><p>
+<dd>
+ <p>
Specify the default time to live for records to be added.
The value <em class="parameter"><code>none</code></em> will clear the default
ttl.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">key</strong></span>
+ <span class="command"><strong>key</strong></span>
[hmac:] {keyname}
{secret}
</span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies that all updates are to be TSIG-signed using the
<em class="parameter"><code>keyname</code></em> <em class="parameter"><code>secret</code></em> pair.
If <em class="parameter"><code>hmac</code></em> is specified, then it sets the
signing algorithm in use; the default is
- <code class="literal">hmac-md5</code>. The <span><strong class="command">key</strong></span>
+ <code class="literal">hmac-md5</code>. The <span class="command"><strong>key</strong></span>
command overrides any key specified on the command line via
<code class="option">-y</code> or <code class="option">-k</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">gsstsig</strong></span>
+ <span class="command"><strong>gsstsig</strong></span>
</span></dt>
-<dd><p>
+<dd>
+ <p>
Use GSS-TSIG to sign the updated. This is equivalent to
specifying <code class="option">-g</code> on the command line.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">oldgsstsig</strong></span>
+ <span class="command"><strong>oldgsstsig</strong></span>
</span></dt>
-<dd><p>
+<dd>
+ <p>
Use the Windows 2000 version of GSS-TSIG to sign the updated.
This is equivalent to specifying <code class="option">-o</code> on the
command line.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">realm</strong></span>
+ <span class="command"><strong>realm</strong></span>
{[<span class="optional">realm_name</span>]}
</span></dt>
-<dd><p>
+<dd>
+ <p>
When using GSS-TSIG use <em class="parameter"><code>realm_name</code></em> rather
than the default realm in <code class="filename">krb5.conf</code>. If no
realm is specified the saved realm is cleared.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">check-names</strong></span>
+ <span class="command"><strong>check-names</strong></span>
{[<span class="optional">yes_or_no</span>]}
</span></dt>
-<dd><p>
+<dd>
+ <p>
Turn on or off check-names processing on records to
be added. Check-names has no effect on prerequisites
or records to be deleted. By default check-names
processing is on. If check-names processing fails
the record will not be added to the UPDATE message.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">[<span class="optional">prereq</span>] nxdomain</strong></span>
+ <span class="command"><strong>[<span class="optional">prereq</span>] nxdomain</strong></span>
{domain-name}
</span></dt>
-<dd><p>
+<dd>
+ <p>
Requires that no resource record of any type exists with name
<em class="parameter"><code>domain-name</code></em>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">[<span class="optional">prereq</span>] yxdomain</strong></span>
+ <span class="command"><strong>[<span class="optional">prereq</span>] yxdomain</strong></span>
{domain-name}
</span></dt>
-<dd><p>
+<dd>
+ <p>
Requires that
<em class="parameter"><code>domain-name</code></em>
exists (has as at least one resource record, of any type).
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">[<span class="optional">prereq</span>] nxrrset</strong></span>
+ <span class="command"><strong>[<span class="optional">prereq</span>] nxrrset</strong></span>
{domain-name}
[class]
{type}
</span></dt>
-<dd><p>
+<dd>
+ <p>
Requires that no resource record exists of the specified
<em class="parameter"><code>type</code></em>,
<em class="parameter"><code>class</code></em>
If
<em class="parameter"><code>class</code></em>
is omitted, IN (internet) is assumed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">[<span class="optional">prereq</span>] yxrrset</strong></span>
+ <span class="command"><strong>[<span class="optional">prereq</span>] yxrrset</strong></span>
{domain-name}
[class]
{type}
</span></dt>
-<dd><p>
+<dd>
+ <p>
This requires that a resource record of the specified
<em class="parameter"><code>type</code></em>,
<em class="parameter"><code>class</code></em>
If
<em class="parameter"><code>class</code></em>
is omitted, IN (internet) is assumed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">[<span class="optional">prereq</span>] yxrrset</strong></span>
+ <span class="command"><strong>[<span class="optional">prereq</span>] yxrrset</strong></span>
{domain-name}
[class]
{type}
{data...}
</span></dt>
-<dd><p>
+<dd>
+ <p>
The
<em class="parameter"><code>data</code></em>
from each set of prerequisites of this form
are written in the standard text representation of the resource
record's
RDATA.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">[<span class="optional">update</span>] del[<span class="optional">ete</span>]</strong></span>
+ <span class="command"><strong>[<span class="optional">update</span>] del[<span class="optional">ete</span>]</strong></span>
{domain-name}
[ttl]
[class]
[type [data...]]
</span></dt>
-<dd><p>
+<dd>
+ <p>
Deletes any resource records named
<em class="parameter"><code>domain-name</code></em>.
If
is not supplied. The
<em class="parameter"><code>ttl</code></em>
is ignored, and is only allowed for compatibility.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">[<span class="optional">update</span>] add</strong></span>
+ <span class="command"><strong>[<span class="optional">update</span>] add</strong></span>
{domain-name}
{ttl}
[class]
{type}
{data...}
</span></dt>
-<dd><p>
+<dd>
+ <p>
Adds a new resource record with the specified
<em class="parameter"><code>ttl</code></em>,
<em class="parameter"><code>class</code></em>
and
<em class="parameter"><code>data</code></em>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">show</strong></span>
+ <span class="command"><strong>show</strong></span>
</span></dt>
-<dd><p>
+<dd>
+ <p>
Displays the current message, containing all of the
prerequisites and
updates specified since the last send.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">send</strong></span>
+ <span class="command"><strong>send</strong></span>
</span></dt>
-<dd><p>
+<dd>
+ <p>
Sends the current message. This is equivalent to entering a
blank line.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">answer</strong></span>
+ <span class="command"><strong>answer</strong></span>
</span></dt>
-<dd><p>
+<dd>
+ <p>
Displays the answer.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">debug</strong></span>
+ <span class="command"><strong>debug</strong></span>
</span></dt>
-<dd><p>
+<dd>
+ <p>
Turn on debugging.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">version</strong></span>
+ <span class="command"><strong>version</strong></span>
</span></dt>
-<dd><p>
+<dd>
+ <p>
Print version number.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">
- <span><strong class="command">help</strong></span>
+ <span class="command"><strong>help</strong></span>
</span></dt>
-<dd><p>
+<dd>
+ <p>
Print a list of commands.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-<p>
+
+ <p>
Lines beginning with a semicolon are comments and are ignored.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545012"></a><h2>EXAMPLES</h2>
-<p>
+
+ </div>
+
+ <div class="refsection" title="EXAMPLES">
+<a name="idp61256528"></a><h2>EXAMPLES</h2>
+
+ <p>
The examples below show how
- <span><strong class="command">nsupdate</strong></span>
+ <span class="command"><strong>nsupdate</strong></span>
could be used to insert and delete resource records from the
<span class="type">example.com</span>
zone.
</pre>
<p>
</p>
-<p>
+ <p>
Any A records for
<span class="type">oldhost.example.com</span>
are deleted.
</pre>
<p>
</p>
-<p>
+ <p>
The prerequisite condition gets the name server to check that there
are no resource records of any type for
<span class="type">nickname.example.com</span>.
(The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have
RRSIG, DNSKEY and NSEC records.)
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545056"></a><h2>FILES</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="FILES">
+<a name="idp61262160"></a><h2>FILES</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term"><code class="constant">/etc/resolv.conf</code></span></dt>
-<dd><p>
+<dd>
+ <p>
used to identify default name server
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">/var/run/named/session.key</code></span></dt>
-<dd><p>
+<dd>
+ <p>
sets the default TSIG key for use in local-only mode
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">K{name}.+157.+{random}.key</code></span></dt>
-<dd><p>
+<dd>
+ <p>
base-64 encoding of HMAC-MD5 key created by
- <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
- </p></dd>
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>.
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">K{name}.+157.+{random}.private</code></span></dt>
-<dd><p>
+<dd>
+ <p>
base-64 encoding of HMAC-MD5 key created by
- <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
- </p></dd>
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>.
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545142"></a><h2>SEE ALSO</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61276496"></a><h2>SEE ALSO</h2>
+
+ <p>
<em class="citetitle">RFC 2136</em>,
<em class="citetitle">RFC 3007</em>,
<em class="citetitle">RFC 2104</em>,
<em class="citetitle">RFC 1034</em>,
<em class="citetitle">RFC 2535</em>,
<em class="citetitle">RFC 2931</em>,
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">ddns-confgen</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">ddns-confgen</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545200"></a><h2>BUGS</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="BUGS">
+<a name="idp61283792"></a><h2>BUGS</h2>
+
+ <p>
The TSIG key is redundantly stored in two separate files.
This is a consequence of nsupdate using the DST library
for its cryptographic operations, and may change in future
releases.
</p>
-</div>
+ </div>
+
</div></body>
</html>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-destroy">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-keygen">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-list">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-tokens">
<info>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-checkds
+'\" t
+.\" Title: dnssec-checkds
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 01, 2013
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2013-01-01
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-CHECKDS" "8" "January 01, 2013" "BIND9" "BIND9"
+.TH "DNSSEC\-CHECKDS" "8" "2013\-01\-01" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-checkds \- A DNSSEC delegation consistency checking tool.
+dnssec-checkds \- A DNSSEC delegation consistency checking tool\&.
.SH "SYNOPSIS"
.HP 15
\fBdnssec\-checkds\fR [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-d\ \fR\fB\fIdig\ path\fR\fR] [\fB\-D\ \fR\fB\fIdsfromkey\ path\fR\fR] {zone}
.SH "DESCRIPTION"
.PP
\fBdnssec\-checkds\fR
-verifies the correctness of Delegation Signer (DS) or DNSSEC Lookaside Validation (DLV) resource records for keys in a specified zone.
+verifies the correctness of Delegation Signer (DS) or DNSSEC Lookaside Validation (DLV) resource records for keys in a specified zone\&.
.SH "OPTIONS"
.PP
\-f \fIfile\fR
.RS 4
If a
\fBfile\fR
-is specified, then the zone is read from that file to find the DNSKEY records. If not, then the DNSKEY records for the zone are looked up in the DNS.
+is specified, then the zone is read from that file to find the DNSKEY records\&. If not, then the DNSKEY records for the zone are looked up in the DNS\&.
.RE
.PP
\-l \fIdomain\fR
.RS 4
-Check for a DLV record in the specified lookaside domain, instead of checking for a DS record in the zone's parent. For example, to check for DLV records for "example.com" in ISC's DLV zone, use:
-\fBdnssec\-checkds \-l dlv.isc.org example.com\fR
+Check for a DLV record in the specified lookaside domain, instead of checking for a DS record in the zone\*(Aqs parent\&. For example, to check for DLV records for "example\&.com" in ISC\*(Aqs DLV zone, use:
+\fBdnssec\-checkds \-l dlv\&.isc\&.org example\&.com\fR
.RE
.PP
\-d \fIdig path\fR
.RS 4
Specifies a path to a
\fBdig\fR
-binary. Used for testing.
+binary\&. Used for testing\&.
.RE
.PP
\-D \fIdsfromkey path\fR
.RS 4
Specifies a path to a
\fBdnssec\-dsfromkey\fR
-binary. Used for testing.
+binary\&. Used for testing\&.
.RE
.SH "SEE ALSO"
.PP
-\fBdnssec\-dsfromkey\fR(8),
-\fBdnssec\-keygen\fR(8),
-\fBdnssec\-signzone\fR(8),
+\fBdnssec-dsfromkey\fR(8),
+\fBdnssec-keygen\fR(8),
+\fBdnssec-signzone\fR(8),
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2012\-2014 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2012-2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-checkds">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-checkds</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-checkds">
<a name="man.dnssec-checkds"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-checkds</span> — A DNSSEC delegation consistency checking tool.</p>
+<p>
+ <span class="application">dnssec-checkds</span>
+ — A DNSSEC delegation consistency checking tool.
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-checkds</code> [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-f <em class="replaceable"><code>file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>dig path</code></em></code>] [<code class="option">-D <em class="replaceable"><code>dsfromkey path</code></em></code>] {zone}</p></div>
-<div class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code> [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-f <em class="replaceable"><code>file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>dig path</code></em></code>] [<code class="option">-D <em class="replaceable"><code>dsfromkey path</code></em></code>] {zone}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543434"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-checkds</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-checkds</code>
+ [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>file</code></em></code>]
+ [<code class="option">-d <em class="replaceable"><code>dig path</code></em></code>]
+ [<code class="option">-D <em class="replaceable"><code>dsfromkey path</code></em></code>]
+ {zone}
+ </p></div>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-dsfromkey</code>
+ [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>file</code></em></code>]
+ [<code class="option">-d <em class="replaceable"><code>dig path</code></em></code>]
+ [<code class="option">-D <em class="replaceable"><code>dsfromkey path</code></em></code>]
+ {zone}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60896592"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-checkds</strong></span>
verifies the correctness of Delegation Signer (DS) or DNSSEC
Lookaside Validation (DLV) resource records for keys in a specified
zone.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543446"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60898256"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
If a <code class="option">file</code> is specified, then the zone is
read from that file to find the DNSKEY records. If not,
then the DNSKEY records for the zone are looked up in the DNS.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Check for a DLV record in the specified lookaside domain,
instead of checking for a DS record in the zone's parent.
For example, to check for DLV records for "example.com"
in ISC's DLV zone, use:
- <span><strong class="command">dnssec-checkds -l dlv.isc.org example.com</strong></span>
- </p></dd>
+ <span class="command"><strong>dnssec-checkds -l dlv.isc.org example.com</strong></span>
+ </p>
+ </dd>
<dt><span class="term">-d <em class="replaceable"><code>dig path</code></em></span></dt>
-<dd><p>
- Specifies a path to a <span><strong class="command">dig</strong></span> binary. Used
+<dd>
+ <p>
+ Specifies a path to a <span class="command"><strong>dig</strong></span> binary. Used
for testing.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-D <em class="replaceable"><code>dsfromkey path</code></em></span></dt>
-<dd><p>
- Specifies a path to a <span><strong class="command">dnssec-dsfromkey</strong></span> binary.
+<dd>
+ <p>
+ Specifies a path to a <span class="command"><strong>dnssec-dsfromkey</strong></span> binary.
Used for testing.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543542"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dnssec-dsfromkey</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60913104"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dnssec-dsfromkey</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-signzone</span>(8)
+ </span>,
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543576"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: dnssec\-coverage
+'\" t
+.\" Title: dnssec-coverage
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 11, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-01-11
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "DNSSEC\-COVERAGE" "8" "January 11, 2014" "BIND9" "BIND9"
+.TH "DNSSEC\-COVERAGE" "8" "2014\-01\-11" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-dnssec\-coverage \- checks future DNSKEY coverage for a zone
+dnssec-coverage \- checks future DNSKEY coverage for a zone
.SH "SYNOPSIS"
.HP 16
\fBdnssec\-coverage\fR [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-l\ \fR\fB\fIlength\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-d\ \fR\fB\fIDNSKEY\ TTL\fR\fR] [\fB\-m\ \fR\fB\fImax\ TTL\fR\fR] [\fB\-r\ \fR\fB\fIinterval\fR\fR] [\fB\-c\ \fR\fB\fIcompilezone\ path\fR\fR] [\fB\-k\fR] [\fB\-z\fR] [zone]
.SH "DESCRIPTION"
.PP
\fBdnssec\-coverage\fR
-verifies that the DNSSEC keys for a given zone or a set of zones have timing metadata set properly to ensure no future lapses in DNSSEC coverage.
+verifies that the DNSSEC keys for a given zone or a set of zones have timing metadata set properly to ensure no future lapses in DNSSEC coverage\&.
.PP
If
\fBzone\fR
-is specified, then keys found in the key repository matching that zone are scanned, and an ordered list is generated of the events scheduled for that key (i.e., publication, activation, inactivation, deletion). The list of events is walked in order of occurrence. Warnings are generated if any event is scheduled which could cause the zone to enter a state in which validation failures might occur: for example, if the number of published or active keys for a given algorithm drops to zero, or if a key is deleted from the zone too soon after a new key is rolled, and cached data signed by the prior key has not had time to expire from resolver caches.
+is specified, then keys found in the key repository matching that zone are scanned, and an ordered list is generated of the events scheduled for that key (i\&.e\&., publication, activation, inactivation, deletion)\&. The list of events is walked in order of occurrence\&. Warnings are generated if any event is scheduled which could cause the zone to enter a state in which validation failures might occur: for example, if the number of published or active keys for a given algorithm drops to zero, or if a key is deleted from the zone too soon after a new key is rolled, and cached data signed by the prior key has not had time to expire from resolver caches\&.
.PP
If
\fBzone\fR
-is not specified, then all keys in the key repository will be scanned, and all zones for which there are keys will be analyzed. (Note: This method of reporting is only accurate if all the zones that have keys in a given repository share the same TTL parameters.)
+is not specified, then all keys in the key repository will be scanned, and all zones for which there are keys will be analyzed\&. (Note: This method of reporting is only accurate if all the zones that have keys in a given repository share the same TTL parameters\&.)
.SH "OPTIONS"
.PP
\-K \fIdirectory\fR
.RS 4
-Sets the directory in which keys can be found. Defaults to the current working directory.
+Sets the directory in which keys can be found\&. Defaults to the current working directory\&.
.RE
.PP
\-f \fIfile\fR
\fB\-m\fR
and
\fB\-d\fR
-options do not need to be specified on the command line.
+options do not need to be specified on the command line\&.
.RE
.PP
\-l \fIduration\fR
.RS 4
-The length of time to check for DNSSEC coverage. Key events scheduled further into the future than
+The length of time to check for DNSSEC coverage\&. Key events scheduled further into the future than
\fBduration\fR
-will be ignored, and assumed to be correct.
+will be ignored, and assumed to be correct\&.
.sp
The value of
\fBduration\fR
-can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
+can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&.
.RE
.PP
\-m \fImaximum TTL\fR
.RS 4
-Sets the value to be used as the maximum TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure. When a zone\-signing key is deactivated, there must be enough time for the record in the zone with the longest TTL to have expired from resolver caches before that key can be purged from the DNSKEY RRset. If that condition does not apply, a warning will be generated.
+Sets the value to be used as the maximum TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure\&. When a zone\-signing key is deactivated, there must be enough time for the record in the zone with the longest TTL to have expired from resolver caches before that key can be purged from the DNSKEY RRset\&. If that condition does not apply, a warning will be generated\&.
.sp
-The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
+The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&.
.sp
This option is mandatory unless the
\fB\-f\fR
-has been used to specify a zone file. (If
+has been used to specify a zone file\&. (If
\fB\-f\fR
-has been specified, this option may still be used; it will override the value found in the file.)
+has been specified, this option may still be used; it will override the value found in the file\&.)
.RE
.PP
\-d \fIDNSKEY TTL\fR
.RS 4
-Sets the value to be used as the DNSKEY TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure. When a key is rolled (that is, replaced with a new key), there must be enough time for the old DNSKEY RRset to have expired from resolver caches before the new key is activated and begins generating signatures. If that condition does not apply, a warning will be generated.
+Sets the value to be used as the DNSKEY TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure\&. When a key is rolled (that is, replaced with a new key), there must be enough time for the old DNSKEY RRset to have expired from resolver caches before the new key is activated and begins generating signatures\&. If that condition does not apply, a warning will be generated\&.
.sp
-The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
+The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&.
.sp
This option is mandatory unless the
\fB\-f\fR
has been used to specify a zone file, or a default key TTL was set with the
\fB\-L\fR
to
-\fBdnssec\-keygen\fR. (If either of those is true, this option may still be used; it will override the value found in the zone or key file.)
+\fBdnssec\-keygen\fR\&. (If either of those is true, this option may still be used; it will override the value found in the zone or key file\&.)
.RE
.PP
\-r \fIresign interval\fR
.RS 4
-Sets the value to be used as the resign interval for the zone or zones being analyzed when determining whether there is a possibility of validation failure. This value defaults to 22.5 days, which is also the default in
-\fBnamed\fR. However, if it has been changed by the
+Sets the value to be used as the resign interval for the zone or zones being analyzed when determining whether there is a possibility of validation failure\&. This value defaults to 22\&.5 days, which is also the default in
+\fBnamed\fR\&. However, if it has been changed by the
\fBsig\-validity\-interval\fR
option in
-\fInamed.conf\fR, then it should also be changed here.
+named\&.conf, then it should also be changed here\&.
.sp
-The length of the interval can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
+The length of the interval can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&.
.RE
.PP
\-k
.RS 4
-Only check KSK coverage; ignore ZSK events. Cannot be used with
-\fB\-z\fR.
+Only check KSK coverage; ignore ZSK events\&. Cannot be used with
+\fB\-z\fR\&.
.RE
.PP
\-z
.RS 4
-Only check ZSK coverage; ignore KSK events. Cannot be used with
-\fB\-k\fR.
+Only check ZSK coverage; ignore KSK events\&. Cannot be used with
+\fB\-k\fR\&.
.RE
.PP
\-c \fIcompilezone path\fR
.RS 4
Specifies a path to a
\fBnamed\-compilezone\fR
-binary. Used for testing.
+binary\&. Used for testing\&.
.RE
.SH "SEE ALSO"
.PP
-\fBdnssec\-checkds\fR(8),
-\fBdnssec\-dsfromkey\fR(8),
-\fBdnssec\-keygen\fR(8),
-\fBdnssec\-signzone\fR(8)
+\fBdnssec-checkds\fR(8),
+\fBdnssec-dsfromkey\fR(8),
+\fBdnssec-keygen\fR(8),
+\fBdnssec-signzone\fR(8)
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-coverage">
<info>
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-coverage</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-coverage">
<a name="man.dnssec-coverage"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">dnssec-coverage</span> — checks future DNSKEY coverage for a zone</p>
+<p>
+ <span class="application">dnssec-coverage</span>
+ — checks future DNSKEY coverage for a zone
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">dnssec-coverage</code> [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-l <em class="replaceable"><code>length</code></em></code>] [<code class="option">-f <em class="replaceable"><code>file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>DNSKEY TTL</code></em></code>] [<code class="option">-m <em class="replaceable"><code>max TTL</code></em></code>] [<code class="option">-r <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-c <em class="replaceable"><code>compilezone path</code></em></code>] [<code class="option">-k</code>] [<code class="option">-z</code>] [zone]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543419"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">dnssec-coverage</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">dnssec-coverage</code>
+ [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
+ [<code class="option">-l <em class="replaceable"><code>length</code></em></code>]
+ [<code class="option">-f <em class="replaceable"><code>file</code></em></code>]
+ [<code class="option">-d <em class="replaceable"><code>DNSKEY TTL</code></em></code>]
+ [<code class="option">-m <em class="replaceable"><code>max TTL</code></em></code>]
+ [<code class="option">-r <em class="replaceable"><code>interval</code></em></code>]
+ [<code class="option">-c <em class="replaceable"><code>compilezone path</code></em></code>]
+ [<code class="option">-k</code>]
+ [<code class="option">-z</code>]
+ [zone]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60896080"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>dnssec-coverage</strong></span>
verifies that the DNSSEC keys for a given zone or a set of zones
have timing metadata set properly to ensure no future lapses in DNSSEC
coverage.
</p>
-<p>
+ <p>
If <code class="option">zone</code> is specified, then keys found in
the key repository matching that zone are scanned, and an ordered
list is generated of the events scheduled for that key (i.e.,
key is rolled, and cached data signed by the prior key has not had
time to expire from resolver caches.
</p>
-<p>
+ <p>
If <code class="option">zone</code> is not specified, then all keys in the
key repository will be scanned, and all zones for which there are
keys will be analyzed. (Note: This method of reporting is only
accurate if all the zones that have keys in a given repository
share the same TTL parameters.)
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543444"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60899280"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the directory in which keys can be found. Defaults to the
current working directory.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
If a <code class="option">file</code> is specified, then the zone is
read from that file; the largest TTL and the DNSKEY TTL are
determined directly from the zone data, and the
<code class="option">-m</code> and <code class="option">-d</code> options do
not need to be specified on the command line.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-l <em class="replaceable"><code>duration</code></em></span></dt>
<dd>
-<p>
+ <p>
The length of time to check for DNSSEC coverage. Key events
scheduled further into the future than <code class="option">duration</code>
will be ignored, and assumed to be correct.
</p>
-<p>
+ <p>
The value of <code class="option">duration</code> can be set in seconds,
or in larger units of time by adding a suffix: 'mi' for minutes,
'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months,
'y' for years.
</p>
-</dd>
+ </dd>
<dt><span class="term">-m <em class="replaceable"><code>maximum TTL</code></em></span></dt>
<dd>
-<p>
+ <p>
Sets the value to be used as the maximum TTL for the zone or
zones being analyzed when determining whether there is a
possibility of validation failure. When a zone-signing key is
before that key can be purged from the DNSKEY RRset. If that
condition does not apply, a warning will be generated.
</p>
-<p>
+ <p>
The length of the TTL can be set in seconds, or in larger units
of time by adding a suffix: 'mi' for minutes, 'h' for hours,
'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
</p>
-<p>
+ <p>
This option is mandatory unless the <code class="option">-f</code> has
been used to specify a zone file. (If <code class="option">-f</code> has
been specified, this option may still be used; it will override
the value found in the file.)
</p>
-</dd>
+ </dd>
<dt><span class="term">-d <em class="replaceable"><code>DNSKEY TTL</code></em></span></dt>
<dd>
-<p>
+ <p>
Sets the value to be used as the DNSKEY TTL for the zone or
zones being analyzed when determining whether there is a
possibility of validation failure. When a key is rolled (that
signatures. If that condition does not apply, a warning
will be generated.
</p>
-<p>
+ <p>
The length of the TTL can be set in seconds, or in larger units
of time by adding a suffix: 'mi' for minutes, 'h' for hours,
'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
</p>
-<p>
+ <p>
This option is mandatory unless the <code class="option">-f</code> has
been used to specify a zone file, or a default key TTL was
set with the <code class="option">-L</code> to
- <span><strong class="command">dnssec-keygen</strong></span>. (If either of those is true,
+ <span class="command"><strong>dnssec-keygen</strong></span>. (If either of those is true,
this option may still be used; it will override the value found
in the zone or key file.)
</p>
-</dd>
+ </dd>
<dt><span class="term">-r <em class="replaceable"><code>resign interval</code></em></span></dt>
<dd>
-<p>
+ <p>
Sets the value to be used as the resign interval for the zone
or zones being analyzed when determining whether there is a
possibility of validation failure. This value defaults to
22.5 days, which is also the default in
- <span><strong class="command">named</strong></span>. However, if it has been changed
+ <span class="command"><strong>named</strong></span>. However, if it has been changed
by the <code class="option">sig-validity-interval</code> option in
<code class="filename">named.conf</code>, then it should also be
changed here.
</p>
-<p>
+ <p>
The length of the interval can be set in seconds, or in larger
units of time by adding a suffix: 'mi' for minutes, 'h' for hours,
'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
</p>
-</dd>
+ </dd>
<dt><span class="term">-k</span></dt>
-<dd><p>
+<dd>
+ <p>
Only check KSK coverage; ignore ZSK events. Cannot be
used with <code class="option">-z</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-z</span></dt>
-<dd><p>
+<dd>
+ <p>
Only check ZSK coverage; ignore KSK events. Cannot be
used with <code class="option">-k</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>compilezone path</code></em></span></dt>
-<dd><p>
- Specifies a path to a <span><strong class="command">named-compilezone</strong></span> binary.
+<dd>
+ <p>
+ Specifies a path to a <span class="command"><strong>named-compilezone</strong></span> binary.
Used for testing.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543745"></a><h2>SEE ALSO</h2>
-<p>
- <span class="citerefentry"><span class="refentrytitle">dnssec-checkds</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-dsfromkey</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>
- </p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543788"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60930384"></a><h2>SEE ALSO</h2>
+
+ <p>
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-checkds</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-dsfromkey</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-keygen</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">dnssec-signzone</span>(8)
+ </span>
</p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: rndc
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: August 15, 2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2014-08-15
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "RNDC" "8" "August 15, 2014" "BIND9" "BIND9"
+.TH "RNDC" "8" "2014\-08\-15" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
rndc \- name server control utility
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBrndc\fR
-controls the operation of a name server. It supersedes the
+controls the operation of a name server\&. It supersedes the
\fBndc\fR
-utility that was provided in old BIND releases. If
+utility that was provided in old BIND releases\&. If
\fBrndc\fR
-is invoked with no command line options or arguments, it prints a short summary of the supported commands and the available options and their arguments.
+is invoked with no command line options or arguments, it prints a short summary of the supported commands and the available options and their arguments\&.
.PP
\fBrndc\fR
-communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of
+communicates with the name server over a TCP connection, sending commands authenticated with digital signatures\&. In the current versions of
\fBrndc\fR
and
-\fBnamed\fR, the only supported authentication algorithms are HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512. They use a shared secret on each end of the connection. This provides TSIG\-style authentication for the command request and the name server's response. All commands sent over the channel must be signed by a key_id known to the server.
+\fBnamed\fR, the only supported authentication algorithms are HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512\&. They use a shared secret on each end of the connection\&. This provides TSIG\-style authentication for the command request and the name server\*(Aqs response\&. All commands sent over the channel must be signed by a key_id known to the server\&.
.PP
\fBrndc\fR
-reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use.
+reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use\&.
.SH "OPTIONS"
.PP
\-b \fIsource\-address\fR
.RS 4
Use
\fIsource\-address\fR
-as the source address for the connection to the server. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses.
+as the source address for the connection to the server\&. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses\&.
.RE
.PP
\-c \fIconfig\-file\fR
Use
\fIconfig\-file\fR
as the configuration file instead of the default,
-\fI/etc/rndc.conf\fR.
+/etc/rndc\&.conf\&.
.RE
.PP
\-k \fIkey\-file\fR
Use
\fIkey\-file\fR
as the key file instead of the default,
-\fI/etc/rndc.key\fR. The key in
-\fI/etc/rndc.key\fR
+/etc/rndc\&.key\&. The key in
+/etc/rndc\&.key
will be used to authenticate commands sent to the server if the
\fIconfig\-file\fR
-does not exist.
+does not exist\&.
.RE
.PP
\-s \fIserver\fR
.RS 4
\fIserver\fR
is the name or address of the server which matches a server statement in the configuration file for
-\fBrndc\fR. If no server is supplied on the command line, the host named by the default\-server clause in the options statement of the
+\fBrndc\fR\&. If no server is supplied on the command line, the host named by the default\-server clause in the options statement of the
\fBrndc\fR
-configuration file will be used.
+configuration file will be used\&.
.RE
.PP
\-p \fIport\fR
.RS 4
Send commands to TCP port
\fIport\fR
-instead of BIND 9's default control channel port, 953.
+instead of BIND 9\*(Aqs default control channel port, 953\&.
.RE
.PP
\-q
.RS 4
-Quiet mode: Message text returned by the server will not be printed except when there is an error.
+Quiet mode: Message text returned by the server will not be printed except when there is an error\&.
.RE
.PP
\-r
\fBrndc\fR
to print the result code returned by
\fBnamed\fR
-after executing the requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc).
+after executing the requested command (e\&.g\&., ISC_R_SUCCESS, ISC_R_FAILURE, etc)\&.
.RE
.PP
\-V
.RS 4
-Enable verbose logging.
+Enable verbose logging\&.
.RE
.PP
\-y \fIkey_id\fR
.RS 4
Use the key
\fIkey_id\fR
-from the configuration file.
+from the configuration file\&.
\fIkey_id\fR
must be known by
\fBnamed\fR
-with the same algorithm and secret string in order for control message validation to succeed. If no
+with the same algorithm and secret string in order for control message validation to succeed\&. If no
\fIkey_id\fR
is specified,
\fBrndc\fR
-will first look for a key clause in the server statement of the server being used, or if no server statement is present for that host, then the default\-key clause of the options statement. Note that the configuration file contains shared secrets which are used to send authenticated control commands to name servers. It should therefore not have general read or write access.
+will first look for a key clause in the server statement of the server being used, or if no server statement is present for that host, then the default\-key clause of the options statement\&. Note that the configuration file contains shared secrets which are used to send authenticated control commands to name servers\&. It should therefore not have general read or write access\&.
.RE
.SH "COMMANDS"
.PP
\fBrndc\fR
can be seen by running
\fBrndc\fR
-without arguments.
+without arguments\&.
.PP
Currently supported commands are:
.PP
\fBaddzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR\fB\fIconfiguration\fR\fR\fB \fR
.RS 4
-Add a zone while the server is running. This command requires the
+Add a zone while the server is running\&. This command requires the
\fBallow\-new\-zones\fR
option to be set to
-\fByes\fR. The
+\fByes\fR\&. The
\fIconfiguration\fR
string specified on the command line is the zone configuration text that would ordinarily be placed in
-\fInamed.conf\fR.
+named\&.conf\&.
.sp
The configuration is saved in a file called
-\fI\fIname\fR\fR\fI.nzf\fR, where
+\fIname\fR\&.nzf, where
\fIname\fR
-is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view. When
+is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view\&. When
\fBnamed\fR
-is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart.
+is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart\&.
.sp
This sample
\fBaddzone\fR
command would add the zone
-example.com
+example\&.com
to the default view:
.sp
-$\fBrndc addzone example.com '{ type master; file "example.com.db"; };'\fR
+$\fBrndc addzone example\&.com \*(Aq{ type master; file "example\&.com\&.db"; };\*(Aq\fR
.sp
-(Note the brackets and semi\-colon around the zone configuration text.)
+(Note the brackets and semi\-colon around the zone configuration text\&.)
.sp
See also
\fBrndc delzone\fR
and
-\fBrndc modzone\fR.
+\fBrndc modzone\fR\&.
.RE
.PP
\fBdelzone \fR\fB[\-clean]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR
.RS 4
-Delete a zone while the server is running.
+Delete a zone while the server is running\&.
.sp
If the
\fB\-clean\fR
-argument is specified, the zone's master file (and journal file, if any) will be deleted along with the zone. Without the
+argument is specified, the zone\*(Aqs master file (and journal file, if any) will be deleted along with the zone\&. Without the
\fB\-clean\fR
-option, zone files must be cleaned up by hand. (If the zone is of type "slave" or "stub", the files needing to be cleaned up will be reported in the output of the
+option, zone files must be cleaned up by hand\&. (If the zone is of type "slave" or "stub", the files needing to be cleaned up will be reported in the output of the
\fBrndc delzone\fR
-command.)
+command\&.)
.sp
If the zone was originally added via
-\fBrndc addzone\fR, then it will be removed permanently. However, if it was originally configured in
-\fInamed.conf\fR, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will come back. To remove it permanently, it must also be removed from
-\fInamed.conf\fR
+\fBrndc addzone\fR, then it will be removed permanently\&. However, if it was originally configured in
+named\&.conf, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will come back\&. To remove it permanently, it must also be removed from
+named\&.conf
.sp
See also
\fBrndc addzone\fR
and
-\fBrndc modzone\fR.
+\fBrndc modzone\fR\&.
.RE
.PP
-\fBdumpdb \fR\fB[\-all|\-cache|\-zone|\-adb|\-bad|\-fail]\fR\fB \fR\fB[\fIview ...\fR]\fR
+\fBdumpdb \fR\fB[\-all|\-cache|\-zone|\-adb|\-bad|\-fail]\fR\fB \fR\fB[\fIview \&.\&.\&.\fR]\fR
.RS 4
-Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all views are dumped. (See the
+Dump the server\*(Aqs caches (default) and/or zones to the dump file for the specified views\&. If no view is specified, all views are dumped\&. (See the
\fBdump\-file\fR
-option in the BIND 9 Administrator Reference Manual.)
+option in the BIND 9 Administrator Reference Manual\&.)
.RE
.PP
\fBflush\fR
.RS 4
-Flushes the server's cache.
+Flushes the server\*(Aqs cache\&.
.RE
.PP
\fBflushname\fR \fIname\fR [\fIview\fR]
.RS 4
-Flushes the given name from the view's DNS cache and, if applicable, from the view's nameserver address database, bad server cache and SERVFAIL cache.
+Flushes the given name from the view\*(Aqs DNS cache and, if applicable, from the view\*(Aqs nameserver address database, bad server cache and SERVFAIL cache\&.
.RE
.PP
\fBflushtree\fR \fIname\fR [\fIview\fR]
.RS 4
-Flushes the given name, and all of its subdomains, from the view's DNS cache, address database, bad server cache, and SERVFAIL cache.
+Flushes the given name, and all of its subdomains, from the view\*(Aqs DNS cache, address database, bad server cache, and SERVFAIL cache\&.
.RE
.PP
\fBfreeze \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
.RS 4
-Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by dynamic update. It also causes changes in the journal file to be synced into the master file. All dynamic update attempts will be refused while the zone is frozen.
+Suspend updates to a dynamic zone\&. If no zone is specified, then all zones are suspended\&. This allows manual edits to be made to a zone normally updated by dynamic update\&. It also causes changes in the journal file to be synced into the master file\&. All dynamic update attempts will be refused while the zone is frozen\&.
.sp
See also
-\fBrndc thaw\fR.
+\fBrndc thaw\fR\&.
.RE
.PP
\fBhalt \fR\fB[\-p]\fR
.RS 4
-Stop the server immediately. Recent changes made through dynamic update or IXFR are not saved to the master files, but will be rolled forward from the journal files when the server is restarted. If
+Stop the server immediately\&. Recent changes made through dynamic update or IXFR are not saved to the master files, but will be rolled forward from the journal files when the server is restarted\&. If
\fB\-p\fR
is specified
-\fBnamed\fR's process id is returned. This allows an external process to determine when
+\fBnamed\fR\*(Aqs process id is returned\&. This allows an external process to determine when
\fBnamed\fR
-had completed halting.
+had completed halting\&.
.sp
See also
-\fBrndc stop\fR.
+\fBrndc stop\fR\&.
.RE
.PP
\fBloadkeys \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
-Fetch all DNSSEC keys for the given zone from the key directory. If they are within their publication period, merge them into the zone's DNSKEY RRset. Unlike
-\fBrndc sign\fR, however, the zone is not immediately re\-signed by the new keys, but is allowed to incrementally re\-sign over time.
+Fetch all DNSSEC keys for the given zone from the key directory\&. If they are within their publication period, merge them into the zone\*(Aqs DNSKEY RRset\&. Unlike
+\fBrndc sign\fR, however, the zone is not immediately re\-signed by the new keys, but is allowed to incrementally re\-sign over time\&.
.sp
This command requires that the
\fBauto\-dnssec\fR
zone option be set to
-maintain, and also requires the zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)
+maintain, and also requires the zone to be configured to allow dynamic DNS\&. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details\&.)
.RE
.PP
\fBmanaged\-keys \fR\fB\fI(status | refresh | sync)\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
-When run with the "status" keyword, print the current status of the managed\-keys database for the specified view, or for all views if none is specified. When run with the "refresh" keyword, force an immediate refresh of all the managed\-keys in the specified view, or all views. When run with the "sync" keyword, force an immediate dump of the managed\-keys database to disk (in the file
-\fImanaged\-keys.bind\fR
-or (\fI\fIviewname\fR\fR\fI.mkeys\fR).
+When run with the "status" keyword, print the current status of the managed\-keys database for the specified view, or for all views if none is specified\&. When run with the "refresh" keyword, force an immediate refresh of all the managed\-keys in the specified view, or all views\&. When run with the "sync" keyword, force an immediate dump of the managed\-keys database to disk (in the file
+managed\-keys\&.bind
+or (\fIviewname\fR\&.mkeys)\&.
.RE
.PP
\fBmodzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR\fB\fIconfiguration\fR\fR\fB \fR
.RS 4
-Modify the configuration of a zone while the server is running. This command requires the
+Modify the configuration of a zone while the server is running\&. This command requires the
\fBallow\-new\-zones\fR
option to be set to
-\fByes\fR. As with
+\fByes\fR\&. As with
\fBaddzone\fR, the
\fIconfiguration\fR
string specified on the command line is the zone configuration text that would ordinarily be placed in
-\fInamed.conf\fR.
+named\&.conf\&.
.sp
If the zone was originally added via
-\fBrndc addzone\fR, the configuration changes will be recorded permanently and will still be in effect after the server is restarted or reconfigured. However, if it was originally configured in
-\fInamed.conf\fR, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will revert to its original configuration. To make the changes permanent, it must also be modified in
-\fInamed.conf\fR
+\fBrndc addzone\fR, the configuration changes will be recorded permanently and will still be in effect after the server is restarted or reconfigured\&. However, if it was originally configured in
+named\&.conf, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will revert to its original configuration\&. To make the changes permanent, it must also be modified in
+named\&.conf
.sp
See also
\fBrndc addzone\fR
and
-\fBrndc delzone\fR.
+\fBrndc delzone\fR\&.
.RE
.PP
\fBnotify \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
-Resend NOTIFY messages for the zone.
+Resend NOTIFY messages for the zone\&.
.RE
.PP
\fBnotrace\fR
.RS 4
-Sets the server's debugging level to 0.
+Sets the server\*(Aqs debugging level to 0\&.
.sp
See also
-\fBrndc trace\fR.
+\fBrndc trace\fR\&.
.RE
.PP
\fBnta \fR\fB[( \-d | \-f | \-r | \-l \fIduration\fR)]\fR\fB \fR\fB\fIdomain\fR\fR\fB \fR\fB[\fIview\fR]\fR\fB \fR
.RS 4
Sets a DNSSEC negative trust anchor (NTA) for
\fBdomain\fR, with a lifetime of
-\fBduration\fR. The default lifetime is configured in
-\fInamed.conf\fR
+\fBduration\fR\&. The default lifetime is configured in
+named\&.conf
via the
\fBnta\-lifetime\fR
-option, and defaults to one hour. The lifetime cannot exceed one week.
+option, and defaults to one hour\&. The lifetime cannot exceed one week\&.
.sp
-A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration rather than an attack. When data to be validated is at or below an active NTA (and above any other configured trust anchors),
+A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration rather than an attack\&. When data to be validated is at or below an active NTA (and above any other configured trust anchors),
\fBnamed\fR
-will abort the DNSSEC validation process and treat the data as insecure rather than bogus. This continues until the NTA's lifetime is elapsed.
+will abort the DNSSEC validation process and treat the data as insecure rather than bogus\&. This continues until the NTA\*(Aqs lifetime is elapsed\&.
.sp
NTAs persist across restarts of the
\fBnamed\fR
-server. The NTAs for a view are saved in a file called
-\fI\fIname\fR\fR\fI.nta\fR, where
+server\&. The NTAs for a view are saved in a file called
+\fIname\fR\&.nta, where
\fIname\fR
-is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view.
+is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view\&.
.sp
An existing NTA can be removed by using the
\fB\-remove\fR
-option.
+option\&.
.sp
-An NTA's lifetime can be specified with the
+An NTA\*(Aqs lifetime can be specified with the
\fB\-lifetime\fR
-option. TTL\-style suffixes can be used to specify the lifetime in seconds, minutes, or hours. If the specified NTA already exists, its lifetime will be updated to the new value. Setting
+option\&. TTL\-style suffixes can be used to specify the lifetime in seconds, minutes, or hours\&. If the specified NTA already exists, its lifetime will be updated to the new value\&. Setting
\fBlifetime\fR
to zero is equivalent to
-\fB\-remove\fR.
+\fB\-remove\fR\&.
.sp
If
\fB\-dump\fR
-is used, any other arguments are ignored, and a list of existing NTAs is printed (note that this may include NTAs that are expired but have not yet been cleaned up).
+is used, any other arguments are ignored, and a list of existing NTAs is printed (note that this may include NTAs that are expired but have not yet been cleaned up)\&.
.sp
Normally,
\fBnamed\fR
will periodically test to see whether data below an NTA can now be validated (see the
\fBnta\-recheck\fR
-option in the Administrator Reference Manual for details). If data can be validated, then the NTA is regarded as no longer necessary, and will be allowed to expire early. The
+option in the Administrator Reference Manual for details)\&. If data can be validated, then the NTA is regarded as no longer necessary, and will be allowed to expire early\&. The
\fB\-force\fR
-overrides this behavior and forces an NTA to persist for its entire lifetime, regardless of whether data could be validated if the NTA were not present.
+overrides this behavior and forces an NTA to persist for its entire lifetime, regardless of whether data could be validated if the NTA were not present\&.
.sp
-All of these options can be shortened, i.e., to
+All of these options can be shortened, i\&.e\&., to
\fB\-l\fR,
\fB\-r\fR,
\fB\-d\fR, and
-\fB\-f\fR.
+\fB\-f\fR\&.
.RE
.PP
\fBquerylog\fR [on|off]
.RS 4
-Enable or disable query logging. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off.)
+Enable or disable query logging\&. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off\&.)
.sp
Query logging can also be enabled by explicitly directing the
\fBqueries\fR
in the
\fBlogging\fR
section of
-\fInamed.conf\fR
+named\&.conf
or by specifying
\fBquerylog yes;\fR
in the
\fBoptions\fR
section of
-\fInamed.conf\fR.
+named\&.conf\&.
.RE
.PP
\fBreconfig\fR
.RS 4
-Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed. This is faster than a full
+Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed\&. This is faster than a full
\fBreload\fR
-when there is a large number of zones because it avoids the need to examine the modification times of the zones files.
+when there is a large number of zones because it avoids the need to examine the modification times of the zones files\&.
.RE
.PP
\fBrecursing\fR
.RS 4
Dump the list of queries
\fBnamed\fR
-is currently recursing on, and the list of domains to which iterative queries are currently being sent. (The second list includes the number of fetches currently active for the given domain, and how many have been passed or dropped because of the
+is currently recursing on, and the list of domains to which iterative queries are currently being sent\&. (The second list includes the number of fetches currently active for the given domain, and how many have been passed or dropped because of the
\fBfetches\-per\-zone\fR
-option.)
+option\&.)
.RE
.PP
\fBrefresh \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
-Schedule zone maintenance for the given zone.
+Schedule zone maintenance for the given zone\&.
.RE
.PP
\fBreload\fR
.RS 4
-Reload configuration file and zones.
+Reload configuration file and zones\&.
.RE
.PP
\fBreload \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
-Reload the given zone.
+Reload the given zone\&.
.RE
.PP
\fBretransfer \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
-Retransfer the given slave zone from the master server.
+Retransfer the given slave zone from the master server\&.
.sp
If the zone is configured to use
-\fBinline\-signing\fR, the signed version of the zone is discarded; after the retransfer of the unsigned version is complete, the signed version will be regenerated with all new signatures.
+\fBinline\-signing\fR, the signed version of the zone is discarded; after the retransfer of the unsigned version is complete, the signed version will be regenerated with all new signatures\&.
.RE
.PP
\fBscan\fR
\fBreconfig\fR
or waiting for the
\fBinterface\-interval\fR
-timer.
+timer\&.
.RE
.PP
-\fBsecroots \fR\fB[\-]\fR\fB \fR\fB[\fIview ...\fR]\fR
+\fBsecroots \fR\fB[\-]\fR\fB \fR\fB[\fIview \&.\&.\&.\fR]\fR
.RS 4
-Dump the server's security roots and negative trust anchors for the specified views. If no view is specified, all views are dumped.
+Dump the server\*(Aqs security roots and negative trust anchors for the specified views\&. If no view is specified, all views are dumped\&.
.sp
If the first argument is "\-", then the output is returned via the
\fBrndc\fR
-response channel and printed to the standard output. Otherwise, it is written to the secroots dump file, which defaults to
-\fInamed.secroots\fR, but can be overridden via the
+response channel and printed to the standard output\&. Otherwise, it is written to the secroots dump file, which defaults to
+named\&.secroots, but can be overridden via the
\fBsecroots\-file\fR
option in
-\fInamed.conf\fR.
+named\&.conf\&.
.sp
See also
-\fBrndc managed\-keys\fR.
+\fBrndc managed\-keys\fR\&.
.RE
.PP
\fBshowzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR
.RS 4
-Print the configuration of a running zone.
+Print the configuration of a running zone\&.
.sp
See also
-\fBrndc zonestatus\fR.
+\fBrndc zonestatus\fR\&.
.RE
.PP
\fBsign \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
Fetch all DNSSEC keys for the given zone from the key directory (see the
\fBkey\-directory\fR
-option in the BIND 9 Administrator Reference Manual). If they are within their publication period, merge them into the zone's DNSKEY RRset. If the DNSKEY RRset is changed, then the zone is automatically re\-signed with the new key set.
+option in the BIND 9 Administrator Reference Manual)\&. If they are within their publication period, merge them into the zone\*(Aqs DNSKEY RRset\&. If the DNSKEY RRset is changed, then the zone is automatically re\-signed with the new key set\&.
.sp
This command requires that the
\fBauto\-dnssec\fR
zone option be set to
allow
or
-maintain, and also requires the zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)
+maintain, and also requires the zone to be configured to allow dynamic DNS\&. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details\&.)
.sp
See also
-\fBrndc loadkeys\fR.
+\fBrndc loadkeys\fR\&.
.RE
.PP
\fBsigning \fR\fB[( \-list | \-clear \fIkeyid/algorithm\fR | \-clear all | \-nsec3param ( \fIparameters\fR | none ) | \-serial \fIvalue\fR ) ]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR
.RS 4
-List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type
-\fBsig\-signing\-type\fR.
+List, edit, or remove the DNSSEC signing state records for the specified zone\&. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type
+\fBsig\-signing\-type\fR\&.
\fBrndc signing \-list\fR
-converts these records into a human\-readable form, indicating which keys are currently signing or have finished signing the zone, and which NSEC3 chains are being created or removed.
+converts these records into a human\-readable form, indicating which keys are currently signing or have finished signing the zone, and which NSEC3 chains are being created or removed\&.
.sp
\fBrndc signing \-clear\fR
can remove a single key (specified in the same format that
\fBrndc signing \-list\fR
-uses to display it), or all keys. In either case, only completed keys are removed; any record indicating that a key has not yet finished signing the zone will be retained.
+uses to display it), or all keys\&. In either case, only completed keys are removed; any record indicating that a key has not yet finished signing the zone will be retained\&.
.sp
\fBrndc signing \-nsec3param\fR
-sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with
+sets the NSEC3 parameters for a zone\&. This is the only supported mechanism for using NSEC3 with
\fBinline\-signing\fR
-zones. Parameters are specified in the same format as an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order.
+zones\&. Parameters are specified in the same format as an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order\&.
.sp
Currently, the only defined value for hash algorithm is
-1, representing SHA\-1. The
+1, representing SHA\-1\&. The
\fBflags\fR
may be set to
0
or
-1, depending on whether you wish to set the opt\-out bit in the NSEC3 chain.
+1, depending on whether you wish to set the opt\-out bit in the NSEC3 chain\&.
\fBiterations\fR
-defines the number of additional times to apply the algorithm when generating an NSEC3 hash. The
+defines the number of additional times to apply the algorithm when generating an NSEC3 hash\&. The
\fBsalt\fR
-is a string of data expressed in hexadecimal, a hyphen (`\-') if no salt is to be used, or the keyword
+is a string of data expressed in hexadecimal, a hyphen (`\-\*(Aq) if no salt is to be used, or the keyword
auto, which causes
\fBnamed\fR
-to generate a random 64\-bit salt.
+to generate a random 64\-bit salt\&.
.sp
So, for example, to create an NSEC3 chain using the SHA\-1 hash algorithm, no opt\-out flag, 10 iterations, and a salt value of "FFFF", use:
-\fBrndc signing \-nsec3param 1 0 10 FFFF \fR\fB\fIzone\fR\fR. To set the opt\-out flag, 15 iterations, and no salt, use:
-\fBrndc signing \-nsec3param 1 1 15 \- \fR\fB\fIzone\fR\fR.
+\fBrndc signing \-nsec3param 1 0 10 FFFF \fR\fB\fIzone\fR\fR\&. To set the opt\-out flag, 15 iterations, and no salt, use:
+\fBrndc signing \-nsec3param 1 1 15 \- \fR\fB\fIzone\fR\fR\&.
.sp
\fBrndc signing \-nsec3param none\fR
-removes an existing NSEC3 chain and replaces it with NSEC.
+removes an existing NSEC3 chain and replaces it with NSEC\&.
.sp
\fBrndc signing \-serial value\fR
-sets the serial number of the zone to value. If the value would cause the serial number to go backwards it will be rejected. The primary use is to set the serial on inline signed zones.
+sets the serial number of the zone to value\&. If the value would cause the serial number to go backwards it will be rejected\&. The primary use is to set the serial on inline signed zones\&.
.RE
.PP
\fBstats\fR
.RS 4
-Write server statistics to the statistics file. (See the
+Write server statistics to the statistics file\&. (See the
\fBstatistics\-file\fR
-option in the BIND 9 Administrator Reference Manual.)
+option in the BIND 9 Administrator Reference Manual\&.)
.RE
.PP
\fBstatus\fR
.RS 4
-Display status of the server. Note that the number of zones includes the internal
+Display status of the server\&. Note that the number of zones includes the internal
\fBbind/CH\fR
zone and the default
-\fB./IN\fR
-hint zone if there is not an explicit root zone configured.
+\fB\&./IN\fR
+hint zone if there is not an explicit root zone configured\&.
.RE
.PP
\fBstop \fR\fB[\-p]\fR
.RS 4
-Stop the server, making sure any recent changes made through dynamic update or IXFR are first saved to the master files of the updated zones. If
+Stop the server, making sure any recent changes made through dynamic update or IXFR are first saved to the master files of the updated zones\&. If
\fB\-p\fR
is specified
-\fBnamed\fR's process id is returned. This allows an external process to determine when
+\fBnamed\fR\*(Aqs process id is returned\&. This allows an external process to determine when
\fBnamed\fR
-had completed stopping.
+had completed stopping\&.
.sp
See also
-\fBrndc halt\fR.
+\fBrndc halt\fR\&.
.RE
.PP
\fBsync \fR\fB[\-clean]\fR\fB \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
.RS 4
-Sync changes in the journal file for a dynamic zone to the master file. If the "\-clean" option is specified, the journal file is also removed. If no zone is specified, then all zones are synced.
+Sync changes in the journal file for a dynamic zone to the master file\&. If the "\-clean" option is specified, the journal file is also removed\&. If no zone is specified, then all zones are synced\&.
.RE
.PP
\fBthaw \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
.RS 4
-Enable updates to a frozen dynamic zone. If no zone is specified, then all frozen zones are enabled. This causes the server to reload the zone from disk, and re\-enables dynamic updates after the load has completed. After a zone is thawed, dynamic updates will no longer be refused. If the zone has changed and the
+Enable updates to a frozen dynamic zone\&. If no zone is specified, then all frozen zones are enabled\&. This causes the server to reload the zone from disk, and re\-enables dynamic updates after the load has completed\&. After a zone is thawed, dynamic updates will no longer be refused\&. If the zone has changed and the
\fBixfr\-from\-differences\fR
-option is in use, then the journal file will be updated to reflect changes in the zone. Otherwise, if the zone has changed, any existing journal file will be removed.
+option is in use, then the journal file will be updated to reflect changes in the zone\&. Otherwise, if the zone has changed, any existing journal file will be removed\&.
.sp
See also
-\fBrndc freeze\fR.
+\fBrndc freeze\fR\&.
.RE
.PP
\fBtrace\fR
.RS 4
-Increment the servers debugging level by one.
+Increment the servers debugging level by one\&.
.RE
.PP
\fBtrace \fR\fB\fIlevel\fR\fR
.RS 4
-Sets the server's debugging level to an explicit value.
+Sets the server\*(Aqs debugging level to an explicit value\&.
.sp
See also
-\fBrndc notrace\fR.
+\fBrndc notrace\fR\&.
.RE
.PP
\fBtsig\-delete\fR \fIkeyname\fR [\fIview\fR]
.RS 4
-Delete a given TKEY\-negotiated key from the server. (This does not apply to statically configured TSIG keys.)
+Delete a given TKEY\-negotiated key from the server\&. (This does not apply to statically configured TSIG keys\&.)
.RE
.PP
\fBtsig\-list\fR
.RS 4
List the names of all TSIG keys currently configured for use by
\fBnamed\fR
-in each view. The list both statically configured keys and dynamic TKEY\-negotiated keys.
+in each view\&. The list both statically configured keys and dynamic TKEY\-negotiated keys\&.
.RE
.PP
-\fBvalidation ( on | off | check ) \fR\fB[\fIview ...\fR]\fR\fB \fR
+\fBvalidation ( on | off | check ) \fR\fB[\fIview \&.\&.\&.\fR]\fR\fB \fR
.RS 4
-Enable, disable, or check the current status of DNSSEC validation. Note
+Enable, disable, or check the current status of DNSSEC validation\&. Note
\fBdnssec\-enable\fR
also needs to be set to
\fByes\fR
or
\fBauto\fR
-to be effective. It defaults to enabled.
+to be effective\&. It defaults to enabled\&.
.RE
.PP
\fBzonestatus \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
-Displays the current status of the given zone, including the master file name and any include files from which it was loaded, when it was most recently loaded, the current serial number, the number of nodes, whether the zone supports dynamic updates, whether the zone is DNSSEC signed, whether it uses automatic DNSSEC key management or inline signing, and the scheduled refresh or expiry times for the zone.
+Displays the current status of the given zone, including the master file name and any include files from which it was loaded, when it was most recently loaded, the current serial number, the number of nodes, whether the zone supports dynamic updates, whether the zone is DNSSEC signed, whether it uses automatic DNSSEC key management or inline signing, and the scheduled refresh or expiry times for the zone\&.
.sp
See also
-\fBrndc showzone\fR.
+\fBrndc showzone\fR\&.
.RE
.SH "LIMITATIONS"
.PP
There is currently no way to provide the shared secret for a
\fBkey_id\fR
-without using the configuration file.
+without using the configuration file\&.
.PP
-Several error messages could be clearer.
+Several error messages could be clearer\&.
.SH "SEE ALSO"
.PP
\fBrndc.conf\fR(5),
-\fBrndc\-confgen\fR(8),
+\fBrndc-confgen\fR(8),
\fBnamed\fR(8),
\fBnamed.conf\fR(5),
\fBndc\fR(8),
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004, 2005, 2007, 2013\-2015 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2004, 2005, 2007, 2013-2015 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
.br
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: \fIrndc.conf\fR
+'\" t
+.\" Title: rndc.conf
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: March 14, 2013
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2013-03-14
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "\fIRNDC.CONF\fR" "5" "March 14, 2013" "BIND9" "BIND9"
+.TH "RNDC\&.CONF" "5" "2013\-03\-14" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
rndc.conf \- rndc configuration file
.SH "SYNOPSIS"
.HP 10
-\fBrndc.conf\fR
+\fBrndc\&.conf\fR
.SH "DESCRIPTION"
.PP
-\fIrndc.conf\fR
+rndc\&.conf
is the configuration file for
-\fBrndc\fR, the BIND 9 name server control utility. This file has a similar structure and syntax to
-\fInamed.conf\fR. Statements are enclosed in braces and terminated with a semi\-colon. Clauses in the statements are also semi\-colon terminated. The usual comment styles are supported:
+\fBrndc\fR, the BIND 9 name server control utility\&. This file has a similar structure and syntax to
+named\&.conf\&. Statements are enclosed in braces and terminated with a semi\-colon\&. Clauses in the statements are also semi\-colon terminated\&. The usual comment styles are supported:
.PP
C style: /* */
.PP
.PP
Unix style: # to end of line
.PP
-\fIrndc.conf\fR
+rndc\&.conf
is much simpler than
-\fInamed.conf\fR. The file uses three statements: an options statement, a server statement and a key statement.
+named\&.conf\&. The file uses three statements: an options statement, a server statement and a key statement\&.
.PP
The
\fBoptions\fR
-statement contains five clauses. The
+statement contains five clauses\&. The
\fBdefault\-server\fR
-clause is followed by the name or address of a name server. This host will be used when no name server is given as an argument to
-\fBrndc\fR. The
+clause is followed by the name or address of a name server\&. This host will be used when no name server is given as an argument to
+\fBrndc\fR\&. The
\fBdefault\-key\fR
clause is followed by the name of a key which is identified by a
\fBkey\fR
-statement. If no
+statement\&. If no
\fBkeyid\fR
is provided on the rndc command line, and no
\fBkey\fR
clause is found in a matching
\fBserver\fR
-statement, this default key will be used to authenticate the server's commands and responses. The
+statement, this default key will be used to authenticate the server\*(Aqs commands and responses\&. The
\fBdefault\-port\fR
-clause is followed by the port to connect to on the remote name server. If no
+clause is followed by the port to connect to on the remote name server\&. If no
\fBport\fR
option is provided on the rndc command line, and no
\fBport\fR
clause is found in a matching
\fBserver\fR
-statement, this default port will be used to connect. The
+statement, this default port will be used to connect\&. The
\fBdefault\-source\-address\fR
and
\fBdefault\-source\-address\-v6\fR
-clauses which can be used to set the IPv4 and IPv6 source addresses respectively.
+clauses which can be used to set the IPv4 and IPv6 source addresses respectively\&.
.PP
After the
\fBserver\fR
-keyword, the server statement includes a string which is the hostname or address for a name server. The statement has three possible clauses:
+keyword, the server statement includes a string which is the hostname or address for a name server\&. The statement has three possible clauses:
\fBkey\fR,
\fBport\fR
and
-\fBaddresses\fR. The key name must match the name of a key statement in the file. The port number specifies the port to connect to. If an
+\fBaddresses\fR\&. The key name must match the name of a key statement in the file\&. The port number specifies the port to connect to\&. If an
\fBaddresses\fR
-clause is supplied these addresses will be used instead of the server name. Each address can take an optional port. If an
+clause is supplied these addresses will be used instead of the server name\&. Each address can take an optional port\&. If an
\fBsource\-address\fR
or
\fBsource\-address\-v6\fR
-of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively.
+of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively\&.
.PP
The
\fBkey\fR
-statement begins with an identifying string, the name of the key. The statement has two clauses.
+statement begins with an identifying string, the name of the key\&. The statement has two clauses\&.
\fBalgorithm\fR
identifies the authentication algorithm for
\fBrndc\fR
-to use; currently only HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512 are supported. This is followed by a secret clause which contains the base\-64 encoding of the algorithm's authentication key. The base\-64 string is enclosed in double quotes.
+to use; currently only HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512 are supported\&. This is followed by a secret clause which contains the base\-64 encoding of the algorithm\*(Aqs authentication key\&. The base\-64 string is enclosed in double quotes\&.
.PP
-There are two common ways to generate the base\-64 string for the secret. The BIND 9 program
+There are two common ways to generate the base\-64 string for the secret\&. The BIND 9 program
\fBrndc\-confgen\fR
can be used to generate a random key, or the
\fBmmencode\fR
program, also known as
-\fBmimencode\fR, can be used to generate a base\-64 string from known input.
+\fBmimencode\fR, can be used to generate a base\-64 string from known input\&.
\fBmmencode\fR
-does not ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each.
+does not ship with BIND 9 but is available on many systems\&. See the EXAMPLE section for sample command lines for each\&.
.SH "EXAMPLE"
.PP
+.if n \{\
.RS 4
+.\}
.nf
options {
default\-server localhost;
default\-key samplekey;
};
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
server localhost {
key samplekey;
};
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
server testserver {
key testkey;
addresses { localhost port 5353; };
};
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
key samplekey {
algorithm hmac\-sha256;
secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
};
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
key testkey {
algorithm hmac\-sha256;
secret "R3HI8P6BKw9ZwXwN3VZKuQ==";
};
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
In the above example,
\fBrndc\fR
-will by default use the server at localhost (127.0.0.1) and the key called samplekey. Commands to the localhost server will use the samplekey key, which must also be defined in the server's configuration file with the same name and secret. The key statement indicates that samplekey uses the HMAC\-SHA256 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-SHA256 secret enclosed in double quotes.
+will by default use the server at localhost (127\&.0\&.0\&.1) and the key called samplekey\&. Commands to the localhost server will use the samplekey key, which must also be defined in the server\*(Aqs configuration file with the same name and secret\&. The key statement indicates that samplekey uses the HMAC\-SHA256 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-SHA256 secret enclosed in double quotes\&.
.PP
If
\fBrndc \-s testserver\fR
is used then
\fBrndc\fR
-will connect to server on localhost port 5353 using the key testkey.
+will connect to server on localhost port 5353 using the key testkey\&.
.PP
To generate a random secret with
\fBrndc\-confgen\fR:
\fBrndc\-confgen\fR
.PP
A complete
-\fIrndc.conf\fR
-file, including the randomly generated key, will be written to the standard output. Commented\-out
+rndc\&.conf
+file, including the randomly generated key, will be written to the standard output\&. Commented\-out
\fBkey\fR
and
\fBcontrols\fR
statements for
-\fInamed.conf\fR
-are also printed.
+named\&.conf
+are also printed\&.
.PP
To generate a base\-64 secret with
\fBmmencode\fR:
.SH "NAME SERVER CONFIGURATION"
.PP
The name server must be configured to accept rndc connections and to recognize the key specified in the
-\fIrndc.conf\fR
+rndc\&.conf
file, using the controls statement in
-\fInamed.conf\fR. See the sections on the
+named\&.conf\&. See the sections on the
\fBcontrols\fR
-statement in the BIND 9 Administrator Reference Manual for details.
+statement in the BIND 9 Administrator Reference Manual for details\&.
.SH "SEE ALSO"
.PP
\fBrndc\fR(8),
-\fBrndc\-confgen\fR(8),
+\fBrndc-confgen\fR(8),
\fBmmencode\fR(1),
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.rndc.conf">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>rndc.conf</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="rndc.conf">
<a name="man.rndc.conf"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><code class="filename">rndc.conf</code> — rndc configuration file</p>
+<p>
+ <code class="filename">rndc.conf</code>
+ — rndc configuration file
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">rndc.conf</code> </p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543367"></a><h2>DESCRIPTION</h2>
-<p><code class="filename">rndc.conf</code> is the configuration file
- for <span><strong class="command">rndc</strong></span>, the BIND 9 name server control
+ <div class="cmdsynopsis"><p>
+ <code class="command">rndc.conf</code>
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60774352"></a><h2>DESCRIPTION</h2>
+
+ <p><code class="filename">rndc.conf</code> is the configuration file
+ for <span class="command"><strong>rndc</strong></span>, the BIND 9 name server control
utility. This file has a similar structure and syntax to
<code class="filename">named.conf</code>. Statements are enclosed
in braces and terminated with a semi-colon. Clauses in
the statements are also semi-colon terminated. The usual
comment styles are supported:
</p>
-<p>
+ <p>
C style: /* */
</p>
-<p>
+ <p>
C++ style: // to end of line
</p>
-<p>
+ <p>
Unix style: # to end of line
</p>
-<p><code class="filename">rndc.conf</code> is much simpler than
+ <p><code class="filename">rndc.conf</code> is much simpler than
<code class="filename">named.conf</code>. The file uses three
statements: an options statement, a server statement
and a key statement.
</p>
-<p>
+ <p>
The <code class="option">options</code> statement contains five clauses.
The <code class="option">default-server</code> clause is followed by the
name or address of a name server. This host will be used when
no name server is given as an argument to
- <span><strong class="command">rndc</strong></span>. The <code class="option">default-key</code>
+ <span class="command"><strong>rndc</strong></span>. The <code class="option">default-key</code>
clause is followed by the name of a key which is identified by
a <code class="option">key</code> statement. If no
<code class="option">keyid</code> is provided on the rndc command line,
can be used to set the IPv4 and IPv6 source addresses
respectively.
</p>
-<p>
+ <p>
After the <code class="option">server</code> keyword, the server
statement includes a string which is the hostname or address
for a name server. The statement has three possible clauses:
of supplied then these will be used to specify the IPv4 and IPv6
source addresses respectively.
</p>
-<p>
+ <p>
The <code class="option">key</code> statement begins with an identifying
string, the name of the key. The statement has two clauses.
<code class="option">algorithm</code> identifies the authentication algorithm
- for <span><strong class="command">rndc</strong></span> to use; currently only HMAC-MD5
+ for <span class="command"><strong>rndc</strong></span> to use; currently only HMAC-MD5
(for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
(default), HMAC-SHA384 and HMAC-SHA512 are
supported. This is followed by a secret clause which contains
the base-64 encoding of the algorithm's authentication key. The
base-64 string is enclosed in double quotes.
</p>
-<p>
+ <p>
There are two common ways to generate the base-64 string for the
- secret. The BIND 9 program <span><strong class="command">rndc-confgen</strong></span>
+ secret. The BIND 9 program <span class="command"><strong>rndc-confgen</strong></span>
can
be used to generate a random key, or the
- <span><strong class="command">mmencode</strong></span> program, also known as
- <span><strong class="command">mimencode</strong></span>, can be used to generate a
+ <span class="command"><strong>mmencode</strong></span> program, also known as
+ <span class="command"><strong>mimencode</strong></span>, can be used to generate a
base-64
- string from known input. <span><strong class="command">mmencode</strong></span> does
+ string from known input. <span class="command"><strong>mmencode</strong></span> does
not
ship with BIND 9 but is available on many systems. See the
EXAMPLE section for sample command lines for each.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543515"></a><h2>EXAMPLE</h2>
-<pre class="programlisting">
+ </div>
+
+ <div class="refsection" title="EXAMPLE">
+<a name="idp60795984"></a><h2>EXAMPLE</h2>
+
+
+ <pre class="programlisting">
options {
default-server localhost;
default-key samplekey;
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
server localhost {
key samplekey;
};
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
server testserver {
key testkey;
addresses { localhost port 5353; };
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
key samplekey {
algorithm hmac-sha256;
secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
key testkey {
algorithm hmac-sha256;
secret "R3HI8P6BKw9ZwXwN3VZKuQ==";
</pre>
<p>
</p>
-<p>
- In the above example, <span><strong class="command">rndc</strong></span> will by
+
+ <p>
+ In the above example, <span class="command"><strong>rndc</strong></span> will by
default use
the server at localhost (127.0.0.1) and the key called samplekey.
Commands to the localhost server will use the samplekey key, which
uses the HMAC-SHA256 algorithm and its secret clause contains the
base-64 encoding of the HMAC-SHA256 secret enclosed in double quotes.
</p>
-<p>
- If <span><strong class="command">rndc -s testserver</strong></span> is used then <span><strong class="command">rndc</strong></span> will
+ <p>
+ If <span class="command"><strong>rndc -s testserver</strong></span> is used then <span class="command"><strong>rndc</strong></span> will
connect to server on localhost port 5353 using the key testkey.
</p>
-<p>
- To generate a random secret with <span><strong class="command">rndc-confgen</strong></span>:
+ <p>
+ To generate a random secret with <span class="command"><strong>rndc-confgen</strong></span>:
</p>
-<p><strong class="userinput"><code>rndc-confgen</code></strong>
+ <p><strong class="userinput"><code>rndc-confgen</code></strong>
</p>
-<p>
+ <p>
A complete <code class="filename">rndc.conf</code> file, including
the
randomly generated key, will be written to the standard
<code class="option">controls</code> statements for
<code class="filename">named.conf</code> are also printed.
</p>
-<p>
- To generate a base-64 secret with <span><strong class="command">mmencode</strong></span>:
+ <p>
+ To generate a base-64 secret with <span class="command"><strong>mmencode</strong></span>:
</p>
-<p><strong class="userinput"><code>echo "known plaintext for a secret" | mmencode</code></strong>
+ <p><strong class="userinput"><code>echo "known plaintext for a secret" | mmencode</code></strong>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543607"></a><h2>NAME SERVER CONFIGURATION</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="NAME SERVER CONFIGURATION">
+<a name="idp60807120"></a><h2>NAME SERVER CONFIGURATION</h2>
+
+ <p>
The name server must be configured to accept rndc connections and
to recognize the key specified in the <code class="filename">rndc.conf</code>
file, using the controls statement in <code class="filename">named.conf</code>.
See the sections on the <code class="option">controls</code> statement in the
BIND 9 Administrator Reference Manual for details.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543628"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">mmencode</span>(1)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60809936"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">rndc</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">rndc-confgen</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">mmencode</span>(1)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543667"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.rndc">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>rndc</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="rndc">
<a name="man.rndc"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">rndc</span> — name server control utility</p>
+<p>
+ <span class="application">rndc</span>
+ — name server control utility
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">rndc</code> [<code class="option">-b <em class="replaceable"><code>source-address</code></em></code>] [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-k <em class="replaceable"><code>key-file</code></em></code>] [<code class="option">-s <em class="replaceable"><code>server</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-q</code>] [<code class="option">-r</code>] [<code class="option">-V</code>] [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>] {command}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543440"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">rndc</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">rndc</code>
+ [<code class="option">-b <em class="replaceable"><code>source-address</code></em></code>]
+ [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>]
+ [<code class="option">-k <em class="replaceable"><code>key-file</code></em></code>]
+ [<code class="option">-s <em class="replaceable"><code>server</code></em></code>]
+ [<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
+ [<code class="option">-q</code>]
+ [<code class="option">-r</code>]
+ [<code class="option">-V</code>]
+ [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>]
+ {command}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61072208"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>rndc</strong></span>
controls the operation of a name
- server. It supersedes the <span><strong class="command">ndc</strong></span> utility
+ server. It supersedes the <span class="command"><strong>ndc</strong></span> utility
that was provided in old BIND releases. If
- <span><strong class="command">rndc</strong></span> is invoked with no command line
+ <span class="command"><strong>rndc</strong></span> is invoked with no command line
options or arguments, it prints a short summary of the
supported commands and the available options and their
arguments.
</p>
-<p><span><strong class="command">rndc</strong></span>
+ <p><span class="command"><strong>rndc</strong></span>
communicates with the name server over a TCP connection, sending
commands authenticated with digital signatures. In the current
versions of
- <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
+ <span class="command"><strong>rndc</strong></span> and <span class="command"><strong>named</strong></span>,
the only supported authentication algorithms are HMAC-MD5
(for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
(default), HMAC-SHA384 and HMAC-SHA512.
over the channel must be signed by a key_id known to the
server.
</p>
-<p><span><strong class="command">rndc</strong></span>
+ <p><span class="command"><strong>rndc</strong></span>
reads a configuration file to
determine how to contact the name server and decide what
algorithm and key it should use.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543475"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp61076688"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Use <em class="replaceable"><code>source-address</code></em>
as the source address for the connection to the server.
Multiple instances are permitted to allow setting of both
the IPv4 and IPv6 source addresses.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Use <em class="replaceable"><code>config-file</code></em>
as the configuration file instead of the default,
<code class="filename">/etc/rndc.conf</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Use <em class="replaceable"><code>key-file</code></em>
as the key file instead of the default,
<code class="filename">/etc/rndc.key</code>. The key in
authenticate
commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
does not exist.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
-<dd><p><em class="replaceable"><code>server</code></em> is
+<dd>
+ <p><em class="replaceable"><code>server</code></em> is
the name or address of the server which matches a
server statement in the configuration file for
- <span><strong class="command">rndc</strong></span>. If no server is supplied on the
+ <span class="command"><strong>rndc</strong></span>. If no server is supplied on the
command line, the host named by the default-server clause
- in the options statement of the <span><strong class="command">rndc</strong></span>
+ in the options statement of the <span class="command"><strong>rndc</strong></span>
configuration file will be used.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Send commands to TCP port
<em class="replaceable"><code>port</code></em>
instead
of BIND 9's default control channel port, 953.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-q</span></dt>
-<dd><p>
+<dd>
+ <p>
Quiet mode: Message text returned by the server
will not be printed except when there is an error.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-r</span></dt>
-<dd><p>
- Instructs <span><strong class="command">rndc</strong></span> to print the result code
- returned by <span><strong class="command">named</strong></span> after executing the
+<dd>
+ <p>
+ Instructs <span class="command"><strong>rndc</strong></span> to print the result code
+ returned by <span class="command"><strong>named</strong></span> after executing the
requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc).
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-V</span></dt>
-<dd><p>
+<dd>
+ <p>
Enable verbose logging.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
Use the key <em class="replaceable"><code>key_id</code></em>
from the configuration file.
<em class="replaceable"><code>key_id</code></em>
must be
- known by <span><strong class="command">named</strong></span> with the same algorithm and secret string
+ known by <span class="command"><strong>named</strong></span> with the same algorithm and secret string
in order for control message validation to succeed.
If no <em class="replaceable"><code>key_id</code></em>
- is specified, <span><strong class="command">rndc</strong></span> will first look
+ is specified, <span class="command"><strong>rndc</strong></span> will first look
for a key clause in the server statement of the server
being used, or if no server statement is present for that
host, then the default-key clause of the options statement.
which are used to send authenticated control commands
to name servers. It should therefore not have general read
or write access.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543708"></a><h2>COMMANDS</h2>
-<p>
- A list of commands supported by <span><strong class="command">rndc</strong></span> can
- be seen by running <span><strong class="command">rndc</strong></span> without arguments.
+ </div>
+
+ <div class="refsection" title="COMMANDS">
+<a name="idp61102800"></a><h2>COMMANDS</h2>
+
+ <p>
+ A list of commands supported by <span class="command"><strong>rndc</strong></span> can
+ be seen by running <span class="command"><strong>rndc</strong></span> without arguments.
</p>
-<p>
+ <p>
Currently supported commands are:
</p>
-<div class="variablelist"><dl>
+
+ <div class="variablelist"><dl>
<dt><span class="term"><strong class="userinput"><code>addzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] <em class="replaceable"><code>configuration</code></em> </code></strong></span></dt>
<dd>
-<p>
+ <p>
Add a zone while the server is running. This
command requires the
- <span><strong class="command">allow-new-zones</strong></span> option to be set
+ <span class="command"><strong>allow-new-zones</strong></span> option to be set
to <strong class="userinput"><code>yes</code></strong>. The
<em class="replaceable"><code>configuration</code></em> string
specified on the command line is the zone
configuration text that would ordinarily be
placed in <code class="filename">named.conf</code>.
</p>
-<p>
+ <p>
The configuration is saved in a file called
<code class="filename"><em class="replaceable"><code>name</code></em>.nzf</code>,
where <em class="replaceable"><code>name</code></em> is the
that are incompatible with use as a file name, a
cryptographic hash generated from the name
of the view.
- When <span><strong class="command">named</strong></span> is
+ When <span class="command"><strong>named</strong></span> is
restarted, the file will be loaded into the view
configuration, so that zones that were added
can persist after a restart.
</p>
-<p>
- This sample <span><strong class="command">addzone</strong></span> command
+ <p>
+ This sample <span class="command"><strong>addzone</strong></span> command
would add the zone <code class="literal">example.com</code>
to the default view:
</p>
-<p>
+ <p>
<code class="prompt">$ </code><strong class="userinput"><code>rndc addzone example.com '{ type master; file "example.com.db"; };'</code></strong>
</p>
-<p>
+ <p>
(Note the brackets and semi-colon around the zone
configuration text.)
</p>
-<p>
- See also <span><strong class="command">rndc delzone</strong></span> and <span><strong class="command">rndc modzone</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc delzone</strong></span> and <span class="command"><strong>rndc modzone</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>delzone [<span class="optional">-clean</span>] <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt>
<dd>
-<p>
+ <p>
Delete a zone while the server is running.
</p>
-<p>
+ <p>
If the <code class="option">-clean</code> argument is specified,
the zone's master file (and journal file, if any)
will be deleted along with the zone. Without the
be cleaned up by hand. (If the zone is of
type "slave" or "stub", the files needing to
be cleaned up will be reported in the output
- of the <span><strong class="command">rndc delzone</strong></span> command.)
+ of the <span class="command"><strong>rndc delzone</strong></span> command.)
</p>
-<p>
+ <p>
If the zone was originally added via
- <span><strong class="command">rndc addzone</strong></span>, then it will be
+ <span class="command"><strong>rndc addzone</strong></span>, then it will be
removed permanently. However, if it was originally
configured in <code class="filename">named.conf</code>, then
that original configuration is still in place; when
come back. To remove it permanently, it must also be
removed from <code class="filename">named.conf</code>
</p>
-<p>
- See also <span><strong class="command">rndc addzone</strong></span> and <span><strong class="command">rndc modzone</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc addzone</strong></span> and <span class="command"><strong>rndc modzone</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>dumpdb [<span class="optional">-all|-cache|-zone|-adb|-bad|-fail</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Dump the server's caches (default) and/or zones to
the
dump file for the specified views. If no view is
specified, all
views are dumped.
- (See the <span><strong class="command">dump-file</strong></span> option in
+ (See the <span class="command"><strong>dump-file</strong></span> option in
the BIND 9 Administrator Reference Manual.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>flush</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Flushes the server's cache.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>flushname</code></strong> <em class="replaceable"><code>name</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>] </span></dt>
-<dd><p>
+<dd>
+ <p>
Flushes the given name from the view's DNS cache
and, if applicable, from the view's nameserver address
database, bad server cache and SERVFAIL cache.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>flushtree</code></strong> <em class="replaceable"><code>name</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>] </span></dt>
-<dd><p>
+<dd>
+ <p>
Flushes the given name, and all of its subdomains,
from the view's DNS cache, address database,
bad server cache, and SERVFAIL cache.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>freeze [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
<dd>
-<p>
+ <p>
Suspend updates to a dynamic zone. If no zone is
specified, then all zones are suspended. This allows
manual edits to be made to a zone normally updated by
All dynamic update attempts will be refused while
the zone is frozen.
</p>
-<p>
- See also <span><strong class="command">rndc thaw</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc thaw</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>halt [<span class="optional">-p</span>]</code></strong></span></dt>
<dd>
-<p>
+ <p>
Stop the server immediately. Recent changes
made through dynamic update or IXFR are not saved to
the master files, but will be rolled forward from the
journal files when the server is restarted.
- If <code class="option">-p</code> is specified <span><strong class="command">named</strong></span>'s process id is returned.
- This allows an external process to determine when <span><strong class="command">named</strong></span>
+ If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned.
+ This allows an external process to determine when <span class="command"><strong>named</strong></span>
had completed halting.
</p>
-<p>
- See also <span><strong class="command">rndc stop</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc stop</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>loadkeys <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
<dd>
-<p>
+ <p>
Fetch all DNSSEC keys for the given zone
from the key directory. If they are within
their publication period, merge them into the
- zone's DNSKEY RRset. Unlike <span><strong class="command">rndc
+ zone's DNSKEY RRset. Unlike <span class="command"><strong>rndc
sign</strong></span>, however, the zone is not
immediately re-signed by the new keys, but is
allowed to incrementally re-sign over time.
</p>
-<p>
+ <p>
This command requires that the
- <span><strong class="command">auto-dnssec</strong></span> zone option
+ <span class="command"><strong>auto-dnssec</strong></span> zone option
be set to <code class="literal">maintain</code>,
and also requires the zone to be configured to
allow dynamic DNS.
(See "Dynamic Update Policies" in the Administrator
Reference Manual for more details.)
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>managed-keys <em class="replaceable"><code>(status | refresh | sync)</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
When run with the "status" keyword, print the current
status of the managed-keys database for the specified
view, or for all views if none is specified. When run
immediate dump of the managed-keys database to disk (in
the file <code class="filename">managed-keys.bind</code> or
(<code class="filename"><em class="replaceable"><code>viewname</code></em>.mkeys</code>).
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>modzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] <em class="replaceable"><code>configuration</code></em> </code></strong></span></dt>
<dd>
-<p>
+ <p>
Modify the configuration of a zone while the server
is running. This command requires the
- <span><strong class="command">allow-new-zones</strong></span> option to be
+ <span class="command"><strong>allow-new-zones</strong></span> option to be
set to <strong class="userinput"><code>yes</code></strong>. As with
- <span><strong class="command">addzone</strong></span>, the
+ <span class="command"><strong>addzone</strong></span>, the
<em class="replaceable"><code>configuration</code></em> string
specified on the command line is the zone
configuration text that would ordinarily be
placed in <code class="filename">named.conf</code>.
</p>
-<p>
+ <p>
If the zone was originally added via
- <span><strong class="command">rndc addzone</strong></span>, the configuration
+ <span class="command"><strong>rndc addzone</strong></span>, the configuration
changes will be recorded permanently and will still be
in effect after the server is restarted or reconfigured.
However, if it was originally configured in
permanent, it must also be modified in
<code class="filename">named.conf</code>
</p>
-<p>
- See also <span><strong class="command">rndc addzone</strong></span> and <span><strong class="command">rndc delzone</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc addzone</strong></span> and <span class="command"><strong>rndc delzone</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>notify <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Resend NOTIFY messages for the zone.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>notrace</code></strong></span></dt>
<dd>
-<p>
+ <p>
Sets the server's debugging level to 0.
</p>
-<p>
- See also <span><strong class="command">rndc trace</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc trace</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>nta
[<span class="optional">( -d | -f | -r | -l <em class="replaceable"><code>duration</code></em>)</span>]
<em class="replaceable"><code>domain</code></em>
[<span class="optional"><em class="replaceable"><code>view</code></em></span>]
</code></strong></span></dt>
<dd>
-<p>
+ <p>
Sets a DNSSEC negative trust anchor (NTA)
for <code class="option">domain</code>, with a lifetime of
<code class="option">duration</code>. The default lifetime is
<code class="option">nta-lifetime</code> option, and defaults to
one hour. The lifetime cannot exceed one week.
</p>
-<p>
+ <p>
A negative trust anchor selectively disables
DNSSEC validation for zones that are known to be
failing because of misconfiguration rather than
an attack. When data to be validated is
at or below an active NTA (and above any other
- configured trust anchors), <span><strong class="command">named</strong></span> will
+ configured trust anchors), <span class="command"><strong>named</strong></span> will
abort the DNSSEC validation process and treat the data as
insecure rather than bogus. This continues until the
NTA's lifetime is elapsed.
</p>
-<p>
- NTAs persist across restarts of the <span><strong class="command">named</strong></span> server.
+ <p>
+ NTAs persist across restarts of the <span class="command"><strong>named</strong></span> server.
The NTAs for a view are saved in a file called
<code class="filename"><em class="replaceable"><code>name</code></em>.nta</code>,
where <em class="replaceable"><code>name</code></em> is the
cryptographic hash generated from the name
of the view.
</p>
-<p>
+ <p>
An existing NTA can be removed by using the
<code class="option">-remove</code> option.
</p>
-<p>
+ <p>
An NTA's lifetime can be specified with the
<code class="option">-lifetime</code> option. TTL-style
suffixes can be used to specify the lifetime in
new value. Setting <code class="option">lifetime</code> to zero
is equivalent to <code class="option">-remove</code>.
</p>
-<p>
+ <p>
If <code class="option">-dump</code> is used, any other arguments
are ignored, and a list of existing NTAs is printed
(note that this may include NTAs that are expired but
have not yet been cleaned up).
</p>
-<p>
- Normally, <span><strong class="command">named</strong></span> will periodically
+ <p>
+ Normally, <span class="command"><strong>named</strong></span> will periodically
test to see whether data below an NTA can now be
validated (see the <code class="option">nta-recheck</code> option
in the Administrator Reference Manual for details).
lifetime, regardless of whether data could be
validated if the NTA were not present.
</p>
-<p>
+ <p>
All of these options can be shortened, i.e., to
<code class="option">-l</code>, <code class="option">-r</code>, <code class="option">-d</code>,
and <code class="option">-f</code>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>querylog</code></strong> [<span class="optional">on|off</span>] </span></dt>
<dd>
-<p>
+ <p>
Enable or disable query logging. (For backward
compatibility, this command can also be used without
an argument to toggle query logging on and off.)
</p>
-<p>
+ <p>
Query logging can also be enabled
- by explicitly directing the <span><strong class="command">queries</strong></span>
- <span><strong class="command">category</strong></span> to a
- <span><strong class="command">channel</strong></span> in the
- <span><strong class="command">logging</strong></span> section of
+ by explicitly directing the <span class="command"><strong>queries</strong></span>
+ <span class="command"><strong>category</strong></span> to a
+ <span class="command"><strong>channel</strong></span> in the
+ <span class="command"><strong>logging</strong></span> section of
<code class="filename">named.conf</code> or by specifying
- <span><strong class="command">querylog yes;</strong></span> in the
- <span><strong class="command">options</strong></span> section of
+ <span class="command"><strong>querylog yes;</strong></span> in the
+ <span class="command"><strong>options</strong></span> section of
<code class="filename">named.conf</code>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>reconfig</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Reload the configuration file and load new zones,
but do not reload existing zone files even if they
have changed.
- This is faster than a full <span><strong class="command">reload</strong></span> when there
+ This is faster than a full <span class="command"><strong>reload</strong></span> when there
is a large number of zones because it avoids the need
to examine the
modification times of the zones files.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>recursing</code></strong></span></dt>
-<dd><p>
- Dump the list of queries <span><strong class="command">named</strong></span> is currently
+<dd>
+ <p>
+ Dump the list of queries <span class="command"><strong>named</strong></span> is currently
recursing on, and the list of domains to which iterative
queries are currently being sent. (The second list includes
the number of fetches currently active for the given domain,
and how many have been passed or dropped because of the
<code class="option">fetches-per-zone</code> option.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>refresh <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Schedule zone maintenance for the given zone.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>reload</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Reload configuration file and zones.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>reload <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Reload the given zone.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>retransfer <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
<dd>
-<p>
+ <p>
Retransfer the given slave zone from the master server.
</p>
-<p>
+ <p>
If the zone is configured to use
- <span><strong class="command">inline-signing</strong></span>, the signed
+ <span class="command"><strong>inline-signing</strong></span>, the signed
version of the zone is discarded; after the
retransfer of the unsigned version is complete, the
signed version will be regenerated with all new
signatures.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>scan</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Scan the list of available network interfaces
for changes, without performing a full
- <span><strong class="command">reconfig</strong></span> or waiting for the
- <span><strong class="command">interface-interval</strong></span> timer.
- </p></dd>
+ <span class="command"><strong>reconfig</strong></span> or waiting for the
+ <span class="command"><strong>interface-interval</strong></span> timer.
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>secroots [<span class="optional">-</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
<dd>
-<p>
+ <p>
Dump the server's security roots and negative trust anchors
for the specified views. If no view is specified, all views
are dumped.
</p>
-<p>
+ <p>
If the first argument is "-", then the output is
- returned via the <span><strong class="command">rndc</strong></span> response channel
+ returned via the <span class="command"><strong>rndc</strong></span> response channel
and printed to the standard output.
Otherwise, it is written to the secroots dump file, which
defaults to <code class="filename">named.secroots</code>, but can be
overridden via the <code class="option">secroots-file</code> option in
<code class="filename">named.conf</code>.
</p>
-<p>
- See also <span><strong class="command">rndc managed-keys</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc managed-keys</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>showzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt>
<dd>
-<p>
+ <p>
Print the configuration of a running zone.
</p>
-<p>
- See also <span><strong class="command">rndc zonestatus</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc zonestatus</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>sign <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
<dd>
-<p>
+ <p>
Fetch all DNSSEC keys for the given zone
from the key directory (see the
- <span><strong class="command">key-directory</strong></span> option in
+ <span class="command"><strong>key-directory</strong></span> option in
the BIND 9 Administrator Reference Manual). If they are within
their publication period, merge them into the
zone's DNSKEY RRset. If the DNSKEY RRset
is changed, then the zone is automatically
re-signed with the new key set.
</p>
-<p>
+ <p>
This command requires that the
- <span><strong class="command">auto-dnssec</strong></span> zone option be set
+ <span class="command"><strong>auto-dnssec</strong></span> zone option be set
to <code class="literal">allow</code> or
<code class="literal">maintain</code>,
and also requires the zone to be configured to
(See "Dynamic Update Policies" in the Administrator
Reference Manual for more details.)
</p>
-<p>
- See also <span><strong class="command">rndc loadkeys</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc loadkeys</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>signing [<span class="optional">( -list | -clear <em class="replaceable"><code>keyid/algorithm</code></em> | -clear <code class="literal">all</code> | -nsec3param ( <em class="replaceable"><code>parameters</code></em> | <code class="literal">none</code> ) | -serial <em class="replaceable"><code>value</code></em> ) </span>] <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt>
<dd>
-<p>
+ <p>
List, edit, or remove the DNSSEC signing state records
for the specified zone. The status of ongoing DNSSEC
operations (such as signing or generating
NSEC3 chains) is stored in the zone in the form
of DNS resource records of type
- <span><strong class="command">sig-signing-type</strong></span>.
- <span><strong class="command">rndc signing -list</strong></span> converts
+ <span class="command"><strong>sig-signing-type</strong></span>.
+ <span class="command"><strong>rndc signing -list</strong></span> converts
these records into a human-readable form,
indicating which keys are currently signing
or have finished signing the zone, and which NSEC3
chains are being created or removed.
</p>
-<p>
- <span><strong class="command">rndc signing -clear</strong></span> can remove
+ <p>
+ <span class="command"><strong>rndc signing -clear</strong></span> can remove
a single key (specified in the same format that
- <span><strong class="command">rndc signing -list</strong></span> uses to
+ <span class="command"><strong>rndc signing -list</strong></span> uses to
display it), or all keys. In either case, only
completed keys are removed; any record indicating
that a key has not yet finished signing the zone
will be retained.
</p>
-<p>
- <span><strong class="command">rndc signing -nsec3param</strong></span> sets
+ <p>
+ <span class="command"><strong>rndc signing -nsec3param</strong></span> sets
the NSEC3 parameters for a zone. This is the
only supported mechanism for using NSEC3 with
- <span><strong class="command">inline-signing</strong></span> zones.
+ <span class="command"><strong>inline-signing</strong></span> zones.
Parameters are specified in the same format as
an NSEC3PARAM resource record: hash algorithm,
flags, iterations, and salt, in that order.
</p>
-<p>
+ <p>
Currently, the only defined value for hash algorithm
is <code class="literal">1</code>, representing SHA-1.
The <code class="option">flags</code> may be set to
<code class="option">salt</code> is a string of data expressed
in hexadecimal, a hyphen (`-') if no salt is
to be used, or the keyword <code class="literal">auto</code>,
- which causes <span><strong class="command">named</strong></span> to generate a
+ which causes <span class="command"><strong>named</strong></span> to generate a
random 64-bit salt.
</p>
-<p>
+ <p>
So, for example, to create an NSEC3 chain using
the SHA-1 hash algorithm, no opt-out flag,
10 iterations, and a salt value of "FFFF", use:
- <span><strong class="command">rndc signing -nsec3param 1 0 10 FFFF <em class="replaceable"><code>zone</code></em></strong></span>.
+ <span class="command"><strong>rndc signing -nsec3param 1 0 10 FFFF <em class="replaceable"><code>zone</code></em></strong></span>.
To set the opt-out flag, 15 iterations, and no
salt, use:
- <span><strong class="command">rndc signing -nsec3param 1 1 15 - <em class="replaceable"><code>zone</code></em></strong></span>.
+ <span class="command"><strong>rndc signing -nsec3param 1 1 15 - <em class="replaceable"><code>zone</code></em></strong></span>.
</p>
-<p>
- <span><strong class="command">rndc signing -nsec3param none</strong></span>
+ <p>
+ <span class="command"><strong>rndc signing -nsec3param none</strong></span>
removes an existing NSEC3 chain and replaces it
with NSEC.
</p>
-<p>
- <span><strong class="command">rndc signing -serial value</strong></span> sets
+ <p>
+ <span class="command"><strong>rndc signing -serial value</strong></span> sets
the serial number of the zone to value. If the value
would cause the serial number to go backwards it will
be rejected. The primary use is to set the serial on
inline signed zones.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>stats</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Write server statistics to the statistics file.
- (See the <span><strong class="command">statistics-file</strong></span> option in
+ (See the <span class="command"><strong>statistics-file</strong></span> option in
the BIND 9 Administrator Reference Manual.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>status</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Display status of the server.
- Note that the number of zones includes the internal <span><strong class="command">bind/CH</strong></span> zone
- and the default <span><strong class="command">./IN</strong></span>
+ Note that the number of zones includes the internal <span class="command"><strong>bind/CH</strong></span> zone
+ and the default <span class="command"><strong>./IN</strong></span>
hint zone if there is not an
explicit root zone configured.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>stop [<span class="optional">-p</span>]</code></strong></span></dt>
<dd>
-<p>
+ <p>
Stop the server, making sure any recent changes
made through dynamic update or IXFR are first saved to
the master files of the updated zones.
- If <code class="option">-p</code> is specified <span><strong class="command">named</strong></span>'s process id is returned.
- This allows an external process to determine when <span><strong class="command">named</strong></span>
+ If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned.
+ This allows an external process to determine when <span class="command"><strong>named</strong></span>
had completed stopping.
</p>
-<p>See also <span><strong class="command">rndc halt</strong></span>.</p>
-</dd>
+ <p>See also <span class="command"><strong>rndc halt</strong></span>.</p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>sync [<span class="optional">-clean</span>] [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Sync changes in the journal file for a dynamic zone
to the master file. If the "-clean" option is
specified, the journal file is also removed. If
no zone is specified, then all zones are synced.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>thaw [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
<dd>
-<p>
+ <p>
Enable updates to a frozen dynamic zone. If no
zone is specified, then all frozen zones are
enabled. This causes the server to reload the zone
load has completed. After a zone is thawed,
dynamic updates will no longer be refused. If
the zone has changed and the
- <span><strong class="command">ixfr-from-differences</strong></span> option is
+ <span class="command"><strong>ixfr-from-differences</strong></span> option is
in use, then the journal file will be updated to
reflect changes in the zone. Otherwise, if the
zone has changed, any existing journal file will be
removed.
</p>
-<p>See also <span><strong class="command">rndc freeze</strong></span>.</p>
-</dd>
+ <p>See also <span class="command"><strong>rndc freeze</strong></span>.</p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>trace</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Increment the servers debugging level by one.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>trace <em class="replaceable"><code>level</code></em></code></strong></span></dt>
<dd>
-<p>
+ <p>
Sets the server's debugging level to an explicit
value.
</p>
-<p>
- See also <span><strong class="command">rndc notrace</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc notrace</strong></span>.
</p>
-</dd>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>tsig-delete</code></strong> <em class="replaceable"><code>keyname</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span></dt>
-<dd><p>
+<dd>
+ <p>
Delete a given TKEY-negotiated key from the server.
(This does not apply to statically configured TSIG
keys.)
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>tsig-list</code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
List the names of all TSIG keys currently configured
- for use by <span><strong class="command">named</strong></span> in each view. The
+ for use by <span class="command"><strong>named</strong></span> in each view. The
list both statically configured keys and dynamic
TKEY-negotiated keys.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>validation ( on | off | check ) [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>] </code></strong></span></dt>
-<dd><p>
+<dd>
+ <p>
Enable, disable, or check the current status of
DNSSEC validation.
- Note <span><strong class="command">dnssec-enable</strong></span> also needs to be
+ Note <span class="command"><strong>dnssec-enable</strong></span> also needs to be
set to <strong class="userinput"><code>yes</code></strong> or
<strong class="userinput"><code>auto</code></strong> to be effective.
It defaults to enabled.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><strong class="userinput"><code>zonestatus <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
<dd>
-<p>
+ <p>
Displays the current status of the given zone,
including the master file name and any include
files from which it was loaded, when it was most
management or inline signing, and the scheduled
refresh or expiry times for the zone.
</p>
-<p>
- See also <span><strong class="command">rndc showzone</strong></span>.
+ <p>
+ See also <span class="command"><strong>rndc showzone</strong></span>.
</p>
-</dd>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545418"></a><h2>LIMITATIONS</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="LIMITATIONS">
+<a name="idp61327440"></a><h2>LIMITATIONS</h2>
+
+ <p>
There is currently no way to provide the shared secret for a
<code class="option">key_id</code> without using the configuration file.
</p>
-<p>
+ <p>
Several error messages could be clearer.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545436"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
- <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
- <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61329616"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">rndc.conf</span>(5)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">rndc-confgen</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">named.conf</span>(5)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">ndc</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2545492"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: arpaname
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: March 03, 2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2009-03-03
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "ARPANAME" "1" "March 03, 2009" "BIND9" "BIND9"
+.TH "ARPANAME" "1" "2009\-03\-03" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
arpaname \- translate IP addresses to the corresponding ARPA names
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBarpaname\fR
-translates IP addresses (IPv4 and IPv6) to the corresponding IN\-ADDR.ARPA or IP6.ARPA names.
+translates IP addresses (IPv4 and IPv6) to the corresponding IN\-ADDR\&.ARPA or IP6\&.ARPA names\&.
.SH "SEE ALSO"
.PP
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.arpaname">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>arpaname</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="arpaname">
<a name="man.arpaname"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">arpaname</span> — translate IP addresses to the corresponding ARPA names</p>
+<p>
+ <span class="application">arpaname</span>
+ — translate IP addresses to the corresponding ARPA names
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">arpaname</code> {<em class="replaceable"><code>ipaddress </code></em>...}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543356"></a><h2>DESCRIPTION</h2>
-<p>
- <span><strong class="command">arpaname</strong></span> translates IP addresses (IPv4 and
+ <div class="cmdsynopsis"><p>
+ <code class="command">arpaname</code>
+ {<em class="replaceable"><code>ipaddress </code></em>...}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60857296"></a><h2>DESCRIPTION</h2>
+
+ <p>
+ <span class="command"><strong>arpaname</strong></span> translates IP addresses (IPv4 and
IPv6) to the corresponding IN-ADDR.ARPA or IP6.ARPA names.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543369"></a><h2>SEE ALSO</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60859216"></a><h2>SEE ALSO</h2>
+
+ <p>
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543383"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnstap-read">
<info>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: genrandom
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: August 08, 2011
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2011-08-08
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "GENRANDOM" "8" "August 08, 2011" "BIND9" "BIND9"
+.TH "GENRANDOM" "8" "2011\-08\-08" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
genrandom \- generate a file containing random data
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBgenrandom\fR
-generates a file or a set of files containing a specified quantity of pseudo\-random data, which can be used as a source of entropy for other commands on systems with no random device.
+generates a file or a set of files containing a specified quantity of pseudo\-random data, which can be used as a source of entropy for other commands on systems with no random device\&.
.SH "ARGUMENTS"
.PP
\-n \fInumber\fR
\fBnumber\fR
(from 2 to 9) files, appending
\fBnumber\fR
-to the name.
+to the name\&.
.RE
.PP
size
.RS 4
-The size of the file, in kilobytes, to generate.
+The size of the file, in kilobytes, to generate\&.
.RE
.PP
filename
.RS 4
-The file name into which random data should be written.
+The file name into which random data should be written\&.
.RE
.SH "SEE ALSO"
.PP
\fBarc4random\fR(3)
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2009\-2011, 2014 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2009-2011, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.genrandom">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>genrandom</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="genrandom">
<a name="man.genrandom"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">genrandom</span> — generate a file containing random data</p>
+<p>
+ <span class="application">genrandom</span>
+ — generate a file containing random data
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">genrandom</code> [<code class="option">-n <em class="replaceable"><code>number</code></em></code>] {<em class="replaceable"><code>size</code></em>} {<em class="replaceable"><code>filename</code></em>}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543378"></a><h2>DESCRIPTION</h2>
-<p>
- <span><strong class="command">genrandom</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">genrandom</code>
+ [<code class="option">-n <em class="replaceable"><code>number</code></em></code>]
+ {<em class="replaceable"><code>size</code></em>}
+ {<em class="replaceable"><code>filename</code></em>}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60847184"></a><h2>DESCRIPTION</h2>
+
+ <p>
+ <span class="command"><strong>genrandom</strong></span>
generates a file or a set of files containing a specified quantity
of pseudo-random data, which can be used as a source of entropy for
other commands on systems with no random device.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543390"></a><h2>ARGUMENTS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="ARGUMENTS">
+<a name="idp60848976"></a><h2>ARGUMENTS</h2>
+
+ <div class="variablelist"><dl>
<dt><span class="term">-n <em class="replaceable"><code>number</code></em></span></dt>
-<dd><p>
+<dd>
+ <p>
In place of generating one file, generates <code class="option">number</code>
(from 2 to 9) files, appending <code class="option">number</code> to the name.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">size</span></dt>
-<dd><p>
+<dd>
+ <p>
The size of the file, in kilobytes, to generate.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">filename</span></dt>
-<dd><p>
+<dd>
+ <p>
The file name into which random data should be written.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543451"></a><h2>SEE ALSO</h2>
-<p>
- <span class="citerefentry"><span class="refentrytitle">rand</span>(3)</span>,
- <span class="citerefentry"><span class="refentrytitle">arc4random</span>(3)</span>
- </p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543478"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60872656"></a><h2>SEE ALSO</h2>
+
+ <p>
+ <span class="citerefentry">
+ <span class="refentrytitle">rand</span>(3)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">arc4random</span>(3)
+ </span>
</p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: isc\-hmac\-fixup
+'\" t
+.\" Title: isc-hmac-fixup
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: April 28, 2013
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2013-04-28
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "ISC\-HMAC\-FIXUP" "8" "April 28, 2013" "BIND9" "BIND9"
+.TH "ISC\-HMAC\-FIXUP" "8" "2013\-04\-28" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-isc\-hmac\-fixup \- fixes HMAC keys generated by older versions of BIND
+isc-hmac-fixup \- fixes HMAC keys generated by older versions of BIND
.SH "SYNOPSIS"
.HP 15
\fBisc\-hmac\-fixup\fR {\fIalgorithm\fR} {\fIsecret\fR}
.SH "DESCRIPTION"
.PP
-Versions of BIND 9 up to and including BIND 9.6 had a bug causing HMAC\-SHA* TSIG keys which were longer than the digest length of the hash algorithm (i.e., SHA1 keys longer than 160 bits, SHA256 keys longer than 256 bits, etc) to be used incorrectly, generating a message authentication code that was incompatible with other DNS implementations.
+Versions of BIND 9 up to and including BIND 9\&.6 had a bug causing HMAC\-SHA* TSIG keys which were longer than the digest length of the hash algorithm (i\&.e\&., SHA1 keys longer than 160 bits, SHA256 keys longer than 256 bits, etc) to be used incorrectly, generating a message authentication code that was incompatible with other DNS implementations\&.
.PP
-This bug has been fixed in BIND 9.7. However, the fix may cause incompatibility between older and newer versions of BIND, when using long keys.
+This bug has been fixed in BIND 9\&.7\&. However, the fix may cause incompatibility between older and newer versions of BIND, when using long keys\&.
\fBisc\-hmac\-fixup\fR
-modifies those keys to restore compatibility.
+modifies those keys to restore compatibility\&.
.PP
To modify a key, run
\fBisc\-hmac\-fixup\fR
-and specify the key's algorithm and secret on the command line. If the secret is longer than the digest length of the algorithm (64 bytes for SHA1 through SHA256, or 128 bytes for SHA384 and SHA512), then a new secret will be generated consisting of a hash digest of the old secret. (If the secret did not require conversion, then it will be printed without modification.)
+and specify the key\*(Aqs algorithm and secret on the command line\&. If the secret is longer than the digest length of the algorithm (64 bytes for SHA1 through SHA256, or 128 bytes for SHA384 and SHA512), then a new secret will be generated consisting of a hash digest of the old secret\&. (If the secret did not require conversion, then it will be printed without modification\&.)
.SH "SECURITY CONSIDERATIONS"
.PP
Secrets that have been converted by
\fBisc\-hmac\-fixup\fR
-are shortened, but as this is how the HMAC protocol works in operation anyway, it does not affect security. RFC 2104 notes, "Keys longer than [the digest length] are acceptable but the extra length would not significantly increase the function strength."
+are shortened, but as this is how the HMAC protocol works in operation anyway, it does not affect security\&. RFC 2104 notes, "Keys longer than [the digest length] are acceptable but the extra length would not significantly increase the function strength\&."
.SH "SEE ALSO"
.PP
BIND 9 Administrator Reference Manual,
-RFC 2104.
+RFC 2104\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>isc-hmac-fixup</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="isc-hmac-fixup">
<a name="man.isc-hmac-fixup"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">isc-hmac-fixup</span> — fixes HMAC keys generated by older versions of BIND</p>
+<p>
+ <span class="application">isc-hmac-fixup</span>
+ — fixes HMAC keys generated by older versions of BIND
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">isc-hmac-fixup</code> {<em class="replaceable"><code>algorithm</code></em>} {<em class="replaceable"><code>secret</code></em>}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543366"></a><h2>DESCRIPTION</h2>
-<p>
+ <div class="cmdsynopsis"><p>
+ <code class="command">isc-hmac-fixup</code>
+ {<em class="replaceable"><code>algorithm</code></em>}
+ {<em class="replaceable"><code>secret</code></em>}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60854864"></a><h2>DESCRIPTION</h2>
+
+ <p>
Versions of BIND 9 up to and including BIND 9.6 had a bug causing
HMAC-SHA* TSIG keys which were longer than the digest length of the
hash algorithm (i.e., SHA1 keys longer than 160 bits, SHA256 keys
message authentication code that was incompatible with other DNS
implementations.
</p>
-<p>
+ <p>
This bug has been fixed in BIND 9.7. However, the fix may
cause incompatibility between older and newer versions of
- BIND, when using long keys. <span><strong class="command">isc-hmac-fixup</strong></span>
+ BIND, when using long keys. <span class="command"><strong>isc-hmac-fixup</strong></span>
modifies those keys to restore compatibility.
</p>
-<p>
- To modify a key, run <span><strong class="command">isc-hmac-fixup</strong></span> and
+ <p>
+ To modify a key, run <span class="command"><strong>isc-hmac-fixup</strong></span> and
specify the key's algorithm and secret on the command line. If the
secret is longer than the digest length of the algorithm (64 bytes
for SHA1 through SHA256, or 128 bytes for SHA384 and SHA512), then a
secret. (If the secret did not require conversion, then it will be
printed without modification.)
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543389"></a><h2>SECURITY CONSIDERATIONS</h2>
-<p>
- Secrets that have been converted by <span><strong class="command">isc-hmac-fixup</strong></span>
+ </div>
+
+ <div class="refsection" title="SECURITY CONSIDERATIONS">
+<a name="idp60857808"></a><h2>SECURITY CONSIDERATIONS</h2>
+
+ <p>
+ Secrets that have been converted by <span class="command"><strong>isc-hmac-fixup</strong></span>
are shortened, but as this is how the HMAC protocol works in
operation anyway, it does not affect security. RFC 2104 notes,
"Keys longer than [the digest length] are acceptable but the
extra length would not significantly increase the function
strength."
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543403"></a><h2>SEE ALSO</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60859728"></a><h2>SEE ALSO</h2>
+
+ <p>
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 2104</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543489"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: mdig
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: January 5, 2015
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2015-01-05
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "MDIG" "1" "January 5, 2015" "BIND9" "BIND9"
+.TH "MDIG" "1" "2015\-01\-05" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
mdig \- DNS pipelined lookup utility
.SH "SYNOPSIS"
.PP
\fBmdig\fR
is a multiple/pipelined query version of
-\fBdig\fR: instead of waiting for a response after sending each query, it begins by sending all queries. Responses are displayed in the order in which they are received, not in the order the corresponding queries were sent.
+\fBdig\fR: instead of waiting for a response after sending each query, it begins by sending all queries\&. Responses are displayed in the order in which they are received, not in the order the corresponding queries were sent\&.
.PP
\fBmdig\fR
options are a subset of the
\fBdig\fR
-options, and are divided into "anywhere options" which can occur anywhere, "global options" which must occur before the query name (or they are ignored with a warning), and "local options" which apply to the next query on the command line.
+options, and are divided into "anywhere options" which can occur anywhere, "global options" which must occur before the query name (or they are ignored with a warning), and "local options" which apply to the next query on the command line\&.
.PP
The
{@server}
-option is a mandatory global option. It is the name or IP address of the name server to query. (Unlike
+option is a mandatory global option\&. It is the name or IP address of the name server to query\&. (Unlike
\fBdig\fR, this value is not retrieved from
-\fI/etc/resolv.conf\fR.) It can be an IPv4 address in dotted\-decimal notation, an IPv6 address in colon\-delimited notation, or a hostname. When the supplied
+/etc/resolv\&.conf\&.) It can be an IPv4 address in dotted\-decimal notation, an IPv6 address in colon\-delimited notation, or a hostname\&. When the supplied
\fIserver\fR
argument is a hostname,
\fBmdig\fR
-resolves that name before querying the name server.
+resolves that name before querying the name server\&.
.PP
\fBmdig\fR
-provides a number of query options which affect the way in which lookups are made and the results displayed. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies.
+provides a number of query options which affect the way in which lookups are made and the results displayed\&. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies\&.
.PP
-Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded by the string
+Each query option is identified by a keyword preceded by a plus sign (+)\&. Some keywords set or reset an option\&. These may be preceded by the string
no
-to negate the meaning of that keyword. Other keywords assign values to options like the timeout interval. They have the form
-\fB+keyword=value\fR.
+to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form
+\fB+keyword=value\fR\&.
.SH "ANYWHERE OPTIONS"
.PP
The
option makes
\fBmdig\fR
operate in batch mode by reading a list of lookup requests to process from the file
-\fIfilename\fR. The file contains a number of queries, one per line. Each entry in the file should be organized in the same way they would be presented as queries to
+\fIfilename\fR\&. The file contains a number of queries, one per line\&. Each entry in the file should be organized in the same way they would be presented as queries to
\fBmdig\fR
-using the command\-line interface.
+using the command\-line interface\&.
.PP
The
\fB\-h\fR
causes
\fBmdig\fR
-to print the detailed help with the full list of options and exit.
+to print the detailed help with the full list of options and exit\&.
.PP
The
\fB\-v\fR
causes
\fBmdig\fR
-to print the version number and exit.
+to print the version number and exit\&.
.SH "GLOBAL OPTIONS"
.PP
The
\fB\-4\fR
option forces
\fBmdig\fR
-to only use IPv4 query transport.
+to only use IPv4 query transport\&.
.PP
The
\fB\-6\fR
option forces
\fBmdig\fR
-to only use IPv6 query transport.
+to only use IPv6 query transport\&.
.PP
The
\fB\-b\fR
option sets the source IP address of the query to
-\fIaddress\fR. This must be a valid address on one of the host's network interfaces or "0.0.0.0" or "::". An optional port may be specified by appending "#<port>"
+\fIaddress\fR\&. This must be a valid address on one of the host\*(Aqs network interfaces or "0\&.0\&.0\&.0" or "::"\&. An optional port may be specified by appending "#<port>"
.PP
The
\fB\-p\fR
-option is used when a non\-standard port number is to be queried.
+option is used when a non\-standard port number is to be queried\&.
\fIport#\fR
is the port number that
\fBmdig\fR
-will send its queries instead of the standard DNS port number 53. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number.
+will send its queries instead of the standard DNS port number 53\&. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number\&.
.PP
The global query options are:
.PP
\fB+[no]additional\fR
.RS 4
-Display [do not display] the additional section of a reply. The default is to display it.
+Display [do not display] the additional section of a reply\&. The default is to display it\&.
.RE
.PP
\fB+[no]all\fR
.RS 4
-Set or clear all display flags.
+Set or clear all display flags\&.
.RE
.PP
\fB+[no]answer\fR
.RS 4
-Display [do not display] the answer section of a reply. The default is to display it.
+Display [do not display] the answer section of a reply\&. The default is to display it\&.
.RE
.PP
\fB+[no]authority\fR
.RS 4
-Display [do not display] the authority section of a reply. The default is to display it.
+Display [do not display] the authority section of a reply\&. The default is to display it\&.
.RE
.PP
\fB+[no]besteffort\fR
.RS 4
-Attempt to display the contents of messages which are malformed. The default is to not display malformed answers.
+Attempt to display the contents of messages which are malformed\&. The default is to not display malformed answers\&.
.RE
.PP
\fB+[no]cl\fR
.RS 4
-Display [do not display] the CLASS when printing the record.
+Display [do not display] the CLASS when printing the record\&.
.RE
.PP
\fB+[no]comments\fR
.RS 4
-Toggle the display of comment lines in the output. The default is to print comments.
+Toggle the display of comment lines in the output\&. The default is to print comments\&.
.RE
.PP
\fB+[no]crypto\fR
.RS 4
-Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures. The default is to display the fields. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]".
+Toggle the display of cryptographic fields in DNSSEC records\&. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures\&. The default is to display the fields\&. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e\&.g\&. "[ key id = value ]"\&.
.RE
.PP
\fB+dscp[=value]\fR
.RS 4
-Set the DSCP code point to be used when sending the query. Valid DSCP code points are in the range [0..63]. By default no code point is explicitly set.
+Set the DSCP code point to be used when sending the query\&. Valid DSCP code points are in the range [0\&.\&.63]\&. By default no code point is explicitly set\&.
.RE
.PP
\fB+[no]multiline\fR
.RS 4
-Print records like the SOA records in a verbose multi\-line format with human\-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the
+Print records like the SOA records in a verbose multi\-line format with human\-readable comments\&. The default is to print each record on a single line, to facilitate machine parsing of the
\fBmdig\fR
-output.
+output\&.
.RE
.PP
\fB+[no]question\fR
.RS 4
-Print [do not print] the question section of a query when an answer is returned. The default is to print the question section as a comment.
+Print [do not print] the question section of a query when an answer is returned\&. The default is to print the question section as a comment\&.
.RE
.PP
\fB+[no]rrcomments\fR
.RS 4
-Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records). The default is not to print record comments unless multiline mode is active.
+Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records)\&. The default is not to print record comments unless multiline mode is active\&.
.RE
.PP
\fB+[no]short\fR
.RS 4
-Provide a terse answer. The default is to print the answer in a verbose form.
+Provide a terse answer\&. The default is to print the answer in a verbose form\&.
.RE
.PP
\fB+split=W\fR
\fIW\fR
characters (where
\fIW\fR
-is rounded up to the nearest multiple of 4).
+is rounded up to the nearest multiple of 4)\&.
\fI+nosplit\fR
or
\fI+split=0\fR
-causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active.
+causes fields not to be split at all\&. The default is 56 characters, or 44 characters when multiline mode is active\&.
.RE
.PP
\fB+[no]tcp\fR
.RS 4
-Use [do not use] TCP when querying name servers. The default behavior is to use UDP.
+Use [do not use] TCP when querying name servers\&. The default behavior is to use UDP\&.
.RE
.PP
\fB+[no]ttlid\fR
.RS 4
-Display [do not display] the TTL when printing the record.
+Display [do not display] the TTL when printing the record\&.
.RE
.PP
\fB+[no]ttlunits\fR
.RS 4
-Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks. Implies +ttlid.
+Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks\&. Implies +ttlid\&.
.RE
.PP
\fB+[no]vc\fR
.RS 4
-Use [do not use] TCP when querying name servers. This alternate syntax to
+Use [do not use] TCP when querying name servers\&. This alternate syntax to
\fI+[no]tcp\fR
-is provided for backwards compatibility. The "vc" stands for "virtual circuit".
+is provided for backwards compatibility\&. The "vc" stands for "virtual circuit"\&.
.RE
.SH "LOCAL OPTIONS"
.PP
The
\fB\-c\fR
option sets the query class to
-\fIclass\fR. It can be any valid query class which is supported in BIND 9. The default query class is "IN".
+\fIclass\fR\&. It can be any valid query class which is supported in BIND 9\&. The default query class is "IN"\&.
.PP
The
\fB\-t\fR
option sets the query type to
-\fItype\fR. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the
+\fItype\fR\&. It can be any valid query type which is supported in BIND 9\&. The default query type is "A", unless the
\fB\-x\fR
-option is supplied to indicate a reverse lookup with the "PTR" query type.
+option is supplied to indicate a reverse lookup with the "PTR" query type\&.
.PP
The
\fB\-i\fR
-option sets the reverse domain for IPv6 addresses to IP6.INT.
+option sets the reverse domain for IPv6 addresses to IP6\&.INT\&.
.PP
Reverse lookups \(em mapping addresses to names \(em are simplified by the
\fB\-x\fR
-option.
+option\&.
\fIaddr\fR
-is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address.
+is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&.
\fBmdig\fR
automatically performs a lookup for a query name like
-11.12.13.10.in\-addr.arpa
-and sets the query type and class to PTR and IN respectively. By default, IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. To use the older RFC1886 method using the IP6.INT domain specify the
+11\&.12\&.13\&.10\&.in\-addr\&.arpa
+and sets the query type and class to PTR and IN respectively\&. By default, IPv6 addresses are looked up using nibble format under the IP6\&.ARPA domain\&. To use the older RFC1886 method using the IP6\&.INT domain specify the
\fB\-i\fR
-option.
+option\&.
.PP
The local query options are:
.PP
\fB+[no]aaflag\fR
.RS 4
A synonym for
-\fI+[no]aaonly\fR.
+\fI+[no]aaonly\fR\&.
.RE
.PP
\fB+[no]aaonly\fR
.RS 4
-Sets the "aa" flag in the query.
+Sets the "aa" flag in the query\&.
.RE
.PP
\fB+[no]adflag\fR
.RS 4
-Set [do not set] the AD (authentic data) bit in the query. This requests the server to return whether all of the answer and authority sections have all been validated as secure according to the security policy of the server. AD=1 indicates that all records have been validated as secure and the answer is not from a OPT\-OUT range. AD=0 indicate that some part of the answer was insecure or not validated. This bit is set by default.
+Set [do not set] the AD (authentic data) bit in the query\&. This requests the server to return whether all of the answer and authority sections have all been validated as secure according to the security policy of the server\&. AD=1 indicates that all records have been validated as secure and the answer is not from a OPT\-OUT range\&. AD=0 indicate that some part of the answer was insecure or not validated\&. This bit is set by default\&.
.RE
.PP
\fB+bufsize=B\fR
.RS 4
Set the UDP message buffer size advertised using EDNS0 to
\fIB\fR
-bytes. The maximum and minimum sizes of this buffer are 65535 and 0 respectively. Values outside this range are rounded up or down appropriately. Values other than zero will cause a EDNS query to be sent.
+bytes\&. The maximum and minimum sizes of this buffer are 65535 and 0 respectively\&. Values outside this range are rounded up or down appropriately\&. Values other than zero will cause a EDNS query to be sent\&.
.RE
.PP
\fB+[no]cdflag\fR
.RS 4
-Set [do not set] the CD (checking disabled) bit in the query. This requests the server to not perform DNSSEC validation of responses.
+Set [do not set] the CD (checking disabled) bit in the query\&. This requests the server to not perform DNSSEC validation of responses\&.
.RE
.PP
\fB+[no]cookie\fR\fB[=####]\fR
.RS 4
-Send a COOKIE EDNS option, with optional value. Replaying a COOKIE from a previous response will allow the server to identify a previous client. The default is
-\fB+nocookie\fR.
+Send a COOKIE EDNS option, with optional value\&. Replaying a COOKIE from a previous response will allow the server to identify a previous client\&. The default is
+\fB+nocookie\fR\&.
.RE
.PP
\fB+[no]dnssec\fR
.RS 4
-Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query.
+Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query\&.
.RE
.PP
\fB+[no]edns[=#]\fR
.RS 4
-Specify the EDNS version to query with. Valid values are 0 to 255. Setting the EDNS version will cause a EDNS query to be sent.
+Specify the EDNS version to query with\&. Valid values are 0 to 255\&. Setting the EDNS version will cause a EDNS query to be sent\&.
\fB+noedns\fR
-clears the remembered EDNS version. EDNS is set to 0 by default.
+clears the remembered EDNS version\&. EDNS is set to 0 by default\&.
.RE
.PP
\fB+[no]ednsflags[=#]\fR
.RS 4
-Set the must\-be\-zero EDNS flags bits (Z bits) to the specified value. Decimal, hex and octal encodings are accepted. Setting a named flag (e.g. DO) will silently be ignored. By default, no Z bits are set.
+Set the must\-be\-zero EDNS flags bits (Z bits) to the specified value\&. Decimal, hex and octal encodings are accepted\&. Setting a named flag (e\&.g\&. DO) will silently be ignored\&. By default, no Z bits are set\&.
.RE
.PP
\fB+[no]ednsopt[=code[:value]]\fR
\fBcode\fR
and optionally payload of
\fBvalue\fR
-as a hexadecimal string.
+as a hexadecimal string\&.
\fB+noednsopt\fR
-clears the EDNS options to be sent.
+clears the EDNS options to be sent\&.
.RE
.PP
\fB+[no]expire\fR
.RS 4
-Send an EDNS Expire option.
+Send an EDNS Expire option\&.
.RE
.PP
\fB+[no]nsid\fR
.RS 4
-Include an EDNS name server ID request when sending a query.
+Include an EDNS name server ID request when sending a query\&.
.RE
.PP
\fB+[no]recurse\fR
.RS 4
-Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means
+Toggle the setting of the RD (recursion desired) bit in the query\&. This bit is set by default, which means
\fBmdig\fR
-normally sends recursive queries.
+normally sends recursive queries\&.
.RE
.PP
\fB+retry=T\fR
.RS 4
Sets the number of times to retry UDP queries to server to
\fIT\fR
-instead of the default, 2. Unlike
-\fI+tries\fR, this does not include the initial query.
+instead of the default, 2\&. Unlike
+\fI+tries\fR, this does not include the initial query\&.
.RE
.PP
\fB+[no]subnet=addr/prefix\fR
.RS 4
-Send an EDNS Client Subnet option with the specified IP address or network prefix.
+Send an EDNS Client Subnet option with the specified IP address or network prefix\&.
.RE
.PP
\fB+timeout=T\fR
.RS 4
Sets the timeout for a query to
\fIT\fR
-seconds. The default timeout is 5 seconds for UDP transport and 10 for TCP. An attempt to set
+seconds\&. The default timeout is 5 seconds for UDP transport and 10 for TCP\&. An attempt to set
\fIT\fR
-to less than 1 will result in a query timeout of 1 second being applied.
+to less than 1 will result in a query timeout of 1 second being applied\&.
.RE
.PP
\fB+tries=T\fR
.RS 4
Sets the number of times to try UDP queries to server to
\fIT\fR
-instead of the default, 3. If
+instead of the default, 3\&. If
\fIT\fR
-is less than or equal to zero, the number of tries is silently rounded up to 1.
+is less than or equal to zero, the number of tries is silently rounded up to 1\&.
.RE
.PP
\fB+udptimeout=T\fR
.RS 4
-Sets the timeout between UDP query retries.
+Sets the timeout between UDP query retries\&.
.RE
.PP
\fB+[no]zflag\fR
.RS 4
-Set [do not set] the last unassigned DNS header flag in a DNS query. This flag is off by default.
+Set [do not set] the last unassigned DNS header flag in a DNS query\&. This flag is off by default\&.
.RE
.SH "SEE ALSO"
.PP
\fBdig\fR(1),
-RFC1035.
+RFC1035\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2015 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>mdig</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="mdig">
<a name="man.mdig"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">mdig</span> — DNS pipelined lookup utility</p>
+<p>
+ <span class="application">mdig</span>
+ — DNS pipelined lookup utility
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">mdig</code> {@server} [<code class="option">-f <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v</code>] [<code class="option">-4</code>] [<code class="option">-6</code>] [<code class="option">-b <em class="replaceable"><code>address</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port#</code></em></code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-i</code>] [<code class="option">-x <em class="replaceable"><code>addr</code></em></code>] [plusopt...]</p></div>
-<div class="cmdsynopsis"><p><code class="command">mdig</code> {-h}</p></div>
-<div class="cmdsynopsis"><p><code class="command">mdig</code> [@server] {global-opt...} {
+ <div class="cmdsynopsis"><p>
+ <code class="command">mdig</code>
+ {@server}
+ [<code class="option">-f <em class="replaceable"><code>filename</code></em></code>]
+ [<code class="option">-h</code>]
+ [<code class="option">-v</code>]
+ [<code class="option">-4</code>]
+ [<code class="option">-6</code>]
+ [<code class="option">-b <em class="replaceable"><code>address</code></em></code>]
+ [<code class="option">-p <em class="replaceable"><code>port#</code></em></code>]
+ [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
+ [<code class="option">-t <em class="replaceable"><code>type</code></em></code>]
+ [<code class="option">-i</code>]
+ [<code class="option">-x <em class="replaceable"><code>addr</code></em></code>]
+ [plusopt...]
+ </p></div>
+
+ <div class="cmdsynopsis"><p>
+ <code class="command">mdig</code>
+ {-h}
+ </p></div>
+
+ <div class="cmdsynopsis"><p>
+ <code class="command">mdig</code>
+ [@server]
+ {global-opt...}
+ {
{local-opt...}
{query}
- ...}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543476"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">mdig</strong></span>
- is a multiple/pipelined query version of <span><strong class="command">dig</strong></span>:
+ ...}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp61001296"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>mdig</strong></span>
+ is a multiple/pipelined query version of <span class="command"><strong>dig</strong></span>:
instead of waiting for a response after sending each query,
it begins by sending all queries. Responses are displayed in
the order in which they are received, not in the order the
corresponding queries were sent.
</p>
-<p>
- <span><strong class="command">mdig</strong></span> options are a subset of the
- <span><strong class="command">dig</strong></span> options, and are divided into "anywhere
+
+ <p>
+ <span class="command"><strong>mdig</strong></span> options are a subset of the
+ <span class="command"><strong>dig</strong></span> options, and are divided into "anywhere
options" which can occur anywhere, "global options" which must
occur before the query name (or they are ignored with a warning),
and "local options" which apply to the next query on the command
line.
</p>
-<p>
+
+ <p>
The {@server} option is a mandatory global
option. It is the name or IP address of the name server to query.
- (Unlike <span><strong class="command">dig</strong></span>, this value is not retrieved from
+ (Unlike <span class="command"><strong>dig</strong></span>, this value is not retrieved from
<code class="filename">/etc/resolv.conf</code>.) It can be an IPv4 address
in dotted-decimal notation, an IPv6 address in colon-delimited
notation, or a hostname. When the supplied
<em class="parameter"><code>server</code></em> argument is a hostname,
- <span><strong class="command">mdig</strong></span> resolves that name before querying
+ <span class="command"><strong>mdig</strong></span> resolves that name before querying
the name server.
</p>
-<p><span><strong class="command">mdig</strong></span>
+
+ <p><span class="command"><strong>mdig</strong></span>
provides a number of query options which affect
the way in which lookups are made and the results displayed. Some of
these set or reset flag bits in the query header, some determine which
sections of the answer get printed, and others determine the timeout
and retry strategies.
</p>
-<p>
+
+ <p>
Each query option is identified by a keyword preceded by a plus
sign (<code class="literal">+</code>). Some keywords set or reset an
option. These may be preceded by the string <code class="literal">no</code>
values to options like the timeout interval. They have the
form <code class="option">+keyword=value</code>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543544"></a><h2>ANYWHERE OPTIONS</h2>
-<p>
- The <code class="option">-f</code> option makes <span><strong class="command">mdig</strong></span>
+ </div>
+
+ <div class="refsection" title="ANYWHERE OPTIONS">
+<a name="idp61017680"></a><h2>ANYWHERE OPTIONS</h2>
+
+
+ <p>
+ The <code class="option">-f</code> option makes <span class="command"><strong>mdig</strong></span>
operate in batch mode by reading a list of lookup requests to
process from the file <em class="parameter"><code>filename</code></em>. The file
contains a number of queries, one per line. Each entry in the
file should be organized in the same way they would be presented
- as queries to <span><strong class="command">mdig</strong></span> using the command-line interface.
+ as queries to <span class="command"><strong>mdig</strong></span> using the command-line interface.
</p>
-<p>
- The <code class="option">-h</code> causes <span><strong class="command">mdig</strong></span> to
+
+ <p>
+ The <code class="option">-h</code> causes <span class="command"><strong>mdig</strong></span> to
print the detailed help with the full list of options and exit.
</p>
-<p>
- The <code class="option">-v</code> causes <span><strong class="command">mdig</strong></span> to
+
+ <p>
+ The <code class="option">-v</code> causes <span class="command"><strong>mdig</strong></span> to
print the version number and exit.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543588"></a><h2>GLOBAL OPTIONS</h2>
-<p>
- The <code class="option">-4</code> option forces <span><strong class="command">mdig</strong></span> to
+ </div>
+
+ <div class="refsection" title="GLOBAL OPTIONS">
+<a name="idp61023056"></a><h2>GLOBAL OPTIONS</h2>
+
+
+ <p>
+ The <code class="option">-4</code> option forces <span class="command"><strong>mdig</strong></span> to
only use IPv4 query transport.
</p>
-<p>
- The <code class="option">-6</code> option forces <span><strong class="command">mdig</strong></span> to
+
+ <p>
+ The <code class="option">-6</code> option forces <span class="command"><strong>mdig</strong></span> to
only use IPv6 query transport.
</p>
-<p>
+
+ <p>
The <code class="option">-b</code> option sets the source IP address of the
query to <em class="parameter"><code>address</code></em>. This must be a valid
address on one of the host's network interfaces or "0.0.0.0" or
"::". An optional port may be specified by appending
"#<port>"
</p>
-<p>
+
+ <p>
The <code class="option">-p</code> option is used when a non-standard port
number is to be queried.
<em class="parameter"><code>port#</code></em> is the port number
- that <span><strong class="command">mdig</strong></span> will send its queries instead of
+ that <span class="command"><strong>mdig</strong></span> will send its queries instead of
the standard DNS port number 53. This option would be used to
test a name server that has been configured to listen for
queries on a non-standard port number.
</p>
-<p>
+
+ <p>
The global query options are:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="option">+[no]additional</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the additional section of a
reply. The default is to display it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]all</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set or clear all display flags.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]answer</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the answer section of a
reply. The default is to display it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]authority</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the authority section of a
reply. The default is to display it.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]besteffort</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Attempt to display the contents of messages which are
malformed. The default is to not display malformed
answers.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]cl</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the CLASS when printing the
record.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]comments</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the display of comment lines in the output.
The default is to print comments.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]crypto</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the display of cryptographic fields in DNSSEC
records. The contents of these field are unnecessary
to debug most DNSSEC validation failures and removing
are replaced by the string "[omitted]" or in the
DNSKEY case the key id is displayed as the replacement,
e.g. "[ key id = value ]".
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+dscp[=value]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the DSCP code point to be used when sending the
query. Valid DSCP code points are in the range
[0..63]. By default no code point is explicitly set.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]multiline</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Print records like the SOA records in a verbose
multi-line format with human-readable comments. The
default is to print each record on a single line, to
- facilitate machine parsing of the <span><strong class="command">mdig</strong></span>
+ facilitate machine parsing of the <span class="command"><strong>mdig</strong></span>
output.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]question</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Print [do not print] the question section of a query
when an answer is returned. The default is to print
the question section as a comment.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]rrcomments</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the display of per-record comments in the
output (for example, human-readable key information
about DNSKEY records). The default is not to print
record comments unless multiline mode is active.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]short</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Provide a terse answer. The default is to print the
answer in a verbose form.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+split=W</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Split long hex- or base64-formatted fields in resource
records into chunks of <em class="parameter"><code>W</code></em>
characters (where <em class="parameter"><code>W</code></em> is rounded
<em class="parameter"><code>+split=0</code></em> causes fields not to
be split at all. The default is 56 characters, or
44 characters when multiline mode is active.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]tcp</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Use [do not use] TCP when querying name servers. The
default behavior is to use UDP.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ttlid</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the TTL when printing the
record.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ttlunits</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Display [do not display] the TTL in friendly human-readable
time units of "s", "m", "h", "d", and "w", representing
seconds, minutes, hours, days and weeks. Implies +ttlid.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]vc</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Use [do not use] TCP when querying name servers. This
alternate syntax to <em class="parameter"><code>+[no]tcp</code></em>
is provided for backwards compatibility. The "vc"
stands for "virtual circuit".
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544055"></a><h2>LOCAL OPTIONS</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="LOCAL OPTIONS">
+<a name="idp61063248"></a><h2>LOCAL OPTIONS</h2>
+
+
+ <p>
The <code class="option">-c</code> option sets the query class to
<em class="parameter"><code>class</code></em>. It can be any valid query class
which is supported in BIND 9. The default query class is "IN".
</p>
-<p>
+
+ <p>
The <code class="option">-t</code> option sets the query type to
<em class="parameter"><code>type</code></em>. It can be any valid query type
which is supported in BIND 9. The default query type is "A",
unless the <code class="option">-x</code> option is supplied to indicate
a reverse lookup with the "PTR" query type.
</p>
-<p>
+
+ <p>
The <code class="option">-i</code> option sets the reverse domain for
IPv6 addresses to IP6.INT.
</p>
-<p>
+
+ <p>
Reverse lookups — mapping addresses to names — are
simplified by the <code class="option">-x</code> option.
<em class="parameter"><code>addr</code></em> is an IPv4
address in dotted-decimal notation, or a colon-delimited IPv6 address.
- <span><strong class="command">mdig</strong></span> automatically performs a lookup for a
+ <span class="command"><strong>mdig</strong></span> automatically performs a lookup for a
query name like <code class="literal">11.12.13.10.in-addr.arpa</code> and
sets the query type and class to PTR and IN respectively.
By default, IPv6 addresses are looked up using nibble format
under the IP6.ARPA domain. To use the older RFC1886 method
using the IP6.INT domain specify the <code class="option">-i</code> option.
</p>
-<p>
+
+ <p>
The local query options are:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="option">+[no]aaflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A synonym for <em class="parameter"><code>+[no]aaonly</code></em>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]aaonly</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the "aa" flag in the query.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]adflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set [do not set] the AD (authentic data) bit in the
query. This requests the server to return whether
all of the answer and authority sections have all
from a OPT-OUT range. AD=0 indicate that some part
of the answer was insecure or not validated. This
bit is set by default.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+bufsize=B</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the UDP message buffer size advertised using EDNS0
to <em class="parameter"><code>B</code></em> bytes. The maximum and
minimum sizes of this buffer are 65535 and 0 respectively.
Values outside this range are rounded up or down
appropriately. Values other than zero will cause a
EDNS query to be sent.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]cdflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set [do not set] the CD (checking disabled) bit in
the query. This requests the server to not perform
DNSSEC validation of responses.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]cookie[<span class="optional">=####</span>]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Send a COOKIE EDNS option, with optional value.
Replaying a COOKIE from a previous response will allow
the server to identify a previous client. The default
is <code class="option">+nocookie</code>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]dnssec</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Requests DNSSEC records be sent by setting the DNSSEC
OK bit (DO) in the OPT record in the additional section
of the query.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]edns[=#]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify the EDNS version to query with. Valid values
are 0 to 255. Setting the EDNS version will cause
a EDNS query to be sent. <code class="option">+noedns</code>
clears the remembered EDNS version. EDNS is set to
0 by default.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ednsflags[=#]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set the must-be-zero EDNS flags bits (Z bits) to the
specified value. Decimal, hex and octal encodings are
accepted. Setting a named flag (e.g. DO) will silently be
ignored. By default, no Z bits are set.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]ednsopt[=code[:value]]</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Specify EDNS option with code point <code class="option">code</code>
and optionally payload of <code class="option">value</code> as a
hexadecimal string. <code class="option">+noednsopt</code>
clears the EDNS options to be sent.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]expire</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Send an EDNS Expire option.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]nsid</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Include an EDNS name server ID request when sending
a query.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]recurse</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Toggle the setting of the RD (recursion desired) bit
in the query. This bit is set by default, which means
- <span><strong class="command">mdig</strong></span> normally sends recursive
+ <span class="command"><strong>mdig</strong></span> normally sends recursive
queries.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+retry=T</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the number of times to retry UDP queries to
server to <em class="parameter"><code>T</code></em> instead of the
default, 2. Unlike <em class="parameter"><code>+tries</code></em>,
this does not include the initial query.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]subnet=addr/prefix</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Send an EDNS Client Subnet option with the specified
IP address or network prefix.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+timeout=T</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the timeout for a query to
<em class="parameter"><code>T</code></em> seconds. The default
timeout is 5 seconds for UDP transport and 10 for TCP.
An attempt to set <em class="parameter"><code>T</code></em> to less
than 1 will result
in a query timeout of 1 second being applied.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+tries=T</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the number of times to try UDP queries to server
to <em class="parameter"><code>T</code></em> instead of the default,
3. If <em class="parameter"><code>T</code></em> is less than or equal
to zero, the number of tries is silently rounded up
to 1.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+udptimeout=T</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Sets the timeout between UDP query retries.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="option">+[no]zflag</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Set [do not set] the last unassigned DNS header flag in a
DNS query. This flag is off by default.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544579"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">dig</span>(1)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp61162704"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">dig</span>(1)
+ </span>,
<em class="citetitle">RFC1035</em>.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: named\-journalprint
+'\" t
+.\" Title: named-journalprint
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: December 04, 2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2009-12-04
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "NAMED\-JOURNALPRINT" "8" "December 04, 2009" "BIND9" "BIND9"
+.TH "NAMED\-JOURNALPRINT" "8" "2009\-12\-04" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-named\-journalprint \- print zone journal in human\-readable form
+named-journalprint \- print zone journal in human\-readable form
.SH "SYNOPSIS"
.HP 19
\fBnamed\-journalprint\fR {\fIjournal\fR}
.SH "DESCRIPTION"
.PP
\fBnamed\-journalprint\fR
-prints the contents of a zone journal file in a human\-readable form.
+prints the contents of a zone journal file in a human\-readable form\&.
.PP
Journal files are automatically created by
\fBnamed\fR
-when changes are made to dynamic zones (e.g., by
-\fBnsupdate\fR). They record each addition or deletion of a resource record, in binary format, allowing the changes to be re\-applied to the zone when the server is restarted after a shutdown or crash. By default, the name of the journal file is formed by appending the extension
-\fI.jnl\fR
-to the name of the corresponding zone file.
+when changes are made to dynamic zones (e\&.g\&., by
+\fBnsupdate\fR)\&. They record each addition or deletion of a resource record, in binary format, allowing the changes to be re\-applied to the zone when the server is restarted after a shutdown or crash\&. By default, the name of the journal file is formed by appending the extension
+\&.jnl
+to the name of the corresponding zone file\&.
.PP
\fBnamed\-journalprint\fR
-converts the contents of a given journal file into a human\-readable text format. Each line begins with "add" or "del", to indicate whether the record was added or deleted, and continues with the resource record in master\-file format.
+converts the contents of a given journal file into a human\-readable text format\&. Each line begins with "add" or "del", to indicate whether the record was added or deleted, and continues with the resource record in master\-file format\&.
.SH "SEE ALSO"
.PP
\fBnamed\fR(8),
\fBnsupdate\fR(8),
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-journalprint">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-journalprint</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="named-journalprint">
<a name="man.named-journalprint"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">named-journalprint</span> — print zone journal in human-readable form</p>
+<p>
+ <span class="application">named-journalprint</span>
+ — print zone journal in human-readable form
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">named-journalprint</code> {<em class="replaceable"><code>journal</code></em>}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543354"></a><h2>DESCRIPTION</h2>
-<p>
- <span><strong class="command">named-journalprint</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">named-journalprint</code>
+ {<em class="replaceable"><code>journal</code></em>}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60869968"></a><h2>DESCRIPTION</h2>
+
+ <p>
+ <span class="command"><strong>named-journalprint</strong></span>
prints the contents of a zone journal file in a human-readable
form.
</p>
-<p>
- Journal files are automatically created by <span><strong class="command">named</strong></span>
+ <p>
+ Journal files are automatically created by <span class="command"><strong>named</strong></span>
when changes are made to dynamic zones (e.g., by
- <span><strong class="command">nsupdate</strong></span>). They record each addition
+ <span class="command"><strong>nsupdate</strong></span>). They record each addition
or deletion of a resource record, in binary format, allowing the
changes to be re-applied to the zone when the server is
restarted after a shutdown or crash. By default, the name of
<code class="filename">.jnl</code> to the name of the corresponding
zone file.
</p>
-<p>
- <span><strong class="command">named-journalprint</strong></span> converts the contents of a given
+ <p>
+ <span class="command"><strong>named-journalprint</strong></span> converts the contents of a given
journal file into a human-readable text format. Each line begins
with "add" or "del", to indicate whether the record was added or
deleted, and continues with the resource record in master-file
format.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543389"></a><h2>SEE ALSO</h2>
-<p>
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
- <span class="citerefentry"><span class="refentrytitle">nsupdate</span>(8)</span>,
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60874064"></a><h2>SEE ALSO</h2>
+
+ <p>
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">nsupdate</span>(8)
+ </span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543420"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: named\-rrchecker
+'\" t
+.\" Title: named-rrchecker
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: November 12, 2013
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2013-11-12
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "NAMED\-RRCHECKER" "1" "November 12, 2013" "BIND9" "BIND9"
+.TH "NAMED\-RRCHECKER" "1" "2013\-11\-12" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-named\-rrchecker \- A syntax checker for individual DNS resource records
+named-rrchecker \- A syntax checker for individual DNS resource records
.SH "SYNOPSIS"
.HP 16
\fBnamed\-rrchecker\fR [\fB\-h\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-p\fR] [\fB\-u\fR] [\fB\-C\fR] [\fB\-T\fR] [\fB\-P\fR]
.SH "DESCRIPTION"
.PP
\fBnamed\-rrchecker\fR
-read a individual DNS resource record from standard input and checks if it is syntactically correct.
+read a individual DNS resource record from standard input and checks if it is syntactically correct\&.
.PP
The
\fB\-h\fR
-prints out the help menu.
+prints out the help menu\&.
.PP
The
\fB\-o \fR\fB\fIorigin\fR\fR
-option specifies a origin to be used when interpreting the record.
+option specifies a origin to be used when interpreting the record\&.
.PP
The
\fB\-p\fR
-prints out the resulting record in canonical form. If there is no canonical form defined then the record will be printed in unknown record format.
+prints out the resulting record in canonical form\&. If there is no canonical form defined then the record will be printed in unknown record format\&.
.PP
The
\fB\-u\fR
-prints out the resulting record in unknown record form.
+prints out the resulting record in unknown record form\&.
.PP
The
\fB\-C\fR,
\fB\-T\fR
and
\fB\-P\fR
-print out the known class, standard type and private type mnemonics respectively.
+print out the known class, standard type and private type mnemonics respectively\&.
.SH "SEE ALSO"
.PP
RFC 1034,
RFC 1035,
\fBnamed\fR(8)
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-rrchecker">
<info>
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-rrchecker</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="named-rrchecker">
<a name="man.named-rrchecker"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">named-rrchecker</span> — A syntax checker for individual DNS resource records</p>
+<p>
+ <span class="application">named-rrchecker</span>
+ — A syntax checker for individual DNS resource records
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">named-rrchecker</code> [<code class="option">-h</code>] [<code class="option">-o <em class="replaceable"><code>origin</code></em></code>] [<code class="option">-p</code>] [<code class="option">-u</code>] [<code class="option">-C</code>] [<code class="option">-T</code>] [<code class="option">-P</code>]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543380"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">named-rrchecker</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">named-rrchecker</code>
+ [<code class="option">-h</code>]
+ [<code class="option">-o <em class="replaceable"><code>origin</code></em></code>]
+ [<code class="option">-p</code>]
+ [<code class="option">-u</code>]
+ [<code class="option">-C</code>]
+ [<code class="option">-T</code>]
+ [<code class="option">-P</code>]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60845008"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>named-rrchecker</strong></span>
read a individual DNS resource record from standard input and checks if it
is syntactically correct.
</p>
-<p>
+ <p>
The <code class="option">-h</code> prints out the help menu.
</p>
-<p>
+ <p>
The <code class="option">-o <em class="replaceable"><code>origin</code></em></code>
option specifies a origin to be used when interpreting the record.
</p>
-<p>
+ <p>
The <code class="option">-p</code> prints out the resulting record in canonical
form. If there is no canonical form defined then the record will be
printed in unknown record format.
</p>
-<p>
+ <p>
The <code class="option">-u</code> prints out the resulting record in unknown record
form.
</p>
-<p>
+ <p>
The <code class="option">-C</code>, <code class="option">-T</code> and <code class="option">-P</code>
print out the known class, standard type and private type mnemonics
respectively.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543434"></a><h2>SEE ALSO</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60815056"></a><h2>SEE ALSO</h2>
+
+ <p>
<em class="citetitle">RFC 1034</em>,
<em class="citetitle">RFC 1035</em>,
- <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">named</span>(8)
+ </span>
</p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: nsec3hash
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: March 02, 2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2009-03-02
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "NSEC3HASH" "8" "March 02, 2009" "BIND9" "BIND9"
+.TH "NSEC3HASH" "8" "2009\-03\-02" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
nsec3hash \- generate NSEC3 hash
.SH "SYNOPSIS"
.SH "DESCRIPTION"
.PP
\fBnsec3hash\fR
-generates an NSEC3 hash based on a set of NSEC3 parameters. This can be used to check the validity of NSEC3 records in a signed zone.
+generates an NSEC3 hash based on a set of NSEC3 parameters\&. This can be used to check the validity of NSEC3 records in a signed zone\&.
.SH "ARGUMENTS"
.PP
salt
.RS 4
-The salt provided to the hash algorithm.
+The salt provided to the hash algorithm\&.
.RE
.PP
algorithm
.RS 4
-A number indicating the hash algorithm. Currently the only supported hash algorithm for NSEC3 is SHA\-1, which is indicated by the number 1; consequently "1" is the only useful value for this argument.
+A number indicating the hash algorithm\&. Currently the only supported hash algorithm for NSEC3 is SHA\-1, which is indicated by the number 1; consequently "1" is the only useful value for this argument\&.
.RE
.PP
iterations
.RS 4
-The number of additional times the hash should be performed.
+The number of additional times the hash should be performed\&.
.RE
.PP
domain
.RS 4
-The domain name to be hashed.
+The domain name to be hashed\&.
.RE
.SH "SEE ALSO"
.PP
BIND 9 Administrator Reference Manual,
-RFC 5155.
+RFC 5155\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.nsec3hash">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>nsec3hash</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="nsec3hash">
<a name="man.nsec3hash"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">nsec3hash</span> — generate NSEC3 hash</p>
+<p>
+ <span class="application">nsec3hash</span>
+ — generate NSEC3 hash
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">nsec3hash</code> {<em class="replaceable"><code>salt</code></em>} {<em class="replaceable"><code>algorithm</code></em>} {<em class="replaceable"><code>iterations</code></em>} {<em class="replaceable"><code>domain</code></em>}</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543379"></a><h2>DESCRIPTION</h2>
-<p>
- <span><strong class="command">nsec3hash</strong></span> generates an NSEC3 hash based on
+ <div class="cmdsynopsis"><p>
+ <code class="command">nsec3hash</code>
+ {<em class="replaceable"><code>salt</code></em>}
+ {<em class="replaceable"><code>algorithm</code></em>}
+ {<em class="replaceable"><code>iterations</code></em>}
+ {<em class="replaceable"><code>domain</code></em>}
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60866512"></a><h2>DESCRIPTION</h2>
+
+ <p>
+ <span class="command"><strong>nsec3hash</strong></span> generates an NSEC3 hash based on
a set of NSEC3 parameters. This can be used to check the validity
of NSEC3 records in a signed zone.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543392"></a><h2>ARGUMENTS</h2>
-<div class="variablelist"><dl>
+ </div>
+
+ <div class="refsection" title="ARGUMENTS">
+<a name="idp60868304"></a><h2>ARGUMENTS</h2>
+
+ <div class="variablelist"><dl>
<dt><span class="term">salt</span></dt>
-<dd><p>
+<dd>
+ <p>
The salt provided to the hash algorithm.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">algorithm</span></dt>
-<dd><p>
+<dd>
+ <p>
A number indicating the hash algorithm. Currently the
only supported hash algorithm for NSEC3 is SHA-1, which is
indicated by the number 1; consequently "1" is the only
useful value for this argument.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">iterations</span></dt>
-<dd><p>
+<dd>
+ <p>
The number of additional times the hash should be performed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">domain</span></dt>
-<dd><p>
+<dd>
+ <p>
The domain name to be hashed.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543453"></a><h2>SEE ALSO</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60875984"></a><h2>SEE ALSO</h2>
+
+ <p>
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 5155</em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543470"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<book xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 1. Introduction</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
</table>
<hr>
</div>
-<div class="chapter">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch01"></a>Chapter 1. Introduction</h1></div></div></div>
+<div class="chapter" title="Chapter 1. Introduction">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch01"></a>Chapter 1. Introduction</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.4">Scope of Document</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.5">Organization of This Document</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.6">Conventions Used in This Document</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7">The Domain Name System (<acronym class="acronym">DNS</acronym>)</a></span></dt>
+<dl>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71663696">Scope of Document</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71666384">Organization of This Document</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71674448">Conventions Used in This Document</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71718608">The Domain Name System (<acronym class="acronym">DNS</acronym>)</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.4">DNS Fundamentals</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.5">Domains and Domain Names</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.6">Zones</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.7">Authoritative Name Servers</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.8">Caching Name Servers</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.9">Name Servers in Multiple Roles</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71721808">DNS Fundamentals</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71725904">Domains and Domain Names</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71735504">Zones</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71744720">Authoritative Name Servers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71765968">Caching Name Servers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71773776">Name Servers in Multiple Roles</a></span></dt>
</dl></dd>
</dl>
</div>
hierarchical databases.
</p>
- <div class="section">
+ <div class="section" title="Scope of Document">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.2.4"></a>Scope of Document</h2></div></div></div>
+<a name="idp71663696"></a>Scope of Document</h2></div></div></div>
<p>
<p>This version of the manual corresponds to BIND version 9.11.</p>
</div>
- <div class="section">
+ <div class="section" title="Organization of This Document">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.2.5"></a>Organization of This Document</h2></div></div></div>
+<a name="idp71666384"></a>Organization of This Document</h2></div></div></div>
<p>
In this document, <span class="emphasis"><em>Chapter 1</em></span> introduces
System.
</p>
</div>
- <div class="section">
+ <div class="section" title="Conventions Used in This Document">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.2.6"></a>Conventions Used in This Document</h2></div></div></div>
+<a name="idp71674448"></a>Conventions Used in This Document</h2></div></div></div>
<p>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="The Domain Name System (DNS)">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.2.7"></a>The Domain Name System (<acronym class="acronym">DNS</acronym>)</h2></div></div></div>
+<a name="idp71718608"></a>The Domain Name System (<acronym class="acronym">DNS</acronym>)</h2></div></div></div>
<p>
The purpose of this document is to explain the installation
(<acronym class="acronym">DNS</acronym>) as they relate to <acronym class="acronym">BIND</acronym>.
</p>
- <div class="section">
+ <div class="section" title="DNS Fundamentals">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.2.7.4"></a>DNS Fundamentals</h3></div></div></div>
+<a name="idp71721808"></a>DNS Fundamentals</h3></div></div></div>
<p>
</p>
</div>
-<div class="section">
+<div class="section" title="Domains and Domain Names">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.2.7.5"></a>Domains and Domain Names</h3></div></div></div>
+<a name="idp71725904"></a>Domains and Domain Names</h3></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="Zones">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.2.7.6"></a>Zones</h3></div></div></div>
+<a name="idp71735504"></a>Zones</h3></div></div></div>
<p>
To properly operate a name server, it is important to understand
</p>
</div>
- <div class="section">
+ <div class="section" title="Authoritative Name Servers">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.2.7.7"></a>Authoritative Name Servers</h3></div></div></div>
+<a name="idp71744720"></a>Authoritative Name Servers</h3></div></div></div>
<p>
<span class="command"><strong>dig</strong></span> (<a class="xref" href="Bv9ARM.ch03.html#diagnostic_tools" title="Diagnostic Tools">the section called “Diagnostic Tools”</a>).
</p>
- <div class="section">
+ <div class="section" title="The Primary Master">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.2.7.7.5"></a>The Primary Master</h4></div></div></div>
+<a name="idp71747536"></a>The Primary Master</h4></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="Slave Servers">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.2.7.7.6"></a>Slave Servers</h4></div></div></div>
+<a name="idp71759568"></a>Slave Servers</h4></div></div></div>
<p>
The other authoritative servers, the <span class="emphasis"><em>slave</em></span>
</p>
</div>
- <div class="section">
+ <div class="section" title="Stealth Servers">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.2.7.7.7"></a>Stealth Servers</h4></div></div></div>
+<a name="idp71762128"></a>Stealth Servers</h4></div></div></div>
<p>
</div>
</div>
- <div class="section">
+ <div class="section" title="Caching Name Servers">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.2.7.8"></a>Caching Name Servers</h3></div></div></div>
+<a name="idp71765968"></a>Caching Name Servers</h3></div></div></div>
Time To Live (TTL) field associated with each resource record.
</p>
- <div class="section">
+ <div class="section" title="Forwarding">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.2.7.8.6"></a>Forwarding</h4></div></div></div>
+<a name="idp71770320"></a>Forwarding</h4></div></div></div>
<p>
</div>
- <div class="section">
+ <div class="section" title="Name Servers in Multiple Roles">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.2.7.9"></a>Name Servers in Multiple Roles</h3></div></div></div>
+<a name="idp71773776"></a>Name Servers in Multiple Roles</h3></div></div></div>
<p>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 2. BIND Resource Requirements</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch01.html" title="Chapter 1. Introduction">
</table>
<hr>
</div>
-<div class="chapter">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch02"></a>Chapter 2. <acronym class="acronym">BIND</acronym> Resource Requirements</h1></div></div></div>
+<div class="chapter" title="Chapter 2. BIND Resource Requirements">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch02"></a>Chapter 2. <acronym class="acronym">BIND</acronym> Resource Requirements</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.3">Hardware requirements</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.4">CPU Requirements</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.5">Memory Requirements</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.6">Name Server Intensive Environment Issues</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.7">Supported Operating Systems</a></span></dt>
+<dl>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71778640">Hardware requirements</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71781968">CPU Requirements</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71783888">Memory Requirements</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71787344">Name Server Intensive Environment Issues</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71788752">Supported Operating Systems</a></span></dt>
</dl>
</div>
- <div class="section">
+ <div class="section" title="Hardware requirements">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.3.3"></a>Hardware requirements</h2></div></div></div>
+<a name="idp71778640"></a>Hardware requirements</h2></div></div></div>
<p>
multiprocessor systems for installations that need it.
</p>
</div>
- <div class="section">
+ <div class="section" title="CPU Requirements">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.3.4"></a>CPU Requirements</h2></div></div></div>
+<a name="idp71781968"></a>CPU Requirements</h2></div></div></div>
<p>
CPU requirements for <acronym class="acronym">BIND</acronym> 9 range from
</p>
</div>
- <div class="section">
+ <div class="section" title="Memory Requirements">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.3.5"></a>Memory Requirements</h2></div></div></div>
+<a name="idp71783888"></a>Memory Requirements</h2></div></div></div>
<p>
The memory of the server has to be large enough to fit the
</div>
- <div class="section">
+ <div class="section" title="Name Server Intensive Environment Issues">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.3.6"></a>Name Server Intensive Environment Issues</h2></div></div></div>
+<a name="idp71787344"></a>Name Server Intensive Environment Issues</h2></div></div></div>
<p>
For name server intensive environments, there are two alternative
</p>
</div>
- <div class="section">
+ <div class="section" title="Supported Operating Systems">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.3.7"></a>Supported Operating Systems</h2></div></div></div>
+<a name="idp71788752"></a>Supported Operating Systems</h2></div></div></div>
<p>
ISC <acronym class="acronym">BIND</acronym> 9 compiles and runs on a large
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 3. Name Server Configuration</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch02.html" title="Chapter 2. BIND Resource Requirements">
</table>
<hr>
</div>
-<div class="chapter">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch03"></a>Chapter 3. Name Server Configuration</h1></div></div></div>
+<div class="chapter" title="Chapter 3. Name Server Configuration">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch03"></a>Chapter 3. Name Server Configuration</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
+<dl>
<dt><span class="section"><a href="Bv9ARM.ch03.html#sample_configuration">Sample Configurations</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.4.3">A Caching-only Name Server</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.4.4">An Authoritative-only Name Server</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71793232">A Caching-only Name Server</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71795408">An Authoritative-only Name Server</a></span></dt>
</dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.5">Load Balancing</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.6">Name Server Operations</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71798224">Load Balancing</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71842384">Name Server Operations</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.6.3">Tools for Use With the Name Server Daemon</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.6.4">Signals</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71843280">Tools for Use With the Name Server Daemon</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71949264">Signals</a></span></dt>
</dl></dd>
</dl>
</div>
certain option settings.
</p>
- <div class="section">
+ <div class="section" title="Sample Configurations">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="sample_configuration"></a>Sample Configurations</h2></div></div></div>
- <div class="section">
+ <div class="section" title="A Caching-only Name Server">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.4.4.3"></a>A Caching-only Name Server</h3></div></div></div>
+<a name="idp71793232"></a>A Caching-only Name Server</h3></div></div></div>
<p>
The following sample configuration is appropriate for a caching-only
</div>
- <div class="section">
+ <div class="section" title="An Authoritative-only Name Server">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.4.4.4"></a>An Authoritative-only Name Server</h3></div></div></div>
+<a name="idp71795408"></a>An Authoritative-only Name Server</h3></div></div></div>
<p>
This sample configuration is for an authoritative-only server
</div>
</div>
- <div class="section">
+ <div class="section" title="Load Balancing">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.4.5"></a>Load Balancing</h2></div></div></div>
+<a name="idp71798224"></a>Load Balancing</h2></div></div></div>
</div>
- <div class="section">
+ <div class="section" title="Name Server Operations">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.4.6"></a>Name Server Operations</h2></div></div></div>
+<a name="idp71842384"></a>Name Server Operations</h2></div></div></div>
- <div class="section">
+ <div class="section" title="Tools for Use With the Name Server Daemon">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.4.6.3"></a>Tools for Use With the Name Server Daemon</h3></div></div></div>
+<a name="idp71843280"></a>Tools for Use With the Name Server Daemon</h3></div></div></div>
<p>
This section describes several indispensable diagnostic,
administrator for controlling and debugging the name server
daemon.
</p>
- <div class="section">
+ <div class="section" title="Diagnostic Tools">
<div class="titlepage"><div><div><h4 class="title">
<a name="diagnostic_tools"></a>Diagnostic Tools</h4></div></div></div>
output format.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><a name="dig"></a><span class="command"><strong>dig</strong></span></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="section">
+ <div class="section" title="Administrative Tools">
<div class="titlepage"><div><div><h4 class="title">
<a name="admin_tools"></a>Administrative Tools</h4></div></div></div>
Administrative tools play an integral part in the management
of a server.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt>
<a name="named-checkconf"></a><span class="term"><span class="command"><strong>named-checkconf</strong></span></span>
</dt>
</div>
</div>
- <div class="section">
+ <div class="section" title="Signals">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.4.6.4"></a>Signals</h3></div></div></div>
+<a name="idp71949264"></a>Signals</h3></div></div></div>
<p>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 4. Advanced DNS Features</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch03.html" title="Chapter 3. Name Server Configuration">
</table>
<hr>
</div>
-<div class="chapter">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch04"></a>Chapter 4. Advanced DNS Features</h1></div></div></div>
+<div class="chapter" title="Chapter 4. Advanced DNS Features">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch04"></a>Chapter 4. Advanced DNS Features</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
+<dl>
<dt><span class="section"><a href="Bv9ARM.ch04.html#notify">Notify</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch04.html#dynamic_update">Dynamic Update</a></span></dt>
<dd><dl><dt><span class="section"><a href="Bv9ARM.ch04.html#journal">The journal file</a></span></dt></dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#incremental_zone_transfers">Incremental Zone Transfers (IXFR)</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.6">Split DNS</a></span></dt>
-<dd><dl><dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.6.6">Example split DNS setup</a></span></dt></dl></dd>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72035152">Split DNS</a></span></dt>
+<dd><dl><dt><span class="section"><a href="Bv9ARM.ch04.html#idp72037712">Example split DNS setup</a></span></dt></dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#tsig">TSIG</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.6">Generate Shared Keys for Each Pair of Hosts</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.7">Copying the Shared Secret to Both Machines</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.8">Informing the Servers of the Key's Existence</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.9">Instructing the Server to Use the Key</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.10">TSIG Key Based Access Control</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.11">Errors</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72096464">Generate Shared Keys for Each Pair of Hosts</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72105552">Copying the Shared Secret to Both Machines</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72106960">Informing the Servers of the Key's Existence</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72115920">Instructing the Server to Use the Key</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72122448">TSIG Key Based Access Control</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72128336">Errors</a></span></dt>
</dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.8">TKEY</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.9">SIG(0)</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72130256">TKEY</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72136400">SIG(0)</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch04.html#DNSSEC">DNSSEC</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.10.7">Generating Keys</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.10.8">Signing the Zone</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.10.9">Configuring Servers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72144720">Generating Keys</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72154192">Signing the Zone</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72167504">Configuring Servers</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#dnssec.dynamic.zones">DNSSEC, Dynamic Zones, and Automatic Signing</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.4">Converting from insecure to secure</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.9">Dynamic DNS update method</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.17">Fully automatic zone signing</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.26">Private-type records</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.33">DNSKEY rollovers</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.35">Dynamic DNS update method</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.40">Automatic key rollovers</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.42">NSEC3PARAM rollovers via UPDATE</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.44">Converting from NSEC to NSEC3</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.46">Converting from NSEC3 to NSEC</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.48">Converting from secure to insecure</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.52">Periodic re-signing</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.54">NSEC3 and OPTOUT</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72186448">Converting from insecure to secure</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72190928">Dynamic DNS update method</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72195536">Fully automatic zone signing</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72208080">Private-type records</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72212944">DNSKEY rollovers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72214864">Dynamic DNS update method</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72219088">Automatic key rollovers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72222416">NSEC3PARAM rollovers via UPDATE</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72223824">Converting from NSEC to NSEC3</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72225360">Converting from NSEC3 to NSEC</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72227152">Converting from secure to insecure</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72231760">Periodic re-signing</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72233680">NSEC3 and OPTOUT</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#rfc5011.support">Dynamic Trust Anchor Management</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.12.4">Validating Resolver</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.12.5">Authoritative Server</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72238672">Validating Resolver</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72241488">Authoritative Server</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#pkcs11">PKCS#11 (Cryptoki) support</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.7">Prerequisites</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.8">Native PKCS#11</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.9">OpenSSL-based PKCS#11</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.10">PKCS#11 Tools</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.11">Using the HSM</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.12">Specifying the engine on the command line</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.13">Running named with automatic zone re-signing</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72254672">Prerequisites</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72256080">Native PKCS#11</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72273744">OpenSSL-based PKCS#11</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72340560">PKCS#11 Tools</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72343888">Using the HSM</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72378192">Specifying the engine on the command line</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72382800">Running named with automatic zone re-signing</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#dlz-info">DLZ (Dynamically Loadable Zones)</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.14.7">Configuring DLZ</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.14.8">Sample DLZ Driver</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72395472">Configuring DLZ</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72403920">Sample DLZ Driver</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#dyndb-info">DynDB (Dynamic Database)</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.15.6">Configuring DynDB</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.15.7">Sample DynDB Module</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72421456">Configuring DynDB</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72426448">Sample DynDB Module</a></span></dt>
</dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.16">IPv6 Support in <acronym class="acronym">BIND</acronym> 9</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72430416">IPv6 Support in <acronym class="acronym">BIND</acronym> 9</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.16.7">Address Lookups Using AAAA Records</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.16.8">Address to Name Lookups Using Nibble Format</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72437840">Address Lookups Using AAAA Records</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72440528">Address to Name Lookups Using Nibble Format</a></span></dt>
</dl></dd>
</dl>
</div>
- <div class="section">
+ <div class="section" title="Notify">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="notify"></a>Notify</h2></div></div></div>
protocol is specified in RFC 1996.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
As a slave zone can also be a master to other slaves, <span class="command"><strong>named</strong></span>,
by default, sends <span class="command"><strong>NOTIFY</strong></span> messages for every zone
</div>
- <div class="section">
+ <div class="section" title="Dynamic Update">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="dynamic_update"></a>Dynamic Update</h2></div></div></div>
signatures and an explicit server policy.
</p>
- <div class="section">
+ <div class="section" title="The journal file">
<div class="titlepage"><div><div><h3 class="title">
<a name="journal"></a>The journal file</h3></div></div></div>
</div>
- <div class="section">
+ <div class="section" title="Incremental Zone Transfers (IXFR)">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="incremental_zone_transfers"></a>Incremental Zone Transfers (IXFR)</h2></div></div></div>
</p>
</div>
- <div class="section">
+ <div class="section" title="Split DNS">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.5.6"></a>Split DNS</h2></div></div></div>
+<a name="idp72035152"></a>Split DNS</h2></div></div></div>
<p>
Setting up different views, or visibility, of the DNS space to
on the Internet. Split DNS can also be used to allow mail from outside
back in to the internal network.
</p>
- <div class="section">
+ <div class="section" title="Example split DNS setup">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.6.6"></a>Example split DNS setup</h3></div></div></div>
+<a name="idp72037712"></a>Example split DNS setup</h3></div></div></div>
<p>
Let's say a company named <span class="emphasis"><em>Example, Inc.</em></span>
If everything has been set properly, <span class="emphasis"><em>Example, Inc.</em></span>'s
internal clients will now be able to:
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
Look up any hostnames in the <code class="literal">site1</code>
<p>
Hosts on the Internet will be able to:
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
Look up any hostnames in the <code class="literal">site1</code>
</div>
</div>
- <div class="section">
+ <div class="section" title="TSIG">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="tsig"></a>TSIG</h2></div></div></div>
of the <span class="command"><strong>key</strong></span>.
</p>
- <div class="section">
+ <div class="section" title="Generate Shared Keys for Each Pair of Hosts">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.7.6"></a>Generate Shared Keys for Each Pair of Hosts</h3></div></div></div>
+<a name="idp72096464"></a>Generate Shared Keys for Each Pair of Hosts</h3></div></div></div>
<p>
A shared secret is generated to be shared between <span class="emphasis"><em>host1</em></span> and <span class="emphasis"><em>host2</em></span>.
An arbitrary key name is chosen: "host1-host2.". The key name must
be the same on both hosts.
</p>
- <div class="section">
+ <div class="section" title="Automatic Generation">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.7.6.4"></a>Automatic Generation</h4></div></div></div>
+<a name="idp72098640"></a>Automatic Generation</h4></div></div></div>
<p>
The following command will generate a 128-bit (16 byte) HMAC-SHA256
be used as the shared secret.
</p>
</div>
- <div class="section">
+ <div class="section" title="Manual Generation">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.7.6.5"></a>Manual Generation</h4></div></div></div>
+<a name="idp72103248"></a>Manual Generation</h4></div></div></div>
<p>
The shared secret is simply a random sequence of bits, encoded
</p>
</div>
</div>
- <div class="section">
+ <div class="section" title="Copying the Shared Secret to Both Machines">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.7.7"></a>Copying the Shared Secret to Both Machines</h3></div></div></div>
+<a name="idp72105552"></a>Copying the Shared Secret to Both Machines</h3></div></div></div>
<p>
This is beyond the scope of DNS. A secure transport mechanism
should be used. This could be secure FTP, ssh, telephone, etc.
</p>
</div>
- <div class="section">
+ <div class="section" title="Informing the Servers of the Key's Existence">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.7.8"></a>Informing the Servers of the Key's Existence</h3></div></div></div>
+<a name="idp72106960"></a>Informing the Servers of the Key's Existence</h3></div></div></div>
<p>
Imagine <span class="emphasis"><em>host1</em></span> and <span class="emphasis"><em>host 2</em></span>
</p>
</div>
- <div class="section">
+ <div class="section" title="Instructing the Server to Use the Key">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.7.9"></a>Instructing the Server to Use the Key</h3></div></div></div>
+<a name="idp72115920"></a>Instructing the Server to Use the Key</h3></div></div></div>
<p>
Since keys are shared between two hosts only, the server must
sign request messages to <span class="emphasis"><em>host1</em></span>.
</p>
</div>
- <div class="section">
+ <div class="section" title="TSIG Key Based Access Control">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.7.10"></a>TSIG Key Based Access Control</h3></div></div></div>
+<a name="idp72122448"></a>TSIG Key Based Access Control</h3></div></div></div>
<p>
<acronym class="acronym">BIND</acronym> allows IP addresses and ranges
</p>
</div>
- <div class="section">
+ <div class="section" title="Errors">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.7.11"></a>Errors</h3></div></div></div>
+<a name="idp72128336"></a>Errors</h3></div></div></div>
<p>
</div>
</div>
- <div class="section">
+ <div class="section" title="TKEY">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.5.8"></a>TKEY</h2></div></div></div>
+<a name="idp72130256"></a>TKEY</h2></div></div></div>
<p><span class="command"><strong>TKEY</strong></span>
</p>
</div>
- <div class="section">
+ <div class="section" title="SIG(0)">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.5.9"></a>SIG(0)</h2></div></div></div>
+<a name="idp72136400"></a>SIG(0)</h2></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="DNSSEC">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="DNSSEC"></a>DNSSEC</h2></div></div></div>
zone key of another zone above this one in the DNS tree.
</p>
- <div class="section">
+ <div class="section" title="Generating Keys">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.10.7"></a>Generating Keys</h3></div></div></div>
+<a name="idp72144720"></a>Generating Keys</h3></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="Signing the Zone">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.10.8"></a>Signing the Zone</h3></div></div></div>
+<a name="idp72154192"></a>Signing the Zone</h3></div></div></div>
<p>
</div>
- <div class="section">
+ <div class="section" title="Configuring Servers">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.10.9"></a>Configuring Servers</h3></div></div></div>
+<a name="idp72167504"></a>Configuring Servers</h3></div></div></div>
<p>
};
</pre>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
None of the keys listed in this example are valid. In particular,
the root key is not valid.
been secure.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
When the validator receives a response from an unsigned zone
</div>
</div>
- <div class="section">
+ <div class="section" title="DNSSEC, Dynamic Zones, and Automatic Signing">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="dnssec.dynamic.zones"></a>DNSSEC, Dynamic Zones, and Automatic Signing</h2></div></div></div>
<p>As of BIND 9.7.0 it is possible to change a dynamic zone
from insecure to signed and back again. A secure zone can use
either NSEC or NSEC3 chains.</p>
- <div class="section">
+ <div class="section" title="Converting from insecure to secure">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.4"></a>Converting from insecure to secure</h3></div></div></div>
+<a name="idp72186448"></a>Converting from insecure to secure</h3></div></div></div>
</div>
<p>Changing a zone from insecure to secure can be done in two
with the ZSK, and the DNSKEY RRset to be signed with the KSK as
well. An NSEC chain will be generated as part of the initial
signing process.</p>
- <div class="section">
+ <div class="section" title="Dynamic DNS update method">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.9"></a>Dynamic DNS update method</h3></div></div></div>
+<a name="idp72190928"></a>Dynamic DNS update method</h3></div></div></div>
</div>
<p>To insert the keys via dynamic update:</p>
be removed once the operation completes.</p>
<p>While the initial signing and NSEC/NSEC3 chain generation
is happening, other updates are possible as well.</p>
- <div class="section">
+ <div class="section" title="Fully automatic zone signing">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.17"></a>Fully automatic zone signing</h3></div></div></div>
+<a name="idp72195536"></a>Fully automatic zone signing</h3></div></div></div>
</div>
<p>To enable automatic signing, add the
<span class="command"><strong>update-policy</strong></span> statement to the zone
configuration. If this has not been done, the configuration will
fail.</p>
- <div class="section">
+ <div class="section" title="Private-type records">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.26"></a>Private-type records</h3></div></div></div>
+<a name="idp72208080"></a>Private-type records</h3></div></div></div>
</div>
<p>The state of the signing process is signaled by
</p></div>
<p>
</p>
- <div class="section">
+ <div class="section" title="DNSKEY rollovers">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.33"></a>DNSKEY rollovers</h3></div></div></div>
+<a name="idp72212944"></a>DNSKEY rollovers</h3></div></div></div>
</div>
<p>As with insecure-to-secure conversions, rolling DNSSEC
keys can be done in two ways: using a dynamic DNS update, or the
<span class="command"><strong>auto-dnssec</strong></span> zone option.</p>
- <div class="section">
+ <div class="section" title="Dynamic DNS update method">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.35"></a>Dynamic DNS update method</h3></div></div></div>
+<a name="idp72214864"></a>Dynamic DNS update method</h3></div></div></div>
</div>
<p> To perform key rollovers via dynamic update, you need to add
specify the correct key.
<span class="command"><strong>named</strong></span> will clean out any signatures generated
by the old key after the update completes.</p>
- <div class="section">
+ <div class="section" title="Automatic key rollovers">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.40"></a>Automatic key rollovers</h3></div></div></div>
+<a name="idp72219088"></a>Automatic key rollovers</h3></div></div></div>
</div>
<p>When a new key reaches its activation date (as set by
signature validity periods expire. By default, this rollover
completes in 30 days, after which it will be safe to remove the
old key from the DNSKEY RRset.</p>
- <div class="section">
+ <div class="section" title="NSEC3PARAM rollovers via UPDATE">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.42"></a>NSEC3PARAM rollovers via UPDATE</h3></div></div></div>
+<a name="idp72222416"></a>NSEC3PARAM rollovers via UPDATE</h3></div></div></div>
</div>
<p>Add the new NSEC3PARAM record via dynamic update. When the
will be zero. At this point you can remove the old NSEC3PARAM
record. The old chain will be removed after the update request
completes.</p>
- <div class="section">
+ <div class="section" title="Converting from NSEC to NSEC3">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.44"></a>Converting from NSEC to NSEC3</h3></div></div></div>
+<a name="idp72223824"></a>Converting from NSEC to NSEC3</h3></div></div></div>
</div>
<p>To do this, you just need to add an NSEC3PARAM record. When
and the NSEC3PARAM record will have a zero flag field. The NSEC3
chain will be generated before the NSEC chain is
destroyed.</p>
- <div class="section">
+ <div class="section" title="Converting from NSEC3 to NSEC">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.46"></a>Converting from NSEC3 to NSEC</h3></div></div></div>
+<a name="idp72225360"></a>Converting from NSEC3 to NSEC</h3></div></div></div>
</div>
<p>To do this, use <span class="command"><strong>nsupdate</strong></span> to
remove all NSEC3PARAM records with a zero flag
field. The NSEC chain will be generated before the NSEC3 chain is
removed.</p>
- <div class="section">
+ <div class="section" title="Converting from secure to insecure">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.48"></a>Converting from secure to insecure</h3></div></div></div>
+<a name="idp72227152"></a>Converting from secure to insecure</h3></div></div></div>
</div>
<p>To convert a signed zone to unsigned using dynamic DNS,
zone statement is used, it should be removed or changed to
<span class="command"><strong>allow</strong></span> instead (or it will re-sign).
</p>
- <div class="section">
+ <div class="section" title="Periodic re-signing">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.52"></a>Periodic re-signing</h3></div></div></div>
+<a name="idp72231760"></a>Periodic re-signing</h3></div></div></div>
</div>
<p>In any secure zone which supports dynamic updates, <span class="command"><strong>named</strong></span>
a result of some update action. The signature lifetimes will be
adjusted so as to spread the re-sign load over time rather than
all at once.</p>
- <div class="section">
+ <div class="section" title="NSEC3 and OPTOUT">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.11.54"></a>NSEC3 and OPTOUT</h3></div></div></div>
+<a name="idp72233680"></a>NSEC3 and OPTOUT</h3></div></div></div>
</div>
<p>
changed.</p>
</div>
- <div class="section">
+ <div class="section" title="Dynamic Trust Anchor Management">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="rfc5011.support"></a>Dynamic Trust Anchor Management</h2></div></div></div>
<span class="command"><strong>named</strong></span> to keep track of changes to critical
DNSSEC keys without any need for the operator to make changes to
configuration files.</p>
- <div class="section">
+ <div class="section" title="Validating Resolver">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.12.4"></a>Validating Resolver</h3></div></div></div>
+<a name="idp72238672"></a>Validating Resolver</h3></div></div></div>
<p>To configure a validating resolver to use RFC 5011 to
and Usage”</a>.</p>
</div>
- <div class="section">
+ <div class="section" title="Authoritative Server">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.12.5"></a>Authoritative Server</h3></div></div></div>
+<a name="idp72241488"></a>Authoritative Server</h3></div></div></div>
<p>To set up an authoritative zone for RFC 5011 trust anchor
maintenance, generate two (or more) key signing keys (KSKs) for
</div>
</div>
- <div class="section">
+ <div class="section" title="PKCS#11 (Cryptoki) support">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="pkcs11"></a>PKCS#11 (Cryptoki) support</h2></div></div></div>
OpenSSL completely; BIND loads the provider library itself, and uses
the PKCS#11 API to drive the HSM directly.
</p>
- <div class="section">
+ <div class="section" title="Prerequisites">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.13.7"></a>Prerequisites</h3></div></div></div>
+<a name="idp72254672"></a>Prerequisites</h3></div></div></div>
<p>
See the documentation provided by your HSM vendor for
troubleshooting the HSM.
</p>
</div>
- <div class="section">
+ <div class="section" title="Native PKCS#11">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.13.8"></a>Native PKCS#11</h3></div></div></div>
+<a name="idp72256080"></a>Native PKCS#11</h3></div></div></div>
<p>
Native PKCS#11 mode will only work with an HSM capable of carrying
<span class="command"><strong>dnssec-*</strong></span> tools, or the <code class="option">-m</code> in
the <span class="command"><strong>pkcs11-*</strong></span> tools.)
</p>
- <div class="section">
+ <div class="section" title="Building SoftHSMv2">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.13.8.7"></a>Building SoftHSMv2</h4></div></div></div>
+<a name="idp72263504"></a>Building SoftHSMv2</h4></div></div></div>
<p>
SoftHSMv2, the latest development version of SoftHSM, is available
</pre>
</div>
</div>
- <div class="section">
+ <div class="section" title="OpenSSL-based PKCS#11">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.13.9"></a>OpenSSL-based PKCS#11</h3></div></div></div>
+<a name="idp72273744"></a>OpenSSL-based PKCS#11</h3></div></div></div>
<p>
OpenSSL-based PKCS#11 mode uses a modified version of the
configuration time. The correct choice depends on the HSM
hardware:
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
Use 'crypto-accelerator' with HSMs that have hardware
we use OpenSSL 0.9.8, but the same methods work with OpenSSL
1.0.0 and 1.0.1.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
The latest OpenSSL versions as of this writing (January 2015)
are 0.9.8zc, 1.0.0o, and 1.0.1j.
necessary to build OpenSSL with the patch in place, and configure
it with the path to your HSM's PKCS#11 provider library.
</p>
- <div class="section">
+ <div class="section" title="Patching OpenSSL">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.13.9.9"></a>Patching OpenSSL</h4></div></div></div>
+<a name="idp72299088"></a>Patching OpenSSL</h4></div></div></div>
<pre class="screen">
$ <strong class="userinput"><code>wget <a class="ulink" href="" target="_top">http://www.openssl.org/source/openssl-0.9.8zc.tar.gz</a></code></strong>
$ <strong class="userinput"><code>patch -p1 -d openssl-0.9.8zc \
< bind9/bin/pkcs11/openssl-0.9.8zc-patch</code></strong>
</pre>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
Note that the patch file may not be compatible with the
"patch" utility on all operating systems. You may need to
OpenSSL library will need to be specified via configure.
</p>
</div>
- <div class="section">
+ <div class="section" title="Building OpenSSL for the AEP Keyper on Linux">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.13.9.10"></a>Building OpenSSL for the AEP Keyper on Linux</h4></div></div></div>
+<a name="idp72304720"></a>Building OpenSSL for the AEP Keyper on Linux</h4></div></div></div>
<p>
add the -pthread above.
</p>
</div>
- <div class="section">
+ <div class="section" title="Building OpenSSL for the SCA 6000 on Solaris">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.13.9.11"></a>Building OpenSSL for the SCA 6000 on Solaris</h4></div></div></div>
+<a name="idp72311120"></a>Building OpenSSL for the SCA 6000 on Solaris</h4></div></div></div>
<p>
<span class="command"><strong>make test</strong></span>.
</p>
</div>
- <div class="section">
+ <div class="section" title="Building OpenSSL for SoftHSM">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.13.9.12"></a>Building OpenSSL for SoftHSM</h4></div></div></div>
+<a name="idp72315984"></a>Building OpenSSL for SoftHSM</h4></div></div></div>
<p>
"<span class="command"><strong>make install</strong></span>" which will install the
modified OpenSSL suite to <code class="filename">/opt/pkcs11/usr</code>.
</p>
- <div class="section">
+ <div class="section" title="Configuring BIND 9 for Linux with the AEP Keyper">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.13.9.19"></a>Configuring BIND 9 for Linux with the AEP Keyper</h4></div></div></div>
+<a name="idp72328912"></a>Configuring BIND 9 for Linux with the AEP Keyper</h4></div></div></div>
<p>
--with-pkcs11=/opt/pkcs11/usr/lib/libpkcs11.so</code></strong>
</pre>
</div>
- <div class="section">
+ <div class="section" title="Configuring BIND 9 for Solaris with the SCA 6000">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.13.9.20"></a>Configuring BIND 9 for Solaris with the SCA 6000</h4></div></div></div>
+<a name="idp72332240"></a>Configuring BIND 9 for Solaris with the SCA 6000</h4></div></div></div>
<p>
Configure).
</p>
</div>
- <div class="section">
+ <div class="section" title="Configuring BIND 9 for SoftHSM">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.5.13.9.21"></a>Configuring BIND 9 for SoftHSM</h4></div></div></div>
+<a name="idp72335824"></a>Configuring BIND 9 for SoftHSM</h4></div></div></div>
<pre class="screen">
have forgotten to set the SOFTHSM_CONF environment variable.)
</p>
</div>
- <div class="section">
+ <div class="section" title="PKCS#11 Tools">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.13.10"></a>PKCS#11 Tools</h3></div></div></div>
+<a name="idp72340560"></a>PKCS#11 Tools</h3></div></div></div>
<p>
BIND 9 includes a minimal set of tools to operate the
provider.)
</p>
</div>
- <div class="section">
+ <div class="section" title="Using the HSM">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.13.11"></a>Using the HSM</h3></div></div></div>
+<a name="idp72343888"></a>Using the HSM</h3></div></div></div>
<p>
For OpenSSL-based PKCS#11, we must first set up the runtime
example.net.signed
</pre>
</div>
- <div class="section">
+ <div class="section" title="Specifying the engine on the command line">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.13.12"></a>Specifying the engine on the command line</h3></div></div></div>
+<a name="idp72378192"></a>Specifying the engine on the command line</h3></div></div></div>
<p>
When using OpenSSL-based PKCS#11, the "engine" to be used by
library. This may be useful when testing a new provider library.
</p>
</div>
- <div class="section">
+ <div class="section" title="Running named with automatic zone re-signing">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.13.13"></a>Running named with automatic zone re-signing</h3></div></div></div>
+<a name="idp72382800"></a>Running named with automatic zone re-signing</h3></div></div></div>
<p>
If you want <span class="command"><strong>named</strong></span> to dynamically re-sign zones
then the PIN would be read from the file
<code class="filename">/etc/hsmpin</code>.
</p>
- <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p>
Placing the HSM's PIN in a text file in this manner may reduce the
</div>
</div>
- <div class="section">
+ <div class="section" title="DLZ (Dynamically Loadable Zones)">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="dlz-info"></a>DLZ (Dynamically Loadable Zones)</h2></div></div></div>
zones in the database.)
</p>
- <div class="section">
+ <div class="section" title="Configuring DLZ">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.14.7"></a>Configuring DLZ</h3></div></div></div>
+<a name="idp72395472"></a>Configuring DLZ</h3></div></div></div>
<p>
A DLZ database is configured with a <span class="command"><strong>dlz</strong></span>
};
</pre>
</div>
- <div class="section">
+ <div class="section" title="Sample DLZ Driver">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.14.8"></a>Sample DLZ Driver</h3></div></div></div>
+<a name="idp72403920"></a>Sample DLZ Driver</h3></div></div></div>
<p>
For guidance in implementation of DLZ modules, the directory
</div>
</div>
- <div class="section">
+ <div class="section" title="DynDB (Dynamic Database)">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="dyndb-info"></a>DynDB (Dynamic Database)</h2></div></div></div>
<code class="filename">bin/tests/system/dyndb/driver</code>.
</p>
- <div class="section">
+ <div class="section" title="Configuring DynDB">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.15.6"></a>Configuring DynDB</h3></div></div></div>
+<a name="idp72421456"></a>Configuring DynDB</h3></div></div></div>
<p>
A DynDB database is configured with a <span class="command"><strong>dyndb</strong></span>
syntax will differ depending on the driver.
</p>
</div>
- <div class="section">
+ <div class="section" title="Sample DynDB Module">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.15.7"></a>Sample DynDB Module</h3></div></div></div>
+<a name="idp72426448"></a>Sample DynDB Module</h3></div></div></div>
<p>
For guidance in implementation of DynDB modules, the directory
</div>
</div>
- <div class="section">
+ <div class="section" title="IPv6 Support in BIND 9">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.5.16"></a>IPv6 Support in <acronym class="acronym">BIND</acronym> 9</h2></div></div></div>
+<a name="idp72430416"></a>IPv6 Support in <acronym class="acronym">BIND</acronym> 9</h2></div></div></div>
<p>
<acronym class="acronym">BIND</acronym> 9 fully supports all currently
defined forms of IPv6 name to address and address to name
see <a class="xref" href="Bv9ARM.ch11.html#ipv6addresses" title="IPv6 addresses (AAAA)">the section called “IPv6 addresses (AAAA)”</a>.
</p>
- <div class="section">
+ <div class="section" title="Address Lookups Using AAAA Records">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.16.7"></a>Address Lookups Using AAAA Records</h3></div></div></div>
+<a name="idp72437840"></a>Address Lookups Using AAAA Records</h3></div></div></div>
<p>
the address.
</p>
</div>
- <div class="section">
+ <div class="section" title="Address to Name Lookups Using Nibble Format">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.5.16.8"></a>Address to Name Lookups Using Nibble Format</h3></div></div></div>
+<a name="idp72440528"></a>Address to Name Lookups Using Nibble Format</h3></div></div></div>
<p>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 5. The BIND 9 Lightweight Resolver</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch04.html" title="Chapter 4. Advanced DNS Features">
</table>
<hr>
</div>
-<div class="chapter">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch05"></a>Chapter 5. The <acronym class="acronym">BIND</acronym> 9 Lightweight Resolver</h1></div></div></div>
+<div class="chapter" title="Chapter 5. The BIND 9 Lightweight Resolver">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch05"></a>Chapter 5. The <acronym class="acronym">BIND</acronym> 9 Lightweight Resolver</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
-<dt><span class="section"><a href="Bv9ARM.ch05.html#id-1.6.3">The Lightweight Resolver Library</a></span></dt>
+<dl>
+<dt><span class="section"><a href="Bv9ARM.ch05.html#idp72445136">The Lightweight Resolver Library</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch05.html#lwresd">Running a Resolver Daemon</a></span></dt>
</dl>
</div>
- <div class="section">
+ <div class="section" title="The Lightweight Resolver Library">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.6.3"></a>The Lightweight Resolver Library</h2></div></div></div>
+<a name="idp72445136"></a>The Lightweight Resolver Library</h2></div></div></div>
<p>
Traditionally applications have been linked with a stub resolver
that is distinct from and simpler than the full DNS protocol.
</p>
</div>
- <div class="section">
+ <div class="section" title="Running a Resolver Daemon">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="lwresd"></a>Running a Resolver Daemon</h2></div></div></div>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 6. BIND 9 Configuration Reference</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch05.html" title="Chapter 5. The BIND 9 Lightweight Resolver">
</table>
<hr>
</div>
-<div class="chapter">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch06"></a>Chapter 6. <acronym class="acronym">BIND</acronym> 9 Configuration Reference</h1></div></div></div>
+<div class="chapter" title="Chapter 6. BIND 9 Configuration Reference">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch06"></a>Chapter 6. <acronym class="acronym">BIND</acronym> 9 Configuration Reference</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
+<dl>
<dt><span class="section"><a href="Bv9ARM.ch06.html#configuration_file_elements">Configuration File Elements</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch06.html#address_match_lists">Address Match Lists</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.5.6">Comment Syntax</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72601040">Comment Syntax</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch06.html#Configuration_File_Grammar">Configuration File Grammar</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.7"><span class="command"><strong>acl</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72658128"><span class="command"><strong>acl</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#acl"><span class="command"><strong>acl</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.9"><span class="command"><strong>controls</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72690384"><span class="command"><strong>controls</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#controls_statement_definition_and_usage"><span class="command"><strong>controls</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.11"><span class="command"><strong>include</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.12"><span class="command"><strong>include</strong></span> Statement Definition and
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72740688"><span class="command"><strong>include</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72747472"><span class="command"><strong>include</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.13"><span class="command"><strong>key</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.14"><span class="command"><strong>key</strong></span> Statement Definition and Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.15"><span class="command"><strong>logging</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.16"><span class="command"><strong>logging</strong></span> Statement Definition and
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72750544"><span class="command"><strong>key</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72754000"><span class="command"><strong>key</strong></span> Statement Definition and Usage</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72765136"><span class="command"><strong>logging</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72782160"><span class="command"><strong>logging</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.17"><span class="command"><strong>lwres</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.18"><span class="command"><strong>lwres</strong></span> Statement Definition and Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.19"><span class="command"><strong>masters</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.20"><span class="command"><strong>masters</strong></span> Statement Definition and
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73052752"><span class="command"><strong>lwres</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73065040"><span class="command"><strong>lwres</strong></span> Statement Definition and Usage</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73076816"><span class="command"><strong>masters</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73083344"><span class="command"><strong>masters</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.21"><span class="command"><strong>options</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73086416"><span class="command"><strong>options</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#options"><span class="command"><strong>options</strong></span> Statement Definition and
Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#server_statement_grammar"><span class="command"><strong>server</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#server_statement_definition_and_usage"><span class="command"><strong>server</strong></span> Statement Definition and
Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#statschannels"><span class="command"><strong>statistics-channels</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.26"><span class="command"><strong>statistics-channels</strong></span> Statement Definition and
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74653264"><span class="command"><strong>statistics-channels</strong></span> Statement Definition and
Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#trusted-keys"><span class="command"><strong>trusted-keys</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.28"><span class="command"><strong>trusted-keys</strong></span> Statement Definition
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74702544"><span class="command"><strong>trusted-keys</strong></span> Statement Definition
and Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.29"><span class="command"><strong>managed-keys</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74713424"><span class="command"><strong>managed-keys</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#managed-keys"><span class="command"><strong>managed-keys</strong></span> Statement Definition
and Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#view_statement_grammar"><span class="command"><strong>view</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.32"><span class="command"><strong>view</strong></span> Statement Definition and Usage</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74750160"><span class="command"><strong>view</strong></span> Statement Definition and Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#zone_statement_grammar"><span class="command"><strong>zone</strong></span>
Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.34"><span class="command"><strong>zone</strong></span> Statement Definition and Usage</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74976080"><span class="command"><strong>zone</strong></span> Statement Definition and Usage</a></span></dt>
</dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7">Zone File</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75353680">Zone File</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch06.html#types_of_resource_records_and_when_to_use_them">Types of Resource Records and When to Use Them</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7.4">Discussion of MX Records</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75721424">Discussion of MX Records</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#Setting_TTLs">Setting TTLs</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7.6">Inverse Mapping in IPv4</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7.7">Other Zone File Directives</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7.8"><acronym class="acronym">BIND</acronym> Master File Extension: the <span class="command"><strong>$GENERATE</strong></span> Directive</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75794256">Inverse Mapping in IPv4</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75807568">Other Zone File Directives</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75833808"><acronym class="acronym">BIND</acronym> Master File Extension: the <span class="command"><strong>$GENERATE</strong></span> Directive</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#zonefile_format">Additional File Formats</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch06.html#statistics">BIND9 Statistics</a></span></dt>
using the shell script
<code class="filename">contrib/named-bootconf/named-bootconf.sh</code>.
</p>
- <div class="section">
+ <div class="section" title="Configuration File Elements">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="configuration_file_elements"></a>Configuration File Elements</h2></div></div></div>
</tbody>
</table>
</div>
- <div class="section">
+ <div class="section" title="Address Match Lists">
<div class="titlepage"><div><div><h3 class="title">
<a name="address_match_lists"></a>Address Match Lists</h3></div></div></div>
- <div class="section">
+ <div class="section" title="Syntax">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.5.5.3"></a>Syntax</h4></div></div></div>
+<a name="idp72576720"></a>Syntax</h4></div></div></div>
<pre class="programlisting"><code class="varname">address_match_list</code> = address_match_list_element ;
</pre>
</div>
- <div class="section">
+ <div class="section" title="Definition and Usage">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.5.5.4"></a>Definition and Usage</h4></div></div></div>
+<a name="idp72584144"></a>Definition and Usage</h4></div></div></div>
<p>
Address match lists are primarily used to determine access
statements. The elements which constitute an address match
list can be any of the following:
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
an IP address (IPv4 or IPv6)
</li>
</div>
</div>
- <div class="section">
+ <div class="section" title="Comment Syntax">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.5.6"></a>Comment Syntax</h3></div></div></div>
+<a name="idp72601040"></a>Comment Syntax</h3></div></div></div>
<p>
in the C, C++, or shell/perl style.
</p>
- <div class="section">
+ <div class="section" title="Syntax">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.5.6.4"></a>Syntax</h4></div></div></div>
+<a name="idp72603088"></a>Syntax</h4></div></div></div>
<p>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="Definition and Usage">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.5.6.5"></a>Definition and Usage</h4></div></div></div>
+<a name="idp72606928"></a>Definition and Usage</h4></div></div></div>
<p>
Comments may appear anywhere that whitespace may appear in
</p>
- <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p>
You cannot use the semicolon (`;') character
</div>
</div>
- <div class="section">
+ <div class="section" title="Configuration File Grammar">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="Configuration_File_Grammar"></a>Configuration File Grammar</h2></div></div></div>
configuration.
</p>
- <div class="section">
+ <div class="section" title="acl Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.7"></a><span class="command"><strong>acl</strong></span> Statement Grammar</h3></div></div></div>
+<a name="idp72658128"></a><span class="command"><strong>acl</strong></span> Statement Grammar</h3></div></div></div>
<pre class="programlisting"><span class="command"><strong>acl</strong></span> acl-name {
</pre>
</div>
- <div class="section">
+ <div class="section" title="acl Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
<a name="acl"></a><span class="command"><strong>acl</strong></span> Statement Definition and
Usage</h3></div></div></div>
</table>
</div>
</div>
- <div class="section">
+ <div class="section" title="controls Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.9"></a><span class="command"><strong>controls</strong></span> Statement Grammar</h3></div></div></div>
+<a name="idp72690384"></a><span class="command"><strong>controls</strong></span> Statement Grammar</h3></div></div></div>
<pre class="programlisting"><span class="command"><strong>controls</strong></span> {
</div>
- <div class="section">
+ <div class="section" title="controls Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
<a name="controls_statement_definition_and_usage"></a><span class="command"><strong>controls</strong></span> Statement Definition and
Usage</h3></div></div></div>
</p>
</div>
- <div class="section">
+ <div class="section" title="include Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.11"></a><span class="command"><strong>include</strong></span> Statement Grammar</h3></div></div></div>
+<a name="idp72740688"></a><span class="command"><strong>include</strong></span> Statement Grammar</h3></div></div></div>
<pre class="programlisting"><span class="command"><strong>include</strong></span> <em class="replaceable"><code>filename</code></em>;</pre>
</div>
- <div class="section">
+ <div class="section" title="include Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.12"></a><span class="command"><strong>include</strong></span> Statement Definition and
+<a name="idp72747472"></a><span class="command"><strong>include</strong></span> Statement Definition and
Usage</h3></div></div></div>
</p>
</div>
- <div class="section">
+ <div class="section" title="key Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.13"></a><span class="command"><strong>key</strong></span> Statement Grammar</h3></div></div></div>
+<a name="idp72750544"></a><span class="command"><strong>key</strong></span> Statement Grammar</h3></div></div></div>
<pre class="programlisting"><span class="command"><strong>key</strong></span> <em class="replaceable"><code>key_id</code></em> {
</div>
- <div class="section">
+ <div class="section" title="key Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.14"></a><span class="command"><strong>key</strong></span> Statement Definition and Usage</h3></div></div></div>
+<a name="idp72754000"></a><span class="command"><strong>key</strong></span> Statement Definition and Usage</h3></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="logging Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.15"></a><span class="command"><strong>logging</strong></span> Statement Grammar</h3></div></div></div>
+<a name="idp72765136"></a><span class="command"><strong>logging</strong></span> Statement Grammar</h3></div></div></div>
<pre class="programlisting"><span class="command"><strong>logging</strong></span> {
</div>
- <div class="section">
+ <div class="section" title="logging Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.16"></a><span class="command"><strong>logging</strong></span> Statement Definition and
+<a name="idp72782160"></a><span class="command"><strong>logging</strong></span> Statement Definition and
Usage</h3></div></div></div>
was specified.
</p>
- <div class="section">
+ <div class="section" title="The channel Phrase">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.16.9"></a>The <span class="command"><strong>channel</strong></span> Phrase</h4></div></div></div>
+<a name="idp72798544"></a>The <span class="command"><strong>channel</strong></span> Phrase</h4></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="The category Phrase">
<div class="titlepage"><div><div><h4 class="title">
<a name="the_category_phrase"></a>The <span class="command"><strong>category</strong></span> Phrase</h4></div></div></div>
</table>
</div>
</div>
- <div class="section">
+ <div class="section" title="The query-errors Category">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.16.11"></a>The <span class="command"><strong>query-errors</strong></span> Category</h4></div></div></div>
+<a name="idp72970192"></a>The <span class="command"><strong>query-errors</strong></span> Category</h4></div></div></div>
<p>
The <span class="command"><strong>query-errors</strong></span> category is
specifically intended for debugging purposes: To identify
</div>
</div>
- <div class="section">
+ <div class="section" title="lwres Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.17"></a><span class="command"><strong>lwres</strong></span> Statement Grammar</h3></div></div></div>
+<a name="idp73052752"></a><span class="command"><strong>lwres</strong></span> Statement Grammar</h3></div></div></div>
<p>
</pre>
</div>
- <div class="section">
+ <div class="section" title="lwres Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.18"></a><span class="command"><strong>lwres</strong></span> Statement Definition and Usage</h3></div></div></div>
+<a name="idp73065040"></a><span class="command"><strong>lwres</strong></span> Statement Definition and Usage</h3></div></div></div>
<p>
<code class="option">lwres-tasks</code> times <code class="option">lwres-clients</code>.
</p>
</div>
- <div class="section">
+ <div class="section" title="masters Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.19"></a><span class="command"><strong>masters</strong></span> Statement Grammar</h3></div></div></div>
+<a name="idp73076816"></a><span class="command"><strong>masters</strong></span> Statement Grammar</h3></div></div></div>
<pre class="programlisting">
</div>
- <div class="section">
+ <div class="section" title="masters Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.20"></a><span class="command"><strong>masters</strong></span> Statement Definition and
+<a name="idp73083344"></a><span class="command"><strong>masters</strong></span> Statement Definition and
Usage</h3></div></div></div>
<p><span class="command"><strong>masters</strong></span>
</p>
</div>
- <div class="section">
+ <div class="section" title="options Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.21"></a><span class="command"><strong>options</strong></span> Statement Grammar</h3></div></div></div>
+<a name="idp73086416"></a><span class="command"><strong>options</strong></span> Statement Grammar</h3></div></div></div>
<p>
</div>
- <div class="section">
+ <div class="section" title="options Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
<a name="options"></a><span class="command"><strong>options</strong></span> Statement Definition and
Usage</h3></div></div></div>
be used.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>attach-cache</strong></span></span></dt>
<dd>
<p>
</dd>
</dl></div>
- <div class="section">
+ <div class="section" title="Boolean Options">
<div class="titlepage"><div><div><h4 class="title">
<a name="boolean_options"></a>Boolean Options</h4></div></div></div>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>automatic-interface-scan</strong></span></span></dt>
<dd>
<p>
record for negative
answers. The default is <strong class="userinput"><code>no</code></strong>.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Not yet implemented in <acronym class="acronym">BIND</acronym>
<span class="command"><strong>managed-keys</strong></span> statement. The default
is <strong class="userinput"><code>yes</code></strong>.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Whenever the resolver sends out queries to an
</div>
- <div class="section">
+ <div class="section" title="Forwarding">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.22.6"></a>Forwarding</h4></div></div></div>
+<a name="idp73848528"></a>Forwarding</h4></div></div></div>
<p>
The forwarding facility can be used to create a large site-wide
its cache.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>forward</strong></span></span></dt>
<dd>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="Dual-stack Servers">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.22.7"></a>Dual-stack Servers</h4></div></div></div>
+<a name="idp73859920"></a>Dual-stack Servers</h4></div></div></div>
<p>
Dual-stack servers are used as servers of last resort to work
on the host machine.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>dual-stack-servers</strong></span></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="section">
+ <div class="section" title="Access Control">
<div class="titlepage"><div><div><h4 class="title">
<a name="access_control"></a>Access Control</h4></div></div></div>
details on how to specify IP address lists.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>allow-notify</strong></span></span></dt>
<dd>
<p>
If not specified, the default is to allow queries
from all hosts.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
<span class="command"><strong>allow-query-cache</strong></span> is now
If not specified, the default is to allow queries
on all addresses.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
<span class="command"><strong>allow-query-cache</strong></span> is
</div>
- <div class="section">
+ <div class="section" title="Interfaces">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.22.9"></a>Interfaces</h4></div></div></div>
+<a name="idp73917520"></a>Interfaces</h4></div></div></div>
<p>
The interfaces and ports that the server will answer queries
</div>
- <div class="section">
+ <div class="section" title="Query Address">
<div class="titlepage"><div><div><h4 class="title">
<a name="query_address"></a>Query Address</h4></div></div></div>
it implicitly disables the use of randomized port numbers.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>use-queryport-pool</strong></span></span></dt>
<dd>
<p>
</p>
</dd>
</dl></div>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
The address specified in the <span class="command"><strong>query-source</strong></span> option
unprivileged port.
</p>
</div>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Solaris 2.5.1 and earlier does not support setting the source
address for TCP sockets.
</p>
</div>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
See also <span class="command"><strong>transfer-source</strong></span> and
</div>
</div>
- <div class="section">
+ <div class="section" title="Zone Transfers">
<div class="titlepage"><div><div><h4 class="title">
<a name="zone_transfers"></a>Zone Transfers</h4></div></div></div>
system. The following options apply to zone transfers.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>also-notify</strong></span></span></dt>
<dd>
<p>
<span class="command"><strong>zone</strong></span> block in the configuration
file.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Solaris 2.5.1 and earlier does not support setting the
<span class="command"><strong>use-alt-transfer-source</strong></span> is
set.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
If you do not wish the alternate transfer source
to be used, you should set
<span class="command"><strong>view</strong></span> block in the configuration
file.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Solaris 2.5.1 and earlier does not support setting the
</div>
- <div class="section">
+ <div class="section" title="UDP Port Lists">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.22.12"></a>UDP Port Lists</h4></div></div></div>
+<a name="idp74030416"></a>UDP Port Lists</h4></div></div></div>
<p>
<span class="command"><strong>use-v4-udp-ports</strong></span>,
</p>
</div>
- <div class="section">
+ <div class="section" title="Operating System Resource Limits">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.22.13"></a>Operating System Resource Limits</h4></div></div></div>
+<a name="idp74041936"></a>Operating System Resource Limits</h4></div></div></div>
<p>
unsupported limit is used.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>coresize</strong></span></span></dt>
<dd>
<p>
</div>
- <div class="section">
+ <div class="section" title="Server Resource Limits">
<div class="titlepage"><div><div><h4 class="title">
<a name="server_resource_limits"></a>Server Resource Limits</h4></div></div></div>
server rather than the operating system.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>max-ixfr-log-size</strong></span></span></dt>
<dd>
<p>
</div>
- <div class="section">
+ <div class="section" title="Periodic Task Intervals">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.22.15"></a>Periodic Task Intervals</h4></div></div></div>
+<a name="idp74126416"></a>Periodic Task Intervals</h4></div></div></div>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>cleaning-interval</strong></span></span></dt>
<dd>
<p>
60. The maximum value is 28 days (40320 minutes).
If set to 0, no statistics will be logged.
</p>
-<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Not yet implemented in
</div>
- <div class="section">
+ <div class="section" title="Topology">
<div class="titlepage"><div><div><h4 class="title">
<a name="topology"></a>Topology</h4></div></div></div>
<pre class="programlisting"> topology { localhost; localnets; };
</pre>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
The <span class="command"><strong>topology</strong></span> option
</div>
</div>
- <div class="section">
+ <div class="section" title="The sortlist Statement">
<div class="titlepage"><div><div><h4 class="title">
<a name="the_sortlist_statement"></a>The <span class="command"><strong>sortlist</strong></span> Statement</h4></div></div></div>
</pre>
</div>
- <div class="section">
+ <div class="section" title="RRset Ordering">
<div class="titlepage"><div><div><h4 class="title">
<a name="rrset_ordering"></a>RRset Ordering</h4></div></div></div>
By default, all records are returned in random order.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
In this release of <acronym class="acronym">BIND</acronym> 9, the
</div>
</div>
- <div class="section">
+ <div class="section" title="Tuning">
<div class="titlepage"><div><div><h4 class="title">
<a name="tuning"></a>Tuning</h4></div></div></div>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>lame-ttl</strong></span></span></dt>
<dd>
<p>
accepted. The default
is <strong class="userinput"><code>2</code></strong>.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Not implemented in <acronym class="acronym">BIND</acronym> 9.
</div>
- <div class="section">
+ <div class="section" title="Built-in server information zones">
<div class="titlepage"><div><div><h4 class="title">
<a name="builtin"></a>Built-in server information zones</h4></div></div></div>
that matches all clients.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>version</strong></span></span></dt>
<dd>
<p>
</div>
- <div class="section">
+ <div class="section" title="Built-in Empty Zones">
<div class="titlepage"><div><div><h4 class="title">
<a name="empty"></a>Built-in Empty Zones</h4></div></div></div>
<p>
The current list of empty zones is:
</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">10.IN-ADDR.ARPA</li>
<li class="listitem">16.172.IN-ADDR.ARPA</li>
<li class="listitem">17.172.IN-ADDR.ARPA</li>
to be deployed to channel the query load away from the
infrastructure servers.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
The real parent servers for these zones should disable all
empty zone under the parent zone they serve. For the real
root servers, this is all built-in empty zones. This will
enable them to return referrals to deeper in the tree.
</div>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>empty-server</strong></span></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="section">
+ <div class="section" title="Additional Section Caching">
<div class="titlepage"><div><div><h4 class="title">
<a name="acache"></a>Additional Section Caching</h4></div></div></div>
<span class="command"><strong>acache</strong></span>.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>acache-enable</strong></span></span></dt>
<dd>
<p>
</div>
- <div class="section">
+ <div class="section" title="Content Filtering">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.22.23"></a>Content Filtering</h4></div></div></div>
+<a name="idp74434000"></a>Content Filtering</h4></div></div></div>
<p>
<acronym class="acronym">BIND</acronym> 9 provides the ability to filter
</p>
</div>
- <div class="section">
+ <div class="section" title="Response Policy Zone (RPZ) Rewriting">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.22.24"></a>Response Policy Zone (RPZ) Rewriting</h4></div></div></div>
+<a name="idp74448720"></a>Response Policy Zone (RPZ) Rewriting</h4></div></div></div>
<p>
<acronym class="acronym">BIND</acronym> 9 includes a limited
<p>
Five policy triggers can be encoded in RPZ records.
</p>
-<div class="variablelist"><dl class="variablelist">
+<div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>RPZ-CLIENT-IP</strong></span></span></dt>
<dd>
<p>
it can be used with any type of trigger to force the use of
TCP for responses with owner names in a zone.
</p>
-<div class="variablelist"><dl class="variablelist">
+<div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>PASSTHRU</strong></span></span></dt>
<dd>
<p>
organization might use this mechanism to redirect domains
to its own walled garden.
</p>
-<div class="variablelist"><dl class="variablelist">
+<div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>GIVEN</strong></span></span></dt>
<dd>
<p>The placeholder policy says "do not override but
</p>
</div>
- <div class="section">
+ <div class="section" title="Response Rate Limiting">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.22.25"></a>Response Rate Limiting</h4></div></div></div>
+<a name="idp74534736"></a>Response Rate Limiting</h4></div></div></div>
<p>
Excessive almost identical UDP <span class="emphasis"><em>responses</em></span>
<p>
Named supports NXDOMAIN redirection via two methods:
</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">Redirect zone <a class="xref" href="Bv9ARM.ch06.html#zone_statement_grammar" title="zone Statement Grammar">the section called “<span class="command"><strong>zone</strong></span>
Statement Grammar”</a>
</li>
</div>
</div>
- <div class="section">
+ <div class="section" title="server Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
<a name="server_statement_grammar"></a><span class="command"><strong>server</strong></span> Statement Grammar</h3></div></div></div>
</div>
- <div class="section">
+ <div class="section" title="server Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
<a name="server_statement_definition_and_usage"></a><span class="command"><strong>server</strong></span> Statement Definition and
Usage</h3></div></div></div>
</p>
</div>
- <div class="section">
+ <div class="section" title="statistics-channels Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
<a name="statschannels"></a><span class="command"><strong>statistics-channels</strong></span> Statement Grammar</h3></div></div></div>
</pre>
</div>
- <div class="section">
+ <div class="section" title="statistics-channels Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.26"></a><span class="command"><strong>statistics-channels</strong></span> Statement Definition and
+<a name="idp74653264"></a><span class="command"><strong>statistics-channels</strong></span> Statement Definition and
Usage</h3></div></div></div>
</p>
</div>
- <div class="section">
+ <div class="section" title="trusted-keys Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
<a name="trusted-keys"></a><span class="command"><strong>trusted-keys</strong></span> Statement Grammar</h3></div></div></div>
</pre>
</div>
- <div class="section">
+ <div class="section" title="trusted-keys Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.28"></a><span class="command"><strong>trusted-keys</strong></span> Statement Definition
+<a name="idp74702544"></a><span class="command"><strong>trusted-keys</strong></span> Statement Definition
and Usage</h3></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="managed-keys Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.29"></a><span class="command"><strong>managed-keys</strong></span> Statement Grammar</h3></div></div></div>
+<a name="idp74713424"></a><span class="command"><strong>managed-keys</strong></span> Statement Grammar</h3></div></div></div>
<pre class="programlisting"><span class="command"><strong>managed-keys</strong></span> {
</pre>
</div>
- <div class="section">
+ <div class="section" title="managed-keys Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
<a name="managed-keys"></a><span class="command"><strong>managed-keys</strong></span> Statement Definition
and Usage</h3></div></div></div>
</p>
</div>
- <div class="section">
+ <div class="section" title="view Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
<a name="view_statement_grammar"></a><span class="command"><strong>view</strong></span> Statement Grammar</h3></div></div></div>
</pre>
</div>
- <div class="section">
+ <div class="section" title="view Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.32"></a><span class="command"><strong>view</strong></span> Statement Definition and Usage</h3></div></div></div>
+<a name="idp74750160"></a><span class="command"><strong>view</strong></span> Statement Definition and Usage</h3></div></div></div>
<p>
</pre>
</div>
- <div class="section">
+ <div class="section" title="zone Statement Grammar">
<div class="titlepage"><div><div><h3 class="title">
<a name="zone_statement_grammar"></a><span class="command"><strong>zone</strong></span>
Statement Grammar</h3></div></div></div>
</pre>
</div>
- <div class="section">
+ <div class="section" title="zone Statement Definition and Usage">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.6.34"></a><span class="command"><strong>zone</strong></span> Statement Definition and Usage</h3></div></div></div>
+<a name="idp74976080"></a><span class="command"><strong>zone</strong></span> Statement Definition and Usage</h3></div></div></div>
- <div class="section">
+ <div class="section" title="Zone Types">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.34.3"></a>Zone Types</h4></div></div></div>
+<a name="idp74977488"></a>Zone Types</h4></div></div></div>
<p>
The <span class="command"><strong>type</strong></span> keyword is required
for the <span class="command"><strong>zone</strong></span> configuration unless
</div>
</div>
- <div class="section">
+ <div class="section" title="Class">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.34.4"></a>Class</h4></div></div></div>
+<a name="idp75021264"></a>Class</h4></div></div></div>
<p>
The zone's name may optionally be followed by a class. If
</p>
</div>
- <div class="section">
+ <div class="section" title="Zone Options">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.34.5"></a>Zone Options</h4></div></div></div>
+<a name="idp75025488"></a>Zone Options</h4></div></div></div>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>allow-notify</strong></span></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="section">
+ <div class="section" title="Dynamic Update Policies">
<div class="titlepage"><div><div><h4 class="title">
<a name="dynamic_update_policies"></a>Dynamic Update Policies</h4></div></div></div>
IP address into the IN-ADDR.ARPA and IP6.ARPA
namespaces match the name to be updated.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
It is theoretically possible to spoof these TCP
sessions.
to allow NS or DNAME RRsets to be added to the
reverse tree.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
It is theoretically possible to spoof these TCP
sessions.
</p>
</div>
- <div class="section">
+ <div class="section" title="Multiple views">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.6.34.7"></a>Multiple views</h4></div></div></div>
+<a name="idp75342032"></a>Multiple views</h4></div></div></div>
<p>
When multiple views are in use, a zone may be
</div>
</div>
- <div class="section">
+ <div class="section" title="Zone File">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.7.7"></a>Zone File</h2></div></div></div>
+<a name="idp75353680"></a>Zone File</h2></div></div></div>
- <div class="section">
+ <div class="section" title="Types of Resource Records and When to Use Them">
<div class="titlepage"><div><div><h3 class="title">
<a name="types_of_resource_records_and_when_to_use_them"></a>Types of Resource Records and When to Use Them</h3></div></div></div>
identified
and implemented in the DNS. These are also included.
</p>
- <div class="section">
+ <div class="section" title="Resource Records">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.7.3.4"></a>Resource Records</h4></div></div></div>
+<a name="idp75355984"></a>Resource Records</h4></div></div></div>
<p>
used as "pointers" to other data in the DNS.
</p>
</div>
- <div class="section">
+ <div class="section" title="Textual expression of RRs">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.7.3.5"></a>Textual expression of RRs</h4></div></div></div>
+<a name="idp75634128"></a>Textual expression of RRs</h4></div></div></div>
<p>
RRs are represented in binary form in the packets of the DNS
</div>
</div>
- <div class="section">
+ <div class="section" title="Discussion of MX Records">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.7.4"></a>Discussion of MX Records</h3></div></div></div>
+<a name="idp75721424"></a>Discussion of MX Records</h3></div></div></div>
<p>
be attempted.
</p>
</div>
- <div class="section">
+ <div class="section" title="Setting TTLs">
<div class="titlepage"><div><div><h3 class="title">
<a name="Setting_TTLs"></a>Setting TTLs</h3></div></div></div>
can be explicitly specified, for example, <code class="literal">1h30m</code>.
</p>
</div>
- <div class="section">
+ <div class="section" title="Inverse Mapping in IPv4">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.7.6"></a>Inverse Mapping in IPv4</h3></div></div></div>
+<a name="idp75794256"></a>Inverse Mapping in IPv4</h3></div></div></div>
<p>
Reverse name resolution (that is, translation from IP address
</tbody>
</table>
</div>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
The <span class="command"><strong>$ORIGIN</strong></span> lines in the examples
</p>
</div>
</div>
- <div class="section">
+ <div class="section" title="Other Zone File Directives">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.7.7"></a>Other Zone File Directives</h3></div></div></div>
+<a name="idp75807568"></a>Other Zone File Directives</h3></div></div></div>
<p>
The Master File Format was initially defined in RFC 1035 and
Master File Directives include <span class="command"><strong>$ORIGIN</strong></span>, <span class="command"><strong>$INCLUDE</strong></span>,
and <span class="command"><strong>$TTL.</strong></span>
</p>
- <div class="section">
+ <div class="section" title="The @ (at-sign)">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.7.7.5"></a>The <span class="command"><strong>@</strong></span> (at-sign)</h4></div></div></div>
+<a name="idp75810384"></a>The <span class="command"><strong>@</strong></span> (at-sign)</h4></div></div></div>
<p>
When used in the label (or name) field, the asperand or
trailing dot).
</p>
</div>
- <div class="section">
+ <div class="section" title="The $ORIGIN Directive">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.7.7.6"></a>The <span class="command"><strong>$ORIGIN</strong></span> Directive</h4></div></div></div>
+<a name="idp75812944"></a>The <span class="command"><strong>$ORIGIN</strong></span> Directive</h4></div></div></div>
<p>
Syntax: <span class="command"><strong>$ORIGIN</strong></span>
</pre>
</div>
- <div class="section">
+ <div class="section" title="The $INCLUDE Directive">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.7.7.7"></a>The <span class="command"><strong>$INCLUDE</strong></span> Directive</h4></div></div></div>
+<a name="idp75820240"></a>The <span class="command"><strong>$INCLUDE</strong></span> Directive</h4></div></div></div>
<p>
Syntax: <span class="command"><strong>$INCLUDE</strong></span>
revert to the values they had prior to the <span class="command"><strong>$INCLUDE</strong></span> once
the file has been read.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
RFC 1035 specifies that the current origin should be restored
</p>
</div>
</div>
- <div class="section">
+ <div class="section" title="The $TTL Directive">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.7.7.8"></a>The <span class="command"><strong>$TTL</strong></span> Directive</h4></div></div></div>
+<a name="idp75828816"></a>The <span class="command"><strong>$TTL</strong></span> Directive</h4></div></div></div>
<p>
Syntax: <span class="command"><strong>$TTL</strong></span>
</p>
</div>
</div>
- <div class="section">
+ <div class="section" title="BIND Master File Extension: the $GENERATE Directive">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.7.7.8"></a><acronym class="acronym">BIND</acronym> Master File Extension: the <span class="command"><strong>$GENERATE</strong></span> Directive</h3></div></div></div>
+<a name="idp75833808"></a><acronym class="acronym">BIND</acronym> Master File Extension: the <span class="command"><strong>$GENERATE</strong></span> Directive</h3></div></div></div>
<p>
Syntax: <span class="command"><strong>$GENERATE</strong></span>
</p>
</div>
- <div class="section">
+ <div class="section" title="Additional File Formats">
<div class="titlepage"><div><div><h3 class="title">
<a name="zonefile_format"></a>Additional File Formats</h3></div></div></div>
</div>
</div>
- <div class="section">
+ <div class="section" title="BIND9 Statistics">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="statistics"></a>BIND9 Statistics</h2></div></div></div>
(see <a class="xref" href="Bv9ARM.ch06.html#statschannels" title="statistics-channels Statement Grammar">the section called “<span class="command"><strong>statistics-channels</strong></span> Statement Grammar”</a>.)
</p>
- <div class="section">
+ <div class="section" title="The Statistics File">
<div class="titlepage"><div><div><h3 class="title">
<a name="statsfile"></a>The Statistics File</h3></div></div></div>
</p>
</div>
- <div class="section">
+ <div class="section" title="Statistics Counters">
<div class="titlepage"><div><div><h3 class="title">
<a name="statistics_counters"></a>Statistics Counters</h3></div></div></div>
<acronym class="acronym">BIND</acronym> 8 statistics, if applicable.
</p>
- <div class="section">
+ <div class="section" title="Name Server Statistics Counters">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.8.10.4"></a>Name Server Statistics Counters</h4></div></div></div>
+<a name="idp75958736"></a>Name Server Statistics Counters</h4></div></div></div>
<div class="informaltable">
</div>
</div>
- <div class="section">
+ <div class="section" title="Zone Maintenance Statistics Counters">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.8.10.5"></a>Zone Maintenance Statistics Counters</h4></div></div></div>
+<a name="idp76141776"></a>Zone Maintenance Statistics Counters</h4></div></div></div>
<div class="informaltable">
</div>
</div>
- <div class="section">
+ <div class="section" title="Resolver Statistics Counters">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.8.10.6"></a>Resolver Statistics Counters</h4></div></div></div>
+<a name="idp76197840"></a>Resolver Statistics Counters</h4></div></div></div>
<div class="informaltable">
</div>
- <div class="section">
+ <div class="section" title="Socket I/O Statistics Counters">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.8.10.7"></a>Socket I/O Statistics Counters</h4></div></div></div>
+<a name="idp76330960"></a>Socket I/O Statistics Counters</h4></div></div></div>
<p>
</table>
</div>
</div>
- <div class="section">
+ <div class="section" title="Compatibility with BIND 8 Counters">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.7.8.10.8"></a>Compatibility with <span class="emphasis"><em>BIND</em></span> 8 Counters</h4></div></div></div>
+<a name="idp76377808"></a>Compatibility with <span class="emphasis"><em>BIND</em></span> 8 Counters</h4></div></div></div>
<p>
Most statistics counters that were available
in these tables.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>RFwdR,SFwdR</strong></span></span></dt>
<dd>
<p>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 7. BIND 9 Security Considerations</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch06.html" title="Chapter 6. BIND 9 Configuration Reference">
</table>
<hr>
</div>
-<div class="chapter">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch07"></a>Chapter 7. <acronym class="acronym">BIND</acronym> 9 Security Considerations</h1></div></div></div>
+<div class="chapter" title="Chapter 7. BIND 9 Security Considerations">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch07"></a>Chapter 7. <acronym class="acronym">BIND</acronym> 9 Security Considerations</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
+<dl>
<dt><span class="section"><a href="Bv9ARM.ch07.html#Access_Control_Lists">Access Control Lists</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch07.html#id-1.8.4"><span class="command"><strong>Chroot</strong></span> and <span class="command"><strong>Setuid</strong></span></a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch07.html#idp76415824"><span class="command"><strong>Chroot</strong></span> and <span class="command"><strong>Setuid</strong></span></a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch07.html#id-1.8.4.7">The <span class="command"><strong>chroot</strong></span> Environment</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch07.html#id-1.8.4.8">Using the <span class="command"><strong>setuid</strong></span> Function</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch07.html#idp76425552">The <span class="command"><strong>chroot</strong></span> Environment</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch07.html#idp76433360">Using the <span class="command"><strong>setuid</strong></span> Function</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch07.html#dynamic_update_security">Dynamic Update Security</a></span></dt>
</dl>
</div>
- <div class="section">
+ <div class="section" title="Access Control Lists">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="Access_Control_Lists"></a>Access Control Lists</h2></div></div></div>
</p>
</div>
- <div class="section">
+ <div class="section" title="Chroot and Setuid">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.8.4"></a><span class="command"><strong>Chroot</strong></span> and <span class="command"><strong>Setuid</strong></span>
+<a name="idp76415824"></a><span class="command"><strong>Chroot</strong></span> and <span class="command"><strong>Setuid</strong></span>
</h2></div></div></div>
<p>
<strong class="userinput"><code>/usr/local/sbin/named -u 202 -t /var/named</code></strong>
</p>
- <div class="section">
+ <div class="section" title="The chroot Environment">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.8.4.7"></a>The <span class="command"><strong>chroot</strong></span> Environment</h3></div></div></div>
+<a name="idp76425552"></a>The <span class="command"><strong>chroot</strong></span> Environment</h3></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="Using the setuid Function">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.8.4.8"></a>Using the <span class="command"><strong>setuid</strong></span> Function</h3></div></div></div>
+<a name="idp76433360"></a>Using the <span class="command"><strong>setuid</strong></span> Function</h3></div></div></div>
<p>
to which you want <acronym class="acronym">BIND</acronym>
to write.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
Note that if the <span class="command"><strong>named</strong></span> daemon is running as an
unprivileged user, it will not be able to bind to new restricted
</div>
</div>
- <div class="section">
+ <div class="section" title="Dynamic Update Security">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="dynamic_update_security"></a>Dynamic Update Security</h2></div></div></div>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 8. Troubleshooting</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch07.html" title="Chapter 7. BIND 9 Security Considerations">
</table>
<hr>
</div>
-<div class="chapter">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch08"></a>Chapter 8. Troubleshooting</h1></div></div></div>
+<div class="chapter" title="Chapter 8. Troubleshooting">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch08"></a>Chapter 8. Troubleshooting</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
-<dt><span class="section"><a href="Bv9ARM.ch08.html#id-1.9.3">Common Problems</a></span></dt>
-<dd><dl><dt><span class="section"><a href="Bv9ARM.ch08.html#id-1.9.3.3">It's not working; how can I figure out what's wrong?</a></span></dt></dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch08.html#id-1.9.4">Incrementing and Changing the Serial Number</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch08.html#id-1.9.5">Where Can I Get Help?</a></span></dt>
+<dl>
+<dt><span class="section"><a href="Bv9ARM.ch08.html#idp76443600">Common Problems</a></span></dt>
+<dd><dl><dt><span class="section"><a href="Bv9ARM.ch08.html#idp76444624">It's not working; how can I figure out what's wrong?</a></span></dt></dl></dd>
+<dt><span class="section"><a href="Bv9ARM.ch08.html#idp76446160">Incrementing and Changing the Serial Number</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch08.html#idp76448336">Where Can I Get Help?</a></span></dt>
</dl>
</div>
- <div class="section">
+ <div class="section" title="Common Problems">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.9.3"></a>Common Problems</h2></div></div></div>
+<a name="idp76443600"></a>Common Problems</h2></div></div></div>
- <div class="section">
+ <div class="section" title="It's not working; how can I figure out what's wrong?">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.9.3.3"></a>It's not working; how can I figure out what's wrong?</h3></div></div></div>
+<a name="idp76444624"></a>It's not working; how can I figure out what's wrong?</h3></div></div></div>
<p>
</div>
</div>
- <div class="section">
+ <div class="section" title="Incrementing and Changing the Serial Number">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.9.4"></a>Incrementing and Changing the Serial Number</h2></div></div></div>
+<a name="idp76446160"></a>Incrementing and Changing the Serial Number</h2></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="Where Can I Get Help?">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.9.5"></a>Where Can I Get Help?</h2></div></div></div>
+<a name="idp76448336"></a>Where Can I Get Help?</h2></div></div></div>
<p>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Appendix A. Release Notes</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch08.html" title="Chapter 8. Troubleshooting">
</table>
<hr>
</div>
-<div class="appendix">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch09"></a>Appendix A. Release Notes</h1></div></div></div>
+<div class="appendix" title="Appendix A. Release Notes">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch09"></a>Appendix A. Release Notes</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
-<dt><span class="section"><a href="Bv9ARM.ch09.html#id-1.10.3">Release Notes for BIND Version 9.11.0pre-alpha</a></span></dt>
+<dl>
+<dt><span class="section"><a href="Bv9ARM.ch09.html#idp76455504">Release Notes for BIND Version 9.11.0pre-alpha</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch09.html#relnotes_intro">Introduction</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch09.html#relnotes_download">Download</a></span></dt>
</dl>
</div>
- <div class="section">
+ <div class="section" title="Release Notes for BIND Version 9.11.0pre-alpha">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.10.3"></a>Release Notes for BIND Version 9.11.0pre-alpha</h2></div></div></div>
+<a name="idp76455504"></a>Release Notes for BIND Version 9.11.0pre-alpha</h2></div></div></div>
- <div class="section">
+ <div class="section" title="Introduction">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_intro"></a>Introduction</h3></div></div></div>
of BIND on the corresponding major release branch.
</p>
</div>
- <div class="section">
+ <div class="section" title="Download">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_download"></a>Download</h3></div></div></div>
operating systems.
</p>
</div>
- <div class="section">
+ <div class="section" title="Security Fixes">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_security"></a>Security Fixes</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
An incorrect boundary check in the OPENPGPKEY rdatatype
</li>
</ul></div>
</div>
- <div class="section">
+ <div class="section" title="New Features">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_features"></a>New Features</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
Added support for DynDB, a new interface for loading zone data
experienced by recursives when they are being used as a
vehicle for such an attack.
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle">
<li class="listitem">
<p>
<code class="option">fetches-per-server</code> limits the number of
</li>
</ul></div>
</div>
- <div class="section">
+ <div class="section" title="Feature Changes">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_changes"></a>Feature Changes</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
ACLs containing <span class="command"><strong>geoip asnum</strong></span> elements were
</li>
</ul></div>
</div>
- <div class="section">
+ <div class="section" title="Porting Changes">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_port"></a>Porting Changes</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<p>
The Microsoft Windows install tool
<span class="command"><strong>BINDInstall.exe</strong></span> which requires a
</p>
</li></ul></div>
</div>
- <div class="section">
+ <div class="section" title="Bug Fixes">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_bugs"></a>Bug Fixes</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
<span class="command"><strong>dig</strong></span>, <span class="command"><strong>host</strong></span> and
<p>
Several bugs have been fixed in the RPZ implementation:
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle">
<li class="listitem">
<p>
Policy zones that did not specifically require recursion
</li>
</ul></div>
</div>
- <div class="section">
+ <div class="section" title="End of Life">
<div class="titlepage"><div><div><h3 class="title">
<a name="end_of_life"></a>End of Life</h3></div></div></div>
<a class="ulink" href="https://www.isc.org/downloads/software-support-policy/" target="_top">https://www.isc.org/downloads/software-support-policy/</a>
</p>
</div>
- <div class="section">
+ <div class="section" title="Thank You">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_thanks"></a>Thank You</h3></div></div></div>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Appendix B. A Brief History of the DNS and BIND</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch09.html" title="Appendix A. Release Notes">
</table>
<hr>
</div>
-<div class="appendix">
-<div class="titlepage"><div><div><h1 class="title">
+<div class="appendix" title="Appendix B. A Brief History of the DNS and BIND">
+<div class="titlepage"><div><div><h2 class="title">
<a name="Bv9ARM.ch10"></a>Appendix B. A Brief History of the <acronym class="acronym">DNS</acronym> and <acronym class="acronym">BIND</acronym>
-</h1></div></div></div>
+</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
+<dl>
<dt><span class="section"><a href="Bv9ARM.ch10.html#dns_history">DNS</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch10.html#bind_history">BIND</a></span></dt>
</dl>
</div>
- <div class="section">
+ <div class="section" title="DNS">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="dns_history"></a>DNS</h2></div></div></div>
<p>
</p>
</div>
- <div class="section">
+ <div class="section" title="BIND">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bind_history"></a>BIND</h2></div></div></div>
<p>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Appendix C. General DNS Reference Information</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch10.html" title="Appendix B. A Brief History of the DNS and BIND">
</table>
<hr>
</div>
-<div class="appendix">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch11"></a>Appendix C. General <acronym class="acronym">DNS</acronym> Reference Information</h1></div></div></div>
+<div class="appendix" title="Appendix C. General DNS Reference Information">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch11"></a>Appendix C. General <acronym class="acronym">DNS</acronym> Reference Information</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
+<dl>
<dt><span class="section"><a href="Bv9ARM.ch11.html#ipv6addresses">IPv6 addresses (AAAA)</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch11.html#bibliography">Bibliography (and Suggested Reading)</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch11.html#rfcs">Request for Comments (RFCs)</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch11.html#internet_drafts">Internet Drafts</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch11.html#id-1.12.4.5">Other Documents About <acronym class="acronym">BIND</acronym></a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch11.html#idp76985296">Other Documents About <acronym class="acronym">BIND</acronym></a></span></dt>
</dl></dd>
</dl>
</div>
- <div class="section">
+ <div class="section" title="IPv6 addresses (AAAA)">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="ipv6addresses"></a>IPv6 addresses (AAAA)</h2></div></div></div>
of zeros that can fit, and can be used only once in an address.
</p>
</div>
- <div class="section">
+ <div class="section" title="Bibliography (and Suggested Reading)">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bibliography"></a>Bibliography (and Suggested Reading)</h2></div></div></div>
- <div class="section">
+ <div class="section" title="Request for Comments (RFCs)">
<div class="titlepage"><div><div><h3 class="title">
<a name="rfcs"></a>Request for Comments (RFCs)</h3></div></div></div>
<p>
<a class="ulink" href="http://www.ietf.org/rfc/" target="_top">http://www.ietf.org/rfc/</a>.
</p>
- <div class="bibliography">
+ <div class="bibliography" title="Bibliography">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.12.4.3.7"></a>Bibliography</h4></div></div></div>
- <div class="bibliodiv">
+<a name="idp76648016"></a>Bibliography</h4></div></div></div>
+ <div class="bibliodiv" title="Standards">
<h3 class="title">
-<a name="id-1.12.4.3.7.1"></a>Standards</h3>
+<a name="idp76648272"></a>Standards</h3>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.1.3"></a><p>[<abbr class="abbrev">RFC974</abbr>]
+<a name="idp76657744"></a><p>[<abbr class="abbrev">RFC974</abbr>]
<span class="author"><span class="firstname">C.</span> <span class="surname">Partridge</span>. </span>
<span class="citetitle"><em class="citetitle">Mail Routing and the Domain System</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.1.4"></a><p>[<abbr class="abbrev">RFC1034</abbr>]
+<a name="idp76660176"></a><p>[<abbr class="abbrev">RFC1034</abbr>]
<span class="author"><span class="firstname">P.V.</span> <span class="surname">Mockapetris</span>. </span>
<span class="citetitle"><em class="citetitle">Domain Names — Concepts and Facilities</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.1.5"></a><p>[<abbr class="abbrev">RFC1035</abbr>]
+<a name="idp76662608"></a><p>[<abbr class="abbrev">RFC1035</abbr>]
<span class="author"><span class="firstname">P. V.</span> <span class="surname">Mockapetris</span>. </span> <span class="citetitle"><em class="citetitle">Domain Names — Implementation and
Specification</em>. </span>
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="Proposed Standards">
<h3 class="title">
<a name="proposed_standards"></a>Proposed Standards</h3>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.3"></a><p>[<abbr class="abbrev">RFC2181</abbr>]
+<a name="idp76666704"></a><p>[<abbr class="abbrev">RFC2181</abbr>]
<span class="author"><span class="firstname">R., R. Bush</span> <span class="surname">Elz</span>. </span>
<span class="citetitle"><em class="citetitle">Clarifications to the <acronym class="acronym">DNS</acronym>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.4"></a><p>[<abbr class="abbrev">RFC2308</abbr>]
+<a name="idp76669520"></a><p>[<abbr class="abbrev">RFC2308</abbr>]
<span class="author"><span class="firstname">M.</span> <span class="surname">Andrews</span>. </span>
<span class="citetitle"><em class="citetitle">Negative Caching of <acronym class="acronym">DNS</acronym>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.5"></a><p>[<abbr class="abbrev">RFC1995</abbr>]
+<a name="idp76672336"></a><p>[<abbr class="abbrev">RFC1995</abbr>]
<span class="author"><span class="firstname">M.</span> <span class="surname">Ohta</span>. </span>
<span class="citetitle"><em class="citetitle">Incremental Zone Transfer in <acronym class="acronym">DNS</acronym></em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.6"></a><p>[<abbr class="abbrev">RFC1996</abbr>]
+<a name="idp76679248"></a><p>[<abbr class="abbrev">RFC1996</abbr>]
<span class="author"><span class="firstname">P.</span> <span class="surname">Vixie</span>. </span>
<span class="citetitle"><em class="citetitle">A Mechanism for Prompt Notification of Zone Changes</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.7"></a><p>[<abbr class="abbrev">RFC2136</abbr>]
+<a name="idp76681680"></a><p>[<abbr class="abbrev">RFC2136</abbr>]
<span class="authorgroup"><span class="firstname">P.</span> <span class="surname">Vixie</span>, <span class="firstname">S.</span> <span class="surname">Thomson</span>, <span class="firstname">Y.</span> <span class="surname">Rekhter</span>, and <span class="firstname">J.</span> <span class="surname">Bound</span>. </span>
<span class="citetitle"><em class="citetitle">Dynamic Updates in the Domain Name System</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.8"></a><p>[<abbr class="abbrev">RFC2671</abbr>]
+<a name="idp76687312"></a><p>[<abbr class="abbrev">RFC2671</abbr>]
<span class="authorgroup"><span class="firstname">P.</span> <span class="surname">Vixie</span>. </span>
<span class="citetitle"><em class="citetitle">Extension Mechanisms for DNS (EDNS0)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.9"></a><p>[<abbr class="abbrev">RFC2672</abbr>]
+<a name="idp76690128"></a><p>[<abbr class="abbrev">RFC2672</abbr>]
<span class="authorgroup"><span class="firstname">M.</span> <span class="surname">Crawford</span>. </span>
<span class="citetitle"><em class="citetitle">Non-Terminal DNS Name Redirection</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.10"></a><p>[<abbr class="abbrev">RFC2845</abbr>]
+<a name="idp76692944"></a><p>[<abbr class="abbrev">RFC2845</abbr>]
<span class="authorgroup"><span class="firstname">P.</span> <span class="surname">Vixie</span>, <span class="firstname">O.</span> <span class="surname">Gudmundsson</span>, <span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>, and <span class="firstname">B.</span> <span class="surname">Wellington</span>. </span>
<span class="citetitle"><em class="citetitle">Secret Key Transaction Authentication for <acronym class="acronym">DNS</acronym> (TSIG)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.11"></a><p>[<abbr class="abbrev">RFC2930</abbr>]
+<a name="idp76699216"></a><p>[<abbr class="abbrev">RFC2930</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>. </span>
<span class="citetitle"><em class="citetitle">Secret Key Establishment for DNS (TKEY RR)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.12"></a><p>[<abbr class="abbrev">RFC2931</abbr>]
+<a name="idp76702416"></a><p>[<abbr class="abbrev">RFC2931</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>. </span>
<span class="citetitle"><em class="citetitle">DNS Request and Transaction Signatures (SIG(0)s)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.13"></a><p>[<abbr class="abbrev">RFC3007</abbr>]
+<a name="idp76705488"></a><p>[<abbr class="abbrev">RFC3007</abbr>]
<span class="authorgroup"><span class="firstname">B.</span> <span class="surname">Wellington</span>. </span>
<span class="citetitle"><em class="citetitle">Secure Domain Name System (DNS) Dynamic Update</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.2.14"></a><p>[<abbr class="abbrev">RFC3645</abbr>]
+<a name="idp76708304"></a><p>[<abbr class="abbrev">RFC3645</abbr>]
<span class="authorgroup"><span class="firstname">S.</span> <span class="surname">Kwan</span>, <span class="firstname">P.</span> <span class="surname">Garg</span>, <span class="firstname">J.</span> <span class="surname">Gilroy</span>, <span class="firstname">L.</span> <span class="surname">Esibov</span>, <span class="firstname">J.</span> <span class="surname">Westhead</span>, and <span class="firstname">R.</span> <span class="surname">Hall</span>. </span>
<span class="citetitle"><em class="citetitle">Generic Security Service Algorithm for Secret
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="DNS Security Proposed Standards">
<h3 class="title">
-<a name="id-1.12.4.3.7.3"></a><acronym class="acronym">DNS</acronym> Security Proposed Standards</h3>
+<a name="idp76715856"></a><acronym class="acronym">DNS</acronym> Security Proposed Standards</h3>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.3.3"></a><p>[<abbr class="abbrev">RFC3225</abbr>]
+<a name="idp76717264"></a><p>[<abbr class="abbrev">RFC3225</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Conrad</span>. </span>
<span class="citetitle"><em class="citetitle">Indicating Resolver Support of DNSSEC</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.3.4"></a><p>[<abbr class="abbrev">RFC3833</abbr>]
+<a name="idp76724304"></a><p>[<abbr class="abbrev">RFC3833</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Atkins</span> and <span class="firstname">R.</span> <span class="surname">Austein</span>. </span>
<span class="citetitle"><em class="citetitle">Threat Analysis of the Domain Name System (DNS)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.3.5"></a><p>[<abbr class="abbrev">RFC4033</abbr>]
+<a name="idp76728016"></a><p>[<abbr class="abbrev">RFC4033</abbr>]
<span class="authorgroup"><span class="firstname">R.</span> <span class="surname">Arends</span>, <span class="firstname">R.</span> <span class="surname">Austein</span>, <span class="firstname">M.</span> <span class="surname">Larson</span>, <span class="firstname">D.</span> <span class="surname">Massey</span>, and <span class="firstname">S.</span> <span class="surname">Rose</span>. </span>
<span class="citetitle"><em class="citetitle">DNS Security Introduction and Requirements</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.3.6"></a><p>[<abbr class="abbrev">RFC4034</abbr>]
+<a name="idp76734544"></a><p>[<abbr class="abbrev">RFC4034</abbr>]
<span class="authorgroup"><span class="firstname">R.</span> <span class="surname">Arends</span>, <span class="firstname">R.</span> <span class="surname">Austein</span>, <span class="firstname">M.</span> <span class="surname">Larson</span>, <span class="firstname">D.</span> <span class="surname">Massey</span>, and <span class="firstname">S.</span> <span class="surname">Rose</span>. </span>
<span class="citetitle"><em class="citetitle">Resource Records for the DNS Security Extensions</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.3.7"></a><p>[<abbr class="abbrev">RFC4035</abbr>]
+<a name="idp76741072"></a><p>[<abbr class="abbrev">RFC4035</abbr>]
<span class="authorgroup"><span class="firstname">R.</span> <span class="surname">Arends</span>, <span class="firstname">R.</span> <span class="surname">Austein</span>, <span class="firstname">M.</span> <span class="surname">Larson</span>, <span class="firstname">D.</span> <span class="surname">Massey</span>, and <span class="firstname">S.</span> <span class="surname">Rose</span>. </span>
<span class="citetitle"><em class="citetitle">Protocol Modifications for the DNS
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="Other Important RFCs About DNS Implementation">
<h3 class="title">
-<a name="id-1.12.4.3.7.4"></a>Other Important RFCs About <acronym class="acronym">DNS</acronym>
+<a name="idp76747728"></a>Other Important RFCs About <acronym class="acronym">DNS</acronym>
Implementation</h3>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.4.3"></a><p>[<abbr class="abbrev">RFC1535</abbr>]
+<a name="idp76749392"></a><p>[<abbr class="abbrev">RFC1535</abbr>]
<span class="author"><span class="firstname">E.</span> <span class="surname">Gavron</span>. </span>
<span class="citetitle"><em class="citetitle">A Security Problem and Proposed Correction With Widely
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.4.4"></a><p>[<abbr class="abbrev">RFC1536</abbr>]
+<a name="idp76752208"></a><p>[<abbr class="abbrev">RFC1536</abbr>]
<span class="authorgroup"><span class="firstname">A.</span> <span class="surname">Kumar</span>, <span class="firstname">J.</span> <span class="surname">Postel</span>, <span class="firstname">C.</span> <span class="surname">Neuman</span>, <span class="firstname">P.</span> <span class="surname">Danzig</span>, and <span class="firstname">S.</span> <span class="surname">Miller</span>. </span>
<span class="citetitle"><em class="citetitle">Common <acronym class="acronym">DNS</acronym> Implementation
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.4.5"></a><p>[<abbr class="abbrev">RFC1982</abbr>]
+<a name="idp76759120"></a><p>[<abbr class="abbrev">RFC1982</abbr>]
<span class="authorgroup"><span class="firstname">R.</span> <span class="surname">Elz</span> and <span class="firstname">R.</span> <span class="surname">Bush</span>. </span>
<span class="citetitle"><em class="citetitle">Serial Number Arithmetic</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.4.6"></a><p>[<abbr class="abbrev">RFC4074</abbr>]
+<a name="idp76762832"></a><p>[<abbr class="abbrev">RFC4074</abbr>]
<span class="authorgroup"><span class="firstname">Y.</span> <span class="surname">Morishita</span> and <span class="firstname">T.</span> <span class="surname">Jinmei</span>. </span>
<span class="citetitle"><em class="citetitle">Common Misbehaviour Against <acronym class="acronym">DNS</acronym>
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="Resource Record Types">
<h3 class="title">
-<a name="id-1.12.4.3.7.5"></a>Resource Record Types</h3>
+<a name="idp76767184"></a>Resource Record Types</h3>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.3"></a><p>[<abbr class="abbrev">RFC1183</abbr>]
+<a name="idp76768080"></a><p>[<abbr class="abbrev">RFC1183</abbr>]
<span class="authorgroup"><span class="firstname">C.F.</span> <span class="surname">Everhart</span>, <span class="firstname">L. A.</span> <span class="surname">Mamakos</span>, <span class="firstname">R.</span> <span class="surname">Ullmann</span>, and <span class="firstname">P.</span> <span class="surname">Mockapetris</span>. </span>
<span class="citetitle"><em class="citetitle">New <acronym class="acronym">DNS</acronym> RR Definitions</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.4"></a><p>[<abbr class="abbrev">RFC1706</abbr>]
+<a name="idp76774096"></a><p>[<abbr class="abbrev">RFC1706</abbr>]
<span class="authorgroup"><span class="firstname">B.</span> <span class="surname">Manning</span> and <span class="firstname">R.</span> <span class="surname">Colella</span>. </span>
<span class="citetitle"><em class="citetitle"><acronym class="acronym">DNS</acronym> NSAP Resource Records</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.5"></a><p>[<abbr class="abbrev">RFC2168</abbr>]
+<a name="idp76778064"></a><p>[<abbr class="abbrev">RFC2168</abbr>]
<span class="authorgroup"><span class="firstname">R.</span> <span class="surname">Daniel</span> and <span class="firstname">M.</span> <span class="surname">Mealling</span>. </span>
<span class="citetitle"><em class="citetitle">Resolution of Uniform Resource Identifiers using
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.6"></a><p>[<abbr class="abbrev">RFC1876</abbr>]
+<a name="idp76781904"></a><p>[<abbr class="abbrev">RFC1876</abbr>]
<span class="authorgroup"><span class="firstname">C.</span> <span class="surname">Davis</span>, <span class="firstname">P.</span> <span class="surname">Vixie</span>, <span class="firstname">T.</span>, and <span class="firstname">I.</span> <span class="surname">Dickinson</span>. </span>
<span class="citetitle"><em class="citetitle">A Means for Expressing Location Information in the
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.7"></a><p>[<abbr class="abbrev">RFC2052</abbr>]
+<a name="idp76787408"></a><p>[<abbr class="abbrev">RFC2052</abbr>]
<span class="authorgroup"><span class="firstname">A.</span> <span class="surname">Gulbrandsen</span> and <span class="firstname">P.</span> <span class="surname">Vixie</span>. </span>
<span class="citetitle"><em class="citetitle">A <acronym class="acronym">DNS</acronym> RR for Specifying the
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.8"></a><p>[<abbr class="abbrev">RFC2163</abbr>]
+<a name="idp76791632"></a><p>[<abbr class="abbrev">RFC2163</abbr>]
<span class="author"><span class="firstname">A.</span> <span class="surname">Allocchio</span>. </span>
<span class="citetitle"><em class="citetitle">Using the Internet <acronym class="acronym">DNS</acronym> to
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.9"></a><p>[<abbr class="abbrev">RFC2230</abbr>]
+<a name="idp76794448"></a><p>[<abbr class="abbrev">RFC2230</abbr>]
<span class="author"><span class="firstname">R.</span> <span class="surname">Atkinson</span>. </span>
<span class="citetitle"><em class="citetitle">Key Exchange Delegation Record for the <acronym class="acronym">DNS</acronym></em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.10"></a><p>[<abbr class="abbrev">RFC2536</abbr>]
+<a name="idp76797264"></a><p>[<abbr class="abbrev">RFC2536</abbr>]
<span class="author"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>. </span>
<span class="citetitle"><em class="citetitle">DSA KEYs and SIGs in the Domain Name System (DNS)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.11"></a><p>[<abbr class="abbrev">RFC2537</abbr>]
+<a name="idp76799952"></a><p>[<abbr class="abbrev">RFC2537</abbr>]
<span class="author"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>. </span>
<span class="citetitle"><em class="citetitle">RSA/MD5 KEYs and SIGs in the Domain Name System (DNS)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.12"></a><p>[<abbr class="abbrev">RFC2538</abbr>]
+<a name="idp76802640"></a><p>[<abbr class="abbrev">RFC2538</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span> and <span class="firstname">O.</span> <span class="surname">Gudmundsson</span>. </span>
<span class="citetitle"><em class="citetitle">Storing Certificates in the Domain Name System (DNS)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.13"></a><p>[<abbr class="abbrev">RFC2539</abbr>]
+<a name="idp76806736"></a><p>[<abbr class="abbrev">RFC2539</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>. </span>
<span class="citetitle"><em class="citetitle">Storage of Diffie-Hellman Keys in the Domain Name System (DNS)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.14"></a><p>[<abbr class="abbrev">RFC2540</abbr>]
+<a name="idp76809808"></a><p>[<abbr class="abbrev">RFC2540</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>. </span>
<span class="citetitle"><em class="citetitle">Detached Domain Name System (DNS) Information</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.15"></a><p>[<abbr class="abbrev">RFC2782</abbr>]
+<a name="idp76813008"></a><p>[<abbr class="abbrev">RFC2782</abbr>]
<span class="author"><span class="firstname">A.</span> <span class="surname">Gulbrandsen</span>. </span>
<span class="author"><span class="firstname">P.</span> <span class="surname">Vixie</span>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.16"></a><p>[<abbr class="abbrev">RFC2915</abbr>]
+<a name="idp76817232"></a><p>[<abbr class="abbrev">RFC2915</abbr>]
<span class="author"><span class="firstname">M.</span> <span class="surname">Mealling</span>. </span>
<span class="author"><span class="firstname">R.</span> <span class="surname">Daniel</span>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.17"></a><p>[<abbr class="abbrev">RFC3110</abbr>]
+<a name="idp76820560"></a><p>[<abbr class="abbrev">RFC3110</abbr>]
<span class="author"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>. </span>
<span class="citetitle"><em class="citetitle">RSA/SHA-1 SIGs and RSA KEYs in the Domain Name System (DNS)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.18"></a><p>[<abbr class="abbrev">RFC3123</abbr>]
+<a name="idp76823376"></a><p>[<abbr class="abbrev">RFC3123</abbr>]
<span class="author"><span class="firstname">P.</span> <span class="surname">Koch</span>. </span>
<span class="citetitle"><em class="citetitle">A DNS RR Type for Lists of Address Prefixes (APL RR)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.19"></a><p>[<abbr class="abbrev">RFC3596</abbr>]
+<a name="idp76825808"></a><p>[<abbr class="abbrev">RFC3596</abbr>]
<span class="authorgroup"><span class="firstname">S.</span> <span class="surname">Thomson</span>, <span class="firstname">C.</span> <span class="surname">Huitema</span>, <span class="firstname">V.</span> <span class="surname">Ksinant</span>, and <span class="firstname">M.</span> <span class="surname">Souissi</span>. </span>
<span class="citetitle"><em class="citetitle"><acronym class="acronym">DNS</acronym> Extensions to support IP
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.5.20"></a><p>[<abbr class="abbrev">RFC3597</abbr>]
+<a name="idp76831696"></a><p>[<abbr class="abbrev">RFC3597</abbr>]
<span class="author"><span class="firstname">A.</span> <span class="surname">Gustafsson</span>. </span>
<span class="citetitle"><em class="citetitle">Handling of Unknown DNS Resource Record (RR) Types</em>. </span>
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="DNS and the Internet">
<h3 class="title">
-<a name="id-1.12.4.3.7.6"></a><acronym class="acronym">DNS</acronym> and the Internet</h3>
+<a name="idp76834256"></a><acronym class="acronym">DNS</acronym> and the Internet</h3>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.6.3"></a><p>[<abbr class="abbrev">RFC1101</abbr>]
+<a name="idp76835664"></a><p>[<abbr class="abbrev">RFC1101</abbr>]
<span class="author"><span class="firstname">P. V.</span> <span class="surname">Mockapetris</span>. </span>
<span class="citetitle"><em class="citetitle"><acronym class="acronym">DNS</acronym> Encoding of Network Names
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.6.4"></a><p>[<abbr class="abbrev">RFC1123</abbr>]
+<a name="idp76838480"></a><p>[<abbr class="abbrev">RFC1123</abbr>]
<span class="author"><span class="surname">Braden</span>. </span>
<span class="citetitle"><em class="citetitle">Requirements for Internet Hosts - Application and
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.6.5"></a><p>[<abbr class="abbrev">RFC1591</abbr>]
+<a name="idp76840912"></a><p>[<abbr class="abbrev">RFC1591</abbr>]
<span class="author"><span class="firstname">J.</span> <span class="surname">Postel</span>. </span>
<span class="citetitle"><em class="citetitle">Domain Name System Structure and Delegation</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.6.6"></a><p>[<abbr class="abbrev">RFC2317</abbr>]
+<a name="idp76843344"></a><p>[<abbr class="abbrev">RFC2317</abbr>]
<span class="authorgroup"><span class="firstname">H.</span> <span class="surname">Eidnes</span>, <span class="firstname">G.</span> <span class="surname">de Groot</span>, and <span class="firstname">P.</span> <span class="surname">Vixie</span>. </span>
<span class="citetitle"><em class="citetitle">Classless IN-ADDR.ARPA Delegation</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.6.7"></a><p>[<abbr class="abbrev">RFC2826</abbr>]
+<a name="idp76848080"></a><p>[<abbr class="abbrev">RFC2826</abbr>]
<span class="authorgroup"><span class="surname">Internet Architecture Board</span>. </span>
<span class="citetitle"><em class="citetitle">IAB Technical Comment on the Unique DNS Root</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.6.8"></a><p>[<abbr class="abbrev">RFC2929</abbr>]
+<a name="idp76850640"></a><p>[<abbr class="abbrev">RFC2929</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>, <span class="firstname">E.</span> <span class="surname">Brunner-Williams</span>, and <span class="firstname">B.</span> <span class="surname">Manning</span>. </span>
<span class="citetitle"><em class="citetitle">Domain Name System (DNS) IANA Considerations</em>. </span>
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="DNS Operations">
<h3 class="title">
-<a name="id-1.12.4.3.7.7"></a><acronym class="acronym">DNS</acronym> Operations</h3>
+<a name="idp76855760"></a><acronym class="acronym">DNS</acronym> Operations</h3>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.7.3"></a><p>[<abbr class="abbrev">RFC1033</abbr>]
+<a name="idp76857168"></a><p>[<abbr class="abbrev">RFC1033</abbr>]
<span class="author"><span class="firstname">M.</span> <span class="surname">Lottor</span>. </span>
<span class="citetitle"><em class="citetitle">Domain administrators operations guide</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.7.4"></a><p>[<abbr class="abbrev">RFC1537</abbr>]
+<a name="idp76859600"></a><p>[<abbr class="abbrev">RFC1537</abbr>]
<span class="author"><span class="firstname">P.</span> <span class="surname">Beertema</span>. </span>
<span class="citetitle"><em class="citetitle">Common <acronym class="acronym">DNS</acronym> Data File
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.7.5"></a><p>[<abbr class="abbrev">RFC1912</abbr>]
+<a name="idp76862544"></a><p>[<abbr class="abbrev">RFC1912</abbr>]
<span class="author"><span class="firstname">D.</span> <span class="surname">Barr</span>. </span>
<span class="citetitle"><em class="citetitle">Common <acronym class="acronym">DNS</acronym> Operational and
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.7.6"></a><p>[<abbr class="abbrev">RFC2010</abbr>]
+<a name="idp76865360"></a><p>[<abbr class="abbrev">RFC2010</abbr>]
<span class="authorgroup"><span class="firstname">B.</span> <span class="surname">Manning</span> and <span class="firstname">P.</span> <span class="surname">Vixie</span>. </span>
<span class="citetitle"><em class="citetitle">Operational Criteria for Root Name Servers</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.7.7"></a><p>[<abbr class="abbrev">RFC2219</abbr>]
+<a name="idp76869072"></a><p>[<abbr class="abbrev">RFC2219</abbr>]
<span class="authorgroup"><span class="firstname">M.</span> <span class="surname">Hamilton</span> and <span class="firstname">R.</span> <span class="surname">Wright</span>. </span>
<span class="citetitle"><em class="citetitle">Use of <acronym class="acronym">DNS</acronym> Aliases for
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="Internationalized Domain Names">
<h3 class="title">
-<a name="id-1.12.4.3.7.8"></a>Internationalized Domain Names</h3>
+<a name="idp76877520"></a>Internationalized Domain Names</h3>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.8.3"></a><p>[<abbr class="abbrev">RFC2825</abbr>]
+<a name="idp76878416"></a><p>[<abbr class="abbrev">RFC2825</abbr>]
<span class="authorgroup"><span class="surname">IAB</span> and <span class="firstname">R.</span> <span class="surname">Daigle</span>. </span>
<span class="citetitle"><em class="citetitle">A Tangled Web: Issues of I18N, Domain Names,
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.8.4"></a><p>[<abbr class="abbrev">RFC3490</abbr>]
+<a name="idp76881872"></a><p>[<abbr class="abbrev">RFC3490</abbr>]
<span class="authorgroup"><span class="firstname">P.</span> <span class="surname">Faltstrom</span>, <span class="firstname">P.</span> <span class="surname">Hoffman</span>, and <span class="firstname">A.</span> <span class="surname">Costello</span>. </span>
<span class="citetitle"><em class="citetitle">Internationalizing Domain Names in Applications (IDNA)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.8.5"></a><p>[<abbr class="abbrev">RFC3491</abbr>]
+<a name="idp76886608"></a><p>[<abbr class="abbrev">RFC3491</abbr>]
<span class="authorgroup"><span class="firstname">P.</span> <span class="surname">Hoffman</span> and <span class="firstname">M.</span> <span class="surname">Blanchet</span>. </span>
<span class="citetitle"><em class="citetitle">Nameprep: A Stringprep Profile for Internationalized Domain Names</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.8.6"></a><p>[<abbr class="abbrev">RFC3492</abbr>]
+<a name="idp76890320"></a><p>[<abbr class="abbrev">RFC3492</abbr>]
<span class="authorgroup"><span class="firstname">A.</span> <span class="surname">Costello</span>. </span>
<span class="citetitle"><em class="citetitle">Punycode: A Bootstring encoding of Unicode
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="Other DNS-related RFCs">
<h3 class="title">
-<a name="id-1.12.4.3.7.9"></a>Other <acronym class="acronym">DNS</acronym>-related RFCs</h3>
+<a name="idp76893392"></a>Other <acronym class="acronym">DNS</acronym>-related RFCs</h3>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Note: the following list of RFCs, although
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.9.4"></a><p>[<abbr class="abbrev">RFC1464</abbr>]
+<a name="idp76896208"></a><p>[<abbr class="abbrev">RFC1464</abbr>]
<span class="author"><span class="firstname">R.</span> <span class="surname">Rosenbaum</span>. </span>
<span class="citetitle"><em class="citetitle">Using the Domain Name System To Store Arbitrary String
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.9.5"></a><p>[<abbr class="abbrev">RFC1713</abbr>]
+<a name="idp76898640"></a><p>[<abbr class="abbrev">RFC1713</abbr>]
<span class="author"><span class="firstname">A.</span> <span class="surname">Romao</span>. </span>
<span class="citetitle"><em class="citetitle">Tools for <acronym class="acronym">DNS</acronym> Debugging</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.9.6"></a><p>[<abbr class="abbrev">RFC1794</abbr>]
+<a name="idp76901584"></a><p>[<abbr class="abbrev">RFC1794</abbr>]
<span class="author"><span class="firstname">T.</span> <span class="surname">Brisco</span>. </span>
<span class="citetitle"><em class="citetitle"><acronym class="acronym">DNS</acronym> Support for Load
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.9.7"></a><p>[<abbr class="abbrev">RFC2240</abbr>]
+<a name="idp76904272"></a><p>[<abbr class="abbrev">RFC2240</abbr>]
<span class="author"><span class="firstname">O.</span> <span class="surname">Vaughan</span>. </span>
<span class="citetitle"><em class="citetitle">A Legal Basis for Domain Name Allocation</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.9.8"></a><p>[<abbr class="abbrev">RFC2345</abbr>]
+<a name="idp76906704"></a><p>[<abbr class="abbrev">RFC2345</abbr>]
<span class="authorgroup"><span class="firstname">J.</span> <span class="surname">Klensin</span>, <span class="firstname">T.</span> <span class="surname">Wolf</span>, and <span class="firstname">G.</span> <span class="surname">Oglesby</span>. </span>
<span class="citetitle"><em class="citetitle">Domain Names and Company Name Retrieval</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.9.9"></a><p>[<abbr class="abbrev">RFC2352</abbr>]
+<a name="idp76911440"></a><p>[<abbr class="abbrev">RFC2352</abbr>]
<span class="author"><span class="firstname">O.</span> <span class="surname">Vaughan</span>. </span>
<span class="citetitle"><em class="citetitle">A Convention For Using Legal Names as Domain Names</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.9.10"></a><p>[<abbr class="abbrev">RFC3071</abbr>]
+<a name="idp76913872"></a><p>[<abbr class="abbrev">RFC3071</abbr>]
<span class="authorgroup"><span class="firstname">J.</span> <span class="surname">Klensin</span>. </span>
<span class="citetitle"><em class="citetitle">Reflections on the DNS, RFC 1591, and Categories of Domains</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.9.11"></a><p>[<abbr class="abbrev">RFC3258</abbr>]
+<a name="idp76916816"></a><p>[<abbr class="abbrev">RFC3258</abbr>]
<span class="authorgroup"><span class="firstname">T.</span> <span class="surname">Hardie</span>. </span>
<span class="citetitle"><em class="citetitle">Distributing Authoritative Name Servers via
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.9.12"></a><p>[<abbr class="abbrev">RFC3901</abbr>]
+<a name="idp76919632"></a><p>[<abbr class="abbrev">RFC3901</abbr>]
<span class="authorgroup"><span class="firstname">A.</span> <span class="surname">Durand</span> and <span class="firstname">J.</span> <span class="surname">Ihren</span>. </span>
<span class="citetitle"><em class="citetitle">DNS IPv6 Transport Operational Guidelines</em>. </span>
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="Obsolete and Unimplemented Experimental RFC">
<h3 class="title">
-<a name="id-1.12.4.3.7.10"></a>Obsolete and Unimplemented Experimental RFC</h3>
+<a name="idp76923600"></a>Obsolete and Unimplemented Experimental RFC</h3>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.10.3"></a><p>[<abbr class="abbrev">RFC1712</abbr>]
+<a name="idp76924496"></a><p>[<abbr class="abbrev">RFC1712</abbr>]
<span class="authorgroup"><span class="firstname">C.</span> <span class="surname">Farrell</span>, <span class="firstname">M.</span> <span class="surname">Schulze</span>, <span class="firstname">S.</span> <span class="surname">Pleitner</span>, and <span class="firstname">D.</span> <span class="surname">Baldoni</span>. </span>
<span class="citetitle"><em class="citetitle"><acronym class="acronym">DNS</acronym> Encoding of Geographical
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.10.4"></a><p>[<abbr class="abbrev">RFC2673</abbr>]
+<a name="idp76930256"></a><p>[<abbr class="abbrev">RFC2673</abbr>]
<span class="authorgroup"><span class="firstname">M.</span> <span class="surname">Crawford</span>. </span>
<span class="citetitle"><em class="citetitle">Binary Labels in the Domain Name System</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.10.5"></a><p>[<abbr class="abbrev">RFC2874</abbr>]
+<a name="idp76933200"></a><p>[<abbr class="abbrev">RFC2874</abbr>]
<span class="authorgroup"><span class="firstname">M.</span> <span class="surname">Crawford</span> and <span class="firstname">C.</span> <span class="surname">Huitema</span>. </span>
<span class="citetitle"><em class="citetitle">DNS Extensions to Support IPv6 Address Aggregation
</p>
</div>
</div>
- <div class="bibliodiv">
+ <div class="bibliodiv" title="Obsoleted DNS Security RFCs">
<h3 class="title">
-<a name="id-1.12.4.3.7.11"></a>Obsoleted DNS Security RFCs</h3>
+<a name="idp76937040"></a>Obsoleted DNS Security RFCs</h3>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Most of these have been consolidated into RFC4033,
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.4"></a><p>[<abbr class="abbrev">RFC2065</abbr>]
+<a name="idp76938704"></a><p>[<abbr class="abbrev">RFC2065</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span> and <span class="firstname">C.</span> <span class="surname">Kaufman</span>. </span>
<span class="citetitle"><em class="citetitle">Domain Name System Security Extensions</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.5"></a><p>[<abbr class="abbrev">RFC2137</abbr>]
+<a name="idp76942800"></a><p>[<abbr class="abbrev">RFC2137</abbr>]
<span class="author"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>. </span>
<span class="citetitle"><em class="citetitle">Secure Domain Name System Dynamic Update</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.6"></a><p>[<abbr class="abbrev">RFC2535</abbr>]
+<a name="idp76945488"></a><p>[<abbr class="abbrev">RFC2535</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Eastlake</span>, <span class="lineage">3rd</span>. </span>
<span class="citetitle"><em class="citetitle">Domain Name System Security Extensions</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.7"></a><p>[<abbr class="abbrev">RFC3008</abbr>]
+<a name="idp76952784"></a><p>[<abbr class="abbrev">RFC3008</abbr>]
<span class="authorgroup"><span class="firstname">B.</span> <span class="surname">Wellington</span>. </span>
<span class="citetitle"><em class="citetitle">Domain Name System Security (DNSSEC)
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.8"></a><p>[<abbr class="abbrev">RFC3090</abbr>]
+<a name="idp76955600"></a><p>[<abbr class="abbrev">RFC3090</abbr>]
<span class="authorgroup"><span class="firstname">E.</span> <span class="surname">Lewis</span>. </span>
<span class="citetitle"><em class="citetitle">DNS Security Extension Clarification on Zone Status</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.9"></a><p>[<abbr class="abbrev">RFC3445</abbr>]
+<a name="idp76958416"></a><p>[<abbr class="abbrev">RFC3445</abbr>]
<span class="authorgroup"><span class="firstname">D.</span> <span class="surname">Massey</span> and <span class="firstname">S.</span> <span class="surname">Rose</span>. </span>
<span class="citetitle"><em class="citetitle">Limiting the Scope of the KEY Resource Record (RR)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.10"></a><p>[<abbr class="abbrev">RFC3655</abbr>]
+<a name="idp76966352"></a><p>[<abbr class="abbrev">RFC3655</abbr>]
<span class="authorgroup"><span class="firstname">B.</span> <span class="surname">Wellington</span> and <span class="firstname">O.</span> <span class="surname">Gudmundsson</span>. </span>
<span class="citetitle"><em class="citetitle">Redefinition of DNS Authenticated Data (AD) bit</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.11"></a><p>[<abbr class="abbrev">RFC3658</abbr>]
+<a name="idp76970064"></a><p>[<abbr class="abbrev">RFC3658</abbr>]
<span class="authorgroup"><span class="firstname">O.</span> <span class="surname">Gudmundsson</span>. </span>
<span class="citetitle"><em class="citetitle">Delegation Signer (DS) Resource Record (RR)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.12"></a><p>[<abbr class="abbrev">RFC3755</abbr>]
+<a name="idp76973008"></a><p>[<abbr class="abbrev">RFC3755</abbr>]
<span class="authorgroup"><span class="firstname">S.</span> <span class="surname">Weiler</span>. </span>
<span class="citetitle"><em class="citetitle">Legacy Resolver Compatibility for Delegation Signer (DS)</em>. </span>
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.13"></a><p>[<abbr class="abbrev">RFC3757</abbr>]
+<a name="idp76975824"></a><p>[<abbr class="abbrev">RFC3757</abbr>]
<span class="authorgroup"><span class="firstname">O.</span> <span class="surname">Kolkman</span>, <span class="firstname">J.</span> <span class="surname">Schlyter</span>, and <span class="firstname">E.</span> <span class="surname">Lewis</span>. </span>
<span class="citetitle"><em class="citetitle">Domain Name System KEY (DNSKEY) Resource Record
</p>
</div>
<div class="biblioentry">
-<a name="id-1.12.4.3.7.11.14"></a><p>[<abbr class="abbrev">RFC3845</abbr>]
+<a name="idp76980432"></a><p>[<abbr class="abbrev">RFC3845</abbr>]
<span class="authorgroup"><span class="firstname">J.</span> <span class="surname">Schlyter</span>. </span>
<span class="citetitle"><em class="citetitle">DNS Security (DNSSEC) NextSECure (NSEC) RDATA Format</em>. </span>
</div>
</div>
</div>
- <div class="section">
+ <div class="section" title="Internet Drafts">
<div class="titlepage"><div><div><h3 class="title">
<a name="internet_drafts"></a>Internet Drafts</h3></div></div></div>
after which they are deleted unless updated by their authors.
</p>
</div>
- <div class="section">
+ <div class="section" title="Other Documents About BIND">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.12.4.5"></a>Other Documents About <acronym class="acronym">BIND</acronym>
+<a name="idp76985296"></a>Other Documents About <acronym class="acronym">BIND</acronym>
</h3></div></div></div>
<p></p>
- <div class="bibliography">
+ <div class="bibliography" title="Bibliography">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.12.4.5.4"></a>Bibliography</h4></div></div></div>
+<a name="idp76986960"></a>Bibliography</h4></div></div></div>
<div class="biblioentry">
-<a name="id-1.12.4.5.4.1"></a><p>
+<a name="idp76987216"></a><p>
<span class="authorgroup"><span class="firstname">Paul</span> <span class="surname">Albitz</span> and <span class="firstname">Cricket</span> <span class="surname">Liu</span>. </span>
<span class="citetitle"><em class="citetitle"><acronym class="acronym">DNS</acronym> and <acronym class="acronym">BIND</acronym></em>. </span>
<span class="copyright">Copyright © 1998 Sebastopol, CA: O'Reilly and Associates. </span>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Appendix D. BIND 9 DNS Library Support</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch11.html" title="Appendix C. General DNS Reference Information">
</table>
<hr>
</div>
-<div class="appendix">
-<div class="titlepage"><div><div><h1 class="title">
-<a name="Bv9ARM.ch12"></a>Appendix D. BIND 9 DNS Library Support</h1></div></div></div>
+<div class="appendix" title="Appendix D. BIND 9 DNS Library Support">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Bv9ARM.ch12"></a>Appendix D. BIND 9 DNS Library Support</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
+<dl>
<dt><span class="section"><a href="Bv9ARM.ch12.html#bind9.library">BIND 9 DNS Library Support</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.5">Prerequisite</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.6">Compilation</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.7">Installation</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.8">Known Defects/Restrictions</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.9">The dns.conf File</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.10">Sample Applications</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.11">Library References</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77002448">Prerequisite</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77003856">Compilation</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77007056">Installation</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77010896">Known Defects/Restrictions</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77032656">The dns.conf File</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77035984">Sample Applications</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77096144">Library References</a></span></dt>
</dl></dd>
</dl>
</div>
- <div class="section">
+ <div class="section" title="BIND 9 DNS Library Support">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="bind9.library"></a>BIND 9 DNS Library Support</h2></div></div></div>
call them "export" libraries in this document). In addition to
all major DNS-related APIs BIND 9 is currently using, the export
libraries provide the following features:</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>The newly created "DNS client" module. This is a higher
level API that provides an interface to name resolution,
libraries than BIND 9's internal event task system.</p>
</li>
</ul></div>
- <div class="section">
+ <div class="section" title="Prerequisite">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.13.3.5"></a>Prerequisite</h3></div></div></div>
+<a name="idp77002448"></a>Prerequisite</h3></div></div></div>
<p>GNU make is required to build the export libraries (other
part of BIND 9 can still be built with other types of make). In
in some platforms you may need to invoke a different command name
than "make" (e.g. "gmake") to indicate it's GNU make.</p>
</div>
- <div class="section">
+ <div class="section" title="Compilation">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.13.3.6"></a>Compilation</h3></div></div></div>
+<a name="idp77003856"></a>Compilation</h3></div></div></div>
<pre class="screen">
$ <strong class="userinput"><code>./configure --enable-exportlib <em class="replaceable"><code>[other flags]</code></em></code></strong>
programs using the libraries will also be built under the
lib/export/samples directory (see below).</p>
</div>
- <div class="section">
+ <div class="section" title="Installation">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.13.3.7"></a>Installation</h3></div></div></div>
+<a name="idp77007056"></a>Installation</h3></div></div></div>
<pre class="screen">
$ <strong class="userinput"><code>cd lib/export</code></strong>
application after the installation, see
<code class="filename">lib/export/samples/Makefile-postinstall.in</code>.</p>
</div>
- <div class="section">
+ <div class="section" title="Known Defects/Restrictions">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.13.3.8"></a>Known Defects/Restrictions</h3></div></div></div>
+<a name="idp77010896"></a>Known Defects/Restrictions</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>Currently, win32 is not supported for the export
</li>
</ul></div>
</div>
- <div class="section">
+ <div class="section" title="The dns.conf File">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.13.3.9"></a>The dns.conf File</h3></div></div></div>
+<a name="idp77032656"></a>The dns.conf File</h3></div></div></div>
<p>The IRS library supports an "advanced" configuration file
related to the DNS library for configuration parameters that
of statement for <code class="filename">named.conf</code>. (See
<a class="xref" href="Bv9ARM.ch06.html#trusted-keys" title="trusted-keys Statement Grammar">the section called “<span class="command"><strong>trusted-keys</strong></span> Statement Grammar”</a> for details.)</p>
</div>
- <div class="section">
+ <div class="section" title="Sample Applications">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.13.3.10"></a>Sample Applications</h3></div></div></div>
+<a name="idp77035984"></a>Sample Applications</h3></div></div></div>
<p>Some sample application programs using this API are
provided for reference. The following is a brief description of
these applications.
</p>
- <div class="section">
+ <div class="section" title="sample: a simple stub resolver utility">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.13.3.10.4"></a>sample: a simple stub resolver utility</h4></div></div></div>
+<a name="idp77037264"></a>sample: a simple stub resolver utility</h4></div></div></div>
<p>
It sends a query of a given name (of a given optional RR type) to a
<p>
Options and Arguments:
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">
-t RRtype
</span></dt>
</p></dd>
</dl></div>
</div>
- <div class="section">
+ <div class="section" title="sample-async: a simple stub resolver, working asynchronously">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.13.3.10.5"></a>sample-async: a simple stub resolver, working asynchronously</h4></div></div></div>
+<a name="idp77047888"></a>sample-async: a simple stub resolver, working asynchronously</h4></div></div></div>
<p>
Similar to "sample", but accepts a list
<p>
Options and Arguments:
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">
-s server_address
</span></dt>
</dd>
</dl></div>
</div>
- <div class="section">
+ <div class="section" title="sample-request: a simple DNS transaction client">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.13.3.10.6"></a>sample-request: a simple DNS transaction client</h4></div></div></div>
+<a name="idp77054288"></a>sample-request: a simple DNS transaction client</h4></div></div></div>
<p>
It sends a query to a specified server, and
<p>
Options and Arguments:
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">
-t RRtype
</span></dt>
</dd>
</dl></div>
</div>
- <div class="section">
+ <div class="section" title="sample-gai: getaddrinfo() and getnameinfo() test code">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.13.3.10.7"></a>sample-gai: getaddrinfo() and getnameinfo() test code</h4></div></div></div>
+<a name="idp77066064"></a>sample-gai: getaddrinfo() and getnameinfo() test code</h4></div></div></div>
<p>
This is a test program
Usage: sample-gai hostname
</p>
</div>
- <div class="section">
+ <div class="section" title="sample-update: a simple dynamic update client program">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.13.3.10.8"></a>sample-update: a simple dynamic update client program</h4></div></div></div>
+<a name="idp77072080"></a>sample-update: a simple dynamic update client program</h4></div></div></div>
<p>
It accepts a single update command as a
<p>
Options and Arguments:
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">
-a auth_server
</span></dt>
</p></dd>
</dl></div>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>In practice, either -a or -r must be specified. Others can
be optional; the underlying library routine tries to identify the
appropriate server and the zone name for the update.</div>
removes all RRs for foo.dynamic.example.com using the given key.
</p>
</div>
- <div class="section">
+ <div class="section" title="nsprobe: domain/name server checker in terms of RFC 4074">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id-1.13.3.10.9"></a>nsprobe: domain/name server checker in terms of RFC 4074</h4></div></div></div>
+<a name="idp77088208"></a>nsprobe: domain/name server checker in terms of RFC 4074</h4></div></div></div>
<p>
It checks a set
Options
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">
-d
</span></dt>
</dl></div>
</div>
</div>
- <div class="section">
+ <div class="section" title="Library References">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id-1.13.3.11"></a>Library References</h3></div></div></div>
+<a name="idp77096144"></a>Library References</h3></div></div></div>
<p>As of this writing, there is no formal "manual" of the
libraries, except this document, header files (some of them
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Manual pages</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch12.html" title="Appendix D. BIND 9 DNS Library Support">
</table>
<hr>
</div>
-<div class="reference">
+<div class="reference" title="Manual pages">
<div class="titlepage">
<div><div><h1 class="title">
<a name="Bv9ARM.ch13"></a>Manual pages</h1></div></div>
</div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
+<dl>
<dt>
<span class="refentrytitle"><a href="man.dig.html">dig</a></span><span class="refpurpose"> — DNS lookup utility</span>
</dt>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>BIND 9 Administrator Reference Manual</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="next" href="Bv9ARM.ch01.html" title="Chapter 1. Introduction">
</head>
</table>
<hr>
</div>
-<div class="book">
+<div class="book" title="BIND 9 Administrator Reference Manual">
<div class="titlepage">
<div>
<div><h1 class="title">
-<a name="id-1"></a>BIND 9 Administrator Reference Manual</h1></div>
+<a name="idp71619792"></a>BIND 9 Administrator Reference Manual</h1></div>
<div><p class="releaseinfo">BIND Version 9.11.0pre-alpha</p></div>
<div><p class="copyright">Copyright © 2004-2015 Internet Systems Consortium, Inc. ("ISC")</p></div>
<div><p class="copyright">Copyright © 2000-2003 Internet Software Consortium.</p></div>
</div>
<div class="toc">
<p><b>Table of Contents</b></p>
-<dl class="toc">
+<dl>
<dt><span class="chapter"><a href="Bv9ARM.ch01.html">1. Introduction</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.4">Scope of Document</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.5">Organization of This Document</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.6">Conventions Used in This Document</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7">The Domain Name System (<acronym class="acronym">DNS</acronym>)</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71663696">Scope of Document</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71666384">Organization of This Document</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71674448">Conventions Used in This Document</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71718608">The Domain Name System (<acronym class="acronym">DNS</acronym>)</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.4">DNS Fundamentals</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.5">Domains and Domain Names</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.6">Zones</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.7">Authoritative Name Servers</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.8">Caching Name Servers</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch01.html#id-1.2.7.9">Name Servers in Multiple Roles</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71721808">DNS Fundamentals</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71725904">Domains and Domain Names</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71735504">Zones</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71744720">Authoritative Name Servers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71765968">Caching Name Servers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch01.html#idp71773776">Name Servers in Multiple Roles</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="Bv9ARM.ch02.html">2. <acronym class="acronym">BIND</acronym> Resource Requirements</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.3">Hardware requirements</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.4">CPU Requirements</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.5">Memory Requirements</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.6">Name Server Intensive Environment Issues</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch02.html#id-1.3.7">Supported Operating Systems</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71778640">Hardware requirements</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71781968">CPU Requirements</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71783888">Memory Requirements</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71787344">Name Server Intensive Environment Issues</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch02.html#idp71788752">Supported Operating Systems</a></span></dt>
</dl></dd>
<dt><span class="chapter"><a href="Bv9ARM.ch03.html">3. Name Server Configuration</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch03.html#sample_configuration">Sample Configurations</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.4.3">A Caching-only Name Server</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.4.4">An Authoritative-only Name Server</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71793232">A Caching-only Name Server</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71795408">An Authoritative-only Name Server</a></span></dt>
</dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.5">Load Balancing</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.6">Name Server Operations</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71798224">Load Balancing</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71842384">Name Server Operations</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.6.3">Tools for Use With the Name Server Daemon</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch03.html#id-1.4.6.4">Signals</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71843280">Tools for Use With the Name Server Daemon</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch03.html#idp71949264">Signals</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="Bv9ARM.ch04.html">4. Advanced DNS Features</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch04.html#dynamic_update">Dynamic Update</a></span></dt>
<dd><dl><dt><span class="section"><a href="Bv9ARM.ch04.html#journal">The journal file</a></span></dt></dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#incremental_zone_transfers">Incremental Zone Transfers (IXFR)</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.6">Split DNS</a></span></dt>
-<dd><dl><dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.6.6">Example split DNS setup</a></span></dt></dl></dd>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72035152">Split DNS</a></span></dt>
+<dd><dl><dt><span class="section"><a href="Bv9ARM.ch04.html#idp72037712">Example split DNS setup</a></span></dt></dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#tsig">TSIG</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.6">Generate Shared Keys for Each Pair of Hosts</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.7">Copying the Shared Secret to Both Machines</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.8">Informing the Servers of the Key's Existence</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.9">Instructing the Server to Use the Key</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.10">TSIG Key Based Access Control</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.7.11">Errors</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72096464">Generate Shared Keys for Each Pair of Hosts</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72105552">Copying the Shared Secret to Both Machines</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72106960">Informing the Servers of the Key's Existence</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72115920">Instructing the Server to Use the Key</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72122448">TSIG Key Based Access Control</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72128336">Errors</a></span></dt>
</dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.8">TKEY</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.9">SIG(0)</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72130256">TKEY</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72136400">SIG(0)</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch04.html#DNSSEC">DNSSEC</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.10.7">Generating Keys</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.10.8">Signing the Zone</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.10.9">Configuring Servers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72144720">Generating Keys</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72154192">Signing the Zone</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72167504">Configuring Servers</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#dnssec.dynamic.zones">DNSSEC, Dynamic Zones, and Automatic Signing</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.4">Converting from insecure to secure</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.9">Dynamic DNS update method</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.17">Fully automatic zone signing</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.26">Private-type records</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.33">DNSKEY rollovers</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.35">Dynamic DNS update method</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.40">Automatic key rollovers</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.42">NSEC3PARAM rollovers via UPDATE</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.44">Converting from NSEC to NSEC3</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.46">Converting from NSEC3 to NSEC</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.48">Converting from secure to insecure</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.52">Periodic re-signing</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.11.54">NSEC3 and OPTOUT</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72186448">Converting from insecure to secure</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72190928">Dynamic DNS update method</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72195536">Fully automatic zone signing</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72208080">Private-type records</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72212944">DNSKEY rollovers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72214864">Dynamic DNS update method</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72219088">Automatic key rollovers</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72222416">NSEC3PARAM rollovers via UPDATE</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72223824">Converting from NSEC to NSEC3</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72225360">Converting from NSEC3 to NSEC</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72227152">Converting from secure to insecure</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72231760">Periodic re-signing</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72233680">NSEC3 and OPTOUT</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#rfc5011.support">Dynamic Trust Anchor Management</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.12.4">Validating Resolver</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.12.5">Authoritative Server</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72238672">Validating Resolver</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72241488">Authoritative Server</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#pkcs11">PKCS#11 (Cryptoki) support</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.7">Prerequisites</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.8">Native PKCS#11</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.9">OpenSSL-based PKCS#11</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.10">PKCS#11 Tools</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.11">Using the HSM</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.12">Specifying the engine on the command line</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.13.13">Running named with automatic zone re-signing</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72254672">Prerequisites</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72256080">Native PKCS#11</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72273744">OpenSSL-based PKCS#11</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72340560">PKCS#11 Tools</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72343888">Using the HSM</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72378192">Specifying the engine on the command line</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72382800">Running named with automatic zone re-signing</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#dlz-info">DLZ (Dynamically Loadable Zones)</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.14.7">Configuring DLZ</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.14.8">Sample DLZ Driver</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72395472">Configuring DLZ</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72403920">Sample DLZ Driver</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch04.html#dyndb-info">DynDB (Dynamic Database)</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.15.6">Configuring DynDB</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.15.7">Sample DynDB Module</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72421456">Configuring DynDB</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72426448">Sample DynDB Module</a></span></dt>
</dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.16">IPv6 Support in <acronym class="acronym">BIND</acronym> 9</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72430416">IPv6 Support in <acronym class="acronym">BIND</acronym> 9</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.16.7">Address Lookups Using AAAA Records</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch04.html#id-1.5.16.8">Address to Name Lookups Using Nibble Format</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72437840">Address Lookups Using AAAA Records</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch04.html#idp72440528">Address to Name Lookups Using Nibble Format</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="Bv9ARM.ch05.html">5. The <acronym class="acronym">BIND</acronym> 9 Lightweight Resolver</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch05.html#id-1.6.3">The Lightweight Resolver Library</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch05.html#idp72445136">The Lightweight Resolver Library</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch05.html#lwresd">Running a Resolver Daemon</a></span></dt>
</dl></dd>
<dt><span class="chapter"><a href="Bv9ARM.ch06.html">6. <acronym class="acronym">BIND</acronym> 9 Configuration Reference</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#configuration_file_elements">Configuration File Elements</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch06.html#address_match_lists">Address Match Lists</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.5.6">Comment Syntax</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72601040">Comment Syntax</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch06.html#Configuration_File_Grammar">Configuration File Grammar</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.7"><span class="command"><strong>acl</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72658128"><span class="command"><strong>acl</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#acl"><span class="command"><strong>acl</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.9"><span class="command"><strong>controls</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72690384"><span class="command"><strong>controls</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#controls_statement_definition_and_usage"><span class="command"><strong>controls</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.11"><span class="command"><strong>include</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.12"><span class="command"><strong>include</strong></span> Statement Definition and
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72740688"><span class="command"><strong>include</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72747472"><span class="command"><strong>include</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.13"><span class="command"><strong>key</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.14"><span class="command"><strong>key</strong></span> Statement Definition and Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.15"><span class="command"><strong>logging</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.16"><span class="command"><strong>logging</strong></span> Statement Definition and
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72750544"><span class="command"><strong>key</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72754000"><span class="command"><strong>key</strong></span> Statement Definition and Usage</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72765136"><span class="command"><strong>logging</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp72782160"><span class="command"><strong>logging</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.17"><span class="command"><strong>lwres</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.18"><span class="command"><strong>lwres</strong></span> Statement Definition and Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.19"><span class="command"><strong>masters</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.20"><span class="command"><strong>masters</strong></span> Statement Definition and
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73052752"><span class="command"><strong>lwres</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73065040"><span class="command"><strong>lwres</strong></span> Statement Definition and Usage</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73076816"><span class="command"><strong>masters</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73083344"><span class="command"><strong>masters</strong></span> Statement Definition and
Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.21"><span class="command"><strong>options</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp73086416"><span class="command"><strong>options</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#options"><span class="command"><strong>options</strong></span> Statement Definition and
Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#server_statement_grammar"><span class="command"><strong>server</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#server_statement_definition_and_usage"><span class="command"><strong>server</strong></span> Statement Definition and
Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#statschannels"><span class="command"><strong>statistics-channels</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.26"><span class="command"><strong>statistics-channels</strong></span> Statement Definition and
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74653264"><span class="command"><strong>statistics-channels</strong></span> Statement Definition and
Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#trusted-keys"><span class="command"><strong>trusted-keys</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.28"><span class="command"><strong>trusted-keys</strong></span> Statement Definition
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74702544"><span class="command"><strong>trusted-keys</strong></span> Statement Definition
and Usage</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.29"><span class="command"><strong>managed-keys</strong></span> Statement Grammar</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74713424"><span class="command"><strong>managed-keys</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#managed-keys"><span class="command"><strong>managed-keys</strong></span> Statement Definition
and Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#view_statement_grammar"><span class="command"><strong>view</strong></span> Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.32"><span class="command"><strong>view</strong></span> Statement Definition and Usage</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74750160"><span class="command"><strong>view</strong></span> Statement Definition and Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#zone_statement_grammar"><span class="command"><strong>zone</strong></span>
Statement Grammar</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.6.34"><span class="command"><strong>zone</strong></span> Statement Definition and Usage</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp74976080"><span class="command"><strong>zone</strong></span> Statement Definition and Usage</a></span></dt>
</dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7">Zone File</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75353680">Zone File</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch06.html#types_of_resource_records_and_when_to_use_them">Types of Resource Records and When to Use Them</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7.4">Discussion of MX Records</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75721424">Discussion of MX Records</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#Setting_TTLs">Setting TTLs</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7.6">Inverse Mapping in IPv4</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7.7">Other Zone File Directives</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch06.html#id-1.7.7.8"><acronym class="acronym">BIND</acronym> Master File Extension: the <span class="command"><strong>$GENERATE</strong></span> Directive</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75794256">Inverse Mapping in IPv4</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75807568">Other Zone File Directives</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch06.html#idp75833808"><acronym class="acronym">BIND</acronym> Master File Extension: the <span class="command"><strong>$GENERATE</strong></span> Directive</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#zonefile_format">Additional File Formats</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch06.html#statistics">BIND9 Statistics</a></span></dt>
<dt><span class="chapter"><a href="Bv9ARM.ch07.html">7. <acronym class="acronym">BIND</acronym> 9 Security Considerations</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch07.html#Access_Control_Lists">Access Control Lists</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch07.html#id-1.8.4"><span class="command"><strong>Chroot</strong></span> and <span class="command"><strong>Setuid</strong></span></a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch07.html#idp76415824"><span class="command"><strong>Chroot</strong></span> and <span class="command"><strong>Setuid</strong></span></a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch07.html#id-1.8.4.7">The <span class="command"><strong>chroot</strong></span> Environment</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch07.html#id-1.8.4.8">Using the <span class="command"><strong>setuid</strong></span> Function</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch07.html#idp76425552">The <span class="command"><strong>chroot</strong></span> Environment</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch07.html#idp76433360">Using the <span class="command"><strong>setuid</strong></span> Function</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch07.html#dynamic_update_security">Dynamic Update Security</a></span></dt>
</dl></dd>
<dt><span class="chapter"><a href="Bv9ARM.ch08.html">8. Troubleshooting</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch08.html#id-1.9.3">Common Problems</a></span></dt>
-<dd><dl><dt><span class="section"><a href="Bv9ARM.ch08.html#id-1.9.3.3">It's not working; how can I figure out what's wrong?</a></span></dt></dl></dd>
-<dt><span class="section"><a href="Bv9ARM.ch08.html#id-1.9.4">Incrementing and Changing the Serial Number</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch08.html#id-1.9.5">Where Can I Get Help?</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch08.html#idp76443600">Common Problems</a></span></dt>
+<dd><dl><dt><span class="section"><a href="Bv9ARM.ch08.html#idp76444624">It's not working; how can I figure out what's wrong?</a></span></dt></dl></dd>
+<dt><span class="section"><a href="Bv9ARM.ch08.html#idp76446160">Incrementing and Changing the Serial Number</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch08.html#idp76448336">Where Can I Get Help?</a></span></dt>
</dl></dd>
<dt><span class="appendix"><a href="Bv9ARM.ch09.html">A. Release Notes</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch09.html#id-1.10.3">Release Notes for BIND Version 9.11.0pre-alpha</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch09.html#idp76455504">Release Notes for BIND Version 9.11.0pre-alpha</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch09.html#relnotes_intro">Introduction</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch09.html#relnotes_download">Download</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch11.html#rfcs">Request for Comments (RFCs)</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch11.html#internet_drafts">Internet Drafts</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch11.html#id-1.12.4.5">Other Documents About <acronym class="acronym">BIND</acronym></a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch11.html#idp76985296">Other Documents About <acronym class="acronym">BIND</acronym></a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="appendix"><a href="Bv9ARM.ch12.html">D. BIND 9 DNS Library Support</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch12.html#bind9.library">BIND 9 DNS Library Support</a></span></dt>
<dd><dl>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.5">Prerequisite</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.6">Compilation</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.7">Installation</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.8">Known Defects/Restrictions</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.9">The dns.conf File</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.10">Sample Applications</a></span></dt>
-<dt><span class="section"><a href="Bv9ARM.ch12.html#id-1.13.3.11">Library References</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77002448">Prerequisite</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77003856">Compilation</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77007056">Installation</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77010896">Known Defects/Restrictions</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77032656">The dns.conf File</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77035984">Sample Applications</a></span></dt>
+<dt><span class="section"><a href="Bv9ARM.ch12.html#idp77096144">Library References</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="reference"><a href="Bv9ARM.ch13.html">I. Manual pages</a></span></dt>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="dlz-info"><info><title>DLZ (Dynamically Loadable Zones)</title></info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="dnssec.dynamic.zones"><info><title>DNSSEC, Dynamic Zones, and Automatic Signing</title></info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="dyndb-info"><info><title>DynDB (Dynamic Database)</title></info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="bind9.library"><info><title>BIND 9 DNS Library Support</title></info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<informaltable xmlns="http://docbook.org/ns/docbook" version="5.0" colsep="0" rowsep="0">
<tgroup cols="2" colsep="0" rowsep="0" tgroupstyle="4Level-table">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>arpaname</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.ddns-confgen.html" title="ddns-confgen">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="arpaname">
<a name="man.arpaname"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">arpaname</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.27.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp80253904"></a><h2>DESCRIPTION</h2>
<p>
<span class="command"><strong>arpaname</strong></span> translates IP addresses (IPv4 and
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.27.8"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp80255696"></a><h2>SEE ALSO</h2>
<p>
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>ddns-confgen</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="ddns-confgen">
<a name="man.ddns-confgen"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">tsig-keygen</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.26.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp80195280"></a><h2>DESCRIPTION</h2>
<p>
<span class="command"><strong>tsig-keygen</strong></span> and <span class="command"><strong>ddns-confgen</strong></span>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.26.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp80207824"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.26.9"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp80234960"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">nsupdate</span>(1)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>delv</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.host.html" title="host">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="delv">
<a name="man.delv"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">delv</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.4.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp77546192"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>delv</strong></span>
(Domain Entity Lookup & Validation) is a tool for sending
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.4.8"></a><h2>SIMPLE USAGE</h2>
+ <div class="refsection" title="SIMPLE USAGE">
+<a name="idp77556688"></a><h2>SIMPLE USAGE</h2>
<p>
where:
</p>
-<div class="variablelist"><dl class="variablelist">
+<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">server</code></span></dt>
<dd>
<p>
</div>
- <div class="refsection">
-<a name="id-1.14.4.9"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp77573456"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>anchor-file</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.4.10"></a><h2>QUERY OPTIONS</h2>
+ <div class="refsection" title="QUERY OPTIONS">
+<a name="idp77636304"></a><h2>QUERY OPTIONS</h2>
<p><span class="command"><strong>delv</strong></span>
The query options are:
</p>
-<div class="variablelist"><dl class="variablelist">
+<div class="variablelist"><dl>
<dt><span class="term"><code class="option">+[no]cdflag</code></span></dt>
<dd>
<p>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.4.11"></a><h2>FILES</h2>
+ <div class="refsection" title="FILES">
+<a name="idp77680720"></a><h2>FILES</h2>
<p><code class="filename">/etc/bind.keys</code></p>
<p><code class="filename">/etc/resolv.conf</code></p>
</div>
- <div class="refsection">
-<a name="id-1.14.4.12"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp77682768"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dig</span>(1)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dig</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="Bv9ARM.ch13.html" title="Manual pages">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dig">
<a name="man.dig"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dig</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.2.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp77122512"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dig</strong></span>
(domain information groper) is a flexible tool
</div>
- <div class="refsection">
-<a name="id-1.14.2.8"></a><h2>SIMPLE USAGE</h2>
+ <div class="refsection" title="SIMPLE USAGE">
+<a name="idp77131600"></a><h2>SIMPLE USAGE</h2>
<p>
where:
</p>
-<div class="variablelist"><dl class="variablelist">
+<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">server</code></span></dt>
<dd>
<p>
</div>
- <div class="refsection">
-<a name="id-1.14.2.9"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp77144016"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-4</span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.2.10"></a><h2>QUERY OPTIONS</h2>
+ <div class="refsection" title="QUERY OPTIONS">
+<a name="idp77196624"></a><h2>QUERY OPTIONS</h2>
<p><span class="command"><strong>dig</strong></span>
The query options are:
</p>
-<div class="variablelist"><dl class="variablelist">
+<div class="variablelist"><dl>
<dt><span class="term"><code class="option">+[no]aaflag</code></span></dt>
<dd>
<p>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.2.11"></a><h2>MULTIPLE QUERIES</h2>
+ <div class="refsection" title="MULTIPLE QUERIES">
+<a name="idp77372752"></a><h2>MULTIPLE QUERIES</h2>
<p>
</div>
- <div class="refsection">
-<a name="id-1.14.2.12"></a><h2>IDN SUPPORT</h2>
+ <div class="refsection" title="IDN SUPPORT">
+<a name="idp77380176"></a><h2>IDN SUPPORT</h2>
<p>
If <span class="command"><strong>dig</strong></span> has been built with IDN (internationalized
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.2.13"></a><h2>FILES</h2>
+ <div class="refsection" title="FILES">
+<a name="idp77383248"></a><h2>FILES</h2>
<p><code class="filename">/etc/resolv.conf</code>
</p>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.2.14"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp77385552"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">host</span>(1)
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.2.15"></a><h2>BUGS</h2>
+ <div class="refsection" title="BUGS">
+<a name="idp77390416"></a><h2>BUGS</h2>
<p>
There are probably too many query options.
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-checkds</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.delv.html" title="delv">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-checkds">
<a name="man.dnssec-checkds"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-checkds</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.5.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp77709136"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-checkds</strong></span>
verifies the correctness of Delegation Signer (DS) or DNSSEC
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.5.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp77710928"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.5.9"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp77721680"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dnssec-dsfromkey</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-coverage</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-checkds.html" title="dnssec-checkds">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-coverage">
<a name="man.dnssec-coverage"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-coverage</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.6.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp77753808"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-coverage</strong></span>
verifies that the DNSSEC keys for a given zone or a set of zones
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.6.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp77757008"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.6.9"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp77796432"></a><h2>SEE ALSO</h2>
<p>
<span class="citerefentry">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-dsfromkey</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-coverage.html" title="dnssec-coverage">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-dsfromkey">
<a name="man.dnssec-dsfromkey"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-dsfromkey</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.7.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp77836624"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-dsfromkey</strong></span>
outputs the Delegation Signer (DS) resource record (RR), as defined in
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.7.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp77850704"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-1</span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.7.9"></a><h2>EXAMPLE</h2>
+ <div class="refsection" title="EXAMPLE">
+<a name="idp77889872"></a><h2>EXAMPLE</h2>
<p>
To build the SHA-256 DS RR from the
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.7.10"></a><h2>FILES</h2>
+ <div class="refsection" title="FILES">
+<a name="idp77893456"></a><h2>FILES</h2>
<p>
The keyfile can be designed by the key identification
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.7.11"></a><h2>CAVEAT</h2>
+ <div class="refsection" title="CAVEAT">
+<a name="idp77897808"></a><h2>CAVEAT</h2>
<p>
A keyfile error can give a "file not found" even if the file exists.
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.7.12"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp77899344"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dnssec-keygen</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-importkey</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-importkey">
<a name="man.dnssec-importkey"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-importkey</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.8.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp77931856"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-importkey</strong></span>
reads a public DNSKEY record and generates a pair of
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.8.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp77935056"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-f <em class="replaceable"><code>filename</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.8.9"></a><h2>TIMING OPTIONS</h2>
+ <div class="refsection" title="TIMING OPTIONS">
+<a name="idp77950160"></a><h2>TIMING OPTIONS</h2>
<p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
set, use 'none' or 'never'.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.8.10"></a><h2>FILES</h2>
+ <div class="refsection" title="FILES">
+<a name="idp77955920"></a><h2>FILES</h2>
<p>
A keyfile can be designed by the key identification
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.8.11"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp77958736"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dnssec-keygen</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-keyfromlabel</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-importkey.html" title="dnssec-importkey">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-keyfromlabel">
<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-keyfromlabel</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.9.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp78015440"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-keyfromlabel</strong></span>
generates a key pair of files that referencing a key object stored
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.9.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp78018256"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.9.9"></a><h2>TIMING OPTIONS</h2>
+ <div class="refsection" title="TIMING OPTIONS">
+<a name="idp78064336"></a><h2>TIMING OPTIONS</h2>
<p>
set, use 'none' or 'never'.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.9.10"></a><h2>GENERATED KEY FILES</h2>
+ <div class="refsection" title="GENERATED KEY FILES">
+<a name="idp78086864"></a><h2>GENERATED KEY FILES</h2>
<p>
When <span class="command"><strong>dnssec-keyfromlabel</strong></span> completes
to the standard output. This is an identification string for
the key files it has generated.
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p><code class="filename">nnnn</code> is the key name.
</p>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.9.11"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp78107856"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dnssec-keygen</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-keygen</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-keygen">
<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-keygen</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.10.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp78166608"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-keygen</strong></span>
generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.10.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp78169040"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.10.9"></a><h2>TIMING OPTIONS</h2>
+ <div class="refsection" title="TIMING OPTIONS">
+<a name="idp78226768"></a><h2>TIMING OPTIONS</h2>
<p>
set, use 'none' or 'never'.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd>
<p>
</div>
- <div class="refsection">
-<a name="id-1.14.10.10"></a><h2>GENERATED KEYS</h2>
+ <div class="refsection" title="GENERATED KEYS">
+<a name="idp78245072"></a><h2>GENERATED KEYS</h2>
<p>
When <span class="command"><strong>dnssec-keygen</strong></span> completes
to the standard output. This is an identification string for
the key it has generated.
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p><code class="filename">nnnn</code> is the key name.
</p>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.10.11"></a><h2>EXAMPLE</h2>
+ <div class="refsection" title="EXAMPLE">
+<a name="idp78279632"></a><h2>EXAMPLE</h2>
<p>
To generate a 768-bit DSA key for the domain
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.10.12"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp78284624"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dnssec-signzone</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-revoke</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-keygen.html" title="dnssec-keygen">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-revoke">
<a name="man.dnssec-revoke"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-revoke</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.11.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp78309456"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-revoke</strong></span>
reads a DNSSEC key file, sets the REVOKED bit on the key as defined
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.11.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp78311120"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-h</span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.11.9"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp78326992"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dnssec-keygen</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-settime</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-revoke.html" title="dnssec-revoke">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-settime">
<a name="man.dnssec-settime"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-settime</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.12.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp78362064"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-settime</strong></span>
reads a DNSSEC private key file and sets the key timing metadata
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.12.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp78368080"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-f</span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.12.9"></a><h2>TIMING OPTIONS</h2>
+ <div class="refsection" title="TIMING OPTIONS">
+<a name="idp78383568"></a><h2>TIMING OPTIONS</h2>
<p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
is computed in seconds. To unset a date, use 'none' or 'never'.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.12.10"></a><h2>PRINTING OPTIONS</h2>
+ <div class="refsection" title="PRINTING OPTIONS">
+<a name="idp78403920"></a><h2>PRINTING OPTIONS</h2>
<p>
<span class="command"><strong>dnssec-settime</strong></span> can also be used to print the
timing metadata associated with a key.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-u</span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.12.11"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp78416848"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dnssec-keygen</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-signzone</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-settime.html" title="dnssec-settime">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-signzone">
<a name="man.dnssec-signzone"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-signzone</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.13.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp78483664"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-signzone</strong></span>
signs a zone. It generates
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.13.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp78485712"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-a</span></dt>
<dd>
<p>
and <span class="command"><strong>"date"</strong></span>.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><span class="command"><strong>"keep"</strong></span></span></dt>
<dd>
<p>Do not modify the SOA serial number.</p>
rules. Each successive rule takes priority over the prior
ones:
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.13.9"></a><h2>EXAMPLE</h2>
+ <div class="refsection" title="EXAMPLE">
+<a name="idp78644048"></a><h2>EXAMPLE</h2>
<p>
The following command signs the <strong class="userinput"><code>example.com</code></strong>
%</pre>
</div>
- <div class="refsection">
-<a name="id-1.14.13.10"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp78654800"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dnssec-keygen</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-verify</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-signzone.html" title="dnssec-signzone">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnssec-verify">
<a name="man.dnssec-verify"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnssec-verify</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.14.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp78680272"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>dnssec-verify</strong></span>
verifies that a zone is fully signed for each algorithm found
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.14.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp78682064"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.14.9"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp78702672"></a><h2>SEE ALSO</h2>
<p>
<span class="citerefentry">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnstap-read</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.arpaname.html" title="arpaname">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="dnstap-read">
<a name="man.dnstap-read"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">dnstap-read</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.28.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp80269520"></a><h2>DESCRIPTION</h2>
<p>
<span class="command"><strong>dnstap-read</strong></span>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.28.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp80272464"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-m</span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.28.9"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp80288336"></a><h2>SEE ALSO</h2>
<p>
<span class="citerefentry">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>genrandom</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnstap-read.html" title="dnstap-read">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="genrandom">
<a name="man.genrandom"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">genrandom</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.29.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp80305104"></a><h2>DESCRIPTION</h2>
<p>
<span class="command"><strong>genrandom</strong></span>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.29.8"></a><h2>ARGUMENTS</h2>
+ <div class="refsection" title="ARGUMENTS">
+<a name="idp80307024"></a><h2>ARGUMENTS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-n <em class="replaceable"><code>number</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.29.9"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp80314192"></a><h2>SEE ALSO</h2>
<p>
<span class="citerefentry">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>host</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dig.html" title="dig">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="host">
<a name="man.host"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">host</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.3.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp77416400"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>host</strong></span>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.3.8"></a><h2>IDN SUPPORT</h2>
+ <div class="refsection" title="IDN SUPPORT">
+<a name="idp77458768"></a><h2>IDN SUPPORT</h2>
<p>
If <span class="command"><strong>host</strong></span> has been built with IDN (internationalized
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.3.9"></a><h2>FILES</h2>
+ <div class="refsection" title="FILES">
+<a name="idp77461840"></a><h2>FILES</h2>
<p><code class="filename">/etc/resolv.conf</code>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.3.10"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp77463504"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">dig</span>(1)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>isc-hmac-fixup</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.genrandom.html" title="genrandom">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="isc-hmac-fixup">
<a name="man.isc-hmac-fixup"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">isc-hmac-fixup</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.30.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp80329040"></a><h2>DESCRIPTION</h2>
<p>
Versions of BIND 9 up to and including BIND 9.6 had a bug causing
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.30.8"></a><h2>SECURITY CONSIDERATIONS</h2>
+ <div class="refsection" title="SECURITY CONSIDERATIONS">
+<a name="idp80332112"></a><h2>SECURITY CONSIDERATIONS</h2>
<p>
Secrets that have been converted by <span class="command"><strong>isc-hmac-fixup</strong></span>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.30.9"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp80333904"></a><h2>SEE ALSO</h2>
<p>
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwresd</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-verify.html" title="dnssec-verify">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="lwresd">
<a name="man.lwresd"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">lwresd</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.15.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp78734928"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>lwresd</strong></span>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.15.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp78741072"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-4</span></dt>
<dd>
<p>
Write memory usage statistics to <code class="filename">stdout</code>
on exit.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
This option is mainly of interest to BIND 9 developers
processing the command line arguments, but before
reading the configuration file.
</p>
- <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p>
This option should be used in conjunction with the
</div>
- <div class="refsection">
-<a name="id-1.14.15.9"></a><h2>FILES</h2>
+ <div class="refsection" title="FILES">
+<a name="idp78804560"></a><h2>FILES</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><code class="filename">/etc/resolv.conf</code></span></dt>
<dd>
<p>
</div>
- <div class="refsection">
-<a name="id-1.14.15.10"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp78809296"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">named</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-checkconf</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.named.conf.html" title="named.conf">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="named-checkconf">
<a name="man.named-checkconf"></a><div class="titlepage"></div>
</p>
</div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">named-checkconf</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.18.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp79285584"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>named-checkconf</strong></span>
checks the syntax, but not the semantics, of a
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.18.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp79291216"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-h</span></dt>
<dd>
<p>
</div>
- <div class="refsection">
-<a name="id-1.14.18.9"></a><h2>RETURN VALUES</h2>
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp79308752"></a><h2>RETURN VALUES</h2>
<p><span class="command"><strong>named-checkconf</strong></span>
returns an exit status of 1 if
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.18.10"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp79310416"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">named</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-checkzone</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.named-checkconf.html" title="named-checkconf">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="named-checkzone">
<a name="man.named-checkzone"></a><div class="titlepage"></div>
</p>
</div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">named-checkzone</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.19.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp79396944"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>named-checkzone</strong></span>
checks the syntax and integrity of a zone file. It performs the
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.19.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp79401552"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-d</span></dt>
<dd>
<p>
</div>
- <div class="refsection">
-<a name="id-1.14.19.9"></a><h2>RETURN VALUES</h2>
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp79498960"></a><h2>RETURN VALUES</h2>
<p><span class="command"><strong>named-checkzone</strong></span>
returns an exit status of 1 if
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.19.10"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp79500752"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">named</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-journalprint</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.named-checkzone.html" title="named-checkzone">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="named-journalprint">
<a name="man.named-journalprint"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">named-journalprint</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.20.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp79518928"></a><h2>DESCRIPTION</h2>
<p>
<span class="command"><strong>named-journalprint</strong></span>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.20.8"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp79523152"></a><h2>SEE ALSO</h2>
<p>
<span class="citerefentry">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-rrchecker</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.named-journalprint.html" title="named-journalprint">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="named-rrchecker">
<a name="man.named-rrchecker"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">named-rrchecker</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.21.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp79541968"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>named-rrchecker</strong></span>
read a individual DNS resource record from standard input and checks if it
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.21.8"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp79548880"></a><h2>SEE ALSO</h2>
<p>
<em class="citetitle">RFC 1034</em>,
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named.conf</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.named.html" title="named">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="named.conf">
<a name="man.named.conf"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">named.conf</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp78982096"></a><h2>DESCRIPTION</h2>
<p><code class="filename">named.conf</code> is the configuration file
for
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.17.8"></a><h2>ACL</h2>
+ <div class="refsection" title="ACL">
+<a name="idp78985424"></a><h2>ACL</h2>
<div class="literallayout"><p><br>
acl <em class="replaceable"><code>string</code></em> { <em class="replaceable"><code>address_match_element</code></em>; ... };<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.9"></a><h2>KEY</h2>
+ <div class="refsection" title="KEY">
+<a name="idp78987728"></a><h2>KEY</h2>
<div class="literallayout"><p><br>
key <em class="replaceable"><code>domain_name</code></em> {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.10"></a><h2>MASTERS</h2>
+ <div class="refsection" title="MASTERS">
+<a name="idp78990416"></a><h2>MASTERS</h2>
<div class="literallayout"><p><br>
masters <em class="replaceable"><code>string</code></em> [<span class="optional"> port <em class="replaceable"><code>integer</code></em> </span>] {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.11"></a><h2>SERVER</h2>
+ <div class="refsection" title="SERVER">
+<a name="idp78996432"></a><h2>SERVER</h2>
<div class="literallayout"><p><br>
server ( <em class="replaceable"><code>ipv4_address[<span class="optional">/prefixlen</span>]</code></em> | <em class="replaceable"><code>ipv6_address[<span class="optional">/prefixlen</span>]</code></em> ) {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.12"></a><h2>TRUSTED-KEYS</h2>
+ <div class="refsection" title="TRUSTED-KEYS">
+<a name="idp79005520"></a><h2>TRUSTED-KEYS</h2>
<div class="literallayout"><p><br>
trusted-keys {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.13"></a><h2>MANAGED-KEYS</h2>
+ <div class="refsection" title="MANAGED-KEYS">
+<a name="idp79009104"></a><h2>MANAGED-KEYS</h2>
<div class="literallayout"><p><br>
managed-keys {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.14"></a><h2>CONTROLS</h2>
+ <div class="refsection" title="CONTROLS">
+<a name="idp79012944"></a><h2>CONTROLS</h2>
<div class="literallayout"><p><br>
controls {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.15"></a><h2>LOGGING</h2>
+ <div class="refsection" title="LOGGING">
+<a name="idp79017680"></a><h2>LOGGING</h2>
<div class="literallayout"><p><br>
logging {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.16"></a><h2>LWRES</h2>
+ <div class="refsection" title="LWRES">
+<a name="idp79022672"></a><h2>LWRES</h2>
<div class="literallayout"><p><br>
lwres {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.17"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp79028944"></a><h2>OPTIONS</h2>
<div class="literallayout"><p><br>
options {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.18"></a><h2>VIEW</h2>
+ <div class="refsection" title="VIEW">
+<a name="idp79129296"></a><h2>VIEW</h2>
<div class="literallayout"><p><br>
view <em class="replaceable"><code>string</code></em> <em class="replaceable"><code>optional_class</code></em> {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.19"></a><h2>ZONE</h2>
+ <div class="refsection" title="ZONE">
+<a name="idp79204688"></a><h2>ZONE</h2>
<div class="literallayout"><p><br>
zone <em class="replaceable"><code>string</code></em> <em class="replaceable"><code>optional_class</code></em> {<br>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.17.20"></a><h2>FILES</h2>
+ <div class="refsection" title="FILES">
+<a name="idp79247696"></a><h2>FILES</h2>
<p><code class="filename">/etc/named.conf</code>
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.17.21"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp79249360"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">named</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.lwresd.html" title="lwresd">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="named">
<a name="man.named"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">named</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.16.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp78854992"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>named</strong></span>
is a Domain Name System (DNS) server,
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.16.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp78870224"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-4</span></dt>
<dd>
<p>
<p>
Write memory usage statistics to <code class="filename">stdout</code> on exit.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
This option is mainly of interest to BIND 9 developers
configuration options, and 21000 on systems built with
"configure --with-tuning=large".
</p>
- <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p>
This option should be unnecessary for the vast majority
processing the command line arguments, but before
reading the configuration file.
</p>
- <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p>
This option should be used in conjunction with the
privileged operations, such as creating sockets that
listen on privileged ports.
</p>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
On Linux, <span class="command"><strong>named</strong></span> uses the kernel's
Load data from <em class="replaceable"><code>cache-file</code></em> into the
cache of the default view.
</p>
- <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+ <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p>
This option must not be used. It is only of interest
</div>
- <div class="refsection">
-<a name="id-1.14.16.9"></a><h2>SIGNALS</h2>
+ <div class="refsection" title="SIGNALS">
+<a name="idp78936784"></a><h2>SIGNALS</h2>
<p>
In routine operation, signals should not be used to control
instead.
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">SIGHUP</span></dt>
<dd>
<p>
</div>
- <div class="refsection">
-<a name="id-1.14.16.10"></a><h2>CONFIGURATION</h2>
+ <div class="refsection" title="CONFIGURATION">
+<a name="idp78942416"></a><h2>CONFIGURATION</h2>
<p>
The <span class="command"><strong>named</strong></span> configuration file is too complex
</div>
- <div class="refsection">
-<a name="id-1.14.16.11"></a><h2>FILES</h2>
+ <div class="refsection" title="FILES">
+<a name="idp78947152"></a><h2>FILES</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><code class="filename">/etc/named.conf</code></span></dt>
<dd>
<p>
</div>
- <div class="refsection">
-<a name="id-1.14.16.12"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp78956112"></a><h2>SEE ALSO</h2>
<p><em class="citetitle">RFC 1033</em>,
<em class="citetitle">RFC 1034</em>,
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>nsec3hash</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.isc-hmac-fixup.html" title="isc-hmac-fixup">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="nsec3hash">
<a name="man.nsec3hash"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">nsec3hash</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.31.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp80348880"></a><h2>DESCRIPTION</h2>
<p>
<span class="command"><strong>nsec3hash</strong></span> generates an NSEC3 hash based on
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.31.8"></a><h2>ARGUMENTS</h2>
+ <div class="refsection" title="ARGUMENTS">
+<a name="idp80350672"></a><h2>ARGUMENTS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">salt</span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.31.9"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp80358352"></a><h2>SEE ALSO</h2>
<p>
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>nsupdate</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.named-rrchecker.html" title="named-rrchecker">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="nsupdate">
<a name="man.nsupdate"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">nsupdate</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.22.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp79587920"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>nsupdate</strong></span>
is used to submit Dynamic DNS Update requests as defined in RFC 2136
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.22.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp79609040"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-d</span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.22.9"></a><h2>INPUT FORMAT</h2>
+ <div class="refsection" title="INPUT FORMAT">
+<a name="idp79653072"></a><h2>INPUT FORMAT</h2>
<p><span class="command"><strong>nsupdate</strong></span>
reads input from
<p>
The command formats and their meaning are as follows:
</p>
-<div class="variablelist"><dl class="variablelist">
+<div class="variablelist"><dl>
<dt><span class="term">
<span class="command"><strong>server</strong></span>
{servername}
</div>
- <div class="refsection">
-<a name="id-1.14.22.10"></a><h2>EXAMPLES</h2>
+ <div class="refsection" title="EXAMPLES">
+<a name="idp79753936"></a><h2>EXAMPLES</h2>
<p>
The examples below show how
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.22.11"></a><h2>FILES</h2>
+ <div class="refsection" title="FILES">
+<a name="idp79763792"></a><h2>FILES</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><code class="constant">/etc/resolv.conf</code></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.22.12"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp79774032"></a><h2>SEE ALSO</h2>
<p>
<em class="citetitle">RFC 2136</em>,
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.22.13"></a><h2>BUGS</h2>
+ <div class="refsection" title="BUGS">
+<a name="idp79785424"></a><h2>BUGS</h2>
<p>
The TSIG key is redundantly stored in two separate files.
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>rndc-confgen</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="rndc-confgen">
<a name="man.rndc-confgen"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">rndc-confgen</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.25.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp80113104"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>rndc-confgen</strong></span>
generates configuration files
</div>
- <div class="refsection">
-<a name="id-1.14.25.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp80126544"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-a</span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.25.9"></a><h2>EXAMPLES</h2>
+ <div class="refsection" title="EXAMPLES">
+<a name="idp80163920"></a><h2>EXAMPLES</h2>
<p>
To allow <span class="command"><strong>rndc</strong></span> to be used with
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.25.10"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp80168912"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">rndc</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>rndc.conf</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.rndc.html" title="rndc">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="rndc.conf">
<a name="man.rndc.conf"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">rndc.conf</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.24.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp80048464"></a><h2>DESCRIPTION</h2>
<p><code class="filename">rndc.conf</code> is the configuration file
for <span class="command"><strong>rndc</strong></span>, the BIND 9 name server control
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.24.8"></a><h2>EXAMPLE</h2>
+ <div class="refsection" title="EXAMPLE">
+<a name="idp80066000"></a><h2>EXAMPLE</h2>
<pre class="programlisting">
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.24.9"></a><h2>NAME SERVER CONFIGURATION</h2>
+ <div class="refsection" title="NAME SERVER CONFIGURATION">
+<a name="idp80077136"></a><h2>NAME SERVER CONFIGURATION</h2>
<p>
The name server must be configured to accept rndc connections and
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.24.10"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp80079952"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">rndc</span>(8)
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>rndc</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.nsupdate.html" title="nsupdate">
</table>
<hr>
</div>
-<div class="refentry">
+<div class="refentry" title="rndc">
<a name="man.rndc"></a><div class="titlepage"></div>
- <div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p>
<code class="command">rndc</code>
</p></div>
</div>
- <div class="refsection">
-<a name="id-1.14.23.7"></a><h2>DESCRIPTION</h2>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp79809104"></a><h2>DESCRIPTION</h2>
<p><span class="command"><strong>rndc</strong></span>
controls the operation of a name
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.23.8"></a><h2>OPTIONS</h2>
+ <div class="refsection" title="OPTIONS">
+<a name="idp79813584"></a><h2>OPTIONS</h2>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.23.9"></a><h2>COMMANDS</h2>
+ <div class="refsection" title="COMMANDS">
+<a name="idp79852112"></a><h2>COMMANDS</h2>
<p>
A list of commands supported by <span class="command"><strong>rndc</strong></span> can
Currently supported commands are:
</p>
- <div class="variablelist"><dl class="variablelist">
+ <div class="variablelist"><dl>
<dt><span class="term"><strong class="userinput"><code>addzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] <em class="replaceable"><code>configuration</code></em> </code></strong></span></dt>
<dd>
<p>
</dl></div>
</div>
- <div class="refsection">
-<a name="id-1.14.23.10"></a><h2>LIMITATIONS</h2>
+ <div class="refsection" title="LIMITATIONS">
+<a name="idp80019280"></a><h2>LIMITATIONS</h2>
<p>
There is currently no way to provide the shared secret for a
</p>
</div>
- <div class="refsection">
-<a name="id-1.14.23.11"></a><h2>SEE ALSO</h2>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp80025680"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">rndc.conf</span>(5)
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="rfc5011.support"><info><title>Dynamic Trust Anchor Management</title></info>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title></title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article">
- <div class="section">
+ <div class="section" title="Release Notes for BIND Version 9.11.0pre-alpha">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id-1.2"></a>Release Notes for BIND Version 9.11.0pre-alpha</h2></div></div></div>
+<a name="idp60863824"></a>Release Notes for BIND Version 9.11.0pre-alpha</h2></div></div></div>
- <div class="section">
+ <div class="section" title="Introduction">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_intro"></a>Introduction</h3></div></div></div>
of BIND on the corresponding major release branch.
</p>
</div>
- <div class="section">
+ <div class="section" title="Download">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_download"></a>Download</h3></div></div></div>
operating systems.
</p>
</div>
- <div class="section">
+ <div class="section" title="Security Fixes">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_security"></a>Security Fixes</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
An incorrect boundary check in the OPENPGPKEY rdatatype
</li>
</ul></div>
</div>
- <div class="section">
+ <div class="section" title="New Features">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_features"></a>New Features</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
Added support for DynDB, a new interface for loading zone data
experienced by recursives when they are being used as a
vehicle for such an attack.
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle">
<li class="listitem">
<p>
<code class="option">fetches-per-server</code> limits the number of
</li>
</ul></div>
</div>
- <div class="section">
+ <div class="section" title="Feature Changes">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_changes"></a>Feature Changes</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
ACLs containing <span class="command"><strong>geoip asnum</strong></span> elements were
</li>
</ul></div>
</div>
- <div class="section">
+ <div class="section" title="Porting Changes">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_port"></a>Porting Changes</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<p>
The Microsoft Windows install tool
<span class="command"><strong>BINDInstall.exe</strong></span> which requires a
</p>
</li></ul></div>
</div>
- <div class="section">
+ <div class="section" title="Bug Fixes">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_bugs"></a>Bug Fixes</h3></div></div></div>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
<span class="command"><strong>dig</strong></span>, <span class="command"><strong>host</strong></span> and
<p>
Several bugs have been fixed in the RPZ implementation:
</p>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle">
<li class="listitem">
<p>
Policy zones that did not specifically require recursion
</li>
</ul></div>
</div>
- <div class="section">
+ <div class="section" title="End of Life">
<div class="titlepage"><div><div><h3 class="title">
<a name="end_of_life"></a>End of Life</h3></div></div></div>
<a class="ulink" href="https://www.isc.org/downloads/software-support-policy/" target="_top">https://www.isc.org/downloads/software-support-policy/</a>
</p>
</div>
- <div class="section">
+ <div class="section" title="Thank You">
<div class="titlepage"><div><div><h3 class="title">
<a name="relnotes_thanks"></a>Thank You</h3></div></div></div>
- PERFORMANCE OF THIS SOFTWARE.
-->
+<!-- $Id$ -->
+
<!-- Generate ISC copyright comments from Docbook copyright metadata. -->
<xsl:stylesheet version="1.0"
- PERFORMANCE OF THIS SOFTWARE.
-->
+<!-- $Id$ -->
+
<!-- Tweaks to Docbook-XSL HTML for producing flat ASCII text. -->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
- PERFORMANCE OF THIS SOFTWARE.
-->
+<!-- $Id$ -->
+
<!-- ISC customizations for Docbook-XSL manual page generator. -->
<xsl:stylesheet version="1.0"
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: isc\-config.sh
+'\" t
+.\" Title: isc-config.sh
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: February 18, 2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2009-02-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "ISC\-CONFIG.SH" "1" "February 18, 2009" "BIND9" "BIND9"
+.TH "ISC\-CONFIG\&.SH" "1" "2009\-02\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-isc\-config.sh \- Get information about the installed version of ISC BIND
+isc-config.sh \- Get information about the installed version of ISC BIND
.SH "SYNOPSIS"
.HP 14
-\fBisc\-config.sh\fR [\fB\-\-cflags\fR] [\fB\-\-exec\-prefix\fR] [\fB\-\-libs\fR] [\fB\-\-prefix\fR] [\fB\-\-version\fR] [libraries...]
+\fBisc\-config\&.sh\fR [\fB\-\-cflags\fR] [\fB\-\-exec\-prefix\fR] [\fB\-\-libs\fR] [\fB\-\-prefix\fR] [\fB\-\-version\fR] [libraries...]
.SH "DESCRIPTION"
.PP
-\fBisc\-config.sh\fR
-prints information related to the installed version of ISC BIND, such as the compiler and linker flags required to compile and link programs that use ISC BIND libraries.
+\fBisc\-config\&.sh\fR
+prints information related to the installed version of ISC BIND, such as the compiler and linker flags required to compile and link programs that use ISC BIND libraries\&.
.PP
-The optional libraries are used to report specific details for compiling and linking for the listed libraries. The allowed choices are:
+The optional libraries are used to report specific details for compiling and linking for the listed libraries\&. The allowed choices are:
\fBisc\fR,
\fBisccc\fR,
\fBisccfg\fR,
\fBdns\fR,
\fBlwres\fR, and
-\fBbind9\fR. Multiple libraries may be listed on the command line. (Some libraries require other libraries, so are implied.)
+\fBbind9\fR\&. Multiple libraries may be listed on the command line\&. (Some libraries require other libraries, so are implied\&.)
.SH "OPTIONS"
.PP
\-\-cflags
.RS 4
-Prints the compiler command line options required to compile files that use ISC BIND. Use the
+Prints the compiler command line options required to compile files that use ISC BIND\&. Use the
\fBlibraries\fR
-command line argument(s) to print additional specific flags to pass to the C compiler.
+command line argument(s) to print additional specific flags to pass to the C compiler\&.
.RE
.PP
\-\-exec\-prefix
.RS 4
-Prints the directory prefix used in the ISC BIND installation for architecture dependent files to standard output.
+Prints the directory prefix used in the ISC BIND installation for architecture dependent files to standard output\&.
.RE
.PP
\-\-libs
.RS 4
-Prints the linker command line options used to link with the ISC BIND libraries. Use the
+Prints the linker command line options used to link with the ISC BIND libraries\&. Use the
\fBlibraries\fR
-command line argument(s) to print additional specific flags.
+command line argument(s) to print additional specific flags\&.
.RE
.PP
\-\-prefix
.RS 4
-Prints the directory prefix used in the ISC BIND installation for architecture independent files to standard output.
+Prints the directory prefix used in the ISC BIND installation for architecture independent files to standard output\&.
.RE
.PP
\-\-version
.RS 4
-Prints the version of the installed ISC BIND suite.
+Prints the version of the installed ISC BIND suite\&.
.RE
.SH "RETURN VALUES"
.PP
-\fBisc\-config.sh\fR
-returns an exit status of 1 if invoked with invalid arguments or no arguments at all. It returns 0 if information was successfully printed.
+\fBisc\-config\&.sh\fR
+returns an exit status of 1 if invoked with invalid arguments or no arguments at all\&. It returns 0 if information was successfully printed\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.isc-config.sh">
<info>
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>isc-config.sh</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="isc-config.sh">
<a name="man.isc-config.sh"></a><div class="titlepage"></div>
-<div class="refnamediv">
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p><span class="application">isc-config.sh</span> — Get information about the installed version of ISC BIND</p>
+<p>
+ <span class="application">isc-config.sh</span>
+ — Get information about the installed version of ISC BIND
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="cmdsynopsis"><p><code class="command">isc-config.sh</code> [<code class="option">--cflags</code>] [<code class="option">--exec-prefix</code>] [<code class="option">--libs</code>] [<code class="option">--prefix</code>] [<code class="option">--version</code>] [libraries...]</p></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543373"></a><h2>DESCRIPTION</h2>
-<p><span><strong class="command">isc-config.sh</strong></span>
+ <div class="cmdsynopsis"><p>
+ <code class="command">isc-config.sh</code>
+ [<code class="option">--cflags</code>]
+ [<code class="option">--exec-prefix</code>]
+ [<code class="option">--libs</code>]
+ [<code class="option">--prefix</code>]
+ [<code class="option">--version</code>]
+ [libraries...]
+ </p></div>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60774736"></a><h2>DESCRIPTION</h2>
+
+ <p><span class="command"><strong>isc-config.sh</strong></span>
prints information related to the installed version of ISC BIND,
such as the compiler and linker flags required to compile
and link programs that use ISC BIND libraries.
</p>
-<p>
+ <p>
The optional libraries are used to report specific details
for compiling and linking for the listed libraries.
The allowed choices are:
Multiple libraries may be listed on the command line.
(Some libraries require other libraries, so are implied.)
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543408"></a><h2>OPTIONS</h2>
-<div class="variablelist"><dl>
+
+ </div>
+
+ <div class="refsection" title="OPTIONS">
+<a name="idp60779216"></a><h2>OPTIONS</h2>
+
+
+ <div class="variablelist"><dl>
<dt><span class="term">--cflags</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints the compiler command line options required to
compile files that use ISC BIND.
Use the <code class="option">libraries</code> command line argument(s)
to print additional specific flags to pass to the C compiler.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">--exec-prefix</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints the directory prefix used in the ISC BIND installation
for architecture dependent files to standard output.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">--libs</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints the linker command line options used to
link with the ISC BIND libraries.
Use the <code class="option">libraries</code> command line argument(s)
to print additional specific flags.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">--prefix</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints the directory prefix used in the ISC BIND installation
for architecture independent files to standard output.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term">--version</span></dt>
-<dd><p>
+<dd>
+ <p>
Prints the version of the installed ISC BIND suite.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543488"></a><h2>RETURN VALUES</h2>
-<p><span><strong class="command">isc-config.sh</strong></span>
+
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60797648"></a><h2>RETURN VALUES</h2>
+
+ <p><span class="command"><strong>isc-config.sh</strong></span>
returns an exit status of 1 if
invoked with invalid arguments or no arguments at all.
It returns 0 if information was successfully printed.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543499"></a><h2>AUTHOR</h2>
-<p><span class="corpauthor">Internet Systems Consortium</span>
- </p>
-</div>
+ </div>
+
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres \- introduction to the lightweight resolver library
.SH "SYNOPSIS"
.nf
-#include <lwres/lwres.h>
+#include <lwres/lwres\&.h>
.fi
.SH "DESCRIPTION"
.PP
-The BIND 9 lightweight resolver library is a simple, name service independent stub resolver library. It provides hostname\-to\-address and address\-to\-hostname lookup services to applications by transmitting lookup requests to a resolver daemon
+The BIND 9 lightweight resolver library is a simple, name service independent stub resolver library\&. It provides hostname\-to\-address and address\-to\-hostname lookup services to applications by transmitting lookup requests to a resolver daemon
\fBlwresd\fR
-running on the local host. The resolver daemon performs the lookup using the DNS or possibly other name service protocols, and returns the results to the application through the library. The library and resolver daemon communicate using a simple UDP\-based protocol.
+running on the local host\&. The resolver daemon performs the lookup using the DNS or possibly other name service protocols, and returns the results to the application through the library\&. The library and resolver daemon communicate using a simple UDP\-based protocol\&.
.SH "OVERVIEW"
.PP
-The lwresd library implements multiple name service APIs. The standard
+The lwresd library implements multiple name service APIs\&. The standard
\fBgethostbyname()\fR,
\fBgethostbyaddr()\fR,
\fBgethostbyname_r()\fR,
\fBgetaddrinfo()\fR,
\fBgetipnodebyname()\fR, and
\fBgetipnodebyaddr()\fR
-functions are all supported. To allow the lwres library to coexist with system libraries that define functions of the same name, the library defines these functions with names prefixed by
-lwres_. To define the standard names, applications must include the header file
-\fI<lwres/netdb.h>\fR
+functions are all supported\&. To allow the lwres library to coexist with system libraries that define functions of the same name, the library defines these functions with names prefixed by
+lwres_\&. To define the standard names, applications must include the header file
+<lwres/netdb\&.h>
which contains macro definitions mapping the standard function names into
lwres_
-prefixed ones. Operating system vendors who integrate the lwres library into their base distributions should rename the functions in the library proper so that the renaming macros are not needed.
+prefixed ones\&. Operating system vendors who integrate the lwres library into their base distributions should rename the functions in the library proper so that the renaming macros are not needed\&.
.PP
The library also provides a native API consisting of the functions
\fBlwres_getaddrsbyname()\fR
and
-\fBlwres_getnamebyaddr()\fR. These may be called by applications that require more detailed control over the lookup process than the standard functions provide.
+\fBlwres_getnamebyaddr()\fR\&. These may be called by applications that require more detailed control over the lookup process than the standard functions provide\&.
.PP
In addition to these name service independent address lookup functions, the library implements a new, experimental API for looking up arbitrary DNS resource records, using the
\fBlwres_getaddrsbyname()\fR
-function.
+function\&.
.PP
-Finally, there is a low\-level API for converting lookup requests and responses to and from raw lwres protocol packets. This API can be used by clients requiring nonblocking operation, and is also used when implementing the server side of the lwres protocol, for example in the
+Finally, there is a low\-level API for converting lookup requests and responses to and from raw lwres protocol packets\&. This API can be used by clients requiring nonblocking operation, and is also used when implementing the server side of the lwres protocol, for example in the
\fBlwresd\fR
-resolver daemon. The use of this low\-level API in clients and servers is outlined in the following sections.
-.SH "CLIENT\-SIDE LOW\-LEVEL API CALL FLOW"
+resolver daemon\&. The use of this low\-level API in clients and servers is outlined in the following sections\&.
+.SH "CLIENT-SIDE LOW-LEVEL API CALL FLOW"
.PP
-When a client program wishes to make an lwres request using the native low\-level API, it typically performs the following sequence of actions.
+When a client program wishes to make an lwres request using the native low\-level API, it typically performs the following sequence of actions\&.
.PP
(1) Allocate or use an existing
\fBlwres_packet_t\fR, called
\fIpkt\fR
-below.
+below\&.
.PP
(2) Set
-pkt.recvlength
-to the maximum length we will accept. This is done so the receiver of our packets knows how large our receive buffer is. The "default" is a constant in
-\fIlwres.h\fR:
-\fBLWRES_RECVLENGTH = 4096\fR.
+\fIpkt\&.recvlength\fR
+to the maximum length we will accept\&. This is done so the receiver of our packets knows how large our receive buffer is\&. The "default" is a constant in
+lwres\&.h:
+\fBLWRES_RECVLENGTH = 4096\fR\&.
.PP
(3) Set
-pkt.serial
-to a unique serial number. This value is echoed back to the application by the remote server.
+\fIpkt\&.serial\fR
+to a unique serial number\&. This value is echoed back to the application by the remote server\&.
.PP
(4) Set
-pkt.pktflags. Usually this is set to 0.
+\fIpkt\&.pktflags\fR\&. Usually this is set to 0\&.
.PP
(5) Set
-pkt.result
-to 0.
+\fIpkt\&.result\fR
+to 0\&.
.PP
(6) Call
\fBlwres_*request_render()\fR, or marshall in the data using the primitives such as
\fBlwres_packet_render()\fR
-and storing the packet data.
+and storing the packet data\&.
.PP
-(7) Transmit the resulting buffer.
+(7) Transmit the resulting buffer\&.
.PP
(8) Call
\fBlwres_*response_parse()\fR
-to parse any packets received.
+to parse any packets received\&.
.PP
-(9) Verify that the opcode and serial match a request, and process the packet specific information contained in the body.
-.SH "SERVER\-SIDE LOW\-LEVEL API CALL FLOW"
+(9) Verify that the opcode and serial match a request, and process the packet specific information contained in the body\&.
+.SH "SERVER-SIDE LOW-LEVEL API CALL FLOW"
.PP
-When implementing the server side of the lightweight resolver protocol using the lwres library, a sequence of actions like the following is typically involved in processing each request packet.
+When implementing the server side of the lightweight resolver protocol using the lwres library, a sequence of actions like the following is typically involved in processing each request packet\&.
.PP
Note that the same
\fBlwres_packet_t\fR
\fB_parse()\fR
and
\fB_render()\fR
-calls, with only a few modifications made to the packet header's contents between uses. This method is recommended as it keeps the serial, opcode, and other fields correct.
+calls, with only a few modifications made to the packet header\*(Aqs contents between uses\&. This method is recommended as it keeps the serial, opcode, and other fields correct\&.
.PP
(1) When a packet is received, call
\fBlwres_*request_parse()\fR
-to unmarshall it. This returns a
+to unmarshall it\&. This returns a
\fBlwres_packet_t\fR
(also called
\fIpkt\fR, below) as well as a data specific type, such as
-\fBlwres_gabnrequest_t\fR.
+\fBlwres_gabnrequest_t\fR\&.
.PP
-(2) Process the request in the data specific type.
+(2) Process the request in the data specific type\&.
.PP
(3) Set the
-pkt.result,
-pkt.recvlength
-as above. All other fields can be left untouched since they were filled in by the
+\fIpkt\&.result\fR,
+\fIpkt\&.recvlength\fR
+as above\&. All other fields can be left untouched since they were filled in by the
\fB*_parse()\fR
-call above. If using
+call above\&. If using
\fBlwres_*response_render()\fR,
-pkt.pktflags
-will be set up properly. Otherwise, the
+\fIpkt\&.pktflags\fR
+will be set up properly\&. Otherwise, the
\fBLWRES_LWPACKETFLAG_RESPONSE\fR
-bit should be set.
+bit should be set\&.
.PP
(4) Call the data specific rendering function, such as
-\fBlwres_gabnresponse_render()\fR.
+\fBlwres_gabnresponse_render()\fR\&.
.PP
-(5) Send the resulting packet to the client.
+(5) Send the resulting packet to the client\&.
.PP
.SH "SEE ALSO"
.PP
\fBlwres_context\fR(3),
\fBlwres_config\fR(3),
\fBresolver\fR(5),
-\fBlwresd\fR(8).
+\fBlwresd\fR(8)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres">
+<a name="idp60840656"></a><div class="titlepage"></div>
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres — introduction to the lightweight resolver library</p>
+<p>
+ lwres
+ — introduction to the lightweight resolver library
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis"><pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre></div>
+ <div class="funcsynopsis">
+<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre>
</div>
-<div class="refsect1" lang="en">
-<a name="id2543360"></a><h2>DESCRIPTION</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60883920"></a><h2>DESCRIPTION</h2>
+
+ <p>
The BIND 9 lightweight resolver library is a simple, name service
independent stub resolver library. It provides hostname-to-address
and address-to-hostname lookup services to applications by
transmitting lookup requests to a resolver daemon
- <span><strong class="command">lwresd</strong></span>
+ <span class="command"><strong>lwresd</strong></span>
running on the local host. The resolver daemon performs the
lookup using the DNS or possibly other name service protocols,
and returns the results to the application through the library.
The library and resolver daemon communicate using a simple
UDP-based protocol.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543372"></a><h2>OVERVIEW</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="OVERVIEW">
+<a name="idp60885712"></a><h2>OVERVIEW</h2>
+
+ <p>
The lwresd library implements multiple name service APIs.
The standard
<code class="function">gethostbyname()</code>,
library into their base distributions should rename the functions
in the library proper so that the renaming macros are not needed.
</p>
-<p>
+ <p>
The library also provides a native API consisting of the functions
<code class="function">lwres_getaddrsbyname()</code>
and
control over the lookup process than the standard functions
provide.
</p>
-<p>
+ <p>
In addition to these name service independent address lookup
functions, the library implements a new, experimental API
for looking up arbitrary DNS resource records, using the
<code class="function">lwres_getaddrsbyname()</code>
function.
</p>
-<p>
+ <p>
Finally, there is a low-level API for converting lookup
requests and responses to and from raw lwres protocol packets.
This API can be used by clients requiring nonblocking operation,
and is also used when implementing the server side of the lwres
protocol, for example in the
- <span><strong class="command">lwresd</strong></span>
+ <span class="command"><strong>lwresd</strong></span>
resolver daemon. The use of this low-level API in clients
and servers is outlined in the following sections.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543436"></a><h2>CLIENT-SIDE LOW-LEVEL API CALL FLOW</h2>
-<p>
+ </div>
+ <div class="refsection" title="CLIENT-SIDE LOW-LEVEL API CALL FLOW">
+<a name="idp60898000"></a><h2>CLIENT-SIDE LOW-LEVEL API CALL FLOW</h2>
+
+ <p>
When a client program wishes to make an lwres request using the
native low-level API, it typically performs the following
sequence of actions.
</p>
-<p>
+ <p>
(1) Allocate or use an existing <span class="type">lwres_packet_t</span>,
called <code class="varname">pkt</code> below.
</p>
-<p>
- (2) Set <em class="structfield"><code>pkt.recvlength</code></em> to the maximum length
+ <p>
+ (2) Set <code class="varname">pkt.recvlength</code> to the maximum length
we will accept.
This is done so the receiver of our packets knows how large our receive
buffer is. The "default" is a constant in
<code class="filename">lwres.h</code>: <code class="constant">LWRES_RECVLENGTH = 4096</code>.
</p>
-<p>
- (3) Set <em class="structfield"><code>pkt.serial</code></em>
+ <p>
+ (3) Set <code class="varname">pkt.serial</code>
to a unique serial number. This value is echoed
back to the application by the remote server.
</p>
-<p>
- (4) Set <em class="structfield"><code>pkt.pktflags</code></em>. Usually this is set to
+ <p>
+ (4) Set <code class="varname">pkt.pktflags</code>. Usually this is set to
0.
</p>
-<p>
- (5) Set <em class="structfield"><code>pkt.result</code></em> to 0.
+ <p>
+ (5) Set <code class="varname">pkt.result</code> to 0.
</p>
-<p>
+ <p>
(6) Call <code class="function">lwres_*request_render()</code>,
or marshall in the data using the primitives
such as <code class="function">lwres_packet_render()</code>
and storing the packet data.
</p>
-<p>
+ <p>
(7) Transmit the resulting buffer.
</p>
-<p>
+ <p>
(8) Call <code class="function">lwres_*response_parse()</code>
to parse any packets received.
</p>
-<p>
+ <p>
(9) Verify that the opcode and serial match a request, and process the
packet specific information contained in the body.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543585"></a><h2>SERVER-SIDE LOW-LEVEL API CALL FLOW</h2>
-<p>
+ </div>
+ <div class="refsection" title="SERVER-SIDE LOW-LEVEL API CALL FLOW">
+<a name="idp60907856"></a><h2>SERVER-SIDE LOW-LEVEL API CALL FLOW</h2>
+
+ <p>
When implementing the server side of the lightweight resolver
protocol using the lwres library, a sequence of actions like the
following is typically involved in processing each request packet.
</p>
-<p>
+ <p>
Note that the same <span class="type">lwres_packet_t</span> is used
in both the <code class="function">_parse()</code> and <code class="function">_render()</code> calls,
with only a few modifications made
recommended
as it keeps the serial, opcode, and other fields correct.
</p>
-<p>
+ <p>
(1) When a packet is received, call <code class="function">lwres_*request_parse()</code> to
unmarshall it. This returns a <span class="type">lwres_packet_t</span> (also called <code class="varname">pkt</code>, below)
as well as a data specific type, such as <span class="type">lwres_gabnrequest_t</span>.
</p>
-<p>
+ <p>
(2) Process the request in the data specific type.
</p>
-<p>
- (3) Set the <em class="structfield"><code>pkt.result</code></em>,
- <em class="structfield"><code>pkt.recvlength</code></em> as above. All other fields
+ <p>
+ (3) Set the <code class="varname">pkt.result</code>,
+ <code class="varname">pkt.recvlength</code> as above. All other fields
can
be left untouched since they were filled in by the <code class="function">*_parse()</code> call
above. If using <code class="function">lwres_*response_render()</code>,
- <em class="structfield"><code>pkt.pktflags</code></em> will be set up
+ <code class="varname">pkt.pktflags</code> will be set up
properly. Otherwise, the <code class="constant">LWRES_LWPACKETFLAG_RESPONSE</code> bit should be
set.
</p>
-<p>
+ <p>
(4) Call the data specific rendering function, such as
<code class="function">lwres_gabnresponse_render()</code>.
</p>
-<p>
+ <p>
(5) Send the resulting packet to the client.
</p>
-<p></p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543668"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">lwres_gethostent</span>(3)</span>,
+ <p></p>
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60926032"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres_gethostent</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_getipnode</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_getipnode</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_getnameinfo</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_getnameinfo</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_noop</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_noop</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_gabn</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_gabn</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_gnba</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_gnba</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_context</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_context</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_config</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_config</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">resolver</span>(5)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwresd</span>(8)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">lwresd</span>(8)
+ </span>.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_buffer
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_BUFFER" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_BUFFER" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_buffer_init, lwres_buffer_invalidate, lwres_buffer_add, lwres_buffer_subtract, lwres_buffer_clear, lwres_buffer_first, lwres_buffer_forward, lwres_buffer_back, lwres_buffer_getuint8, lwres_buffer_putuint8, lwres_buffer_getuint16, lwres_buffer_putuint16, lwres_buffer_getuint32, lwres_buffer_putuint32, lwres_buffer_putmem, lwres_buffer_getmem \- lightweight resolver buffer management
.SH "SYNOPSIS"
.nf
-#include <lwres/lwbuffer.h>
+#include <lwres/lwbuffer\&.h>
.fi
-.HP 23
+.HP \w'void\ lwres_buffer_init('u
.BI "void lwres_buffer_init(lwres_buffer_t\ *" "b" ", void\ *" "base" ", unsigned\ int\ " "length" ");"
-.HP 29
+.HP \w'void\ lwres_buffer_invalidate('u
.BI "void lwres_buffer_invalidate(lwres_buffer_t\ *" "b" ");"
-.HP 22
+.HP \w'void\ lwres_buffer_add('u
.BI "void lwres_buffer_add(lwres_buffer_t\ *" "b" ", unsigned\ int\ " "n" ");"
-.HP 27
+.HP \w'void\ lwres_buffer_subtract('u
.BI "void lwres_buffer_subtract(lwres_buffer_t\ *" "b" ", unsigned\ int\ " "n" ");"
-.HP 24
+.HP \w'void\ lwres_buffer_clear('u
.BI "void lwres_buffer_clear(lwres_buffer_t\ *" "b" ");"
-.HP 24
+.HP \w'void\ lwres_buffer_first('u
.BI "void lwres_buffer_first(lwres_buffer_t\ *" "b" ");"
-.HP 26
+.HP \w'void\ lwres_buffer_forward('u
.BI "void lwres_buffer_forward(lwres_buffer_t\ *" "b" ", unsigned\ int\ " "n" ");"
-.HP 23
+.HP \w'void\ lwres_buffer_back('u
.BI "void lwres_buffer_back(lwres_buffer_t\ *" "b" ", unsigned\ int\ " "n" ");"
-.HP 36
+.HP \w'lwres_uint8_t\ lwres_buffer_getuint8('u
.BI "lwres_uint8_t lwres_buffer_getuint8(lwres_buffer_t\ *" "b" ");"
-.HP 27
+.HP \w'void\ lwres_buffer_putuint8('u
.BI "void lwres_buffer_putuint8(lwres_buffer_t\ *" "b" ", lwres_uint8_t\ " "val" ");"
-.HP 38
+.HP \w'lwres_uint16_t\ lwres_buffer_getuint16('u
.BI "lwres_uint16_t lwres_buffer_getuint16(lwres_buffer_t\ *" "b" ");"
-.HP 28
+.HP \w'void\ lwres_buffer_putuint16('u
.BI "void lwres_buffer_putuint16(lwres_buffer_t\ *" "b" ", lwres_uint16_t\ " "val" ");"
-.HP 38
+.HP \w'lwres_uint32_t\ lwres_buffer_getuint32('u
.BI "lwres_uint32_t lwres_buffer_getuint32(lwres_buffer_t\ *" "b" ");"
-.HP 28
+.HP \w'void\ lwres_buffer_putuint32('u
.BI "void lwres_buffer_putuint32(lwres_buffer_t\ *" "b" ", lwres_uint32_t\ " "val" ");"
-.HP 25
+.HP \w'void\ lwres_buffer_putmem('u
.BI "void lwres_buffer_putmem(lwres_buffer_t\ *" "b" ", const\ unsigned\ char\ *" "base" ", unsigned\ int\ " "length" ");"
-.HP 25
+.HP \w'void\ lwres_buffer_getmem('u
.BI "void lwres_buffer_getmem(lwres_buffer_t\ *" "b" ", unsigned\ char\ *" "base" ", unsigned\ int\ " "length" ");"
.SH "DESCRIPTION"
.PP
-These functions provide bounds checked access to a region of memory where data is being read or written. They are based on, and similar to, the
+These functions provide bounds checked access to a region of memory where data is being read or written\&. They are based on, and similar to, the
isc_buffer_
-functions in the ISC library.
+functions in the ISC library\&.
.PP
-A buffer is a region of memory, together with a set of related subregions. The
+A buffer is a region of memory, together with a set of related subregions\&. The
\fIused region\fR
and the
\fIavailable\fR
-region are disjoint, and their union is the buffer's region. The used region extends from the beginning of the buffer region to the last used byte. The available region extends from one byte greater than the last used byte to the end of the buffer's region. The size of the used region can be changed using various buffer commands. Initially, the used region is empty.
+region are disjoint, and their union is the buffer\*(Aqs region\&. The used region extends from the beginning of the buffer region to the last used byte\&. The available region extends from one byte greater than the last used byte to the end of the buffer\*(Aqs region\&. The size of the used region can be changed using various buffer commands\&. Initially, the used region is empty\&.
.PP
The used region is further subdivided into two disjoint regions: the
\fIconsumed region\fR
and the
-\fIremaining region\fR. The union of these two regions is the used region. The consumed region extends from the beginning of the used region to the byte before the
+\fIremaining region\fR\&. The union of these two regions is the used region\&. The consumed region extends from the beginning of the used region to the byte before the
\fIcurrent\fR
-offset (if any). The
+offset (if any)\&. The
\fIremaining\fR
-region the current pointer to the end of the used region. The size of the consumed region can be changed using various buffer commands. Initially, the consumed region is empty.
+region the current pointer to the end of the used region\&. The size of the consumed region can be changed using various buffer commands\&. Initially, the consumed region is empty\&.
.PP
The
\fIactive region\fR
-is an (optional) subregion of the remaining region. It extends from the current offset to an offset in the remaining region. Initially, the active region is empty. If the current offset advances beyond the chosen offset, the active region will also be empty.
+is an (optional) subregion of the remaining region\&. It extends from the current offset to an offset in the remaining region\&. Initially, the active region is empty\&. If the current offset advances beyond the chosen offset, the active region will also be empty\&.
.PP
+.if n \{\
.RS 4
+.\}
.nf
- /\-\-\-\-\-\-\-\-\-\-\-\-entire length\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\\\\
- /\-\-\-\-\- used region \-\-\-\-\-\\\\/\-\- available \-\-\\\\
+ /\-\-\-\-\-\-\-\-\-\-\-\-entire length\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\e\e
+ /\-\-\-\-\- used region \-\-\-\-\-\e\e/\-\- available \-\-\e\e
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| consumed | remaining | |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
a b c d e
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
- a == base of buffer.
- b == current pointer. Can be anywhere between a and d.
- c == active pointer. Meaningful between b and d.
- d == used pointer.
- e == length of buffer.
+ a == base of buffer\&.
+ b == current pointer\&. Can be anywhere between a and d\&.
+ c == active pointer\&. Meaningful between b and d\&.
+ d == used pointer\&.
+ e == length of buffer\&.
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
- a\-e == entire length of buffer.
- a\-d == used region.
- a\-b == consumed region.
- b\-d == remaining region.
- b\-c == optional active region.
+ a\-e == entire length of buffer\&.
+ a\-d == used region\&.
+ a\-b == consumed region\&.
+ b\-d == remaining region\&.
+ b\-c == optional active region\&.
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
\fBlwres_buffer_init()\fR
initializes the
and assocates it with the memory region of size
\fIlength\fR
bytes starting at location
-\fIbase.\fR
+\fIbase\&.\fR
.PP
\fBlwres_buffer_invalidate()\fR
marks the buffer
\fI*b\fR
-as invalid. Invalidating a buffer after use is not required, but makes it possible to catch its possible accidental use.
+as invalid\&. Invalidating a buffer after use is not required, but makes it possible to catch its possible accidental use\&.
.PP
The functions
\fBlwres_buffer_add()\fR
\fI*b\fR
by
\fIn\fR
-bytes.
+bytes\&.
\fBlwres_buffer_add()\fR
checks for buffer overflow and
\fBlwres_buffer_subtract()\fR
-checks for underflow. These functions do not allocate or deallocate memory. They just change the value of
-used.
+checks for underflow\&. These functions do not allocate or deallocate memory\&. They just change the value of
+\fIused\fR\&.
.PP
A buffer is re\-initialised by
-\fBlwres_buffer_clear()\fR. The function sets
-used,
-current
+\fBlwres_buffer_clear()\fR\&. The function sets
+\fIused\fR,
+\fIcurrent\fR
and
-active
-to zero.
+\fIactive\fR
+to zero\&.
.PP
\fBlwres_buffer_first\fR
makes the consumed region of buffer
\fI*p\fR
empty by setting
-current
-to zero (the start of the buffer).
+\fIcurrent\fR
+to zero (the start of the buffer)\&.
.PP
\fBlwres_buffer_forward()\fR
increases the consumed region of buffer
\fI*b\fR
by
\fIn\fR
-bytes, checking for overflow. Similarly,
+bytes, checking for overflow\&. Similarly,
\fBlwres_buffer_back()\fR
decreases buffer
-\fIb\fR's consumed region by
+\fIb\fR\*(Aqs consumed region by
\fIn\fR
-bytes and checks for underflow.
+bytes and checks for underflow\&.
.PP
\fBlwres_buffer_getuint8()\fR
reads an unsigned 8\-bit integer from
\fI*b\fR
-and returns it.
+and returns it\&.
\fBlwres_buffer_putuint8()\fR
writes the unsigned 8\-bit integer
\fIval\fR
to buffer
-\fI*b\fR.
+\fI*b\fR\&.
.PP
\fBlwres_buffer_getuint16()\fR
and
are identical to
\fBlwres_buffer_putuint8()\fR
except that they respectively read an unsigned 16\-bit or 32\-bit integer in network byte order from
-\fIb\fR. Similarly,
+\fIb\fR\&. Similarly,
\fBlwres_buffer_putuint16()\fR
and
\fBlwres_buffer_putuint32()\fR
writes the unsigned 16\-bit or 32\-bit integer
\fIval\fR
to buffer
-\fIb\fR, in network byte order.
+\fIb\fR, in network byte order\&.
.PP
Arbitrary amounts of data are read or written from a lightweight resolver buffer with
\fBlwres_buffer_getmem()\fR
and
\fBlwres_buffer_putmem()\fR
-respectively.
+respectively\&.
\fBlwres_buffer_putmem()\fR
copies
\fIlength\fR
bytes of memory at
\fIbase\fR
to
-\fIb\fR. Conversely,
+\fIb\fR\&. Conversely,
\fBlwres_buffer_getmem()\fR
copies
\fIlength\fR
bytes of memory from
\fIb\fR
to
-\fIbase\fR.
+\fIbase\fR\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_buffer</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_buffer">
+<a name="idp60843600"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_buffer_init, lwres_buffer_invalidate, lwres_buffer_add, lwres_buffer_subtract, lwres_buffer_clear, lwres_buffer_first, lwres_buffer_forward, lwres_buffer_back, lwres_buffer_getuint8, lwres_buffer_putuint8, lwres_buffer_getuint16, lwres_buffer_putuint16, lwres_buffer_getuint32, lwres_buffer_putuint32, lwres_buffer_putmem, lwres_buffer_getmem — lightweight resolver buffer management</p>
+<p>
+ lwres_buffer_init,
+ lwres_buffer_invalidate,
+ lwres_buffer_add,
+ lwres_buffer_subtract,
+ lwres_buffer_clear,
+ lwres_buffer_first,
+ lwres_buffer_forward,
+ lwres_buffer_back,
+ lwres_buffer_getuint8,
+ lwres_buffer_putuint8,
+ lwres_buffer_getuint16,
+ lwres_buffer_putuint16,
+ lwres_buffer_getuint32,
+ lwres_buffer_putuint32,
+ lwres_buffer_putmem,
+ lwres_buffer_getmem
+ — lightweight resolver buffer management
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">
#include <lwres/lwbuffer.h>
</pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_init</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>void * </td>
-<td>
-<var class="pdparam">base</var>, </td>
+<td>void *<var class="pdparam">base</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">length</var><code>)</code>;</td>
+<td>unsigned int <var class="pdparam">length</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_invalidate</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_add</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">n</var><code>)</code>;</td>
+<td>unsigned int <var class="pdparam">n</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_subtract</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">n</var><code>)</code>;</td>
+<td>unsigned int <var class="pdparam">n</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_clear</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_first</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_forward</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">n</var><code>)</code>;</td>
+<td>unsigned int <var class="pdparam">n</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_back</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">n</var><code>)</code>;</td>
+<td>unsigned int <var class="pdparam">n</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
lwres_uint8_t
<b class="fsfunc">lwres_buffer_getuint8</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_putuint8</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_uint8_t </td>
-<td>
-<var class="pdparam">val</var><code>)</code>;</td>
+<td>lwres_uint8_t <var class="pdparam">val</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
lwres_uint16_t
<b class="fsfunc">lwres_buffer_getuint16</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_putuint16</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_uint16_t </td>
-<td>
-<var class="pdparam">val</var><code>)</code>;</td>
+<td>lwres_uint16_t <var class="pdparam">val</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
lwres_uint32_t
<b class="fsfunc">lwres_buffer_getuint32</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_putuint32</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_uint32_t </td>
-<td>
-<var class="pdparam">val</var><code>)</code>;</td>
+<td>lwres_uint32_t <var class="pdparam">val</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_putmem</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>const unsigned char * </td>
-<td>
-<var class="pdparam">base</var>, </td>
+<td>const unsigned char *<var class="pdparam">base</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">length</var><code>)</code>;</td>
+<td>unsigned int <var class="pdparam">length</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_getmem</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned char * </td>
-<td>
-<var class="pdparam">base</var>, </td>
+<td>unsigned char *<var class="pdparam">base</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">length</var><code>)</code>;</td>
+<td>unsigned int <var class="pdparam">length</var><code>)</code>;</td>
</tr>
</table>
+<div class="funcprototype-spacer"> </div>
+
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543904"></a><h2>DESCRIPTION</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60932304"></a><h2>DESCRIPTION</h2>
+
+
+ <p>
These functions provide bounds checked access to a region of memory
where data is being read or written.
They are based on, and similar to, the
<code class="literal">isc_buffer_</code>
functions in the ISC library.
</p>
-<p>
+ <p>
A buffer is a region of memory, together with a set of related
subregions.
The <span class="emphasis"><em>used region</em></span> and the
buffer commands.
Initially, the used region is empty.
</p>
-<p>
+ <p>
The used region is further subdivided into two disjoint regions: the
<span class="emphasis"><em>consumed region</em></span> and the <span class="emphasis"><em>remaining region</em></span>.
The union of these two regions is the used region.
buffer commands.
Initially, the consumed region is empty.
</p>
-<p>
+ <p>
The <span class="emphasis"><em>active region</em></span> is an (optional) subregion of the
remaining
region.
If the current offset advances beyond the chosen offset,
the active region will also be empty.
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
/------------entire length---------------\\
/----- used region -----\\/-- available --\\
+----------------------------------------+
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
a == base of buffer.
b == current pointer. Can be anywhere between a and d.
c == active pointer. Meaningful between b and d.
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
a-e == entire length of buffer.
a-d == used region.
a-b == consumed region.
</pre>
<p>
</p>
-<p><code class="function">lwres_buffer_init()</code>
+ <p><code class="function">lwres_buffer_init()</code>
initializes the
<span class="type">lwres_buffer_t</span>
<em class="parameter"><code>*b</code></em>
bytes starting at location
<em class="parameter"><code>base.</code></em>
</p>
-<p><code class="function">lwres_buffer_invalidate()</code>
+ <p><code class="function">lwres_buffer_invalidate()</code>
marks the buffer <em class="parameter"><code>*b</code></em>
as invalid. Invalidating a buffer after use is not required,
but makes it possible to catch its possible accidental use.
</p>
-<p>
+ <p>
The functions
<code class="function">lwres_buffer_add()</code>
and
checks for underflow.
These functions do not allocate or deallocate memory.
They just change the value of
- <em class="structfield"><code>used</code></em>.
+ <code class="varname">used</code>.
</p>
-<p>
+ <p>
A buffer is re-initialised by
<code class="function">lwres_buffer_clear()</code>.
The function sets
- <em class="structfield"><code>used</code></em>,
- <em class="structfield"><code>current</code></em>
+ <code class="varname">used</code>,
+ <code class="varname">current</code>
and
- <em class="structfield"><code>active</code></em>
+ <code class="varname">active</code>
to zero.
</p>
-<p><code class="function">lwres_buffer_first</code>
+ <p><code class="function">lwres_buffer_first</code>
makes the consumed region of buffer
<em class="parameter"><code>*p</code></em>
empty by setting
- <em class="structfield"><code>current</code></em>
+ <code class="varname">current</code>
to zero (the start of the buffer).
</p>
-<p><code class="function">lwres_buffer_forward()</code>
+ <p><code class="function">lwres_buffer_forward()</code>
increases the consumed region of buffer
<em class="parameter"><code>*b</code></em>
by
<em class="parameter"><code>n</code></em>
bytes and checks for underflow.
</p>
-<p><code class="function">lwres_buffer_getuint8()</code>
+ <p><code class="function">lwres_buffer_getuint8()</code>
reads an unsigned 8-bit integer from
<em class="parameter"><code>*b</code></em>
and returns it.
to buffer
<em class="parameter"><code>*b</code></em>.
</p>
-<p><code class="function">lwres_buffer_getuint16()</code>
+ <p><code class="function">lwres_buffer_getuint16()</code>
and
<code class="function">lwres_buffer_getuint32()</code>
are identical to
<em class="parameter"><code>b</code></em>,
in network byte order.
</p>
-<p>
+ <p>
Arbitrary amounts of data are read or written from a lightweight
resolver buffer with
<code class="function">lwres_buffer_getmem()</code>
to
<em class="parameter"><code>base</code></em>.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_config
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_CONFIG" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_CONFIG" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get \- lightweight resolver configuration
.SH "SYNOPSIS"
.nf
-#include <lwres/lwres.h>
+#include <lwres/lwres\&.h>
.fi
-.HP 21
+.HP \w'void\ lwres_conf_init('u
.BI "void lwres_conf_init(lwres_context_t\ *" "ctx" ");"
-.HP 22
+.HP \w'void\ lwres_conf_clear('u
.BI "void lwres_conf_clear(lwres_context_t\ *" "ctx" ");"
-.HP 32
+.HP \w'lwres_result_t\ lwres_conf_parse('u
.BI "lwres_result_t lwres_conf_parse(lwres_context_t\ *" "ctx" ", const\ char\ *" "filename" ");"
-.HP 32
+.HP \w'lwres_result_t\ lwres_conf_print('u
.BI "lwres_result_t lwres_conf_print(lwres_context_t\ *" "ctx" ", FILE\ *" "fp" ");"
-.HP 30
+.HP \w'lwres_conf_t\ *\ lwres_conf_get('u
.BI "lwres_conf_t * lwres_conf_get(lwres_context_t\ *" "ctx" ");"
.SH "DESCRIPTION"
.PP
creates an empty
\fBlwres_conf_t\fR
structure for lightweight resolver context
-\fIctx\fR.
+\fIctx\fR\&.
.PP
\fBlwres_conf_clear()\fR
frees up all the internal memory used by that
\fBlwres_conf_t\fR
structure in resolver context
-\fIctx\fR.
+\fIctx\fR\&.
.PP
\fBlwres_conf_parse()\fR
opens the file
\fIfilename\fR
and parses it to initialise the resolver context
-\fIctx\fR's
+\fIctx\fR\*(Aqs
\fBlwres_conf_t\fR
-structure.
+structure\&.
.PP
\fBlwres_conf_print()\fR
prints the
\fIctx\fR
to the
\fBFILE\fR
-\fIfp\fR.
+\fIfp\fR\&.
.SH "RETURN VALUES"
.PP
\fBlwres_conf_parse()\fR
returns
\fBLWRES_R_SUCCESS\fR
if it successfully read and parsed
-\fIfilename\fR. It returns
+\fIfilename\fR\&. It returns
\fBLWRES_R_FAILURE\fR
if
\fIfilename\fR
-could not be opened or contained incorrect resolver statements.
+could not be opened or contained incorrect resolver statements\&.
.PP
\fBlwres_conf_print()\fR
returns
\fBLWRES_R_SUCCESS\fR
-unless an error occurred when converting the network addresses to a numeric host address string. If this happens, the function returns
-\fBLWRES_R_FAILURE\fR.
+unless an error occurred when converting the network addresses to a numeric host address string\&. If this happens, the function returns
+\fBLWRES_R_FAILURE\fR\&.
.SH "SEE ALSO"
.PP
\fBstdio\fR(3),
-\fBresolver\fR(5).
+\fBresolver\fR(5)\&.
.SH "FILES"
.PP
-\fI/etc/resolv.conf\fR
+/etc/resolv\&.conf
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_config</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_config">
+<a name="idp60783312"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get — lightweight resolver configuration</p>
+<p>
+ lwres_conf_init,
+ lwres_conf_clear,
+ lwres_conf_parse,
+ lwres_conf_print,
+ lwres_conf_get
+ — lightweight resolver configuration
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_conf_init</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var><code>)</code>;</td>
+<td>lwres_context_t *<var class="pdparam">ctx</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_conf_clear</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var><code>)</code>;</td>
+<td>lwres_context_t *<var class="pdparam">ctx</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_conf_parse</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>const char * </td>
-<td>
-<var class="pdparam">filename</var><code>)</code>;</td>
+<td>const char *<var class="pdparam">filename</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_conf_print</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>FILE * </td>
-<td>
-<var class="pdparam">fp</var><code>)</code>;</td>
+<td>FILE *<var class="pdparam">fp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
lwres_conf_t *
<b class="fsfunc">lwres_conf_get</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var><code>)</code>;</td>
+<td>lwres_context_t *<var class="pdparam">ctx</var><code>)</code>;</td>
</tr></table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543452"></a><h2>DESCRIPTION</h2>
-<p><code class="function">lwres_conf_init()</code>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60858448"></a><h2>DESCRIPTION</h2>
+
+
+ <p><code class="function">lwres_conf_init()</code>
creates an empty
<span class="type">lwres_conf_t</span>
structure for lightweight resolver context
<em class="parameter"><code>ctx</code></em>.
</p>
-<p><code class="function">lwres_conf_clear()</code>
+
+ <p><code class="function">lwres_conf_clear()</code>
frees up all the internal memory used by
that
<span class="type">lwres_conf_t</span>
structure in resolver context
<em class="parameter"><code>ctx</code></em>.
</p>
-<p><code class="function">lwres_conf_parse()</code>
+
+ <p><code class="function">lwres_conf_parse()</code>
opens the file
<em class="parameter"><code>filename</code></em>
and parses it to initialise the resolver context
<span class="type">lwres_conf_t</span>
structure.
</p>
-<p><code class="function">lwres_conf_print()</code>
+
+ <p><code class="function">lwres_conf_print()</code>
prints the
<span class="type">lwres_conf_t</span>
structure for resolver context
<span class="type">FILE</span>
<em class="parameter"><code>fp</code></em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543520"></a><h2>RETURN VALUES</h2>
-<p><code class="function">lwres_conf_parse()</code>
+ </div>
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60870480"></a><h2>RETURN VALUES</h2>
+
+
+
+ <p><code class="function">lwres_conf_parse()</code>
returns <span class="errorcode">LWRES_R_SUCCESS</span>
if it successfully read and parsed
<em class="parameter"><code>filename</code></em>.
could not be opened or contained incorrect
resolver statements.
</p>
-<p><code class="function">lwres_conf_print()</code>
+
+ <p><code class="function">lwres_conf_print()</code>
returns <span class="errorcode">LWRES_R_SUCCESS</span>
unless an error occurred when converting the network addresses to a
numeric host address string.
If this happens, the function returns
<span class="errorcode">LWRES_R_FAILURE</span>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543557"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">stdio</span>(3)</span>,
- <span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>.
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60875088"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">stdio</span>(3)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">resolver</span>(5)
+ </span>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543582"></a><h2>FILES</h2>
-<p><code class="filename">/etc/resolv.conf</code>
+ </div>
+ <div class="refsection" title="FILES">
+<a name="idp60878544"></a><h2>FILES</h2>
+
+ <p><code class="filename">/etc/resolv.conf</code>
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_context
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_CONTEXT" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_CONTEXT" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_context_create, lwres_context_destroy, lwres_context_nextserial, lwres_context_initserial, lwres_context_freemem, lwres_context_allocmem, lwres_context_sendrecv \- lightweight resolver context management
.SH "SYNOPSIS"
.nf
-#include <lwres/lwres.h>
+#include <lwres/lwres\&.h>
.fi
-.HP 36
+.HP \w'lwres_result_t\ lwres_context_create('u
.BI "lwres_result_t lwres_context_create(lwres_context_t\ **" "contextp" ", void\ *" "arg" ", lwres_malloc_t\ " "malloc_function" ", lwres_free_t\ " "free_function" ");"
-.HP 37
+.HP \w'lwres_result_t\ lwres_context_destroy('u
.BI "lwres_result_t lwres_context_destroy(lwres_context_t\ **" "contextp" ");"
-.HP 30
+.HP \w'void\ lwres_context_initserial('u
.BI "void lwres_context_initserial(lwres_context_t\ *" "ctx" ", lwres_uint32_t\ " "serial" ");"
-.HP 40
+.HP \w'lwres_uint32_t\ lwres_context_nextserial('u
.BI "lwres_uint32_t lwres_context_nextserial(lwres_context_t\ *" "ctx" ");"
-.HP 27
+.HP \w'void\ lwres_context_freemem('u
.BI "void lwres_context_freemem(lwres_context_t\ *" "ctx" ", void\ *" "mem" ", size_t\ " "len" ");"
-.HP 28
+.HP \w'void\ lwres_context_allocmem('u
.BI "void lwres_context_allocmem(lwres_context_t\ *" "ctx" ", size_t\ " "len" ");"
-.HP 30
+.HP \w'void\ *\ lwres_context_sendrecv('u
.BI "void * lwres_context_sendrecv(lwres_context_t\ *" "ctx" ", void\ *" "sendbase" ", int\ " "sendlen" ", void\ *" "recvbase" ", int\ " "recvlen" ", int\ *" "recvd_len" ");"
.SH "DESCRIPTION"
.PP
\fBlwres_context_create()\fR
creates a
\fBlwres_context_t\fR
-structure for use in lightweight resolver operations. It holds a socket and other data needed for communicating with a resolver daemon. The new
+structure for use in lightweight resolver operations\&. It holds a socket and other data needed for communicating with a resolver daemon\&. The new
\fBlwres_context_t\fR
is returned through
\fIcontextp\fR, a pointer to a
\fBlwres_context_t\fR
-pointer. This
+pointer\&. This
\fBlwres_context_t\fR
pointer must initially be NULL, and is modified to point to the newly created
-\fBlwres_context_t\fR.
+\fBlwres_context_t\fR\&.
.PP
When the lightweight resolver needs to perform dynamic memory allocation, it will call
\fImalloc_function\fR
to allocate memory and
\fIfree_function\fR
-to free it. If
+to free it\&. If
\fImalloc_function\fR
and
\fIfree_function\fR
are NULL, memory is allocated using
-\fBmalloc\fR(3). and
-\fBfree\fR(3). It is not permitted to have a NULL
+\fBmalloc\fR(3)\&. and
+\fBfree\fR(3)\&. It is not permitted to have a NULL
\fImalloc_function\fR
and a non\-NULL
\fIfree_function\fR
-or vice versa.
+or vice versa\&.
\fIarg\fR
-is passed as the first parameter to the memory allocation functions. If
+is passed as the first parameter to the memory allocation functions\&. If
\fImalloc_function\fR
and
\fIfree_function\fR
are NULL,
\fIarg\fR
-is unused and should be passed as NULL.
+is unused and should be passed as NULL\&.
.PP
Once memory for the structure has been allocated, it is initialized using
\fBlwres_conf_init\fR(3)
and returned via
-\fI*contextp\fR.
+\fI*contextp\fR\&.
.PP
\fBlwres_context_destroy()\fR
destroys a
-\fBlwres_context_t\fR, closing its socket.
+\fBlwres_context_t\fR, closing its socket\&.
\fIcontextp\fR
-is a pointer to a pointer to the context that is to be destroyed. The pointer will be set to NULL when the context has been destroyed.
+is a pointer to a pointer to the context that is to be destroyed\&. The pointer will be set to NULL when the context has been destroyed\&.
.PP
-The context holds a serial number that is used to identify resolver request packets and associate responses with the corresponding requests. This serial number is controlled using
+The context holds a serial number that is used to identify resolver request packets and associate responses with the corresponding requests\&. This serial number is controlled using
\fBlwres_context_initserial()\fR
and
-\fBlwres_context_nextserial()\fR.
+\fBlwres_context_nextserial()\fR\&.
\fBlwres_context_initserial()\fR
sets the serial number for context
\fI*ctx\fR
to
-\fIserial\fR.
+\fIserial\fR\&.
\fBlwres_context_nextserial()\fR
-increments the serial number and returns the previous value.
+increments the serial number and returns the previous value\&.
.PP
Memory for a lightweight resolver context is allocated and freed using
\fBlwres_context_allocmem()\fR
and
-\fBlwres_context_freemem()\fR. These use whatever allocations were defined when the context was created with
-\fBlwres_context_create()\fR.
+\fBlwres_context_freemem()\fR\&. These use whatever allocations were defined when the context was created with
+\fBlwres_context_create()\fR\&.
\fBlwres_context_allocmem()\fR
allocates
\fIlen\fR
-bytes of memory and if successful returns a pointer to the allocated storage.
+bytes of memory and if successful returns a pointer to the allocated storage\&.
\fBlwres_context_freemem()\fR
frees
\fIlen\fR
bytes of space starting at location
-\fImem\fR.
+\fImem\fR\&.
.PP
\fBlwres_context_sendrecv()\fR
performs I/O for the context
-\fIctx\fR. Data are read and written from the context's socket. It writes data from
+\fIctx\fR\&. Data are read and written from the context\*(Aqs socket\&. It writes data from
\fIsendbase\fR
\(em typically a lightweight resolver query packet \(em and waits for a reply which is copied to the receive buffer at
-\fIrecvbase\fR. The number of bytes that were written to this receive buffer is returned in
-\fI*recvd_len\fR.
+\fIrecvbase\fR\&. The number of bytes that were written to this receive buffer is returned in
+\fI*recvd_len\fR\&.
.SH "RETURN VALUES"
.PP
\fBlwres_context_create()\fR
\fBstruct lwres_context\fR
could not be allocated,
\fBLWRES_R_SUCCESS\fR
-otherwise.
+otherwise\&.
.PP
Successful calls to the memory allocator
\fBlwres_context_allocmem()\fR
-return a pointer to the start of the allocated space. It returns NULL if memory could not be allocated.
+return a pointer to the start of the allocated space\&. It returns NULL if memory could not be allocated\&.
.PP
\fBLWRES_R_SUCCESS\fR
is returned when
\fBlwres_context_sendrecv()\fR
-completes successfully.
+completes successfully\&.
\fBLWRES_R_IOERROR\fR
is returned if an I/O error occurs and
\fBLWRES_R_TIMEOUT\fR
is returned if
\fBlwres_context_sendrecv()\fR
-times out waiting for a response.
+times out waiting for a response\&.
.SH "SEE ALSO"
.PP
\fBlwres_conf_init\fR(3),
\fBmalloc\fR(3),
-\fBfree\fR(3).
+\fBfree\fR(3)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_context</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_context">
+<a name="idp60895824"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_context_create, lwres_context_destroy, lwres_context_nextserial, lwres_context_initserial, lwres_context_freemem, lwres_context_allocmem, lwres_context_sendrecv — lightweight resolver context management</p>
+<p>
+ lwres_context_create,
+ lwres_context_destroy,
+ lwres_context_nextserial,
+ lwres_context_initserial,
+ lwres_context_freemem,
+ lwres_context_allocmem,
+ lwres_context_sendrecv
+ — lightweight resolver context management
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_context_create</b>(</code></td>
-<td>lwres_context_t ** </td>
-<td>
-<var class="pdparam">contextp</var>, </td>
+<td>lwres_context_t **<var class="pdparam">contextp</var>, </td>
</tr>
<tr>
<td> </td>
-<td>void * </td>
-<td>
-<var class="pdparam">arg</var>, </td>
+<td>void *<var class="pdparam">arg</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_malloc_t </td>
-<td>
-<var class="pdparam">malloc_function</var>, </td>
+<td>lwres_malloc_t <var class="pdparam">malloc_function</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_free_t </td>
-<td>
-<var class="pdparam">free_function</var><code>)</code>;</td>
+<td>lwres_free_t <var class="pdparam">free_function</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_context_destroy</b>(</code></td>
-<td>lwres_context_t ** </td>
-<td>
-<var class="pdparam">contextp</var><code>)</code>;</td>
+<td>lwres_context_t **<var class="pdparam">contextp</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_context_initserial</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_uint32_t </td>
-<td>
-<var class="pdparam">serial</var><code>)</code>;</td>
+<td>lwres_uint32_t <var class="pdparam">serial</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
lwres_uint32_t
<b class="fsfunc">lwres_context_nextserial</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var><code>)</code>;</td>
+<td>lwres_context_t *<var class="pdparam">ctx</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_context_freemem</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>void * </td>
-<td>
-<var class="pdparam">mem</var>, </td>
+<td>void *<var class="pdparam">mem</var>, </td>
</tr>
<tr>
<td> </td>
-<td>size_t </td>
-<td>
-<var class="pdparam">len</var><code>)</code>;</td>
+<td>size_t <var class="pdparam">len</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_context_allocmem</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>size_t </td>
-<td>
-<var class="pdparam">len</var><code>)</code>;</td>
+<td>size_t <var class="pdparam">len</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void *
<b class="fsfunc">lwres_context_sendrecv</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>void * </td>
-<td>
-<var class="pdparam">sendbase</var>, </td>
+<td>void *<var class="pdparam">sendbase</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">sendlen</var>, </td>
+<td>int <var class="pdparam">sendlen</var>, </td>
</tr>
<tr>
<td> </td>
-<td>void * </td>
-<td>
-<var class="pdparam">recvbase</var>, </td>
+<td>void *<var class="pdparam">recvbase</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">recvlen</var>, </td>
+<td>int <var class="pdparam">recvlen</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int * </td>
-<td>
-<var class="pdparam">recvd_len</var><code>)</code>;</td>
+<td>int *<var class="pdparam">recvd_len</var><code>)</code>;</td>
</tr>
</table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543543"></a><h2>DESCRIPTION</h2>
-<p><code class="function">lwres_context_create()</code>
+ </div>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60941008"></a><h2>DESCRIPTION</h2>
+
+
+ <p><code class="function">lwres_context_create()</code>
creates a <span class="type">lwres_context_t</span> structure for use in
lightweight resolver operations. It holds a socket and other
data needed for communicating with a resolver daemon. The new
is modified to point to the newly created
<span class="type">lwres_context_t</span>.
</p>
-<p>
+ <p>
When the lightweight resolver needs to perform dynamic memory
allocation, it will call
<em class="parameter"><code>malloc_function</code></em>
and
<em class="parameter"><code>free_function</code></em>
are NULL, memory is allocated using
- <span class="citerefentry"><span class="refentrytitle">malloc</span>(3)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">malloc</span>(3)
+ </span>.
and
- <span class="citerefentry"><span class="refentrytitle">free</span>(3)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">free</span>(3)
+ </span>.
It is not permitted to have a NULL
<em class="parameter"><code>malloc_function</code></em> and a non-NULL
<em class="parameter"><code>arg</code></em> is unused and should be passed as
NULL.
</p>
-<p>
+
+ <p>
Once memory for the structure has been allocated,
it is initialized using
- <span class="citerefentry"><span class="refentrytitle">lwres_conf_init</span>(3)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_conf_init</span>(3)
+ </span>
and returned via <em class="parameter"><code>*contextp</code></em>.
</p>
-<p><code class="function">lwres_context_destroy()</code>
+
+ <p><code class="function">lwres_context_destroy()</code>
destroys a <span class="type">lwres_context_t</span>, closing its socket.
<em class="parameter"><code>contextp</code></em> is a pointer to a pointer to the
context that is to be destroyed. The pointer will be set to
NULL when the context has been destroyed.
</p>
-<p>
+
+ <p>
The context holds a serial number that is used to identify
resolver request packets and associate responses with the
corresponding requests. This serial number is controlled using
<code class="function">lwres_context_nextserial()</code> increments the
serial number and returns the previous value.
</p>
-<p>
+
+ <p>
Memory for a lightweight resolver context is allocated and freed
using <code class="function">lwres_context_allocmem()</code> and
<code class="function">lwres_context_freemem()</code>. These use
<em class="parameter"><code>len</code></em> bytes of space starting at location
<em class="parameter"><code>mem</code></em>.
</p>
-<p><code class="function">lwres_context_sendrecv()</code>
+
+ <p><code class="function">lwres_context_sendrecv()</code>
performs I/O for the context <em class="parameter"><code>ctx</code></em>. Data
are read and written from the context's socket. It writes data
from <em class="parameter"><code>sendbase</code></em> — typically a
written to this receive buffer is returned in
<em class="parameter"><code>*recvd_len</code></em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543731"></a><h2>RETURN VALUES</h2>
-<p><code class="function">lwres_context_create()</code>
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60967120"></a><h2>RETURN VALUES</h2>
+
+
+ <p><code class="function">lwres_context_create()</code>
returns <span class="errorcode">LWRES_R_NOMEMORY</span> if memory for
the <span class="type">struct lwres_context</span> could not be allocated,
<span class="errorcode">LWRES_R_SUCCESS</span> otherwise.
</p>
-<p>
+ <p>
Successful calls to the memory allocator
<code class="function">lwres_context_allocmem()</code>
return a pointer to the start of the allocated space.
It returns NULL if memory could not be allocated.
</p>
-<p><span class="errorcode">LWRES_R_SUCCESS</span>
+ <p><span class="errorcode">LWRES_R_SUCCESS</span>
is returned when
<code class="function">lwres_context_sendrecv()</code>
completes successfully.
<code class="function">lwres_context_sendrecv()</code>
times out waiting for a response.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543781"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">lwres_conf_init</span>(3)</span>,
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60973136"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres_conf_init</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">malloc</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">malloc</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">free</span>(3)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">free</span>(3)
+ </span>.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_gabn
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_GABN" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_GABN" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lwres_gabnresponse_parse, lwres_gabnresponse_free, lwres_gabnrequest_free \- lightweight resolver getaddrbyname message handling
.SH "SYNOPSIS"
.nf
-#include <lwres/lwres.h>
+#include <lwres/lwres\&.h>
.fi
-.HP 40
+.HP \w'lwres_result_t\ lwres_gabnrequest_render('u
.BI "lwres_result_t lwres_gabnrequest_render(lwres_context_t\ *" "ctx" ", lwres_gabnrequest_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");"
-.HP 41
+.HP \w'lwres_result_t\ lwres_gabnresponse_render('u
.BI "lwres_result_t lwres_gabnresponse_render(lwres_context_t\ *" "ctx" ", lwres_gabnresponse_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");"
-.HP 39
+.HP \w'lwres_result_t\ lwres_gabnrequest_parse('u
.BI "lwres_result_t lwres_gabnrequest_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gabnrequest_t\ **" "structp" ");"
-.HP 40
+.HP \w'lwres_result_t\ lwres_gabnresponse_parse('u
.BI "lwres_result_t lwres_gabnresponse_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gabnresponse_t\ **" "structp" ");"
-.HP 29
+.HP \w'void\ lwres_gabnresponse_free('u
.BI "void lwres_gabnresponse_free(lwres_context_t\ *" "ctx" ", lwres_gabnresponse_t\ **" "structp" ");"
-.HP 28
+.HP \w'void\ lwres_gabnrequest_free('u
.BI "void lwres_gabnrequest_free(lwres_context_t\ *" "ctx" ", lwres_gabnrequest_t\ **" "structp" ");"
.SH "DESCRIPTION"
.PP
-These are low\-level routines for creating and parsing lightweight resolver name\-to\-address lookup request and response messages.
+These are low\-level routines for creating and parsing lightweight resolver name\-to\-address lookup request and response messages\&.
.PP
-There are four main functions for the getaddrbyname opcode. One render function converts a getaddrbyname request structure \(em
+There are four main functions for the getaddrbyname opcode\&. One render function converts a getaddrbyname request structure \(em
\fBlwres_gabnrequest_t\fR
-\(em to the lightweight resolver's canonical format. It is complemented by a parse function that converts a packet in this canonical format to a getaddrbyname request structure. Another render function converts the getaddrbyname response structure \(em
+\(em to the lightweight resolver\*(Aqs canonical format\&. It is complemented by a parse function that converts a packet in this canonical format to a getaddrbyname request structure\&. Another render function converts the getaddrbyname response structure \(em
\fBlwres_gabnresponse_t\fR
-\(em to the canonical format. This is complemented by a parse function which converts a packet in canonical format to a getaddrbyname response structure.
+\(em to the canonical format\&. This is complemented by a parse function which converts a packet in canonical format to a getaddrbyname response structure\&.
.PP
These structures are defined in
-\fI<lwres/lwres.h>\fR. They are shown below.
+<lwres/lwres\&.h>\&. They are shown below\&.
.PP
+.if n \{\
.RS 4
+.\}
.nf
#define LWRES_OPCODE_GETADDRSBYNAME 0x00010001U
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
typedef struct lwres_addr lwres_addr_t;
typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t;
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
typedef struct {
lwres_uint32_t flags;
char *name;
} lwres_gabnrequest_t;
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
typedef struct {
lwres_uint32_t flags;
size_t baselen;
} lwres_gabnresponse_t;
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
\fBlwres_gabnrequest_render()\fR
uses resolver context
\fIctx\fR
to convert getaddrbyname request structure
\fIreq\fR
-to canonical format. The packet header structure
+to canonical format\&. The packet header structure
\fIpkt\fR
is initialised and transferred to buffer
-\fIb\fR. The contents of
+\fIb\fR\&. The contents of
\fI*req\fR
-are then appended to the buffer in canonical format.
+are then appended to the buffer in canonical format\&.
\fBlwres_gabnresponse_render()\fR
performs the same task, except it converts a getaddrbyname response structure
\fBlwres_gabnresponse_t\fR
-to the lightweight resolver's canonical format.
+to the lightweight resolver\*(Aqs canonical format\&.
.PP
\fBlwres_gabnrequest_parse()\fR
uses context
\fIpkt\fR
to a
\fBlwres_gabnrequest_t\fR
-structure. Buffer
+structure\&. Buffer
\fIb\fR
-provides space to be used for storing this structure. When the function succeeds, the resulting
+provides space to be used for storing this structure\&. When the function succeeds, the resulting
\fBlwres_gabnrequest_t\fR
is made available through
-\fI*structp\fR.
+\fI*structp\fR\&.
\fBlwres_gabnresponse_parse()\fR
offers the same semantics as
\fBlwres_gabnrequest_parse()\fR
except it yields a
\fBlwres_gabnresponse_t\fR
-structure.
+structure\&.
.PP
\fBlwres_gabnresponse_free()\fR
and
or
\fBlwres_gabnrequest_t\fR
structures referenced via
-\fIstructp\fR. Any memory associated with ancillary buffers and strings for those structures is also discarded.
+\fIstructp\fR\&. Any memory associated with ancillary buffers and strings for those structures is also discarded\&.
.SH "RETURN VALUES"
.PP
The getaddrbyname opcode functions
\fBlwres_gabnresponse_parse()\fR
all return
\fBLWRES_R_SUCCESS\fR
-on success. They return
+on success\&. They return
\fBLWRES_R_NOMEMORY\fR
-if memory allocation fails.
+if memory allocation fails\&.
\fBLWRES_R_UNEXPECTEDEND\fR
is returned if the available space in the buffer
\fIb\fR
\fBlwres_gabnrequest_t\fR
and
\fBlwres_gabnresponse_t\fR
-structures.
+structures\&.
\fBlwres_gabnrequest_parse()\fR
and
\fBlwres_gabnresponse_parse()\fR
will return
\fBLWRES_R_UNEXPECTEDEND\fR
-if the buffer is not empty after decoding the received packet. These functions will return
+if the buffer is not empty after decoding the received packet\&. These functions will return
\fBLWRES_R_FAILURE\fR
if
-pktflags
+\fIpktflags\fR
in the packet header structure
\fBlwres_lwpacket_t\fR
-indicate that the packet is not a response to an earlier query.
+indicate that the packet is not a response to an earlier query\&.
.SH "SEE ALSO"
.PP
\fBlwres_packet\fR(3)
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_gabn</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_gabn">
+<a name="idp60913104"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lwres_gabnresponse_parse, lwres_gabnresponse_free, lwres_gabnrequest_free — lightweight resolver getaddrbyname message handling</p>
+<p>
+ lwres_gabnrequest_render,
+ lwres_gabnresponse_render,
+ lwres_gabnrequest_parse,
+ lwres_gabnresponse_parse,
+ lwres_gabnresponse_free,
+ lwres_gabnrequest_free
+ — lightweight resolver getaddrbyname message handling
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_gabnrequest_render</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gabnrequest_t * </td>
-<td>
-<var class="pdparam">req</var>, </td>
+<td>lwres_gabnrequest_t *<var class="pdparam">req</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_gabnresponse_render</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gabnresponse_t * </td>
-<td>
-<var class="pdparam">req</var>, </td>
+<td>lwres_gabnresponse_t *<var class="pdparam">req</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_gabnrequest_parse</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gabnrequest_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gabnrequest_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_gabnresponse_parse</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gabnresponse_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gabnresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_gabnresponse_free</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gabnresponse_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gabnresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_gabnrequest_free</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gabnrequest_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gabnrequest_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543533"></a><h2>DESCRIPTION</h2>
-<p>
+ </div>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60957008"></a><h2>DESCRIPTION</h2>
+
+ <p>
These are low-level routines for creating and parsing
lightweight resolver name-to-address lookup request and
response messages.
</p>
-<p>
+ <p>
There are four main functions for the getaddrbyname opcode.
One render function converts a getaddrbyname request structure —
<span class="type">lwres_gabnrequest_t</span> —
This is complemented by a parse function which converts a packet in
canonical format to a getaddrbyname response structure.
</p>
-<p>
+ <p>
These structures are defined in
<code class="filename"><lwres/lwres.h></code>.
They are shown below.
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
#define LWRES_OPCODE_GETADDRSBYNAME 0x00010001U
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
typedef struct lwres_addr lwres_addr_t;
typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t;
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
typedef struct {
lwres_uint32_t flags;
lwres_uint32_t addrtypes;
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
typedef struct {
lwres_uint32_t flags;
lwres_uint16_t naliases;
</pre>
<p>
</p>
-<p><code class="function">lwres_gabnrequest_render()</code>
+
+ <p><code class="function">lwres_gabnrequest_render()</code>
uses resolver context <em class="parameter"><code>ctx</code></em> to convert
getaddrbyname request structure <em class="parameter"><code>req</code></em> to
canonical format. The packet header structure
<span class="type">lwres_gabnresponse_t</span> to the lightweight resolver's
canonical format.
</p>
-<p><code class="function">lwres_gabnrequest_parse()</code>
+
+ <p><code class="function">lwres_gabnrequest_parse()</code>
uses context <em class="parameter"><code>ctx</code></em> to convert the contents
of packet <em class="parameter"><code>pkt</code></em> to a
<span class="type">lwres_gabnrequest_t</span> structure. Buffer
semantics as <code class="function">lwres_gabnrequest_parse()</code>
except it yields a <span class="type">lwres_gabnresponse_t</span> structure.
</p>
-<p><code class="function">lwres_gabnresponse_free()</code>
+
+ <p><code class="function">lwres_gabnresponse_free()</code>
and <code class="function">lwres_gabnrequest_free()</code> release the
memory in resolver context <em class="parameter"><code>ctx</code></em> that was
allocated to the <span class="type">lwres_gabnresponse_t</span> or
Any memory associated with ancillary buffers and strings for
those structures is also discarded.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543678"></a><h2>RETURN VALUES</h2>
-<p>
+ </div>
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60985552"></a><h2>RETURN VALUES</h2>
+
+ <p>
The getaddrbyname opcode functions
<code class="function">lwres_gabnrequest_render()</code>,
<code class="function">lwres_gabnresponse_render()</code>
These functions will return
<span class="errorcode">LWRES_R_FAILURE</span>
if
- <em class="structfield"><code>pktflags</code></em>
+ <code class="varname">pktflags</code>
in the packet header structure
<span class="type">lwres_lwpacket_t</span>
indicate that the packet is not a response to an earlier query.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543745"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">lwres_packet</span>(3)</span>
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60993360"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres_packet</span>(3)
+ </span>
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_gai_strerror
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_GAI_STRERROR" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_GAI_STRERROR" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_gai_strerror \- print suitable error string
.SH "SYNOPSIS"
.nf
-#include <lwres/netdb.h>
+#include <lwres/netdb\&.h>
.fi
-.HP 20
+.HP \w'char\ *\ gai_strerror('u
.BI "char * gai_strerror(int\ " "ecode" ");"
.SH "DESCRIPTION"
.PP
\fBlwres_gai_strerror()\fR
returns an error message corresponding to an error code returned by
-\fBgetaddrinfo()\fR. The following error codes and their meaning are defined in
-\fIinclude/lwres/netdb.h\fR.
+\fBgetaddrinfo()\fR\&. The following error codes and their meaning are defined in
+include/lwres/netdb\&.h\&.
.PP
\fBEAI_ADDRFAMILY\fR
.RS 4
invalid error code
is returned if
\fIecode\fR
-is out of range.
+is out of range\&.
.PP
\fBai_flags\fR,
\fBai_family\fR
are elements of the
\fBstruct addrinfo\fR
used by
-\fBlwres_getaddrinfo()\fR.
+\fBlwres_getaddrinfo()\fR\&.
.SH "SEE ALSO"
.PP
\fBstrerror\fR(3),
\fBlwres_getaddrinfo\fR(3),
\fBgetaddrinfo\fR(3),
-\fBRFC2133\fR().
+\fBRFC2133\fR()\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_gai_strerror</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_gai_strerror">
+<a name="idp60689232"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_gai_strerror — print suitable error string</p>
+<p>
+ lwres_gai_strerror
+ — print suitable error string
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
char *
<b class="fsfunc">gai_strerror</b>(</code></td>
-<td>int </td>
-<td>
-<var class="pdparam">ecode</var><code>)</code>;</td>
+<td>int <var class="pdparam">ecode</var><code>)</code>;</td>
</tr></table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543372"></a><h2>DESCRIPTION</h2>
-<p><code class="function">lwres_gai_strerror()</code>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60725968"></a><h2>DESCRIPTION</h2>
+
+
+ <p><code class="function">lwres_gai_strerror()</code>
returns an error message corresponding to an error code returned by
<code class="function">getaddrinfo()</code>.
The following error codes and their meaning are defined in
</p>
<div class="variablelist"><dl>
<dt><span class="term"><span class="errorcode">EAI_ADDRFAMILY</span></span></dt>
-<dd><p>
+<dd>
+ <p>
address family for hostname not supported
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_AGAIN</span></span></dt>
-<dd><p>
+<dd>
+ <p>
temporary failure in name resolution
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_BADFLAGS</span></span></dt>
-<dd><p>
+<dd>
+ <p>
invalid value for
<code class="constant">ai_flags</code>
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_FAIL</span></span></dt>
-<dd><p>
+<dd>
+ <p>
non-recoverable failure in name resolution
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_FAMILY</span></span></dt>
-<dd><p><code class="constant">ai_family</code> not supported
- </p></dd>
+<dd>
+ <p><code class="constant">ai_family</code> not supported
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_MEMORY</span></span></dt>
-<dd><p>
+<dd>
+ <p>
memory allocation failure
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_NODATA</span></span></dt>
-<dd><p>
+<dd>
+ <p>
no address associated with hostname
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_NONAME</span></span></dt>
-<dd><p>
+<dd>
+ <p>
hostname or servname not provided, or not known
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_SERVICE</span></span></dt>
-<dd><p>
+<dd>
+ <p>
servname not supported for <code class="constant">ai_socktype</code>
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_SOCKTYPE</span></span></dt>
-<dd><p><code class="constant">ai_socktype</code> not supported
- </p></dd>
+<dd>
+ <p><code class="constant">ai_socktype</code> not supported
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">EAI_SYSTEM</span></span></dt>
-<dd><p>
+<dd>
+ <p>
system error returned in errno
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
The message <span class="errorname">invalid error code</span> is returned if
<em class="parameter"><code>ecode</code></em>
is out of range.
</p>
-<p><code class="constant">ai_flags</code>,
+ <p><code class="constant">ai_flags</code>,
<code class="constant">ai_family</code>
and
<code class="constant">ai_socktype</code>
used by
<code class="function">lwres_getaddrinfo()</code>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543588"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">strerror</span>(3)</span>,
+ </div>
- <span class="citerefentry"><span class="refentrytitle">lwres_getaddrinfo</span>(3)</span>,
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60755792"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">strerror</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">getaddrinfo</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_getaddrinfo</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">RFC2133</span></span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">getaddrinfo</span>(3)
+ </span>,
+
+ <span class="citerefentry">
+ <span class="refentrytitle">RFC2133</span>
+ </span>.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_getaddrinfo
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_GETADDRINFO" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_GETADDRINFO" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_getaddrinfo, lwres_freeaddrinfo \- socket address structure to host and service name
.SH "SYNOPSIS"
.nf
-#include <lwres/netdb.h>
+#include <lwres/netdb\&.h>
.fi
-.HP 22
+.HP \w'int\ lwres_getaddrinfo('u
.BI "int lwres_getaddrinfo(const\ char\ *" "hostname" ", const\ char\ *" "servname" ", const\ struct\ addrinfo\ *" "hints" ", struct\ addrinfo\ **" "res" ");"
-.HP 24
+.HP \w'void\ lwres_freeaddrinfo('u
.BI "void lwres_freeaddrinfo(struct\ addrinfo\ *" "ai" ");"
.PP
If the operating system does not provide a
\fBstruct addrinfo\fR, the following structure is used:
.PP
-.RS 4
.nf
struct addrinfo {
int ai_flags; /* AI_PASSIVE, AI_CANONNAME */
struct addrinfo *ai_next; /* next structure in linked list */
};
.fi
-.RE
.sp
.SH "DESCRIPTION"
.PP
is used to get a list of IP addresses and port numbers for host
\fIhostname\fR
and service
-\fIservname\fR. The function is the lightweight resolver's implementation of
+\fIservname\fR\&. The function is the lightweight resolver\*(Aqs implementation of
\fBgetaddrinfo()\fR
-as defined in RFC2133.
+as defined in RFC2133\&.
\fIhostname\fR
and
\fIservname\fR
are pointers to null\-terminated strings or
-\fBNULL\fR.
+\fBNULL\fR\&.
\fIhostname\fR
-is either a host name or a numeric host address string: a dotted decimal IPv4 address or an IPv6 address.
+is either a host name or a numeric host address string: a dotted decimal IPv4 address or an IPv6 address\&.
\fIservname\fR
is either a decimal port number or a service name as listed in
-\fI/etc/services\fR.
+/etc/services\&.
.PP
\fIhints\fR
is an optional pointer to a
-\fBstruct addrinfo\fR. This structure can be used to provide hints concerning the type of socket that the caller supports or wishes to use. The caller can supply the following structure elements in
+\fBstruct addrinfo\fR\&. This structure can be used to provide hints concerning the type of socket that the caller supports or wishes to use\&. The caller can supply the following structure elements in
\fI*hints\fR:
.PP
\fBai_family\fR
.RS 4
-The protocol family that should be used. When
+The protocol family that should be used\&. When
\fBai_family\fR
is set to
-\fBPF_UNSPEC\fR, it means the caller will accept any protocol family supported by the operating system.
+\fBPF_UNSPEC\fR, it means the caller will accept any protocol family supported by the operating system\&.
.RE
.PP
\fBai_socktype\fR
\fBSOCK_DGRAM\fR
or
\fBSOCK_RAW\fR
-\(em that is wanted. When
+\(em that is wanted\&. When
\fBai_socktype\fR
-is zero the caller will accept any socket type.
+is zero the caller will accept any socket type\&.
.RE
.PP
\fBai_protocol\fR
.RS 4
-indicates which transport protocol is wanted: IPPROTO_UDP or IPPROTO_TCP. If
+indicates which transport protocol is wanted: IPPROTO_UDP or IPPROTO_TCP\&. If
\fBai_protocol\fR
-is zero the caller will accept any protocol.
+is zero the caller will accept any protocol\&.
.RE
.PP
\fBai_flags\fR
.RS 4
-Flag bits. If the
+Flag bits\&. If the
\fBAI_CANONNAME\fR
bit is set, a successful call to
\fBlwres_getaddrinfo()\fR
\fBai_canonname\fR
of the first
\fBaddrinfo\fR
-structure returned. Setting the
+structure returned\&. Setting the
\fBAI_PASSIVE\fR
bit indicates that the returned socket address structure is intended for used in a call to
-\fBbind\fR(2). In this case, if the hostname argument is a
+\fBbind\fR(2)\&. In this case, if the hostname argument is a
\fBNULL\fR
pointer, then the IP address portion of the socket address structure will be set to
\fBINADDR_ANY\fR
for an IPv4 address or
\fBIN6ADDR_ANY_INIT\fR
-for an IPv6 address.
+for an IPv6 address\&.
.sp
When
\fBai_flags\fR
\fBconnect\fR(2),
\fBsendto\fR(2), or
\fBsendmsg\fR(2)
-if a connectionless protocol was chosen. The IP address portion of the socket address structure will be set to the loopback address if
+if a connectionless protocol was chosen\&. The IP address portion of the socket address structure will be set to the loopback address if
\fIhostname\fR
is a
\fBNULL\fR
pointer and
\fBAI_PASSIVE\fR
is not set in
-\fBai_flags\fR.
+\fBai_flags\fR\&.
.sp
If
\fBai_flags\fR
\fBAI_NUMERICHOST\fR
it indicates that
\fIhostname\fR
-should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted.
+should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted\&.
.RE
.PP
All other elements of the
\fBstruct addrinfo\fR
passed via
\fIhints\fR
-must be zero.
+must be zero\&.
.PP
A
\fIhints\fR
\fBstruct addrinfo\fR
initialized to zero with
\fBai_family\fRset to
-\fBPF_UNSPEC\fR.
+\fBPF_UNSPEC\fR\&.
.PP
After a successful call to
\fBlwres_getaddrinfo()\fR,
\fI*res\fR
is a pointer to a linked list of one or more
\fBaddrinfo\fR
-structures. Each
+structures\&. Each
\fBstruct addrinfo\fR
in this list cn be processed by following the
\fBai_next\fR
pointer, until a
\fBNULL\fR
-pointer is encountered. The three members
+pointer is encountered\&. The three members
\fBai_family\fR,
\fBai_socktype\fR, and
\fBai_protocol\fR
in each returned
\fBaddrinfo\fR
structure contain the corresponding arguments for a call to
-\fBsocket\fR(2). For each
+\fBsocket\fR(2)\&. For each
\fBaddrinfo\fR
structure in the list, the
\fBai_addr\fR
member points to a filled\-in socket address structure of length
-\fBai_addrlen\fR.
+\fBai_addrlen\fR\&.
.PP
All of the information returned by
\fBlwres_getaddrinfo()\fR
is dynamically allocated: the addrinfo structures, and the socket address structures and canonical host name strings pointed to by the
-\fBaddrinfo\fRstructures. Memory allocated for the dynamically allocated structures created by a successful call to
+\fBaddrinfo\fRstructures\&. Memory allocated for the dynamically allocated structures created by a successful call to
\fBlwres_getaddrinfo()\fR
is released by
-\fBlwres_freeaddrinfo()\fR.
+\fBlwres_freeaddrinfo()\fR\&.
\fIai\fR
is a pointer to a
\fBstruct addrinfo\fR
created by a call to
-\fBlwres_getaddrinfo()\fR.
+\fBlwres_getaddrinfo()\fR\&.
.SH "RETURN VALUES"
.PP
\fBlwres_getaddrinfo()\fR
returns zero on success or one of the error codes listed in
\fBgai_strerror\fR(3)
-if an error occurs. If both
+if an error occurs\&. If both
\fIhostname\fR
and
\fIservname\fR
\fBNULL\fR
\fBlwres_getaddrinfo()\fR
returns
-\fBEAI_NONAME\fR.
+\fBEAI_NONAME\fR\&.
.SH "SEE ALSO"
.PP
\fBlwres\fR(3),
\fBconnect\fR(2),
\fBsendto\fR(2),
\fBsendmsg\fR(2),
-\fBsocket\fR(2).
+\fBsocket\fR(2)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_getaddrinfo</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_getaddrinfo">
+<a name="idp60785488"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_getaddrinfo, lwres_freeaddrinfo — socket address structure to host and service name</p>
+<p>
+ lwres_getaddrinfo,
+ lwres_freeaddrinfo
+ — socket address structure to host and service name
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
int
<b class="fsfunc">lwres_getaddrinfo</b>(</code></td>
-<td>const char * </td>
-<td>
-<var class="pdparam">hostname</var>, </td>
+<td>const char *<var class="pdparam">hostname</var>, </td>
</tr>
<tr>
<td> </td>
-<td>const char * </td>
-<td>
-<var class="pdparam">servname</var>, </td>
+<td>const char *<var class="pdparam">servname</var>, </td>
</tr>
<tr>
<td> </td>
-<td>const struct addrinfo * </td>
-<td>
-<var class="pdparam">hints</var>, </td>
+<td>const struct addrinfo *<var class="pdparam">hints</var>, </td>
</tr>
<tr>
<td> </td>
-<td>struct addrinfo ** </td>
-<td>
-<var class="pdparam">res</var><code>)</code>;</td>
+<td>struct addrinfo **<var class="pdparam">res</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_freeaddrinfo</b>(</code></td>
-<td>struct addrinfo * </td>
-<td>
-<var class="pdparam">ai</var><code>)</code>;</td>
+<td>struct addrinfo *<var class="pdparam">ai</var><code>)</code>;</td>
</tr></table>
+<div class="funcprototype-spacer"> </div>
</div>
-<p>
+
+ <p>
If the operating system does not provide a
<span class="type">struct addrinfo</span>,
the following structure is used:
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
struct addrinfo {
int ai_flags; /* AI_PASSIVE, AI_CANONNAME */
int ai_family; /* PF_xxx */
</pre>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543424"></a><h2>DESCRIPTION</h2>
-<p><code class="function">lwres_getaddrinfo()</code>
+
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60848592"></a><h2>DESCRIPTION</h2>
+
+
+ <p><code class="function">lwres_getaddrinfo()</code>
is used to get a list of IP addresses and port numbers for host
<em class="parameter"><code>hostname</code></em> and service
<em class="parameter"><code>servname</code></em>.
decimal port number or a service name as listed in
<code class="filename">/etc/services</code>.
</p>
-<p><em class="parameter"><code>hints</code></em>
+
+ <p><em class="parameter"><code>hints</code></em>
is an optional pointer to a
<span class="type">struct addrinfo</span>.
This structure can be used to provide hints concerning the type of
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">ai_family</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The protocol family that should be used.
When
<code class="constant">ai_family</code>
it means the caller will accept any protocol family supported by
the
operating system.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">ai_socktype</code></span></dt>
-<dd><p>
+<dd>
+ <p>
denotes the type of socket —
<span class="type">SOCK_STREAM</span>,
<span class="type">SOCK_DGRAM</span>
When
<code class="constant">ai_socktype</code>
is zero the caller will accept any socket type.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">ai_protocol</code></span></dt>
-<dd><p>
+<dd>
+ <p>
indicates which transport protocol is wanted: IPPROTO_UDP or
IPPROTO_TCP.
If
<code class="constant">ai_protocol</code>
is zero the caller will accept any protocol.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">ai_flags</code></span></dt>
<dd>
-<p>
+ <p>
Flag bits.
If the
<span class="type">AI_CANONNAME</span>
bit indicates that the returned socket address structure is
intended
for used in a call to
- <span class="citerefentry"><span class="refentrytitle">bind</span>(2)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">bind</span>(2)
+ </span>.
In this case, if the hostname argument is a
<span class="type">NULL</span>
<span class="type">IN6ADDR_ANY_INIT</span>
for an IPv6 address.
</p>
-<p>
+ <p>
When
<code class="constant">ai_flags</code>
does not set the
<span class="type">AI_PASSIVE</span>
bit, the returned socket address structure will be ready
for use in a call to
- <span class="citerefentry"><span class="refentrytitle">connect</span>(2)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">connect</span>(2)
+ </span>
for a connection-oriented protocol or
- <span class="citerefentry"><span class="refentrytitle">connect</span>(2)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">connect</span>(2)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">sendto</span>(2)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">sendto</span>(2)
+ </span>,
or
- <span class="citerefentry"><span class="refentrytitle">sendmsg</span>(2)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">sendmsg</span>(2)
+ </span>
if a connectionless protocol was chosen.
The IP address portion of the socket address structure will be
set to the loopback address if
is not set in
<code class="constant">ai_flags</code>.
</p>
-<p>
+ <p>
If
<code class="constant">ai_flags</code>
is set to
address
and no name resolution should be attempted.
</p>
-</dd>
+ </dd>
</dl></div>
<p>
</p>
-<p>
+
+ <p>
All other elements of the <span class="type">struct addrinfo</span> passed
via <em class="parameter"><code>hints</code></em> must be zero.
</p>
-<p>
+
+ <p>
A <em class="parameter"><code>hints</code></em> of <span class="type">NULL</span> is
treated as if
the caller provided a <span class="type">struct addrinfo</span> initialized to zero
with <code class="constant">ai_family</code>set to
<code class="constant">PF_UNSPEC</code>.
</p>
-<p>
+
+ <p>
After a successful call to
<code class="function">lwres_getaddrinfo()</code>,
<em class="parameter"><code>*res</code></em>
returned
<span class="type">addrinfo</span>
structure contain the corresponding arguments for a call to
- <span class="citerefentry"><span class="refentrytitle">socket</span>(2)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">socket</span>(2)
+ </span>.
For each
<span class="type">addrinfo</span>
structure in the list, the
member points to a filled-in socket address structure of length
<code class="constant">ai_addrlen</code>.
</p>
-<p>
+
+ <p>
All of the information returned by
<code class="function">lwres_getaddrinfo()</code>
is dynamically allocated: the addrinfo structures, and the socket
created by a call to
<code class="function">lwres_getaddrinfo()</code>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543801"></a><h2>RETURN VALUES</h2>
-<p><code class="function">lwres_getaddrinfo()</code>
+
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60895440"></a><h2>RETURN VALUES</h2>
+
+
+ <p><code class="function">lwres_getaddrinfo()</code>
returns zero on success or one of the error codes listed in
- <span class="citerefentry"><span class="refentrytitle">gai_strerror</span>(3)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">gai_strerror</span>(3)
+ </span>
if an error occurs. If both <em class="parameter"><code>hostname</code></em> and
<em class="parameter"><code>servname</code></em> are <span class="type">NULL</span>
<code class="function">lwres_getaddrinfo()</code> returns
<span class="errorcode">EAI_NONAME</span>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543838"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>,
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60904272"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_getaddrinfo</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_getaddrinfo</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_freeaddrinfo</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_freeaddrinfo</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_gai_strerror</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_gai_strerror</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">RFC2133</span></span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">RFC2133</span>
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">getservbyname</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">getservbyname</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">bind</span>(2)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">bind</span>(2)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">connect</span>(2)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">connect</span>(2)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">sendto</span>(2)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">sendto</span>(2)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">sendmsg</span>(2)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">sendmsg</span>(2)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">socket</span>(2)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">socket</span>(2)
+ </span>.
</p>
-</div>
+
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_gethostent
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_GETHOSTENT" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_GETHOSTENT" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_gethostbyname, lwres_gethostbyname2, lwres_gethostbyaddr, lwres_gethostent, lwres_sethostent, lwres_endhostent, lwres_gethostbyname_r, lwres_gethostbyaddr_r, lwres_gethostent_r, lwres_sethostent_r, lwres_endhostent_r \- lightweight resolver get network host entry
.SH "SYNOPSIS"
.nf
-#include <lwres/netdb.h>
+#include <lwres/netdb\&.h>
.fi
-.HP 37
+.HP \w'struct\ hostent\ *\ lwres_gethostbyname('u
.BI "struct hostent * lwres_gethostbyname(const\ char\ *" "name" ");"
-.HP 38
+.HP \w'struct\ hostent\ *\ lwres_gethostbyname2('u
.BI "struct hostent * lwres_gethostbyname2(const\ char\ *" "name" ", int\ " "af" ");"
-.HP 37
+.HP \w'struct\ hostent\ *\ lwres_gethostbyaddr('u
.BI "struct hostent * lwres_gethostbyaddr(const\ char\ *" "addr" ", int\ " "len" ", int\ " "type" ");"
-.HP 34
+.HP \w'struct\ hostent\ *\ lwres_gethostent('u
.BI "struct hostent * lwres_gethostent(void);"
-.HP 22
+.HP \w'void\ lwres_sethostent('u
.BI "void lwres_sethostent(int\ " "stayopen" ");"
-.HP 22
+.HP \w'void\ lwres_endhostent('u
.BI "void lwres_endhostent(void);"
-.HP 39
+.HP \w'struct\ hostent\ *\ lwres_gethostbyname_r('u
.BI "struct hostent * lwres_gethostbyname_r(const\ char\ *" "name" ", struct\ hostent\ *" "resbuf" ", char\ *" "buf" ", int\ " "buflen" ", int\ *" "error" ");"
-.HP 39
+.HP \w'struct\ hostent\ *\ lwres_gethostbyaddr_r('u
.BI "struct hostent * lwres_gethostbyaddr_r(const\ char\ *" "addr" ", int\ " "len" ", int\ " "type" ", struct\ hostent\ *" "resbuf" ", char\ *" "buf" ", int\ " "buflen" ", int\ *" "error" ");"
-.HP 36
+.HP \w'struct\ hostent\ *\ lwres_gethostent_r('u
.BI "struct hostent * lwres_gethostent_r(struct\ hostent\ *" "resbuf" ", char\ *" "buf" ", int\ " "buflen" ", int\ *" "error" ");"
-.HP 24
+.HP \w'void\ lwres_sethostent_r('u
.BI "void lwres_sethostent_r(int\ " "stayopen" ");"
-.HP 24
+.HP \w'void\ lwres_endhostent_r('u
.BI "void lwres_endhostent_r(void);"
.SH "DESCRIPTION"
.PP
-These functions provide hostname\-to\-address and address\-to\-hostname lookups by means of the lightweight resolver. They are similar to the standard
+These functions provide hostname\-to\-address and address\-to\-hostname lookups by means of the lightweight resolver\&. They are similar to the standard
\fBgethostent\fR(3)
-functions provided by most operating systems. They use a
+functions provided by most operating systems\&. They use a
\fBstruct hostent\fR
which is usually defined in
-\fI<namedb.h>\fR.
+<namedb\&.h>\&.
.PP
+.if n \{\
.RS 4
+.\}
.nf
struct hostent {
char *h_name; /* official name of host */
};
#define h_addr h_addr_list[0] /* address, for backward compatibility */
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
The members of this structure are:
.PP
\fBh_name\fR
.RS 4
-The official (canonical) name of the host.
+The official (canonical) name of the host\&.
.RE
.PP
\fBh_aliases\fR
.RS 4
-A NULL\-terminated array of alternate names (nicknames) for the host.
+A NULL\-terminated array of alternate names (nicknames) for the host\&.
.RE
.PP
\fBh_addrtype\fR
The type of address being returned \(em
\fBPF_INET\fR
or
-\fBPF_INET6\fR.
+\fBPF_INET6\fR\&.
.RE
.PP
\fBh_length\fR
.RS 4
-The length of the address in bytes.
+The length of the address in bytes\&.
.RE
.PP
\fBh_addr_list\fR
.RS 4
A
\fBNULL\fR
-terminated array of network addresses for the host. Host addresses are returned in network byte order.
+terminated array of network addresses for the host\&. Host addresses are returned in network byte order\&.
.RE
.PP
For backward compatibility with very old software,
\fBh_addr\fR
is the first address in
-\fBh_addr_list.\fR
+\fBh_addr_list\&.\fR
.PP
\fBlwres_gethostent()\fR,
\fBlwres_sethostent()\fR,
and
\fBlwres_endhostent_r()\fR
provide iteration over the known host entries on systems that provide such functionality through facilities like
-\fI/etc/hosts\fR
-or NIS. The lightweight resolver does not currently implement these functions; it only provides them as stub functions that always return failure.
+/etc/hosts
+or NIS\&. The lightweight resolver does not currently implement these functions; it only provides them as stub functions that always return failure\&.
.PP
\fBlwres_gethostbyname()\fR
and
\fBlwres_gethostbyname2()\fR
look up the hostname
-\fIname\fR.
+\fIname\fR\&.
\fBlwres_gethostbyname()\fR
always looks for an IPv4 address while
\fBlwres_gethostbyname2()\fR
\fBPF_INET\fR
or
\fBPF_INET6\fR
-\(em IPv4 or IPV6 addresses respectively. Successful calls of the functions return a
-\fBstruct hostent\fRfor the name that was looked up.
+\(em IPv4 or IPV6 addresses respectively\&. Successful calls of the functions return a
+\fBstruct hostent\fRfor the name that was looked up\&.
\fBNULL\fR
is returned if the lookups by
\fBlwres_gethostbyname()\fR
or
\fBlwres_gethostbyname2()\fR
-fail.
+fail\&.
.PP
Reverse lookups of addresses are performed by
-\fBlwres_gethostbyaddr()\fR.
+\fBlwres_gethostbyaddr()\fR\&.
\fIaddr\fR
is an address of length
\fIlen\fR
\(em
\fBPF_INET\fR
or
-\fBPF_INET6\fR.
+\fBPF_INET6\fR\&.
\fBlwres_gethostbyname_r()\fR
-is a thread\-safe function for forward lookups. If an error occurs, an error code is returned in
-\fI*error\fR.
+is a thread\-safe function for forward lookups\&. If an error occurs, an error code is returned in
+\fI*error\fR\&.
\fIresbuf\fR
is a pointer to a
\fBstruct hostent\fR
which is initialised by a successful call to
-\fBlwres_gethostbyname_r()\fR.
+\fBlwres_gethostbyname_r()\fR\&.
\fIbuf\fR
is a buffer of length
\fIlen\fR
elements of the
\fBstruct hostent\fR
returned in
-\fIresbuf\fR. Successful calls to
+\fIresbuf\fR\&. Successful calls to
\fBlwres_gethostbyname_r()\fR
return
\fIresbuf\fR, which is a pointer to the
\fBstruct hostent\fR
-it created.
+it created\&.
.PP
\fBlwres_gethostbyaddr_r()\fR
is a thread\-safe function that performs a reverse lookup of address
\(em
\fBPF_INET\fR
or
-\fBPF_INET6\fR. If an error occurs, the error code is returned in
-\fI*error\fR. The other function parameters are identical to those in
-\fBlwres_gethostbyname_r()\fR.
+\fBPF_INET6\fR\&. If an error occurs, the error code is returned in
+\fI*error\fR\&. The other function parameters are identical to those in
+\fBlwres_gethostbyname_r()\fR\&.
\fIresbuf\fR
is a pointer to a
\fBstruct hostent\fR
which is initialised by a successful call to
-\fBlwres_gethostbyaddr_r()\fR.
+\fBlwres_gethostbyaddr_r()\fR\&.
\fIbuf\fR
is a buffer of length
\fIlen\fR
elements of the
\fBstruct hostent\fR
returned in
-\fIresbuf\fR. Successful calls to
+\fIresbuf\fR\&. Successful calls to
\fBlwres_gethostbyaddr_r()\fR
return
\fIresbuf\fR, which is a pointer to the
\fBstruct hostent()\fR
-it created.
+it created\&.
.SH "RETURN VALUES"
.PP
The functions
\fBlwres_gethostbyname2()\fR,
\fBlwres_gethostbyaddr()\fR, and
\fBlwres_gethostent()\fR
-return NULL to indicate an error. In this case the global variable
+return NULL to indicate an error\&. In this case the global variable
\fBlwres_h_errno\fR
will contain one of the following error codes defined in
-\fI<lwres/netdb.h>\fR:
+<lwres/netdb\&.h>:
.PP
\fBHOST_NOT_FOUND\fR
.RS 4
-The host or address was not found.
+The host or address was not found\&.
.RE
.PP
\fBTRY_AGAIN\fR
.RS 4
-A recoverable error occurred, e.g., a timeout. Retrying the lookup may succeed.
+A recoverable error occurred, e\&.g\&., a timeout\&. Retrying the lookup may succeed\&.
.RE
.PP
\fBNO_RECOVERY\fR
.RS 4
-A non\-recoverable error occurred.
+A non\-recoverable error occurred\&.
.RE
.PP
\fBNO_DATA\fR
.RS 4
-The name exists, but has no address information associated with it (or vice versa in the case of a reverse lookup). The code NO_ADDRESS is accepted as a synonym for NO_DATA for backwards compatibility.
+The name exists, but has no address information associated with it (or vice versa in the case of a reverse lookup)\&. The code NO_ADDRESS is accepted as a synonym for NO_DATA for backwards compatibility\&.
.RE
.PP
\fBlwres_hstrerror\fR(3)
-translates these error codes to suitable error messages.
+translates these error codes to suitable error messages\&.
.PP
\fBlwres_gethostent()\fR
and
\fBlwres_gethostent_r()\fR
always return
-\fBNULL\fR.
+\fBNULL\fR\&.
.PP
Successful calls to
\fBlwres_gethostbyname_r()\fR
return
\fIresbuf\fR, a pointer to the
\fBstruct hostent\fR
-that was initialised by these functions. They return
+that was initialised by these functions\&. They return
\fBNULL\fR
if the lookups fail or if
\fIbuf\fR
\fBh_aliases\fR, and
\fBh_addr_list\fR
elements of the
-\fBstruct hostent\fR. If
+\fBstruct hostent\fR\&. If
\fIbuf\fR
was too small, both
\fBlwres_gethostbyname_r()\fR
set the global variable
\fBerrno\fR
to
-\fBERANGE\fR.
+\fBERANGE\fR\&.
.SH "SEE ALSO"
.PP
\fBgethostent\fR(3),
\fBlwres_gethostbyaddr()\fR
and
\fBlwres_endhostent()\fR
-are not thread safe; they return pointers to static data and provide error codes through a global variable. Thread\-safe versions for name and address lookup are provided by
+are not thread safe; they return pointers to static data and provide error codes through a global variable\&. Thread\-safe versions for name and address lookup are provided by
\fBlwres_gethostbyname_r()\fR, and
\fBlwres_gethostbyaddr_r()\fR
-respectively.
+respectively\&.
.PP
The resolver daemon does not currently support any non\-DNS name services such as
-\fI/etc/hosts\fR
+/etc/hosts
or
-\fBNIS\fR, consequently the above functions don't, either.
+\fBNIS\fR, consequently the above functions don\*(Aqt, either\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_gethostent</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_gethostent">
+<a name="idp60806992"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_gethostbyname, lwres_gethostbyname2, lwres_gethostbyaddr, lwres_gethostent, lwres_sethostent, lwres_endhostent, lwres_gethostbyname_r, lwres_gethostbyaddr_r, lwres_gethostent_r, lwres_sethostent_r, lwres_endhostent_r — lightweight resolver get network host entry</p>
+<p>
+ lwres_gethostbyname,
+ lwres_gethostbyname2,
+ lwres_gethostbyaddr,
+ lwres_gethostent,
+ lwres_sethostent,
+ lwres_endhostent,
+ lwres_gethostbyname_r,
+ lwres_gethostbyaddr_r,
+ lwres_gethostent_r,
+ lwres_sethostent_r,
+ lwres_endhostent_r
+ — lightweight resolver get network host entry
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
struct hostent *
<b class="fsfunc">lwres_gethostbyname</b>(</code></td>
-<td>const char * </td>
-<td>
-<var class="pdparam">name</var><code>)</code>;</td>
+<td>const char *<var class="pdparam">name</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
struct hostent *
<b class="fsfunc">lwres_gethostbyname2</b>(</code></td>
-<td>const char * </td>
-<td>
-<var class="pdparam">name</var>, </td>
+<td>const char *<var class="pdparam">name</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">af</var><code>)</code>;</td>
+<td>int <var class="pdparam">af</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
struct hostent *
<b class="fsfunc">lwres_gethostbyaddr</b>(</code></td>
-<td>const char * </td>
-<td>
-<var class="pdparam">addr</var>, </td>
+<td>const char *<var class="pdparam">addr</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">len</var>, </td>
+<td>int <var class="pdparam">len</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">type</var><code>)</code>;</td>
+<td>int <var class="pdparam">type</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
struct hostent *
<b class="fsfunc">lwres_gethostent</b>(</code></td>
-<td> </td>
-<td>
-<code>)</code>;</td>
+<td>void<code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_sethostent</b>(</code></td>
-<td>int </td>
-<td>
-<var class="pdparam">stayopen</var><code>)</code>;</td>
+<td>int <var class="pdparam">stayopen</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_endhostent</b>(</code></td>
-<td> </td>
-<td>
-<code>)</code>;</td>
+<td>void<code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
struct hostent *
<b class="fsfunc">lwres_gethostbyname_r</b>(</code></td>
-<td>const char * </td>
-<td>
-<var class="pdparam">name</var>, </td>
+<td>const char *<var class="pdparam">name</var>, </td>
</tr>
<tr>
<td> </td>
-<td>struct hostent * </td>
-<td>
-<var class="pdparam">resbuf</var>, </td>
+<td>struct hostent *<var class="pdparam">resbuf</var>, </td>
</tr>
<tr>
<td> </td>
-<td>char * </td>
-<td>
-<var class="pdparam">buf</var>, </td>
+<td>char *<var class="pdparam">buf</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">buflen</var>, </td>
+<td>int <var class="pdparam">buflen</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int * </td>
-<td>
-<var class="pdparam">error</var><code>)</code>;</td>
+<td>int *<var class="pdparam">error</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
struct hostent *
<b class="fsfunc">lwres_gethostbyaddr_r</b>(</code></td>
-<td>const char * </td>
-<td>
-<var class="pdparam">addr</var>, </td>
+<td>const char *<var class="pdparam">addr</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">len</var>, </td>
+<td>int <var class="pdparam">len</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">type</var>, </td>
+<td>int <var class="pdparam">type</var>, </td>
</tr>
<tr>
<td> </td>
-<td>struct hostent * </td>
-<td>
-<var class="pdparam">resbuf</var>, </td>
+<td>struct hostent *<var class="pdparam">resbuf</var>, </td>
</tr>
<tr>
<td> </td>
-<td>char * </td>
-<td>
-<var class="pdparam">buf</var>, </td>
+<td>char *<var class="pdparam">buf</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">buflen</var>, </td>
+<td>int <var class="pdparam">buflen</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int * </td>
-<td>
-<var class="pdparam">error</var><code>)</code>;</td>
+<td>int *<var class="pdparam">error</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
struct hostent *
<b class="fsfunc">lwres_gethostent_r</b>(</code></td>
-<td>struct hostent * </td>
-<td>
-<var class="pdparam">resbuf</var>, </td>
+<td>struct hostent *<var class="pdparam">resbuf</var>, </td>
</tr>
<tr>
<td> </td>
-<td>char * </td>
-<td>
-<var class="pdparam">buf</var>, </td>
+<td>char *<var class="pdparam">buf</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">buflen</var>, </td>
+<td>int <var class="pdparam">buflen</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int * </td>
-<td>
-<var class="pdparam">error</var><code>)</code>;</td>
+<td>int *<var class="pdparam">error</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_sethostent_r</b>(</code></td>
-<td>int </td>
-<td>
-<var class="pdparam">stayopen</var><code>)</code>;</td>
+<td>int <var class="pdparam">stayopen</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_endhostent_r</b>(</code></td>
-<td> </td>
-<td>
-<code>)</code>;</td>
+<td>void<code>)</code>;</td>
</tr></table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543620"></a><h2>DESCRIPTION</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60902480"></a><h2>DESCRIPTION</h2>
+
+ <p>
These functions provide hostname-to-address and
address-to-hostname lookups by means of the lightweight resolver.
They are similar to the standard
- <span class="citerefentry"><span class="refentrytitle">gethostent</span>(3)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">gethostent</span>(3)
+ </span>
functions provided by most operating systems.
They use a
<span class="type">struct hostent</span>
which is usually defined in
<code class="filename"><namedb.h></code>.
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
struct hostent {
char *h_name; /* official name of host */
char **h_aliases; /* alias list */
</pre>
<p>
</p>
-<p>
+ <p>
The members of this structure are:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">h_name</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The official (canonical) name of the host.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">h_aliases</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A NULL-terminated array of alternate names (nicknames) for the
host.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">h_addrtype</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The type of address being returned —
<span class="type">PF_INET</span>
or
<span class="type">PF_INET6</span>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">h_length</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The length of the address in bytes.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">h_addr_list</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A <span class="type">NULL</span>
terminated array of network addresses for the host.
Host addresses are returned in network byte order.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-<p>
+ <p>
For backward compatibility with very old software,
<code class="constant">h_addr</code>
is the first address in
<code class="constant">h_addr_list.</code>
</p>
-<p><code class="function">lwres_gethostent()</code>,
+ <p><code class="function">lwres_gethostent()</code>,
<code class="function">lwres_sethostent()</code>,
<code class="function">lwres_endhostent()</code>,
<code class="function">lwres_gethostent_r()</code>,
these functions; it only provides them as stub functions that always
return failure.
</p>
-<p><code class="function">lwres_gethostbyname()</code>
+
+ <p><code class="function">lwres_gethostbyname()</code>
and <code class="function">lwres_gethostbyname2()</code> look up the
hostname <em class="parameter"><code>name</code></em>.
<code class="function">lwres_gethostbyname()</code> always looks for an
<code class="function">lwres_gethostbyname()</code> or
<code class="function">lwres_gethostbyname2()</code> fail.
</p>
-<p>
+
+ <p>
Reverse lookups of addresses are performed by
<code class="function">lwres_gethostbyaddr()</code>.
<em class="parameter"><code>addr</code></em> is an address of length
return <em class="parameter"><code>resbuf</code></em>,
which is a pointer to the <span class="type">struct hostent</span> it created.
</p>
-<p><code class="function">lwres_gethostbyaddr_r()</code>
+
+ <p><code class="function">lwres_gethostbyaddr_r()</code>
is a thread-safe function
that performs a reverse lookup of address <em class="parameter"><code>addr</code></em>
which is <em class="parameter"><code>len</code></em> bytes long and is of
<em class="parameter"><code>resbuf</code></em>, which is a pointer to the
<code class="function">struct hostent()</code> it created.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543971"></a><h2>RETURN VALUES</h2>
-<p>
+
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60943056"></a><h2>RETURN VALUES</h2>
+
+ <p>
The functions
<code class="function">lwres_gethostbyname()</code>,
<code class="function">lwres_gethostbyname2()</code>,
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">HOST_NOT_FOUND</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The host or address was not found.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">TRY_AGAIN</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A recoverable error occurred, e.g., a timeout.
Retrying the lookup may succeed.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">NO_RECOVERY</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A non-recoverable error occurred.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">NO_DATA</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The name exists, but has no address information
associated with it (or vice versa in the case
of a reverse lookup). The code NO_ADDRESS
is accepted as a synonym for NO_DATA for backwards
compatibility.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-<p><span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3)</span>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres_hstrerror</span>(3)
+ </span>
translates these error codes to suitable error messages.
</p>
-<p><code class="function">lwres_gethostent()</code>
+
+ <p><code class="function">lwres_gethostent()</code>
and <code class="function">lwres_gethostent_r()</code>
always return <span class="type">NULL</span>.
</p>
-<p>
+
+ <p>
Successful calls to <code class="function">lwres_gethostbyname_r()</code> and
<code class="function">lwres_gethostbyaddr_r()</code> return
<em class="parameter"><code>resbuf</code></em>, a pointer to the
variable
<span class="type">errno</span> to <span class="errorcode">ERANGE</span>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544204"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">gethostent</span>(3)</span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_getipnode</span>(3)</span>,
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60963152"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">gethostent</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_getipnode</span>(3)
+ </span>,
+
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_hstrerror</span>(3)
+ </span>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2544238"></a><h2>BUGS</h2>
-<p><code class="function">lwres_gethostbyname()</code>,
+ </div>
+
+ <div class="refsection" title="BUGS">
+<a name="idp60967504"></a><h2>BUGS</h2>
+
+ <p><code class="function">lwres_gethostbyname()</code>,
<code class="function">lwres_gethostbyname2()</code>,
<code class="function">lwres_gethostbyaddr()</code>
and
<code class="function">lwres_gethostbyaddr_r()</code>
respectively.
</p>
-<p>
+ <p>
The resolver daemon does not currently support any non-DNS
name services such as
<code class="filename">/etc/hosts</code>
<span class="type">NIS</span>,
consequently the above functions don't, either.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_getipnode
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_GETIPNODE" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_GETIPNODE" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_getipnodebyname, lwres_getipnodebyaddr, lwres_freehostent \- lightweight resolver nodename / address translation API
.SH "SYNOPSIS"
.nf
-#include <lwres/netdb.h>
+#include <lwres/netdb\&.h>
.fi
-.HP 39
+.HP \w'struct\ hostent\ *\ lwres_getipnodebyname('u
.BI "struct hostent * lwres_getipnodebyname(const\ char\ *" "name" ", int\ " "af" ", int\ " "flags" ", int\ *" "error_num" ");"
-.HP 39
+.HP \w'struct\ hostent\ *\ lwres_getipnodebyaddr('u
.BI "struct hostent * lwres_getipnodebyaddr(const\ void\ *" "src" ", size_t\ " "len" ", int\ " "af" ", int\ *" "error_num" ");"
-.HP 23
+.HP \w'void\ lwres_freehostent('u
.BI "void lwres_freehostent(struct\ hostent\ *" "he" ");"
.SH "DESCRIPTION"
.PP
-These functions perform thread safe, protocol independent nodename\-to\-address and address\-to\-nodename translation as defined in RFC2553.
+These functions perform thread safe, protocol independent nodename\-to\-address and address\-to\-nodename translation as defined in RFC2553\&.
.PP
They use a
\fBstruct hostent\fR
which is defined in
-\fInamedb.h\fR:
+namedb\&.h:
.PP
+.if n \{\
.RS 4
+.\}
.nf
struct hostent {
char *h_name; /* official name of host */
};
#define h_addr h_addr_list[0] /* address, for backward compatibility */
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
The members of this structure are:
.PP
\fBh_name\fR
.RS 4
-The official (canonical) name of the host.
+The official (canonical) name of the host\&.
.RE
.PP
\fBh_aliases\fR
.RS 4
-A NULL\-terminated array of alternate names (nicknames) for the host.
+A NULL\-terminated array of alternate names (nicknames) for the host\&.
.RE
.PP
\fBh_addrtype\fR
The type of address being returned \- usually
\fBPF_INET\fR
or
-\fBPF_INET6\fR.
+\fBPF_INET6\fR\&.
.RE
.PP
\fBh_length\fR
.RS 4
-The length of the address in bytes.
+The length of the address in bytes\&.
.RE
.PP
\fBh_addr_list\fR
.RS 4
A
\fBNULL\fR
-terminated array of network addresses for the host. Host addresses are returned in network byte order.
+terminated array of network addresses for the host\&. Host addresses are returned in network byte order\&.
.RE
.PP
\fBlwres_getipnodebyname()\fR
looks up addresses of protocol family
\fIaf\fR
for the hostname
-\fIname\fR. The
+\fIname\fR\&. The
\fIflags\fR
-parameter contains ORed flag bits to specify the types of addresses that are searched for, and the types of addresses that are returned. The flag bits are:
+parameter contains ORed flag bits to specify the types of addresses that are searched for, and the types of addresses that are returned\&. The flag bits are:
.PP
\fBAI_V4MAPPED\fR
.RS 4
This is used with an
\fIaf\fR
-of AF_INET6, and causes IPv4 addresses to be returned as IPv4\-mapped IPv6 addresses.
+of AF_INET6, and causes IPv4 addresses to be returned as IPv4\-mapped IPv6 addresses\&.
.RE
.PP
\fBAI_ALL\fR
.RS 4
This is used with an
\fIaf\fR
-of AF_INET6, and causes all known addresses (IPv6 and IPv4) to be returned. If AI_V4MAPPED is also set, the IPv4 addresses are return as mapped IPv6 addresses.
+of AF_INET6, and causes all known addresses (IPv6 and IPv4) to be returned\&. If AI_V4MAPPED is also set, the IPv4 addresses are return as mapped IPv6 addresses\&.
.RE
.PP
\fBAI_ADDRCONFIG\fR
.RS 4
-Only return an IPv6 or IPv4 address if here is an active network interface of that type. This is not currently implemented in the BIND 9 lightweight resolver, and the flag is ignored.
+Only return an IPv6 or IPv4 address if here is an active network interface of that type\&. This is not currently implemented in the BIND 9 lightweight resolver, and the flag is ignored\&.
.RE
.PP
\fBAI_DEFAULT\fR
\fBAI_V4MAPPED\fR
and
\fBAI_ADDRCONFIG\fR
-flag bits.
+flag bits\&.
.RE
.PP
\fBlwres_getipnodebyaddr()\fR
\fIsrc\fR
which is
\fIlen\fR
-bytes long.
+bytes long\&.
\fIaf\fR
denotes the protocol family, typically
\fBPF_INET\fR
or
-\fBPF_INET6\fR.
+\fBPF_INET6\fR\&.
.PP
\fBlwres_freehostent()\fR
releases all the memory associated with the
\fBstruct hostent\fR
pointer
-\fIhe\fR. Any memory allocated for the
+\fIhe\fR\&. Any memory allocated for the
\fBh_name\fR,
\fBh_addr_list\fR
and
\fBh_aliases\fR
is freed, as is the memory for the
\fBhostent\fR
-structure itself.
+structure itself\&.
.SH "RETURN VALUES"
.PP
If an error occurs,
\fI*error_num\fR
to an appropriate error code and the function returns a
\fBNULL\fR
-pointer. The error codes and their meanings are defined in
-\fI<lwres/netdb.h>\fR:
+pointer\&. The error codes and their meanings are defined in
+<lwres/netdb\&.h>:
.PP
\fBHOST_NOT_FOUND\fR
.RS 4
-No such host is known.
+No such host is known\&.
.RE
.PP
\fBNO_ADDRESS\fR
.RS 4
-The server recognised the request and the name but no address is available. Another type of request to the name server for the domain might return an answer.
+The server recognised the request and the name but no address is available\&. Another type of request to the name server for the domain might return an answer\&.
.RE
.PP
\fBTRY_AGAIN\fR
.RS 4
-A temporary and possibly transient error occurred, such as a failure of a server to respond. The request may succeed if retried.
+A temporary and possibly transient error occurred, such as a failure of a server to respond\&. The request may succeed if retried\&.
.RE
.PP
\fBNO_RECOVERY\fR
.RS 4
-An unexpected failure occurred, and retrying the request is pointless.
+An unexpected failure occurred, and retrying the request is pointless\&.
.RE
.PP
\fBlwres_hstrerror\fR(3)
-translates these error codes to suitable error messages.
+translates these error codes to suitable error messages\&.
.SH "SEE ALSO"
.PP
\fBRFC2553\fR(),
\fBlwres_gethostent\fR(3),
\fBlwres_getaddrinfo\fR(3),
\fBlwres_getnameinfo\fR(3),
-\fBlwres_hstrerror\fR(3).
+\fBlwres_hstrerror\fR(3)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_getipnode</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_getipnode">
+<a name="idp60813904"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_getipnodebyname, lwres_getipnodebyaddr, lwres_freehostent — lightweight resolver nodename / address translation API</p>
+<p>
+ lwres_getipnodebyname,
+ lwres_getipnodebyaddr,
+ lwres_freehostent
+ — lightweight resolver nodename / address translation API
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
struct hostent *
<b class="fsfunc">lwres_getipnodebyname</b>(</code></td>
-<td>const char * </td>
-<td>
-<var class="pdparam">name</var>, </td>
+<td>const char *<var class="pdparam">name</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">af</var>, </td>
+<td>int <var class="pdparam">af</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">flags</var>, </td>
+<td>int <var class="pdparam">flags</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int * </td>
-<td>
-<var class="pdparam">error_num</var><code>)</code>;</td>
+<td>int *<var class="pdparam">error_num</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
struct hostent *
<b class="fsfunc">lwres_getipnodebyaddr</b>(</code></td>
-<td>const void * </td>
-<td>
-<var class="pdparam">src</var>, </td>
+<td>const void *<var class="pdparam">src</var>, </td>
</tr>
<tr>
<td> </td>
-<td>size_t </td>
-<td>
-<var class="pdparam">len</var>, </td>
+<td>size_t <var class="pdparam">len</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">af</var>, </td>
+<td>int <var class="pdparam">af</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int * </td>
-<td>
-<var class="pdparam">error_num</var><code>)</code>;</td>
+<td>int *<var class="pdparam">error_num</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_freehostent</b>(</code></td>
-<td>struct hostent * </td>
-<td>
-<var class="pdparam">he</var><code>)</code>;</td>
+<td>struct hostent *<var class="pdparam">he</var><code>)</code>;</td>
</tr></table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543443"></a><h2>DESCRIPTION</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60867280"></a><h2>DESCRIPTION</h2>
+
+
+ <p>
These functions perform thread safe, protocol independent
nodename-to-address and address-to-nodename
translation as defined in RFC2553.
</p>
-<p>
+
+ <p>
They use a
<span class="type">struct hostent</span>
which is defined in
<code class="filename">namedb.h</code>:
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
struct hostent {
char *h_name; /* official name of host */
char **h_aliases; /* alias list */
</pre>
<p>
</p>
-<p>
+
+ <p>
The members of this structure are:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">h_name</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The official (canonical) name of the host.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">h_aliases</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A NULL-terminated array of alternate names (nicknames) for the
host.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">h_addrtype</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The type of address being returned - usually
<span class="type">PF_INET</span>
or
<span class="type">PF_INET6</span>.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">h_length</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The length of the address in bytes.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">h_addr_list</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A
<span class="type">NULL</span>
terminated array of network addresses for the host.
Host addresses are returned in network byte order.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-<p><code class="function">lwres_getipnodebyname()</code>
+
+ <p><code class="function">lwres_getipnodebyname()</code>
looks up addresses of protocol family <em class="parameter"><code>af</code></em>
for the hostname <em class="parameter"><code>name</code></em>. The
<em class="parameter"><code>flags</code></em> parameter contains ORed flag bits
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">AI_V4MAPPED</code></span></dt>
-<dd><p>
+<dd>
+ <p>
This is used with an
<em class="parameter"><code>af</code></em>
of AF_INET6, and causes IPv4 addresses to be returned as
IPv4-mapped
IPv6 addresses.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">AI_ALL</code></span></dt>
-<dd><p>
+<dd>
+ <p>
This is used with an
<em class="parameter"><code>af</code></em>
of AF_INET6, and causes all known addresses (IPv6 and IPv4) to
If AI_V4MAPPED is also set, the IPv4 addresses are return as
mapped
IPv6 addresses.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">AI_ADDRCONFIG</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Only return an IPv6 or IPv4 address if here is an active network
interface of that type. This is not currently implemented
in the BIND 9 lightweight resolver, and the flag is ignored.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">AI_DEFAULT</code></span></dt>
-<dd><p>
+<dd>
+ <p>
This default sets the
<code class="constant">AI_V4MAPPED</code>
and
<code class="constant">AI_ADDRCONFIG</code>
flag bits.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-<p><code class="function">lwres_getipnodebyaddr()</code>
+
+ <p><code class="function">lwres_getipnodebyaddr()</code>
performs a reverse lookup of address <em class="parameter"><code>src</code></em>
which is <em class="parameter"><code>len</code></em> bytes long.
<em class="parameter"><code>af</code></em> denotes the protocol family, typically
<span class="type">PF_INET</span> or <span class="type">PF_INET6</span>.
</p>
-<p><code class="function">lwres_freehostent()</code>
+ <p><code class="function">lwres_freehostent()</code>
releases all the memory associated with the <span class="type">struct
hostent</span> pointer <em class="parameter"><code>he</code></em>. Any memory
allocated for the <code class="constant">h_name</code>,
<code class="constant">h_aliases</code> is freed, as is the memory for
the <span class="type">hostent</span> structure itself.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543701"></a><h2>RETURN VALUES</h2>
-<p>
+ </div>
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60901072"></a><h2>RETURN VALUES</h2>
+
+ <p>
If an error occurs,
<code class="function">lwres_getipnodebyname()</code>
and
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">HOST_NOT_FOUND</code></span></dt>
-<dd><p>
+<dd>
+ <p>
No such host is known.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">NO_ADDRESS</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The server recognised the request and the name but no address is
available. Another type of request to the name server for the
domain might return an answer.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">TRY_AGAIN</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A temporary and possibly transient error occurred, such as a
failure of a server to respond. The request may succeed if
retried.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">NO_RECOVERY</code></span></dt>
-<dd><p>
+<dd>
+ <p>
An unexpected failure occurred, and retrying the request
is pointless.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-<p><span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3)</span>
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres_hstrerror</span>(3)
+ </span>
translates these error codes to suitable error messages.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543798"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">RFC2553</span></span>,
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60913104"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">RFC2553</span>
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_gethostent</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_gethostent</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_getaddrinfo</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_getaddrinfo</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_getnameinfo</span>(3)</span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_getnameinfo</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_hstrerror</span>(3)
+ </span>.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_getnameinfo
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_GETNAMEINFO" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_GETNAMEINFO" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_getnameinfo \- lightweight resolver socket address structure to hostname and service name
.SH "SYNOPSIS"
.nf
-#include <lwres/netdb.h>
+#include <lwres/netdb\&.h>
.fi
-.HP 22
+.HP \w'int\ lwres_getnameinfo('u
.BI "int lwres_getnameinfo(const\ struct\ sockaddr\ *" "sa" ", size_t\ " "salen" ", char\ *" "host" ", size_t\ " "hostlen" ", char\ *" "serv" ", size_t\ " "servlen" ", int\ " "flags" ");"
.SH "DESCRIPTION"
.PP
This function is equivalent to the
\fBgetnameinfo\fR(3)
-function defined in RFC2133.
+function defined in RFC2133\&.
\fBlwres_getnameinfo()\fR
returns the hostname for the
\fBstruct sockaddr\fR
\fIsa\fR
which is
\fIsalen\fR
-bytes long. The hostname is of length
+bytes long\&. The hostname is of length
\fIhostlen\fR
and is returned via
-\fI*host.\fR
+\fI*host\&.\fR
The maximum length of the hostname is 1025 bytes:
-\fBNI_MAXHOST\fR.
+\fBNI_MAXHOST\fR\&.
.PP
The name of the service associated with the port number in
\fIsa\fR
is returned in
-\fI*serv.\fR
+\fI*serv\&.\fR
It is
\fIservlen\fR
-bytes long. The maximum length of the service name is
+bytes long\&. The maximum length of the service name is
\fBNI_MAXSERV\fR
-\- 32 bytes.
+\- 32 bytes\&.
.PP
The
\fIflags\fR
.PP
\fBNI_NOFQDN\fR
.RS 4
-A fully qualified domain name is not required for local hosts. The local part of the fully qualified domain name is returned instead.
+A fully qualified domain name is not required for local hosts\&. The local part of the fully qualified domain name is returned instead\&.
.RE
.PP
\fBNI_NUMERICHOST\fR
.RS 4
-Return the address in numeric form, as if calling inet_ntop(), instead of a host name.
+Return the address in numeric form, as if calling inet_ntop(), instead of a host name\&.
.RE
.PP
\fBNI_NAMEREQD\fR
.RS 4
-A name is required. If the hostname cannot be found in the DNS and this flag is set, a non\-zero error code is returned. If the hostname is not found and the flag is not set, the address is returned in numeric form.
+A name is required\&. If the hostname cannot be found in the DNS and this flag is set, a non\-zero error code is returned\&. If the hostname is not found and the flag is not set, the address is returned in numeric form\&.
.RE
.PP
\fBNI_NUMERICSERV\fR
.RS 4
-The service name is returned as a digit string representing the port number.
+The service name is returned as a digit string representing the port number\&.
.RE
.PP
\fBNI_DGRAM\fR
.RS 4
-Specifies that the service being looked up is a datagram service, and causes getservbyport() to be called with a second argument of "udp" instead of its default of "tcp". This is required for the few ports (512\-514) that have different services for UDP and TCP.
+Specifies that the service being looked up is a datagram service, and causes getservbyport() to be called with a second argument of "udp" instead of its default of "tcp"\&. This is required for the few ports (512\-514) that have different services for UDP and TCP\&.
.RE
.SH "RETURN VALUES"
.PP
\fBlwres_getnameinfo()\fR
-returns 0 on success or a non\-zero error code if an error occurs.
+returns 0 on success or a non\-zero error code if an error occurs\&.
.SH "SEE ALSO"
.PP
\fBRFC2133\fR(),
\fBgetservbyport\fR(3),
\fBlwres\fR(3),
\fBlwres_getnameinfo\fR(3),
-\fBlwres_getnamebyaddr\fR(3).
-\fBlwres_net_ntop\fR(3).
+\fBlwres_getnamebyaddr\fR(3)\&.
+\fBlwres_net_ntop\fR(3)\&.
.SH "BUGS"
.PP
RFC2133 fails to define what the nonzero return values of
\fBgetnameinfo\fR(3)
-are.
+are\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_getnameinfo</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_getnameinfo">
+<a name="idp60804688"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_getnameinfo — lightweight resolver socket address structure to hostname and
+<p>
+ lwres_getnameinfo
+ — lightweight resolver socket address structure to hostname and
service name
- </p>
+
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
int
<b class="fsfunc">lwres_getnameinfo</b>(</code></td>
-<td>const struct sockaddr * </td>
-<td>
-<var class="pdparam">sa</var>, </td>
+<td>const struct sockaddr *<var class="pdparam">sa</var>, </td>
</tr>
<tr>
<td> </td>
-<td>size_t </td>
-<td>
-<var class="pdparam">salen</var>, </td>
+<td>size_t <var class="pdparam">salen</var>, </td>
</tr>
<tr>
<td> </td>
-<td>char * </td>
-<td>
-<var class="pdparam">host</var>, </td>
+<td>char *<var class="pdparam">host</var>, </td>
</tr>
<tr>
<td> </td>
-<td>size_t </td>
-<td>
-<var class="pdparam">hostlen</var>, </td>
+<td>size_t <var class="pdparam">hostlen</var>, </td>
</tr>
<tr>
<td> </td>
-<td>char * </td>
-<td>
-<var class="pdparam">serv</var>, </td>
+<td>char *<var class="pdparam">serv</var>, </td>
</tr>
<tr>
<td> </td>
-<td>size_t </td>
-<td>
-<var class="pdparam">servlen</var>, </td>
+<td>size_t <var class="pdparam">servlen</var>, </td>
</tr>
<tr>
<td> </td>
-<td>int </td>
-<td>
-<var class="pdparam">flags</var><code>)</code>;</td>
+<td>int <var class="pdparam">flags</var><code>)</code>;</td>
</tr>
</table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543404"></a><h2>DESCRIPTION</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60849488"></a><h2>DESCRIPTION</h2>
+
+
+ <p>
This function is equivalent to the
- <span class="citerefentry"><span class="refentrytitle">getnameinfo</span>(3)</span> function defined in RFC2133.
+ <span class="citerefentry">
+ <span class="refentrytitle">getnameinfo</span>(3)
+ </span> function defined in RFC2133.
<code class="function">lwres_getnameinfo()</code> returns the
hostname for the
<span class="type">struct sockaddr</span> <em class="parameter"><code>sa</code></em> which
hostname is
1025 bytes: <code class="constant">NI_MAXHOST</code>.
</p>
-<p> The name of the service associated with the port number in
+
+ <p> The name of the service associated with the port number in
<em class="parameter"><code>sa</code></em> is returned in <em class="parameter"><code>*serv.</code></em>
It is <em class="parameter"><code>servlen</code></em> bytes long. The
maximum length
of the service name is <code class="constant">NI_MAXSERV</code> - 32
bytes.
</p>
-<p>
+
+ <p>
The <em class="parameter"><code>flags</code></em> argument sets the
following
bits:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">NI_NOFQDN</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A fully qualified domain name is not required for local hosts.
The local part of the fully qualified domain name is returned
instead.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">NI_NUMERICHOST</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Return the address in numeric form, as if calling inet_ntop(),
instead of a host name.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">NI_NAMEREQD</code></span></dt>
-<dd><p>
+<dd>
+ <p>
A name is required. If the hostname cannot be found in the DNS
and
this flag is set, a non-zero error code is returned.
If the hostname is not found and the flag is not set, the
address is returned in numeric form.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">NI_NUMERICSERV</code></span></dt>
-<dd><p>
+<dd>
+ <p>
The service name is returned as a digit string representing the
port number.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">NI_DGRAM</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Specifies that the service being looked up is a datagram
service, and causes getservbyport() to be called with a second
argument of "udp" instead of its default of "tcp". This is
for the few ports (512-514) that have different services for UDP
and
TCP.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543546"></a><h2>RETURN VALUES</h2>
-<p><code class="function">lwres_getnameinfo()</code>
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60870480"></a><h2>RETURN VALUES</h2>
+
+ <p><code class="function">lwres_getnameinfo()</code>
returns 0 on success or a non-zero error code if an error occurs.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543558"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">RFC2133</span></span>,
- <span class="citerefentry"><span class="refentrytitle">getservbyport</span>(3)</span>,
- <span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_getnameinfo</span>(3)</span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_getnamebyaddr</span>(3)</span>.
- <span class="citerefentry"><span class="refentrytitle">lwres_net_ntop</span>(3)</span>.
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60872144"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">RFC2133</span>
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">getservbyport</span>(3)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres</span>(3)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_getnameinfo</span>(3)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_getnamebyaddr</span>(3)
+ </span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_net_ntop</span>(3)
+ </span>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543616"></a><h2>BUGS</h2>
-<p>
+ </div>
+ <div class="refsection" title="BUGS">
+<a name="idp60883536"></a><h2>BUGS</h2>
+
+ <p>
RFC2133 fails to define what the nonzero return values of
- <span class="citerefentry"><span class="refentrytitle">getnameinfo</span>(3)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">getnameinfo</span>(3)
+ </span>
are.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_getrrsetbyname
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_GETRRSETBYNAME" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_GETRRSETBYNAME" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_getrrsetbyname, lwres_freerrset \- retrieve DNS records
.SH "SYNOPSIS"
.nf
-#include <lwres/netdb.h>
+#include <lwres/netdb\&.h>
.fi
-.HP 25
+.HP \w'int\ lwres_getrrsetbyname('u
.BI "int lwres_getrrsetbyname(const\ char\ *" "hostname" ", unsigned\ int\ " "rdclass" ", unsigned\ int\ " "rdtype" ", unsigned\ int\ " "flags" ", struct\ rrsetinfo\ **" "res" ");"
-.HP 21
+.HP \w'void\ lwres_freerrset('u
.BI "void lwres_freerrset(struct\ rrsetinfo\ *" "rrset" ");"
.PP
The following structures are used:
.PP
-.RS 4
.nf
struct rdatainfo {
unsigned int rdi_length; /* length of data */
unsigned char *rdi_data; /* record data */
};
.fi
-.RE
-.sp
.PP
-.RS 4
.nf
struct rrsetinfo {
- unsigned int rri_flags; /* RRSET_VALIDATED... */
+ unsigned int rri_flags; /* RRSET_VALIDATED\&.\&.\&. */
unsigned int rri_rdclass; /* class number */
unsigned int rri_rdtype; /* RR type number */
unsigned int rri_ttl; /* time to live */
struct rdatainfo *rri_sigs; /* individual signatures */
};
.fi
-.RE
.sp
.SH "DESCRIPTION"
.PP
gets a set of resource records associated with a
\fIhostname\fR,
\fIclass\fR, and
-\fItype\fR.
+\fItype\fR\&.
\fIhostname\fR
-is a pointer a to null\-terminated string. The
+is a pointer a to null\-terminated string\&. The
\fIflags\fR
-field is currently unused and must be zero.
+field is currently unused and must be zero\&.
.PP
After a successful call to
\fBlwres_getrrsetbyname()\fR,
\fBrdatainfo\fR
structures containing resource records and potentially another list of
\fBrdatainfo\fR
-structures containing SIG resource records associated with those records. The members
+structures containing SIG resource records associated with those records\&. The members
\fBrri_rdclass\fR
and
\fBrri_rdtype\fR
-are copied from the parameters.
+are copied from the parameters\&.
\fBrri_ttl\fR
and
\fBrri_name\fR
-are properties of the obtained rrset. The resource records contained in
+are properties of the obtained rrset\&. The resource records contained in
\fBrri_rdatas\fR
and
\fBrri_sigs\fR
-are in uncompressed DNS wire format. Properties of the rdataset are represented in the
+are in uncompressed DNS wire format\&. Properties of the rdataset are represented in the
\fBrri_flags\fR
-bitfield. If the RRSET_VALIDATED bit is set, the data has been DNSSEC validated and the signatures verified.
+bitfield\&. If the RRSET_VALIDATED bit is set, the data has been DNSSEC validated and the signatures verified\&.
.PP
All of the information returned by
\fBlwres_getrrsetbyname()\fR
and
\fBrdatainfo\fR
structures, and the canonical host name strings pointed to by the
-\fBrrsetinfo\fRstructure. Memory allocated for the dynamically allocated structures created by a successful call to
+\fBrrsetinfo\fRstructure\&. Memory allocated for the dynamically allocated structures created by a successful call to
\fBlwres_getrrsetbyname()\fR
is released by
-\fBlwres_freerrset()\fR.
+\fBlwres_freerrset()\fR\&.
\fIrrset\fR
is a pointer to a
\fBstruct rrset\fR
created by a call to
-\fBlwres_getrrsetbyname()\fR.
+\fBlwres_getrrsetbyname()\fR\&.
.PP
.SH "RETURN VALUES"
.PP
.RE
.SH "SEE ALSO"
.PP
-\fBlwres\fR(3).
+\fBlwres\fR(3)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_getrrsetbyname</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_getrrsetbyname">
+<a name="idp60777808"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_getrrsetbyname, lwres_freerrset — retrieve DNS records</p>
+<p>
+ lwres_getrrsetbyname,
+ lwres_freerrset
+ — retrieve DNS records
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
int
<b class="fsfunc">lwres_getrrsetbyname</b>(</code></td>
-<td>const char * </td>
-<td>
-<var class="pdparam">hostname</var>, </td>
+<td>const char *<var class="pdparam">hostname</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">rdclass</var>, </td>
+<td>unsigned int <var class="pdparam">rdclass</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">rdtype</var>, </td>
+<td>unsigned int <var class="pdparam">rdtype</var>, </td>
</tr>
<tr>
<td> </td>
-<td>unsigned int </td>
-<td>
-<var class="pdparam">flags</var>, </td>
+<td>unsigned int <var class="pdparam">flags</var>, </td>
</tr>
<tr>
<td> </td>
-<td>struct rrsetinfo ** </td>
-<td>
-<var class="pdparam">res</var><code>)</code>;</td>
+<td>struct rrsetinfo **<var class="pdparam">res</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_freerrset</b>(</code></td>
-<td>struct rrsetinfo * </td>
-<td>
-<var class="pdparam">rrset</var><code>)</code>;</td>
+<td>struct rrsetinfo *<var class="pdparam">rrset</var><code>)</code>;</td>
</tr></table>
+<div class="funcprototype-spacer"> </div>
</div>
-<p>
+
+ <p>
The following structures are used:
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
struct rdatainfo {
unsigned int rdi_length; /* length of data */
unsigned char *rdi_data; /* record data */
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
struct rrsetinfo {
unsigned int rri_flags; /* RRSET_VALIDATED... */
unsigned int rri_rdclass; /* class number */
</pre>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543426"></a><h2>DESCRIPTION</h2>
-<p><code class="function">lwres_getrrsetbyname()</code>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60841424"></a><h2>DESCRIPTION</h2>
+
+ <p><code class="function">lwres_getrrsetbyname()</code>
gets a set of resource records associated with a
<em class="parameter"><code>hostname</code></em>, <em class="parameter"><code>class</code></em>,
and <em class="parameter"><code>type</code></em>.
null-terminated string. The <em class="parameter"><code>flags</code></em> field
is currently unused and must be zero.
</p>
-<p>
+ <p>
After a successful call to
<code class="function">lwres_getrrsetbyname()</code>,
<em class="parameter"><code>*res</code></em> is a pointer to an
bit is set, the data has been DNSSEC validated and the
signatures verified.
</p>
-<p>
+ <p>
All of the information returned by
<code class="function">lwres_getrrsetbyname()</code> is dynamically
allocated: the <code class="constant">rrsetinfo</code> and
rrset</span> created by a call to
<code class="function">lwres_getrrsetbyname()</code>.
</p>
-<p></p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543538"></a><h2>RETURN VALUES</h2>
-<p><code class="function">lwres_getrrsetbyname()</code>
+ <p></p>
+ </div>
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60858704"></a><h2>RETURN VALUES</h2>
+
+ <p><code class="function">lwres_getrrsetbyname()</code>
returns zero on success, and one of the following error codes if
an error occurred:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">ERRSET_NONAME</code></span></dt>
-<dd><p>
+<dd>
+ <p>
the name does not exist
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">ERRSET_NODATA</code></span></dt>
-<dd><p>
+<dd>
+ <p>
the name exists, but does not have data of the desired type
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">ERRSET_NOMEMORY</code></span></dt>
-<dd><p>
+<dd>
+ <p>
memory could not be allocated
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">ERRSET_INVAL</code></span></dt>
-<dd><p>
+<dd>
+ <p>
a parameter is invalid
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">ERRSET_FAIL</code></span></dt>
-<dd><p>
+<dd>
+ <p>
other failure
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant"></code></span></dt>
-<dd><p></p></dd>
+<dd>
+ <p></p>
+ </dd>
</dl></div>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543638"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>.
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60870608"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres</span>(3)
+ </span>.
</p>
-</div>
+
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_gnba
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_GNBA" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_GNBA" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lwres_gnbaresponse_parse, lwres_gnbaresponse_free, lwres_gnbarequest_free \- lightweight resolver getnamebyaddress message handling
.SH "SYNOPSIS"
.nf
-#include <lwres/lwres.h>
+#include <lwres/lwres\&.h>
.fi
-.HP 40
+.HP \w'lwres_result_t\ lwres_gnbarequest_render('u
.BI "lwres_result_t lwres_gnbarequest_render(lwres_context_t\ *" "ctx" ", lwres_gnbarequest_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");"
-.HP 41
+.HP \w'lwres_result_t\ lwres_gnbaresponse_render('u
.BI "lwres_result_t lwres_gnbaresponse_render(lwres_context_t\ *" "ctx" ", lwres_gnbaresponse_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");"
-.HP 39
+.HP \w'lwres_result_t\ lwres_gnbarequest_parse('u
.BI "lwres_result_t lwres_gnbarequest_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gnbarequest_t\ **" "structp" ");"
-.HP 40
+.HP \w'lwres_result_t\ lwres_gnbaresponse_parse('u
.BI "lwres_result_t lwres_gnbaresponse_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gnbaresponse_t\ **" "structp" ");"
-.HP 29
+.HP \w'void\ lwres_gnbaresponse_free('u
.BI "void lwres_gnbaresponse_free(lwres_context_t\ *" "ctx" ", lwres_gnbaresponse_t\ **" "structp" ");"
-.HP 28
+.HP \w'void\ lwres_gnbarequest_free('u
.BI "void lwres_gnbarequest_free(lwres_context_t\ *" "ctx" ", lwres_gnbarequest_t\ **" "structp" ");"
.SH "DESCRIPTION"
.PP
-These are low\-level routines for creating and parsing lightweight resolver address\-to\-name lookup request and response messages.
+These are low\-level routines for creating and parsing lightweight resolver address\-to\-name lookup request and response messages\&.
.PP
-There are four main functions for the getnamebyaddr opcode. One render function converts a getnamebyaddr request structure \(em
+There are four main functions for the getnamebyaddr opcode\&. One render function converts a getnamebyaddr request structure \(em
\fBlwres_gnbarequest_t\fR
-\(em to the lightweight resolver's canonical format. It is complemented by a parse function that converts a packet in this canonical format to a getnamebyaddr request structure. Another render function converts the getnamebyaddr response structure \(em
+\(em to the lightweight resolver\*(Aqs canonical format\&. It is complemented by a parse function that converts a packet in this canonical format to a getnamebyaddr request structure\&. Another render function converts the getnamebyaddr response structure \(em
\fBlwres_gnbaresponse_t\fR
-to the canonical format. This is complemented by a parse function which converts a packet in canonical format to a getnamebyaddr response structure.
+to the canonical format\&. This is complemented by a parse function which converts a packet in canonical format to a getnamebyaddr response structure\&.
.PP
These structures are defined in
-\fIlwres/lwres.h\fR. They are shown below.
+lwres/lwres\&.h\&. They are shown below\&.
.PP
+.if n \{\
.RS 4
+.\}
.nf
#define LWRES_OPCODE_GETNAMEBYADDR 0x00010002U
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
typedef struct {
lwres_uint32_t flags;
lwres_addr_t addr;
} lwres_gnbarequest_t;
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
typedef struct {
lwres_uint32_t flags;
size_t baselen;
} lwres_gnbaresponse_t;
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
\fBlwres_gnbarequest_render()\fR
uses resolver context
\fIctx\fR
to convert getnamebyaddr request structure
\fIreq\fR
-to canonical format. The packet header structure
+to canonical format\&. The packet header structure
\fIpkt\fR
is initialised and transferred to buffer
-\fIb\fR. The contents of
+\fIb\fR\&. The contents of
\fI*req\fR
-are then appended to the buffer in canonical format.
+are then appended to the buffer in canonical format\&.
\fBlwres_gnbaresponse_render()\fR
performs the same task, except it converts a getnamebyaddr response structure
\fBlwres_gnbaresponse_t\fR
-to the lightweight resolver's canonical format.
+to the lightweight resolver\*(Aqs canonical format\&.
.PP
\fBlwres_gnbarequest_parse()\fR
uses context
\fIpkt\fR
to a
\fBlwres_gnbarequest_t\fR
-structure. Buffer
+structure\&. Buffer
\fIb\fR
-provides space to be used for storing this structure. When the function succeeds, the resulting
+provides space to be used for storing this structure\&. When the function succeeds, the resulting
\fBlwres_gnbarequest_t\fR
is made available through
-\fI*structp\fR.
+\fI*structp\fR\&.
\fBlwres_gnbaresponse_parse()\fR
offers the same semantics as
\fBlwres_gnbarequest_parse()\fR
except it yields a
\fBlwres_gnbaresponse_t\fR
-structure.
+structure\&.
.PP
\fBlwres_gnbaresponse_free()\fR
and
or
\fBlwres_gnbarequest_t\fR
structures referenced via
-\fIstructp\fR. Any memory associated with ancillary buffers and strings for those structures is also discarded.
+\fIstructp\fR\&. Any memory associated with ancillary buffers and strings for those structures is also discarded\&.
.SH "RETURN VALUES"
.PP
The getnamebyaddr opcode functions
\fBlwres_gnbaresponse_parse()\fR
all return
\fBLWRES_R_SUCCESS\fR
-on success. They return
+on success\&. They return
\fBLWRES_R_NOMEMORY\fR
-if memory allocation fails.
+if memory allocation fails\&.
\fBLWRES_R_UNEXPECTEDEND\fR
is returned if the available space in the buffer
\fIb\fR
\fBlwres_gnbarequest_t\fR
and
\fBlwres_gnbaresponse_t\fR
-structures.
+structures\&.
\fBlwres_gnbarequest_parse()\fR
and
\fBlwres_gnbaresponse_parse()\fR
will return
\fBLWRES_R_UNEXPECTEDEND\fR
-if the buffer is not empty after decoding the received packet. These functions will return
+if the buffer is not empty after decoding the received packet\&. These functions will return
\fBLWRES_R_FAILURE\fR
if
-pktflags
+\fIpktflags\fR
in the packet header structure
\fBlwres_lwpacket_t\fR
-indicate that the packet is not a response to an earlier query.
+indicate that the packet is not a response to an earlier query\&.
.SH "SEE ALSO"
.PP
-\fBlwres_packet\fR(3).
+\fBlwres_packet\fR(3)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_gnba</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_gnba">
+<a name="idp60859600"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lwres_gnbaresponse_parse, lwres_gnbaresponse_free, lwres_gnbarequest_free — lightweight resolver getnamebyaddress message handling</p>
+<p>
+ lwres_gnbarequest_render,
+ lwres_gnbaresponse_render,
+ lwres_gnbarequest_parse,
+ lwres_gnbaresponse_parse,
+ lwres_gnbaresponse_free,
+ lwres_gnbarequest_free
+ — lightweight resolver getnamebyaddress message handling
+ </p>
</div>
-<div class="refsynopsisdiv">
+
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">
#include <lwres/lwres.h>
</pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_gnbarequest_render</b>
(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gnbarequest_t * </td>
-<td>
-<var class="pdparam">req</var>, </td>
+<td>lwres_gnbarequest_t *<var class="pdparam">req</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_gnbaresponse_render</b>
(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gnbaresponse_t * </td>
-<td>
-<var class="pdparam">req</var>, </td>
+<td>lwres_gnbaresponse_t *<var class="pdparam">req</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_gnbarequest_parse</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gnbarequest_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gnbarequest_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_gnbaresponse_parse</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gnbaresponse_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gnbaresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_gnbaresponse_free</b>
(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gnbaresponse_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gnbaresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_gnbarequest_free</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gnbarequest_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gnbarequest_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543537"></a><h2>DESCRIPTION</h2>
-<p>
+
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60904016"></a><h2>DESCRIPTION</h2>
+
+ <p>
These are low-level routines for creating and parsing
lightweight resolver address-to-name lookup request and
response messages.
</p>
-<p>
+ <p>
There are four main functions for the getnamebyaddr opcode.
One render function converts a getnamebyaddr request structure —
<span class="type">lwres_gnbarequest_t</span> —
This is complemented by a parse function which converts a packet in
canonical format to a getnamebyaddr response structure.
</p>
-<p>
+ <p>
These structures are defined in
<code class="filename">lwres/lwres.h</code>.
They are shown below.
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
#define LWRES_OPCODE_GETNAMEBYADDR 0x00010002U
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
typedef struct {
lwres_uint32_t flags;
lwres_addr_t addr;
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
typedef struct {
lwres_uint32_t flags;
lwres_uint16_t naliases;
</pre>
<p>
</p>
-<p><code class="function">lwres_gnbarequest_render()</code>
+
+ <p><code class="function">lwres_gnbarequest_render()</code>
uses resolver context <code class="varname">ctx</code> to convert
getnamebyaddr request structure <code class="varname">req</code> to
canonical format. The packet header structure
<span class="type">lwres_gnbaresponse_t</span> to the lightweight resolver's
canonical format.
</p>
-<p><code class="function">lwres_gnbarequest_parse()</code>
+
+ <p><code class="function">lwres_gnbarequest_parse()</code>
uses context <code class="varname">ctx</code> to convert the contents of
packet <code class="varname">pkt</code> to a
<span class="type">lwres_gnbarequest_t</span> structure. Buffer
semantics as <code class="function">lwres_gnbarequest_parse()</code>
except it yields a <span class="type">lwres_gnbaresponse_t</span> structure.
</p>
-<p><code class="function">lwres_gnbaresponse_free()</code>
+
+ <p><code class="function">lwres_gnbaresponse_free()</code>
and <code class="function">lwres_gnbarequest_free()</code> release the
memory in resolver context <code class="varname">ctx</code> that was
allocated to the <span class="type">lwres_gnbaresponse_t</span> or
ancillary buffers and strings for those structures is also
discarded.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543676"></a><h2>RETURN VALUES</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60923600"></a><h2>RETURN VALUES</h2>
+
+ <p>
The getnamebyaddr opcode functions
<code class="function">lwres_gnbarequest_render()</code>,
<code class="function">lwres_gnbaresponse_render()</code>
These functions will return
<span class="errorcode">LWRES_R_FAILURE</span>
if
- <em class="structfield"><code>pktflags</code></em>
+ <code class="varname">pktflags</code>
in the packet header structure
<span class="type">lwres_lwpacket_t</span>
indicate that the packet is not a response to an earlier query.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543742"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">lwres_packet</span>(3)</span>.
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60935504"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres_packet</span>(3)
+ </span>.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_hstrerror
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_HSTRERROR" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_HSTRERROR" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_herror, lwres_hstrerror \- lightweight resolver error message generation
.SH "SYNOPSIS"
.nf
-#include <lwres/netdb.h>
+#include <lwres/netdb\&.h>
.fi
-.HP 18
+.HP \w'void\ lwres_herror('u
.BI "void lwres_herror(const\ char\ *" "s" ");"
-.HP 29
+.HP \w'const\ char\ *\ lwres_hstrerror('u
.BI "const char * lwres_hstrerror(int\ " "err" ");"
.SH "DESCRIPTION"
.PP
followed by the string generated by
\fBlwres_hstrerror()\fR
for the error code stored in the global variable
-\fBlwres_h_errno\fR.
+\fBlwres_h_errno\fR\&.
.PP
\fBlwres_hstrerror()\fR
returns an appropriate string for the error code gievn by
-\fIerr\fR. The values of the error codes and messages are as follows:
+\fIerr\fR\&. The values of the error codes and messages are as follows:
.PP
\fBNETDB_SUCCESS\fR
.RS 4
\fBlwres_hstrerror()\fR
when the value of
\fBlwres_h_errno\fR
-is not a valid error code.
+is not a valid error code\&.
.SH "SEE ALSO"
.PP
\fBherror\fR(3),
-\fBlwres_hstrerror\fR(3).
+\fBlwres_hstrerror\fR(3)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_hstrerror</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_hstrerror">
+<a name="idp60787024"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_herror, lwres_hstrerror — lightweight resolver error message generation</p>
+<p>
+ lwres_herror,
+ lwres_hstrerror
+ — lightweight resolver error message generation
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_herror</b>(</code></td>
-<td>const char * </td>
-<td>
-<var class="pdparam">s</var><code>)</code>;</td>
+<td>const char *<var class="pdparam">s</var><code>)</code>;</td>
</tr></table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr>
<td><code class="funcdef">
const char *
<b class="fsfunc">lwres_hstrerror</b>(</code></td>
-<td>int </td>
-<td>
-<var class="pdparam">err</var><code>)</code>;</td>
+<td>int <var class="pdparam">err</var><code>)</code>;</td>
</tr></table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543390"></a><h2>DESCRIPTION</h2>
-<p><code class="function">lwres_herror()</code>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60829904"></a><h2>DESCRIPTION</h2>
+
+
+ <p><code class="function">lwres_herror()</code>
prints the string <em class="parameter"><code>s</code></em> on
<span class="type">stderr</span> followed by the string generated by
<code class="function">lwres_hstrerror()</code> for the error code stored
in the global variable <code class="constant">lwres_h_errno</code>.
</p>
-<p><code class="function">lwres_hstrerror()</code>
+
+ <p><code class="function">lwres_hstrerror()</code>
returns an appropriate string for the error code gievn by
<em class="parameter"><code>err</code></em>. The values of the error codes and
messages are as follows:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><span class="errorcode">NETDB_SUCCESS</span></span></dt>
-<dd><p><span class="errorname">Resolver Error 0 (no error)</span>
- </p></dd>
+<dd>
+ <p><span class="errorname">Resolver Error 0 (no error)</span>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">HOST_NOT_FOUND</span></span></dt>
-<dd><p><span class="errorname">Unknown host</span>
- </p></dd>
+<dd>
+ <p><span class="errorname">Unknown host</span>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">TRY_AGAIN</span></span></dt>
-<dd><p><span class="errorname">Host name lookup failure</span>
- </p></dd>
+<dd>
+ <p><span class="errorname">Host name lookup failure</span>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">NO_RECOVERY</span></span></dt>
-<dd><p><span class="errorname">Unknown server error</span>
- </p></dd>
+<dd>
+ <p><span class="errorname">Unknown server error</span>
+ </p>
+ </dd>
<dt><span class="term"><span class="errorcode">NO_DATA</span></span></dt>
-<dd><p><span class="errorname">No address associated with name</span>
- </p></dd>
+<dd>
+ <p><span class="errorname">No address associated with name</span>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543509"></a><h2>RETURN VALUES</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60852560"></a><h2>RETURN VALUES</h2>
+
+ <p>
The string <span class="errorname">Unknown resolver error</span> is returned by
<code class="function">lwres_hstrerror()</code>
when the value of
<code class="constant">lwres_h_errno</code>
is not a valid error code.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543529"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">herror</span>(3)</span>,
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60859344"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">herror</span>(3)
+ </span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3)</span>.
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_hstrerror</span>(3)
+ </span>.
</p>
-</div>
+
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_inetntop
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_INETNTOP" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_INETNTOP" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_net_ntop \- lightweight resolver IP address presentation
.SH "SYNOPSIS"
.nf
-#include <lwres/net.h>
+#include <lwres/net\&.h>
.fi
-.HP 28
+.HP \w'const\ char\ *\ lwres_net_ntop('u
.BI "const char * lwres_net_ntop(int\ " "af" ", const\ void\ *" "src" ", char\ *" "dst" ", size_t\ " "size" ");"
.SH "DESCRIPTION"
.PP
\fIaf\fR
\(em IPv4 or IPv6 \(em at location
\fIsrc\fR
-from network format to its conventional representation as a string. For IPv4 addresses, that string would be a dotted\-decimal. An IPv6 address would be represented in colon notation as described in RFC1884.
+from network format to its conventional representation as a string\&. For IPv4 addresses, that string would be a dotted\-decimal\&. An IPv6 address would be represented in colon notation as described in RFC1884\&.
.PP
The generated string is copied to
\fIdst\fR
provided
\fIsize\fR
-indicates it is long enough to store the ASCII representation of the address.
+indicates it is long enough to store the ASCII representation of the address\&.
.SH "RETURN VALUES"
.PP
If successful, the function returns
-\fIdst\fR: a pointer to a string containing the presentation format of the address.
+\fIdst\fR: a pointer to a string containing the presentation format of the address\&.
\fBlwres_net_ntop()\fR
returns
\fBNULL\fR
\fBEAFNOSUPPORT\fR
if the protocol family given in
\fIaf\fR
-is not supported.
+is not supported\&.
.SH "SEE ALSO"
.PP
\fBRFC1884\fR(),
\fBinet_ntop\fR(3),
-\fBerrno\fR(3).
+\fBerrno\fR(3)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_inetntop</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_inetntop">
+<a name="idp60802896"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_net_ntop — lightweight resolver IP address presentation</p>
+<p>
+ lwres_net_ntop
+ — lightweight resolver IP address presentation
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/net.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
const char *
<b class="fsfunc">lwres_net_ntop</b>(</code></td>
-<td>int </td>
-<td>
-<var class="pdparam">af</var>, </td>
+<td>int <var class="pdparam">af</var>, </td>
</tr>
<tr>
<td> </td>
-<td>const void * </td>
-<td>
-<var class="pdparam">src</var>, </td>
+<td>const void *<var class="pdparam">src</var>, </td>
</tr>
<tr>
<td> </td>
-<td>char * </td>
-<td>
-<var class="pdparam">dst</var>, </td>
+<td>char *<var class="pdparam">dst</var>, </td>
</tr>
<tr>
<td> </td>
-<td>size_t </td>
-<td>
-<var class="pdparam">size</var><code>)</code>;</td>
+<td>size_t <var class="pdparam">size</var><code>)</code>;</td>
</tr>
</table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543390"></a><h2>DESCRIPTION</h2>
-<p><code class="function">lwres_net_ntop()</code>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60845648"></a><h2>DESCRIPTION</h2>
+
+
+ <p><code class="function">lwres_net_ntop()</code>
converts an IP address of protocol family
<em class="parameter"><code>af</code></em> — IPv4 or IPv6 — at
location <em class="parameter"><code>src</code></em> from network format to its
that string would be a dotted-decimal. An IPv6 address would be
represented in colon notation as described in RFC1884.
</p>
-<p>
+
+ <p>
The generated string is copied to <em class="parameter"><code>dst</code></em>
provided
<em class="parameter"><code>size</code></em> indicates it is long enough to
store the
ASCII representation of the address.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543422"></a><h2>RETURN VALUES</h2>
-<p>
+
+ </div>
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60853456"></a><h2>RETURN VALUES</h2>
+
+
+ <p>
If successful, the function returns <em class="parameter"><code>dst</code></em>:
a pointer to a string containing the presentation format of the
address. <code class="function">lwres_net_ntop()</code> returns
not
supported.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543456"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">RFC1884</span></span>,
- <span class="citerefentry"><span class="refentrytitle">inet_ntop</span>(3)</span>,
- <span class="citerefentry"><span class="refentrytitle">errno</span>(3)</span>.
+
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60857168"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">RFC1884</span>
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">inet_ntop</span>(3)
+ </span>,
+ <span class="citerefentry">
+ <span class="refentrytitle">errno</span>(3)
+ </span>.
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_noop
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_NOOP" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_NOOP" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_nooprequest_render, lwres_noopresponse_render, lwres_nooprequest_parse, lwres_noopresponse_parse, lwres_noopresponse_free, lwres_nooprequest_free \- lightweight resolver no\-op message handling
.SH "SYNOPSIS"
.nf
-#include <lwres/lwres.h>
+#include <lwres/lwres\&.h>
.fi
-.HP 40
+.HP \w'lwres_result_t\ lwres_nooprequest_render('u
.BI "lwres_result_t lwres_nooprequest_render(lwres_context_t\ *" "ctx" ", lwres_nooprequest_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");"
-.HP 41
+.HP \w'lwres_result_t\ lwres_noopresponse_render('u
.BI "lwres_result_t lwres_noopresponse_render(lwres_context_t\ *" "ctx" ", lwres_noopresponse_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");"
-.HP 39
+.HP \w'lwres_result_t\ lwres_nooprequest_parse('u
.BI "lwres_result_t lwres_nooprequest_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_nooprequest_t\ **" "structp" ");"
-.HP 40
+.HP \w'lwres_result_t\ lwres_noopresponse_parse('u
.BI "lwres_result_t lwres_noopresponse_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_noopresponse_t\ **" "structp" ");"
-.HP 29
+.HP \w'void\ lwres_noopresponse_free('u
.BI "void lwres_noopresponse_free(lwres_context_t\ *" "ctx" ", lwres_noopresponse_t\ **" "structp" ");"
-.HP 28
+.HP \w'void\ lwres_nooprequest_free('u
.BI "void lwres_nooprequest_free(lwres_context_t\ *" "ctx" ", lwres_nooprequest_t\ **" "structp" ");"
.SH "DESCRIPTION"
.PP
-These are low\-level routines for creating and parsing lightweight resolver no\-op request and response messages.
+These are low\-level routines for creating and parsing lightweight resolver no\-op request and response messages\&.
.PP
The no\-op message is analogous to a
\fBping\fR
-packet: a packet is sent to the resolver daemon and is simply echoed back. The opcode is intended to allow a client to determine if the server is operational or not.
+packet: a packet is sent to the resolver daemon and is simply echoed back\&. The opcode is intended to allow a client to determine if the server is operational or not\&.
.PP
-There are four main functions for the no\-op opcode. One render function converts a no\-op request structure \(em
+There are four main functions for the no\-op opcode\&. One render function converts a no\-op request structure \(em
\fBlwres_nooprequest_t\fR
-\(em to the lightweight resolver's canonical format. It is complemented by a parse function that converts a packet in this canonical format to a no\-op request structure. Another render function converts the no\-op response structure \(em
+\(em to the lightweight resolver\*(Aqs canonical format\&. It is complemented by a parse function that converts a packet in this canonical format to a no\-op request structure\&. Another render function converts the no\-op response structure \(em
\fBlwres_noopresponse_t\fR
-to the canonical format. This is complemented by a parse function which converts a packet in canonical format to a no\-op response structure.
+to the canonical format\&. This is complemented by a parse function which converts a packet in canonical format to a no\-op response structure\&.
.PP
These structures are defined in
-\fIlwres/lwres.h\fR. They are shown below.
+lwres/lwres\&.h\&. They are shown below\&.
.PP
+.if n \{\
.RS 4
+.\}
.nf
#define LWRES_OPCODE_NOOP 0x00000000U
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
typedef struct {
lwres_uint16_t datalength;
unsigned char *data;
} lwres_nooprequest_t;
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
typedef struct {
lwres_uint16_t datalength;
unsigned char *data;
} lwres_noopresponse_t;
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
-Although the structures have different types, they are identical. This is because the no\-op opcode simply echos whatever data was sent: the response is therefore identical to the request.
+Although the structures have different types, they are identical\&. This is because the no\-op opcode simply echos whatever data was sent: the response is therefore identical to the request\&.
.PP
\fBlwres_nooprequest_render()\fR
uses resolver context
\fIctx\fR
to convert no\-op request structure
\fIreq\fR
-to canonical format. The packet header structure
+to canonical format\&. The packet header structure
\fIpkt\fR
is initialised and transferred to buffer
-\fIb\fR. The contents of
+\fIb\fR\&. The contents of
\fI*req\fR
-are then appended to the buffer in canonical format.
+are then appended to the buffer in canonical format\&.
\fBlwres_noopresponse_render()\fR
performs the same task, except it converts a no\-op response structure
\fBlwres_noopresponse_t\fR
-to the lightweight resolver's canonical format.
+to the lightweight resolver\*(Aqs canonical format\&.
.PP
\fBlwres_nooprequest_parse()\fR
uses context
\fIpkt\fR
to a
\fBlwres_nooprequest_t\fR
-structure. Buffer
+structure\&. Buffer
\fIb\fR
-provides space to be used for storing this structure. When the function succeeds, the resulting
+provides space to be used for storing this structure\&. When the function succeeds, the resulting
\fBlwres_nooprequest_t\fR
is made available through
-\fI*structp\fR.
+\fI*structp\fR\&.
\fBlwres_noopresponse_parse()\fR
offers the same semantics as
\fBlwres_nooprequest_parse()\fR
except it yields a
\fBlwres_noopresponse_t\fR
-structure.
+structure\&.
.PP
\fBlwres_noopresponse_free()\fR
and
or
\fBlwres_nooprequest_t\fR
structures referenced via
-\fIstructp\fR.
+\fIstructp\fR\&.
.SH "RETURN VALUES"
.PP
The no\-op opcode functions
\fBlwres_noopresponse_parse()\fR
all return
\fBLWRES_R_SUCCESS\fR
-on success. They return
+on success\&. They return
\fBLWRES_R_NOMEMORY\fR
-if memory allocation fails.
+if memory allocation fails\&.
\fBLWRES_R_UNEXPECTEDEND\fR
is returned if the available space in the buffer
\fIb\fR
\fBlwres_nooprequest_t\fR
and
\fBlwres_noopresponse_t\fR
-structures.
+structures\&.
\fBlwres_nooprequest_parse()\fR
and
\fBlwres_noopresponse_parse()\fR
will return
\fBLWRES_R_UNEXPECTEDEND\fR
-if the buffer is not empty after decoding the received packet. These functions will return
+if the buffer is not empty after decoding the received packet\&. These functions will return
\fBLWRES_R_FAILURE\fR
if
\fBpktflags\fR
in the packet header structure
\fBlwres_lwpacket_t\fR
-indicate that the packet is not a response to an earlier query.
+indicate that the packet is not a response to an earlier query\&.
.SH "SEE ALSO"
.PP
\fBlwres_packet\fR(3)
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_noop</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_noop">
+<a name="idp60843728"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_nooprequest_render, lwres_noopresponse_render, lwres_nooprequest_parse, lwres_noopresponse_parse, lwres_noopresponse_free, lwres_nooprequest_free — lightweight resolver no-op message handling</p>
+<p>
+ lwres_nooprequest_render,
+ lwres_noopresponse_render,
+ lwres_nooprequest_parse,
+ lwres_noopresponse_parse,
+ lwres_noopresponse_free,
+ lwres_nooprequest_free
+ — lightweight resolver no-op message handling
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">
#include <lwres/lwres.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_nooprequest_render</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_nooprequest_t * </td>
-<td>
-<var class="pdparam">req</var>, </td>
+<td>lwres_nooprequest_t *<var class="pdparam">req</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_noopresponse_render</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_noopresponse_t * </td>
-<td>
-<var class="pdparam">req</var>, </td>
+<td>lwres_noopresponse_t *<var class="pdparam">req</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var><code>)</code>;</td>
+<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_nooprequest_parse</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_nooprequest_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_nooprequest_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_noopresponse_parse</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var>, </td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_noopresponse_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_noopresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_noopresponse_free</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_noopresponse_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_noopresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_nooprequest_free</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_nooprequest_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_nooprequest_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543533"></a><h2>DESCRIPTION</h2>
-<p>
+ </div>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60908240"></a><h2>DESCRIPTION</h2>
+
+ <p>
These are low-level routines for creating and parsing
lightweight resolver no-op request and response messages.
</p>
-<p>
- The no-op message is analogous to a <span><strong class="command">ping</strong></span>
+ <p>
+ The no-op message is analogous to a <span class="command"><strong>ping</strong></span>
packet:
a packet is sent to the resolver daemon and is simply echoed back.
The opcode is intended to allow a client to determine if the server is
operational or not.
</p>
-<p>
+ <p>
There are four main functions for the no-op opcode.
One render function converts a no-op request structure —
<span class="type">lwres_nooprequest_t</span> —
This is complemented by a parse function which converts a packet in
canonical format to a no-op response structure.
</p>
-<p>
+ <p>
These structures are defined in
<code class="filename">lwres/lwres.h</code>.
They are shown below.
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
#define LWRES_OPCODE_NOOP 0x00000000U
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
typedef struct {
lwres_uint16_t datalength;
unsigned char *data;
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
typedef struct {
lwres_uint16_t datalength;
unsigned char *data;
</pre>
<p>
</p>
-<p>
+ <p>
Although the structures have different types, they are identical.
This is because the no-op opcode simply echos whatever data was sent:
the response is therefore identical to the request.
</p>
-<p><code class="function">lwres_nooprequest_render()</code>
+
+ <p><code class="function">lwres_nooprequest_render()</code>
uses resolver context <em class="parameter"><code>ctx</code></em> to convert
no-op request structure <em class="parameter"><code>req</code></em> to canonical
format. The packet header structure <em class="parameter"><code>pkt</code></em>
<span class="type">lwres_noopresponse_t</span> to the lightweight resolver's
canonical format.
</p>
-<p><code class="function">lwres_nooprequest_parse()</code>
+
+ <p><code class="function">lwres_nooprequest_parse()</code>
uses context <em class="parameter"><code>ctx</code></em> to convert the contents
of packet <em class="parameter"><code>pkt</code></em> to a
<span class="type">lwres_nooprequest_t</span> structure. Buffer
semantics as <code class="function">lwres_nooprequest_parse()</code>
except it yields a <span class="type">lwres_noopresponse_t</span> structure.
</p>
-<p><code class="function">lwres_noopresponse_free()</code>
+
+ <p><code class="function">lwres_noopresponse_free()</code>
and <code class="function">lwres_nooprequest_free()</code> release the
memory in resolver context <em class="parameter"><code>ctx</code></em> that was
allocated to the <span class="type">lwres_noopresponse_t</span> or
<span class="type">lwres_nooprequest_t</span> structures referenced via
<em class="parameter"><code>structp</code></em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543684"></a><h2>RETURN VALUES</h2>
-<p>
+
+ </div>
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60928976"></a><h2>RETURN VALUES</h2>
+
+ <p>
The no-op opcode functions
<code class="function">lwres_nooprequest_render()</code>,
<span class="type">lwres_lwpacket_t</span>
indicate that the packet is not a response to an earlier query.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543750"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">lwres_packet</span>(3)</span>
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60936528"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres_packet</span>(3)
+ </span>
</p>
-</div>
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_packet
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_PACKET" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_PACKET" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_lwpacket_renderheader, lwres_lwpacket_parseheader \- lightweight resolver packet handling functions
.SH "SYNOPSIS"
.nf
-#include <lwres/lwpacket.h>
+#include <lwres/lwpacket\&.h>
.fi
-.HP 43
+.HP \w'lwres_result_t\ lwres_lwpacket_renderheader('u
.BI "lwres_result_t lwres_lwpacket_renderheader(lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ");"
-.HP 42
+.HP \w'lwres_result_t\ lwres_lwpacket_parseheader('u
.BI "lwres_result_t lwres_lwpacket_parseheader(lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ");"
.SH "DESCRIPTION"
.PP
These functions rely on a
\fBstruct lwres_lwpacket\fR
which is defined in
-\fIlwres/lwpacket.h\fR.
+lwres/lwpacket\&.h\&.
.PP
+.if n \{\
.RS 4
+.\}
.nf
typedef struct lwres_lwpacket lwres_lwpacket_t;
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
+.if n \{\
.RS 4
+.\}
.nf
struct lwres_lwpacket {
lwres_uint32_t length;
lwres_uint16_t authlength;
};
.fi
+.if n \{\
.RE
-.sp
+.\}
.PP
The elements of this structure are:
.PP
\fBlength\fR
.RS 4
-the overall packet length, including the entire packet header. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls.
+the overall packet length, including the entire packet header\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&.
.RE
.PP
\fBversion\fR
.RS 4
-the header format. There is currently only one format,
-\fBLWRES_LWPACKETVERSION_0\fR. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls.
+the header format\&. There is currently only one format,
+\fBLWRES_LWPACKETVERSION_0\fR\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&.
.RE
.PP
\fBpktflags\fR
.RS 4
-library\-defined flags for this packet: for instance whether the packet is a request or a reply. Flag values can be set, but not defined by the caller. This field is filled in by the application wit the exception of the LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in the lwres_gabn_*() and lwres_gnba_*() calls.
+library\-defined flags for this packet: for instance whether the packet is a request or a reply\&. Flag values can be set, but not defined by the caller\&. This field is filled in by the application wit the exception of the LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in the lwres_gabn_*() and lwres_gnba_*() calls\&.
.RE
.PP
\fBserial\fR
.RS 4
-is set by the requestor and is returned in all replies. If two or more packets from the same source have the same serial number and are from the same source, they are assumed to be duplicates and the latter ones may be dropped. This field must be set by the application.
+is set by the requestor and is returned in all replies\&. If two or more packets from the same source have the same serial number and are from the same source, they are assumed to be duplicates and the latter ones may be dropped\&. This field must be set by the application\&.
.RE
.PP
\fBopcode\fR
.RS 4
-indicates the operation. Opcodes between 0x00000000 and 0x03ffffff are reserved for use by the lightweight resolver library. Opcodes between 0x04000000 and 0xffffffff are application defined. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls.
+indicates the operation\&. Opcodes between 0x00000000 and 0x03ffffff are reserved for use by the lightweight resolver library\&. Opcodes between 0x04000000 and 0xffffffff are application defined\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&.
.RE
.PP
\fBresult\fR
.RS 4
-is only valid for replies. Results between 0x04000000 and 0xffffffff are application defined. Results between 0x00000000 and 0x03ffffff are reserved for library use. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls.
+is only valid for replies\&. Results between 0x04000000 and 0xffffffff are application defined\&. Results between 0x00000000 and 0x03ffffff are reserved for library use\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&.
.RE
.PP
\fBrecvlength\fR
.RS 4
-is the maximum buffer size that the receiver can handle on requests and the size of the buffer needed to satisfy a request when the buffer is too large for replies. This field is supplied by the application.
+is the maximum buffer size that the receiver can handle on requests and the size of the buffer needed to satisfy a request when the buffer is too large for replies\&. This field is supplied by the application\&.
.RE
.PP
\fBauthtype\fR
.RS 4
-defines the packet level authentication that is used. Authorisation types between 0x1000 and 0xffff are application defined and types between 0x0000 and 0x0fff are reserved for library use. Currently these are not used and must be zero.
+defines the packet level authentication that is used\&. Authorisation types between 0x1000 and 0xffff are application defined and types between 0x0000 and 0x0fff are reserved for library use\&. Currently these are not used and must be zero\&.
.RE
.PP
\fBauthlen\fR
.RS 4
-gives the length of the authentication data. Since packet authentication is currently not used, this must be zero.
+gives the length of the authentication data\&. Since packet authentication is currently not used, this must be zero\&.
.RE
.PP
The following opcodes are currently defined:
.PP
\fBNOOP\fR
.RS 4
-Success is always returned and the packet contents are echoed. The lwres_noop_*() functions should be used for this type.
+Success is always returned and the packet contents are echoed\&. The lwres_noop_*() functions should be used for this type\&.
.RE
.PP
\fBGETADDRSBYNAME\fR
.RS 4
-returns all known addresses for a given name. The lwres_gabn_*() functions should be used for this type.
+returns all known addresses for a given name\&. The lwres_gabn_*() functions should be used for this type\&.
.RE
.PP
\fBGETNAMEBYADDR\fR
.RS 4
-return the hostname for the given address. The lwres_gnba_*() functions should be used for this type.
+return the hostname for the given address\&. The lwres_gnba_*() functions should be used for this type\&.
.RE
.PP
\fBlwres_lwpacket_renderheader()\fR
\fBlwres_lwpacket_t\fR
\fI*pkt\fR
in network byte order to the lightweight resolver buffer,
-\fI*b\fR.
+\fI*b\fR\&.
.PP
\fBlwres_lwpacket_parseheader()\fR
-performs the converse operation. It transfers data in network byte order from buffer
+performs the converse operation\&. It transfers data in network byte order from buffer
\fI*b\fR
to resolver packet
-\fI*pkt\fR. The contents of the buffer
+\fI*pkt\fR\&. The contents of the buffer
\fIb\fR
should correspond to a
-\fBlwres_lwpacket_t\fR.
+\fBlwres_lwpacket_t\fR\&.
.SH "RETURN VALUES"
.PP
Successful calls to
and
\fBlwres_lwpacket_parseheader()\fR
return
-\fBLWRES_R_SUCCESS\fR. If there is insufficient space to copy data between the buffer
+\fBLWRES_R_SUCCESS\fR\&. If there is insufficient space to copy data between the buffer
\fI*b\fR
and lightweight resolver packet
\fI*pkt\fR
both functions return
-\fBLWRES_R_UNEXPECTEDEND\fR.
+\fBLWRES_R_UNEXPECTEDEND\fR\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_packet</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_packet">
+<a name="idp60887888"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_lwpacket_renderheader, lwres_lwpacket_parseheader — lightweight resolver packet handling functions</p>
+<p>
+ lwres_lwpacket_renderheader,
+ lwres_lwpacket_parseheader
+ — lightweight resolver packet handling functions
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/lwpacket.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_lwpacket_renderheader</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var><code>)</code>;</td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_lwpacket_parseheader</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_lwpacket_t * </td>
-<td>
-<var class="pdparam">pkt</var><code>)</code>;</td>
+<td>lwres_lwpacket_t *<var class="pdparam">pkt</var><code>)</code>;</td>
</tr>
</table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543401"></a><h2>DESCRIPTION</h2>
-<p>
+ </div>
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60919760"></a><h2>DESCRIPTION</h2>
+
+ <p>
These functions rely on a
<span class="type">struct lwres_lwpacket</span>
which is defined in
<code class="filename">lwres/lwpacket.h</code>.
</p>
-<pre class="programlisting">
+
+ <pre class="programlisting">
typedef struct lwres_lwpacket lwres_lwpacket_t;
</pre>
<p>
</p>
-<pre class="programlisting">
+ <pre class="programlisting">
struct lwres_lwpacket {
lwres_uint32_t length;
lwres_uint16_t version;
</pre>
<p>
</p>
-<p>
+
+ <p>
The elements of this structure are:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">length</code></span></dt>
-<dd><p>
+<dd>
+ <p>
the overall packet length, including the entire packet header.
This field is filled in by the lwres_gabn_*() and lwres_gnba_*()
calls.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">version</code></span></dt>
-<dd><p>
+<dd>
+ <p>
the header format. There is currently only one format,
<span class="type">LWRES_LWPACKETVERSION_0</span>.
This field is filled in by the lwres_gabn_*() and lwres_gnba_*()
calls.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">pktflags</code></span></dt>
-<dd><p>
+<dd>
+ <p>
library-defined flags for this packet: for instance whether the
packet
is a request or a reply. Flag values can be set, but not defined
LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in
the
lwres_gabn_*() and lwres_gnba_*() calls.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">serial</code></span></dt>
-<dd><p>
+<dd>
+ <p>
is set by the requestor and is returned in all replies. If two
or more
packets from the same source have the same serial number and are
latter ones
may be dropped.
This field must be set by the application.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">opcode</code></span></dt>
-<dd><p>
+<dd>
+ <p>
indicates the operation.
Opcodes between 0x00000000 and 0x03ffffff are
reserved for use by the lightweight resolver library. Opcodes
0x04000000 and 0xffffffff are application defined.
This field is filled in by the lwres_gabn_*() and lwres_gnba_*()
calls.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">result</code></span></dt>
-<dd><p>
+<dd>
+ <p>
is only valid for replies.
Results between 0x04000000 and 0xffffffff are application
defined.
library use.
This field is filled in by the lwres_gabn_*() and lwres_gnba_*()
calls.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">recvlength</code></span></dt>
-<dd><p>
+<dd>
+ <p>
is the maximum buffer size that the receiver can handle on
requests
and the size of the buffer needed to satisfy a request when the
buffer
is too large for replies.
This field is supplied by the application.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">authtype</code></span></dt>
-<dd><p>
+<dd>
+ <p>
defines the packet level authentication that is used.
Authorisation types between 0x1000 and 0xffff are application
defined
and types between 0x0000 and 0x0fff are reserved for library
use.
Currently these are not used and must be zero.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">authlen</code></span></dt>
-<dd><p>
+<dd>
+ <p>
gives the length of the authentication data.
Since packet authentication is currently not used, this must be
zero.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-<p>
+ <p>
The following opcodes are currently defined:
</p>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">NOOP</code></span></dt>
-<dd><p>
+<dd>
+ <p>
Success is always returned and the packet contents are echoed.
The lwres_noop_*() functions should be used for this type.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">GETADDRSBYNAME</code></span></dt>
-<dd><p>
+<dd>
+ <p>
returns all known addresses for a given name.
The lwres_gabn_*() functions should be used for this type.
- </p></dd>
+ </p>
+ </dd>
<dt><span class="term"><code class="constant">GETNAMEBYADDR</code></span></dt>
-<dd><p>
+<dd>
+ <p>
return the hostname for the given address.
The lwres_gnba_*() functions should be used for this type.
- </p></dd>
+ </p>
+ </dd>
</dl></div>
<p>
</p>
-<p><code class="function">lwres_lwpacket_renderheader()</code>
+
+ <p><code class="function">lwres_lwpacket_renderheader()</code>
transfers the contents of lightweight resolver packet structure
<span class="type">lwres_lwpacket_t</span> <em class="parameter"><code>*pkt</code></em> in
network byte order to the lightweight resolver buffer,
<em class="parameter"><code>*b</code></em>.
</p>
-<p><code class="function">lwres_lwpacket_parseheader()</code>
+
+ <p><code class="function">lwres_lwpacket_parseheader()</code>
performs the converse operation. It transfers data in network
byte order from buffer <em class="parameter"><code>*b</code></em> to resolver
packet <em class="parameter"><code>*pkt</code></em>. The contents of the buffer
<em class="parameter"><code>b</code></em> should correspond to a
<span class="type">lwres_lwpacket_t</span>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543718"></a><h2>RETURN VALUES</h2>
-<p>
+
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60953808"></a><h2>RETURN VALUES</h2>
+
+ <p>
Successful calls to
<code class="function">lwres_lwpacket_renderheader()</code> and
<code class="function">lwres_lwpacket_parseheader()</code> return
functions
return <span class="errorcode">LWRES_R_UNEXPECTEDEND</span>.
</p>
-</div>
+
+ </div>
</div></body>
</html>
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
+'\" t
.\" Title: lwres_resutil
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 18, 2007
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2007-06-18
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "LWRES_RESUTIL" "3" "June 18, 2007" "BIND9" "BIND9"
+.TH "LWRES_RESUTIL" "3" "2007\-06\-18" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * 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 '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr \- lightweight resolver utility functions
.SH "SYNOPSIS"
.nf
-#include <lwres/lwres.h>
+#include <lwres/lwres\&.h>
.fi
-.HP 34
+.HP \w'lwres_result_t\ lwres_string_parse('u
.BI "lwres_result_t lwres_string_parse(lwres_buffer_t\ *" "b" ", char\ **" "c" ", lwres_uint16_t\ *" "len" ");"
-.HP 32
+.HP \w'lwres_result_t\ lwres_addr_parse('u
.BI "lwres_result_t lwres_addr_parse(lwres_buffer_t\ *" "b" ", lwres_addr_t\ *" "addr" ");"
-.HP 36
+.HP \w'lwres_result_t\ lwres_getaddrsbyname('u
.BI "lwres_result_t lwres_getaddrsbyname(lwres_context_t\ *" "ctx" ", const\ char\ *" "name" ", lwres_uint32_t\ " "addrtypes" ", lwres_gabnresponse_t\ **" "structp" ");"
-.HP 35
+.HP \w'lwres_result_t\ lwres_getnamebyaddr('u
.BI "lwres_result_t lwres_getnamebyaddr(lwres_context_t\ *" "ctx" ", lwres_uint32_t\ " "addrtype" ", lwres_uint16_t\ " "addrlen" ", const\ unsigned\ char\ *" "addr" ", lwres_gnbaresponse_t\ **" "structp" ");"
.SH "DESCRIPTION"
.PP
\fBlwres_string_parse()\fR
retrieves a DNS\-encoded string starting the current pointer of lightweight resolver buffer
-\fIb\fR: i.e.
-\fBb\->current\fR. When the function returns, the address of the first byte of the encoded string is returned via
+\fIb\fR: i\&.e\&.
+\fBb\->current\fR\&. When the function returns, the address of the first byte of the encoded string is returned via
\fI*c\fR
and the length of that string is given by
-\fI*len\fR. The buffer's current pointer is advanced to point at the character following the string length, the encoded string, and the trailing
+\fI*len\fR\&. The buffer\*(Aqs current pointer is advanced to point at the character following the string length, the encoded string, and the trailing
\fBNULL\fR
-character.
+character\&.
.PP
\fBlwres_addr_parse()\fR
extracts an address from the buffer
-\fIb\fR. The buffer's current pointer
+\fIb\fR\&. The buffer\*(Aqs current pointer
\fBb\->current\fR
-is presumed to point at an encoded address: the address preceded by a 32\-bit protocol family identifier and a 16\-bit length field. The encoded address is copied to
+is presumed to point at an encoded address: the address preceded by a 32\-bit protocol family identifier and a 16\-bit length field\&. The encoded address is copied to
\fBaddr\->address\fR
and
\fBaddr\->length\fR
-indicates the size in bytes of the address that was copied.
+indicates the size in bytes of the address that was copied\&.
\fBb\->current\fR
-is advanced to point at the next byte of available data in the buffer following the encoded address.
+is advanced to point at the next byte of available data in the buffer following the encoded address\&.
.PP
\fBlwres_getaddrsbyname()\fR
and
\fBlwres_gnbaresponse_t\fR
structure defined below:
.PP
+.if n \{\
.RS 4
+.\}
.nf
typedef struct {
lwres_uint32_t flags;
size_t baselen;
} lwres_gabnresponse_t;
.fi
+.if n \{\
.RE
+.\}
.PP
The contents of this structure are not manipulated directly but they are controlled through the
\fBlwres_gabn\fR(3)
-functions.
+functions\&.
.PP
The lightweight resolver uses
\fBlwres_getaddrsbyname()\fR
-to perform forward lookups. Hostname
+to perform forward lookups\&. Hostname
\fIname\fR
is looked up using the resolver context
\fIctx\fR
-for memory allocation.
+for memory allocation\&.
\fIaddrtypes\fR
-is a bitmask indicating which type of addresses are to be looked up. Current values for this bitmask are
+is a bitmask indicating which type of addresses are to be looked up\&. Current values for this bitmask are
\fBLWRES_ADDRTYPE_V4\fR
for IPv4 addresses and
\fBLWRES_ADDRTYPE_V6\fR
-for IPv6 addresses. Results of the lookup are returned in
-\fI*structp\fR.
+for IPv6 addresses\&. Results of the lookup are returned in
+\fI*structp\fR\&.
.PP
\fBlwres_getnamebyaddr()\fR
-performs reverse lookups. Resolver context
+performs reverse lookups\&. Resolver context
\fIctx\fR
-is used for memory allocation. The address type is indicated by
+is used for memory allocation\&. The address type is indicated by
\fIaddrtype\fR:
\fBLWRES_ADDRTYPE_V4\fR
or
-\fBLWRES_ADDRTYPE_V6\fR. The address to be looked up is given by
+\fBLWRES_ADDRTYPE_V6\fR\&. The address to be looked up is given by
\fIaddr\fR
and its length is
\fIaddrlen\fR
-bytes. The result of the function call is made available through
-\fI*structp\fR.
+bytes\&. The result of the function call is made available through
+\fI*structp\fR\&.
.SH "RETURN VALUES"
.PP
Successful calls to
and
\fBlwres_addr_parse()\fR
return
-\fBLWRES_R_SUCCESS.\fR
+\fBLWRES_R_SUCCESS\&.\fR
Both functions return
\fBLWRES_R_FAILURE\fR
if the buffer is corrupt or
\fBLWRES_R_UNEXPECTEDEND\fR
-if the buffer has less space than expected for the components of the encoded string or address.
+if the buffer has less space than expected for the components of the encoded string or address\&.
.PP
\fBlwres_getaddrsbyname()\fR
returns
\fBLWRES_R_NOTFOUND\fR
if the hostname
\fIname\fR
-could not be found.
+could not be found\&.
.PP
\fBLWRES_R_SUCCESS\fR
is returned by a successful call to
-\fBlwres_getnamebyaddr()\fR.
+\fBlwres_getnamebyaddr()\fR\&.
.PP
Both
\fBlwres_getaddrsbyname()\fR
\fBLWRES_R_NOMEMORY\fR
when memory allocation requests fail and
\fBLWRES_R_UNEXPECTEDEND\fR
-if the buffers used for sending queries and receiving replies are too small.
+if the buffers used for sending queries and receiving replies are too small\&.
.SH "SEE ALSO"
.PP
\fBlwres_buffer\fR(3),
-\fBlwres_gabn\fR(3).
+\fBlwres_gabn\fR(3)\&.
+.SH "AUTHOR"
+.PP
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
+.br
Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
+
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
-<!-- $Id$ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>lwres_resutil</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
-<a name="id2476282"></a><div class="titlepage"></div>
-<div class="refnamediv">
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_resutil">
+<a name="idp60846416"></a><div class="titlepage"></div>
+
+
+
+
+
+
+
+ <div class="refnamediv">
<h2>Name</h2>
-<p>lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr — lightweight resolver utility functions</p>
+<p>
+ lwres_string_parse,
+ lwres_addr_parse,
+ lwres_getaddrsbyname,
+ lwres_getnamebyaddr
+ — lightweight resolver utility functions
+ </p>
</div>
-<div class="refsynopsisdiv">
+ <div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
-<div class="funcsynopsis">
+ <div class="funcsynopsis">
<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_string_parse</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>char ** </td>
-<td>
-<var class="pdparam">c</var>, </td>
+<td>char **<var class="pdparam">c</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_uint16_t * </td>
-<td>
-<var class="pdparam">len</var><code>)</code>;</td>
+<td>lwres_uint16_t *<var class="pdparam">len</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_addr_parse</b>(</code></td>
-<td>lwres_buffer_t * </td>
-<td>
-<var class="pdparam">b</var>, </td>
+<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_addr_t * </td>
-<td>
-<var class="pdparam">addr</var><code>)</code>;</td>
+<td>lwres_addr_t *<var class="pdparam">addr</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_getaddrsbyname</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>const char * </td>
-<td>
-<var class="pdparam">name</var>, </td>
+<td>const char *<var class="pdparam">name</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_uint32_t </td>
-<td>
-<var class="pdparam">addrtypes</var>, </td>
+<td>lwres_uint32_t <var class="pdparam">addrtypes</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gabnresponse_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gabnresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
-<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
+<div class="funcprototype-spacer"> </div>
+<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">
lwres_result_t
<b class="fsfunc">lwres_getnamebyaddr</b>(</code></td>
-<td>lwres_context_t * </td>
-<td>
-<var class="pdparam">ctx</var>, </td>
+<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_uint32_t </td>
-<td>
-<var class="pdparam">addrtype</var>, </td>
+<td>lwres_uint32_t <var class="pdparam">addrtype</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_uint16_t </td>
-<td>
-<var class="pdparam">addrlen</var>, </td>
+<td>lwres_uint16_t <var class="pdparam">addrlen</var>, </td>
</tr>
<tr>
<td> </td>
-<td>const unsigned char * </td>
-<td>
-<var class="pdparam">addr</var>, </td>
+<td>const unsigned char *<var class="pdparam">addr</var>, </td>
</tr>
<tr>
<td> </td>
-<td>lwres_gnbaresponse_t ** </td>
-<td>
-<var class="pdparam">structp</var><code>)</code>;</td>
+<td>lwres_gnbaresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
+<div class="funcprototype-spacer"> </div>
</div>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543478"></a><h2>DESCRIPTION</h2>
-<p><code class="function">lwres_string_parse()</code>
+ </div>
+
+ <div class="refsection" title="DESCRIPTION">
+<a name="idp60916432"></a><h2>DESCRIPTION</h2>
+
+
+ <p><code class="function">lwres_string_parse()</code>
retrieves a DNS-encoded string starting the current pointer of
lightweight resolver buffer <em class="parameter"><code>b</code></em>: i.e.
<code class="constant">b->current</code>. When the function returns,
string length, the encoded string, and the trailing
<span class="type">NULL</span> character.
</p>
-<p><code class="function">lwres_addr_parse()</code>
+
+ <p><code class="function">lwres_addr_parse()</code>
extracts an address from the buffer <em class="parameter"><code>b</code></em>.
The buffer's current pointer <code class="constant">b->current</code>
is presumed to point at an encoded address: the address preceded
next byte of available data in the buffer following the encoded
address.
</p>
-<p><code class="function">lwres_getaddrsbyname()</code>
+
+ <p><code class="function">lwres_getaddrsbyname()</code>
and <code class="function">lwres_getnamebyaddr()</code> use the
<span class="type">lwres_gnbaresponse_t</span> structure defined below:
</p>
+
<pre class="programlisting">
typedef struct {
lwres_uint32_t flags;
size_t baselen;
} lwres_gabnresponse_t;
</pre>
-<p>
+
+ <p>
The contents of this structure are not manipulated directly but
they are controlled through the
- <span class="citerefentry"><span class="refentrytitle">lwres_gabn</span>(3)</span>
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_gabn</span>(3)
+ </span>
functions.
</p>
-<p>
+
+ <p>
The lightweight resolver uses
<code class="function">lwres_getaddrsbyname()</code> to perform
forward lookups.
<span class="type">LWRES_ADDRTYPE_V6</span> for IPv6 addresses. Results of the
lookup are returned in <em class="parameter"><code>*structp</code></em>.
</p>
-<p><code class="function">lwres_getnamebyaddr()</code>
+
+ <p><code class="function">lwres_getnamebyaddr()</code>
performs reverse lookups. Resolver context
<em class="parameter"><code>ctx</code></em> is used for memory allocation. The
address type is indicated by <em class="parameter"><code>addrtype</code></em>:
function call is made available through
<em class="parameter"><code>*structp</code></em>.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543617"></a><h2>RETURN VALUES</h2>
-<p>
+ </div>
+
+ <div class="refsection" title="RETURN VALUES">
+<a name="idp60937040"></a><h2>RETURN VALUES</h2>
+
+ <p>
Successful calls to
<code class="function">lwres_string_parse()</code>
and
if the buffer has less space than expected for the components of the
encoded string or address.
</p>
-<p><code class="function">lwres_getaddrsbyname()</code>
+
+ <p><code class="function">lwres_getaddrsbyname()</code>
returns <span class="errorcode">LWRES_R_SUCCESS</span> on success and it
returns <span class="errorcode">LWRES_R_NOTFOUND</span> if the hostname
<em class="parameter"><code>name</code></em> could not be found.
</p>
-<p><span class="errorcode">LWRES_R_SUCCESS</span>
+ <p><span class="errorcode">LWRES_R_SUCCESS</span>
is returned by a successful call to
<code class="function">lwres_getnamebyaddr()</code>.
</p>
-<p>
+
+ <p>
Both
<code class="function">lwres_getaddrsbyname()</code>
and
if the buffers used for sending queries and receiving replies are too
small.
</p>
-</div>
-<div class="refsect1" lang="en">
-<a name="id2543688"></a><h2>SEE ALSO</h2>
-<p><span class="citerefentry"><span class="refentrytitle">lwres_buffer</span>(3)</span>,
- <span class="citerefentry"><span class="refentrytitle">lwres_gabn</span>(3)</span>.
+ </div>
+ <div class="refsection" title="SEE ALSO">
+<a name="idp60945360"></a><h2>SEE ALSO</h2>
+
+ <p><span class="citerefentry">
+ <span class="refentrytitle">lwres_buffer</span>(3)
+ </span>,
+
+ <span class="citerefentry">
+ <span class="refentrytitle">lwres_gabn</span>(3)
+ </span>.
</p>
-</div>
+
+ </div>
</div></body>
</html>