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