contrib/bind9/bin/named/named.8

   1 .\" Copyright (C) 2004-2009, 2011, 2013-2015 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 .hy 0
  17 .ad l
  18 '\" t
  19 .\"     Title: named
  20 .\"    Author:
  21 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
  22 .\"      Date: 2014-02-20
  23 .\"    Manual: BIND9
  24 .\"    Source: ISC
  25 .\"  Language: English
  26 .\"
  27 .TH "NAMED" "8" "2014\-02\-20" "ISC" "BIND9"
  28 .\" -----------------------------------------------------------------
  29 .\" * Define some portability stuff
  30 .\" -----------------------------------------------------------------
  31 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32 .\" http://bugs.debian.org/507673
  33 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .ie \n(.g .ds Aq \(aq
  36 .el       .ds Aq '
  37 .\" -----------------------------------------------------------------
  38 .\" * set default formatting
  39 .\" -----------------------------------------------------------------
  40 .\" disable hyphenation
  41 .nh
  42 .\" disable justification (adjust text to left margin only)
  43 .ad l
  44 .\" -----------------------------------------------------------------
  45 .\" * MAIN CONTENT STARTS HERE *
  46 .\" -----------------------------------------------------------------
  47 .SH "NAME"
  48 named \- Internet domain name server
  49 .SH "SYNOPSIS"
  50 .HP \w'\fBnamed\fR\ 'u
  51 \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\-E\ \fR\fB\fIengine\-name\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-M\ \fR\fB\fIoption\fR\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\fI#listeners\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-V\fR] [\fB\-x\ \fR\fB\fIcache\-file\fR\fR]
  52 .SH "DESCRIPTION"
  53 .PP
  54 \fBnamed\fR
  55 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\&.
  56 .PP
  57 When invoked without arguments,
  58 \fBnamed\fR
  59 will read the default configuration file
  60 /etc/named\&.conf, read any initial data, and listen for queries\&.
  61 .SH "OPTIONS"
  62 .PP
  63 \-4
  64 .RS 4
  65 Use IPv4 only even if the host machine is capable of IPv6\&.
  66 \fB\-4\fR
  67 and
  68 \fB\-6\fR
  69 are mutually exclusive\&.
  70 .RE
  71 .PP
  72 \-6
  73 .RS 4
  74 Use IPv6 only even if the host machine is capable of IPv4\&.
  75 \fB\-4\fR
  76 and
  77 \fB\-6\fR
  78 are mutually exclusive\&.
  79 .RE
  80 .PP
  81 \-c \fIconfig\-file\fR
  82 .RS 4
  83 Use
  84 \fIconfig\-file\fR
  85 as the configuration file instead of the default,
  86 /etc/named\&.conf\&. To ensure that reloading the configuration file continues to work after the server has changed its working directory due to to a possible
  87 \fBdirectory\fR
  88 option in the configuration file,
  89 \fIconfig\-file\fR
  90 should be an absolute pathname\&.
  91 .RE
  92 .PP
  93 \-d \fIdebug\-level\fR
  94 .RS 4
  95 Set the daemon\*(Aqs debug level to
  96 \fIdebug\-level\fR\&. Debugging traces from
  97 \fBnamed\fR
  98 become more verbose as the debug level increases\&.
  99 .RE
 100 .PP
 101 \-E \fIengine\-name\fR
 102 .RS 4
 103 Use a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance re\-signing with private keys from a secure key store\&. When compiled with PKCS#11 support
 104 \fIengine\-name\fR
 105 defaults to pkcs11, the empty name resets it to no engine\&.
 106 .RE
 107 .PP
 108 \-f
 109 .RS 4
 110 Run the server in the foreground (i\&.e\&. do not daemonize)\&.
 111 .RE
 112 .PP
 113 \-g
 114 .RS 4
 115 Run the server in the foreground and force all logging to
 116 stderr\&.
 117 .RE
 118 .PP
 119 \-M \fIoption\fR
 120 .RS 4
 121 Sets the default memory context options\&. Currently the only supported option is
 122 \fIexternal\fR, which causes the internal memory manager to be bypassed in favor of system\-provided memory allocation functions\&.
 123 .RE
 124 .PP
 125 \-m \fIflag\fR
 126 .RS 4
 127 Turn on memory usage debugging flags\&. Possible flags are
 128 \fIusage\fR,
 129 \fItrace\fR,
 130 \fIrecord\fR,
 131 \fIsize\fR, and
 132 \fImctx\fR\&. These correspond to the ISC_MEM_DEBUGXXXX flags described in
 133 <isc/mem\&.h>\&.
 134 .RE
 135 .PP
 136 \-n \fI#cpus\fR
 137 .RS 4
 138 Create
 139 \fI#cpus\fR
 140 worker threads to take advantage of multiple CPUs\&. If not specified,
 141 \fBnamed\fR
 142 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\&.
 143 .RE
 144 .PP
 145 \-p \fIport\fR
 146 .RS 4
 147 Listen for queries on port
 148 \fIport\fR\&. If not specified, the default is port 53\&.
 149 .RE
 150 .PP
 151 \-s
 152 .RS 4
 153 Write memory usage statistics to
 154 stdout
 155 on exit\&.
 156 .if n \{\
 157 .sp
 158 .\}
 159 .RS 4
 160 .it 1 an-trap
 161 .nr an-no-space-flag 1
 162 .nr an-break-flag 1
 163 .br
 164 .ps +1
 165 \fBNote\fR
 166 .ps -1
 167 .br
 168 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&.
 169 .sp .5v
 170 .RE
 171 .RE
 172 .PP
 173 \-S \fI#max\-socks\fR
 174 .RS 4
 175 Allow
 176 \fBnamed\fR
 177 to use up to
 178 \fI#max\-socks\fR
 179 sockets\&.
 180 .if n \{\
 181 .sp
 182 .\}
 183 .RS 4
 184 .it 1 an-trap
 185 .nr an-no-space-flag 1
 186 .nr an-break-flag 1
 187 .br
 188 .ps +1
 189 \fBWarning\fR
 190 .ps -1
 191 .br
 192 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
 193 \fBnamed\fR
 194 reserves some file descriptors for its internal use\&.
 195 .sp .5v
 196 .RE
 197 .RE
 198 .PP
 199 \-t \fIdirectory\fR
 200 .RS 4
 201 Chroot to
 202 \fIdirectory\fR
 203 after processing the command line arguments, but before reading the configuration file\&.
 204 .if n \{\
 205 .sp
 206 .\}
 207 .RS 4
 208 .it 1 an-trap
 209 .nr an-no-space-flag 1
 210 .nr an-break-flag 1
 211 .br
 212 .ps +1
 213 \fBWarning\fR
 214 .ps -1
 215 .br
 216 This option should be used in conjunction with the
 217 \fB\-u\fR
 218 option, as chrooting a process running as root doesn\*(Aqt enhance security on most systems; the way
 219 \fBchroot(2)\fR
 220 is defined allows a process with root privileges to escape a chroot jail\&.
 221 .sp .5v
 222 .RE
 223 .RE
 224 .PP
 225 \-U \fI#listeners\fR
 226 .RS 4
 227 Use
 228 \fI#listeners\fR
 229 worker threads to listen for incoming UDP packets on each address\&. If not specified,
 230 \fBnamed\fR
 231 will calculate a default value based on the number of detected CPUs: 1 for 1 CPU, and the number of detected CPUs minus one for machines with more than 1 CPU\&. This cannot be increased to a value higher than the number of CPUs\&. If
 232 \fB\-n\fR
 233 has been set to a higher value than the number of detected CPUs, then
 234 \fB\-U\fR
 235 may be increased as high as that value, but no higher\&. On Windows, the number of UDP listeners is hardwired to 1 and this option has no effect\&.
 236 .RE
 237 .PP
 238 \-u \fIuser\fR
 239 .RS 4
 240 Setuid to
 241 \fIuser\fR
 242 after completing privileged operations, such as creating sockets that listen on privileged ports\&.
 243 .if n \{\
 244 .sp
 245 .\}
 246 .RS 4
 247 .it 1 an-trap
 248 .nr an-no-space-flag 1
 249 .nr an-break-flag 1
 250 .br
 251 .ps +1
 252 \fBNote\fR
 253 .ps -1
 254 .br
 255 On Linux,
 256 \fBnamed\fR
 257 uses the kernel\*(Aqs capability mechanism to drop all root privileges except the ability to
 258 \fBbind(2)\fR
 259 to a privileged port and set process resource limits\&. Unfortunately, this means that the
 260 \fB\-u\fR
 261 option only works when
 262 \fBnamed\fR
 263 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
 264 \fBsetuid(2)\fR\&.
 265 .sp .5v
 266 .RE
 267 .RE
 268 .PP
 269 \-v
 270 .RS 4
 271 Report the version number and exit\&.
 272 .RE
 273 .PP
 274 \-V
 275 .RS 4
 276 Report the version number and build options, and exit\&.
 277 .RE
 278 .PP
 279 \-x \fIcache\-file\fR
 280 .RS 4
 281 Load data from
 282 \fIcache\-file\fR
 283 into the cache of the default view\&.
 284 .if n \{\
 285 .sp
 286 .\}
 287 .RS 4
 288 .it 1 an-trap
 289 .nr an-no-space-flag 1
 290 .nr an-break-flag 1
 291 .br
 292 .ps +1
 293 \fBWarning\fR
 294 .ps -1
 295 .br
 296 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\&.
 297 .sp .5v
 298 .RE
 299 .RE
 300 .SH "SIGNALS"
 301 .PP
 302 In routine operation, signals should not be used to control the nameserver;
 303 \fBrndc\fR
 304 should be used instead\&.
 305 .PP
 306 SIGHUP
 307 .RS 4
 308 Force a reload of the server\&.
 309 .RE
 310 .PP
 311 SIGINT, SIGTERM
 312 .RS 4
 313 Shut down the server\&.
 314 .RE
 315 .PP
 316 The result of sending any other signals to the server is undefined\&.
 317 .SH "CONFIGURATION"
 318 .PP
 319 The
 320 \fBnamed\fR
 321 configuration file is too complex to describe in detail here\&. A complete description is provided in the
 322 BIND 9 Administrator Reference Manual\&.
 323 .PP
 324 \fBnamed\fR
 325 inherits the
 326 \fBumask\fR
 327 (file creation mode mask) from the parent process\&. If files created by
 328 \fBnamed\fR, such as journal files, need to have custom permissions, the
 329 \fBumask\fR
 330 should be set explicitly in the script used to start the
 331 \fBnamed\fR
 332 process\&.
 333 .SH "FILES"
 334 .PP
 335 /etc/named\&.conf
 336 .RS 4
 337 The default configuration file\&.
 338 .RE
 339 .PP
 340 /var/run/named/named\&.pid
 341 .RS 4
 342 The default process\-id file\&.
 343 .RE
 344 .SH "SEE ALSO"
 345 .PP
 346 RFC 1033,
 347 RFC 1034,
 348 RFC 1035,
 349 \fBnamed-checkconf\fR(8),
 350 \fBnamed-checkzone\fR(8),
 351 \fBrndc\fR(8),
 352 \fBlwresd\fR(8),
 353 \fBnamed.conf\fR(5),
 354 BIND 9 Administrator Reference Manual\&.
 355 .SH "AUTHOR"
 356 .PP
 357 \fBInternet Systems Consortium, Inc\&.\fR
 358 .SH "COPYRIGHT"
 359 .br
 360 Copyright \(co 2004-2009, 2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC")
 361 .br
 362 Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
 363 .br