diff options
| -rw-r--r-- | share/man/man5/resolv.conf.5 | 97 |
1 files changed, 51 insertions, 46 deletions
diff --git a/share/man/man5/resolv.conf.5 b/share/man/man5/resolv.conf.5 index c3ae8511681..367e73990f2 100644 --- a/share/man/man5/resolv.conf.5 +++ b/share/man/man5/resolv.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: resolv.conf.5,v 1.36 2012/10/02 06:31:47 jmc Exp $ +.\" $OpenBSD: resolv.conf.5,v 1.37 2012/10/05 06:25:13 jmc Exp $ .\" $NetBSD: resolv.conf.5,v 1.7 1996/03/06 18:22:16 scottr Exp $ .\" .\" Copyright (c) 1986, 1991 The Regents of the University of California. @@ -30,7 +30,7 @@ .\" .\" @(#)resolver.5 5.12 (Berkeley) 5/10/91 .\" -.Dd $Mdocdate: October 2 2012 $ +.Dd $Mdocdate: October 5 2012 $ .Dt RESOLV.CONF 5 .Os .Sh NAME @@ -92,7 +92,7 @@ to refer to hard-coded information in local files, or otherwise override the defaults. .Pp A keyword and its values must appear on a single line, and the keyword (e.g.\& -.Sy nameserver ) +.Cm nameserver ) must start the line. The value follows the keyword, separated by whitespace. A hash mark @@ -105,7 +105,7 @@ the routines that read the file. .Pp The configuration options (which may be placed in either file) are: .Bl -tag -width nameserver -.It Sy nameserver +.It Cm nameserver IPv4 address (in dot notation) or IPv6 address (in hex-and-colon notation) of a name server that the resolver should query. @@ -130,25 +130,25 @@ Up to If there are multiple servers, the resolver library queries them in the order listed. If no -.Sy nameserver +.Cm nameserver entries are present, the default is to use the name server on the local machine. (The algorithm used is to try a name server, and if the query times out, try the next, until out of name servers, then repeat trying all name servers until a maximum number of retries are performed.) -.It Sy domain +.It Cm domain Local domain name. Most queries for names within this domain can use short names relative to the local domain. If no -.Sy domain +.Cm domain entry is present, the domain is determined from the local host name returned by .Xr gethostname 3 ; the domain part is taken to be everything after the first -.Dq \&. . +.Sq \&. . Finally, if the host name does not contain a domain part, the root domain is assumed. -.It Sy lookup +.It Cm lookup This keyword is used by the library routines .Xr gethostbyname 3 and @@ -156,36 +156,35 @@ and It specifies which databases should be searched, and the order to do so. The legal space-separated values are: .Pp -.Bl -tag -width bind -compact -.It Sy bind -Use the Domain Name server by querying -.Xr named 8 . -.It Sy file +.Bl -tag -width bind -offset indent -compact +.It Cm bind +Query a domain name server. +.It Cm file Search for entries in .Pa /etc/hosts . -.It Sy yp +.It Cm yp Talk to the YP system if .Xr ypbind 8 is running. .El .Pp If the -.Sy lookup +.Cm lookup keyword is not used in the system's .Pa resolv.conf file then the assumed order is -.Sy bind file . +.Cm bind file . Furthermore, if the system's .Pa resolv.conf file does not exist, then the only database used is -.Sy file . -.It Sy search +.Cm file . +.It Cm search Search list for hostname lookup. The search list is normally determined from the local domain name; by default, it begins with the local domain name, then successive parent domains that have at least two components in their names. This may be changed by listing the desired domain search path following the -.Sy search +.Cm search keyword with spaces or tabs separating the names. Most resolver queries will be attempted using each component of the search path in turn until a match is found. @@ -197,35 +196,38 @@ for one of the domains. The search list is currently limited to six domains with a total of 1024 characters. Only one -.Nm search +.Cm search line should appear; if more than one is present, the last one found overwrites any values found in earlier lines. So if such a line appears in the .Nm resolv.conf.tail file, it should include all the domains that need to be searched. -.It Sy sortlist +.It Cm sortlist Allows addresses returned by .Xr gethostbyname 3 to be sorted. A -.Sy sortlist +.Cm sortlist is specified by IP address netmask pairs. The netmask is optional and defaults to the natural netmask of the net. The IP address and optional network pairs are separated by slashes. -Up to 10 pairs may be specified, e.g.: +Up to 10 pairs may be specified. +For example: .Pp -.Sy sortlist 130.155.160.0/255.255.240.0 130.155.0.0 -.It Sy family +.Dl sortlist 130.155.160.0/255.255.240.0 130.155.0.0 +.It Cm family Specify which type of Internet protocol family to prefer, if a host is reachable using different address families. By default IPv4 addresses are queried first, and then IPv6 addresses. The syntax is: +.Bd -ragged -offset indent +.Cm family Ar family Op Ar family +.Ed .Pp -.D1 family family1 [family2] -.Pp -A maximum of two families can be specified, -where family can be any of: +A maximum of two families can be specified, where +.Ar family +can be any of: .Pp .Bl -tag -width "inet4XXX" -offset indent -compact .It inet4 @@ -233,17 +235,20 @@ IPv4 queries. .It inet6 IPv6 queries. .El -.It Sy options +.It Cm options Allows certain internal resolver variables to be modified. The syntax is: +.Bd -ragged -offset indent +.Cm options Ar option ... +.Ed .Pp -.Sy options option ... -.Pp -where option is one of the following: +Where +.Ar option +is one of the following: .Bl -tag -width insecure1 -.It Sy debug +.It Cm debug Sets RES_DEBUG in _res.options. -.It Sy edns0 +.It Cm edns0 Attach OPT pseudo-RR for EDNS0 extension specified in RFC 2671, to inform DNS server of our receive buffer size. The option will allow DNS servers to take advantage of non-default receive @@ -251,22 +256,22 @@ buffer size, and to send larger replies. DNS query packets with EDNS0 extension are not compatible with non-EDNS0 DNS servers. The option must be used only when all the DNS servers listed in -.Sy nameserver +.Cm nameserver lines are able to handle EDNS0 extension. -.It Sy inet6 +.It Cm inet6 Enables support for IPv6-only applications, by setting RES_USE_INET6 in _res.options (see .Xr resolver 3 ) . Use of this option is discouraged, and meaningless on .Ox . -.It Sy insecure1 +.It Cm insecure1 Do not require IP source address on the reply packet to be equal to the server's address. -.It Sy insecure2 +.It Cm insecure2 Do not check if the query section of the reply packet is equal to that of the query packet. For testing purposes only. -.It Sy ndots:n +.It Cm ndots : Ns Ar n Sets a threshold for the number of dots which must appear in a name given to res_query (see .Xr resolver 3 ) @@ -275,16 +280,16 @@ The default for .Ar n is 1, meaning that if there are any dots in a name, the name will be tried first as an absolute name before any search list elements are appended to it. -.It Sy tcp +.It Cm tcp Forces the use of TCP for queries. Normal behaviour is to query via UDP but fall back to TCP on failure. .El .El .Pp The -.Sy domain +.Cm domain and -.Sy search +.Cm search keywords are mutually exclusive. If more than one instance of these keywords is present, the last instance will override. @@ -293,7 +298,7 @@ will override. .It Ev LOCALDOMAIN A space-separated list of search domains, overriding the -.Sy search +.Cm search keyword of a system's .Nm resolv.conf or @@ -302,7 +307,7 @@ file. .It Ev RES_OPTIONS A space-separated list of resolver options, overriding the -.Sy options +.Cm options keyword of a system's .Nm resolv.conf or |