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.5 2005/10/13 02:33:58 marka Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\" ** You probably do not want to edit this file directly **
  21 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
  22 .\" Instead of manually editing it, you probably should edit the DocBook XML
  23 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
  24 .TH "LWRES_CONFIG" "3" "Jun 30, 2000" "BIND9" "BIND9"
  25 .\" disable hyphenation
  26 .nh
  27 .\" disable justification (adjust text to left margin only)
  28 .ad l
  29 .SH "NAME"
  30 lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get \- lightweight resolver configuration
  31 .SH "SYNOPSIS"
  32 .nf
  33 #include <lwres/lwres.h>
  34 .fi
  35 .HP 21
  36 \fBvoid\ \fBlwres_conf_init\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB);\fR
  37 .HP 22
  38 \fBvoid\ \fBlwres_conf_clear\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB);\fR
  39 .HP 32
  40 \fBlwres_result_t\ \fBlwres_conf_parse\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBconst\ char\ *filename\fR\fB);\fR
  41 .HP 32
  42 \fBlwres_result_t\ \fBlwres_conf_print\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBFILE\ *fp\fR\fB);\fR
  43 .HP 30
  44 \fBlwres_conf_t\ *\ \fBlwres_conf_get\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB);\fR
  45 .SH "DESCRIPTION"
  46 .PP
  47 \fBlwres_conf_init()\fR
  48 creates an empty
  49 \fBlwres_conf_t\fR
  50 structure for lightweight resolver context
  51 \fIctx\fR.
  52 .PP
  53 \fBlwres_conf_clear()\fR
  54 frees up all the internal memory used by that
  55 \fBlwres_conf_t\fR
  56 structure in resolver context
  57 \fIctx\fR.
  58 .PP
  59 \fBlwres_conf_parse()\fR
  60 opens the file
  61 \fIfilename\fR
  62 and parses it to initialise the resolver context
  63 \fIctx\fR's
  64 \fBlwres_conf_t\fR
  65 structure.
  66 .PP
  67 \fBlwres_conf_print()\fR
  68 prints the
  69 \fBlwres_conf_t\fR
  70 structure for resolver context
  71 \fIctx\fR
  72 to the
  73 \fBFILE\fR\fIfp\fR.
  74 .SH "RETURN VALUES"
  75 .PP
  76 \fBlwres_conf_parse()\fR
  77 returns
  78 \fBLWRES_R_SUCCESS\fR
  79 if it successfully read and parsed
  80 \fIfilename\fR. It returns
  81 \fBLWRES_R_FAILURE\fR
  82 if
  83 \fIfilename\fR
  84 could not be opened or contained incorrect resolver statements.
  85 .PP
  86 \fBlwres_conf_print()\fR
  87 returns
  88 \fBLWRES_R_SUCCESS\fR
  89 unless an error occurred when converting the network addresses to a numeric host address string. If this happens, the function returns
  90 \fBLWRES_R_FAILURE\fR.
  91 .SH "SEE ALSO"
  92 .PP
  93 \fBstdio\fR(3),
  94 \fBresolver\fR(5).
  95 .SH "FILES"
  96 .PP
  97 \fI/etc/resolv.conf\fR