lwresd.docbook revision 1753d3c4d74241a847794f7e7cfd94cc79be6600
6bdda696b3ea703c47e87fea61017ec655f91d92nd<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
6bdda696b3ea703c47e87fea61017ec655f91d92nd [<!ENTITY mdash "—">]>
6bdda696b3ea703c47e87fea61017ec655f91d92nd - Copyright (C) 2004, 2005, 2007-2009 Internet Systems Consortium, Inc. ("ISC")
6bdda696b3ea703c47e87fea61017ec655f91d92nd - Copyright (C) 2000, 2001 Internet Software Consortium.
6bdda696b3ea703c47e87fea61017ec655f91d92nd - Permission to use, copy, modify, and/or distribute this software for any
6bdda696b3ea703c47e87fea61017ec655f91d92nd - purpose with or without fee is hereby granted, provided that the above
6bdda696b3ea703c47e87fea61017ec655f91d92nd - copyright notice and this permission notice appear in all copies.
6bdda696b3ea703c47e87fea61017ec655f91d92nd - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
6bdda696b3ea703c47e87fea61017ec655f91d92nd - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
6bdda696b3ea703c47e87fea61017ec655f91d92nd - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
6bdda696b3ea703c47e87fea61017ec655f91d92nd - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
6bdda696b3ea703c47e87fea61017ec655f91d92nd - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
6bdda696b3ea703c47e87fea61017ec655f91d92nd - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
6bdda696b3ea703c47e87fea61017ec655f91d92nd - PERFORMANCE OF THIS SOFTWARE.
16b55a35cff91315d261d1baa776138af465c4e4fuankg <refentryinfo>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </refentryinfo>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <refentrytitle><application>lwresd</application></refentrytitle>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </refmeta>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <refnamediv>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </refnamediv>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <copyright>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </copyright>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <copyright>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </copyright>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </docinfo>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <refsynopsisdiv>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <cmdsynopsis>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-C <replaceable class="parameter">config-file</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-i <replaceable class="parameter">pid-file</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-m <replaceable class="parameter">flag</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-P <replaceable class="parameter">port</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </cmdsynopsis>
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg </refsynopsisdiv>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <refsect1>
6bdda696b3ea703c47e87fea61017ec655f91d92nd is the daemon providing name lookup
6bdda696b3ea703c47e87fea61017ec655f91d92nd services to clients that use the BIND 9 lightweight resolver
6bdda696b3ea703c47e87fea61017ec655f91d92nd library. It is essentially a stripped-down, caching-only name
6bdda696b3ea703c47e87fea61017ec655f91d92nd server that answers queries using the BIND 9 lightweight
6bdda696b3ea703c47e87fea61017ec655f91d92nd resolver protocol rather than the DNS protocol.
6bdda696b3ea703c47e87fea61017ec655f91d92nd listens for resolver queries on a
6bdda696b3ea703c47e87fea61017ec655f91d92nd UDP port on the IPv4 loopback interface, 127.0.0.1. This
6bdda696b3ea703c47e87fea61017ec655f91d92nd processes running on the local machine. By default, UDP port
6bdda696b3ea703c47e87fea61017ec655f91d92nd number 921 is used for lightweight resolver requests and
6bdda696b3ea703c47e87fea61017ec655f91d92nd responses.
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg Incoming lightweight resolver requests are decoded by the
6bdda696b3ea703c47e87fea61017ec655f91d92nd server which then resolves them using the DNS protocol. When
6bdda696b3ea703c47e87fea61017ec655f91d92nd the DNS lookup completes, <command>lwresd</command> encodes
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg the answers in the lightweight resolver format and returns
6bdda696b3ea703c47e87fea61017ec655f91d92nd them to the client that made the request.
6bdda696b3ea703c47e87fea61017ec655f91d92nd <option>nameserver</option> entries, <command>lwresd</command>
6bdda696b3ea703c47e87fea61017ec655f91d92nd sends recursive DNS queries to those servers. This is similar
6bdda696b3ea703c47e87fea61017ec655f91d92nd to the use of forwarders in a caching name server. If no
6bdda696b3ea703c47e87fea61017ec655f91d92nd queries autonomously starting at the root name servers, using
6bdda696b3ea703c47e87fea61017ec655f91d92nd a built-in list of root server hints.
0662ed52e814f8f08ef0e09956413a792584eddffuankg </refsect1>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <variablelist>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Use IPv4 only even if the host machine is capable of IPv6.
6bdda696b3ea703c47e87fea61017ec655f91d92nd </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
0662ed52e814f8f08ef0e09956413a792584eddffuankg <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Use IPv6 only even if the host machine is capable of IPv4.
6bdda696b3ea703c47e87fea61017ec655f91d92nd exclusive.
6bdda696b3ea703c47e87fea61017ec655f91d92nd </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <!-- this is in source but not mentioned? does this matter? -->
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg <term>-c <replaceable class="parameter">config-file</replaceable></term>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Use <replaceable class="parameter">config-file</replaceable> as the
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg configuration file instead of the default,
6bdda696b3ea703c47e87fea61017ec655f91d92nd <!-- Should this be an absolute path name? -->
6bdda696b3ea703c47e87fea61017ec655f91d92nd <option>-c</option> can not be used with <option>-C</option>.
6bdda696b3ea703c47e87fea61017ec655f91d92nd </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <term>-C <replaceable class="parameter">config-file</replaceable></term>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Use <replaceable class="parameter">config-file</replaceable> as the
6bdda696b3ea703c47e87fea61017ec655f91d92nd configuration file instead of the default,
6bdda696b3ea703c47e87fea61017ec655f91d92nd <option>-C</option> can not be used with <option>-c</option>.
6bdda696b3ea703c47e87fea61017ec655f91d92nd </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <term>-d <replaceable class="parameter">debug-level</replaceable></term>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Set the daemon's debug level to <replaceable class="parameter">debug-level</replaceable>.
6bdda696b3ea703c47e87fea61017ec655f91d92nd more verbose as the debug level increases.
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Run the server in the foreground (i.e. do not daemonize).
6bdda696b3ea703c47e87fea61017ec655f91d92nd </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg Run the server in the foreground and force all logging
6bdda696b3ea703c47e87fea61017ec655f91d92nd </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <term>-i <replaceable class="parameter">pid-file</replaceable></term>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Use <replaceable class="parameter">pid-file</replaceable> as the
6bdda696b3ea703c47e87fea61017ec655f91d92nd PID file instead of the default,
6bdda696b3ea703c47e87fea61017ec655f91d92nd </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <term>-m <replaceable class="parameter">flag</replaceable></term>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Turn on memory usage debugging flags. Possible flags are
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg These correspond to the ISC_MEM_DEBUGXXXX flags described in
6bdda696b3ea703c47e87fea61017ec655f91d92nd </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <term>-n <replaceable class="parameter">#cpus</replaceable></term>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Create <replaceable class="parameter">#cpus</replaceable> worker threads
6bdda696b3ea703c47e87fea61017ec655f91d92nd to take advantage of multiple CPUs. If not specified,
6bdda696b3ea703c47e87fea61017ec655f91d92nd number of CPUs present and create one thread per CPU.
6bdda696b3ea703c47e87fea61017ec655f91d92nd If it is unable to determine the number of CPUs, a
6bdda696b3ea703c47e87fea61017ec655f91d92nd single worker thread will be created.
0662ed52e814f8f08ef0e09956413a792584eddffuankg </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <term>-P <replaceable class="parameter">port</replaceable></term>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd Listen for lightweight resolver queries on port
6bdda696b3ea703c47e87fea61017ec655f91d92nd not specified, the default is port 921.
6bdda696b3ea703c47e87fea61017ec655f91d92nd </listitem>
6bdda696b3ea703c47e87fea61017ec655f91d92nd </varlistentry>
6bdda696b3ea703c47e87fea61017ec655f91d92nd <varlistentry>
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg <term>-p <replaceable class="parameter">port</replaceable></term>