Annotation of embedaddon/rsync/rsync-ssl.1.html, revision 1.1.1.1
1.1 misho 1: <html><head>
2: <title>rsync-ssl(1) man page</title>
3: <link href="https://fonts.googleapis.com/css2?family=Roboto&family=Roboto+Mono&display=swap" rel="stylesheet">
4: <style>
5: body {
6: max-width: 50em;
7: margin: auto;
8: }
9: body, b, strong, u {
10: font-family: 'Roboto', sans-serif;
11: }
12: code {
13: font-family: 'Roboto Mono', monospace;
14: font-weight: bold;
15: white-space: pre;
16: }
17: pre code {
18: display: block;
19: font-weight: normal;
20: }
21: blockquote pre code {
22: background: #f1f1f1;
23: }
24: dd p:first-of-type {
25: margin-block-start: 0em;
26: }
27: </style>
28: </head><body>
29: <h1>NAME</h1>
30: <p>rsync-ssl -⁠ a helper script for connecting to an ssl rsync daemon</p>
31: <h1>SYNOPSIS</h1>
32: <pre><code>rsync-ssl [--type=SSL_TYPE] RSYNC_ARGS
33: </code></pre>
34: <h1>DESCRIPTION</h1>
35: <p>The rsync-ssl script helps you to run an rsync copy to/from an rsync daemon
36: that requires ssl connections.</p>
37: <p>The script requires that you specify an rsync-daemon arg in the style of either
38: <code>hostname::</code> (with 2 colons) or <code>rsync://hostname/</code>. The default port used for
39: connecting is 874 (one higher than the normal 873) unless overridden in the
40: environment. You can specify an overriding port via <code>--port</code> or by including
41: it in the normal spot in the URL format, though both of those require your
42: rsync version to be at least 3.2.0.</p>
43: <h1>OPTIONS</h1>
44: <p>If the <strong>first</strong> arg is a <code>--type=SSL_TYPE</code> option, the script will only use
45: that particular program to open an ssl connection instead of trying to find an
46: openssl or stunnel executable via a simple heuristic (assuming that the
47: <code>RSYNC_SSL_TYPE</code> environment variable is not set as well -⁠-⁠ see below). This
48: option must specify one of <code>openssl</code> or <code>stunnel</code>. The equal sign is
49: required for this particular option.</p>
50: <p>All the other options are passed through to the rsync command, so consult the
51: <strong>rsync</strong>(1) manpage for more information on how it works.</p>
52: <h1>ENVIRONMENT VARIABLES</h1>
53: <p>The ssl helper scripts are affected by the following environment variables:</p>
54: <dl>
55: <dt><code>RSYNC_SSL_TYPE</code></dt><dd> Specifies the program type that should be used to open the
56: ssl connection. It must be one of <code>openssl</code> or <code>stunnel</code>. The
57: <code>--type=SSL_TYPE</code> option overrides this, when specified.</dd>
58: <dt><code>RSYNC_SSL_PORT</code></dt><dd> If specified, the value is the port number that is used as
59: the default when the user does not specify a port in their rsync command.
60: When not specified, the default port number is 874. (Note that older rsync
61: versions (prior to 3.2.0) did not communicate an overriding port number
62: value to the helper script.)</dd>
63: <dt><code>RSYNC_SSL_CERT</code></dt><dd> If specified, the value is a filename that contains a
64: certificate to use for the connection.</dd>
65: <dt><code>RSYNC_SSL_CA_CERT</code></dt><dd> If specified, the value is a filename that contains a
66: certificate authority certificate that is used to validate the connection.</dd>
67: <dt><code>RSYNC_SSL_OPENSSL</code></dt><dd> Specifies the openssl executable to run when the
68: connection type is set to openssl. If unspecified, the $PATH is searched
69: for "openssl".</dd>
70: <dt><code>RSYNC_SSL_GNUTLS</code></dt><dd> Specifies the gnutls-cli executable to run when the
71: connection type is set to gnutls. If unspecified, the $PATH is searched
72: for "gnutls-cli".</dd>
73: <dt><code>RSYNC_SSL_STUNNEL</code></dt><dd> Specifies the stunnel executable to run when the
74: connection type is set to stunnel. If unspecified, the $PATH is searched
75: first for "stunnel4" and then for "stunnel".</dd>
76: </dl>
77: <h1>EXAMPLES</h1>
78: <blockquote>
79: <pre><code>rsync-ssl -aiv example.com::mod/ dest
80: </code></pre>
81: </blockquote>
82: <blockquote>
83: <pre><code>rsync-ssl --type=openssl -aiv example.com::mod/ dest
84: </code></pre>
85: </blockquote>
86: <blockquote>
87: <pre><code>rsync-ssl -aiv --port 9874 example.com::mod/ dest
88: </code></pre>
89: </blockquote>
90: <blockquote>
91: <pre><code>rsync-ssl -aiv rsync://example.com:9874/mod/ dest
92: </code></pre>
93: </blockquote>
94: <h1>SEE ALSO</h1>
95: <p><strong>rsync</strong>(1), <strong>rsyncd.conf</strong>(5)</p>
96: <h1>CAVEATS</h1>
97: <p>Note that using an stunnel connection requires at least version 4 of stunnel,
98: which should be the case on modern systems. Also, it does not verify a
99: connection against the CA certificate collection, so it only encrypts the
100: connection without any cert validation unless you have specified the
101: certificate environment options.</p>
102: <p>This script also supports a <code>--type=gnutls</code> option, but at the time of this
103: release the gnutls-cli command was dropping output, making it unusable. If
104: that bug has been fixed in your version, feel free to put gnutls into an
105: exported RSYNC_SSL_TYPE environment variable to make its use the default.</p>
106: <h1>BUGS</h1>
107: <p>Please report bugs! See the web site at <a href="https://rsync.samba.org/">https://rsync.samba.org/</a>.</p>
108: <h1>VERSION</h1>
109: <p>This man page is current for version 3.2.3 of rsync.</p>
110: <h1>CREDITS</h1>
111: <p>rsync is distributed under the GNU General Public License. See the file
112: COPYING for details.</p>
113: <p>A web site is available at <a href="https://rsync.samba.org/">https://rsync.samba.org/</a>. The site includes an
114: FAQ-O-Matic which may cover questions unanswered by this manual page.</p>
115: <h1>AUTHOR</h1>
116: <p>This manpage was written by Wayne Davison.</p>
117: <p>Mailing lists for support and development are available at
118: <a href="https://lists.samba.org/">https://lists.samba.org/</a>.</p>
119: <div style="float: right"><p><i>06 Aug 2020</i></p></div>
120: </body></html>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to rsync-ssl.1.html CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / rsync