diff options
Diffstat (limited to 'contrib/openresolv/resolvconf.8.in')
| -rw-r--r-- | contrib/openresolv/resolvconf.8.in | 108 |
1 files changed, 87 insertions, 21 deletions
diff --git a/contrib/openresolv/resolvconf.8.in b/contrib/openresolv/resolvconf.8.in index 4e6f59a0449e..10dcf5dd7399 100644 --- a/contrib/openresolv/resolvconf.8.in +++ b/contrib/openresolv/resolvconf.8.in @@ -1,4 +1,4 @@ -.\" Copyright (c) 2007-2009 Roy Marples +.\" Copyright (c) 2007-2015 Roy Marples .\" All rights reserved .\" .\" Redistribution and use in source and binary forms, with or without @@ -22,8 +22,8 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd December 3, 2009 -.Dt RESOLVCONF 8 SMM +.Dd April 27, 2014 +.Dt RESOLVCONF 8 .Os .Sh NAME .Nm resolvconf @@ -34,11 +34,14 @@ .Nm .Op Fl m Ar metric .Op Fl p -.Fl a Ar interface No < Ns Pa file +.Op Fl x +.Fl a Ar interface Ns Op Ar .protocol +.No < Ns Pa file .Nm .Op Fl f -.Fl d Ar interface +.Fl d Ar interface Ns Op Ar .protocol .Nm +.Op Fl x .Fl il Ar pattern .Nm .Fl u @@ -63,7 +66,7 @@ file to via .Xr stdin 3 with the argument -.Fl a Ar interface +.Fl a Ar interface Ns Op Ar .protocol instead of the filesystem. .Nm then updates @@ -78,6 +81,20 @@ then will supply files that the resolver should be configured to include. .Pp .Nm +assumes it has a job to do. +In some situations +.Nm +needs to act as a deterrent to writing to +.Pa /etc/resolv.conf . +Where this file cannot be made immutable or you just need to toggle this +behaviour, +.Nm +can be disabled by adding +.Sy resolvconf Ns = Ns NO +to +.Xr resolvconf.conf 5 . +.Pp +.Nm can mark an interfaces .Pa resolv.conf as private. @@ -91,13 +108,21 @@ for how to configure .Nm to use a local name server. .Pp +.Nm +can mark an interfaces +.Pa resolv.conf +as exclusive. +Only the latest exclusive interface is used for processing, otherwise all are. +.Pp When an interface goes down, it should then call .Nm with -.Fl d Ar interface +.Fl d Ar interface.* arguments to delete the .Pa resolv.conf -file for the +file(s) for all the +.Ar protocols +on the .Ar interface . .Pp Here are some more options that @@ -119,7 +144,7 @@ is used to add interfaces. Ignore non existant interfaces. Only really useful for deleting interfaces. .It Fl i Ar pattern -List the interfaces, optionally matching +List the interfaces and protocols, optionally matching .Ar pattern , we have .Pa resolv.conf @@ -130,7 +155,8 @@ List the files we have. If .Ar pattern -is specified then we list the files for the interfaces that match it. +is specified then we list the files for the interfaces and protocols +that match it. .It Fl m Ar metric Set the metric of the interface when adding it, default of 0. Lower metrics take precedence. @@ -142,18 +168,28 @@ as private. .It Fl u Force .Nm -to update all it's subscribers. +to update all its subscribers. .Nm does not update the subscribers when adding a resolv.conf that matches what it already has for that interface. +.It Fl x +Mark the interface +.Pa resolv.conf +as exclusive when adding, otherwise only use the latest exclusive interface. .El .Pp .Nm -also has some options designed to be used by it's subscribers:- +also has some options designed to be used by its subscribers:- .Bl -tag -width indent .It Fl v Echo variables DOMAINS, SEARCH and NAMESERVERS so that the subscriber can configure the resolver easily. +.It Fl V +Same as +.Fl v +except that only the information configured in +.Xr resolvconf.conf 5 +is set. .El .Sh INTERFACE ORDERING For @@ -170,6 +206,29 @@ the operating systems lexical order. See .Xr resolvconf.conf 5 for details on these lists. +.Sh PROTOCOLS +Here are some suggested protocol tags to use for each +.Pa resolv.conf +file registered on an +.Ar interface Ns No :- +.Bl -tag -width indent +.It dhcp +Dynamic Host Configuration Protocol. +Initial versions of +.Nm +did not recommend a +.Ar protocol +tag be appended to the +.Ar interface +name. +When the protocol is absent, it is assumed to be the DHCP protocol. +.It ppp +Point-to-Point Protocol. +.It ra +IPv6 Router Advertisement. +.It dhcp6 +Dynamic Host Configuration Protocol, version 6. +.El .Sh IMPLEMENTATION NOTES If a subscriber has the executable bit then it is executed otherwise it is assumed to be a shell script and sourced into the current environment in a @@ -197,9 +256,15 @@ for the metric. Marks the interface .Pa resolv.conf as private. +.It Va IF_EXCLUSIVE +Marks the interface +.Pa resolv.conf +as exclusive. .El .Sh FILES .Bl -ohang +.It Pa /etc/resolv.conf.bak +Backup file of the original resolv.conf. .It Pa @SYSCONFDIR@/resolvconf.conf Configuration file for .Nm . @@ -218,7 +283,17 @@ This implementation of .Nm is called openresolv and is fully command line compatible with Debian's resolvconf, as written by Thomas Hood. +.Sh SEE ALSO +.Xr resolv.conf 5 , +.Xr resolvconf.conf 5 , +.Xr resolver 3 , +.Xr stdin 3 +.Sh AUTHORS +.An Roy Marples Aq Mt roy@marples.name .Sh BUGS +Please report them to +.Lk http://roy.marples.name/projects/openresolv +.Pp .Nm does not validate any of the files given to it. .Pp @@ -229,12 +304,3 @@ will generate. You should consult .Xr resolvconf.conf 5 for instructions on how to configure your resolver. -.Sh SEE ALSO -.Xr resolv.conf 5 , -.Xr resolvconf.conf 5 , -.Xr resolver 3 , -.Xr stdin 3 -.Sh AUTHORS -.An Roy Marples Aq roy@marples.name -.Sh BUGS -Please report them to http://roy.marples.name/projects/openresolv |