src/libfreeswan/liblwres/man/lwres_config.3

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