X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/ec40899bb9461b0aaa9b3f5c7fc4d6d321932bb8..71020fc3aafc1cea58188b261b0f9f5b0c29b5f8:/rsync.yo diff --git a/rsync.yo b/rsync.yo index 96829ee5..acc3e9c0 100644 --- a/rsync.yo +++ b/rsync.yo @@ -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 @@ -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) @@ -334,7 +334,7 @@ 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 @@ -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,20 +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. The preservation is done -primarily by name, but falls back to using the ID number if the ID has -no name on the sending side or has no match on the receiving side. -See also the --numeric-ids option and the "use chroot" setting in the -rsyncd.conf manpage. +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. The preservation is done -primarily by name, but falls back to using the ID number if the ID has -no name on the sending side or has no match on the receiving side. -See also the --numeric-ids option and the "use chroot" setting in the -rsyncd.conf manpage. +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 @@ -656,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 @@ -669,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. @@ -764,7 +758,9 @@ option is not specified. 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. +"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 I/O timeout in seconds. If no data is transferred for the specified time @@ -863,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. @@ -1166,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.