share/man/man5/resolver.5

   1 .\" Copyright (c) 1986, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)resolver.5  8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd September 9, 2004
  36 .Dt RESOLVER 5
  37 .Os
  38 .Sh NAME
  39 .Nm resolver
  40 .Nd resolver configuration file
  41 .Sh SYNOPSIS
  42 .Nm resolv.conf
  43 .Sh DESCRIPTION
  44 The
  45 .Xr resolver 3
  46 is a set of routines in the C library
  47 which provide access to the Internet Domain Name System.
  48 The resolver configuration file contains information that is read
  49 by the resolver routines the first time they are invoked by a process.
  50 The file is designed to be human readable and contains a list of
  51 keywords with values that provide various types of resolver information.
  52 .Pp
  53 On a normally configured system this file should not be necessary.
  54 The only name server to be queried will be on the local machine,
  55 the domain name is determined from the host name,
  56 and the domain search path is constructed from the domain name.
  57 .Pp
  58 The different configuration options are:
  59 .Bl -tag -width nameserver
  60 .It Sy nameserver
  61 Internet address (in dot notation) of a name server
  62 that the resolver should query.
  63 Up to
  64 .Dv MAXNS
  65 (currently 3) name servers may be listed,
  66 one per keyword.
  67 If there are multiple servers,
  68 the resolver library queries them in the order listed.
  69 If no
  70 .Sy nameserver
  71 entries are present,
  72 the default is to use the name server on the local machine.
  73 (The algorithm used is to try a name server, and if the query times out,
  74 try the next, until out of name servers,
  75 then repeat trying all the name servers
  76 until a maximum number of retries are made).
  77 .It Sy domain
  78 Local domain name.
  79 Most queries for names within this domain can use short names
  80 relative to the local domain.
  81 If no
  82 .Sy domain
  83 entry is present, the domain is determined
  84 from the local host name returned by
  85 .Xr gethostname 3 ;
  86 the domain part is taken to be everything after the first
  87 .Ql \&. .
  88 Finally, if the host name does not contain a domain part, the root
  89 domain is assumed.
  90 .It Sy search
  91 Search list for host-name lookup.
  92 The search list is normally determined from the local domain name;
  93 by default, it contains only the local domain name.
  94 This may be changed by listing the desired domain search path
  95 following the
  96 .Sy search
  97 keyword with spaces or tabs separating
  98 the names.
  99 Most resolver queries will be attempted using each component
 100 of the search path in turn until a match is found.
 101 Note that this process may be slow and will generate a lot of network
 102 traffic if the servers for the listed domains are not local,
 103 and that queries will time out if no server is available
 104 for one of the domains.
 105 .Pp
 106 The search list is currently limited to six domains
 107 with a total of 256 characters.
 108 .It Sy sortlist
 109 Sortlist allows addresses returned by gethostbyname to be sorted.
 110 A sortlist is specified by IP address netmask pairs.
 111 The netmask is
 112 optional and defaults to the natural netmask of the net.
 113 The IP address
 114 and optional network pairs are separated by slashes.
 115 Up to 10 pairs may
 116 be specified.
 117 E.g.,
 118 .Pp
 119 .Dl "sortlist 130.155.160.0/255.255.240.0 130.155.0.0"
 120 .It Sy options
 121 Options allows certain internal resolver variables to be modified.
 122 The syntax is
 123 .Pp
 124 \fBoptions\fP \fIoption\fP \fI...\fP
 125 .Pp
 126 where
 127 .Sy option
 128 is one of the following:
 129 .Pp
 130 .Bl -tag -width no_tld_query
 131 .It Sy debug
 132 sets
 133 .Dv RES_DEBUG
 134 in _res.options.
 135 .It Sy ndots: Ns Ar n
 136 sets a threshold for the number of dots which must appear in a name given to
 137 .Fn res_query
 138 (see
 139 .Xr resolver 3 )
 140 before an
 141 .Em initial absolute query
 142 will be made.
 143 The default for
 144 .Em n
 145 is
 146 .Dq 1 ,
 147 meaning that if there are any dots in a name, the name
 148 will be tried first as an absolute name before any
 149 .Em search list
 150 elements are appended to it.
 151 .It Sy timeout: Ns Ar n
 152 sets the initial amount of time the resolver will wait
 153 for a response from a remote
 154 name server before retrying the query via a different name server.
 155 The resolver may wait longer during subsequent retries
 156 of the current query since an exponential back-off is applied to
 157 the timeout value.
 158 Measured in seconds, the default is
 159 .Dv RES_TIMEOUT ,
 160 the allowed maximum is
 161 .Dv RES_MAXRETRANS
 162 (see
 163 .In resolv.h ) .
 164 .It Sy attempts: Ns Ar n
 165 sets the number of times the resolver will send a query to each of
 166 its name servers
 167 before giving up and returning an error to the calling application.
 168 The default is
 169 .Dv RES_DFLRETRY ,
 170 the allowed maximum is
 171 .Dv RES_MAXRETRY
 172 (see
 173 .In resolv.h ) .
 174 .It Sy no_tld_query
 175 tells the resolver not to attempt to resolve a top level domain name, that
 176 is, a name that contains no dots.
 177 Use of this option does not prevent
 178 the resolver from obeying the standard
 179 .Sy domain
 180 and
 181 .Sy search
 182 rules with the given name.
 183 .El
 184 .Pp
 185 Options may also be specified as a space or tab separated list using the
 186 .Dv RES_OPTIONS
 187 environment variable.
 188 .El
 189 .Pp
 190 The
 191 .Sy domain
 192 and
 193 .Sy search
 194 keywords are mutually exclusive.
 195 If more than one instance of these keywords is present,
 196 the last instance will override.
 197 .Pp
 198 The keyword and value must appear on a single line, and the keyword
 199 (e.g.\&
 200 .Sy nameserver )
 201 must start the line.
 202 The value follows the keyword, separated by white space.
 203 .Sh FILES
 204 .Bl -tag -width /etc/resolv.conf -compact
 205 .It Pa /etc/resolv.conf
 206 The file
 207 .Nm resolv.conf
 208 resides in
 209 .Pa /etc .
 210 .El
 211 .Sh SEE ALSO
 212 .Xr gethostbyname 3 ,
 213 .Xr resolver 3 ,
 214 .Xr hostname 7 ,
 215 .Xr named 8
 216 .Rs
 217 .%T "Name Server Operations Guide for BIND"
 218 .Re
 219 .Sh HISTORY
 220 The
 221 .Nm resolv.conf
 222 file format appeared in
 223 .Bx 4.3 .