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, 2012  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$ -->
  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       <year>2012</year>
  40       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  41     </copyright>
  42     <copyright>
  43       <year>2000</year>
  44       <year>2001</year>
  45       <holder>Internet Software Consortium.</holder>
  46     </copyright>
  47   </docinfo>
  48
  49   <refnamediv>
  50     <refname>lwres_conf_init</refname>
  51     <refname>lwres_conf_clear</refname>
  52     <refname>lwres_conf_parse</refname>
  53     <refname>lwres_conf_print</refname>
  54     <refname>lwres_conf_get</refname>
  55     <refpurpose>lightweight resolver configuration</refpurpose>
  56   </refnamediv>
  57
  58   <refsynopsisdiv>
  59     <funcsynopsis>
  60 <funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
  61 <funcprototype>
  62         <funcdef>
  63 void
  64 <function>lwres_conf_init</function></funcdef>
  65         <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  66         </funcprototype>
  67 <funcprototype>
  68         <funcdef>
  69 void
  70 <function>lwres_conf_clear</function></funcdef>
  71         <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  72         </funcprototype>
  73 <funcprototype>
  74         <funcdef>
  75 lwres_result_t
  76 <function>lwres_conf_parse</function></funcdef>
  77         <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  78         <paramdef>const char *<parameter>filename</parameter></paramdef>
  79         </funcprototype>
  80 <funcprototype>
  81         <funcdef>
  82 lwres_result_t
  83 <function>lwres_conf_print</function></funcdef>
  84         <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  85         <paramdef>FILE *<parameter>fp</parameter></paramdef>
  86         </funcprototype>
  87 <funcprototype>
  88         <funcdef>
  89 lwres_conf_t *
  90 <function>lwres_conf_get</function></funcdef>
  91         <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  92       </funcprototype>
  93 </funcsynopsis>
  94   </refsynopsisdiv>
  95
  96   <refsect1>
  97     <title>DESCRIPTION</title>
  98
  99     <para><function>lwres_conf_init()</function>
 100       creates an empty
 101       <type>lwres_conf_t</type>
 102       structure for lightweight resolver context
 103       <parameter>ctx</parameter>.
 104     </para>
 105
 106     <para><function>lwres_conf_clear()</function>
 107       frees up all the internal memory used by
 108       that
 109       <type>lwres_conf_t</type>
 110       structure in resolver context
 111       <parameter>ctx</parameter>.
 112     </para>
 113
 114     <para><function>lwres_conf_parse()</function>
 115       opens the file
 116       <parameter>filename</parameter>
 117       and parses it to initialise the resolver context
 118       <parameter>ctx</parameter>'s
 119       <type>lwres_conf_t</type>
 120       structure.
 121     </para>
 122
 123     <para><function>lwres_conf_print()</function>
 124       prints the
 125       <type>lwres_conf_t</type>
 126       structure for resolver context
 127       <parameter>ctx</parameter>
 128       to the
 129       <type>FILE</type>
 130       <parameter>fp</parameter>.
 131     </para>
 132   </refsect1>
 133   <refsect1>
 134
 135     <title>RETURN VALUES</title>
 136
 137     <para><function>lwres_conf_parse()</function>
 138       returns <errorcode>LWRES_R_SUCCESS</errorcode>
 139       if it successfully read and parsed
 140       <parameter>filename</parameter>.
 141       It returns <errorcode>LWRES_R_FAILURE</errorcode>
 142       if <parameter>filename</parameter>
 143       could not be opened or contained incorrect
 144       resolver statements.
 145     </para>
 146
 147     <para><function>lwres_conf_print()</function>
 148       returns <errorcode>LWRES_R_SUCCESS</errorcode>
 149       unless an error occurred when converting the network addresses to a
 150       numeric host address string.
 151       If this happens, the function returns
 152       <errorcode>LWRES_R_FAILURE</errorcode>.
 153     </para>
 154   </refsect1>
 155   <refsect1>
 156     <title>SEE ALSO</title>
 157     <para><citerefentry>
 158         <refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
 159       </citerefentry>,
 160       <citerefentry>
 161         <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
 162       </citerefentry>.
 163     </para>
 164   </refsect1>
 165   <refsect1>
 166     <title>FILES</title>
 167     <para><filename>/etc/resolv.conf</filename>
 168     </para>
 169   </refsect1>
 170 </refentry><!--
 171  - Local variables:
 172  - mode: sgml
 173  - End:
 174 -->