X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/4b957c22381cf1848ff6a5e59249bb71ba79e9fa..654175798bdbdd6403e10c8fa74e8586b3612ea1:/rsync.yo diff --git a/rsync.yo b/rsync.yo index b6f1d160..15f62859 100644 --- a/rsync.yo +++ b/rsync.yo @@ -9,9 +9,11 @@ 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] + +rsync [options] rsync://host/module/path path manpagedescription() @@ -40,7 +42,7 @@ itemize( manpagesection(GENERAL) -There are five different ways of using rsync. They are: +There are six different ways of using rsync. They are: itemize( it() for copying local files. This is invoked when neither @@ -57,11 +59,16 @@ itemize( it() for copying from a remote rsync server to the local machine. This is invoked when the source path contains a :: - separator. + separator. You can also use a rsync:// URL if no username + is required. it() for copying from the local machine to a remote rsync server. This is invoked when the destination path contains a :: separator. + + it() for listing files on a remote machine. This is done the + same way as rsync transfers except that you leave off the + local destination. ) Note that in all cases at least one of the source and destination @@ -140,6 +147,9 @@ itemize( it() if you specify no path name on the remote server then the list of accessible paths on the server will be shown. + + it() if you specify no local destination then a listing of the + specified files on the remote server is provided ) Some paths on the remote server may require authentication. If so then @@ -231,6 +241,7 @@ Options --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 @@ -243,6 +254,7 @@ Options --port=PORT specify alternate rsyncd port number --stats give some file transfer stats --progress show progress during transfer + --log-format=FORMAT log file transfers using specified format -h, --help show this help screen ) @@ -315,6 +327,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. @@ -339,10 +356,14 @@ permissions to be the same as the local permissions. dit(bf(-o, --owner)) This option causes rsync to update the remote owner of the file to be the same as the local owner. This is only available -to the super-user. +to the super-user. Note that if the source system is a daemon using chroot, +the --numeric-ids option is implied because the source system cannot get +access to the user names. dit(bf(-g, --group)) This option causes rsync to update the remote group -of the file to be the same as the local group. +of the file to be the same as the local group. Note that if the source +system is a daemon using chroot, the --numeric-ids option is implied because +the source system cannot get access to the group names. dit(bf(-D, --devices)) This option causes rsync to transfer character and block device information to the remote system to recreate these @@ -357,6 +378,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. @@ -378,9 +403,11 @@ Still, it is probably easy to get burnt with this option. The moral of the story is to use the -n option until you get used to the behavior of --delete. -NOTE: It also may delete files on the destination if the sending side -can't open them or stat them. This is a bug that hopefully will be -fixed in a future release. +If the sending side detects any IO errors then the deletion of any +files at the destination will be automatically disabled. This is to +prevent temporary filesystem failures (such as NFS errors) on the +sending side causing a massive deletion of files on the +destination. dit(bf(--force)) This options tells rsync to delete directories even if they are not empty. This applies to both the --delete option and to @@ -468,11 +495,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 @@ -492,8 +529,9 @@ what ownership to give files. The special uid 0 and the special group 0 and never mapped via user/group names even if the --numeric-ids option is not specified. -If a user or group name does not exist on the destination system then -the numeric id from the source system is used instead. +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 from the +source system is used instead. dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO timeout in seconds. If no data is transferred for the specified time @@ -514,6 +552,11 @@ specified. dit(bf(--port PORT)) This specifies an alternate TCP port number to use rather than the default port 873. +dit(bf(--log-format=FORMAT)) Normally rsync just logs filenames as +they are transferred. This allows you to specify exactly what gets +logged on a per file basis. The log format is specified using the same +format conventions as the log format option in rsyncd.conf. + 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 @@ -585,6 +628,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()