From: Wayne Davison <wayned@samba.org>
Date: Sat, 27 Aug 2011 17:07:28 +0000 (-0700)
Subject: Some option-parsing clarifiation in the intro.
X-Git-Tag: v3.1.0pre1~92
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a05758fde647e1d1b36446ca09afbb9433799920;p=thirdparty%2Frsync.git

Some option-parsing clarifiation in the intro.
---

diff --git a/rsync.yo b/rsync.yo
index 3174ca37..96e26344 100644
--- a/rsync.yo
+++ b/rsync.yo
@@ -463,11 +463,17 @@ accepted: verb(
 
 manpageoptions()
 
-rsync uses the GNU long options package. Many of the command line
-options have two variants, one short and one long.  These are shown
-below, separated by commas. Some options only have a long variant.
-The '=' for options that take a parameter is optional; whitespace
-can be used instead.
+Rsync accepts both long (double-dash + word) and short (single-dash + letter)
+options.  The full list of the available options are described below.  If an
+option can be specified in more than one way, the choices are comma-separated.
+Some options only have a long variant, not a short.  If the option takes a
+parameter, the parameter is only listed after the long variant, even though it
+must also be specified for the short.  When specifying a parameter, you can
+either use the form --option=param or replace the '=' with whitespace.  The
+parameter may need to be quoted in some manner for it to survive the shell's
+command-line parsing.  Keep in mind that a leading tilde (~) in a filename is
+substituted by your shell, so --option=~/foo will not change the tilde into
+your home directory (remove the '=' for that).
 
 startdit()
 dit(bf(--help)) Print a short help page describing the options