named.docbook revision f5d30e2864e048a42c4dc1134993ae7efdb5d6c3
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
841179549b6433e782c164a562eb3422f603533dAndreas Gustafsson "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
841179549b6433e782c164a562eb3422f603533dAndreas Gustafsson [<!ENTITY mdash "&#8212;">]>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<!--
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
841179549b6433e782c164a562eb3422f603533dAndreas Gustafsson -
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - Permission to use, copy, modify, and distribute this software for any
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - purpose with or without fee is hereby granted, provided that the above
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - copyright notice and this permission notice appear in all copies.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington -
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
841179549b6433e782c164a562eb3422f603533dAndreas Gustafsson - PERFORMANCE OF THIS SOFTWARE.
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington-->
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<!-- $Id: named.docbook,v 1.10 2005/05/13 01:35:40 marka Exp $ -->
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refentryinfo>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <date>June 30, 2000</date>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </refentryinfo>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refmeta>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refentrytitle><application>named</application></refentrytitle>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <manvolnum>8</manvolnum>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refmiscinfo>BIND9</refmiscinfo>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </refmeta>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refnamediv>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refname><application>named</application></refname>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refpurpose>Internet domain name server</refpurpose>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </refnamediv>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <docinfo>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <copyright>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <year>2004</year>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <year>2005</year>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </copyright>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <copyright>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <year>2000</year>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <year>2001</year>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <year>2003</year>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <holder>Internet Software Consortium.</holder>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </copyright>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </docinfo>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refsynopsisdiv>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <cmdsynopsis>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <command>named</command>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-4</option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-6</option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-f</option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-g</option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-s</option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-v</option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <arg><option>-x <replaceable class="parameter">cache-file</replaceable></option></arg>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </cmdsynopsis>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </refsynopsisdiv>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <title>DESCRIPTION</title>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para><command>named</command>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington is a Domain Name System (DNS) server,
c40265eba0c99708887d68e67901924065ba2514Brian Wellington part of the BIND 9 distribution from ISC. For more
c40265eba0c99708887d68e67901924065ba2514Brian Wellington information on the DNS, see RFCs 1033, 1034, and 1035.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington When invoked without arguments, <command>named</command>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington will
c40265eba0c99708887d68e67901924065ba2514Brian Wellington read the default configuration file
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <filename>/etc/named.conf</filename>, read any initial
c40265eba0c99708887d68e67901924065ba2514Brian Wellington data, and listen for queries.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <title>OPTIONS</title>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <variablelist>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-4</term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Use IPv4 only even if the host machine is capable of IPv6.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <option>-4</option> and <option>-6</option> are mutually
c40265eba0c99708887d68e67901924065ba2514Brian Wellington exclusive.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-6</term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Use IPv6 only even if the host machine is capable of IPv4.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <option>-4</option> and <option>-6</option> are mutually
c40265eba0c99708887d68e67901924065ba2514Brian Wellington exclusive.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-c <replaceable class="parameter">config-file</replaceable></term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Use <replaceable class="parameter">config-file</replaceable> as the
c40265eba0c99708887d68e67901924065ba2514Brian Wellington configuration file instead of the default,
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <filename>/etc/named.conf</filename>. To
c40265eba0c99708887d68e67901924065ba2514Brian Wellington ensure that reloading the configuration file continues
c40265eba0c99708887d68e67901924065ba2514Brian Wellington to work after the server has changed its working
c40265eba0c99708887d68e67901924065ba2514Brian Wellington directory due to to a possible
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <option>directory</option> option in the configuration
c40265eba0c99708887d68e67901924065ba2514Brian Wellington file, <replaceable class="parameter">config-file</replaceable> should be
c40265eba0c99708887d68e67901924065ba2514Brian Wellington an absolute pathname.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-d <replaceable class="parameter">debug-level</replaceable></term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Set the daemon's debug level to <replaceable class="parameter">debug-level</replaceable>.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Debugging traces from <command>named</command> become
c40265eba0c99708887d68e67901924065ba2514Brian Wellington more verbose as the debug level increases.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-f</term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Run the server in the foreground (i.e. do not daemonize).
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-g</term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Run the server in the foreground and force all logging
c40265eba0c99708887d68e67901924065ba2514Brian Wellington to <filename>stderr</filename>.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-n <replaceable class="parameter">#cpus</replaceable></term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Create <replaceable class="parameter">#cpus</replaceable> worker threads
c40265eba0c99708887d68e67901924065ba2514Brian Wellington to take advantage of multiple CPUs. If not specified,
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <command>named</command> will try to determine the
c40265eba0c99708887d68e67901924065ba2514Brian Wellington number of CPUs present and create one thread per CPU.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington If it is unable to determine the number of CPUs, a
c40265eba0c99708887d68e67901924065ba2514Brian Wellington single worker thread will be created.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-p <replaceable class="parameter">port</replaceable></term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Listen for queries on port <replaceable class="parameter">port</replaceable>. If not
c40265eba0c99708887d68e67901924065ba2514Brian Wellington specified, the default is port 53.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-s</term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Write memory usage statistics to <filename>stdout</filename> on exit.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <note>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington This option is mainly of interest to BIND 9 developers
c40265eba0c99708887d68e67901924065ba2514Brian Wellington and may be removed or changed in a future release.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </note>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <varlistentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <term>-t <replaceable class="parameter">directory</replaceable></term>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <listitem>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para><function>chroot()</function>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington to <replaceable class="parameter">directory</replaceable> after
c40265eba0c99708887d68e67901924065ba2514Brian Wellington processing the command line arguments, but before
c40265eba0c99708887d68e67901924065ba2514Brian Wellington reading the configuration file.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <warning>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington This option should be used in conjunction with the
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <option>-u</option> option, as chrooting a process
c40265eba0c99708887d68e67901924065ba2514Brian Wellington running as root doesn't enhance security on most
c40265eba0c99708887d68e67901924065ba2514Brian Wellington systems; the way <function>chroot()</function> is
c40265eba0c99708887d68e67901924065ba2514Brian Wellington defined allows a process with root privileges to
c40265eba0c99708887d68e67901924065ba2514Brian Wellington escape a chroot jail.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term>-u <replaceable class="parameter">user</replaceable></term>
<listitem>
<para><function>setuid()</function>
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()</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()</function>.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>-v</term>
<listitem>
<para>
Report the version number 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.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>rndc</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>lwresd</refentrytitle><manvolnum>8</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:
-->