Merge branch 'vendor/TCPDUMP' (early part)
[dragonfly.git] / contrib / bind-9.3 / bin / named / lwresd.8
1 .\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
3 .\" 
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\" 
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14 .\" PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .\" $Id: lwresd.8,v 1.13.208.6 2006/06/29 13:02:30 marka Exp $
17 .\"
18 .hy 0
19 .ad l
20 .\"     Title: lwresd
21 .\"    Author: 
22 .\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
23 .\"      Date: June 30, 2000
24 .\"    Manual: BIND9
25 .\"    Source: BIND9
26 .\"
27 .TH "LWRESD" "8" "June 30, 2000" "BIND9" "BIND9"
28 .\" disable hyphenation
29 .nh
30 .\" disable justification (adjust text to left margin only)
31 .ad l
32 .SH "NAME"
33 lwresd \- lightweight resolver daemon
34 .SH "SYNOPSIS"
35 .HP 7
36 \fBlwresd\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\-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]
37 .SH "DESCRIPTION"
38 .PP
39 \fBlwresd\fR
40 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.
41 .PP
42 \fBlwresd\fR
43 listens for resolver queries on a UDP port on the IPv4 loopback interface, 127.0.0.1. This means that
44 \fBlwresd\fR
45 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.
46 .PP
47 Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol. When the DNS lookup completes,
48 \fBlwresd\fR
49 encodes the answers in the lightweight resolver format and returns them to the client that made the request.
50 .PP
51 If
52 \fI/etc/resolv.conf\fR
53 contains any
54 \fBnameserver\fR
55 entries,
56 \fBlwresd\fR
57 sends recursive DNS queries to those servers. This is similar to the use of forwarders in a caching name server. If no
58 \fBnameserver\fR
59 entries are present, or if forwarding fails,
60 \fBlwresd\fR
61 resolves the queries autonomously starting at the root name servers, using a built\-in list of root server hints.
62 .SH "OPTIONS"
63 .TP 3n
64 \-C \fIconfig\-file\fR
65 Use
66 \fIconfig\-file\fR
67 as the configuration file instead of the default,
68 \fI/etc/resolv.conf\fR.
69 .TP 3n
70 \-d \fIdebug\-level\fR
71 Set the daemon's debug level to
72 \fIdebug\-level\fR. Debugging traces from
73 \fBlwresd\fR
74 become more verbose as the debug level increases.
75 .TP 3n
76 \-f
77 Run the server in the foreground (i.e. do not daemonize).
78 .TP 3n
79 \-g
80 Run the server in the foreground and force all logging to
81 \fIstderr\fR.
82 .TP 3n
83 \-n \fI#cpus\fR
84 Create
85 \fI#cpus\fR
86 worker threads to take advantage of multiple CPUs. If not specified,
87 \fBlwresd\fR
88 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.
89 .TP 3n
90 \-P \fIport\fR
91 Listen for lightweight resolver queries on port
92 \fIport\fR. If not specified, the default is port 921.
93 .TP 3n
94 \-p \fIport\fR
95 Send DNS lookups to port
96 \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.
97 .TP 3n
98 \-s
99 Write memory usage statistics to
100 \fIstdout\fR
101 on exit.
102 .RS
103 .B "Note:"
104 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
105 .RE
106 .TP 3n
107 \-t \fIdirectory\fR
108 \fBchroot()\fR
109 to
110 \fIdirectory\fR
111 after processing the command line arguments, but before reading the configuration file.
112 .RS
113 .B "Warning:"
114 This option should be used in conjunction with the
115 \fB\-u\fR
116 option, as chrooting a process running as root doesn't enhance security on most systems; the way
117 \fBchroot()\fR
118 is defined allows a process with root privileges to escape a chroot jail.
119 .RE
120 .TP 3n
121 \-u \fIuser\fR
122 \fBsetuid()\fR
123 to
124 \fIuser\fR
125 after completing privileged operations, such as creating sockets that listen on privileged ports.
126 .TP 3n
127 \-v
128 Report the version number and exit.
129 .SH "FILES"
130 .TP 3n
131 \fI/etc/resolv.conf\fR
132 The default configuration file.
133 .TP 3n
134 \fI/var/run/lwresd.pid\fR
135 The default process\-id file.
136 .SH "SEE ALSO"
137 .PP
138 \fBnamed\fR(8),
139 \fBlwres\fR(3),
140 \fBresolver\fR(5).
141 .SH "AUTHOR"
142 .PP
143 Internet Systems Consortium
144 .SH "COPYRIGHT"
145 Copyright \(co 2004, 2005 Internet Systems Consortium, Inc. ("ISC")