Import bind 9.5.2 vendor sources.
[dragonfly.git] / contrib / bind-9.5.2 / bin / named / named.8
1 .\" Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
2 .\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
3 .\" 
4 .\" Permission to use, copy, modify, and/or 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: named.8,v 1.34.130.2 2009/07/11 01:43:29 tbox Exp $
17 .\"
18 .hy 0
19 .ad l
20 .\"     Title: named
21 .\"    Author: 
22 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
23 .\"      Date: June 30, 2000
24 .\"    Manual: BIND9
25 .\"    Source: BIND9
26 .\"
27 .TH "NAMED" "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 named \- Internet domain name server
34 .SH "SYNOPSIS"
35 .HP 6
36 \fBnamed\fR [\fB\-4\fR] [\fB\-6\fR] [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-S\ \fR\fB\fI#max\-socks\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-x\ \fR\fB\fIcache\-file\fR\fR]
37 .SH "DESCRIPTION"
38 .PP
39 \fBnamed\fR
40 is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC. For more information on the DNS, see RFCs 1033, 1034, and 1035.
41 .PP
42 When invoked without arguments,
43 \fBnamed\fR
44 will read the default configuration file
45 \fI/etc/named.conf\fR, read any initial data, and listen for queries.
46 .SH "OPTIONS"
47 .PP
48 \-4
49 .RS 4
50 Use IPv4 only even if the host machine is capable of IPv6.
51 \fB\-4\fR
52 and
53 \fB\-6\fR
54 are mutually exclusive.
55 .RE
56 .PP
57 \-6
58 .RS 4
59 Use IPv6 only even if the host machine is capable of IPv4.
60 \fB\-4\fR
61 and
62 \fB\-6\fR
63 are mutually exclusive.
64 .RE
65 .PP
66 \-c \fIconfig\-file\fR
67 .RS 4
68 Use
69 \fIconfig\-file\fR
70 as the configuration file instead of the default,
71 \fI/etc/named.conf\fR. To ensure that reloading the configuration file continues to work after the server has changed its working directory due to to a possible
72 \fBdirectory\fR
73 option in the configuration file,
74 \fIconfig\-file\fR
75 should be an absolute pathname.
76 .RE
77 .PP
78 \-d \fIdebug\-level\fR
79 .RS 4
80 Set the daemon's debug level to
81 \fIdebug\-level\fR. Debugging traces from
82 \fBnamed\fR
83 become more verbose as the debug level increases.
84 .RE
85 .PP
86 \-f
87 .RS 4
88 Run the server in the foreground (i.e. do not daemonize).
89 .RE
90 .PP
91 \-g
92 .RS 4
93 Run the server in the foreground and force all logging to
94 \fIstderr\fR.
95 .RE
96 .PP
97 \-m \fIflag\fR
98 .RS 4
99 Turn on memory usage debugging flags. Possible flags are
100 \fIusage\fR,
101 \fItrace\fR,
102 \fIrecord\fR,
103 \fIsize\fR, and
104 \fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in
105 \fI<isc/mem.h>\fR.
106 .RE
107 .PP
108 \-n \fI#cpus\fR
109 .RS 4
110 Create
111 \fI#cpus\fR
112 worker threads to take advantage of multiple CPUs. If not specified,
113 \fBnamed\fR
114 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.
115 .RE
116 .PP
117 \-p \fIport\fR
118 .RS 4
119 Listen for queries on port
120 \fIport\fR. If not specified, the default is port 53.
121 .RE
122 .PP
123 \-s
124 .RS 4
125 Write memory usage statistics to
126 \fIstdout\fR
127 on exit.
128 .RS
129 .B "Note:"
130 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
131 .RE
132 .RE
133 .PP
134 \-S \fI#max\-socks\fR
135 .RS 4
136 Allow
137 \fBnamed\fR
138 to use up to
139 \fI#max\-socks\fR
140 sockets.
141 .RS
142 .B "Warning:"
143 This option should be unnecessary for the vast majority of users. The use of this option could even be harmful because the specified value may exceed the limitation of the underlying system API. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets. Note also that the actual maximum number is normally a little fewer than the specified value because
144 \fBnamed\fR
145 reserves some file descriptors for its internal use.
146 .RE
147 .RE
148 .PP
149 \-t \fIdirectory\fR
150 .RS 4
151 Chroot to
152 \fIdirectory\fR
153 after processing the command line arguments, but before reading the configuration file.
154 .RS
155 .B "Warning:"
156 This option should be used in conjunction with the
157 \fB\-u\fR
158 option, as chrooting a process running as root doesn't enhance security on most systems; the way
159 \fBchroot(2)\fR
160 is defined allows a process with root privileges to escape a chroot jail.
161 .RE
162 .RE
163 .PP
164 \-u \fIuser\fR
165 .RS 4
166 Setuid to
167 \fIuser\fR
168 after completing privileged operations, such as creating sockets that listen on privileged ports.
169 .RS
170 .B "Note:"
171 On Linux,
172 \fBnamed\fR
173 uses the kernel's capability mechanism to drop all root privileges except the ability to
174 \fBbind(2)\fR
175 to a privileged port and set process resource limits. Unfortunately, this means that the
176 \fB\-u\fR
177 option only works when
178 \fBnamed\fR
179 is run on kernel 2.2.18 or later, or kernel 2.3.99\-pre3 or later, since previous kernels did not allow privileges to be retained after
180 \fBsetuid(2)\fR.
181 .RE
182 .RE
183 .PP
184 \-v
185 .RS 4
186 Report the version number and exit.
187 .RE
188 .PP
189 \-x \fIcache\-file\fR
190 .RS 4
191 Load data from
192 \fIcache\-file\fR
193 into the cache of the default view.
194 .RS
195 .B "Warning:"
196 This option must not be used. It is only of interest to BIND 9 developers and may be removed or changed in a future release.
197 .RE
198 .RE
199 .SH "SIGNALS"
200 .PP
201 In routine operation, signals should not be used to control the nameserver;
202 \fBrndc\fR
203 should be used instead.
204 .PP
205 SIGHUP
206 .RS 4
207 Force a reload of the server.
208 .RE
209 .PP
210 SIGINT, SIGTERM
211 .RS 4
212 Shut down the server.
213 .RE
214 .PP
215 The result of sending any other signals to the server is undefined.
216 .SH "CONFIGURATION"
217 .PP
218 The
219 \fBnamed\fR
220 configuration file is too complex to describe in detail here. A complete description is provided in the
221 BIND 9 Administrator Reference Manual.
222 .SH "FILES"
223 .PP
224 \fI/etc/named.conf\fR
225 .RS 4
226 The default configuration file.
227 .RE
228 .PP
229 \fI/var/run/named.pid\fR
230 .RS 4
231 The default process\-id file.
232 .RE
233 .SH "SEE ALSO"
234 .PP
235 RFC 1033,
236 RFC 1034,
237 RFC 1035,
238 \fBnamed\-checkconf\fR(8),
239 \fBnamed\-checkzone\fR(8),
240 \fBrndc\fR(8),
241 \fBlwresd\fR(8),
242 \fBnamed.conf\fR(5),
243 BIND 9 Administrator Reference Manual.
244 .SH "AUTHOR"
245 .PP
246 Internet Systems Consortium
247 .SH "COPYRIGHT"
248 Copyright \(co 2004\-2008 Internet Systems Consortium, Inc. ("ISC")
249 .br
250 Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
251 .br