lwresd.docbook revision dafcb997e390efa4423883dafd100c975c4095d6
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi<!--
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - Copyright (C) 2000, 2001 Internet Software Consortium.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi -
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - Permission to use, copy, modify, and distribute this software for any
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - purpose with or without fee is hereby granted, provided that the above
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - copyright notice and this permission notice appear in all copies.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi -
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi - PERFORMANCE OF THIS SOFTWARE.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi-->
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi<!-- $Id: lwresd.docbook,v 1.7 2004/03/05 04:57:48 marka Exp $ -->
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi<refentry>
a5ba96715d4ef264c43d4f187251de491ba198c0KATOH Yasufumi <refentryinfo>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <date>June 30, 2000</date>
8900b9eb2514c07047541833286428572493a9fdStéphane Graber </refentryinfo>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <refmeta>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <refentrytitle><application>lwresd</application></refentrytitle>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <manvolnum>8</manvolnum>
faefa7f8584a7d1567df2e6f1f9240a28a6466abStéphane Graber <refmiscinfo>BIND9</refmiscinfo>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </refmeta>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <refnamediv>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <refname><application>lwresd</application></refname>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <refpurpose>lightweight resolver daemon</refpurpose>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </refnamediv>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <refsynopsisdiv>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <cmdsynopsis>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <command>lwresd</command>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-C <replaceable class="parameter">config-file</replaceable></option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-f</option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-g</option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-i <replaceable class="parameter">pid-file</replaceable></option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-P <replaceable class="parameter">port</replaceable></option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-s</option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <arg><option>-v</option></arg>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </cmdsynopsis>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </refsynopsisdiv>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <refsect1>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <title>DESCRIPTION</title>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <command>lwresd</command> is the daemon providing name lookup
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi services to clients that use the BIND 9 lightweight resolver
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi library. It is essentially a stripped-down, caching-only name
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi server that answers queries using the BIND 9 lightweight
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi resolver protocol rather than the DNS protocol.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <command>lwresd</command> listens for resolver queries on a
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi UDP port on the IPv4 loopback interface, 127.0.0.1. This
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi means that <command>lwresd</command> can only be used by
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi processes running on the local machine. By default UDP port
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi number 921 is used for lightweight resolver requests and
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi responses.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi Incoming lightweight resolver requests are decoded by the
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi server which then resolves them using the DNS protocol. When
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi the DNS lookup completes, <command>lwresd</command> encodes
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi the answers in the lightweight resolver format and returns
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi them to the client that made the request.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi If <filename>/etc/resolv.conf</filename> contains any
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <option>nameserver</option> entries, <command>lwresd</command>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi sends recursive DNS queries to those servers. This is similar
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi to the use of forwarders in a caching name server. If no
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <option>nameserver</option> entries are present, or if
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi forwarding fails, <command>lwresd</command> resolves the
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi queries autonomously starting at the root name servers, using
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi a built-in list of root server hints.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </refsect1>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <refsect1>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <title>OPTIONS</title>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <variablelist>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <varlistentry>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <term>-C <replaceable class="parameter">config-file</replaceable></term>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <listitem>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi Use <replaceable
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi class="parameter">config-file</replaceable> as the
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi configuration file instead of the default,
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <filename>/etc/resolv.conf</filename>.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </listitem>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </varlistentry>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <varlistentry>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <term>-d <replaceable class="parameter">debug-level</replaceable></term>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <listitem>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi Set the daemon's debug level to <replaceable
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi class="parameter">debug-level</replaceable>.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi Debugging traces from <command>lwresd</command> become
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi more verbose as the debug level increases.
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </listitem>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </varlistentry>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <varlistentry>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <term>-f</term>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <listitem>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi <para>
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi Run the server in the foreground (i.e. do not daemonize).
57da8c32f85c0255efa61ee32e260068afdaa565KATOH Yasufumi </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 Software Consortium</corpauthor>
</para>
</refsect1>
</refentry>
<!--
- Local variables:
- mode: sgml
- End:
-->