lwres_config.docbook revision 14a656f94b1fd0ababd84a772228dfa52276ba15
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<!--
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - Copyright (C) 2000, 2001 Internet Software Consortium.
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore -
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - Permission to use, copy, modify, and/or distribute this software for any
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - purpose with or without fee is hereby granted, provided that the above
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - copyright notice and this permission notice appear in all copies.
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore -
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - PERFORMANCE OF THIS SOFTWARE.
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore-->
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<!-- Converted by db4-upgrade version 1.0 -->
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <info>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <date>2007-06-18</date>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </info>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refentryinfo>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <corpname>ISC</corpname>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </refentryinfo>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refmeta>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refentrytitle>lwres_config</refentrytitle>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <manvolnum>3</manvolnum>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refmiscinfo>BIND9</refmiscinfo>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </refmeta>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <docinfo>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <copyright>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <year>2004</year>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <year>2005</year>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <year>2007</year>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <year>2014</year>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </copyright>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <copyright>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <year>2000</year>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <year>2001</year>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <holder>Internet Software Consortium.</holder>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </copyright>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </docinfo>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refnamediv>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refname>lwres_conf_init</refname>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refname>lwres_conf_clear</refname>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refname>lwres_conf_parse</refname>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refname>lwres_conf_print</refname>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refname>lwres_conf_get</refname>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refpurpose>lightweight resolver configuration</refpurpose>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </refnamediv>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <refsynopsisdiv>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <funcsynopsis>
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe<funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe<funcprototype>
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe <funcdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amorevoid
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<function>lwres_conf_init</function></funcdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </funcprototype>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<funcprototype>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <funcdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amorevoid
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<function>lwres_conf_clear</function></funcdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </funcprototype>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<funcprototype>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <funcdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amorelwres_result_t
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<function>lwres_conf_parse</function></funcdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <paramdef>const char *<parameter>filename</parameter></paramdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </funcprototype>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<funcprototype>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <funcdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amorelwres_result_t
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<function>lwres_conf_print</function></funcdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <paramdef>FILE *<parameter>fp</parameter></paramdef>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </funcprototype>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<funcprototype>
<funcdef>
lwres_conf_t *
<function>lwres_conf_get</function></funcdef>
<paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection><info><title>DESCRIPTION</title></info>
<para><function>lwres_conf_init()</function>
creates an empty
<type>lwres_conf_t</type>
structure for lightweight resolver context
<parameter>ctx</parameter>.
</para>
<para><function>lwres_conf_clear()</function>
frees up all the internal memory used by
that
<type>lwres_conf_t</type>
structure in resolver context
<parameter>ctx</parameter>.
</para>
<para><function>lwres_conf_parse()</function>
opens the file
<parameter>filename</parameter>
and parses it to initialise the resolver context
<parameter>ctx</parameter>'s
<type>lwres_conf_t</type>
structure.
</para>
<para><function>lwres_conf_print()</function>
prints the
<type>lwres_conf_t</type>
structure for resolver context
<parameter>ctx</parameter>
to the
<type>FILE</type>
<parameter>fp</parameter>.
</para>
</refsection>
<refsection><info><title>RETURN VALUES</title></info>
<para><function>lwres_conf_parse()</function>
returns <errorcode>LWRES_R_SUCCESS</errorcode>
if it successfully read and parsed
<parameter>filename</parameter>.
It returns <errorcode>LWRES_R_FAILURE</errorcode>
if <parameter>filename</parameter>
could not be opened or contained incorrect
resolver statements.
</para>
<para><function>lwres_conf_print()</function>
returns <errorcode>LWRES_R_SUCCESS</errorcode>
unless an error occurred when converting the network addresses to a
numeric host address string.
If this happens, the function returns
<errorcode>LWRES_R_FAILURE</errorcode>.
</para>
</refsection>
<refsection><info><title>SEE ALSO</title></info>
<para><citerefentry>
<refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>.
</para>
</refsection>
<refsection><info><title>FILES</title></info>
<para><filename>/etc/resolv.conf</filename>
</para>
</refsection>
</refentry>