contrib/bind9/bin/named/named.8

   1 .\" Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and/or 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.38.14.2 2009/12/03 05:06:38 tbox 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: May 21, 2009
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "NAMED" "8" "May 21, 2009" "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\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-S\ \fR\fB\fI#max\-socks\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\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 \-m \fIflag\fR
  98 .RS 4
  99 Turn on memory usage debugging flags. Possible flags are
 100 \fIusage\fR,
 101 \fItrace\fR,
 102 \fIrecord\fR,
 103 \fIsize\fR, and
 104 \fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in
 105 \fI<isc/mem.h>\fR.
 106 .RE
 107 .PP
 108 \-n \fI#cpus\fR
 109 .RS 4
 110 Create
 111 \fI#cpus\fR
 112 worker threads to take advantage of multiple CPUs. If not specified,
 113 \fBnamed\fR
 114 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.
 115 .RE
 116 .PP
 117 \-p \fIport\fR
 118 .RS 4
 119 Listen for queries on port
 120 \fIport\fR. If not specified, the default is port 53.
 121 .RE
 122 .PP
 123 \-s
 124 .RS 4
 125 Write memory usage statistics to
 126 \fIstdout\fR
 127 on exit.
 128 .RS
 129 .B "Note:"
 130 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
 131 .RE
 132 .RE
 133 .PP
 134 \-S \fI#max\-socks\fR
 135 .RS 4
 136 Allow
 137 \fBnamed\fR
 138 to use up to
 139 \fI#max\-socks\fR
 140 sockets.
 141 .RS
 142 .B "Warning:"
 143 This option should be unnecessary for the vast majority of users. The use of this option could even be harmful because the specified value may exceed the limitation of the underlying system API. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets. Note also that the actual maximum number is normally a little fewer than the specified value because
 144 \fBnamed\fR
 145 reserves some file descriptors for its internal use.
 146 .RE
 147 .RE
 148 .PP
 149 \-t \fIdirectory\fR
 150 .RS 4
 151 Chroot to
 152 \fIdirectory\fR
 153 after processing the command line arguments, but before reading the configuration file.
 154 .RS
 155 .B "Warning:"
 156 This option should be used in conjunction with the
 157 \fB\-u\fR
 158 option, as chrooting a process running as root doesn't enhance security on most systems; the way
 159 \fBchroot(2)\fR
 160 is defined allows a process with root privileges to escape a chroot jail.
 161 .RE
 162 .RE
 163 .PP
 164 \-u \fIuser\fR
 165 .RS 4
 166 Setuid to
 167 \fIuser\fR
 168 after completing privileged operations, such as creating sockets that listen on privileged ports.
 169 .RS
 170 .B "Note:"
 171 On Linux,
 172 \fBnamed\fR
 173 uses the kernel's capability mechanism to drop all root privileges except the ability to
 174 \fBbind(2)\fR
 175 to a privileged port and set process resource limits. Unfortunately, this means that the
 176 \fB\-u\fR
 177 option only works when
 178 \fBnamed\fR
 179 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
 180 \fBsetuid(2)\fR.
 181 .RE
 182 .RE
 183 .PP
 184 \-v
 185 .RS 4
 186 Report the version number and exit.
 187 .RE
 188 .PP
 189 \-V
 190 .RS 4
 191 Report the version number and build options, and exit.
 192 .RE
 193 .PP
 194 \-x \fIcache\-file\fR
 195 .RS 4
 196 Load data from
 197 \fIcache\-file\fR
 198 into the cache of the default view.
 199 .RS
 200 .B "Warning:"
 201 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.
 202 .RE
 203 .RE
 204 .SH "SIGNALS"
 205 .PP
 206 In routine operation, signals should not be used to control the nameserver;
 207 \fBrndc\fR
 208 should be used instead.
 209 .PP
 210 SIGHUP
 211 .RS 4
 212 Force a reload of the server.
 213 .RE
 214 .PP
 215 SIGINT, SIGTERM
 216 .RS 4
 217 Shut down the server.
 218 .RE
 219 .PP
 220 The result of sending any other signals to the server is undefined.
 221 .SH "CONFIGURATION"
 222 .PP
 223 The
 224 \fBnamed\fR
 225 configuration file is too complex to describe in detail here. A complete description is provided in the
 226 BIND 9 Administrator Reference Manual.
 227 .PP
 228 \fBnamed\fR
 229 inherits the
 230 \fBumask\fR
 231 (file creation mode mask) from the parent process. If files created by
 232 \fBnamed\fR, such as journal files, need to have custom permissions, the
 233 \fBumask\fR
 234 should be set explicitly in the script used to start the
 235 \fBnamed\fR
 236 process.
 237 .SH "FILES"
 238 .PP
 239 \fI/etc/named.conf\fR
 240 .RS 4
 241 The default configuration file.
 242 .RE
 243 .PP
 244 \fI/var/run/named/named.pid\fR
 245 .RS 4
 246 The default process\-id file.
 247 .RE
 248 .SH "SEE ALSO"
 249 .PP
 250 RFC 1033,
 251 RFC 1034,
 252 RFC 1035,
 253 \fBnamed\-checkconf\fR(8),
 254 \fBnamed\-checkzone\fR(8),
 255 \fBrndc\fR(8),
 256 \fBlwresd\fR(8),
 257 \fBnamed.conf\fR(5),
 258 BIND 9 Administrator Reference Manual.
 259 .SH "AUTHOR"
 260 .PP
 261 Internet Systems Consortium
 262 .SH "COPYRIGHT"
 263 Copyright \(co 2004\-2009 Internet Systems Consortium, Inc. ("ISC")
 264 .br
 265 Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
 266 .br