named.docbook revision 44613d4d868ed5e73a1132280880f0699af56733
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson [<!ENTITY mdash "—">]>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews - Copyright (C) 2004-2009, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson - Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson - Permission to use, copy, modify, and/or distribute this software for any
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson - purpose with or without fee is hereby granted, provided that the above
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson - 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
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson - PERFORMANCE OF THIS SOFTWARE.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refentryinfo>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refentryinfo>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refentrytitle><application>named</application></refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refname><application>named</application></refname>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refpurpose>Internet domain name server</refpurpose>
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsynopsisdiv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <cmdsynopsis>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <arg><option>-D <replaceable class="parameter">string</replaceable></option></arg>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <arg><option>-E <replaceable class="parameter">engine-name</replaceable></option></arg>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <arg><option>-L <replaceable class="parameter">logfile</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-m <replaceable class="parameter">flag</replaceable></option></arg>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-S <replaceable class="parameter">#max-socks</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-U <replaceable class="parameter">#listeners</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <arg><option>-x <replaceable class="parameter">cache-file</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </cmdsynopsis>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson </refsynopsisdiv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is a Domain Name System (DNS) server,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein part of the BIND 9 distribution from ISC. For more
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein information on the DNS, see RFCs 1033, 1034, and 1035.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson When invoked without arguments, <command>named</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein read the default configuration file
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <filename>/etc/named.conf</filename>, read any initial
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein data, and listen for queries.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <variablelist>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson Use IPv4 only even if the host machine is capable of IPv6.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <option>-4</option> and <option>-6</option> are mutually
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson Use IPv6 only even if the host machine is capable of IPv4.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <option>-4</option> and <option>-6</option> are mutually
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <term>-c <replaceable class="parameter">config-file</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Use <replaceable class="parameter">config-file</replaceable> as the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein configuration file instead of the default,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein ensure that reloading the configuration file continues
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein to work after the server has changed its working
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein directory due to to a possible
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <option>directory</option> option in the configuration
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein file, <replaceable class="parameter">config-file</replaceable> should be
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein an absolute pathname.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-d <replaceable class="parameter">debug-level</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Set the daemon's debug level to <replaceable class="parameter">debug-level</replaceable>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Debugging traces from <command>named</command> become
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein more verbose as the debug level increases.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson <term>-D <replaceable class="parameter">string</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Specifies a string that is used to identify a instance of
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <command>named</command> in a process listing. The contents
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson of <replaceable class="parameter">string</replaceable> are
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <varlistentry>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson <term>-E <replaceable class="parameter">engine-name</replaceable></term>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson When applicable, specifies the hardware to use for
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson cryptographic operations, such as a secure key store used
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson When BIND is built with OpenSSL PKCS#11 support, this defaults
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson to the string "pkcs11", which identifies an OpenSSL engine
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein that can drive a cryptographic accelerator or hardware service
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein module. When BIND is built with native PKCS#11 cryptography
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein (--enable-native-pkcs11), it defaults to the path of the PKCS#11
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein provider library specified via "--with-pkcs11".
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Run the server in the foreground (i.e. do not daemonize).
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Run the server in the foreground and force all logging
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-L <replaceable class="parameter">logfile</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Log to the file <option>logfile</option> by default
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein instead of the system log.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-m <replaceable class="parameter">flag</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Turn on memory usage debugging flags. Possible flags are
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <replaceable class="parameter">usage</replaceable>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <replaceable class="parameter">trace</replaceable>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <replaceable class="parameter">record</replaceable>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <replaceable class="parameter">size</replaceable>, and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <replaceable class="parameter">mctx</replaceable>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein These correspond to the ISC_MEM_DEBUGXXXX flags described in
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-n <replaceable class="parameter">#cpus</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Create <replaceable class="parameter">#cpus</replaceable> worker threads
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein to take advantage of multiple CPUs. If not specified,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>named</command> will try to determine the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein number of CPUs present and create one thread per CPU.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If it is unable to determine the number of CPUs, a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein single worker thread will be created.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-p <replaceable class="parameter">port</replaceable></term>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Listen for queries on port <replaceable class="parameter">port</replaceable>. If not
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein specified, the default is port 53.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Write memory usage statistics to <filename>stdout</filename> on exit.