X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/a8b9d4edec745757d34a10be0f6956c0609c2284..d73ee7b70e4a80743149fd3e43506634814d3b0c:/rsync.yo diff --git a/rsync.yo b/rsync.yo index 28097494..14eaec39 100644 --- a/rsync.yo +++ b/rsync.yo @@ -1,5 +1,5 @@ mailto(rsync-bugs@samba.org) -manpage(rsync)(1)(18 Feb 1999)()() +manpage(rsync)(1)(1 Mar 1999)()() manpagename(rsync)(faster, flexible replacement for rcp) manpagesynopsis() @@ -139,6 +139,11 @@ It is also possible to use rsync without using rsh or ssh as the transport. In this case you will connect to a remote rsync server running on TCP port 873. +You may establish the connetcion via a web proxy by setting the +environment variable RSYNC_PROXY to a hostname:port pair pointing to +your web proxy. Note that your web proxy must allow proxying to port +873, this must be configured in your proxy servers ruleset. + Using rsync in this way is the same as using it with rsh or ssh except that: @@ -247,9 +252,10 @@ Options -x, --one-file-system don't cross filesystem boundaries -B, --block-size=SIZE checksum blocking size (default 700) -e, --rsh=COMMAND specify rsh replacement - --rsync-path=PATH specify path to rsync on the remote machine + --rsync-path=PATH specify full path to rsync on the remote machine -C, --cvs-exclude auto ignore files in the same way CVS does --delete delete files that don't exist on the sending side + --delete-excluded also delete excluded files on the receiving side --partial keep partially transferred files --force force deletion of directories even if not empty --numeric-ids don't map uid/gid values by user/group name @@ -318,13 +324,15 @@ explicitly checked on the receiver and any files of the same name which already exist and have the same checksum and size on the receiver are skipped. This option can be quite slow. -dit(bf(-a, --archive)) This is equivalent to -rlptDg. It is a quick way +dit(bf(-a, --archive)) This is equivalent to -rlptg. It is a quick way of saying you want recursion and want to preserve everything. -Note: if the user launching rsync is root then the -o option (preserve -uid) is also implied. +Note: if the user launching rsync is root then the -o (preserve +uid) and -D (preserve devices) options are also implied. -dit(bf(-r, --recursive)) This tells rsync to copy directories recursively. +dit(bf(-r, --recursive)) This tells rsync to copy directories +recursively. If you don't specify this then rsync won't copy +directories at all. dit(bf(-R, --relative)) Use relative paths. This means that the full path names specified on the command line are sent to the server rather than @@ -399,9 +407,9 @@ the --numeric-ids option is implied because the source system cannot get access to the usernames. dit(bf(-g, --group)) This option causes rsync to update the remote 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. +of the file to be the same as the local group. If the receving system is +not running as the super-user, only groups that the receiver is a member of +will be preserved (by group name, not group id number). dit(bf(-D, --devices)) This option causes rsync to transfer character and block device information to the remote system to recreate these @@ -430,21 +438,14 @@ boundaries when recursing. This is useful for transferring the contents of only one filesystem. dit(bf(--delete)) This tells rsync to delete any files on the receiving -side that aren't on the sending side. This option can be dangerous if -used incorrectly! - -It is a very good idea to run first using the dry run option (-n) to -see what files would be deleted to make sure important files aren't -listed. +side that aren't on the sending side. Files that are excluded from +transfer are excluded from being deleted unless you use --delete-excluded. -rsync 1.6.4 changed the behavior of --delete to make it less -dangerous. rsync now only scans directories on the receiving side -that are explicitly transferred from the sending side. Only files in -these directories are deleted. +This option has no effect if directory recursion is not selected. -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. +This option can be dangerous if used incorrectly! It is a very good idea +to run first using the dry run option (-n) to see what files would be +deleted to make sure important files aren't listed. If the sending side detects any IO errors then the deletion of any files at the destination will be automatically disabled. This is to @@ -452,6 +453,10 @@ prevent temporary filesystem failures (such as NFS errors) on the sending side causing a massive deletion of files on the destination. +dit(bf(--delete-excluded)) In addition to deleting the files on the +receiving side that are not on the sending side, this tells rsync to also +delete any files on the receiving side that are excluded (see --exclude). + 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 cases where rsync tries to copy a normal file but the destination @@ -472,7 +477,9 @@ You can also choose the remote shell program using the RSYNC_RSH environment variable. dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of -rsync on the remote machine. Useful when it's not in your path. +rsync on the remote machine. Useful when it's not in your path. Note +that this is the full path to the binary, not just the directory that +the binary is in. dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude certain files from the list of files to be transferred. This is most @@ -607,6 +614,9 @@ dit(bf(--progress)) This option tells rsync to print information showing the progress of the transfer. This gives a bored user something to watch. +This option is normally combined with -v. Using this option without +the -v option will produce weird results on your display. + dit(bf(--password-file)) This option allows you to provide a password in a file for accessing a remote rsync server. Note that this option is only useful when accessing a rsync server using the built in @@ -718,6 +728,10 @@ dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to override the default shell used as the transport for rsync. This can be used instead of the -e option. +dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to +redirect your rsync client to use a web proxy when connecting to a +rsync daemon. You should set RSYNC_PROXY to a hostname:port pair. + dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required password allows you to run authenticated rsync connections to a rsync daemon without user intervention. Note that this does not supply a