contrib/bind9/bin/named/named.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004-2006  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.5.98.7 2006/01/17 23:49:30 marka Exp $ -->
  22
  23 <refentry>
  24   <refentryinfo>
  25     <date>June 30, 2000</date>
  26   </refentryinfo>
  27
  28   <refmeta>
  29     <refentrytitle><application>named</application></refentrytitle>
  30     <manvolnum>8</manvolnum>
  31     <refmiscinfo>BIND9</refmiscinfo>
  32   </refmeta>
  33
  34   <docinfo>
  35     <copyright>
  36       <year>2004</year>
  37       <year>2005</year>
  38       <year>2006</year>
  39       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  40     </copyright>
  41     <copyright>
  42       <year>2000</year>
  43       <year>2001</year>
  44       <year>2003</year>
  45       <holder>Internet Software Consortium.</holder>
  46     </copyright>
  47   </docinfo>
  48
  49   <refnamediv>
  50     <refname><application>named</application></refname>
  51     <refpurpose>Internet domain name server</refpurpose>
  52   </refnamediv>
  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>
  76         <command>named</command> 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> will
  82         read the default configuration file
  83         <filename>/etc/named.conf</filename>, read any initial
  84         data, and listen for queries.
  85     </para>
  86   </refsect1>
  87
  88   <refsect1>
  89     <title>OPTIONS</title>
  90
  91     <variablelist>
  92       <varlistentry>
  93         <term>-4</term>
  94         <listitem>
  95           <para>
  96                 Use IPv4 only even if the host machine is capable of IPv6.
  97                 <option>-4</option> and <option>-6</option> are mutually
  98                 exclusive.
  99           </para>
 100         </listitem>
 101       </varlistentry>
 102
 103       <varlistentry>
 104         <term>-6</term>
 105         <listitem>
 106           <para>
 107                 Use IPv6 only even if the host machine is capable of IPv4.
 108                 <option>-4</option> and <option>-6</option> are mutually
 109                 exclusive.
 110           </para>
 111         </listitem>
 112       </varlistentry>
 113       <varlistentry>
 114         <term>-c <replaceable class="parameter">config-file</replaceable></term>
 115         <listitem>
 116           <para>
 117                 Use <replaceable
 118                 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
 126                 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
 137                 class="parameter">debug-level</replaceable>.
 138                 Debugging traces from <command>named</command> become
 139                 more verbose as the debug level increases.
 140           </para>
 141         </listitem>
 142       </varlistentry>
 143
 144       <varlistentry>
 145         <term>-f</term>
 146         <listitem>
 147           <para>
 148                 Run the server in the foreground (i.e. do not daemonize).
 149           </para>
 150         </listitem>
 151       </varlistentry>
 152
 153       <varlistentry>
 154         <term>-g</term>
 155         <listitem>
 156           <para>
 157                 Run the server in the foreground and force all logging
 158                 to <filename>stderr</filename>.
 159           </para>
 160         </listitem>
 161       </varlistentry>
 162
 163       <varlistentry>
 164         <term>-n <replaceable class="parameter">#cpus</replaceable></term>
 165         <listitem>
 166           <para>
 167                 Create <replaceable
 168                 class="parameter">#cpus</replaceable> worker threads
 169                 to take advantage of multiple CPUs.  If not specified,
 170                 <command>named</command> will try to determine the
 171                 number of CPUs present and create one thread per CPU.
 172                 If it is unable to determine the number of CPUs, a
 173                 single worker thread will be created.
 174           </para>
 175         </listitem>
 176       </varlistentry>
 177
 178       <varlistentry>
 179         <term>-p <replaceable class="parameter">port</replaceable></term>
 180         <listitem>
 181           <para>
 182                 Listen for queries on port <replaceable
 183                 class="parameter">port</replaceable>.  If not
 184                 specified, the default is port 53.
 185           </para>
 186         </listitem>
 187       </varlistentry>
 188
 189       <varlistentry>
 190         <term>-s</term>
 191         <listitem>
 192           <para>
 193                 Write memory usage statistics to <filename>stdout</filename> on exit.
 194           </para>
 195           <note>
 196             <para>
 197                 This option is mainly of interest to BIND 9 developers
 198                 and may be removed or changed in a future release.
 199             </para>
 200           </note>
 201         </listitem>
 202       </varlistentry>
 203
 204       <varlistentry>
 205         <term>-t <replaceable class="parameter">directory</replaceable></term>
 206         <listitem>
 207           <para>
 208                 <function>chroot()</function> to <replaceable
 209                 class="parameter">directory</replaceable> after
 210                 processing the command line arguments, but before
 211                 reading the configuration file.
 212           </para>
 213           <warning>
 214             <para>
 215                 This option should be used in conjunction with the
 216                 <option>-u</option> option, as chrooting a process
 217                 running as root doesn't enhance security on most
 218                 systems; the way <function>chroot()</function> is
 219                 defined allows a process with root privileges to
 220                 escape a chroot jail.
 221             </para>
 222           </warning>
 223         </listitem>
 224       </varlistentry>
 225
 226       <varlistentry>
 227         <term>-u <replaceable class="parameter">user</replaceable></term>
 228         <listitem>
 229           <para>
 230                 <function>setuid()</function> to <replaceable
 231                 class="parameter">user</replaceable> after completing
 232                 privileged operations, such as creating sockets that
 233                 listen on privileged ports.
 234           </para>
 235           <note>
 236             <para>
 237                 On Linux, <command>named</command> uses the kernel's
 238                 capability mechanism to drop all root privileges
 239                 except the ability to <function>bind()</function> to a
 240                 privileged port and set process resource limits.
 241                 Unfortunately, this means that the <option>-u</option>
 242                 option only works when <command>named</command> is run
 243                 on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
 244                 later, since previous kernels did not allow privileges
 245                 to be retained after <function>setuid()</function>.
 246             </para>
 247           </note>
 248         </listitem>
 249       </varlistentry>
 250
 251       <varlistentry>
 252         <term>-v</term>
 253         <listitem>
 254           <para>
 255                 Report the version number and exit.
 256           </para>
 257         </listitem>
 258       </varlistentry>
 259
 260       <varlistentry>
 261         <term>-x <replaceable class="parameter">cache-file</replaceable></term>
 262         <listitem>
 263           <para>
 264                 Load data from <replaceable
 265                 class="parameter">cache-file</replaceable> into the
 266                 cache of the default view.
 267           </para>
 268           <warning>
 269             <para>
 270                 This option must not be used.  It is only of interest
 271                 to BIND 9 developers and may be removed or changed in a
 272                 future release.
 273             </para>
 274           </warning>
 275         </listitem>
 276       </varlistentry>
 277
 278     </variablelist>
 279
 280   </refsect1>
 281
 282   <refsect1>
 283     <title>SIGNALS</title>
 284     <para>
 285         In routine operation, signals should not be used to control
 286         the nameserver; <command>rndc</command> should be used
 287         instead.
 288     </para>
 289
 290     <variablelist>
 291
 292       <varlistentry>
 293         <term>SIGHUP</term>
 294         <listitem>
 295           <para>
 296                 Force a reload of the server.
 297           </para>
 298         </listitem>
 299       </varlistentry>
 300
 301       <varlistentry>
 302         <term>SIGINT, SIGTERM</term>
 303         <listitem>
 304           <para>
 305                 Shut down the server.
 306           </para>
 307         </listitem>
 308       </varlistentry>
 309
 310     </variablelist>
 311
 312     <para>
 313         The result of sending any other signals to the server is undefined.
 314     </para>
 315
 316   </refsect1>
 317
 318   <refsect1>
 319     <title>CONFIGURATION</title>
 320     <para>
 321         The <command>named</command> configuration file is too complex
 322         to describe in detail here.  A complete description is
 323         provided in the <citetitle>BIND 9 Administrator Reference
 324         Manual</citetitle>.
 325     </para>
 326   </refsect1>
 327
 328   <refsect1>
 329     <title>FILES</title>
 330
 331     <variablelist>
 332
 333       <varlistentry>
 334         <term><filename>/etc/named.conf</filename></term>
 335         <listitem>
 336           <para>
 337                 The default configuration file.
 338           </para>
 339         </listitem>
 340       </varlistentry>
 341
 342       <varlistentry>
 343         <term><filename>/var/run/named.pid</filename></term>
 344         <listitem>
 345           <para>
 346                 The default process-id file.
 347           </para>
 348         </listitem>
 349       </varlistentry>
 350
 351     </variablelist>
 352
 353   </refsect1>
 354
 355   <refsect1>
 356     <title>SEE ALSO</title>
 357     <para>
 358         <citetitle>RFC 1033</citetitle>,
 359         <citetitle>RFC 1034</citetitle>,
 360         <citetitle>RFC 1035</citetitle>,
 361         <citerefentry>
 362           <refentrytitle>rndc</refentrytitle>
 363           <manvolnum>8</manvolnum>
 364         </citerefentry>,
 365         <citerefentry>
 366           <refentrytitle>lwresd</refentrytitle>
 367           <manvolnum>8</manvolnum>
 368         </citerefentry>,
 369         <citerefentry>
 370           <refentrytitle>named.conf</refentrytitle>
 371           <manvolnum>5</manvolnum>
 372         </citerefentry>,
 373         <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 374     </para>
 375   </refsect1>
 376
 377   <refsect1>
 378     <title>AUTHOR</title>
 379     <para>
 380         <corpauthor>Internet Systems Consortium</corpauthor>
 381     </para>
 382   </refsect1>
 383
 384 </refentry>
 385
 386
 387 <!--
 388  - Local variables:
 389  - mode: sgml
 390  - End:
 391 -->