diff options
author | jmc <> | 2012-11-29 21:37:13 +0000 |
---|---|---|
committer | jmc <> | 2012-11-29 21:37:13 +0000 |
commit | 0e46258b9990cfb456367b54a1dc872870086bd3 (patch) | |
tree | d95fbed6b6f0d3692659e7b989110cce2d5f88e5 | |
parent | 02b81b29f81045ee6d53dbbdf9ce83b05a9811cb (diff) | |
download | openbsd-0e46258b9990cfb456367b54a1dc872870086bd3.tar.gz openbsd-0e46258b9990cfb456367b54a1dc872870086bd3.tar.bz2 openbsd-0e46258b9990cfb456367b54a1dc872870086bd3.zip |
- put the various options into the same order as those in resolv.h
- sync RES_DEBUG with resolv.conf.5
- document RES_PRIMARY, but mark it unsupported (like we already do
for RES_AAAONLY)
- use the exact same text (about being enabled by default) for
RES_RECURSE as for the other two defaults
- document RES_INSECURE{1,2} - description lifted from resolv.conf.5
- document RES_NOALIASES
- mostly sync the RES_USE_EDNS0 text with resolv.conf.5
- RES_USE_DNSSEC not documented for now. something to come...
ok sthen
-rw-r--r-- | src/lib/libc/net/resolver.3 | 55 |
1 files changed, 38 insertions, 17 deletions
diff --git a/src/lib/libc/net/resolver.3 b/src/lib/libc/net/resolver.3 index 1982d1c8b1..97b7a2d8cc 100644 --- a/src/lib/libc/net/resolver.3 +++ b/src/lib/libc/net/resolver.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: resolver.3,v 1.25 2012/11/19 16:39:30 jmc Exp $ | 1 | .\" $OpenBSD: resolver.3,v 1.26 2012/11/29 21:37:13 jmc Exp $ |
2 | .\" | 2 | .\" |
3 | .\" Copyright (c) 1985, 1991, 1993 | 3 | .\" Copyright (c) 1985, 1991, 1993 |
4 | .\" The Regents of the University of California. All rights reserved. | 4 | .\" The Regents of the University of California. All rights reserved. |
@@ -27,7 +27,7 @@ | |||
27 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | 27 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
28 | .\" SUCH DAMAGE. | 28 | .\" SUCH DAMAGE. |
29 | .\" | 29 | .\" |
30 | .Dd $Mdocdate: November 19 2012 $ | 30 | .Dd $Mdocdate: November 29 2012 $ |
31 | .Dt RESOLVER 3 | 31 | .Dt RESOLVER 3 |
32 | .Os | 32 | .Os |
33 | .Sh NAME | 33 | .Sh NAME |
@@ -112,14 +112,19 @@ are defined in | |||
112 | and are as follows. | 112 | and are as follows. |
113 | Options are stored as a simple bit mask containing the bitwise OR | 113 | Options are stored as a simple bit mask containing the bitwise OR |
114 | of the options enabled. | 114 | of the options enabled. |
115 | .Bl -tag -width RES_USE_INET6 | 115 | .Bl -tag -width RES_USE_DNSSEC |
116 | .It Dv RES_INIT | 116 | .It Dv RES_INIT |
117 | True if the initial name server address and default domain name are | 117 | True if the initial name server address and default domain name are |
118 | initialized (i.e.\& | 118 | initialized (i.e.\& |
119 | .Fn res_init | 119 | .Fn res_init |
120 | has been called). | 120 | has been called). |
121 | .It Dv RES_DEBUG | 121 | .It Dv RES_DEBUG |
122 | Print debugging messages. | 122 | Print debugging messages, |
123 | if libc is compiled with | ||
124 | .Dv DEBUG . | ||
125 | By default on | ||
126 | .Ox | ||
127 | this option does nothing. | ||
123 | .It Dv RES_AAONLY | 128 | .It Dv RES_AAONLY |
124 | Accept authoritative answers only. | 129 | Accept authoritative answers only. |
125 | With this option, | 130 | With this option, |
@@ -128,26 +133,29 @@ should continue until it finds an authoritative answer or finds an error. | |||
128 | Currently this is not implemented. | 133 | Currently this is not implemented. |
129 | .It Dv RES_USEVC | 134 | .It Dv RES_USEVC |
130 | Use TCP connections for queries instead of UDP datagrams. | 135 | Use TCP connections for queries instead of UDP datagrams. |
131 | .It Dv RES_STAYOPEN | 136 | .It Dv RES_PRIMARY |
132 | Used with | 137 | Query the primary name server only. |
133 | .Dv RES_USEVC | 138 | Currently this is not implemented. |
134 | to keep the TCP connection open between queries. | ||
135 | This is useful only in programs that regularly do many queries. | ||
136 | UDP should be the normal mode used. | ||
137 | .It Dv RES_IGNTC | 139 | .It Dv RES_IGNTC |
138 | Ignore truncation errors, i.e. don't retry with TCP. | 140 | Ignore truncation errors, i.e. don't retry with TCP. |
139 | .It Dv RES_RECURSE | 141 | .It Dv RES_RECURSE |
140 | Set the recursion-desired bit in queries. | 142 | Set the recursion-desired bit in queries. |
141 | This is the default. | ||
142 | .Pf ( Fn res_send | 143 | .Pf ( Fn res_send |
143 | does not do iterative queries and expects the name server | 144 | does not do iterative queries and expects the name server |
144 | to handle recursion.) | 145 | to handle recursion.) |
146 | This option is enabled by default. | ||
145 | .It Dv RES_DEFNAMES | 147 | .It Dv RES_DEFNAMES |
146 | If set, | 148 | If set, |
147 | .Fn res_search | 149 | .Fn res_search |
148 | will append the default domain name to single-component names | 150 | will append the default domain name to single-component names |
149 | (those that do not contain a dot). | 151 | (those that do not contain a dot). |
150 | This option is enabled by default. | 152 | This option is enabled by default. |
153 | .It Dv RES_STAYOPEN | ||
154 | Used with | ||
155 | .Dv RES_USEVC | ||
156 | to keep the TCP connection open between queries. | ||
157 | This is useful only in programs that regularly do many queries. | ||
158 | UDP should be the normal mode used. | ||
151 | .It Dv RES_DNSRCH | 159 | .It Dv RES_DNSRCH |
152 | If this option is set, | 160 | If this option is set, |
153 | .Fn res_search | 161 | .Fn res_search |
@@ -156,6 +164,19 @@ will search for host names in the current domain and in parent domains; see | |||
156 | This is used by the standard host lookup routine | 164 | This is used by the standard host lookup routine |
157 | .Xr gethostbyname 3 . | 165 | .Xr gethostbyname 3 . |
158 | This option is enabled by default. | 166 | This option is enabled by default. |
167 | .It Dv RES_INSECURE_1 | ||
168 | Do not require the IP source address on the reply packet | ||
169 | to be equal to the server's address. | ||
170 | .It Dv RES_INSECURE_2 | ||
171 | Do not check if the query section of the reply packet | ||
172 | is equal to that of the query packet. | ||
173 | .It Dv RES_NOALIASES | ||
174 | Turn off the | ||
175 | .Ev HOSTALIASES | ||
176 | feature. | ||
177 | See | ||
178 | .Xr hostname 7 | ||
179 | for more information. | ||
159 | .It Dv RES_USE_INET6 | 180 | .It Dv RES_USE_INET6 |
160 | Enables support for IPv6-only applications. | 181 | Enables support for IPv6-only applications. |
161 | This causes IPv4 addresses to be returned as an IPv4 mapped address. | 182 | This causes IPv4 addresses to be returned as an IPv4 mapped address. |
@@ -163,12 +184,12 @@ For example, 10.1.1.1 will be returned as ::ffff:10.1.1.1. | |||
163 | The option is not meaningful on | 184 | The option is not meaningful on |
164 | .Ox . | 185 | .Ox . |
165 | .It Dv RES_USE_EDNS0 | 186 | .It Dv RES_USE_EDNS0 |
166 | Enables support for OPT pseudo-RR for EDNS0 extension. | 187 | Attach an OPT pseudo-RR for the EDNS0 extension, |
167 | With this option, resolver code will attach OPT pseudo-RR into DNS queries, | 188 | as specified in RFC 2671. |
168 | to inform of our receive buffer size. | 189 | This informs DNS servers of a client's receive buffer size, |
169 | The option will allow DNS servers to take advantage of non-default receive | 190 | allowing them to take advantage of a non-default receive buffer size, |
170 | buffer size, and to send larger replies. | 191 | and thus to send larger replies. |
171 | DNS query packets with EDNS0 extension is not compatible with | 192 | DNS query packets with the EDNS0 extension are not compatible with |
172 | non-EDNS0 DNS servers. | 193 | non-EDNS0 DNS servers. |
173 | .El | 194 | .El |
174 | .Pp | 195 | .Pp |