lwresd.docbook revision 36d3f6b40f89cfc1be669377f6260639b53ed9c0
df46ff21c57d00f6addccaaf9b1484f2b56b8577pquerna - Copyright (C) 2000, 2001, 2004, 2005, 2007-2009, 2014-2017 Internet Systems Consortium, Inc. ("ISC")
3e9c0665b06e44cf776528c6954ed3ca34a77c7fsctemme - This Source Code Form is subject to the terms of the Mozilla Public
3e9c0665b06e44cf776528c6954ed3ca34a77c7fsctemme - License, v. 2.0. If a copy of the MPL was not distributed with this
3e9c0665b06e44cf776528c6954ed3ca34a77c7fsctemme - file, You can obtain one at http://mozilla.org/MPL/2.0/.
873c287c391b0bbc4719b68bb84946515811e1batrawick<!-- Converted by db4-upgrade version 1.0 -->
873c287c391b0bbc4719b68bb84946515811e1batrawick<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="man.lwresd">
d2696ac6757b3d8bdaa27634a141ac8c8a045e08fielding <refentryinfo>
d2696ac6757b3d8bdaa27634a141ac8c8a045e08fielding <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
d2696ac6757b3d8bdaa27634a141ac8c8a045e08fielding </refentryinfo>
d2696ac6757b3d8bdaa27634a141ac8c8a045e08fielding <refentrytitle><application>lwresd</application></refentrytitle>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <refnamediv>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem </refnamediv>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <copyright>
abb99af8aa7da2cb4c324133a4e10bd7a50f875erpluem <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem </copyright>
382d14411b582d97075a836190d74c778977505fcovener <refsynopsisdiv>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
06e6657fd0f376a16db696876f9bff5927cc3cb0trawick <arg choice="opt" rep="norepeat"><option>-C <replaceable class="parameter">config-file</replaceable></option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-f</option></arg>
0e9dae659943679108357054e9aa7657cdc52dc4minfrin <arg choice="opt" rep="norepeat"><option>-g</option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">pid-file</replaceable></option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">flag</replaceable></option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">port</replaceable></option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port</replaceable></option></arg>
d03aa31ada476d8eb97feaec2b1099809e7f3d57niq <arg choice="opt" rep="norepeat"><option>-s</option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">user</replaceable></option></arg>
a7757dd38bb2a1afc93e241b7ea67b3de85ecc8bminfrin <arg choice="opt" rep="norepeat"><option>-v</option></arg>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem <arg choice="opt" rep="norepeat"><option>-4</option></arg>
df46ff21c57d00f6addccaaf9b1484f2b56b8577pquerna <arg choice="opt" rep="norepeat"><option>-6</option></arg>
df46ff21c57d00f6addccaaf9b1484f2b56b8577pquerna </cmdsynopsis>
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem </refsynopsisdiv>
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq is the daemon providing name lookup
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem services to clients that use the BIND 9 lightweight resolver
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem library. It is essentially a stripped-down, caching-only name
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq server that answers queries using the BIND 9 lightweight
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem resolver protocol rather than the DNS protocol.
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem listens for resolver queries on a
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem UDP port on the IPv4 loopback interface, 127.0.0.1. This
0c26d213d85bc40fc05963c63bf670b42b352d25niq means that <command>lwresd</command> can only be used by
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem processes running on the local machine. By default, UDP port
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem number 921 is used for lightweight resolver requests and
92357fb76d3ad043e29ba2ba2041a7bdb8d13390niq responses.
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem Incoming lightweight resolver requests are decoded by the
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem server which then resolves them using the DNS protocol. When
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem the DNS lookup completes, <command>lwresd</command> encodes
f7cec4a86292b160401472286a17497ae0d4df18covener the answers in the lightweight resolver format and returns
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem them to the client that made the request.
abc69b39766c0de3eaf99e9016ea3f35e23c116drpluem If <filename>/etc/resolv.conf</filename> contains any
1464434c2c104e0ba224644c42552330f5158537covener <option>nameserver</option> entries, <command>lwresd</command>
8d574b3ac4185e4f71c8b9aae76e7122a78201c4rpluem sends recursive DNS queries to those servers. This is similar
8d574b3ac4185e4f71c8b9aae76e7122a78201c4rpluem to the use of forwarders in a caching name server. If no
8d574b3ac4185e4f71c8b9aae76e7122a78201c4rpluem <option>nameserver</option> entries are present, or if
7f4ac5a4cd99a9cae866b5908e358bd932736307chrisd forwarding fails, <command>lwresd</command> resolves the
92357fb76d3ad043e29ba2ba2041a7bdb8d13390niq queries autonomously starting at the root name servers, using
8d574b3ac4185e4f71c8b9aae76e7122a78201c4rpluem a built-in list of root server hints.
509111f5f58a9effd4c832f6a0cbd6ad9d549188jorton </refsection>
235b900b78cf6849f8344e377a91ded37d9cc9depquerna <variablelist>
66b8ec445dced7a2036bcd3b87b6fc3f08a1ab24jorton <varlistentry>
0e2a2eae9b72ac099aa25d7419e55af13b004be9minfrin Use IPv4 only even if the host machine is capable of IPv6.
0e2a2eae9b72ac099aa25d7419e55af13b004be9minfrin <option>-4</option> and <option>-6</option> are mutually
8d574b3ac4185e4f71c8b9aae76e7122a78201c4rpluem </listitem>
6f33babce8f8bc723f0b2c755aef049cd509504fpquerna </varlistentry>
0a12339f39799193ac6866fce812a1deb8f4a1abpquerna <varlistentry>
3fb118bc4e1a634f71c1fa509819ceac36c79dcbpquerna Use IPv6 only even if the host machine is capable of IPv4.
3fb118bc4e1a634f71c1fa509819ceac36c79dcbpquerna <option>-4</option> and <option>-6</option> are mutually
fb59af4ce3fcdd314b848359faeddf1e51bb24c5jim exclusive.
fb59af4ce3fcdd314b848359faeddf1e51bb24c5jim </listitem>
fb59af4ce3fcdd314b848359faeddf1e51bb24c5jim </varlistentry>
a91a59d0b0ceed7cd5621fe8757eda5ff6a043a8pquerna <!-- this is in source but not mentioned? does this matter? -->
a91a59d0b0ceed7cd5621fe8757eda5ff6a043a8pquerna <varlistentry>
a91a59d0b0ceed7cd5621fe8757eda5ff6a043a8pquerna <term>-c <replaceable class="parameter">config-file</replaceable></term>
a91a59d0b0ceed7cd5621fe8757eda5ff6a043a8pquerna Use <replaceable class="parameter">config-file</replaceable> as the
a91a59d0b0ceed7cd5621fe8757eda5ff6a043a8pquerna configuration file instead of the default,
a91a59d0b0ceed7cd5621fe8757eda5ff6a043a8pquerna <!-- Should this be an absolute path name? -->
a91a59d0b0ceed7cd5621fe8757eda5ff6a043a8pquerna <option>-c</option> can not be used with <option>-C</option>.
19e5deda3a29d71ac1cc4bfecce39f96ea3ab55dcovener </listitem>
19e5deda3a29d71ac1cc4bfecce39f96ea3ab55dcovener </varlistentry>
19e5deda3a29d71ac1cc4bfecce39f96ea3ab55dcovener <varlistentry>
19e5deda3a29d71ac1cc4bfecce39f96ea3ab55dcovener <term>-C <replaceable class="parameter">config-file</replaceable></term>
3ec1e3a35106ec4c8bcf8fae6a20cb623aed0b62pquerna Use <replaceable class="parameter">config-file</replaceable> as the
97f7daaffd9b6c1031302d7e551d5279fa0d0d72pquerna configuration file instead of the default,
97f7daaffd9b6c1031302d7e551d5279fa0d0d72pquerna <option>-C</option> can not be used with <option>-c</option>.
97f7daaffd9b6c1031302d7e551d5279fa0d0d72pquerna </listitem>
97f7daaffd9b6c1031302d7e551d5279fa0d0d72pquerna </varlistentry>
527fc83e2bf315b2026a9ac6b1e6ce83143609bbcovener <varlistentry>
527fc83e2bf315b2026a9ac6b1e6ce83143609bbcovener <term>-d <replaceable class="parameter">debug-level</replaceable></term>
99c8705f69fae71940ad9b091bd2f588a7b9f484minfrin Set the daemon's debug level to <replaceable class="parameter">debug-level</replaceable>.
99c8705f69fae71940ad9b091bd2f588a7b9f484minfrin Debugging traces from <command>lwresd</command> become
99c8705f69fae71940ad9b091bd2f588a7b9f484minfrin more verbose as the debug level increases.
9376e7dc573bb2721491c79b92f9c06fdfacebe6minfrin </listitem>
9376e7dc573bb2721491c79b92f9c06fdfacebe6minfrin </varlistentry>
9376e7dc573bb2721491c79b92f9c06fdfacebe6minfrin <varlistentry>
edaefb8bf78debc86ef7de441c7983d8b05517e1minfrin Run the server in the foreground (i.e. do not daemonize).
b5cbd7bc65a5c0eda246b0cd32e7d9ed124d66c4niq </listitem>
b5cbd7bc65a5c0eda246b0cd32e7d9ed124d66c4niq </varlistentry>
b5cbd7bc65a5c0eda246b0cd32e7d9ed124d66c4niq <varlistentry>
6ad55f63504cf5fe5205ed9495664519afeadcd9chrisd Run the server in the foreground and force all logging
809ec9d7cc8bc12d7dc6fafba24f3acad3e49d81chrisd </listitem>
809ec9d7cc8bc12d7dc6fafba24f3acad3e49d81chrisd </varlistentry>
809ec9d7cc8bc12d7dc6fafba24f3acad3e49d81chrisd <varlistentry>
f436f5cf34615c3c7d49dd229560ba658033f9eachrisd <term>-i <replaceable class="parameter">pid-file</replaceable></term>
ce6098001014d149e90e56ab0e89c1b4aab30136chrisd Use <replaceable class="parameter">pid-file</replaceable> as the
ce6098001014d149e90e56ab0e89c1b4aab30136chrisd PID file instead of the default,
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd </listitem>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd </varlistentry>
38b062650152074931a68e933461762c5e233cfcniq <varlistentry>
38b062650152074931a68e933461762c5e233cfcniq <term>-m <replaceable class="parameter">flag</replaceable></term>
38b062650152074931a68e933461762c5e233cfcniq <listitem>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Turn on memory usage debugging flags. Possible flags are
63de18ba5e922ffaab500317d7d1d0ad6b27b7e2covener <replaceable class="parameter">record</replaceable>,
91ef999a69527d2a64983681c92aaef9270697b4rpluem <replaceable class="parameter">size</replaceable>, and
91ef999a69527d2a64983681c92aaef9270697b4rpluem These correspond to the ISC_MEM_DEBUGXXXX flags described in
cf95511601acd18c75339ef5d90a298e070617ccminfrin </listitem>
cf95511601acd18c75339ef5d90a298e070617ccminfrin </varlistentry>
e82c197ca8872669af89367746826fe6b9955bb3niq <varlistentry>
e82c197ca8872669af89367746826fe6b9955bb3niq <term>-n <replaceable class="parameter">#cpus</replaceable></term>
baef4b5261d84ad9bacb2f4e745b33f35534c25aniq <listitem>
baef4b5261d84ad9bacb2f4e745b33f35534c25aniq Create <replaceable class="parameter">#cpus</replaceable> worker threads
baef4b5261d84ad9bacb2f4e745b33f35534c25aniq to take advantage of multiple CPUs. If not specified,
742ec45ed2ac00ab03080e898332352220cc1f13niq number of CPUs present and create one thread per CPU.
a5e068c4aa3d0084a41e178c7c0c1b1ae2f28125jim If it is unable to determine the number of CPUs, a
742ec45ed2ac00ab03080e898332352220cc1f13niq single worker thread will be created.
f82568a780e35e8786958c49a1259434e2088b9cniq </listitem>
f82568a780e35e8786958c49a1259434e2088b9cniq </varlistentry>
56b7c92bac48127bda06d80bf94952258f7e0bd3minfrin <varlistentry>
56b7c92bac48127bda06d80bf94952258f7e0bd3minfrin <term>-P <replaceable class="parameter">port</replaceable></term>
41abbbf0cbaef202fe1ba2dd671ea48990d6e012minfrin Listen for lightweight resolver queries on port
41abbbf0cbaef202fe1ba2dd671ea48990d6e012minfrin <replaceable class="parameter">port</replaceable>. If
6aa239b3d12f531ad9e305b1a81ad5fd671a3493minfrin not specified, the default is port 921.
6aa239b3d12f531ad9e305b1a81ad5fd671a3493minfrin </listitem>
6aa239b3d12f531ad9e305b1a81ad5fd671a3493minfrin </varlistentry>
d05e6175473332a8433e4ac85edda0d5a33c94b5minfrin <varlistentry>
d05e6175473332a8433e4ac85edda0d5a33c94b5minfrin <term>-p <replaceable class="parameter">port</replaceable></term>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq Send DNS lookups to port <replaceable class="parameter">port</replaceable>. If not
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq specified, the default is port 53. This provides a
13d29a334cfa69f2995b70a48aeacacc1ac7125frpluem way of testing the lightweight resolver daemon with a
13d29a334cfa69f2995b70a48aeacacc1ac7125frpluem name server that listens for queries on a non-standard
6951fc02abfd7642e45333902c14855836717fadrpluem port number.
6951fc02abfd7642e45333902c14855836717fadrpluem </listitem>
6951fc02abfd7642e45333902c14855836717fadrpluem </varlistentry>
aced0f6381ba4b9ec6ca8b9f9253f5aeb1a0b1actdonovan <varlistentry>
db455cbc662c98dbbf53175393c50086ff63370cchrisd Write memory usage statistics to <filename>stdout</filename>
7cb45b833e465d46f6b61de983cc68112587d04bchrisd This option is mainly of interest to BIND 9 developers
2e242dca7111f99d54dd144b7b8418d88d560032chrisd and may be removed or changed in a future release.
b5d91f803b61ef5b13666e423173eb72d96f8938niq </listitem>
b5d91f803b61ef5b13666e423173eb72d96f8938niq </varlistentry>
b6b1df87b7ce62620d48526a7ab630897cdaad90chrisd <varlistentry>
b6b1df87b7ce62620d48526a7ab630897cdaad90chrisd <term>-t <replaceable class="parameter">directory</replaceable></term>
b6b1df87b7ce62620d48526a7ab630897cdaad90chrisd <para>Chroot
b6b1df87b7ce62620d48526a7ab630897cdaad90chrisd to <replaceable class="parameter">directory</replaceable> after
4cf58054a85830c67dc23890ee613f62e1f7bdc8minfrin processing the command line arguments, but before
4cf58054a85830c67dc23890ee613f62e1f7bdc8minfrin reading the configuration file.
4cf58054a85830c67dc23890ee613f62e1f7bdc8minfrin This option should be used in conjunction with the
caaa32f2d2e3b28063c745c2632d3979da7f8326minfrin running as root doesn't enhance security on most
caaa32f2d2e3b28063c745c2632d3979da7f8326minfrin defined allows a process with root privileges to
66a8e1cc29cc4612cd938bc8fcabc0ef569e5769rpluem escape a chroot jail.
e02cb8f5090d904c054633ff33dfd1111e16e404minfrin </listitem>
e02cb8f5090d904c054633ff33dfd1111e16e404minfrin </varlistentry>
e02cb8f5090d904c054633ff33dfd1111e16e404minfrin <varlistentry>
8a3e2ef19ddfb8addcccdc61da0d1442695a8280rpluem <term>-u <replaceable class="parameter">user</replaceable></term>
8a3e2ef19ddfb8addcccdc61da0d1442695a8280rpluem <para>Setuid
213e520edc00641400771fc8f90b37a967a2d9ebdirkx to <replaceable class="parameter">user</replaceable> after completing
2ac474e42b9281e247e7082e30c50c5bef1f2cc3rjung privileged operations, such as creating sockets that
213e520edc00641400771fc8f90b37a967a2d9ebdirkx listen on privileged ports.
213e520edc00641400771fc8f90b37a967a2d9ebdirkx </listitem>
a449830d5caa5b9900fe64cc383658b3641f9810dirkx </varlistentry>
a449830d5caa5b9900fe64cc383658b3641f9810dirkx <varlistentry>
a449830d5caa5b9900fe64cc383658b3641f9810dirkx Report the version number and exit.
06d3a46db9574ad55b65fed36b856fee72bd71a7rpluem </listitem>
06d3a46db9574ad55b65fed36b856fee72bd71a7rpluem </varlistentry>
82632a19f2f9c346fee2b28a65920ba9737b3973minfrin </variablelist>
82632a19f2f9c346fee2b28a65920ba9737b3973minfrin </refsection>
0481ff0599c9e3c0c7ad5c1930939dcdac908582chrisd <variablelist>
835d676191444a46d695171e8760d55a66c60fecminfrin <varlistentry>
723f9f463f1922eaef3d24d00cb289e10daa73ffminfrin The default configuration file.
723f9f463f1922eaef3d24d00cb289e10daa73ffminfrin </listitem>
c2213b3a46a2666e2e7606ceec509cc4978f187fminfrin </varlistentry>
c2213b3a46a2666e2e7606ceec509cc4978f187fminfrin <varlistentry>
c2213b3a46a2666e2e7606ceec509cc4978f187fminfrin <term><filename>/var/run/lwresd.pid</filename></term>
d4562e99f620170ce0bedddc16887b900b34913bminfrin The default process-id file.
fd279fe992f7171dc3f6d4d40d6db5bb74f2d96eminfrin </listitem>
fd279fe992f7171dc3f6d4d40d6db5bb74f2d96eminfrin </varlistentry>
fed63d1b62cc7e56aad77b70ee5b5cc7f5c6aademinfrin </variablelist>
fed63d1b62cc7e56aad77b70ee5b5cc7f5c6aademinfrin </refsection>
abe0d0e38b9705f21a13ac8748bce1e3ed35e488minfrin <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
abe0d0e38b9705f21a13ac8748bce1e3ed35e488minfrin </citerefentry>,
abe0d0e38b9705f21a13ac8748bce1e3ed35e488minfrin <citerefentry>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <refentrytitle>lwres</refentrytitle><manvolnum>3</manvolnum>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin </citerefentry>,
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <citerefentry>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
a72211e92bab814bfa28ee086ca9b2a1a6095c92chrisd </citerefentry>.
a72211e92bab814bfa28ee086ca9b2a1a6095c92chrisd </refsection>