1<!--
2 - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
3 - Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
4 - 
5 - Permission to use, copy, modify, and/or distribute this software for any
6 - purpose with or without fee is hereby granted, provided that the above
7 - copyright notice and this permission notice appear in all copies.
8 - 
9 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 - PERFORMANCE OF THIS SOFTWARE.
16-->
17<!-- $Id$ -->
18<html>
19<head>
20<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21<title>named</title>
22<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
23</head>
24<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
25<a name="man.named"></a><div class="titlepage"></div>
26<div class="refnamediv">
27<h2>Name</h2>
28<p><span class="application">named</span> &#8212; Internet domain name server</p>
29</div>
30<div class="refsynopsisdiv">
31<h2>Synopsis</h2>
32<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">-E <em class="replaceable"><code>engine-name</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>
33</div>
34<div class="refsect1" lang="en">
35<a name="id2543482"></a><h2>DESCRIPTION</h2>
36<p><span><strong class="command">named</strong></span>
37      is a Domain Name System (DNS) server,
38      part of the BIND 9 distribution from ISC.  For more
39      information on the DNS, see RFCs 1033, 1034, and 1035.
40    </p>
41<p>
42      When invoked without arguments, <span><strong class="command">named</strong></span>
43      will
44      read the default configuration file
45      <code class="filename">/etc/named.conf</code>, read any initial
46      data, and listen for queries.
47    </p>
48</div>
49<div class="refsect1" lang="en">
50<a name="id2543507"></a><h2>OPTIONS</h2>
51<div class="variablelist"><dl>
52<dt><span class="term">-4</span></dt>
53<dd><p>
54            Use IPv4 only even if the host machine is capable of IPv6.
55            <code class="option">-4</code> and <code class="option">-6</code> are mutually
56            exclusive.
57          </p></dd>
58<dt><span class="term">-6</span></dt>
59<dd><p>
60            Use IPv6 only even if the host machine is capable of IPv4.
61            <code class="option">-4</code> and <code class="option">-6</code> are mutually
62            exclusive.
63          </p></dd>
64<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
65<dd><p>
66            Use <em class="replaceable"><code>config-file</code></em> as the
67            configuration file instead of the default,
68            <code class="filename">/etc/named.conf</code>.  To
69            ensure that reloading the configuration file continues
70            to work after the server has changed its working
71            directory due to to a possible
72            <code class="option">directory</code> option in the configuration
73            file, <em class="replaceable"><code>config-file</code></em> should be
74            an absolute pathname.
75          </p></dd>
76<dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt>
77<dd><p>
78            Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>.
79            Debugging traces from <span><strong class="command">named</strong></span> become
80            more verbose as the debug level increases.
81          </p></dd>
82<dt><span class="term">-E <em class="replaceable"><code>engine-name</code></em></span></dt>
83<dd><p>
84            Use a crypto hardware (OpenSSL engine) for the crypto operations
85            it supports, for instance re-signing with private keys from
86            a secure key store. When compiled with PKCS#11 support
87            <em class="replaceable"><code>engine-name</code></em>
88            defaults to pkcs11, the empty name resets it to no engine.
89          </p></dd>
90<dt><span class="term">-f</span></dt>
91<dd><p>
92            Run the server in the foreground (i.e. do not daemonize).
93          </p></dd>
94<dt><span class="term">-g</span></dt>
95<dd><p>
96            Run the server in the foreground and force all logging
97            to <code class="filename">stderr</code>.
98          </p></dd>
99<dt><span class="term">-m <em class="replaceable"><code>flag</code></em></span></dt>
100<dd><p>
101	    Turn on memory usage debugging flags.  Possible flags are
102	    <em class="replaceable"><code>usage</code></em>,
103	    <em class="replaceable"><code>trace</code></em>,
104	    <em class="replaceable"><code>record</code></em>,
105	    <em class="replaceable"><code>size</code></em>, and
106	    <em class="replaceable"><code>mctx</code></em>.
107	    These correspond to the ISC_MEM_DEBUGXXXX flags described in
108	    <code class="filename">&lt;isc/mem.h&gt;</code>.
109          </p></dd>
110<dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt>
111<dd><p>
112            Create <em class="replaceable"><code>#cpus</code></em> worker threads
113            to take advantage of multiple CPUs.  If not specified,
114            <span><strong class="command">named</strong></span> will try to determine the
115            number of CPUs present and create one thread per CPU.
116            If it is unable to determine the number of CPUs, a
117            single worker thread will be created.
118          </p></dd>
119<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
120<dd><p>
121            Listen for queries on port <em class="replaceable"><code>port</code></em>.  If not
122            specified, the default is port 53.
123          </p></dd>
124<dt><span class="term">-s</span></dt>
125<dd>
126<p>
127            Write memory usage statistics to <code class="filename">stdout</code> on exit.
128          </p>
129<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
130<h3 class="title">Note</h3>
131<p>
132              This option is mainly of interest to BIND 9 developers
133              and may be removed or changed in a future release.
134            </p>
135</div>
136</dd>
137<dt><span class="term">-S <em class="replaceable"><code>#max-socks</code></em></span></dt>
138<dd>
139<p>
140	    Allow <span><strong class="command">named</strong></span> to use up to
141	    <em class="replaceable"><code>#max-socks</code></em> sockets.
142	  </p>
143<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
144<h3 class="title">Warning</h3>
145<p>
146              This option should be unnecessary for the vast majority
147              of users.
148	      The use of this option could even be harmful because the
149              specified value may exceed the limitation of the
150              underlying system API.
151	      It is therefore set only when the default configuration
152              causes exhaustion of file descriptors and the
153              operational environment is known to support the
154              specified number of sockets.
155	      Note also that the actual maximum number is normally a little
156              fewer than the specified value because
157	      <span><strong class="command">named</strong></span> reserves some file descriptors
158	      for its internal use.
159            </p>
160</div>
161</dd>
162<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
163<dd>
164<p>Chroot
165	    to <em class="replaceable"><code>directory</code></em> after
166            processing the command line arguments, but before
167            reading the configuration file.
168          </p>
169<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
170<h3 class="title">Warning</h3>
171<p>
172              This option should be used in conjunction with the
173              <code class="option">-u</code> option, as chrooting a process
174              running as root doesn't enhance security on most
175              systems; the way <code class="function">chroot(2)</code> is
176              defined allows a process with root privileges to
177              escape a chroot jail.
178            </p>
179</div>
180</dd>
181<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
182<dd>
183<p>Setuid
184	    to <em class="replaceable"><code>user</code></em> after completing
185            privileged operations, such as creating sockets that
186            listen on privileged ports.
187          </p>
188<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
189<h3 class="title">Note</h3>
190<p>
191              On Linux, <span><strong class="command">named</strong></span> uses the kernel's
192              		capability mechanism to drop all root privileges
193              except the ability to <code class="function">bind(2)</code> to
194              a
195              privileged port and set process resource limits.
196              Unfortunately, this means that the <code class="option">-u</code>
197              option only works when <span><strong class="command">named</strong></span> is
198              run
199              on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
200              later, since previous kernels did not allow privileges
201              to be retained after <code class="function">setuid(2)</code>.
202            </p>
203</div>
204</dd>
205<dt><span class="term">-v</span></dt>
206<dd><p>
207            Report the version number and exit.
208          </p></dd>
209<dt><span class="term">-V</span></dt>
210<dd><p>
211            Report the version number and build options, and exit.
212          </p></dd>
213<dt><span class="term">-x <em class="replaceable"><code>cache-file</code></em></span></dt>
214<dd>
215<p>
216            Load data from <em class="replaceable"><code>cache-file</code></em> into the
217            cache of the default view.
218          </p>
219<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
220<h3 class="title">Warning</h3>
221<p>
222              This option must not be used.  It is only of interest
223              to BIND 9 developers and may be removed or changed in a
224              future release.
225            </p>
226</div>
227</dd>
228</dl></div>
229</div>
230<div class="refsect1" lang="en">
231<a name="id2543964"></a><h2>SIGNALS</h2>
232<p>
233      In routine operation, signals should not be used to control
234      the nameserver; <span><strong class="command">rndc</strong></span> should be used
235      instead.
236    </p>
237<div class="variablelist"><dl>
238<dt><span class="term">SIGHUP</span></dt>
239<dd><p>
240            Force a reload of the server.
241          </p></dd>
242<dt><span class="term">SIGINT, SIGTERM</span></dt>
243<dd><p>
244            Shut down the server.
245          </p></dd>
246</dl></div>
247<p>
248      The result of sending any other signals to the server is undefined.
249    </p>
250</div>
251<div class="refsect1" lang="en">
252<a name="id2544012"></a><h2>CONFIGURATION</h2>
253<p>
254      The <span><strong class="command">named</strong></span> configuration file is too complex
255      to describe in detail here.  A complete description is provided
256      in the
257      <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
258    </p>
259<p>
260      <span><strong class="command">named</strong></span> inherits the <code class="function">umask</code>
261      (file creation mode mask) from the parent process. If files
262      created by <span><strong class="command">named</strong></span>, such as journal files,
263      need to have custom permissions, the <code class="function">umask</code>
264      should be set explicitly in the script used to start the
265      <span><strong class="command">named</strong></span> process.
266    </p>
267</div>
268<div class="refsect1" lang="en">
269<a name="id2544049"></a><h2>FILES</h2>
270<div class="variablelist"><dl>
271<dt><span class="term"><code class="filename">/etc/named.conf</code></span></dt>
272<dd><p>
273            The default configuration file.
274          </p></dd>
275<dt><span class="term"><code class="filename">/var/run/named/named.pid</code></span></dt>
276<dd><p>
277            The default process-id file.
278          </p></dd>
279</dl></div>
280</div>
281<div class="refsect1" lang="en">
282<a name="id2544088"></a><h2>SEE ALSO</h2>
283<p><em class="citetitle">RFC 1033</em>,
284      <em class="citetitle">RFC 1034</em>,
285      <em class="citetitle">RFC 1035</em>,
286      <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
287      <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
288      <span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
289      <span class="citerefentry"><span class="refentrytitle">lwresd</span>(8)</span>,
290      <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
291      <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
292    </p>
293</div>
294<div class="refsect1" lang="en">
295<a name="id2544295"></a><h2>AUTHOR</h2>
296<p><span class="corpauthor">Internet Systems Consortium</span>
297    </p>
298</div>
299</div></body>
300</html>
301