X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/73f2fa818948cf2b8d256da3bcc96374a924fff7..fbd91cae0cadf80229b41ee58394a046974c878c:/rsync.yo diff --git a/rsync.yo b/rsync.yo index a649dd95..eb85c7cf 100644 --- a/rsync.yo +++ b/rsync.yo @@ -219,6 +219,21 @@ environment variable RSYNC_PROXY to a hostname:port pair pointing to your web proxy. Note that your web proxy's configuration must support proxy connections to port 873. +You may also establish a daemon connection using a program as a proxy by +setting the environment variable RSYNC_CONNECT_PROG to the commands you +wish to run in place of making a direct socket connection. The string may +contain the escape "%H" to represent the hostname specified in the rsync +command (so use "%%" if you need a single "%" in your string). For +example: + +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, +which forwards all data to port 873 (the rsync daemon) on the targethost +(%H). + manpagesection(USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION) It is sometimes useful to use various features of an rsync daemon (such as @@ -318,6 +333,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 -d, --dirs transfer directories without recursing -l, --links copy symlinks as symlinks -L, --copy-links transform symlink into referent file/dir @@ -330,7 +346,7 @@ to the detailed description below for a complete description. verb( -E, --executability preserve executability --chmod=CHMOD affect file and/or directory permissions -A, --acls preserve ACLs (implies -p) - -X, --xattrs preserve extended attrs (implies -p) + -X, --xattrs preserve extended attributes -o, --owner preserve owner (super-user only) -g, --group preserve group --devices preserve device files (super-user only) @@ -701,13 +717,22 @@ receiving user. dit(bf(--append)) This causes rsync to update a file by appending data onto the end of the file, which presumes that the data that already exists on the receiving side is identical with the start of the file on the sending -side. If that is not true, the file will fail the checksum test, and the -resend will do a normal bf(--inplace) update to correct the mismatched data. -Only files on the receiving side that are shorter than the corresponding -file on the sending side (as well as new files) are transferred. -Implies bf(--inplace), but does not conflict with bf(--sparse) (though the -bf(--sparse) option will be auto-disabled if a resend of the already-existing -data is required). +side. Any files that are the same size or shorter on the receiving size +are skipped. Files that do not yet exist on the receiving side are also +sent, since they are considered to have 0 length. Implies bf(--inplace), +but does not conflict with bf(--sparse) (since it is always extending a +file's length). + +dit(bf(--append-verify)) This works just like the bf(--append) option, but +the existing data on the receiving side is included in the full-file +checksum verification step, which will cause a file to be resent if the +final verification step fails (rsync uses a normal, non-appending +bf(--inplace) transfer for the resend). + +Note: prior to rsync 3.0.0, the bf(--append) option worked like +bf(--append-verify), so if you are interacting with an older rsync (or the +transfer is using a protocol prior to 30), specifying either append option +will initiate an bf(--append-verify) transfer. dit(bf(-d, --dirs)) Tell the sending side to include any directories that are encountered. Unlike bf(--recursive), a directory's contents are not copied @@ -848,8 +873,7 @@ works if the remote rsync also supports it. bf(--acls) implies bf(--perms). dit(bf(-X, --xattrs)) This option causes rsync to update the remote extended attributes to be the same as the local ones. This will work -only if the remote machine's rsync supports this option also. This is -a non-standard option. +only if the remote machine's rsync also supports this option. dit(bf(--chmod)) This option tells rsync to apply one or more comma-separated "chmod" strings to the permission of the files in the @@ -964,7 +988,7 @@ 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(-W, --whole-file)) With this option the differential rsync algorithm +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 faster if this option is used when the bandwidth between the source and destination machines is higher than the bandwidth to disk (especially when the @@ -1706,7 +1730,7 @@ after it has served its purpose. Note that if bf(--whole-file) is specified (or implied), any partial-dir file that is found for a file that is being updated will simply be removed (since -rsync is sending files without using the differential rsync algorithm). +rsync is sending files without using the delta transfer algorithm). Rsync will create the em(DIR) if it is missing (just the last dir -- not the whole path). This makes it easy to use a relative path (such as @@ -1824,7 +1848,7 @@ sender's file, which is being reconstructed at a rate of 110.64 kilobytes per second, and the transfer will finish in 4 seconds if the current rate is maintained until the end. -These statistics can be misleading if the differential transfer algorithm is +These statistics can be misleading if the delta transfer algorithm is in use. For example, if the sender's file consists of the basis file followed by additional data, the reported rate will probably drop dramatically when the receiver gets to the literal data, and the transfer @@ -1935,6 +1959,10 @@ when creating sockets. This only affects sockets that rsync has direct control over, such as the outgoing socket when directly contacting an rsync daemon. See also these options in the bf(--daemon) mode section. +If rsync was complied without support for IPv6, the bf(--ipv6) option +will have no effect. The bf(--version) output will tell you if this +is the case. + dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer NUM. This 4 byte checksum seed is included in each block and file MD4 checksum calculation. By default the checksum seed is generated @@ -2017,6 +2045,10 @@ versions of Linux to work around an IPv6 bug in the kernel (if you see an "address already in use" error when nothing else is using the port, try specifying bf(--ipv6) or bf(--ipv4) when starting the daemon). +If rsync was complied without support for IPv6, the bf(--ipv6) option +will have no effect. The bf(--version) output will tell you if this +is the case. + dit(bf(-h, --help)) When specified after bf(--daemon), print a short help page describing the options available for starting an rsync daemon. enddit() @@ -2720,7 +2752,7 @@ values see also the comments on the bf(--delete) option -Please report bugs! See the website at +Please report bugs! See the web site at url(http://rsync.samba.org/)(http://rsync.samba.org/) manpagesection(VERSION)