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