rsync-ssl.yo

   1 mailto(rsync-bugs@samba.org)
   2 manpage(rsync-ssl)(1)(22 Apr 2020)()()
   3 manpagename(rsync-ssl)(a helper script for connecting to an ssl rsync daemon)
   4 manpagesynopsis()
   5
   6 verb(rsync-ssl [--type=openssl|stunnel] RSYNC_ARGS)
   7
   8 manpagedescription()
   9
  10 The rsync-ssl script helps you to run an rsync copy to/from an rsync daemon
  11 that requires ssl connections.
  12
  13 If the bf(first) arg is a bf(--type=NAME) option, the script will only use that
  14 particular program to open an ssl connection instead of trying to find an
  15 stunnel or openssl executable via a simple heuristic (assuming that the
  16 bf(RSYNC_SSL_TYPE) environment variable is not set as well -- see below).  This
  17 option must be one of bf(--type=openssl) or bf(--type=stunnel).  The equal sign
  18 is required for this particular option.
  19
  20 All the other options are passed through to the rsync command, so consult the
  21 bf(rsync) manpage for more information on how it works.
  22
  23 Note that the stunnel connection type requires at least version 4 of stunnel,
  24 which should be the case on modern systems.
  25
  26 manpagesection(ENVIRONMENT VARIABLES)
  27
  28 The ssl helper scripts are affected by the following environment variables:
  29
  30 description(
  31
  32 dit(bf(RSYNC_SSL_TYPE)) Specifies the program type that should be used to open
  33 the ssl connection.  It must be one of "openssl" or "stunnel".  The
  34 bf(--type=NAME) option overrides this, if specified.
  35
  36 dit(bf(RSYNC_SSL_PORT)) If specified, the value is the port number that is used
  37 as the default when the user does not specify a port in their rsync command.
  38 When not specified, the default port number is 874.  (Note that older rsync
  39 versions (prior to 3.2.0) did not communicate an overriding port number value
  40 to the helper script.)
  41
  42 dit(bf(RSYNC_SSL_CERT)) If specified, the value is a filename that contains a
  43 certificate to use for the connection.
  44
  45 dit(bf(RSYNC_SSL_CA_CERT)) If specified, the value is a filename that contains
  46 a certificate authority certificate that is used to validate the connection.
  47
  48 dit(bf(RSYNC_SSL_STUNNEL)) Specifies the stunnel executable to run when the
  49 connection type is set to stunnel.  If unspecified, the $PATH is searched first
  50 for "stunnel4" and then for "stunnel".
  51
  52 dit(bf(RSYNC_SSL_OPENSSL)) Specifies the openssl executable to run when the
  53 connection type is set to openssl.  If unspecified, the $PATH is searched for
  54 "openssl".
  55
  56 )
  57
  58 manpagesection(EXAMPLES)
  59
  60 verb(    rsync-ssl -aiv example.com::src/ dest)
  61
  62 verb(    rsync-ssl --type=openssl -aiv example.com::src/ dest)
  63
  64 manpageauthor()
  65
  66 This manpage was written by Wayne Davison.
  67
  68 Mailing lists for support and development are available at
  69 url(http://lists.samba.org)(lists.samba.org)