mailto(rsync-bugs@samba.org)
-manpage(rsync)(1)(1 Dec 1998)()()
+manpage(rsync)(1)(10 Feb 1999)()()
manpagename(rsync)(faster, flexible replacement for rcp)
manpagesynopsis()
-rsync [options] [user@]host:path path
+rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST
-rsync [options] path [user@]host:path
+rsync [OPTION]... [USER@]HOST:SRC DEST
-rsync [options] path path
+rsync [OPTION]... SRC [SRC]... DEST
-rsync [options] [user@]host::module[/path] path
+rsync [OPTION]... [USER@]HOST::SRC [DEST]
-rsync [options] path [user@]host::module[/path]
+rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST
-rsync [options] rsync://[user@]host[:port]/module/path path
+rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]
manpagedescription()
Some paths on the remote server may require authentication. If so then
you will receive a password prompt when you connect. You can avoid the
password prompt by setting the environment variable RSYNC_PASSWORD to
-the password you want to use. This may be useful when scripting rsync.
+the password you want to use or using the --password-file option. This
+may be useful when scripting rsync.
+
+WARNING: On some systems environment variables are visible to all
+users. On those systems using --password-file is recommended.
manpagesection(RUNNING AN RSYNC SERVER)
to the detailed description below for a complete description.
verb(
-Usage: rsync [OPTION]... SRC [USER@]HOST:DEST
+Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST
or rsync [OPTION]... [USER@]HOST:SRC DEST
- or rsync [OPTION]... SRC DEST
+ or rsync [OPTION]... SRC [SRC]... DEST
or rsync [OPTION]... [USER@]HOST::SRC [DEST]
- or rsync [OPTION]... SRC [USER@]HOST::DEST
+ or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST
or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]
+SRC on single-colon remote HOST will be expanded by remote shell
+SRC on server remote HOST may contain shell wildcards or multiple
+ sources separated by space as long as they have same top-level
Options
-v, --verbose increase verbosity
+ -q, --quiet decrease verbosity
-c, --checksum always checksum
-a, --archive archive mode
-r, --recursive recurse into directories
-R, --relative use relative path names
- -b, --backup make backups (default ~ extension)
+ -b, --backup make backups (default ~ suffix)
+ --suffix=SUFFIX override backup suffix
-u, --update update only (don't overwrite newer files)
-l, --links preserve soft links
-L, --copy-links treat soft links like regular files
-n, --dry-run show what would have been transferred
-W, --whole-file copy whole files, no incremental checks
-x, --one-file-system don't cross filesystem boundaries
- -B, --block-size=SIZE checksum blocking size
+ -B, --block-size=SIZE checksum blocking size (default 700)
-e, --rsh=COMMAND specify rsh replacement
--rsync-path=PATH specify path to rsync on the remote machine
-C, --cvs-exclude auto ignore files in the same way CVS does
--compare-dest=DIR also compare destination files relative to DIR
-z, --compress compress file data
--exclude=PATTERN exclude files matching PATTERN
- --exclude-from=FILE exclude files listed in FILE
+ --exclude-from=FILE exclude patterns listed in FILE
--include=PATTERN don't exclude files matching PATTERN
- --include-from=FILE don't exclude files listed in FILE
- --suffix=SUFFIX override backup suffix
+ --include-from=FILE don't exclude patterns listed in FILE
--version print version number
--daemon run as a rsync daemon
--config=FILE specify alternate rsyncd.conf file
--stats give some file transfer stats
--progress show progress during transfer
--log-format=FORMAT log file transfers using specified format
+ --password-file=FILE get password from FILE
-h, --help show this help screen
)
information at the end. More than two -v flags should only be used if
you are debugging rsync.
+dit(bf(-q, --quiet)) This option decreases the amount of information you
+are given during the transfer, notably suppressing information messages
+from the remote server. This flag is useful when invoking rsync from
+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.
renamed with a ~ extension as each file is transferred. You can
control the backup suffix using the --suffix option.
+dit(bf(--suffix SUFFIX)) This option allows you to override the default
+backup suffix used with the -b option. The default is a ~.
+
dit(bf(-u, --update)) This forces rsync to skip any files for which the
destination file already exists and has a date later than the source
file.
dit(bf(--exclude-from FILE)) This option is similar to the --exclude
option, but instead it adds all filenames listed in the file FILE to
-the exclude list.
+the exclude list. Blank lines in FILE and lines starting with ';' or '#'
+are ignored.
dit(bf(--include pattern)) This option tells rsync to not exclude the
specified pattern of filenames. This is useful as it allows you to
Finally in each directory any files listed in the .cvsignore file in
that directory are added to the list.
-dit(bf(--suffix SUFFIX)) This option allows you to override the default
-backup suffix used with the -b option. The default is a ~.
-
dit(bf(--csum-length LENGTH)) By default the primary checksum used in
rsync is a very strong 16 byte MD4 checksum. In most cases you will
find that a truncated version of this checksum is quite efficient, and
dit(bf(--stats)) This tells rsync to print a verbose set of statistics
on the file transfer, allowing you to tell how effective the rsync
-algorithm is for your data. This option only works in conjunction with
-the -v (verbose) option.
+algorithm is for your data.
dit(bf(--progress)) This option tells rsync to print information
showing the progress of the transfer. This gives a bored user
something to watch.
+dit(bf(--password-file)) This option allows you to provide a password
+in a file for accessing a remote rsync server. Note that this option
+is only useful when accessing a rsync server using the built in
+transport, not when using a remote shell as the transport. The file
+must not be world readable.
+
enddit()
manpagesection(EXCLUDE PATTERNS)
only against the final component of the filename.
it() if the pattern starts with "+ " (a plus followed by a space)
- then it is always considered a include pattern, even if specified as
+ then it is always considered an include pattern, even if specified as
part of an exclude option. The "+ " part is discarded before matching.
it() if the pattern starts with "- " (a minus followed by a space)
- then it is always considered a exclude pattern, even if specified as
+ then it is always considered an exclude pattern, even if specified as
part of an include option. The "- " part is discarded before matching.
it() if the pattern is a single exclamation mark ! then the current
)
then look at out.dat. If everything is working correctly then out.dat
-should be a zero length file. You you are getting the above error from
+should be a zero length file. If you are getting the above error from
rsync then you will probably find that out.dat contains some text or
data. Look at the contents and try to work out what is producing
it. The most common cause is incorrectly configured shell startup
Matt McCutchen's Web Site / rsync / rsync.git / blobdiff