contrib/bind-9.3/lib/lwres/man/lwres_config.3

   1 .\" Copyright (C) 2004, 2005 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.1.8.6 2006/06/29 13:02:31 marka Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: lwres_config
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
  23 .\"      Date: Jun 30, 2000
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "LWRES_CONFIG" "3" "Jun 30, 2000" "BIND9" "BIND9"
  28 .\" disable hyphenation
  29 .nh
  30 .\" disable justification (adjust text to left margin only)
  31 .ad l
  32 .SH "NAME"
  33 lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get \- lightweight resolver configuration
  34 .SH "SYNOPSIS"
  35 .nf
  36 #include <lwres/lwres.h>
  37 .fi
  38 .HP 21
  39 .BI "void lwres_conf_init(lwres_context_t\ *ctx);"
  40 .HP 22
  41 .BI "void lwres_conf_clear(lwres_context_t\ *ctx);"
  42 .HP 32
  43 .BI "lwres_result_t lwres_conf_parse(lwres_context_t\ *ctx, const\ char\ *filename);"
  44 .HP 32
  45 .BI "lwres_result_t lwres_conf_print(lwres_context_t\ *ctx, FILE\ *fp);"
  46 .HP 30
  47 .BI "lwres_conf_t * lwres_conf_get(lwres_context_t\ *ctx);"
  48 .SH "DESCRIPTION"
  49 .PP
  50 \fBlwres_conf_init()\fR
  51 creates an empty
  52 \fBlwres_conf_t\fR
  53 structure for lightweight resolver context
  54 \fIctx\fR.
  55 .PP
  56 \fBlwres_conf_clear()\fR
  57 frees up all the internal memory used by 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 \fBLWRES_R_SUCCESS\fR
  83 if it successfully read and parsed
  84 \fIfilename\fR. It returns
  85 \fBLWRES_R_FAILURE\fR
  86 if
  87 \fIfilename\fR
  88 could not be opened or contained incorrect resolver statements.
  89 .PP
  90 \fBlwres_conf_print()\fR
  91 returns
  92 \fBLWRES_R_SUCCESS\fR
  93 unless an error occurred when converting the network addresses to a numeric host address string. If this happens, the function returns
  94 \fBLWRES_R_FAILURE\fR.
  95 .SH "SEE ALSO"
  96 .PP
  97 \fBstdio\fR(3),
  98 \fBresolver\fR(5).
  99 .SH "FILES"
 100 .PP
 101 \fI/etc/resolv.conf\fR
 102 .SH "COPYRIGHT"
 103 Copyright \(co 2004, 2005 Internet Systems Consortium, Inc. ("ISC")