mailto(rsync-bugs@samba.org)
-manpage(rsync)(1)(26 Jan 2003)()()
+manpage(rsync)(1)(1 Jan 2004)()()
manpagename(rsync)(faster, flexible replacement for rcp)
manpagesynopsis()
it() support for copying links, devices, owners, groups and permissions
it() exclude and exclude-from options similar to GNU tar
it() a CVS exclude mode for ignoring the same files that CVS would ignore
- it() can use any transparent remote shell, including rsh or ssh
+ it() can use any transparent remote shell, including ssh or rsh
it() does not require root privileges
it() pipelining of file transfers to minimize latency costs
it() support for anonymous or authenticated rsync servers (ideal for
source nor destination path contains a : separator
it() for copying from the local machine to a remote machine using
- a remote shell program as the transport (such as rsh or
- ssh). This is invoked when the destination path contains a
+ a remote shell program as the transport (such as ssh or
+ rsh). This is invoked when the destination path contains a
single : separator.
it() for copying from a remote machine to the local machine
using a remote shell program as the transport, using rsync
server on the remote machine. This is invoked when the
destination path contains a :: separator and the
- --rsh=COMMMAND option is also provided.
+ --rsh=COMMAND option is also provided.
it() for listing files on a remote machine. This is done the
same way as rsync transfers except that you leave off the
Once installed, you can use rsync to any machine that you can access via
a remote shell (as well as some that you can access using the rsync
-daemon-mode protocol). For remote transfers, rsync typically uses rsh
+daemon-mode protocol). For remote transfers, a modern rsync uses ssh
for its communications, but it may have been configured to use a
-different remote shell by default, such as ssh.
+different remote shell by default, such as rsh or remsh.
You can also specify any remote shell you like, either by using the -e
command line option, or by setting the RSYNC_RSH environment variable.
You use rsync in the same way you use rcp. You must specify a source
and a destination, one of which may be remote.
-Perhaps the best way to explain the syntax is some examples:
+Perhaps the best way to explain the syntax is with some examples:
quote(rsync *.c foo:src/)
-this would transfer all files matching the pattern *.c from the
+This would transfer all files matching the pattern *.c from the
current directory to the directory src on the machine foo. If any of
the files already exist on the remote system then the rsync
remote-update protocol is used to update the file by sending only the
quote(rsync -avz foo:src/bar /data/tmp)
-this would recursively transfer all files from the directory src/bar on the
+This would recursively transfer all files from the directory src/bar on the
machine foo into the /data/tmp/bar directory on the local machine. The
files are transferred in "archive" mode, which ensures that symbolic
links, devices, attributes, permissions, ownerships etc are preserved
quote(rsync -avz foo:src/bar/ /data/tmp)
-a trailing slash on the source changes this behavior to transfer
-all files from the directory src/bar on the machine foo into the
-/data/tmp/. A trailing / on a source name means "copy the
-contents of this directory". Without a trailing slash it means "copy
-the directory". This difference becomes particularly important when
-using the --delete option.
+A trailing slash on the source changes this behavior to avoid creating an
+additional directory level at the destination. You can think of a trailing
+/ on a source as meaning "copy the contents of this directory" as opposed
+to "copy the directory by name", but in both cases the attributes of the
+containing directory are transferred to the containing directory on the
+destination. In other words, each of the following commands copies the
+files in the same way, including their setting of the attributes of
+/dest/foo:
+
+quote(rsync -avz /src/foo /dest)
+quote(rsync -avz /src/foo/ /dest/foo)
You can also use rsync in local-only mode, where both the source and
destination don't have a ':' in the name. In this case it behaves like
quote(rsync somehost.mydomain.com::)
-this would list all the anonymous rsync modules available on the host
+This would list all the anonymous rsync modules available on the host
somehost.mydomain.com. (See the following section for more details.)
You may establish the connection via a web proxy by setting the
environment variable RSYNC_PROXY to a hostname:port pair pointing to
-your web proxy. Note that your web proxy's configuration must allow
-proxying to port 873.
+your web proxy. Note that your web proxy's configuration must support
+proxy connections to port 873.
Using rsync in this way is the same as using it with a remote shell except
that:
manpagesection(CONNECTING TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM)
It is sometimes useful to be able to set up file transfers using rsync
-server capabilities on the remote machine, while still using rsh or
-ssh for transport. This is especially useful when you want to connect
+server capabilities on the remote machine, while still using ssh or
+rsh for transport. This is especially useful when you want to connect
to a remote machine via ssh (for encryption or to get through a
firewall), but you still want to have access to the rsync server
features (see RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM,
manpagesection(RUNNING AN RSYNC SERVER)
-An rsync server is configured using a config file. Please see the
+An rsync server is configured using a configuration file. Please see the
rsyncd.conf(5) man page for more information. By default the configuration
file is called /etc/rsyncd.conf, unless rsync is running over a remote
shell program and is not running as root; in that case, the default name
configure inetd or the services map to include the rsync server port
if you run an rsync server only via a remote shell program.
-To run an rsync server out of a single-use ssh key, use the
-"command=em(COMMAND)" syntax in the remote user's
-authorized_keys entry, where command would be
-
-quote(rsync --server --daemon .)
-
-NOTE: rsync's argument parsing expects the trailing ".", so make sure
-that it's there. If you want to use a rsyncd.conf(5)-style
-configuration file other than the default, you can added a
---config option to the em(command):
-
-quote(rsync --server --daemon --config=em(file) .)
+To run an rsync server out of a single-use ssh key, see this section
+in the rsyncd.conf(5) man page.
manpagesection(EXAMPLES)
-R, --relative use relative path names
--no-relative turn off --relative
--no-implied-dirs don't send implied dirs with -R
- -b, --backup make backups (see --suffix)
+ -b, --backup make backups (see --suffix & --backup-dir)
--backup-dir make backups into this directory
- --suffix=SUFFIX define backup suffix (default ~ w/o --backup-dir)
+ --suffix=SUFFIX backup suffix (default ~ w/o --backup-dir)
-u, --update update only (don't overwrite newer files)
-l, --links copy symlinks as symlinks
-L, --copy-links copy the referent of symlinks
--no-whole-file turn off --whole-file
-x, --one-file-system don't cross filesystem boundaries
-B, --block-size=SIZE checksum blocking size (default 700)
- -e, --rsh=COMMAND specify the remote shell to use
+ -e, --rsh=COMMAND specify the remote shell
--rsync-path=PATH specify path to rsync on the remote machine
--existing only update files that already exist
- --ignore-existing ignore files that already exist on the receiving side
- --delete delete files that don't exist on the sending side
- --delete-excluded also delete excluded files on the receiving side
- --delete-after delete after transferring, not before
+ --ignore-existing ignore files that already exist on receiver
+ --delete delete files that don't exist on sender
+ --delete-excluded also delete excluded files on receiver
+ --delete-after receiver deletes after transfer, not before
--ignore-errors delete even if there are IO errors
--max-delete=NUM don't delete more than NUM files
--partial keep partially transferred files
- --force force deletion of directories even if not empty
+ --force force deletion of dirs even if not empty
--numeric-ids don't map uid/gid values by user/group name
--timeout=TIME set IO timeout in seconds
- -I, --ignore-times don't exclude files that match length and time
- --size-only only use file size when determining if a file should be transferred
- --modify-window=NUM Timestamp window (seconds) for file match (default=0)
+ -I, --ignore-times turn off mod time & file size quick check
+ --size-only ignore mod time for quick check (use size)
+ --modify-window=NUM compare mod times with reduced accuracy
-T --temp-dir=DIR create temporary files in directory DIR
- --compare-dest=DIR also compare destination files relative to DIR
+ --compare-dest=DIR also compare received files relative to DIR
--link-dest=DIR create hardlinks to DIR for unchanged files
-P equivalent to --partial --progress
-z, --compress compress file data
--include=PATTERN don't exclude files matching PATTERN
--include-from=FILE don't exclude patterns listed in FILE
--files-from=FILE read FILE for list of source-file names
- -0 --from0 file names we read are separated by nulls, not newlines
+ -0 --from0 all file lists are delimited by nulls
--version print version number
--daemon run as a rsync daemon
--no-detach do not detach from the parent
--log-format=FORMAT log file transfers using specified format
--password-file=FILE get password from FILE
--bwlimit=KBPS limit I/O bandwidth, KBytes per second
- --read-batch=PREFIX read batch fileset starting with PREFIX
--write-batch=PREFIX write batch fileset starting with PREFIX
+ --read-batch=PREFIX read batch fileset starting with PREFIX
-h, --help show this help screen
cron.
dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are
-already the same length and have the same time-stamp. This option turns
-off this behavior.
+already the same size and have the same modification time-stamp.
+This option turns off this "quick check" behavior.
dit(bf(--size-only)) Normally rsync will skip any files that are
-already the same length and have the same time-stamp. With the
+already the same size and have the same modification time-stamp. With the
--size-only option files will be skipped if they have the same size,
regardless of timestamp. This is useful when starting to use rsync
after using another mirroring system which may not preserve timestamps
is not used and the whole file is sent as-is instead. The transfer may be
faster if this option is used when the bandwidth between the source and
target machines is higher than the bandwidth to disk (especially when the
-"disk" is actually a networked file system). This is the default when both
+"disk" is actually a networked filesystem). This is the default when both
the source and target are on the local machine.
dit(bf(--no-whole-file)) Turn off --whole-file, for use when it is the
dit(bf(-g, --group)) This option causes rsync to set the group of the
destination file to be the same as the source file. If the receiving
program is not running as the super-user, only groups that the
-receiver is a member of will be preserved (by group name, not group id
+receiver is a member of will be preserved (by group name, not group ID
number).
dit(bf(-D, --devices)) This option causes rsync to transfer character and
delete any files on the receiving side that are excluded (see --exclude).
Implies --delete.
-dit(bf(--delete-after)) By default rsync does file deletions before
-transferring files to try to ensure that there is sufficient space on
-the receiving filesystem. If you want to delete after transferring
-then use the --delete-after switch. Implies --delete.
+dit(bf(--delete-after)) By default rsync does file deletions on the
+receiving side before transferring files to try to ensure that there is
+sufficient space on the receiving filesystem. If you want to delete
+after transferring, use the --delete-after switch. Implies --delete.
dit(bf(--ignore-errors)) Tells --delete to go ahead and delete files
even when there are IO errors.
dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative
remote shell program to use for communication between the local and
-remote copies of rsync. Typically, rsync is configured to use rsh by
-default, but you may prefer to use ssh because of its high security.
+remote copies of rsync. Typically, rsync is configured to use ssh by
+default, but you may prefer to use rsh on a local network.
If this option is used with bf([user@]host::module/path), then the
-remote shell em(COMMMAND) will be used to run an rsync server on the
+remote shell em(COMMAND) will be used to run an rsync server on the
remote host, and all data will be transmitted through that remote
shell connection, rather than through a direct socket connection to a
running rsync server on the remote host. See the section "CONNECTING
information sent for matching data blocks.
dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
-and user ids rather than using user and group names and mapping them
+and user IDs rather than using user and group names and mapping them
at both ends.
-By default rsync will use the user name and group name to determine
+By default rsync will use the username and groupname to determine
what ownership to give files. The special uid 0 and the special group
0 are never mapped via user/group names even if the --numeric-ids
option is not specified.
If the source system is a daemon using chroot, or if a user or group
-name does not exist on the destination system, then the numeric id
+name does not exist on the destination system, then the numeric ID
from the source system is used instead.
dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO
rather than the default port 873.
dit(bf(--blocking-io)) This tells rsync to use blocking IO when launching
-a remote shell transport. If -e or --rsh are not specified or are set to
-the default "rsh", this defaults to blocking IO, otherwise it defaults to
-non-blocking IO. You may find the --blocking-io option is needed for some
-remote shells that can't handle non-blocking IO. (Note that ssh prefers
-non-blocking IO.)
+a remote shell transport. If the remote shell is either rsh or remsh,
+rsync defaults to using
+blocking IO, otherwise it defaults to using non-blocking IO. (Note that
+ssh prefers non-blocking IO.)
dit(bf(--no-blocking-io)) Turn off --blocking-io, for use when it is the
default.
something to watch.
Implies --verbose without incrementing verbosity.
+When the file is transferring, the data looks like this:
+
+verb(
+ 782448 63% 110.64kB/s 0:00:04
+)
+
+This tells you the current file size, the percentage of the transfer that
+is complete, the current calculated file-completion rate (including both
+data over the wire and data being matched locally), and the estimated time
+remaining in this transfer.
+
+After the a file is complete, it the data looks like this:
+
+verb(
+ 1238099 100% 146.38kB/s 0:00:08 (5, 57.1% of 396)
+)
+
+This tells you the final file size, that it's 100% complete, the final
+transfer rate for the file, the amount of elapsed time it took to transfer
+the file, and the addition of a total-transfer summary in parentheses.
+These additional numbers tell you how many files have been updated, and
+what percent of the total number of files has been scanned.
+
dit(bf(-P)) The -P option is equivalent to --partial --progress. I
found myself typing that combination quite often so I created an
option to make it easier.
using rsync with large files (several megabytes and up). Due to the nature
of rsync transfers, blocks of data are sent, then if rsync determines the
transfer was too fast, it will wait before sending the next data block. The
-result is an average transfer rate equalling the specified limit. A value
+result is an average transfer rate equaling the specified limit. A value
of zero specifies no limit.
dit(bf(--write-batch=PREFIX)) Generate a set of files that can be
Example:
verb(
-$ rsync --write_batch=pfx -a /source/dir/ /adest/dir/
+$ rsync --write-batch=pfx -a /source/dir/ /adest/dir/
$ rcp pfx.rsync_* remote:
-$ rsh remote rsync --read_batch=pfx -a /bdest/dir/
+$ ssh remote rsync --read-batch=pfx -a /bdest/dir/
# or alternatively
-$ rsh remote ./pfx.rsync_argvs /bdest/dir/
+$ ssh remote ./pfx.rsync_argvs /bdest/dir/
)
In this example, rsync is used to update /adest/dir/ with /source/dir/
bf(/etc/passwd) in the public section of the site. Using
bf(--copy-unsafe-links) will cause any links to be copied as the file
they point to on the destination. Using bf(--safe-links) will cause
-unsafe links to be ommitted altogether.
+unsafe links to be omitted altogether.
Symbolic links are considered unsafe if they are absolute symlinks
(start with bf(/)), empty, or if they contain enough bf("..")
remote shell like this:
verb(
- rsh remotehost /bin/true > out.dat
+ ssh remotehost /bin/true > out.dat
)
then look at out.dat. If everything is working correctly then out.dat
manpagesection(EXIT VALUES)
startdit()
-dit(bf(RERR_SYNTAX 1)) Syntax or usage error
-dit(bf(RERR_PROTOCOL 2)) Protocol incompatibility
-dit(bf(RERR_FILESELECT 3)) Errors selecting input/output files, dirs
-
-dit(bf(RERR_UNSUPPORTED 4)) Requested action not supported: an attempt
+dit(bf(0)) Success
+dit(bf(1)) Syntax or usage error
+dit(bf(2)) Protocol incompatibility
+dit(bf(3)) Errors selecting input/output files, dirs
+dit(bf(4)) Requested action not supported: an attempt
was made to manipulate 64-bit files on a platform that cannot support
-them; or an option was speciifed that is supported by the client and
+them; or an option was specifed that is supported by the client and
not by the server.
-
-dit(bf(RERR_SOCKETIO 10)) Error in socket IO
-dit(bf(RERR_FILEIO 11)) Error in file IO
-dit(bf(RERR_STREAMIO 12)) Error in rsync protocol data stream
-dit(bf(RERR_MESSAGEIO 13)) Errors with program diagnostics
-dit(bf(RERR_IPC 14)) Error in IPC code
-dit(bf(RERR_SIGNAL 20)) Received SIGUSR1 or SIGINT
-dit(bf(RERR_WAITCHILD 21)) Some error returned by waitpid()
-dit(bf(RERR_MALLOC 22)) Error allocating core memory buffers
-dit(bf(RERR_TIMEOUT 30)) Timeout in data send/receive
+dit(bf(5)) Error starting client-server protocol
+dit(bf(10)) Error in socket IO
+dit(bf(11)) Error in file IO
+dit(bf(12)) Error in rsync protocol data stream
+dit(bf(13)) Errors with program diagnostics
+dit(bf(14)) Error in IPC code
+dit(bf(20)) Received SIGUSR1 or SIGINT
+dit(bf(21)) Some error returned by waitpid()
+dit(bf(22)) Error allocating core memory buffers
+dit(bf(23)) Partial transfer due to error
+dit(bf(24)) Partial transfer due to vanished source files
+dit(bf(30)) Timeout in data send/receive
enddit()
manpagesection(ENVIRONMENT VARIABLES)
times are transferred as unix time_t values
-When transferring to FAT filesystmes rsync may resync
+When transferring to FAT filesystems rsync may resync
unmodified files.
See the comments on the --modify-window option.
Matt McCutchen's Web Site / rsync / rsync.git / blobdiff