external/bsd/bind/dist/lib/lwres/man/lwres_config.3

   1 .\"     $NetBSD: lwres_config.3,v 1.5 2014/12/10 04:38:02 christos Exp $
   2 .\"
   3 .\" Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
   4 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
   5 .\"
   6 .\" Permission to use, copy, modify, and/or distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  11 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  12 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  13 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  14 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  15 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16 .\" PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .\" Id
  19 .\"
  20 .hy 0
  21 .ad l
  22 .\"     Title: lwres_config
  23 .\"    Author:
  24 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  25 .\"      Date: June 18, 2007
  26 .\"    Manual: BIND9
  27 .\"    Source: BIND9
  28 .\"
  29 .TH "LWRES_CONFIG" "3" "June 18, 2007" "BIND9" "BIND9"
  30 .\" disable hyphenation
  31 .nh
  32 .\" disable justification (adjust text to left margin only)
  33 .ad l
  34 .SH "NAME"
  35 lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get \- lightweight resolver configuration
  36 .SH "SYNOPSIS"
  37 .nf
  38 #include <lwres/lwres.h>
  39 .fi
  40 .HP 21
  41 .BI "void lwres_conf_init(lwres_context_t\ *" "ctx" ");"
  42 .HP 22
  43 .BI "void lwres_conf_clear(lwres_context_t\ *" "ctx" ");"
  44 .HP 32
  45 .BI "lwres_result_t lwres_conf_parse(lwres_context_t\ *" "ctx" ", const\ char\ *" "filename" ");"
  46 .HP 32
  47 .BI "lwres_result_t lwres_conf_print(lwres_context_t\ *" "ctx" ", FILE\ *" "fp" ");"
  48 .HP 30
  49 .BI "lwres_conf_t * lwres_conf_get(lwres_context_t\ *" "ctx" ");"
  50 .SH "DESCRIPTION"
  51 .PP
  52 \fBlwres_conf_init()\fR
  53 creates an empty
  54 \fBlwres_conf_t\fR
  55 structure for lightweight resolver context
  56 \fIctx\fR.
  57 .PP
  58 \fBlwres_conf_clear()\fR
  59 frees up all the internal memory used by 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 \fBLWRES_R_SUCCESS\fR
  85 if it successfully read and parsed
  86 \fIfilename\fR. It returns
  87 \fBLWRES_R_FAILURE\fR
  88 if
  89 \fIfilename\fR
  90 could not be opened or contained incorrect resolver statements.
  91 .PP
  92 \fBlwres_conf_print()\fR
  93 returns
  94 \fBLWRES_R_SUCCESS\fR
  95 unless an error occurred when converting the network addresses to a numeric host address string. If this happens, the function returns
  96 \fBLWRES_R_FAILURE\fR.
  97 .SH "SEE ALSO"
  98 .PP
  99 \fBstdio\fR(3),
 100 \fBresolver\fR(5).
 101 .SH "FILES"
 102 .PP
 103 \fI/etc/resolv.conf\fR
 104 .SH "COPYRIGHT"
 105 Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
 106 .br
 107 Copyright \(co 2000, 2001 Internet Software Consortium.
 108 .br