doc: Update the manpage for resolv.conf.
[resolv_wrapper.git] / doc / resolv_wrapper.1.txt
1 resolv_wrapper(1)
2 =================
3
4 NAME
5 ----
6
7 resolv_wrapper - A wrapper for the dns resolving with our own resolv.conf.
8
9 SYNOPSIS
10 --------
11
12 LD_PRELOAD=libresolv_wrapper.so RESOLV_WRAPPER_CONF="/path/to/resolv.conf" *./myapplication*
13
14 DESCRIPTION
15 -----------
16
17 resolv_wrapper makes it possible on most UNIX platforms to contact your own DNS
18 implmentation in your test environment. It requires socket_wrapper to be able
19 to contact it.
20
21 - Redirects name queries to the nameservers specified in your resolv.conf
22
23 ENVIRONMENT VARIABLES
24 ---------------------
25
26 *RESOLV_WRAPPER_CONF*::
27
28 This is used to specify the resolv.conf to use. The format of the resolv.conf
29 file is defined in the manpage 'resolv.conf(5)'. Currently only the *namserver*
30 directive is supported.
31
32 *RESOLV_WRAPPER_DEBUGLEVEL*::
33
34 If you need to see what is going on in resolv_wrapper itself or try to find a
35 bug, you can enable logging support in resolv_wrapper if you built it with
36 debug symbols.
37
38 - 0 = ERROR
39 - 1 = WARNING
40 - 2 = DEBUG
41 - 3 = TRACE
42
43 EXAMPLE
44 -------
45
46   $ LD_PRELOAD=libresolv_wrapper.so RESOLV_WRAPPER_CONF="./resolv.conf" dig test.example.site