external/bsd/libbind/dist/doc/hesiod.man3

   1 .\" Id: hesiod.man3,v 1.2 2009/01/21 00:12:34 each Exp
   2 .\"
   3 .\" Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  15 .\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .\" Copyright 1988, 1996 by the Massachusetts Institute of Technology.
  18 .\"
  19 .\" Permission to use, copy, modify, and distribute this
  20 .\" software and its documentation for any purpose and without
  21 .\" fee is hereby granted, provided that the above copyright
  22 .\" notice appear in all copies and that both that copyright
  23 .\" notice and this permission notice appear in supporting
  24 .\" documentation, and that the name of M.I.T. not be used in
  25 .\" advertising or publicity pertaining to distribution of the
  26 .\" software without specific, written prior permission.
  27 .\" M.I.T. makes no representations about the suitability of
  28 .\" this software for any purpose.  It is provided "as is"
  29 .\" without express or implied warranty.
  30 .\"
  31 .TH HESIOD 3 "30 November 1996"
  32 .SH NAME
  33 hesiod, hesiod_init, hesiod_resolve, hesiod_free_list, hesiod_to_bind, hesiod_end \- Hesiod name server interface library
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <hesiod.h>
  37 .PP
  38 .B int hesiod_init(void **\fIcontext\fP)
  39 .B char **hesiod_resolve(void *\fIcontext\fP, const char *\fIname\fP,
  40 .B      const char *\fItype\fP)
  41 .B void hesiod_free_list(void *\fIcontext\fP, char **\fIlist\fP);
  42 .B char *hesiod_to_bind(void *\fIcontext\fP, const char *\fIname\fP,
  43 .B      const char *\fItype\fP)
  44 .B void hesiod_end(void *\fIcontext\fP)
  45 .fi
  46 .SH DESCRIPTION
  47 This family of functions allows you to perform lookups of Hesiod
  48 information, which is stored as text records in the Domain Name
  49 Service.  To perform lookups, you must first initialize a
  50 .IR context ,
  51 an opaque object which stores information used internally by the
  52 library between calls.
  53 .I hesiod_init
  54 initializes a context, storing a pointer to the context in the
  55 location pointed to by the
  56 .I context
  57 argument.
  58 .I hesiod_end
  59 frees the resources used by a context.
  60 .PP
  61 .I hesiod_resolve
  62 is the primary interface to the library.  If successful, it returns a
  63 list of one or more strings giving the records matching
  64 .I name
  65 and
  66 .IR type .
  67 The last element of the list is followed by a NULL pointer.  It is the
  68 caller's responsibility to call
  69 .I hesiod_free_list
  70 to free the resources used by the returned list.
  71 .PP
  72 .I hesiod_to_bind
  73 converts
  74 .I name
  75 and
  76 .I type
  77 into the DNS name used by
  78 .IR hesiod_resolve .
  79 It is the caller's responsibility to free the returned string using
  80 .IR free .
  81 .SH RETURN VALUES
  82 If successful,
  83 .I hesiod_init
  84 returns 0; otherwise it returns \-1 and sets
  85 .I errno
  86 to indicate the error.  On failure,
  87 .I hesiod_resolve
  88 and
  89 .I hesiod_to_bind
  90 return NULL and set the global variable
  91 .I errno
  92 to indicate the error.
  93 .SH ENVIRONMENT
  94 If the environment variable
  95 .B HES_DOMAIN
  96 is set, it will override the domain in the Hesiod configuration file.
  97 If the environment variable
  98 .B HESIOD_CONFIG
  99 is set, it specifies the location of the Hesiod configuration file.
 100 .SH SEE ALSO
 101 `Hesiod - Project Athena Technical Plan -- Name Service'
 102 .SH ERRORS
 103 Hesiod calls may fail because of:
 104 .IP ENOMEM
 105 Insufficient memory was available to carry out the requested
 106 operation.
 107 .IP ENOEXEC
 108 .I hesiod_init
 109 failed because the Hesiod configuration file was invalid.
 110 .IP ECONNREFUSED
 111 .I hesiod_resolve
 112 failed because no name server could be contacted to answer the query.
 113 .IP EMSGSIZE
 114 .I hesiod_resolve
 115 failed because the query or response was too big to fit into the
 116 packet buffers.
 117 .IP ENOENT
 118 .I hesiod_resolve
 119 failed because the name server had no text records matching
 120 .I name
 121 and
 122 .IR type ,
 123 or
 124 .I hesiod_to_bind
 125 failed because the
 126 .I name
 127 argument had a domain extension which could not be resolved with type
 128 ``rhs-extension'' in the local Hesiod domain.
 129 .SH AUTHOR
 130 Steve Dyer, IBM/Project Athena
 131 .br
 132 Greg Hudson, MIT Team Athena
 133 .br
 134 Copyright 1987, 1988, 1995, 1996 by the Massachusetts Institute of Technology.
 135 .SH BUGS
 136 The strings corresponding to the
 137 .I errno
 138 values set by the Hesiod functions are not particularly indicative of
 139 what went wrong, especially for
 140 .I ENOEXEC
 141 and
 142 .IR ENOENT .