X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/b72f24c7190fde1c15662d52c8d62789bd2086ad..298c10d5bb83a6c3fc1ee6583383c6ae26e12751:/rsync.yo diff --git a/rsync.yo b/rsync.yo index 893c0bae..9847ac90 100644 --- a/rsync.yo +++ b/rsync.yo @@ -187,6 +187,57 @@ quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba") this is launched from cron every few hours. +manpagesection(OPTIONS SUMMARY) + +Here is a short summary of the options avalable in rsync. Please refer +to the detailed description below for a complete description. + +verb( + -v, --verbose increase verbosity + -c, --checksum always checksum + -a, --archive archive mode + -r, --recursive recurse into directories + -R, --relative use relative path names + -b, --backup make backups (default ~ extension) + -u, --update update only (don't overwrite newer files) + -l, --links preserve soft links + -L, --copy-links treat soft links like regular files + -H, --hard-links preserve hard links + -p, --perms preserve permissions + -o, --owner preserve owner (root only) + -g, --group preserve group + -D, --devices preserve devices (root only) + -t, --times preserve times + -S, --sparse handle sparse files efficiently + -n, --dry-run show what would have been transferred + -W, --whole-file copy whole files, no incremental checks + -x, --one-file-system don't cross filesystem boundaries + -B, --block-size=SIZE checksum blocking size + -e, --rsh=COMMAND specify rsh replacement + --rsync-path=PATH specify 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 + --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 + --timeout=TIME set IO timeout in seconds + -I, --ignore-times don't exclude files that match length and time + -T --temp-dir=DIR create temporary files in directory DIR + -z, --compress compress file data + --exclude=PATTERN exclude file FILE + --exclude-from=PATTERN exclude files listed in FILE + --include=PATTERN don't exclude file FILE + --include-from=PATTERN don't exclude files listed in FILE + --suffix=SUFFIX override backup suffix + --version print version number + --daemon run as a rsync daemon + --config=FILE specify alternate rsyncd.conf file + --port=PORT specify alternate rsyncd port number + --stats give some file transfer stats + --progress show progress during transfer + -h, --help show this help screen +) + manpageoptions() rsync uses the GNU long options package. Many of the command line @@ -269,6 +320,12 @@ 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. @@ -388,7 +445,7 @@ dit(bf(--csum-length LENGTH)) By default the primary checksum used in rsync is a very strong 16 byte MD4 checksum. In most cases you will find that a truncated version of this checksum is quite efficient, and this will decrease the size of the checksum data sent over the link, -making things faster. +making things faster. You can choose the number of bytes in the truncated checksum using the --csum-length option. Any value less than or equal to 16 is valid. @@ -398,6 +455,11 @@ with an incorrect target file. The risk with a value of 16 is microscopic and can be safely ignored (the universe will probably end before it fails) but with smaller values the risk is higher. +Current versions of rsync actually use an adaptive algorithm for the +checksum length by default, using a 16 byte file checksum to determine +if a 2nd pass is required with a longer block checksum. Only use this +option if you have read the source code and know what you are doing. + dit(bf(-T, --temp-dir DIR)) This options instructs rsync to use DIR as a scratch directory when creating a temporary copies of the files transferred on the receiving side. The default behavior is to create @@ -425,9 +487,9 @@ option is not specified. If a user or group name does not exist on the destination system then the numeric id from the source system is used instead. -dit(bf(--timeout)) This option allows you to set a maximum IO timeout in -seconds. If no data is transferred for the specified time then rsync -will exit. The default is 0, which means no timeout. +dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO +timeout in seconds. If no data is transferred for the specified time +then rsync will exit. The default is 0, which means no timeout. dit(bf(--daemon)) This tells rsync that it is to run as a rsync daemon. If standard input is a socket then rsync will assume that it @@ -446,7 +508,12 @@ rather than the default port 873. 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. +algorithm is for your data. This option only works in conjunction with +the -v (verbose) option. + +dit(bf(--progress)) This option tells rsync to print information +showing the progress of the transfer. This gives a bored user +something to watch. enddit() @@ -492,6 +559,9 @@ itemize( it() if the pattern starts with "- " (a minus followed by a space) then it is always considered a exclude pattern, even if specified as part of an include option. The "- " part is discarded before matching. + + it() if the pattern is a single exclamation mark ! then the current + exclude list is reset, removing all previous exclude patterns. ) The +/- rules are most useful in exclude lists, allowing you to have a @@ -507,6 +577,31 @@ itemize( directories and C source files. ) +manpagesection(ENVIRONMENT VARIABLES) + +startdit() + +dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any +ignore patterns in .cvsignore files. See the --cvs-exclude option for +more details. + +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_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 +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. + +dit(bf(HOME)) The HOME environment variable is used to find the users +default .cvsignore file. + +enddit() + manpagefiles() /etc/rsyncd.conf