lwres/man/lwres_config.html

	lwres_config.html revision e3f6b4d2195b2fcd28f769452d460d1b35f1952a
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell<!--
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - Copyright (C) 2000, 2001  Internet Software Consortium.
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell -
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - Permission to use, copy, modify, and distribute this software for any
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - purpose with or without fee is hereby granted, provided that the above
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - copyright notice and this permission notice appear in all copies.
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell -
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell - PERFORMANCE OF THIS SOFTWARE.
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell-->
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell<HTML
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell><HEAD
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><TITLE
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell>lwres_config</TITLE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><META
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellNAME="GENERATOR"
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert WapshottCONTENT="Modular DocBook HTML Stylesheet Version 1.73
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell"></HEAD
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><BODY
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnellCLASS="REFENTRY"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnellBGCOLOR="#FFFFFF"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnellTEXT="#000000"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnellLINK="#0000FF"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnellVLINK="#840084"
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert WapshottALINK="#0000FF"
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><H1
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><A
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellNAME="AEN1"
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott>lwres_config</A
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></H1
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><DIV
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="REFNAMEDIV"
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott><A
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnellNAME="AEN8"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell></A
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell><H2
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>Name</H2
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get&nbsp;--&nbsp;lightweight resolver configuration</DIV
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><DIV
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="REFSYNOPSISDIV"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><A
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert WapshottNAME="AEN15"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></A
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell><H2
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell>Synopsis</H2
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell><DIV
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert WapshottCLASS="FUNCSYNOPSIS"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell><A
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnellNAME="AEN16"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell></A
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><P
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></P
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><PRE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="FUNCSYNOPSISINFO"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>#include &lt;lwres/lwres.h&gt;</PRE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><P
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="FUNCDEF"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>void
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnelllwres_conf_init</CODE
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>(lwres_context_t *ctx);</CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></P
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="FUNCDEF"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>void
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnelllwres_conf_clear</CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>(lwres_context_t *ctx);</CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><CODE
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert WapshottCLASS="FUNCDEF"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>lwres_result_t
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnelllwres_conf_parse</CODE
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>(lwres_context_t *ctx, const char *filename);</CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></P
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><CODE
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert WapshottCLASS="FUNCDEF"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>lwres_result_t
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnelllwres_conf_print</CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>(lwres_context_t *ctx, FILE *fp);</CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="FUNCDEF"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>lwres_conf_t *
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshottlwres_conf_get</CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>(lwres_context_t *ctx);</CODE
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><P
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></P
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></DIV
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott></DIV
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><DIV
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="REFSECT1"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><A
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellNAME="AEN40"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></A
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell><H2
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>DESCRIPTION</H2
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><TT
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="FUNCTION"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>lwres_conf_init()</TT
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellcreates an empty
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell<SPAN
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert WapshottCLASS="TYPE"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>lwres_conf_t</SPAN
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellstructure for lightweight resolver context
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell<TT
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="PARAMETER"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell><I
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>ctx</I
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott></TT
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>.</P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><TT
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert WapshottCLASS="FUNCTION"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell>lwres_conf_clear()</TT
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell>
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshottfrees up all the internal memory used by
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshottthat
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott<SPAN
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert WapshottCLASS="TYPE"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>lwres_conf_t</SPAN
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshottstructure in resolver context
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott<TT
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="PARAMETER"
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott><I
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>ctx</I
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott></TT
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>.</P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><P
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott><TT
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="FUNCTION"
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>lwres_conf_parse()</TT
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshottopens the file
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott<TT
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert WapshottCLASS="PARAMETER"
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott><I
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott>filename</I
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott></TT
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshottand parses it to initialise the resolver context
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott<TT
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellCLASS="PARAMETER"
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott><I
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>ctx</I
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell></TT
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>'s
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott<SPAN
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert WapshottCLASS="TYPE"
91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5bRobert Wapshott>lwres_conf_t</SPAN
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshottstructure.</P
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell><P
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell><TT
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert WapshottCLASS="FUNCTION"
721bb987c406979bcfe705fa1ca8d54497d40fcbRobert Wapshott>lwres_conf_print()</TT
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnell>
415243fbc81341293a852ff6aa14e9608d08685cCraig McDonnellprints the
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell<SPAN
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnellCLASS="TYPE"
2beebed98b4fc7f018fb224a1e4a3ab6103a4c0bCraig McDonnell>lwres_conf_t</SPAN
>
structure for resolver context
<TT
CLASS="PARAMETER"
><I
>ctx</I
></TT
>
to the
<SPAN
CLASS="TYPE"
>FILE</SPAN
>
<TT
CLASS="PARAMETER"
><I
>fp</I
></TT
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61"
></A
><H2
>RETURN VALUES</H2
><P
><TT
CLASS="FUNCTION"
>lwres_conf_parse()</TT
>
returns
<SPAN
CLASS="ERRORCODE"
>LWRES_R_SUCCESS</SPAN
>
if it successfully read and parsed
<TT
CLASS="PARAMETER"
><I
>filename</I
></TT
>.
It returns
<SPAN
CLASS="ERRORCODE"
>LWRES_R_FAILURE</SPAN
>
if
<TT
CLASS="PARAMETER"
><I
>filename</I
></TT
>
could not be opened or contained incorrect
resolver statements.</P
><P
><TT
CLASS="FUNCTION"
>lwres_conf_print()</TT
>
returns
<SPAN
CLASS="ERRORCODE"
>LWRES_R_SUCCESS</SPAN
>
unless an error occurred when converting the network addresses to a
numeric host address string.
If this happens, the function returns
<SPAN
CLASS="ERRORCODE"
>LWRES_R_FAILURE</SPAN
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN73"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>stdio</SPAN
>(3)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>resolver</SPAN
>(5)</SPAN
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN82"
></A
><H2
>FILES</H2
><P
><TT
CLASS="FILENAME"
>/etc/resolv.conf</TT
></P
></DIV
></BODY
></HTML
>