All rights reserved
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.Dd August 24, 2010 .Dt DHCPCD-RUN-HOOKS 8 SMM .Os .Sh NAME .Nm dhcpcd-run-hooks .Nd DHCP client configuration script .Sh DESCRIPTION .Nm is used by .Xr dhcpcd 8 to run any system and user defined hook scripts. System hook scripts are found in
a /libexec/dhcpcd-hooks and the user defined hooks are
a /etc/dhcpcd.enter-hook . and
a /etc/dhcpcd.exit-hook . The default install supplies hook scripts for configuring
a /etc/resolv.conf and the hostname. Your distribution may have included other hook scripts to say configure ntp or ypbind. A test hook is also supplied that simply echos the dhcp variables to the console from DISCOVER message.
p Each time .Nm is invoked, .Ev $interface is set to the interface that .Nm dhcpcd is run on and .Ev $reason is to the reason why .Nm was invoked. DHCP information to be configured is held in variables starting with the word new_ and old DHCP information to be removed is held in variables starting with the word old_. .Nm dhcpcd can display the full list of variables it knows how about by using the .Fl V , -variables argument.
p Here's a list of reasons why .Nm could be invoked: l -tag -width PREINIT t Dv PREINIT dhcpcd is starting up and any pre-initialisation should be done. t Dv CARRIER dhcpcd has detected the carrier is up. This is generally just a notification and no action need be taken. t Dv INFORM dhcpcd informed a DHCP server about it's address and obtained other configuration details. t Dv BOUND dhcpcd obtained a new lease from a DHCP server. t Dv RENEW dhcpcd renewed it's lease. t Dv REBIND dhcpcd has rebound to a new DHCP server. t Dv REBOOT dhcpcd successfully requested a lease from a DHCP server. t Dv IPV4LL dhcpcd failed to contact any DHCP servers but did obtain an IPV4LL address. t Dv STATIC dhcpcd has been configured with a static configuration which has not been obtained from a DHCP server. t Dv 3RDPARTY dhcpcd is monitoring the interface for a 3rd party to give it an IP address. t Dv TIMEOUT dhcpcd failed to contact any DHCP servers but was able to use an old lease. t Dv EXPIRE dhcpcd's lease or state expired and it failed to obtain a new one. t Dv RELEASE dhcpcd's lease was released back to the DHCP server for re-use. t Dv NAK dhcpcd received a NAK from the DHCP server. This should be treated as EXPIRE. t Dv NOCARRIER dhcpcd lost the carrier. The cable may have been unplugged or association to the wireless point lost. t 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. t Dv STOP dhcpcd stopped running on the interface. t Dv DUMP dhcpcd has been asked to dump the last lease for the interface. t Dv TEST 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. .El .Sh FILES When .Nm runs, it loads
a /etc/dhcpcd.enter-hook and any scripts found in
a /libexec/dhcpcd-hooks in a lexical order and then finally
a /etc/dhcpcd.exit-hook .Sh SEE ALSO .Xr dhcpcd 8 .Sh AUTHORS .An Roy Marples Aq roy@marples.name .Sh BUGS Please report them to http://roy.marples.name/projects/dhcpcd