rsync [options] path path
-rsync [options] [user@]host::path path
+rsync [options] [user@]host::module[/path] path
-rsync [options] path [user@]host::path
+rsync [options] path [user@]host::module[/path]
manpagedescription()
this is launched from cron every few hours.
+manpagesection(OPTIONS SUMMARY)
+
+Here is a short summary of the options avalable in rsync. Please refer
+to the detailed description below for a complete description.
+
+verb(
+Usage: rsync [OPTION]... SRC [USER@]HOST:DEST
+ or rsync [OPTION]... [USER@]HOST:SRC DEST
+ or rsync [OPTION]... SRC DEST
+ or rsync [OPTION]... [USER@]HOST::SRC DEST
+ or rsync [OPTION]... SRC [USER@]HOST::DEST
+
+Options
+ -v, --verbose increase 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)
+ -u, --update update only (don't overwrite newer files)
+ -l, --links preserve soft links
+ -L, --copy-links treat soft links like regular files
+ --safe-links ignore links outside the destination tree
+ -H, --hard-links preserve hard links
+ -p, --perms preserve permissions
+ -o, --owner preserve owner (root only)
+ -g, --group preserve group
+ -D, --devices preserve devices (root only)
+ -t, --times preserve times
+ -S, --sparse handle sparse files efficiently
+ -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
+ -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
+ --delete delete files that don't exist on the sending side
+ --partial keep partially transferred files
+ --force force deletion of directories 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
+ -T --temp-dir=DIR create temporary files in directory DIR
+ -z, --compress compress file data
+ --exclude=PATTERN exclude file FILE
+ --exclude-from=PATTERN exclude files listed in FILE
+ --include=PATTERN don't exclude file FILE
+ --include-from=PATTERN don't exclude files listed in FILE
+ --suffix=SUFFIX override backup suffix
+ --version print version number
+ --daemon run as a rsync daemon
+ --config=FILE specify alternate rsyncd.conf file
+ --port=PORT specify alternate rsyncd port number
+ --stats give some file transfer stats
+ --progress show progress during transfer
+ -h, --help show this help screen
+)
+
manpageoptions()
rsync uses the GNU long options package. Many of the command line
dit(bf(-L, --copy-links)) This tells rsync to treat symbolic links just
like ordinary files.
+dit(bf(--safe-links)) This tells rsync to ignore any symbolic links
+which point outside the destination tree. All absolute symlinks are
+also ignored. Using this option in conjunction with --relative may
+give unexpecetd results.
+
dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on
the remote system to be the same as the local system. Without this
option hard links are treated like regular files.
is not used and the whole file is sent as-is instead. This may be
useful when using rsync with a local machine.
+dit(bf(--partial)) By default rsync will delete any partially
+transferred file if the transfer is interrupted. In some circumstances
+it is more desirable to keep partially transferred files. Using the
+--partial option tells rsync to keep the partial file which should
+make a subsequent transfer of the rest of the file much faster.
+
dit(bf(-p, --perms)) This option causes rsync to update the remote
permissions to be the same as the local permissions.
dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take
up less space on the destination.
+NOTE: Don't use this option when the destination is a Solaris "tmpfs"
+filesystem. It doesn't seem to handle seeks over null regions
+correctly and ends up corrupting the files.
+
dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem
boundaries when recursing. This is useful for transferring the
contents of only one filesystem.
algorithm is for your data. This option only works in conjunction with
the -v (verbose) option.
+dit(bf(--progress)) This option tells rsync to print information
+showing the progress of the transfer. This gives a bored user
+something to watch.
+
enddit()
manpagesection(EXCLUDE PATTERNS)
directories and C source files.
)
+manpagesection(DIAGNOSTICS)
+
+rsync occasinally produces error messages that may seem a little
+cryptic. The one that seems to cause the most confusion is "protocol
+version mismatch - is your shell clean?".
+
+This message is usually caused by your startup scripts or remote shell
+facility producing unwanted garbage on the stream that rsync is using
+for its transport. The way ot diagnose this problem is to run your
+remote shell like this:
+
+verb(
+ rsh remotehost /bin/true > out.dat
+)
+
+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
+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 configued shell startup
+scripts (such as .cshrc or .profile) that contain output statements
+for non-interactive logins.
+
manpagesection(ENVIRONMENT VARIABLES)
startdit()
Matt McCutchen's Web Site / rsync / rsync.git / blobdiff