Update documentation (ARM, READMEs and man pages)
This commit is contained in:
Ondřej Surý
Ondřej Surý
@@ -10,7 +10,7 @@
|
||||
<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.79.1">
|
||||
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
|
||||
<link rel="up" href="Bv9ARM.ch12.html" title="Manual pages">
|
||||
<link rel="prev" href="man.named.conf.html" title="named.conf">
|
||||
@@ -32,93 +32,46 @@
|
||||
</div>
|
||||
<div class="refentry">
|
||||
<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">
|
||||
<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="refsection">
|
||||
<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">
|
||||
<a name="id-1.13.27.7"></a><h2>DESCRIPTION</h2>
|
||||
|
||||
<p><span class="command"><strong>named</strong></span>
|
||||
<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>
|
||||
<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="refsection">
|
||||
</div>
|
||||
<div class="refsection">
|
||||
<a name="id-1.13.27.8"></a><h2>OPTIONS</h2>
|
||||
|
||||
|
||||
<div class="variablelist"><dl class="variablelist">
|
||||
<div class="variablelist"><dl class="variablelist">
|
||||
<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
|
||||
@@ -128,33 +81,28 @@
|
||||
<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 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>
|
||||
<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>
|
||||
</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
|
||||
@@ -162,30 +110,23 @@
|
||||
(--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>
|
||||
<dd><p>
|
||||
Sets the default memory context options. If set to
|
||||
<em class="replaceable"><code>external</code></em>,
|
||||
this causes the internal memory manager to be bypassed
|
||||
@@ -197,11 +138,9 @@
|
||||
disables this behavior, and is the default unless
|
||||
<span class="command"><strong>named</strong></span> has been compiled with developer
|
||||
options.)
|
||||
</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>,
|
||||
@@ -210,51 +149,46 @@
|
||||
<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 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" 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>
|
||||
<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;">
|
||||
<div class="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
|
||||
@@ -269,18 +203,18 @@
|
||||
<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
|
||||
<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" 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
|
||||
@@ -288,11 +222,10 @@
|
||||
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 class="command"><strong>named</strong></span> will
|
||||
@@ -305,18 +238,17 @@
|
||||
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.
|
||||
</p>
|
||||
</dd>
|
||||
</p></dd>
|
||||
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
|
||||
<dd>
|
||||
<p>Setuid
|
||||
<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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||||
<h3 class="title">Note</h3>
|
||||
<p>
|
||||
<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
|
||||
@@ -329,23 +261,18 @@
|
||||
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 class="command"><strong>named</strong></span> instances
|
||||
from running simultaneously.
|
||||
@@ -353,68 +280,54 @@
|
||||
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" 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="refsection">
|
||||
</div>
|
||||
<div class="refsection">
|
||||
<a name="id-1.13.27.9"></a><h2>SIGNALS</h2>
|
||||
|
||||
<p>
|
||||
<p>
|
||||
In routine operation, signals should not be used to control
|
||||
the nameserver; <span class="command"><strong>rndc</strong></span> should be used
|
||||
instead.
|
||||
</p>
|
||||
|
||||
<div class="variablelist"><dl class="variablelist">
|
||||
<div class="variablelist"><dl class="variablelist">
|
||||
<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="refsection">
|
||||
</div>
|
||||
<div class="refsection">
|
||||
<a name="id-1.13.27.10"></a><h2>CONFIGURATION</h2>
|
||||
|
||||
<p>
|
||||
<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>
|
||||
<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 class="command"><strong>named</strong></span>, such as journal files,
|
||||
@@ -422,56 +335,32 @@
|
||||
should be set explicitly in the script used to start the
|
||||
<span class="command"><strong>named</strong></span> process.
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="refsection">
|
||||
</div>
|
||||
<div class="refsection">
|
||||
<a name="id-1.13.27.11"></a><h2>FILES</h2>
|
||||
|
||||
|
||||
<div class="variablelist"><dl class="variablelist">
|
||||
<div class="variablelist"><dl class="variablelist">
|
||||
<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="refsection">
|
||||
</div>
|
||||
<div class="refsection">
|
||||
<a name="id-1.13.27.12"></a><h2>SEE ALSO</h2>
|
||||
|
||||
<p><em class="citetitle">RFC 1033</em>,
|
||||
<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">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">named.conf</span>(5)</span>,
|
||||
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="navfooter">
|
||||
<hr>
|
||||
@@ -492,6 +381,6 @@
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.13.2 (Development Release)</p>
|
||||
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.13.3-dev (Development Release)</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user