update the readme files for bind-9.3.4 import
[dragonfly.git] / contrib / bind-9.2.4rc7 / bin / named / named.8
1 .\" Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
2 .\" Copyright (C) 2000, 2001  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.2.2 2004/06/03 05:21:13 marka Exp $
17 .\"
18 .TH "NAMED" "8" "June 30, 2000" "BIND9" ""
19 .SH NAME
20 named \- Internet domain name server
21 .SH SYNOPSIS
22 .sp
23 \fBnamed\fR [ \fB-c \fIconfig-file\fB\fR ]  [ \fB-d \fIdebug-level\fB\fR ]  [ \fB-f\fR ]  [ \fB-g\fR ]  [ \fB-n \fI#cpus\fB\fR ]  [ \fB-p \fIport\fB\fR ]  [ \fB-s\fR ]  [ \fB-t \fIdirectory\fB\fR ]  [ \fB-u \fIuser\fB\fR ]  [ \fB-v\fR ]  [ \fB-x \fIcache-file\fB\fR ] 
24 .SH "DESCRIPTION"
25 .PP
26 \fBnamed\fR is a Domain Name System (DNS) server,
27 part of the BIND 9 distribution from ISC. For more
28 information on the DNS, see RFCs 1033, 1034, and 1035.
29 .PP
30 When invoked without arguments, \fBnamed\fR will
31 read the default configuration file
32 \fI/etc/named.conf\fR, read any initial
33 data, and listen for queries.
34 .SH "OPTIONS"
35 .TP
36 \fB-c \fIconfig-file\fB\fR
37 Use \fIconfig-file\fR as the
38 configuration file instead of the default,
39 \fI/etc/named.conf\fR. To
40 ensure that reloading the configuration file continues
41 to work after the server has changed its working
42 directory due to to a possible
43 \fBdirectory\fR option in the configuration
44 file, \fIconfig-file\fR should be
45 an absolute pathname.
46 .TP
47 \fB-d \fIdebug-level\fB\fR
48 Set the daemon's debug level to \fIdebug-level\fR.
49 Debugging traces from \fBnamed\fR become
50 more verbose as the debug level increases.
51 .TP
52 \fB-f\fR
53 Run the server in the foreground (i.e. do not daemonize).
54 .TP
55 \fB-g\fR
56 Run the server in the foreground and force all logging
57 to \fIstderr\fR.
58 .TP
59 \fB-n \fI#cpus\fB\fR
60 Create \fI#cpus\fR worker threads
61 to take advantage of multiple CPUs. If not specified,
62 \fBnamed\fR will try to determine the
63 number of CPUs present and create one thread per CPU.
64 If it is unable to determine the number of CPUs, a
65 single worker thread will be created.
66 .TP
67 \fB-p \fIport\fB\fR
68 Listen for queries on port \fIport\fR. If not
69 specified, the default is port 53.
70 .TP
71 \fB-s\fR
72 Write memory usage statistics to \fIstdout\fR on exit.
73 .sp
74 .RS
75 .B "Note:"
76 This option is mainly of interest to BIND 9 developers
77 and may be removed or changed in a future release.
78 .RE
79 .sp
80 .TP
81 \fB-t \fIdirectory\fB\fR
82 \fBchroot()\fR to \fIdirectory\fR after
83 processing the command line arguments, but before
84 reading the configuration file.
85 .sp
86 .RS
87 .B "Warning:"
88 This option should be used in conjunction with the
89 \fB-u\fR option, as chrooting a process
90 running as root doesn't enhance security on most
91 systems; the way \fBchroot()\fR is
92 defined allows a process with root privileges to
93 escape a chroot jail.
94 .RE
95 .sp
96 .TP
97 \fB-u \fIuser\fB\fR
98 \fBsetuid()\fR to \fIuser\fR after completing
99 privileged operations, such as creating sockets that
100 listen on privileged ports.
101 .sp
102 .RS
103 .B "Note:"
104 On Linux, \fBnamed\fR uses the kernel's
105 capability mechanism to drop all root privileges
106 except the ability to \fBbind()\fR to a
107 privileged port and set process resource limits.
108 Unfortunately, this means that the \fB-u\fR
109 option only works when \fBnamed\fR is run
110 on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
111 later, since previous kernels did not allow privileges
112 to be retained after \fBsetuid()\fR.
113 .RE
114 .sp
115 .TP
116 \fB-v\fR
117 Report the version number and exit.
118 .TP
119 \fB-x \fIcache-file\fB\fR
120 Load data from \fIcache-file\fR into the
121 cache of the default view.
122 .sp
123 .RS
124 .B "Warning:"
125 This option must not be used. It is only of interest
126 to BIND 9 developers and may be removed or changed in a
127 future release.
128 .RE
129 .sp
130 .SH "SIGNALS"
131 .PP
132 In routine operation, signals should not be used to control
133 the nameserver; \fBrndc\fR should be used
134 instead.
135 .TP
136 \fBSIGHUP\fR
137 Force a reload of the server.
138 .TP
139 \fBSIGINT, SIGTERM\fR
140 Shut down the server.
141 .PP
142 The result of sending any other signals to the server is undefined.
143 .PP
144 .SH "CONFIGURATION"
145 .PP
146 The \fBnamed\fR configuration file is too complex
147 to describe in detail here. A complete description is
148 provided in the \fIBIND 9 Administrator Reference
149 Manual\fR.
150 .SH "FILES"
151 .TP
152 \fB\fI/etc/named.conf\fB\fR
153 The default configuration file.
154 .TP
155 \fB\fI/var/run/named.pid\fB\fR
156 The default process-id file.
157 .SH "SEE ALSO"
158 .PP
159 \fIRFC 1033\fR,
160 \fIRFC 1034\fR,
161 \fIRFC 1035\fR,
162 \fBrndc\fR(8),
163 \fBlwresd\fR(8),
164 \fIBIND 9 Administrator Reference Manual\fR.
165 .SH "AUTHOR"
166 .PP
167 Internet Systems Consortium