lwresd.docbook revision 5cd4555ad444fd391002ae32450572054369fd42
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa [<!ENTITY mdash "&#8212;">]>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa<!--
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - Copyright (C) 2000, 2001 Internet Software Consortium.
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa -
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - Permission to use, copy, modify, and distribute this software for any
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - purpose with or without fee is hereby granted, provided that the above
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - copyright notice and this permission notice appear in all copies.
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa -
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa - PERFORMANCE OF THIS SOFTWARE.
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa-->
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa<!-- $Id: lwresd.docbook,v 1.11 2007/01/29 22:16:02 sra Exp $ -->
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa<refentry>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <refentryinfo>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <date>June 30, 2000</date>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </refentryinfo>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <refmeta>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <refentrytitle><application>lwresd</application></refentrytitle>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <manvolnum>8</manvolnum>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <refmiscinfo>BIND9</refmiscinfo>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </refmeta>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <refnamediv>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <refname><application>lwresd</application></refname>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <refpurpose>lightweight resolver daemon</refpurpose>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </refnamediv>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <docinfo>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <copyright>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <year>2004</year>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <year>2005</year>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </copyright>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <copyright>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <year>2000</year>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <year>2001</year>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <holder>Internet Software Consortium.</holder>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </copyright>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </docinfo>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <refsynopsisdiv>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <cmdsynopsis>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <command>lwresd</command>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-C <replaceable class="parameter">config-file</replaceable></option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-f</option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-g</option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-i <replaceable class="parameter">pid-file</replaceable></option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-P <replaceable class="parameter">port</replaceable></option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-s</option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <arg><option>-v</option></arg>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </cmdsynopsis>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </refsynopsisdiv>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <refsect1>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <title>DESCRIPTION</title>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <para><command>lwresd</command>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa is the daemon providing name lookup
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa services to clients that use the BIND 9 lightweight resolver
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa library. It is essentially a stripped-down, caching-only name
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa server that answers queries using the BIND 9 lightweight
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa resolver protocol rather than the DNS protocol.
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </para>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <para><command>lwresd</command>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa listens for resolver queries on a
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa UDP port on the IPv4 loopback interface, 127.0.0.1. This
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa means that <command>lwresd</command> can only be used by
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa processes running on the local machine. By default UDP port
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa number 921 is used for lightweight resolver requests and
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa responses.
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </para>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <para>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa Incoming lightweight resolver requests are decoded by the
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa server which then resolves them using the DNS protocol. When
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa the DNS lookup completes, <command>lwresd</command> encodes
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa the answers in the lightweight resolver format and returns
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa them to the client that made the request.
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa </para>
7bb0a9e92bc7a6f868eaa0b9c3212c0af4f96b7fEugen Kuksa <para>
If <filename>/etc/resolv.conf</filename> contains any
<option>nameserver</option> entries, <command>lwresd</command>
sends recursive DNS queries to those servers. This is similar
to the use of forwarders in a caching name server. If no
<option>nameserver</option> entries are present, or if
forwarding fails, <command>lwresd</command> resolves the
queries autonomously starting at the root name servers, using
a built-in list of root server hints.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-C <replaceable class="parameter">config-file</replaceable></term>
<listitem>
<para>
Use <replaceable class="parameter">config-file</replaceable> as the
configuration file instead of the default,
<filename>/etc/resolv.conf</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-d <replaceable class="parameter">debug-level</replaceable></term>
<listitem>
<para>
Set the daemon's debug level to <replaceable class="parameter">debug-level</replaceable>.
Debugging traces from <command>lwresd</command> become
more verbose as the debug level increases.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-f</term>
<listitem>
<para>
Run the server in the foreground (i.e. do not daemonize).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-g</term>
<listitem>
<para>
Run the server in the foreground and force all logging
to <filename>stderr</filename>.
</para>
</listitem>
</varlistentry>
<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>lwresd</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 lightweight resolver queries on port
<replaceable class="parameter">port</replaceable>. If
not specified, the default is port 921.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p <replaceable class="parameter">port</replaceable></term>
<listitem>
<para>
Send DNS lookups to port <replaceable class="parameter">port</replaceable>. If not
specified, the default is port 53. This provides a
way of testing the lightweight resolver daemon with a
name server that listens for queries on a non-standard
port number.
</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>-t <replaceable class="parameter">directory</replaceable></term>
<listitem>
<para><function>chroot()</function>
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()</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><function>setuid()</function>
to <replaceable class="parameter">user</replaceable> after completing
privileged operations, such as creating sockets that
listen on privileged ports.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-v</term>
<listitem>
<para>
Report the version number and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/etc/resolv.conf</filename></term>
<listitem>
<para>
The default configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>/var/run/lwresd.pid</filename></term>
<listitem>
<para>
The default process-id file.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry>
<refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>lwres</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>.
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para><corpauthor>Internet Systems Consortium</corpauthor>
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->