From: Wayne Davison <wayne@opencoder.net>
Date: Wed, 17 Jun 2020 18:25:38 +0000 (-0700)
Subject: A few minor man page improvements.
X-Git-Tag: v3.2.0~19
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7dc9431f60b358620b4a2f8ba105a5732028c545;p=thirdparty%2Frsync.git

A few minor man page improvements.
---

diff --git a/rsync-ssl.1.md b/rsync-ssl.1.md
index c2903425..31cb465f 100644
--- a/rsync-ssl.1.md
+++ b/rsync-ssl.1.md
@@ -13,6 +13,13 @@ rsync-ssl [--type=SSL_TYPE] RSYNC_ARGS
 The rsync-ssl script helps you to run an rsync copy to/from an rsync daemon
 that requires ssl connections.
 
+The script requires that you specify an rsync-daemon arg in the style of either
+`hostname::` (with 2 colons) or `rsync://hostname/`.  The default port used for
+connecting is 874 (one higher than the normal 873) unless overridden in the
+environment.  You can specify an overriding port via `--port` or by including
+it in the normal spot in the URL format, though both of those require your
+rsync version to be at least 3.2.0.
+
 # OPTIONS
 
 If the **first** arg is a `--type=SSL_TYPE` option, the script will only use
@@ -23,7 +30,7 @@ option must specify one of `openssl` or `stunnel`.  The equal sign is
 required for this particular option.
 
 All the other options are passed through to the rsync command, so consult the
-**rsync** manpage for more information on how it works.
+**rsync**(1) manpage for more information on how it works.
 
 # ENVIRONMENT VARIABLES
 
@@ -53,9 +60,13 @@ The ssl helper scripts are affected by the following environment variables:
 
 # EXAMPLES
 
->     rsync-ssl -aiv example.com::src/ dest
+>     rsync-ssl -aiv example.com::mod/ dest
+
+>     rsync-ssl --type=openssl -aiv example.com::mod/ dest
+
+>     rsync-ssl -aiv --port 9874 example.com::mod/ dest
 
->     rsync-ssl --type=openssl -aiv example.com::src/ dest
+>     rsync-ssl -aiv rsync://example.com:9874/mod/ dest
 
 # SEE ALSO