summaryrefslogtreecommitdiff
path: root/usr/src/man/man3resolv/resolver.3resolv
diff options
context:
space:
mode:
authorJerry Jelinek <jerry.jelinek@joyent.com>2016-06-22 12:55:10 +0000
committerJerry Jelinek <jerry.jelinek@joyent.com>2016-06-22 12:55:10 +0000
commit8bae72dc3f645da905eab5fe960867037f57bae0 (patch)
tree24dce03bc58aa36ef080558a440d351c2237d4db /usr/src/man/man3resolv/resolver.3resolv
parent766f41d1d95d047e65ac4942d66037ce7f924027 (diff)
parent01aaaf328842760a1002109b299908a027e94cf8 (diff)
downloadillumos-joyent-release-20160625.tar.gz
[illumos-gate merge]release-20160625
commit 01aaaf328842760a1002109b299908a027e94cf8 7051 want id_space(9F) docs commit c1de7575521deda5ee777b8054a9c5b12f15b1ee 7120 mDNS resync was not wsdiff safe commit 9c05409f2b9301e686735887a9573454cceb0331 7069 i386_XARCH should include -m32 commit 406fc5100dac8d225a315a6def6be8d628f34e24 6602 lofi should support labeled devices commit f3a07f941f1be263a48a040c059edbcb722cf436 4712 Prefer 'parsable' over 'parseable' in the manual pages commit 1b2031a95889aea96be6af55dcf31a0d5ffdfed9 7050 Prefer 'subcommand' over 'sub-command' in the manual pages commit 831b40b1c811223fd0b1131791a38e3ae5143377 7049 Prefer 'writable' over 'writeable' in the manual pages commit a716f1a92056bc2e231e57ae2a20725ce606ea73 7047 Fix spelling mistakes in sections 9E, 9F and 9S commit 95e15299a2c42b8014fa27631a6f3be2a93febc2 7048 Fix spelling mistakes in sections 7D, 7I, 7IPP, and 7P commit df23565fe1d0b225f9f898c50dfafea6749b0b7f 7046 Fix spelling mistakes in section 5 commit c855112f85cf71e42f6381a66f3f86f98e2ed24e 7045 Fix spelling mistakes in section 4 commit 843c398e8904ed9d833d2af3103894f909fb4b52 7042 Fix spelling mistakes in library sections commit 0db8de19c0e494758b68b702523a2b0eaffe3b2e 7044 Fix spelling mistakes in sections 1HAS and 2 commit df23d905b96680e56379c5a5ecb4b363f36b9e74 7041 Fix spelling mistakes in sections 1 and 1M commit 71af3be340c57171837478555e2eb0d496318cfc 7040 Detect common spelling errors in manual pages Conflicts: usr/src/uts/common/fs/vfs.c usr/src/man/man7d/cpuid.7d usr/src/man/man5/privileges.5 usr/src/man/man3c/signalfd.3c usr/src/cmd/lofiadm/main.c
Diffstat (limited to 'usr/src/man/man3resolv/resolver.3resolv')
-rw-r--r--usr/src/man/man3resolv/resolver.3resolv23
1 files changed, 2 insertions, 21 deletions
diff --git a/usr/src/man/man3resolv/resolver.3resolv b/usr/src/man/man3resolv/resolver.3resolv
index a391775de0..f54bda17d1 100644
--- a/usr/src/man/man3resolv/resolver.3resolv
+++ b/usr/src/man/man3resolv/resolver.3resolv
@@ -1,7 +1,7 @@
'\" te
.\" Portions Copyright 1989 AT&T Portions Copyright (c) 1985, 1995 Regents of the University of California.
.\" Copyright (C) 2006, Sun Microsystems, Inc. All Rights Reserved
-.TH RESOLVER 3RESOLV "Dec 26, 2006"
+.TH RESOLVER 3RESOLV "April 9, 2016"
.SH NAME
resolver, res_ninit, fp_resstat, res_hostalias, res_nquery, res_nsearch,
res_nquerydomain, res_nmkquery, res_nsend, res_nclose, res_nsendsigned,
@@ -163,7 +163,6 @@ Deprecated Interfaces
.fi
.SH DESCRIPTION
-.sp
.LP
These routines are used for making, sending, and interpreting query and reply
messages with Internet domain name servers.
@@ -180,7 +179,7 @@ The \fBres_ndestroy()\fR function should be called to free memory allocated by
.LP
The functions \fBres_init()\fR, \fBres_query()\fR, \fBres_search()\fR,
\fBres_mkquery()\fR, \fBres_send()\fR, and \fBherror()\fR are deprecated. They
-are supplied for backwards compatability. They use global configuration and
+are supplied for backwards compatibility. They use global configuration and
state information that is kept in the structure \fB_res\fR rather than state
information referenced through \fIstatp\fR.
.sp
@@ -327,7 +326,6 @@ the header would be updated.
.RE
.SS "\fBres_ninit()\fR, \fBres_init()\fR"
-.sp
.LP
The \fBres_ninit()\fR and \fBres_init()\fR routines read the configuration
file, if any is present, to get the default domain name, search list and the
@@ -347,7 +345,6 @@ are inherited from the configuration file's \fBoptions\fR command. See
\fBRES_OPTIONS\fR environment variable. Initialization normally occurs on the
first call to one of the other resolver routines.
.SS "\fBres_nquery()\fR, \fBres_query()\fR"
-.sp
.LP
The \fBres_nquery()\fR and \fBres_query()\fR functions provide interfaces to
the server query mechanism. They construct a query, send it to the local
@@ -367,7 +364,6 @@ by the previous query. \fIanswer\fR must be large enough to receive a maximum
\fBUDP\fR response from the server or parts of the \fIanswer\fR will be
silently discarded. The default maximum \fBUDP\fR response size is 512 bytes.
.SS "\fBres_nsearch()\fR, \fBres_search()\fR"
-.sp
.LP
The \fBres_nsearch()\fR and \fBres_search()\fR routines make a query and await
a response, just like like \fBres_nquery()\fR and \fBres_query()\fR. In
@@ -385,13 +381,11 @@ by the previous query. \fIanswer\fR must be large enough to receive a maximum
\fBUDP\fR response from the server or parts of the \fIanswer\fR will be
silently discarded. The default maximum \fBUDP\fR response size is 512 bytes.
.SS "\fBres_nquerydomain()\fR"
-.sp
.LP
The \fBres_nquerydomain()\fR function calls \fBres_query()\fR on the
concatenation of \fIname\fR and \fIdomain\fR, removing a trailing dot from
\fIname\fR if \fIdomain\fR is \fINULL\fR.
.SS "\fBres_nmkquery()\fR, \fBres_mkquery()\fR"
-.sp
.LP
These routines are used by \fBres_nquery()\fR and \fBres_query()\fR. The
\fBres_nmkquery()\fR and \fBres_mkquery()\fR functions construct a standard
@@ -401,7 +395,6 @@ the query, or -1 if the query is larger than \fIbuflen\fR. The query type
<\fBarpa/nameser.h\fR>. The domain name for the query is given by \fIdname\fR.
\fInewrr\fR is currently unused but is intended for making update messages.
.SS "\fBres_nsend()\fR, \fBres_send()\fR, \fBres_nsendsigned()\fR"
-.sp
.LP
The \fBres_nsend()\fR, \fBres_send()\fR, and \fBres_nsendsigned()\fR routines
send a pre-formatted query that returns an \fIanswer\fR. The routine calls
@@ -421,30 +414,25 @@ by the previous query. \fIanswer\fR must be large enough to receive a maximum
\fBUDP\fR response from the server or parts of the \fIanswer\fR will be
silently discarded. The default maximum \fBUDP\fR response size is 512 bytes.
.SS "\fBfp_resstat()\fR"
-.sp
.LP
The function \fBfp_resstat()\fR prints out the active flag bits in
\fIstatp\fR->\fBoptions\fR preceded by the text "\fB;; res options:\fR" on
\fIfile\fR.
.SS "\fBres_hostalias()\fR"
-.sp
.LP
The function \fBres_hostalias()\fR looks up \fIname\fR in the file referred to
by the \fBHOSTALIASES\fR environment variable and returns the fully qualified
host name. If \fIname\fR is not found or an error occurs, \fBNULL\fR is
returned. \fBres_hostalias()\fR stores the result in \fIbuf\fR.
.SS "\fBres_nclose()\fR"
-.sp
.LP
The \fBres_nclose()\fR function closes any open files referenced through
\fIstatp\fR.
.SS "\fBres_ndestroy()\fR"
-.sp
.LP
The \fBres_ndestroy()\fR function calls \fBres_nclose()\fR, then frees any
memory allocated by \fBres_ninit()\fR referenced through \fIstatp\fR.
.SS "\fBdn_comp()\fR"
-.sp
.LP
The \fBdn_comp()\fR function compresses the domain name \fIexp_dn\fR and stores
it in \fIcomp_dn\fR. The \fBdn_comp()\fR function returns the size of the
@@ -463,7 +451,6 @@ labels inserted into the message by \fBdn_comp()\fR as the name is compressed.
If \fIdnptrs\fR is \fINULL\fR, names are not compressed. If \fIlastdnptr\fR is
\fINULL\fR, \fBdn_comp()\fR does not update the list of labels.
.SS "\fBdn_expand()\fR"
-.sp
.LP
The \fBdn_expand()\fR function expands the compressed domain name \fIcomp_dn\fR
to a full domain name. The compressed name is contained in a query or reply
@@ -472,7 +459,6 @@ uncompressed name is placed in the buffer indicated by \fIexp_dn\fR, which is
of size \fIlength\fR. The \fBdn_expand()\fR function returns the size of the
compressed name, or \fB\(mi1\fR if there was an error.
.SS "\fBhstrerror()\fR, \fBherror()\fR"
-.sp
.LP
The variables \fIstatp->res_h_errno\fR and \fI_res.res_h_errno\fR and external
variable \fIh_errno\fR are set whenever an error occurs during a resolver
@@ -500,12 +486,10 @@ message corresponding to the value of \fIh_errno\fR.
The \fBhstrerror()\fR function returns a string, which is the message text that
corresponds to the value of the \fIerr\fR parameter.
.SS "\fBres_setservers()\fR, \fBres_getservers()\fR"
-.sp
.LP
The functions \fBres_getservers()\fR and \fBres_setservers()\fR are used to get
and set the list of servers to be queried.
.SH FILES
-.sp
.ne 2
.na
\fB\fB/etc/resolv.conf\fR\fR
@@ -515,7 +499,6 @@ resolver configuration file
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -534,7 +517,6 @@ T}
.TE
.SH SEE ALSO
-.sp
.LP
\fBdomainname\fR(1M), \fBgethostbyname\fR(3NSL), \fBlibresolv\fR(3LIB),
\fBresolv.conf\fR(4), \fBattributes\fR(5)
@@ -563,7 +545,6 @@ November 1987.
Vixie, Paul, Dunlap, Kevin J., Karels, Michael J. \fIName Server Operations
Guide for BIND\fR. Internet Software Consortium, 1996.
.SH NOTES
-.sp
.LP
When the caller supplies a work buffer, for example the \fIanswer\fR buffer
argument to \fBres_nsend()\fR or \fBres_send()\fR, the buffer should be aligned