| blob | bec533f94fed9f8e473fa60d8e75215f28670862 |
1 .\" $NetBSD: named.8,v 1.7 2014/12/10 04:37:51 christos Exp $
2 .\"
3 .\" Copyright (C) 2004-2009, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
4 .\" Copyright (C) 2000, 2001, 2003 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: named
23 .\" Author:
24 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
25 .\" Date: February 19, 2014
26 .\" Manual: BIND9
27 .\" Source: BIND9
28 .\"
29 .TH "NAMED" "8" "February 19, 2014" "BIND9" "BIND9"
30 .\" disable hyphenation
31 .nh
32 .\" disable justification (adjust text to left margin only)
33 .ad l
34 .SH "NAME"
35 named \- Internet domain name server
36 .SH "SYNOPSIS"
37 .HP 6
38 \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\-D\ \fR\fB\fIstring\fR\fR] [\fB\-E\ \fR\fB\fIengine\-name\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\fI#listeners\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-V\fR] [\fB\-x\ \fR\fB\fIcache\-file\fR\fR]
39 .SH "DESCRIPTION"
40 .PP
41 \fBnamed\fR
42 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.
43 .PP
44 When invoked without arguments,
45 \fBnamed\fR
46 will read the default configuration file
47 \fI/etc/named.conf\fR, read any initial data, and listen for queries.
48 .SH "OPTIONS"
49 .PP
50 \-4
51 .RS 4
52 Use IPv4 only even if the host machine is capable of IPv6.
53 \fB\-4\fR
54 and
55 \fB\-6\fR
56 are mutually exclusive.
57 .RE
58 .PP
59 \-6
60 .RS 4
61 Use IPv6 only even if the host machine is capable of IPv4.
62 \fB\-4\fR
63 and
64 \fB\-6\fR
65 are mutually exclusive.
66 .RE
67 .PP
68 \-c \fIconfig\-file\fR
69 .RS 4
70 Use
71 \fIconfig\-file\fR
72 as the configuration file instead of the default,
73 \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
74 \fBdirectory\fR
75 option in the configuration file,
76 \fIconfig\-file\fR
77 should be an absolute pathname.
78 .RE
79 .PP
80 \-d \fIdebug\-level\fR
81 .RS 4
82 Set the daemon's debug level to
83 \fIdebug\-level\fR. Debugging traces from
84 \fBnamed\fR
85 become more verbose as the debug level increases.
86 .RE
87 .PP
88 \-D \fIstring\fR
89 .RS 4
90 Specifies a string that is used to identify a instance of
91 \fBnamed\fR
92 in a process listing. The contents of
93 \fIstring\fR
94 are not examined.
95 .RE
96 .PP
97 \-E \fIengine\-name\fR
98 .RS 4
99 When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing.
100 .sp
101 When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11".
102 .RE
103 .PP
104 \-f
105 .RS 4
106 Run the server in the foreground (i.e. do not daemonize).
107 .RE
108 .PP
109 \-g
110 .RS 4
111 Run the server in the foreground and force all logging to
112 \fIstderr\fR.
113 .RE
114 .PP
115 \-m \fIflag\fR
116 .RS 4
117 Turn on memory usage debugging flags. Possible flags are
118 \fIusage\fR,
119 \fItrace\fR,
120 \fIrecord\fR,
121 \fIsize\fR, and
122 \fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in
123 \fI<isc/mem.h>\fR.
124 .RE
125 .PP
126 \-n \fI#cpus\fR
127 .RS 4
128 Create
129 \fI#cpus\fR
130 worker threads to take advantage of multiple CPUs. If not specified,
131 \fBnamed\fR
132 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.
133 .RE
134 .PP
135 \-p \fIport\fR
136 .RS 4
137 Listen for queries on port
138 \fIport\fR. If not specified, the default is port 53.
139 .RE
140 .PP
141 \-s
142 .RS 4
143 Write memory usage statistics to
144 \fIstdout\fR
145 on exit.
146 .RS
147 .B "Note:"
148 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
149 .RE
150 .RE
151 .PP
152 \-S \fI#max\-socks\fR
153 .RS 4
154 Allow
155 \fBnamed\fR
156 to use up to
157 \fI#max\-socks\fR
158 sockets. The default value is 4096 on systems built with default configuration options, and 21000 on systems built with "configure \-\-with\-tuning=large".
159 .RS
160 .B "Warning:"
161 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
162 \fBnamed\fR
163 reserves some file descriptors for its internal use.
164 .RE
165 .RE
166 .PP
167 \-t \fIdirectory\fR
168 .RS 4
169 Chroot to
170 \fIdirectory\fR
171 after processing the command line arguments, but before reading the configuration file.
172 .RS
173 .B "Warning:"
174 This option should be used in conjunction with the
175 \fB\-u\fR
176 option, as chrooting a process running as root doesn't enhance security on most systems; the way
177 \fBchroot(2)\fR
178 is defined allows a process with root privileges to escape a chroot jail.
179 .RE
180 .RE
181 .PP
182 \-U \fI#listeners\fR
183 .RS 4
184 Use
185 \fI#listeners\fR
186 worker threads to listen for incoming UDP packets on each address. If not specified,
187 \fBnamed\fR
188 will calculate a default value based on the number of detected CPUs: 1 for 1 CPU, 2 for 2\-4 CPUs, and the number of detected CPUs divided by 2 for values higher than 4. If
189 \fB\-n\fR
190 has been set to a higher value than the number of detected CPUs, then
191 \fB\-U\fR
192 may be increased as high as that value, but no higher.
193 .RE
194 .PP
195 \-u \fIuser\fR
196 .RS 4
197 Setuid to
198 \fIuser\fR
199 after completing privileged operations, such as creating sockets that listen on privileged ports.
200 .RS
201 .B "Note:"
202 On Linux,
203 \fBnamed\fR
204 uses the kernel's capability mechanism to drop all root privileges except the ability to
205 \fBbind(2)\fR
206 to a privileged port and set process resource limits. Unfortunately, this means that the
207 \fB\-u\fR
208 option only works when
209 \fBnamed\fR
210 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
211 \fBsetuid(2)\fR.
212 .RE
213 .RE
214 .PP
215 \-v
216 .RS 4
217 Report the version number and exit.
218 .RE
219 .PP
220 \-V
221 .RS 4
222 Report the version number and build options, and exit.
223 .RE
224 .PP
225 \-x \fIcache\-file\fR
226 .RS 4
227 Load data from
228 \fIcache\-file\fR
229 into the cache of the default view.
230 .RS
231 .B "Warning:"
232 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.
233 .RE
234 .RE
235 .SH "SIGNALS"
236 .PP
237 In routine operation, signals should not be used to control the nameserver;
238 \fBrndc\fR
239 should be used instead.
240 .PP
241 SIGHUP
242 .RS 4
243 Force a reload of the server.
244 .RE
245 .PP
246 SIGINT, SIGTERM
247 .RS 4
248 Shut down the server.
249 .RE
250 .PP
251 The result of sending any other signals to the server is undefined.
252 .SH "CONFIGURATION"
253 .PP
254 The
255 \fBnamed\fR
256 configuration file is too complex to describe in detail here. A complete description is provided in the
257 BIND 9 Administrator Reference Manual.
258 .PP
259 \fBnamed\fR
260 inherits the
261 \fBumask\fR
262 (file creation mode mask) from the parent process. If files created by
263 \fBnamed\fR, such as journal files, need to have custom permissions, the
264 \fBumask\fR
265 should be set explicitly in the script used to start the
266 \fBnamed\fR
267 process.
268 .SH "FILES"
269 .PP
270 \fI/etc/named.conf\fR
271 .RS 4
272 The default configuration file.
273 .RE
274 .PP
275 \fI/var/run/named/named.pid\fR
276 .RS 4
277 The default process\-id file.
278 .RE
279 .SH "SEE ALSO"
280 .PP
281 RFC 1033,
282 RFC 1034,
283 RFC 1035,
284 \fBnamed\-checkconf\fR(8),
285 \fBnamed\-checkzone\fR(8),
286 \fBrndc\fR(8),
287 \fBlwresd\fR(8),
288 \fBnamed.conf\fR(5),
289 BIND 9 Administrator Reference Manual.
290 .SH "AUTHOR"
291 .PP
292 Internet Systems Consortium
293 .SH "COPYRIGHT"
294 Copyright \(co 2004\-2009, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
295 .br
296 Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
297 .br