rsync.1

Rsync 3.0.5 source code

You may also establish a daemon connection using a program as a proxy by
setting the environment variable RSYNC_CONNECT_PROG to the commands you
wish to run in place of making a direct socket connection.  The string may
contain the escape \(lq%H\(rq to represent the hostname specified in the rsync
command (so use \(lq%%\(rq if you need a single \(lq%\(rq in your string).  For
example:
.PP 
.nf 
  export RSYNC_CONNECT_PROG='ssh proxyhost nc %H 873'
  rsync \-av targethost1::module/src/ /dest/
  rsync \-av rsync:://targethost2/module/src/ /dest/ 
.fi 

.PP 
The command specified above uses ssh to run nc (netcat) on a proxyhost,
which forwards all data to port 873 (the rsync daemon) on the targethost
(%H).
.PP 
.SH "USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION"

.PP 
It is sometimes useful to use various features of an rsync daemon (such as
named modules) without actually allowing any new socket connections into a
system (other than what is already required to allow remote-shell access).
Rsync supports connecting to a host using a remote shell and then spawning
a single-use \(lqdaemon\(rq server that expects to read its config file in the
home dir of the remote user.  This can be useful if you want to encrypt a
daemon-style transfer's data, but since the daemon is started up fresh by
the remote user, you may not be able to use features such as chroot or
change the uid used by the daemon.  (For another way to encrypt a daemon
transfer, consider using ssh to tunnel a local port to a remote machine and
configure a normal rsync daemon on that remote host to only allow
connections from \(lqlocalhost\(rq.)
.PP 
From the user's perspective, a daemon transfer via a remote-shell
connection uses nearly the same command-line syntax as a normal
rsync-daemon transfer, with the only exception being that you must
explicitly set the remote shell program on the command-line with the
\fB\-\-rsh=COMMAND\fP option.  (Setting the RSYNC_RSH in the environment
will not turn on this functionality.)  For example:
.PP 
.nf 
    rsync \-av \-\-rsh=ssh host::module /dest
.fi 

.PP 
If you need to specify a different remote-shell user, keep in mind that the
user@ prefix in front of the host is specifying the rsync-user value (for a
module that requires user-based authentication).  This means that you must
give the '\-l user' option to ssh when specifying the remote-shell, as in
this example that uses the short version of the \fB\-\-rsh\fP option:
.PP 
.nf 
    rsync \-av \-e "ssh \-l ssh-user" rsync-user@host::module /dest
.fi 

.PP 
The \(lqssh-user\(rq will be used at the ssh level; the \(lqrsync-user\(rq will be
used to log-in to the \(lqmodule\(rq.
.PP 
.SH "STARTING AN RSYNC DAEMON TO ACCEPT CONNECTIONS"

.PP 
In order to connect to an rsync daemon, the remote system needs to have a
daemon already running (or it needs to have configured something like inetd
to spawn an rsync daemon for incoming connections on a particular port).
For full information on how to start a daemon that will handling incoming
socket connections, see the \fBrsyncd.conf\fP(5) man page \(em that is the config
file for the daemon, and it contains the full details for how to run the
daemon (including stand-alone and inetd configurations).
.PP 
If you're using one of the remote-shell transports for the transfer, there is
no need to manually start an rsync daemon.
.PP 
.SH "EXAMPLES"

.PP 
Here are some examples of how I use rsync.
.PP 
To backup my wife's home directory, which consists of large MS Word
files and mail folders, I use a cron job that runs
.PP 
.RS 
\f(CWrsync \-Cavz . arvidsjaur:backup\fP
.RE

.PP 
each night over a PPP connection to a duplicate directory on my machine
\(lqarvidsjaur\(rq.
.PP 
To synchronize my samba source trees I use the following Makefile
targets:
.PP 
.nf 
    get:
            rsync \-avuzb \-\-exclude '*~' samba:samba/ .
    put:
            rsync \-Cavuzb . samba:samba/
    sync: get put
.fi 

.PP 
this allows me to sync with a CVS directory at the other end of the
connection. I then do CVS operations on the remote machine, which saves a
lot of time as the remote CVS protocol isn't very efficient.
.PP 
I mirror a directory between my \(lqold\(rq and \(lqnew\(rq ftp sites with the
command:
.PP 
\f(CWrsync \-az \-e ssh \-\-delete ~ftp/pub/samba nimbus:"~ftp/pub/tridge"\fP
.PP 
This is launched from cron every few hours.
.PP 
.SH "OPTIONS SUMMARY"

.PP 
Here is a short summary of the options available in rsync. Please refer
to the detailed description below for a complete description.  
.nf 

 \-v, \-\-verbose               increase verbosity
 \-q, \-\-quiet                 suppress non-error messages
     \-\-no\-motd               suppress daemon-mode MOTD (see caveat)
 \-c, \-\-checksum              skip based on checksum, not mod-time & size
 \-a, \-\-archive               archive mode; equals \-rlptgoD (no \-H,\-A,\-X)
     \-\-no\-OPTION             turn off an implied OPTION (e.g. \-\-no\-D)
 \-r, \-\-recursive             recurse into directories
 \-R, \-\-relative              use relative path names
     \-\-no\-implied\-dirs       don't send implied dirs with \-\-relative
 \-b, \-\-backup                make backups (see \-\-suffix & \-\-backup\-dir)
     \-\-backup\-dir=DIR        make backups into hierarchy based in DIR
     \-\-suffix=SUFFIX         backup suffix (default ~ w/o \-\-backup\-dir)
 \-u, \-\-update                skip files that are newer on the receiver
     \-\-inplace               update destination files in-place
     \-\-append                append data onto shorter files
     \-\-append\-verify         \-\-append w/old data in file checksum
 \-d, \-\-dirs                  transfer directories without recursing
 \-l, \-\-links                 copy symlinks as symlinks
 \-L, \-\-copy\-links            transform symlink into referent file/dir
     \-\-copy\-unsafe\-links     only "unsafe" symlinks are transformed
     \-\-safe\-links            ignore symlinks that point outside the tree
 \-k, \-\-copy\-dirlinks         transform symlink to dir into referent dir
 \-K, \-\-keep\-dirlinks         treat symlinked dir on receiver as dir
 \-H, \-\-hard\-links            preserve hard links
 \-p, \-\-perms                 preserve permissions
 \-E, \-\-executability         preserve executability
     \-\-chmod=CHMOD           affect file and/or directory permissions
 \-A, \-\-acls                  preserve ACLs (implies \-p)
 \-X, \-\-xattrs                preserve extended attributes
 \-o, \-\-owner                 preserve owner (super-user only)
 \-g, \-\-group                 preserve group
     \-\-devices               preserve device files (super-user only)
     \-\-specials              preserve special files
 \-D                          same as \-\-devices \-\-specials
 \-t, \-\-times                 preserve modification times
 \-O, \-\-omit\-dir\-times        omit directories from \-\-times
     \-\-super                 receiver attempts super-user activities
     \-\-fake\-super            store/recover privileged attrs using xattrs
 \-S, \-\-sparse                handle sparse files efficiently
 \-n, \-\-dry\-run               perform a trial run with no changes made
 \-W, \-\-whole\-file            copy files whole (w/o delta-xfer algorithm)
 \-x, \-\-one\-file\-system       don't cross filesystem boundaries
 \-B, \-\-block\-size=SIZE       force a fixed checksum block-size
 \-e, \-\-rsh=COMMAND           specify the remote shell to use
     \-\-rsync\-path=PROGRAM    specify the rsync to run on remote machine
     \-\-existing              skip creating new files on receiver
     \-\-ignore\-existing       skip updating files that exist on receiver
     \-\-remove\-source\-files   sender removes synchronized files (non-dir)
     \-\-del                   an alias for \-\-delete\-during
     \-\-delete                delete extraneous files from dest dirs
     \-\-delete\-before         receiver deletes before transfer (default)
     \-\-delete\-during         receiver deletes during xfer, not before
     \-\-delete\-delay          find deletions during, delete after
     \-\-delete\-after          receiver deletes after transfer, not before
     \-\-delete\-excluded       also delete excluded files from dest dirs
     \-\-ignore\-errors         delete even if there are I/O errors
     \-\-force                 force deletion of dirs even if not empty
     \-\-max\-delete=NUM        don't delete more than NUM files
     \-\-max\-size=SIZE         don't transfer any file larger than SIZE
     \-\-min\-size=SIZE         don't transfer any file smaller than SIZE
     \-\-partial               keep partially transferred files
     \-\-partial\-dir=DIR       put a partially transferred file into DIR
     \-\-delay\-updates         put all updated files into place at end
 \-m, \-\-prune\-empty\-dirs      prune empty directory chains from file-list
     \-\-numeric\-ids           don't map uid/gid values by user/group name
     \-\-timeout=SECONDS       set I/O timeout in seconds
     \-\-contimeout=SECONDS    set daemon connection timeout in seconds
 \-I, \-\-ignore\-times          don't skip files that match size and time
     \-\-size\-only             skip files that match in size
     \-\-modify\-window=NUM     compare mod-times with reduced accuracy
 \-T, \-\-temp\-dir=DIR          create temporary files in directory DIR
 \-y, \-\-fuzzy                 find similar file for basis if no dest file
     \-\-compare\-dest=DIR      also compare received files relative to DIR
     \-\-copy\-dest=DIR         ... and include copies of unchanged files
     \-\-link\-dest=DIR         hardlink to files in DIR when unchanged
 \-z, \-\-compress              compress file data during the transfer
     \-\-compress\-level=NUM    explicitly set compression level
     \-\-skip\-compress=LIST    skip compressing files with suffix in LIST
 \-C, \-\-cvs\-exclude           auto-ignore files in the same way CVS does
 \-f, \-\-filter=RULE           add a file-filtering RULE
 \-F                          same as \-\-filter='dir-merge /.rsync\-filter'
                             repeated: \-\-filter='\- .rsync\-filter'
     \-\-exclude=PATTERN       exclude files matching PATTERN
     \-\-exclude\-from=FILE     read exclude patterns from FILE
     \-\-include=PATTERN       don't exclude files matching PATTERN
     \-\-include\-from=FILE     read include patterns from FILE
     \-\-files\-from=FILE       read list of source-file names from FILE
 \-0, \-\-from0                 all *from/filter files are delimited by 0s
 \-s, \-\-protect\-args          no space-splitting; wildcard chars only
     \-\-address=ADDRESS       bind address for outgoing socket to daemon
     \-\-port=PORT             specify double-colon alternate port number
     \-\-sockopts=OPTIONS      specify custom TCP options
     \-\-blocking\-io           use blocking I/O for the remote shell
     \-\-stats                 give some file-transfer stats
 \-8, \-\-8\-bit\-output          leave high-bit chars unescaped in output
 \-h, \-\-human\-readable        output numbers in a human-readable format
     \-\-progress              show progress during transfer
 \-P                          same as \-\-partial \-\-progress
 \-i, \-\-itemize\-changes       output a change-summary for all updates
     \-\-out\-format=FORMAT     output updates using the specified FORMAT
     \-\-log\-file=FILE         log what we're doing to the specified FILE
     \-\-log\-file\-format=FMT   log updates using the specified FMT
     \-\-password\-file=FILE    read daemon-access password from FILE
     \-\-list\-only             list the files instead of copying them
     \-\-bwlimit=KBPS          limit I/O bandwidth; KBytes per second
     \-\-write\-batch=FILE      write a batched update to FILE
     \-\-only\-write\-batch=FILE like \-\-write\-batch but w/o updating dest
     \-\-read\-batch=FILE       read a batched update from FILE
     \-\-protocol=NUM          force an older protocol version to be used
     \-\-iconv=CONVERT_SPEC    request charset conversion of filenames
     \-\-checksum\-seed=NUM     set block/file checksum seed (advanced)
 \-4, \-\-ipv4                  prefer IPv4
 \-6, \-\-ipv6                  prefer IPv6
     \-\-version               print version number
(\-h) \-\-help                  show this help (see below for \-h comment)
.fi 

.PP 
Rsync can also be run as a daemon, in which case the following options are
accepted: 
.nf 

     \-\-daemon                run as an rsync daemon
     \-\-address=ADDRESS       bind to the specified address
     \-\-bwlimit=KBPS          limit I/O bandwidth; KBytes per second
     \-\-config=FILE           specify alternate rsyncd.conf file
     \-\-no\-detach             do not detach from the parent
     \-\-port=PORT             listen on alternate port number
     \-\-log\-file=FILE         override the "log file" setting
     \-\-log\-file\-format=FMT   override the "log format" setting
     \-\-sockopts=OPTIONS      specify custom TCP options
 \-v, \-\-verbose               increase verbosity
 \-4, \-\-ipv4                  prefer IPv4
 \-6, \-\-ipv6                  prefer IPv6
 \-h, \-\-help                  show this help (if used after \-\-daemon)
.fi 

.PP 
.SH "OPTIONS"

.PP 
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 \(oq=\(cq for options that take a parameter is optional; whitespace
can be used instead.
.PP 
.IP "\fB\-\-help\fP"
Print a short help page describing the options
available in rsync and exit.  For backward-compatibility with older
versions of rsync, the help will also be output if you use the \fB\-h\fP
option without any other args.
.IP 
.IP "\fB\-\-version\fP"