etc/services - sync with NetBSD-8
[minix.git] / external / bsd / bind / dist / bin / named / lwresd.8
blobcbd45852cc6d7db9960b9a6b6ded9e02d36b66c7
1 .\"     $NetBSD: lwresd.8,v 1.5 2014/12/10 04:37:51 christos Exp $
2 .\"
3 .\" Copyright (C) 2004, 2005, 2007-2009, 2014 Internet Systems Consortium, Inc. ("ISC")
4 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
5 .\" 
6 .\" Permission to use, copy, modify, and/or distribute this software for any
7 .\" purpose with or without fee is hereby granted, provided that the above
8 .\" copyright notice and this permission notice appear in all copies.
9 .\" 
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
11 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
12 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
13 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
14 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
15 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16 .\" PERFORMANCE OF THIS SOFTWARE.
17 .\"
18 .\" Id
19 .\"
20 .hy 0
21 .ad l
22 .\"     Title: lwresd
23 .\"    Author: 
24 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
25 .\"      Date: January 20, 2009
26 .\"    Manual: BIND9
27 .\"    Source: BIND9
28 .\"
29 .TH "LWRESD" "8" "January 20, 2009" "BIND9" "BIND9"
30 .\" disable hyphenation
31 .nh
32 .\" disable justification (adjust text to left margin only)
33 .ad l
34 .SH "NAME"
35 lwresd \- lightweight resolver daemon
36 .SH "SYNOPSIS"
37 .HP 7
38 \fBlwresd\fR [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-C\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-i\ \fR\fB\fIpid\-file\fR\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-P\ \fR\fB\fIport\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-4\fR] [\fB\-6\fR]
39 .SH "DESCRIPTION"
40 .PP
41 \fBlwresd\fR
42 is the daemon providing name lookup services to clients that use the BIND 9 lightweight resolver library. It is essentially a stripped\-down, caching\-only name server that answers queries using the BIND 9 lightweight resolver protocol rather than the DNS protocol.
43 .PP
44 \fBlwresd\fR
45 listens for resolver queries on a UDP port on the IPv4 loopback interface, 127.0.0.1. This means that
46 \fBlwresd\fR
47 can only be used by processes running on the local machine. By default, UDP port number 921 is used for lightweight resolver requests and responses.
48 .PP
49 Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol. When the DNS lookup completes,
50 \fBlwresd\fR
51 encodes the answers in the lightweight resolver format and returns them to the client that made the request.
52 .PP
54 \fI/etc/resolv.conf\fR
55 contains any
56 \fBnameserver\fR
57 entries,
58 \fBlwresd\fR
59 sends recursive DNS queries to those servers. This is similar to the use of forwarders in a caching name server. If no
60 \fBnameserver\fR
61 entries are present, or if forwarding fails,
62 \fBlwresd\fR
63 resolves the queries autonomously starting at the root name servers, using a built\-in list of root server hints.
64 .SH "OPTIONS"
65 .PP
66 \-4
67 .RS 4
68 Use IPv4 only even if the host machine is capable of IPv6.
69 \fB\-4\fR
70 and
71 \fB\-6\fR
72 are mutually exclusive.
73 .RE
74 .PP
75 \-6
76 .RS 4
77 Use IPv6 only even if the host machine is capable of IPv4.
78 \fB\-4\fR
79 and
80 \fB\-6\fR
81 are mutually exclusive.
82 .RE
83 .PP
84 \-c \fIconfig\-file\fR
85 .RS 4
86 Use
87 \fIconfig\-file\fR
88 as the configuration file instead of the default,
89 \fI/etc/lwresd.conf\fR.
90 \fB\-c\fR
91 can not be used with
92 \fB\-C\fR.
93 .RE
94 .PP
95 \-C \fIconfig\-file\fR
96 .RS 4
97 Use
98 \fIconfig\-file\fR
99 as the configuration file instead of the default,
100 \fI/etc/resolv.conf\fR.
101 \fB\-C\fR
102 can not be used with
103 \fB\-c\fR.
106 \-d \fIdebug\-level\fR
107 .RS 4
108 Set the daemon's debug level to
109 \fIdebug\-level\fR. Debugging traces from
110 \fBlwresd\fR
111 become more verbose as the debug level increases.
115 .RS 4
116 Run the server in the foreground (i.e. do not daemonize).
120 .RS 4
121 Run the server in the foreground and force all logging to
122 \fIstderr\fR.
125 \-i \fIpid\-file\fR
126 .RS 4
128 \fIpid\-file\fR
129 as the PID file instead of the default,
130 \fI/var/run/lwresd/lwresd.pid\fR.
133 \-m \fIflag\fR
134 .RS 4
135 Turn on memory usage debugging flags. Possible flags are
136 \fIusage\fR,
137 \fItrace\fR,
138 \fIrecord\fR,
139 \fIsize\fR, and
140 \fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in
141 \fI<isc/mem.h>\fR.
144 \-n \fI#cpus\fR
145 .RS 4
146 Create
147 \fI#cpus\fR
148 worker threads to take advantage of multiple CPUs. If not specified,
149 \fBlwresd\fR
150 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.
153 \-P \fIport\fR
154 .RS 4
155 Listen for lightweight resolver queries on port
156 \fIport\fR. If not specified, the default is port 921.
159 \-p \fIport\fR
160 .RS 4
161 Send DNS lookups to port
162 \fIport\fR. 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.
166 .RS 4
167 Write memory usage statistics to
168 \fIstdout\fR
169 on exit.
171 .B "Note:"
172 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
176 \-t \fIdirectory\fR
177 .RS 4
178 Chroot to
179 \fIdirectory\fR
180 after processing the command line arguments, but before reading the configuration file.
182 .B "Warning:"
183 This option should be used in conjunction with the
184 \fB\-u\fR
185 option, as chrooting a process running as root doesn't enhance security on most systems; the way
186 \fBchroot(2)\fR
187 is defined allows a process with root privileges to escape a chroot jail.
191 \-u \fIuser\fR
192 .RS 4
193 Setuid to
194 \fIuser\fR
195 after completing privileged operations, such as creating sockets that listen on privileged ports.
199 .RS 4
200 Report the version number and exit.
202 .SH "FILES"
204 \fI/etc/resolv.conf\fR
205 .RS 4
206 The default configuration file.
209 \fI/var/run/lwresd.pid\fR
210 .RS 4
211 The default process\-id file.
213 .SH "SEE ALSO"
215 \fBnamed\fR(8),
216 \fBlwres\fR(3),
217 \fBresolver\fR(5).
218 .SH "AUTHOR"
220 Internet Systems Consortium
221 .SH "COPYRIGHT"
222 Copyright \(co 2004, 2005, 2007\-2009, 2014 Internet Systems Consortium, Inc. ("ISC")
224 Copyright \(co 2000, 2001 Internet Software Consortium.