lwres_config.docbook revision d4ef65050feac78554addf6e16a06c6e2e0bd331
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<!--
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - Copyright (C) 2001 Internet Software Consortium.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington -
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - Permission to use, copy, modify, and distribute this software for any
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - purpose with or without fee is hereby granted, provided that the above
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - copyright notice and this permission notice appear in all copies.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington -
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
c40265eba0c99708887d68e67901924065ba2514Brian Wellington - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington-->
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<!-- $Id: lwres_config.docbook,v 1.2 2001/04/10 21:51:21 bwelling Exp $ -->
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refentryinfo>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<date>Jun 30, 2000</date>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</refentryinfo>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refmeta>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refentrytitle>lwres_config</refentrytitle>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<manvolnum>3</manvolnum>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refmiscinfo>BIND9</refmiscinfo>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</refmeta>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refnamediv>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refname>lwres_conf_init</refname>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refname>lwres_conf_clear</refname>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refname>lwres_conf_parse</refname>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refname>lwres_conf_print</refname>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refname>lwres_conf_get</refname>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refpurpose>lightweight resolver configuration</refpurpose>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</refnamediv>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refsynopsisdiv>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcsynopsis>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonvoid
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_init</function></funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<paramdef>lwres_context_t *ctx</paramdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonvoid
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_clear</function></funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<paramdef>lwres_context_t *ctx</paramdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonlwres_result_t
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_parse</function></funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<paramdef>lwres_context_t *ctx</paramdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<paramdef>const char *filename</paramdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonlwres_result_t
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_print</function></funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<paramdef>lwres_context_t *ctx</paramdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<paramdef>FILE *fp</paramdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonlwres_conf_t *
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_get</function></funcdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<paramdef>lwres_context_t *ctx</paramdef>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</funcprototype>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</funcsynopsis>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</refsynopsisdiv>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<title>DESCRIPTION</title>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_init()</function>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtoncreates an empty
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<type>lwres_conf_t</type>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonstructure for lightweight resolver context
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<parameter>ctx</parameter>.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_clear()</function>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonfrees up all the internal memory used by
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonthat
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<type>lwres_conf_t</type>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonstructure in resolver context
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<parameter>ctx</parameter>.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_parse()</function>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonopens the file
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<parameter>filename</parameter>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonand parses it to initialise the resolver context
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<parameter>ctx</parameter>'s
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<type>lwres_conf_t</type>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonstructure.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_print()</function>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonprints the
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<type>lwres_conf_t</type>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonstructure for resolver context
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<parameter>ctx</parameter>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonto the
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<type>FILE</type>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<parameter>fp</parameter>.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<title>RETURN VALUES</title>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_parse()</function>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonreturns
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<errorcode>LWRES_R_SUCCESS</errorcode>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonif it successfully read and parsed
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<parameter>filename</parameter>.
c40265eba0c99708887d68e67901924065ba2514Brian WellingtonIt returns
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<errorcode>LWRES_R_FAILURE</errorcode>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonif
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<parameter>filename</parameter>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtoncould not be opened or contained incorrect
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonresolver statements.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<function>lwres_conf_print()</function>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonreturns
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<errorcode>LWRES_R_SUCCESS</errorcode>
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonunless an error occurred when converting the network addresses to a
c40265eba0c99708887d68e67901924065ba2514Brian Wellingtonnumeric host address string.
c40265eba0c99708887d68e67901924065ba2514Brian WellingtonIf this happens, the function returns
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<errorcode>LWRES_R_FAILURE</errorcode>.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<title>SEE ALSO</title>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<citerefentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</citerefentry>,
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<citerefentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</citerefentry>.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<title>FILES</title>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<filename>/etc/resolv.conf</filename>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</para>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</refsect1>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</refentry>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington