When an interface is marked private, we just discard the nameservers from the
[openresolv] / resolvconf.8.in
index 0c2c011e01225b8b084ade1dd43f901ac5c7a6d8..6ea701d519d0586ab5b211a58b976fd9b9f76339 100644 (file)
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd September 17, 2008
+.Dd October 03, 2008
 .Dt RESOLVCONF 8 SMM
 .Sh NAME
 .Nm resolvconf
@@ -30,6 +30,7 @@
 .Sh SYNOPSIS
 .Nm
 .Op Fl m Ar metric
+.Op Fl p
 .Fl a Ar interface No < Ns Pa file
 .Nm
 .Op Fl f
@@ -72,28 +73,23 @@ or
 then
 .Nm
 will supply files that the resolver should be configured to include.
-This allows
+.Pp
 .Nm
-to configure the local resolver such that
+can mark an interfaces
 .Pa resolv.conf
-files specifiying a domain only query the listed nameservers when resolving
-for that domain.
-Otherwise the nameservers are treated as global nameservers.
-This in turn means, that you can trivially configure nameservers for say
-VPN domains.
-Example:-
-.Bd -literal -offset indent
-# resolv.conf from bge0
-search foo.com
-nameserver 1.2.3.4
-
-# resolv.conf from tap0
-domain bar.org
-nameserver 5.6.7.8
-.Ed
-.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.
+as private.
+This means that the nameservers listed in that
+.Pa resolv.conf
+are only used for queries against the domain/search listed in the same file.
+This only works when a local resolver other than libc is installed.
+Doing this, you would probably want
+.Nm
+to always configure
+.Pa /etc/resolv.conf
+with the local nameserver.
+See
+.Pa @SYSCONFDIR@/resolv.conf.d/base
+below on how to do this.
 .Pp
 When an interface goes down, it should then call
 .Nm
@@ -128,6 +124,10 @@ is specified then we list the files for the interfaces that match it.
 Set the metric of the interface when adding it, default of 0.
 Lower metrics take precedence.
 This affects the default order of interfaces when listed.
+.It Fl p
+Marks the interface
+.Pa resolv.conf
+as private.
 .It Fl u
 Force
 .Nm
@@ -150,7 +150,7 @@ Normally this is something like
 We have this command, so the helpers don't have to know too much about the
 operating system on the host.
 .It Fl v
-Echo variables NEWDOMAIN, NEWSEARCH and NEWNS so that the helper can configure
+Echo variables DOMAINS, SEARCH and NAMESERVERS so that the helper can configure
 the resolver easily.
 .El
 .Sh ENVIRONMENT
@@ -161,6 +161,10 @@ If the
 option is not present then we use
 .Va IF_METRIC
 for the metric.
+.It Va IF_PRIVATE
+Marks the interface
+.Pa resolv.conf
+as private.
 .El
 .Sh FILES
 .Bl -ohang
@@ -176,10 +180,16 @@ Directory of helper scripts which are run after the libc helper script is run.
 .It Pa @SYSCONFDIR@/interface-order
 Determines the order in which nameserver information records are processed
 by resolvconf -l.
+.It Pa @SYSCONFDIR@/private-interfaces
+A list of interfaces who should be marked as private by default.
 .It Pa @SYSCONFDIR@/resolv.conf.d/base
 Contains basic resolver information which is included in
 .Pa /etc/resolv.conf
 even when no interfaces are configured.
+This is a good place to set libc to always use your local nameserver like so:
+.Bd -literal -offset indent
+nameserver 127.0.0.1
+.Ed
 .It Pa @SYSCONFDIR@/resolv.conf.d/head
 File to be prepended to
 .Pa /etc/resolv.conf .