X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/4e308a95267d1b6564d9e345f7f7dadf0a9073e3..7be73df4e7c9978b619c7e849b3f8ac2987cb667:/rsync.yo diff --git a/rsync.yo b/rsync.yo index 6aaaecd2..c7bd1c99 100644 --- a/rsync.yo +++ b/rsync.yo @@ -1,5 +1,5 @@ mailto(rsync-bugs@samba.org) -manpage(rsync)(1)(1 Jan 2004)()() +manpage(rsync)(1)(24 Mar 2004)()() manpagename(rsync)(faster, flexible replacement for rcp) manpagesynopsis() @@ -61,11 +61,11 @@ itemize( it() for copying from a remote rsync server to the local machine. This is invoked when the source path contains a :: - separator or a rsync:// URL. + separator or an rsync:// URL. it() for copying from the local machine to a remote rsync server. This is invoked when the destination path contains a :: - separator or a rsync:// URL. + separator or an rsync:// URL. it() for copying from a remote machine using a remote shell program as the transport, using rsync server on the remote @@ -126,7 +126,7 @@ quote(rsync -avz foo:src/bar /data/tmp) This would recursively transfer all files from the directory src/bar on the machine foo into the /data/tmp/bar directory on the local machine. The files are transferred in "archive" mode, which ensures that symbolic -links, devices, attributes, permissions, ownerships etc are preserved +links, devices, attributes, permissions, ownerships, etc. are preserved in the transfer. Additionally, compression will be used to reduce the size of data portions of the transfer. @@ -170,7 +170,7 @@ that: itemize( it() you use a double colon :: instead of a single colon to - separate the hostname from the path or a rsync:// URL. + separate the hostname from the path or an rsync:// URL. it() the remote server may print a message of the day when you connect. @@ -290,9 +290,9 @@ verb( --suffix=SUFFIX backup suffix (default ~ w/o --backup-dir) -u, --update update only (don't overwrite newer files) -l, --links copy symlinks as symlinks - -L, --copy-links copy the referent of symlinks - --copy-unsafe-links copy links outside the source tree - --safe-links ignore links outside the destination tree + -L, --copy-links copy the referent of all symlinks + --copy-unsafe-links copy the referent of "unsafe" symlinks + --safe-links ignore "unsafe" symlinks -H, --hard-links preserve hard links -p, --perms preserve permissions -o, --owner preserve owner (root only) @@ -312,12 +312,12 @@ verb( --delete delete files that don't exist on sender --delete-excluded also delete excluded files on receiver --delete-after receiver deletes after transfer, not before - --ignore-errors delete even if there are IO errors + --ignore-errors delete even if there are I/O errors --max-delete=NUM don't delete more than NUM files --partial keep partially transferred files --force force deletion of dirs even if not empty --numeric-ids don't map uid/gid values by user/group name - --timeout=TIME set IO timeout in seconds + --timeout=TIME set I/O timeout in seconds -I, --ignore-times turn off mod time & file size quick check --size-only ignore mod time for quick check (use size) --modify-window=NUM compare mod times with reduced accuracy @@ -334,12 +334,12 @@ verb( --files-from=FILE read FILE for list of source-file names -0 --from0 all file lists are delimited by nulls --version print version number - --daemon run as a rsync daemon + --daemon run as an rsync daemon --no-detach do not detach from the parent --address=ADDRESS bind to the specified address --config=FILE specify alternate rsyncd.conf file --port=PORT specify alternate rsyncd port number - --blocking-io use blocking IO for the remote shell + --blocking-io use blocking I/O for the remote shell --no-blocking-io turn off --blocking-io --stats give some file transfer stats --progress show progress during transfer @@ -471,15 +471,15 @@ dit(bf(-l, --links)) When symlinks are encountered, recreate the symlink on the destination. dit(bf(-L, --copy-links)) When symlinks are encountered, the file that -they point to is copied, rather than the symlink. +they point to (the referent) is copied, rather than the symlink. dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of -symbolic links that point outside the source tree. Absolute symlinks +symbolic links that point outside the copied tree. Absolute symlinks are also treated like ordinary files, and so are any symlinks in the source path itself when --relative is used. dit(bf(--safe-links)) This tells rsync to ignore any symbolic links -which point outside the destination tree. All absolute symlinks are +which point outside the copied tree. All absolute symlinks are also ignored. Using this option in conjunction with --relative may give unexpected results. @@ -512,15 +512,16 @@ other files (including updated files) retain their existing permissions dit(bf(-o, --owner)) This option causes rsync to set the owner of the destination file to be the same as the source file. On most systems, -only the super-user can set file ownership. Note that if the remote system -is a daemon using chroot, the --numeric-ids option is implied because the -remote system cannot get access to the usernames from /etc/passwd. +only the super-user can set file ownership. By default, the preservation +is done by name, but may fall back to using the ID number in some +circumstances. See the --numeric-ids option for a full discussion. dit(bf(-g, --group)) This option causes rsync to set the group of the destination file to be the same as the source file. If the receiving program 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). +receiver is a member of will be preserved. By default, the preservation +is done by name, but may fall back to using the ID number in some +circumstances. See the --numeric-ids option for a full discussion. dit(bf(-D, --devices)) This option causes rsync to transfer character and block device information to the remote system to recreate these @@ -569,7 +570,7 @@ 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 +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 prevent temporary filesystem failures (such as NFS errors) on the sending side causing a massive deletion of files on the @@ -586,7 +587,7 @@ sufficient space on the receiving filesystem. If you want to delete after transferring, use the --delete-after switch. Implies --delete. dit(bf(--ignore-errors)) Tells --delete to go ahead and delete files -even when there are IO errors. +even when there are I/O errors. dit(bf(--force)) This options tells rsync to delete directories even if they are not empty when they are to be replaced by non-directories. This @@ -651,8 +652,7 @@ useful in combination with a recursive transfer. You may use as many --exclude options on the command line as you like to build up the list of files to exclude. -See the EXCLUDE PATTERNS section for information on the syntax of -this option. +See the EXCLUDE PATTERNS section for detailed information on this option. dit(bf(--exclude-from=FILE)) This option is similar to the --exclude option, but instead it adds all exclude patterns listed in the file @@ -664,8 +664,7 @@ dit(bf(--include=PATTERN)) This option tells rsync to not exclude the specified pattern of filenames. This is useful as it allows you to build up quite complex exclude/include rules. -See the EXCLUDE PATTERNS section for information on the syntax of -this option. +See the EXCLUDE PATTERNS section for detailed information on this option. dit(bf(--include-from=FILE)) This specifies a list of include patterns from a file. @@ -756,11 +755,14 @@ what ownership to give files. The special uid 0 and the special group 0 are never mapped via user/group names even if the --numeric-ids option is not specified. -If the source system is a daemon using chroot, or if a user or group -name does not exist on the destination system, then the numeric ID -from the source system is used instead. +If a user or group has no name on the source system or it has no match +on the destination system, then the numeric ID +from the source system is used instead. See also the comments on the +"use chroot" setting in the rsyncd.conf manpage for information on how +the chroot setting affects rsync's ability to look up the names of the +users and groups and what you can do about it. -dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO +dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O timeout in seconds. If no data is transferred for the specified time then rsync will exit. The default is 0, which means no timeout. @@ -799,11 +801,11 @@ the default is rsyncd.conf in the current directory (typically $HOME). dit(bf(--port=PORT)) This specifies an alternate TCP port number to use rather than the default port 873. -dit(bf(--blocking-io)) This tells rsync to use blocking IO when launching +dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching a remote shell transport. If the remote shell is either rsh or remsh, rsync defaults to using -blocking IO, otherwise it defaults to using non-blocking IO. (Note that -ssh prefers non-blocking IO.) +blocking I/O, otherwise it defaults to using non-blocking I/O. (Note that +ssh prefers non-blocking I/O.) dit(bf(--no-blocking-io)) Turn off --blocking-io, for use when it is the default. @@ -857,7 +859,7 @@ 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 +is only useful when accessing an rsync server using the built in transport, not when using a remote shell as the transport. The file must not be world readable. It should contain just the password as a single line. @@ -1130,8 +1132,8 @@ was made to manipulate 64-bit files on a platform that cannot support them; or an option was specifed that is supported by the client and not by the server. dit(bf(5)) Error starting client-server protocol -dit(bf(10)) Error in socket IO -dit(bf(11)) Error in file IO +dit(bf(10)) Error in socket I/O +dit(bf(11)) Error in file I/O dit(bf(12)) Error in rsync protocol data stream dit(bf(13)) Errors with program diagnostics dit(bf(14)) Error in IPC code @@ -1160,12 +1162,12 @@ 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 +password allows you to run authenticated rsync connections to an rsync daemon without user intervention. Note that this does not supply a password to a shell transport such as ssh. dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables -are used to determine the default username sent to a rsync server. +are used to determine the default username sent to an rsync server. dit(bf(HOME)) The HOME environment variable is used to find the user's default .cvsignore file. @@ -1190,7 +1192,7 @@ When transferring to FAT filesystems rsync may resync unmodified files. See the comments on the --modify-window option. -file permissions, devices etc are transferred as native numerical +file permissions, devices, etc. are transferred as native numerical values see also the comments on the --delete option