Only update our files if PREFIX is non null and not /
[openresolv] / resolvconf.8
index 6d51a4c1ef9e0a79c843fb1f8ca2b0e1bc90680f..70943b39c2bf35ed5958b648237d9f31e5600a28 100644 (file)
@@ -1,6 +1,4 @@
-.\" $Id$
-.\"
-.TH RESOLVCONF 8 "1 Aug 2007" "resolvconf-1.4"
+.TH RESOLVCONF 8 "9 Nov 2007" "openresolv"
 .SH NAME
 resolvconf \- manage nameserver information
 .SH SYNOPSIS
@@ -25,7 +23,7 @@ cat \fIFILE\fR |
 .SH DESCRIPTION
 Overwrite (\fB\-a\fR) or delete (\fB\-d\fR) the nameserver information
 record for network interface \fIINTERFACE\fR
-and run the update scripts in \fI/etc/resolvconf/update.d/\fR.
+and run the update scripts in \fI%%PREFIX%%/etc/resolvconf/update.d/\fR.
 .PP
 With \fB\-u\fR, just run the update scripts.
 .PP
@@ -46,7 +44,7 @@ such as
 .BR pppd (8) 
 (for ppp interfaces),
 to DHCP clients such as
-.BR dhclient (8),
+.BR dhcpcd (8),
 to
 .BR /etc/init.d/net.eth0 
 and
@@ -63,8 +61,8 @@ Nameserver information provided to
 .B resolvconf
 is stored for use by subscribers to \fBresolvconf\fR's notification service.
 Subscribers that need to know when nameserver information has changed
-should install a script in \fI/etc/resolvconf/update.d/\fR
-(... or in \fI/etc/resolvconf/update-libc.d/\fR: see below).
+should install a script in \fI%%PREFIX%%/etc/resolvconf/update.d/\fR
+(... or in \fI%%PREFIX%%/etc/resolvconf/update-libc.d/\fR: see below).
 For example, DNS caches such as
 .BR dnsmasq (8)
 and
@@ -77,25 +75,46 @@ software that subscribes to the notification service is the set of functions
 that make up the GNU C Library
 .BR resolver (3).
 When nameserver information is updated the script
-\fI/etc/resolvconf/update.d/libc\fR writes a new resolver configuration
-file to \fI/etc/resolvconf/run/resolv.conf\fR and then runs the scripts in
-/etc/resolvconf/update-libc.d/.
+\fI%%PREFIX%%/etc/resolvconf/update.d/libc\fR writes a new resolver configuration
+file to \fI%%PREFIX%%/etc/resolvconf/run/resolv.conf\fR and then runs the scripts in
+%%PREFIX%%/etc/resolvconf/update-libc.d/.
 To make the resolver use the dynamically generated resolver configuration
 file the administrator should ensure that \fI/etc/resolv.conf\fR is a symbolic
-link to \fIresolvconf/run/resolv.conf\fR.
+link to \fI%%PREFIX%%/etc/resolvconf/run/resolv.conf\fR.
 This link is never modified by \fB/sbin/resolvconf\fR.
 If you find that \fI/etc/resolv.conf\fR is not being updated,
 check to see that the link is intact.
 .PP
-The GNU C Library resolver library isn't the only resolver library available.
+The C Library resolver library isn't the only resolver library available.
 However, any resolver library that reads /etc/resolv.conf
-(and most of them do, in order to be compatible with the GNU C Library resolver)
-should work with
-.BR resolvconf .
+(and most of them do, in order to be compatible with the C Library resolver)
+should work with \fBresolvconf\fR.
+.PP
+\fBopenresolv\fR ships with subscribers for
+.BR dnsmasq (8)
+and
+.BR named (8)
+wwhich handle resolv.conf a bit differently. If they handle search AND domain
+options then the nameservers listed with the domain are only used when
+querying for that domain.
+.TP
+Example
+.nf
+# resolv.conf from bge0
+# search foo.com
+# nameserver 1.2.3.4
+
+# resolv.conf from tap0
+# domain bar.org
+# nameserver 5.6.7.8
+.fi
+.PP
+In this instance, nameserver 5.6.7.8 will only handle requests for bar.org
+and nameserver 1.2.3.4 will handle everything else.
 .PP
 Subscribers that need to know only when the resolver configuration file
 has changed should install a script in \fI/etc/resolvconf/update-libc.d/\fR
-rather than in \fI/etc/resolvconf/update.d/\fR.
+rather than in \fI%%PREFIX%%/etc/resolvconf/update.d/\fR.
 (This is important for synchronization purposes:
 scripts in \fIupdate-libc.d/\fR are run after resolv.conf has been updated;
 the same is not necessarily true of scripts in update.d/.)
@@ -133,26 +152,26 @@ List the interfaces that match the pattern otherwise all the interfaces.
 Echo variables NEWDOMAIN, NEWSEARCH and NEWNS to the console.
 .SH FILES
 .TP
-.I /etc/resolvconf/run
+.I %%PREFIX%%/etc/resolvconf/run
 This is either a directory where nameserver information can be stored
 or a symbolic link to such a directory.
 Clients should not make any assumptions about the canonical location
 of this directory or the hierarchy that is constructed under it.
 .TP
-.I /etc/resolvconf/interface-order
+.I %%PREFIX%%/etc/resolvconf/interface-order
 Determines the order in which nameserver information records are processed
 by resolvconf -l.
 .TP
-.I /etc/resolvconf/resolv.conf.d/base
+.I %%PREFIX%%/etc/resolvconf/resolv.conf.d/base
 File containing basic resolver information.
 The lines in this file are included in the resolver configuration file
 even when no interfaces are configured.
 .TP
-.I /etc/resolvconf/resolv.conf.d/head
+.I %%PREFIX%%/etc/resolvconf/resolv.conf.d/head
 File to be prepended to the dynamically generated resolver configuration file.
 Normally this is just a comment line.
 .TP
-.I /etc/resolvconf/reslov.conf.d/tail
+.I %%PREFIX%%/etc/resolvconf/reslov.conf.d/tail
 File to be appended to the dynamically generated resolver configuration file.
 To append nothing, make this an empty file.
 .SH BUGS
@@ -160,14 +179,13 @@ Currently
 .B resolvconf
 does not check the sanity of the information provided to it.
 .SH AUTHOR
-Written by Roy Marples <uberlord@gentoo.org>.
+Written by Roy Marples <roy@marples.name>.
 .br
 Heavily based on Debians resolvconf by Thomas Hood <jdthood_AT_yahoo.co.uk>
 .SH COPYRIGHT
-Copyright \(co 2006-2007 Gentoo Foundation
+Copyright \(co 2006 Gentoo Foundation
 .br
-This is free software; see the source for copying conditions.  There is NO
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+Copyright \(co 2007 Roy Marples
 .SH "SEE ALSO"
 .BR resolv.conf (5),
 .BR resolver (3).