dhclient-script(8) - Align man page with current reality.
authorAntonio Huete Jimenez <tuxillo@quantumachine.net>
Fri, 3 Aug 2012 22:46:34 +0000 (00:46 +0200)
committerAntonio Huete Jimenez <tuxillo@quantumachine.net>
Wed, 15 Aug 2012 01:22:16 +0000 (03:22 +0200)
Taken-from: OpenBSD

sbin/dhclient/dhclient-script.8

index 392d6c7..8932ead 100644 (file)
@@ -1,5 +1,4 @@
-.\"    $OpenBSD: dhclient-script.8,v 1.5 2007/05/31 19:19:43 jmc Exp $
-.\"    $DragonFly: src/sbin/dhclient/dhclient-script.8,v 1.3 2008/09/01 10:48:29 swildner Exp $
+.\" $OpenBSD: src/sbin/dhclient/dhclient-script.8,v 1.6 2011/04/04 11:43:20 krw Exp $
 .\"
 .\" Copyright (c) 1997 The Internet Software Consortium.
 .\" All rights reserved.
@@ -37,7 +36,7 @@
 .\" see ``http://www.isc.org/isc''.  To learn more about Vixie
 .\" Enterprises, see ``http://www.vix.com''.
 .\"
-.Dd August 30, 2008
+.Dd August 4, 2012
 .Dt DHCLIENT-SCRIPT 8
 .Os
 .Sh NAME
 The DHCP client network configuration script is invoked from time to
 time by
 .Xr dhclient 8 .
-This script is used by the DHCP client to set each interface's initial
-configuration prior to requesting an address, to test the address once it
-has been offered, and to set the interface's final configuration once a
-lease has been acquired.
-If no lease is acquired, the script is used to test predefined leases, if
-any, and also called once if no valid lease can be identified.
 .Pp
 .\" No standard client script exists for some operating systems, even though
 .\" the actual client may work, so a pioneering user may well need to create
@@ -71,60 +64,14 @@ In all cases,
 .Va $reason
 is set to the name of the reason why the script has been invoked.
 The following reasons are currently defined:
-MEDIUM, PREINIT, ARPCHECK, ARPSEND, BOUND, RENEW, REBIND, REBOOT,
-EXPIRE, FAIL and TIMEOUT.
+BOUND, RENEW, REBIND, REBOOT, EXPIRE, FAIL and TIMEOUT.
 .Bl -tag -width "ARPCHECK"
-.It MEDIUM
-The DHCP client is requesting that an interface's media type be set.
-The interface name is passed in
-.Va $interface ,
-and the media type is passed in
-.Va $medium .
-.It PREINIT
-The DHCP client is requesting that an interface be configured as
-required in order to send packets prior to receiving an actual address.
-.\" For clients which use the BSD socket library,
-This means configuring the interface with an IP address of 0.0.0.0
-and a broadcast address of 255.255.255.255.
-.\" For other clients, it may be possible to simply configure the interface up
-.\" without actually giving it an IP address at all.
-The interface name is passed in
-.Va $interface ,
-and the media type in
-.Va $medium .
-.Pp
-If an IP alias has been declared in
-.Xr dhclient.conf 5 ,
-its address will be passed in
-.Va $alias_ip_address ,
-and that IP alias should be deleted from the interface,
-along with any routes to it.
-.It ARPSEND
-The DHCP client is requesting that an address that has been offered to
-it be checked to see if somebody else is using it, by sending an ARP
-request for that address.
-It's not clear how to implement this, so no examples exist yet.
-The IP address to check is passed in
-.Va $new_ip_address ,
-and the interface name is passed in
-.Va $interface .
-.It ARPCHECK
-The DHCP client wants to know if a response to the ARP request sent
-using ARPSEND has been received.
-If one has, the script should exit with a nonzero status, indicating that
-the offered address has already been requested and should be declined.
-.Va $new_ip_address
-and
-.Va $interface
-are set as with ARPSEND.
 .It BOUND
 The DHCP client has done an initial binding to a new address.
 The new IP address is passed in
 .Va $new_ip_address ,
 and the interface name is passed in
 .Va $interface .
-The media type is passed in
-.Va $medium .
 Any options acquired from the server are passed using the option name
 described in
 .Xr dhcp-options 5 ,
@@ -166,16 +113,6 @@ by
 .\".Xr resolv.conf.tail 5
 .\"for further information.
 .Pp
-If an IP alias has been declared, it must be set up here.
-The alias IP address will be written as
-.Va $alias_ip_address ,
-and other DHCP options that are set for the alias (e.g., subnet mask)
-will be passed in variables named as described previously except starting with
-$alias_ instead of $new_.
-Care should be taken that the alias IP address not be used if it is identical
-to the bound IP address
-.Pq Va $new_ip_address ,
-since the other alias parameters may be incorrect in this case.
 .It RENEW
 When a binding has been renewed, the script is called as in BOUND,
 except that in addition to all the variables starting with $new_,