{
    "content": [
        {
            "type": "text",
            "text": "# rsync-ssl(1) (man)\n\n**Summary:** rsync-ssl - a helper script for connecting to an ssl rsync daemon\n\n**Synopsis:** rsync-ssl [--type=SSLTYPE] RSYNCARGS\nThe  online  version  of this manpage (that includes cross-linking of topics) is available at\nhttps://download.samba.org/pub/rsync/rsync-ssl.1.\n\n## Examples\n\n- `rsync-ssl -aiv example.com::mod/ dest`\n- `rsync-ssl --type=openssl -aiv example.com::mod/ dest`\n- `rsync-ssl -aiv --port 9874 example.com::mod/ dest`\n- `rsync-ssl -aiv rsync://example.com:9874/mod/ dest`\n\n## See Also\n\n- rsync(1)\n- rsyncd.conf(5)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (5 lines)\n- **DESCRIPTION** (9 lines)\n- **OPTIONS** (9 lines)\n- **ENVIRONMENT VARIABLES** (36 lines)\n- **EXAMPLES** (8 lines)\n- **THE SERVER SIDE** (2 lines)\n- **SEE ALSO** (2 lines)\n- **CAVEATS** (10 lines)\n- **BUGS** (2 lines)\n- **VERSION** (2 lines)\n- **CREDITS** (5 lines)\n- **AUTHOR** (7 lines)\n\n## Full Content\n\n### NAME\n\nrsync-ssl - a helper script for connecting to an ssl rsync daemon\n\n### SYNOPSIS\n\nrsync-ssl [--type=SSLTYPE] RSYNCARGS\n\nThe  online  version  of this manpage (that includes cross-linking of topics) is available at\nhttps://download.samba.org/pub/rsync/rsync-ssl.1.\n\n### DESCRIPTION\n\nThe rsync-ssl script helps you to run an rsync copy to/from an rsync daemon that requires ssl\nconnections.\n\nThe  script  requires  that you specify an rsync-daemon arg in the style of either hostname::\n(with 2 colons) or rsync://hostname/.  The default port  used  for  connecting  is  874  (one\nhigher  than  the normal 873) unless overridden in the environment.  You can specify an over‐\nriding port via --port or by including it in the normal spot in the URL format,  though  both\nof those require your rsync version to be at least 3.2.0.\n\n### OPTIONS\n\nIf  the  first arg is a --type=SSLTYPE option, the script will only use that particular pro‐\ngram to open an ssl connection instead of trying to find an openssl or stunnel executable via\na  simple  heuristic  (assuming  that  the  RSYNCSSLTYPE environment variable is not set as\nwell -- see below).  This option must specify one of openssl or stunnel.  The equal  sign  is\nrequired for this particular option.\n\nAll  the  other options are passed through to the rsync command, so consult the rsync(1) man‐\npage for more information on how it works.\n\n### ENVIRONMENT VARIABLES\n\nThe ssl helper scripts are affected by the following environment variables:\n\nRSYNCSSLTYPE\nSpecifies the program type that should be used to open the ssl connection.  It must be\none of openssl or stunnel.  The --type=SSLTYPE option overrides this, when specified.\n\nRSYNCSSLPORT\nIf  specified,  the value is the port number that is used as the default when the user\ndoes not specify a port in their rsync command.  When not specified, the default  port\nnumber  is  874.  (Note that older rsync versions (prior to 3.2.0) did not communicate\nan overriding port number value to the helper script.)\n\nRSYNCSSLCERT\nIf specified, the value is a filename that contains a certificate to use for the  con‐\nnection.\n\nRSYNCSSLKEY\nIf specified, the value is a filename that contains a key for the provided certificate\nto use for the connection.\n\nRSYNCSSLCACERT\nIf specified, the value is a filename that contains a certificate  authority  certifi‐\ncate that is used to validate the connection.\n\nRSYNCSSLOPENSSL\nSpecifies  the  openssl  executable to run when the connection type is set to openssl.\nIf unspecified, the $PATH is searched for \"openssl\".\n\nRSYNCSSLGNUTLS\nSpecifies the gnutls-cli executable to run when the connection type is set to  gnutls.\nIf unspecified, the $PATH is searched for \"gnutls-cli\".\n\nRSYNCSSLSTUNNEL\nSpecifies  the  stunnel  executable to run when the connection type is set to stunnel.\nIf unspecified, the $PATH is searched first for \"stunnel4\" and then for \"stunnel\".\n\n### EXAMPLES\n\nrsync-ssl -aiv example.com::mod/ dest\n\nrsync-ssl --type=openssl -aiv example.com::mod/ dest\n\nrsync-ssl -aiv --port 9874 example.com::mod/ dest\n\nrsync-ssl -aiv rsync://example.com:9874/mod/ dest\n\n### THE SERVER SIDE\n\nFor help setting up an SSL/TLS supporting rsync, see the instructions in rsyncd.conf.\n\n### SEE ALSO\n\nrsync(1), rsyncd.conf(5)\n\n### CAVEATS\n\nNote that using an stunnel connection requires at least version 4 of stunnel, which should be\nthe case on modern systems.  Also, it does not verify a connection against the CA certificate\ncollection, so it only encrypts the connection without any cert validation  unless  you  have\nspecified the certificate environment options.\n\nThis script also supports a --type=gnutls option, but at the time of this release the gnutls-\ncli command was dropping output, making it unusable.  If that bug has been fixed in your ver‐\nsion,  feel  free  to put gnutls into an exported RSYNCSSLTYPE environment variable to make\nits use the default.\n\n### BUGS\n\nPlease report bugs! See the web site at https://rsync.samba.org/.\n\n### VERSION\n\nThis manpage is current for version 3.2.7 of rsync.\n\n### CREDITS\n\nRsync is distributed under the GNU General Public License.  See the file COPYING for details.\n\nA web site is available at https://rsync.samba.org/.  The site includes an FAQ-O-Matic  which\nmay cover questions unanswered by this manual page.\n\n### AUTHOR\n\nThis manpage was written by Wayne Davison.\n\nMailing lists for support and development are available at https://lists.samba.org/.\n\n\n\nrsync-ssl from rsync 3.2.7                   20 Oct 2022                                rsync-ssl(1)\n\n"
        }
    ],
    "structuredContent": {
        "command": "rsync-ssl",
        "section": "1",
        "mode": "man",
        "summary": "rsync-ssl - a helper script for connecting to an ssl rsync daemon",
        "synopsis": "rsync-ssl [--type=SSLTYPE] RSYNCARGS\nThe  online  version  of this manpage (that includes cross-linking of topics) is available at\nhttps://download.samba.org/pub/rsync/rsync-ssl.1.",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [
            "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 -aiv rsync://example.com:9874/mod/ dest"
        ],
        "see_also": [
            {
                "name": "rsync",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/rsync/1/json"
            },
            {
                "name": "rsyncd.conf",
                "section": "5",
                "url": "https://www.chedong.com/phpMan.php/man/rsyncd.conf/5/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "ENVIRONMENT VARIABLES",
                "lines": 36,
                "subsections": []
            },
            {
                "name": "EXAMPLES",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "THE SERVER SIDE",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "CAVEATS",
                "lines": 10,
                "subsections": []
            },
            {
                "name": "BUGS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "VERSION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "CREDITS",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 7,
                "subsections": []
            }
        ]
    }
}