Annotation of 43BSDTahoe/man/man8/named.8, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1985 Regents of the University of California.
                      2: .\" All rights reserved.  The Berkeley software License Agreement
                      3: .\" specifies the terms and conditions for redistribution.
                      4: .\"
                      5: .\"    @(#)named.8     6.5 (Berkeley) 2/28/88
                      6: .\"
                      7: .TH NAMED 8 "February 28, 1988"
                      8: .UC 4
                      9: .SH NAME
                     10: named \- Internet domain name server
                     11: .SH SYNOPSIS
                     12: .B named
                     13: [
                     14: .B \-d
                     15: .I debuglevel
                     16: ] [
                     17: .B \-p
                     18: .I port#
                     19: ] [{\-b}
                     20: .I bootfile
                     21: ]
                     22: .SH DESCRIPTION
                     23: .I Named
                     24: is the Internet domain name server.
                     25: See RFC883 for more information on the Internet name-domain system.
                     26: Without any arguments,
                     27: .I named
                     28: will read the default boot file
                     29: .IR /etc/named.boot ,
                     30: read any initial data and listen for queries.
                     31: .PP
                     32: Options are:
                     33: .TP
                     34: .B \-d
                     35: Print debugging information.
                     36: A number after the ``d'' determines the level of
                     37: messages printed.
                     38: .TP
                     39: .B \-p
                     40: Use a different port number.  The default is the standard port number
                     41: as listed in /etc/services.
                     42: .TP
                     43: .B \-b
                     44: Use an alternate boot file.  This is optional and allows you to
                     45: specify a file with a leading dash.
                     46: .PP
                     47: Any additional argument is taken as the name of the boot file.
                     48: The boot file contains information about where the name server is to get
                     49: its initial data.  If multiple boot files are specified, only the last
                     50: is used.
                     51: Lines in the boot file cannot be continued on subsequent lines.
                     52: The following is a small example:
                     53: .in +2m
                     54: .nf
                     55: 
                     56: ;
                     57: ;      boot file for name server
                     58: ;
                     59: directory      /usr/local/domain
                     60: 
                     61: .ta \w'forwarders\ 'u +\w'6.32.128.IN-ADDR.ARPA\ 'u +\w'128.32.137.8 128.32.137.3\ 'u
                     62: ; type domain  source host/file                                backup file
                     63: 
                     64: cache  .                                                       root.cache
                     65: primary        Berkeley.EDU    berkeley.edu.zone
                     66: primary        32.128.IN-ADDR.ARPA     ucbhosts.rev
                     67: secondary      CC.Berkeley.EDU 128.32.137.8 128.32.137.3       cc.zone.bak
                     68: secondary      6.32.128.IN-ADDR.ARPA   128.32.137.8 128.32.137.3       cc.rev.bak
                     69: primary        0.0.127.IN-ADDR.ARPA                                    localhost.rev
                     70: forwarders     10.0.0.78 10.2.0.78
                     71: ; slave
                     72: 
                     73: .DT
                     74: .fi
                     75: .in
                     76: The ``directory'' line causes the server to change its
                     77: working directory to the directory specified.  This can
                     78: be important for the correct processing of $INCLUDE files
                     79: in primary zone files.
                     80: .LP
                     81: The ``cache'' line specifies that data in ``root.cache'' is to be
                     82: placed in the backup cache.
                     83: Its main use is to specify data such as locations of root domain servers.
                     84: This cache is not used during normal operation,
                     85: but is used as ``hints'' to find the current root servers.
                     86: The file ``root.cache'' is in the same format as ``berkeley.edu.zone''.
                     87: There can be more than one ``cache'' file specified.
                     88: .\"The first such file will be updated under certain conditions to snapshot the
                     89: .\"cache (see SIGQUIT below).
                     90: .\"The cache line can also have an optional interval argument after
                     91: .\"the filename.
                     92: .\"If an interval is listed,
                     93: .\"it requests the nameserver to dump the cache contents
                     94: .\"at that interval (in seconds).
                     95: .\"The example above requests the nameserver to dump the cache content
                     96: .\"every 3600 seconds (once an hour).
                     97: .\"The use of automatic cache file updates is not currently recommended
                     98: .\"because of the way the cache is currently managed by the server;
                     99: .\"although the entire cache will be dumped for later reloading,
                    100: .\"most of the cache contents will be ignored when reloaded.
                    101: .\"The exact dump interval will vary
                    102: .\"based on the minimum maintence interval time which is typically about
                    103: .\"5 minutes.
                    104: The cache files are processed in such a way as to preserve the
                    105: time-to-live's
                    106: of data dumped out.  Data for the root nameservers is kept artificially
                    107: valid if necessary.
                    108: .LP
                    109: The first ``primary'' line states that the file ``berkeley.edu.zone'' contains
                    110: authoritative data for the ``Berkeley.EDU'' zone.
                    111: The file ``berkeley.edu.zone''
                    112: contains data in the master file format described in RFC883.
                    113: All domain names are relative to the origin, in this
                    114: case, ``Berkeley.EDU'' (see below for a more detailed description).
                    115: The second ``primary'' line states that the file ``ucbhosts.rev'' contains
                    116: authoritative data for the domain ``32.128.IN-ADDR.ARPA,'' which is used
                    117: to translate addresses in network 128.32 to hostnames.
                    118: Each master file should begin with an SOA record for the zone
                    119: (see below).
                    120: .LP
                    121: The first ``secondary'' line specifies that all authoritative data
                    122: under ``CC.Berkeley.EDU'' is to be transferred from the name server
                    123: at 128.32.137.8.  If the transfer fails it will try 128.32.137.3 and
                    124: continue trying the addresses, up to 10, listed on this line.
                    125: The secondary copy is also authoritative for the specified domain.
                    126: The first non-dotted-quad address on this line will be taken
                    127: as a filename in which to backup the transfered zone.
                    128: The name server will load the zone from this backup file if it exists
                    129: when it boots, providing a complete copy even if the master servers
                    130: are unreachable.
                    131: Whenever a new copy of the domain is received by automatic zone transfer
                    132: from one of the master servers, this file will be updated.
                    133: The second ``secondary'' line states that the address-to-hostname
                    134: mapping for the subnet 128.32.136 should be obtained from the same list
                    135: of master servers as the previous zone.
                    136: .LP
                    137: The ``forwarders'' line specifies the addresses of sitewide servers
                    138: that will accept recursive queries from other servers.
                    139: If the boot file specifies one or more forwarders, then the
                    140: server will send all queries for data not in the cache to the forwarders first.
                    141: Each forwarder will be asked in turn until an answer is returned
                    142: or the list is exhausted.  If no answer is forthcoming from a
                    143: forwarder, the server will continue as it would have without
                    144: the forwarders line unless it is in ``slave'' mode.
                    145: The forwarding facility is useful
                    146: to cause a large sitewide cache to be generated on a master,
                    147: and to reduce traffic over links to outside servers.
                    148: It can also be used to allow servers to run that do not have
                    149: access directly to the Internet, but wish to act as though
                    150: they do.
                    151: .LP
                    152: The ``slave'' line (shown commented out) is used to put the server
                    153: in slave mode.  In this mode, the server will only make queries to
                    154: forwarders.  This option is normally used on machine that wish to
                    155: run a server but for physical or administrative reasons cannot
                    156: be given access to the Internet, but have access to a host that
                    157: does have access.
                    158: .LP
                    159: The ``sortlist'' line can be used to indicate networks that are to be
                    160: preferred over other, unlisted networks.
                    161: Queries for host addresses from hosts on the same network as the server
                    162: will receive responses with local network addresses listed first,
                    163: then addresses on the sort list, then other addresses.
                    164: This line is only acted on at initial startup.
                    165: When reloading the nameserver with
                    166: a SIGHUP, this line will be ignored.
                    167: .PP
                    168: The master file consists of control information
                    169: and a list of resource records for objects in the zone
                    170: of the forms:
                    171: .RS
                    172: .nf
                    173: 
                    174: $INCLUDE <filename> <opt_domain>
                    175: $ORIGIN <domain>
                    176: <domain> <opt_ttl> <opt_class> <type> <resource_record_data>
                    177: 
                    178: .fi
                    179: .RE
                    180: where
                    181: .I domain
                    182: is "." for root, "@" for the current origin, or a standard domain
                    183: name. If
                    184: .I domain
                    185: is a standard domain name that does not end with ``.'', the current origin
                    186: is appended to the domain. Domain names ending with ``.'' are
                    187: unmodified.
                    188: The
                    189: .I opt_domain
                    190: field is used to define an origin for the data in an included file.
                    191: It is equivalent to placing a $ORIGIN statement before the first
                    192: line of the included file.  The field is optional.
                    193: Neither the
                    194: .I opt_domain
                    195: field nor $ORIGIN statements in the included file modify the current origin
                    196: for this file.
                    197: The
                    198: .I opt_ttl
                    199: field is an optional integer number for the time-to-live field.
                    200: It defaults to zero, meaning the minimum value specified in the SOA
                    201: record for the zone.
                    202: The
                    203: .I opt_class
                    204: field is the object address type; currently only one type is supported,
                    205: .BR IN ,
                    206: for objects connected to the DARPA Internet. 
                    207: The
                    208: .I type
                    209: field contains one of the following tokens; the data expected in the
                    210: .I resource_record_data
                    211: field is in parentheses.
                    212: .TP "\w'MINFO    'u"
                    213: A
                    214: a host address (dotted quad)
                    215: .IP NS
                    216: an authoritative name server (domain)
                    217: .IP MX
                    218: a mail exchanger (domain)
                    219: .IP CNAME
                    220: the canonical name for an alias (domain)
                    221: .IP SOA
                    222: marks the start of a zone of authority (domain of originating host,
                    223: domain address of maintainer, a serial number and the following
                    224: parameters in seconds: refresh, retry, expire and minimum TTL (see RFC883))
                    225: .IP MB
                    226: a mailbox domain name (domain)
                    227: .IP MG
                    228: a mail group member (domain)
                    229: .IP MR
                    230: a mail rename domain name (domain)
                    231: .IP NULL
                    232: a null resource record (no format or data)
                    233: .IP WKS
                    234: a well know service description (not implemented yet)
                    235: .IP PTR
                    236: a domain name pointer (domain)
                    237: .IP HINFO
                    238: host information (cpu_type OS_type)
                    239: .IP MINFO
                    240: mailbox or mail list information (request_domain error_domain)
                    241: .PP
                    242: Resource records normally end at the end of a line,
                    243: but may be continued across lines between opening and closing parentheses.
                    244: Comments are introduced by semicolons and continue to the end of the line.
                    245: .PP
                    246: Each master zone file should begin with an SOA record for the zone.
                    247: An example SOA record is as follows:
                    248: .LP
                    249: .nf
                    250: @      IN      SOA     ucbvax.Berkeley.EDU. rwh.ucbvax.Berkeley.EDU. (
                    251:                                2.89    ; serial
                    252:                                10800   ; refresh
                    253:                                3600    ; retry
                    254:                                3600000 ; expire
                    255:                                86400 ) ; minimum
                    256: .fi
                    257: .LP
                    258: The SOA lists a serial number, which should be changed each time the master
                    259: file is changed.
                    260: Secondary servers check the serial number at intervals specified by the refresh
                    261: time in seconds; if the serial number changes, a zone transfer will be done
                    262: to load the new data.
                    263: If a master server cannot be contacted when a refresh is due, the retry time
                    264: specifies the interval at which refreshes should be attempted until successful.
                    265: If a master server cannot be contacted within the interval given by the
                    266: expire time, all data from the zone is discarded by secondary servers.
                    267: The minimum value is the time-to-live used by records in the file
                    268: with no explicit time-to-live value.
                    269: .SH NOTES
                    270: The boot file directives ``domain'' and ``suffixes'' have been
                    271: obsoleted by a more useful resolver based implementation of
                    272: suffixing for partially qualified domain names.  The prior mechanisms
                    273: could fail under a number of situations, especially when then local
                    274: nameserver did not have complete information.
                    275: .sp
                    276: The following signals have the specified effect when sent to the
                    277: server process using the
                    278: .IR kill (1)
                    279: command.
                    280: .IP SIGHUP
                    281: Causes server to read named.boot and reload database.
                    282: .IP SIGINT
                    283: Dumps current data base and cache to /usr/tmp/named_dump.db
                    284: .\".IP SIGQUIT
                    285: .\"Causes the server to checkpoint the cache into the first ``cache'' file.
                    286: .IP SIGIOT
                    287: Dumps statistics data into /usr/tmp/named.stats if the server is
                    288: compiled -DSTATS.  Statistics data is appended to the file.
                    289: .IP SIGSYS
                    290: Dumps the profiling data in /usr/tmp if the server is compiled
                    291: with profiling (server forks, chdirs and exits).
                    292: .IP SIGTERM
                    293: Dumps the primary and secondary database files.
                    294: Used to save modified data on shutdown if the
                    295: server is compiled with dynamic updating enabled.
                    296: .IP SIGUSR1
                    297: Turns on debugging; each SIGUSR1 increments debug level.
                    298: (SIGEMT on older systems without SIGUSR1)
                    299: .IP SIGUSR2
                    300: Turns off debugging completely.
                    301: (SIGFPE on older systems without SIGUSR2)
                    302: .SH FILES
                    303: .nf
                    304: .ta \w'/usr/tmp/named_dump.db   'u
                    305: /etc/named.boot        name server configuration boot file
                    306: /etc/named.pid the process id
                    307: /usr/tmp/named.run     debug output
                    308: /usr/tmp/named_dump.db dump of the name server database
                    309: /usr/tmp/named.stats   nameserver statistics data
                    310: .fi
                    311: .SH "SEE ALSO"
                    312: kill(1), gethostbyname(3N), signal(3c), resolver(3), resolver(5), hostname(7),
                    313: RFC882, RFC883, RFC973, RFC974,
                    314: \fIName Server Operations Guide for BIND\fR

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.