lwres_config.docbook revision ddccd5811feff696ba460dabfb666ce61040f545
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
232d4387e2ef22eb95f7e49ebbfb4d7e8d0daae6Automatic Updater<!--
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000, 2001 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson - Permission to use, copy, modify, and distribute this software for any
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson - purpose with or without fee is hereby granted, provided that the above
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater-->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!-- $Id: lwres_config.docbook,v 1.1 2001/03/31 00:08:04 gson Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refentry>
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews<refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<date>Jun 30, 2000</date>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refmeta>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refentrytitle>lwres_config</refentrytitle>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<manvolnum>3</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refmiscinfo>BIND9</refmiscinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</refmeta>
7329012471d165cd3dc4180ad2a0a43de91e7f01Mark Andrews
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refname>lwres_conf_init</refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refname>lwres_conf_clear</refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refname>lwres_conf_parse</refname>
232d4387e2ef22eb95f7e49ebbfb4d7e8d0daae6Automatic Updater<refname>lwres_conf_print</refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refname>lwres_conf_get</refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refpurpose>lightweight resolver configuration</refpurpose>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_conf_init</function></funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<paramdef>lwres_context_t *ctx</paramdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcdef>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrewsvoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_conf_clear</function></funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<paramdef>lwres_context_t *ctx</paramdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinlwres_result_t
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_conf_parse</function></funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<paramdef>lwres_context_t *ctx</paramdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<paramdef>const char *filename</paramdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcprototype>
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater<funcdef>
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updaterlwres_result_t
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_conf_print</function></funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<paramdef>lwres_context_t *ctx</paramdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<paramdef>FILE *fp</paramdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinlwres_conf_t *
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews<function>lwres_conf_get</function></funcdef>
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews<paramdef>lwres_context_t *ctx</paramdef>
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews</funcprototype>
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater</funcsynopsis>
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater</refsynopsisdiv>
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews<refsect1>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<title>DESCRIPTION</title>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<para>
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater<function>lwres_conf_init()</function>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeincreates an empty
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<type>lwres_conf_t</type>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinstructure for lightweight resolver context
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<parameter>ctx</parameter>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<para>
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrews<function>lwres_conf_clear()</function>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinfrees up all the internal memory used by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinthat
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<type>lwres_conf_t</type>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinstructure in resolver context
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<parameter>ctx</parameter>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_conf_parse()</function>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinopens the file
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<parameter>filename</parameter>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinand parses it to initialise the resolver context
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<parameter>ctx</parameter>'s
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<type>lwres_conf_t</type>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinstructure.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_conf_print()</function>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinprints the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<type>lwres_conf_t</type>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinstructure for resolver context
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<parameter>ctx</parameter>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinto the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<type>FILE</type>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<parameter>fp</parameter>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</refsect1>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refsect1>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<title>RETURN VALUES</title>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_conf_parse()</function>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinreturns
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<errorcode>LWRES_R_SUCCESS</errorcode>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinif it successfully read and parsed
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<parameter>filename</parameter>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinIt returns
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<errorcode>LWRES_R_FAILURE</errorcode>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinif
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater<parameter>filename</parameter>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeincould not be opened or contained incorrect
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinresolver statements.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_conf_print()</function>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinreturns
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<errorcode>LWRES_R_SUCCESS</errorcode>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinunless an error occurred when converting the network addresses to a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinnumeric host address string.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinIf this happens, the function returns
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<errorcode>LWRES_R_FAILURE</errorcode>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</para>
a1b05dea35aa30b152a47115e18bbe679d3fcf19Mark Andrews</refsect1>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refsect1>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<title>SEE ALSO</title>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</citerefentry>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<citerefentry>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews<refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</citerefentry>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</refsect1>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refsect1>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<title>FILES</title>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<filename>/etc/resolv.conf</filename>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</refsect1>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</refentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein