man.named.html revision 254402
1<!-- 2 - Copyright (C) 2004-2013 Internet Systems Consortium, Inc. ("ISC") 3 - Copyright (C) 2000-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<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual"> 24<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages"> 25<link rel="prev" href="man.named-checkzone.html" title="named-checkzone"> 26<link rel="next" href="man.named-journalprint.html" title="named-journalprint"> 27</head> 28<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 29<div class="navheader"> 30<table width="100%" summary="Navigation header"> 31<tr><th colspan="3" align="center"><span class="application">named</span></th></tr> 32<tr> 33<td width="20%" align="left"> 34<a accesskey="p" href="man.named-checkzone.html">Prev</a>�</td> 35<th width="60%" align="center">Manual pages</th> 36<td width="20%" align="right">�<a accesskey="n" href="man.named-journalprint.html">Next</a> 37</td> 38</tr> 39</table> 40<hr> 41</div> 42<div class="refentry" lang="en"> 43<a name="man.named"></a><div class="titlepage"></div> 44<div class="refnamediv"> 45<h2>Name</h2> 46<p><span class="application">named</span> — Internet domain name server</p> 47</div> 48<div class="refsynopsisdiv"> 49<h2>Synopsis</h2> 50<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> 51</div> 52<div class="refsect1" lang="en"> 53<a name="id2633550"></a><h2>DESCRIPTION</h2> 54<p><span><strong class="command">named</strong></span> 55 is a Domain Name System (DNS) server, 56 part of the BIND 9 distribution from ISC. For more 57 information on the DNS, see RFCs 1033, 1034, and 1035. 58 </p> 59<p> 60 When invoked without arguments, <span><strong class="command">named</strong></span> 61 will 62 read the default configuration file 63 <code class="filename">/etc/named.conf</code>, read any initial 64 data, and listen for queries. 65 </p> 66</div> 67<div class="refsect1" lang="en"> 68<a name="id2633581"></a><h2>OPTIONS</h2> 69<div class="variablelist"><dl> 70<dt><span class="term">-4</span></dt> 71<dd><p> 72 Use IPv4 only even if the host machine is capable of IPv6. 73 <code class="option">-4</code> and <code class="option">-6</code> are mutually 74 exclusive. 75 </p></dd> 76<dt><span class="term">-6</span></dt> 77<dd><p> 78 Use IPv6 only even if the host machine is capable of IPv4. 79 <code class="option">-4</code> and <code class="option">-6</code> are mutually 80 exclusive. 81 </p></dd> 82<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt> 83<dd><p> 84 Use <em class="replaceable"><code>config-file</code></em> as the 85 configuration file instead of the default, 86 <code class="filename">/etc/named.conf</code>. To 87 ensure that reloading the configuration file continues 88 to work after the server has changed its working 89 directory due to to a possible 90 <code class="option">directory</code> option in the configuration 91 file, <em class="replaceable"><code>config-file</code></em> should be 92 an absolute pathname. 93 </p></dd> 94<dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt> 95<dd><p> 96 Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>. 97 Debugging traces from <span><strong class="command">named</strong></span> become 98 more verbose as the debug level increases. 99 </p></dd> 100<dt><span class="term">-E <em class="replaceable"><code>engine-name</code></em></span></dt> 101<dd><p> 102 Use a crypto hardware (OpenSSL engine) for the crypto operations 103 it supports, for instance re-signing with private keys from 104 a secure key store. When compiled with PKCS#11 support 105 <em class="replaceable"><code>engine-name</code></em> 106 defaults to pkcs11, the empty name resets it to no engine. 107 </p></dd> 108<dt><span class="term">-f</span></dt> 109<dd><p> 110 Run the server in the foreground (i.e. do not daemonize). 111 </p></dd> 112<dt><span class="term">-g</span></dt> 113<dd><p> 114 Run the server in the foreground and force all logging 115 to <code class="filename">stderr</code>. 116 </p></dd> 117<dt><span class="term">-m <em class="replaceable"><code>flag</code></em></span></dt> 118<dd><p> 119 Turn on memory usage debugging flags. Possible flags are 120 <em class="replaceable"><code>usage</code></em>, 121 <em class="replaceable"><code>trace</code></em>, 122 <em class="replaceable"><code>record</code></em>, 123 <em class="replaceable"><code>size</code></em>, and 124 <em class="replaceable"><code>mctx</code></em>. 125 These correspond to the ISC_MEM_DEBUGXXXX flags described in 126 <code class="filename"><isc/mem.h></code>. 127 </p></dd> 128<dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt> 129<dd><p> 130 Create <em class="replaceable"><code>#cpus</code></em> worker threads 131 to take advantage of multiple CPUs. If not specified, 132 <span><strong class="command">named</strong></span> will try to determine the 133 number of CPUs present and create one thread per CPU. 134 If it is unable to determine the number of CPUs, a 135 single worker thread will be created. 136 </p></dd> 137<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt> 138<dd><p> 139 Listen for queries on port <em class="replaceable"><code>port</code></em>. If not 140 specified, the default is port 53. 141 </p></dd> 142<dt><span class="term">-s</span></dt> 143<dd> 144<p> 145 Write memory usage statistics to <code class="filename">stdout</code> on exit. 146 </p> 147<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> 148<h3 class="title">Note</h3> 149<p> 150 This option is mainly of interest to BIND 9 developers 151 and may be removed or changed in a future release. 152 </p> 153</div> 154</dd> 155<dt><span class="term">-S <em class="replaceable"><code>#max-socks</code></em></span></dt> 156<dd> 157<p> 158 Allow <span><strong class="command">named</strong></span> to use up to 159 <em class="replaceable"><code>#max-socks</code></em> sockets. 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 unnecessary for the vast majority 165 of users. 166 The use of this option could even be harmful because the 167 specified value may exceed the limitation of the 168 underlying system API. 169 It is therefore set only when the default configuration 170 causes exhaustion of file descriptors and the 171 operational environment is known to support the 172 specified number of sockets. 173 Note also that the actual maximum number is normally a little 174 fewer than the specified value because 175 <span><strong class="command">named</strong></span> reserves some file descriptors 176 for its internal use. 177 </p> 178</div> 179</dd> 180<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt> 181<dd> 182<p>Chroot 183 to <em class="replaceable"><code>directory</code></em> after 184 processing the command line arguments, but before 185 reading the configuration file. 186 </p> 187<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> 188<h3 class="title">Warning</h3> 189<p> 190 This option should be used in conjunction with the 191 <code class="option">-u</code> option, as chrooting a process 192 running as root doesn't enhance security on most 193 systems; the way <code class="function">chroot(2)</code> is 194 defined allows a process with root privileges to 195 escape a chroot jail. 196 </p> 197</div> 198</dd> 199<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt> 200<dd> 201<p>Setuid 202 to <em class="replaceable"><code>user</code></em> after completing 203 privileged operations, such as creating sockets that 204 listen on privileged ports. 205 </p> 206<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> 207<h3 class="title">Note</h3> 208<p> 209 On Linux, <span><strong class="command">named</strong></span> uses the kernel's 210 capability mechanism to drop all root privileges 211 except the ability to <code class="function">bind(2)</code> to 212 a 213 privileged port and set process resource limits. 214 Unfortunately, this means that the <code class="option">-u</code> 215 option only works when <span><strong class="command">named</strong></span> is 216 run 217 on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or 218 later, since previous kernels did not allow privileges 219 to be retained after <code class="function">setuid(2)</code>. 220 </p> 221</div> 222</dd> 223<dt><span class="term">-v</span></dt> 224<dd><p> 225 Report the version number and exit. 226 </p></dd> 227<dt><span class="term">-V</span></dt> 228<dd><p> 229 Report the version number and build options, and exit. 230 </p></dd> 231<dt><span class="term">-x <em class="replaceable"><code>cache-file</code></em></span></dt> 232<dd> 233<p> 234 Load data from <em class="replaceable"><code>cache-file</code></em> into the 235 cache of the default view. 236 </p> 237<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> 238<h3 class="title">Warning</h3> 239<p> 240 This option must not be used. It is only of interest 241 to BIND 9 developers and may be removed or changed in a 242 future release. 243 </p> 244</div> 245</dd> 246</dl></div> 247</div> 248<div class="refsect1" lang="en"> 249<a name="id2641303"></a><h2>SIGNALS</h2> 250<p> 251 In routine operation, signals should not be used to control 252 the nameserver; <span><strong class="command">rndc</strong></span> should be used 253 instead. 254 </p> 255<div class="variablelist"><dl> 256<dt><span class="term">SIGHUP</span></dt> 257<dd><p> 258 Force a reload of the server. 259 </p></dd> 260<dt><span class="term">SIGINT, SIGTERM</span></dt> 261<dd><p> 262 Shut down the server. 263 </p></dd> 264</dl></div> 265<p> 266 The result of sending any other signals to the server is undefined. 267 </p> 268</div> 269<div class="refsect1" lang="en"> 270<a name="id2641353"></a><h2>CONFIGURATION</h2> 271<p> 272 The <span><strong class="command">named</strong></span> configuration file is too complex 273 to describe in detail here. A complete description is provided 274 in the 275 <em class="citetitle">BIND 9 Administrator Reference Manual</em>. 276 </p> 277<p> 278 <span><strong class="command">named</strong></span> inherits the <code class="function">umask</code> 279 (file creation mode mask) from the parent process. If files 280 created by <span><strong class="command">named</strong></span>, such as journal files, 281 need to have custom permissions, the <code class="function">umask</code> 282 should be set explicitly in the script used to start the 283 <span><strong class="command">named</strong></span> process. 284 </p> 285</div> 286<div class="refsect1" lang="en"> 287<a name="id2675740"></a><h2>FILES</h2> 288<div class="variablelist"><dl> 289<dt><span class="term"><code class="filename">/etc/named.conf</code></span></dt> 290<dd><p> 291 The default configuration file. 292 </p></dd> 293<dt><span class="term"><code class="filename">/var/run/named/named.pid</code></span></dt> 294<dd><p> 295 The default process-id file. 296 </p></dd> 297</dl></div> 298</div> 299<div class="refsect1" lang="en"> 300<a name="id2675784"></a><h2>SEE ALSO</h2> 301<p><em class="citetitle">RFC 1033</em>, 302 <em class="citetitle">RFC 1034</em>, 303 <em class="citetitle">RFC 1035</em>, 304 <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>, 305 <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>, 306 <span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>, 307 <span class="citerefentry"><span class="refentrytitle">lwresd</span>(8)</span>, 308 <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>, 309 <em class="citetitle">BIND 9 Administrator Reference Manual</em>. 310 </p> 311</div> 312<div class="refsect1" lang="en"> 313<a name="id2675854"></a><h2>AUTHOR</h2> 314<p><span class="corpauthor">Internet Systems Consortium</span> 315 </p> 316</div> 317</div> 318<div class="navfooter"> 319<hr> 320<table width="100%" summary="Navigation footer"> 321<tr> 322<td width="40%" align="left"> 323<a accesskey="p" href="man.named-checkzone.html">Prev</a>�</td> 324<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td> 325<td width="40%" align="right">�<a accesskey="n" href="man.named-journalprint.html">Next</a> 326</td> 327</tr> 328<tr> 329<td width="40%" align="left" valign="top"> 330<span class="application">named-checkzone</span>�</td> 331<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td> 332<td width="40%" align="right" valign="top">�<span class="application">named-journalprint</span> 333</td> 334</tr> 335</table> 336</div> 337</body> 338</html> 339