From 681c71eccec20e3977bd29e376fb325d843cb56e Mon Sep 17 00:00:00 2001
From: Roy Marples <roy@marples.name>
Date: Tue, 9 Sep 2014 12:59:08 +0000
Subject: [PATCH] Document every variable set for dhcpcd-run-hooks(8)

---
 dhcpcd-run-hooks.8.in | 95 ++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 84 insertions(+), 11 deletions(-)

diff --git a/dhcpcd-run-hooks.8.in b/dhcpcd-run-hooks.8.in
index b078f07a..d280d562 100644
--- a/dhcpcd-run-hooks.8.in
+++ b/dhcpcd-run-hooks.8.in
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd June 6, 2013
+.Dd September 9, 2014
 .Dt DHCPCD-RUN-HOOKS 8
 .Os
 .Sh NAME
@@ -69,12 +69,15 @@ argument.
 Here's a list of reasons why
 .Nm
 could be invoked:
-.Bl -tag -width ROUTERADVERT
+.Bl -tag -width EXPIREXXXEXPIRE6
 .It Dv PREINIT
 dhcpcd is starting up and any pre-initialisation should be done.
 .It Dv CARRIER
 dhcpcd has detected the carrier is up.
 This is generally just a notification and no action need be taken.
+.It Dv NOCARRIER
+dhcpcd lost the carrier.
+The cable may have been unplugged or association to the wireless point lost.
 .It Dv INFORM | Dv INFORM6
 dhcpcd informed a DHCP server about it's address and obtained other
 configuration details.
@@ -102,18 +105,19 @@ dhcpcd received a NAK from the DHCP server.
 This should be treated as EXPIRE.
 .It Dv RECONFIGURE
 dhcpcd has been instructed to reconfigure an interface.
-.It Dv NOCARRIER
-dhcpcd lost the carrier.
-The cable may have been unplugged or association to the wireless point lost.
+.It Dv ROUTERADVERT
+dhcpcd has received an IPv6 Router Advertisment, or one has expired.
+.It Dv STOP | Dv STOP6
+dhcpcd stopped running on the interface.
+.It Dv STOPPED
+dhcpcd has stopped entirely.
+.It Dv DEPARTED
+The interface has been removed.
 .It Dv FAIL
 dhcpcd failed to operate on the interface.
 This normally happens when dhcpcd does not support the raw interface, which
 means it cannot work as a DHCP or ZeroConf client.
 Static configuration and DHCP INFORM is still allowed.
-.It Dv STOP | Dv STOP6
-dhcpcd stopped running on the interface.
-.It Dv DEPARTED
-The interface has been removed.
 .It Dv DUMP
 dhcpcd has been asked to dump the last lease for the interface.
 .It Dv TEST
@@ -121,8 +125,77 @@ dhcpcd received an OFFER from a DHCP server but will not configure the
 interface.
 This is primarily used to test the variables are filled correctly for the
 script to process them.
-.It Dv ROUTERADVERT
-dhcpcd has received an IPv6 Router Advertisment, or one has expired.
+.El
+.Sh ENVIRONMENT
+.Nm dhcpcd
+will clear the environment variables aside from
+.Ev $PATH
+and
+.Ev $SVCNAME .
+The following variables will then be set, along with any protocol supplied
+ones.
+.Bl -tag -width Xinterface_order
+.It Ev $interface
+the name of the interface.
+.It Ev $reason
+as described above.
+.It Ev $pid
+the pid of
+.Nm dhcpcd .
+.It Ev $ifcarrier
+the link status of
+.Ev $interface :
+.Dv unknown ,
+.Dv up
+or
+.Dv down .
+.It Ev $ifmetric
+.Ev $interface
+preference, lower is better.
+.It Ev $ifwireless
+.Dv 1 if
+.Ev $interface
+is wireless, otherwise
+.Dv 0 .
+.It Ev $ifflags
+.Ev $interface
+flags.
+.It Ev $ifmtu
+.Ev $interface
+MTU.
+.It Ev $interface_order
+A list of interfaces, in order of preference.
+.It Ev $if_up
+.Dv true
+if the
+.Ev interface
+is up, otherwise
+.Dv false .
+.It Ev $if_down
+.Dv true
+if the
+.Ev interface
+is down, otherwise
+.Dv false .
+.It Ev $if_oneup
+.Dv true
+if any interface is up, otherwise false.
+.It Ev $if_ipwaited
+.Dv true
+if any interface has been assigned an IP address which matches any wait
+requirements specified in
+.Xr dhcpcd.conf 5 .
+.It Ev $profile
+the name of the profile selected from
+.Xr dhcpcd.conf 5 .
+.It Ev $new_ssid
+the name of the SSID the
+.Ev interface
+is connected to.
+.It Ev $old_ssid
+the name of the SSID the
+.Ev interface
+was connected to.
 .El
 .Sh FILES
 When
-- 
2.47.3