| blob | f899415ad9db34e37442d93d5658578298250205 |
1 .\" $NetBSD$
2 .\"
3 .\" Copyright (C) 2004-2009 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: named.8,v 1.41 2009/10/06 01:14:41 tbox Exp
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: May 21, 2009
26 .\" Manual: BIND9
27 .\" Source: BIND9
28 .\"
29 .TH "NAMED" "8" "May 21, 2009" "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\-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\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 \-E \fIengine\-name\fR
89 .RS 4
90 Use a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance re\-signing with private keys from a secure key store. When compiled with PKCS#11 support
91 \fIengine\-name\fR
92 defaults to pkcs11, the empty name resets it to no engine.
93 .RE
94 .PP
95 \-f
96 .RS 4
97 Run the server in the foreground (i.e. do not daemonize).
98 .RE
99 .PP
100 \-g
101 .RS 4
102 Run the server in the foreground and force all logging to
103 \fIstderr\fR.
104 .RE
105 .PP
106 \-m \fIflag\fR
107 .RS 4
108 Turn on memory usage debugging flags. Possible flags are
109 \fIusage\fR,
110 \fItrace\fR,
111 \fIrecord\fR,
112 \fIsize\fR, and
113 \fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in
114 \fI<isc/mem.h>\fR.
115 .RE
116 .PP
117 \-n \fI#cpus\fR
118 .RS 4
119 Create
120 \fI#cpus\fR
121 worker threads to take advantage of multiple CPUs. If not specified,
122 \fBnamed\fR
123 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.
124 .RE
125 .PP
126 \-p \fIport\fR
127 .RS 4
128 Listen for queries on port
129 \fIport\fR. If not specified, the default is port 53.
130 .RE
131 .PP
132 \-s
133 .RS 4
134 Write memory usage statistics to
135 \fIstdout\fR
136 on exit.
137 .RS
138 .B "Note:"
139 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
140 .RE
141 .RE
142 .PP
143 \-S \fI#max\-socks\fR
144 .RS 4
145 Allow
146 \fBnamed\fR
147 to use up to
148 \fI#max\-socks\fR
149 sockets.
150 .RS
151 .B "Warning:"
152 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
153 \fBnamed\fR
154 reserves some file descriptors for its internal use.
155 .RE
156 .RE
157 .PP
158 \-t \fIdirectory\fR
159 .RS 4
160 Chroot to
161 \fIdirectory\fR
162 after processing the command line arguments, but before reading the configuration file.
163 .RS
164 .B "Warning:"
165 This option should be used in conjunction with the
166 \fB\-u\fR
167 option, as chrooting a process running as root doesn't enhance security on most systems; the way
168 \fBchroot(2)\fR
169 is defined allows a process with root privileges to escape a chroot jail.
170 .RE
171 .RE
172 .PP
173 \-u \fIuser\fR
174 .RS 4
175 Setuid to
176 \fIuser\fR
177 after completing privileged operations, such as creating sockets that listen on privileged ports.
178 .RS
179 .B "Note:"
180 On Linux,
181 \fBnamed\fR
182 uses the kernel's capability mechanism to drop all root privileges except the ability to
183 \fBbind(2)\fR
184 to a privileged port and set process resource limits. Unfortunately, this means that the
185 \fB\-u\fR
186 option only works when
187 \fBnamed\fR
188 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
189 \fBsetuid(2)\fR.
190 .RE
191 .RE
192 .PP
193 \-v
194 .RS 4
195 Report the version number and exit.
196 .RE
197 .PP
198 \-V
199 .RS 4
200 Report the version number and build options, and exit.
201 .RE
202 .PP
203 \-x \fIcache\-file\fR
204 .RS 4
205 Load data from
206 \fIcache\-file\fR
207 into the cache of the default view.
208 .RS
209 .B "Warning:"
210 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.
211 .RE
212 .RE
213 .SH "SIGNALS"
214 .PP
215 In routine operation, signals should not be used to control the nameserver;
216 \fBrndc\fR
217 should be used instead.
218 .PP
219 SIGHUP
220 .RS 4
221 Force a reload of the server.
222 .RE
223 .PP
224 SIGINT, SIGTERM
225 .RS 4
226 Shut down the server.
227 .RE
228 .PP
229 The result of sending any other signals to the server is undefined.
230 .SH "CONFIGURATION"
231 .PP
232 The
233 \fBnamed\fR
234 configuration file is too complex to describe in detail here. A complete description is provided in the
235 BIND 9 Administrator Reference Manual.
236 .PP
237 \fBnamed\fR
238 inherits the
239 \fBumask\fR
240 (file creation mode mask) from the parent process. If files created by
241 \fBnamed\fR, such as journal files, need to have custom permissions, the
242 \fBumask\fR
243 should be set explicitly in the script used to start the
244 \fBnamed\fR
245 process.
246 .SH "FILES"
247 .PP
248 \fI/etc/named.conf\fR
249 .RS 4
250 The default configuration file.
251 .RE
252 .PP
253 \fI/var/run/named/named.pid\fR
254 .RS 4
255 The default process\-id file.
256 .RE
257 .SH "SEE ALSO"
258 .PP
259 RFC 1033,
260 RFC 1034,
261 RFC 1035,
262 \fBnamed\-checkconf\fR(8),
263 \fBnamed\-checkzone\fR(8),
264 \fBrndc\fR(8),
265 \fBlwresd\fR(8),
266 \fBnamed.conf\fR(5),
267 BIND 9 Administrator Reference Manual.
268 .SH "AUTHOR"
269 .PP
270 Internet Systems Consortium
271 .SH "COPYRIGHT"
272 Copyright \(co 2004\-2009 Internet Systems Consortium, Inc. ("ISC")
273 .br
274 Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
275 .br