/contrib/bind9/lib/lwres/man/lwres_config.docbook

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 174 lines · 160 code · 14 blank · 0 comment · 0 complexity · 2ec38c970f718cdeb6a1a198ad4bcaa4 MD5 · raw file

  1. <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  2. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
  3. [<!ENTITY mdash "&#8212;">]>
  4. <!--
  5. - Copyright (C) 2004, 2005, 2007, 2012 Internet Systems Consortium, Inc. ("ISC")
  6. - Copyright (C) 2000, 2001 Internet Software Consortium.
  7. -
  8. - Permission to use, copy, modify, and/or distribute this software for any
  9. - purpose with or without fee is hereby granted, provided that the above
  10. - copyright notice and this permission notice appear in all copies.
  11. -
  12. - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  13. - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  14. - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  15. - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  16. - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  17. - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  18. - PERFORMANCE OF THIS SOFTWARE.
  19. -->
  20. <!-- $Id$ -->
  21. <refentry>
  22. <refentryinfo>
  23. <date>Jun 30, 2000</date>
  24. </refentryinfo>
  25. <refmeta>
  26. <refentrytitle>lwres_config</refentrytitle>
  27. <manvolnum>3</manvolnum>
  28. <refmiscinfo>BIND9</refmiscinfo>
  29. </refmeta>
  30. <docinfo>
  31. <copyright>
  32. <year>2004</year>
  33. <year>2005</year>
  34. <year>2007</year>
  35. <year>2012</year>
  36. <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  37. </copyright>
  38. <copyright>
  39. <year>2000</year>
  40. <year>2001</year>
  41. <holder>Internet Software Consortium.</holder>
  42. </copyright>
  43. </docinfo>
  44. <refnamediv>
  45. <refname>lwres_conf_init</refname>
  46. <refname>lwres_conf_clear</refname>
  47. <refname>lwres_conf_parse</refname>
  48. <refname>lwres_conf_print</refname>
  49. <refname>lwres_conf_get</refname>
  50. <refpurpose>lightweight resolver configuration</refpurpose>
  51. </refnamediv>
  52. <refsynopsisdiv>
  53. <funcsynopsis>
  54. <funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
  55. <funcprototype>
  56. <funcdef>
  57. void
  58. <function>lwres_conf_init</function></funcdef>
  59. <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  60. </funcprototype>
  61. <funcprototype>
  62. <funcdef>
  63. void
  64. <function>lwres_conf_clear</function></funcdef>
  65. <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  66. </funcprototype>
  67. <funcprototype>
  68. <funcdef>
  69. lwres_result_t
  70. <function>lwres_conf_parse</function></funcdef>
  71. <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  72. <paramdef>const char *<parameter>filename</parameter></paramdef>
  73. </funcprototype>
  74. <funcprototype>
  75. <funcdef>
  76. lwres_result_t
  77. <function>lwres_conf_print</function></funcdef>
  78. <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  79. <paramdef>FILE *<parameter>fp</parameter></paramdef>
  80. </funcprototype>
  81. <funcprototype>
  82. <funcdef>
  83. lwres_conf_t *
  84. <function>lwres_conf_get</function></funcdef>
  85. <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
  86. </funcprototype>
  87. </funcsynopsis>
  88. </refsynopsisdiv>
  89. <refsect1>
  90. <title>DESCRIPTION</title>
  91. <para><function>lwres_conf_init()</function>
  92. creates an empty
  93. <type>lwres_conf_t</type>
  94. structure for lightweight resolver context
  95. <parameter>ctx</parameter>.
  96. </para>
  97. <para><function>lwres_conf_clear()</function>
  98. frees up all the internal memory used by
  99. that
  100. <type>lwres_conf_t</type>
  101. structure in resolver context
  102. <parameter>ctx</parameter>.
  103. </para>
  104. <para><function>lwres_conf_parse()</function>
  105. opens the file
  106. <parameter>filename</parameter>
  107. and parses it to initialise the resolver context
  108. <parameter>ctx</parameter>'s
  109. <type>lwres_conf_t</type>
  110. structure.
  111. </para>
  112. <para><function>lwres_conf_print()</function>
  113. prints the
  114. <type>lwres_conf_t</type>
  115. structure for resolver context
  116. <parameter>ctx</parameter>
  117. to the
  118. <type>FILE</type>
  119. <parameter>fp</parameter>.
  120. </para>
  121. </refsect1>
  122. <refsect1>
  123. <title>RETURN VALUES</title>
  124. <para><function>lwres_conf_parse()</function>
  125. returns <errorcode>LWRES_R_SUCCESS</errorcode>
  126. if it successfully read and parsed
  127. <parameter>filename</parameter>.
  128. It returns <errorcode>LWRES_R_FAILURE</errorcode>
  129. if <parameter>filename</parameter>
  130. could not be opened or contained incorrect
  131. resolver statements.
  132. </para>
  133. <para><function>lwres_conf_print()</function>
  134. returns <errorcode>LWRES_R_SUCCESS</errorcode>
  135. unless an error occurred when converting the network addresses to a
  136. numeric host address string.
  137. If this happens, the function returns
  138. <errorcode>LWRES_R_FAILURE</errorcode>.
  139. </para>
  140. </refsect1>
  141. <refsect1>
  142. <title>SEE ALSO</title>
  143. <para><citerefentry>
  144. <refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
  145. </citerefentry>,
  146. <citerefentry>
  147. <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
  148. </citerefentry>.
  149. </para>
  150. </refsect1>
  151. <refsect1>
  152. <title>FILES</title>
  153. <para><filename>/etc/resolv.conf</filename>
  154. </para>
  155. </refsect1>
  156. </refentry><!--
  157. - Local variables:
  158. - mode: sgml
  159. - End:
  160. -->