From: Roy Marples <roy@marples.name>
Date: Sat, 25 Jul 2009 17:57:49 +0000 (+0000)
Subject: Documentation updates.
X-Git-Tag: v5.1.0~25
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=35d02ae670d20ea28a4332011a01daac76e50cde;p=thirdparty%2Fdhcpcd.git

Documentation updates.
A few minor corrections, but mainly updates the expected behaviour for the hostname being sent.
---

diff --git a/dhcpcd.8.in b/dhcpcd.8.in
index 823be8dc..1f284a08 100644
--- a/dhcpcd.8.in
+++ b/dhcpcd.8.in
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd July 11, 2009
+.Dd July 25, 2009
 .Dt DHCPCD 8 SMM
 .Os
 .Sh NAME
@@ -126,10 +126,8 @@ metric, otherwise
 .Nm
 changes the routes to use the interface with the same route and the lowest
 metric.
-See options below for controlling what interfaces we allow and deny through
-the use of patterns. Also, see the BUGS section if
-.Nm
-runs on a BSD system.
+See options below for controlling which interfaces we allow and deny through
+the use of patterns.
 .Ss Hooking into DHCP events
 .Nm
 runs
@@ -169,7 +167,7 @@ Use this
 instead of the default
 .Pa @SCRIPT@ .
 .It Fl d , -debug
-Echo debug and informational messages to the console.
+Echo debug messages to the stderr and syslog.
 Subsequent debug options stop
 .Nm
 from daemonising.
@@ -179,7 +177,9 @@ will re-apply IP address, routing and run
 .Xr dhcpcd-run-hooks 8
 for each interface.
 This is useful so that a 3rd party such as PPP or VPN can change the routing
-table and / or DNS, etc and then instruct dhcpcd to put things back afterwards.
+table and / or DNS, etc and then instruct
+.Nm
+to put things back afterwards.
 .Nm
 does not read a new configuration when this happens - you should rebind if you
 need that functionality.
@@ -189,15 +189,15 @@ Specify a config to load instead of
 .Nm
 always processes the config file before any command line options.
 .It Fl h , -hostname Ar hostname
-By default,
-.Nm
-sends the current hostname to the DHCP server so it can register in DNS.
-You can use this option to specify the
+Sends
 .Ar hostname
-sent, or an empty string to
-stop any
+to the DHCP server so it can be registered in DNS.
+If
 .Ar hostname
-from being sent.
+is an empty string then the current system hostname is sent.
+If
+.Ar hostname
+is a FQDN (ie, contains a .) then it will be encoded as such.
 .It Fl i , -vendorclassid Ar vendorclassid
 Override the
 .Ar vendorclassid
@@ -265,7 +265,7 @@ You can use this option to stop this from happening.
 normally sends a DHCP DISCOVER to find servers to offer an address.
 .Nm
 then requests the address used.
-You can use this option to skip the BROADCAST step and just request the
+You can use this option to skip the DISCOVER phase and just request the
 .Ar address .
 The downside is if you request an
 .Ar address
@@ -347,7 +347,7 @@ This requires persistent storage and not all DHCP servers work with it so it's
 not enabled by default.
 .Nm
 generates the DUID and stores in it
-.Pa @SYSCONFDIR@/dhcpcd.duid
+.Pa @SYSCONFDIR@/dhcpcd.duid .
 This file should not be copied to other hosts.
 .It Fl E , -lastlease
 If
@@ -539,10 +539,3 @@ RFC 3397, RFC 3442, RFC 3927, RFC 4361, RFC 4390, RFC 4702.
 .An Roy Marples Aq roy@marples.name
 .Sh BUGS
 Please report them to http://roy.marples.name/projects/dhcpcd
-.Pp
-.Nm
-does not wait for commands to complete when sending them to the master
-.Nm
-process, nor does it echo its progress to stderr.
-This is a behaviour change from dhcpcd-4 and may need to be addressed if
-there is sufficient need.
diff --git a/dhcpcd.conf.5.in b/dhcpcd.conf.5.in
index c9efad72..a605ef8b 100644
--- a/dhcpcd.conf.5.in
+++ b/dhcpcd.conf.5.in
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd July 5, 2009
+.Dd July 25, 2009
 .Dt DHCPCD.CONF 5 SMM
 .Os
 .Sh NAME
@@ -109,11 +109,15 @@ and should not be copied to other hosts.
 Fallback to using this profile if DHCP fails.
 This allows you to configure a static profile instead of using ZeroConf.
 .It Ic hostname Ar name
-Sends specified
+Sends
 .Ar hostname
-to the DHCP server so it can be registered in DNS. If
+to the DHCP server so it can be registered in DNS.
+If
+.Ar hostname
+is an empty string then the current system hostname is sent.
+If
 .Ar hostname
-if a FQDN (ie, contains a .) then it will be encoded as such.
+is a FQDN (ie, contains a .) then it will be encoded as such.
 .It Ic fqdn Op none | ptr | both
 none disables FQDN encoding, ptr just asks the DHCP server to update the PTR
 record of the host in DNS whereas both also updates the A record.