diff options
Diffstat (limited to 'lib/lwres/man/lwres_config.docbook')
| -rw-r--r-- | lib/lwres/man/lwres_config.docbook | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/lib/lwres/man/lwres_config.docbook b/lib/lwres/man/lwres_config.docbook new file mode 100644 index 0000000..83ebeeb --- /dev/null +++ b/lib/lwres/man/lwres_config.docbook @@ -0,0 +1,165 @@ +<!-- + - Copyright (C) Internet Systems Consortium, Inc. ("ISC") + - + - This Source Code Form is subject to the terms of the Mozilla Public + - License, v. 2.0. If a copy of the MPL was not distributed with this + - file, You can obtain one at http://mozilla.org/MPL/2.0/. + - + - See the COPYRIGHT file distributed with this work for additional + - information regarding copyright ownership. +--> + +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0"> + <info> + <date>2007-06-18</date> + </info> + <refentryinfo> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> + </refentryinfo> + + <refmeta> + <refentrytitle>lwres_config</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>BIND9</refmiscinfo> + </refmeta> + + <docinfo> + <copyright> + <year>2000</year> + <year>2001</year> + <year>2004</year> + <year>2005</year> + <year>2007</year> + <year>2014</year> + <year>2015</year> + <year>2016</year> + <year>2018</year> + <year>2019</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + </docinfo> + + <refnamediv> + <refname>lwres_conf_init</refname> + <refname>lwres_conf_clear</refname> + <refname>lwres_conf_parse</refname> + <refname>lwres_conf_print</refname> + <refname>lwres_conf_get</refname> + <refpurpose>lightweight resolver configuration</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> +<funcsynopsisinfo>#include <lwres/lwres.h></funcsynopsisinfo> +<funcprototype> + <funcdef> +void +<function>lwres_conf_init</function></funcdef> + <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef> + </funcprototype> +<funcprototype> + <funcdef> +void +<function>lwres_conf_clear</function></funcdef> + <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef> + </funcprototype> +<funcprototype> + <funcdef> +lwres_result_t +<function>lwres_conf_parse</function></funcdef> + <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef> + <paramdef>const char *<parameter>filename</parameter></paramdef> + </funcprototype> +<funcprototype> + <funcdef> +lwres_result_t +<function>lwres_conf_print</function></funcdef> + <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef> + <paramdef>FILE *<parameter>fp</parameter></paramdef> + </funcprototype> +<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> |