dhclient: partial sync from OpenBSD man pages
authorFranco Fichtner <franco@lastsummer.de>
Tue, 23 Jul 2013 12:18:15 +0000 (14:18 +0200)
committerSascha Wildner <saw@online.de>
Tue, 23 Jul 2013 15:58:47 +0000 (17:58 +0200)
sbin/dhclient/dhclient.8
sbin/dhclient/dhclient.conf.5
sbin/dhclient/dhclient.leases.5

index 528a242..d32c380 100644 (file)
 .\" Enterprises.  To learn more about the Internet Software Consortium,
 .\" see ``http://www.isc.org/isc''.  To learn more about Vixie
 .\" Enterprises, see ``http://www.vix.com''.
-.Dd September 3, 2008
+.Dd July 23, 2013
 .Dt DHCLIENT 8
 .Os
 .Sh NAME
 .Nm dhclient
-.Nd Dynamic Host Configuration Protocol (DHCP) Client
+.Nd Dynamic Host Configuration Protocol (DHCP) client
 .Sh SYNOPSIS
 .Nm
 .Op Fl dqu
 .Op Fl l Ar file
 .Ar interface
 .Sh DESCRIPTION
-The
-.Nm
-utility provides a means for configuring network interfaces using DHCP, BOOTP,
-or if these protocols fail, by statically assigning an address.
+The Dynamic Host Configuration Protocol (DHCP) allows hosts on a TCP/IP network
+to configure one or more network interfaces based on information collected from
+a DHCP server.
+DHCP is often used, for example, by cable modem and DSL network
+providers to automate network configuration for their customers.
+.Pp
+Information typically provided via DHCP includes
+address and subnet mask for the interface,
+default route,
+and domain name server.
 .Pp
-The name of the network interface that
+To have
+.Dx
+configure an interface using DHCP
+(or its predecessor, BOOTP)
+the
 .Nm
-should attempt to
-configure must be specified on the command line.
+utility is used.
+.Nm
+is run on the command line with the name of the
+.Ar interface
+to be configured.
 .Pp
 The options are as follows:
 .Bl -tag -width "-p port"
 .It Fl c Ar file
-Specify an alternate location,
-.Ar file ,
+Specify an alternate location to
+.Pa /etc/dhclient.conf
 for the configuration file.
 .It Fl d
 Forces
@@ -73,8 +86,8 @@ By default,
 runs in the foreground until it has configured the interface, and then
 will revert to running in the background.
 .It Fl l Ar file
-Specify an alternate location,
-.Ar file ,
+Specify an alternate location to
+.Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME
 for the leases file.
 .It Fl q
 Forces
@@ -102,17 +115,17 @@ On startup,
 reads
 .Pa /etc/dhclient.conf
 for configuration instructions.
-It then gets a list of all the
-network interfaces that are configured in the current system.
-It then attempts to configure each interface with DHCP.
+It then attempts to configure the network interface
+.Ar interface
+with DHCP.
 .Pp
 In order to keep track of leases across system reboots and server
 restarts,
 .Nm
 keeps a list of leases it has been assigned in the
-.Pa /var/db/dhclient.leases.IFNAME
+.Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME
 file.
-.Qq IFNAME
+.Ar IFNAME
 represents the network interface of the DHCP client
 .Pq e.g. em0 ,
 one for each interface.
@@ -128,7 +141,7 @@ Old leases are kept around in case the DHCP server is unavailable when
 is first invoked (generally during the initial system boot
 process).
 In that event, old leases from the
-.Pa dhclient.leases.IFNAME
+.Pa dhclient.leases. Ns Aq Ar IFNAME
 file which have not yet expired are tested, and if they are determined to
 be valid, they are used until either they expire or the DHCP server
 becomes available.
@@ -156,10 +169,10 @@ See
 .Xr bpf 4
 for more information.
 .Sh FILES
-.Bl -tag -width /var/db/dhclient.leases.IFNAME~ -compact
+.Bl -tag -width "/var/db/dhclient.leases.<IFNAME>XXX" -compact
 .It Pa /etc/dhclient.conf
 DHCP client configuration file
-.It Pa /var/db/dhclient.leases.IFNAME
+.It Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME
 database of acquired leases
 .El
 .Sh SEE ALSO
@@ -170,6 +183,49 @@ database of acquired leases
 .Xr dhcp 8 ,
 .Xr dhcpd 8 Pq Pa net/isc-dhcp42-server ,
 .Xr dhcrelay 8 Pq Pa net/isc-dhcp42-relay
+.Sh STANDARDS
+.Rs
+.%A R. Droms
+.%D October 1993
+.%R RFC 1534
+.%T Interoperation Between DHCP and BOOTP
+.Re
+.Pp
+.Rs
+.%A R. Droms
+.%D March 1997
+.%R RFC 2131
+.%T Dynamic Host Configuration Protocol
+.Re
+.Pp
+.Rs
+.%A S. Alexander
+.%A R. Droms
+.%D March 1997
+.%R RFC 2132
+.%T DHCP Options and BOOTP Vendor Extensions
+.Re
+.Pp
+.Rs
+.%A T. Lemon
+.%A S. Cheshire
+.%D November 2002
+.%R RFC 3396
+.%T Encoding Long Options in the Dynamic Host Configuration Protocol (DHCPv4)
+.Re
+.Pp
+.Rs
+.%A T. Lemon
+.%A S. Cheshire
+.%A B. Volz
+.%D December 2002
+.%R RFC 3442
+.%T The Classless Static Route Option for Dynamic Host Configuration Protocol (DHCP) version 4
+.Re
+.Sh HISTORY
+.Nm
+was imported into
+.Dx 2.1 .
 .Sh AUTHORS
 .An -nosplit
 .Nm
@@ -179,6 +235,4 @@ and
 .An Elliot Poger Aq Mt elliot@poger.com .
 .Pp
 The current implementation was reworked by
-.An Henning Brauer Aq Mt henning@openbsd.org
-and was imported into
-.Dx 2.1 .
+.An Henning Brauer Aq Mt henning@openbsd.org .
index b64a93e..86e590f 100644 (file)
@@ -36,7 +36,7 @@
 .\" see ``http://www.isc.org/isc''.  To learn more about Vixie
 .\" Enterprises, see ``http://www.vix.com''.
 .\"
-.Dd August 4, 2012
+.Dd July 23, 2013
 .Dt DHCLIENT.CONF 5
 .Os
 .Sh NAME
@@ -46,8 +46,7 @@
 The
 .Nm
 file contains configuration information for
-.Xr dhclient 8 ,
-the Internet Software Consortium DHCP Client.
+.Xr dhclient 8 .
 .Pp
 The
 .Nm
@@ -178,34 +177,35 @@ The data that can be specifically requested is what are called
 DHCP Options are defined in
 .Xr dhcp-options 5 .
 .Bl -tag -width Ds
-.It Xo
-.Ic request Op Ar option
-.Oo , Ar ... option Oc ;
-.Xc
+.It Ic request Op Ar option , ... ;
 The
 .Ic request
 statement causes the client to request that any server responding to the
 client send the client its values for the specified options.
-Only the option names should be specified in the request statement \- not
-option parameters.
-.It Xo
-.Ic require Op Ar option
-.Oo , Ar ... option Oc ;
-.Xc
+Only option names should be specified in the request statement \- not
+option values.
+Only the last
+.Ic request
+statement has any effect, overriding any previous
+.Ic request
+statement.
+.It Ic require Op Ar option , ... ;
 The
 .Ic require
 statement lists options that must be sent in order for an offer to be accepted.
 Offers that do not contain all the listed options will be ignored.
-.It Xo
-.Ic send No { Op Ar option declaration
-.Oo , Ar ... option declaration Oc }
-.Xc
+Only option names should be specified in the require statement \- not
+option values.
+Only the last
+.Ic require
+statement has any effect, overriding any previous
+.Ic require
+statement.
+.It Ic send Ar option option-value ;
 The
 .Ic send
-statement causes the client to send the specified options to the server with
-the specified values.
-These are full option declarations as described in
-.Xr dhcp-options 5 .
+statement causes the client to send the specified option and value
+to the server.
 Options that are always sent in the DHCP protocol should not be specified
 here.
 One use for this statement is to send information to the server
@@ -226,58 +226,41 @@ the client configuration script is modified.
 .Pp
 Several option modifiers are available.
 .Bl -tag -width Ds
-.It Xo
-.Ic default No { Op Ar option declaration
-.Oo , Ar ... option declaration Oc }
-.Xc
-If for some set of options the client should use the value supplied by
-the server, but needs to use some default value if no value was supplied
-by the server, these values can be defined in the
-.Ic default
-statement.
-.It Xo
-.Ic supersede No { Op Ar option declaration
-.Oo , Ar ... option declaration Oc }
-.Xc
-If for some set of options the client should always use its own value
-rather than any value supplied by the server, these values can be defined
-in the
-.Ic supersede
-statement.
-.It Xo
-.Ic prepend No { Op Ar option declaration
-.Oo , Ar ... option declaration Oc }
-.Xc
-If for some set of options the client should use a value you supply,
-and then use the values supplied by the server, if any,
-these values can be defined in the
+.It Ic default Ar option option-value ;
+Use
+.Ar option-value
+for the given
+.Ar option ,
+if no value is supplied by the server.
+.It Ic supersede Ar option option-value ;
+Use
+.Ar option-value
+for the given
+.Ar option ,
+regardless of the value supplied by the server.
+.It Ic prepend Ar option option-value ;
+Use
+.Ar option-value
+for the given
+.Ar option ,
+and then use the value supplied by the server.
 .Ic prepend
-statement.
-The
-.Ic prepend
-statement can only be used for options which allow more than one value to
-be given.
-This restriction is not enforced \- if violated, the results are unpredictable.
-.It Xo
-.Ic append No { Op Ar option declaration
-.Oo , Ar ... option declaration Oc }
-.Xc
-If for some set of options the client should first use the values
-supplied by the server, if any, and then use values you supply, these
-values can be defined in the
+can only be used for options which allow more than one value to be given.
+The restriction is not enforced \- if violated, the results are unpredictable.
+.It Ic append Ar option option-value ;
+Use
+.Ar option-value
+for the given
+.Ar option ,
+after first using the value supplied by the server.
 .Ic append
-statement.
-The
-.Ic append
-statement can only be used for options which allow more than one value to
-be given.
-This restriction is not enforced \- if you ignore it,
-the behaviour will be unpredictable.
+can only be used for options which allow more than one value to be given.
+The restriction is not enforced \- if violated, the results are unpredictable.
 .El
 .Sh LEASE DECLARATIONS
 The lease declaration:
 .Pp
-.D1 Ic lease No { Ar lease-declaration Oo Ar ... lease-declaration Oc }
+.D1 Ic lease No { Ar lease-declaration ; ... ; No }
 .Pp
 The DHCP client may decide after some period of time (see
 .Sx PROTOCOL TIMING )
@@ -295,10 +278,10 @@ This is done with the
 statement.
 .Pp
 NOTE: the lease statement is also used in the
-.Pa dhclient.leases
+.Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME
 file in order to record leases that have been received from DHCP servers.
 Some of the syntax for leases as described below is only needed in the
-.Pa dhclient.leases
+.Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME
 file.
 Such syntax is documented here for completeness.
 .Pp
@@ -306,7 +289,8 @@ A lease statement consists of the lease keyword, followed by a left
 curly brace, followed by one or more lease declaration statements,
 followed by a right curly brace.
 The following lease declarations are possible:
-.Bl -tag -width Ds
+.Pp
+.Bl -tag -width Ds -compact
 .It Ic bootp ;
 The
 .Ic bootp
@@ -314,7 +298,8 @@ statement is used to indicate that the lease was acquired using the
 BOOTP protocol rather than the DHCP protocol.
 It is never necessary to specify this in the client configuration file.
 The client uses this syntax in its lease database file.
-.It Ic interface Ar \&"string\&" ;
+.Pp
+.It Ic interface Qq Ar string ;
 The
 .Ic interface
 lease statement is used to indicate the interface on which the lease is valid.
@@ -324,31 +309,35 @@ interface number on which it received that lease.
 If predefined leases are specified in the
 .Nm
 file, the interface should also be specified, although this is not required.
+.Pp
 .It Ic fixed-address Ar ip-address ;
 The
 .Ic fixed-address
 statement is used to set the IP address of a particular lease.
 This is required for all lease statements.
 The IP address must be specified as a dotted quad (e.g., 12.34.56.78).
-.It Ic filename Ar \&"string\&" ;
+.Pp
+.It Ic filename Qq Ar string ;
 The
 .Ic filename
 statement specifies the name of the boot filename to use.
-This is not used by the standard client configuration script, but is
-included for completeness.
-.It Ic server-name Ar \&"string\&" ;
+This is not used by the standard client, but is included for completeness.
+.Pp
+.It Ic server-name Qq Ar string ;
 The
 .Ic server-name
 statement specifies the name of the boot server name to use.
-This is also not used by the standard client configuration script.
-.It Ic option Ar option-declaration ;
+This is not used by the standard client, but is included for completeness.
+.Pp
+.It Ic option Ar option option-value ;
 The
 .Ic option
 statement is used to specify the value of an option supplied by the server,
 or, in the case of predefined leases declared in
-.Nm ,
-the value that the user wishes the client configuration script to use if the
+.Nm dhclient.conf ,
+the value that the user wishes the client to use if the
 predefined lease is used.
+.Pp
 .It Ic renew Ar date ;
 .It Ic rebind Ar date ;
 .It Ic expire Ar date ;
@@ -374,13 +363,8 @@ predefined lease whose expiry time has passed will not be used by the
 DHCP client.
 .Pp
 Dates are specified as follows:
-.Bd -ragged -offset indent
-.Ar <weekday>
-.Sm off
-.Ar <year> No / Ar <month> No / Ar <day>
-.Ar <hour> : <minute> : <second>
-.Sm on
-.Ed
+.Pp
+.D1 <weekday> <year>/<month>/<day> <hour>:<minute>:<second>
 .Pp
 The weekday is present to make it easy for a human to tell when a
 lease expires \- it's specified as a number from zero to six, with zero
@@ -403,10 +387,7 @@ the specified address as a server identifier.
 This can be used to avoid being configured by rogue or misconfigured DHCP
 servers, although it should be a last resort \- better to track down
 the bad DHCP server and fix it.
-.It Xo
-.Ic interface Ar \&"name\&" No { Ar declarations
-.Ar ... No }
-.Xc
+.It Ic interface Qo Ar name Qc No { Ar declaration ; ... ; No }
 A client with more than one network interface may require different
 behaviour depending on which interface is being configured.
 All timing parameters and declarations other than lease
@@ -466,13 +447,26 @@ In many cases, it's sufficient to just create an empty
 file \- the defaults are usually fine.
 .Sh SEE ALSO
 .Xr dhclient.leases 5 ,
-.Xr dhclient-script 8 ,
 .Xr dhcp-options 5 ,
 .Xr dhcpd.conf 5 Pq Pa net/isc-dhcp42-server ,
 .Xr dhclient 8 ,
+.Xr dhclient-script 8 ,
 .Xr dhcpd 8 Pq Pa net/isc-dhcp42-server
+.Sh STANDARDS
+.Rs
+.%A R. Droms
+.%D March 1997
+.%R RFC 2131
+.%T Dynamic Host Configuration Protocol
+.Re
 .Pp
-RFC 2132, RFC 2131.
+.Rs
+.%A S. Alexander
+.%A R. Droms
+.%D March 1997
+.%R RFC 2132
+.%T DHCP Options and BOOTP Vendor Extensions
+.Re
 .Sh AUTHORS
 .An -nosplit
 .Xr dhclient 8
index c91aae6..3b4bba5 100644 (file)
@@ -1,5 +1,4 @@
 .\"    $OpenBSD: dhclient.leases.5,v 1.6 2007/05/31 19:19:43 jmc Exp $
-.\"    $DragonFly: src/sbin/dhclient/dhclient.leases.5,v 1.2 2008/09/01 10:48:29 swildner Exp $
 .\"
 .\" Copyright (c) 1997 The Internet Software Consortium.
 .\" All rights reserved.
 .\" see ``http://www.isc.org/isc''.  To learn more about Vixie
 .\" Enterprises, see ``http://www.vix.com''.
 .\"
-.Dd August 30, 2008
+.Dd July 23, 2013
 .Dt DHCLIENT.LEASES 5
 .Os
 .Sh NAME
 .Nm dhclient.leases
 .Nd DHCP client lease database
 .Sh DESCRIPTION
-The Internet Software Consortium DHCP client keeps a persistent
-database of leases that it has acquired that are still valid.
+.Xr dhclient 8
+keeps a persistent database of leases that it has acquired that are still
+valid.
 The database is a free-form ASCII file containing one valid declaration
 per lease.
-If more than one declaration appears for a given lease,
-the last one in the file is used.
-The file is written as a log, so this is not an unusual occurrence.
+The file is written as a log, so the last declaration is the most recent
+lease obtained.
 .Pp
 The lease file is named
-.Qq dhclient.leases.IFNAME ,
+.Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME ,
 where
 .Qq IFNAME
-represents the network interface the DHCP client acquired the lease on.
+represents the network interface
+.Xr dhclient 8
+acquired the lease on.
 For example, if
 .Xr dhclient 8
 is configured for the em0 network device,
 the lease file will be named
-.Qq dhclient.leases.em0 .
+.Pa /var/db/dhclient.leases.em0 ,
 .Pp
 The format of the lease declarations is described in
 .Xr dhclient.conf 5 .
 .Sh FILES
 .Bl -tag -width "/var/db/dhclient.leases.IFNAME   "
-.It /var/db/dhclient.leases.IFNAME
+.It Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME ,
 Current lease file.
 .El
 .Sh SEE ALSO
@@ -76,8 +77,21 @@ Current lease file.
 .Xr dhcpd.conf 5 ,
 .Xr dhclient 8 ,
 .Xr dhcpd 8
+.Sh STANDARDS
+.Rs
+.%A R. Droms
+.%D March 1997
+.%R RFC 2131
+.%T Dynamic Host Configuration Protocol
+.Re
 .Pp
-RFC 2132, RFC 2131.
+.Rs
+.%A S. Alexander
+.%A R. Droms
+.%D March 1997
+.%R RFC 2132
+.%T DHCP Options and BOOTP Vendor Extensions
+.Re
 .Sh AUTHORS
 .An -nosplit
 .Xr dhclient 8