summaryrefslogtreecommitdiff
path: root/sbin/dhclient/dhclient.conf.5
diff options
context:
space:
mode:
authorJason McIntyre <jmc@cvs.openbsd.org>2013-02-09 16:44:38 +0000
committerJason McIntyre <jmc@cvs.openbsd.org>2013-02-09 16:44:38 +0000
commit606a9a16c1b9ce46ffe59f22d265e0db581a3252 (patch)
tree3f708f8a65f18fc5f4e4e4e15a62f142bd96d87c /sbin/dhclient/dhclient.conf.5
parentaae24e9d37e4c8d2a60205a28e37c85e01dc7e1f (diff)
get the format of the various options in this file right and, along
the way, cut back on some of the crazy macros that were mostly around to appease groff; whilst there, fix the warnings reported by Jan Stary back in january; lots of help and ok krw
Diffstat (limited to 'sbin/dhclient/dhclient.conf.5')
-rw-r--r--sbin/dhclient/dhclient.conf.595
1 files changed, 33 insertions, 62 deletions
diff --git a/sbin/dhclient/dhclient.conf.5 b/sbin/dhclient/dhclient.conf.5
index 39ec2f0b327..f7c543e2b7b 100644
--- a/sbin/dhclient/dhclient.conf.5
+++ b/sbin/dhclient/dhclient.conf.5
@@ -1,4 +1,4 @@
-.\" $OpenBSD: dhclient.conf.5,v 1.26 2012/11/27 15:51:48 krw Exp $
+.\" $OpenBSD: dhclient.conf.5,v 1.27 2013/02/09 16:44:37 jmc Exp $
.\"
.\" Copyright (c) 1997 The Internet Software Consortium.
.\" All rights reserved.
@@ -36,7 +36,7 @@
.\" see ``http://www.isc.org/isc''. To learn more about Vixie
.\" Enterprises, see ``http://www.vix.com''.
.\"
-.Dd $Mdocdate: November 27 2012 $
+.Dd $Mdocdate: February 9 2013 $
.Dt DHCLIENT.CONF 5
.Os
.Sh NAME
@@ -178,61 +178,47 @@ 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 ignore Op Ar option
-.Oo , Ar ... option Oc ;
-.Xc
+.It Ic ignore Op Ar option , ... ;
The
.Ic ignore
statement causes the client to discard values provided by the server for
the specified options.
-Only the option names should be specified in the ignore statement \- not
-option parameters.
+Only option names should be specified in the ignore statement \- not
+option values.
Only the last
.Ic ignore
statement has any effect, overriding any previous
.Ic ignore
statement.
-.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.
+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 Xo
-.Ic require Op Ar option
-.Oo , Ar ... option Oc ;
-.Xc
+.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.
-Only the option names should be specified in the require statement \- not
-option parameters.
+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 Xo
-.Ic send No { Op Ar option declaration
-.Oo , Ar ... option declaration Oc }
-.Xc
+.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
@@ -244,28 +230,19 @@ Options in the lease can be modified before being accepted.
.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
+.It Ic default Ar option option-value ;
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
+.It Ic supersede Ar option option-value ;
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
+.It Ic prepend Ar option option-value ;
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
@@ -276,10 +253,7 @@ The
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
+.It Ic append Ar option option-value ;
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
@@ -295,10 +269,7 @@ the behaviour will be unpredictable.
.Sh LEASE DECLARATIONS
The lease declaration:
.Pp
-.Xo
-.Ic \ \& lease No { Ar lease-declaration
-.Oo Ar ... lease-declaration Oc }
-.Xc
+.D1 Ic lease No { Ar lease-declaration ; ... ; No }
.Pp
The DHCP client may decide after some period of time (see
.Sx PROTOCOL TIMING )
@@ -327,7 +298,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
@@ -335,7 +307,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.
@@ -345,23 +318,27 @@ 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, but is included for completeness.
-.It Ic server-name Ar \&"string\&" ;
+.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 not used by the standard client, but is included for completeness.
-.It Ic option Ar option-declaration ;
+.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,
@@ -369,6 +346,7 @@ or, in the case of predefined leases declared in
.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 ;
@@ -395,11 +373,7 @@ DHCP client.
.Pp
Dates are specified as follows:
.Pp
-.Ar \ \&<weekday>
-.Sm off
-.Ar <year> No / Ar <month> No / Ar <day>
-.Ar <hour> : <minute> : <second>
-.Sm on
+.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
@@ -422,10 +396,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