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-2008  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000, 2001, 2003  Internet Software Consortium.
   7  -
   8  - Permission to use, copy, modify, and/or 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.23 2008/11/06 05:30:24 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       <year>2008</year>
  45       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  46     </copyright>
  47     <copyright>
  48       <year>2000</year>
  49       <year>2001</year>
  50       <year>2003</year>
  51       <holder>Internet Software Consortium.</holder>
  52     </copyright>
  53   </docinfo>
  54
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  57       <command>named</command>
  58       <arg><option>-4</option></arg>
  59       <arg><option>-6</option></arg>
  60       <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
  61       <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
  62       <arg><option>-f</option></arg>
  63       <arg><option>-g</option></arg>
  64       <arg><option>-m <replaceable class="parameter">flag</replaceable></option></arg>
  65       <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
  66       <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
  67       <arg><option>-s</option></arg>
  68       <arg><option>-S <replaceable class="parameter">#max-socks</replaceable></option></arg>
  69       <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
  70       <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
  71       <arg><option>-v</option></arg>
  72       <arg><option>-V</option></arg>
  73       <arg><option>-x <replaceable class="parameter">cache-file</replaceable></option></arg>
  74     </cmdsynopsis>
  75   </refsynopsisdiv>
  76
  77   <refsect1>
  78     <title>DESCRIPTION</title>
  79     <para><command>named</command>
  80       is a Domain Name System (DNS) server,
  81       part of the BIND 9 distribution from ISC.  For more
  82       information on the DNS, see RFCs 1033, 1034, and 1035.
  83     </para>
  84     <para>
  85       When invoked without arguments, <command>named</command>
  86       will
  87       read the default configuration file
  88       <filename>/etc/named.conf</filename>, read any initial
  89       data, and listen for queries.
  90     </para>
  91   </refsect1>
  92
  93   <refsect1>
  94     <title>OPTIONS</title>
  95
  96     <variablelist>
  97       <varlistentry>
  98         <term>-4</term>
  99         <listitem>
 100           <para>
 101             Use IPv4 only even if the host machine is capable of IPv6.
 102             <option>-4</option> and <option>-6</option> are mutually
 103             exclusive.
 104           </para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term>-6</term>
 110         <listitem>
 111           <para>
 112             Use IPv6 only even if the host machine is capable of IPv4.
 113             <option>-4</option> and <option>-6</option> are mutually
 114             exclusive.
 115           </para>
 116         </listitem>
 117       </varlistentry>
 118       <varlistentry>
 119         <term>-c <replaceable class="parameter">config-file</replaceable></term>
 120         <listitem>
 121           <para>
 122             Use <replaceable class="parameter">config-file</replaceable> as the
 123             configuration file instead of the default,
 124             <filename>/etc/named.conf</filename>.  To
 125             ensure that reloading the configuration file continues
 126             to work after the server has changed its working
 127             directory due to to a possible
 128             <option>directory</option> option in the configuration
 129             file, <replaceable class="parameter">config-file</replaceable> should be
 130             an absolute pathname.
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134
 135       <varlistentry>
 136         <term>-d <replaceable class="parameter">debug-level</replaceable></term>
 137         <listitem>
 138           <para>
 139             Set the daemon's debug level to <replaceable class="parameter">debug-level</replaceable>.
 140             Debugging traces from <command>named</command> become
 141             more verbose as the debug level increases.
 142           </para>
 143         </listitem>
 144       </varlistentry>
 145
 146       <varlistentry>
 147         <term>-f</term>
 148         <listitem>
 149           <para>
 150             Run the server in the foreground (i.e. do not daemonize).
 151           </para>
 152         </listitem>
 153       </varlistentry>
 154
 155       <varlistentry>
 156         <term>-g</term>
 157         <listitem>
 158           <para>
 159             Run the server in the foreground and force all logging
 160             to <filename>stderr</filename>.
 161           </para>
 162         </listitem>
 163       </varlistentry>
 164
 165       <varlistentry>
 166         <term>-m <replaceable class="parameter">flag</replaceable></term>
 167         <listitem>
 168           <para>
 169             Turn on memory usage debugging flags.  Possible flags are
 170             <replaceable class="parameter">usage</replaceable>,
 171             <replaceable class="parameter">trace</replaceable>,
 172             <replaceable class="parameter">record</replaceable>,
 173             <replaceable class="parameter">size</replaceable>, and
 174             <replaceable class="parameter">mctx</replaceable>.
 175             These correspond to the ISC_MEM_DEBUGXXXX flags described in
 176             <filename>&lt;isc/mem.h&gt;</filename>.
 177           </para>
 178         </listitem>
 179       </varlistentry>
 180
 181       <varlistentry>
 182         <term>-n <replaceable class="parameter">#cpus</replaceable></term>
 183         <listitem>
 184           <para>
 185             Create <replaceable class="parameter">#cpus</replaceable> worker threads
 186             to take advantage of multiple CPUs.  If not specified,
 187             <command>named</command> will try to determine the
 188             number of CPUs present and create one thread per CPU.
 189             If it is unable to determine the number of CPUs, a
 190             single worker thread will be created.
 191           </para>
 192         </listitem>
 193       </varlistentry>
 194
 195       <varlistentry>
 196         <term>-p <replaceable class="parameter">port</replaceable></term>
 197         <listitem>
 198           <para>
 199             Listen for queries on port <replaceable class="parameter">port</replaceable>.  If not
 200             specified, the default is port 53.
 201           </para>
 202         </listitem>
 203       </varlistentry>
 204
 205       <varlistentry>
 206         <term>-s</term>
 207         <listitem>
 208           <para>
 209             Write memory usage statistics to <filename>stdout</filename> on exit.
 210           </para>
 211           <note>
 212             <para>
 213               This option is mainly of interest to BIND 9 developers
 214               and may be removed or changed in a future release.
 215             </para>
 216           </note>
 217         </listitem>
 218       </varlistentry>
 219
 220       <varlistentry>
 221         <term>-S <replaceable class="parameter">#max-socks</replaceable></term>
 222         <listitem>
 223           <para>
 224             Allow <command>named</command> to use up to
 225             <replaceable class="parameter">#max-socks</replaceable> sockets.
 226           </para>
 227           <warning>
 228             <para>
 229               This option should be unnecessary for the vast majority
 230               of users.
 231               The use of this option could even be harmful because the
 232               specified value may exceed the limitation of the
 233               underlying system API.
 234               It is therefore set only when the default configuration
 235               causes exhaustion of file descriptors and the
 236               operational environment is known to support the
 237               specified number of sockets.
 238               Note also that the actual maximum number is normally a little
 239               fewer than the specified value because
 240               <command>named</command> reserves some file descriptors
 241               for its internal use.
 242             </para>
 243           </warning>
 244         </listitem>
 245       </varlistentry>
 246
 247       <varlistentry>
 248         <term>-t <replaceable class="parameter">directory</replaceable></term>
 249         <listitem>
 250           <para>Chroot
 251             to <replaceable class="parameter">directory</replaceable> after
 252             processing the command line arguments, but before
 253             reading the configuration file.
 254           </para>
 255           <warning>
 256             <para>
 257               This option should be used in conjunction with the
 258               <option>-u</option> option, as chrooting a process
 259               running as root doesn't enhance security on most
 260               systems; the way <function>chroot(2)</function> is
 261               defined allows a process with root privileges to
 262               escape a chroot jail.
 263             </para>
 264           </warning>
 265         </listitem>
 266       </varlistentry>
 267
 268       <varlistentry>
 269         <term>-u <replaceable class="parameter">user</replaceable></term>
 270         <listitem>
 271           <para>Setuid
 272             to <replaceable class="parameter">user</replaceable> after completing
 273             privileged operations, such as creating sockets that
 274             listen on privileged ports.
 275           </para>
 276           <note>
 277             <para>
 278               On Linux, <command>named</command> uses the kernel's
 279                         capability mechanism to drop all root privileges
 280               except the ability to <function>bind(2)</function> to
 281               a
 282               privileged port and set process resource limits.
 283               Unfortunately, this means that the <option>-u</option>
 284               option only works when <command>named</command> is
 285               run
 286               on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
 287               later, since previous kernels did not allow privileges
 288               to be retained after <function>setuid(2)</function>.
 289             </para>
 290           </note>
 291         </listitem>
 292       </varlistentry>
 293
 294       <varlistentry>
 295         <term>-v</term>
 296         <listitem>
 297           <para>
 298             Report the version number and exit.
 299           </para>
 300         </listitem>
 301       </varlistentry>
 302
 303       <varlistentry>
 304         <term>-V</term>
 305         <listitem>
 306           <para>
 307             Report the version number and build options, and exit.
 308           </para>
 309         </listitem>
 310       </varlistentry>
 311
 312       <varlistentry>
 313         <term>-x <replaceable class="parameter">cache-file</replaceable></term>
 314         <listitem>
 315           <para>
 316             Load data from <replaceable class="parameter">cache-file</replaceable> into the
 317             cache of the default view.
 318           </para>
 319           <warning>
 320             <para>
 321               This option must not be used.  It is only of interest
 322               to BIND 9 developers and may be removed or changed in a
 323               future release.
 324             </para>
 325           </warning>
 326         </listitem>
 327       </varlistentry>
 328
 329     </variablelist>
 330
 331   </refsect1>
 332
 333   <refsect1>
 334     <title>SIGNALS</title>
 335     <para>
 336       In routine operation, signals should not be used to control
 337       the nameserver; <command>rndc</command> should be used
 338       instead.
 339     </para>
 340
 341     <variablelist>
 342
 343       <varlistentry>
 344         <term>SIGHUP</term>
 345         <listitem>
 346           <para>
 347             Force a reload of the server.
 348           </para>
 349         </listitem>
 350       </varlistentry>
 351
 352       <varlistentry>
 353         <term>SIGINT, SIGTERM</term>
 354         <listitem>
 355           <para>
 356             Shut down the server.
 357           </para>
 358         </listitem>
 359       </varlistentry>
 360
 361     </variablelist>
 362
 363     <para>
 364       The result of sending any other signals to the server is undefined.
 365     </para>
 366
 367   </refsect1>
 368
 369   <refsect1>
 370     <title>CONFIGURATION</title>
 371     <para>
 372       The <command>named</command> configuration file is too complex
 373       to describe in detail here.  A complete description is provided
 374       in the
 375       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 376     </para>
 377   </refsect1>
 378
 379   <refsect1>
 380     <title>FILES</title>
 381
 382     <variablelist>
 383
 384       <varlistentry>
 385         <term><filename>/etc/named.conf</filename></term>
 386         <listitem>
 387           <para>
 388             The default configuration file.
 389           </para>
 390         </listitem>
 391       </varlistentry>
 392
 393       <varlistentry>
 394         <term><filename>/var/run/named/named.pid</filename></term>
 395         <listitem>
 396           <para>
 397             The default process-id file.
 398           </para>
 399         </listitem>
 400       </varlistentry>
 401
 402     </variablelist>
 403
 404   </refsect1>
 405
 406   <refsect1>
 407     <title>SEE ALSO</title>
 408     <para><citetitle>RFC 1033</citetitle>,
 409       <citetitle>RFC 1034</citetitle>,
 410       <citetitle>RFC 1035</citetitle>,
 411       <citerefentry>
 412         <refentrytitle>named-checkconf</refentrytitle>
 413         <manvolnum>8</manvolnum>
 414       </citerefentry>,
 415       <citerefentry>
 416         <refentrytitle>named-checkzone</refentrytitle>
 417         <manvolnum>8</manvolnum>
 418       </citerefentry>,
 419       <citerefentry>
 420         <refentrytitle>rndc</refentrytitle>
 421         <manvolnum>8</manvolnum>
 422       </citerefentry>,
 423       <citerefentry>
 424         <refentrytitle>lwresd</refentrytitle>
 425         <manvolnum>8</manvolnum>
 426       </citerefentry>,
 427       <citerefentry>
 428         <refentrytitle>named.conf</refentrytitle>
 429         <manvolnum>5</manvolnum>
 430       </citerefentry>,
 431       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 432     </para>
 433   </refsect1>
 434
 435   <refsect1>
 436     <title>AUTHOR</title>
 437     <para><corpauthor>Internet Systems Consortium</corpauthor>
 438     </para>
 439   </refsect1>
 440
 441 </refentry><!--
 442  - Local variables:
 443  - mode: sgml
 444  - End:
 445 -->