X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/c95da96a0c51c66c8cb2eff97b768a717d9e0c79..8638dd48f71023642d3af282250bbe157ee9b67d:/rsync.yo diff --git a/rsync.yo b/rsync.yo index b13a8b8c..cedf5781 100644 --- a/rsync.yo +++ b/rsync.yo @@ -9,9 +9,9 @@ rsync [options] path [user@]host:path 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() @@ -193,6 +193,13 @@ 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 @@ -202,6 +209,7 @@ verb( -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) @@ -223,6 +231,7 @@ verb( --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 + --compare-dest=DIR also compare destination files relative to DIR -z, --compress compress file data --exclude=PATTERN exclude file FILE --exclude-from=PATTERN exclude files listed in FILE @@ -234,6 +243,7 @@ verb( --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 ) @@ -306,6 +316,11 @@ option all symbolic links are skipped. 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. @@ -348,6 +363,10 @@ instead it will just report the actions it would have taken. 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. @@ -459,11 +478,21 @@ checksum length by default, using a 16 byte file checksum to determine if a 2nd pass is required with a longer block checksum. Only use this option if you have read the source code and know what you are doing. -dit(bf(-T, --temp-dir DIR)) This options instructs rsync to use DIR as a -scratch directory when creating a temporary copies of the files +dit(bf(-T, --temp-dir DIR)) This option instructs rsync to use DIR as a +scratch directory when creating temporary copies of the files transferred on the receiving side. The default behavior is to create the temporary files in the receiving directory. +dit(bf(--compare-dest DIR)) This option instructs rsync to use DIR as an +additional directory to compare destination files against when doing +transfers. This is useful for doing transfers to a new destination while +leaving existing files intact, and then doing a flash-cutover when all +files have been successfully transfered (for example by moving directories +around and removing the old directory). This option increases the +usefulness of --partial because partially transferred files will remain in +the new temporary destination until they have a chance to be completed. +If DIR is a relative path, it is relative to the destination directory. + dit(bf(-z, --compress)) With this option, rsync compresses any data from the source file(s) which it sends to the destination machine. This option is useful on slow links. The compression method used is the @@ -510,6 +539,10 @@ 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. +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) @@ -572,6 +605,29 @@ itemize( 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()