diff options
author | Shawn Routhier <sar@isc.org> | 2012-08-13 16:22:32 -0700 |
---|---|---|
committer | Shawn Routhier <sar@isc.org> | 2012-08-13 16:22:32 -0700 |
commit | a0497ac5ac9b787edebceaecb29da0c4e5e0b320 (patch) | |
tree | 6d2ccd1d5886dee6fa51e2060c83c0d41c10e916 /client | |
parent | ffec568b4fd18c43812aedd151a66cd5017c85d8 (diff) | |
download | isc-dhcp-a0497ac5ac9b787edebceaecb29da0c4e5e0b320.tar.gz |
[rt29771]
[rt29770]
[rt29846]
Tidy up man pages, mostly convert a period followed by 1
or 3 spaces to a period followed by 2 spaces. This also
covers tickets 29770 and 29846
Squashed commit of the following:
commit d40674fdfc8a81a44f8033bf048587a3eab0471f
Author: Shawn Routhier <sar@isc.org>
Date: Fri Aug 3 17:55:05 2012 -0700
Diffstat (limited to 'client')
-rw-r--r-- | client/dhclient.8 | 44 | ||||
-rw-r--r-- | client/dhclient.conf.5 | 136 |
2 files changed, 90 insertions, 90 deletions
diff --git a/client/dhclient.8 b/client/dhclient.8 index 7326830b..05646ca5 100644 --- a/client/dhclient.8 +++ b/client/dhclient.8 @@ -1,6 +1,6 @@ .\" $Id: dhclient.8,v 1.36 2011/04/15 21:58:12 sar Exp $ .\" -.\" Copyright (c) 2004,2007-2011 by Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (c) 2004,2007-2012 by Internet Systems Consortium, Inc. ("ISC") .\" Copyright (c) 1996-2003 by Internet Software Consortium .\" .\" Permission to use, copy, modify, and distribute this software for any @@ -138,8 +138,8 @@ fail, by statically assigning an address. .PP The DHCP protocol allows a host to contact a central server which maintains a list of IP addresses which may be assigned on one or more -subnets. A DHCP client may request an address from this pool, and -then use it on a temporary basis for communication on network. The +subnets. A DHCP client may request an address from this pool, and +then use it on a temporary basis for communication on network. The DHCP protocol also provides a mechanism whereby a client can learn important details about the network to which it is attached, such as the location of a default router, the location of a name server, and @@ -153,19 +153,19 @@ or options. .PP On startup, \fBdhclient\fR reads the dhclient.conf -for configuration instructions. It then gets a list of all the -network interfaces that are configured in the current system. For +for configuration instructions. It then gets a list of all the +network interfaces that are configured in the current system. For each interface, it attempts to configure the interface using the DHCP protocol. .PP In order to keep track of leases across system reboots and server restarts, \fBdhclient\fR keeps a list of leases it has been assigned in the -dhclient.leases file. On startup, after reading the dhclient.conf +dhclient.leases file. On startup, after reading the dhclient.conf file, \fBdhclient\fR reads the dhclient.leases file to refresh its memory about what leases it has been assigned. .PP When a new lease is acquired, it is appended to the end of the -dhclient.leases file. In order to prevent the file from becoming +dhclient.leases file. In order to prevent the file from becoming arbitrarily large, from time to time \fBdhclient\fR creates a new dhclient.leases file from its in-core lease database. The old version of the dhclient.leases file is retained under the name @@ -174,19 +174,19 @@ until the next time \fBdhclient\fR rewrites the database. .PP Old leases are kept around in case the DHCP server is unavailable when \fBdhclient\fR is first invoked (generally during the initial system boot -process). In that event, old leases from the dhclient.leases file +process). In that event, old leases from the dhclient.leases 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. .PP A mobile host which may sometimes need to access a network on which no DHCP server exists may be preloaded with a lease for a fixed -address on that network. When all attempts to contact a DHCP server +address on that network. When all attempts to contact a DHCP server have failed, \fBdhclient\fR will try to validate the static lease, and if it succeeds, will use that lease until it is restarted. .PP A mobile host may also travel to some networks on which DHCP is not -available but BOOTP is. In that case, it may be advantageous to +available but BOOTP is. In that case, it may be advantageous to arrange with the network administrator for an entry on the BOOTP database, so that the host can boot quickly on that network rather than cycling through the list of old leases. @@ -199,7 +199,7 @@ network interfaces, eliminating non-broadcast interfaces if possible, and attempt to configure each interface. .PP It is also possible to specify interfaces by name in the dhclient.conf -file. If interfaces are specified in this way, then the client will +file. If interfaces are specified in this way, then the client will only configure interfaces that are either specified in the configuration file or on the command line, and will ignore all other interfaces. @@ -262,7 +262,7 @@ DHCP client will exit if it isn't able to identify any network interfaces to configure. On laptop computers and other computers with hot-swappable I/O buses, it is possible that a broadcast interface may be added after system startup. This flag can be used to cause the client -not to exit when it doesn't find any such interfaces. The +not to exit when it doesn't find any such interfaces. The .B omshell(1) program can then be used to notify the client when a network interface has been added or removed, so that the client can attempt to configure an IP @@ -409,28 +409,28 @@ client using TCP/IP, authenticate, and can then examine the client's current status and make changes to it. .PP Rather than implementing the underlying OMAPI protocol directly, user -programs should use the dhcpctl API or OMAPI itself. Dhcpctl is a +programs should use the dhcpctl API or OMAPI itself. Dhcpctl is a wrapper that handles some of the housekeeping chores that OMAPI does -not do automatically. Dhcpctl and OMAPI are documented in +not do automatically. Dhcpctl and OMAPI are documented in \fBdhcpctl(3)\fR -and \fBomapi(3)\fR. Most things you'd want to do with the client can +and \fBomapi(3)\fR. Most things you'd want to do with the client can be done directly using the \fBomshell(1)\fR command, rather than having to write a special program. .SH THE CONTROL OBJECT The control object allows you to shut the client down, releasing all leases that it holds and deleting any DNS records it may have added. It also allows you to pause the client - this unconfigures any -interfaces the client is using. You can then restart it, which -causes it to reconfigure those interfaces. You would normally pause +interfaces the client is using. You can then restart it, which +causes it to reconfigure those interfaces. You would normally pause the client prior to going into hibernation or sleep on a laptop -computer. You would then resume it after the power comes back. +computer. You would then resume it after the power comes back. This allows PC cards to be shut down while the computer is hibernating or sleeping, and then reinitialized to their previous state once the computer comes out of hibernation or sleep. .PP -The control object has one attribute - the state attribute. To shut -the client down, set its state attribute to 2. It will automatically -do a DHCPRELEASE. To pause it, set its state attribute to 3. To +The control object has one attribute - the state attribute. To shut +the client down, set its state attribute to 2. It will automatically +do a DHCPRELEASE. To pause it, set its state attribute to 3. To resume it, set its state attribute to 4. .PP .SH ENVIRONMENT VARIABLES @@ -477,7 +477,7 @@ Stanford. The current version owes much to Elliot's Linux enhancements, but was substantially reorganized and partially rewritten by Ted Lemon so as to use the same networking framework that the Internet Systems -Consortium DHCP server uses. Much system-specific configuration code +Consortium DHCP server uses. Much system-specific configuration code was moved into a shell script so that as support for more operating systems is added, it will not be necessary to port and maintain system-specific configuration code to these operating systems - instead, diff --git a/client/dhclient.conf.5 b/client/dhclient.conf.5 index 3b172886..37d38864 100644 --- a/client/dhclient.conf.5 +++ b/client/dhclient.conf.5 @@ -36,11 +36,11 @@ The dhclient.conf file contains configuration information for .IR dhclient, the Internet Systems Consortium DHCP Client. .PP -The dhclient.conf file is a free-form ASCII text file. It is parsed by -the recursive-descent parser built into dhclient. The file may contain +The dhclient.conf file is a free-form ASCII text file. It is parsed by +the recursive-descent parser built into dhclient. 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 # character and +are case-insensitive. Comments may be placed anywhere within the +file (except within quotes). Comments begin with the # character and end at the end of the line. .PP The dhclient.conf file can be used to configure the behaviour of the @@ -74,12 +74,12 @@ The 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. By default, this timeout is sixty seconds. After the +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 have not yet expired, the client will loop through these leases attempting to validate them, and if it finds one that appears to be -valid, it will use that lease's address. If there are no valid +valid, it will use that lease's address. If there are no valid static leases or unexpired leases in the lease database, the client will restart the protocol after the defined retry interval. .PP @@ -93,7 +93,7 @@ The .I retry statement determines the time that must pass after the client has determined that there is no DHCP server present before it tries again -to contact a DHCP server. By default, this is five minutes. +to contact a DHCP server. By default, this is five minutes. .PP .I The .B select-timeout @@ -102,9 +102,9 @@ to contact a DHCP server. By default, this is five minutes. \fBselect-timeout \fItime\fR\fB;\fR .PP It is possible (some might say desirable) for there to be more than -one DHCP server serving any given network. In this case, it is +one DHCP server serving any given network. In this case, it is possible that a client may be sent more than one offer in response to -its initial lease discovery message. It may be that one of these +its initial lease discovery message. It may be that one of these offers is preferable to the other (e.g., one offer may have the address the client previously used, and the other may not). .PP @@ -112,7 +112,7 @@ The .I select-timeout is the time after the client sends its first lease discovery request at which it stops waiting for offers from servers, assuming that it -has received at least one such offer. If no offers have been +has received at least one such offer. If no offers have been received by the time the .I select-timeout has expired, the client will accept the first offer that arrives. @@ -127,13 +127,13 @@ will take the first offer it sees. \fBreboot \fItime\fR\fB;\fR .PP When the client is restarted, it first tries to reacquire the last -address it had. This is called the INIT-REBOOT state. If it is +address it had. This is called the INIT-REBOOT state. If it is still attached to the same network it was attached to when it last -ran, this is the quickest way to get started. The +ran, this is the quickest way to get started. The .I reboot statement sets the time that must elapse after the client first tries to reacquire its old address before it gives up and tries to discover -a new address. By default, the reboot timeout is ten seconds. +a new address. By default, the reboot timeout is ten seconds. .PP .I The .B backoff-cutoff @@ -143,11 +143,11 @@ a new address. By default, the reboot timeout is ten seconds. .PP The client uses an exponential backoff algorithm with some randomness, so that if many clients try to configure themselves at the same time, -they will not make their requests in lockstep. The +they will not make their requests in lockstep. The .I backoff-cutoff statement determines the maximum amount of time that the client is allowed to back off, the actual value will be evaluated randomly between -1/2 to 1 1/2 times the \fItime\fR specified. It defaults to fifteen +1/2 to 1 1/2 times the \fItime\fR specified. It defaults to fifteen seconds. .PP .I The @@ -182,7 +182,7 @@ to 5. .SH LEASE REQUIREMENTS AND REQUESTS 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 +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 is not satisfactory. .PP @@ -199,8 +199,8 @@ are called \fIDHCP Options\fR. DHCP Options are defined in .PP The 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. By default, the DHCPv4 client +options. Only the option names should be specified in the request +statement - not option parameters. By default, the DHCPv4 client requests the subnet-mask, broadcast-address, time-offset, routers, domain-name, domain-name-servers and host-name options while the DHCPv6 client requests the dhcp6 name-servers and domain-search options. Note @@ -208,7 +208,7 @@ that if you enter a \'request\' statement, you over-ride these defaults and these options will not be requested. .PP In some cases, it may be desirable to send no parameter request list -at all. To do this, simply write the request statement but specify +at all. To do this, simply write the request statement but specify no parameters: .PP .nf @@ -230,7 +230,7 @@ is best to \'also request\' the additional options: \fB[ also ] require [ [ \fIoption-space\fR . ] \fIoption\fR ] [\fB,\fI ... ]\fB;\fR .PP The require statement lists options that must be sent in order for an -offer to be accepted. Offers that do not contain all the listed +offer to be accepted. Offers that do not contain all the listed options will be ignored. There is no default require list. .PP .nf @@ -258,15 +258,15 @@ that will allow it to differentiate between this client and other clients or kinds of clients. .SH DYNAMIC DNS The client now has some very limited support for doing DNS updates -when a lease is acquired. This is prototypical, and probably doesn't -do what you want. It also only works if you happen to have control +when a lease is acquired. This is prototypical, and probably doesn't +do what you want. It also only works if you happen to have control over your DNS server, which isn't very likely. .PP Note that everything in this section is true whether you are using DHCPv4 or DHCPv6. The exact same syntax is used for both. .PP To make it work, you have to declare a key and zone as in the DHCP -server (see \fBdhcpd.conf\fR(5) for details). You also need to +server (see \fBdhcpd.conf\fR(5) for details). You also need to configure the fqdn option on the client, as follows: .PP .nf @@ -277,8 +277,8 @@ configure the fqdn option on the client, as follows: .fi .PP The \fIfqdn.fqdn\fR option \fBMUST\fR be a fully-qualified domain -name. You \fBMUST\fR define a zone statement for the zone to be -updated. The \fIfqdn.encoded\fR option may need to be set to +name. You \fBMUST\fR define a zone statement for the zone to be +updated. The \fIfqdn.encoded\fR option may need to be set to \fIon\fR or \fIoff\fR, depending on the DHCP server you are using. .PP .I The @@ -292,16 +292,16 @@ script (see \fBdhclient-script(8)\fR) rather than having the DHCP client do the update directly (for example, if you want to use SIG(0) authentication, which is not supported directly by the DHCP client, you can instruct the client not to do the update using -the \fBdo-forward-updates\fR statement. \fIFlag\fR should be \fBtrue\fR +the \fBdo-forward-updates\fR statement. \fIFlag\fR should be \fBtrue\fR if you want the DHCP client to do the update, and \fBfalse\fR if -you don't want the DHCP client to do the update. By default, the DHCP +you don't want the DHCP client to do the update. By default, the DHCP client will do the DNS update. .SH OPTION MODIFIERS In some cases, a client may receive option data from the server which is not really appropriate for that client, or may not receive 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 +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. .PP .I The @@ -338,10 +338,10 @@ 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 .B prepend -statement. The +statement. The .B prepend statement can only be used for options which -allow more than one value to be given. This restriction is not +allow more than one value to be given. This restriction is not enforced - if you ignore it, the behaviour will be unpredictable. .PP .I The @@ -354,10 +354,10 @@ 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 .B append -statement. The +statement. The .B append statement can only be used for options which -allow more than one value to be given. This restriction is not +allow more than one value to be given. This restriction is not enforced - if you ignore it, the behaviour will be unpredictable. .SH LEASE DECLARATIONS .PP @@ -369,12 +369,12 @@ enforced - if you ignore it, the behaviour will be unpredictable. .PP The DHCP client may decide after some period of time (see \fBPROTOCOL TIMING\fR) that it is not going to succeed in contacting a -server. At that time, it consults its own database of old leases and +server. At that time, it consults its own database of old leases and tests each one that has not yet timed out by pinging the listed router -for that lease to see if that lease could work. It is possible to +for that lease to see if that lease could work. It is possible to define one or more \fIfixed\fR leases in the client configuration file for networks where there is no DHCP or BOOTP service, so that the -client can still automatically configure its address. This is done +client can still automatically configure its address. This is done with the .B lease statement. @@ -382,12 +382,12 @@ statement. NOTE: the lease statement is also used in the dhclient.leases 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 -dhclient.leases file. Such syntax is documented here for +dhclient.leases file. Such syntax is documented here for completeness. .PP 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 +followed by a right curly brace. The following lease declarations are possible: .PP \fBbootp;\fR @@ -395,8 +395,8 @@ are possible: The .B bootp 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 +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. .PP \fBinterface\fR \fB"\fR\fIstring\fR\fB";\fR @@ -404,8 +404,8 @@ this syntax in its lease database file. The .B interface lease statement is used to indicate the interface on which the lease -is valid. If set, this lease will only be tried on a particular -interface. When the client receives a lease from a server, it always +is valid. If set, this lease will only be tried on a particular +interface. When the client receives a lease from a server, it always records the interface number on which it received that lease. If predefined leases are specified in the dhclient.conf file, the interface should also be specified, although this is not required. @@ -414,15 +414,15 @@ interface should also be specified, although this is not required. .PP The .B 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 +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). .PP \fBfilename "\fR\fIstring\fR\fB";\fR .PP The .B filename -statement specifies the name of the boot filename to use. This is +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. .PP @@ -430,7 +430,7 @@ for completeness. .PP The .B server-name -statement specifies the name of the boot server name to use. This is +statement specifies the name of the boot server name to use. This is also not used by the standard client configuration script. .PP \fBoption\fR \fIoption-declaration\fR\fB;\fR @@ -450,9 +450,9 @@ statement is used to specify the pathname of the dhcp client configuration script. 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 +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. For +any, and also called once if no valid lease can be identified. For more information, see .B dhclient-script(8). .PP @@ -463,7 +463,7 @@ The statement is used to specify which option space should be used for decoding the vendor-encapsulate-options option if one is received. The \fIdhcp-vendor-identifier\fR can be used to request a specific -class of vendor options from the server. See +class of vendor options from the server. See .B dhcp-options(5) for details. .PP @@ -494,9 +494,9 @@ interface requires media type configuration. .PP The \fBrenew\fR statement defines the time at which the dhcp client should begin trying to contact its server to renew a lease that it is -using. The \fBrebind\fR statement defines the time at which the dhcp +using. The \fBrebind\fR statement defines the time at which the dhcp client should begin to try to contact \fIany\fR dhcp server in order -to renew its lease. The \fBexpire\fR statement defines the time at +to renew its lease. The \fBexpire\fR statement defines the time at which the dhcp client must stop using a lease if it has not been able to contact a server in order to renew it. .PP @@ -548,7 +548,7 @@ instead of an actual date. 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 Systems +permanent IP address even while roaming. The Internet Systems Consortium DHCP client doesn't 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 @@ -560,7 +560,7 @@ options other than the subnet-mask option are ignored by the standard client configuration script, and expiry times are ignored. 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. A medium statement should never be included in an alias declaration. .SH OTHER DECLARATIONS \fBdb-time-format\fR [ \fIdefault\fR | \fIlocal\fR ] \fB;\fR @@ -597,11 +597,11 @@ single address 10.0.0.5, to be rejected. \fBinterface "\fIname\fB" { \fIdeclarations ... \fB } .PP A client with more than one network interface may require different -behaviour depending on which interface is being configured. All +behaviour depending on which interface is being configured. All timing parameters and declarations other than lease and alias declarations can be enclosed in an interface declaration, and those parameters will then be used only for the interface that matches the -specified name. Interfaces for which there is no interface +specified name. Interfaces for which there is no interface declaration will use the parameters declared outside of any interface declaration, or the default settings. .PP @@ -622,11 +622,11 @@ Each interface that the DHCP client is supporting normally has a DHCP client state machine running on it to acquire and maintain its lease. A pseudo-interface is just another state machine running on the interface named \fIreal-name\fR, with its own lease and its own -state. If you use this feature, you must provide a client identifier +state. If you use this feature, you must provide a client identifier for both the pseudo-interface and the actual interface, and the two -identifiers must be different. You must also provide a separate +identifiers must be different. You must also provide a separate client script for the pseudo-interface to do what you want with the IP -address. For example: +address. For example: .PP .nf interface "ep0" { @@ -641,7 +641,7 @@ address. For example: The client script for the pseudo-interface should not configure the interface up or down - essentially, all it needs to handle are the states where a lease has been acquired or renewed, and the states -where a lease has expired. See \fBdhclient-script(8)\fR for more +where a lease has expired. See \fBdhclient-script(8)\fR for more information. .PP \fBmedia "\fImedia setup\fB"\fI [ \fB, "\fImedia setup\fB", \fI... ]\fB;\fR @@ -649,20 +649,20 @@ information. The .B media statement defines one or more media configuration parameters which may -be tried while attempting to acquire an IP address. The dhcp client +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 +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 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 -acquisition (the DHCPDISCOVER and DHCPOFFER packets). Once an +acquisition (the DHCPDISCOVER and DHCPOFFER packets). Once an address has been acquired, the dhcp client will record it in its lease database and will record the media type used to acquire the address. Whenever the client tries to renew the lease, it will use that same -media type. The lease must expire before the client will go back to +media type. The lease must expire before the client will go back to cycling through media types. .PP \fBhardware\fR \fIlink-type mac-address\fR\fB;\fR @@ -690,10 +690,10 @@ in a similar manner to the \fBhardware\fR statement. .PP .SH SAMPLE The following configuration file is used on a laptop running NetBSD -1.3. The laptop has an IP alias of 192.5.5.213, and has one -interface, ep0 (a 3com 3C589C). Booting intervals have been +1.3. The laptop has an IP alias of 192.5.5.213, and has one +interface, 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. The +spend most of its time on networks with little DHCP activity. The laptop does roam to multiple networks. .nf @@ -726,7 +726,7 @@ alias { } .fi This is a very complicated dhclient.conf file - in general, yours -should be much simpler. In many cases, it's sufficient to just +should be much simpler. In many cases, it's sufficient to just create an empty dhclient.conf file - the defaults are usually fine. .SH SEE ALSO dhcp-options(5), dhcp-eval(5), dhclient.leases(5), dhcpd(8), dhcpd.conf(5), @@ -734,7 +734,7 @@ RFC2132, RFC2131. .SH AUTHOR .B dhclient(8) was written by Ted Lemon -under a contract with Vixie Labs. Funding +under a contract with Vixie Labs. Funding for this project was provided by Internet Systems Consortium. Information about Internet Systems Consortium can be found at .B https://www.isc.org. |