~andreserl/ubuntu/lucid/bind9/bind9-apport-533601

« back to all changes in this revision

Viewing changes to bin/named/lwresd.8

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2006-01-05 12:29:28 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060105122928-oih7ttkkmpb90q8q
Tags: 1:9.3.2-1
* New upstream
* use lsb-base for start/stop messages in init.d.
* switch to debhelper 4

Show diffs side-by-side

added added

removed removed

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