lwres_config.docbook revision 14a656f94b1fd0ababd84a772228dfa52276ba15
f743002678eb67b99bbc29fee116b65d9530fec0wrowe<!--
80833bb9a1bf25dcf19e814438a4b311d2e1f4cffuankg - Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
a34684a59b60a4173c25035d0c627ef17e6dc215rpluem - Copyright (C) 2000, 2001 Internet Software Consortium.
1337c7673efc1f80f634139fbad7cbb98a0dc657ylavic -
1337c7673efc1f80f634139fbad7cbb98a0dc657ylavic - Permission to use, copy, modify, and/or distribute this software for any
1337c7673efc1f80f634139fbad7cbb98a0dc657ylavic - purpose with or without fee is hereby granted, provided that the above
1337c7673efc1f80f634139fbad7cbb98a0dc657ylavic - copyright notice and this permission notice appear in all copies.
4da61833a1cbbca94094f9653fd970582b97a72etrawick -
4da61833a1cbbca94094f9653fd970582b97a72etrawick - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
4da61833a1cbbca94094f9653fd970582b97a72etrawick - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
4da61833a1cbbca94094f9653fd970582b97a72etrawick - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
4da61833a1cbbca94094f9653fd970582b97a72etrawick - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
4789804be088bcd86ae637a29cdb7fda25169521jailletc - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
4789804be088bcd86ae637a29cdb7fda25169521jailletc - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4789804be088bcd86ae637a29cdb7fda25169521jailletc - PERFORMANCE OF THIS SOFTWARE.
4789804be088bcd86ae637a29cdb7fda25169521jailletc-->
e50c3026198fd496f183cda4c32a202925476778covener<!-- Converted by db4-upgrade version 1.0 -->
e50c3026198fd496f183cda4c32a202925476778covener<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
e50c3026198fd496f183cda4c32a202925476778covener <info>
5b88c8507d5ef6d0c4cfbc78230294968175b638minfrin <date>2007-06-18</date>
5b88c8507d5ef6d0c4cfbc78230294968175b638minfrin </info>
6c3b9cebb551140fbb25d58bae08b539b3802133ylavic <refentryinfo>
6c3b9cebb551140fbb25d58bae08b539b3802133ylavic <corpname>ISC</corpname>
6c3b9cebb551140fbb25d58bae08b539b3802133ylavic <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
4f29b65ab4b547ad5dbe506e2d0ff5d12ead9247ylavic </refentryinfo>
4f29b65ab4b547ad5dbe506e2d0ff5d12ead9247ylavic
0a0df13b7f1f4f1a74fe295253d89ca3911b301aylavic <refmeta>
0a0df13b7f1f4f1a74fe295253d89ca3911b301aylavic <refentrytitle>lwres_config</refentrytitle>
0a0df13b7f1f4f1a74fe295253d89ca3911b301aylavic <manvolnum>3</manvolnum>
0a0df13b7f1f4f1a74fe295253d89ca3911b301aylavic <refmiscinfo>BIND9</refmiscinfo>
69301145375a889e7e37caf7cc7321ac0f91801erpluem </refmeta>
69301145375a889e7e37caf7cc7321ac0f91801erpluem
69301145375a889e7e37caf7cc7321ac0f91801erpluem <docinfo>
506bfe33206b2fece40ef25f695af39dd4130facjkaluza <copyright>
506bfe33206b2fece40ef25f695af39dd4130facjkaluza <year>2004</year>
506bfe33206b2fece40ef25f695af39dd4130facjkaluza <year>2005</year>
506bfe33206b2fece40ef25f695af39dd4130facjkaluza <year>2007</year>
d58a848a016d401b965111e50ef829e1641f7834minfrin <year>2014</year>
d58a848a016d401b965111e50ef829e1641f7834minfrin <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
d58a848a016d401b965111e50ef829e1641f7834minfrin </copyright>
2e6f4d654c96c98b761fb012fd25c5d5b1558c44sf <copyright>
2e6f4d654c96c98b761fb012fd25c5d5b1558c44sf <year>2000</year>
2e6f4d654c96c98b761fb012fd25c5d5b1558c44sf <year>2001</year>
17e6c95f3b22d18acdf8380fb26a8d0e10c80767ylavic <holder>Internet Software Consortium.</holder>
17e6c95f3b22d18acdf8380fb26a8d0e10c80767ylavic </copyright>
17e6c95f3b22d18acdf8380fb26a8d0e10c80767ylavic </docinfo>
17e6c95f3b22d18acdf8380fb26a8d0e10c80767ylavic
17e6c95f3b22d18acdf8380fb26a8d0e10c80767ylavic <refnamediv>
e8bd80a4bb88199d2f9a24a50345688e52d9c116ylavic <refname>lwres_conf_init</refname>
e8bd80a4bb88199d2f9a24a50345688e52d9c116ylavic <refname>lwres_conf_clear</refname>
e8bd80a4bb88199d2f9a24a50345688e52d9c116ylavic <refname>lwres_conf_parse</refname>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic <refname>lwres_conf_print</refname>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic <refname>lwres_conf_get</refname>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic <refpurpose>lightweight resolver configuration</refpurpose>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic </refnamediv>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic <refsynopsisdiv>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic <funcsynopsis>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener<funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener<funcprototype>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener <funcdef>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covenervoid
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener<function>lwres_conf_init</function></funcdef>
44ff304057225e944e220e981d434a046d14cf06covener <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
44ff304057225e944e220e981d434a046d14cf06covener </funcprototype>
44ff304057225e944e220e981d434a046d14cf06covener<funcprototype>
44ff304057225e944e220e981d434a046d14cf06covener <funcdef>
5d1ba75b8794925e67591c209085a49279791de9covenervoid
5d1ba75b8794925e67591c209085a49279791de9covener<function>lwres_conf_clear</function></funcdef>
5d1ba75b8794925e67591c209085a49279791de9covener <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
032982212dbcc7c3cce95bf89c503bb56e185ac7kbrand </funcprototype>
032982212dbcc7c3cce95bf89c503bb56e185ac7kbrand<funcprototype>
032982212dbcc7c3cce95bf89c503bb56e185ac7kbrand <funcdef>
032982212dbcc7c3cce95bf89c503bb56e185ac7kbrandlwres_result_t
caad2986f81ab263f7af41467dd622dc9add17f3ylavic<function>lwres_conf_parse</function></funcdef>
caad2986f81ab263f7af41467dd622dc9add17f3ylavic <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
caad2986f81ab263f7af41467dd622dc9add17f3ylavic <paramdef>const char *<parameter>filename</parameter></paramdef>
caad2986f81ab263f7af41467dd622dc9add17f3ylavic </funcprototype>
45a10d38e6051fd7bdf9d742aaae633d97ff02abjailletc<funcprototype>
f7317ff316c2b141feea31bddb74d5d3fa1584edjorton <funcdef>
f7317ff316c2b141feea31bddb74d5d3fa1584edjortonlwres_result_t
2165214331e4afafca4048f66f303d0253d7b001covener<function>lwres_conf_print</function></funcdef>
a34684a59b60a4173c25035d0c627ef17e6dc215rpluem <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
a34684a59b60a4173c25035d0c627ef17e6dc215rpluem <paramdef>FILE *<parameter>fp</parameter></paramdef>
1e2d421a36999d292042a5539971070d54aa6c63ylavic </funcprototype>
1e2d421a36999d292042a5539971070d54aa6c63ylavic<funcprototype>
1e2d421a36999d292042a5539971070d54aa6c63ylavic <funcdef>
fa7ed98b9dc94c5845cf845aea0a44ecacd290c9humbedoohlwres_conf_t *
fa7ed98b9dc94c5845cf845aea0a44ecacd290c9humbedooh<function>lwres_conf_get</function></funcdef>
fa7ed98b9dc94c5845cf845aea0a44ecacd290c9humbedooh <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
0b67eb8568cd58bb77082703951679b42cf098actrawick </funcprototype>
0b67eb8568cd58bb77082703951679b42cf098actrawick</funcsynopsis>
0b67eb8568cd58bb77082703951679b42cf098actrawick </refsynopsisdiv>
0b67eb8568cd58bb77082703951679b42cf098actrawick
5ef3c61605a3a021ff71f488983cb0065f8e1a79covener <refsection><info><title>DESCRIPTION</title></info>
fb1985a97912b25ec6564c73e610a31e5fc6e25fcovener
09c87c777bed1655621bb20e1c46cb6b1a63279dcovener
6502b7b32f980cc2093bb3ebce37e5e4dc68fba4ylavic <para><function>lwres_conf_init()</function>
6502b7b32f980cc2093bb3ebce37e5e4dc68fba4ylavic creates an empty
3060ce7f798fbda7999cd4ddf89b525d2b294185covener <type>lwres_conf_t</type>
c1a63b8fad09c419c1a64f75993feb8a343a6801ylavic structure for lightweight resolver context
c1a63b8fad09c419c1a64f75993feb8a343a6801ylavic <parameter>ctx</parameter>.
c1a63b8fad09c419c1a64f75993feb8a343a6801ylavic </para>
e6b4bd1113567627ab6bb6c6a7105e1e01a7d889jailletc
e6b4bd1113567627ab6bb6c6a7105e1e01a7d889jailletc <para><function>lwres_conf_clear()</function>
e466c40e1801982602ee0200c9e8b61cc148742djailletc frees up all the internal memory used by
e466c40e1801982602ee0200c9e8b61cc148742djailletc that
457468b82e59d01eba00dd9d0817309c8f5e414ejim <type>lwres_conf_t</type>
457468b82e59d01eba00dd9d0817309c8f5e414ejim structure in resolver context
457468b82e59d01eba00dd9d0817309c8f5e414ejim <parameter>ctx</parameter>.
04983e3bd1754764eec7d6bb772fe3b0bf391771jorton </para>
04983e3bd1754764eec7d6bb772fe3b0bf391771jorton
15890c9306ba98f6fc243e15a3c4778ddc7d773erpluem <para><function>lwres_conf_parse()</function>
15660979a30d251681463de2e0584853890082accovener opens the file
15660979a30d251681463de2e0584853890082accovener <parameter>filename</parameter>
49dacedb6c387b786b7911082ff35121a45f414bcovener and parses it to initialise the resolver context
49dacedb6c387b786b7911082ff35121a45f414bcovener <parameter>ctx</parameter>'s
cfd9415521847b2f9394fad04fb701cfb955f503rjung <type>lwres_conf_t</type>
cfd9415521847b2f9394fad04fb701cfb955f503rjung structure.
cfd9415521847b2f9394fad04fb701cfb955f503rjung </para>
28c31fb73c1264bd1d0ff932573677030b024c7dwrowe
28c31fb73c1264bd1d0ff932573677030b024c7dwrowe <para><function>lwres_conf_print()</function>
28c31fb73c1264bd1d0ff932573677030b024c7dwrowe prints the
28c31fb73c1264bd1d0ff932573677030b024c7dwrowe <type>lwres_conf_t</type>
28c31fb73c1264bd1d0ff932573677030b024c7dwrowe structure for resolver context
8491e0600f69b0405e156ea8a419653c065c645bcovener <parameter>ctx</parameter>
63b9f1f5880391261705f696d7d65507bbe9ace3covener to the
63b9f1f5880391261705f696d7d65507bbe9ace3covener <type>FILE</type>
63b9f1f5880391261705f696d7d65507bbe9ace3covener <parameter>fp</parameter>.
49dacedb6c387b786b7911082ff35121a45f414bcovener </para>
49dacedb6c387b786b7911082ff35121a45f414bcovener </refsection>
49dacedb6c387b786b7911082ff35121a45f414bcovener <refsection><info><title>RETURN VALUES</title></info>
49dacedb6c387b786b7911082ff35121a45f414bcovener
3c990331fc6702119e4f5b8ba9eae3021aea5265jim
3c990331fc6702119e4f5b8ba9eae3021aea5265jim
3c990331fc6702119e4f5b8ba9eae3021aea5265jim <para><function>lwres_conf_parse()</function>
3c990331fc6702119e4f5b8ba9eae3021aea5265jim returns <errorcode>LWRES_R_SUCCESS</errorcode>
fc42512879dd0504532f52fe5d0d0383dda96a1eniq if it successfully read and parsed
fc42512879dd0504532f52fe5d0d0383dda96a1eniq <parameter>filename</parameter>.
fc42512879dd0504532f52fe5d0d0383dda96a1eniq It returns <errorcode>LWRES_R_FAILURE</errorcode>
0451df5dc50fa5d8b3e07d92ee6a92e36a1181a5niq if <parameter>filename</parameter>
0451df5dc50fa5d8b3e07d92ee6a92e36a1181a5niq could not be opened or contained incorrect
0451df5dc50fa5d8b3e07d92ee6a92e36a1181a5niq resolver statements.
da0442c0440caef34706e2c2f3af05cb65921cc0jailletc </para>
983528026996668ea295be95aedb9c7a346af470ylavic
da0442c0440caef34706e2c2f3af05cb65921cc0jailletc <para><function>lwres_conf_print()</function>
da0442c0440caef34706e2c2f3af05cb65921cc0jailletc returns <errorcode>LWRES_R_SUCCESS</errorcode>
06b8f183140c8e02e0974e938a05078b511d1603covener unless an error occurred when converting the network addresses to a
06b8f183140c8e02e0974e938a05078b511d1603covener numeric host address string.
06b8f183140c8e02e0974e938a05078b511d1603covener If this happens, the function returns
15890c9306ba98f6fc243e15a3c4778ddc7d773erpluem <errorcode>LWRES_R_FAILURE</errorcode>.
259878293a997ff49f5ddfc53d3739cbdc25444ecovener </para>
259878293a997ff49f5ddfc53d3739cbdc25444ecovener </refsection>
259878293a997ff49f5ddfc53d3739cbdc25444ecovener <refsection><info><title>SEE ALSO</title></info>
259878293a997ff49f5ddfc53d3739cbdc25444ecovener
15890c9306ba98f6fc243e15a3c4778ddc7d773erpluem <para><citerefentry>
b54b024c06a19926832d77d40ba35ad8c41e4d3dminfrin <refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
b54b024c06a19926832d77d40ba35ad8c41e4d3dminfrin </citerefentry>,
b54b024c06a19926832d77d40ba35ad8c41e4d3dminfrin <citerefentry>
65967d05f839dbf27cf91d91fa79585eeae19660minfrin <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
65967d05f839dbf27cf91d91fa79585eeae19660minfrin </citerefentry>.
65967d05f839dbf27cf91d91fa79585eeae19660minfrin </para>
65967d05f839dbf27cf91d91fa79585eeae19660minfrin </refsection>
8152945ae46857b170cb227e79bb799f4fc7710dminfrin <refsection><info><title>FILES</title></info>
8152945ae46857b170cb227e79bb799f4fc7710dminfrin
8152945ae46857b170cb227e79bb799f4fc7710dminfrin <para><filename>/etc/resolv.conf</filename>
8152945ae46857b170cb227e79bb799f4fc7710dminfrin </para>
75f5c2db254c0167a0e396254460de09b775d203trawick </refsection>
75f5c2db254c0167a0e396254460de09b775d203trawick</refentry>
75f5c2db254c0167a0e396254460de09b775d203trawick