bind - Upgraded vendor branch to 9.5.2-P1
[dragonfly.git] / contrib / bind-9.5.2 / bin / named / named.html
1 <!--
2  - Copyright (C) 2004-2008 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: named.html,v 1.26.130.2 2009/07/11 01:43:28 tbox Exp $ -->
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">-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">-x <em class="replaceable"><code>cache-file</code></em></code>]</p></div>
33 </div>
34 <div class="refsect1" lang="en">
35 <a name="id2543464"></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="id2543489"></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">-f</span></dt>
83 <dd><p>
84             Run the server in the foreground (i.e. do not daemonize).
85           </p></dd>
86 <dt><span class="term">-g</span></dt>
87 <dd><p>
88             Run the server in the foreground and force all logging
89             to <code class="filename">stderr</code>.
90           </p></dd>
91 <dt><span class="term">-m <em class="replaceable"><code>flag</code></em></span></dt>
92 <dd><p>
93             Turn on memory usage debugging flags.  Possible flags are
94             <em class="replaceable"><code>usage</code></em>,
95             <em class="replaceable"><code>trace</code></em>,
96             <em class="replaceable"><code>record</code></em>,
97             <em class="replaceable"><code>size</code></em>, and
98             <em class="replaceable"><code>mctx</code></em>.
99             These correspond to the ISC_MEM_DEBUGXXXX flags described in
100             <code class="filename">&lt;isc/mem.h&gt;</code>.
101           </p></dd>
102 <dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt>
103 <dd><p>
104             Create <em class="replaceable"><code>#cpus</code></em> worker threads
105             to take advantage of multiple CPUs.  If not specified,
106             <span><strong class="command">named</strong></span> will try to determine the
107             number of CPUs present and create one thread per CPU.
108             If it is unable to determine the number of CPUs, a
109             single worker thread will be created.
110           </p></dd>
111 <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
112 <dd><p>
113             Listen for queries on port <em class="replaceable"><code>port</code></em>.  If not
114             specified, the default is port 53.
115           </p></dd>
116 <dt><span class="term">-s</span></dt>
117 <dd>
118 <p>
119             Write memory usage statistics to <code class="filename">stdout</code> on exit.
120           </p>
121 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
122 <h3 class="title">Note</h3>
123 <p>
124               This option is mainly of interest to BIND 9 developers
125               and may be removed or changed in a future release.
126             </p>
127 </div>
128 </dd>
129 <dt><span class="term">-S <em class="replaceable"><code>#max-socks</code></em></span></dt>
130 <dd>
131 <p>
132             Allow <span><strong class="command">named</strong></span> to use up to
133             <em class="replaceable"><code>#max-socks</code></em> sockets.
134           </p>
135 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
136 <h3 class="title">Warning</h3>
137 <p>
138               This option should be unnecessary for the vast majority
139               of users.
140               The use of this option could even be harmful because the
141               specified value may exceed the limitation of the
142               underlying system API.
143               It is therefore set only when the default configuration
144               causes exhaustion of file descriptors and the
145               operational environment is known to support the
146               specified number of sockets.
147               Note also that the actual maximum number is normally a little
148               fewer than the specified value because
149               <span><strong class="command">named</strong></span> reserves some file descriptors
150               for its internal use.
151             </p>
152 </div>
153 </dd>
154 <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
155 <dd>
156 <p>Chroot
157             to <em class="replaceable"><code>directory</code></em> after
158             processing the command line arguments, but before
159             reading the configuration file.
160           </p>
161 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
162 <h3 class="title">Warning</h3>
163 <p>
164               This option should be used in conjunction with the
165               <code class="option">-u</code> option, as chrooting a process
166               running as root doesn't enhance security on most
167               systems; the way <code class="function">chroot(2)</code> is
168               defined allows a process with root privileges to
169               escape a chroot jail.
170             </p>
171 </div>
172 </dd>
173 <dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
174 <dd>
175 <p>Setuid
176             to <em class="replaceable"><code>user</code></em> after completing
177             privileged operations, such as creating sockets that
178             listen on privileged ports.
179           </p>
180 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
181 <h3 class="title">Note</h3>
182 <p>
183               On Linux, <span><strong class="command">named</strong></span> uses the kernel's
184                         capability mechanism to drop all root privileges
185               except the ability to <code class="function">bind(2)</code> to
186               a
187               privileged port and set process resource limits.
188               Unfortunately, this means that the <code class="option">-u</code>
189               option only works when <span><strong class="command">named</strong></span> is
190               run
191               on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
192               later, since previous kernels did not allow privileges
193               to be retained after <code class="function">setuid(2)</code>.
194             </p>
195 </div>
196 </dd>
197 <dt><span class="term">-v</span></dt>
198 <dd><p>
199             Report the version number and exit.
200           </p></dd>
201 <dt><span class="term">-x <em class="replaceable"><code>cache-file</code></em></span></dt>
202 <dd>
203 <p>
204             Load data from <em class="replaceable"><code>cache-file</code></em> into the
205             cache of the default view.
206           </p>
207 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
208 <h3 class="title">Warning</h3>
209 <p>
210               This option must not be used.  It is only of interest
211               to BIND 9 developers and may be removed or changed in a
212               future release.
213             </p>
214 </div>
215 </dd>
216 </dl></div>
217 </div>
218 <div class="refsect1" lang="en">
219 <a name="id2543911"></a><h2>SIGNALS</h2>
220 <p>
221       In routine operation, signals should not be used to control
222       the nameserver; <span><strong class="command">rndc</strong></span> should be used
223       instead.
224     </p>
225 <div class="variablelist"><dl>
226 <dt><span class="term">SIGHUP</span></dt>
227 <dd><p>
228             Force a reload of the server.
229           </p></dd>
230 <dt><span class="term">SIGINT, SIGTERM</span></dt>
231 <dd><p>
232             Shut down the server.
233           </p></dd>
234 </dl></div>
235 <p>
236       The result of sending any other signals to the server is undefined.
237     </p>
238 </div>
239 <div class="refsect1" lang="en">
240 <a name="id2543959"></a><h2>CONFIGURATION</h2>
241 <p>
242       The <span><strong class="command">named</strong></span> configuration file is too complex
243       to describe in detail here.  A complete description is provided
244       in the
245       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
246     </p>
247 </div>
248 <div class="refsect1" lang="en">
249 <a name="id2543976"></a><h2>FILES</h2>
250 <div class="variablelist"><dl>
251 <dt><span class="term"><code class="filename">/etc/named.conf</code></span></dt>
252 <dd><p>
253             The default configuration file.
254           </p></dd>
255 <dt><span class="term"><code class="filename">/var/run/named.pid</code></span></dt>
256 <dd><p>
257             The default process-id file.
258           </p></dd>
259 </dl></div>
260 </div>
261 <div class="refsect1" lang="en">
262 <a name="id2544016"></a><h2>SEE ALSO</h2>
263 <p><em class="citetitle">RFC 1033</em>,
264       <em class="citetitle">RFC 1034</em>,
265       <em class="citetitle">RFC 1035</em>,
266       <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
267       <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
268       <span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
269       <span class="citerefentry"><span class="refentrytitle">lwresd</span>(8)</span>,
270       <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
271       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
272     </p>
273 </div>
274 <div class="refsect1" lang="en">
275 <a name="id2544086"></a><h2>AUTHOR</h2>
276 <p><span class="corpauthor">Internet Systems Consortium</span>
277     </p>
278 </div>
279 </div></body>
280 </html>