X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/8d69d57113c7dccefa50638f3cb91d6a6a208e5f..ea5164d18118edc0d980795bfa760e5384c8d286:/rsync.yo diff --git a/rsync.yo b/rsync.yo index 6751ea27..bc3b713f 100644 --- a/rsync.yo +++ b/rsync.yo @@ -1,5 +1,5 @@ mailto(rsync-bugs@samba.org) -manpage(rsync)(1)(25 Jan 2002)()() +manpage(rsync)(1)(26 Jan 2003)()() manpagename(rsync)(faster, flexible replacement for rcp) manpagesynopsis() @@ -25,7 +25,7 @@ greatly speed up file transfers when the destination file already exists. The rsync remote-update protocol allows rsync to transfer just the -differences between two sets of files across the network link, using +differences between two sets of files across the network connection, using an efficient checksum-search algorithm described in the technical report that accompanies this package. @@ -212,9 +212,12 @@ used to check against the rsyncd.conf on the remote host. manpagesection(RUNNING AN RSYNC SERVER) -An rsync server is configured using a config file which by default is -called /etc/rsyncd.conf. Please see the rsyncd.conf(5) man page for more -information. +An rsync server is configured using a config file. Please see the +rsyncd.conf(5) man page for more information. By default the configuration +file is called /etc/rsyncd.conf, unless rsync is running over a remote +shell program and is not running as root; in that case, the default name +is rsyncd.conf in the current directory on the remote computer +(typically $HOME). manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) @@ -234,10 +237,10 @@ quote(rsync --server --daemon .) NOTE: rsync's argument parsing expects the trailing ".", so make sure that it's there. If you want to use a rsyncd.conf(5)-style -configuration file other than /etc/rsyncd.conf, you can added a ---config-file option to the em(command): +configuration file other than the default, you can added a +--config option to the em(command): -quote(rsync --server --daemon --config-file=em(file) .) +quote(rsync --server --daemon --config=em(file) .) manpagesection(EXAMPLES) @@ -248,7 +251,7 @@ files and mail folders, I use a cron job that runs quote(rsync -Cavz . arvidsjaur:backup) -each night over a PPP link to a duplicate directory on my machine +each night over a PPP connection to a duplicate directory on my machine "arvidsjaur". To synchronize my samba source trees I use the following Makefile @@ -263,7 +266,7 @@ quote( get:nl() sync: get put) this allows me to sync with a CVS directory at the other end of the -link. I then do cvs operations on the remote machine, which saves a +connection. I then do cvs operations on the remote machine, which saves a lot of time as the remote cvs protocol isn't very efficient. I mirror a directory between my "old" and "new" ftp sites with the @@ -282,7 +285,7 @@ verb( -v, --verbose increase verbosity -q, --quiet decrease verbosity -c, --checksum always checksum - -a, --archive archive mode + -a, --archive archive mode, equivalent to -rlptgoD -r, --recursive recurse into directories -R, --relative use relative path names -b, --backup make backups (default ~ suffix) @@ -324,6 +327,7 @@ verb( --modify-window=NUM Timestamp window (seconds) for file match (default=0) -T --temp-dir=DIR create temporary files in directory DIR --compare-dest=DIR also compare destination files relative to DIR + --link-dest=DIR create hardlinks to DIR for unchanged files -P equivalent to --partial --progress -z, --compress compress file data --exclude=PATTERN exclude files matching PATTERN @@ -392,8 +396,8 @@ dit(bf(--modify-window)) When comparing two timestamps rsync treats the timestamps as being equal if they are within the value of modify_window. This is normally zero, but you may find it useful to set this to a larger value in some situations. In particular, when -transferring to/from FAT filesystems which cannot represent times with -a 1 second resolution this option is useful. +transferring to Windows FAT filesystems which cannot represent times +with a 1 second resolution --modify-window=1 is useful. dit(bf(-c, --checksum)) This forces the sender to checksum all files using a 128-bit MD4 checksum before transfer. The checksum is then @@ -617,6 +621,8 @@ dit(bf(--exclude-from=FILE)) This option is similar to the --exclude option, but instead it adds all exclude patterns listed in the file FILE to the exclude list. Blank lines in FILE and lines starting with ';' or '#' are ignored. +If em(FILE) is bf(-) the list will be read from standard input. + dit(bf(--include=PATTERN)) This option tells rsync to not exclude the specified pattern of filenames. This is useful as it allows you to @@ -627,6 +633,8 @@ this option. dit(bf(--include-from=FILE)) This specifies a list of include patterns from a file. +If em(FILE) is bf(-) the list will be read from standard input. + dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a broad range of files that you often don't want to transfer between @@ -635,7 +643,7 @@ a file should be ignored. The exclude list is initialized to: -quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state +quote(RCS/ SCCS/ CVS/ .svn/ CVS.adm RCSLOG cvslog.* tags TAGS .make.state .nse_depinfo *~ #* .#* ,* *.old *.bak *.BAK *.orig *.rej .del-* *.a *.o *.obj *.so *.Z *.elc *.ln core) @@ -646,25 +654,6 @@ Finally, any file is ignored if it is in the same directory as a .cvsignore file and matches one of the patterns listed therein. See the bf(cvs(1)) manual for more information. -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. - -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. - -Note that if you use this option then you run the risk of ending up -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 option instructs rsync to use DIR as a scratch directory when creating temporary copies of the files transferred on the receiving side. The default behavior is to create @@ -672,19 +661,25 @@ the temporary files in the receiving directory. dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR on the destination machine as an additional directory to compare destination -files against when doing transfers. This is useful for doing transfers to -a new destination while leaving existing files intact, and then doing a +files against when doing transfers if the files are missing in the +destination directory. This is useful for doing transfers to a new +destination while leaving existing files intact, and then doing a flash-cutover when all files have been successfully transferred (for example by moving directories around and removing the old directory, -although this requires also doing the transfer with -I to avoid skipping -files that haven't changed). This option increases the usefulness of ---partial because partially transferred files will remain in the new -temporary destination until they have a chance to be completed. If DIR is -a relative path, it is relative to the destination directory. +although this skips files that haven't changed; see also --link-dest). +This option increases the usefulness of --partial because partially +transferred files will remain in the new temporary destination until they +have a chance to be completed. If DIR is a relative path, it is relative +to the destination directory. + +dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but +also will create hard links from em(DIR) to the destination directory for +unchanged files. Files with changed ownership or permissions will not be +linked. dit(bf(-z, --compress)) With this option, rsync compresses any data from the files that it sends to the destination machine. This -option is useful on slow links. The compression method used is the +option is useful on slow connections. The compression method used is the same method that gzip uses. Note this this option typically achieves better compression ratios @@ -716,7 +711,7 @@ bf(rsync://host/module/) syntax. If standard input is a socket then rsync will assume that it is being run via inetd, otherwise it will detach from the current terminal and become a background daemon. The daemon will read the config file -(/etc/rsyncd.conf) on each connect made by a client and respond to +(rsyncd.conf) on each connect made by a client and respond to requests accordingly. See the rsyncd.conf(5) man page for more details. @@ -736,8 +731,10 @@ 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. +the default. This is only relevant when --daemon is specified. +The default is /etc/rsyncd.conf unless the daemon is running over +a remote shell program and the remote user is not root; in that case +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. @@ -1082,7 +1079,7 @@ enddit() manpagefiles() -/etc/rsyncd.conf +/etc/rsyncd.conf or rsyncd.conf manpageseealso() @@ -1094,16 +1091,17 @@ manpagebugs() times are transferred as unix time_t values +When transferring to FAT filesystmes rsync may resync +unmodified files. +See the comments on the --modify-window option. + file permissions, devices etc are transferred as native numerical values see also the comments on the --delete option -Please report bugs! The rsync bug tracking system is online at -url(http://rsync.samba.org/rsync/)(http://rsync.samba.org/rsync/) - -manpagesection(VERSION) -This man page is current for version 2.0 of rsync +Please report bugs! See the website at +url(http://rsync.samba.org/)(http://rsync.samba.org/) manpagesection(CREDITS)