contrib/bind9/lib/lwres/man/lwres_config.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004, 2005  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000, 2001  Internet Software Consortium.
   7  -
   8  - Permission to use, copy, modify, and distribute this software for any
   9  - purpose with or without fee is hereby granted, provided that the above
  10  - copyright notice and this permission notice appear in all copies.
  11  -
  12  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  13  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  14  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  15  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  16  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  17  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  18  - PERFORMANCE OF THIS SOFTWARE.
  19 -->
  20
  21 <!-- $Id: lwres_config.docbook,v 1.2.206.3 2005/05/12 21:36:12 sra Exp $ -->
  22
  23 <refentry>
  24 <refentryinfo>
  25
  26 <date>Jun 30, 2000</date>
  27 </refentryinfo>
  28
  29 <refmeta>
  30 <refentrytitle>lwres_config</refentrytitle>
  31 <manvolnum>3</manvolnum>
  32 <refmiscinfo>BIND9</refmiscinfo>
  33 </refmeta>
  34
  35   <docinfo>
  36     <copyright>
  37       <year>2004</year>
  38       <year>2005</year>
  39       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  40     </copyright>
  41     <copyright>
  42       <year>2000</year>
  43       <year>2001</year>
  44       <holder>Internet Software Consortium.</holder>
  45     </copyright>
  46   </docinfo>
  47
  48 <refnamediv>
  49 <refname>lwres_conf_init</refname>
  50 <refname>lwres_conf_clear</refname>
  51 <refname>lwres_conf_parse</refname>
  52 <refname>lwres_conf_print</refname>
  53 <refname>lwres_conf_get</refname>
  54 <refpurpose>lightweight resolver configuration</refpurpose>
  55 </refnamediv>
  56
  57 <refsynopsisdiv>
  58 <funcsynopsis>
  59 <funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
  60 <funcprototype>
  61 <funcdef>
  62 void
  63 <function>lwres_conf_init</function></funcdef>
  64 <paramdef>lwres_context_t *ctx</paramdef>
  65 </funcprototype>
  66 <funcprototype>
  67 <funcdef>
  68 void
  69 <function>lwres_conf_clear</function></funcdef>
  70 <paramdef>lwres_context_t *ctx</paramdef>
  71 </funcprototype>
  72 <funcprototype>
  73 <funcdef>
  74 lwres_result_t
  75 <function>lwres_conf_parse</function></funcdef>
  76 <paramdef>lwres_context_t *ctx</paramdef>
  77 <paramdef>const char *filename</paramdef>
  78 </funcprototype>
  79 <funcprototype>
  80 <funcdef>
  81 lwres_result_t
  82 <function>lwres_conf_print</function></funcdef>
  83 <paramdef>lwres_context_t *ctx</paramdef>
  84 <paramdef>FILE *fp</paramdef>
  85 </funcprototype>
  86 <funcprototype>
  87 <funcdef>
  88 lwres_conf_t *
  89 <function>lwres_conf_get</function></funcdef>
  90 <paramdef>lwres_context_t *ctx</paramdef>
  91 </funcprototype>
  92 </funcsynopsis>
  93 </refsynopsisdiv>
  94
  95 <refsect1>
  96 <title>DESCRIPTION</title>
  97 <para>
  98 <function>lwres_conf_init()</function>
  99 creates an empty
 100 <type>lwres_conf_t</type>
 101 structure for lightweight resolver context
 102 <parameter>ctx</parameter>.
 103 </para>
 104 <para>
 105 <function>lwres_conf_clear()</function>
 106 frees up all the internal memory used by
 107 that
 108 <type>lwres_conf_t</type>
 109 structure in resolver context
 110 <parameter>ctx</parameter>.
 111 </para>
 112 <para>
 113 <function>lwres_conf_parse()</function>
 114 opens the file
 115 <parameter>filename</parameter>
 116 and parses it to initialise the resolver context
 117 <parameter>ctx</parameter>'s
 118 <type>lwres_conf_t</type>
 119 structure.
 120 </para>
 121 <para>
 122 <function>lwres_conf_print()</function>
 123 prints the
 124 <type>lwres_conf_t</type>
 125 structure for resolver context
 126 <parameter>ctx</parameter>
 127 to the
 128 <type>FILE</type>
 129 <parameter>fp</parameter>.
 130 </para>
 131 </refsect1>
 132 <refsect1>
 133
 134 <title>RETURN VALUES</title>
 135 <para>
 136 <function>lwres_conf_parse()</function>
 137 returns
 138 <errorcode>LWRES_R_SUCCESS</errorcode>
 139 if it successfully read and parsed
 140 <parameter>filename</parameter>.
 141 It returns
 142 <errorcode>LWRES_R_FAILURE</errorcode>
 143 if
 144 <parameter>filename</parameter>
 145 could not be opened or contained incorrect
 146 resolver statements.
 147 </para>
 148 <para>
 149 <function>lwres_conf_print()</function>
 150 returns
 151 <errorcode>LWRES_R_SUCCESS</errorcode>
 152 unless an error occurred when converting the network addresses to a
 153 numeric host address string.
 154 If this happens, the function returns
 155 <errorcode>LWRES_R_FAILURE</errorcode>.
 156 </para>
 157 </refsect1>
 158 <refsect1>
 159 <title>SEE ALSO</title>
 160 <para>
 161 <citerefentry>
 162 <refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
 163 </citerefentry>,
 164 <citerefentry>
 165 <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
 166 </citerefentry>.
 167 </para>
 168 </refsect1>
 169 <refsect1>
 170 <title>FILES</title>
 171 <para>
 172 <filename>/etc/resolv.conf</filename>
 173 </para>
 174 </refsect1>
 175 </refentry>