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, 2005  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.5 2005/05/13 01:22:33 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       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  39     </copyright>
  40     <copyright>
  41       <year>2000</year>
  42       <year>2001</year>
  43       <year>2003</year>
  44       <holder>Internet Software Consortium.</holder>
  45     </copyright>
  46   </docinfo>
  47
  48   <refnamediv>
  49     <refname><application>named</application></refname>
  50     <refpurpose>Internet domain name server</refpurpose>
  51   </refnamediv>
  52
  53   <refsynopsisdiv>
  54     <cmdsynopsis>
  55       <command>named</command>
  56       <arg><option>-4</option></arg>
  57       <arg><option>-6</option></arg>
  58       <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
  59       <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
  60       <arg><option>-f</option></arg>
  61       <arg><option>-g</option></arg>
  62       <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
  63       <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
  64       <arg><option>-s</option></arg>
  65       <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
  66       <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
  67       <arg><option>-v</option></arg>
  68       <arg><option>-x <replaceable class="parameter">cache-file</replaceable></option></arg>
  69     </cmdsynopsis>
  70   </refsynopsisdiv>
  71
  72   <refsect1>
  73     <title>DESCRIPTION</title>
  74     <para>
  75         <command>named</command> is a Domain Name System (DNS) server,
  76         part of the BIND 9 distribution from ISC.  For more
  77         information on the DNS, see RFCs 1033, 1034, and 1035.
  78     </para>
  79     <para>
  80         When invoked without arguments, <command>named</command> will
  81         read the default configuration file
  82         <filename>/etc/named.conf</filename>, read any initial
  83         data, and listen for queries.
  84     </para>
  85   </refsect1>
  86
  87   <refsect1>
  88     <title>OPTIONS</title>
  89
  90     <variablelist>
  91       <varlistentry>
  92         <term>-4</term>
  93         <listitem>
  94           <para>
  95                 Use IPv4 only even if the host machine is capable of IPv6.
  96                 <option>-4</option> and <option>-6</option> are mutually
  97                 exclusive.
  98           </para>
  99         </listitem>
 100       </varlistentry>
 101
 102       <varlistentry>
 103         <term>-6</term>
 104         <listitem>
 105           <para>
 106                 Use IPv6 only even if the host machine is capable of IPv4.
 107                 <option>-4</option> and <option>-6</option> are mutually
 108                 exclusive.
 109           </para>
 110         </listitem>
 111       </varlistentry>
 112       <varlistentry>
 113         <term>-c <replaceable class="parameter">config-file</replaceable></term>
 114         <listitem>
 115           <para>
 116                 Use <replaceable
 117                 class="parameter">config-file</replaceable> as the
 118                 configuration file instead of the default,
 119                 <filename>/etc/named.conf</filename>.  To
 120                 ensure that reloading the configuration file continues
 121                 to work after the server has changed its working
 122                 directory due to to a possible
 123                 <option>directory</option> option in the configuration
 124                 file, <replaceable
 125                 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
 136                 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>-n <replaceable class="parameter">#cpus</replaceable></term>
 164         <listitem>
 165           <para>
 166                 Create <replaceable
 167                 class="parameter">#cpus</replaceable> worker threads
 168                 to take advantage of multiple CPUs.  If not specified,
 169                 <command>named</command> will try to determine the
 170                 number of CPUs present and create one thread per CPU.
 171                 If it is unable to determine the number of CPUs, a
 172                 single worker thread will be created.
 173           </para>
 174         </listitem>
 175       </varlistentry>
 176
 177       <varlistentry>
 178         <term>-p <replaceable class="parameter">port</replaceable></term>
 179         <listitem>
 180           <para>
 181                 Listen for queries on port <replaceable
 182                 class="parameter">port</replaceable>.  If not
 183                 specified, the default is port 53.
 184           </para>
 185         </listitem>
 186       </varlistentry>
 187
 188       <varlistentry>
 189         <term>-s</term>
 190         <listitem>
 191           <para>
 192                 Write memory usage statistics to <filename>stdout</filename> on exit.
 193           </para>
 194           <note>
 195             <para>
 196                 This option is mainly of interest to BIND 9 developers
 197                 and may be removed or changed in a future release.
 198             </para>
 199           </note>
 200         </listitem>
 201       </varlistentry>
 202
 203       <varlistentry>
 204         <term>-t <replaceable class="parameter">directory</replaceable></term>
 205         <listitem>
 206           <para>
 207                 <function>chroot()</function> to <replaceable
 208                 class="parameter">directory</replaceable> after
 209                 processing the command line arguments, but before
 210                 reading the configuration file.
 211           </para>
 212           <warning>
 213             <para>
 214                 This option should be used in conjunction with the
 215                 <option>-u</option> option, as chrooting a process
 216                 running as root doesn't enhance security on most
 217                 systems; the way <function>chroot()</function> is
 218                 defined allows a process with root privileges to
 219                 escape a chroot jail.
 220             </para>
 221           </warning>
 222         </listitem>
 223       </varlistentry>
 224
 225       <varlistentry>
 226         <term>-u <replaceable class="parameter">user</replaceable></term>
 227         <listitem>
 228           <para>
 229                 <function>setuid()</function> to <replaceable
 230                 class="parameter">user</replaceable> after completing
 231                 privileged operations, such as creating sockets that
 232                 listen on privileged ports.
 233           </para>
 234           <note>
 235             <para>
 236                 On Linux, <command>named</command> uses the kernel's
 237                 capability mechanism to drop all root privileges
 238                 except the ability to <function>bind()</function> to a
 239                 privileged port and set process resource limits.
 240                 Unfortunately, this means that the <option>-u</option>
 241                 option only works when <command>named</command> is run
 242                 on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
 243                 later, since previous kernels did not allow privileges
 244                 to be retained after <function>setuid()</function>.
 245             </para>
 246           </note>
 247         </listitem>
 248       </varlistentry>
 249
 250       <varlistentry>
 251         <term>-v</term>
 252         <listitem>
 253           <para>
 254                 Report the version number and exit.
 255           </para>
 256         </listitem>
 257       </varlistentry>
 258
 259       <varlistentry>
 260         <term>-x <replaceable class="parameter">cache-file</replaceable></term>
 261         <listitem>
 262           <para>
 263                 Load data from <replaceable
 264                 class="parameter">cache-file</replaceable> into the
 265                 cache of the default view.
 266           </para>
 267           <warning>
 268             <para>
 269                 This option must not be used.  It is only of interest
 270                 to BIND 9 developers and may be removed or changed in a
 271                 future release.
 272             </para>
 273           </warning>
 274         </listitem>
 275       </varlistentry>
 276
 277     </variablelist>
 278
 279   </refsect1>
 280
 281   <refsect1>
 282     <title>SIGNALS</title>
 283     <para>
 284         In routine operation, signals should not be used to control
 285         the nameserver; <command>rndc</command> should be used
 286         instead.
 287     </para>
 288
 289     <variablelist>
 290
 291       <varlistentry>
 292         <term>SIGHUP</term>
 293         <listitem>
 294           <para>
 295                 Force a reload of the server.
 296           </para>
 297         </listitem>
 298       </varlistentry>
 299
 300       <varlistentry>
 301         <term>SIGINT, SIGTERM</term>
 302         <listitem>
 303           <para>
 304                 Shut down the server.
 305           </para>
 306         </listitem>
 307       </varlistentry>
 308
 309     </variablelist>
 310
 311     <para>
 312         The result of sending any other signals to the server is undefined.
 313     </para>
 314
 315   </refsect1>
 316
 317   <refsect1>
 318     <title>CONFIGURATION</title>
 319     <para>
 320         The <command>named</command> configuration file is too complex
 321         to describe in detail here.  A complete description is
 322         provided in the <citetitle>BIND 9 Administrator Reference
 323         Manual</citetitle>.
 324     </para>
 325   </refsect1>
 326
 327   <refsect1>
 328     <title>FILES</title>
 329
 330     <variablelist>
 331
 332       <varlistentry>
 333         <term><filename>/etc/named.conf</filename></term>
 334         <listitem>
 335           <para>
 336                 The default configuration file.
 337           </para>
 338         </listitem>
 339       </varlistentry>
 340
 341       <varlistentry>
 342         <term><filename>/var/run/named.pid</filename></term>
 343         <listitem>
 344           <para>
 345                 The default process-id file.
 346           </para>
 347         </listitem>
 348       </varlistentry>
 349
 350     </variablelist>
 351
 352   </refsect1>
 353
 354   <refsect1>
 355     <title>SEE ALSO</title>
 356     <para>
 357         <citetitle>RFC 1033</citetitle>,
 358         <citetitle>RFC 1034</citetitle>,
 359         <citetitle>RFC 1035</citetitle>,
 360         <citerefentry>
 361           <refentrytitle>rndc</refentrytitle>
 362           <manvolnum>8</manvolnum>
 363         </citerefentry>,
 364         <citerefentry>
 365           <refentrytitle>lwresd</refentrytitle>
 366           <manvolnum>8</manvolnum>
 367         </citerefentry>,
 368         <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 369     </para>
 370   </refsect1>
 371
 372   <refsect1>
 373     <title>AUTHOR</title>
 374     <para>
 375         <corpauthor>Internet Systems Consortium</corpauthor>
 376     </para>
 377   </refsect1>
 378
 379 </refentry>
 380
 381
 382 <!--
 383  - Local variables:
 384  - mode: sgml
 385  - End:
 386 -->