1.\" Copyright 2006-2008 Roy Marples 2.\" All rights reserved 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.Dd August 14, 2008 26.Dt DHCPCD.SH 8 SMM 27.Os 28.Sh NAME 29.Nm dhcpcd-run-hooks 30.Nd DHCP client configuration script 31.Sh DESCRIPTION 32.Nm 33is used by 34.Xr dhcpcd 8 35to run any system and user defined hook scripts. 36System hook scripts are found in 37.Pa @HOOKDIR@ 38and the user defined hooks are 39.Pa @SYSCONFDIR@/dhcpcd.enter-hook . 40and 41.Pa @SYSCONFDIR@/dhcpcd.exit-hook . 42The default install supplies hook scripts for configuring 43.Pa /etc/resolv.conf 44and the hostname. 45Your distribution may have included other hook scripts to say configure 46ntp or ypbind. 47A test hook is also supplied that simply echos the dhcp variables to the 48console from DISCOVER message. 49.Pp 50Each time 51.Nm 52is invoked, 53.Ev $interface 54is set to the interface that 55.Nm dhcpcd 56is run on and 57.Ev $reason 58is to the reason why 59.Nm 60was invoked. 61DHCP information to be configured is held in variables starting with the word 62new_ and old DHCP information to be removed is held in variables starting with 63the word old_. 64.Nm dhcpcd 65can display the full list of variables it knows how about by using the 66.Fl V , -variables 67argument. 68.Pp 69Here's a list of reasons why 70.Nm 71could be invoked: 72.Bl -tag -width indent 73.It Dv PREINIT 74dhcpcd is starting up and any pre-initialisation should be done. 75.It Dv INFORM 76dhcpcd informed a DHCP server about it's address and obtained other 77configuration details. 78.It Dv BOUND 79dhcpcd obtained a new lease from a DHCP server. 80.It Dv RENEW 81dhcpcd renewed it's lease. 82.It Dv REBIND 83dhcpcd has rebound to a new DHCP server. 84.It Dv REBOOT 85dhcpcd successfully requested a lease from a DHCP server. 86.It Dv EXPIRE 87dhcpcd's lease expired and it failed to obtain a new one. 88.It Dv IPV4LL 89dhcpcd failed to contact any DHCP servers but did obtain an IPV4LL address. 90.It Dv FAIL 91dhcpcd failed to contact any DHCP servers or use an old lease. 92.It Dv TIMEOUT 93dhcpcd failed to contact any DHCP servers but was able to use an old lease. 94.It Dv TEST 95dhcpcd received an OFFER from a DHCP server but will not configure the 96interface. 97This is primarily used to test the variables are filled correctly for the 98script to process them. 99.El 100.Sh FILES 101When 102.Nm 103runs, it loads 104.Pa @SYSCONFDIR@/dhcpcd.enter-hook 105and any scripts found in 106.Pa @HOOKDIR@ 107in a lexical order and then finally 108.Pa @SYSCONFDIR@/dhcpcd.exit-hook 109.Sh SEE ALSO 110.Xr dhcpcd 8 111.Sh AUTHORS 112.An Roy Marples <roy@marples.name> 113.Sh BUGS 114Please report them to http://roy.marples.name/projects/dhcpcd 115