share/man/man3lib/libresolv.3lib

   1 '\" te
   2 .\" Copyright (C) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LIBRESOLV 3LIB "Mar 24, 2004"
   7 .SH NAME
   8 libresolv \- resolver library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lresolv\fR [ \fIlibrary\fR... ]
  13 #include <\fBsys/types.h\fR>
  14 #include <\fBnetinet/in.h\fR>
  15 #include <\fBarpa/nameser.h\fR>
  16 #include <\fBresolv.h\fR>
  17 #include <\fBnetdb.h\fR>
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 Functions in this library provide for creating, sending, and interpreting
  24 packets to the Internet domain name servers.
  25 .SH INTERFACES
  26 .sp
  27 .LP
  28 The shared object \fBlibresolv.so.2\fR provides the public interfaces defined
  29 below. See \fBIntro\fR(3) for additional information on shared object
  30 interfaces.
  31 .sp
  32
  33 .sp
  34 .TS
  35 l l
  36 l l .
  37 \fB__dn_skipname\fR     \fB__fp_query\fR
  38 \fB__hostalias\fR       \fB__p_cdname\fR
  39 \fB__p_class\fR \fB__p_query\fR
  40 \fB__p_time\fR  \fB__p_type\fR
  41 \fB__putlong\fR \fB_getlong\fR
  42 \fB_getshort\fR \fB_res\fR
  43 \fBdn_comp\fR   \fBdn_expand\fR
  44 \fBfp_resstat\fR        \fBh_errno\fR
  45 \fBherror\fR    \fBhstrerror\fR
  46 \fBres_hostalias\fR     \fBres_init\fR
  47 \fBres_mkquery\fR       \fBres_nclose\fR
  48 \fBres_ninit\fR \fBres_nmkquery\fR
  49 \fBres_nquery\fR        \fBres_nquerydomain\fR
  50 \fBres_nsearch\fR       \fBres_nsend\fR
  51 \fBres_nsendsigned\fR   \fBres_query\fR
  52 \fBres_querydomain\fR   \fBres_search\fR
  53 \fBres_send\fR  \fBres_update\fR
  54 .TE
  55
  56 .sp
  57 .LP
  58 Programs are expected to use the aliases defined in  <\fBresolv.h\fR> rather
  59 than calling the "__" prefixed procedures, as indicated in the following table.
  60 Use of the routines in the first column is discouraged.
  61 .sp
  62
  63 .sp
  64 .TS
  65 c c
  66 l l .
  67 \fBFUNCTION REFERENCED\fR       \fBALIAS TO USE\fR
  68 \fB__dn_skipname\fR     \fBdn_skipname\fR
  69 \fB__fp_query\fR        \fBfp_query\fR
  70 \fB__putlong\fR \fBputlong\fR
  71 \fB__p_cdname\fR        \fBp_cdname\fR
  72 \fB__p_class\fR \fBp_class\fR
  73 \fB__p_time\fR  \fBp_time\fR
  74 \fB__p_type\fR  \fBp_type\fR
  75 .TE
  76
  77 .SH FILES
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fB/lib/libresolv.so.1\fR\fR
  82 .ad
  83 .RS 26n
  84 shared object for backward compatibility only
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB/lib/64/libresolv.so.1\fR\fR
  91 .ad
  92 .RS 26n
  93 64-bit shared object for backward compatibility only
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fB/lib/libresolv.so.2\fR\fR
 100 .ad
 101 .RS 26n
 102 shared object
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fB/lib/64/libresolv.so.2\fR\fR
 109 .ad
 110 .RS 26n
 111 64-bit shared object
 112 .RE
 113
 114 .SH ATTRIBUTES
 115 .sp
 116 .LP
 117 See \fBattributes\fR(5) for descriptions of the following attributes:
 118 .sp
 119
 120 .sp
 121 .TS
 122 box;
 123 c | c
 124 l | l .
 125 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 126 _
 127 Interface Stability     Standard:  BIND 8.2.4
 128 _
 129 MT-Level        See \fBresolver\fR(3RESOLV)
 130 .TE
 131
 132 .SH SEE ALSO
 133 .sp
 134 .LP
 135 \fBpvs\fR(1), \fBIntro\fR(3), \fBresolver\fR(3RESOLV), \fBattributes\fR(5)