[src/trunk]: src/external/bsd/dhcpcd/dist Fix Dd and Dt arguments.

[wiz <wiz%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/6fec2c98288d
branches:  trunk
changeset: 778360:6fec2c98288d
user:      wiz <wiz%NetBSD.org@localhost>
date:      Fri Mar 23 11:19:18 2012 +0000

description:
Fix Dd and Dt arguments.
New sentence, new line.
Sort options and option descriptions.
Sort SEE ALSO.
Use Fl Fl for long options.
Comment out --version description which binary doesn't support.

diffstat:

 external/bsd/dhcpcd/dist/dhcpcd.8.in |  296 +++++++++++++++++-----------------
 1 files changed, 149 insertions(+), 147 deletions(-)

diffs (truncated from 574 to 300 lines):

diff -r 392041625776 -r 6fec2c98288d external/bsd/dhcpcd/dist/dhcpcd.8.in
--- a/external/bsd/dhcpcd/dist/dhcpcd.8.in      Fri Mar 23 11:18:30 2012 +0000
+++ b/external/bsd/dhcpcd/dist/dhcpcd.8.in      Fri Mar 23 11:19:18 2012 +0000
@@ -22,8 +22,8 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd March 19, 20122
-.Dt DHCPCD 8 SMM
+.Dd March 19, 2012
+.Dt DHCPCD 8
 .Os
 .Sh NAME
 .Nm dhcpcd
@@ -31,43 +31,43 @@
 .Sh SYNOPSIS
 .Nm
 .Op Fl bdgknpqwABDEGHJKLTV
-.Op Fl c , -script Ar script
-.Op Fl e , -env Ar value
-.Op Fl f , -config Ar file
-.Op Fl h , -hostname Ar hostname
-.Op Fl i , -vendorclassid Ar vendorclassid
-.Op Fl l , -leasetime Ar seconds
-.Op Fl m , -metric Ar metric
-.Op Fl o , -option Ar option
-.Op Fl r , -request Ar address
-.Op Fl s , -inform Ar address Ns Op Ar /cidr
-.Op Fl t , -timeout Ar seconds
-.Op Fl u , -userclass Ar class
-.Op Fl v , -vendor Ar code , Ar value
-.Op Fl y , -reboot Ar seconds
-.Op Fl z , -allowinterfaces Ar pattern
-.Op Fl C , -nohook Ar hook
-.Op Fl F , -fqdn Ar FQDN
-.Op Fl I , -clientid Ar clientid
-.Op Fl O , -nooption Ar option
-.Op Fl Q , -require Ar option
-.Op Fl S , -static Ar value
-.Op Fl W , -whitelist Ar address Ns Op Ar /cidr
-.Op Fl X , -blacklist Ar address Ns Op Ar /cidr
-.Op Fl Z , -denyinterfaces Ar pattern
+.Op Fl C , Fl Fl nohook Ar hook
+.Op Fl c , Fl Fl script Ar script
+.Op Fl e , Fl Fl env Ar value
+.Op Fl F , Fl Fl fqdn Ar FQDN
+.Op Fl f , Fl Fl config Ar file
+.Op Fl h , Fl Fl hostname Ar hostname
+.Op Fl I , Fl Fl clientid Ar clientid
+.Op Fl i , Fl Fl vendorclassid Ar vendorclassid
+.Op Fl l , Fl Fl leasetime Ar seconds
+.Op Fl m , Fl Fl metric Ar metric
+.Op Fl O , Fl Fl nooption Ar option
+.Op Fl o , Fl Fl option Ar option
+.Op Fl Q , Fl Fl require Ar option
+.Op Fl r , Fl Fl request Ar address
+.Op Fl S , Fl Fl static Ar value
+.Op Fl s , Fl Fl inform Ar address Ns Op Ar /cidr
+.Op Fl t , Fl Fl timeout Ar seconds
+.Op Fl u , Fl Fl userclass Ar class
+.Op Fl v , Fl Fl vendor Ar code , Ar value
+.Op Fl W , Fl Fl whitelist Ar address Ns Op Ar /cidr
+.Op Fl y , Fl Fl reboot Ar seconds
+.Op Fl X , Fl Fl blacklist Ar address Ns Op Ar /cidr
+.Op Fl Z , Fl Fl denyinterfaces Ar pattern
+.Op Fl z , Fl Fl allowinterfaces Ar pattern
 .Op interface
 .Op ...
 .Nm
-.Fl k , -release
+.Fl k , Fl Fl release
 .Op interface
 .Nm
-.Fl U, -dumplease
+.Fl U, Fl Fl dumplease
 .Ar interface
 .Nm
-.Fl x , -exit
+.Fl v , Fl Fl version
+.Nm
+.Fl x , Fl Fl exit
 .Op interface
-.Nm
-.Fl v , -version
 .Sh DESCRIPTION
 .Nm
 is an implementation of the DHCP client specified in
@@ -120,7 +120,7 @@
 In the rare case it fails, it normally means that there is a reverse ARP proxy
 installed which always defeats IPv4LL probing.
 To disable this behaviour, you can use the
-.Fl L , -noipv4ll
+.Fl L , Fl Fl noipv4ll
 option.
 .Ss Multiple interfaces
 If a list of interfaces are given on the command line, then
@@ -133,16 +133,16 @@
 will try and obtain a lease before forking to the background,
 otherwise it will fork right away.
 This behaviour can be modified with the
-.Fl b , -background
+.Fl b , Fl Fl background
 and
-.Fl w , -waitip
+.Fl w , Fl Fl waitip
 options.
 .Pp
 If a single interface is given then
 .Nm
 only works for that interface and runs as a separate instance.
 The
-.Fl w , -waitip
+.Fl w , Fl Fl waitip
 option is enabled in this instance to maintain compatibility with older
 versions.
 .Pp
@@ -159,7 +159,7 @@
 runs
 .Pa @SCRIPT@ ,
 or the script specified by the
-.Fl c , -script
+.Fl c , Fl Fl script
 option.
 This script runs each script found in
 .Pa @HOOKDIR@
@@ -171,7 +171,7 @@
 and
 .Pa 30-hostname .
 You can disable each script by using the
-.Fl C , -nohook
+.Fl C , Fl Fl nohook
 option.
 See
 .Xr dhcpcd-run-hooks 8
@@ -183,18 +183,36 @@
 .Nm
 with the following options:
 .Bl -tag -width indent
-.It Fl b , -background
+.It Fl b , Fl Fl background
 Background immediately.
 This is useful for startup scripts which don't disable link messages for
 carrier status.
-.It Fl c , -script Ar script
+.It Fl c , Fl Fl script Ar script
 Use this
 .Ar script
 instead of the default
 .Pa @SCRIPT@ .
-.It Fl d , -debug
+.It Fl D , Fl Fl duid
+Generate an
+.Li RFC 4361
+compliant clientid.
+This requires persistent storage and not all DHCP servers work with it so it
+is not enabled by default.
+.Nm
+generates the DUID and stores it in
+.Pa @SYSCONFDIR@/dhcpcd.duid .
+This file should not be copied to other hosts.
+.It Fl d , Fl Fl debug
 Echo debug messages to the stderr and syslog.
-.It Fl e , -env Ar value
+.It Fl E , Fl Fl lastlease
+If
+.Nm
+cannot obtain a lease, then try to use the last lease acquired for the
+interface.
+If the
+.Fl p, Fl Fl persistent
+option is not given then the lease is used if it hasn't expired.
+.It Fl e , Fl Fl env Ar value
 Push
 .Ar value
 to the environment for use in
@@ -202,7 +220,7 @@
 For example, you can force the hostname hook to always set the hostname with
 .Fl e
 .Va force_hostname=YES .
-.It Fl g , -reconfigure
+.It Fl g , Fl Fl reconfigure
 .Nm
 will re-apply IP address, routing and run
 .Xr dhcpcd-run-hooks 8
@@ -214,12 +232,23 @@
 .Nm
 does not read a new configuration when this happens - you should rebind if you
 need that functionality.
-.It Fl f , -config Ar file
+.It Fl F , Fl Fl fqdn Ar fqdn
+Requests that the DHCP server updates DNS using FQDN instead of just a
+hostname.
+Valid values for
+.Ar fqdn
+are disable, none, ptr and both.
+.Nm
+itself never does any DNS updates.
+.Nm
+encodes the FQDN hostname as specified in
+.Li RFC1035 .
+.It Fl f , Fl Fl config Ar file
 Specify a config to load instead of
 .Pa @SYSCONFDIR@/dhcpcd.conf .
 .Nm
 always processes the config file before any command line options.
-.It Fl h , -hostname Ar hostname
+.It Fl h , Fl Fl hostname Ar hostname
 Sends
 .Ar hostname
 to the DHCP server so it can be registered in DNS.
@@ -229,13 +258,25 @@
 If
 .Ar hostname
 is a FQDN (ie, contains a .) then it will be encoded as such.
-.It Fl i , -vendorclassid Ar vendorclassid
+.It Fl I , Fl Fl clientid Ar clientid
+Send the
+.Ar clientid .
+If the string is of the format 01:02:03 then it is encoded as hex.
+For interfaces whose hardware address is longer than 8 bytes, or if the
+.Ar clientid
+is an empty string then
+.Nm
+sends a default
+.Ar clientid
+of the hardware family and the hardware address.
+.It Fl i , Fl Fl vendorclassid Ar vendorclassid
 Override the
 .Ar vendorclassid
-field sent. The default is
+field sent.
+The default is
 dhcpcd <version>.
 If not set then none is sent.
-.It Fl k , -release
+.It Fl k , Fl Fl release
 This causes an existing
 .Nm
 process running on the
@@ -245,32 +286,32 @@
 and then exit.
 .Nm
 then waits until this process has exited.
-.It Fl l , -leasetime Ar seconds
+.It Fl l , Fl Fl leasetime Ar seconds
 Request a specific lease time in
 .Ar seconds .
 By default
 .Nm
 does not request any lease time and leaves it in the hands of the
 DHCP server.
-.It Fl m , -metric Ar metric
+.It Fl m , Fl Fl metric Ar metric
 Metrics are used to prefer an interface over another one, lowest wins.
 .Nm
 will supply a default metic of 200 +
 .Xr if_nametoindex 3 .
 An extra 100 will be added for wireless interfaces.
-.It Fl o , -option Ar option
-Request the DHCP
-.Ar option
-variable for use in
-.Pa @SCRIPT@ .
-.It Fl n , -rebind
+.It Fl n , Fl Fl rebind
 Notifies
 .Nm
 to reload its configuration and rebind its interfaces.
 If
 .Nm
 is not running, then it starts up as normal.
-.It Fl p , -persistent
+.It Fl o , Fl Fl option Ar option
+Request the DHCP
+.Ar option
+variable for use in
+.Pa @SCRIPT@ .
+.It Fl p , Fl Fl persistent
 .Nm
 normally de-configures the
 .Ar interface
@@ -278,7 +319,7 @@
 Sometimes, this isn't desirable if, for example, you have root mounted over
 NFS.
 You can use this option to stop this from happening.
-.It Fl r , -request Op Ar address
+.It Fl r , Fl Fl request Op Ar address
 Request the
 .Ar address
 in the DHCP DISCOVER message.
@@ -288,9 +329,9 @@
 is given then the first address currently assigned to the
 .Ar interface
 is used.
-.It Fl s , -inform Op Ar address Ns Op Ar /cidr
+.It Fl s , Fl Fl inform Op Ar address Ns Op Ar /cidr
 Behaves like
-.Fl r , -request
+.Fl r , Fl Fl request
 as above, but sends a DHCP INFORM instead of DISCOVER/REQUEST.