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

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004, 2005, 2007  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000, 2001  Internet Software Consortium.
   7  -
   8  - Permission to use, copy, modify, and/or 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.9 2007/06/18 23:47:51 tbox Exp $ -->
  22 <refentry>
  23   <refentryinfo>
  24
  25     <date>Jun 30, 2000</date>
  26   </refentryinfo>
  27
  28   <refmeta>
  29     <refentrytitle>lwres_config</refentrytitle>
  30     <manvolnum>3</manvolnum>
  31     <refmiscinfo>BIND9</refmiscinfo>
  32   </refmeta>
  33
  34   <docinfo>
  35     <copyright>
  36       <year>2004</year>
  37       <year>2005</year>
  38       <year>2007</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 *<parameter>ctx</parameter></paramdef>
  65         </funcprototype>
  66 <funcprototype>
  67         <funcdef>
  68 void
  69 <function>lwres_conf_clear</function></funcdef>
  70         <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  71         </funcprototype>
  72 <funcprototype>
  73         <funcdef>
  74 lwres_result_t
  75 <function>lwres_conf_parse</function></funcdef>
  76         <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  77         <paramdef>const char *<parameter>filename</parameter></paramdef>
  78         </funcprototype>
  79 <funcprototype>
  80         <funcdef>
  81 lwres_result_t
  82 <function>lwres_conf_print</function></funcdef>
  83         <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  84         <paramdef>FILE *<parameter>fp</parameter></paramdef>
  85         </funcprototype>
  86 <funcprototype>
  87         <funcdef>
  88 lwres_conf_t *
  89 <function>lwres_conf_get</function></funcdef>
  90         <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  91       </funcprototype>
  92 </funcsynopsis>
  93   </refsynopsisdiv>
  94
  95   <refsect1>
  96     <title>DESCRIPTION</title>
  97
  98     <para><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
 105     <para><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
 113     <para><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
 122     <para><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
 136     <para><function>lwres_conf_parse()</function>
 137       returns <errorcode>LWRES_R_SUCCESS</errorcode>
 138       if it successfully read and parsed
 139       <parameter>filename</parameter>.
 140       It returns <errorcode>LWRES_R_FAILURE</errorcode>
 141       if <parameter>filename</parameter>
 142       could not be opened or contained incorrect
 143       resolver statements.
 144     </para>
 145
 146     <para><function>lwres_conf_print()</function>
 147       returns <errorcode>LWRES_R_SUCCESS</errorcode>
 148       unless an error occurred when converting the network addresses to a
 149       numeric host address string.
 150       If this happens, the function returns
 151       <errorcode>LWRES_R_FAILURE</errorcode>.
 152     </para>
 153   </refsect1>
 154   <refsect1>
 155     <title>SEE ALSO</title>
 156     <para><citerefentry>
 157         <refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
 158       </citerefentry>,
 159       <citerefentry>
 160         <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
 161       </citerefentry>.
 162     </para>
 163   </refsect1>
 164   <refsect1>
 165     <title>FILES</title>
 166     <para><filename>/etc/resolv.conf</filename>
 167     </para>
 168   </refsect1>
 169 </refentry><!--
 170  - Local variables:
 171  - mode: sgml
 172  - End:
 173 -->