Merge branch 'vendor/GCC'
[dragonfly.git] / contrib / bind-9.3 / bin / named / named.8
1 .\" Copyright (C) 2004-2006 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.9 2006/06/29 13:02:30 marka Exp $
17 .\"
18 .hy 0
19 .ad l
20 .\"     Title: named
21 .\"    Author: 
22 .\" Generator: DocBook XSL Stylesheets v1.70.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 .TP 3n
48 \-4
49 Use IPv4 only even if the host machine is capable of IPv6.
50 \fB\-4\fR
51 and
52 \fB\-6\fR
53 are mutually exclusive.
54 .TP 3n
55 \-6
56 Use IPv6 only even if the host machine is capable of IPv4.
57 \fB\-4\fR
58 and
59 \fB\-6\fR
60 are mutually exclusive.
61 .TP 3n
62 \-c \fIconfig\-file\fR
63 Use
64 \fIconfig\-file\fR
65 as the configuration file instead of the default,
66 \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
67 \fBdirectory\fR
68 option in the configuration file,
69 \fIconfig\-file\fR
70 should be an absolute pathname.
71 .TP 3n
72 \-d \fIdebug\-level\fR
73 Set the daemon's debug level to
74 \fIdebug\-level\fR. Debugging traces from
75 \fBnamed\fR
76 become more verbose as the debug level increases.
77 .TP 3n
78 \-f
79 Run the server in the foreground (i.e. do not daemonize).
80 .TP 3n
81 \-g
82 Run the server in the foreground and force all logging to
83 \fIstderr\fR.
84 .TP 3n
85 \-n \fI#cpus\fR
86 Create
87 \fI#cpus\fR
88 worker threads to take advantage of multiple CPUs. If not specified,
89 \fBnamed\fR
90 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.
91 .TP 3n
92 \-p \fIport\fR
93 Listen for queries on port
94 \fIport\fR. If not specified, the default is port 53.
95 .TP 3n
96 \-s
97 Write memory usage statistics to
98 \fIstdout\fR
99 on exit.
100 .RS
101 .B "Note:"
102 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
103 .RE
104 .TP 3n
105 \-t \fIdirectory\fR
106 \fBchroot()\fR
107 to
108 \fIdirectory\fR
109 after processing the command line arguments, but before reading the configuration file.
110 .RS
111 .B "Warning:"
112 This option should be used in conjunction with the
113 \fB\-u\fR
114 option, as chrooting a process running as root doesn't enhance security on most systems; the way
115 \fBchroot()\fR
116 is defined allows a process with root privileges to escape a chroot jail.
117 .RE
118 .TP 3n
119 \-u \fIuser\fR
120 \fBsetuid()\fR
121 to
122 \fIuser\fR
123 after completing privileged operations, such as creating sockets that listen on privileged ports.
124 .RS
125 .B "Note:"
126 On Linux,
127 \fBnamed\fR
128 uses the kernel's capability mechanism to drop all root privileges except the ability to
129 \fBbind()\fR
130 to a privileged port and set process resource limits. Unfortunately, this means that the
131 \fB\-u\fR
132 option only works when
133 \fBnamed\fR
134 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
135 \fBsetuid()\fR.
136 .RE
137 .TP 3n
138 \-v
139 Report the version number and exit.
140 .TP 3n
141 \-x \fIcache\-file\fR
142 Load data from
143 \fIcache\-file\fR
144 into the cache of the default view.
145 .RS
146 .B "Warning:"
147 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.
148 .RE
149 .SH "SIGNALS"
150 .PP
151 In routine operation, signals should not be used to control the nameserver;
152 \fBrndc\fR
153 should be used instead.
154 .TP 3n
155 SIGHUP
156 Force a reload of the server.
157 .TP 3n
158 SIGINT, SIGTERM
159 Shut down the server.
160 .PP
161 The result of sending any other signals to the server is undefined.
162 .SH "CONFIGURATION"
163 .PP
164 The
165 \fBnamed\fR
166 configuration file is too complex to describe in detail here. A complete description is provided in the
167 BIND 9 Administrator Reference Manual.
168 .SH "FILES"
169 .TP 3n
170 \fI/etc/named.conf\fR
171 The default configuration file.
172 .TP 3n
173 \fI/var/run/named.pid\fR
174 The default process\-id file.
175 .SH "SEE ALSO"
176 .PP
177 RFC 1033,
178 RFC 1034,
179 RFC 1035,
180 \fBrndc\fR(8),
181 \fBlwresd\fR(8),
182 \fBnamed.conf\fR(5),
183 BIND 9 Administrator Reference Manual.
184 .SH "AUTHOR"
185 .PP
186 Internet Systems Consortium
187 .SH "COPYRIGHT"
188 Copyright \(co 2004\-2006 Internet Systems Consortium, Inc. ("ISC")