named.html revision 4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721
2N/A<!--
2N/A - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
2N/A - Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
2N/A -
2N/A - Permission to use, copy, modify, and/or distribute this software for any
2N/A - purpose with or without fee is hereby granted, provided that the above
2N/A - copyright notice and this permission notice appear in all copies.
2N/A -
2N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2N/A - PERFORMANCE OF THIS SOFTWARE.
2N/A-->
2N/A<!-- $Id: named.html,v 1.32 2009/07/11 01:12:45 tbox Exp $ -->
2N/A<html>
2N/A<head>
2N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
2N/A<title>named</title>
2N/A<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
2N/A</head>
2N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
2N/A<a name="man.named"></a><div class="titlepage"></div>
2N/A<div class="refnamediv">
2N/A<h2>Name</h2>
2N/A<p><span class="application">named</span> &#8212; Internet domain name server</p>
2N/A</div>
2N/A<div class="refsynopsisdiv">
2N/A<h2>Synopsis</h2>
2N/A<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">-f</code>] [<code class="option">-g</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>user</code></em></code>] [<code class="option">-v</code>] [<code class="option">-V</code>] [<code class="option">-x <em class="replaceable"><code>cache-file</code></em></code>]</p></div>
2N/A</div>
2N/A<div class="refsect1" lang="en">
2N/A<a name="id2543472"></a><h2>DESCRIPTION</h2>
2N/A<p><span><strong class="command">named</strong></span>
2N/A is a Domain Name System (DNS) server,
2N/A part of the BIND 9 distribution from ISC. For more
2N/A information on the DNS, see RFCs 1033, 1034, and 1035.
2N/A </p>
2N/A<p>
2N/A When invoked without arguments, <span><strong class="command">named</strong></span>
2N/A will
2N/A read the default configuration file
2N/A <code class="filename">/etc/named.conf</code>, read any initial
2N/A data, and listen for queries.
2N/A </p>
2N/A</div>
2N/A<div class="refsect1" lang="en">
2N/A<a name="id2543496"></a><h2>OPTIONS</h2>
2N/A<div class="variablelist"><dl>
2N/A<dt><span class="term">-4</span></dt>
2N/A<dd><p>
2N/A Use IPv4 only even if the host machine is capable of IPv6.
2N/A <code class="option">-4</code> and <code class="option">-6</code> are mutually
2N/A exclusive.
2N/A </p></dd>
2N/A<dt><span class="term">-6</span></dt>
2N/A<dd><p>
2N/A Use IPv6 only even if the host machine is capable of IPv4.
2N/A <code class="option">-4</code> and <code class="option">-6</code> are mutually
2N/A exclusive.
2N/A </p></dd>
2N/A<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
2N/A<dd><p>
2N/A Use <em class="replaceable"><code>config-file</code></em> as the
2N/A configuration file instead of the default,
2N/A <code class="filename">/etc/named.conf</code>. To
2N/A ensure that reloading the configuration file continues
2N/A to work after the server has changed its working
2N/A directory due to to a possible
2N/A <code class="option">directory</code> option in the configuration
2N/A file, <em class="replaceable"><code>config-file</code></em> should be
2N/A an absolute pathname.
2N/A </p></dd>
2N/A<dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt>
2N/A<dd><p>
2N/A Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>.
2N/A Debugging traces from <span><strong class="command">named</strong></span> become
2N/A more verbose as the debug level increases.
2N/A </p></dd>
2N/A<dt><span class="term">-f</span></dt>
2N/A<dd><p>
2N/A Run the server in the foreground (i.e. do not daemonize).
2N/A </p></dd>
2N/A<dt><span class="term">-g</span></dt>
2N/A<dd><p>
2N/A Run the server in the foreground and force all logging
2N/A to <code class="filename">stderr</code>.
2N/A </p></dd>
2N/A<dt><span class="term">-m <em class="replaceable"><code>flag</code></em></span></dt>
2N/A<dd><p>
2N/A Turn on memory usage debugging flags. Possible flags are
2N/A <em class="replaceable"><code>usage</code></em>,
2N/A <em class="replaceable"><code>trace</code></em>,
2N/A <em class="replaceable"><code>record</code></em>,
2N/A <em class="replaceable"><code>size</code></em>, and
2N/A <em class="replaceable"><code>mctx</code></em>.
2N/A These correspond to the ISC_MEM_DEBUGXXXX flags described in
2N/A <code class="filename">&lt;isc/mem.h&gt;</code>.
2N/A </p></dd>
2N/A<dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt>
2N/A<dd><p>
2N/A Create <em class="replaceable"><code>#cpus</code></em> worker threads
2N/A to take advantage of multiple CPUs. If not specified,
2N/A <span><strong class="command">named</strong></span> will try to determine the
2N/A number of CPUs present and create one thread per CPU.
2N/A If it is unable to determine the number of CPUs, a
2N/A single worker thread will be created.
2N/A </p></dd>
2N/A<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
2N/A<dd><p>
2N/A Listen for queries on port <em class="replaceable"><code>port</code></em>. If not
2N/A specified, the default is port 53.
2N/A </p></dd>
2N/A<dt><span class="term">-s</span></dt>
2N/A<dd>
2N/A<p>
2N/A Write memory usage statistics to <code class="filename">stdout</code> on exit.
2N/A </p>
2N/A<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2N/A<h3 class="title">Note</h3>
2N/A<p>
2N/A This option is mainly of interest to BIND 9 developers
2N/A and may be removed or changed in a future release.
2N/A </p>
2N/A</div>
2N/A</dd>
2N/A<dt><span class="term">-S <em class="replaceable"><code>#max-socks</code></em></span></dt>
2N/A<dd>
2N/A<p>
2N/A Allow <span><strong class="command">named</strong></span> to use up to
2N/A <em class="replaceable"><code>#max-socks</code></em> sockets.
2N/A </p>
2N/A<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2N/A<h3 class="title">Warning</h3>
2N/A<p>
2N/A This option should be unnecessary for the vast majority
2N/A of users.
2N/A The use of this option could even be harmful because the
2N/A specified value may exceed the limitation of the
2N/A underlying system API.
2N/A It is therefore set only when the default configuration
2N/A causes exhaustion of file descriptors and the
2N/A operational environment is known to support the
2N/A specified number of sockets.
2N/A Note also that the actual maximum number is normally a little
2N/A fewer than the specified value because
2N/A <span><strong class="command">named</strong></span> reserves some file descriptors
2N/A for its internal use.
2N/A </p>
2N/A</div>
2N/A</dd>
2N/A<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
2N/A<dd>
2N/A<p>Chroot
2N/A to <em class="replaceable"><code>directory</code></em> after
2N/A processing the command line arguments, but before
2N/A reading the configuration file.
2N/A </p>
2N/A<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2N/A<h3 class="title">Warning</h3>
2N/A<p>
2N/A This option should be used in conjunction with the
2N/A <code class="option">-u</code> option, as chrooting a process
2N/A running as root doesn't enhance security on most
2N/A systems; the way <code class="function">chroot(2)</code> is
2N/A defined allows a process with root privileges to
2N/A escape a chroot jail.
2N/A </p>
2N/A</div>
2N/A</dd>
2N/A<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
2N/A<dd>
2N/A<p>Setuid
2N/A to <em class="replaceable"><code>user</code></em> after completing
2N/A privileged operations, such as creating sockets that
2N/A listen on privileged ports.
2N/A </p>
2N/A<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2N/A<h3 class="title">Note</h3>
2N/A<p>
2N/A On Linux, <span><strong class="command">named</strong></span> uses the kernel's
2N/A capability mechanism to drop all root privileges
2N/A except the ability to <code class="function">bind(2)</code> to
2N/A a
2N/A privileged port and set process resource limits.
2N/A Unfortunately, this means that the <code class="option">-u</code>
2N/A option only works when <span><strong class="command">named</strong></span> is
2N/A run
2N/A on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
2N/A later, since previous kernels did not allow privileges
2N/A to be retained after <code class="function">setuid(2)</code>.
2N/A </p>
2N/A</div>
2N/A</dd>
2N/A<dt><span class="term">-v</span></dt>
2N/A<dd><p>
2N/A Report the version number and exit.
2N/A </p></dd>
2N/A<dt><span class="term">-V</span></dt>
2N/A<dd><p>
2N/A Report the version number and build options, and exit.
2N/A </p></dd>
2N/A<dt><span class="term">-x <em class="replaceable"><code>cache-file</code></em></span></dt>
2N/A<dd>
2N/A<p>
2N/A Load data from <em class="replaceable"><code>cache-file</code></em> into the
2N/A cache of the default view.
2N/A </p>
2N/A<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2N/A<h3 class="title">Warning</h3>
2N/A<p>
2N/A This option must not be used. It is only of interest
2N/A to BIND 9 developers and may be removed or changed in a
2N/A future release.
2N/A </p>
2N/A</div>
2N/A</dd>
2N/A</dl></div>
2N/A</div>
2N/A<div class="refsect1" lang="en">
2N/A<a name="id2543931"></a><h2>SIGNALS</h2>
2N/A<p>
2N/A In routine operation, signals should not be used to control
2N/A the nameserver; <span><strong class="command">rndc</strong></span> should be used
2N/A instead.
2N/A </p>
2N/A<div class="variablelist"><dl>
2N/A<dt><span class="term">SIGHUP</span></dt>
2N/A<dd><p>
2N/A Force a reload of the server.
2N/A </p></dd>
2N/A<dt><span class="term">SIGINT, SIGTERM</span></dt>
2N/A<dd><p>
2N/A Shut down the server.
2N/A </p></dd>
2N/A</dl></div>
2N/A<p>
2N/A The result of sending any other signals to the server is undefined.
2N/A </p>
2N/A</div>
2N/A<div class="refsect1" lang="en">
2N/A<a name="id2543979"></a><h2>CONFIGURATION</h2>
2N/A<p>
2N/A The <span><strong class="command">named</strong></span> configuration file is too complex
2N/A to describe in detail here. A complete description is provided
2N/A in the
2N/A <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
2N/A </p>
2N/A<p>
2N/A <span><strong class="command">named</strong></span> inherits the <code class="function">umask</code>
2N/A (file creation mode mask) from the parent process. If files
2N/A created by <span><strong class="command">named</strong></span>, such as journal files,
2N/A need to have custom permissions, the <code class="function">umask</code>
2N/A should be set explicitly in the script used to start the
2N/A <span><strong class="command">named</strong></span> process.
2N/A </p>
2N/A</div>
2N/A<div class="refsect1" lang="en">
2N/A<a name="id2544016"></a><h2>FILES</h2>
2N/A<div class="variablelist"><dl>
2N/A<dt><span class="term"><code class="filename">/etc/named.conf</code></span></dt>
2N/A<dd><p>
2N/A The default configuration file.
2N/A </p></dd>
2N/A<dt><span class="term"><code class="filename">/var/run/named/named.pid</code></span></dt>
2N/A<dd><p>
2N/A The default process-id file.
2N/A </p></dd>
2N/A</dl></div>
2N/A</div>
2N/A<div class="refsect1" lang="en">
2N/A<a name="id2544123"></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>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2544194"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div></body>
</html>