contrib/bind9/bin/named/named.docbook

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