X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/8bb5aa8fe8e4903dac0675279b745debdb888124..baf3e5049e43659e24735bf893e4726f9074512a:/rsync.yo diff --git a/rsync.yo b/rsync.yo index 236aca56..820f4e48 100644 --- a/rsync.yo +++ b/rsync.yo @@ -13,6 +13,8 @@ rsync [options] [user@]host::module[/path] path rsync [options] path [user@]host::module[/path] +rsync [options] rsync://[user@]host[:port]/module/path path + manpagedescription() rsync is a program that behaves in much the same way that rcp does, @@ -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,15 @@ itemize( it() for copying from a remote rsync server to the local machine. This is invoked when the source path contains a :: - separator. + separator or a rsync:// URL. 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 +146,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 @@ -198,6 +207,7 @@ Usage: rsync [OPTION]... SRC [USER@]HOST:DEST or rsync [OPTION]... SRC DEST or rsync [OPTION]... [USER@]HOST::SRC DEST or rsync [OPTION]... SRC [USER@]HOST::DEST + or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC DEST Options -v, --verbose increase verbosity @@ -233,10 +243,10 @@ Options -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 - --include=PATTERN don't exclude file FILE - --include-from=PATTERN don't exclude files listed in FILE + --exclude=PATTERN exclude files matching PATTERN + --exclude-from=FILE exclude files 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 --version print version number --daemon run as a rsync daemon @@ -244,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 ) @@ -359,7 +370,12 @@ block device information to the remote system to recreate these devices. This option is only available to the super-user. dit(bf(-t, --times)) This tells rsync to transfer modification times along -with the files and update them on the remote system +with the files and update them on the remote system. Note that if this +option is not used, the optimization that excludes files that have not been +modified cannot be effective; in other words, a missing -t or -a will +cause the next transfer to behave as if it used -I, and all files will have +their checksums compared and show up in log messages even if they haven't +changed. dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers, instead it will just report the actions it would have taken. @@ -392,9 +408,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 @@ -492,10 +510,12 @@ 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. +around and removing the old directory, although this requires also doing +the transfer with -I to avoid skipping files that haven't changed). 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 @@ -539,6 +559,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