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