From 557bdadf6654a364477fad611a28eac7294974df Mon Sep 17 00:00:00 2001 From: ru Date: Wed, 22 Jun 2005 14:55:59 +0000 Subject: Line up the markup. Approved by: re (blanket) --- sbin/dhclient/dhclient-script.8 | 101 +++++++++++++++++++----------- sbin/dhclient/dhclient.8 | 27 +++++--- sbin/dhclient/dhclient.conf.5 | 133 ++++++++++++++++++++-------------------- sbin/dhclient/dhclient.leases.5 | 26 +++++--- sbin/dhclient/dhcp-options.5 | 50 ++++++++++----- 5 files changed, 200 insertions(+), 137 deletions(-) diff --git a/sbin/dhclient/dhclient-script.8 b/sbin/dhclient/dhclient-script.8 index 57a2abd..b04974b 100644 --- a/sbin/dhclient/dhclient-script.8 +++ b/sbin/dhclient/dhclient-script.8 @@ -36,6 +36,8 @@ .\" see ``http://www.isc.org/isc''. To learn more about Vixie .\" Enterprises, see ``http://www.vix.com''. .\" +.\" $FreeBSD$ +.\" .Dd January 1, 1997 .Dt DHCLIENT-SCRIPT 8 .Os @@ -65,21 +67,23 @@ When .Xr dhclient 8 needs to invoke the client configuration script, it sets up a number of environment variables and runs -.Nm dhclient-script . +.Nm . 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. -.Bl -tag -width "ARPCHECK" -.It MEDIUM +.Li MEDIUM , PREINIT , ARPCHECK , ARPSEND , BOUND , RENEW , REBIND , REBOOT , +.Li EXPIRE , FAIL +and +.Li TIMEOUT . +.Bl -tag -width ".Li ARPCHECK" +.It Li 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 +.It Li 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, @@ -98,25 +102,29 @@ 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 +.It Li 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. +It is 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 +.It Li ARPCHECK The DHCP client wants to know if a response to the ARP request sent -using ARPSEND has been received. +using +.Li 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. +The .Va $new_ip_address and .Va $interface -are set as with ARPSEND. -.It BOUND +variables are set as with +.Li ARPSEND . +.It Li BOUND The DHCP client has done an initial binding to a new address. The new IP address is passed in .Va $new_ip_address , @@ -128,10 +136,11 @@ Any options acquired from the server are passed using the option name described in .Xr dhcp-options 5 , except that dashes -.Pq Sq - +.Pq Ql - are replaced by underscores -.Pq Sq _ -in order to make valid shell variables, and the variable names start with new_. +.Pq Ql _ +in order to make valid shell variables, and the variable names start with +.Dq Li new_ . So for example, the new subnet mask would be passed in .Va $new_subnet_mask . .Pp @@ -154,48 +163,63 @@ 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_. +.Dq Li $alias_ +instead of +.Dq Li $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_, -there is another set of variables starting with $old_. -Persistent settings that may have changed need to be deleted \- for example, +.It Li RENEW +When a binding has been renewed, the script is called as in +.Li BOUND , +except that in addition to all the variables starting with +.Dq Li $new_ , +there is another set of variables starting with +.Dq Li $old_ . +Persistent settings that may have changed need to be deleted - for example, if a local route to the bound address is being configured, the old local route should be deleted. If the default route has changed, the old default route should be deleted. If the static routes have changed, the old ones should be deleted. -Otherwise, processing can be done as with BOUND. -.It REBIND +Otherwise, processing can be done as with +.Li BOUND . +.It Li REBIND The DHCP client has rebound to a new DHCP server. -This can be handled as with RENEW, except that if the IP address has changed, +This can be handled as with +.Li RENEW , +except that if the IP address has changed, the ARP table should be cleared. -.It REBOOT +.It Li REBOOT The DHCP client has successfully reacquired its old address after a reboot. -This can be processed as with BOUND. -.It EXPIRE +This can be processed as with +.Li BOUND . +.It Li EXPIRE The DHCP client has failed to renew its lease or acquire a new one, and the lease has expired. The IP address must be relinquished, and all related parameters should be -deleted, as in RENEW and REBIND. -.It FAIL +deleted, as in +.Li RENEW +and +.Li REBIND . +.It Li FAIL The DHCP client has been unable to contact any DHCP servers, and any leases that have been tested have not proved to be valid. The parameters from the last lease tested should be deconfigured. -This can be handled in the same way as EXPIRE. -.It TIMEOUT +This can be handled in the same way as +.Li EXPIRE . +.It Li TIMEOUT The DHCP client has been unable to contact any DHCP servers. However, an old lease has been identified, and its parameters have -been passed in as with BOUND. +been passed in as with +.Li BOUND . The client configuration script should test these parameters and, if it has reason to believe they are valid, should exit with a value of zero. If not, it should exit with a nonzero value. .El .Pp -The usual way to test a lease is to set up the network as with REBIND +The usual way to test a lease is to set up the network as with +.Li REBIND (since this may be called to test more than one lease) and then ping the first router defined in .Va $routers . @@ -221,6 +245,7 @@ but current scripts do not do this. .Xr dhcpd 8 , .Xr dhcrelay 8 .Sh AUTHORS +.An -nosplit The original version of .Nm was written for the Internet Software Consortium by @@ -234,13 +259,15 @@ implementation of was written by .An Kenneth R. Westerback Aq krw@openbsd.org . .Sh BUGS -If more than one interface is being used, there's no obvious way to -avoid clashes between server-supplied configuration parameters \- for -example, the stock dhclient-script rewrites +If more than one interface is being used, there is no obvious way to +avoid clashes between server-supplied configuration parameters - for +example, the stock +.Nm +rewrites .Pa /etc/resolv.conf . If more than one interface is being configured, .Pa /etc/resolv.conf will be repeatedly initialized to the values provided by one server, and then the other. -Assuming the information provided by both servers is valid, this shouldn't +Assuming the information provided by both servers is valid, this should not cause any real problems, but it could be confusing. diff --git a/sbin/dhclient/dhclient.8 b/sbin/dhclient/dhclient.8 index a12952f..e0797ef 100644 --- a/sbin/dhclient/dhclient.8 +++ b/sbin/dhclient/dhclient.8 @@ -35,12 +35,15 @@ .\" 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''. +.\" +.\" $FreeBSD$ +.\" .Dd April 7, 2004 .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 @@ -59,7 +62,7 @@ should attempt to configure must be specified on the command line. .Pp The options are as follows: -.Bl -tag -width "-p port" +.Bl -tag -width ".Fl c Ar file" .It Fl c Ar file Specify an alternate location, .Ar file , @@ -110,11 +113,12 @@ 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 Ar IFNAME file. -.Qq IFNAME +.Ar IFNAME represents the network interface of the DHCP client -.Pq e.g. em0 , +(e.g., +.Li em0 ) , one for each interface. On startup, after reading the .Xr dhclient.conf 5 @@ -128,7 +132,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 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. @@ -149,18 +153,20 @@ database, so that the host can boot quickly on that network rather than cycling through the list of old leases. .Sh NOTES You must have the Berkeley Packet Filter (BPF) configured in your kernel. +The .Nm +utility requires at least one .Pa /dev/bpf* -file for each broadcast network interface that is attached to your system. +device for each broadcast network interface that is attached to your system. See .Xr bpf 4 for more information. .Sh FILES -.Bl -tag -width /var/db/dhclient.leases.IFNAME~ -compact +.Bl -tag -width ".Pa /var/db/dhclient.leases. Ns Ar IFNAME" -compact .It Pa /etc/dhclient.conf DHCP client configuration file -.It Pa /var/db/dhclient.leases.IFNAME +.It Pa /var/db/dhclient.leases. Ns Ar IFNAME database of acquired leases .El .Sh SEE ALSO @@ -171,7 +177,10 @@ database of acquired leases .Xr dhcpd 8 , .Xr dhcrelay 8 .Sh AUTHORS +.An -nosplit +The .Nm +utility was written by .An Ted Lemon Aq mellon@fugue.com and diff --git a/sbin/dhclient/dhclient.conf.5 b/sbin/dhclient/dhclient.conf.5 index daf6f79..167239e 100644 --- a/sbin/dhclient/dhclient.conf.5 +++ b/sbin/dhclient/dhclient.conf.5 @@ -36,6 +36,8 @@ .\" see ``http://www.isc.org/isc''. To learn more about Vixie .\" Enterprises, see ``http://www.vix.com''. .\" +.\" $FreeBSD$ +.\" .Dd January 1, 1997 .Dt DHCLIENT.CONF 5 .Os @@ -58,7 +60,7 @@ The file may contain extra tabs and newlines for formatting purposes. Keywords in the file are case-insensitive. Comments may be placed anywhere within the file (except within quotes). Comments begin with the -.Sq # +.Ql # character and end at the end of the line. .Pp The @@ -70,23 +72,23 @@ certain information, values with which to override information provided by the server, or values to prepend or append to information provided by the server. The configuration file can also be preinitialized with addresses to -use on networks that don't have DHCP servers. +use on networks that do not have DHCP servers. .Sh PROTOCOL TIMING The timing behaviour of the client need not be configured by the user. If no timing configuration is provided by the user, a fairly -reasonable timing behaviour will be used by default \- one which +reasonable timing behaviour will be used by default - one which results in fairly timely updates without placing an inordinate load on the server. .Pp The following statements can be used to adjust the timing behaviour of the DHCP client if required, however: -.Bl -tag -width Ds +.Bl -tag -width indent .It Ic timeout Ar time ; The .Ic timeout statement determines the amount of time that must pass between the time that the client begins to try to determine its address and the -time that it decides that it's not going to be able to contact a server. +time that it decides that it is not going to be able to contact a server. By default, this timeout is sixty seconds. After the timeout has passed, if there are any static leases defined in the configuration file, or any leases remaining in the lease database that @@ -122,7 +124,7 @@ has expired, the client will accept the first offer that arrives. .Pp By default, the .Ic select-timeout -is zero seconds \- that is, the client will take the first offer it sees. +is zero seconds - that is, the client will take the first offer it sees. .It Ic reboot Ar time ; When the client is restarted, it first tries to reacquire the last address it had. @@ -151,7 +153,9 @@ statement sets the amount of time between the first attempt to reach a server and the second attempt to reach a server. Each time a message is sent, the interval between messages is incremented by twice the current interval multiplied by a random number between zero and one. -If it is greater than the backoff-cutoff amount, it is set to that +If it is greater than the +.Ic backoff-cutoff +amount, it is set to that amount. It defaults to ten seconds. .El @@ -160,7 +164,7 @@ The DHCP protocol allows the client to request that the server send it specific information, and not send it other information that it is not prepared to accept. The protocol also allows the client to reject offers from servers if they -don't contain information the client needs, or if the information provided +do not contain information the client needs, or if the information provided is not satisfactory. .Pp There is a variety of data contained in offers that DHCP servers send @@ -169,29 +173,20 @@ The data that can be specifically requested is what are called .Em DHCP Options . 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 +.Bl -tag -width indent +.It Ic request Oo Ar option Oc Oo , Ar ... option Oc ; 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 +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 +.It Ic require Oo Ar option Oc Oo , Ar ... option Oc ; 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 +.It Ic send No { Oo Ar option declaration Oc Oo , Ar ... option declaration Oc } The .Ic send statement causes the client to send the specified options to the server with @@ -213,7 +208,7 @@ information that it needs, and for which a useful default value exists. It may also receive information which is useful, but which needs to be supplemented with local information. To handle these needs, several option modifiers are available. -.Bl -tag -width Ds +.Bl -tag -width indent .It Xo .Ic default No { Op Ar option declaration .Oo , Ar ... option declaration Oc } @@ -245,7 +240,7 @@ 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. +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 } @@ -259,16 +254,13 @@ 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, +This restriction is not enforced - if you ignore it, the behaviour will be unpredictable. .El .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 Oo Ar ... lease-declaration Oc } .Pp The DHCP client may decide after some period of time (see .Sx PROTOCOL TIMING ) @@ -293,11 +285,13 @@ Some of the syntax for leases as described below is only needed in the file. Such syntax is documented here for completeness. .Pp -A lease statement consists of the lease keyword, followed by a left +A lease statement consists of the +.Ic 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 +.Bl -tag -width indent .It Ic bootp ; The .Ic bootp @@ -305,7 +299,7 @@ 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\&" ; +.It Ic interface Qq Ar string ; The .Ic interface lease statement is used to indicate the interface on which the lease is valid. @@ -320,14 +314,15 @@ 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\&" ; +The IP address must be specified as a dotted quad (e.g., +.Li 12.34.56.78 ) . +.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\&" ; +.It Ic server-name Qq Ar string ; The .Ic server-name statement specifies the name of the boot server name to use. @@ -337,10 +332,10 @@ 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 dhclient.conf , +.Nm , the value that the user wishes the client configuration script to use if the predefined lease is used. -.It Ic script Ar \&"script-name\&" ; +.It Ic script Qq Ar script-name ; The .Ic script statement is used to specify the pathname of the DHCP client configuration @@ -353,16 +348,22 @@ 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. For more information, see .Xr dhclient.leases 5 . -.It Ic medium Ar \&"media setup\&" ; +.It Ic medium Qq Ar "media setup" ; The .Ic medium statement can be used on systems where network interfaces cannot automatically determine the type of network to which they are connected. -The media setup string is a system-dependent parameter which is passed +The +.Ar "media setup" +string is a system-dependent parameter which is passed to the DHCP client configuration script when initializing the interface. On .Ux -and UNIX-like systems, the argument is passed on the ifconfig command line +and +.Ux Ns -like +systems, the argument is passed on the +.Xr ifconfig 8 +command line when configuring the interface. .Pp The DHCP client automatically declares this parameter if it used a @@ -391,20 +392,21 @@ if it has not been able to contact a server in order to renew it. .El .Pp These declarations are automatically set in leases acquired by the -DHCP client, but must also be configured in predefined leases \- a +DHCP client, but must also be configured in predefined leases - a predefined lease whose expiry time has passed will not be used by the DHCP client. .Pp Dates are specified as follows: -.Pp -.Ar \ \& +.Bd -ragged -offset indent +.Ar .Sm off .Ar No / Ar No / Ar .Ar : : .Sm on +.Ed .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 +lease expires - it is specified as a number from zero to six, with zero being Sunday. When declaring a predefined lease, it can always be specified as zero. The year is specified with the century, so it should generally be four @@ -421,7 +423,7 @@ Some DHCP clients running TCP/IP roaming protocols may require that in addition to the lease they may acquire via DHCP, their interface also be configured with a predefined IP alias so that they can have a permanent IP address even while roaming. -The Internet Software Consortium DHCP client doesn't support roaming with +The Internet Software Consortium DHCP client does not support roaming with fixed addresses directly, but in order to facilitate such experimentation, the DHCP client can be set up to configure an IP alias using the .Ic alias @@ -436,19 +438,16 @@ A typical alias declaration includes an interface declaration, a fixed-address declaration for the IP alias address, and a subnet-mask option declaration. A medium statement should never be included in an alias declaration. .Sh OTHER DECLARATIONS -.Bl -tag -width Ds +.Bl -tag -width indent .It Ic reject Ar ip-address ; The .Ic reject statement causes the DHCP client to reject offers from servers who use 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 +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 { Ar declarations ... 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 and alias @@ -458,10 +457,7 @@ specified name. Interfaces for which there is no interface declaration will use the parameters declared outside of any interface declaration, or the default settings. -.It Xo -.Ic media Ar \&"media setup\&" -.Oo , Ar \&"media setup\&" , ... Oc ; -.Xc +.It Ic media Qo Ar "media setup" Qc Oo , Qo Ar "media setup" Qc , Ar ... Oc ; The .Ic media statement defines one or more media configuration parameters which may @@ -469,8 +465,8 @@ be tried while attempting to acquire an IP address. The DHCP client will cycle through each media setup string on the list, configuring the interface using that setup and attempting to boot, and then trying the next one. -This can be used for network interfaces which aren't capable of sensing -the media type unaided \- whichever media type succeeds in getting a request +This can be used for network interfaces which are not capable of sensing +the media type unaided - whichever media type succeeds in getting a request to the server and hearing the reply is probably right (no guarantees). .Pp The media setup is only used for the initial phase of address @@ -483,8 +479,11 @@ types. .El .Sh EXAMPLES The following configuration file is used on a laptop -which has an IP alias of 192.5.5.213, and has one interface, -ep0 (a 3Com 3C589C). +which has an IP alias of +.Li 192.5.5.213 , +and has one interface, +.Li ep0 +(a 3Com 3C589C). Booting intervals have been shortened somewhat from the default, because the client is known to spend most of its time on networks with little DHCP activity. @@ -519,20 +518,24 @@ alias { .Pp This is a very complicated .Nm -file \- in general, yours should be much simpler. -In many cases, it's sufficient to just create an empty +file - in general, yours should be much simpler. +In many cases, it is sufficient to just create an empty .Nm -file \- the defaults are usually fine. +file - the defaults are usually fine. .Sh SEE ALSO .Xr dhclient.leases 5 , -.Xr dhcp-options 5 , .Xr dhcpd.conf 5 , +.Xr dhcp-options 5 , .Xr dhclient 8 , .Xr dhcpd 8 -.Pp -RFC 2132, RFC 2131. +.Rs +.%R "RFC 2132, RFC 2131" +.Re .Sh AUTHORS +.An -nosplit +The .Xr dhclient 8 +utility was written by .An Ted Lemon Aq mellon@vix.com under a contract with Vixie Labs. diff --git a/sbin/dhclient/dhclient.leases.5 b/sbin/dhclient/dhclient.leases.5 index d5a8a29..b1f0f3d 100644 --- a/sbin/dhclient/dhclient.leases.5 +++ b/sbin/dhclient/dhclient.leases.5 @@ -36,6 +36,8 @@ .\" see ``http://www.isc.org/isc''. To learn more about Vixie .\" Enterprises, see ``http://www.vix.com''. .\" +.\" $FreeBSD$ +.\" .Dd January 1, 1997 .Dt DHCLIENT.LEASES 5 .Os @@ -52,33 +54,39 @@ the last one in the file is used. The file is written as a log, so this is not an unusual occurrence. .Pp The lease file is named -.Qq dhclient.leases.IFNAME , +.Pa dhclient.leases. Ns Ar IFNAME , where -.Qq IFNAME +.Ar IFNAME represents the network interface the DHCP client acquired the lease on. For example, if .Xr dhclient 8 -is configured for the em0 network device, +is configured for the +.Li em0 +network device, the lease file will be named -.Qq dhclient.leases.em0 . +.Pa 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 +.Bl -tag -width ".Pa /var/db/dhclient.leases. Ns Ar IFNAME" +.It Pa /var/db/dhclient.leases. Ns Ar IFNAME Current lease file. .El .Sh SEE ALSO .Xr dhclient.conf 5 , -.Xr dhcp-options 5 , .Xr dhcpd.conf 5 , +.Xr dhcp-options 5 , .Xr dhclient 8 , .Xr dhcpd 8 -.Pp -RFC 2132, RFC 2131. +.Rs +.%R "RFC 2132, RFC 2131" +.Re .Sh AUTHORS +.An -nosplit +The .Xr dhclient 8 +utility was written by .An Ted Lemon Aq mellon@vix.com under a contract with Vixie Labs. diff --git a/sbin/dhclient/dhcp-options.5 b/sbin/dhclient/dhcp-options.5 index da3dd1c..35b47e6 100644 --- a/sbin/dhclient/dhcp-options.5 +++ b/sbin/dhclient/dhcp-options.5 @@ -36,6 +36,8 @@ .\" see ``http://www.isc.org/isc''. To learn more about Vixie .\" Enterprises, see ``http://www.vix.com''. .\" +.\" $FreeBSD$ +.\" .Dd January 1, 1995 .Dt DHCP-OPTIONS 5 .Os @@ -61,7 +63,7 @@ statements always start with the .Ic option keyword, followed by an option name, followed by option data. The option names and data formats are described below. -It is not necessary to exhaustively specify all DHCP options \- +It is not necessary to exhaustively specify all DHCP options - only those options which are needed by clients must be specified. .Pp Option data comes in a variety of formats, as defined below: @@ -69,7 +71,10 @@ Option data comes in a variety of formats, as defined below: The .Ar ip-address data type can be entered either as an explicit IP address -(e.g., 239.254.197.10) or as a domain name (e.g., haagen.isc.org). +(e.g., +.Li 239.254.197.10 ) +or as a domain name (e.g., +.Li haagen.isc.org ) . A domain name must resolve to a single IP address. .Pp The @@ -96,16 +101,23 @@ data type specifies an .Tn NVT .Pq Network Virtual Terminal .Tn ASCII -string, which must be enclosed in double quotes \- for example, +string, which must be enclosed in double quotes - for example, to specify a domain-name option, the syntax would be .Pp -.Dl option domain-name \&"isc.org\&"; +.Dl option domain-name \&"isc.org"; .Pp The .Ar flag data type specifies a boolean value. -Booleans can be either true or false -(or on or off, if that makes more sense to you). +Booleans can be either +.Li true +or +.Li false +(or +.Li on +or +.Li off , +if that makes more sense to you). .Pp The .Ar data-string @@ -115,14 +127,14 @@ string enclosed in double quotes, or a series of octets specified in hexadecimal, separated by colons. For example: .Pp -.Dl option dhcp-client-identifier \&"CLIENT-FOO\&"; +.Dl option dhcp-client-identifier \&"CLIENT-FOO"; or .Dl option dhcp-client-identifier 43:4c:49:45:54:2d:46:4f:4f; .Pp The documentation for the various options mentioned below is taken from the IETF draft document on DHCP options, RFC 2132. Options which are not listed by name may be defined by the name -.Pf option\- Ns Ar nnn , +.Li option- Ns Ar nnn , where .Ar nnn is the decimal number of the option code. @@ -142,7 +154,7 @@ no checking is done to ensure the correctness of the entered data. .Pp The standard options are: .Ss RFC 1497 Vendor Extensions -.Bl -tag -width Ds +.Bl -tag -width indent .It Ic option subnet-mask Ar ip-address ; The .Ic subnet-mask @@ -263,7 +275,7 @@ the character set. .El .Ss IP Layer Parameters per Host -.Bl -tag -width Ds +.Bl -tag -width indent .It Ic option ip-forwarding Ar flag ; This option specifies whether the client should configure its IP layer for packet forwarding. @@ -308,7 +320,7 @@ ordered from smallest to largest. The minimum MTU value cannot be smaller than 68. .El .Ss IP Layer Parameters per Interface -.Bl -tag -width Ds +.Bl -tag -width indent .It Ic option interface-mtu Ar uint16 ; This option specifies the MTU to use on this interface. The minimum legal value for the MTU is 68. @@ -360,7 +372,7 @@ To specify the default route, use the option. .El .Ss Link Layer Parameters per Interface -.Bl -tag -width Ds +.Bl -tag -width indent .It Ic option trailer-encapsulation Ar flag ; This option specifies whether or not the client should negotiate the use of trailers (RFC 893 [14]) when using the ARP protocol. @@ -376,7 +388,7 @@ A value of 0 indicates that the client should use RFC 894 encapsulation. A value of 1 means that the client should use RFC 1042 encapsulation. .El .Ss TCP Parameters -.Bl -tag -width Ds +.Bl -tag -width indent .It Ic option default-tcp-ttl Ar uint8 ; This option specifies the default TTL that the client should use when sending TCP segments. @@ -394,7 +406,7 @@ A value of 0 indicates that a garbage octet should not be sent. A value of 1 indicates that a garbage octet should be sent. .El .Ss Application and Service Parameters -.Bl -tag -width Ds +.Bl -tag -width indent .It Ic option nis-domain Ar string ; This option specifies the name of the client's NIS (Sun Network Information Services) domain. @@ -438,7 +450,7 @@ are configurable to be configured as described in RFC 1001/1002. The value is specified as a single octet which identifies the client type. .Pp Possible node types are: -.Bl -tag -width Ds +.Bl -tag -width indent .It 1 B-node: Broadcast - no WINS .It 2 @@ -578,10 +590,14 @@ Servers should be listed in order of preference. .Xr dhcpd.leases 5 , .Xr dhclient 8 , .Xr dhcpd 8 -.Pp -RFC 2131, RFC 2132. +.Rs +.%R "RFC 2131, RFC 2132" +.Re .Sh AUTHORS +.An -nosplit +The .Xr dhcpd 8 +utility was written by .An Ted Lemon Aq mellon@vix.com under a contract with Vixie Labs. -- cgit v1.1