From: Roy Marples Date: Tue, 20 May 2008 12:33:04 +0000 (+0000) Subject: One sentence per line. X-Git-Tag: v4.0.2~368 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cf42802e15aa95933019caebd61338d4687f3816;p=thirdparty%2Fdhcpcd.git One sentence per line. --- diff --git a/dhcpcd.8.in b/dhcpcd.8.in index c77827b4..2bed6aa4 100644 --- a/dhcpcd.8.in +++ b/dhcpcd.8.in @@ -192,15 +192,14 @@ You can use this option to stop this from happening. .Nm normally sends a DHCP Broadcast to find servers to offer an address. .Nm -will then request the address used. You can use this option to skip the -broadcast step and just request an +will then request the address used. +You can use this option to skip the broadcast step and just request an .Ar address . -The downside is if you request -an +The downside is if you request an .Ar address the DHCP server does not know about or the DHCP server is not -authorative, it will remain silent. In this situation, we go back to the init -state and broadcast again. +authorative, it will remain silent. +In this situation, we go back to the init state and broadcast again. If no .Ar address is given then we use the first address currently assigned to the @@ -208,12 +207,13 @@ is given then we use the first address currently assigned to the .It Fl s , -inform Op Ar address Op / Ar cidr Behaves exactly like .Fl r , -request -as above, but sends a DHCP inform instead of a request. This requires the -interface to be configured first. This does not get a lease as such, just -notifies the DHCP server of the +as above, but sends a DHCP inform instead of a request. +This requires the interface to be configured first. +This does not get a lease as such, just notifies the DHCP server of the .Ar address -we are using. If we fail to contact a DHCP server then we return a failure -instead of falling back on IPv4LL. +we are using. +If we fail to contact a DHCP server then we return a failure instead of falling +back on IPv4LL. .It Fl t , -timeout Ar seconds Timeout after .Ar seconds , @@ -233,14 +233,16 @@ Generate an .Rs .%T "RFC 4361" .Re -compliant clientid. This requires persistent storage -and not all DHCP servers work with it so it's not enabled by default. +compliant clientid. +This requires persistent storage and not all DHCP servers work with it so it's +not enabled by default. The DUID generated will be held in .Pa @SYSCONFDIR@/dhcpcd.duid and should not be copied to other hosts. .It Fl F , -fqdn Ar fqdn Requests that the DHCP server updates DNS using FQDN instead of just a -hostname. Valid values for +hostname. +Valid values for .Ar fqdn are none, ptr and both. The current hostname or the hostname specified using the @@ -255,10 +257,10 @@ If not set then none is sent. .El .Ss Restriciting behaviour .Nm -will try to do as much as it can by default. However, there are sometimes -situations where you don't want the things to be configured exactly how the -the DHCP server wants. Here are some option that deal with turning these bits -off. +will try to do as much as it can by default. +However, there are sometimes situations where you don't want the things to be +configured exactly how the the DHCP server wants. +Here are some option that deal with turning these bits off. .Bl -tag -width indent .It Fl A , -noarp Don't request or claim the address by ARP. @@ -267,14 +269,16 @@ Don't set any default routes. .It Fl L , -noipv4ll Don't use IPv4LL at all. .It Fl O , -nooption Ar option -Don't request the specified option. If no option given, then don't request -any options other than those to configure the interface and routing. +Don't request the specified option. +If no option given, then don't request any options other than those to +configure the interface and routing. .It Fl T, -test On receipt of discover messages we just call .Pa @SCRIPT@ with the reason of TEST which echo's the DHCP variables found in the message -to the console. The interface configuration isn't touched and neither are any -configuration files. +to the console. +The interface configuration isn't touched and neither are any configuration +files. .It Fl V, -variables Display a list of option codes and the associated variable for use in .Xr dhcpcd.sh 8 . diff --git a/dhcpcd.conf.5.in b/dhcpcd.conf.5.in index 93c099dc..f5512230 100644 --- a/dhcpcd.conf.5.in +++ b/dhcpcd.conf.5.in @@ -31,19 +31,21 @@ Although .Nm dhcpcd can do everything from the command line, there are cases where it's just easier -to do it once in a configuration file. Most of the options found in +to do it once in a configuration file. +Most of the options found in .Xr dhcpcd 8 -can be used here. The first word on the line is the option and the rest of the -line is the value. Leading and trailing whitespace for the option and value -are trimmed. You can escape characters in the value using the \\ character. +can be used here. +The first word on the line is the option and the rest of the line is the value. +Leading and trailing whitespace for the option and value are trimmed. +You can escape characters in the value using the \\ character. .Pp Blank lines and lines starting with # are ignored. .Pp Here's a list of available options: .Bl -tag -width indent .It Ic classid Ar string -Change the default classid sent from dhcpcd-version. If not set then none -is sent. +Change the default classid sent from dhcpcd-version. +If not set then none is sent. .It Ic clientid Ar string Change the default clientid sent from the interface hardware address. If the string is of the format 01:02:03 then it is encoded as hex. @@ -53,8 +55,9 @@ Generate an .Rs .%T "RFC 4361" .Re -compliant clientid. This requires persistent storage -and not all DHCP servers work with it so it's not enabled by default. +compliant clientid. +This requires persistent storage and not all DHCP servers work with it so it's +not enabled by default. The duid generated will be held in .Pa @SYSCONFDIR@/dhcpcd.duid and should not be copied to other hosts. @@ -79,7 +82,8 @@ Subsequent options are only parsed for this Request a leasetime of .Ar seconds . .It Ic noarp -Don't send any ARP requests. This also disables IPv4LL. +Don't send any ARP requests. +This also disables IPv4LL. .It Ic nogateway Don't install any default routes. .It Ic noipv4ll @@ -91,10 +95,11 @@ See .It Ic option Ar dhcp-option Requests the .Ar dhcp-option -from the server. It can be a variable to be used in +from the server. +It can be a variable to be used in .Xr dhcpcd.sh 8 -or the numerical value. You can specify more seperated by commas, spaces or -more option lines. +or the numerical value. +You can specify more seperated by commas, spaces or more option lines. .It Ic script Ar script Use .Ar script @@ -104,7 +109,8 @@ instead of the default The default timeout for waiting for a DHCP response is 20 seconds which may be too long or too short and can be changed here. .It Ic userclass Ar string -Tag the DHCP messages with the userclass. You can specify more than one. +Tag the DHCP messages with the userclass. +You can specify more than one. .El .Sh SEE ALSO .Xr dhcpcd.sh 8 , diff --git a/dhcpcd.sh.8.in b/dhcpcd.sh.8.in index ace556e1..1b4406a1 100644 --- a/dhcpcd.sh.8.in +++ b/dhcpcd.sh.8.in @@ -44,9 +44,10 @@ is run on and .Ev $reason is to the reason why .Nm -was invoked. DHCP information to be configured is held in variables starting -with the word new_ and old DHCP information to be removed is held in variables -starting with the word old_. +was invoked. +DHCP information to be configured is held in variables starting with the word +new_ and old DHCP information to be removed is held in variables starting with +the word old_. .Nm dhcpcd can display the full list of variables it knows how about by using the .Fl V , -variables @@ -74,8 +75,9 @@ dhcpcd failed to contact any DHCP servers or use an old lease. dhcpcd failed to contact any DHCP servers but was able to use an old lease. .It Dv TEST dhcpcd received an OFFER from a DHCP server but will not configure the -interface. This is primarily used to test the variables are filled correctly -for the script to process them. +interface. +This is primarily used to test the variables are filled correctly for the +script to process them. .El .Sh FILES When