X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/bef493404517020b3c863c90d5d26f50bbf0bc74..089a2435f83439a7eb68a539fd99d39b220df120:/rsync.yo diff --git a/rsync.yo b/rsync.yo index 9df6b6f4..8d68958b 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() @@ -15,6 +15,8 @@ rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST] +rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST + manpagedescription() rsync is a program that behaves in much the same way that rcp does, @@ -63,7 +65,7 @@ itemize( it() for copying from the local machine to a remote rsync server. This is invoked when the destination path contains a :: - separator. + separator or a rsync:// URL. it() for copying from a remote machine using a remote shell program as the transport, using rsync server on the remote @@ -163,7 +165,7 @@ that: itemize( it() you use a double colon :: instead of a single colon to - separate the hostname from the path. + separate the hostname from the path or a rsync:// URL. it() the remote server may print a message of the day when you connect. @@ -210,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) @@ -232,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) @@ -280,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) @@ -322,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 @@ -580,7 +586,8 @@ If this option is used with bf([user@]host::module/path), then the remote shell em(COMMMAND) will be used to run an rsync server on the remote host, and all data will be transmitted through that remote shell connection, rather than through a direct socket connection to a -running rsync server on the remote host. +running rsync server on the remote host. See the section "CONNECTING +TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM" above. Command-line arguments are permitted in COMMAND provided that COMMAND is presented to rsync as a single argument. For example: @@ -614,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 @@ -624,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 @@ -632,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) @@ -669,15 +680,21 @@ 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 @@ -713,7 +730,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. @@ -733,8 +750,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. @@ -1079,7 +1098,7 @@ enddit() manpagefiles() -/etc/rsyncd.conf +/etc/rsyncd.conf or rsyncd.conf manpageseealso()