contrib/bind9/doc/arm/man.named.html

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