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