named.docbook revision dafcb997e390efa4423883dafd100c975c4095d6
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
dd750c560ae48cf6caeb9a9fe81d33fc4746106dBrian Wellington - Permission to use, copy, modify, and distribute this software for any
dd750c560ae48cf6caeb9a9fe81d33fc4746106dBrian Wellington - purpose with or without fee is hereby granted, provided that the above
dd750c560ae48cf6caeb9a9fe81d33fc4746106dBrian Wellington - copyright notice and this permission notice appear in all copies.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews<!-- $Id: named.docbook,v 1.7 2004/03/05 04:57:48 marka Exp $ -->
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refentryinfo>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refentryinfo>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refentrytitle><application>named</application></refentrytitle>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refnamediv>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refname><application>named</application></refname>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refpurpose>Internet domain name server</refpurpose>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refnamediv>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refsynopsisdiv>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <cmdsynopsis>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <arg><option>-x <replaceable class="parameter">cache-file</replaceable></option></arg>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </cmdsynopsis>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refsynopsisdiv>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <command>named</command> is a Domain Name System (DNS) server,
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley part of the BIND 9 distribution from ISC. For more
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley information on the DNS, see RFCs 1033, 1034, and 1035.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley When invoked without arguments, <command>named</command> will
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley read the default configuration file
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <filename>/etc/named.conf</filename>, read any initial
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley data, and listen for queries.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <variablelist>
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews <varlistentry>
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews Use IPv4 only even if the host machine is capable of IPv6.
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews <option>-4</option> and <option>-6</option> are mutually
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews </varlistentry>
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews <varlistentry>
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews Use IPv6 only even if the host machine is capable of IPv4.
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews <option>-4</option> and <option>-6</option> are mutually
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <term>-c <replaceable class="parameter">config-file</replaceable></term>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Use <replaceable
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley class="parameter">config-file</replaceable> as the
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley configuration file instead of the default,
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley ensure that reloading the configuration file continues
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley to work after the server has changed its working
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley directory due to to a possible
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <option>directory</option> option in the configuration
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley file, <replaceable
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley class="parameter">config-file</replaceable> should be
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley an absolute pathname.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <term>-d <replaceable class="parameter">debug-level</replaceable></term>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Set the daemon's debug level to <replaceable
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Debugging traces from <command>named</command> become
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley more verbose as the debug level increases.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Run the server in the foreground (i.e. do not daemonize).
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Run the server in the foreground and force all logging
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <term>-n <replaceable class="parameter">#cpus</replaceable></term>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Create <replaceable
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley class="parameter">#cpus</replaceable> worker threads
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley to take advantage of multiple CPUs. If not specified,
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <command>named</command> will try to determine the
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley number of CPUs present and create one thread per CPU.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley If it is unable to determine the number of CPUs, a
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley single worker thread will be created.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <term>-p <replaceable class="parameter">port</replaceable></term>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Listen for queries on port <replaceable
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley specified, the default is port 53.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Write memory usage statistics to <filename>stdout</filename> on exit.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley This option is mainly of interest to BIND 9 developers
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley and may be removed or changed in a future release.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <term>-t <replaceable class="parameter">directory</replaceable></term>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley processing the command line arguments, but before
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley reading the configuration file.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley This option should be used in conjunction with the
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <option>-u</option> option, as chrooting a process
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley running as root doesn't enhance security on most
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley systems; the way <function>chroot()</function> is
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley defined allows a process with root privileges to
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley escape a chroot jail.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <term>-u <replaceable class="parameter">user</replaceable></term>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley class="parameter">user</replaceable> after completing
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley privileged operations, such as creating sockets that
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley listen on privileged ports.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley On Linux, <command>named</command> uses the kernel's
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley capability mechanism to drop all root privileges
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley except the ability to <function>bind()</function> to a
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley privileged port and set process resource limits.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Unfortunately, this means that the <option>-u</option>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley option only works when <command>named</command> is run
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley later, since previous kernels did not allow privileges
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley to be retained after <function>setuid()</function>.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Report the version number and exit.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <term>-x <replaceable class="parameter">cache-file</replaceable></term>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Load data from <replaceable
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley class="parameter">cache-file</replaceable> into the
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley cache of the default view.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley This option must not be used. It is only of interest
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley to BIND 9 developers and may be removed or changed in a
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley future release.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </variablelist>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley In routine operation, signals should not be used to control
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley the nameserver; <command>rndc</command> should be used
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <variablelist>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Force a reload of the server.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Shut down the server.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </variablelist>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley The result of sending any other signals to the server is undefined.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley The <command>named</command> configuration file is too complex
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley to describe in detail here. A complete description is
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley provided in the <citetitle>BIND 9 Administrator Reference
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley Manual</citetitle>.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <variablelist>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <term><filename>/etc/named.conf</filename></term>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley The default configuration file.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <term><filename>/var/run/named.pid</filename></term>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley The default process-id file.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </variablelist>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <citerefentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </citerefentry>,
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <citerefentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </citerefentry>,
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <corpauthor>Internet Software Consortium</corpauthor>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley - Local variables:
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley - mode: sgml