X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/24986abd0717cf40252f98269c22d7553f609ad9..3420c8e6e06f316e0e7f99eba3f5c957cd0d3106:/rsync.yo diff --git a/rsync.yo b/rsync.yo index 2ba99f87..0b46cde8 100644 --- a/rsync.yo +++ b/rsync.yo @@ -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: @@ -259,6 +264,7 @@ Options --size-only only use file size when determining if a file should be transferred -T --temp-dir=DIR create temporary files in directory DIR --compare-dest=DIR also compare destination files relative to DIR + -P equivalent to --partial --progress -z, --compress compress file data --exclude=PATTERN exclude files matching PATTERN --exclude-from=FILE exclude patterns listed in FILE @@ -266,6 +272,7 @@ Options --include-from=FILE don't exclude patterns listed in FILE --version print version number --daemon run as a rsync daemon + --address bind to the specified address --config=FILE specify alternate rsyncd.conf file --port=PORT specify alternate rsyncd port number --stats give some file transfer stats @@ -386,12 +393,6 @@ dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm is not used and the whole file is sent as-is instead. This may be useful when using rsync with a local machine. -dit(bf(--partial)) By default, rsync will delete any partially -transferred file if the transfer is interrupted. In some circumstances -it is more desirable to keep partially transferred files. Using the ---partial option tells rsync to keep the partial file which should -make a subsequent transfer of the rest of the file much faster. - dit(bf(-p, --perms)) This option causes rsync to update the remote permissions to be the same as the local permissions. @@ -442,15 +443,6 @@ 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. -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. - -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. - 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 @@ -481,7 +473,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 @@ -596,6 +590,12 @@ config file (/etc/rsyncd.conf) on each connect made by a client and respond to requests accordingly. See the rsyncd.conf(5) man page for more details. +dit(bf(--address)) By default rsync will bind to the wildcard address +when run as a daemon with the --daemon option. The --address option +allows you to specify a specific IP address (or hostname) to bind +to. This makes virtual hosting possible in conjunction with the +--config option. + dit(bf(--config=FILE)) This specifies an alternate config file than the default /etc/rsyncd.conf. This is only relevant when --daemon is specified. @@ -612,10 +612,23 @@ 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. +dit(bf(--partial)) By default, rsync will delete any partially +transferred file if the transfer is interrupted. In some circumstances +it is more desirable to keep partially transferred files. Using the +--partial option tells rsync to keep the partial file which should +make a subsequent transfer of the rest of the file much faster. + 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(-P)) The -P option is equivalent to --partial --progress. I +found myself typing that combination quite often so I created an +option to make it easier. + 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 @@ -727,6 +740,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