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

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