doc: Update the manpage for resolv.conf.
authorAndreas Schneider <asn@samba.org>
Thu, 4 Sep 2014 09:19:04 +0000 (11:19 +0200)
committerMichael Adam <obnox@samba.org>
Tue, 21 Oct 2014 11:39:39 +0000 (13:39 +0200)
Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Michael Adam <obnox@samba.org>
doc/resolv_wrapper.1
doc/resolv_wrapper.1.txt

index e4bd945..911f4b4 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: resolv_wrapper
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 08/28/2014
+.\"      Date: 10/12/2014
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "RESOLV_WRAPPER" "1" "08/28/2014" "\ \&" "\ \&"
+.TH "RESOLV_WRAPPER" "1" "10/12/2014" "\ \&" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "NAME"
-resolv_wrapper \- A wrapper for the dns resolving\&.
+resolv_wrapper \- A wrapper for the dns resolving with our own resolv\&.conf\&.
 .SH "SYNOPSIS"
 .sp
-LD_PRELOAD=libresolv_wrapper\&.so RESOLV_WRAPPER_NAMESERVER="127\&.0\&.0\&.21" \fB\&./myapplication\fR
+LD_PRELOAD=libresolv_wrapper\&.so RESOLV_WRAPPER_CONF="/path/to/resolv\&.conf" \fB\&./myapplication\fR
 .SH "DESCRIPTION"
 .sp
-TODO
+resolv_wrapper makes it possible on most UNIX platforms to contact your own DNS implmentation in your test environment\&. It requires socket_wrapper to be able to contact it\&.
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Redirects name queries to the nameservers specified in your resolv\&.conf
+.RE
 .SH "ENVIRONMENT VARIABLES"
 .PP
-\fBRESOLV_WRAPPER_NAMESERVER\fR
+\fBRESOLV_WRAPPER_CONF\fR
 .RS 4
-Specify the nameserver to use\&.
+This is used to specify the resolv\&.conf to use\&. The format of the resolv\&.conf file is defined in the manpage
+\fIresolv\&.conf(5)\fR\&. Currently only the
+\fBnamserver\fR
+directive is supported\&.
 .RE
 .PP
 \fBRESOLV_WRAPPER_DEBUGLEVEL\fR
@@ -96,7 +110,7 @@ If you need to see what is going on in resolv_wrapper itself or try to find a bu
 .RS 4
 .\}
 .nf
-$ LD_PRELOAD=libresolv_wrapper\&.so RESOLV_WRAPPER_NAMESERVER="127\&.0\&.0\&.21" dig test\&.example\&.site
+$ LD_PRELOAD=libresolv_wrapper\&.so RESOLV_WRAPPER_CONF="\&./resolv\&.conf" dig test\&.example\&.site
 .fi
 .if n \{\
 .RE
index 0754136..132ec36 100644 (file)
@@ -4,24 +4,30 @@ resolv_wrapper(1)
 NAME
 ----
 
-resolv_wrapper - A wrapper for the dns resolving.
+resolv_wrapper - A wrapper for the dns resolving with our own resolv.conf.
 
 SYNOPSIS
 --------
 
-LD_PRELOAD=libresolv_wrapper.so RESOLV_WRAPPER_NAMESERVER="127.0.0.21" *./myapplication*
+LD_PRELOAD=libresolv_wrapper.so RESOLV_WRAPPER_CONF="/path/to/resolv.conf" *./myapplication*
 
 DESCRIPTION
 -----------
 
-TODO
+resolv_wrapper makes it possible on most UNIX platforms to contact your own DNS
+implmentation in your test environment. It requires socket_wrapper to be able
+to contact it.
+
+- Redirects name queries to the nameservers specified in your resolv.conf
 
 ENVIRONMENT VARIABLES
 ---------------------
 
-*RESOLV_WRAPPER_NAMESERVER*::
+*RESOLV_WRAPPER_CONF*::
 
-Specify the nameserver to use.
+This is used to specify the resolv.conf to use. The format of the resolv.conf
+file is defined in the manpage 'resolv.conf(5)'. Currently only the *namserver*
+directive is supported.
 
 *RESOLV_WRAPPER_DEBUGLEVEL*::
 
@@ -37,4 +43,4 @@ debug symbols.
 EXAMPLE
 -------
 
-  $ LD_PRELOAD=libresolv_wrapper.so RESOLV_WRAPPER_NAMESERVER="127.0.0.21" dig test.example.site
+  $ LD_PRELOAD=libresolv_wrapper.so RESOLV_WRAPPER_CONF="./resolv.conf" dig test.example.site