X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/32b9011ae97cb4be9dbd6d1991a9b633b64ce6a0..a685271de33c6d9d39fb1a8855fe214911c774e6:/rsync.yo diff --git a/rsync.yo b/rsync.yo index 18c79842..ec8654f9 100644 --- a/rsync.yo +++ b/rsync.yo @@ -1,5 +1,5 @@ mailto(rsync-bugs@samba.org) -manpage(rsync)(1)(11 Oct 2007)()() +manpage(rsync)(1)(8 Nov 2007)()() manpagename(rsync)(a fast, versatile, remote (and local) file-copying tool) manpagesynopsis() @@ -225,7 +225,7 @@ verb( export RSYNC_CONNECT_PROG='ssh proxyhost nc %H 873' rsync -av targethost1::module/src/ /dest/ rsync -av rsync:://targethost2/module/src/ /dest/ ) -The command specifed above uses ssh to run nc (netcat) on a proxyhost, +The command specified above uses ssh to run nc (netcat) on a proxyhost, which forwards all data to port 873 (the rsync daemon) on the targethost (%H). @@ -328,7 +328,7 @@ to the detailed description below for a complete description. verb( -u, --update skip files that are newer on the receiver --inplace update destination files in-place --append append data onto shorter files - --append-verify --append w/old data in file cheksum + --append-verify --append w/old data in file checksum -d, --dirs transfer directories without recursing -l, --links copy symlinks as symlinks -L, --copy-links transform symlink into referent file/dir @@ -352,7 +352,7 @@ to the detailed description below for a complete description. verb( --super receiver attempts super-user activities --fake-super store/recover privileged attrs using xattrs -S, --sparse handle sparse files efficiently - -n, --dry-run show what would have been transferred + -n, --dry-run perform a trial run with no changes made -W, --whole-file copy files whole (without rsync algorithm) -x, --one-file-system don't cross filesystem boundaries -B, --block-size=SIZE force a fixed checksum block-size @@ -421,7 +421,7 @@ to the detailed description below for a complete description. verb( --only-write-batch=FILE like --write-batch but w/o updating dest --read-batch=FILE read a batched update from FILE --protocol=NUM force an older protocol version to be used - --iconv=CONVERT_SPEC request charset conversion of filesnames + --iconv=CONVERT_SPEC request charset conversion of filenames --checksum-seed=NUM set block/file checksum seed (advanced) -4, --ipv4 prefer IPv4 -6, --ipv6 prefer IPv6 @@ -801,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 @@ -846,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 @@ -987,7 +995,7 @@ files we create can always be accessed/changed by the creating user). This option also handles ACLs (if bf(--acls) was specified) and non-user extended attributes (if bf(--xattrs) was specified). -This is a good way to backup data withou using a super-user, and to store +This is a good way to backup data without using a super-user, and to store ACLs from incompatible systems. The bf(--fake-super) option only affects the side where the option is used. @@ -997,7 +1005,7 @@ path: quote(tt( rsync -av --rsync-path="rsync --fake-super" /src/ host:/dest/)) Since there is only one "side" in a local copy, this option affects both -the sending and recieving of files. You'll need to specify a copy using +the sending and receiving of files. You'll need to specify a copy using "localhost" if you need to avoid this, possibly using the "lsh" shell script (from the support directory) as a substitute for an actual remote shell (see bf(--rsh)). @@ -1014,8 +1022,20 @@ 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(-n, --dry-run)) This tells rsync to not do any file transfers, -instead it will just report the actions it would have taken. +dit(bf(-n, --dry-run)) This makes rsync perform a trial run that doesn't +make any changes (and produces mostly the same output as a real run). It +is most commonly used in combination with the bf(-v, --verbose) and/or +bf(-i, --itemize-changes) options to see what an rsync command is going +to do before one actually runs it. + +The output of bf(--itemize-changes) is supposed to be exactly the same on a +dry run and a subsequent real run (barring intentional trickery and system +call failures); if it isn't, that's a bug. Other output is the same to the +extent practical, but may differ in some areas. Notably, a dry run does not +send the actual data for file transfers, so bf(--progress) has no effect, +the "bytes sent", "bytes received", "literal data", and "matched data" +statistics are too small, and the "speedup" value is equivalent to a run +where no file transfers are needed. dit(bf(-W, --whole-file)) With this option the delta transfer algorithm is not used and the whole file is sent as-is instead. The transfer may be @@ -1243,8 +1263,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 @@ -2808,7 +2828,7 @@ url(http://rsync.samba.org/)(http://rsync.samba.org/) manpagesection(VERSION) -This man page is current for version 3.0.0pre2 of rsync. +This man page is current for version 3.0.0pre5 of rsync. manpagesection(INTERNAL OPTIONS) @@ -2834,23 +2854,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)