man.named.html revision de283bda6a902c2102a795192eeab3a769001c7d
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - Copyright (C) 2000-2003 Internet Software Consortium.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - Permission to use, copy, modify, and/or distribute this software for any
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - purpose with or without fee is hereby granted, provided that the above
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - copyright notice and this permission notice appear in all copies.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - PERFORMANCE OF THIS SOFTWARE.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<link rel="prev" href="man.named-checkzone.html" title="named-checkzone">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<link rel="next" href="man.named-journalprint.html" title="named-journalprint">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<table width="100%" summary="Navigation header">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<tr><th colspan="3" align="center"><span class="application">named</span></th></tr>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<a accesskey="p" href="man.named-checkzone.html">Prev</a>�</td>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<th width="60%" align="center">Manual pages</th>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<td width="20%" align="right">�<a accesskey="n" href="man.named-journalprint.html">Next</a>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<a name="man.named"></a><div class="titlepage"></div>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<p><span class="application">named</span> — Internet domain name server</p>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<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>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>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<a name="id2653505"></a><h2>DESCRIPTION</h2>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<p><span><strong class="command">named</strong></span>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland is a Domain Name System (DNS) server,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland part of the BIND 9 distribution from ISC. For more
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland information on the DNS, see RFCs 1033, 1034, and 1035.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland When invoked without arguments, <span><strong class="command">named</strong></span>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland read the default configuration file
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="filename">/etc/named.conf</code>, read any initial
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland data, and listen for queries.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Use IPv4 only even if the host machine is capable of IPv6.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="option">-4</code> and <code class="option">-6</code> are mutually
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Use IPv6 only even if the host machine is capable of IPv4.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="option">-4</code> and <code class="option">-6</code> are mutually
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Use <em class="replaceable"><code>config-file</code></em> as the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland configuration file instead of the default,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="filename">/etc/named.conf</code>. To
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland ensure that reloading the configuration file continues
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland to work after the server has changed its working
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland directory due to to a possible
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="option">directory</code> option in the configuration
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland file, <em class="replaceable"><code>config-file</code></em> should be
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland an absolute pathname.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Debugging traces from <span><strong class="command">named</strong></span> become
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland more verbose as the debug level increases.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-D <em class="replaceable"><code>string</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Specifies a string that is used to identify a instance of
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <span><strong class="command">named</strong></span> in a process listing. The contents
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland of <em class="replaceable"><code>string</code></em> are
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland not examined.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-E <em class="replaceable"><code>engine-name</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland When applicable, specifies the hardware to use for
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland cryptographic operations, such as a secure key store used
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland When BIND is built with OpenSSL PKCS#11 support, this defaults
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland to the string "pkcs11", which identifies an OpenSSL engine
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland that can drive a cryptographic accelerator or hardware service
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland module. When BIND is built with native PKCS#11 cryptography
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland (--enable-native-pkcs11), it defaults to the path of the PKCS#11
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland provider library specified via "--with-pkcs11".
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Run the server in the foreground (i.e. do not daemonize).
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Run the server in the foreground and force all logging
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-L <em class="replaceable"><code>logfile</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Log to the file <code class="option">logfile</code> by default
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland instead of the system log.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-m <em class="replaceable"><code>flag</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Turn on memory usage debugging flags. Possible flags are
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <em class="replaceable"><code>usage</code></em>,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <em class="replaceable"><code>trace</code></em>,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <em class="replaceable"><code>record</code></em>,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <em class="replaceable"><code>size</code></em>, and
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <em class="replaceable"><code>mctx</code></em>.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland These correspond to the ISC_MEM_DEBUGXXXX flags described in
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="filename"><isc/mem.h></code>.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Create <em class="replaceable"><code>#cpus</code></em> worker threads
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland to take advantage of multiple CPUs. If not specified,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <span><strong class="command">named</strong></span> will try to determine the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland number of CPUs present and create one thread per CPU.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland If it is unable to determine the number of CPUs, a
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland single worker thread will be created.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Listen for queries on port <em class="replaceable"><code>port</code></em>. If not
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland specified, the default is port 53.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Write memory usage statistics to <code class="filename">stdout</code> on exit.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland This option is mainly of interest to BIND 9 developers
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland and may be removed or changed in a future release.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-S <em class="replaceable"><code>#max-socks</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Allow <span><strong class="command">named</strong></span> to use up to
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <em class="replaceable"><code>#max-socks</code></em> sockets.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland The default value is 4096 on systems built with default
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland configuration options, and 21000 on systems built with
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland "configure --with-tuning=large".
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland This option should be unnecessary for the vast majority
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland The use of this option could even be harmful because the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland specified value may exceed the limitation of the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland underlying system API.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland It is therefore set only when the default configuration
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland causes exhaustion of file descriptors and the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland operational environment is known to support the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland specified number of sockets.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Note also that the actual maximum number is normally a little
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland fewer than the specified value because
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <span><strong class="command">named</strong></span> reserves some file descriptors
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland for its internal use.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>