named.docbook revision f6f1672b4e460571c418e43ae3bd0fae97e4c149
f808c858fa61e7769218966759510a8b1190dfcfraf<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
f808c858fa61e7769218966759510a8b1190dfcfraf "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
f808c858fa61e7769218966759510a8b1190dfcfraf [<!ENTITY mdash "&#8212;">]>
f808c858fa61e7769218966759510a8b1190dfcfraf<!--
f808c858fa61e7769218966759510a8b1190dfcfraf - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
f808c858fa61e7769218966759510a8b1190dfcfraf - Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
f808c858fa61e7769218966759510a8b1190dfcfraf -
f808c858fa61e7769218966759510a8b1190dfcfraf - Permission to use, copy, modify, and/or distribute this software for any
f808c858fa61e7769218966759510a8b1190dfcfraf - purpose with or without fee is hereby granted, provided that the above
f808c858fa61e7769218966759510a8b1190dfcfraf - copyright notice and this permission notice appear in all copies.
f808c858fa61e7769218966759510a8b1190dfcfraf -
f808c858fa61e7769218966759510a8b1190dfcfraf - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
f808c858fa61e7769218966759510a8b1190dfcfraf - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
f808c858fa61e7769218966759510a8b1190dfcfraf - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f808c858fa61e7769218966759510a8b1190dfcfraf - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f808c858fa61e7769218966759510a8b1190dfcfraf - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f808c858fa61e7769218966759510a8b1190dfcfraf - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f808c858fa61e7769218966759510a8b1190dfcfraf - PERFORMANCE OF THIS SOFTWARE.
f808c858fa61e7769218966759510a8b1190dfcfraf-->
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf<!-- $Id: named.docbook,v 1.23 2008/11/06 05:30:24 marka Exp $ -->
e5dcf7beb7c949f9234713d5818b581ec3825443Robert Johnston<refentry id="man.named">
f808c858fa61e7769218966759510a8b1190dfcfraf <refentryinfo>
f808c858fa61e7769218966759510a8b1190dfcfraf <date>June 30, 2000</date>
f808c858fa61e7769218966759510a8b1190dfcfraf </refentryinfo>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <refmeta>
f808c858fa61e7769218966759510a8b1190dfcfraf <refentrytitle><application>named</application></refentrytitle>
f808c858fa61e7769218966759510a8b1190dfcfraf <manvolnum>8</manvolnum>
f808c858fa61e7769218966759510a8b1190dfcfraf <refmiscinfo>BIND9</refmiscinfo>
f808c858fa61e7769218966759510a8b1190dfcfraf </refmeta>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <refnamediv>
f808c858fa61e7769218966759510a8b1190dfcfraf <refname><application>named</application></refname>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <refpurpose>Internet domain name server</refpurpose>
f808c858fa61e7769218966759510a8b1190dfcfraf </refnamediv>
c40d7343efa60b18ad1ceb316eb337caeea79046cindi
c40d7343efa60b18ad1ceb316eb337caeea79046cindi <docinfo>
9dd0f810214fdc8e1af881a9a5c4b6927629ff9ecindi <copyright>
f808c858fa61e7769218966759510a8b1190dfcfraf <year>2004</year>
f808c858fa61e7769218966759510a8b1190dfcfraf <year>2005</year>
25c6ff4b77fcddf4097ce78a8277275ca603b46cstephh <year>2006</year>
e4b86885570d77af552e9cf94f142f4d744fb8c8Cheng Sean Ye <year>2007</year>
2cb5535af222653abf2eba5c180ded4a7b85d8b6robj <year>2008</year>
25c6ff4b77fcddf4097ce78a8277275ca603b46cstephh <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
c40d7343efa60b18ad1ceb316eb337caeea79046cindi </copyright>
f808c858fa61e7769218966759510a8b1190dfcfraf <copyright>
940d71d237794874e18a0eb72f6564821a823517eschrock <year>2000</year>
940d71d237794874e18a0eb72f6564821a823517eschrock <year>2001</year>
e4b86885570d77af552e9cf94f142f4d744fb8c8Cheng Sean Ye <year>2003</year>
f808c858fa61e7769218966759510a8b1190dfcfraf <holder>Internet Software Consortium.</holder>
f808c858fa61e7769218966759510a8b1190dfcfraf </copyright>
c93c462eec9d46f84d567abf52eb29a27c2e134bCheng Sean Ye </docinfo>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <refsynopsisdiv>
f808c858fa61e7769218966759510a8b1190dfcfraf <cmdsynopsis>
f808c858fa61e7769218966759510a8b1190dfcfraf <command>named</command>
f808c858fa61e7769218966759510a8b1190dfcfraf <arg><option>-4</option></arg>
c93c462eec9d46f84d567abf52eb29a27c2e134bCheng Sean Ye <arg><option>-6</option></arg>
f808c858fa61e7769218966759510a8b1190dfcfraf <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
f808c858fa61e7769218966759510a8b1190dfcfraf <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
f808c858fa61e7769218966759510a8b1190dfcfraf <arg><option>-f</option></arg>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <arg><option>-g</option></arg>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <arg><option>-m <replaceable class="parameter">flag</replaceable></option></arg>
184cd04c26b064536977dfbb913a1240eaf6f708cth <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
184cd04c26b064536977dfbb913a1240eaf6f708cth <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
f808c858fa61e7769218966759510a8b1190dfcfraf <arg><option>-s</option></arg>
f808c858fa61e7769218966759510a8b1190dfcfraf <arg><option>-S <replaceable class="parameter">#max-socks</replaceable></option></arg>
e5dcf7beb7c949f9234713d5818b581ec3825443Robert Johnston <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
f808c858fa61e7769218966759510a8b1190dfcfraf <arg><option>-v</option></arg>
f808c858fa61e7769218966759510a8b1190dfcfraf <arg><option>-V</option></arg>
f808c858fa61e7769218966759510a8b1190dfcfraf <arg><option>-x <replaceable class="parameter">cache-file</replaceable></option></arg>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </cmdsynopsis>
f808c858fa61e7769218966759510a8b1190dfcfraf </refsynopsisdiv>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi <refsect1>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi <title>DESCRIPTION</title>
f808c858fa61e7769218966759510a8b1190dfcfraf <para><command>named</command>
f808c858fa61e7769218966759510a8b1190dfcfraf is a Domain Name System (DNS) server,
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi part of the BIND 9 distribution from ISC. For more
f808c858fa61e7769218966759510a8b1190dfcfraf information on the DNS, see RFCs 1033, 1034, and 1035.
f808c858fa61e7769218966759510a8b1190dfcfraf </para>
f808c858fa61e7769218966759510a8b1190dfcfraf <para>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi When invoked without arguments, <command>named</command>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi will
0b1b4412cfd6c4ac5467dbe6f4088dcec4f55fe8Eric Schrock read the default configuration file
0b1b4412cfd6c4ac5467dbe6f4088dcec4f55fe8Eric Schrock <filename>/etc/named.conf</filename>, read any initial
f808c858fa61e7769218966759510a8b1190dfcfraf data, and listen for queries.
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </para>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </refsect1>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <refsect1>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi <title>OPTIONS</title>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi <variablelist>
f808c858fa61e7769218966759510a8b1190dfcfraf <varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf <term>-4</term>
f808c858fa61e7769218966759510a8b1190dfcfraf <listitem>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi <para>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi Use IPv4 only even if the host machine is capable of IPv6.
f808c858fa61e7769218966759510a8b1190dfcfraf <option>-4</option> and <option>-6</option> are mutually
f808c858fa61e7769218966759510a8b1190dfcfraf exclusive.
f808c858fa61e7769218966759510a8b1190dfcfraf </para>
f808c858fa61e7769218966759510a8b1190dfcfraf </listitem>
12cc75c814f0c017004a9bbc96429911e008601bcindi </varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf <term>-6</term>
f808c858fa61e7769218966759510a8b1190dfcfraf <listitem>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <para>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj Use IPv6 only even if the host machine is capable of IPv4.
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <option>-4</option> and <option>-6</option> are mutually
f808c858fa61e7769218966759510a8b1190dfcfraf exclusive.
f808c858fa61e7769218966759510a8b1190dfcfraf </para>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </listitem>
f808c858fa61e7769218966759510a8b1190dfcfraf </varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf <varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf <term>-c <replaceable class="parameter">config-file</replaceable></term>
e4b86885570d77af552e9cf94f142f4d744fb8c8Cheng Sean Ye <listitem>
f808c858fa61e7769218966759510a8b1190dfcfraf <para>
4557a2a1868181b517f5dfe61ba6eeba58edf4c0robj Use <replaceable class="parameter">config-file</replaceable> as the
f808c858fa61e7769218966759510a8b1190dfcfraf configuration file instead of the default,
f808c858fa61e7769218966759510a8b1190dfcfraf <filename>/etc/named.conf</filename>. To
f808c858fa61e7769218966759510a8b1190dfcfraf ensure that reloading the configuration file continues
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi to work after the server has changed its working
f808c858fa61e7769218966759510a8b1190dfcfraf directory due to to a possible
f808c858fa61e7769218966759510a8b1190dfcfraf <option>directory</option> option in the configuration
f808c858fa61e7769218966759510a8b1190dfcfraf file, <replaceable class="parameter">config-file</replaceable> should be
f808c858fa61e7769218966759510a8b1190dfcfraf an absolute pathname.
c40d7343efa60b18ad1ceb316eb337caeea79046cindi </para>
f808c858fa61e7769218966759510a8b1190dfcfraf </listitem>
f808c858fa61e7769218966759510a8b1190dfcfraf </varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf <term>-d <replaceable class="parameter">debug-level</replaceable></term>
f808c858fa61e7769218966759510a8b1190dfcfraf <listitem>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <para>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi Set the daemon's debug level to <replaceable class="parameter">debug-level</replaceable>.
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi Debugging traces from <command>named</command> become
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi more verbose as the debug level increases.
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </para>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </listitem>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </varlistentry>
9af3851a3a831b4de34b42482c22351e14f33f16eschrock
c40d7343efa60b18ad1ceb316eb337caeea79046cindi <varlistentry>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi <term>-f</term>
f808c858fa61e7769218966759510a8b1190dfcfraf <listitem>
c40d7343efa60b18ad1ceb316eb337caeea79046cindi <para>
c40d7343efa60b18ad1ceb316eb337caeea79046cindi Run the server in the foreground (i.e. do not daemonize).
f808c858fa61e7769218966759510a8b1190dfcfraf </para>
f808c858fa61e7769218966759510a8b1190dfcfraf </listitem>
f808c858fa61e7769218966759510a8b1190dfcfraf </varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf <term>-g</term>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <listitem>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi <para>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi Run the server in the foreground and force all logging
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi to <filename>stderr</filename>.
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </para>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </listitem>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </varlistentry>
c40d7343efa60b18ad1ceb316eb337caeea79046cindi
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <varlistentry>
e5dcf7beb7c949f9234713d5818b581ec3825443Robert Johnston <term>-m <replaceable class="parameter">flag</replaceable></term>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi <listitem>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <para>
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj Turn on memory usage debugging flags. Possible flags are
825ba0f20a74fd9c5d0d1ce2c195da2cc88a7f77robj <replaceable class="parameter">usage</replaceable>,
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi <replaceable class="parameter">trace</replaceable>,
f808c858fa61e7769218966759510a8b1190dfcfraf <replaceable class="parameter">record</replaceable>,
f808c858fa61e7769218966759510a8b1190dfcfraf <replaceable class="parameter">size</replaceable>, and
f808c858fa61e7769218966759510a8b1190dfcfraf <replaceable class="parameter">mctx</replaceable>.
f808c858fa61e7769218966759510a8b1190dfcfraf These correspond to the ISC_MEM_DEBUGXXXX flags described in
f808c858fa61e7769218966759510a8b1190dfcfraf <filename>&lt;isc/mem.h&gt;</filename>.
f808c858fa61e7769218966759510a8b1190dfcfraf </para>
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi </listitem>
f808c858fa61e7769218966759510a8b1190dfcfraf </varlistentry>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <varlistentry>
<term>-n <replaceable class="parameter">#cpus</replaceable></term>
<listitem>
<para>
Create <replaceable class="parameter">#cpus</replaceable> worker threads
to take advantage of multiple CPUs. If not specified,
<command>named</command> will try to determine the
number of CPUs present and create one thread per CPU.
If it is unable to determine the number of CPUs, a
single worker thread will be created.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p <replaceable class="parameter">port</replaceable></term>
<listitem>
<para>
Listen for queries on port <replaceable class="parameter">port</replaceable>. If not
specified, the default is port 53.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s</term>
<listitem>
<para>
Write memory usage statistics to <filename>stdout</filename> on exit.
</para>
<note>
<para>
This option is mainly of interest to BIND 9 developers
and may be removed or changed in a future release.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>-S <replaceable class="parameter">#max-socks</replaceable></term>
<listitem>
<para>
Allow <command>named</command> to use up to
<replaceable class="parameter">#max-socks</replaceable> sockets.
</para>
<warning>
<para>
This option should be unnecessary for the vast majority
of users.
The use of this option could even be harmful because the
specified value may exceed the limitation of the
underlying system API.
It is therefore set only when the default configuration
causes exhaustion of file descriptors and the
operational environment is known to support the
specified number of sockets.
Note also that the actual maximum number is normally a little
fewer than the specified value because
<command>named</command> reserves some file descriptors
for its internal use.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term>-t <replaceable class="parameter">directory</replaceable></term>
<listitem>
<para>Chroot
to <replaceable class="parameter">directory</replaceable> after
processing the command line arguments, but before
reading the configuration file.
</para>
<warning>
<para>
This option should be used in conjunction with the
<option>-u</option> option, as chrooting a process
running as root doesn't enhance security on most
systems; the way <function>chroot(2)</function> is
defined allows a process with root privileges to
escape a chroot jail.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term>-u <replaceable class="parameter">user</replaceable></term>
<listitem>
<para>Setuid
to <replaceable class="parameter">user</replaceable> after completing
privileged operations, such as creating sockets that
listen on privileged ports.
</para>
<note>
<para>
On Linux, <command>named</command> uses the kernel's
capability mechanism to drop all root privileges
except the ability to <function>bind(2)</function> to
a
privileged port and set process resource limits.
Unfortunately, this means that the <option>-u</option>
option only works when <command>named</command> is
run
on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
later, since previous kernels did not allow privileges
to be retained after <function>setuid(2)</function>.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>-v</term>
<listitem>
<para>
Report the version number and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-V</term>
<listitem>
<para>
Report the version number and build options, and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-x <replaceable class="parameter">cache-file</replaceable></term>
<listitem>
<para>
Load data from <replaceable class="parameter">cache-file</replaceable> into the
cache of the default view.
</para>
<warning>
<para>
This option must not be used. It is only of interest
to BIND 9 developers and may be removed or changed in a
future release.
</para>
</warning>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SIGNALS</title>
<para>
In routine operation, signals should not be used to control
the nameserver; <command>rndc</command> should be used
instead.
</para>
<variablelist>
<varlistentry>
<term>SIGHUP</term>
<listitem>
<para>
Force a reload of the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SIGINT, SIGTERM</term>
<listitem>
<para>
Shut down the server.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The result of sending any other signals to the server is undefined.
</para>
</refsect1>
<refsect1>
<title>CONFIGURATION</title>
<para>
The <command>named</command> configuration file is too complex
to describe in detail here. A complete description is provided
in the
<citetitle>BIND 9 Administrator Reference Manual</citetitle>.
</para>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/etc/named.conf</filename></term>
<listitem>
<para>
The default configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>/var/run/named/named.pid</filename></term>
<listitem>
<para>
The default process-id file.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citetitle>RFC 1033</citetitle>,
<citetitle>RFC 1034</citetitle>,
<citetitle>RFC 1035</citetitle>,
<citerefentry>
<refentrytitle>named-checkconf</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>named-checkzone</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>rndc</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>lwresd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>named.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>,
<citetitle>BIND 9 Administrator Reference Manual</citetitle>.
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para><corpauthor>Internet Systems Consortium</corpauthor>
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->