]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - 6/contrib/bind9/bin/named/named.8
merge fix for boot-time hang on centos' xen
[FreeBSD/FreeBSD.git] / 6 / contrib / bind9 / bin / named / named.8
1 .\" Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
2 .\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
3 .\" 
4 .\" Permission to use, copy, modify, and 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.17.208.14 2007/06/20 02:26:23 marka 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\-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, and
102 \fIrecord\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in
103 \fI<isc/mem.h>\fR.
104 .RE
105 .PP
106 \-n \fI#cpus\fR
107 .RS 4
108 Create
109 \fI#cpus\fR
110 worker threads to take advantage of multiple CPUs. If not specified,
111 \fBnamed\fR
112 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.
113 .RE
114 .PP
115 \-p \fIport\fR
116 .RS 4
117 Listen for queries on port
118 \fIport\fR. If not specified, the default is port 53.
119 .RE
120 .PP
121 \-s
122 .RS 4
123 Write memory usage statistics to
124 \fIstdout\fR
125 on exit.
126 .RS
127 .B "Note:"
128 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
129 .RE
130 .RE
131 .PP
132 \-t \fIdirectory\fR
133 .RS 4
134 \fBChroot\fR
135 to
136 \fIdirectory\fR
137 after processing the command line arguments, but before reading the configuration file.
138 .RS
139 .B "Warning:"
140 This option should be used in conjunction with the
141 \fB\-u\fR
142 option, as chrooting a process running as root doesn't enhance security on most systems; the way
143 \fBchroot(2)\fR
144 is defined allows a process with root privileges to escape a chroot jail.
145 .RE
146 .RE
147 .PP
148 \-u \fIuser\fR
149 .RS 4
150 \fBSetuid\fR
151 to
152 \fIuser\fR
153 after completing privileged operations, such as creating sockets that listen on privileged ports.
154 .RS
155 .B "Note:"
156 On Linux,
157 \fBnamed\fR
158 uses the kernel's capability mechanism to drop all root privileges except the ability to
159 \fBbind(2)\fR
160 to a privileged port and set process resource limits. Unfortunately, this means that the
161 \fB\-u\fR
162 option only works when
163 \fBnamed\fR
164 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
165 \fBsetuid(2)\fR.
166 .RE
167 .RE
168 .PP
169 \-v
170 .RS 4
171 Report the version number and exit.
172 .RE
173 .PP
174 \-x \fIcache\-file\fR
175 .RS 4
176 Load data from
177 \fIcache\-file\fR
178 into the cache of the default view.
179 .RS
180 .B "Warning:"
181 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.
182 .RE
183 .RE
184 .SH "SIGNALS"
185 .PP
186 In routine operation, signals should not be used to control the nameserver;
187 \fBrndc\fR
188 should be used instead.
189 .PP
190 SIGHUP
191 .RS 4
192 Force a reload of the server.
193 .RE
194 .PP
195 SIGINT, SIGTERM
196 .RS 4
197 Shut down the server.
198 .RE
199 .PP
200 The result of sending any other signals to the server is undefined.
201 .SH "CONFIGURATION"
202 .PP
203 The
204 \fBnamed\fR
205 configuration file is too complex to describe in detail here. A complete description is provided in the
206 BIND 9 Administrator Reference Manual.
207 .SH "FILES"
208 .PP
209 \fI/etc/named.conf\fR
210 .RS 4
211 The default configuration file.
212 .RE
213 .PP
214 \fI/var/run/named.pid\fR
215 .RS 4
216 The default process\-id file.
217 .RE
218 .SH "SEE ALSO"
219 .PP
220 RFC 1033,
221 RFC 1034,
222 RFC 1035,
223 \fBnamed\-checkconf\fR(8),
224 \fBnamed\-checkzone\fR(8),
225 \fBrndc\fR(8),
226 \fBlwresd\fR(8),
227 \fBnamed.conf\fR(5),
228 BIND 9 Administrator Reference Manual.
229 .SH "AUTHOR"
230 .PP
231 Internet Systems Consortium
232 .SH "COPYRIGHT"
233 Copyright \(co 2004\-2007 Internet Systems Consortium, Inc. ("ISC")
234 .br
235 Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
236 .br