Document the --no-motd option, with a caveat on how it can also
[rsync.git] / rsync.yo
1 mailto(rsync-bugs@samba.org)
2 manpage(rsync)(1)(14 Oct 2006)()()
3 manpagename(rsync)(faster, flexible replacement for rcp)
4 manpagesynopsis()
5
6 rsync [OPTION]... SRC [SRC]... DEST
7
8 rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST
9
10 rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST
11
12 rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST
13
14 rsync [OPTION]... SRC
15
16 rsync [OPTION]... [USER@]HOST:SRC [DEST]
17
18 rsync [OPTION]... [USER@]HOST::SRC [DEST]
19
20 rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]
21
22 manpagedescription()
23
24 rsync is a program that behaves in much the same way that rcp does,
25 but has many more options and uses the rsync remote-update protocol to
26 greatly speed up file transfers when the destination file is being
27 updated.
28
29 The rsync remote-update protocol allows rsync to transfer just the
30 differences between two sets of files across the network connection, using
31 an efficient checksum-search algorithm described in the technical
32 report that accompanies this package.
33
34 Some of the additional features of rsync are:
35
36 itemization(
37   it() support for copying links, devices, owners, groups, and permissions
38   it() exclude and exclude-from options similar to GNU tar
39   it() a CVS exclude mode for ignoring the same files that CVS would ignore
40   it() can use any transparent remote shell, including ssh or rsh
41   it() does not require super-user privileges
42   it() pipelining of file transfers to minimize latency costs
43   it() support for anonymous or authenticated rsync daemons (ideal for
44        mirroring)
45 )
46
47 manpagesection(GENERAL)
48
49 Rsync copies files either to or from a remote host, or locally on the
50 current host (it does not support copying files between two remote hosts).
51
52 There are two different ways for rsync to contact a remote system: using a
53 remote-shell program as the transport (such as ssh or rsh) or contacting an
54 rsync daemon directly via TCP.  The remote-shell transport is used whenever
55 the source or destination path contains a single colon (:) separator after
56 a host specification.  Contacting an rsync daemon directly happens when the
57 source or destination path contains a double colon (::) separator after a
58 host specification, OR when an rsync:// URL is specified (see also the
59 "USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION" section for
60 an exception to this latter rule).
61
62 As a special case, if a single source arg is specified without a
63 destination, the files are listed in an output format similar to "ls -l".
64
65 As expected, if neither the source or destination path specify a remote
66 host, the copy occurs locally (see also the bf(--list-only) option).
67
68 manpagesection(SETUP)
69
70 See the file README for installation instructions.
71
72 Once installed, you can use rsync to any machine that you can access via
73 a remote shell (as well as some that you can access using the rsync
74 daemon-mode protocol).  For remote transfers, a modern rsync uses ssh
75 for its communications, but it may have been configured to use a
76 different remote shell by default, such as rsh or remsh.
77
78 You can also specify any remote shell you like, either by using the bf(-e)
79 command line option, or by setting the RSYNC_RSH environment variable.
80
81 Note that rsync must be installed on both the source and destination
82 machines.
83
84 manpagesection(USAGE)
85
86 You use rsync in the same way you use rcp. You must specify a source
87 and a destination, one of which may be remote.
88
89 Perhaps the best way to explain the syntax is with some examples:
90
91 quote(tt(rsync -t *.c foo:src/))
92
93 This would transfer all files matching the pattern *.c from the
94 current directory to the directory src on the machine foo. If any of
95 the files already exist on the remote system then the rsync
96 remote-update protocol is used to update the file by sending only the
97 differences. See the tech report for details.
98
99 quote(tt(rsync -avz foo:src/bar /data/tmp))
100
101 This would recursively transfer all files from the directory src/bar on the
102 machine foo into the /data/tmp/bar directory on the local machine. The
103 files are transferred in "archive" mode, which ensures that symbolic
104 links, devices, attributes, permissions, ownerships, etc. are preserved
105 in the transfer.  Additionally, compression will be used to reduce the
106 size of data portions of the transfer.
107
108 quote(tt(rsync -avz foo:src/bar/ /data/tmp))
109
110 A trailing slash on the source changes this behavior to avoid creating an
111 additional directory level at the destination.  You can think of a trailing
112 / on a source as meaning "copy the contents of this directory" as opposed
113 to "copy the directory by name", but in both cases the attributes of the
114 containing directory are transferred to the containing directory on the
115 destination.  In other words, each of the following commands copies the
116 files in the same way, including their setting of the attributes of
117 /dest/foo:
118
119 quote(
120 tt(rsync -av /src/foo /dest)nl()
121 tt(rsync -av /src/foo/ /dest/foo)nl()
122 )
123
124 Note also that host and module references don't require a trailing slash to
125 copy the contents of the default directory.  For example, both of these
126 copy the remote directory's contents into "/dest":
127
128 quote(
129 tt(rsync -av host: /dest)nl()
130 tt(rsync -av host::module /dest)nl()
131 )
132
133 You can also use rsync in local-only mode, where both the source and
134 destination don't have a ':' in the name. In this case it behaves like
135 an improved copy command.
136
137 Finally, you can list all the (listable) modules available from a
138 particular rsync daemon by leaving off the module name:
139
140 quote(tt(rsync somehost.mydomain.com::))
141
142 See the following section for more details.
143
144 manpagesection(ADVANCED USAGE)
145
146 The syntax for requesting multiple files from a remote host involves using
147 quoted spaces in the SRC.  Some examples:
148
149 quote(tt(rsync host::'modname/dir1/file1 modname/dir2/file2' /dest))
150
151 This would copy file1 and file2 into /dest from an rsync daemon.  Each
152 additional arg must include the same "modname/" prefix as the first one,
153 and must be preceded by a single space.  All other spaces are assumed
154 to be a part of the filenames.
155
156 quote(tt(rsync -av host:'dir1/file1 dir2/file2' /dest))
157
158 This would copy file1 and file2 into /dest using a remote shell.  This
159 word-splitting is done by the remote shell, so if it doesn't work it means
160 that the remote shell isn't configured to split its args based on
161 whitespace (a very rare setting, but not unknown).  If you need to transfer
162 a filename that contains whitespace, you'll need to either escape the
163 whitespace in a way that the remote shell will understand, or use wildcards
164 in place of the spaces.  Two examples of this are:
165
166 quote(
167 tt(rsync -av host:'file\ name\ with\ spaces' /dest)nl()
168 tt(rsync -av host:file?name?with?spaces /dest)nl()
169 )
170
171 This latter example assumes that your shell passes through unmatched
172 wildcards.  If it complains about "no match", put the name in quotes.
173
174 manpagesection(CONNECTING TO AN RSYNC DAEMON)
175
176 It is also possible to use rsync without a remote shell as the transport.
177 In this case you will directly connect to a remote rsync daemon, typically
178 using TCP port 873.  (This obviously requires the daemon to be running on
179 the remote system, so refer to the STARTING AN RSYNC DAEMON TO ACCEPT
180 CONNECTIONS section below for information on that.)
181
182 Using rsync in this way is the same as using it with a remote shell except
183 that:
184
185 itemization(
186         it() you either use a double colon :: instead of a single colon to
187         separate the hostname from the path, or you use an rsync:// URL.
188         it() the first word of the "path" is actually a module name.
189         it() the remote daemon may print a message of the day when you
190         connect.
191         it() if you specify no path name on the remote daemon then the
192         list of accessible paths on the daemon will be shown.
193         it() if you specify no local destination then a listing of the
194         specified files on the remote daemon is provided.
195         it() you must not specify the bf(--rsh) (bf(-e)) option.
196 )
197
198 An example that copies all the files in a remote module named "src":
199
200 verb(    rsync -av host::src /dest)
201
202 Some modules on the remote daemon may require authentication. If so,
203 you will receive a password prompt when you connect. You can avoid the
204 password prompt by setting the environment variable RSYNC_PASSWORD to
205 the password you want to use or using the bf(--password-file) option. This
206 may be useful when scripting rsync.
207
208 WARNING: On some systems environment variables are visible to all
209 users. On those systems using bf(--password-file) is recommended.
210
211 You may establish the connection via a web proxy by setting the
212 environment variable RSYNC_PROXY to a hostname:port pair pointing to
213 your web proxy.  Note that your web proxy's configuration must support
214 proxy connections to port 873.
215
216 manpagesection(USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION)
217
218 It is sometimes useful to use various features of an rsync daemon (such as
219 named modules) without actually allowing any new socket connections into a
220 system (other than what is already required to allow remote-shell access).
221 Rsync supports connecting to a host using a remote shell and then spawning
222 a single-use "daemon" server that expects to read its config file in the
223 home dir of the remote user.  This can be useful if you want to encrypt a
224 daemon-style transfer's data, but since the daemon is started up fresh by
225 the remote user, you may not be able to use features such as chroot or
226 change the uid used by the daemon.  (For another way to encrypt a daemon
227 transfer, consider using ssh to tunnel a local port to a remote machine and
228 configure a normal rsync daemon on that remote host to only allow
229 connections from "localhost".)
230
231 From the user's perspective, a daemon transfer via a remote-shell
232 connection uses nearly the same command-line syntax as a normal
233 rsync-daemon transfer, with the only exception being that you must
234 explicitly set the remote shell program on the command-line with the
235 bf(--rsh=COMMAND) option.  (Setting the RSYNC_RSH in the environment
236 will not turn on this functionality.)  For example:
237
238 verb(    rsync -av --rsh=ssh host::module /dest)
239
240 If you need to specify a different remote-shell user, keep in mind that the
241 user@ prefix in front of the host is specifying the rsync-user value (for a
242 module that requires user-based authentication).  This means that you must
243 give the '-l user' option to ssh when specifying the remote-shell, as in
244 this example that uses the short version of the bf(--rsh) option:
245
246 verb(    rsync -av -e "ssh -l ssh-user" rsync-user@host::module /dest)
247
248 The "ssh-user" will be used at the ssh level; the "rsync-user" will be
249 used to log-in to the "module".
250
251 manpagesection(STARTING AN RSYNC DAEMON TO ACCEPT CONNECTIONS)
252
253 In order to connect to an rsync daemon, the remote system needs to have a
254 daemon already running (or it needs to have configured something like inetd
255 to spawn an rsync daemon for incoming connections on a particular port).
256 For full information on how to start a daemon that will handling incoming
257 socket connections, see the bf(rsyncd.conf)(5) man page -- that is the config
258 file for the daemon, and it contains the full details for how to run the
259 daemon (including stand-alone and inetd configurations).
260
261 If you're using one of the remote-shell transports for the transfer, there is
262 no need to manually start an rsync daemon.
263
264 manpagesection(EXAMPLES)
265
266 Here are some examples of how I use rsync.
267
268 To backup my wife's home directory, which consists of large MS Word
269 files and mail folders, I use a cron job that runs
270
271 quote(tt(rsync -Cavz . arvidsjaur:backup))
272
273 each night over a PPP connection to a duplicate directory on my machine
274 "arvidsjaur".
275
276 To synchronize my samba source trees I use the following Makefile
277 targets:
278
279 verb(    get:
280             rsync -avuzb --exclude '*~' samba:samba/ .
281     put:
282             rsync -Cavuzb . samba:samba/
283     sync: get put)
284
285 this allows me to sync with a CVS directory at the other end of the
286 connection. I then do CVS operations on the remote machine, which saves a
287 lot of time as the remote CVS protocol isn't very efficient.
288
289 I mirror a directory between my "old" and "new" ftp sites with the
290 command:
291
292 tt(rsync -az -e ssh --delete ~ftp/pub/samba nimbus:"~ftp/pub/tridge")
293
294 This is launched from cron every few hours.
295
296 manpagesection(OPTIONS SUMMARY)
297
298 Here is a short summary of the options available in rsync. Please refer
299 to the detailed description below for a complete description.  verb(
300  -v, --verbose               increase verbosity
301  -q, --quiet                 suppress non-error messages
302      --no-motd               suppress daemon-mode MOTD (see caveat)
303  -c, --checksum              skip based on checksum, not mod-time & size
304  -a, --archive               archive mode; same as -rlptgoD (no -H)
305      --no-OPTION             turn off an implied OPTION (e.g. --no-D)
306  -r, --recursive             recurse into directories
307  -R, --relative              use relative path names
308      --no-implied-dirs       don't send implied dirs with --relative
309  -b, --backup                make backups (see --suffix & --backup-dir)
310      --backup-dir=DIR        make backups into hierarchy based in DIR
311      --suffix=SUFFIX         backup suffix (default ~ w/o --backup-dir)
312  -u, --update                skip files that are newer on the receiver
313      --inplace               update destination files in-place
314      --append                append data onto shorter files
315  -d, --dirs                  transfer directories without recursing
316  -l, --links                 copy symlinks as symlinks
317  -L, --copy-links            transform symlink into referent file/dir
318      --copy-unsafe-links     only "unsafe" symlinks are transformed
319      --safe-links            ignore symlinks that point outside the tree
320  -k, --copy-dirlinks         transform symlink to dir into referent dir
321  -K, --keep-dirlinks         treat symlinked dir on receiver as dir
322  -H, --hard-links            preserve hard links
323  -p, --perms                 preserve permissions
324  -E, --executability         preserve executability
325      --chmod=CHMOD           affect file and/or directory permissions
326  -o, --owner                 preserve owner (super-user only)
327  -g, --group                 preserve group
328      --devices               preserve device files (super-user only)
329      --specials              preserve special files
330  -D                          same as --devices --specials
331  -t, --times                 preserve times
332  -O, --omit-dir-times        omit directories when preserving times
333      --super                 receiver attempts super-user activities
334  -S, --sparse                handle sparse files efficiently
335  -n, --dry-run               show what would have been transferred
336  -W, --whole-file            copy files whole (without rsync algorithm)
337  -x, --one-file-system       don't cross filesystem boundaries
338  -B, --block-size=SIZE       force a fixed checksum block-size
339  -e, --rsh=COMMAND           specify the remote shell to use
340      --rsync-path=PROGRAM    specify the rsync to run on remote machine
341      --existing              skip creating new files on receiver
342      --ignore-existing       skip updating files that exist on receiver
343      --remove-source-files   sender removes synchronized files (non-dir)
344      --del                   an alias for --delete-during
345      --delete                delete extraneous files from dest dirs
346      --delete-before         receiver deletes before transfer (default)
347      --delete-during         receiver deletes during xfer, not before
348      --delete-after          receiver deletes after transfer, not before
349      --delete-excluded       also delete excluded files from dest dirs
350      --ignore-errors         delete even if there are I/O errors
351      --force                 force deletion of dirs even if not empty
352      --max-delete=NUM        don't delete more than NUM files
353      --max-size=SIZE         don't transfer any file larger than SIZE
354      --min-size=SIZE         don't transfer any file smaller than SIZE
355      --partial               keep partially transferred files
356      --partial-dir=DIR       put a partially transferred file into DIR
357      --delay-updates         put all updated files into place at end
358  -m, --prune-empty-dirs      prune empty directory chains from file-list
359      --numeric-ids           don't map uid/gid values by user/group name
360      --timeout=TIME          set I/O timeout in seconds
361  -I, --ignore-times          don't skip files that match size and time
362      --size-only             skip files that match in size
363      --modify-window=NUM     compare mod-times with reduced accuracy
364  -T, --temp-dir=DIR          create temporary files in directory DIR
365  -y, --fuzzy                 find similar file for basis if no dest file
366      --compare-dest=DIR      also compare received files relative to DIR
367      --copy-dest=DIR         ... and include copies of unchanged files
368      --link-dest=DIR         hardlink to files in DIR when unchanged
369  -z, --compress              compress file data during the transfer
370      --compress-level=NUM    explicitly set compression level
371  -C, --cvs-exclude           auto-ignore files in the same way CVS does
372  -f, --filter=RULE           add a file-filtering RULE
373  -F                          same as --filter='dir-merge /.rsync-filter'
374                              repeated: --filter='- .rsync-filter'
375      --exclude=PATTERN       exclude files matching PATTERN
376      --exclude-from=FILE     read exclude patterns from FILE
377      --include=PATTERN       don't exclude files matching PATTERN
378      --include-from=FILE     read include patterns from FILE
379      --files-from=FILE       read list of source-file names from FILE
380  -0, --from0                 all *from/filter files are delimited by 0s
381      --address=ADDRESS       bind address for outgoing socket to daemon
382      --port=PORT             specify double-colon alternate port number
383      --sockopts=OPTIONS      specify custom TCP options
384      --blocking-io           use blocking I/O for the remote shell
385      --stats                 give some file-transfer stats
386  -8, --8-bit-output          leave high-bit chars unescaped in output
387  -h, --human-readable        output numbers in a human-readable format
388      --progress              show progress during transfer
389  -P                          same as --partial --progress
390  -i, --itemize-changes       output a change-summary for all updates
391      --out-format=FORMAT     output updates using the specified FORMAT
392      --log-file=FILE         log what we're doing to the specified FILE
393      --log-file-format=FMT   log updates using the specified FMT
394      --password-file=FILE    read password from FILE
395      --list-only             list the files instead of copying them
396      --bwlimit=KBPS          limit I/O bandwidth; KBytes per second
397      --write-batch=FILE      write a batched update to FILE
398      --only-write-batch=FILE like --write-batch but w/o updating dest
399      --read-batch=FILE       read a batched update from FILE
400      --protocol=NUM          force an older protocol version to be used
401      --checksum-seed=NUM     set block/file checksum seed (advanced)
402  -4, --ipv4                  prefer IPv4
403  -6, --ipv6                  prefer IPv6
404      --version               print version number
405 (-h) --help                  show this help (see below for -h comment))
406
407 Rsync can also be run as a daemon, in which case the following options are
408 accepted: verb(
409      --daemon                run as an rsync daemon
410      --address=ADDRESS       bind to the specified address
411      --bwlimit=KBPS          limit I/O bandwidth; KBytes per second
412      --config=FILE           specify alternate rsyncd.conf file
413      --no-detach             do not detach from the parent
414      --port=PORT             listen on alternate port number
415      --log-file=FILE         override the "log file" setting
416      --log-file-format=FMT   override the "log format" setting
417      --sockopts=OPTIONS      specify custom TCP options
418  -v, --verbose               increase verbosity
419  -4, --ipv4                  prefer IPv4
420  -6, --ipv6                  prefer IPv6
421  -h, --help                  show this help (if used after --daemon))
422
423 manpageoptions()
424
425 rsync uses the GNU long options package. Many of the command line
426 options have two variants, one short and one long.  These are shown
427 below, separated by commas. Some options only have a long variant.
428 The '=' for options that take a parameter is optional; whitespace
429 can be used instead.
430
431 startdit()
432 dit(bf(--help)) Print a short help page describing the options
433 available in rsync and exit.  For backward-compatibility with older
434 versions of rsync, the help will also be output if you use the bf(-h)
435 option without any other args.
436
437 dit(bf(--version)) print the rsync version number and exit.
438
439 dit(bf(-v, --verbose)) This option increases the amount of information you
440 are given during the transfer.  By default, rsync works silently. A
441 single bf(-v) will give you information about what files are being
442 transferred and a brief summary at the end. Two bf(-v) flags will give you
443 information on what files are being skipped and slightly more
444 information at the end. More than two bf(-v) flags should only be used if
445 you are debugging rsync.
446
447 Note that the names of the transferred files that are output are done using
448 a default bf(--out-format) of "%n%L", which tells you just the name of the
449 file and, if the item is a link, where it points.  At the single bf(-v)
450 level of verbosity, this does not mention when a file gets its attributes
451 changed.  If you ask for an itemized list of changed attributes (either
452 bf(--itemize-changes) or adding "%i" to the bf(--out-format) setting), the
453 output (on the client) increases to mention all items that are changed in
454 any way.  See the bf(--out-format) option for more details.
455
456 dit(bf(-q, --quiet)) This option decreases the amount of information you
457 are given during the transfer, notably suppressing information messages
458 from the remote server. This flag is useful when invoking rsync from
459 cron.
460
461 dit(bf(--no-motd)) This option affects the information that is output
462 by the client at the start of a daemon transfer.  This suppresses the
463 message-of-the-day (MOTD) text, but it also affects the list of modules
464 that the daemon sends in response to the "rsync host::" request (due to
465 a limitation in the rsync protocol), so omit this option if you want to
466 request the list of modules from the deamon.
467
468 dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are
469 already the same size and have the same modification time-stamp.
470 This option turns off this "quick check" behavior, causing all files to
471 be updated.
472
473 dit(bf(--size-only)) Normally rsync will not transfer any files that are
474 already the same size and have the same modification time-stamp. With the
475 bf(--size-only) option, files will not be transferred if they have the same size,
476 regardless of timestamp. This is useful when starting to use rsync
477 after using another mirroring system which may not preserve timestamps
478 exactly.
479
480 dit(bf(--modify-window)) When comparing two timestamps, rsync treats the
481 timestamps as being equal if they differ by no more than the modify-window
482 value.  This is normally 0 (for an exact match), but you may find it useful
483 to set this to a larger value in some situations.  In particular, when
484 transferring to or from an MS Windows FAT filesystem (which represents
485 times with a 2-second resolution), bf(--modify-window=1) is useful
486 (allowing times to differ by up to 1 second).
487
488 dit(bf(-c, --checksum)) This forces the sender to checksum em(every)
489 regular file using a 128-bit MD4 checksum.  It does this during the initial
490 file-system scan as it builds the list of all available files. The receiver
491 then checksums its version of each file (if it exists and it has the same
492 size as its sender-side counterpart) in order to decide which files need to
493 be updated: files with either a changed size or a changed checksum are
494 selected for transfer.  Since this whole-file checksumming of all files on
495 both sides of the connection occurs in addition to the automatic checksum
496 verifications that occur during a file's transfer, this option can be quite
497 slow.
498
499 Note that rsync always verifies that each em(transferred) file was correctly
500 reconstructed on the receiving side by checking its whole-file checksum, but
501 that automatic after-the-transfer verification has nothing to do with this
502 option's before-the-transfer "Does this file need to be updated?" check.
503
504 dit(bf(-a, --archive)) This is equivalent to bf(-rlptgoD). It is a quick
505 way of saying you want recursion and want to preserve almost
506 everything (with -H being a notable omission).
507 The only exception to the above equivalence is when bf(--files-from) is
508 specified, in which case bf(-r) is not implied.
509
510 Note that bf(-a) bf(does not preserve hardlinks), because
511 finding multiply-linked files is expensive.  You must separately
512 specify bf(-H).
513
514 dit(--no-OPTION) You may turn off one or more implied options by prefixing
515 the option name with "no-".  Not all options may be prefixed with a "no-":
516 only options that are implied by other options (e.g. bf(--no-D),
517 bf(--no-perms)) or have different defaults in various circumstances
518 (e.g. bf(--no-whole-file), bf(--no-blocking-io), bf(--no-dirs)).  You may
519 specify either the short or the long option name after the "no-" prefix
520 (e.g. bf(--no-R) is the same as bf(--no-relative)).
521
522 For example: if you want to use bf(-a) (bf(--archive)) but don't want
523 bf(-o) (bf(--owner)), instead of converting bf(-a) into bf(-rlptgD), you
524 could specify bf(-a --no-o) (or bf(-a --no-owner)).
525
526 The order of the options is important:  if you specify bf(--no-r -a), the
527 bf(-r) option would end up being turned on, the opposite of bf(-a --no-r).
528 Note also that the side-effects of the bf(--files-from) option are NOT
529 positional, as it affects the default state of several options and slightly
530 changes the meaning of bf(-a) (see the bf(--files-from) option for more
531 details).
532
533 dit(bf(-r, --recursive)) This tells rsync to copy directories
534 recursively.  See also bf(--dirs) (bf(-d)).
535
536 dit(bf(-R, --relative)) Use relative paths. This means that the full path
537 names specified on the command line are sent to the server rather than
538 just the last parts of the filenames. This is particularly useful when
539 you want to send several different directories at the same time. For
540 example, if you used this command:
541
542 quote(tt(   rsync -av /foo/bar/baz.c remote:/tmp/))
543
544 ... this would create a file named baz.c in /tmp/ on the remote
545 machine. If instead you used
546
547 quote(tt(   rsync -avR /foo/bar/baz.c remote:/tmp/))
548
549 then a file named /tmp/foo/bar/baz.c would be created on the remote
550 machine -- the full path name is preserved.  To limit the amount of
551 path information that is sent, you have a couple options:  (1) With
552 a modern rsync on the sending side (beginning with 2.6.7), you can
553 insert a dot and a slash into the source path, like this:
554
555 quote(tt(   rsync -avR /foo/./bar/baz.c remote:/tmp/))
556
557 That would create /tmp/bar/baz.c on the remote machine.  (Note that the
558 dot must be followed by a slash, so "/foo/." would not be abbreviated.)
559 (2) For older rsync versions, you would need to use a chdir to limit the
560 source path.  For example, when pushing files:
561
562 quote(tt(   (cd /foo; rsync -avR bar/baz.c remote:/tmp/) ))
563
564 (Note that the parens put the two commands into a sub-shell, so that the
565 "cd" command doesn't remain in effect for future commands.)
566 If you're pulling files, use this idiom (which doesn't work with an
567 rsync daemon):
568
569 quote(
570 tt(   rsync -avR --rsync-path="cd /foo; rsync" \ )nl()
571 tt(       remote:bar/baz.c /tmp/)
572 )
573
574 dit(bf(--no-implied-dirs)) This option affects the default behavior of the
575 bf(--relative) option.  When it is specified, the attributes of the implied
576 directories from the source names are not included in the transfer.  This
577 means that the corresponding path elements on the destination system are
578 left unchanged if they exist, and any missing implied directories are
579 created with default attributes.  This even allows these implied path
580 elements to have big differences, such as being a symlink to a directory on
581 one side of the transfer, and a real directory on the other side.
582
583 For instance, if a command-line arg or a files-from entry told rsync to
584 transfer the file "path/foo/file", the directories "path" and "path/foo"
585 are implied when bf(--relative) is used.  If "path/foo" is a symlink to
586 "bar" on the destination system, the receiving rsync would ordinarily
587 delete "path/foo", recreate it as a directory, and receive the file into
588 the new directory.  With bf(--no-implied-dirs), the receiving rsync updates
589 "path/foo/file" using the existing path elements, which means that the file
590 ends up being created in "path/bar".  Another way to accomplish this link
591 preservation is to use the bf(--keep-dirlinks) option (which will also
592 affect symlinks to directories in the rest of the transfer).
593
594 In a similar but opposite scenario, if the transfer of "path/foo/file" is
595 requested and "path/foo" is a symlink on the sending side, running without
596 bf(--no-implied-dirs) would cause rsync to transform "path/foo" on the
597 receiving side into an identical symlink, and then attempt to transfer
598 "path/foo/file", which might fail if the duplicated symlink did not point
599 to a directory on the receiving side.  Another way to avoid this sending of
600 a symlink as an implied directory is to use bf(--copy-unsafe-links), or
601 bf(--copy-dirlinks) (both of which also affect symlinks in the rest of the
602 transfer -- see their descriptions for full details).
603
604 dit(bf(-b, --backup)) With this option, preexisting destination files are
605 renamed as each file is transferred or deleted.  You can control where the
606 backup file goes and what (if any) suffix gets appended using the
607 bf(--backup-dir) and bf(--suffix) options.
608
609 Note that if you don't specify bf(--backup-dir), (1) the
610 bf(--omit-dir-times) option will be implied, and (2) if bf(--delete) is
611 also in effect (without bf(--delete-excluded)), rsync will add a "protect"
612 filter-rule for the backup suffix to the end of all your existing excludes
613 (e.g. -f "P *~").  This will prevent previously backed-up files from being
614 deleted.  Note that if you are supplying your own filter rules, you may
615 need to manually insert your own exclude/protect rule somewhere higher up
616 in the list so that it has a high enough priority to be effective (e.g., if
617 your rules specify a trailing inclusion/exclusion of '*', the auto-added
618 rule would never be reached).
619
620 dit(bf(--backup-dir=DIR)) In combination with the bf(--backup) option, this
621 tells rsync to store all backups in the specified directory on the receiving
622 side.  This can be used for incremental backups.  You can additionally
623 specify a backup suffix using the bf(--suffix) option
624 (otherwise the files backed up in the specified directory
625 will keep their original filenames).
626
627 dit(bf(--suffix=SUFFIX)) This option allows you to override the default
628 backup suffix used with the bf(--backup) (bf(-b)) option. The default suffix is a ~
629 if no -bf(-backup-dir) was specified, otherwise it is an empty string.
630
631 dit(bf(-u, --update)) This forces rsync to skip any files which exist on
632 the destination and have a modified time that is newer than the source
633 file.  (If an existing destination file has a modify time equal to the
634 source file's, it will be updated if the sizes are different.)
635
636 In the current implementation of bf(--update), a difference of file format
637 between the sender and receiver is always
638 considered to be important enough for an update, no matter what date
639 is on the objects.  In other words, if the source has a directory or a
640 symlink where the destination has a file, the transfer would occur
641 regardless of the timestamps.  This might change in the future (feel
642 free to comment on this on the mailing list if you have an opinion).
643
644 dit(bf(--inplace)) This causes rsync not to create a new copy of the file
645 and then move it into place.  Instead rsync will overwrite the existing
646 file, meaning that the rsync algorithm can't accomplish the full amount of
647 network reduction it might be able to otherwise (since it does not yet try
648 to sort data matches).  One exception to this is if you combine the option
649 with bf(--backup), since rsync is smart enough to use the backup file as the
650 basis file for the transfer.
651
652 This option is useful for transfer of large files with block-based changes
653 or appended data, and also on systems that are disk bound, not network
654 bound.
655
656 The option implies bf(--partial) (since an interrupted transfer does not delete
657 the file), but conflicts with bf(--partial-dir) and bf(--delay-updates).
658 Prior to rsync 2.6.4 bf(--inplace) was also incompatible with bf(--compare-dest)
659 and bf(--link-dest).
660
661 WARNING: The file's data will be in an inconsistent state during the
662 transfer (and possibly afterward if the transfer gets interrupted), so you
663 should not use this option to update files that are in use.  Also note that
664 rsync will be unable to update a file in-place that is not writable by the
665 receiving user.
666
667 dit(bf(--append)) This causes rsync to update a file by appending data onto
668 the end of the file, which presumes that the data that already exists on
669 the receiving side is identical with the start of the file on the sending
670 side.  If that is not true, the file will fail the checksum test, and the
671 resend will do a normal bf(--inplace) update to correct the mismatched data.
672 Only files on the receiving side that are shorter than the corresponding
673 file on the sending side (as well as new files) are sent.
674 Implies bf(--inplace), but does not conflict with bf(--sparse) (though the
675 bf(--sparse) option will be auto-disabled if a resend of the already-existing
676 data is required).
677
678 dit(bf(-d, --dirs)) Tell the sending side to include any directories that
679 are encountered.  Unlike bf(--recursive), a directory's contents are not copied
680 unless the directory name specified is "." or ends with a trailing slash
681 (e.g. ".", "dir/.", "dir/", etc.).  Without this option or the
682 bf(--recursive) option, rsync will skip all directories it encounters (and
683 output a message to that effect for each one).  If you specify both
684 bf(--dirs) and bf(--recursive), bf(--recursive) takes precedence.
685
686 dit(bf(-l, --links)) When symlinks are encountered, recreate the
687 symlink on the destination.
688
689 dit(bf(-L, --copy-links)) When symlinks are encountered, the item that
690 they point to (the referent) is copied, rather than the symlink.  In older
691 versions of rsync, this option also had the side-effect of telling the
692 receiving side to follow symlinks, such as symlinks to directories.  In a
693 modern rsync such as this one, you'll need to specify bf(--keep-dirlinks) (bf(-K))
694 to get this extra behavior.  The only exception is when sending files to
695 an rsync that is too old to understand bf(-K) -- in that case, the bf(-L) option
696 will still have the side-effect of bf(-K) on that older receiving rsync.
697
698 dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of
699 symbolic links that point outside the copied tree.  Absolute symlinks
700 are also treated like ordinary files, and so are any symlinks in the
701 source path itself when bf(--relative) is used.  This option has no
702 additional effect if bf(--copy-links) was also specified.
703
704 dit(bf(--safe-links)) This tells rsync to ignore any symbolic links
705 which point outside the copied tree. All absolute symlinks are
706 also ignored. Using this option in conjunction with bf(--relative) may
707 give unexpected results.
708
709 dit(bf(-K, --copy-dirlinks)) This option causes the sending side to treat
710 a symlink to a directory as though it were a real directory.  This is
711 useful if you don't want symlinks to non-directories to be affected, as
712 they would be using bf(--copy-links).
713
714 Without this option, if the sending side has replaced a directory with a
715 symlink to a directory, the receiving side will delete anything that is in
716 the way of the new symlink, including a directory hierarchy (as long as
717 bf(--force) or bf(--delete) is in effect).
718
719 See also bf(--keep-dirlinks) for an analogous option for the receiving
720 side.
721
722 dit(bf(-K, --keep-dirlinks)) This option causes the receiving side to treat
723 a symlink to a directory as though it were a real directory, but only if it
724 matches a real directory from the sender.  Without this option, the
725 receiver's symlink would be deleted and replaced with a real directory.
726
727 For example, suppose you transfer a directory "foo" that contains a file
728 "file", but "foo" is a symlink to directory "bar" on the receiver.  Without
729 bf(--keep-dirlinks), the receiver deletes symlink "foo", recreates it as a
730 directory, and receives the file into the new directory.  With
731 bf(--keep-dirlinks), the receiver keeps the symlink and "file" ends up in
732 "bar".
733
734 See also bf(--copy-dirlinks) for an analogous option for the sending side.
735
736 dit(bf(-H, --hard-links)) This tells rsync to look for hard-linked files in
737 the transfer and link together the corresponding files on the receiving
738 side.  Without this option, hard-linked files in the transfer are treated
739 as though they were separate files.
740
741 Note that rsync can only detect hard links if both parts of the link
742 are in the list of files being sent.
743
744 dit(bf(-p, --perms)) This option causes the receiving rsync to set the
745 destination permissions to be the same as the source permissions.  (See
746 also the bf(--chmod) option for a way to modify what rsync considers to
747 be the source permissions.)
748
749 When this option is em(off), permissions are set as follows:
750
751 quote(itemization(
752   it() Existing files (including updated files) retain their existing
753   permissions, though the bf(--executability) option might change just
754   the execute permission for the file.
755   it() New files get their "normal" permission bits set to the source
756   file's permissions masked with the receiving end's umask setting, and
757   their special permission bits disabled except in the case where a new
758   directory inherits a setgid bit from its parent directory.
759 ))
760
761 Thus, when bf(--perms) and bf(--executability) are both disabled,
762 rsync's behavior is the same as that of other file-copy utilities,
763 such as bf(cp)(1) and bf(tar)(1).
764
765 In summary: to give destination files (both old and new) the source
766 permissions, use bf(--perms).  To give new files the destination-default
767 permissions (while leaving existing files unchanged), make sure that the
768 bf(--perms) option is off and use bf(--chmod=ugo=rwX) (which ensures that
769 all non-masked bits get enabled).  If you'd care to make this latter
770 behavior easier to type, you could define a popt alias for it, such as
771 putting this line in the file ~/.popt (this defines the bf(-s) option,
772 and includes --no-g to use the default group of the destination dir):
773
774 quote(tt(   rsync alias -s --no-p --no-g --chmod=ugo=rwX))
775
776 You could then use this new option in a command such as this one:
777
778 quote(tt(   rsync -asv src/ dest/))
779
780 (Caveat: make sure that bf(-a) does not follow bf(-s), or it will re-enable
781 the "--no-*" options.)
782
783 The preservation of the destination's setgid bit on newly-created
784 directories when bf(--perms) is off was added in rsync 2.6.7.  Older rsync
785 versions erroneously preserved the three special permission bits for
786 newly-created files when bf(--perms) was off, while overriding the
787 destination's setgid bit setting on a newly-created directory.  (Keep in
788 mind that it is the version of the receiving rsync that affects this
789 behavior.)
790
791 dit(bf(-E, --executability)) This option causes rsync to preserve the
792 executability (or non-executability) of regular files when bf(--perms) is
793 not enabled.  A regular file is considered to be executable if at least one
794 'x' is turned on in its permissions.  When an existing destination file's
795 executability differs from that of the corresponding source file, rsync
796 modifies the destination file's permissions as follows:
797
798 quote(itemization(
799   it() To make a file non-executable, rsync turns off all its 'x'
800   permissions.
801   it() To make a file executable, rsync turns on each 'x' permission that
802   has a corresponding 'r' permission enabled.
803 ))
804
805 If bf(--perms) is enabled, this option is ignored.
806
807 dit(bf(--chmod)) This option tells rsync to apply one or more
808 comma-separated "chmod" strings to the permission of the files in the
809 transfer.  The resulting value is treated as though it was the permissions
810 that the sending side supplied for the file, which means that this option
811 can seem to have no effect on existing files if bf(--perms) is not enabled.
812
813 In addition to the normal parsing rules specified in the bf(chmod)(1)
814 manpage, you can specify an item that should only apply to a directory by
815 prefixing it with a 'D', or specify an item that should only apply to a
816 file by prefixing it with a 'F'.  For example:
817
818 quote(--chmod=Dg+s,ug+w,Fo-w,+X)
819
820 It is also legal to specify multiple bf(--chmod) options, as each
821 additional option is just appended to the list of changes to make.
822
823 See the bf(--perms) and bf(--executability) options for how the resulting
824 permission value can be applied to the files in the transfer.
825
826 dit(bf(-o, --owner)) This option causes rsync to set the owner of the
827 destination file to be the same as the source file, but only if the
828 receiving rsync is being run as the super-user (see also the bf(--super)
829 option to force rsync to attempt super-user activities).
830 Without this option, the owner is set to the invoking user on the
831 receiving side.
832
833 The preservation of ownership will associate matching names by default, but
834 may fall back to using the ID number in some circumstances (see also the
835 bf(--numeric-ids) option for a full discussion).
836
837 dit(bf(-g, --group)) This option causes rsync to set the group of the
838 destination file to be the same as the source file.  If the receiving
839 program is not running as the super-user (or if bf(--no-super) was
840 specified), only groups that the invoking user on the receiving side
841 is a member of will be preserved.
842 Without this option, the group is set to the default group of the invoking
843 user on the receiving side.
844
845 The preservation of group information will associate matching names by
846 default, but may fall back to using the ID number in some circumstances
847 (see also the bf(--numeric-ids) option for a full discussion).
848
849 dit(bf(--devices)) This option causes rsync to transfer character and
850 block device files to the remote system to recreate these devices.
851 This option has no effect if the receiving rsync is not run as the
852 super-user and bf(--super) is not specified.
853
854 dit(bf(--specials)) This option causes rsync to transfer special files
855 such as named sockets and fifos.
856
857 dit(bf(-D)) The bf(-D) option is equivalent to bf(--devices) bf(--specials).
858
859 dit(bf(-t, --times)) This tells rsync to transfer modification times along
860 with the files and update them on the remote system.  Note that if this
861 option is not used, the optimization that excludes files that have not been
862 modified cannot be effective; in other words, a missing bf(-t) or bf(-a) will
863 cause the next transfer to behave as if it used bf(-I), causing all files to be
864 updated (though the rsync algorithm will make the update fairly efficient
865 if the files haven't actually changed, you're much better off using bf(-t)).
866
867 dit(bf(-O, --omit-dir-times)) This tells rsync to omit directories when
868 it is preserving modification times (see bf(--times)).  If NFS is sharing
869 the directories on the receiving side, it is a good idea to use bf(-O).
870 This option is inferred if you use bf(--backup) without bf(--backup-dir).
871
872 dit(bf(--super)) This tells the receiving side to attempt super-user
873 activities even if the receiving rsync wasn't run by the super-user.  These
874 activities include: preserving users via the bf(--owner) option, preserving
875 all groups (not just the current user's groups) via the bf(--groups)
876 option, and copying devices via the bf(--devices) option.  This is useful
877 for systems that allow such activities without being the super-user, and
878 also for ensuring that you will get errors if the receiving side isn't
879 being running as the super-user.  To turn off super-user activities, the
880 super-user can use bf(--no-super).
881
882 dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take
883 up less space on the destination.  Conflicts with bf(--inplace) because it's
884 not possible to overwrite data in a sparse fashion.
885
886 NOTE: Don't use this option when the destination is a Solaris "tmpfs"
887 filesystem. It doesn't seem to handle seeks over null regions
888 correctly and ends up corrupting the files.
889
890 dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers,
891 instead it will just report the actions it would have taken.
892
893 dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm
894 is not used and the whole file is sent as-is instead.  The transfer may be
895 faster if this option is used when the bandwidth between the source and
896 destination machines is higher than the bandwidth to disk (especially when the
897 "disk" is actually a networked filesystem).  This is the default when both
898 the source and destination are specified as local paths.
899
900 dit(bf(-x, --one-file-system)) This tells rsync to avoid crossing a
901 filesystem boundary when recursing.  This does not limit the user's ability
902 to specify items to copy from multiple filesystems, just rsync's recursion
903 through the hierarchy of each directory that the user specified, and also
904 the analogous recursion on the receiving side during deletion.  Also keep
905 in mind that rsync treats a "bind" mount to the same device as being on the
906 same filesystem.
907
908 If this option is repeated, rsync omits all mount-point directories from
909 the copy.  Otherwise, it includes an empty directory at each mount-point it
910 encounters (using the attributes of the mounted directory because those of
911 the underlying mount-point directory are inaccessible).
912
913 If rsync has been told to collapse symlinks (via bf(--copy-links) or
914 bf(--copy-unsafe-links)), a symlink to a directory on another device is
915 treated like a mount-point.  Symlinks to non-directories are unaffected
916 by this option.
917
918 dit(bf(--existing, --ignore-non-existing)) This tells rsync to skip
919 creating files (including directories) that do not exist
920 yet on the destination.  If this option is
921 combined with the bf(--ignore-existing) option, no files will be updated
922 (which can be useful if all you want to do is to delete extraneous files).
923
924 dit(bf(--ignore-existing)) This tells rsync to skip updating files that
925 already exist on the destination (this does em(not) ignore existing
926 directores, or nothing would get done).  See also bf(--existing).
927
928 dit(bf(--remove-source-files)) This tells rsync to remove from the sending
929 side the files (meaning non-directories) that are a part of the transfer
930 and have been successfully duplicated on the receiving side.
931
932 dit(bf(--delete)) This tells rsync to delete extraneous files from the
933 receiving side (ones that aren't on the sending side), but only for the
934 directories that are being synchronized.  You must have asked rsync to
935 send the whole directory (e.g. "dir" or "dir/") without using a wildcard
936 for the directory's contents (e.g. "dir/*") since the wildcard is expanded
937 by the shell and rsync thus gets a request to transfer individual files, not
938 the files' parent directory.  Files that are excluded from transfer are
939 also excluded from being deleted unless you use the bf(--delete-excluded)
940 option or mark the rules as only matching on the sending side (see the
941 include/exclude modifiers in the FILTER RULES section).
942
943 Prior to rsync 2.6.7, this option would have no effect unless bf(--recursive)
944 was in effect.  Beginning with 2.6.7, deletions will also occur when bf(--dirs)
945 (bf(-d)) is in effect, but only for directories whose contents are being copied.
946
947 This option can be dangerous if used incorrectly!  It is a very good idea
948 to run first using the bf(--dry-run) option (bf(-n)) to see what files would be
949 deleted to make sure important files aren't listed.
950
951 If the sending side detects any I/O errors, then the deletion of any
952 files at the destination will be automatically disabled. This is to
953 prevent temporary filesystem failures (such as NFS errors) on the
954 sending side causing a massive deletion of files on the
955 destination.  You can override this with the bf(--ignore-errors) option.
956
957 The bf(--delete) option may be combined with one of the --delete-WHEN options
958 without conflict, as well as bf(--delete-excluded).  However, if none of the
959 --delete-WHEN options are specified, rsync will currently choose the
960 bf(--delete-before) algorithm.  A future version may change this to choose the
961 bf(--delete-during) algorithm.  See also bf(--delete-after).
962
963 dit(bf(--delete-before)) Request that the file-deletions on the receiving
964 side be done before the transfer starts.  This is the default if bf(--delete)
965 or bf(--delete-excluded) is specified without one of the --delete-WHEN options.
966 See bf(--delete) (which is implied) for more details on file-deletion.
967
968 Deleting before the transfer is helpful if the filesystem is tight for space
969 and removing extraneous files would help to make the transfer possible.
970 However, it does introduce a delay before the start of the transfer,
971 and this delay might cause the transfer to timeout (if bf(--timeout) was
972 specified).
973
974 dit(bf(--delete-during, --del)) Request that the file-deletions on the
975 receiving side be done incrementally as the transfer happens.  This is
976 a faster method than choosing the before- or after-transfer algorithm,
977 but it is only supported beginning with rsync version 2.6.4.
978 See bf(--delete) (which is implied) for more details on file-deletion.
979
980 dit(bf(--delete-after)) Request that the file-deletions on the receiving
981 side be done after the transfer has completed.  This is useful if you
982 are sending new per-directory merge files as a part of the transfer and
983 you want their exclusions to take effect for the delete phase of the
984 current transfer.
985 See bf(--delete) (which is implied) for more details on file-deletion.
986
987 dit(bf(--delete-excluded)) In addition to deleting the files on the
988 receiving side that are not on the sending side, this tells rsync to also
989 delete any files on the receiving side that are excluded (see bf(--exclude)).
990 See the FILTER RULES section for a way to make individual exclusions behave
991 this way on the receiver, and for a way to protect files from
992 bf(--delete-excluded).
993 See bf(--delete) (which is implied) for more details on file-deletion.
994
995 dit(bf(--ignore-errors)) Tells bf(--delete) to go ahead and delete files
996 even when there are I/O errors.
997
998 dit(bf(--force)) This option tells rsync to delete a non-empty directory
999 when it is to be replaced by a non-directory.  This is only relevant if
1000 deletions are not active (see bf(--delete) for details).
1001
1002 Note for older rsync versions: bf(--force) used to still be required when
1003 using bf(--delete-after), and it used to be non-functional unless the
1004 bf(--recursive) option was also enabled.
1005
1006 dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM
1007 files or directories (NUM must be non-zero).
1008 This is useful when mirroring very large trees to prevent disasters.
1009
1010 dit(bf(--max-size=SIZE)) This tells rsync to avoid transferring any
1011 file that is larger than the specified SIZE. The SIZE value can be
1012 suffixed with a string to indicate a size multiplier, and
1013 may be a fractional value (e.g. "bf(--max-size=1.5m)").
1014
1015 The suffixes are as follows: "K" (or "KiB") is a kibibyte (1024),
1016 "M" (or "MiB") is a mebibyte (1024*1024), and "G" (or "GiB") is a
1017 gibibyte (1024*1024*1024).
1018 If you want the multiplier to be 1000 instead of 1024, use "KB",
1019 "MB", or "GB".  (Note: lower-case is also accepted for all values.)
1020 Finally, if the suffix ends in either "+1" or "-1", the value will
1021 be offset by one byte in the indicated direction.
1022
1023 Examples: --max-size=1.5mb-1 is 1499999 bytes, and --max-size=2g+1 is
1024 2147483649 bytes.
1025
1026 dit(bf(--min-size=SIZE)) This tells rsync to avoid transferring any
1027 file that is smaller than the specified SIZE, which can help in not
1028 transferring small, junk files.
1029 See the bf(--max-size) option for a description of SIZE.
1030
1031 dit(bf(-B, --block-size=BLOCKSIZE)) This forces the block size used in
1032 the rsync algorithm to a fixed value.  It is normally selected based on
1033 the size of each file being updated.  See the technical report for details.
1034
1035 dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative
1036 remote shell program to use for communication between the local and
1037 remote copies of rsync. Typically, rsync is configured to use ssh by
1038 default, but you may prefer to use rsh on a local network.
1039
1040 If this option is used with bf([user@]host::module/path), then the
1041 remote shell em(COMMAND) will be used to run an rsync daemon on the
1042 remote host, and all data will be transmitted through that remote
1043 shell connection, rather than through a direct socket connection to a
1044 running rsync daemon on the remote host.  See the section "USING
1045 RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION" above.
1046
1047 Command-line arguments are permitted in COMMAND provided that COMMAND is
1048 presented to rsync as a single argument.  You must use spaces (not tabs
1049 or other whitespace) to separate the command and args from each other,
1050 and you can use single- and/or double-quotes to preserve spaces in an
1051 argument (but not backslashes).  Note that doubling a single-quote
1052 inside a single-quoted string gives you a single-quote; likewise for
1053 double-quotes (though you need to pay attention to which quotes your
1054 shell is parsing and which quotes rsync is parsing).  Some examples:
1055
1056 quote(
1057 tt(    -e 'ssh -p 2234')nl()
1058 tt(    -e 'ssh -o "ProxyCommand nohup ssh firewall nc -w1 %h %p"')nl()
1059 )
1060
1061 (Note that ssh users can alternately customize site-specific connect
1062 options in their .ssh/config file.)
1063
1064 You can also choose the remote shell program using the RSYNC_RSH
1065 environment variable, which accepts the same range of values as bf(-e).
1066
1067 See also the bf(--blocking-io) option which is affected by this option.
1068
1069 dit(bf(--rsync-path=PROGRAM)) Use this to specify what program is to be run
1070 on the remote machine to start-up rsync.  Often used when rsync is not in
1071 the default remote-shell's path (e.g. --rsync-path=/usr/local/bin/rsync).
1072 Note that PROGRAM is run with the help of a shell, so it can be any
1073 program, script, or command sequence you'd care to run, so long as it does
1074 not corrupt the standard-in & standard-out that rsync is using to
1075 communicate.
1076
1077 One tricky example is to set a different default directory on the remote
1078 machine for use with the bf(--relative) option.  For instance:
1079
1080 quote(tt(    rsync -avR --rsync-path="cd /a/b && rsync" hst:c/d /e/))
1081
1082 dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a
1083 broad range of files that you often don't want to transfer between
1084 systems. It uses the same algorithm that CVS uses to determine if
1085 a file should be ignored.
1086
1087 The exclude list is initialized to:
1088
1089 quote(quote(tt(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state
1090 .nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej
1091 .del-* *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/)))
1092
1093 then files listed in a $HOME/.cvsignore are added to the list and any
1094 files listed in the CVSIGNORE environment variable (all cvsignore names
1095 are delimited by whitespace).
1096
1097 Finally, any file is ignored if it is in the same directory as a
1098 .cvsignore file and matches one of the patterns listed therein.  Unlike
1099 rsync's filter/exclude files, these patterns are split on whitespace.
1100 See the bf(cvs)(1) manual for more information.
1101
1102 If you're combining bf(-C) with your own bf(--filter) rules, you should
1103 note that these CVS excludes are appended at the end of your own rules,
1104 regardless of where the bf(-C) was placed on the command-line.  This makes them
1105 a lower priority than any rules you specified explicitly.  If you want to
1106 control where these CVS excludes get inserted into your filter rules, you
1107 should omit the bf(-C) as a command-line option and use a combination of
1108 bf(--filter=:C) and bf(--filter=-C) (either on your command-line or by
1109 putting the ":C" and "-C" rules into a filter file with your other rules).
1110 The first option turns on the per-directory scanning for the .cvsignore
1111 file.  The second option does a one-time import of the CVS excludes
1112 mentioned above.
1113
1114 dit(bf(-f, --filter=RULE)) This option allows you to add rules to selectively
1115 exclude certain files from the list of files to be transferred. This is
1116 most useful in combination with a recursive transfer.
1117
1118 You may use as many bf(--filter) options on the command line as you like
1119 to build up the list of files to exclude.
1120
1121 See the FILTER RULES section for detailed information on this option.
1122
1123 dit(bf(-F)) The bf(-F) option is a shorthand for adding two bf(--filter) rules to
1124 your command.  The first time it is used is a shorthand for this rule:
1125
1126 quote(tt(   --filter='dir-merge /.rsync-filter'))
1127
1128 This tells rsync to look for per-directory .rsync-filter files that have
1129 been sprinkled through the hierarchy and use their rules to filter the
1130 files in the transfer.  If bf(-F) is repeated, it is a shorthand for this
1131 rule:
1132
1133 quote(tt(   --filter='exclude .rsync-filter'))
1134
1135 This filters out the .rsync-filter files themselves from the transfer.
1136
1137 See the FILTER RULES section for detailed information on how these options
1138 work.
1139
1140 dit(bf(--exclude=PATTERN)) This option is a simplified form of the
1141 bf(--filter) option that defaults to an exclude rule and does not allow
1142 the full rule-parsing syntax of normal filter rules.
1143
1144 See the FILTER RULES section for detailed information on this option.
1145
1146 dit(bf(--exclude-from=FILE)) This option is related to the bf(--exclude)
1147 option, but it specifies a FILE that contains exclude patterns (one per line).
1148 Blank lines in the file and lines starting with ';' or '#' are ignored.
1149 If em(FILE) is bf(-), the list will be read from standard input.
1150
1151 dit(bf(--include=PATTERN)) This option is a simplified form of the
1152 bf(--filter) option that defaults to an include rule and does not allow
1153 the full rule-parsing syntax of normal filter rules.
1154
1155 See the FILTER RULES section for detailed information on this option.
1156
1157 dit(bf(--include-from=FILE)) This option is related to the bf(--include)
1158 option, but it specifies a FILE that contains include patterns (one per line).
1159 Blank lines in the file and lines starting with ';' or '#' are ignored.
1160 If em(FILE) is bf(-), the list will be read from standard input.
1161
1162 dit(bf(--files-from=FILE)) Using this option allows you to specify the
1163 exact list of files to transfer (as read from the specified FILE or bf(-)
1164 for standard input).  It also tweaks the default behavior of rsync to make
1165 transferring just the specified files and directories easier:
1166
1167 quote(itemization(
1168   it() The bf(--relative) (bf(-R)) option is implied, which preserves the path
1169   information that is specified for each item in the file (use
1170   bf(--no-relative) or bf(--no-R) if you want to turn that off).
1171   it() The bf(--dirs) (bf(-d)) option is implied, which will create directories
1172   specified in the list on the destination rather than noisily skipping
1173   them (use bf(--no-dirs) or bf(--no-d) if you want to turn that off).
1174   it() The bf(--archive) (bf(-a)) option's behavior does not imply bf(--recursive)
1175   (bf(-r)), so specify it explicitly, if you want it.
1176   it() These side-effects change the default state of rsync, so the position
1177   of the bf(--files-from) option on the command-line has no bearing on how
1178   other options are parsed (e.g. bf(-a) works the same before or after
1179   bf(--files-from), as does bf(--no-R) and all other options).
1180 ))
1181
1182 The file names that are read from the FILE are all relative to the
1183 source dir -- any leading slashes are removed and no ".." references are
1184 allowed to go higher than the source dir.  For example, take this
1185 command:
1186
1187 quote(tt(   rsync -a --files-from=/tmp/foo /usr remote:/backup))
1188
1189 If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin
1190 directory will be created as /backup/bin on the remote host.  If it
1191 contains "bin/" (note the trailing slash), the immediate contents of
1192 the directory would also be sent (without needing to be explicitly
1193 mentioned in the file -- this began in version 2.6.4).  In both cases,
1194 if the bf(-r) option was enabled, that dir's entire hierarchy would
1195 also be transferred (keep in mind that bf(-r) needs to be specified
1196 explicitly with bf(--files-from), since it is not implied by bf(-a)).
1197 Also note
1198 that the effect of the (enabled by default) bf(--relative) option is to
1199 duplicate only the path info that is read from the file -- it does not
1200 force the duplication of the source-spec path (/usr in this case).
1201
1202 In addition, the bf(--files-from) file can be read from the remote host
1203 instead of the local host if you specify a "host:" in front of the file
1204 (the host must match one end of the transfer).  As a short-cut, you can
1205 specify just a prefix of ":" to mean "use the remote end of the
1206 transfer".  For example:
1207
1208 quote(tt(   rsync -a --files-from=:/path/file-list src:/ /tmp/copy))
1209
1210 This would copy all the files specified in the /path/file-list file that
1211 was located on the remote "src" host.
1212
1213 dit(bf(-0, --from0)) This tells rsync that the rules/filenames it reads from a
1214 file are terminated by a null ('\0') character, not a NL, CR, or CR+LF.
1215 This affects bf(--exclude-from), bf(--include-from), bf(--files-from), and any
1216 merged files specified in a bf(--filter) rule.
1217 It does not affect bf(--cvs-exclude) (since all names read from a .cvsignore
1218 file are split on whitespace).
1219
1220 dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a
1221 scratch directory when creating temporary copies of the files transferred
1222 on the receiving side.  The default behavior is to create each temporary
1223 file in the same directory as the associated destination file.
1224
1225 This option is most often used when the receiving disk partition does not
1226 have enough free space to hold a copy of the largest file in the transfer.
1227 In this case (i.e. when the scratch directory in on a different disk
1228 partition), rsync will not be able to rename each received temporary file
1229 over the top of the associated destination file, but instead must copy it
1230 into place.  Rsync does this by copying the file over the top of the
1231 destination file, which means that the destination file will contain
1232 truncated data during this copy.  If this were not done this way (even if
1233 the destination file were first removed, the data locally copied to a
1234 temporary file in the destination directory, and then renamed into place)
1235 it would be possible for the old file to continue taking up disk space (if
1236 someone had it open), and thus there might not be enough room to fit the
1237 new version on the disk at the same time.
1238
1239 If you are using this option for reasons other than a shortage of disk
1240 space, you may wish to combine it with the bf(--delay-updates) option,
1241 which will ensure that all copied files get put into subdirectories in the
1242 destination hierarchy, awaiting the end of the transfer.  If you don't
1243 have enough room to duplicate all the arriving files on the destination
1244 partition, another way to tell rsync that you aren't overly concerned
1245 about disk space is to use the bf(--partial-dir) option with a relative
1246 path; because this tells rsync that it is OK to stash off a copy of a
1247 single file in a subdir in the destination hierarchy, rsync will use the
1248 partial-dir as a staging area to bring over the copied file, and then
1249 rename it into place from there. (Specifying a bf(--partial-dir) with
1250 an absolute path does not have this side-effect.)
1251
1252 dit(bf(-y, --fuzzy)) This option tells rsync that it should look for a
1253 basis file for any destination file that is missing.  The current algorithm
1254 looks in the same directory as the destination file for either a file that
1255 has an identical size and modified-time, or a similarly-named file.  If
1256 found, rsync uses the fuzzy basis file to try to speed up the transfer.
1257
1258 Note that the use of the bf(--delete) option might get rid of any potential
1259 fuzzy-match files, so either use bf(--delete-after) or specify some
1260 filename exclusions if you need to prevent this.
1261
1262 dit(bf(--compare-dest=DIR)) This option instructs rsync to use em(DIR) on
1263 the destination machine as an additional hierarchy to compare destination
1264 files against doing transfers (if the files are missing in the destination
1265 directory).  If a file is found in em(DIR) that is identical to the
1266 sender's file, the file will NOT be transferred to the destination
1267 directory.  This is useful for creating a sparse backup of just files that
1268 have changed from an earlier backup.
1269
1270 Beginning in version 2.6.4, multiple bf(--compare-dest) directories may be
1271 provided, which will cause rsync to search the list in the order specified
1272 for an exact match.
1273 If a match is found that differs only in attributes, a local copy is made
1274 and the attributes updated.
1275 If a match is not found, a basis file from one of the em(DIR)s will be
1276 selected to try to speed up the transfer.
1277
1278 If em(DIR) is a relative path, it is relative to the destination directory.
1279 See also bf(--copy-dest) and bf(--link-dest).
1280
1281 dit(bf(--copy-dest=DIR)) This option behaves like bf(--compare-dest), but
1282 rsync will also copy unchanged files found in em(DIR) to the destination
1283 directory using a local copy.
1284 This is useful for doing transfers to a new destination while leaving
1285 existing files intact, and then doing a flash-cutover when all files have
1286 been successfully transferred.
1287
1288 Multiple bf(--copy-dest) directories may be provided, which will cause
1289 rsync to search the list in the order specified for an unchanged file.
1290 If a match is not found, a basis file from one of the em(DIR)s will be
1291 selected to try to speed up the transfer.
1292
1293 If em(DIR) is a relative path, it is relative to the destination directory.
1294 See also bf(--compare-dest) and bf(--link-dest).
1295
1296 dit(bf(--link-dest=DIR)) This option behaves like bf(--copy-dest), but
1297 unchanged files are hard linked from em(DIR) to the destination directory.
1298 The files must be identical in all preserved attributes (e.g. permissions,
1299 possibly ownership) in order for the files to be linked together.
1300 An example:
1301
1302 quote(tt(  rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/))
1303
1304 Beginning in version 2.6.4, multiple bf(--link-dest) directories may be
1305 provided, which will cause rsync to search the list in the order specified
1306 for an exact match.
1307 If a match is found that differs only in attributes, a local copy is made
1308 and the attributes updated.
1309 If a match is not found, a basis file from one of the em(DIR)s will be
1310 selected to try to speed up the transfer.
1311
1312 Note that if you combine this option with bf(--ignore-times), rsync will not
1313 link any files together because it only links identical files together as a
1314 substitute for transferring the file, never as an additional check after the
1315 file is updated.
1316
1317 If em(DIR) is a relative path, it is relative to the destination directory.
1318 See also bf(--compare-dest) and bf(--copy-dest).
1319
1320 Note that rsync versions prior to 2.6.1 had a bug that could prevent
1321 bf(--link-dest) from working properly for a non-super-user when bf(-o) was
1322 specified (or implied by bf(-a)).  You can work-around this bug by avoiding
1323 the bf(-o) option when sending to an old rsync.
1324
1325 dit(bf(-z, --compress)) With this option, rsync compresses the file data
1326 as it is sent to the destination machine, which reduces the amount of data
1327 being transmitted -- something that is useful over a slow connection.
1328
1329 Note that this option typically achieves better compression ratios than can
1330 be achieved by using a compressing remote shell or a compressing transport
1331 because it takes advantage of the implicit information in the matching data
1332 blocks that are not explicitly sent over the connection.
1333
1334 dit(bf(--compress-level=NUM)) Explicitly set the compression level to use
1335 (see bf(--compress)) instead of letting it default.  If NUM is non-zero,
1336 the bf(--compress) option is implied.
1337
1338 dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
1339 and user IDs rather than using user and group names and mapping them
1340 at both ends.
1341
1342 By default rsync will use the username and groupname to determine
1343 what ownership to give files. The special uid 0 and the special group
1344 0 are never mapped via user/group names even if the bf(--numeric-ids)
1345 option is not specified.
1346
1347 If a user or group has no name on the source system or it has no match
1348 on the destination system, then the numeric ID
1349 from the source system is used instead.  See also the comments on the
1350 "use chroot" setting in the rsyncd.conf manpage for information on how
1351 the chroot setting affects rsync's ability to look up the names of the
1352 users and groups and what you can do about it.
1353
1354 dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O
1355 timeout in seconds. If no data is transferred for the specified time
1356 then rsync will exit. The default is 0, which means no timeout.
1357
1358 dit(bf(--address)) By default rsync will bind to the wildcard address when
1359 connecting to an rsync daemon.  The bf(--address) option allows you to
1360 specify a specific IP address (or hostname) to bind to.  See also this
1361 option in the bf(--daemon) mode section.
1362
1363 dit(bf(--port=PORT)) This specifies an alternate TCP port number to use
1364 rather than the default of 873.  This is only needed if you are using the
1365 double-colon (::) syntax to connect with an rsync daemon (since the URL
1366 syntax has a way to specify the port as a part of the URL).  See also this
1367 option in the bf(--daemon) mode section.
1368
1369 dit(bf(--sockopts)) This option can provide endless fun for people
1370 who like to tune their systems to the utmost degree. You can set all
1371 sorts of socket options which may make transfers faster (or
1372 slower!). Read the man page for the code(setsockopt()) system call for
1373 details on some of the options you may be able to set. By default no
1374 special socket options are set. This only affects direct socket
1375 connections to a remote rsync daemon.  This option also exists in the
1376 bf(--daemon) mode section.
1377
1378 dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching
1379 a remote shell transport.  If the remote shell is either rsh or remsh,
1380 rsync defaults to using
1381 blocking I/O, otherwise it defaults to using non-blocking I/O.  (Note that
1382 ssh prefers non-blocking I/O.)
1383
1384 dit(bf(-i, --itemize-changes)) Requests a simple itemized list of the
1385 changes that are being made to each file, including attribute changes.
1386 This is exactly the same as specifying bf(--out-format='%i %n%L').
1387 If you repeat the option, unchanged files will also be output, but only
1388 if the receiving rsync is at least version 2.6.7 (you can use bf(-vv)
1389 with older versions of rsync, but that also turns on the output of other
1390 verbose messages).
1391
1392 The "%i" escape has a cryptic output that is 9 letters long.  The general
1393 format is like the string bf(YXcstpogz), where bf(Y) is replaced by the
1394 type of update being done, bf(X) is replaced by the file-type, and the
1395 other letters represent attributes that may be output if they are being
1396 modified.
1397
1398 The update types that replace the bf(Y) are as follows:
1399
1400 quote(itemization(
1401   it() A bf(<) means that a file is being transferred to the remote host
1402   (sent).
1403   it() A bf(>) means that a file is being transferred to the local host
1404   (received).
1405   it() A bf(c) means that a local change/creation is occurring for the item
1406   (such as the creation of a directory or the changing of a symlink, etc.).
1407   it() A bf(h) means that the item is a hard link to another item (requires
1408   bf(--hard-links)).
1409   it() A bf(.) means that the item is not being updated (though it might
1410   have attributes that are being modified).
1411 ))
1412
1413 The file-types that replace the bf(X) are: bf(f) for a file, a bf(d) for a
1414 directory, an bf(L) for a symlink, a bf(D) for a device, and a bf(S) for a
1415 special file (e.g. named sockets and fifos).
1416
1417 The other letters in the string above are the actual letters that
1418 will be output if the associated attribute for the item is being updated or
1419 a "." for no change.  Three exceptions to this are: (1) a newly created
1420 item replaces each letter with a "+", (2) an identical item replaces the
1421 dots with spaces, and (3) an unknown attribute replaces each letter with
1422 a "?" (this can happen when talking to an older rsync).
1423
1424 The attribute that is associated with each letter is as follows:
1425
1426 quote(itemization(
1427   it() A bf(c) means the checksum of the file is different and will be
1428   updated by the file transfer (requires bf(--checksum)).
1429   it() A bf(s) means the size of the file is different and will be updated
1430   by the file transfer.
1431   it() A bf(t) means the modification time is different and is being updated
1432   to the sender's value (requires bf(--times)).  An alternate value of bf(T)
1433   means that the time will be set to the transfer time, which happens
1434   anytime a symlink is transferred, or when a file or device is transferred
1435   without bf(--times).
1436   it() A bf(p) means the permissions are different and are being updated to
1437   the sender's value (requires bf(--perms)).
1438   it() An bf(o) means the owner is different and is being updated to the
1439   sender's value (requires bf(--owner) and super-user privileges).
1440   it() A bf(g) means the group is different and is being updated to the
1441   sender's value (requires bf(--group) and the authority to set the group).
1442   it() The bf(z) slot is reserved for future use.
1443 ))
1444
1445 One other output is possible:  when deleting files, the "%i" will output
1446 the string "*deleting" for each item that is being removed (assuming that
1447 you are talking to a recent enough rsync that it logs deletions instead of
1448 outputting them as a verbose message).
1449
1450 dit(bf(--out-format=FORMAT)) This allows you to specify exactly what the
1451 rsync client outputs to the user on a per-update basis.  The format is a text
1452 string containing embedded single-character escape sequences prefixed with
1453 a percent (%) character.  For a list of the possible escape characters, see
1454 the "log format" setting in the rsyncd.conf manpage.
1455
1456 Specifying this option will mention each file, dir, etc. that gets updated
1457 in a significant way (a transferred file, a recreated symlink/device, or a
1458 touched directory).  In addition, if the itemize-changes escape (%i) is
1459 included in the string, the logging of names increases to mention any
1460 item that is changed in any way (as long as the receiving side is at least
1461 2.6.4).  See the bf(--itemize-changes) option for a description of the
1462 output of "%i".
1463
1464 The bf(--verbose) option implies a format of "%n%L", but you can use
1465 bf(--out-format) without bf(--verbose) if you like, or you can override
1466 the format of its per-file output using this option.
1467
1468 Rsync will output the out-format string prior to a file's transfer unless
1469 one of the transfer-statistic escapes is requested, in which case the
1470 logging is done at the end of the file's transfer.  When this late logging
1471 is in effect and bf(--progress) is also specified, rsync will also output
1472 the name of the file being transferred prior to its progress information
1473 (followed, of course, by the out-format output).
1474
1475 dit(bf(--log-file=FILE)) This option causes rsync to log what it is doing
1476 to a file.  This is similar to the logging that a daemon does, but can be
1477 requested for the client side and/or the server side of a non-daemon
1478 transfer.  If specified as a client option, transfer logging will be
1479 enabled with a default format of "%i %n%L".  See the bf(--log-file-format)
1480 option if you wish to override this.
1481
1482 Here's a example command that requests the remote side to log what is
1483 happening:
1484
1485 verb(  rsync -av --rsync-path="rsync --log-file=/tmp/rlog" src/ dest/)
1486
1487 This is very useful if you need to debug why a connection is closing
1488 unexpectedly.
1489
1490 dit(bf(--log-file-format=FORMAT)) This allows you to specify exactly what
1491 per-update logging is put into the file specified by the bf(--log-file) option
1492 (which must also be specified for this option to have any effect).  If you
1493 specify an empty string, updated files will not be mentioned in the log file.
1494 For a list of the possible escape characters, see the "log format" setting
1495 in the rsyncd.conf manpage.
1496
1497 dit(bf(--stats)) This tells rsync to print a verbose set of statistics
1498 on the file transfer, allowing you to tell how effective the rsync
1499 algorithm is for your data.
1500
1501 The current statistics are as follows: quote(itemization(
1502   it() bf(Number of files) is the count of all "files" (in the generic
1503   sense), which includes directories, symlinks, etc.
1504   it() bf(Number of files transferred) is the count of normal files that
1505   were updated via the rsync algorithm, which does not include created
1506   dirs, symlinks, etc.
1507   it() bf(Total file size) is the total sum of all file sizes in the transfer.
1508   This does not count any size for directories or special files, but does
1509   include the size of symlinks.
1510   it() bf(Total transferred file size) is the total sum of all files sizes
1511   for just the transferred files.
1512   it() bf(Literal data) is how much unmatched file-update data we had to
1513   send to the receiver for it to recreate the updated files.
1514   it() bf(Matched data) is how much data the receiver got locally when
1515   recreating the updated files.
1516   it() bf(File list size) is how big the file-list data was when the sender
1517   sent it to the receiver.  This is smaller than the in-memory size for the
1518   file list due to some compressing of duplicated data when rsync sends the
1519   list.
1520   it() bf(File list generation time) is the number of seconds that the
1521   sender spent creating the file list.  This requires a modern rsync on the
1522   sending side for this to be present.
1523   it() bf(File list transfer time) is the number of seconds that the sender
1524   spent sending the file list to the receiver.
1525   it() bf(Total bytes sent) is the count of all the bytes that rsync sent
1526   from the client side to the server side.
1527   it() bf(Total bytes received) is the count of all non-message bytes that
1528   rsync received by the client side from the server side.  "Non-message"
1529   bytes means that we don't count the bytes for a verbose message that the
1530   server sent to us, which makes the stats more consistent.
1531 ))
1532
1533 dit(bf(-8, --8-bit-output)) This tells rsync to leave all high-bit characters
1534 unescaped in the output instead of trying to test them to see if they're
1535 valid in the current locale and escaping the invalid ones.  All control
1536 characters (but never tabs) are always escaped, regardless of this option's
1537 setting.
1538
1539 The escape idiom that started in 2.6.7 is to output a literal backslash (\)
1540 and a hash (#), followed by exactly 3 octal digits.  For example, a newline
1541 would output as "\#012".  A literal backslash that is in a filename is not
1542 escaped unless it is followed by a hash and 3 digits (0-9).
1543
1544 dit(bf(-h, --human-readable)) Output numbers in a more human-readable format.
1545 This makes big numbers output using larger units, with a K, M, or G suffix.  If
1546 this option was specified once, these units are K (1000), M (1000*1000), and
1547 G (1000*1000*1000); if the option is repeated, the units are powers of 1024
1548 instead of 1000.
1549
1550 dit(bf(--partial)) By default, rsync will delete any partially
1551 transferred file if the transfer is interrupted. In some circumstances
1552 it is more desirable to keep partially transferred files. Using the
1553 bf(--partial) option tells rsync to keep the partial file which should
1554 make a subsequent transfer of the rest of the file much faster.
1555
1556 dit(bf(--partial-dir=DIR)) A better way to keep partial files than the
1557 bf(--partial) option is to specify a em(DIR) that will be used to hold the
1558 partial data (instead of writing it out to the destination file).
1559 On the next transfer, rsync will use a file found in this
1560 dir as data to speed up the resumption of the transfer and then delete it
1561 after it has served its purpose.
1562
1563 Note that if bf(--whole-file) is specified (or implied), any partial-dir
1564 file that is found for a file that is being updated will simply be removed
1565 (since
1566 rsync is sending files without using the incremental rsync algorithm).
1567
1568 Rsync will create the em(DIR) if it is missing (just the last dir -- not
1569 the whole path).  This makes it easy to use a relative path (such as
1570 "bf(--partial-dir=.rsync-partial)") to have rsync create the
1571 partial-directory in the destination file's directory when needed, and then
1572 remove it again when the partial file is deleted.
1573
1574 If the partial-dir value is not an absolute path, rsync will add an exclude
1575 rule at the end of all your existing excludes.  This will prevent the
1576 sending of any partial-dir files that may exist on the sending side, and
1577 will also prevent the untimely deletion of partial-dir items on the
1578 receiving side.  An example: the above bf(--partial-dir) option would add
1579 the equivalent of "bf(--exclude=.rsync-partial/)" at the end of any other
1580 filter rules.
1581
1582 If you are supplying your own exclude rules, you may need to add your own
1583 exclude/hide/protect rule for the partial-dir because (1) the auto-added
1584 rule may be ineffective at the end of your other rules, or (2) you may wish
1585 to override rsync's exclude choice.  For instance, if you want to make
1586 rsync clean-up any left-over partial-dirs that may be lying around, you
1587 should specify bf(--delete-after) and add a "risk" filter rule, e.g.
1588 bf(-f 'R .rsync-partial/').  (Avoid using bf(--delete-before) or
1589 bf(--delete-during) unless you don't need rsync to use any of the
1590 left-over partial-dir data during the current run.)
1591
1592 IMPORTANT: the bf(--partial-dir) should not be writable by other users or it
1593 is a security risk.  E.g. AVOID "/tmp".
1594
1595 You can also set the partial-dir value the RSYNC_PARTIAL_DIR environment
1596 variable.  Setting this in the environment does not force bf(--partial) to be
1597 enabled, but rather it affects where partial files go when bf(--partial) is
1598 specified.  For instance, instead of using bf(--partial-dir=.rsync-tmp)
1599 along with bf(--progress), you could set RSYNC_PARTIAL_DIR=.rsync-tmp in your
1600 environment and then just use the bf(-P) option to turn on the use of the
1601 .rsync-tmp dir for partial transfers.  The only times that the bf(--partial)
1602 option does not look for this environment value are (1) when bf(--inplace) was
1603 specified (since bf(--inplace) conflicts with bf(--partial-dir)), and (2) when
1604 bf(--delay-updates) was specified (see below).
1605
1606 For the purposes of the daemon-config's "refuse options" setting,
1607 bf(--partial-dir) does em(not) imply bf(--partial).  This is so that a
1608 refusal of the bf(--partial) option can be used to disallow the overwriting
1609 of destination files with a partial transfer, while still allowing the
1610 safer idiom provided by bf(--partial-dir).
1611
1612 dit(bf(--delay-updates)) This option puts the temporary file from each
1613 updated file into a holding directory until the end of the
1614 transfer, at which time all the files are renamed into place in rapid
1615 succession.  This attempts to make the updating of the files a little more
1616 atomic.  By default the files are placed into a directory named ".~tmp~" in
1617 each file's destination directory, but if you've specified the
1618 bf(--partial-dir) option, that directory will be used instead.  See the
1619 comments in the bf(--partial-dir) section for a discussion of how this
1620 ".~tmp~" dir will be excluded from the transfer, and what you can do if
1621 you wnat rsync to cleanup old ".~tmp~" dirs that might be lying around.
1622 Conflicts with bf(--inplace) and bf(--append).
1623
1624 This option uses more memory on the receiving side (one bit per file
1625 transferred) and also requires enough free disk space on the receiving
1626 side to hold an additional copy of all the updated files.  Note also that
1627 you should not use an absolute path to bf(--partial-dir) unless (1)
1628 there is no
1629 chance of any of the files in the transfer having the same name (since all
1630 the updated files will be put into a single directory if the path is
1631 absolute)
1632 and (2) there are no mount points in the hierarchy (since the
1633 delayed updates will fail if they can't be renamed into place).
1634
1635 See also the "atomic-rsync" perl script in the "support" subdir for an
1636 update algorithm that is even more atomic (it uses bf(--link-dest) and a
1637 parallel hierarchy of files).
1638
1639 dit(bf(-m, --prune-empty-dirs)) This option tells the receiving rsync to get
1640 rid of empty directories from the file-list, including nested directories
1641 that have no non-directory children.  This is useful for avoiding the
1642 creation of a bunch of useless directories when the sending rsync is
1643 recursively scanning a hierarchy of files using include/exclude/filter
1644 rules.
1645
1646 Because the file-list is actually being pruned, this option also affects
1647 what directories get deleted when a delete is active.  However, keep in
1648 mind that excluded files and directories can prevent existing items from
1649 being deleted (because an exclude hides source files and protects
1650 destination files).
1651
1652 You can prevent the pruning of certain empty directories from the file-list
1653 by using a global "protect" filter.  For instance, this option would ensure
1654 that the directory "emptydir" was kept in the file-list:
1655
1656 quote(    --filter 'protect emptydir/')
1657
1658 Here's an example that copies all .pdf files in a hierarchy, only creating
1659 the necessary destination directories to hold the .pdf files, and ensures
1660 that any superfluous files and directories in the destination are removed
1661 (note the hide filter of non-directories being used instead of an exclude):
1662
1663 quote(     rsync -avm --del --include='*.pdf' -f 'hide,! */' src/ dest)
1664
1665 If you didn't want to remove superfluous destination files, the more
1666 time-honored options of "--include='*/' --exclude='*'" would work fine
1667 in place of the hide-filter (if that is more natural to you).
1668
1669 dit(bf(--progress)) This option tells rsync to print information
1670 showing the progress of the transfer. This gives a bored user
1671 something to watch.
1672 Implies bf(--verbose) if it wasn't already specified.
1673
1674 While rsync is transferring a regular file, it updates a progress line that
1675 looks like this:
1676
1677 verb(      782448  63%  110.64kB/s    0:00:04)
1678
1679 In this example, the receiver has reconstructed 782448 bytes or 63% of the
1680 sender's file, which is being reconstructed at a rate of 110.64 kilobytes
1681 per second, and the transfer will finish in 4 seconds if the current rate
1682 is maintained until the end.
1683
1684 These statistics can be misleading if the incremental transfer algorithm is
1685 in use.  For example, if the sender's file consists of the basis file
1686 followed by additional data, the reported rate will probably drop
1687 dramatically when the receiver gets to the literal data, and the transfer
1688 will probably take much longer to finish than the receiver estimated as it
1689 was finishing the matched part of the file.
1690
1691 When the file transfer finishes, rsync replaces the progress line with a
1692 summary line that looks like this:
1693
1694 verb(     1238099 100%  146.38kB/s    0:00:08  (xfer#5, to-check=169/396))
1695
1696 In this example, the file was 1238099 bytes long in total, the average rate
1697 of transfer for the whole file was 146.38 kilobytes per second over the 8
1698 seconds that it took to complete, it was the 5th transfer of a regular file
1699 during the current rsync session, and there are 169 more files for the
1700 receiver to check (to see if they are up-to-date or not) remaining out of
1701 the 396 total files in the file-list.
1702
1703 dit(bf(-P)) The bf(-P) option is equivalent to bf(--partial) bf(--progress).  Its
1704 purpose is to make it much easier to specify these two options for a long
1705 transfer that may be interrupted.
1706
1707 dit(bf(--password-file)) This option allows you to provide a password
1708 in a file for accessing a remote rsync daemon. Note that this option
1709 is only useful when accessing an rsync daemon using the built in
1710 transport, not when using a remote shell as the transport. The file
1711 must not be world readable. It should contain just the password as a
1712 single line.
1713
1714 dit(bf(--list-only)) This option will cause the source files to be listed
1715 instead of transferred.  This option is inferred if there is a single source
1716 arg and no destination specified, so its main uses are: (1) to turn a copy
1717 command that includes a
1718 destination arg into a file-listing command, (2) to be able to specify more
1719 than one local source arg (note: be sure to include the destination), or
1720 (3) to avoid the automatically added "bf(-r --exclude='/*/*')" options that
1721 rsync usually uses as a compatibility kluge when generating a non-recursive
1722 listing.  Caution: keep in mind that a source arg with a wild-card is expanded
1723 by the shell into multiple args, so it is never safe to try to list such an arg
1724 without using this option.  For example:
1725
1726 verb(    rsync -av --list-only foo* dest/)
1727
1728 dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum
1729 transfer rate in kilobytes per second. This option is most effective when
1730 using rsync with large files (several megabytes and up). Due to the nature
1731 of rsync transfers, blocks of data are sent, then if rsync determines the
1732 transfer was too fast, it will wait before sending the next data block. The
1733 result is an average transfer rate equaling the specified limit. A value
1734 of zero specifies no limit.
1735
1736 dit(bf(--write-batch=FILE)) Record a file that can later be applied to
1737 another identical destination with bf(--read-batch). See the "BATCH MODE"
1738 section for details, and also the bf(--only-write-batch) option.
1739
1740 dit(bf(--only-write-batch=FILE)) Works like bf(--write-batch), except that
1741 no updates are made on the destination system when creating the batch.
1742 This lets you transport the changes to the destination system via some
1743 other means and then apply the changes via bf(--read-batch).
1744
1745 Note that you can feel free to write the batch directly to some portable
1746 media: if this media fills to capacity before the end of the transfer, you
1747 can just apply that partial transfer to the destination and repeat the
1748 whole process to get the rest of the changes (as long as you don't mind a
1749 partially updated destination system while the multi-update cycle is
1750 happening).
1751
1752 Also note that you only save bandwidth when pushing changes to a remote
1753 system because this allows the batched data to be diverted from the sender
1754 into the batch file without having to flow over the wire to the receiver
1755 (when pulling, the sender is remote, and thus can't write the batch).
1756
1757 dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a
1758 file previously generated by bf(--write-batch).
1759 If em(FILE) is bf(-), the batch data will be read from standard input.
1760 See the "BATCH MODE" section for details.
1761
1762 dit(bf(--protocol=NUM)) Force an older protocol version to be used.  This
1763 is useful for creating a batch file that is compatible with an older
1764 version of rsync.  For instance, if rsync 2.6.4 is being used with the
1765 bf(--write-batch) option, but rsync 2.6.3 is what will be used to run the
1766 bf(--read-batch) option, you should use "--protocol=28" when creating the
1767 batch file to force the older protocol version to be used in the batch
1768 file (assuming you can't upgrade the rsync on the reading system).
1769
1770 dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6
1771 when creating sockets.  This only affects sockets that rsync has direct
1772 control over, such as the outgoing socket when directly contacting an
1773 rsync daemon.  See also these options in the bf(--daemon) mode section.
1774
1775 dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer
1776 NUM.  This 4 byte checksum seed is included in each block and file
1777 MD4 checksum calculation.  By default the checksum seed is generated
1778 by the server and defaults to the current code(time()).  This option
1779 is used to set a specific checksum seed, which is useful for
1780 applications that want repeatable block and file checksums, or
1781 in the case where the user wants a more random checksum seed.
1782 Note that setting NUM to 0 causes rsync to use the default of code(time())
1783 for checksum seed.
1784 enddit()
1785
1786 manpagesection(DAEMON OPTIONS)
1787
1788 The options allowed when starting an rsync daemon are as follows:
1789
1790 startdit()
1791 dit(bf(--daemon)) This tells rsync that it is to run as a daemon.  The
1792 daemon you start running may be accessed using an rsync client using
1793 the bf(host::module) or bf(rsync://host/module/) syntax.
1794
1795 If standard input is a socket then rsync will assume that it is being
1796 run via inetd, otherwise it will detach from the current terminal and
1797 become a background daemon.  The daemon will read the config file
1798 (rsyncd.conf) on each connect made by a client and respond to
1799 requests accordingly.  See the bf(rsyncd.conf)(5) man page for more
1800 details.
1801
1802 dit(bf(--address)) By default rsync will bind to the wildcard address when
1803 run as a daemon with the bf(--daemon) option.  The bf(--address) option
1804 allows you to specify a specific IP address (or hostname) to bind to.  This
1805 makes virtual hosting possible in conjunction with the bf(--config) option.
1806 See also the "address" global option in the rsyncd.conf manpage.
1807
1808 dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum
1809 transfer rate in kilobytes per second for the data the daemon sends.
1810 The client can still specify a smaller bf(--bwlimit) value, but their
1811 requested value will be rounded down if they try to exceed it.  See the
1812 client version of this option (above) for some extra details.
1813
1814 dit(bf(--config=FILE)) This specifies an alternate config file than
1815 the default.  This is only relevant when bf(--daemon) is specified.
1816 The default is /etc/rsyncd.conf unless the daemon is running over
1817 a remote shell program and the remote user is not the super-user; in that case
1818 the default is rsyncd.conf in the current directory (typically $HOME).
1819
1820 dit(bf(--no-detach)) When running as a daemon, this option instructs
1821 rsync to not detach itself and become a background process.  This
1822 option is required when running as a service on Cygwin, and may also
1823 be useful when rsync is supervised by a program such as
1824 bf(daemontools) or AIX's bf(System Resource Controller).
1825 bf(--no-detach) is also recommended when rsync is run under a
1826 debugger.  This option has no effect if rsync is run from inetd or
1827 sshd.
1828
1829 dit(bf(--port=PORT)) This specifies an alternate TCP port number for the
1830 daemon to listen on rather than the default of 873.  See also the "port"
1831 global option in the rsyncd.conf manpage.
1832
1833 dit(bf(--log-file=FILE)) This option tells the rsync daemon to use the
1834 given log-file name instead of using the "log file" setting in the config
1835 file.
1836
1837 dit(bf(--log-file-format=FORMAT)) This option tells the rsync daemon to use the
1838 given FORMAT string instead of using the "log format" setting in the config
1839 file.  It also enables "transfer logging" unless the string is empty, in which
1840 case transfer logging is turned off.
1841
1842 dit(bf(--sockopts)) This overrides the bf(socket options) setting in the
1843 rsyncd.conf file and has the same syntax.
1844
1845 dit(bf(-v, --verbose)) This option increases the amount of information the
1846 daemon logs during its startup phase.  After the client connects, the
1847 daemon's verbosity level will be controlled by the options that the client
1848 used and the "max verbosity" setting in the module's config section.
1849
1850 dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6
1851 when creating the incoming sockets that the rsync daemon will use to
1852 listen for connections.  One of these options may be required in older
1853 versions of Linux to work around an IPv6 bug in the kernel (if you see
1854 an "address already in use" error when nothing else is using the port,
1855 try specifying bf(--ipv6) or bf(--ipv4) when starting the daemon).
1856
1857 dit(bf(-h, --help)) When specified after bf(--daemon), print a short help
1858 page describing the options available for starting an rsync daemon.
1859 enddit()
1860
1861 manpagesection(FILTER RULES)
1862
1863 The filter rules allow for flexible selection of which files to transfer
1864 (include) and which files to skip (exclude).  The rules either directly
1865 specify include/exclude patterns or they specify a way to acquire more
1866 include/exclude patterns (e.g. to read them from a file).
1867
1868 As the list of files/directories to transfer is built, rsync checks each
1869 name to be transferred against the list of include/exclude patterns in
1870 turn, and the first matching pattern is acted on:  if it is an exclude
1871 pattern, then that file is skipped; if it is an include pattern then that
1872 filename is not skipped; if no matching pattern is found, then the
1873 filename is not skipped.
1874
1875 Rsync builds an ordered list of filter rules as specified on the
1876 command-line.  Filter rules have the following syntax:
1877
1878 quote(
1879 tt(RULE [PATTERN_OR_FILENAME])nl()
1880 tt(RULE,MODIFIERS [PATTERN_OR_FILENAME])nl()
1881 )
1882
1883 You have your choice of using either short or long RULE names, as described
1884 below.  If you use a short-named rule, the ',' separating the RULE from the
1885 MODIFIERS is optional.  The PATTERN or FILENAME that follows (when present)
1886 must come after either a single space or an underscore (_).
1887 Here are the available rule prefixes:
1888
1889 quote(
1890 bf(exclude, -) specifies an exclude pattern. nl()
1891 bf(include, +) specifies an include pattern. nl()
1892 bf(merge, .) specifies a merge-file to read for more rules. nl()
1893 bf(dir-merge, :) specifies a per-directory merge-file. nl()
1894 bf(hide, H) specifies a pattern for hiding files from the transfer. nl()
1895 bf(show, S) files that match the pattern are not hidden. nl()
1896 bf(protect, P) specifies a pattern for protecting files from deletion. nl()
1897 bf(risk, R) files that match the pattern are not protected. nl()
1898 bf(clear, !) clears the current include/exclude list (takes no arg) nl()
1899 )
1900
1901 When rules are being read from a file, empty lines are ignored, as are
1902 comment lines that start with a "#".
1903
1904 Note that the bf(--include)/bf(--exclude) command-line options do not allow the
1905 full range of rule parsing as described above -- they only allow the
1906 specification of include/exclude patterns plus a "!" token to clear the
1907 list (and the normal comment parsing when rules are read from a file).
1908 If a pattern
1909 does not begin with "- " (dash, space) or "+ " (plus, space), then the
1910 rule will be interpreted as if "+ " (for an include option) or "- " (for
1911 an exclude option) were prefixed to the string.  A bf(--filter) option, on
1912 the other hand, must always contain either a short or long rule name at the
1913 start of the rule.
1914
1915 Note also that the bf(--filter), bf(--include), and bf(--exclude) options take one
1916 rule/pattern each. To add multiple ones, you can repeat the options on
1917 the command-line, use the merge-file syntax of the bf(--filter) option, or
1918 the bf(--include-from)/bf(--exclude-from) options.
1919
1920 manpagesection(INCLUDE/EXCLUDE PATTERN RULES)
1921
1922 You can include and exclude files by specifying patterns using the "+",
1923 "-", etc. filter rules (as introduced in the FILTER RULES section above).
1924 The include/exclude rules each specify a pattern that is matched against
1925 the names of the files that are going to be transferred.  These patterns
1926 can take several forms:
1927
1928 itemization(
1929   it() if the pattern starts with a / then it is anchored to a
1930   particular spot in the hierarchy of files, otherwise it is matched
1931   against the end of the pathname.  This is similar to a leading ^ in
1932   regular expressions.
1933   Thus "/foo" would match a file named "foo" at either the "root of the
1934   transfer" (for a global rule) or in the merge-file's directory (for a
1935   per-directory rule).
1936   An unqualified "foo" would match any file or directory named "foo"
1937   anywhere in the tree because the algorithm is applied recursively from
1938   the
1939   top down; it behaves as if each path component gets a turn at being the
1940   end of the file name.  Even the unanchored "sub/foo" would match at
1941   any point in the hierarchy where a "foo" was found within a directory
1942   named "sub".  See the section on ANCHORING INCLUDE/EXCLUDE PATTERNS for
1943   a full discussion of how to specify a pattern that matches at the root
1944   of the transfer.
1945   it() if the pattern ends with a / then it will only match a
1946   directory, not a file, link, or device.
1947   it() rsync chooses between doing a simple string match and wildcard
1948   matching by checking if the pattern contains one of these three wildcard
1949   characters: '*', '?', and '[' .
1950   it() a '*' matches any non-empty path component (it stops at slashes).
1951   it() use '**' to match anything, including slashes.
1952   it() a '?' matches any character except a slash (/).
1953   it() a '[' introduces a character class, such as [a-z] or [[:alpha:]].
1954   it() in a wildcard pattern, a backslash can be used to escape a wildcard
1955   character, but it is matched literally when no wildcards are present.
1956   it() if the pattern contains a / (not counting a trailing /) or a "**",
1957   then it is matched against the full pathname, including any leading
1958   directories. If the pattern doesn't contain a / or a "**", then it is
1959   matched only against the final component of the filename.
1960   (Remember that the algorithm is applied recursively so "full filename"
1961   can actually be any portion of a path from the starting directory on
1962   down.)
1963   it() a trailing "dir_name/***" will match both the directory (as if
1964   "dir_name/" had been specified) and all the files in the directory
1965   (as if "dir_name/**" had been specified).  (This behavior is new for
1966   version 2.6.7.)
1967 )
1968
1969 Note that, when using the bf(--recursive) (bf(-r)) option (which is implied by
1970 bf(-a)), every subcomponent of every path is visited from the top down, so
1971 include/exclude patterns get applied recursively to each subcomponent's
1972 full name (e.g. to include "/foo/bar/baz" the subcomponents "/foo" and
1973 "/foo/bar" must not be excluded).
1974 The exclude patterns actually short-circuit the directory traversal stage
1975 when rsync finds the files to send.  If a pattern excludes a particular
1976 parent directory, it can render a deeper include pattern ineffectual
1977 because rsync did not descend through that excluded section of the
1978 hierarchy.  This is particularly important when using a trailing '*' rule.
1979 For instance, this won't work:
1980
1981 quote(
1982 tt(+ /some/path/this-file-will-not-be-found)nl()
1983 tt(+ /file-is-included)nl()
1984 tt(- *)nl()
1985 )
1986
1987 This fails because the parent directory "some" is excluded by the '*'
1988 rule, so rsync never visits any of the files in the "some" or "some/path"
1989 directories.  One solution is to ask for all directories in the hierarchy
1990 to be included by using a single rule: "+ */" (put it somewhere before the
1991 "- *" rule), and perhaps use the bf(--prune-empty-dirs) option.  Another
1992 solution is to add specific include rules for all
1993 the parent dirs that need to be visited.  For instance, this set of rules
1994 works fine:
1995
1996 quote(
1997 tt(+ /some/)nl()
1998 tt(+ /some/path/)nl()
1999 tt(+ /some/path/this-file-is-found)nl()
2000 tt(+ /file-also-included)nl()
2001 tt(- *)nl()
2002 )
2003
2004 Here are some examples of exclude/include matching:
2005
2006 itemization(
2007   it() "- *.o" would exclude all filenames matching *.o
2008   it() "- /foo" would exclude a file (or directory) named foo in the
2009   transfer-root directory
2010   it() "- foo/" would exclude any directory named foo
2011   it() "- /foo/*/bar" would exclude any file named bar which is at two
2012   levels below a directory named foo in the transfer-root directory
2013   it() "- /foo/**/bar" would exclude any file named bar two
2014   or more levels below a directory named foo in the transfer-root directory
2015   it() The combination of "+ */", "+ *.c", and "- *" would include all
2016   directories and C source files but nothing else (see also the
2017   bf(--prune-empty-dirs) option)
2018   it() The combination of "+ foo/", "+ foo/bar.c", and "- *" would include
2019   only the foo directory and foo/bar.c (the foo directory must be
2020   explicitly included or it would be excluded by the "*")
2021 )
2022
2023 manpagesection(MERGE-FILE FILTER RULES)
2024
2025 You can merge whole files into your filter rules by specifying either a
2026 merge (.) or a dir-merge (:) filter rule (as introduced in the FILTER RULES
2027 section above).
2028
2029 There are two kinds of merged files -- single-instance ('.') and
2030 per-directory (':').  A single-instance merge file is read one time, and
2031 its rules are incorporated into the filter list in the place of the "."
2032 rule.  For per-directory merge files, rsync will scan every directory that
2033 it traverses for the named file, merging its contents when the file exists
2034 into the current list of inherited rules.  These per-directory rule files
2035 must be created on the sending side because it is the sending side that is
2036 being scanned for the available files to transfer.  These rule files may
2037 also need to be transferred to the receiving side if you want them to
2038 affect what files don't get deleted (see PER-DIRECTORY RULES AND DELETE
2039 below).
2040
2041 Some examples:
2042
2043 quote(
2044 tt(merge /etc/rsync/default.rules)nl()
2045 tt(. /etc/rsync/default.rules)nl()
2046 tt(dir-merge .per-dir-filter)nl()
2047 tt(dir-merge,n- .non-inherited-per-dir-excludes)nl()
2048 tt(:n- .non-inherited-per-dir-excludes)nl()
2049 )
2050
2051 The following modifiers are accepted after a merge or dir-merge rule:
2052
2053 itemization(
2054   it() A bf(-) specifies that the file should consist of only exclude
2055   patterns, with no other rule-parsing except for in-file comments.
2056   it() A bf(+) specifies that the file should consist of only include
2057   patterns, with no other rule-parsing except for in-file comments.
2058   it() A bf(C) is a way to specify that the file should be read in a
2059   CVS-compatible manner.  This turns on 'n', 'w', and '-', but also
2060   allows the list-clearing token (!) to be specified.  If no filename is
2061   provided, ".cvsignore" is assumed.
2062   it() A bf(e) will exclude the merge-file name from the transfer; e.g.
2063   "dir-merge,e .rules" is like "dir-merge .rules" and "- .rules".
2064   it() An bf(n) specifies that the rules are not inherited by subdirectories.
2065   it() A bf(w) specifies that the rules are word-split on whitespace instead
2066   of the normal line-splitting.  This also turns off comments.  Note: the
2067   space that separates the prefix from the rule is treated specially, so
2068   "- foo + bar" is parsed as two rules (assuming that prefix-parsing wasn't
2069   also disabled).
2070   it() You may also specify any of the modifiers for the "+" or "-" rules
2071   (below) in order to have the rules that are read in from the file
2072   default to having that modifier set.  For instance, "merge,-/ .excl" would
2073   treat the contents of .excl as absolute-path excludes,
2074   while "dir-merge,s .filt" and ":sC" would each make all their
2075   per-directory rules apply only on the sending side.
2076 )
2077
2078 The following modifiers are accepted after a "+" or "-":
2079
2080 itemization(
2081   it() A "/" specifies that the include/exclude rule should be matched
2082   against the absolute pathname of the current item.  For example,
2083   "-/ /etc/passwd" would exclude the passwd file any time the transfer
2084   was sending files from the "/etc" directory, and "-/ subdir/foo"
2085   would always exclude "foo" when it is in a dir named "subdir", even
2086   if "foo" is at the root of the current transfer.
2087   it() A "!" specifies that the include/exclude should take effect if
2088   the pattern fails to match.  For instance, "-! */" would exclude all
2089   non-directories.
2090   it() A bf(C) is used to indicate that all the global CVS-exclude rules
2091   should be inserted as excludes in place of the "-C".  No arg should
2092   follow.
2093   it() An bf(s) is used to indicate that the rule applies to the sending
2094   side.  When a rule affects the sending side, it prevents files from
2095   being transferred.  The default is for a rule to affect both sides
2096   unless bf(--delete-excluded) was specified, in which case default rules
2097   become sender-side only.  See also the hide (H) and show (S) rules,
2098   which are an alternate way to specify sending-side includes/excludes.
2099   it() An bf(r) is used to indicate that the rule applies to the receiving
2100   side.  When a rule affects the receiving side, it prevents files from
2101   being deleted.  See the bf(s) modifier for more info.  See also the
2102   protect (P) and risk (R) rules, which are an alternate way to
2103   specify receiver-side includes/excludes.
2104 )
2105
2106 Per-directory rules are inherited in all subdirectories of the directory
2107 where the merge-file was found unless the 'n' modifier was used.  Each
2108 subdirectory's rules are prefixed to the inherited per-directory rules
2109 from its parents, which gives the newest rules a higher priority than the
2110 inherited rules.  The entire set of dir-merge rules are grouped together in
2111 the spot where the merge-file was specified, so it is possible to override
2112 dir-merge rules via a rule that got specified earlier in the list of global
2113 rules.  When the list-clearing rule ("!") is read from a per-directory
2114 file, it only clears the inherited rules for the current merge file.
2115
2116 Another way to prevent a single rule from a dir-merge file from being inherited is to
2117 anchor it with a leading slash.  Anchored rules in a per-directory
2118 merge-file are relative to the merge-file's directory, so a pattern "/foo"
2119 would only match the file "foo" in the directory where the dir-merge filter
2120 file was found.
2121
2122 Here's an example filter file which you'd specify via bf(--filter=". file":)
2123
2124 quote(
2125 tt(merge /home/user/.global-filter)nl()
2126 tt(- *.gz)nl()
2127 tt(dir-merge .rules)nl()
2128 tt(+ *.[ch])nl()
2129 tt(- *.o)nl()
2130 )
2131
2132 This will merge the contents of the /home/user/.global-filter file at the
2133 start of the list and also turns the ".rules" filename into a per-directory
2134 filter file.  All rules read in prior to the start of the directory scan
2135 follow the global anchoring rules (i.e. a leading slash matches at the root
2136 of the transfer).
2137
2138 If a per-directory merge-file is specified with a path that is a parent
2139 directory of the first transfer directory, rsync will scan all the parent
2140 dirs from that starting point to the transfer directory for the indicated
2141 per-directory file.  For instance, here is a common filter (see bf(-F)):
2142
2143 quote(tt(--filter=': /.rsync-filter'))
2144
2145 That rule tells rsync to scan for the file .rsync-filter in all
2146 directories from the root down through the parent directory of the
2147 transfer prior to the start of the normal directory scan of the file in
2148 the directories that are sent as a part of the transfer.  (Note: for an
2149 rsync daemon, the root is always the same as the module's "path".)
2150
2151 Some examples of this pre-scanning for per-directory files:
2152
2153 quote(
2154 tt(rsync -avF /src/path/ /dest/dir)nl()
2155 tt(rsync -av --filter=': ../../.rsync-filter' /src/path/ /dest/dir)nl()
2156 tt(rsync -av --filter=': .rsync-filter' /src/path/ /dest/dir)nl()
2157 )
2158
2159 The first two commands above will look for ".rsync-filter" in "/" and
2160 "/src" before the normal scan begins looking for the file in "/src/path"
2161 and its subdirectories.  The last command avoids the parent-dir scan
2162 and only looks for the ".rsync-filter" files in each directory that is
2163 a part of the transfer.
2164
2165 If you want to include the contents of a ".cvsignore" in your patterns,
2166 you should use the rule ":C", which creates a dir-merge of the .cvsignore
2167 file, but parsed in a CVS-compatible manner.  You can
2168 use this to affect where the bf(--cvs-exclude) (bf(-C)) option's inclusion of the
2169 per-directory .cvsignore file gets placed into your rules by putting the
2170 ":C" wherever you like in your filter rules.  Without this, rsync would
2171 add the dir-merge rule for the .cvsignore file at the end of all your other
2172 rules (giving it a lower priority than your command-line rules).  For
2173 example:
2174
2175 quote(
2176 tt(cat <<EOT | rsync -avC --filter='. -' a/ b)nl()
2177 tt(+ foo.o)nl()
2178 tt(:C)nl()
2179 tt(- *.old)nl()
2180 tt(EOT)nl()
2181 tt(rsync -avC --include=foo.o -f :C --exclude='*.old' a/ b)nl()
2182 )
2183
2184 Both of the above rsync commands are identical.  Each one will merge all
2185 the per-directory .cvsignore rules in the middle of the list rather than
2186 at the end.  This allows their dir-specific rules to supersede the rules
2187 that follow the :C instead of being subservient to all your rules.  To
2188 affect the other CVS exclude rules (i.e. the default list of exclusions,
2189 the contents of $HOME/.cvsignore, and the value of $CVSIGNORE) you should
2190 omit the bf(-C) command-line option and instead insert a "-C" rule into
2191 your filter rules; e.g. "--filter=-C".
2192
2193 manpagesection(LIST-CLEARING FILTER RULE)
2194
2195 You can clear the current include/exclude list by using the "!" filter
2196 rule (as introduced in the FILTER RULES section above).  The "current"
2197 list is either the global list of rules (if the rule is encountered while
2198 parsing the filter options) or a set of per-directory rules (which are
2199 inherited in their own sub-list, so a subdirectory can use this to clear
2200 out the parent's rules).
2201
2202 manpagesection(ANCHORING INCLUDE/EXCLUDE PATTERNS)
2203
2204 As mentioned earlier, global include/exclude patterns are anchored at the
2205 "root of the transfer" (as opposed to per-directory patterns, which are
2206 anchored at the merge-file's directory).  If you think of the transfer as
2207 a subtree of names that are being sent from sender to receiver, the
2208 transfer-root is where the tree starts to be duplicated in the destination
2209 directory.  This root governs where patterns that start with a / match.
2210
2211 Because the matching is relative to the transfer-root, changing the
2212 trailing slash on a source path or changing your use of the bf(--relative)
2213 option affects the path you need to use in your matching (in addition to
2214 changing how much of the file tree is duplicated on the destination
2215 host).  The following examples demonstrate this.
2216
2217 Let's say that we want to match two source files, one with an absolute
2218 path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz".
2219 Here is how the various command choices differ for a 2-source transfer:
2220
2221 quote(
2222    Example cmd: rsync -a /home/me /home/you /dest nl()
2223    +/- pattern: /me/foo/bar nl()
2224    +/- pattern: /you/bar/baz nl()
2225    Target file: /dest/me/foo/bar nl()
2226    Target file: /dest/you/bar/baz nl()
2227 )
2228
2229 quote(
2230    Example cmd: rsync -a /home/me/ /home/you/ /dest nl()
2231    +/- pattern: /foo/bar               (note missing "me") nl()
2232    +/- pattern: /bar/baz               (note missing "you") nl()
2233    Target file: /dest/foo/bar nl()
2234    Target file: /dest/bar/baz nl()
2235 )
2236
2237 quote(
2238    Example cmd: rsync -a --relative /home/me/ /home/you /dest nl()
2239    +/- pattern: /home/me/foo/bar       (note full path) nl()
2240    +/- pattern: /home/you/bar/baz      (ditto) nl()
2241    Target file: /dest/home/me/foo/bar nl()
2242    Target file: /dest/home/you/bar/baz nl()
2243 )
2244
2245 quote(
2246    Example cmd: cd /home; rsync -a --relative me/foo you/ /dest nl()
2247    +/- pattern: /me/foo/bar      (starts at specified path) nl()
2248    +/- pattern: /you/bar/baz     (ditto) nl()
2249    Target file: /dest/me/foo/bar nl()
2250    Target file: /dest/you/bar/baz nl()
2251 )
2252
2253 The easiest way to see what name you should filter is to just
2254 look at the output when using bf(--verbose) and put a / in front of the name
2255 (use the bf(--dry-run) option if you're not yet ready to copy any files).
2256
2257 manpagesection(PER-DIRECTORY RULES AND DELETE)
2258
2259 Without a delete option, per-directory rules are only relevant on the
2260 sending side, so you can feel free to exclude the merge files themselves
2261 without affecting the transfer.  To make this easy, the 'e' modifier adds
2262 this exclude for you, as seen in these two equivalent commands:
2263
2264 quote(
2265 tt(rsync -av --filter=': .excl' --exclude=.excl host:src/dir /dest)nl()
2266 tt(rsync -av --filter=':e .excl' host:src/dir /dest)nl()
2267 )
2268
2269 However, if you want to do a delete on the receiving side AND you want some
2270 files to be excluded from being deleted, you'll need to be sure that the
2271 receiving side knows what files to exclude.  The easiest way is to include
2272 the per-directory merge files in the transfer and use bf(--delete-after),
2273 because this ensures that the receiving side gets all the same exclude
2274 rules as the sending side before it tries to delete anything:
2275
2276 quote(tt(rsync -avF --delete-after host:src/dir /dest))
2277
2278 However, if the merge files are not a part of the transfer, you'll need to
2279 either specify some global exclude rules (i.e. specified on the command
2280 line), or you'll need to maintain your own per-directory merge files on
2281 the receiving side.  An example of the first is this (assume that the
2282 remote .rules files exclude themselves):
2283
2284 verb(rsync -av --filter=': .rules' --filter='. /my/extra.rules'
2285    --delete host:src/dir /dest)
2286
2287 In the above example the extra.rules file can affect both sides of the
2288 transfer, but (on the sending side) the rules are subservient to the rules
2289 merged from the .rules files because they were specified after the
2290 per-directory merge rule.
2291
2292 In one final example, the remote side is excluding the .rsync-filter
2293 files from the transfer, but we want to use our own .rsync-filter files
2294 to control what gets deleted on the receiving side.  To do this we must
2295 specifically exclude the per-directory merge files (so that they don't get
2296 deleted) and then put rules into the local files to control what else
2297 should not get deleted.  Like one of these commands:
2298
2299 verb(    rsync -av --filter=':e /.rsync-filter' --delete \ 
2300         host:src/dir /dest
2301     rsync -avFF --delete host:src/dir /dest)
2302
2303 manpagesection(BATCH MODE)
2304
2305 Batch mode can be used to apply the same set of updates to many
2306 identical systems. Suppose one has a tree which is replicated on a
2307 number of hosts.  Now suppose some changes have been made to this
2308 source tree and those changes need to be propagated to the other
2309 hosts. In order to do this using batch mode, rsync is run with the
2310 write-batch option to apply the changes made to the source tree to one
2311 of the destination trees.  The write-batch option causes the rsync
2312 client to store in a "batch file" all the information needed to repeat
2313 this operation against other, identical destination trees.
2314
2315 To apply the recorded changes to another destination tree, run rsync
2316 with the read-batch option, specifying the name of the same batch
2317 file, and the destination tree.  Rsync updates the destination tree
2318 using the information stored in the batch file.
2319
2320 For convenience, one additional file is creating when the write-batch
2321 option is used.  This file's name is created by appending
2322 ".sh" to the batch filename.  The .sh file contains
2323 a command-line suitable for updating a destination tree using that
2324 batch file. It can be executed using a Bourne (or Bourne-like) shell,
2325 optionally
2326 passing in an alternate destination tree pathname which is then used
2327 instead of the original path. This is useful when the destination tree
2328 path differs from the original destination tree path.
2329
2330 Generating the batch file once saves having to perform the file
2331 status, checksum, and data block generation more than once when
2332 updating multiple destination trees. Multicast transport protocols can
2333 be used to transfer the batch update files in parallel to many hosts
2334 at once, instead of sending the same data to every host individually.
2335
2336 Examples:
2337
2338 quote(
2339 tt($ rsync --write-batch=foo -a host:/source/dir/ /adest/dir/)nl()
2340 tt($ scp foo* remote:)nl()
2341 tt($ ssh remote ./foo.sh /bdest/dir/)nl()
2342 )
2343
2344 quote(
2345 tt($ rsync --write-batch=foo -a /source/dir/ /adest/dir/)nl()
2346 tt($ ssh remote rsync --read-batch=- -a /bdest/dir/ <foo)nl()
2347 )
2348
2349 In these examples, rsync is used to update /adest/dir/ from /source/dir/
2350 and the information to repeat this operation is stored in "foo" and
2351 "foo.sh".  The host "remote" is then updated with the batched data going
2352 into the directory /bdest/dir.  The differences between the two examples
2353 reveals some of the flexibility you have in how you deal with batches:
2354
2355 itemization(
2356   it() The first example shows that the initial copy doesn't have to be
2357   local -- you can push or pull data to/from a remote host using either the
2358   remote-shell syntax or rsync daemon syntax, as desired.
2359   it() The first example uses the created "foo.sh" file to get the right
2360   rsync options when running the read-batch command on the remote host.
2361   it() The second example reads the batch data via standard input so that
2362   the batch file doesn't need to be copied to the remote machine first.
2363   This example avoids the foo.sh script because it needed to use a modified
2364   bf(--read-batch) option, but you could edit the script file if you wished to
2365   make use of it (just be sure that no other option is trying to use
2366   standard input, such as the "bf(--exclude-from=-)" option).
2367 )
2368
2369 Caveats:
2370
2371 The read-batch option expects the destination tree that it is updating
2372 to be identical to the destination tree that was used to create the
2373 batch update fileset.  When a difference between the destination trees
2374 is encountered the update might be discarded with a warning (if the file
2375 appears to be up-to-date already) or the file-update may be attempted
2376 and then, if the file fails to verify, the update discarded with an
2377 error.  This means that it should be safe to re-run a read-batch operation
2378 if the command got interrupted.  If you wish to force the batched-update to
2379 always be attempted regardless of the file's size and date, use the bf(-I)
2380 option (when reading the batch).
2381 If an error occurs, the destination tree will probably be in a
2382 partially updated state. In that case, rsync can
2383 be used in its regular (non-batch) mode of operation to fix up the
2384 destination tree.
2385
2386 The rsync version used on all destinations must be at least as new as the
2387 one used to generate the batch file.  Rsync will die with an error if the
2388 protocol version in the batch file is too new for the batch-reading rsync
2389 to handle.  See also the bf(--protocol) option for a way to have the
2390 creating rsync generate a batch file that an older rsync can understand.
2391 (Note that batch files changed format in version 2.6.3, so mixing versions
2392 older than that with newer versions will not work.)
2393
2394 When reading a batch file, rsync will force the value of certain options
2395 to match the data in the batch file if you didn't set them to the same
2396 as the batch-writing command.  Other options can (and should) be changed.
2397 For instance bf(--write-batch) changes to bf(--read-batch),
2398 bf(--files-from) is dropped, and the
2399 bf(--filter)/bf(--include)/bf(--exclude) options are not needed unless
2400 one of the bf(--delete) options is specified.
2401
2402 The code that creates the BATCH.sh file transforms any filter/include/exclude
2403 options into a single list that is appended as a "here" document to the
2404 shell script file.  An advanced user can use this to modify the exclude
2405 list if a change in what gets deleted by bf(--delete) is desired.  A normal
2406 user can ignore this detail and just use the shell script as an easy way
2407 to run the appropriate bf(--read-batch) command for the batched data.
2408
2409 The original batch mode in rsync was based on "rsync+", but the latest
2410 version uses a new implementation.
2411
2412 manpagesection(SYMBOLIC LINKS)
2413
2414 Three basic behaviors are possible when rsync encounters a symbolic
2415 link in the source directory.
2416
2417 By default, symbolic links are not transferred at all.  A message
2418 "skipping non-regular" file is emitted for any symlinks that exist.
2419
2420 If bf(--links) is specified, then symlinks are recreated with the same
2421 target on the destination.  Note that bf(--archive) implies
2422 bf(--links).
2423
2424 If bf(--copy-links) is specified, then symlinks are "collapsed" by
2425 copying their referent, rather than the symlink.
2426
2427 rsync also distinguishes "safe" and "unsafe" symbolic links.  An
2428 example where this might be used is a web site mirror that wishes
2429 ensure the rsync module they copy does not include symbolic links to
2430 bf(/etc/passwd) in the public section of the site.  Using
2431 bf(--copy-unsafe-links) will cause any links to be copied as the file
2432 they point to on the destination.  Using bf(--safe-links) will cause
2433 unsafe links to be omitted altogether.  (Note that you must specify
2434 bf(--links) for bf(--safe-links) to have any effect.)
2435
2436 Symbolic links are considered unsafe if they are absolute symlinks
2437 (start with bf(/)), empty, or if they contain enough bf("..")
2438 components to ascend from the directory being copied.
2439
2440 Here's a summary of how the symlink options are interpreted.  The list is
2441 in order of precedence, so if your combination of options isn't mentioned,
2442 use the first line that is a complete subset of your options:
2443
2444 dit(bf(--copy-links)) Turn all symlinks into normal files (leaving no
2445 symlinks for any other options to affect).
2446
2447 dit(bf(--links --copy-unsafe-links)) Turn all unsafe symlinks into files
2448 and duplicate all safe symlinks.
2449
2450 dit(bf(--copy-unsafe-links)) Turn all unsafe symlinks into files, noisily
2451 skip all safe symlinks.
2452
2453 dit(bf(--links --safe-links)) Duplicate safe symlinks and skip unsafe
2454 ones.
2455
2456 dit(bf(--links)) Duplicate all symlinks.
2457
2458 manpagediagnostics()
2459
2460 rsync occasionally produces error messages that may seem a little
2461 cryptic. The one that seems to cause the most confusion is "protocol
2462 version mismatch -- is your shell clean?".
2463
2464 This message is usually caused by your startup scripts or remote shell
2465 facility producing unwanted garbage on the stream that rsync is using
2466 for its transport. The way to diagnose this problem is to run your
2467 remote shell like this:
2468
2469 quote(tt(ssh remotehost /bin/true > out.dat))
2470
2471 then look at out.dat. If everything is working correctly then out.dat
2472 should be a zero length file. If you are getting the above error from
2473 rsync then you will probably find that out.dat contains some text or
2474 data. Look at the contents and try to work out what is producing
2475 it. The most common cause is incorrectly configured shell startup
2476 scripts (such as .cshrc or .profile) that contain output statements
2477 for non-interactive logins.
2478
2479 If you are having trouble debugging filter patterns, then
2480 try specifying the bf(-vv) option.  At this level of verbosity rsync will
2481 show why each individual file is included or excluded.
2482
2483 manpagesection(EXIT VALUES)
2484
2485 startdit()
2486 dit(bf(0)) Success
2487 dit(bf(1)) Syntax or usage error
2488 dit(bf(2)) Protocol incompatibility
2489 dit(bf(3)) Errors selecting input/output files, dirs
2490 dit(bf(4)) Requested action not supported: an attempt
2491 was made to manipulate 64-bit files on a platform that cannot support
2492 them; or an option was specified that is supported by the client and
2493 not by the server.
2494 dit(bf(5)) Error starting client-server protocol
2495 dit(bf(6)) Daemon unable to append to log-file
2496 dit(bf(10)) Error in socket I/O
2497 dit(bf(11)) Error in file I/O
2498 dit(bf(12)) Error in rsync protocol data stream
2499 dit(bf(13)) Errors with program diagnostics
2500 dit(bf(14)) Error in IPC code
2501 dit(bf(20)) Received SIGUSR1 or SIGINT
2502 dit(bf(21)) Some error returned by code(waitpid())
2503 dit(bf(22)) Error allocating core memory buffers
2504 dit(bf(23)) Partial transfer due to error
2505 dit(bf(24)) Partial transfer due to vanished source files
2506 dit(bf(25)) The --max-delete limit stopped deletions
2507 dit(bf(30)) Timeout in data send/receive
2508 enddit()
2509
2510 manpagesection(ENVIRONMENT VARIABLES)
2511
2512 startdit()
2513 dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any
2514 ignore patterns in .cvsignore files. See the bf(--cvs-exclude) option for
2515 more details.
2516 dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to
2517 override the default shell used as the transport for rsync.  Command line
2518 options are permitted after the command name, just as in the bf(-e) option.
2519 dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to
2520 redirect your rsync client to use a web proxy when connecting to a
2521 rsync daemon. You should set RSYNC_PROXY to a hostname:port pair.
2522 dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required
2523 password allows you to run authenticated rsync connections to an rsync
2524 daemon without user intervention. Note that this does not supply a
2525 password to a shell transport such as ssh.
2526 dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables
2527 are used to determine the default username sent to an rsync daemon.
2528 If neither is set, the username defaults to "nobody".
2529 dit(bf(HOME)) The HOME environment variable is used to find the user's
2530 default .cvsignore file.
2531 enddit()
2532
2533 manpagefiles()
2534
2535 /etc/rsyncd.conf or rsyncd.conf
2536
2537 manpageseealso()
2538
2539 bf(rsyncd.conf)(5)
2540
2541 manpagebugs()
2542
2543 times are transferred as *nix time_t values
2544
2545 When transferring to FAT filesystems rsync may re-sync
2546 unmodified files.
2547 See the comments on the bf(--modify-window) option.
2548
2549 file permissions, devices, etc. are transferred as native numerical
2550 values
2551
2552 see also the comments on the bf(--delete) option
2553
2554 Please report bugs! See the website at
2555 url(http://rsync.samba.org/)(http://rsync.samba.org/)
2556
2557 manpagesection(VERSION)
2558
2559 This man page is current for version 2.6.9pre2 of rsync.
2560
2561 manpagesection(INTERNAL OPTIONS)
2562
2563 The options bf(--server) and bf(--sender) are used internally by rsync,
2564 and should never be typed by a user under normal circumstances.  Some
2565 awareness of these options may be needed in certain scenarios, such as
2566 when setting up a login that can only run an rsync command.  For instance,
2567 the support directory of the rsync distribution has an example script
2568 named rrsync (for restricted rsync) that can be used with a restricted
2569 ssh login.
2570
2571 manpagesection(CREDITS)
2572
2573 rsync is distributed under the GNU public license.  See the file
2574 COPYING for details.
2575
2576 A WEB site is available at
2577 url(http://rsync.samba.org/)(http://rsync.samba.org/).  The site
2578 includes an FAQ-O-Matic which may cover questions unanswered by this
2579 manual page.
2580
2581 The primary ftp site for rsync is
2582 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
2583
2584 We would be delighted to hear from you if you like this program.
2585
2586 This program uses the excellent zlib compression library written by
2587 Jean-loup Gailly and Mark Adler.
2588
2589 manpagesection(THANKS)
2590
2591 Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
2592 and David Bell for helpful suggestions, patches and testing of rsync.
2593 I've probably missed some people, my apologies if I have.
2594
2595 Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer,
2596 Martin Pool, Wayne Davison, J.W. Schultz.
2597
2598 manpageauthor()
2599
2600 rsync was originally written by Andrew Tridgell and Paul Mackerras.
2601 Many people have later contributed to it.
2602
2603 Mailing lists for support and development are available at
2604 url(http://lists.samba.org)(lists.samba.org)