contrib/bind9/bin/named/named.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004-2007  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000, 2001, 2003  Internet Software Consortium.
   7  -
   8  - Permission to use, copy, modify, and distribute this software for any
   9  - purpose with or without fee is hereby granted, provided that the above
  10  - copyright notice and this permission notice appear in all copies.
  11  -
  12  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  13  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  14  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  15  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  16  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  17  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  18  - PERFORMANCE OF THIS SOFTWARE.
  19 -->
  20
  21 <!-- $Id: named.docbook,v 1.7.18.8 2007/01/29 23:57:20 marka Exp $ -->
  22 <refentry id="man.named">
  23   <refentryinfo>
  24     <date>June 30, 2000</date>
  25   </refentryinfo>
  26
  27   <refmeta>
  28     <refentrytitle><application>named</application></refentrytitle>
  29     <manvolnum>8</manvolnum>
  30     <refmiscinfo>BIND9</refmiscinfo>
  31   </refmeta>
  32
  33   <refnamediv>
  34     <refname><application>named</application></refname>
  35     <refpurpose>Internet domain name server</refpurpose>
  36   </refnamediv>
  37
  38   <docinfo>
  39     <copyright>
  40       <year>2004</year>
  41       <year>2005</year>
  42       <year>2006</year>
  43       <year>2007</year>
  44       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  45     </copyright>
  46     <copyright>
  47       <year>2000</year>
  48       <year>2001</year>
  49       <year>2003</year>
  50       <holder>Internet Software Consortium.</holder>
  51     </copyright>
  52   </docinfo>
  53
  54   <refsynopsisdiv>
  55     <cmdsynopsis>
  56       <command>named</command>
  57       <arg><option>-4</option></arg>
  58       <arg><option>-6</option></arg>
  59       <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
  60       <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
  61       <arg><option>-f</option></arg>
  62       <arg><option>-g</option></arg>
  63       <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
  64       <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
  65       <arg><option>-s</option></arg>
  66       <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
  67       <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
  68       <arg><option>-v</option></arg>
  69       <arg><option>-x <replaceable class="parameter">cache-file</replaceable></option></arg>
  70     </cmdsynopsis>
  71   </refsynopsisdiv>
  72
  73   <refsect1>
  74     <title>DESCRIPTION</title>
  75     <para><command>named</command>
  76       is a Domain Name System (DNS) server,
  77       part of the BIND 9 distribution from ISC.  For more
  78       information on the DNS, see RFCs 1033, 1034, and 1035.
  79     </para>
  80     <para>
  81       When invoked without arguments, <command>named</command>
  82       will
  83       read the default configuration file
  84       <filename>/etc/named.conf</filename>, read any initial
  85       data, and listen for queries.
  86     </para>
  87   </refsect1>
  88
  89   <refsect1>
  90     <title>OPTIONS</title>
  91
  92     <variablelist>
  93       <varlistentry>
  94         <term>-4</term>
  95         <listitem>
  96           <para>
  97             Use IPv4 only even if the host machine is capable of IPv6.
  98             <option>-4</option> and <option>-6</option> are mutually
  99             exclusive.
 100           </para>
 101         </listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term>-6</term>
 106         <listitem>
 107           <para>
 108             Use IPv6 only even if the host machine is capable of IPv4.
 109             <option>-4</option> and <option>-6</option> are mutually
 110             exclusive.
 111           </para>
 112         </listitem>
 113       </varlistentry>
 114       <varlistentry>
 115         <term>-c <replaceable class="parameter">config-file</replaceable></term>
 116         <listitem>
 117           <para>
 118             Use <replaceable class="parameter">config-file</replaceable> as the
 119             configuration file instead of the default,
 120             <filename>/etc/named.conf</filename>.  To
 121             ensure that reloading the configuration file continues
 122             to work after the server has changed its working
 123             directory due to to a possible
 124             <option>directory</option> option in the configuration
 125             file, <replaceable class="parameter">config-file</replaceable> should be
 126             an absolute pathname.
 127           </para>
 128         </listitem>
 129       </varlistentry>
 130
 131       <varlistentry>
 132         <term>-d <replaceable class="parameter">debug-level</replaceable></term>
 133         <listitem>
 134           <para>
 135             Set the daemon's debug level to <replaceable class="parameter">debug-level</replaceable>.
 136             Debugging traces from <command>named</command> become
 137             more verbose as the debug level increases.
 138           </para>
 139         </listitem>
 140       </varlistentry>
 141
 142       <varlistentry>
 143         <term>-f</term>
 144         <listitem>
 145           <para>
 146             Run the server in the foreground (i.e. do not daemonize).
 147           </para>
 148         </listitem>
 149       </varlistentry>
 150
 151       <varlistentry>
 152         <term>-g</term>
 153         <listitem>
 154           <para>
 155             Run the server in the foreground and force all logging
 156             to <filename>stderr</filename>.
 157           </para>
 158         </listitem>
 159       </varlistentry>
 160
 161       <varlistentry>
 162         <term>-n <replaceable class="parameter">#cpus</replaceable></term>
 163         <listitem>
 164           <para>
 165             Create <replaceable class="parameter">#cpus</replaceable> worker threads
 166             to take advantage of multiple CPUs.  If not specified,
 167             <command>named</command> will try to determine the
 168             number of CPUs present and create one thread per CPU.
 169             If it is unable to determine the number of CPUs, a
 170             single worker thread will be created.
 171           </para>
 172         </listitem>
 173       </varlistentry>
 174
 175       <varlistentry>
 176         <term>-p <replaceable class="parameter">port</replaceable></term>
 177         <listitem>
 178           <para>
 179             Listen for queries on port <replaceable class="parameter">port</replaceable>.  If not
 180             specified, the default is port 53.
 181           </para>
 182         </listitem>
 183       </varlistentry>
 184
 185       <varlistentry>
 186         <term>-s</term>
 187         <listitem>
 188           <para>
 189             Write memory usage statistics to <filename>stdout</filename> on exit.
 190           </para>
 191           <note>
 192             <para>
 193               This option is mainly of interest to BIND 9 developers
 194               and may be removed or changed in a future release.
 195             </para>
 196           </note>
 197         </listitem>
 198       </varlistentry>
 199
 200       <varlistentry>
 201         <term>-t <replaceable class="parameter">directory</replaceable></term>
 202         <listitem>
 203           <para><function>chroot()</function>
 204             to <replaceable class="parameter">directory</replaceable> after
 205             processing the command line arguments, but before
 206             reading the configuration file.
 207           </para>
 208           <warning>
 209             <para>
 210               This option should be used in conjunction with the
 211               <option>-u</option> option, as chrooting a process
 212               running as root doesn't enhance security on most
 213               systems; the way <function>chroot()</function> is
 214               defined allows a process with root privileges to
 215               escape a chroot jail.
 216             </para>
 217           </warning>
 218         </listitem>
 219       </varlistentry>
 220
 221       <varlistentry>
 222         <term>-u <replaceable class="parameter">user</replaceable></term>
 223         <listitem>
 224           <para><function>setuid()</function>
 225             to <replaceable class="parameter">user</replaceable> after completing
 226             privileged operations, such as creating sockets that
 227             listen on privileged ports.
 228           </para>
 229           <note>
 230             <para>
 231               On Linux, <command>named</command> uses the kernel's
 232                         capability mechanism to drop all root privileges
 233               except the ability to <function>bind()</function> to
 234               a
 235               privileged port and set process resource limits.
 236               Unfortunately, this means that the <option>-u</option>
 237               option only works when <command>named</command> 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 <function>setuid()</function>.
 242             </para>
 243           </note>
 244         </listitem>
 245       </varlistentry>
 246
 247       <varlistentry>
 248         <term>-v</term>
 249         <listitem>
 250           <para>
 251             Report the version number and exit.
 252           </para>
 253         </listitem>
 254       </varlistentry>
 255
 256       <varlistentry>
 257         <term>-x <replaceable class="parameter">cache-file</replaceable></term>
 258         <listitem>
 259           <para>
 260             Load data from <replaceable class="parameter">cache-file</replaceable> into the
 261             cache of the default view.
 262           </para>
 263           <warning>
 264             <para>
 265               This option must not be used.  It is only of interest
 266               to BIND 9 developers and may be removed or changed in a
 267               future release.
 268             </para>
 269           </warning>
 270         </listitem>
 271       </varlistentry>
 272
 273     </variablelist>
 274
 275   </refsect1>
 276
 277   <refsect1>
 278     <title>SIGNALS</title>
 279     <para>
 280       In routine operation, signals should not be used to control
 281       the nameserver; <command>rndc</command> should be used
 282       instead.
 283     </para>
 284
 285     <variablelist>
 286
 287       <varlistentry>
 288         <term>SIGHUP</term>
 289         <listitem>
 290           <para>
 291             Force a reload of the server.
 292           </para>
 293         </listitem>
 294       </varlistentry>
 295
 296       <varlistentry>
 297         <term>SIGINT, SIGTERM</term>
 298         <listitem>
 299           <para>
 300             Shut down the server.
 301           </para>
 302         </listitem>
 303       </varlistentry>
 304
 305     </variablelist>
 306
 307     <para>
 308       The result of sending any other signals to the server is undefined.
 309     </para>
 310
 311   </refsect1>
 312
 313   <refsect1>
 314     <title>CONFIGURATION</title>
 315     <para>
 316       The <command>named</command> configuration file is too complex
 317       to describe in detail here.  A complete description is provided
 318       in the
 319       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 320     </para>
 321   </refsect1>
 322
 323   <refsect1>
 324     <title>FILES</title>
 325
 326     <variablelist>
 327
 328       <varlistentry>
 329         <term><filename>/etc/named.conf</filename></term>
 330         <listitem>
 331           <para>
 332             The default configuration file.
 333           </para>
 334         </listitem>
 335       </varlistentry>
 336
 337       <varlistentry>
 338         <term><filename>/var/run/named.pid</filename></term>
 339         <listitem>
 340           <para>
 341             The default process-id file.
 342           </para>
 343         </listitem>
 344       </varlistentry>
 345
 346     </variablelist>
 347
 348   </refsect1>
 349
 350   <refsect1>
 351     <title>SEE ALSO</title>
 352     <para><citetitle>RFC 1033</citetitle>,
 353       <citetitle>RFC 1034</citetitle>,
 354       <citetitle>RFC 1035</citetitle>,
 355       <citerefentry>
 356         <refentrytitle>rndc</refentrytitle>
 357         <manvolnum>8</manvolnum>
 358       </citerefentry>,
 359       <citerefentry>
 360         <refentrytitle>lwresd</refentrytitle>
 361         <manvolnum>8</manvolnum>
 362       </citerefentry>,
 363       <citerefentry>
 364         <refentrytitle>named.conf</refentrytitle>
 365         <manvolnum>5</manvolnum>
 366       </citerefentry>,
 367       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 368     </para>
 369   </refsect1>
 370
 371   <refsect1>
 372     <title>AUTHOR</title>
 373     <para><corpauthor>Internet Systems Consortium</corpauthor>
 374     </para>
 375   </refsect1>
 376
 377 </refentry><!--
 378  - Local variables:
 379  - mode: sgml
 380  - End:
 381 -->