36d3f6b40f89cfc1be669377f6260639b53ed9c0Tinderbox User - Copyright (C) 2000, 2001, 2004, 2005, 2007-2009, 2014-2017 Internet Systems Consortium, Inc. ("ISC")
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - This Source Code Form is subject to the terms of the Mozilla Public
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - License, v. 2.0. If a copy of the MPL was not distributed with this
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - file, You can obtain one at http://mozilla.org/MPL/2.0/.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!-- Converted by db4-upgrade version 1.0 -->
83a28ca274521e15086fc39febde507bcc4e145eMark Andrews<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="man.lwresd">
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refentryinfo>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refentryinfo>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refentrytitle><application>lwresd</application></refentrytitle>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refnamediv>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refname><application>lwresd</application></refname>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refpurpose>lightweight resolver daemon</refpurpose>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refsynopsisdiv>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-C <replaceable class="parameter">config-file</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-f</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-g</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">pid-file</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">flag</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">port</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-s</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">user</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-v</option></arg>
b7a823a402eb5c4e99f283e58d778a903d2e72f5Michał Kępień <arg choice="opt" rep="norepeat"><option>-4</option></arg>
b7a823a402eb5c4e99f283e58d778a903d2e72f5Michał Kępień <arg choice="opt" rep="norepeat"><option>-6</option></arg>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </cmdsynopsis>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refsynopsisdiv>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refsection><info><title>DESCRIPTION</title></info>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is the daemon providing name lookup
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein services to clients that use the BIND 9 lightweight resolver
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein library. It is essentially a stripped-down, caching-only name
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein server that answers queries using the BIND 9 lightweight
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein resolver protocol rather than the DNS protocol.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein listens for resolver queries on a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein UDP port on the IPv4 loopback interface, 127.0.0.1. This
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein means that <command>lwresd</command> can only be used by
f9f11eb54be19b7deedf3978496f71d81432a5eeJeremy Reed processes running on the local machine. By default, UDP port
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein number 921 is used for lightweight resolver requests and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Incoming lightweight resolver requests are decoded by the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein server which then resolves them using the DNS protocol. When
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein the DNS lookup completes, <command>lwresd</command> encodes
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein the answers in the lightweight resolver format and returns
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein them to the client that made the request.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If <filename>/etc/resolv.conf</filename> contains any
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <option>nameserver</option> entries, <command>lwresd</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein sends recursive DNS queries to those servers. This is similar
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein to the use of forwarders in a caching name server. If no
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <option>nameserver</option> entries are present, or if
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein forwarding fails, <command>lwresd</command> resolves the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein queries autonomously starting at the root name servers, using
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein a built-in list of root server hints.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <variablelist>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <varlistentry>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews Use IPv4 only even if the host machine is capable of IPv6.
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <option>-4</option> and <option>-6</option> are mutually
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews </varlistentry>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <varlistentry>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews Use IPv6 only even if the host machine is capable of IPv4.
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <option>-4</option> and <option>-6</option> are mutually
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews </varlistentry>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <!-- this is in source but not mentioned? does this matter? -->
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <varlistentry>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <term>-c <replaceable class="parameter">config-file</replaceable></term>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews Use <replaceable class="parameter">config-file</replaceable> as the
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews configuration file instead of the default,
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <!-- Should this be an absolute path name? -->
48a866144e3b14efa6c51af05ef7641b23c7516dJeremy Reed <option>-c</option> can not be used with <option>-C</option>.
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <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,
48a866144e3b14efa6c51af05ef7641b23c7516dJeremy Reed <option>-C</option> can not be used with <option>-c</option>.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <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>lwresd</command> become
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein more verbose as the debug level increases.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Run the server in the foreground (i.e. do not daemonize).
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Run the server in the foreground and force all logging
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <varlistentry>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <term>-i <replaceable class="parameter">pid-file</replaceable></term>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews Use <replaceable class="parameter">pid-file</replaceable> as the
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews PID file instead of the default,
f6f1672b4e460571c418e43ae3bd0fae97e4c149Mark Andrews <filename>/var/run/lwresd/lwresd.pid</filename>.
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews </varlistentry>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <varlistentry>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <term>-m <replaceable class="parameter">flag</replaceable></term>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews Turn on memory usage debugging flags. Possible flags are
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <replaceable class="parameter">usage</replaceable>,
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <replaceable class="parameter">trace</replaceable>,
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <replaceable class="parameter">record</replaceable>,
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <replaceable class="parameter">size</replaceable>, and
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews <replaceable class="parameter">mctx</replaceable>.
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews These correspond to the ISC_MEM_DEBUGXXXX flags described in
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <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>lwresd</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.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-P <replaceable class="parameter">port</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Listen for lightweight resolver queries on port
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <replaceable class="parameter">port</replaceable>. If
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein not specified, the default is port 921.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-p <replaceable class="parameter">port</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Send DNS lookups to port <replaceable class="parameter">port</replaceable>. If not
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein specified, the default is port 53. This provides a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein way of testing the lightweight resolver daemon with a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein name server that listens for queries on a non-standard
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein port number.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Write memory usage statistics to <filename>stdout</filename>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This option is mainly of interest to BIND 9 developers
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and may be removed or changed in a future release.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-t <replaceable class="parameter">directory</replaceable></term>
561a29af8c54a216e7d30b5b4f6e0d21661654ecMark Andrews <para>Chroot
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein to <replaceable class="parameter">directory</replaceable> after
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein processing the command line arguments, but before
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein reading the configuration file.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This option should be used in conjunction with the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <option>-u</option> option, as chrooting a process
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein running as root doesn't enhance security on most
561a29af8c54a216e7d30b5b4f6e0d21661654ecMark Andrews systems; the way <function>chroot(2)</function> is
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein defined allows a process with root privileges to
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein escape a chroot jail.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-u <replaceable class="parameter">user</replaceable></term>
561a29af8c54a216e7d30b5b4f6e0d21661654ecMark Andrews <para>Setuid
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein to <replaceable class="parameter">user</replaceable> after completing
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein privileged operations, such as creating sockets that
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein listen on privileged ports.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Report the version number and exit.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </variablelist>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <variablelist>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><filename>/etc/resolv.conf</filename></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The default configuration file.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><filename>/var/run/lwresd.pid</filename></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The default process-id file.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </varlistentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </variablelist>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>lwres</refentrytitle><manvolnum>3</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>