~ubuntu-branches/ubuntu/karmic/pdnsd/karmic

« back to all changes in this revision

Viewing changes to debian/pdnsd.8

  • Committer: Bazaar Package Importer
  • Author(s): Pierre Habouzit
  • Date: 2008-10-05 09:54:52 UTC
  • mfrom: (4.1.4 intrepid)
  • Revision ID: james.westby@ubuntu.com-20081005095452-wc58cmdofvyipcv3
Tags: 1.2.6-par-10
* Add patches/0005-fix-for-CVE-2008-4194.patch for CVE-2008-4194.
  (Closes: #500910).
* Document where the two default configuration are in README.Debian
  (Closes: #499984).
* Update turkish translation thanks to Mert Dirik (Closes: #490047).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "PDNSD" "8"  "May 2004" "pdnsd 1.1.10\-par" "System Administration Commands"
2
 
 
3
 
.SH NAME
4
 
\fBpdnsd\fP \- proxy DNS daemon
5
 
 
6
 
.SH SYNOPSIS
7
 
 
8
 
\fBpdnsd\fP [\-h] [\-V] [\-s] [\-d] [\-g] [\-v\fIn\fR] [\-m\fIxx\fR] [\-c \fIfile\fR] [\-4] [\-6]
9
 
 
10
 
.SH DESCRIPTION
11
 
.PP
12
 
\fBpdnsd\fP is an IPv6 capable proxy domain name system (DNS) server
13
 
which caches the results of DNS lookups to disk.
14
 
 
15
 
.SH OPTIONS
16
 
 
17
 
.RS
18
 
.TP
19
 
\fB\-4\fP
20
 
enables IPv4 support. IPv6 support is automatically
21
 
disabled (should it be available). On by default. 
22
 
.TP
23
 
\fB\-6\fP
24
 
enables IPv6 support. IPv4 support is automatically
25
 
disabled (should it be available). Off by default.
26
 
.TP
27
 
\fB\-V\fP, \fB\-\-version\fP
28
 
Print version information and exit.
29
 
.TP
30
 
\fB\-c\fP, \fB\-\-config\-file\fP \fIFILE\fP
31
 
Read configuration from \fIFILE\fP.
32
 
The default is \fI/etc/pdnsd.conf\fP.
33
 
.TP
34
 
\fB\-d\fP, \fB\-\-daemon\fP
35
 
Start \fBpdnsd\fP in daemon mode (i.e., as a background process).
36
 
.TP
37
 
\fB\-g\fP, \fB\-\-debug\fP
38
 
Print debug messages on the console (in non-daemon mode)
39
 
or to the file \fIpdnsd.debug\fP in the cache directory
40
 
(in daemon mode).
41
 
.TP
42
 
\fB\-h\fP, \fB\-\-help\fP
43
 
Print help and exit.
44
 
.TP
45
 
\fB\-p\fP \fIPIDFILE\fP
46
 
While running store the process ID of the parent
47
 
.B pdnsd
48
 
process in \fIPIDFILE\fP.
49
 
.TP
50
 
\fB\-\-pdnsd\-user\fP
51
 
Print the user as whom \fBpdnsd\fP will run and exit.
52
 
.TP
53
 
\fB\-s\fP, \fB\-\-status\fP
54
 
Enable the status control socket.
55
 
This option must be passed to the command line if you want
56
 
to use
57
 
.BR pdnsd\-ctl (9)
58
 
to control \fBpdnsd\fP at run time.
59
 
.TP
60
 
\fB\-t\fP, \fB\-\-tcp\fP
61
 
Enable the TCP server thread.
62
 
\fBpdnsd\fP will then serve TCP and UDP queries.
63
 
.TP
64
 
\fB\-v\fP\fIn\fP
65
 
Set the verbosity of \fBpdnsd\fP.
66
 
\fIn\fP is a numeric argument between 0 (normal operation)
67
 
and 3 (many messages for debugging).
68
 
.TP
69
 
\fB\-m\fP\fIxx\fP
70
 
Set the query method \fBpdnsd\fP uses.
71
 
Possible values for \fIxx\fP are:
72
 
.IP
73
 
.B
74
 
to
75
 
\- pdnsd will use TCP only. TCP queries usually take longer time than
76
 
UDP queries, but are more secure against certain attacks, where an
77
 
attacker tries to guess your query id and to send forged answers. TCP
78
 
queries are not supported by some name servers.
79
 
 
80
 
.IP
81
 
.B
82
 
tu
83
 
\- pdnsd will try to use TCP, and will fall back to UDP if its
84
 
connection is refused. 
85
 
 
86
 
.IP
87
 
.B
88
 
uo
89
 
\- pdnsd will use UDP only. This is the fastest method, and should
90
 
be supported by all name servers on the Internet. 
91
 
 
92
 
.PP
93
 
Additionally, \fBno\fP can be prepended to the
94
 
.BR \-\-status ,
95
 
.BR \-\-daemon ,
96
 
.BR \-\-debug and \-\-tcp
97
 
options (e.g.
98
 
.BR \-\-notcp )
99
 
to reverse their effect.
100
 
.RE
101
 
 
102
 
.SH USAGE
103
 
.PP
104
 
\fBpdnsd\fP is usually run from an init script.
105
 
 
106
 
For \fBpdnsd\fP to work, You need to do two things.
107
 
 
108
 
.IP
109
 
1. Tell your system to use \fBpdnsd\fP as the primary DNS server.
110
 
.PP
111
 
To do this, put the following line in \fI/etc/resolv.conf\fP
112
 
.PP
113
 
.RS
114
 
nameserver 127.0.0.X
115
 
.RE
116
 
.PP
117
 
where X can be any number. (I use 3).
118
 
This line should precede all other \fBnameserver\fP lines.
119
 
You should put the same value in the \fBserver_ip=\fP line in the
120
 
\fBglobal\fP section of \fI/etc/pdnsd.conf\fP.
121
 
.RE
122
 
 
123
 
.IP
124
 
2. Tell \fBpdnsd\fP where to get DNS information.
125
 
 
126
 
.PP
127
 
To tell \fBpdnsd\fP where to get DNS information, add the
128
 
following lines in \fI/etc/pdnsd.conf\fP:
129
 
 
130
 
.PP
131
 
.RS
132
 
server {
133
 
        ip="123.123.123.123"; /* Put your ISP's DNS server address here */
134
 
        timeout=60;
135
 
        interval=900;
136
 
        uptest=none;
137
 
        ping_timeout=500;
138
 
        purge_cache=off;
139
 
        caching=on;
140
 
  }
141
 
.RE
142
 
.PP
143
 
Note the opening and closing braces.
144
 
You can add another \fBserver\fP section
145
 
for each DNS server you want \fBpdnsd\fP to query.
146
 
 
147
 
.PP
148
 
Note that interface configurers sometimes replace
149
 
\fI/etc/resolv.conf\fP when an interface is brought up.
150
 
You need to disable such features.
151
 
If you use pppconfig, for example, you specify `none' in the
152
 
`nameservers' option  in the `advanced' tab.
153
 
If you use multiple ISPs, you should do this for
154
 
each connection/account.
155
 
 
156
 
.PP
157
 
Note that if you have the
158
 
.B resolvconf
159
 
package installed and properly configured and you have 
160
 
.PP
161
 
.RS
162
 
server {
163
 
    label="resolvconf";
164
 
  }
165
 
.RE
166
 
.PP
167
 
in \fI/etc/pdnsd.conf\fP then both \fI/etc/resolv.conf\fP and
168
 
.BR pdnsd 's
169
 
nameserver list will be updated automatically.
170
 
 
171
 
.SH FILES
172
 
 
173
 
\fI/etc/init.d/pdnsd\fP
174
 
.PP
175
 
\fI/etc/pdnsd.conf\fP
176
 
.PP
177
 
\fI/etc/resolv.conf\fP
178
 
.PP
179
 
\fI/etc/defaults/pdnsd\fP contains additional parameters or options 
180
 
which may be passed to pdnsd at boot time. This saves the hassle of 
181
 
fiddling with initscripts.
182
 
 
183
 
.SH BUGS
184
 
.PP
185
 
Report bugs to the authors.
186
 
 
187
 
.SH CONFORMING TO
188
 
.PP
189
 
\fBpdnsd\fP should comply with RFCs 1034 and 1035. As of version
190
 
1.0.0, RFC compliance has been improved and pdnsd is now believed (or
191
 
hoped?)  to be fully RFC compatible. It completely follows RFC 2181
192
 
(except for one minor issue in the FreeBSD port, see the
193
 
documentation).
194
 
.PP
195
 
It does \fINOT\fP support the following features, of which most are
196
 
marked optional, experimental or obsolete in these RFCs:
197
 
 
198
 
 
199
 
.IP
200
 
\(bu Inverse queries
201
 
.IP
202
 
\(bu Status queries
203
 
.IP
204
 
\(bu Completion queries
205
 
.IP
206
 
\(bu Namespaces other than IN (Internet)
207
 
.IP
208
 
\(bu AXFR and IXFR queries (whole zone transfers); since pdnsd does not maintain zones, that should not violate the standard  
209
 
 
210
 
.PP
211
 
The following record types, that are extensions to the original DNS
212
 
standard, are supported if given as options at compile time. (if you
213
 
do not need them, you do not need to compile support for them into
214
 
pdnsd and save cache and executable space):
215
 
 
216
 
.IP
217
 
\(bu RP (responsible person, RFC 1183)
218
 
.IP
219
 
\(bu AFSDB (AFS database location, RFC 1183)
220
 
.IP
221
 
\(bu X25 (X25 address, RFC 1183)
222
 
.IP
223
 
\(bu ISDN (ISDN number/address, RFC 1183)
224
 
.IP
225
 
\(bu RT (route through, RFC 1183)
226
 
.IP
227
 
\(bu NSAP (Network Service Access Protocol address , RFC 1348)
228
 
.IP
229
 
\(bu PX (X.400/RFC822 mapping information, RFC 1995)
230
 
.IP
231
 
\(bu GPOS (geographic position, deprecated)
232
 
.IP
233
 
\(bu AAAA (IPv6 address, RFC 1886)
234
 
.IP
235
 
\(bu LOC (location, RFC 1876)
236
 
.IP
237
 
\(bu EID (Nimrod EID)
238
 
.IP
239
 
\(bu NIMLOC (Nimrod locator)
240
 
.IP
241
 
\(bu SRV (service record, RFC 2052)
242
 
.IP
243
 
\(bu ATMA (ATM address)
244
 
.IP
245
 
\(bu NAPTR (URI mapping, RFC 2168)
246
 
.IP
247
 
\(bu KX (key exchange, RFC 2230)
248
 
 
249
 
.SH SEE ALSO
250
 
.PP
251
 
.BR pdnsd\-ctl(8),
252
 
.BR pppconfig(8),
253
 
.BR resolv.conf(5)
254
 
.PP
255
 
More documentation is available in the \fI/usr/share/doc/pdnsd/\fP directory.
256
 
 
257
 
.SH AUTHORS
258
 
 
259
 
\fBpdnsd\fP was originally written by Thomas Moestl,
260
 
.UR
261
 
<tmoestl@gmx.net>,
262
 
.UE
263
 
and was extensively revised by Paul Rombouts
264
 
.UR
265
 
<p.a.rombouts@home.nl>
266
 
.UE
267
 
(for versions 1.1.10\-par and later).
268
 
.PP
269
 
Several others have contributed to \fBpdnsd\fP; see files in the
270
 
\fI/usr/share/doc/pdnsd/\fP directory.
271
 
.PP
272
 
This man page was written by Mahesh T. Pai
273
 
.UR
274
 
<paivakil@yahoo.co.in>
275
 
.UE
276
 
using the documents in \fI/usr/share/docs/pdnsd/\fP directory for Debian,
277
 
but can be used on other distributions too. 
278
 
.PP
279
 
 
280
 
.SH COPYRIGHT
281
 
 
282
 
.PP
283
 
This man page is a part of the pdnsd package, and may be distributed
284
 
in original or modified form under terms of the GNU General Public
285
 
License, as published by the Free Software Foundation; either version
286
 
2, or (at your option) any later version.
287
 
 
288
 
.PP
289
 
You can find a copy of the GNU GPL in
290
 
the\fI/usr/share/common\-licenses/\fP directory if you are using a
291
 
Debian system.