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

   1 <!--
   2  - Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2003 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and 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: man.named.html,v 1.2.2.53 2007/10/31 01:35:59 marka 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 <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.rndc.html" title="rndc">
  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.rndc.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> &#8212; 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">-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">-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>
  51 </div>
  52 <div class="refsect1" lang="en">
  53 <a name="id2601798"></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="id2601829"></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">-f</span></dt>
 101 <dd><p>
 102             Run the server in the foreground (i.e. do not daemonize).
 103           </p></dd>
 104 <dt><span class="term">-g</span></dt>
 105 <dd><p>
 106             Run the server in the foreground and force all logging
 107             to <code class="filename">stderr</code>.
 108           </p></dd>
 109 <dt><span class="term">-m <em class="replaceable"><code>flag</code></em></span></dt>
 110 <dd><p>
 111             Turn on memory usage debugging flags.  Possible flags are
 112             <em class="replaceable"><code>usage</code></em>,
 113             <em class="replaceable"><code>trace</code></em>,
 114             <em class="replaceable"><code>record</code></em>,
 115             <em class="replaceable"><code>size</code></em>, and
 116             <em class="replaceable"><code>mctx</code></em>.
 117             These correspond to the ISC_MEM_DEBUGXXXX flags described in
 118             <code class="filename">&lt;isc/mem.h&gt;</code>.
 119           </p></dd>
 120 <dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt>
 121 <dd><p>
 122             Create <em class="replaceable"><code>#cpus</code></em> worker threads
 123             to take advantage of multiple CPUs.  If not specified,
 124             <span><strong class="command">named</strong></span> will try to determine the
 125             number of CPUs present and create one thread per CPU.
 126             If it is unable to determine the number of CPUs, a
 127             single worker thread will be created.
 128           </p></dd>
 129 <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
 130 <dd><p>
 131             Listen for queries on port <em class="replaceable"><code>port</code></em>.  If not
 132             specified, the default is port 53.
 133           </p></dd>
 134 <dt><span class="term">-s</span></dt>
 135 <dd>
 136 <p>
 137             Write memory usage statistics to <code class="filename">stdout</code> on exit.
 138           </p>
 139 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 140 <h3 class="title">Note</h3>
 141 <p>
 142               This option is mainly of interest to BIND 9 developers
 143               and may be removed or changed in a future release.
 144             </p>
 145 </div>
 146 </dd>
 147 <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
 148 <dd>
 149 <p>Chroot
 150             to <em class="replaceable"><code>directory</code></em> after
 151             processing the command line arguments, but before
 152             reading the configuration file.
 153           </p>
 154 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 155 <h3 class="title">Warning</h3>
 156 <p>
 157               This option should be used in conjunction with the
 158               <code class="option">-u</code> option, as chrooting a process
 159               running as root doesn't enhance security on most
 160               systems; the way <code class="function">chroot(2)</code> is
 161               defined allows a process with root privileges to
 162               escape a chroot jail.
 163             </p>
 164 </div>
 165 </dd>
 166 <dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
 167 <dd>
 168 <p>Setuid
 169             to <em class="replaceable"><code>user</code></em> after completing
 170             privileged operations, such as creating sockets that
 171             listen on privileged ports.
 172           </p>
 173 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 174 <h3 class="title">Note</h3>
 175 <p>
 176               On Linux, <span><strong class="command">named</strong></span> uses the kernel's
 177                         capability mechanism to drop all root privileges
 178               except the ability to <code class="function">bind(2)</code> to
 179               a
 180               privileged port and set process resource limits.
 181               Unfortunately, this means that the <code class="option">-u</code>
 182               option only works when <span><strong class="command">named</strong></span> is
 183               run
 184               on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
 185               later, since previous kernels did not allow privileges
 186               to be retained after <code class="function">setuid(2)</code>.
 187             </p>
 188 </div>
 189 </dd>
 190 <dt><span class="term">-v</span></dt>
 191 <dd><p>
 192             Report the version number and exit.
 193           </p></dd>
 194 <dt><span class="term">-x <em class="replaceable"><code>cache-file</code></em></span></dt>
 195 <dd>
 196 <p>
 197             Load data from <em class="replaceable"><code>cache-file</code></em> into the
 198             cache of the default view.
 199           </p>
 200 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 201 <h3 class="title">Warning</h3>
 202 <p>
 203               This option must not be used.  It is only of interest
 204               to BIND 9 developers and may be removed or changed in a
 205               future release.
 206             </p>
 207 </div>
 208 </dd>
 209 </dl></div>
 210 </div>
 211 <div class="refsect1" lang="en">
 212 <a name="id2604492"></a><h2>SIGNALS</h2>
 213 <p>
 214       In routine operation, signals should not be used to control
 215       the nameserver; <span><strong class="command">rndc</strong></span> should be used
 216       instead.
 217     </p>
 218 <div class="variablelist"><dl>
 219 <dt><span class="term">SIGHUP</span></dt>
 220 <dd><p>
 221             Force a reload of the server.
 222           </p></dd>
 223 <dt><span class="term">SIGINT, SIGTERM</span></dt>
 224 <dd><p>
 225             Shut down the server.
 226           </p></dd>
 227 </dl></div>
 228 <p>
 229       The result of sending any other signals to the server is undefined.
 230     </p>
 231 </div>
 232 <div class="refsect1" lang="en">
 233 <a name="id2604542"></a><h2>CONFIGURATION</h2>
 234 <p>
 235       The <span><strong class="command">named</strong></span> configuration file is too complex
 236       to describe in detail here.  A complete description is provided
 237       in the
 238       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 239     </p>
 240 </div>
 241 <div class="refsect1" lang="en">
 242 <a name="id2604562"></a><h2>FILES</h2>
 243 <div class="variablelist"><dl>
 244 <dt><span class="term"><code class="filename">/etc/named.conf</code></span></dt>
 245 <dd><p>
 246             The default configuration file.
 247           </p></dd>
 248 <dt><span class="term"><code class="filename">/var/run/named.pid</code></span></dt>
 249 <dd><p>
 250             The default process-id file.
 251           </p></dd>
 252 </dl></div>
 253 </div>
 254 <div class="refsect1" lang="en">
 255 <a name="id2604605"></a><h2>SEE ALSO</h2>
 256 <p><em class="citetitle">RFC 1033</em>,
 257       <em class="citetitle">RFC 1034</em>,
 258       <em class="citetitle">RFC 1035</em>,
 259       <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
 260       <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
 261       <span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
 262       <span class="citerefentry"><span class="refentrytitle">lwresd</span>(8)</span>,
 263       <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
 264       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 265     </p>
 266 </div>
 267 <div class="refsect1" lang="en">
 268 <a name="id2604881"></a><h2>AUTHOR</h2>
 269 <p><span class="corpauthor">Internet Systems Consortium</span>
 270     </p>
 271 </div>
 272 </div>
 273 <div class="navfooter">
 274 <hr>
 275 <table width="100%" summary="Navigation footer">
 276 <tr>
 277 <td width="40%" align="left">
 278 <a accesskey="p" href="man.named-checkzone.html">Prev</a> </td>
 279 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
 280 <td width="40%" align="right"> <a accesskey="n" href="man.rndc.html">Next</a>
 281 </td>
 282 </tr>
 283 <tr>
 284 <td width="40%" align="left" valign="top">
 285 <span class="application">named-checkzone</span> </td>
 286 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 287 <td width="40%" align="right" valign="top"> <span class="application">rndc</span>
 288 </td>
 289 </tr>
 290 </table>
 291 </div>
 292 </body>
 293 </html>