lwres_config.docbook revision ec5347e2c775f027573ce5648b910361aa926c01
5cd4555ad444fd391002ae32450572054369fd42Rob Austein<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5cd4555ad444fd391002ae32450572054369fd42Rob Austein "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein [<!ENTITY mdash "&#8212;">]>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley<!--
5422929ca0d62760b204f18cf830069ae3f3fc77Automatic Updater - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - Copyright (C) 2000, 2001 Internet Software Consortium.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley -
ec5347e2c775f027573ce5648b910361aa926c01Automatic Updater - Permission to use, copy, modify, and/or distribute this software for any
dd750c560ae48cf6caeb9a9fe81d33fc4746106dBrian Wellington - purpose with or without fee is hereby granted, provided that the above
dd750c560ae48cf6caeb9a9fe81d33fc4746106dBrian Wellington - copyright notice and this permission notice appear in all copies.
dd750c560ae48cf6caeb9a9fe81d33fc4746106dBrian Wellington -
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley-->
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews
5d924e398ed15c57c506315c7d11125dcc9cb098Jeremy Reed<!-- $Id: lwres_config.docbook,v 1.9 2007/06/18 23:47:51 tbox Exp $ -->
b5ad6dfea4cc3e7d1d322ac99f1e5a31096837c4Mark Andrews<refentry>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refentryinfo>
5d924e398ed15c57c506315c7d11125dcc9cb098Jeremy Reed
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <date>Jun 30, 2000</date>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refentryinfo>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refmeta>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refentrytitle>lwres_config</refentrytitle>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <manvolnum>3</manvolnum>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refmiscinfo>BIND9</refmiscinfo>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refmeta>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <docinfo>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <copyright>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <year>2004</year>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <year>2005</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2007</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews <copyright>
d6b5e0b0e8a4e3e927f8d47ca82c3e7f42e0f4bbMark Andrews <year>2000</year>
c1a883f2e04d94e99c433b1f6cfd0c0338f4ed85Mark Andrews <year>2001</year>
5422929ca0d62760b204f18cf830069ae3f3fc77Automatic Updater <holder>Internet Software Consortium.</holder>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </docinfo>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refname>lwres_conf_init</refname>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refname>lwres_conf_clear</refname>
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews <refname>lwres_conf_parse</refname>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refname>lwres_conf_print</refname>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refname>lwres_conf_get</refname>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refpurpose>lightweight resolver configuration</refpurpose>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refnamediv>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refsynopsisdiv>
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews <funcsynopsis>
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews<funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley<funcprototype>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <funcdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halleyvoid
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley<function>lwres_conf_init</function></funcdef>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </funcprototype>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley<funcprototype>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <funcdef>
13d9b8ce94aee267761cd297a583e280df262d60Tatuya JINMEI 神明達哉void
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley<function>lwres_conf_clear</function></funcdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </funcprototype>
eeaa2277ead6df7253a8958ee2d786f73e05b8beTatuya JINMEI 神明達哉<funcprototype>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <funcdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halleylwres_result_t
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley<function>lwres_conf_parse</function></funcdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <paramdef>const char *<parameter>filename</parameter></paramdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </funcprototype>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<funcprototype>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <funcdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinlwres_result_t
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<function>lwres_conf_print</function></funcdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <paramdef>FILE *<parameter>fp</parameter></paramdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </funcprototype>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<funcprototype>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <funcdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinlwres_conf_t *
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<function>lwres_conf_get</function></funcdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </funcprototype>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley</funcsynopsis>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refsynopsisdiv>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refsect1>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <title>DESCRIPTION</title>
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><function>lwres_conf_init()</function>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein creates an empty
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>lwres_conf_t</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein structure for lightweight resolver context
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>ctx</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><function>lwres_conf_clear()</function>
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews frees up all the internal memory used by
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews that
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews <type>lwres_conf_t</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein structure in resolver context
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>ctx</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><function>lwres_conf_parse()</function>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein opens the file
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews <parameter>filename</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and parses it to initialise the resolver context
0ffaee887ff5674b8c3bb0435ae838f641981706Mark Andrews <parameter>ctx</parameter>'s
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <type>lwres_conf_t</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein structure.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><function>lwres_conf_print()</function>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein prints the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>lwres_conf_t</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein structure for resolver context
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>ctx</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein to the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>FILE</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>fp</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsect1>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <title>RETURN VALUES</title>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><function>lwres_conf_parse()</function>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein returns <errorcode>LWRES_R_SUCCESS</errorcode>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein if it successfully read and parsed
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>filename</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein It returns <errorcode>LWRES_R_FAILURE</errorcode>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein if <parameter>filename</parameter>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley could not be opened or contained incorrect
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein resolver statements.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </para>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <para><function>lwres_conf_print()</function>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein returns <errorcode>LWRES_R_SUCCESS</errorcode>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein unless an error occurred when converting the network addresses to a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein numeric host address string.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If this happens, the function returns
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <errorcode>LWRES_R_FAILURE</errorcode>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refsect1>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refsect1>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <title>SEE ALSO</title>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </citerefentry>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley </refsect1>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley <refsect1>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <title>FILES</title>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews <para><filename>/etc/resolv.conf</filename>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews </para>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews </refsect1>
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews</refentry><!--
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews - Local variables:
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews - mode: sgml
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews - End:
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews-->
0f78f780648806bcb3e374b7dafac73e6c558ea8Mark Andrews