X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/da564b51a16259cfc22123ee5134fd7e6398ca1e..58b7b3d668bd95e7552eb285c6e1e17de2b7b233:/rsync.yo diff --git a/rsync.yo b/rsync.yo index b0060129..df37b182 100644 --- a/rsync.yo +++ b/rsync.yo @@ -1,41 +1,40 @@ mailto(rsync-bugs@samba.org) -manpage(rsync)(1)(4 Oct 2007)()() -manpagename(rsync)(faster, flexible replacement for rcp) +manpage(rsync)(1)(26 Oct 2007)()() +manpagename(rsync)(a fast, versatile, remote (and local) file-copying tool) manpagesynopsis() -rsync [OPTION]... SRC [SRC]... DEST +verb(Local: rsync [OPTION...] SRC... [DEST] -rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST +Access via remote shell: + Pull: rsync [OPTION...] [USER@]HOST:SRC... [DEST] + Push: rsync [OPTION...] SRC... [USER@]HOST:DEST -rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST +Access via rsync daemon: + Pull: rsync [OPTION...] [USER@]HOST::SRC... [DEST] + rsync [OPTION...] rsync://[USER@]HOST[:PORT]/SRC... [DEST] + Push: rsync [OPTION...] SRC... [USER@]HOST::DEST + rsync [OPTION...] SRC... rsync://[USER@]HOST[:PORT]/DEST) -rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST - -rsync [OPTION]... SRC - -rsync [OPTION]... [USER@]HOST:SRC [DEST] - -rsync [OPTION]... [USER@]HOST::SRC [DEST] - -rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST] +Usages with just one SRC arg and no DEST arg will list the source files +instead of copying. manpagedescription() -Rsync is a program that behaves in much the same way that rcp does, -but has many more options and uses the rsync remote-update protocol to -greatly speed up file transfers when the destination file is being -updated. - -The rsync remote-update protocol allows rsync to transfer just the -differences between two sets of files across the network connection, using -an efficient checksum-search algorithm described in the technical -report that accompanies this package. - -Rsync finds files that need to be transferred using a "quick check" algorithm -that looks for files that have changed in size or in last-modified time (by -default). Any changes in the other preserved attributes (as requested by -options) are made on the destination file directly when the quick check -indicates that the file's data does not need to be updated. +Rsync is a fast and extraordinarily versatile file copying tool. It can +copy locally, to/from another host over any remote shell, or to/from a +remote rsync daemon. It offers a large number of options that control +every aspect of its behavior and permit very flexible specification of the +set of files to be copied. It is famous for its delta-transfer algorithm, +which reduces the amount of data sent over the network by sending only the +differences between the source files and the existing files in the +destination. Rsync is widely used for backups and mirroring and as an +improved copy command for everyday use. + +Rsync finds files that need to be transferred using a "quick check" +algorithm (by default) that looks for files that have changed in size or +in last-modified time. Any changes in the other preserved attributes (as +requested by options) are made on the destination file directly when the +quick check indicates that the file's data does not need to be updated. Some of the additional features of rsync are: @@ -748,6 +747,12 @@ bf(--recursive) option, rsync will skip all directories it encounters (and output a message to that effect for each one). If you specify both bf(--dirs) and bf(--recursive), bf(--recursive) takes precedence. +This option is implied by the bf(--list-only) option (including an implied +bf(--list-only) usage) if bf(--recursive) wasn't specified (so that +directories are seen in the listing). Specify bf(--no-dirs) (or bf(--no-d)) +if you want to override this. This option is also implied by +bf(--files-from). + dit(bf(-l, --links)) When symlinks are encountered, recreate the symlink on the destination. @@ -796,6 +801,14 @@ directory, and receives the file into the new directory. With bf(--keep-dirlinks), the receiver keeps the symlink and "file" ends up in "bar". +One note of caution: if you use bf(--keep-dirlinks), you must trust all +the symlinks in the copy! If it is possible for an untrusted user to +create their own symlink to any directory, the user could then (on a +subsequent copy) replace the symlink with a real directory and affect the +content of whatever directory the symlink references. For backup copies, +you are better off using something like a bind mount instead of a symlink +to modify your receiving hierarchy. + See also bf(--copy-dirlinks) for an analogous option for the sending side. dit(bf(-H, --hard-links)) This tells rsync to look for hard-linked files in @@ -841,17 +854,17 @@ permissions (while leaving existing files unchanged), make sure that the bf(--perms) option is off and use bf(--chmod=ugo=rwX) (which ensures that all non-masked bits get enabled). If you'd care to make this latter behavior easier to type, you could define a popt alias for it, such as -putting this line in the file ~/.popt (this defines the bf(-s) option, +putting this line in the file ~/.popt (the following defines the bf(-Z) option, and includes --no-g to use the default group of the destination dir): -quote(tt( rsync alias -s --no-p --no-g --chmod=ugo=rwX)) +quote(tt( rsync alias -Z --no-p --no-g --chmod=ugo=rwX)) You could then use this new option in a command such as this one: -quote(tt( rsync -asv src/ dest/)) +quote(tt( rsync -avZ src/ dest/)) -(Caveat: make sure that bf(-a) does not follow bf(-s), or it will re-enable -the "--no-*" options.) +(Caveat: make sure that bf(-a) does not follow bf(-Z), or it will re-enable +the two "--no-*" options mentioned above.) The preservation of the destination's setgid bit on newly-created directories when bf(--perms) is off was added in rsync 2.6.7. Older rsync @@ -1074,9 +1087,9 @@ Prior to rsync 2.6.7, this option would have no effect unless bf(--recursive) was enabled. Beginning with 2.6.7, deletions will also occur when bf(--dirs) (bf(-d)) is enabled, but only for directories whose contents are being copied. -This option can be dangerous if used incorrectly! It is a very good idea -to run first using the bf(--dry-run) option (bf(-n)) to see what files would be -deleted to make sure important files aren't listed. +This option can be dangerous if used incorrectly! It is a very good idea to +first try a run using the bf(--dry-run) option (bf(-n)) to see what files are +going to be deleted. If the sending side detects any I/O errors, then the deletion of any files at the destination will be automatically disabled. This is to @@ -1238,8 +1251,8 @@ The exclude list is initialized to exclude the following items (these initial items are marked as perishable -- see the FILTER RULES section): quote(quote(tt(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state -.nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej -.del-* *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/ .bzr/))) +.nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej .del-* +*.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/ .git/ .bzr/))) then, files listed in a $HOME/.cvsignore are added to the list and any files listed in the CVSIGNORE environment variable (all cvsignore names @@ -1923,16 +1936,22 @@ dit(bf(--list-only)) This option will cause the source files to be listed instead of transferred. This option is inferred if there is a single source arg and no destination specified, so its main uses are: (1) to turn a copy command that includes a -destination arg into a file-listing command, (2) to be able to specify more -than one local source arg (note: be sure to include the destination), or -(3) to avoid the automatically added "bf(-r --exclude='/*/*')" options that -rsync usually uses as a compatibility kluge when generating a non-recursive -listing. Caution: keep in mind that a source arg with a wild-card is expanded -by the shell into multiple args, so it is never safe to try to list such an arg +destination arg into a file-listing command, or (2) to be able to specify +more than one source arg (note: be sure to include the destination). +Caution: keep in mind that a source arg with a wild-card is expanded by the +shell into multiple args, so it is never safe to try to list such an arg without using this option. For example: verb( rsync -av --list-only foo* dest/) +Compatibility note: when requesting a remote listing of files from an rsync +that is version 2.6.3 or older, you may encounter an error if you ask for a +non-recursive listing. This is because a file listing implies the bf(--dirs) +option w/o bf(--recursive), and older rsyncs don't have that option. To +avoid this problem, either specify the bf(--no-dirs) option (if you don't +need to expand a directory's content), or turn on recursion and exclude +the content of subdirectories: bf(-r --exclude='/*/*'). + dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum transfer rate in kilobytes per second. This option is most effective when using rsync with large files (several megabytes and up). Due to the nature @@ -2797,7 +2816,7 @@ url(http://rsync.samba.org/)(http://rsync.samba.org/) manpagesection(VERSION) -This man page is current for version 3.0.0pre1 of rsync. +This man page is current for version 3.0.0pre4 of rsync. manpagesection(INTERNAL OPTIONS) @@ -2823,23 +2842,25 @@ The primary ftp site for rsync is url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). We would be delighted to hear from you if you like this program. +Please contact the mailing-list at rsync@lists.samba.org. This program uses the excellent zlib compression library written by Jean-loup Gailly and Mark Adler. manpagesection(THANKS) -Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell -and David Bell for helpful suggestions, patches and testing of rsync. -I've probably missed some people, my apologies if I have. +Especial thanks go out to: John Van Essen, Matt McCutchen, Wesley W. Terpstra, +David Dykstra, Jos Backus, Sebastian Krahmer, Martin Pool, and our +gone-but-not-forgotten compadre, J.W. Schultz. -Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer, -Martin Pool, Wayne Davison, J.W. Schultz. +Thanks also to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell +and David Bell. I've probably missed some people, my apologies if I have. manpageauthor() rsync was originally written by Andrew Tridgell and Paul Mackerras. -Many people have later contributed to it. +Many people have later contributed to it. It is currently maintained +by Wayne Davison. Mailing lists for support and development are available at url(http://lists.samba.org)(lists.samba.org)