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