contrib/bind-9.2.4rc7/lib/lwres/man/lwres_config.3

   1 .\" Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000, 2001  Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10 .\" AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14 .\" PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $Id: lwres_config.3,v 1.12.2.2 2004/03/15 04:45:00 marka Exp $
  17 .\"
  18 .TH "LWRES_CONFIG" "3" "Jun 30, 2000" "BIND9" ""
  19 .SH NAME
  20 lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get \- lightweight resolver configuration
  21 .SH SYNOPSIS
  22 \fB#include <lwres/lwres.h>
  23 .sp
  24 .na
  25 void
  26 lwres_conf_init(lwres_context_t *ctx);
  27 .ad
  28 .sp
  29 .na
  30 void
  31 lwres_conf_clear(lwres_context_t *ctx);
  32 .ad
  33 .sp
  34 .na
  35 lwres_result_t
  36 lwres_conf_parse(lwres_context_t *ctx, const char *filename);
  37 .ad
  38 .sp
  39 .na
  40 lwres_result_t
  41 lwres_conf_print(lwres_context_t *ctx, FILE *fp);
  42 .ad
  43 .sp
  44 .na
  45 lwres_conf_t *
  46 lwres_conf_get(lwres_context_t *ctx);
  47 .ad
  48 \fR
  49 .SH "DESCRIPTION"
  50 .PP
  51 \fBlwres_conf_init()\fR
  52 creates an empty
  53 \fBlwres_conf_t\fR
  54 structure for lightweight resolver context
  55 \fIctx\fR.
  56 .PP
  57 \fBlwres_conf_clear()\fR
  58 frees up all the internal memory used by
  59 that
  60 \fBlwres_conf_t\fR
  61 structure in resolver context
  62 \fIctx\fR.
  63 .PP
  64 \fBlwres_conf_parse()\fR
  65 opens the file
  66 \fIfilename\fR
  67 and parses it to initialise the resolver context
  68 \fIctx\fR's
  69 \fBlwres_conf_t\fR
  70 structure.
  71 .PP
  72 \fBlwres_conf_print()\fR
  73 prints the
  74 \fBlwres_conf_t\fR
  75 structure for resolver context
  76 \fIctx\fR
  77 to the
  78 \fBFILE\fR
  79 \fIfp\fR.
  80 .SH "RETURN VALUES"
  81 .PP
  82 \fBlwres_conf_parse()\fR
  83 returns
  84 LWRES_R_SUCCESS
  85 if it successfully read and parsed
  86 \fIfilename\fR.
  87 It returns
  88 LWRES_R_FAILURE
  89 if
  90 \fIfilename\fR
  91 could not be opened or contained incorrect
  92 resolver statements.
  93 .PP
  94 \fBlwres_conf_print()\fR
  95 returns
  96 LWRES_R_SUCCESS
  97 unless an error occurred when converting the network addresses to a
  98 numeric host address string.
  99 If this happens, the function returns
 100 LWRES_R_FAILURE.
 101 .SH "SEE ALSO"
 102 .PP
 103 \fBstdio\fR(3),
 104 \fBresolver\fR(5).
 105 .SH "FILES"
 106 .PP
 107 \fI/etc/resolv.conf\fR