contrib/bind-9.2.4rc7/bin/named/named.html

   1 <!--
   2  - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000, 2001  Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17
  18 <!-- $Id: named.html,v 1.4.2.3 2004/06/03 05:21:14 marka Exp $ -->
  19
  20 <HTML
  21 ><HEAD
  22 ><TITLE
  23 >named</TITLE
  24 ><META
  25 NAME="GENERATOR"
  26 CONTENT="Modular DocBook HTML Stylesheet Version 1.73
  27 "></HEAD
  28 ><BODY
  29 CLASS="REFENTRY"
  30 BGCOLOR="#FFFFFF"
  31 TEXT="#000000"
  32 LINK="#0000FF"
  33 VLINK="#840084"
  34 ALINK="#0000FF"
  35 ><H1
  36 ><A
  37 NAME="AEN1"
  38 ><SPAN
  39 CLASS="APPLICATION"
  40 >named</SPAN
  41 ></A
  42 ></H1
  43 ><DIV
  44 CLASS="REFNAMEDIV"
  45 ><A
  46 NAME="AEN9"
  47 ></A
  48 ><H2
  49 >Name</H2
  50 ><SPAN
  51 CLASS="APPLICATION"
  52 >named</SPAN
  53 >&nbsp;--&nbsp;Internet domain name server</DIV
  54 ><DIV
  55 CLASS="REFSYNOPSISDIV"
  56 ><A
  57 NAME="AEN13"
  58 ></A
  59 ><H2
  60 >Synopsis</H2
  61 ><P
  62 ><B
  63 CLASS="COMMAND"
  64 >named</B
  65 >  [<TT
  66 CLASS="OPTION"
  67 >-c <TT
  68 CLASS="REPLACEABLE"
  69 ><I
  70 >config-file</I
  71 ></TT
  72 ></TT
  73 >] [<TT
  74 CLASS="OPTION"
  75 >-d <TT
  76 CLASS="REPLACEABLE"
  77 ><I
  78 >debug-level</I
  79 ></TT
  80 ></TT
  81 >] [<TT
  82 CLASS="OPTION"
  83 >-f</TT
  84 >] [<TT
  85 CLASS="OPTION"
  86 >-g</TT
  87 >] [<TT
  88 CLASS="OPTION"
  89 >-n <TT
  90 CLASS="REPLACEABLE"
  91 ><I
  92 >#cpus</I
  93 ></TT
  94 ></TT
  95 >] [<TT
  96 CLASS="OPTION"
  97 >-p <TT
  98 CLASS="REPLACEABLE"
  99 ><I
 100 >port</I
 101 ></TT
 102 ></TT
 103 >] [<TT
 104 CLASS="OPTION"
 105 >-s</TT
 106 >] [<TT
 107 CLASS="OPTION"
 108 >-t <TT
 109 CLASS="REPLACEABLE"
 110 ><I
 111 >directory</I
 112 ></TT
 113 ></TT
 114 >] [<TT
 115 CLASS="OPTION"
 116 >-u <TT
 117 CLASS="REPLACEABLE"
 118 ><I
 119 >user</I
 120 ></TT
 121 ></TT
 122 >] [<TT
 123 CLASS="OPTION"
 124 >-v</TT
 125 >] [<TT
 126 CLASS="OPTION"
 127 >-x <TT
 128 CLASS="REPLACEABLE"
 129 ><I
 130 >cache-file</I
 131 ></TT
 132 ></TT
 133 >]</P
 134 ></DIV
 135 ><DIV
 136 CLASS="REFSECT1"
 137 ><A
 138 NAME="AEN45"
 139 ></A
 140 ><H2
 141 >DESCRIPTION</H2
 142 ><P
 143 >       <B
 144 CLASS="COMMAND"
 145 >named</B
 146 > is a Domain Name System (DNS) server,
 147         part of the BIND 9 distribution from ISC.  For more
 148         information on the DNS, see RFCs 1033, 1034, and 1035.
 149     </P
 150 ><P
 151 >       When invoked without arguments, <B
 152 CLASS="COMMAND"
 153 >named</B
 154 > will
 155         read the default configuration file
 156         <TT
 157 CLASS="FILENAME"
 158 >/etc/named.conf</TT
 159 >, read any initial
 160         data, and listen for queries.
 161     </P
 162 ></DIV
 163 ><DIV
 164 CLASS="REFSECT1"
 165 ><A
 166 NAME="AEN52"
 167 ></A
 168 ><H2
 169 >OPTIONS</H2
 170 ><P
 171 ></P
 172 ><DIV
 173 CLASS="VARIABLELIST"
 174 ><DL
 175 ><DT
 176 >-c <TT
 177 CLASS="REPLACEABLE"
 178 ><I
 179 >config-file</I
 180 ></TT
 181 ></DT
 182 ><DD
 183 ><P
 184 >               Use <TT
 185 CLASS="REPLACEABLE"
 186 ><I
 187 >config-file</I
 188 ></TT
 189 > as the
 190                 configuration file instead of the default,
 191                 <TT
 192 CLASS="FILENAME"
 193 >/etc/named.conf</TT
 194 >.  To
 195                 ensure that reloading the configuration file continues
 196                 to work after the server has changed its working
 197                 directory due to to a possible
 198                 <TT
 199 CLASS="OPTION"
 200 >directory</TT
 201 > option in the configuration
 202                 file, <TT
 203 CLASS="REPLACEABLE"
 204 ><I
 205 >config-file</I
 206 ></TT
 207 > should be
 208                 an absolute pathname.
 209           </P
 210 ></DD
 211 ><DT
 212 >-d <TT
 213 CLASS="REPLACEABLE"
 214 ><I
 215 >debug-level</I
 216 ></TT
 217 ></DT
 218 ><DD
 219 ><P
 220 >               Set the daemon's debug level to <TT
 221 CLASS="REPLACEABLE"
 222 ><I
 223 >debug-level</I
 224 ></TT
 225 >.
 226                 Debugging traces from <B
 227 CLASS="COMMAND"
 228 >named</B
 229 > become
 230                 more verbose as the debug level increases.
 231           </P
 232 ></DD
 233 ><DT
 234 >-f</DT
 235 ><DD
 236 ><P
 237 >               Run the server in the foreground (i.e. do not daemonize).
 238           </P
 239 ></DD
 240 ><DT
 241 >-g</DT
 242 ><DD
 243 ><P
 244 >               Run the server in the foreground and force all logging
 245                 to <TT
 246 CLASS="FILENAME"
 247 >stderr</TT
 248 >.
 249           </P
 250 ></DD
 251 ><DT
 252 >-n <TT
 253 CLASS="REPLACEABLE"
 254 ><I
 255 >#cpus</I
 256 ></TT
 257 ></DT
 258 ><DD
 259 ><P
 260 >               Create <TT
 261 CLASS="REPLACEABLE"
 262 ><I
 263 >#cpus</I
 264 ></TT
 265 > worker threads
 266                 to take advantage of multiple CPUs.  If not specified,
 267                 <B
 268 CLASS="COMMAND"
 269 >named</B
 270 > will try to determine the
 271                 number of CPUs present and create one thread per CPU.
 272                 If it is unable to determine the number of CPUs, a
 273                 single worker thread will be created.
 274           </P
 275 ></DD
 276 ><DT
 277 >-p <TT
 278 CLASS="REPLACEABLE"
 279 ><I
 280 >port</I
 281 ></TT
 282 ></DT
 283 ><DD
 284 ><P
 285 >               Listen for queries on port <TT
 286 CLASS="REPLACEABLE"
 287 ><I
 288 >port</I
 289 ></TT
 290 >.  If not
 291                 specified, the default is port 53.
 292           </P
 293 ></DD
 294 ><DT
 295 >-s</DT
 296 ><DD
 297 ><P
 298 >               Write memory usage statistics to <TT
 299 CLASS="FILENAME"
 300 >stdout</TT
 301 > on exit.
 302           </P
 303 ><DIV
 304 CLASS="NOTE"
 305 ><BLOCKQUOTE
 306 CLASS="NOTE"
 307 ><P
 308 ><B
 309 >Note: </B
 310 >               This option is mainly of interest to BIND 9 developers
 311                 and may be removed or changed in a future release.
 312             </P
 313 ></BLOCKQUOTE
 314 ></DIV
 315 ></DD
 316 ><DT
 317 >-t <TT
 318 CLASS="REPLACEABLE"
 319 ><I
 320 >directory</I
 321 ></TT
 322 ></DT
 323 ><DD
 324 ><P
 325 >               <TT
 326 CLASS="FUNCTION"
 327 >chroot()</TT
 328 > to <TT
 329 CLASS="REPLACEABLE"
 330 ><I
 331 >directory</I
 332 ></TT
 333 > after
 334                 processing the command line arguments, but before
 335                 reading the configuration file.
 336           </P
 337 ><DIV
 338 CLASS="WARNING"
 339 ><P
 340 ></P
 341 ><TABLE
 342 CLASS="WARNING"
 343 BORDER="1"
 344 WIDTH="90%"
 345 ><TR
 346 ><TD
 347 ALIGN="CENTER"
 348 ><B
 349 >Warning</B
 350 ></TD
 351 ></TR
 352 ><TR
 353 ><TD
 354 ALIGN="LEFT"
 355 ><P
 356 >               This option should be used in conjunction with the
 357                 <TT
 358 CLASS="OPTION"
 359 >-u</TT
 360 > option, as chrooting a process
 361                 running as root doesn't enhance security on most
 362                 systems; the way <TT
 363 CLASS="FUNCTION"
 364 >chroot()</TT
 365 > is
 366                 defined allows a process with root privileges to
 367                 escape a chroot jail.
 368             </P
 369 ></TD
 370 ></TR
 371 ></TABLE
 372 ></DIV
 373 ></DD
 374 ><DT
 375 >-u <TT
 376 CLASS="REPLACEABLE"
 377 ><I
 378 >user</I
 379 ></TT
 380 ></DT
 381 ><DD
 382 ><P
 383 >               <TT
 384 CLASS="FUNCTION"
 385 >setuid()</TT
 386 > to <TT
 387 CLASS="REPLACEABLE"
 388 ><I
 389 >user</I
 390 ></TT
 391 > after completing
 392                 privileged operations, such as creating sockets that
 393                 listen on privileged ports.
 394           </P
 395 ><DIV
 396 CLASS="NOTE"
 397 ><BLOCKQUOTE
 398 CLASS="NOTE"
 399 ><P
 400 ><B
 401 >Note: </B
 402 >               On Linux, <B
 403 CLASS="COMMAND"
 404 >named</B
 405 > uses the kernel's
 406                 capability mechanism to drop all root privileges
 407                 except the ability to <TT
 408 CLASS="FUNCTION"
 409 >bind()</TT
 410 > to a
 411                 privileged port and set process resource limits.
 412                 Unfortunately, this means that the <TT
 413 CLASS="OPTION"
 414 >-u</TT
 415 >
 416                 option only works when <B
 417 CLASS="COMMAND"
 418 >named</B
 419 > is run
 420                 on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
 421                 later, since previous kernels did not allow privileges
 422                 to be retained after <TT
 423 CLASS="FUNCTION"
 424 >setuid()</TT
 425 >.
 426             </P
 427 ></BLOCKQUOTE
 428 ></DIV
 429 ></DD
 430 ><DT
 431 >-v</DT
 432 ><DD
 433 ><P
 434 >               Report the version number and exit.
 435           </P
 436 ></DD
 437 ><DT
 438 >-x <TT
 439 CLASS="REPLACEABLE"
 440 ><I
 441 >cache-file</I
 442 ></TT
 443 ></DT
 444 ><DD
 445 ><P
 446 >               Load data from <TT
 447 CLASS="REPLACEABLE"
 448 ><I
 449 >cache-file</I
 450 ></TT
 451 > into the
 452                 cache of the default view.
 453           </P
 454 ><DIV
 455 CLASS="WARNING"
 456 ><P
 457 ></P
 458 ><TABLE
 459 CLASS="WARNING"
 460 BORDER="1"
 461 WIDTH="90%"
 462 ><TR
 463 ><TD
 464 ALIGN="CENTER"
 465 ><B
 466 >Warning</B
 467 ></TD
 468 ></TR
 469 ><TR
 470 ><TD
 471 ALIGN="LEFT"
 472 ><P
 473 >               This option must not be used.  It is only of interest
 474                 to BIND 9 developers and may be removed or changed in a
 475                 future release.
 476             </P
 477 ></TD
 478 ></TR
 479 ></TABLE
 480 ></DIV
 481 ></DD
 482 ></DL
 483 ></DIV
 484 ></DIV
 485 ><DIV
 486 CLASS="REFSECT1"
 487 ><A
 488 NAME="AEN137"
 489 ></A
 490 ><H2
 491 >SIGNALS</H2
 492 ><P
 493 >       In routine operation, signals should not be used to control
 494         the nameserver; <B
 495 CLASS="COMMAND"
 496 >rndc</B
 497 > should be used
 498         instead.
 499     </P
 500 ><P
 501 ></P
 502 ><DIV
 503 CLASS="VARIABLELIST"
 504 ><DL
 505 ><DT
 506 >SIGHUP</DT
 507 ><DD
 508 ><P
 509 >               Force a reload of the server.
 510           </P
 511 ></DD
 512 ><DT
 513 >SIGINT, SIGTERM</DT
 514 ><DD
 515 ><P
 516 >               Shut down the server.
 517           </P
 518 ></DD
 519 ></DL
 520 ></DIV
 521 ><P
 522 >       The result of sending any other signals to the server is undefined.
 523     </P
 524 ></DIV
 525 ><DIV
 526 CLASS="REFSECT1"
 527 ><A
 528 NAME="AEN151"
 529 ></A
 530 ><H2
 531 >CONFIGURATION</H2
 532 ><P
 533 >       The <B
 534 CLASS="COMMAND"
 535 >named</B
 536 > configuration file is too complex
 537         to describe in detail here.  A complete description is
 538         provided in the <I
 539 CLASS="CITETITLE"
 540 >BIND 9 Administrator Reference
 541         Manual</I
 542 >.
 543     </P
 544 ></DIV
 545 ><DIV
 546 CLASS="REFSECT1"
 547 ><A
 548 NAME="AEN156"
 549 ></A
 550 ><H2
 551 >FILES</H2
 552 ><P
 553 ></P
 554 ><DIV
 555 CLASS="VARIABLELIST"
 556 ><DL
 557 ><DT
 558 ><TT
 559 CLASS="FILENAME"
 560 >/etc/named.conf</TT
 561 ></DT
 562 ><DD
 563 ><P
 564 >               The default configuration file.
 565           </P
 566 ></DD
 567 ><DT
 568 ><TT
 569 CLASS="FILENAME"
 570 >/var/run/named.pid</TT
 571 ></DT
 572 ><DD
 573 ><P
 574 >               The default process-id file.
 575           </P
 576 ></DD
 577 ></DL
 578 ></DIV
 579 ></DIV
 580 ><DIV
 581 CLASS="REFSECT1"
 582 ><A
 583 NAME="AEN169"
 584 ></A
 585 ><H2
 586 >SEE ALSO</H2
 587 ><P
 588 >       <I
 589 CLASS="CITETITLE"
 590 >RFC 1033</I
 591 >,
 592         <I
 593 CLASS="CITETITLE"
 594 >RFC 1034</I
 595 >,
 596         <I
 597 CLASS="CITETITLE"
 598 >RFC 1035</I
 599 >,
 600         <SPAN
 601 CLASS="CITEREFENTRY"
 602 ><SPAN
 603 CLASS="REFENTRYTITLE"
 604 >rndc</SPAN
 605 >(8)</SPAN
 606 >,
 607         <SPAN
 608 CLASS="CITEREFENTRY"
 609 ><SPAN
 610 CLASS="REFENTRYTITLE"
 611 >lwresd</SPAN
 612 >(8)</SPAN
 613 >,
 614         <I
 615 CLASS="CITETITLE"
 616 >BIND 9 Administrator Reference Manual</I
 617 >.
 618     </P
 619 ></DIV
 620 ><DIV
 621 CLASS="REFSECT1"
 622 ><A
 623 NAME="AEN182"
 624 ></A
 625 ><H2
 626 >AUTHOR</H2
 627 ><P
 628 >       Internet Systems Consortium
 629     </P
 630 ></DIV
 631 ></BODY
 632 ></HTML
 633 >