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