resolvconf -s now does service commands so subscribers don't need to know about how...

[openresolv] / resolvconf.8

diff --git a/resolvconf.8 b/resolvconf.8
index 58be2fd8e629313362ceb360caaa102f3daebe61..a8fcd4eefa4b1f3959bc7a6c7a8312c25409be61 100644 (file)
--- a/resolvconf.8
+++ b/resolvconf.8
@@ -1,5 +1,3 @@
-.\" $Id$
-.\"

 .TH RESOLVCONF 8 "9 Nov 2007" "openresolv"
 .SH NAME
 resolvconf \- manage nameserver information
 .TH RESOLVCONF 8 "9 Nov 2007" "openresolv"
 .SH NAME
 resolvconf \- manage nameserver information


@@ -21,11 +19,13 @@ cat \fIFILE\fR |
 \fB\-i\fR \fIPATTERN\fR
 .PP
 .B resolvconf
 \fB\-i\fR \fIPATTERN\fR
 .PP
 .B resolvconf

-\fB\-v\fR \fIPATTERN\fr
+\fB\-v\fR \fIPATTERN\fR
+.B resolvconf
+\fB\-s\fR \fISERVICE COMMAND [args]\fR

 .SH DESCRIPTION
 Overwrite (\fB\-a\fR) or delete (\fB\-d\fR) the nameserver information
 record for network interface \fIINTERFACE\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
 .PP
 With \fB\-u\fR, just run the update scripts.
 .PP


@@ -38,6 +38,10 @@ with patterns to match interface names.
 With \fB\-v\fR, we echo variables NEWDOMAIN, NEWSEARCH and NEWNS to the
 console which can be used to make it easer writing scripts which configure
 DNS resolvers.
 With \fB\-v\fR, we echo variables NEWDOMAIN, NEWSEARCH and NEWNS to the
 console which can be used to make it easer writing scripts which configure
 DNS resolvers.

+.PP
+With \fB\-s\fR, we work out if the service is running by finding its pidfile
+and if it is we restart it. This means that only resolvconf needs to know this
+for supported platforms and subscribers can just call this resolvconf function.

 .SH SERVERS
 Normally
 .B resolvconf
 .SH SERVERS
 Normally
 .B resolvconf


@@ -63,8 +67,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
 .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
 For example, DNS caches such as
 .BR dnsmasq (8)
 and


@@ -77,12 +81,12 @@ 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
 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
 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.
 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.


@@ -116,7 +120,7 @@ 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
 .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/.)
 (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/.)


@@ -154,26 +158,26 @@ List the interfaces that match the pattern otherwise all the interfaces.
 Echo variables NEWDOMAIN, NEWSEARCH and NEWNS to the console.
 .SH FILES
 .TP
 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
 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
 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
 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
 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
 File to be appended to the dynamically generated resolver configuration file.
 To append nothing, make this an empty file.
 .SH BUGS