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