lwresd.html revision 02004b6ff1357b0b97147058d54b58e9f29d8452
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<!--
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - Copyright (C) 2000, 2001 Internet Software Consortium.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin -
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - Permission to use, copy, modify, and distribute this software for any
3e14f97f673e8a630f076077de35afdd43dc1587Roger A. Faulkner - purpose with or without fee is hereby granted, provided that the above
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - copyright notice and this permission notice appear in all copies.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin -
7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - PERFORMANCE OF THIS SOFTWARE.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin-->
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<!-- $Id: lwresd.html,v 1.14 2005/07/18 02:57:49 marka Exp $ -->
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<html>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<head>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<title>lwresd</title>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</head>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="id2456972"></a><div class="titlepage"></div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<div class="refnamediv">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<h2>Name</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<p><span class="application">lwresd</span> &#8212; lightweight resolver daemon</p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<div class="refsynopsisdiv">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<h2>Synopsis</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<div class="cmdsynopsis"><p><code class="command">lwresd</code> [<code class="option">-C <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>debug-level</code></em></code>] [<code class="option">-f</code>] [<code class="option">-g</code>] [<code class="option">-i <em class="replaceable"><code>pid-file</code></em></code>] [<code class="option">-n <em class="replaceable"><code>#cpus</code></em></code>] [<code class="option">-P <em class="replaceable"><code>port</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-s</code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>] [<code class="option">-v</code>]</p></div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<div class="refsect1" lang="en">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="id2514670"></a><h2>DESCRIPTION</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<p><span><strong class="command">lwresd</strong></span>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin is the daemon providing name lookup
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin services to clients that use the BIND 9 lightweight resolver
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin library. It is essentially a stripped-down, caching-only name
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin server that answers queries using the BIND 9 lightweight
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin resolver protocol rather than the DNS protocol.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<p><span><strong class="command">lwresd</strong></span>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin listens for resolver queries on a
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin UDP port on the IPv4 loopback interface, 127.0.0.1. This
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin means that <span><strong class="command">lwresd</strong></span> can only be used by
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin processes running on the local machine. By default UDP port
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin number 921 is used for lightweight resolver requests and
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin responses.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Incoming lightweight resolver requests are decoded by the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin server which then resolves them using the DNS protocol. When
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin the DNS lookup completes, <span><strong class="command">lwresd</strong></span> encodes
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin the answers in the lightweight resolver format and returns
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin them to the client that made the request.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin If <code class="filename">/etc/resolv.conf</code> contains any
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <code class="option">nameserver</code> entries, <span><strong class="command">lwresd</strong></span>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin sends recursive DNS queries to those servers. This is similar
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin to the use of forwarders in a caching name server. If no
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <code class="option">nameserver</code> entries are present, or if
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin forwarding fails, <span><strong class="command">lwresd</strong></span> resolves the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin queries autonomously starting at the root name servers, using
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin a built-in list of root server hints.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<div class="refsect1" lang="en">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="id2514717"></a><h2>OPTIONS</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<div class="variablelist"><dl>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dt><span class="term">-C <em class="replaceable"><code>config-file</code></em></span></dt>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dd><p>
Use <em class="replaceable"><code>config-file</code></em> as the
configuration file instead of the default,
<code class="filename">/etc/resolv.conf</code>.
</p></dd>
<dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt>
<dd><p>
Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>.
Debugging traces from <span><strong class="command">lwresd</strong></span> become
more verbose as the debug level increases.
</p></dd>
<dt><span class="term">-f</span></dt>
<dd><p>
Run the server in the foreground (i.e. do not daemonize).
</p></dd>
<dt><span class="term">-g</span></dt>
<dd><p>
Run the server in the foreground and force all logging
to <code class="filename">stderr</code>.
</p></dd>
<dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt>
<dd><p>
Create <em class="replaceable"><code>#cpus</code></em> worker threads
to take advantage of multiple CPUs. If not specified,
<span><strong class="command">lwresd</strong></span> 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.
</p></dd>
<dt><span class="term">-P <em class="replaceable"><code>port</code></em></span></dt>
<dd><p>
Listen for lightweight resolver queries on port
<em class="replaceable"><code>port</code></em>. If
not specified, the default is port 921.
</p></dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
<dd><p>
Send DNS lookups to port <em class="replaceable"><code>port</code></em>. 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.
</p></dd>
<dt><span class="term">-s</span></dt>
<dd>
<p>
Write memory usage statistics to <code class="filename">stdout</code>
on exit.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
This option is mainly of interest to BIND 9 developers
and may be removed or changed in a future release.
</p>
</div>
</dd>
<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
<dd>
<p><code class="function">chroot()</code>
to <em class="replaceable"><code>directory</code></em> after
processing the command line arguments, but before
reading the configuration file.
</p>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p>
This option should be used in conjunction with the
<code class="option">-u</code> option, as chrooting a process
running as root doesn't enhance security on most
systems; the way <code class="function">chroot()</code> is
defined allows a process with root privileges to
escape a chroot jail.
</p>
</div>
</dd>
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
<dd><p><code class="function">setuid()</code>
to <em class="replaceable"><code>user</code></em> after completing
privileged operations, such as creating sockets that
listen on privileged ports.
</p></dd>
<dt><span class="term">-v</span></dt>
<dd><p>
Report the version number and exit.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2515049"></a><h2>FILES</h2>
<div class="variablelist"><dl>
<dt><span class="term"><code class="filename">/etc/resolv.conf</code></span></dt>
<dd><p>
The default configuration file.
</p></dd>
<dt><span class="term"><code class="filename">/var/run/lwresd.pid</code></span></dt>
<dd><p>
The default process-id file.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2515089"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>,
<span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2515123"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div></body>
</html>