Debian Codegraph @

upstream/debian-trixie/man1/rsync.1

raw
1 .TH "rsync" "1" "15 Jan 2025" "rsync 3.4.1" "User Commands"
2 .\" prefix=/usr
3 .P
4 .SH "NAME"
5 .P
6 rsync \- a fast, versatile, remote (and local) file-copying tool
7 .P
8 .SH "SYNOPSIS"
9 .P
10 .nf
11 Local:
12 rsync [OPTION...] SRC... [DEST]
13
14 Access via remote shell:
15 Pull:
16 rsync [OPTION...] [USER@]HOST:SRC... [DEST]
17 Push:
18 rsync [OPTION...] SRC... [USER@]HOST:DEST
19
20 Access via rsync daemon:
21 Pull:
22 rsync [OPTION...] [USER@]HOST::SRC... [DEST]
23 rsync [OPTION...] rsync://[USER@]HOST[:PORT]/SRC... [DEST]
24 Push:
25 rsync [OPTION...] SRC... [USER@]HOST::DEST
26 rsync [OPTION...] SRC... rsync://[USER@]HOST[:PORT]/DEST)
27 .fi
28 .P
29 Usages with just one SRC arg and no DEST arg will list the source files instead
30 of copying.
31 .P
32 The online version of this manpage (that includes cross-linking of topics)
33 is available at
34 .UR https://download.samba.org/pub/rsync/rsync.1
35 .UE .
36 .P
37 .SH "DESCRIPTION"
38 .P
39 Rsync is a fast and extraordinarily versatile file copying tool. It can copy
40 locally, to/from another host over any remote shell, or to/from a remote rsync
41 daemon. It offers a large number of options that control every aspect of its
42 behavior and permit very flexible specification of the set of files to be
43 copied. It is famous for its delta-transfer algorithm, which reduces the
44 amount of data sent over the network by sending only the differences between
45 the source files and the existing files in the destination. Rsync is widely
46 used for backups and mirroring and as an improved copy command for everyday
47 use.
48 .P
49 Rsync finds files that need to be transferred using a "quick check" algorithm
50 (by default) that looks for files that have changed in size or in last-modified
51 time. Any changes in the other preserved attributes (as requested by options)
52 are made on the destination file directly when the quick check indicates that
53 the file's data does not need to be updated.
54 .P
55 Some of the additional features of rsync are:
56 .P
57 .IP o
58 support for copying links, devices, owners, groups, and permissions
59 .IP o
60 exclude and exclude-from options similar to GNU tar
61 .IP o
62 a CVS exclude mode for ignoring the same files that CVS would ignore
63 .IP o
64 can use any transparent remote shell, including ssh or rsh
65 .IP o
66 does not require super-user privileges
67 .IP o
68 pipelining of file transfers to minimize latency costs
69 .IP o
70 support for anonymous or authenticated rsync daemons (ideal for mirroring)
71 .P
72 .SH "GENERAL"
73 .P
74 Rsync copies files either to or from a remote host, or locally on the current
75 host (it does not support copying files between two remote hosts).
76 .P
77 There are two different ways for rsync to contact a remote system: using a
78 remote-shell program as the transport (such as ssh or rsh) or contacting an
79 rsync daemon directly via TCP. The remote-shell transport is used whenever the
80 source or destination path contains a single colon (:) separator after a host
81 specification. Contacting an rsync daemon directly happens when the source or
82 destination path contains a double colon (::) separator after a host
83 specification, OR when an rsync:// URL is specified (see also the USING
84 RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION section for an
85 exception to this latter rule).
86 .P
87 As a special case, if a single source arg is specified without a destination,
88 the files are listed in an output format similar to "\fBls\ \-l\fP".
89 .P
90 As expected, if neither the source or destination path specify a remote host,
91 the copy occurs locally (see also the \fB\-\-list-only\fP option).
92 .P
93 Rsync refers to the local side as the client and the remote side as the server.
94 Don't confuse server with an rsync daemon. A daemon is always a server, but a
95 server can be either a daemon or a remote-shell spawned process.
96 .P
97 .SH "SETUP"
98 .P
99 See the file README.md for installation instructions.
100 .P
101 Once installed, you can use rsync to any machine that you can access via a
102 remote shell (as well as some that you can access using the rsync daemon-mode
103 protocol). For remote transfers, a modern rsync uses ssh for its
104 communications, but it may have been configured to use a different remote shell
105 by default, such as rsh or remsh.
106 .P
107 You can also specify any remote shell you like, either by using the \fB\-e\fP
108 command line option, or by setting the \fBRSYNC_RSH\fP environment variable.
109 .P
110 Note that rsync must be installed on both the source and destination machines.
111 .P
112 .SH "USAGE"
113 .P
114 You use rsync in the same way you use rcp. You must specify a source and a
115 destination, one of which may be remote.
116 .P
117 Perhaps the best way to explain the syntax is with some examples:
118 .RS 4
119 .P
120 .nf
121 rsync -t *.c foo:src/
122 .fi
123 .RE
124 .P
125 This would transfer all files matching the pattern \fB*.c\fP from the current
126 directory to the directory src on the machine foo. If any of the files already
127 exist on the remote system then the rsync remote-update protocol is used to
128 update the file by sending only the differences in the data. Note that the
129 expansion of wildcards on the command-line (\fB*.c\fP) into a list of files is
130 handled by the shell before it runs rsync and not by rsync itself (exactly the
131 same as all other Posix-style programs).
132 .RS 4
133 .P
134 .nf
135 rsync -avz foo:src/bar /data/tmp
136 .fi
137 .RE
138 .P
139 This would recursively transfer all files from the directory src/bar on the
140 machine foo into the /data/tmp/bar directory on the local machine. The files
141 are transferred in archive mode, which ensures that symbolic links, devices,
142 attributes, permissions, ownerships, etc. are preserved in the transfer.
143 Additionally, compression will be used to reduce the size of data portions of
144 the transfer.
145 .RS 4
146 .P
147 .nf
148 rsync -avz foo:src/bar/ /data/tmp
149 .fi
150 .RE
151 .P
152 A trailing slash on the source changes this behavior to avoid creating an
153 additional directory level at the destination. You can think of a trailing /
154 on a source as meaning "copy the contents of this directory" as opposed to
155 "copy the directory by name", but in both cases the attributes of the
156 containing directory are transferred to the containing directory on the
157 destination. In other words, each of the following commands copies the files
158 in the same way, including their setting of the attributes of /dest/foo:
159 .RS 4
160 .P
161 .nf
162 rsync -av /src/foo /dest
163 rsync -av /src/foo/ /dest/foo
164 .fi
165 .RE
166 .P
167 Note also that host and module references don't require a trailing slash to
168 copy the contents of the default directory. For example, both of these copy
169 the remote directory's contents into "/dest":
170 .RS 4
171 .P
172 .nf
173 rsync -av host: /dest
174 rsync -av host::module /dest
175 .fi
176 .RE
177 .P
178 You can also use rsync in local-only mode, where both the source and
179 destination don't have a ':' in the name. In this case it behaves like an
180 improved copy command.
181 .P
182 Finally, you can list all the (listable) modules available from a particular
183 rsync daemon by leaving off the module name:
184 .RS 4
185 .P
186 .nf
187 rsync somehost.mydomain.com::
188 .fi
189 .RE
190 .P
191 .SH "COPYING TO A DIFFERENT NAME"
192 .P
193 When you want to copy a directory to a different name, use a trailing slash on
194 the source directory to put the contents of the directory into any destination
195 directory you like:
196 .RS 4
197 .P
198 .nf
199 rsync -ai foo/ bar/
200 .fi
201 .RE
202 .P
203 Rsync also has the ability to customize a destination file's name when copying
204 a single item. The rules for this are:
205 .P
206 .IP o
207 The transfer list must consist of a single item (either a file or an empty
208 directory)
209 .IP o
210 The final element of the destination path must not exist as a directory
211 .IP o
212 The destination path must not have been specified with a trailing slash
213 .P
214 Under those circumstances, rsync will set the name of the destination's single
215 item to the last element of the destination path. Keep in mind that it is best
216 to only use this idiom when copying a file and use the above trailing-slash
217 idiom when copying a directory.
218 .P
219 The following example copies the \fBfoo.c\fP file as \fBbar.c\fP in the \fBsave\fP dir
220 (assuming that \fBbar.c\fP isn't a directory):
221 .RS 4
222 .P
223 .nf
224 rsync -ai src/foo.c save/bar.c
225 .fi
226 .RE
227 .P
228 The single-item copy rule might accidentally bite you if you unknowingly copy a
229 single item and specify a destination dir that doesn't exist (without using a
230 trailing slash). For example, if \fBsrc/*.c\fP matches one file and \fBsave/dir\fP
231 doesn't exist, this will confuse you by naming the destination file \fBsave/dir\fP:
232 .RS 4
233 .P
234 .nf
235 rsync -ai src/*.c save/dir
236 .fi
237 .RE
238 .P
239 To prevent such an accident, either make sure the destination dir exists or
240 specify the destination path with a trailing slash:
241 .RS 4
242 .P
243 .nf
244 rsync -ai src/*.c save/dir/
245 .fi
246 .RE
247 .P
248 .SH "SORTED TRANSFER ORDER"
249 .P
250 Rsync always sorts the specified filenames into its internal transfer list.
251 This handles the merging together of the contents of identically named
252 directories, makes it easy to remove duplicate filenames. It can, however,
253 confuse someone when the files are transferred in a different order than what
254 was given on the command-line.
255 .P
256 If you need a particular file to be transferred prior to another, either
257 separate the files into different rsync calls, or consider using
258 \fB\-\-delay-updates\fP (which doesn't affect the sorted transfer order, but
259 does make the final file-updating phase happen much more rapidly).
260 .P
261 .SH "MULTI-HOST SECURITY"
262 .P
263 Rsync takes steps to ensure that the file requests that are shared in a
264 transfer are protected against various security issues. Most of the potential
265 problems arise on the receiving side where rsync takes steps to ensure that the
266 list of files being transferred remains within the bounds of what was
267 requested.
268 .P
269 Toward this end, rsync 3.1.2 and later have aborted when a file list contains
270 an absolute or relative path that tries to escape out of the top of the
271 transfer. Also, beginning with version 3.2.5, rsync does two more safety
272 checks of the file list to (1) ensure that no extra source arguments were added
273 into the transfer other than those that the client requested and (2) ensure
274 that the file list obeys the exclude rules that were sent to the sender.
275 .P
276 For those that don't yet have a 3.2.5 client rsync (or those that want to be
277 extra careful), it is safest to do a copy into a dedicated destination
278 directory for the remote files when you don't trust the remote host. For
279 example, instead of doing an rsync copy into your home directory:
280 .RS 4
281 .P
282 .nf
283 rsync -aiv host1:dir1 ~
284 .fi
285 .RE
286 .P
287 Dedicate a "host1-files" dir to the remote content:
288 .RS 4
289 .P
290 .nf
291 rsync -aiv host1:dir1 ~/host1-files
292 .fi
293 .RE
294 .P
295 See the \fB\-\-trust-sender\fP option for additional details.
296 .P
297 CAUTION: it is not particularly safe to use rsync to copy files from a
298 case-preserving filesystem to a case-ignoring filesystem. If you must perform
299 such a copy, you should either disable symlinks via \fB\-\-no-links\fP or enable the
300 munging of symlinks via \fB\-\-munge-links\fP (and make sure you use the
301 right local or remote option). This will prevent rsync from doing potentially
302 dangerous things if a symlink name overlaps with a file or directory. It does
303 not, however, ensure that you get a full copy of all the files (since that may
304 not be possible when the names overlap). A potentially better solution is to
305 list all the source files and create a safe list of filenames that you pass to
306 the \fB\-\-files-from\fP option. Any files that conflict in name would need
307 to be copied to different destination directories using more than one copy.
308 .P
309 While a copy of a case-ignoring filesystem to a case-ignoring filesystem can
310 work out fairly well, if no \fB\-\-delete-during\fP or \fB\-\-delete-before\fP option is
311 active, rsync can potentially update an existing file on the receiving side
312 without noticing that the upper-/lower-case of the filename should be changed
313 to match the sender.
314 .P
315 .SH "ADVANCED USAGE"
316 .P
317 The syntax for requesting multiple files from a remote host is done by
318 specifying additional remote-host args in the same style as the first, or with
319 the hostname omitted. For instance, all these work:
320 .RS 4
321 .P
322 .nf
323 rsync -aiv host:file1 :file2 host:file{3,4} /dest/
324 rsync -aiv host::modname/file{1,2} host::modname/extra /dest/
325 rsync -aiv host::modname/first ::extra-file{1,2} /dest/
326 .fi
327 .RE
328 .P
329 Note that a daemon connection only supports accessing one module per copy
330 command, so if the start of a follow-up path doesn't begin with the
331 modname of the first path, it is assumed to be a path in the module (such as
332 the extra-file1 & extra-file2 that are grabbed above).
333 .P
334 Really old versions of rsync (2.6.9 and before) only allowed specifying one
335 remote-source arg, so some people have instead relied on the remote-shell
336 performing space splitting to break up an arg into multiple paths. Such
337 unintuitive behavior is no longer supported by default (though you can request
338 it, as described below).
339 .P
340 Starting in 3.2.4, filenames are passed to a remote shell in such a way as to
341 preserve the characters you give it. Thus, if you ask for a file with spaces
342 in the name, that's what the remote rsync looks for:
343 .RS 4
344 .P
345 .nf
346 rsync -aiv host:'a simple file.pdf' /dest/
347 .fi
348 .RE
349 .P
350 If you use scripts that have been written to manually apply extra quoting to
351 the remote rsync args (or to require remote arg splitting), you can ask rsync
352 to let your script handle the extra escaping. This is done by either adding
353 the \fB\-\-old-args\fP option to the rsync runs in the script (which requires
354 a new rsync) or exporting RSYNC_OLD_ARGS=1 and RSYNC_PROTECT_ARGS=0
355 (which works with old or new rsync versions).
356 .P
357 .SH "CONNECTING TO AN RSYNC DAEMON"
358 .P
359 It is also possible to use rsync without a remote shell as the transport. In
360 this case you will directly connect to a remote rsync daemon, typically using
361 TCP port 873. (This obviously requires the daemon to be running on the remote
362 system, so refer to the STARTING AN RSYNC DAEMON TO ACCEPT CONNECTIONS
363 section below for information on that.)
364 .P
365 Using rsync in this way is the same as using it with a remote shell except
366 that:
367 .P
368 .IP o
369 Use either double-colon syntax or rsync:// URL syntax instead of the
370 single-colon (remote shell) syntax.
371 .IP o
372 The first element of the "path" is actually a module name.
373 .IP o
374 Additional remote source args can use an abbreviated syntax that omits the
375 hostname and/or the module name, as discussed in ADVANCED USAGE.
376 .IP o
377 The remote daemon may print a "message of the day" when you connect.
378 .IP o
379 If you specify only the host (with no module or path) then a list of
380 accessible modules on the daemon is output.
381 .IP o
382 If you specify a remote source path but no destination, a listing of the
383 matching files on the remote daemon is output.
384 .IP o
385 The \fB\-\-rsh\fP (\fB\-e\fP) option must be omitted to avoid changing the
386 connection style from using a socket connection to USING RSYNC-DAEMON
387 FEATURES VIA A REMOTE-SHELL CONNECTION.
388 .P
389 An example that copies all the files in a remote module named "src":
390 .RS 4
391 .P
392 .nf
393 rsync -av host::src /dest
394 .fi
395 .RE
396 .P
397 Some modules on the remote daemon may require authentication. If so, you will
398 receive a password prompt when you connect. You can avoid the password prompt
399 by setting the environment variable \fBRSYNC_PASSWORD\fP to the password you
400 want to use or using the \fB\-\-password-file\fP option. This may be useful
401 when scripting rsync.
402 .P
403 WARNING: On some systems environment variables are visible to all users. On
404 those systems using \fB\-\-password-file\fP is recommended.
405 .P
406 You may establish the connection via a web proxy by setting the environment
407 variable \fBRSYNC_PROXY\fP to a hostname:port pair pointing to your web proxy.
408 Note that your web proxy's configuration must support proxy connections to port
409 873.
410 .P
411 You may also establish a daemon connection using a program as a proxy by
412 setting the environment variable \fBRSYNC_CONNECT_PROG\fP to the commands you
413 wish to run in place of making a direct socket connection. The string may
414 contain the escape "%H" to represent the hostname specified in the rsync
415 command (so use "%%" if you need a single "%" in your string). For example:
416 .RS 4
417 .P
418 .nf
419 export RSYNC_CONNECT_PROG='ssh proxyhost nc %H 873'
420 rsync -av targethost1::module/src/ /dest/
421 rsync -av rsync://targethost2/module/src/ /dest/
422 .fi
423 .RE
424 .P
425 The command specified above uses ssh to run nc (netcat) on a proxyhost, which
426 forwards all data to port 873 (the rsync daemon) on the targethost (%H).
427 .P
428 Note also that if the \fBRSYNC_SHELL\fP environment variable is set, that
429 program will be used to run the \fBRSYNC_CONNECT_PROG\fP command instead of using
430 the default shell of the \fBsystem()\fP call.
431 .P
432 .SH "USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION"
433 .P
434 It is sometimes useful to use various features of an rsync daemon (such as
435 named modules) without actually allowing any new socket connections into a
436 system (other than what is already required to allow remote-shell access).
437 Rsync supports connecting to a host using a remote shell and then spawning a
438 single-use "daemon" server that expects to read its config file in the home dir
439 of the remote user. This can be useful if you want to encrypt a daemon-style
440 transfer's data, but since the daemon is started up fresh by the remote user,
441 you may not be able to use features such as chroot or change the uid used by
442 the daemon. (For another way to encrypt a daemon transfer, consider using ssh
443 to tunnel a local port to a remote machine and configure a normal rsync daemon
444 on that remote host to only allow connections from "localhost".)
445 .P
446 From the user's perspective, a daemon transfer via a remote-shell connection
447 uses nearly the same command-line syntax as a normal rsync-daemon transfer,
448 with the only exception being that you must explicitly set the remote shell
449 program on the command-line with the \fB\-\-rsh=COMMAND\fP option. (Setting the
450 RSYNC_RSH in the environment will not turn on this functionality.) For example:
451 .RS 4
452 .P
453 .nf
454 rsync -av --rsh=ssh host::module /dest
455 .fi
456 .RE
457 .P
458 If you need to specify a different remote-shell user, keep in mind that the
459 user@ prefix in front of the host is specifying the rsync-user value (for a
460 module that requires user-based authentication). This means that you must give
461 the '\-l user' option to ssh when specifying the remote-shell, as in this
462 example that uses the short version of the \fB\-\-rsh\fP option:
463 .RS 4
464 .P
465 .nf
466 rsync -av -e "ssh -l ssh-user" rsync-user@host::module /dest
467 .fi
468 .RE
469 .P
470 The "ssh-user" will be used at the ssh level; the "rsync-user" will be used to
471 log-in to the "module".
472 .P
473 In this setup, the daemon is started by the ssh command that is accessing the
474 system (which can be forced via the \fB~/.ssh/authorized_keys\fP file, if desired).
475 However, when accessing a daemon directly, it needs to be started beforehand.
476 .P
477 .SH "STARTING AN RSYNC DAEMON TO ACCEPT CONNECTIONS"
478 .P
479 In order to connect to an rsync daemon, the remote system needs to have a
480 daemon already running (or it needs to have configured something like inetd to
481 spawn an rsync daemon for incoming connections on a particular port). For full
482 information on how to start a daemon that will handling incoming socket
483 connections, see the \fBrsyncd.conf\fP(5) manpage\ \-\- that is
484 the config file for the daemon, and it contains the full details for how to run
485 the daemon (including stand-alone and inetd configurations).
486 .P
487 If you're using one of the remote-shell transports for the transfer, there is
488 no need to manually start an rsync daemon.
489 .P
490 .SH "EXAMPLES"
491 .P
492 Here are some examples of how rsync can be used.
493 .P
494 To backup a home directory, which consists of large MS Word files and mail
495 folders, a per-user cron job can be used that runs this each day:
496 .RS 4
497 .P
498 .nf
499 rsync -aiz . bkhost:backup/joe/
500 .fi
501 .RE
502 .P
503 To move some files from a remote host to the local host, you could run:
504 .RS 4
505 .P
506 .nf
507 rsync -aiv --remove-source-files rhost:/tmp/{file1,file2}.c ~/src/
508 .fi
509 .RE
510 .P
511 .SH "OPTION SUMMARY"
512 .P
513 Here is a short summary of the options available in rsync. Each option also
514 has its own detailed description later in this manpage.
515 .P
516 .nf
517 --verbose, -v increase verbosity
518 --info=FLAGS fine-grained informational verbosity
519 --debug=FLAGS fine-grained debug verbosity
520 --stderr=e|a|c change stderr output mode (default: errors)
521 --quiet, -q suppress non-error messages
522 --no-motd suppress daemon-mode MOTD
523 --checksum, -c skip based on checksum, not mod-time & size
524 --archive, -a archive mode is -rlptgoD (no -A,-X,-U,-N,-H)
525 --no-OPTION turn off an implied OPTION (e.g. --no-D)
526 --recursive, -r recurse into directories
527 --relative, -R use relative path names
528 --no-implied-dirs don't send implied dirs with --relative
529 --backup, -b make backups (see --suffix & --backup-dir)
530 --backup-dir=DIR make backups into hierarchy based in DIR
531 --suffix=SUFFIX backup suffix (default ~ w/o --backup-dir)
532 --update, -u skip files that are newer on the receiver
533 --inplace update destination files in-place
534 --append append data onto shorter files
535 --append-verify --append w/old data in file checksum
536 --dirs, -d transfer directories without recursing
537 --old-dirs, --old-d works like --dirs when talking to old rsync
538 --mkpath create destination's missing path components
539 --links, -l copy symlinks as symlinks
540 --copy-links, -L transform symlink into referent file/dir
541 --copy-unsafe-links only "unsafe" symlinks are transformed
542 --safe-links ignore symlinks that point outside the tree
543 --munge-links munge symlinks to make them safe & unusable
544 --copy-dirlinks, -k transform symlink to dir into referent dir
545 --keep-dirlinks, -K treat symlinked dir on receiver as dir
546 --hard-links, -H preserve hard links
547 --perms, -p preserve permissions
548 --executability, -E preserve executability
549 --chmod=CHMOD affect file and/or directory permissions
550 --acls, -A preserve ACLs (implies --perms)
551 --xattrs, -X preserve extended attributes
552 --owner, -o preserve owner (super-user only)
553 --group, -g preserve group
554 --devices preserve device files (super-user only)
555 --copy-devices copy device contents as a regular file
556 --write-devices write to devices as files (implies --inplace)
557 --specials preserve special files
558 -D same as --devices --specials
559 --times, -t preserve modification times
560 --atimes, -U preserve access (use) times
561 --open-noatime avoid changing the atime on opened files
562 --crtimes, -N preserve create times (newness)
563 --omit-dir-times, -O omit directories from --times
564 --omit-link-times, -J omit symlinks from --times
565 --super receiver attempts super-user activities
566 --fake-super store/recover privileged attrs using xattrs
567 --sparse, -S turn sequences of nulls into sparse blocks
568 --preallocate allocate dest files before writing them
569 --dry-run, -n perform a trial run with no changes made
570 --whole-file, -W copy files whole (w/o delta-xfer algorithm)
571 --checksum-choice=STR choose the checksum algorithm (aka --cc)
572 --one-file-system, -x don't cross filesystem boundaries
573 --block-size=SIZE, -B force a fixed checksum block-size
574 --rsh=COMMAND, -e specify the remote shell to use
575 --rsync-path=PROGRAM specify the rsync to run on remote machine
576 --existing skip creating new files on receiver
577 --ignore-existing skip updating files that exist on receiver
578 --remove-source-files sender removes synchronized files (non-dir)
579 --del an alias for --delete-during
580 --delete delete extraneous files from dest dirs
581 --delete-before receiver deletes before xfer, not during
582 --delete-during receiver deletes during the transfer
583 --delete-delay find deletions during, delete after
584 --delete-after receiver deletes after transfer, not during
585 --delete-excluded also delete excluded files from dest dirs
586 --ignore-missing-args ignore missing source args without error
587 --delete-missing-args delete missing source args from destination
588 --ignore-errors delete even if there are I/O errors
589 --force force deletion of dirs even if not empty
590 --max-delete=NUM don't delete more than NUM files
591 --max-size=SIZE don't transfer any file larger than SIZE
592 --min-size=SIZE don't transfer any file smaller than SIZE
593 --max-alloc=SIZE change a limit relating to memory alloc
594 --partial keep partially transferred files
595 --partial-dir=DIR put a partially transferred file into DIR
596 --delay-updates put all updated files into place at end
597 --prune-empty-dirs, -m prune empty directory chains from file-list
598 --numeric-ids don't map uid/gid values by user/group name
599 --usermap=STRING custom username mapping
600 --groupmap=STRING custom groupname mapping
601 --chown=USER:GROUP simple username/groupname mapping
602 --timeout=SECONDS set I/O timeout in seconds
603 --contimeout=SECONDS set daemon connection timeout in seconds
604 --ignore-times, -I don't skip files that match size and time
605 --size-only skip files that match in size
606 --modify-window=NUM, -@ set the accuracy for mod-time comparisons
607 --temp-dir=DIR, -T create temporary files in directory DIR
608 --fuzzy, -y find similar file for basis if no dest file
609 --compare-dest=DIR also compare destination files relative to DIR
610 --copy-dest=DIR ... and include copies of unchanged files
611 --link-dest=DIR hardlink to files in DIR when unchanged
612 --compress, -z compress file data during the transfer
613 --compress-choice=STR choose the compression algorithm (aka --zc)
614 --compress-level=NUM explicitly set compression level (aka --zl)
615 --skip-compress=LIST skip compressing files with suffix in LIST
616 --cvs-exclude, -C auto-ignore files in the same way CVS does
617 --filter=RULE, -f add a file-filtering RULE
618 -F same as --filter='dir-merge /.rsync-filter'
619 repeated: --filter='- .rsync-filter'
620 --exclude=PATTERN exclude files matching PATTERN
621 --exclude-from=FILE read exclude patterns from FILE
622 --include=PATTERN don't exclude files matching PATTERN
623 --include-from=FILE read include patterns from FILE
624 --files-from=FILE read list of source-file names from FILE
625 --from0, -0 all *-from/filter files are delimited by 0s
626 --old-args disable the modern arg-protection idiom
627 --secluded-args, -s use the protocol to safely send the args
628 --trust-sender trust the remote sender's file list
629 --copy-as=USER[:GROUP] specify user & optional group for the copy
630 --address=ADDRESS bind address for outgoing socket to daemon
631 --port=PORT specify double-colon alternate port number
632 --sockopts=OPTIONS specify custom TCP options
633 --blocking-io use blocking I/O for the remote shell
634 --outbuf=N|L|B set out buffering to None, Line, or Block
635 --stats give some file-transfer stats
636 --8-bit-output, -8 leave high-bit chars unescaped in output
637 --human-readable, -h output numbers in a human-readable format
638 --progress show progress during transfer
639 -P same as --partial --progress
640 --itemize-changes, -i output a change-summary for all updates
641 --remote-option=OPT, -M send OPTION to the remote side only
642 --out-format=FORMAT output updates using the specified FORMAT
643 --log-file=FILE log what we're doing to the specified FILE
644 --log-file-format=FMT log updates using the specified FMT
645 --password-file=FILE read daemon-access password from FILE
646 --early-input=FILE use FILE for daemon's early exec input
647 --list-only list the files instead of copying them
648 --bwlimit=RATE limit socket I/O bandwidth
649 --stop-after=MINS Stop rsync after MINS minutes have elapsed
650 --stop-at=y-m-dTh:m Stop rsync at the specified point in time
651 --fsync fsync every written file
652 --write-batch=FILE write a batched update to FILE
653 --only-write-batch=FILE like --write-batch but w/o updating dest
654 --read-batch=FILE read a batched update from FILE
655 --protocol=NUM force an older protocol version to be used
656 --iconv=CONVERT_SPEC request charset conversion of filenames
657 --checksum-seed=NUM set block/file checksum seed (advanced)
658 --ipv4, -4 prefer IPv4
659 --ipv6, -6 prefer IPv6
660 --version, -V print the version + other info and exit
661 --help, -h (*) show this help (* -h is help only on its own)
662 .fi
663 .P
664 Rsync can also be run as a daemon, in which case the following options are
665 accepted:
666 .P
667 .nf
668 --daemon run as an rsync daemon
669 --address=ADDRESS bind to the specified address
670 --bwlimit=RATE limit socket I/O bandwidth
671 --config=FILE specify alternate rsyncd.conf file
672 --dparam=OVERRIDE, -M override global daemon config parameter
673 --no-detach do not detach from the parent
674 --port=PORT listen on alternate port number
675 --log-file=FILE override the "log file" setting
676 --log-file-format=FMT override the "log format" setting
677 --sockopts=OPTIONS specify custom TCP options
678 --verbose, -v increase verbosity
679 --ipv4, -4 prefer IPv4
680 --ipv6, -6 prefer IPv6
681 --help, -h show this help (when used with --daemon)
682 .fi
683 .P
684 .SH "OPTIONS"
685 .P
686 Rsync accepts both long (double-dash + word) and short (single-dash + letter)
687 options. The full list of the available options are described below. If an
688 option can be specified in more than one way, the choices are comma-separated.
689 Some options only have a long variant, not a short.
690 .P
691 If the option takes a parameter, the parameter is only listed after the long
692 variant, even though it must also be specified for the short. When specifying
693 a parameter, you can either use the form \fB\-\-option=param\fP, \fB\-\-option\ param\fP,
694 \fB\-o=param\fP, \fB\-o\ param\fP, or \fB\-oparam\fP (the latter choices assume that your
695 option has a short variant).
696 .P
697 The parameter may need to be quoted in some manner for it to survive the
698 shell's command-line parsing. Also keep in mind that a leading tilde (\fB~\fP) in
699 a pathname is substituted by your shell, so make sure that you separate the
700 option name from the pathname using a space if you want the local shell to
701 expand it.
702 .P
703 .IP "\fB\-\-help\fP"
704 Print a short help page describing the options available in rsync and exit.
705 You can also use \fB\-h\fP for \fB\-\-help\fP when it is used without any other
706 options (since it normally means \fB\-\-human-readable\fP).
707 .IP "\fB\-\-version\fP, \fB\-V\fP"
708 Print the rsync version plus other info and exit. When repeated, the
709 information is output is a JSON format that is still fairly readable
710 (client side only).
711 .IP
712 The output includes a list of compiled-in capabilities, a list of
713 optimizations, the default list of checksum algorithms, the default list of
714 compression algorithms, the default list of daemon auth digests, a link to
715 the rsync web site, and a few other items.
716 .IP "\fB\-\-verbose\fP, \fB\-v\fP"
717 This option increases the amount of information you are given during the
718 transfer. By default, rsync works silently. A single \fB\-v\fP will give you
719 information about what files are being transferred and a brief summary at
720 the end. Two \fB\-v\fP options will give you information on what files are
721 being skipped and slightly more information at the end. More than two \fB\-v\fP
722 options should only be used if you are debugging rsync.
723 .IP
724 The end-of-run summary tells you the number of bytes sent to the remote
725 rsync (which is the receiving side on a local copy), the number of bytes
726 received from the remote host, and the average bytes per second of the
727 transferred data computed over the entire length of the rsync run. The
728 second line shows the total size (in bytes), which is the sum of all the
729 file sizes that rsync considered transferring. It also shows a "speedup"
730 value, which is a ratio of the total file size divided by the sum of the
731 sent and received bytes (which is really just a feel-good bigger-is-better
732 number). Note that these byte values can be made more (or less)
733 human-readable by using the \fB\-\-human-readable\fP (or
734 \fB\-\-no-human-readable\fP) options.
735 .IP
736 In a modern rsync, the \fB\-v\fP option is equivalent to the setting of groups
737 of \fB\-\-info\fP and \fB\-\-debug\fP options. You can choose to use
738 these newer options in addition to, or in place of using \fB\-\-verbose\fP, as
739 any fine-grained settings override the implied settings of \fB\-v\fP. Both
740 \fB\-\-info\fP and \fB\-\-debug\fP have a way to ask for help that
741 tells you exactly what flags are set for each increase in verbosity.
742 .IP
743 However, do keep in mind that a daemon's "\fBmax\ verbosity\fP" setting will limit
744 how high of a level the various individual flags can be set on the daemon
745 side. For instance, if the max is 2, then any info and/or debug flag that
746 is set to a higher value than what would be set by \fB\-vv\fP will be downgraded
747 to the \fB\-vv\fP level in the daemon's logging.
748 .IP "\fB\-\-info=FLAGS\fP"
749 This option lets you have fine-grained control over the information output
750 you want to see. An individual flag name may be followed by a level
751 number, with 0 meaning to silence that output, 1 being the default output
752 level, and higher numbers increasing the output of that flag (for those
753 that support higher levels). Use \fB\-\-info=help\fP to see all the available
754 flag names, what they output, and what flag names are added for each
755 increase in the verbose level. Some examples:
756 .RS 4
757 .IP
758 .nf
759 rsync -a --info=progress2 src/ dest/
760 rsync -avv --info=stats2,misc1,flist0 src/ dest/
761 .fi
762 .RE
763 .IP
764 Note that \fB\-\-info=name\fP's output is affected by the \fB\-\-out-format\fP
765 and \fB\-\-itemize-changes\fP (\fB\-i\fP) options. See those options for more
766 information on what is output and when.
767 .IP
768 This option was added to 3.1.0, so an older rsync on the server side might
769 reject your attempts at fine-grained control (if one or more flags needed
770 to be send to the server and the server was too old to understand them).
771 See also the "\fBmax\ verbosity\fP" caveat above when dealing with a daemon.
772 .IP "\fB\-\-debug=FLAGS\fP"
773 This option lets you have fine-grained control over the debug output you
774 want to see. An individual flag name may be followed by a level number,
775 with 0 meaning to silence that output, 1 being the default output level,
776 and higher numbers increasing the output of that flag (for those that
777 support higher levels). Use \fB\-\-debug=help\fP to see all the available flag
778 names, what they output, and what flag names are added for each increase in
779 the verbose level. Some examples:
780 .RS 4
781 .IP
782 .nf
783 rsync -avvv --debug=none src/ dest/
784 rsync -avA --del --debug=del2,acl src/ dest/
785 .fi
786 .RE
787 .IP
788 Note that some debug messages will only be output when the \fB\-\-stderr=all\fP
789 option is specified, especially those pertaining to I/O and buffer debugging.
790 .IP
791 Beginning in 3.2.0, this option is no longer auto-forwarded to the server
792 side in order to allow you to specify different debug values for each side
793 of the transfer, as well as to specify a new debug option that is only
794 present in one of the rsync versions. If you want to duplicate the same
795 option on both sides, using brace expansion is an easy way to save you some
796 typing. This works in zsh and bash:
797 .RS 4
798 .IP
799 .nf
800 rsync -aiv {-M,}--debug=del2 src/ dest/
801 .fi
802 .RE
803 .IP "\fB\-\-stderr=errors|all|client\fP"
804 This option controls which processes output to stderr and if info messages
805 are also changed to stderr. The mode strings can be abbreviated, so feel
806 free to use a single letter value. The 3 possible choices are:
807 .IP
808 .RS
809 .IP o
810 \fBerrors\fP \- (the default) causes all the rsync processes to send an
811 error directly to stderr, even if the process is on the remote side of
812 the transfer. Info messages are sent to the client side via the protocol
813 stream. If stderr is not available (i.e. when directly connecting with a
814 daemon via a socket) errors fall back to being sent via the protocol
815 stream.
816 .IP o
817 \fBall\fP \- causes all rsync messages (info and error) to get written
818 directly to stderr from all (possible) processes. This causes stderr to
819 become line-buffered (instead of raw) and eliminates the ability to
820 divide up the info and error messages by file handle. For those doing
821 debugging or using several levels of verbosity, this option can help to
822 avoid clogging up the transfer stream (which should prevent any chance of
823 a deadlock bug hanging things up). It also allows \fB\-\-debug\fP to
824 enable some extra I/O related messages.
825 .IP o
826 \fBclient\fP \- causes all rsync messages to be sent to the client side
827 via the protocol stream. One client process outputs all messages, with
828 errors on stderr and info messages on stdout. This \fBwas\fP the default
829 in older rsync versions, but can cause error delays when a lot of
830 transfer data is ahead of the messages. If you're pushing files to an
831 older rsync, you may want to use \fB\-\-stderr=all\fP since that idiom has
832 been around for several releases.
833 .RE
834 .IP
835 This option was added in rsync 3.2.3. This version also began the
836 forwarding of a non-default setting to the remote side, though rsync uses
837 the backward-compatible options \fB\-\-msgs2stderr\fP and \fB\-\-no-msgs2stderr\fP to
838 represent the \fBall\fP and \fBclient\fP settings, respectively. A newer rsync
839 will continue to accept these older option names to maintain compatibility.
840 .IP "\fB\-\-quiet\fP, \fB\-q\fP"
841 This option decreases the amount of information you are given during the
842 transfer, notably suppressing information messages from the remote server.
843 This option is useful when invoking rsync from cron.
844 .IP "\fB\-\-no-motd\fP"
845 This option affects the information that is output by the client at the
846 start of a daemon transfer. This suppresses the message-of-the-day (MOTD)
847 text, but it also affects the list of modules that the daemon sends in
848 response to the "rsync host::" request (due to a limitation in the rsync
849 protocol), so omit this option if you want to request the list of modules
850 from the daemon.
851 .IP "\fB\-\-ignore-times\fP, \fB\-I\fP"
852 Normally rsync will skip any files that are already the same size and have
853 the same modification timestamp. This option turns off this "quick check"
854 behavior, causing all files to be updated.
855 .IP
856 This option can be confusing compared to \fB\-\-ignore-existing\fP and
857 \fB\-\-ignore-non-existing\fP in that that they cause rsync to transfer
858 fewer files, while this option causes rsync to transfer more files.
859 .IP "\fB\-\-size-only\fP"
860 This modifies rsync's "quick check" algorithm for finding files that need
861 to be transferred, changing it from the default of transferring files with
862 either a changed size or a changed last-modified time to just looking for
863 files that have changed in size. This is useful when starting to use rsync
864 after using another mirroring system which may not preserve timestamps
865 exactly.
866 .IP "\fB\-\-modify-window=NUM\fP, \fB\-@\fP"
867 When comparing two timestamps, rsync treats the timestamps as being equal
868 if they differ by no more than the modify-window value. The default is 0,
869 which matches just integer seconds. If you specify a negative value (and
870 the receiver is at least version 3.1.3) then nanoseconds will also be taken
871 into account. Specifying 1 is useful for copies to/from MS Windows FAT
872 filesystems, because FAT represents times with a 2-second resolution
873 (allowing times to differ from the original by up to 1 second).
874 .IP
875 If you want all your transfers to default to comparing nanoseconds, you can
876 create a \fB~/.popt\fP file and put these lines in it:
877 .RS 4
878 .IP
879 .nf
880 rsync alias -a -a@-1
881 rsync alias -t -t@-1
882 .fi
883 .RE
884 .IP
885 With that as the default, you'd need to specify \fB\-\-modify-window=0\fP (aka
886 \fB\-@0\fP) to override it and ignore nanoseconds, e.g. if you're copying
887 between ext3 and ext4, or if the receiving rsync is older than 3.1.3.
888 .IP "\fB\-\-checksum\fP, \fB\-c\fP"
889 This changes the way rsync checks if the files have been changed and are in
890 need of a transfer. Without this option, rsync uses a "quick check" that
891 (by default) checks if each file's size and time of last modification match
892 between the sender and receiver. This option changes this to compare a
893 128-bit checksum for each file that has a matching size. Generating the
894 checksums means that both sides will expend a lot of disk I/O reading all
895 the data in the files in the transfer, so this can slow things down
896 significantly (and this is prior to any reading that will be done to
897 transfer changed files)
898 .IP
899 The sending side generates its checksums while it is doing the file-system
900 scan that builds the list of the available files. The receiver generates
901 its checksums when it is scanning for changed files, and will checksum any
902 file that has the same size as the corresponding sender's file: files with
903 either a changed size or a changed checksum are selected for transfer.
904 .IP
905 Note that rsync always verifies that each \fItransferred\fP file was correctly
906 reconstructed on the receiving side by checking a whole-file checksum that
907 is generated as the file is transferred, but that automatic
908 after-the-transfer verification has nothing to do with this option's
909 before-the-transfer "Does this file need to be updated?" check.
910 .IP
911 The checksum used is auto-negotiated between the client and the server, but
912 can be overridden using either the \fB\-\-checksum-choice\fP (\fB\-\-cc\fP)
913 option or an environment variable that is discussed in that option's
914 section.
915 .IP "\fB\-\-archive\fP, \fB\-a\fP"
916 This is equivalent to \fB\-rlptgoD\fP. It is a quick way of saying you want
917 recursion and want to preserve almost everything. Be aware that it does
918 \fBnot\fP include preserving ACLs (\fB\-A\fP), xattrs (\fB\-X\fP), atimes (\fB\-U\fP),
919 crtimes (\fB\-N\fP), nor the finding and preserving of hardlinks (\fB\-H\fP).
920 .IP
921 The only exception to the above equivalence is when \fB\-\-files-from\fP
922 is specified, in which case \fB\-r\fP is not implied.
923 .IP "\fB\-\-no-OPTION\fP"
924 You may turn off one or more implied options by prefixing the option name
925 with "no-". Not all positive options have a negated opposite, but a lot
926 do, including those that can be used to disable an implied option (e.g.
927 \fB\-\-no-D\fP, \fB\-\-no-perms\fP) or have different defaults in various circumstances
928 (e.g. \fB\-\-no-whole-file\fP, \fB\-\-no-blocking-io\fP, \fB\-\-no-dirs\fP). Every
929 valid negated option accepts both the short and the long option name after
930 the "no-" prefix (e.g. \fB\-\-no-R\fP is the same as \fB\-\-no-relative\fP).
931 .IP
932 As an example, if you want to use \fB\-\-archive\fP (\fB\-a\fP) but don't want
933 \fB\-\-owner\fP (\fB\-o\fP), instead of converting \fB\-a\fP into \fB\-rlptgD\fP, you
934 can specify \fB\-a\ \-\-no-o\fP (aka \fB\-\-archive\ \-\-no-owner\fP).
935 .IP
936 The order of the options is important: if you specify \fB\-\-no-r\ \-a\fP, the \fB\-r\fP
937 option would end up being turned on, the opposite of \fB\-a\ \-\-no-r\fP. Note
938 also that the side-effects of the \fB\-\-files-from\fP option are NOT
939 positional, as it affects the default state of several options and slightly
940 changes the meaning of \fB\-a\fP (see the \fB\-\-files-from\fP option
941 for more details).
942 .IP "\fB\-\-recursive\fP, \fB\-r\fP"
943 This tells rsync to copy directories recursively. See also
944 \fB\-\-dirs\fP (\fB\-d\fP) for an option that allows the scanning of a single
945 directory.
946 .IP
947 See the \fB\-\-inc-recursive\fP option for a discussion of the
948 incremental recursion for creating the list of files to transfer.
949 .IP "\fB\-\-inc-recursive\fP, \fB\-\-i-r\fP"
950 This option explicitly enables on incremental recursion when scanning for
951 files, which is enabled by default when using the \fB\-\-recursive\fP
952 option and both sides of the transfer are running rsync 3.0.0 or newer.
953 .IP
954 Incremental recursion uses much less memory than non-incremental, while
955 also beginning the transfer more quickly (since it doesn't need to scan the
956 entire transfer hierarchy before it starts transferring files). If no
957 recursion is enabled in the source files, this option has no effect.
958 .IP
959 Some options require rsync to know the full file list, so these options
960 disable the incremental recursion mode. These include:
961 .IP
962 .RS
963 .IP o
964 \fB\-\-delete-before\fP (the old default of \fB\-\-delete\fP)
965 .IP o
966 \fB\-\-delete-after\fP
967 .IP o
968 \fB\-\-prune-empty-dirs\fP
969 .IP o
970 \fB\-\-delay-updates\fP
971 .RE
972 .IP
973 In order to make \fB\-\-delete\fP compatible with incremental recursion,
974 rsync 3.0.0 made \fB\-\-delete-during\fP the default delete mode (which
975 was first added in 2.6.4).
976 .IP
977 One side-effect of incremental recursion is that any missing
978 sub-directories inside a recursively-scanned directory are (by default)
979 created prior to recursing into the sub-dirs. This earlier creation point
980 (compared to a non-incremental recursion) allows rsync to then set the
981 modify time of the finished directory right away (without having to delay
982 that until a bunch of recursive copying has finished). However, these
983 early directories don't yet have their completed mode, mtime, or ownership
984 set\ \-\- they have more restrictive rights until the subdirectory's copying
985 actually begins. This early-creation idiom can be avoided by using the
986 \fB\-\-omit-dir-times\fP option.
987 .IP
988 Incremental recursion can be disabled using the
989 \fB\-\-no-inc-recursive\fP (\fB\-\-no-i-r\fP) option.
990 .IP "\fB\-\-no-inc-recursive\fP, \fB\-\-no-i-r\fP"
991 Disables the new incremental recursion algorithm of the
992 \fB\-\-recursive\fP option. This makes rsync scan the full file list
993 before it begins to transfer files. See \fB\-\-inc-recursive\fP for more
994 info.
995 .IP "\fB\-\-relative\fP, \fB\-R\fP"
996 Use relative paths. This means that the full path names specified on the
997 command line are sent to the server rather than just the last parts of the
998 filenames. This is particularly useful when you want to send several
999 different directories at the same time. For example, if you used this
1000 command:
1001 .RS 4
1002 .IP
1003 .nf
1004 rsync -av /foo/bar/baz.c remote:/tmp/
1005 .fi
1006 .RE
1007 .IP
1008 would create a file named baz.c in /tmp/ on the remote machine. If instead
1009 you used
1010 .RS 4
1011 .IP
1012 .nf
1013 rsync -avR /foo/bar/baz.c remote:/tmp/
1014 .fi
1015 .RE
1016 .IP
1017 then a file named /tmp/foo/bar/baz.c would be created on the remote
1018 machine, preserving its full path. These extra path elements are called
1019 "implied directories" (i.e. the "foo" and the "foo/bar" directories in the
1020 above example).
1021 .IP
1022 Beginning with rsync 3.0.0, rsync always sends these implied directories as
1023 real directories in the file list, even if a path element is really a
1024 symlink on the sending side. This prevents some really unexpected behaviors
1025 when copying the full path of a file that you didn't realize had a symlink
1026 in its path. If you want to duplicate a server-side symlink, include both
1027 the symlink via its path, and referent directory via its real path. If
1028 you're dealing with an older rsync on the sending side, you may need to use
1029 the \fB\-\-no-implied-dirs\fP option.
1030 .IP
1031 It is also possible to limit the amount of path information that is sent as
1032 implied directories for each path you specify. With a modern rsync on the
1033 sending side (beginning with 2.6.7), you can insert a dot and a slash into
1034 the source path, like this:
1035 .RS 4
1036 .IP
1037 .nf
1038 rsync -avR /foo/./bar/baz.c remote:/tmp/
1039 .fi
1040 .RE
1041 .IP
1042 That would create /tmp/bar/baz.c on the remote machine. (Note that the dot
1043 must be followed by a slash, so "/foo/." would not be abbreviated.) For
1044 older rsync versions, you would need to use a chdir to limit the source
1045 path. For example, when pushing files:
1046 .RS 4
1047 .IP
1048 .nf
1049 (cd /foo; rsync -avR bar/baz.c remote:/tmp/)
1050 .fi
1051 .RE
1052 .IP
1053 (Note that the parens put the two commands into a sub-shell, so that the
1054 "cd" command doesn't remain in effect for future commands.) If you're
1055 pulling files from an older rsync, use this idiom (but only for a
1056 non-daemon transfer):
1057 .RS 4
1058 .IP
1059 .nf
1060 rsync -avR --rsync-path="cd /foo; rsync" \\
1061 remote:bar/baz.c /tmp/
1062 .fi
1063 .RE
1064 .IP "\fB\-\-no-implied-dirs\fP"
1065 This option affects the default behavior of the \fB\-\-relative\fP option. When
1066 it is specified, the attributes of the implied directories from the source
1067 names are not included in the transfer. This means that the corresponding
1068 path elements on the destination system are left unchanged if they exist,
1069 and any missing implied directories are created with default attributes.
1070 This even allows these implied path elements to have big differences, such
1071 as being a symlink to a directory on the receiving side.
1072 .IP
1073 For instance, if a command-line arg or a files-from entry told rsync to
1074 transfer the file "path/foo/file", the directories "path" and "path/foo"
1075 are implied when \fB\-\-relative\fP is used. If "path/foo" is a symlink to "bar"
1076 on the destination system, the receiving rsync would ordinarily delete
1077 "path/foo", recreate it as a directory, and receive the file into the new
1078 directory. With \fB\-\-no-implied-dirs\fP, the receiving rsync updates
1079 "path/foo/file" using the existing path elements, which means that the file
1080 ends up being created in "path/bar". Another way to accomplish this link
1081 preservation is to use the \fB\-\-keep-dirlinks\fP option (which will also affect
1082 symlinks to directories in the rest of the transfer).
1083 .IP
1084 When pulling files from an rsync older than 3.0.0, you may need to use this
1085 option if the sending side has a symlink in the path you request and you
1086 wish the implied directories to be transferred as normal directories.
1087 .IP "\fB\-\-backup\fP, \fB\-b\fP"
1088 With this option, preexisting destination files are renamed as each file is
1089 transferred or deleted. You can control where the backup file goes and
1090 what (if any) suffix gets appended using the \fB\-\-backup-dir\fP and
1091 \fB\-\-suffix\fP options.
1092 .IP
1093 If you don't specify \fB\-\-backup-dir\fP:
1094 .RS
1095 .IP
1096 .IP 1.
1097 the \fB\-\-omit-dir-times\fP option will be forced on
1098 .IP 2.
1099 the use of \fB\-\-delete\fP (without \fB\-\-delete-excluded\fP),
1100 causes rsync to add a "protect" filter-rule for the
1101 backup suffix to the end of all your existing filters that looks like
1102 this: \fB\-f\ "P\ *~"\fP. This rule prevents previously backed-up files from
1103 being deleted.
1104 .RE
1105 .IP
1106 Note that if you are supplying your own filter rules, you may need to
1107 manually insert your own exclude/protect rule somewhere higher up in the
1108 list so that it has a high enough priority to be effective (e.g. if your
1109 rules specify a trailing inclusion/exclusion of \fB*\fP, the auto-added rule
1110 would never be reached).
1111 .IP "\fB\-\-backup-dir=DIR\fP"
1112 This implies the \fB\-\-backup\fP option, and tells rsync to store all
1113 backups in the specified directory on the receiving side. This can be used
1114 for incremental backups. You can additionally specify a backup suffix
1115 using the \fB\-\-suffix\fP option (otherwise the files backed up in the
1116 specified directory will keep their original filenames).
1117 .IP
1118 Note that if you specify a relative path, the backup directory will be
1119 relative to the destination directory, so you probably want to specify
1120 either an absolute path or a path that starts with "../". If an rsync
1121 daemon is the receiver, the backup dir cannot go outside the module's path
1122 hierarchy, so take extra care not to delete it or copy into it.
1123 .IP "\fB\-\-suffix=SUFFIX\fP"
1124 This option allows you to override the default backup suffix used with the
1125 \fB\-\-backup\fP (\fB\-b\fP) option. The default suffix is a \fB~\fP if no
1126 \fB\-\-backup-dir\fP was specified, otherwise it is an empty string.
1127 .IP "\fB\-\-update\fP, \fB\-u\fP"
1128 This forces rsync to skip any files which exist on the destination and have
1129 a modified time that is newer than the source file. (If an existing
1130 destination file has a modification time equal to the source file's, it
1131 will be updated if the sizes are different.)
1132 .IP
1133 Note that this does not affect the copying of dirs, symlinks, or other
1134 special files. Also, a difference of file format between the sender and
1135 receiver is always considered to be important enough for an update, no
1136 matter what date is on the objects. In other words, if the source has a
1137 directory where the destination has a file, the transfer would occur
1138 regardless of the timestamps.
1139 .IP
1140 This option is a TRANSFER RULE, so don't expect any
1141 exclude side effects.
1142 .IP
1143 A caution for those that choose to combine \fB\-\-inplace\fP with
1144 \fB\-\-update\fP: an interrupted transfer will leave behind a partial file on the
1145 receiving side that has a very recent modified time, so re-running the
1146 transfer will probably \fBnot\fP continue the interrupted file. As such, it
1147 is usually best to avoid combining this with \fB\-\-inplace\fP unless you
1148 have implemented manual steps to handle any interrupted in-progress files.
1149 .IP "\fB\-\-inplace\fP"
1150 This option changes how rsync transfers a file when its data needs to be
1151 updated: instead of the default method of creating a new copy of the file
1152 and moving it into place when it is complete, rsync instead writes the
1153 updated data directly to the destination file.
1154 .IP
1155 This has several effects:
1156 .IP
1157 .RS
1158 .IP o
1159 Hard links are not broken. This means the new data will be visible
1160 through other hard links to the destination file. Moreover, attempts to
1161 copy differing source files onto a multiply-linked destination file will
1162 result in a "tug of war" with the destination data changing back and
1163 forth.
1164 .IP o
1165 In-use binaries cannot be updated (either the OS will prevent this from
1166 happening, or binaries that attempt to swap-in their data will misbehave
1167 or crash).
1168 .IP o
1169 The file's data will be in an inconsistent state during the transfer and
1170 will be left that way if the transfer is interrupted or if an update
1171 fails.
1172 .IP o
1173 A file that rsync cannot write to cannot be updated. While a super user
1174 can update any file, a normal user needs to be granted write permission
1175 for the open of the file for writing to be successful.
1176 .IP o
1177 The efficiency of rsync's delta-transfer algorithm may be reduced if some
1178 data in the destination file is overwritten before it can be copied to a
1179 position later in the file. This does not apply if you use \fB\-\-backup\fP,
1180 since rsync is smart enough to use the backup file as the basis file for
1181 the transfer.
1182 .RE
1183 .IP
1184 WARNING: you should not use this option to update files that are being
1185 accessed by others, so be careful when choosing to use this for a copy.
1186 .IP
1187 This option is useful for transferring large files with block-based changes
1188 or appended data, and also on systems that are disk bound, not network
1189 bound. It can also help keep a copy-on-write filesystem snapshot from
1190 diverging the entire contents of a file that only has minor changes.
1191 .IP
1192 The option implies \fB\-\-partial\fP (since an interrupted transfer does
1193 not delete the file), but conflicts with \fB\-\-partial-dir\fP and
1194 \fB\-\-delay-updates\fP. Prior to rsync 2.6.4 \fB\-\-inplace\fP was also
1195 incompatible with \fB\-\-compare-dest\fP and \fB\-\-link-dest\fP.
1196 .IP "\fB\-\-append\fP"
1197 This special copy mode only works to efficiently update files that are
1198 known to be growing larger where any existing content on the receiving side
1199 is also known to be the same as the content on the sender. The use of
1200 \fB\-\-append\fP \fBcan be dangerous\fP if you aren't 100% sure that all the files
1201 in the transfer are shared, growing files. You should thus use filter
1202 rules to ensure that you weed out any files that do not fit this criteria.
1203 .IP
1204 Rsync updates these growing file in-place without verifying any of the
1205 existing content in the file (it only verifies the content that it is
1206 appending). Rsync skips any files that exist on the receiving side that
1207 are not shorter than the associated file on the sending side (which means
1208 that new files are transferred). It also skips any files whose size on the
1209 sending side gets shorter during the send negotiations (rsync warns about a
1210 "diminished" file when this happens).
1211 .IP
1212 This does not interfere with the updating of a file's non-content
1213 attributes (e.g. permissions, ownership, etc.) when the file does not need
1214 to be transferred, nor does it affect the updating of any directories or
1215 non-regular files.
1216 .IP "\fB\-\-append-verify\fP"
1217 This special copy mode works like \fB\-\-append\fP except that all the
1218 data in the file is included in the checksum verification (making it less
1219 efficient but also potentially safer). This option \fBcan be dangerous\fP if
1220 you aren't 100% sure that all the files in the transfer are shared, growing
1221 files. See the \fB\-\-append\fP option for more details.
1222 .IP
1223 Note: prior to rsync 3.0.0, the \fB\-\-append\fP option worked like
1224 \fB\-\-append-verify\fP, so if you are interacting with an older rsync (or the
1225 transfer is using a protocol prior to 30), specifying either append option
1226 will initiate an \fB\-\-append-verify\fP transfer.
1227 .IP "\fB\-\-dirs\fP, \fB\-d\fP"
1228 Tell the sending side to include any directories that are encountered.
1229 Unlike \fB\-\-recursive\fP, a directory's contents are not copied unless
1230 the directory name specified is "." or ends with a trailing slash (e.g.
1231 ".", "dir/.", "dir/", etc.). Without this option or the
1232 \fB\-\-recursive\fP option, rsync will skip all directories it encounters
1233 (and output a message to that effect for each one). If you specify both
1234 \fB\-\-dirs\fP and \fB\-\-recursive\fP, \fB\-\-recursive\fP takes precedence.
1235 .IP
1236 The \fB\-\-dirs\fP option is implied by the \fB\-\-files-from\fP option or the
1237 \fB\-\-list-only\fP option (including an implied \fB\-\-list-only\fP
1238 usage) if \fB\-\-recursive\fP wasn't specified (so that directories are
1239 seen in the listing). Specify \fB\-\-no-dirs\fP (or \fB\-\-no-d\fP) if you want to
1240 turn this off.
1241 .IP
1242 There is also a backward-compatibility helper option, \fB\-\-old-dirs\fP
1243 (\fB\-\-old-d\fP) that tells rsync to use a hack of \fB\-r\ \-\-exclude='/*/*'\fP to get
1244 an older rsync to list a single directory without recursing.
1245 .IP "\fB\-\-mkpath\fP"
1246 Create all missing path components of the destination path.
1247 .IP
1248 By default, rsync allows only the final component of the destination path
1249 to not exist, which is an attempt to help you to validate your destination
1250 path. With this option, rsync creates all the missing destination-path
1251 components, just as if \fBmkdir\ \-p\ $DEST_PATH\fP had been run on the receiving
1252 side.
1253 .IP
1254 When specifying a destination path, including a trailing slash ensures that
1255 the whole path is treated as directory names to be created, even when the
1256 file list has a single item. See the COPYING TO A DIFFERENT NAME
1257 section for full details on how rsync decides if a final destination-path
1258 component should be created as a directory or not.
1259 .IP
1260 If you would like the newly-created destination dirs to match the dirs on
1261 the sending side, you should be using \fB\-\-relative\fP (\fB\-R\fP) instead
1262 of \fB\-\-mkpath\fP. For instance, the following two commands result in the same
1263 destination tree, but only the second command ensures that the
1264 "some/extra/path" components match the dirs on the sending side:
1265 .RS 4
1266 .IP
1267 .nf
1268 rsync -ai --mkpath host:some/extra/path/*.c some/extra/path/
1269 rsync -aiR host:some/extra/path/*.c ./
1270 .fi
1271 .RE
1272 .IP "\fB\-\-links\fP, \fB\-l\fP"
1273 Add symlinks to the transferred files instead of noisily ignoring them with
1274 a "non-regular file" warning for each symlink encountered. You can
1275 alternately silence the warning by specifying \fB\-\-info=nonreg0\fP.
1276 .IP
1277 The default handling of symlinks is to recreate each symlink's unchanged
1278 value on the receiving side.
1279 .IP
1280 See the SYMBOLIC LINKS section for multi-option info.
1281 .IP "\fB\-\-copy-links\fP, \fB\-L\fP"
1282 The sender transforms each symlink encountered in the transfer into the
1283 referent item, following the symlink chain to the file or directory that it
1284 references. If a symlink chain is broken, an error is output and the file
1285 is dropped from the transfer.
1286 .IP
1287 This option supersedes any other options that affect symlinks in the
1288 transfer, since there are no symlinks left in the transfer.
1289 .IP
1290 This option does not change the handling of existing symlinks on the
1291 receiving side, unlike versions of rsync prior to 2.6.3 which had the
1292 side-effect of telling the receiving side to also follow symlinks. A
1293 modern rsync won't forward this option to a remote receiver (since only the
1294 sender needs to know about it), so this caveat should only affect someone
1295 using an rsync client older than 2.6.7 (which is when \fB\-L\fP stopped being
1296 forwarded to the receiver).
1297 .IP
1298 See the \fB\-\-keep-dirlinks\fP (\fB\-K\fP) if you need a symlink to a
1299 directory to be treated as a real directory on the receiving side.
1300 .IP
1301 See the SYMBOLIC LINKS section for multi-option info.
1302 .IP "\fB\-\-copy-unsafe-links\fP"
1303 This tells rsync to copy the referent of symbolic links that point outside
1304 the copied tree. Absolute symlinks are also treated like ordinary files,
1305 and so are any symlinks in the source path itself when \fB\-\-relative\fP
1306 is used.
1307 .IP
1308 Note that the cut-off point is the top of the transfer, which is the part
1309 of the path that rsync isn't mentioning in the verbose output. If you copy
1310 "/src/subdir" to "/dest/" then the "subdir" directory is a name inside the
1311 transfer tree, not the top of the transfer (which is /src) so it is legal
1312 for created relative symlinks to refer to other names inside the /src and
1313 /dest directories. If you instead copy "/src/subdir/" (with a trailing
1314 slash) to "/dest/subdir" that would not allow symlinks to any files outside
1315 of "subdir".
1316 .IP
1317 Note that safe symlinks are only copied if \fB\-\-links\fP was also
1318 specified or implied. The \fB\-\-copy-unsafe-links\fP option has no extra effect
1319 when combined with \fB\-\-copy-links\fP.
1320 .IP
1321 See the SYMBOLIC LINKS section for multi-option info.
1322 .IP "\fB\-\-safe-links\fP"
1323 This tells the receiving rsync to ignore any symbolic links in the transfer
1324 which point outside the copied tree. All absolute symlinks are also
1325 ignored.
1326 .IP
1327 Since this ignoring is happening on the receiving side, it will still be
1328 effective even when the sending side has munged symlinks (when it is using
1329 \fB\-\-munge-links\fP). It also affects deletions, since the file being
1330 present in the transfer prevents any matching file on the receiver from
1331 being deleted when the symlink is deemed to be unsafe and is skipped.
1332 .IP
1333 This option must be combined with \fB\-\-links\fP (or
1334 \fB\-\-archive\fP) to have any symlinks in the transfer to conditionally
1335 ignore. Its effect is superseded by \fB\-\-copy-unsafe-links\fP.
1336 .IP
1337 Using this option in conjunction with \fB\-\-relative\fP may give
1338 unexpected results.
1339 .IP
1340 See the SYMBOLIC LINKS section for multi-option info.
1341 .IP "\fB\-\-munge-links\fP"
1342 This option affects just one side of the transfer and tells rsync to munge
1343 symlink values when it is receiving files or unmunge symlink values when it
1344 is sending files. The munged values make the symlinks unusable on disk but
1345 allows the original contents of the symlinks to be recovered.
1346 .IP
1347 The server-side rsync often enables this option without the client's
1348 knowledge, such as in an rsync daemon's configuration file or by an option
1349 given to the rrsync (restricted rsync) script. When specified on the
1350 client side, specify the option normally if it is the client side that
1351 has/needs the munged symlinks, or use \fB\-M\-\-munge-links\fP to give the option
1352 to the server when it has/needs the munged symlinks. Note that on a local
1353 transfer, the client is the sender, so specifying the option directly
1354 unmunges symlinks while specifying it as a remote option munges symlinks.
1355 .IP
1356 This option has no effect when sent to a daemon via \fB\-\-remote-option\fP
1357 because the daemon configures whether it wants munged symlinks via its
1358 "\fBmunge\ symlinks\fP" parameter.
1359 .IP
1360 The symlink value is munged/unmunged once it is in the transfer, so any
1361 option that transforms symlinks into non-symlinks occurs prior to the
1362 munging/unmunging \fBexcept\fP for \fB\-\-safe-links\fP, which is a choice
1363 that the receiver makes, so it bases its decision on the munged/unmunged
1364 value. This does mean that if a receiver has munging enabled, that using
1365 \fB\-\-safe-links\fP will cause all symlinks to be ignored (since they
1366 are all absolute).
1367 .IP
1368 The method that rsync uses to munge the symlinks is to prefix each one's
1369 value with the string "/rsyncd-munged/". This prevents the links from
1370 being used as long as the directory does not exist. When this option is
1371 enabled, rsync will refuse to run if that path is a directory or a symlink
1372 to a directory (though it only checks at startup). See also the
1373 "munge-symlinks" python script in the support directory of the source code
1374 for a way to munge/unmunge one or more symlinks in-place.
1375 .IP "\fB\-\-copy-dirlinks\fP, \fB\-k\fP"
1376 This option causes the sending side to treat a symlink to a directory as
1377 though it were a real directory. This is useful if you don't want symlinks
1378 to non-directories to be affected, as they would be using
1379 \fB\-\-copy-links\fP.
1380 .IP
1381 Without this option, if the sending side has replaced a directory with a
1382 symlink to a directory, the receiving side will delete anything that is in
1383 the way of the new symlink, including a directory hierarchy (as long as
1384 \fB\-\-force\fP or \fB\-\-delete\fP is in effect).
1385 .IP
1386 See also \fB\-\-keep-dirlinks\fP for an analogous option for the
1387 receiving side.
1388 .IP
1389 \fB\-\-copy-dirlinks\fP applies to all symlinks to directories in the source. If
1390 you want to follow only a few specified symlinks, a trick you can use is to
1391 pass them as additional source args with a trailing slash, using
1392 \fB\-\-relative\fP to make the paths match up right. For example:
1393 .RS 4
1394 .IP
1395 .nf
1396 rsync -r --relative src/./ src/./follow-me/ dest/
1397 .fi
1398 .RE
1399 .IP
1400 This works because rsync calls \fBlstat\fP(2) on the source arg as given, and
1401 the trailing slash makes \fBlstat\fP(2) follow the symlink, giving rise to a
1402 directory in the file-list which overrides the symlink found during the
1403 scan of "src/./".
1404 .IP
1405 See the SYMBOLIC LINKS section for multi-option info.
1406 .IP "\fB\-\-keep-dirlinks\fP, \fB\-K\fP"
1407 This option causes the receiving side to treat a symlink to a directory as
1408 though it were a real directory, but only if it matches a real directory
1409 from the sender. Without this option, the receiver's symlink would be
1410 deleted and replaced with a real directory.
1411 .IP
1412 For example, suppose you transfer a directory "foo" that contains a file
1413 "file", but "foo" is a symlink to directory "bar" on the receiver. Without
1414 \fB\-\-keep-dirlinks\fP, the receiver deletes symlink "foo", recreates it as a
1415 directory, and receives the file into the new directory. With
1416 \fB\-\-keep-dirlinks\fP, the receiver keeps the symlink and "file" ends up in
1417 "bar".
1418 .IP
1419 One note of caution: if you use \fB\-\-keep-dirlinks\fP, you must trust all the
1420 symlinks in the copy or enable the \fB\-\-munge-links\fP option on the
1421 receiving side! If it is possible for an untrusted user to create their
1422 own symlink to any real directory, the user could then (on a subsequent
1423 copy) replace the symlink with a real directory and affect the content of
1424 whatever directory the symlink references. For backup copies, you are
1425 better off using something like a bind mount instead of a symlink to modify
1426 your receiving hierarchy.
1427 .IP
1428 See also \fB\-\-copy-dirlinks\fP for an analogous option for the sending
1429 side.
1430 .IP
1431 See the SYMBOLIC LINKS section for multi-option info.
1432 .IP "\fB\-\-hard-links\fP, \fB\-H\fP"
1433 This tells rsync to look for hard-linked files in the source and link
1434 together the corresponding files on the destination. Without this option,
1435 hard-linked files in the source are treated as though they were separate
1436 files.
1437 .IP
1438 This option does NOT necessarily ensure that the pattern of hard links on
1439 the destination exactly matches that on the source. Cases in which the
1440 destination may end up with extra hard links include the following:
1441 .IP
1442 .RS
1443 .IP o
1444 If the destination contains extraneous hard-links (more linking than what
1445 is present in the source file list), the copying algorithm will not break
1446 them explicitly. However, if one or more of the paths have content
1447 differences, the normal file-update process will break those extra links
1448 (unless you are using the \fB\-\-inplace\fP option).
1449 .IP o
1450 If you specify a \fB\-\-link-dest\fP directory that contains hard
1451 links, the linking of the destination files against the
1452 \fB\-\-link-dest\fP files can cause some paths in the destination to
1453 become linked together due to the \fB\-\-link-dest\fP associations.
1454 .RE
1455 .IP
1456 Note that rsync can only detect hard links between files that are inside
1457 the transfer set. If rsync updates a file that has extra hard-link
1458 connections to files outside the transfer, that linkage will be broken. If
1459 you are tempted to use the \fB\-\-inplace\fP option to avoid this breakage, be
1460 very careful that you know how your files are being updated so that you are
1461 certain that no unintended changes happen due to lingering hard links (and
1462 see the \fB\-\-inplace\fP option for more caveats).
1463 .IP
1464 If incremental recursion is active (see \fB\-\-inc-recursive\fP), rsync
1465 may transfer a missing hard-linked file before it finds that another link
1466 for that contents exists elsewhere in the hierarchy. This does not affect
1467 the accuracy of the transfer (i.e. which files are hard-linked together),
1468 just its efficiency (i.e. copying the data for a new, early copy of a
1469 hard-linked file that could have been found later in the transfer in
1470 another member of the hard-linked set of files). One way to avoid this
1471 inefficiency is to disable incremental recursion using the
1472 \fB\-\-no-inc-recursive\fP option.
1473 .IP "\fB\-\-perms\fP, \fB\-p\fP"
1474 This option causes the receiving rsync to set the destination permissions
1475 to be the same as the source permissions. (See also the \fB\-\-chmod\fP
1476 option for a way to modify what rsync considers to be the source
1477 permissions.)
1478 .IP
1479 When this option is \fIoff\fP, permissions are set as follows:
1480 .IP
1481 .RS
1482 .IP o
1483 Existing files (including updated files) retain their existing
1484 permissions, though the \fB\-\-executability\fP option might change
1485 just the execute permission for the file.
1486 .IP o
1487 New files get their "normal" permission bits set to the source file's
1488 permissions masked with the receiving directory's default permissions
1489 (either the receiving process's umask, or the permissions specified via
1490 the destination directory's default ACL), and their special permission
1491 bits disabled except in the case where a new directory inherits a setgid
1492 bit from its parent directory.
1493 .RE
1494 .IP
1495 Thus, when \fB\-\-perms\fP and \fB\-\-executability\fP are both disabled, rsync's
1496 behavior is the same as that of other file-copy utilities, such as \fBcp\fP(1)
1497 and \fBtar\fP(1).
1498 .IP
1499 In summary: to give destination files (both old and new) the source
1500 permissions, use \fB\-\-perms\fP. To give new files the destination-default
1501 permissions (while leaving existing files unchanged), make sure that the
1502 \fB\-\-perms\fP option is off and use \fB\-\-chmod=ugo=rwX\fP (which ensures
1503 that all non-masked bits get enabled). If you'd care to make this latter
1504 behavior easier to type, you could define a popt alias for it, such as
1505 putting this line in the file \fB~/.popt\fP (the following defines the \fB\-Z\fP
1506 option, and includes \fB\-\-no-g\fP to use the default group of the destination
1507 dir):
1508 .RS 4
1509 .IP
1510 .nf
1511 rsync alias -Z --no-p --no-g --chmod=ugo=rwX
1512 .fi
1513 .RE
1514 .IP
1515 You could then use this new option in a command such as this one:
1516 .RS 4
1517 .IP
1518 .nf
1519 rsync -avZ src/ dest/
1520 .fi
1521 .RE
1522 .IP
1523 (Caveat: make sure that \fB\-a\fP does not follow \fB\-Z\fP, or it will re-enable the
1524 two \fB\-\-no-*\fP options mentioned above.)
1525 .IP
1526 The preservation of the destination's setgid bit on newly-created
1527 directories when \fB\-\-perms\fP is off was added in rsync 2.6.7. Older rsync
1528 versions erroneously preserved the three special permission bits for
1529 newly-created files when \fB\-\-perms\fP was off, while overriding the
1530 destination's setgid bit setting on a newly-created directory. Default ACL
1531 observance was added to the ACL patch for rsync 2.6.7, so older (or
1532 non-ACL-enabled) rsyncs use the umask even if default ACLs are present.
1533 (Keep in mind that it is the version of the receiving rsync that affects
1534 these behaviors.)
1535 .IP "\fB\-\-executability\fP, \fB\-E\fP"
1536 This option causes rsync to preserve the executability (or
1537 non-executability) of regular files when \fB\-\-perms\fP is not enabled.
1538 A regular file is considered to be executable if at least one 'x' is turned
1539 on in its permissions. When an existing destination file's executability
1540 differs from that of the corresponding source file, rsync modifies the
1541 destination file's permissions as follows:
1542 .IP
1543 .RS
1544 .IP o
1545 To make a file non-executable, rsync turns off all its 'x' permissions.
1546 .IP o
1547 To make a file executable, rsync turns on each 'x' permission that has a
1548 corresponding 'r' permission enabled.
1549 .RE
1550 .IP
1551 If \fB\-\-perms\fP is enabled, this option is ignored.
1552 .IP "\fB\-\-acls\fP, \fB\-A\fP"
1553 This option causes rsync to update the destination ACLs to be the same as
1554 the source ACLs. The option also implies \fB\-\-perms\fP.
1555 .IP
1556 The source and destination systems must have compatible ACL entries for
1557 this option to work properly. See the \fB\-\-fake-super\fP option for a
1558 way to backup and restore ACLs that are not compatible.
1559 .IP "\fB\-\-xattrs\fP, \fB\-X\fP"
1560 This option causes rsync to update the destination extended attributes to
1561 be the same as the source ones.
1562 .IP
1563 For systems that support extended-attribute namespaces, a copy being done
1564 by a super-user copies all namespaces except system.*. A normal user only
1565 copies the user.* namespace. To be able to backup and restore non-user
1566 namespaces as a normal user, see the \fB\-\-fake-super\fP option.
1567 .IP
1568 The above name filtering can be overridden by using one or more filter
1569 options with the \fBx\fP modifier. When you specify an xattr-affecting
1570 filter rule, rsync requires that you do your own system/user filtering, as
1571 well as any additional filtering for what xattr names are copied and what
1572 names are allowed to be deleted. For example, to skip the system
1573 namespace, you could specify:
1574 .RS 4
1575 .IP
1576 .nf
1577 --filter='-x system.*'
1578 .fi
1579 .RE
1580 .IP
1581 To skip all namespaces except the user namespace, you could specify a
1582 negated-user match:
1583 .RS 4
1584 .IP
1585 .nf
1586 --filter='-x! user.*'
1587 .fi
1588 .RE
1589 .IP
1590 To prevent any attributes from being deleted, you could specify a
1591 receiver-only rule that excludes all names:
1592 .RS 4
1593 .IP
1594 .nf
1595 --filter='-xr *'
1596 .fi
1597 .RE
1598 .IP
1599 Note that the \fB\-X\fP option does not copy rsync's special xattr values (e.g.
1600 those used by \fB\-\-fake-super\fP) unless you repeat the option (e.g. \fB\-XX\fP).
1601 This "copy all xattrs" mode cannot be used with \fB\-\-fake-super\fP.
1602 .IP "\fB\-\-chmod=CHMOD\fP"
1603 This option tells rsync to apply one or more comma-separated "chmod" modes
1604 to the permission of the files in the transfer. The resulting value is
1605 treated as though it were the permissions that the sending side supplied
1606 for the file, which means that this option can seem to have no effect on
1607 existing files if \fB\-\-perms\fP is not enabled.
1608 .IP
1609 In addition to the normal parsing rules specified in the \fBchmod\fP(1)
1610 manpage, you can specify an item that should only apply to a directory by
1611 prefixing it with a 'D', or specify an item that should only apply to a
1612 file by prefixing it with a 'F'. For example, the following will ensure
1613 that all directories get marked set-gid, that no files are other-writable,
1614 that both are user-writable and group-writable, and that both have
1615 consistent executability across all bits:
1616 .RS 4
1617 .IP
1618 .nf
1619 --chmod=Dg+s,ug+w,Fo-w,+X
1620 .fi
1621 .RE
1622 .IP
1623 Using octal mode numbers is also allowed:
1624 .RS 4
1625 .IP
1626 .nf
1627 --chmod=D2775,F664
1628 .fi
1629 .RE
1630 .IP
1631 It is also legal to specify multiple \fB\-\-chmod\fP options, as each additional
1632 option is just appended to the list of changes to make.
1633 .IP
1634 See the \fB\-\-perms\fP and \fB\-\-executability\fP options for how the
1635 resulting permission value can be applied to the files in the transfer.
1636 .IP "\fB\-\-owner\fP, \fB\-o\fP"
1637 This option causes rsync to set the owner of the destination file to be the
1638 same as the source file, but only if the receiving rsync is being run as
1639 the super-user (see also the \fB\-\-super\fP and \fB\-\-fake-super\fP
1640 options). Without this option, the owner of new and/or transferred files
1641 are set to the invoking user on the receiving side.
1642 .IP
1643 The preservation of ownership will associate matching names by default, but
1644 may fall back to using the ID number in some circumstances (see also the
1645 \fB\-\-numeric-ids\fP option for a full discussion).
1646 .IP "\fB\-\-group\fP, \fB\-g\fP"
1647 This option causes rsync to set the group of the destination file to be the
1648 same as the source file. If the receiving program is not running as the
1649 super-user (or if \fB\-\-no-super\fP was specified), only groups that the
1650 invoking user on the receiving side is a member of will be preserved.
1651 Without this option, the group is set to the default group of the invoking
1652 user on the receiving side.
1653 .IP
1654 The preservation of group information will associate matching names by
1655 default, but may fall back to using the ID number in some circumstances
1656 (see also the \fB\-\-numeric-ids\fP option for a full discussion).
1657 .IP "\fB\-\-devices\fP"
1658 This option causes rsync to transfer character and block device files to
1659 the remote system to recreate these devices. If the receiving rsync is not
1660 being run as the super-user, rsync silently skips creating the device files
1661 (see also the \fB\-\-super\fP and \fB\-\-fake-super\fP options).
1662 .IP
1663 By default, rsync generates a "non-regular file" warning for each device
1664 file encountered when this option is not set. You can silence the warning
1665 by specifying \fB\-\-info=nonreg0\fP.
1666 .IP "\fB\-\-specials\fP"
1667 This option causes rsync to transfer special files, such as named sockets
1668 and fifos. If the receiving rsync is not being run as the super-user,
1669 rsync silently skips creating the special files (see also the
1670 \fB\-\-super\fP and \fB\-\-fake-super\fP options).
1671 .IP
1672 By default, rsync generates a "non-regular file" warning for each special
1673 file encountered when this option is not set. You can silence the warning
1674 by specifying \fB\-\-info=nonreg0\fP.
1675 .IP "\fB\-D\fP"
1676 The \fB\-D\fP option is equivalent to "\fB\-\-devices\fP
1677 \fB\-\-specials\fP".
1678 .IP "\fB\-\-copy-devices\fP"
1679 This tells rsync to treat a device on the sending side as a regular file,
1680 allowing it to be copied to a normal destination file (or another device
1681 if \fB\-\-write-devices\fP was also specified).
1682 .IP
1683 This option is refused by default by an rsync daemon.
1684 .IP "\fB\-\-write-devices\fP"
1685 This tells rsync to treat a device on the receiving side as a regular file,
1686 allowing the writing of file data into a device.
1687 .IP
1688 This option implies the \fB\-\-inplace\fP option.
1689 .IP
1690 Be careful using this, as you should know what devices are present on the
1691 receiving side of the transfer, especially when running rsync as root.
1692 .IP
1693 This option is refused by default by an rsync daemon.
1694 .IP "\fB\-\-times\fP, \fB\-t\fP"
1695 This tells rsync to transfer modification times along with the files and
1696 update them on the remote system. Note that if this option is not used,
1697 the optimization that excludes files that have not been modified cannot be
1698 effective; in other words, a missing \fB\-t\fP (or \fB\-a\fP) will cause the
1699 next transfer to behave as if it used \fB\-\-ignore-times\fP (\fB\-I\fP),
1700 causing all files to be updated (though rsync's delta-transfer algorithm
1701 will make the update fairly efficient if the files haven't actually
1702 changed, you're much better off using \fB\-t\fP).
1703 .IP
1704 A modern rsync that is using transfer protocol 30 or 31 conveys a modify
1705 time using up to 8-bytes. If rsync is forced to speak an older protocol
1706 (perhaps due to the remote rsync being older than 3.0.0) a modify time is
1707 conveyed using 4-bytes. Prior to 3.2.7, these shorter values could convey
1708 a date range of 13-Dec-1901 to 19-Jan-2038. Beginning with 3.2.7, these
1709 4-byte values now convey a date range of 1-Jan-1970 to 7-Feb-2106. If you
1710 have files dated older than 1970, make sure your rsync executables are
1711 upgraded so that the full range of dates can be conveyed.
1712 .IP "\fB\-\-atimes\fP, \fB\-U\fP"
1713 This tells rsync to set the access (use) times of the destination files to
1714 the same value as the source files.
1715 .IP
1716 If repeated, it also sets the \fB\-\-open-noatime\fP option, which can help you
1717 to make the sending and receiving systems have the same access times on the
1718 transferred files without needing to run rsync an extra time after a file
1719 is transferred.
1720 .IP
1721 Note that some older rsync versions (prior to 3.2.0) may have been built
1722 with a pre-release \fB\-\-atimes\fP patch that does not imply
1723 \fB\-\-open-noatime\fP when this option is repeated.
1724 .IP "\fB\-\-open-noatime\fP"
1725 This tells rsync to open files with the O_NOATIME flag (on systems that
1726 support it) to avoid changing the access time of the files that are being
1727 transferred. If your OS does not support the O_NOATIME flag then rsync
1728 will silently ignore this option. Note also that some filesystems are
1729 mounted to avoid updating the atime on read access even without the
1730 O_NOATIME flag being set.
1731 .IP "\fB\-\-crtimes\fP, \fB\-N,\fP"
1732 This tells rsync to set the create times (newness) of the destination
1733 files to the same value as the source files. Your OS & filesystem must
1734 support the setting of arbitrary creation (birth) times for this option
1735 to be supported.
1736 .IP "\fB\-\-omit-dir-times\fP, \fB\-O\fP"
1737 This tells rsync to omit directories when it is preserving modification,
1738 access, and create times. If NFS is sharing the directories on the receiving
1739 side, it is a good idea to use \fB\-O\fP. This option is inferred if you use
1740 \fB\-\-backup\fP without \fB\-\-backup-dir\fP.
1741 .IP
1742 This option also has the side-effect of avoiding early creation of missing
1743 sub-directories when incremental recursion is enabled, as discussed in the
1744 \fB\-\-inc-recursive\fP section.
1745 .IP "\fB\-\-omit-link-times\fP, \fB\-J\fP"
1746 This tells rsync to omit symlinks when it is preserving modification,
1747 access, and create times.
1748 .IP "\fB\-\-super\fP"
1749 This tells the receiving side to attempt super-user activities even if the
1750 receiving rsync wasn't run by the super-user. These activities include:
1751 preserving users via the \fB\-\-owner\fP option, preserving all groups
1752 (not just the current user's groups) via the \fB\-\-group\fP option, and
1753 copying devices via the \fB\-\-devices\fP option. This is useful for
1754 systems that allow such activities without being the super-user, and also
1755 for ensuring that you will get errors if the receiving side isn't being run
1756 as the super-user. To turn off super-user activities, the super-user can
1757 use \fB\-\-no-super\fP.
1758 .IP "\fB\-\-fake-super\fP"
1759 When this option is enabled, rsync simulates super-user activities by
1760 saving/restoring the privileged attributes via special extended attributes
1761 that are attached to each file (as needed). This includes the file's owner
1762 and group (if it is not the default), the file's device info (device &
1763 special files are created as empty text files), and any permission bits
1764 that we won't allow to be set on the real file (e.g. the real file gets
1765 u-s,g-s,o-t for safety) or that would limit the owner's access (since the
1766 real super-user can always access/change a file, the files we create can
1767 always be accessed/changed by the creating user). This option also handles
1768 ACLs (if \fB\-\-acls\fP was specified) and non-user extended attributes
1769 (if \fB\-\-xattrs\fP was specified).
1770 .IP
1771 This is a good way to backup data without using a super-user, and to store
1772 ACLs from incompatible systems.
1773 .IP
1774 The \fB\-\-fake-super\fP option only affects the side where the option is used.
1775 To affect the remote side of a remote-shell connection, use the
1776 \fB\-\-remote-option\fP (\fB\-M\fP) option:
1777 .RS 4
1778 .IP
1779 .nf
1780 rsync -av -M--fake-super /src/ host:/dest/
1781 .fi
1782 .RE
1783 .IP
1784 For a local copy, this option affects both the source and the destination.
1785 If you wish a local copy to enable this option just for the destination
1786 files, specify \fB\-M\-\-fake-super\fP. If you wish a local copy to enable this
1787 option just for the source files, combine \fB\-\-fake-super\fP with \fB\-M\-\-super\fP.
1788 .IP
1789 This option is overridden by both \fB\-\-super\fP and \fB\-\-no-super\fP.
1790 .IP
1791 See also the \fBfake\ super\fP setting in the
1792 daemon's rsyncd.conf file.
1793 .IP "\fB\-\-sparse\fP, \fB\-S\fP"
1794 Try to handle sparse files efficiently so they take up less space on the
1795 destination. If combined with \fB\-\-inplace\fP the file created might
1796 not end up with sparse blocks with some combinations of kernel version
1797 and/or filesystem type. If \fB\-\-whole-file\fP is in effect (e.g. for a
1798 local copy) then it will always work because rsync truncates the file prior
1799 to writing out the updated version.
1800 .IP
1801 Note that versions of rsync older than 3.1.3 will reject the combination of
1802 \fB\-\-sparse\fP and \fB\-\-inplace\fP.
1803 .IP "\fB\-\-preallocate\fP"
1804 This tells the receiver to allocate each destination file to its eventual
1805 size before writing data to the file. Rsync will only use the real
1806 filesystem-level preallocation support provided by Linux's \fBfallocate\fP(2)
1807 system call or Cygwin's \fBposix_fallocate\fP(3), not the slow glibc
1808 implementation that writes a null byte into each block.
1809 .IP
1810 Without this option, larger files may not be entirely contiguous on the
1811 filesystem, but with this option rsync will probably copy more slowly. If
1812 the destination is not an extent-supporting filesystem (such as ext4, xfs,
1813 NTFS, etc.), this option may have no positive effect at all.
1814 .IP
1815 If combined with \fB\-\-sparse\fP, the file will only have sparse blocks
1816 (as opposed to allocated sequences of null bytes) if the kernel version and
1817 filesystem type support creating holes in the allocated data.
1818 .IP "\fB\-\-dry-run\fP, \fB\-n\fP"
1819 This makes rsync perform a trial run that doesn't make any changes (and
1820 produces mostly the same output as a real run). It is most commonly used
1821 in combination with the \fB\-\-verbose\fP (\fB\-v\fP) and/or
1822 \fB\-\-itemize-changes\fP (\fB\-i\fP) options to see what an rsync command is
1823 going to do before one actually runs it.
1824 .IP
1825 The output of \fB\-\-itemize-changes\fP is supposed to be exactly the
1826 same on a dry run and a subsequent real run (barring intentional trickery
1827 and system call failures); if it isn't, that's a bug. Other output should
1828 be mostly unchanged, but may differ in some areas. Notably, a dry run does
1829 not send the actual data for file transfers, so \fB\-\-progress\fP has no
1830 effect, the "bytes sent", "bytes received", "literal data", and "matched
1831 data" statistics are too small, and the "speedup" value is equivalent to a
1832 run where no file transfers were needed.
1833 .IP "\fB\-\-whole-file\fP, \fB\-W\fP"
1834 This option disables rsync's delta-transfer algorithm, which causes all
1835 transferred files to be sent whole. The transfer may be faster if this
1836 option is used when the bandwidth between the source and destination
1837 machines is higher than the bandwidth to disk (especially when the "disk"
1838 is actually a networked filesystem). This is the default when both the
1839 source and destination are specified as local paths, but only if no
1840 batch-writing option is in effect.
1841 .IP "\fB\-\-no-whole-file\fP, \fB\-\-no-W\fP"
1842 Disable whole-file updating when it is enabled by default for a local
1843 transfer. This usually slows rsync down, but it can be useful if you are
1844 trying to minimize the writes to the destination file (if combined with
1845 \fB\-\-inplace\fP) or for testing the checksum-based update algorithm.
1846 .IP
1847 See also the \fB\-\-whole-file\fP option.
1848 .IP "\fB\-\-checksum-choice=STR\fP, \fB\-\-cc=STR\fP"
1849 This option overrides the checksum algorithms. If one algorithm name is
1850 specified, it is used for both the transfer checksums and (assuming
1851 \fB\-\-checksum\fP is specified) the pre-transfer checksums. If two
1852 comma-separated names are supplied, the first name affects the transfer
1853 checksums, and the second name affects the pre-transfer checksums (\fB\-c\fP).
1854 .IP
1855 The checksum options that you may be able to use are:
1856 .IP
1857 .RS
1858 .IP o
1859 \fBauto\fP (the default automatic choice)
1860 .IP o
1861 \fBxxh128\fP
1862 .IP o
1863 \fBxxh3\fP
1864 .IP o
1865 \fBxxh64\fP (aka \fBxxhash\fP)
1866 .IP o
1867 \fBmd5\fP
1868 .IP o
1869 \fBmd4\fP
1870 .IP o
1871 \fBsha1\fP
1872 .IP o
1873 \fBnone\fP
1874 .RE
1875 .IP
1876 Run \fBrsync\ \-\-version\fP to see the default checksum list compiled into your
1877 version (which may differ from the list above).
1878 .IP
1879 If "none" is specified for the first (or only) name, the \fB\-\-whole-file\fP
1880 option is forced on and no checksum verification is performed on the
1881 transferred data. If "none" is specified for the second (or only) name,
1882 the \fB\-\-checksum\fP option cannot be used.
1883 .IP
1884 The "auto" option is the default, where rsync bases its algorithm choice on
1885 a negotiation between the client and the server as follows:
1886 .IP
1887 When both sides of the transfer are at least 3.2.0, rsync chooses the first
1888 algorithm in the client's list of choices that is also in the server's list
1889 of choices. If no common checksum choice is found, rsync exits with
1890 an error. If the remote rsync is too old to support checksum negotiation,
1891 a value is chosen based on the protocol version (which chooses between MD5
1892 and various flavors of MD4 based on protocol age).
1893 .IP
1894 The default order can be customized by setting the environment variable
1895 \fBRSYNC_CHECKSUM_LIST\fP to a space-separated list of acceptable checksum
1896 names. If the string contains a "\fB&\fP" character, it is separated into the
1897 "client string & server string", otherwise the same string applies to both.
1898 If the string (or string portion) contains no non-whitespace characters,
1899 the default checksum list is used. This method does not allow you to
1900 specify the transfer checksum separately from the pre-transfer checksum,
1901 and it discards "auto" and all unknown checksum names. A list with only
1902 invalid names results in a failed negotiation.
1903 .IP
1904 The use of the \fB\-\-checksum-choice\fP option overrides this environment list.
1905 .IP "\fB\-\-one-file-system\fP, \fB\-x\fP"
1906 This tells rsync to avoid crossing a filesystem boundary when recursing.
1907 This does not limit the user's ability to specify items to copy from
1908 multiple filesystems, just rsync's recursion through the hierarchy of each
1909 directory that the user specified, and also the analogous recursion on the
1910 receiving side during deletion. Also keep in mind that rsync treats a
1911 "bind" mount to the same device as being on the same filesystem.
1912 .IP
1913 If this option is repeated, rsync omits all mount-point directories from
1914 the copy. Otherwise, it includes an empty directory at each mount-point it
1915 encounters (using the attributes of the mounted directory because those of
1916 the underlying mount-point directory are inaccessible).
1917 .IP
1918 If rsync has been told to collapse symlinks (via \fB\-\-copy-links\fP or
1919 \fB\-\-copy-unsafe-links\fP), a symlink to a directory on another device
1920 is treated like a mount-point. Symlinks to non-directories are unaffected
1921 by this option.
1922 .IP "\fB\-\-ignore-non-existing\fP, \fB\-\-existing\fP"
1923 This tells rsync to skip creating files (including directories) that do not
1924 exist yet on the destination. If this option is combined with the
1925 \fB\-\-ignore-existing\fP option, no files will be updated (which can be
1926 useful if all you want to do is delete extraneous files).
1927 .IP
1928 This option is a TRANSFER RULE, so don't expect any
1929 exclude side effects.
1930 .IP "\fB\-\-ignore-existing\fP"
1931 This tells rsync to skip updating files that already exist on the
1932 destination (this does \fInot\fP ignore existing directories, or nothing would
1933 get done). See also \fB\-\-ignore-non-existing\fP.
1934 .IP
1935 This option is a TRANSFER RULE, so don't expect any
1936 exclude side effects.
1937 .IP
1938 This option can be useful for those doing backups using the
1939 \fB\-\-link-dest\fP option when they need to continue a backup run that
1940 got interrupted. Since a \fB\-\-link-dest\fP run is copied into a new
1941 directory hierarchy (when it is used properly), using [\fB\-\-ignore-existing\fP
1942 will ensure that the already-handled files don't get tweaked (which avoids
1943 a change in permissions on the hard-linked files). This does mean that
1944 this option is only looking at the existing files in the destination
1945 hierarchy itself.
1946 .IP
1947 When \fB\-\-info=skip2\fP is used rsync will output "FILENAME exists
1948 (INFO)" messages where the INFO indicates one of "type change", "sum
1949 change" (requires \fB\-c\fP), "file change" (based on the quick check),
1950 "attr change", or "uptodate". Using \fB\-\-info=skip1\fP (which is also
1951 implied by 2 \fB\-v\fP options) outputs the exists message without the
1952 INFO suffix.
1953 .IP "\fB\-\-remove-source-files\fP"
1954 This tells rsync to remove from the sending side the files (meaning
1955 non-directories) that are a part of the transfer and have been successfully
1956 duplicated on the receiving side.
1957 .IP
1958 Note that you should only use this option on source files that are
1959 quiescent. If you are using this to move files that show up in a
1960 particular directory over to another host, make sure that the finished
1961 files get renamed into the source directory, not directly written into it,
1962 so that rsync can't possibly transfer a file that is not yet fully written.
1963 If you can't first write the files into a different directory, you should
1964 use a naming idiom that lets rsync avoid transferring files that are not
1965 yet finished (e.g. name the file "foo.new" when it is written, rename it to
1966 "foo" when it is done, and then use the option \fB\-\-exclude='*.new'\fP
1967 for the rsync transfer).
1968 .IP
1969 Starting with 3.1.0, rsync will skip the sender-side removal (and output an
1970 error) if the file's size or modify time has not stayed unchanged.
1971 .IP
1972 Starting with 3.2.6, a local rsync copy will ensure that the sender does
1973 not remove a file the receiver just verified, such as when the user
1974 accidentally makes the source and destination directory the same path.
1975 .IP "\fB\-\-delete\fP"
1976 This tells rsync to delete extraneous files from the receiving side (ones
1977 that aren't on the sending side), but only for the directories that are
1978 being synchronized. You must have asked rsync to send the whole directory
1979 (e.g. "\fBdir\fP" or "\fBdir/\fP") without using a wildcard for the directory's
1980 contents (e.g. "\fBdir/*\fP") since the wildcard is expanded by the shell and
1981 rsync thus gets a request to transfer individual files, not the files'
1982 parent directory. Files that are excluded from the transfer are also
1983 excluded from being deleted unless you use the \fB\-\-delete-excluded\fP
1984 option or mark the rules as only matching on the sending side (see the
1985 include/exclude modifiers in the FILTER RULES section).
1986 .IP
1987 Prior to rsync 2.6.7, this option would have no effect unless
1988 \fB\-\-recursive\fP was enabled. Beginning with 2.6.7, deletions will
1989 also occur when \fB\-\-dirs\fP (\fB\-d\fP) is enabled, but only for
1990 directories whose contents are being copied.
1991 .IP
1992 This option can be dangerous if used incorrectly! It is a very good idea to
1993 first try a run using the \fB\-\-dry-run\fP (\fB\-n\fP) option to see what
1994 files are going to be deleted.
1995 .IP
1996 If the sending side detects any I/O errors, then the deletion of any files
1997 at the destination will be automatically disabled. This is to prevent
1998 temporary filesystem failures (such as NFS errors) on the sending side from
1999 causing a massive deletion of files on the destination. You can override
2000 this with the \fB\-\-ignore-errors\fP option.
2001 .IP
2002 The \fB\-\-delete\fP option may be combined with one of the \-\-delete-WHEN options
2003 without conflict, as well as \fB\-\-delete-excluded\fP. However, if none
2004 of the \fB\-\-delete-WHEN\fP options are specified, rsync will choose the
2005 \fB\-\-delete-during\fP algorithm when talking to rsync 3.0.0 or newer,
2006 or the \fB\-\-delete-before\fP algorithm when talking to an older rsync.
2007 See also \fB\-\-delete-delay\fP and \fB\-\-delete-after\fP.
2008 .IP "\fB\-\-delete-before\fP"
2009 Request that the file-deletions on the receiving side be done before the
2010 transfer starts. See \fB\-\-delete\fP (which is implied) for more
2011 details on file-deletion.
2012 .IP
2013 Deleting before the transfer is helpful if the filesystem is tight for
2014 space and removing extraneous files would help to make the transfer
2015 possible. However, it does introduce a delay before the start of the
2016 transfer, and this delay might cause the transfer to timeout (if
2017 \fB\-\-timeout\fP was specified). It also forces rsync to use the old,
2018 non-incremental recursion algorithm that requires rsync to scan all the
2019 files in the transfer into memory at once (see \fB\-\-recursive\fP).
2020 .IP "\fB\-\-delete-during\fP, \fB\-\-del\fP"
2021 Request that the file-deletions on the receiving side be done incrementally
2022 as the transfer happens. The per-directory delete scan is done right
2023 before each directory is checked for updates, so it behaves like a more
2024 efficient \fB\-\-delete-before\fP, including doing the deletions prior to
2025 any per-directory filter files being updated. This option was first added
2026 in rsync version 2.6.4. See \fB\-\-delete\fP (which is implied) for more
2027 details on file-deletion.
2028 .IP "\fB\-\-delete-delay\fP"
2029 Request that the file-deletions on the receiving side be computed during
2030 the transfer (like \fB\-\-delete-during\fP), and then removed after the
2031 transfer completes. This is useful when combined with
2032 \fB\-\-delay-updates\fP and/or \fB\-\-fuzzy\fP, and is more efficient
2033 than using \fB\-\-delete-after\fP (but can behave differently, since
2034 \fB\-\-delete-after\fP computes the deletions in a separate pass after
2035 all updates are done). If the number of removed files overflows an
2036 internal buffer, a temporary file will be created on the receiving side to
2037 hold the names (it is removed while open, so you shouldn't see it during
2038 the transfer). If the creation of the temporary file fails, rsync will try
2039 to fall back to using \fB\-\-delete-after\fP (which it cannot do if
2040 \fB\-\-recursive\fP is doing an incremental scan). See
2041 \fB\-\-delete\fP (which is implied) for more details on file-deletion.
2042 .IP "\fB\-\-delete-after\fP"
2043 Request that the file-deletions on the receiving side be done after the
2044 transfer has completed. This is useful if you are sending new
2045 per-directory merge files as a part of the transfer and you want their
2046 exclusions to take effect for the delete phase of the current transfer. It
2047 also forces rsync to use the old, non-incremental recursion algorithm that
2048 requires rsync to scan all the files in the transfer into memory at once
2049 (see \fB\-\-recursive\fP). See \fB\-\-delete\fP (which is implied) for
2050 more details on file-deletion.
2051 .IP
2052 See also the \fB\-\-delete-delay\fP option that might be a faster choice
2053 for those that just want the deletions to occur at the end of the transfer.
2054 .IP "\fB\-\-delete-excluded\fP"
2055 This option turns any unqualified exclude/include rules into server-side
2056 rules that do not affect the receiver's deletions.
2057 .IP
2058 By default, an exclude or include has both a server-side effect (to "hide"
2059 and "show" files when building the server's file list) and a receiver-side
2060 effect (to "protect" and "risk" files when deletions are occurring). Any
2061 rule that has no modifier to specify what sides it is executed on will be
2062 instead treated as if it were a server-side rule only, avoiding any
2063 "protect" effects of the rules.
2064 .IP
2065 A rule can still apply to both sides even with this option specified if the
2066 rule is given both the sender & receiver modifier letters (e.g., \fB\-f'\-sr\ foo'\fP). Receiver-side protect/risk rules can also be explicitly specified
2067 to limit the deletions. This saves you from having to edit a bunch of
2068 \fB\-f'\-\ foo'\fP rules into \fB\-f'\-s\ foo'\fP (aka \fB\-f'H\ foo'\fP) rules (not to mention
2069 the corresponding includes).
2070 .IP
2071 See the FILTER RULES section for more information. See
2072 \fB\-\-delete\fP (which is implied) for more details on deletion.
2073 .IP "\fB\-\-ignore-missing-args\fP"
2074 When rsync is first processing the explicitly requested source files (e.g.
2075 command-line arguments or \fB\-\-files-from\fP entries), it is normally
2076 an error if the file cannot be found. This option suppresses that error,
2077 and does not try to transfer the file. This does not affect subsequent
2078 vanished-file errors if a file was initially found to be present and later
2079 is no longer there.
2080 .IP "\fB\-\-delete-missing-args\fP"
2081 This option takes the behavior of the (implied)
2082 \fB\-\-ignore-missing-args\fP option a step farther: each missing arg
2083 will become a deletion request of the corresponding destination file on the
2084 receiving side (should it exist). If the destination file is a non-empty
2085 directory, it will only be successfully deleted if \fB\-\-force\fP or
2086 \fB\-\-delete\fP are in effect. Other than that, this option is
2087 independent of any other type of delete processing.
2088 .IP
2089 The missing source files are represented by special file-list entries which
2090 display as a "\fB*missing\fP" entry in the \fB\-\-list-only\fP output.
2091 .IP "\fB\-\-ignore-errors\fP"
2092 Tells \fB\-\-delete\fP to go ahead and delete files even when there are
2093 I/O errors.
2094 .IP "\fB\-\-force\fP"
2095 This option tells rsync to delete a non-empty directory when it is to be
2096 replaced by a non-directory. This is only relevant if deletions are not
2097 active (see \fB\-\-delete\fP for details).
2098 .IP
2099 Note for older rsync versions: \fB\-\-force\fP used to still be required when
2100 using \fB\-\-delete-after\fP, and it used to be non-functional unless the
2101 \fB\-\-recursive\fP option was also enabled.
2102 .IP "\fB\-\-max-delete=NUM\fP"
2103 This tells rsync not to delete more than NUM files or directories. If that
2104 limit is exceeded, all further deletions are skipped through the end of the
2105 transfer. At the end, rsync outputs a warning (including a count of the
2106 skipped deletions) and exits with an error code of 25 (unless some more
2107 important error condition also occurred).
2108 .IP
2109 Beginning with version 3.0.0, you may specify \fB\-\-max-delete=0\fP to be warned
2110 about any extraneous files in the destination without removing any of them.
2111 Older clients interpreted this as "unlimited", so if you don't know what
2112 version the client is, you can use the less obvious \fB\-\-max-delete=\-1\fP as a
2113 backward-compatible way to specify that no deletions be allowed (though
2114 really old versions didn't warn when the limit was exceeded).
2115 .IP "\fB\-\-max-size=SIZE\fP"
2116 This tells rsync to avoid transferring any file that is larger than the
2117 specified SIZE. A numeric value can be suffixed with a string to indicate
2118 the numeric units or left unqualified to specify bytes. Feel free to use a
2119 fractional value along with the units, such as \fB\-\-max-size=1.5m\fP.
2120 .IP
2121 This option is a TRANSFER RULE, so don't expect any
2122 exclude side effects.
2123 .IP
2124 The first letter of a units string can be \fBB\fP (bytes), \fBK\fP (kilo), \fBM\fP
2125 (mega), \fBG\fP (giga), \fBT\fP (tera), or \fBP\fP (peta). If the string is a single
2126 char or has "ib" added to it (e.g. "G" or "GiB") then the units are
2127 multiples of 1024. If you use a two-letter suffix that ends with a "B"
2128 (e.g. "kb") then you get units that are multiples of 1000. The string's
2129 letters can be any mix of upper and lower-case that you want to use.
2130 .IP
2131 Finally, if the string ends with either "+1" or "\-1", it is offset by one
2132 byte in the indicated direction. The largest possible value is usually
2133 \fB8192P-1\fP.
2134 .IP
2135 Examples: \fB\-\-max-size=1.5mb-1\fP is 1499999 bytes, and \fB\-\-max-size=2g+1\fP is
2136 2147483649 bytes.
2137 .IP
2138 Note that rsync versions prior to 3.1.0 did not allow \fB\-\-max-size=0\fP.
2139 .IP "\fB\-\-min-size=SIZE\fP"
2140 This tells rsync to avoid transferring any file that is smaller than the
2141 specified SIZE, which can help in not transferring small, junk files. See
2142 the \fB\-\-max-size\fP option for a description of SIZE and other info.
2143 .IP
2144 Note that rsync versions prior to 3.1.0 did not allow \fB\-\-min-size=0\fP.
2145 .IP "\fB\-\-max-alloc=SIZE\fP"
2146 By default rsync limits an individual malloc/realloc to about 1GB in size.
2147 For most people this limit works just fine and prevents a protocol error
2148 causing rsync to request massive amounts of memory. However, if you have
2149 many millions of files in a transfer, a large amount of server memory, and
2150 you don't want to split up your transfer into multiple parts, you can
2151 increase the per-allocation limit to something larger and rsync will
2152 consume more memory.
2153 .IP
2154 Keep in mind that this is not a limit on the total size of allocated
2155 memory. It is a sanity-check value for each individual allocation.
2156 .IP
2157 See the \fB\-\-max-size\fP option for a description of how SIZE can be
2158 specified. The default suffix if none is given is bytes.
2159 .IP
2160 Beginning in 3.2.7, a value of 0 is an easy way to specify SIZE_MAX (the
2161 largest limit possible).
2162 .IP
2163 You can set a default value using the environment variable
2164 \fBRSYNC_MAX_ALLOC\fP using the same SIZE values as supported by this
2165 option. If the remote rsync doesn't understand the \fB\-\-max-alloc\fP option,
2166 you can override an environmental value by specifying \fB\-\-max-alloc=1g\fP,
2167 which will make rsync avoid sending the option to the remote side (because
2168 "1G" is the default).
2169 .IP "\fB\-\-block-size=SIZE\fP, \fB\-B\fP"
2170 This forces the block size used in rsync's delta-transfer algorithm to a
2171 fixed value. It is normally selected based on the size of each file being
2172 updated. See the technical report for details.
2173 .IP
2174 Beginning in 3.2.3 the SIZE can be specified with a suffix as detailed in
2175 the \fB\-\-max-size\fP option. Older versions only accepted a byte count.
2176 .IP "\fB\-\-rsh=COMMAND\fP, \fB\-e\fP"
2177 This option allows you to choose an alternative remote shell program to use
2178 for communication between the local and remote copies of rsync. Typically,
2179 rsync is configured to use ssh by default, but you may prefer to use rsh on
2180 a local network.
2181 .IP
2182 If this option is used with \fB[user@]host::module/path\fP, then the remote
2183 shell \fICOMMAND\fP will be used to run an rsync daemon on the remote host, and
2184 all data will be transmitted through that remote shell connection, rather
2185 than through a direct socket connection to a running rsync daemon on the
2186 remote host. See the USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL
2187 CONNECTION section above.
2188 .IP
2189 Beginning with rsync 3.2.0, the \fBRSYNC_PORT\fP environment variable will
2190 be set when a daemon connection is being made via a remote-shell
2191 connection. It is set to 0 if the default daemon port is being assumed, or
2192 it is set to the value of the rsync port that was specified via either the
2193 \fB\-\-port\fP option or a non-empty port value in an \fBrsync://\fP URL.
2194 This allows the script to discern if a non-default port is being requested,
2195 allowing for things such as an SSL or stunnel helper script to connect to a
2196 default or alternate port.
2197 .IP
2198 Command-line arguments are permitted in COMMAND provided that COMMAND is
2199 presented to rsync as a single argument. You must use spaces (not tabs or
2200 other whitespace) to separate the command and args from each other, and you
2201 can use single- and/or double-quotes to preserve spaces in an argument (but
2202 not backslashes). Note that doubling a single-quote inside a single-quoted
2203 string gives you a single-quote; likewise for double-quotes (though you
2204 need to pay attention to which quotes your shell is parsing and which
2205 quotes rsync is parsing). Some examples:
2206 .RS 4
2207 .IP
2208 .nf
2209 -e 'ssh -p 2234'
2210 -e 'ssh -o "ProxyCommand nohup ssh firewall nc -w1 %h %p"'
2211 .fi
2212 .RE
2213 .IP
2214 (Note that ssh users can alternately customize site-specific connect
2215 options in their .ssh/config file.)
2216 .IP
2217 You can also choose the remote shell program using the \fBRSYNC_RSH\fP
2218 environment variable, which accepts the same range of values as \fB\-e\fP.
2219 .IP
2220 See also the \fB\-\-blocking-io\fP option which is affected by this
2221 option.
2222 .IP "\fB\-\-rsync-path=PROGRAM\fP"
2223 Use this to specify what program is to be run on the remote machine to
2224 start-up rsync. Often used when rsync is not in the default remote-shell's
2225 path (e.g. \fB\-\-rsync-path=/usr/local/bin/rsync\fP). Note that PROGRAM is run
2226 with the help of a shell, so it can be any program, script, or command
2227 sequence you'd care to run, so long as it does not corrupt the standard-in
2228 & standard-out that rsync is using to communicate.
2229 .IP
2230 One tricky example is to set a different default directory on the remote
2231 machine for use with the \fB\-\-relative\fP option. For instance:
2232 .RS 4
2233 .IP
2234 .nf
2235 rsync -avR --rsync-path="cd /a/b && rsync" host:c/d /e/
2236 .fi
2237 .RE
2238 .IP "\fB\-\-remote-option=OPTION\fP, \fB\-M\fP"
2239 This option is used for more advanced situations where you want certain
2240 effects to be limited to one side of the transfer only. For instance, if
2241 you want to pass \fB\-\-log-file=FILE\fP and \fB\-\-fake-super\fP to
2242 the remote system, specify it like this:
2243 .RS 4
2244 .IP
2245 .nf
2246 rsync -av -M --log-file=foo -M--fake-super src/ dest/
2247 .fi
2248 .RE
2249 .IP
2250 If you want to have an option affect only the local side of a transfer when
2251 it normally affects both sides, send its negation to the remote side. Like
2252 this:
2253 .RS 4
2254 .IP
2255 .nf
2256 rsync -av -x -M--no-x src/ dest/
2257 .fi
2258 .RE
2259 .IP
2260 Be cautious using this, as it is possible to toggle an option that will
2261 cause rsync to have a different idea about what data to expect next over
2262 the socket, and that will make it fail in a cryptic fashion.
2263 .IP
2264 Note that you should use a separate \fB\-M\fP option for each remote option you
2265 want to pass. On older rsync versions, the presence of any spaces in the
2266 remote-option arg could cause it to be split into separate remote args, but
2267 this requires the use of \fB\-\-old-args\fP in a modern rsync.
2268 .IP
2269 When performing a local transfer, the "local" side is the sender and the
2270 "remote" side is the receiver.
2271 .IP
2272 Note some versions of the popt option-parsing library have a bug in them
2273 that prevents you from using an adjacent arg with an equal in it next to a
2274 short option letter (e.g. \fB\-M\-\-log-file=/tmp/foo\fP). If this bug affects
2275 your version of popt, you can use the version of popt that is included with
2276 rsync.
2277 .IP "\fB\-\-cvs-exclude\fP, \fB\-C\fP"
2278 This is a useful shorthand for excluding a broad range of files that you
2279 often don't want to transfer between systems. It uses a similar algorithm
2280 to CVS to determine if a file should be ignored.
2281 .IP
2282 The exclude list is initialized to exclude the following items (these
2283 initial items are marked as perishable\ \-\- see the FILTER RULES
2284 section):
2285 .RS 4
2286 .IP
2287 \fBRCS\fP
2288 \fBSCCS\fP
2289 \fBCVS\fP
2290 \fBCVS.adm\fP
2291 \fBRCSLOG\fP
2292 \fBcvslog.*\fP
2293 \fBtags\fP
2294 \fBTAGS\fP
2295 \fB.make.state\fP
2296 \fB.nse_depinfo\fP
2297 \fB*~\fP
2298 \fB#*\fP
2299 \fB.#*\fP
2300 \fB,*\fP
2301 \fB_$*\fP
2302 \fB*$\fP
2303 \fB*.old\fP
2304 \fB*.bak\fP
2305 \fB*.BAK\fP
2306 \fB*.orig\fP
2307 \fB*.rej\fP
2308 \fB.del-*\fP
2309 \fB*.a\fP
2310 \fB*.olb\fP
2311 \fB*.o\fP
2312 \fB*.obj\fP
2313 \fB*.so\fP
2314 \fB*.exe\fP
2315 \fB*.Z\fP
2316 \fB*.elc\fP
2317 \fB*.ln\fP
2318 \fBcore\fP
2319 \fB.svn/\fP
2320 \fB.git/\fP
2321 \fB.hg/\fP
2322 \fB.bzr/\fP
2323 .RE
2324 .IP
2325 then, files listed in a $HOME/.cvsignore are added to the list and any
2326 files listed in the CVSIGNORE environment variable (all cvsignore names are
2327 delimited by whitespace).
2328 .IP
2329 Finally, any file is ignored if it is in the same directory as a .cvsignore
2330 file and matches one of the patterns listed therein. Unlike rsync's
2331 filter/exclude files, these patterns are split on whitespace. See the
2332 \fBcvs\fP(1) manual for more information.
2333 .IP
2334 If you're combining \fB\-C\fP with your own \fB\-\-filter\fP rules, you should
2335 note that these CVS excludes are appended at the end of your own rules,
2336 regardless of where the \fB\-C\fP was placed on the command-line. This makes
2337 them a lower priority than any rules you specified explicitly. If you want
2338 to control where these CVS excludes get inserted into your filter rules,
2339 you should omit the \fB\-C\fP as a command-line option and use a combination of
2340 \fB\-\-filter=:C\fP and \fB\-\-filter=\-C\fP (either on your
2341 command-line or by putting the ":C" and "\-C" rules into a filter file with
2342 your other rules). The first option turns on the per-directory scanning
2343 for the .cvsignore file. The second option does a one-time import of the
2344 CVS excludes mentioned above.
2345 .IP "\fB\-\-filter=RULE\fP, \fB\-f\fP"
2346 This option allows you to add rules to selectively exclude certain files
2347 from the list of files to be transferred. This is most useful in
2348 combination with a recursive transfer.
2349 .IP
2350 You may use as many \fB\-\-filter\fP options on the command line as you like to
2351 build up the list of files to exclude. If the filter contains whitespace,
2352 be sure to quote it so that the shell gives the rule to rsync as a single
2353 argument. The text below also mentions that you can use an underscore to
2354 replace the space that separates a rule from its arg.
2355 .IP
2356 See the FILTER RULES section for detailed information on this option.
2357 .IP "\fB\-F\fP"
2358 The \fB\-F\fP option is a shorthand for adding two \fB\-\-filter\fP rules to
2359 your command. The first time it is used is a shorthand for this rule:
2360 .RS 4
2361 .IP
2362 .nf
2363 --filter='dir-merge /.rsync-filter'
2364 .fi
2365 .RE
2366 .IP
2367 This tells rsync to look for per-directory .rsync-filter files that have
2368 been sprinkled through the hierarchy and use their rules to filter the
2369 files in the transfer. If \fB\-F\fP is repeated, it is a shorthand for this
2370 rule:
2371 .RS 4
2372 .IP
2373 .nf
2374 --filter='exclude .rsync-filter'
2375 .fi
2376 .RE
2377 .IP
2378 This filters out the .rsync-filter files themselves from the transfer.
2379 .IP
2380 See the FILTER RULES section for detailed information on how these
2381 options work.
2382 .IP "\fB\-\-exclude=PATTERN\fP"
2383 This option is a simplified form of the \fB\-\-filter\fP option that
2384 specifies an exclude rule and does not allow the full rule-parsing syntax
2385 of normal filter rules. This is equivalent to specifying \fB\-f'\-\ PATTERN'\fP.
2386 .IP
2387 See the FILTER RULES section for detailed information on this option.
2388 .IP "\fB\-\-exclude-from=FILE\fP"
2389 This option is related to the \fB\-\-exclude\fP option, but it specifies
2390 a FILE that contains exclude patterns (one per line). Blank lines in the
2391 file are ignored, as are whole-line comments that start with '\fB;\fP' or '\fB#\fP'
2392 (filename rules that contain those characters are unaffected).
2393 .IP
2394 If a line begins with "\fB\-\ \fP" (dash, space) or "\fB+\ \fP" (plus, space), then
2395 the type of rule is being explicitly specified as an exclude or an include
2396 (respectively). Any rules without such a prefix are taken to be an exclude.
2397 .IP
2398 If a line consists of just "\fB!\fP", then the current filter rules are cleared
2399 before adding any further rules.
2400 .IP
2401 If \fIFILE\fP is '\fB\-\fP', the list will be read from standard input.
2402 .IP "\fB\-\-include=PATTERN\fP"
2403 This option is a simplified form of the \fB\-\-filter\fP option that
2404 specifies an include rule and does not allow the full rule-parsing syntax
2405 of normal filter rules. This is equivalent to specifying \fB\-f'+\ PATTERN'\fP.
2406 .IP
2407 See the FILTER RULES section for detailed information on this option.
2408 .IP "\fB\-\-include-from=FILE\fP"
2409 This option is related to the \fB\-\-include\fP option, but it specifies
2410 a FILE that contains include patterns (one per line). Blank lines in the
2411 file are ignored, as are whole-line comments that start with '\fB;\fP' or '\fB#\fP'
2412 (filename rules that contain those characters are unaffected).
2413 .IP
2414 If a line begins with "\fB\-\ \fP" (dash, space) or "\fB+\ \fP" (plus, space), then
2415 the type of rule is being explicitly specified as an exclude or an include
2416 (respectively). Any rules without such a prefix are taken to be an include.
2417 .IP
2418 If a line consists of just "\fB!\fP", then the current filter rules are cleared
2419 before adding any further rules.
2420 .IP
2421 If \fIFILE\fP is '\fB\-\fP', the list will be read from standard input.
2422 .IP "\fB\-\-files-from=FILE\fP"
2423 Using this option allows you to specify the exact list of files to transfer
2424 (as read from the specified FILE or '\fB\-\fP' for standard input). It also
2425 tweaks the default behavior of rsync to make transferring just the
2426 specified files and directories easier:
2427 .IP
2428 .RS
2429 .IP o
2430 The \fB\-\-relative\fP (\fB\-R\fP) option is implied, which preserves the
2431 path information that is specified for each item in the file (use
2432 \fB\-\-no-relative\fP or \fB\-\-no-R\fP if you want to turn that off).
2433 .IP o
2434 The \fB\-\-dirs\fP (\fB\-d\fP) option is implied, which will create
2435 directories specified in the list on the destination rather than noisily
2436 skipping them (use \fB\-\-no-dirs\fP or \fB\-\-no-d\fP if you want to turn that off).
2437 .IP o
2438 The \fB\-\-archive\fP (\fB\-a\fP) option's behavior does not imply
2439 \fB\-\-recursive\fP (\fB\-r\fP), so specify it explicitly, if you want it.
2440 .IP o
2441 These side-effects change the default state of rsync, so the position of
2442 the \fB\-\-files-from\fP option on the command-line has no bearing on how other
2443 options are parsed (e.g. \fB\-a\fP works the same before or after
2444 \fB\-\-files-from\fP, as does \fB\-\-no-R\fP and all other options).
2445 .RE
2446 .IP
2447 The filenames that are read from the FILE are all relative to the source
2448 dir\ \-\- any leading slashes are removed and no ".." references are allowed
2449 to go higher than the source dir. For example, take this command:
2450 .RS 4
2451 .IP
2452 .nf
2453 rsync -a --files-from=/tmp/foo /usr remote:/backup
2454 .fi
2455 .RE
2456 .IP
2457 If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin
2458 directory will be created as /backup/bin on the remote host. If it
2459 contains "bin/" (note the trailing slash), the immediate contents of the
2460 directory would also be sent (without needing to be explicitly mentioned in
2461 the file\ \-\- this began in version 2.6.4). In both cases, if the
2462 \fB\-r\fP option was enabled, that dir's entire hierarchy would also be
2463 transferred (keep in mind that \fB\-r\fP needs to be specified
2464 explicitly with \fB\-\-files-from\fP, since it is not implied by \fB\-a\fP.
2465 Also note that the effect of the (enabled by default) \fB\-r\fP option
2466 is to duplicate only the path info that is read from the file\ \-\- it does
2467 not force the duplication of the source-spec path (/usr in this case).
2468 .IP
2469 In addition, the \fB\-\-files-from\fP file can be read from the remote host
2470 instead of the local host if you specify a "host:" in front of the file
2471 (the host must match one end of the transfer). As a short-cut, you can
2472 specify just a prefix of ":" to mean "use the remote end of the transfer".
2473 For example:
2474 .RS 4
2475 .IP
2476 .nf
2477 rsync -a --files-from=:/path/file-list src:/ /tmp/copy
2478 .fi
2479 .RE
2480 .IP
2481 This would copy all the files specified in the /path/file-list file that
2482 was located on the remote "src" host.
2483 .IP
2484 If the \fB\-\-iconv\fP and \fB\-\-secluded-args\fP options are specified
2485 and the \fB\-\-files-from\fP filenames are being sent from one host to another,
2486 the filenames will be translated from the sending host's charset to the
2487 receiving host's charset.
2488 .IP
2489 NOTE: sorting the list of files in the \fB\-\-files-from\fP input helps rsync to
2490 be more efficient, as it will avoid re-visiting the path elements that are
2491 shared between adjacent entries. If the input is not sorted, some path
2492 elements (implied directories) may end up being scanned multiple times, and
2493 rsync will eventually unduplicate them after they get turned into file-list
2494 elements.
2495 .IP "\fB\-\-from0\fP, \fB\-0\fP"
2496 This tells rsync that the rules/filenames it reads from a file are
2497 terminated by a null ('\\0') character, not a NL, CR, or CR+LF. This
2498 affects \fB\-\-exclude-from\fP, \fB\-\-include-from\fP,
2499 \fB\-\-files-from\fP, and any merged files specified in a
2500 \fB\-\-filter\fP rule. It does not affect \fB\-\-cvs-exclude\fP (since
2501 all names read from a .cvsignore file are split on whitespace).
2502 .IP "\fB\-\-old-args\fP"
2503 This option tells rsync to stop trying to protect the arg values on the
2504 remote side from unintended word-splitting or other misinterpretation.
2505 It also allows the client to treat an empty arg as a "." instead of
2506 generating an error.
2507 .IP
2508 The default in a modern rsync is for "shell-active" characters (including
2509 spaces) to be backslash-escaped in the args that are sent to the remote
2510 shell. The wildcard characters \fB*\fP, \fB?\fP, \fB[\fP, & \fB]\fP are not escaped in
2511 filename args (allowing them to expand into multiple filenames) while being
2512 protected in option args, such as \fB\-\-usermap\fP.
2513 .IP
2514 If you have a script that wants to use old-style arg splitting in its
2515 filenames, specify this option once. If the remote shell has a problem
2516 with any backslash escapes at all, specify this option twice.
2517 .IP
2518 You may also control this setting via the \fBRSYNC_OLD_ARGS\fP environment
2519 variable. If it has the value "1", rsync will default to a single-option
2520 setting. If it has the value "2" (or more), rsync will default to a
2521 repeated-option setting. If it is "0", you'll get the default escaping
2522 behavior. The environment is always overridden by manually specified
2523 positive or negative options (the negative is \fB\-\-no-old-args\fP).
2524 .IP
2525 Note that this option also disables the extra safety check added in 3.2.5
2526 that ensures that a remote sender isn't including extra top-level items in
2527 the file-list that you didn't request. This side-effect is necessary
2528 because we can't know for sure what names to expect when the remote shell
2529 is interpreting the args.
2530 .IP
2531 This option conflicts with the \fB\-\-secluded-args\fP option.
2532 .IP "\fB\-\-secluded-args\fP, \fB\-s\fP"
2533 This option sends all filenames and most options to the remote rsync via
2534 the protocol (not the remote shell command line) which avoids letting the
2535 remote shell modify them. Wildcards are expanded on the remote host by
2536 rsync instead of a shell.
2537 .IP
2538 This is similar to the default backslash-escaping of args that was added
2539 in 3.2.4 (see \fB\-\-old-args\fP) in that it prevents things like space
2540 splitting and unwanted special-character side-effects. However, it has the
2541 drawbacks of being incompatible with older rsync versions (prior to 3.0.0)
2542 and of being refused by restricted shells that want to be able to inspect
2543 all the option values for safety.
2544 .IP
2545 This option is useful for those times that you need the argument's
2546 character set to be converted for the remote host, if the remote shell is
2547 incompatible with the default backslash-escpaing method, or there is some
2548 other reason that you want the majority of the options and arguments to
2549 bypass the command-line of the remote shell.
2550 .IP
2551 If you combine this option with \fB\-\-iconv\fP, the args related to the
2552 remote side will be translated from the local to the remote character-set.
2553 The translation happens before wild-cards are expanded. See also the
2554 \fB\-\-files-from\fP option.
2555 .IP
2556 You may also control this setting via the \fBRSYNC_PROTECT_ARGS\fP
2557 environment variable. If it has a non-zero value, this setting will be
2558 enabled by default, otherwise it will be disabled by default. Either state
2559 is overridden by a manually specified positive or negative version of this
2560 option (note that \fB\-\-no-s\fP and \fB\-\-no-secluded-args\fP are the negative
2561 versions). This environment variable is also superseded by a non-zero
2562 \fBRSYNC_OLD_ARGS\fP export.
2563 .IP
2564 This option conflicts with the \fB\-\-old-args\fP option.
2565 .IP
2566 This option used to be called \fB\-\-protect-args\fP (before 3.2.6) and that
2567 older name can still be used (though specifying it as \fB\-s\fP is always the
2568 easiest and most compatible choice).
2569 .IP "\fB\-\-trust-sender\fP"
2570 This option disables two extra validation checks that a local client
2571 performs on the file list generated by a remote sender. This option should
2572 only be used if you trust the sender to not put something malicious in the
2573 file list (something that could possibly be done via a modified rsync, a
2574 modified shell, or some other similar manipulation).
2575 .IP
2576 Normally, the rsync client (as of version 3.2.5) runs two extra validation
2577 checks when pulling files from a remote rsync:
2578 .IP
2579 .RS
2580 .IP o
2581 It verifies that additional arg items didn't get added at the top of the
2582 transfer.
2583 .IP o
2584 It verifies that none of the items in the file list are names that should
2585 have been excluded (if filter rules were specified).
2586 .RE
2587 .IP
2588 Note that various options can turn off one or both of these checks if the
2589 option interferes with the validation. For instance:
2590 .IP
2591 .RS
2592 .IP o
2593 Using a per-directory filter file reads filter rules that only the server
2594 knows about, so the filter checking is disabled.
2595 .IP o
2596 Using the \fB\-\-old-args\fP option allows the sender to manipulate the
2597 requested args, so the arg checking is disabled.
2598 .IP o
2599 Reading the files-from list from the server side means that the client
2600 doesn't know the arg list, so the arg checking is disabled.
2601 .IP o
2602 Using \fB\-\-read-batch\fP disables both checks since the batch file's
2603 contents will have been verified when it was created.
2604 .RE
2605 .IP
2606 This option may help an under-powered client server if the extra pattern
2607 matching is slowing things down on a huge transfer. It can also be used to
2608 work around a currently-unknown bug in the verification logic for a transfer
2609 from a trusted sender.
2610 .IP
2611 When using this option it is a good idea to specify a dedicated destination
2612 directory, as discussed in the MULTI-HOST SECURITY section.
2613 .IP "\fB\-\-copy-as=USER[:GROUP]\fP"
2614 This option instructs rsync to use the USER and (if specified after a
2615 colon) the GROUP for the copy operations. This only works if the user that
2616 is running rsync has the ability to change users. If the group is not
2617 specified then the user's default groups are used.
2618 .IP
2619 This option can help to reduce the risk of an rsync being run as root into
2620 or out of a directory that might have live changes happening to it and you
2621 want to make sure that root-level read or write actions of system files are
2622 not possible. While you could alternatively run all of rsync as the
2623 specified user, sometimes you need the root-level host-access credentials
2624 to be used, so this allows rsync to drop root for the copying part of the
2625 operation after the remote-shell or daemon connection is established.
2626 .IP
2627 The option only affects one side of the transfer unless the transfer is
2628 local, in which case it affects both sides. Use the
2629 \fB\-\-remote-option\fP to affect the remote side, such as
2630 \fB\-M\-\-copy-as=joe\fP. For a local transfer, the lsh (or lsh.sh) support file
2631 provides a local-shell helper script that can be used to allow a
2632 "localhost:" or "lh:" host-spec to be specified without needing to setup
2633 any remote shells, allowing you to specify remote options that affect the
2634 side of the transfer that is using the host-spec (and using hostname "lh"
2635 avoids the overriding of the remote directory to the user's home dir).
2636 .IP
2637 For example, the following rsync writes the local files as user "joe":
2638 .RS 4
2639 .IP
2640 .nf
2641 sudo rsync -aiv --copy-as=joe host1:backups/joe/ /home/joe/
2642 .fi
2643 .RE
2644 .IP
2645 This makes all files owned by user "joe", limits the groups to those that
2646 are available to that user, and makes it impossible for the joe user to do
2647 a timed exploit of the path to induce a change to a file that the joe user
2648 has no permissions to change.
2649 .IP
2650 The following command does a local copy into the "dest/" dir as user "joe"
2651 (assuming you've installed support/lsh into a dir on your $PATH):
2652 .RS 4
2653 .IP
2654 .nf
2655 sudo rsync -aive lsh -M--copy-as=joe src/ lh:dest/
2656 .fi
2657 .RE
2658 .IP "\fB\-\-temp-dir=DIR\fP, \fB\-T\fP"
2659 This option instructs rsync to use DIR as a scratch directory when creating
2660 temporary copies of the files transferred on the receiving side. The
2661 default behavior is to create each temporary file in the same directory as
2662 the associated destination file. Beginning with rsync 3.1.1, the temp-file
2663 names inside the specified DIR will not be prefixed with an extra dot
2664 (though they will still have a random suffix added).
2665 .IP
2666 This option is most often used when the receiving disk partition does not
2667 have enough free space to hold a copy of the largest file in the transfer.
2668 In this case (i.e. when the scratch directory is on a different disk
2669 partition), rsync will not be able to rename each received temporary file
2670 over the top of the associated destination file, but instead must copy it
2671 into place. Rsync does this by copying the file over the top of the
2672 destination file, which means that the destination file will contain
2673 truncated data during this copy. If this were not done this way (even if
2674 the destination file were first removed, the data locally copied to a
2675 temporary file in the destination directory, and then renamed into place)
2676 it would be possible for the old file to continue taking up disk space (if
2677 someone had it open), and thus there might not be enough room to fit the
2678 new version on the disk at the same time.
2679 .IP
2680 If you are using this option for reasons other than a shortage of disk
2681 space, you may wish to combine it with the \fB\-\-delay-updates\fP
2682 option, which will ensure that all copied files get put into subdirectories
2683 in the destination hierarchy, awaiting the end of the transfer. If you
2684 don't have enough room to duplicate all the arriving files on the
2685 destination partition, another way to tell rsync that you aren't overly
2686 concerned about disk space is to use the \fB\-\-partial-dir\fP option
2687 with a relative path; because this tells rsync that it is OK to stash off a
2688 copy of a single file in a subdir in the destination hierarchy, rsync will
2689 use the partial-dir as a staging area to bring over the copied file, and
2690 then rename it into place from there. (Specifying a \fB\-\-partial-dir\fP
2691 with an absolute path does not have this side-effect.)
2692 .IP "\fB\-\-fuzzy\fP, \fB\-y\fP"
2693 This option tells rsync that it should look for a basis file for any
2694 destination file that is missing. The current algorithm looks in the same
2695 directory as the destination file for either a file that has an identical
2696 size and modified-time, or a similarly-named file. If found, rsync uses
2697 the fuzzy basis file to try to speed up the transfer.
2698 .IP
2699 If the option is repeated, the fuzzy scan will also be done in any matching
2700 alternate destination directories that are specified via
2701 \fB\-\-compare-dest\fP, \fB\-\-copy-dest\fP, or \fB\-\-link-dest\fP.
2702 .IP
2703 Note that the use of the \fB\-\-delete\fP option might get rid of any
2704 potential fuzzy-match files, so either use \fB\-\-delete-after\fP or
2705 specify some filename exclusions if you need to prevent this.
2706 .IP "\fB\-\-compare-dest=DIR\fP"
2707 This option instructs rsync to use \fIDIR\fP on the destination machine as an
2708 additional hierarchy to compare destination files against doing transfers
2709 (if the files are missing in the destination directory). If a file is
2710 found in \fIDIR\fP that is identical to the sender's file, the file will NOT be
2711 transferred to the destination directory. This is useful for creating a
2712 sparse backup of just files that have changed from an earlier backup. This
2713 option is typically used to copy into an empty (or newly created)
2714 directory.
2715 .IP
2716 Beginning in version 2.6.4, multiple \fB\-\-compare-dest\fP directories may be
2717 provided, which will cause rsync to search the list in the order specified
2718 for an exact match. If a match is found that differs only in attributes, a
2719 local copy is made and the attributes updated. If a match is not found, a
2720 basis file from one of the \fIDIRs\fP will be selected to try to speed up the
2721 transfer.
2722 .IP
2723 If \fIDIR\fP is a relative path, it is relative to the destination directory.
2724 See also \fB\-\-copy-dest\fP and \fB\-\-link-dest\fP.
2725 .IP
2726 NOTE: beginning with version 3.1.0, rsync will remove a file from a
2727 non-empty destination hierarchy if an exact match is found in one of the
2728 compare-dest hierarchies (making the end result more closely match a fresh
2729 copy).
2730 .IP "\fB\-\-copy-dest=DIR\fP"
2731 This option behaves like \fB\-\-compare-dest\fP, but rsync will also copy
2732 unchanged files found in \fIDIR\fP to the destination directory using a local
2733 copy. This is useful for doing transfers to a new destination while
2734 leaving existing files intact, and then doing a flash-cutover when all
2735 files have been successfully transferred.
2736 .IP
2737 Multiple \fB\-\-copy-dest\fP directories may be provided, which will cause rsync
2738 to search the list in the order specified for an unchanged file. If a
2739 match is not found, a basis file from one of the \fIDIRs\fP will be selected to
2740 try to speed up the transfer.
2741 .IP
2742 If \fIDIR\fP is a relative path, it is relative to the destination directory.
2743 See also \fB\-\-compare-dest\fP and \fB\-\-link-dest\fP.
2744 .IP "\fB\-\-link-dest=DIR\fP"
2745 This option behaves like \fB\-\-copy-dest\fP, but unchanged files are
2746 hard linked from \fIDIR\fP to the destination directory. The files must be
2747 identical in all preserved attributes (e.g. permissions, possibly
2748 ownership) in order for the files to be linked together. An example:
2749 .RS 4
2750 .IP
2751 .nf
2752 rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/
2753 .fi
2754 .RE
2755 .IP
2756 If files aren't linking, double-check their attributes. Also check if
2757 some attributes are getting forced outside of rsync's control, such a mount
2758 option that squishes root to a single user, or mounts a removable drive
2759 with generic ownership (such as OS X's "Ignore ownership on this volume"
2760 option).
2761 .IP
2762 Beginning in version 2.6.4, multiple \fB\-\-link-dest\fP directories may be
2763 provided, which will cause rsync to search the list in the order specified
2764 for an exact match (there is a limit of 20 such directories). If a match
2765 is found that differs only in attributes, a local copy is made and the
2766 attributes updated. If a match is not found, a basis file from one of the
2767 \fIDIRs\fP will be selected to try to speed up the transfer.
2768 .IP
2769 This option works best when copying into an empty destination hierarchy, as
2770 existing files may get their attributes tweaked, and that can affect
2771 alternate destination files via hard-links. Also, itemizing of changes can
2772 get a bit muddled. Note that prior to version 3.1.0, an
2773 alternate-directory exact match would never be found (nor linked into the
2774 destination) when a destination file already exists.
2775 .IP
2776 Note that if you combine this option with \fB\-\-ignore-times\fP, rsync will not
2777 link any files together because it only links identical files together as a
2778 substitute for transferring the file, never as an additional check after
2779 the file is updated.
2780 .IP
2781 If \fIDIR\fP is a relative path, it is relative to the destination directory.
2782 See also \fB\-\-compare-dest\fP and \fB\-\-copy-dest\fP.
2783 .IP
2784 Note that rsync versions prior to 2.6.1 had a bug that could prevent
2785 \fB\-\-link-dest\fP from working properly for a non-super-user when
2786 \fB\-\-owner\fP (\fB\-o\fP) was specified (or implied). You can work-around
2787 this bug by avoiding the \fB\-o\fP option (or using \fB\-\-no-o\fP) when sending to an
2788 old rsync.
2789 .IP "\fB\-\-compress\fP, \fB\-z\fP"
2790 With this option, rsync compresses the file data as it is sent to the
2791 destination machine, which reduces the amount of data being transmitted\ \-\-
2792 something that is useful over a slow connection.
2793 .IP
2794 Rsync supports multiple compression methods and will choose one for you
2795 unless you force the choice using the \fB\-\-compress-choice\fP (\fB\-\-zc\fP)
2796 option.
2797 .IP
2798 Run \fBrsync\ \-\-version\fP to see the default compress list compiled into your
2799 version.
2800 .IP
2801 When both sides of the transfer are at least 3.2.0, rsync chooses the first
2802 algorithm in the client's list of choices that is also in the server's list
2803 of choices. If no common compress choice is found, rsync exits with
2804 an error. If the remote rsync is too old to support checksum negotiation,
2805 its list is assumed to be "zlib".
2806 .IP
2807 The default order can be customized by setting the environment variable
2808 \fBRSYNC_COMPRESS_LIST\fP to a space-separated list of acceptable
2809 compression names. If the string contains a "\fB&\fP" character, it is
2810 separated into the "client string & server string", otherwise the same
2811 string applies to both. If the string (or string portion) contains no
2812 non-whitespace characters, the default compress list is used. Any unknown
2813 compression names are discarded from the list, but a list with only invalid
2814 names results in a failed negotiation.
2815 .IP
2816 There are some older rsync versions that were configured to reject a \fB\-z\fP
2817 option and require the use of \fB\-zz\fP because their compression library was
2818 not compatible with the default zlib compression method. You can usually
2819 ignore this weirdness unless the rsync server complains and tells you to
2820 specify \fB\-zz\fP.
2821 .IP "\fB\-\-compress-choice=STR\fP, \fB\-\-zc=STR\fP"
2822 This option can be used to override the automatic negotiation of the
2823 compression algorithm that occurs when \fB\-\-compress\fP is used. The
2824 option implies \fB\-\-compress\fP unless "none" was specified, which
2825 instead implies \fB\-\-no-compress\fP.
2826 .IP
2827 The compression options that you may be able to use are:
2828 .IP
2829 .RS
2830 .IP o
2831 \fBzstd\fP
2832 .IP o
2833 \fBlz4\fP
2834 .IP o
2835 \fBzlibx\fP
2836 .IP o
2837 \fBzlib\fP
2838 .IP o
2839 \fBnone\fP
2840 .RE
2841 .IP
2842 Run \fBrsync\ \-\-version\fP to see the default compress list compiled into your
2843 version (which may differ from the list above).
2844 .IP
2845 Note that if you see an error about an option named \fB\-\-old-compress\fP or
2846 \fB\-\-new-compress\fP, this is rsync trying to send the \fB\-\-compress-choice=zlib\fP
2847 or \fB\-\-compress-choice=zlibx\fP option in a backward-compatible manner that
2848 more rsync versions understand. This error indicates that the older rsync
2849 version on the server will not allow you to force the compression type.
2850 .IP
2851 Note that the "zlibx" compression algorithm is just the "zlib" algorithm
2852 with matched data excluded from the compression stream (to try to make it
2853 more compatible with an external zlib implementation).
2854 .IP "\fB\-\-compress-level=NUM\fP, \fB\-\-zl=NUM\fP"
2855 Explicitly set the compression level to use (see \fB\-\-compress\fP,
2856 \fB\-z\fP) instead of letting it default. The \fB\-\-compress\fP option is
2857 implied as long as the level chosen is not a "don't compress" level for the
2858 compression algorithm that is in effect (e.g. zlib compression treats level
2859 0 as "off").
2860 .IP
2861 The level values vary depending on the checksum in effect. Because rsync
2862 will negotiate a checksum choice by default (when the remote rsync is new
2863 enough), it can be good to combine this option with a
2864 \fB\-\-compress-choice\fP (\fB\-\-zc\fP) option unless you're sure of the
2865 choice in effect. For example:
2866 .RS 4
2867 .IP
2868 .nf
2869 rsync -aiv --zc=zstd --zl=22 host:src/ dest/
2870 .fi
2871 .RE
2872 .IP
2873 For zlib & zlibx compression the valid values are from 1 to 9 with 6 being
2874 the default. Specifying \fB\-\-zl=0\fP turns compression off, and specifying
2875 \fB\-\-zl=\-1\fP chooses the default level of 6.
2876 .IP
2877 For zstd compression the valid values are from \-131072 to 22 with 3 being
2878 the default. Specifying 0 chooses the default of 3.
2879 .IP
2880 For lz4 compression there are no levels, so the value is always 0.
2881 .IP
2882 If you specify a too-large or too-small value, the number is silently
2883 limited to a valid value. This allows you to specify something like
2884 \fB\-\-zl=999999999\fP and be assured that you'll end up with the maximum
2885 compression level no matter what algorithm was chosen.
2886 .IP
2887 If you want to know the compression level that is in effect, specify
2888 \fB\-\-debug=nstr\fP to see the "negotiated string" results. This will
2889 report something like "\fBClient\ compress:\ zstd\ (level\ 3)\fP" (along with the
2890 checksum choice in effect).
2891 .IP "\fB\-\-skip-compress=LIST\fP"
2892 \fBNOTE:\fP no compression method currently supports per-file compression
2893 changes, so this option has no effect.
2894 .IP
2895 Override the list of file suffixes that will be compressed as little as
2896 possible. Rsync sets the compression level on a per-file basis based on
2897 the file's suffix. If the compression algorithm has an "off" level, then
2898 no compression occurs for those files. Other algorithms that support
2899 changing the streaming level on-the-fly will have the level minimized to
2900 reduces the CPU usage as much as possible for a matching file.
2901 .IP
2902 The \fBLIST\fP should be one or more file suffixes (without the dot) separated
2903 by slashes (\fB/\fP). You may specify an empty string to indicate that no files
2904 should be skipped.
2905 .IP
2906 Simple character-class matching is supported: each must consist of a list
2907 of letters inside the square brackets (e.g. no special classes, such as
2908 "[:alpha:]", are supported, and '\-' has no special meaning).
2909 .IP
2910 The characters asterisk (\fB*\fP) and question-mark (\fB?\fP) have no special meaning.
2911 .IP
2912 Here's an example that specifies 6 suffixes to skip (since 1 of the 5 rules
2913 matches 2 suffixes):
2914 .RS 4
2915 .IP
2916 .nf
2917 --skip-compress=gz/jpg/mp[34]/7z/bz2
2918 .fi
2919 .RE
2920 .IP
2921 The default file suffixes in the skip-compress list in this version of
2922 rsync are:
2923 .RS 4
2924 .IP
2925 3g2
2926 3gp
2927 7z
2928 aac
2929 ace
2930 apk
2931 avi
2932 bz2
2933 deb
2934 dmg
2935 ear
2936 f4v
2937 flac
2938 flv
2939 gpg
2940 gz
2941 iso
2942 jar
2943 jpeg
2944 jpg
2945 lrz
2946 lz
2947 lz4
2948 lzma
2949 lzo
2950 m1a
2951 m1v
2952 m2a
2953 m2ts
2954 m2v
2955 m4a
2956 m4b
2957 m4p
2958 m4r
2959 m4v
2960 mka
2961 mkv
2962 mov
2963 mp1
2964 mp2
2965 mp3
2966 mp4
2967 mpa
2968 mpeg
2969 mpg
2970 mpv
2971 mts
2972 odb
2973 odf
2974 odg
2975 odi
2976 odm
2977 odp
2978 ods
2979 odt
2980 oga
2981 ogg
2982 ogm
2983 ogv
2984 ogx
2985 opus
2986 otg
2987 oth
2988 otp
2989 ots
2990 ott
2991 oxt
2992 png
2993 qt
2994 rar
2995 rpm
2996 rz
2997 rzip
2998 spx
2999 squashfs
3000 sxc
3001 sxd
3002 sxg
3003 sxm
3004 sxw
3005 sz
3006 tbz
3007 tbz2
3008 tgz
3009 tlz
3010 ts
3011 txz
3012 tzo
3013 vob
3014 war
3015 webm
3016 webp
3017 xz
3018 z
3019 zip
3020 zst
3021 .RE
3022 .IP
3023 This list will be replaced by your \fB\-\-skip-compress\fP list in all but one
3024 situation: a copy from a daemon rsync will add your skipped suffixes to its
3025 list of non-compressing files (and its list may be configured to a
3026 different default).
3027 .IP "\fB\-\-numeric-ids\fP"
3028 With this option rsync will transfer numeric group and user IDs rather than
3029 using user and group names and mapping them at both ends.
3030 .IP
3031 By default rsync will use the username and groupname to determine what
3032 ownership to give files. The special uid 0 and the special group 0 are
3033 never mapped via user/group names even if the \fB\-\-numeric-ids\fP option is not
3034 specified.
3035 .IP
3036 If a user or group has no name on the source system or it has no match on
3037 the destination system, then the numeric ID from the source system is used
3038 instead. See also the \fBuse\ chroot\fP setting
3039 in the rsyncd.conf manpage for some comments on how the chroot setting
3040 affects rsync's ability to look up the names of the users and groups and
3041 what you can do about it.
3042 .IP "\fB\-\-usermap=STRING\fP, \fB\-\-groupmap=STRING\fP"
3043 These options allow you to specify users and groups that should be mapped
3044 to other values by the receiving side. The \fBSTRING\fP is one or more
3045 \fBFROM\fP:\fBTO\fP pairs of values separated by commas. Any matching \fBFROM\fP
3046 value from the sender is replaced with a \fBTO\fP value from the receiver.
3047 You may specify usernames or user IDs for the \fBFROM\fP and \fBTO\fP values,
3048 and the \fBFROM\fP value may also be a wild-card string, which will be
3049 matched against the sender's names (wild-cards do NOT match against ID
3050 numbers, though see below for why a '\fB*\fP' matches everything). You may
3051 instead specify a range of ID numbers via an inclusive range: LOW-HIGH.
3052 For example:
3053 .RS 4
3054 .IP
3055 .nf
3056 --usermap=0-99:nobody,wayne:admin,*:normal --groupmap=usr:1,1:usr
3057 .fi
3058 .RE
3059 .IP
3060 The first match in the list is the one that is used. You should specify
3061 all your user mappings using a single \fB\-\-usermap\fP option, and/or all your
3062 group mappings using a single \fB\-\-groupmap\fP option.
3063 .IP
3064 Note that the sender's name for the 0 user and group are not transmitted to
3065 the receiver, so you should either match these values using a 0, or use the
3066 names in effect on the receiving side (typically "root"). All other
3067 \fBFROM\fP names match those in use on the sending side. All \fBTO\fP names
3068 match those in use on the receiving side.
3069 .IP
3070 Any IDs that do not have a name on the sending side are treated as having
3071 an empty name for the purpose of matching. This allows them to be matched
3072 via a "\fB*\fP" or using an empty name. For instance:
3073 .RS 4
3074 .IP
3075 .nf
3076 --usermap=:nobody --groupmap=*:nobody
3077 .fi
3078 .RE
3079 .IP
3080 When the \fB\-\-numeric-ids\fP option is used, the sender does not send any
3081 names, so all the IDs are treated as having an empty name. This means that
3082 you will need to specify numeric \fBFROM\fP values if you want to map these
3083 nameless IDs to different values.
3084 .IP
3085 For the \fB\-\-usermap\fP option to work, the receiver will need to be running as
3086 a super-user (see also the \fB\-\-super\fP and \fB\-\-fake-super\fP
3087 options). For the \fB\-\-groupmap\fP option to work, the receiver will need to
3088 have permissions to set that group.
3089 .IP
3090 Starting with rsync 3.2.4, the \fB\-\-usermap\fP option implies the
3091 \fB\-\-owner\fP (\fB\-o\fP) option while the \fB\-\-groupmap\fP option implies the
3092 \fB\-\-group\fP (\fB\-g\fP) option (since rsync needs to have those options
3093 enabled for the mapping options to work).
3094 .IP
3095 An older rsync client may need to use \fB\-s\fP to avoid a complaint
3096 about wildcard characters, but a modern rsync handles this automatically.
3097 .IP "\fB\-\-chown=USER:GROUP\fP"
3098 This option forces all files to be owned by USER with group GROUP. This is
3099 a simpler interface than using \fB\-\-usermap\fP & \fB\-\-groupmap\fP
3100 directly, but it is implemented using those options internally so they
3101 cannot be mixed. If either the USER or GROUP is empty, no mapping for the
3102 omitted user/group will occur. If GROUP is empty, the trailing colon may
3103 be omitted, but if USER is empty, a leading colon must be supplied.
3104 .IP
3105 If you specify "\fB\-\-chown=foo:bar\fP", this is exactly the same as specifying
3106 "\fB\-\-usermap=*:foo\ \-\-groupmap=*:bar\fP", only easier (and with the same
3107 implied \fB\-\-owner\fP and/or \fB\-\-group\fP options).
3108 .IP
3109 An older rsync client may need to use \fB\-s\fP to avoid a complaint
3110 about wildcard characters, but a modern rsync handles this automatically.
3111 .IP "\fB\-\-timeout=SECONDS\fP"
3112 This option allows you to set a maximum I/O timeout in seconds. If no data
3113 is transferred for the specified time then rsync will exit. The default is
3114 0, which means no timeout.
3115 .IP "\fB\-\-contimeout=SECONDS\fP"
3116 This option allows you to set the amount of time that rsync will wait for
3117 its connection to an rsync daemon to succeed. If the timeout is reached,
3118 rsync exits with an error.
3119 .IP "\fB\-\-address=ADDRESS\fP"
3120 By default rsync will bind to the wildcard address when connecting to an
3121 rsync daemon. The \fB\-\-address\fP option allows you to specify a specific IP
3122 address (or hostname) to bind to.
3123 .IP
3124 See also the daemon version of the \fB\-\-address\fP option.
3125 .IP "\fB\-\-port=PORT\fP"
3126 This specifies an alternate TCP port number to use rather than the default
3127 of 873. This is only needed if you are using the double-colon (::) syntax
3128 to connect with an rsync daemon (since the URL syntax has a way to specify
3129 the port as a part of the URL).
3130 .IP
3131 See also the daemon version of the \fB\-\-port\fP option.
3132 .IP "\fB\-\-sockopts=OPTIONS\fP"
3133 This option can provide endless fun for people who like to tune their
3134 systems to the utmost degree. You can set all sorts of socket options
3135 which may make transfers faster (or slower!). Read the manpage for the
3136 \fBsetsockopt()\fP system call for details on some of the options you may be
3137 able to set. By default no special socket options are set. This only
3138 affects direct socket connections to a remote rsync daemon.
3139 .IP
3140 See also the daemon version of the \fB\-\-sockopts\fP option.
3141 .IP "\fB\-\-blocking-io\fP"
3142 This tells rsync to use blocking I/O when launching a remote shell
3143 transport. If the remote shell is either rsh or remsh, rsync defaults to
3144 using blocking I/O, otherwise it defaults to using non-blocking I/O. (Note
3145 that ssh prefers non-blocking I/O.)
3146 .IP "\fB\-\-outbuf=MODE\fP"
3147 This sets the output buffering mode. The mode can be None (aka
3148 Unbuffered), Line, or Block (aka Full). You may specify as little as a
3149 single letter for the mode, and use upper or lower case.
3150 .IP
3151 The main use of this option is to change Full buffering to Line buffering
3152 when rsync's output is going to a file or pipe.
3153 .IP "\fB\-\-itemize-changes\fP, \fB\-i\fP"
3154 Requests a simple itemized list of the changes that are being made to each
3155 file, including attribute changes. This is exactly the same as specifying
3156 \fB\-\-out-format='%i\ %n%L'\fP. If you repeat the option, unchanged
3157 files will also be output, but only if the receiving rsync is at least
3158 version 2.6.7 (you can use \fB\-vv\fP with older versions of rsync, but that
3159 also turns on the output of other verbose messages).
3160 .IP
3161 The "%i" escape has a cryptic output that is 11 letters long. The general
3162 format is like the string \fBYXcstpoguax\fP, where \fBY\fP is replaced by the type
3163 of update being done, \fBX\fP is replaced by the file-type, and the other
3164 letters represent attributes that may be output if they are being modified.
3165 .IP
3166 The update types that replace the \fBY\fP are as follows:
3167 .IP
3168 .RS
3169 .IP o
3170 A \fB<\fP means that a file is being transferred to the remote host (sent).
3171 .IP o
3172 A \fB>\fP means that a file is being transferred to the local host
3173 (received).
3174 .IP o
3175 A \fBc\fP means that a local change/creation is occurring for the item (such
3176 as the creation of a directory or the changing of a symlink, etc.).
3177 .IP o
3178 A \fBh\fP means that the item is a hard link to another item (requires
3179 \fB\-\-hard-links\fP).
3180 .IP o
3181 A \fB.\fP means that the item is not being updated (though it might have
3182 attributes that are being modified).
3183 .IP o
3184 A \fB*\fP means that the rest of the itemized-output area contains a message
3185 (e.g. "deleting").
3186 .RE
3187 .IP
3188 The file-types that replace the \fBX\fP are: \fBf\fP for a file, a \fBd\fP for a
3189 directory, an \fBL\fP for a symlink, a \fBD\fP for a device, and a \fBS\fP for a
3190 special file (e.g. named sockets and fifos).
3191 .IP
3192 The other letters in the string indicate if some attributes of the file
3193 have changed, as follows:
3194 .IP
3195 .RS
3196 .IP o
3197 "\fB.\fP" \- the attribute is unchanged.
3198 .IP o
3199 "\fB+\fP" \- the file is newly created.
3200 .IP o
3201 "\fB\ \fP" \- all the attributes are unchanged (all dots turn to spaces).
3202 .IP o
3203 "\fB?\fP" \- the change is unknown (when the remote rsync is old).
3204 .IP o
3205 A letter indicates an attribute is being updated.
3206 .RE
3207 .IP
3208 The attribute that is associated with each letter is as follows:
3209 .IP
3210 .RS
3211 .IP o
3212 A \fBc\fP means either that a regular file has a different checksum (requires
3213 \fB\-\-checksum\fP) or that a symlink, device, or special file has a
3214 changed value. Note that if you are sending files to an rsync prior to
3215 3.0.1, this change flag will be present only for checksum-differing
3216 regular files.
3217 .IP o
3218 A \fBs\fP means the size of a regular file is different and will be updated
3219 by the file transfer.
3220 .IP o
3221 A \fBt\fP means the modification time is different and is being updated to
3222 the sender's value (requires \fB\-\-times\fP). An alternate value of
3223 \fBT\fP means that the modification time will be set to the transfer time,
3224 which happens when a file/symlink/device is updated without
3225 \fB\-\-times\fP and when a symlink is changed and the receiver can't
3226 set its time. (Note: when using an rsync 3.0.0 client, you might see the
3227 \fBs\fP flag combined with \fBt\fP instead of the proper \fBT\fP flag for this
3228 time-setting failure.)
3229 .IP o
3230 A \fBp\fP means the permissions are different and are being updated to the
3231 sender's value (requires \fB\-\-perms\fP).
3232 .IP o
3233 An \fBo\fP means the owner is different and is being updated to the sender's
3234 value (requires \fB\-\-owner\fP and super-user privileges).
3235 .IP o
3236 A \fBg\fP means the group is different and is being updated to the sender's
3237 value (requires \fB\-\-group\fP and the authority to set the group).
3238 .IP o
3239 .IP
3240 .RS
3241 .IP o
3242 A \fBu\fP|\fBn\fP|\fBb\fP indicates the following information:
3243
3244 \fBu\fP means the access (use) time is different and is being updated to
3245 the sender's value (requires \fB\-\-atimes\fP)
3246 .IP o
3247 \fBn\fP means the create time (newness) is different and is being updated
3248 to the sender's value (requires \fB\-\-crtimes\fP)
3249 .IP o
3250 \fBb\fP means that both the access and create times are being updated
3251 .RE
3252 .IP o
3253 The \fBa\fP means that the ACL information is being changed.
3254 .IP o
3255 The \fBx\fP means that the extended attribute information is being changed.
3256 .RE
3257 .IP
3258 One other output is possible: when deleting files, the "%i" will output the
3259 string "\fB*deleting\fP" for each item that is being removed (assuming that you
3260 are talking to a recent enough rsync that it logs deletions instead of
3261 outputting them as a verbose message).
3262 .IP "\fB\-\-out-format=FORMAT\fP"
3263 This allows you to specify exactly what the rsync client outputs to the
3264 user on a per-update basis. The format is a text string containing
3265 embedded single-character escape sequences prefixed with a percent (%)
3266 character. A default format of "%n%L" is assumed if either
3267 \fB\-\-info=name\fP or \fB\-v\fP is specified (this tells you just the
3268 name of the file and, if the item is a link, where it points). For a full
3269 list of the possible escape characters, see the \fBlog\ format\fP setting in the rsyncd.conf manpage.
3270 .IP
3271 Specifying the \fB\-\-out-format\fP option implies the \fB\-\-info=name\fP
3272 option, which will mention each file, dir, etc. that gets updated in a
3273 significant way (a transferred file, a recreated symlink/device, or a
3274 touched directory). In addition, if the itemize-changes escape (%i) is
3275 included in the string (e.g. if the \fB\-\-itemize-changes\fP option was
3276 used), the logging of names increases to mention any item that is changed
3277 in any way (as long as the receiving side is at least 2.6.4). See the
3278 \fB\-\-itemize-changes\fP option for a description of the output of "%i".
3279 .IP
3280 Rsync will output the out-format string prior to a file's transfer unless
3281 one of the transfer-statistic escapes is requested, in which case the
3282 logging is done at the end of the file's transfer. When this late logging
3283 is in effect and \fB\-\-progress\fP is also specified, rsync will also
3284 output the name of the file being transferred prior to its progress
3285 information (followed, of course, by the out-format output).
3286 .IP "\fB\-\-log-file=FILE\fP"
3287 This option causes rsync to log what it is doing to a file. This is
3288 similar to the logging that a daemon does, but can be requested for the
3289 client side and/or the server side of a non-daemon transfer. If specified
3290 as a client option, transfer logging will be enabled with a default format
3291 of "%i %n%L". See the \fB\-\-log-file-format\fP option if you wish to
3292 override this.
3293 .IP
3294 Here's an example command that requests the remote side to log what is
3295 happening:
3296 .RS 4
3297 .IP
3298 .nf
3299 rsync -av --remote-option=--log-file=/tmp/rlog src/ dest/
3300 .fi
3301 .RE
3302 .IP
3303 This is very useful if you need to debug why a connection is closing
3304 unexpectedly.
3305 .IP
3306 See also the daemon version of the \fB\-\-log-file\fP option.
3307 .IP "\fB\-\-log-file-format=FORMAT\fP"
3308 This allows you to specify exactly what per-update logging is put into the
3309 file specified by the \fB\-\-log-file\fP option (which must also be
3310 specified for this option to have any effect). If you specify an empty
3311 string, updated files will not be mentioned in the log file. For a list of
3312 the possible escape characters, see the \fBlog\ format\fP
3313 setting in the rsyncd.conf manpage.
3314 .IP
3315 The default FORMAT used if \fB\-\-log-file\fP is specified and this
3316 option is not is '%i %n%L'.
3317 .IP
3318 See also the daemon version of the \fB\-\-log-file-format\fP
3319 option.
3320 .IP "\fB\-\-stats\fP"
3321 This tells rsync to print a verbose set of statistics on the file transfer,
3322 allowing you to tell how effective rsync's delta-transfer algorithm is for
3323 your data. This option is equivalent to \fB\-\-info=stats2\fP if
3324 combined with 0 or 1 \fB\-v\fP options, or \fB\-\-info=stats3\fP if
3325 combined with 2 or more \fB\-v\fP options.
3326 .IP
3327 The current statistics are as follows:
3328 .IP
3329 .RS
3330 .IP o
3331 \fBNumber\ of\ files\fP is the count of all "files" (in the generic sense),
3332 which includes directories, symlinks, etc. The total count will be
3333 followed by a list of counts by filetype (if the total is non-zero). For
3334 example: "(reg: 5, dir: 3, link: 2, dev: 1, special: 1)" lists the totals
3335 for regular files, directories, symlinks, devices, and special files. If
3336 any of value is 0, it is completely omitted from the list.
3337 .IP o
3338 \fBNumber\ of\ created\ files\fP is the count of how many "files" (generic
3339 sense) were created (as opposed to updated). The total count will be
3340 followed by a list of counts by filetype (if the total is non-zero).
3341 .IP o
3342 \fBNumber\ of\ deleted\ files\fP is the count of how many "files" (generic
3343 sense) were deleted. The total count will be
3344 followed by a list of counts by filetype (if the total is non-zero).
3345 Note that this line is only output if deletions are in effect, and only
3346 if protocol 31 is being used (the default for rsync 3.1.x).
3347 .IP o
3348 \fBNumber\ of\ regular\ files\ transferred\fP is the count of normal files that
3349 were updated via rsync's delta-transfer algorithm, which does not include
3350 dirs, symlinks, etc. Note that rsync 3.1.0 added the word "regular" into
3351 this heading.
3352 .IP o
3353 \fBTotal\ file\ size\fP is the total sum of all file sizes in the transfer.
3354 This does not count any size for directories or special files, but does
3355 include the size of symlinks.
3356 .IP o
3357 \fBTotal\ transferred\ file\ size\fP is the total sum of all files sizes for
3358 just the transferred files.
3359 .IP o
3360 \fBLiteral\ data\fP is how much unmatched file-update data we had to send to
3361 the receiver for it to recreate the updated files.
3362 .IP o
3363 \fBMatched\ data\fP is how much data the receiver got locally when recreating
3364 the updated files.
3365 .IP o
3366 \fBFile\ list\ size\fP is how big the file-list data was when the sender sent
3367 it to the receiver. This is smaller than the in-memory size for the file
3368 list due to some compressing of duplicated data when rsync sends the
3369 list.
3370 .IP o
3371 \fBFile\ list\ generation\ time\fP is the number of seconds that the sender
3372 spent creating the file list. This requires a modern rsync on the
3373 sending side for this to be present.
3374 .IP o
3375 \fBFile\ list\ transfer\ time\fP is the number of seconds that the sender spent
3376 sending the file list to the receiver.
3377 .IP o
3378 \fBTotal\ bytes\ sent\fP is the count of all the bytes that rsync sent from the
3379 client side to the server side.
3380 .IP o
3381 \fBTotal\ bytes\ received\fP is the count of all non-message bytes that rsync
3382 received by the client side from the server side. "Non-message" bytes
3383 means that we don't count the bytes for a verbose message that the server
3384 sent to us, which makes the stats more consistent.
3385 .RE
3386 .IP "\fB\-\-8-bit-output\fP, \fB\-8\fP"
3387 This tells rsync to leave all high-bit characters unescaped in the output
3388 instead of trying to test them to see if they're valid in the current
3389 locale and escaping the invalid ones. All control characters (but never
3390 tabs) are always escaped, regardless of this option's setting.
3391 .IP
3392 The escape idiom that started in 2.6.7 is to output a literal backslash
3393 (\fB\\\fP) and a hash (\fB#\fP), followed by exactly 3 octal digits. For example, a
3394 newline would output as "\fB\\#012\fP". A literal backslash that is in a
3395 filename is not escaped unless it is followed by a hash and 3 digits (0-9).
3396 .IP "\fB\-\-human-readable\fP, \fB\-h\fP"
3397 Output numbers in a more human-readable format. There are 3 possible levels:
3398 .RS
3399 .IP
3400 .IP 1.
3401 output numbers with a separator between each set of 3 digits (either a
3402 comma or a period, depending on if the decimal point is represented by a
3403 period or a comma).
3404 .IP 2.
3405 output numbers in units of 1000 (with a character suffix for larger
3406 units\ \-\- see below).
3407 .IP 3.
3408 output numbers in units of 1024.
3409 .RE
3410 .IP
3411 The default is human-readable level 1. Each \fB\-h\fP option increases the
3412 level by one. You can take the level down to 0 (to output numbers as pure
3413 digits) by specifying the \fB\-\-no-human-readable\fP (\fB\-\-no-h\fP) option.
3414 .IP
3415 The unit letters that are appended in levels 2 and 3 are: \fBK\fP (kilo), \fBM\fP
3416 (mega), \fBG\fP (giga), \fBT\fP (tera), or \fBP\fP (peta). For example, a 1234567-byte
3417 file would output as 1.23M in level-2 (assuming that a period is your local
3418 decimal point).
3419 .IP
3420 Backward compatibility note: versions of rsync prior to 3.1.0 do not
3421 support human-readable level 1, and they default to level 0. Thus,
3422 specifying one or two \fB\-h\fP options will behave in a comparable manner in
3423 old and new versions as long as you didn't specify a \fB\-\-no-h\fP option prior
3424 to one or more \fB\-h\fP options. See the \fB\-\-list-only\fP option for one
3425 difference.
3426 .IP "\fB\-\-partial\fP"
3427 By default, rsync will delete any partially transferred file if the
3428 transfer is interrupted. In some circumstances it is more desirable to
3429 keep partially transferred files. Using the \fB\-\-partial\fP option tells rsync
3430 to keep the partial file which should make a subsequent transfer of the
3431 rest of the file much faster.
3432 .IP "\fB\-\-partial-dir=DIR\fP"
3433 This option modifies the behavior of the \fB\-\-partial\fP option while
3434 also implying that it be enabled. This enhanced partial-file method puts
3435 any partially transferred files into the specified \fIDIR\fP instead of writing
3436 the partial file out to the destination file. On the next transfer, rsync
3437 will use a file found in this dir as data to speed up the resumption of the
3438 transfer and then delete it after it has served its purpose.
3439 .IP
3440 Note that if \fB\-\-whole-file\fP is specified (or implied), any
3441 partial-dir files that are found for a file that is being updated will
3442 simply be removed (since rsync is sending files without using rsync's
3443 delta-transfer algorithm).
3444 .IP
3445 Rsync will create the \fIDIR\fP if it is missing, but just the last dir\ \-\- not
3446 the whole path. This makes it easy to use a relative path (such as
3447 "\fB\-\-partial-dir=.rsync-partial\fP") to have rsync create the
3448 partial-directory in the destination file's directory when it is needed,
3449 and then remove it again when the partial file is deleted. Note that this
3450 directory removal is only done for a relative pathname, as it is expected
3451 that an absolute path is to a directory that is reserved for partial-dir
3452 work.
3453 .IP
3454 If the partial-dir value is not an absolute path, rsync will add an exclude
3455 rule at the end of all your existing excludes. This will prevent the
3456 sending of any partial-dir files that may exist on the sending side, and
3457 will also prevent the untimely deletion of partial-dir items on the
3458 receiving side. An example: the above \fB\-\-partial-dir\fP option would add the
3459 equivalent of this "perishable" exclude at the end of any other filter
3460 rules: \fB\-f\ '\-p\ .rsync-partial/'\fP
3461 .IP
3462 If you are supplying your own exclude rules, you may need to add your own
3463 exclude/hide/protect rule for the partial-dir because:
3464 .RS
3465 .IP
3466 .IP 1.
3467 the auto-added rule may be ineffective at the end of your other rules, or
3468 .IP 2.
3469 you may wish to override rsync's exclude choice.
3470 .RE
3471 .IP
3472 For instance, if you want to make rsync clean-up any left-over partial-dirs
3473 that may be lying around, you should specify \fB\-\-delete-after\fP and
3474 add a "risk" filter rule, e.g. \fB\-f\ 'R\ .rsync-partial/'\fP. Avoid using
3475 \fB\-\-delete-before\fP or \fB\-\-delete-during\fP unless you don't
3476 need rsync to use any of the left-over partial-dir data during the current
3477 run.
3478 .IP
3479 IMPORTANT: the \fB\-\-partial-dir\fP should not be writable by other users or it
3480 is a security risk! E.g. AVOID "/tmp"!
3481 .IP
3482 You can also set the partial-dir value the \fBRSYNC_PARTIAL_DIR\fP
3483 environment variable. Setting this in the environment does not force
3484 \fB\-\-partial\fP to be enabled, but rather it affects where partial
3485 files go when \fB\-\-partial\fP is specified. For instance, instead of
3486 using \fB\-\-partial-dir=.rsync-tmp\fP along with \fB\-\-progress\fP, you could
3487 set \fBRSYNC_PARTIAL_DIR=.rsync-tmp\fP in your environment and then use
3488 the \fB\-P\fP option to turn on the use of the .rsync-tmp dir for
3489 partial transfers. The only times that the \fB\-\-partial\fP option does
3490 not look for this environment value are:
3491 .RS
3492 .IP
3493 .IP 1.
3494 when \fB\-\-inplace\fP was specified (since \fB\-\-inplace\fP
3495 conflicts with \fB\-\-partial-dir\fP), and
3496 .IP 2.
3497 when \fB\-\-delay-updates\fP was specified (see below).
3498 .RE
3499 .IP
3500 When a modern rsync resumes the transfer of a file in the partial-dir, that
3501 partial file is now updated in-place instead of creating yet another
3502 tmp-file copy (so it maxes out at dest + tmp instead of dest + partial +
3503 tmp). This requires both ends of the transfer to be at least version
3504 3.2.0.
3505 .IP
3506 For the purposes of the daemon-config's "\fBrefuse\ options\fP" setting,
3507 \fB\-\-partial-dir\fP does \fInot\fP imply \fB\-\-partial\fP. This is so that a
3508 refusal of the \fB\-\-partial\fP option can be used to disallow the
3509 overwriting of destination files with a partial transfer, while still
3510 allowing the safer idiom provided by \fB\-\-partial-dir\fP.
3511 .IP "\fB\-\-delay-updates\fP"
3512 This option puts the temporary file from each updated file into a holding
3513 directory until the end of the transfer, at which time all the files are
3514 renamed into place in rapid succession. This attempts to make the updating
3515 of the files a little more atomic. By default the files are placed into a
3516 directory named \fB.~tmp~\fP in each file's destination directory, but if
3517 you've specified the \fB\-\-partial-dir\fP option, that directory will be
3518 used instead. See the comments in the \fB\-\-partial-dir\fP section for
3519 a discussion of how this \fB.~tmp~\fP dir will be excluded from the transfer,
3520 and what you can do if you want rsync to cleanup old \fB.~tmp~\fP dirs that
3521 might be lying around. Conflicts with \fB\-\-inplace\fP and
3522 \fB\-\-append\fP.
3523 .IP
3524 This option implies \fB\-\-no-inc-recursive\fP since it needs the full
3525 file list in memory in order to be able to iterate over it at the end.
3526 .IP
3527 This option uses more memory on the receiving side (one bit per file
3528 transferred) and also requires enough free disk space on the receiving side
3529 to hold an additional copy of all the updated files. Note also that you
3530 should not use an absolute path to \fB\-\-partial-dir\fP unless:
3531 .RS
3532 .IP
3533 .IP 1.
3534 there is no chance of any of the files in the transfer having the same
3535 name (since all the updated files will be put into a single directory if
3536 the path is absolute), and
3537 .IP 2.
3538 there are no mount points in the hierarchy (since the delayed updates
3539 will fail if they can't be renamed into place).
3540 .RE
3541 .IP
3542 See also the "atomic-rsync" python script in the "support" subdir for an
3543 update algorithm that is even more atomic (it uses \fB\-\-link-dest\fP
3544 and a parallel hierarchy of files).
3545 .IP "\fB\-\-prune-empty-dirs\fP, \fB\-m\fP"
3546 This option tells the receiving rsync to get rid of empty directories from
3547 the file-list, including nested directories that have no non-directory
3548 children. This is useful for avoiding the creation of a bunch of useless
3549 directories when the sending rsync is recursively scanning a hierarchy of
3550 files using include/exclude/filter rules.
3551 .IP
3552 This option can still leave empty directories on the receiving side if you
3553 make use of TRANSFER_RULES.
3554 .IP
3555 Because the file-list is actually being pruned, this option also affects
3556 what directories get deleted when a delete is active. However, keep in
3557 mind that excluded files and directories can prevent existing items from
3558 being deleted due to an exclude both hiding source files and protecting
3559 destination files. See the perishable filter-rule option for how to avoid
3560 this.
3561 .IP
3562 You can prevent the pruning of certain empty directories from the file-list
3563 by using a global "protect" filter. For instance, this option would ensure
3564 that the directory "emptydir" was kept in the file-list:
3565 .RS 4
3566 .IP
3567 .nf
3568 --filter 'protect emptydir/'
3569 .fi
3570 .RE
3571 .IP
3572 Here's an example that copies all .pdf files in a hierarchy, only creating
3573 the necessary destination directories to hold the .pdf files, and ensures
3574 that any superfluous files and directories in the destination are removed
3575 (note the hide filter of non-directories being used instead of an exclude):
3576 .RS 4
3577 .IP
3578 .nf
3579 rsync -avm --del --include='*.pdf' -f 'hide,! */' src/ dest
3580 .fi
3581 .RE
3582 .IP
3583 If you didn't want to remove superfluous destination files, the more
3584 time-honored options of \fB\-\-include='*/'\ \-\-exclude='*'\fP would work
3585 fine in place of the hide-filter (if that is more natural to you).
3586 .IP "\fB\-\-progress\fP"
3587 This option tells rsync to print information showing the progress of the
3588 transfer. This gives a bored user something to watch. With a modern rsync
3589 this is the same as specifying \fB\-\-info=flist2,name,progress\fP, but
3590 any user-supplied settings for those info flags takes precedence (e.g.
3591 \fB\-\-info=flist0\ \-\-progress\fP).
3592 .IP
3593 While rsync is transferring a regular file, it updates a progress line that
3594 looks like this:
3595 .RS 4
3596 .IP
3597 .nf
3598 782448 63% 110.64kB/s 0:00:04
3599 .fi
3600 .RE
3601 .IP
3602 In this example, the receiver has reconstructed 782448 bytes or 63% of the
3603 sender's file, which is being reconstructed at a rate of 110.64 kilobytes
3604 per second, and the transfer will finish in 4 seconds if the current rate
3605 is maintained until the end.
3606 .IP
3607 These statistics can be misleading if rsync's delta-transfer algorithm is
3608 in use. For example, if the sender's file consists of the basis file
3609 followed by additional data, the reported rate will probably drop
3610 dramatically when the receiver gets to the literal data, and the transfer
3611 will probably take much longer to finish than the receiver estimated as it
3612 was finishing the matched part of the file.
3613 .IP
3614 When the file transfer finishes, rsync replaces the progress line with a
3615 summary line that looks like this:
3616 .RS 4
3617 .IP
3618 .nf
3619 1,238,099 100% 146.38kB/s 0:00:08 (xfr#5, to-chk=169/396)
3620 .fi
3621 .RE
3622 .IP
3623 In this example, the file was 1,238,099 bytes long in total, the average
3624 rate of transfer for the whole file was 146.38 kilobytes per second over
3625 the 8 seconds that it took to complete, it was the 5th transfer of a
3626 regular file during the current rsync session, and there are 169 more files
3627 for the receiver to check (to see if they are up-to-date or not) remaining
3628 out of the 396 total files in the file-list.
3629 .IP
3630 In an incremental recursion scan, rsync won't know the total number of
3631 files in the file-list until it reaches the ends of the scan, but since it
3632 starts to transfer files during the scan, it will display a line with the
3633 text "ir-chk" (for incremental recursion check) instead of "to-chk" until
3634 the point that it knows the full size of the list, at which point it will
3635 switch to using "to-chk". Thus, seeing "ir-chk" lets you know that the
3636 total count of files in the file list is still going to increase (and each
3637 time it does, the count of files left to check will increase by the number
3638 of the files added to the list).
3639 .IP "\fB\-P\fP"
3640 The \fB\-P\fP option is equivalent to "\fB\-\-partial\fP
3641 \fB\-\-progress\fP". Its purpose is to make it much easier to specify
3642 these two options for a long transfer that may be interrupted.
3643 .IP
3644 There is also a \fB\-\-info=progress2\fP option that outputs statistics
3645 based on the whole transfer, rather than individual files. Use this flag
3646 without outputting a filename (e.g. avoid \fB\-v\fP or specify
3647 \fB\-\-info=name0\fP) if you want to see how the transfer is doing
3648 without scrolling the screen with a lot of names. (You don't need to
3649 specify the \fB\-\-progress\fP option in order to use
3650 \fB\-\-info=progress2\fP.)
3651 .IP
3652 Finally, you can get an instant progress report by sending rsync a signal
3653 of either SIGINFO or SIGVTALRM. On BSD systems, a SIGINFO is generated by
3654 typing a Ctrl+T (Linux doesn't currently support a SIGINFO signal). When
3655 the client-side process receives one of those signals, it sets a flag to
3656 output a single progress report which is output when the current file
3657 transfer finishes (so it may take a little time if a big file is being
3658 handled when the signal arrives). A filename is output (if needed)
3659 followed by the \fB\-\-info=progress2\fP format of progress info. If you
3660 don't know which of the 3 rsync processes is the client process, it's OK to
3661 signal all of them (since the non-client processes ignore the signal).
3662 .IP
3663 CAUTION: sending SIGVTALRM to an older rsync (pre-3.2.0) will kill it.
3664 .IP "\fB\-\-password-file=FILE\fP"
3665 This option allows you to provide a password for accessing an rsync daemon
3666 via a file or via standard input if \fBFILE\fP is \fB\-\fP. The file should
3667 contain just the password on the first line (all other lines are ignored).
3668 Rsync will exit with an error if \fBFILE\fP is world readable or if a
3669 root-run rsync command finds a non-root-owned file.
3670 .IP
3671 This option does not supply a password to a remote shell transport such as
3672 ssh; to learn how to do that, consult the remote shell's documentation.
3673 When accessing an rsync daemon using a remote shell as the transport, this
3674 option only comes into effect after the remote shell finishes its
3675 authentication (i.e. if you have also specified a password in the daemon's
3676 config file).
3677 .IP "\fB\-\-early-input=FILE\fP"
3678 This option allows rsync to send up to 5K of data to the "early exec"
3679 script on its stdin. One possible use of this data is to give the script a
3680 secret that can be used to mount an encrypted filesystem (which you should
3681 unmount in the the "post-xfer exec" script).
3682 .IP
3683 The daemon must be at least version 3.2.1.
3684 .IP "\fB\-\-list-only\fP"
3685 This option will cause the source files to be listed instead of
3686 transferred. This option is inferred if there is a single source arg and
3687 no destination specified, so its main uses are:
3688 .RS
3689 .IP
3690 .IP 1.
3691 to turn a copy command that includes a destination arg into a
3692 file-listing command, or
3693 .IP 2.
3694 to be able to specify more than one source arg. Note: be sure to
3695 include the destination.
3696 .RE
3697 .IP
3698 CAUTION: keep in mind that a source arg with a wild-card is expanded by the
3699 shell into multiple args, so it is never safe to try to specify a single
3700 wild-card arg to try to infer this option. A safe example is:
3701 .RS 4
3702 .IP
3703 .nf
3704 rsync -av --list-only foo* dest/
3705 .fi
3706 .RE
3707 .IP
3708 This option always uses an output format that looks similar to this:
3709 .RS 4
3710 .IP
3711 .nf
3712 drwxrwxr-x 4,096 2022/09/30 12:53:11 support
3713 -rw-rw-r-- 80 2005/01/11 10:37:37 support/Makefile
3714 .fi
3715 .RE
3716 .IP
3717 The only option that affects this output style is (as of 3.1.0) the
3718 \fB\-\-human-readable\fP (\fB\-h\fP) option. The default is to output sizes
3719 as byte counts with digit separators (in a 14-character-width column).
3720 Specifying at least one \fB\-h\fP option makes the sizes output with unit
3721 suffixes. If you want old-style bytecount sizes without digit separators
3722 (and an 11-character-width column) use \fB\-\-no-h\fP.
3723 .IP
3724 Compatibility note: when requesting a remote listing of files from an rsync
3725 that is version 2.6.3 or older, you may encounter an error if you ask for a
3726 non-recursive listing. This is because a file listing implies the
3727 \fB\-\-dirs\fP option w/o \fB\-\-recursive\fP, and older rsyncs don't
3728 have that option. To avoid this problem, either specify the \fB\-\-no-dirs\fP
3729 option (if you don't need to expand a directory's content), or turn on
3730 recursion and exclude the content of subdirectories: \fB\-r\ \-\-exclude='/*/*'\fP.
3731 .IP "\fB\-\-bwlimit=RATE\fP"
3732 This option allows you to specify the maximum transfer rate for the data
3733 sent over the socket, specified in units per second. The RATE value can be
3734 suffixed with a string to indicate a size multiplier, and may be a
3735 fractional value (e.g. \fB\-\-bwlimit=1.5m\fP). If no suffix is specified, the
3736 value will be assumed to be in units of 1024 bytes (as if "K" or "KiB" had
3737 been appended). See the \fB\-\-max-size\fP option for a description of
3738 all the available suffixes. A value of 0 specifies no limit.
3739 .IP
3740 For backward-compatibility reasons, the rate limit will be rounded to the
3741 nearest KiB unit, so no rate smaller than 1024 bytes per second is
3742 possible.
3743 .IP
3744 Rsync writes data over the socket in blocks, and this option both limits
3745 the size of the blocks that rsync writes, and tries to keep the average
3746 transfer rate at the requested limit. Some burstiness may be seen where
3747 rsync writes out a block of data and then sleeps to bring the average rate
3748 into compliance.
3749 .IP
3750 Due to the internal buffering of data, the \fB\-\-progress\fP option may
3751 not be an accurate reflection on how fast the data is being sent. This is
3752 because some files can show up as being rapidly sent when the data is
3753 quickly buffered, while other can show up as very slow when the flushing of
3754 the output buffer occurs. This may be fixed in a future version.
3755 .IP
3756 See also the daemon version of the \fB\-\-bwlimit\fP option.
3757 .IP "\fB\-\-stop-after=MINS\fP, (\fB\-\-time-limit=MINS\fP)"
3758 This option tells rsync to stop copying when the specified number of
3759 minutes has elapsed.
3760 .IP
3761 For maximal flexibility, rsync does not communicate this option to the
3762 remote rsync since it is usually enough that one side of the connection
3763 quits as specified. This allows the option's use even when only one side
3764 of the connection supports it. You can tell the remote side about the time
3765 limit using \fB\-\-remote-option\fP (\fB\-M\fP), should the need arise.
3766 .IP
3767 The \fB\-\-time-limit\fP version of this option is deprecated.
3768 .IP "\fB\-\-stop-at=y-m-dTh:m\fP"
3769 This option tells rsync to stop copying when the specified point in time
3770 has been reached. The date & time can be fully specified in a numeric
3771 format of year-month-dayThour:minute (e.g. 2000-12-31T23:59) in the local
3772 timezone. You may choose to separate the date numbers using slashes
3773 instead of dashes.
3774 .IP
3775 The value can also be abbreviated in a variety of ways, such as specifying
3776 a 2-digit year and/or leaving off various values. In all cases, the value
3777 will be taken to be the next possible point in time where the supplied
3778 information matches. If the value specifies the current time or a past
3779 time, rsync exits with an error.
3780 .IP
3781 For example, "1-30" specifies the next January 30th (at midnight local
3782 time), "14:00" specifies the next 2 P.M., "1" specifies the next 1st of the
3783 month at midnight, "31" specifies the next month where we can stop on its
3784 31st day, and ":59" specifies the next 59th minute after the hour.
3785 .IP
3786 For maximal flexibility, rsync does not communicate this option to the
3787 remote rsync since it is usually enough that one side of the connection
3788 quits as specified. This allows the option's use even when only one side
3789 of the connection supports it. You can tell the remote side about the time
3790 limit using \fB\-\-remote-option\fP (\fB\-M\fP), should the need arise. Do
3791 keep in mind that the remote host may have a different default timezone
3792 than your local host.
3793 .IP "\fB\-\-fsync\fP"
3794 Cause the receiving side to fsync each finished file. This may slow down
3795 the transfer, but can help to provide peace of mind when updating critical
3796 files.
3797 .IP "\fB\-\-write-batch=FILE\fP"
3798 Record a file that can later be applied to another identical destination
3799 with \fB\-\-read-batch\fP. See the "BATCH MODE" section for details, and
3800 also the \fB\-\-only-write-batch\fP option.
3801 .IP
3802 This option overrides the negotiated checksum & compress lists and always
3803 negotiates a choice based on old-school md5/md4/zlib choices. If you want
3804 a more modern choice, use the \fB\-\-checksum-choice\fP (\fB\-\-cc\fP) and/or
3805 \fB\-\-compress-choice\fP (\fB\-\-zc\fP) options.
3806 .IP "\fB\-\-only-write-batch=FILE\fP"
3807 Works like \fB\-\-write-batch\fP, except that no updates are made on the
3808 destination system when creating the batch. This lets you transport the
3809 changes to the destination system via some other means and then apply the
3810 changes via \fB\-\-read-batch\fP.
3811 .IP
3812 Note that you can feel free to write the batch directly to some portable
3813 media: if this media fills to capacity before the end of the transfer, you
3814 can just apply that partial transfer to the destination and repeat the
3815 whole process to get the rest of the changes (as long as you don't mind a
3816 partially updated destination system while the multi-update cycle is
3817 happening).
3818 .IP
3819 Also note that you only save bandwidth when pushing changes to a remote
3820 system because this allows the batched data to be diverted from the sender
3821 into the batch file without having to flow over the wire to the receiver
3822 (when pulling, the sender is remote, and thus can't write the batch).
3823 .IP "\fB\-\-read-batch=FILE\fP"
3824 Apply all of the changes stored in FILE, a file previously generated by
3825 \fB\-\-write-batch\fP. If \fIFILE\fP is \fB\-\fP, the batch data will be read
3826 from standard input. See the "BATCH MODE" section for details.
3827 .IP "\fB\-\-protocol=NUM\fP"
3828 Force an older protocol version to be used. This is useful for creating a
3829 batch file that is compatible with an older version of rsync. For
3830 instance, if rsync 2.6.4 is being used with the \fB\-\-write-batch\fP
3831 option, but rsync 2.6.3 is what will be used to run the
3832 \fB\-\-read-batch\fP option, you should use "\-\-protocol=28" when creating
3833 the batch file to force the older protocol version to be used in the batch
3834 file (assuming you can't upgrade the rsync on the reading system).
3835 .IP "\fB\-\-iconv=CONVERT_SPEC\fP"
3836 Rsync can convert filenames between character sets using this option.
3837 Using a CONVERT_SPEC of "." tells rsync to look up the default
3838 character-set via the locale setting. Alternately, you can fully specify
3839 what conversion to do by giving a local and a remote charset separated by a
3840 comma in the order \fB\-\-iconv=LOCAL,REMOTE\fP, e.g. \fB\-\-iconv=utf8,iso88591\fP.
3841 This order ensures that the option will stay the same whether you're
3842 pushing or pulling files. Finally, you can specify either \fB\-\-no-iconv\fP or
3843 a CONVERT_SPEC of "\-" to turn off any conversion. The default setting of
3844 this option is site-specific, and can also be affected via the
3845 \fBRSYNC_ICONV\fP environment variable.
3846 .IP
3847 For a list of what charset names your local iconv library supports, you can
3848 run "\fBiconv\ \-\-list\fP".
3849 .IP
3850 If you specify the \fB\-\-secluded-args\fP (\fB\-s\fP) option, rsync will
3851 translate the filenames you specify on the command-line that are being sent
3852 to the remote host. See also the \fB\-\-files-from\fP option.
3853 .IP
3854 Note that rsync does not do any conversion of names in filter files
3855 (including include/exclude files). It is up to you to ensure that you're
3856 specifying matching rules that can match on both sides of the transfer.
3857 For instance, you can specify extra include/exclude rules if there are
3858 filename differences on the two sides that need to be accounted for.
3859 .IP
3860 When you pass an \fB\-\-iconv\fP option to an rsync daemon that allows it, the
3861 daemon uses the charset specified in its "charset" configuration parameter
3862 regardless of the remote charset you actually pass. Thus, you may feel
3863 free to specify just the local charset for a daemon transfer (e.g.
3864 \fB\-\-iconv=utf8\fP).
3865 .IP "\fB\-\-ipv4\fP, \fB\-4\fP or \fB\-\-ipv6\fP, \fB\-6\fP"
3866 Tells rsync to prefer IPv4/IPv6 when creating sockets or running ssh. This
3867 affects sockets that rsync has direct control over, such as the outgoing
3868 socket when directly contacting an rsync daemon, as well as the forwarding
3869 of the \fB\-4\fP or \fB\-6\fP option to ssh when rsync can deduce that ssh is being
3870 used as the remote shell. For other remote shells you'll need to specify
3871 the "\fB\-\-rsh\ SHELL\ \-4\fP" option directly (or whatever IPv4/IPv6 hint options
3872 it uses).
3873 .IP
3874 See also the daemon version of these options.
3875 .IP
3876 If rsync was compiled without support for IPv6, the \fB\-\-ipv6\fP option will
3877 have no effect. The \fBrsync\ \-\-version\fP output will contain "\fBno\ IPv6\fP" if
3878 is the case.
3879 .IP "\fB\-\-checksum-seed=NUM\fP"
3880 Set the checksum seed to the integer NUM. This 4 byte checksum seed is
3881 included in each block and MD4 file checksum calculation (the more modern
3882 MD5 file checksums don't use a seed). By default the checksum seed is
3883 generated by the server and defaults to the current \fBtime\fP(). This
3884 option is used to set a specific checksum seed, which is useful for
3885 applications that want repeatable block checksums, or in the case where the
3886 user wants a more random checksum seed. Setting NUM to 0 causes rsync to
3887 use the default of \fBtime\fP() for checksum seed.
3888 .P
3889 .SH "DAEMON OPTIONS"
3890 .P
3891 The options allowed when starting an rsync daemon are as follows:
3892 .P
3893 .IP "\fB\-\-daemon\fP"
3894 This tells rsync that it is to run as a daemon. The daemon you start
3895 running may be accessed using an rsync client using the \fBhost::module\fP or
3896 \fBrsync://host/module/\fP syntax.
3897 .IP
3898 If standard input is a socket then rsync will assume that it is being run
3899 via inetd, otherwise it will detach from the current terminal and become a
3900 background daemon. The daemon will read the config file (rsyncd.conf) on
3901 each connect made by a client and respond to requests accordingly.
3902 .IP
3903 See the \fBrsyncd.conf\fP(5) manpage for more details.
3904 .IP "\fB\-\-address=ADDRESS\fP"
3905 By default rsync will bind to the wildcard address when run as a daemon
3906 with the \fB\-\-daemon\fP option. The \fB\-\-address\fP option allows you to specify a
3907 specific IP address (or hostname) to bind to. This makes virtual hosting
3908 possible in conjunction with the \fB\-\-config\fP option.
3909 .IP
3910 See also the address global option in the
3911 rsyncd.conf manpage and the client version of the \fB\-\-address\fP
3912 option.
3913 .IP "\fB\-\-bwlimit=RATE\fP"
3914 This option allows you to specify the maximum transfer rate for the data
3915 the daemon sends over the socket. The client can still specify a smaller
3916 \fB\-\-bwlimit\fP value, but no larger value will be allowed.
3917 .IP
3918 See the client version of the \fB\-\-bwlimit\fP option for some
3919 extra details.
3920 .IP "\fB\-\-config=FILE\fP"
3921 This specifies an alternate config file than the default. This is only
3922 relevant when \fB\-\-daemon\fP is specified. The default is
3923 /etc/rsyncd.conf unless the daemon is running over a remote shell program
3924 and the remote user is not the super-user; in that case the default is
3925 rsyncd.conf in the current directory (typically $HOME).
3926 .IP "\fB\-\-dparam=OVERRIDE\fP, \fB\-M\fP"
3927 This option can be used to set a daemon-config parameter when starting up
3928 rsync in daemon mode. It is equivalent to adding the parameter at the end
3929 of the global settings prior to the first module's definition. The
3930 parameter names can be specified without spaces, if you so desire. For
3931 instance:
3932 .RS 4
3933 .IP
3934 .nf
3935 rsync --daemon -M pidfile=/path/rsync.pid
3936 .fi
3937 .RE
3938 .IP "\fB\-\-no-detach\fP"
3939 When running as a daemon, this option instructs rsync to not detach itself
3940 and become a background process. This option is required when running as a
3941 service on Cygwin, and may also be useful when rsync is supervised by a
3942 program such as \fBdaemontools\fP or AIX's \fBSystem\ Resource\ Controller\fP.
3943 \fB\-\-no-detach\fP is also recommended when rsync is run under a debugger. This
3944 option has no effect if rsync is run from inetd or sshd.
3945 .IP "\fB\-\-port=PORT\fP"
3946 This specifies an alternate TCP port number for the daemon to listen on
3947 rather than the default of 873.
3948 .IP
3949 See also the client version of the \fB\-\-port\fP option and the
3950 port global setting in the rsyncd.conf manpage.
3951 .IP "\fB\-\-log-file=FILE\fP"
3952 This option tells the rsync daemon to use the given log-file name instead
3953 of using the "\fBlog\ file\fP" setting in the config file.
3954 .IP
3955 See also the client version of the \fB\-\-log-file\fP option.
3956 .IP "\fB\-\-log-file-format=FORMAT\fP"
3957 This option tells the rsync daemon to use the given FORMAT string instead
3958 of using the "\fBlog\ format\fP" setting in the config file. It also enables
3959 "\fBtransfer\ logging\fP" unless the string is empty, in which case transfer
3960 logging is turned off.
3961 .IP
3962 See also the client version of the \fB\-\-log-file-format\fP
3963 option.
3964 .IP "\fB\-\-sockopts\fP"
3965 This overrides the \fBsocket\ options\fP
3966 setting in the rsyncd.conf file and has the same syntax.
3967 .IP
3968 See also the client version of the \fB\-\-sockopts\fP option.
3969 .IP "\fB\-\-verbose\fP, \fB\-v\fP"
3970 This option increases the amount of information the daemon logs during its
3971 startup phase. After the client connects, the daemon's verbosity level
3972 will be controlled by the options that the client used and the
3973 "\fBmax\ verbosity\fP" setting in the module's config section.
3974 .IP
3975 See also the client version of the \fB\-\-verbose\fP option.
3976 .IP "\fB\-\-ipv4\fP, \fB\-4\fP or \fB\-\-ipv6\fP, \fB\-6\fP"
3977 Tells rsync to prefer IPv4/IPv6 when creating the incoming sockets that the
3978 rsync daemon will use to listen for connections. One of these options may
3979 be required in older versions of Linux to work around an IPv6 bug in the
3980 kernel (if you see an "address already in use" error when nothing else is
3981 using the port, try specifying \fB\-\-ipv6\fP or \fB\-\-ipv4\fP when starting the
3982 daemon).
3983 .IP
3984 See also the client version of these options.
3985 .IP
3986 If rsync was compiled without support for IPv6, the \fB\-\-ipv6\fP option will
3987 have no effect. The \fBrsync\ \-\-version\fP output will contain "\fBno\ IPv6\fP" if
3988 is the case.
3989 .IP "\fB\-\-help\fP, \fB\-h\fP"
3990 When specified after \fB\-\-daemon\fP, print a short help page describing the
3991 options available for starting an rsync daemon.
3992 .P
3993 .SH "FILTER RULES"
3994 .P
3995 The filter rules allow for custom control of several aspects of how files are
3996 handled:
3997 .P
3998 .IP o
3999 Control which files the sending side puts into the file list that describes
4000 the transfer hierarchy
4001 .IP o
4002 Control which files the receiving side protects from deletion when the file
4003 is not in the sender's file list
4004 .IP o
4005 Control which extended attribute names are skipped when copying xattrs
4006 .P
4007 The rules are either directly specified via option arguments or they can be
4008 read in from one or more files. The filter-rule files can even be a part of
4009 the hierarchy of files being copied, affecting different parts of the tree in
4010 different ways.
4011 .P
4012 .SS "SIMPLE INCLUDE/EXCLUDE RULES"
4013 .P
4014 We will first cover the basics of how include & exclude rules affect what files
4015 are transferred, ignoring any deletion side-effects. Filter rules mainly
4016 affect the contents of directories that rsync is "recursing" into, but they can
4017 also affect a top-level item in the transfer that was specified as a argument.
4018 .P
4019 The default for any unmatched file/dir is for it to be included in the
4020 transfer, which puts the file/dir into the sender's file list. The use of an
4021 exclude rule causes one or more matching files/dirs to be left out of the
4022 sender's file list. An include rule can be used to limit the effect of an
4023 exclude rule that is matching too many files.
4024 .P
4025 The order of the rules is important because the first rule that matches is the
4026 one that takes effect. Thus, if an early rule excludes a file, no include rule
4027 that comes after it can have any effect. This means that you must place any
4028 include overrides somewhere prior to the exclude that it is intended to limit.
4029 .P
4030 When a directory is excluded, all its contents and sub-contents are also
4031 excluded. The sender doesn't scan through any of it at all, which can save a
4032 lot of time when skipping large unneeded sub-trees.
4033 .P
4034 It is also important to understand that the include/exclude rules are applied
4035 to every file and directory that the sender is recursing into. Thus, if you
4036 want a particular deep file to be included, you have to make sure that none of
4037 the directories that must be traversed on the way down to that file are
4038 excluded or else the file will never be discovered to be included. As an
4039 example, if the directory "\fBa/path\fP" was given as a transfer argument and you
4040 want to ensure that the file "\fBa/path/down/deep/wanted.txt\fP" is a part of the
4041 transfer, then the sender must not exclude the directories "\fBa/path\fP",
4042 "\fBa/path/down\fP", or "\fBa/path/down/deep\fP" as it makes it way scanning through
4043 the file tree.
4044 .P
4045 When you are working on the rules, it can be helpful to ask rsync to tell you
4046 what is being excluded/included and why. Specifying \fB\-\-debug=FILTER\fP or (when
4047 pulling files) \fB\-M\-\-debug=FILTER\fP turns on level 1 of the FILTER debug
4048 information that will output a message any time that a file or directory is
4049 included or excluded and which rule it matched. Beginning in 3.2.4 it will
4050 also warn if a filter rule has trailing whitespace, since an exclude of "foo\ "
4051 (with a trailing space) will not exclude a file named "foo".
4052 .P
4053 Exclude and include rules can specify wildcard PATTERN MATCHING RULES
4054 (similar to shell wildcards) that allow you to match things like a file suffix
4055 or a portion of a filename.
4056 .P
4057 A rule can be limited to only affecting a directory by putting a trailing slash
4058 onto the filename.
4059 .P
4060 .SS "SIMPLE INCLUDE/EXCLUDE EXAMPLE"
4061 .P
4062 With the following file tree created on the sending side:
4063 .RS 4
4064 .P
4065 .nf
4066 mkdir x/
4067 touch x/file.txt
4068 mkdir x/y/
4069 touch x/y/file.txt
4070 touch x/y/zzz.txt
4071 mkdir x/z/
4072 touch x/z/file.txt
4073 .fi
4074 .RE
4075 .P
4076 Then the following rsync command will transfer the file "\fBx/y/file.txt\fP" and
4077 the directories needed to hold it, resulting in the path "\fB/tmp/x/y/file.txt\fP"
4078 existing on the remote host:
4079 .RS 4
4080 .P
4081 .nf
4082 rsync -ai -f'+ x/' -f'+ x/y/' -f'+ x/y/file.txt' -f'- *' x host:/tmp/
4083 .fi
4084 .RE
4085 .P
4086 Aside: this copy could also have been accomplished using the \fB\-R\fP
4087 option (though the 2 commands behave differently if deletions are enabled):
4088 .RS 4
4089 .P
4090 .nf
4091 rsync -aiR x/y/file.txt host:/tmp/
4092 .fi
4093 .RE
4094 .P
4095 The following command does not need an include of the "x" directory because it
4096 is not a part of the transfer (note the trailing slash). Running this command
4097 would copy just "\fB/tmp/x/file.txt\fP" because the "y" and "z" dirs get excluded:
4098 .RS 4
4099 .P
4100 .nf
4101 rsync -ai -f'+ file.txt' -f'- *' x/ host:/tmp/x/
4102 .fi
4103 .RE
4104 .P
4105 This command would omit the zzz.txt file while copying "x" and everything else
4106 it contains:
4107 .RS 4
4108 .P
4109 .nf
4110 rsync -ai -f'- zzz.txt' x host:/tmp/
4111 .fi
4112 .RE
4113 .P
4114 .SS "FILTER RULES WHEN DELETING"
4115 .P
4116 By default the include & exclude filter rules affect both the sender
4117 (as it creates its file list)
4118 and the receiver (as it creates its file lists for calculating deletions). If
4119 no delete option is in effect, the receiver skips creating the delete-related
4120 file lists. This two-sided default can be manually overridden so that you are
4121 only specifying sender rules or receiver rules, as described in the FILTER
4122 RULES IN DEPTH section.
4123 .P
4124 When deleting, an exclude protects a file from being removed on the receiving
4125 side while an include overrides that protection (putting the file at risk of
4126 deletion). The default is for a file to be at risk\ \-\- its safety depends on it
4127 matching a corresponding file from the sender.
4128 .P
4129 An example of the two-sided exclude effect can be illustrated by the copying of
4130 a C development directory between 2 systems. When doing a touch-up copy, you
4131 might want to skip copying the built executable and the \fB.o\fP files (sender
4132 hide) so that the receiving side can build their own and not lose any object
4133 files that are already correct (receiver protect). For instance:
4134 .RS 4
4135 .P
4136 .nf
4137 rsync -ai --del -f'- *.o' -f'- cmd' src host:/dest/
4138 .fi
4139 .RE
4140 .P
4141 Note that using \fB\-f'\-p\ *.o'\fP is even better than \fB\-f'\-\ *.o'\fP if there is a
4142 chance that the directory structure may have changed. The "p" modifier is
4143 discussed in FILTER RULE MODIFIERS.
4144 .P
4145 One final note, if your shell doesn't mind unexpanded wildcards, you could
4146 simplify the typing of the filter options by using an underscore in place of
4147 the space and leaving off the quotes. For instance, \fB\-f\ \-_*.o\ \-f\ \-_cmd\fP (and
4148 similar) could be used instead of the filter options above.
4149 .P
4150 .SS "FILTER RULES IN DEPTH"
4151 .P
4152 Rsync supports old-style include/exclude rules and new-style filter rules. The
4153 older rules are specified using \fB\-\-include\fP and \fB\-\-exclude\fP as
4154 well as the \fB\-\-include-from\fP and \fB\-\-exclude-from\fP. These are
4155 limited in behavior but they don't require a "\-" or "+" prefix. An old-style
4156 exclude rule is turned into a "\fB\-\ name\fP" filter rule (with no modifiers) and an
4157 old-style include rule is turned into a "\fB+\ name\fP" filter rule (with no
4158 modifiers).
4159 .P
4160 Rsync builds an ordered list of filter rules as specified on the command-line
4161 and/or read-in from files. New style filter rules have the following syntax:
4162 .RS 4
4163 .P
4164 .nf
4165 RULE [PATTERN_OR_FILENAME]
4166 RULE,MODIFIERS [PATTERN_OR_FILENAME]
4167 .fi
4168 .RE
4169 .P
4170 You have your choice of using either short or long RULE names, as described
4171 below. If you use a short-named rule, the ',' separating the RULE from the
4172 MODIFIERS is optional. The PATTERN or FILENAME that follows (when present)
4173 must come after either a single space or an underscore (_). Any additional
4174 spaces and/or underscores are considered to be a part of the pattern name.
4175 Here are the available rule prefixes:
4176 .P
4177 .IP "\fBexclude,\ '\-'\fP"
4178 specifies an exclude pattern that (by default) is both a
4179 \fBhide\fP and a \fBprotect\fP.
4180 .IP "\fBinclude,\ '+'\fP"
4181 specifies an include pattern that (by default) is both a
4182 \fBshow\fP and a \fBrisk\fP.
4183 .IP "\fBmerge,\ '.'\fP"
4184 specifies a merge-file on the client side to read for more
4185 rules.
4186 .IP "\fBdir-merge,\ ':'\fP"
4187 specifies a per-directory merge-file. Using this kind of
4188 filter rule requires that you trust the sending side's filter checking, so
4189 it has the side-effect mentioned under the \fB\-\-trust-sender\fP option.
4190 .IP "\fBhide,\ 'H'\fP"
4191 specifies a pattern for hiding files from the transfer.
4192 Equivalent to a sender-only exclude, so \fB\-f'H\ foo'\fP could also be specified
4193 as \fB\-f'\-s\ foo'\fP.
4194 .IP "\fBshow,\ 'S'\fP"
4195 files that match the pattern are not hidden. Equivalent to a
4196 sender-only include, so \fB\-f'S\ foo'\fP could also be specified as \fB\-f'+s\ foo'\fP.
4197 .IP "\fBprotect,\ 'P'\fP"
4198 specifies a pattern for protecting files from deletion.
4199 Equivalent to a receiver-only exclude, so \fB\-f'P\ foo'\fP could also be
4200 specified as \fB\-f'\-r\ foo'\fP.
4201 .IP "\fBrisk,\ 'R'\fP"
4202 files that match the pattern are not protected. Equivalent to a
4203 receiver-only include, so \fB\-f'R\ foo'\fP could also be specified as \fB\-f'+r\ foo'\fP.
4204 .IP "\fBclear,\ '!'\fP"
4205 clears the current include/exclude list (takes no arg)
4206 .P
4207 When rules are being read from a file (using merge or dir-merge), empty lines
4208 are ignored, as are whole-line comments that start with a '\fB#\fP' (filename rules
4209 that contain a hash character are unaffected).
4210 .P
4211 Note also that the \fB\-\-filter\fP, \fB\-\-include\fP, and
4212 \fB\-\-exclude\fP options take one rule/pattern each. To add multiple ones,
4213 you can repeat the options on the command-line, use the merge-file syntax of
4214 the \fB\-\-filter\fP option, or the \fB\-\-include-from\fP /
4215 \fB\-\-exclude-from\fP options.
4216 .P
4217 .SS "PATTERN MATCHING RULES"
4218 .P
4219 Most of the rules mentioned above take an argument that specifies what the rule
4220 should match. If rsync is recursing through a directory hierarchy, keep in
4221 mind that each pattern is matched against the name of every directory in the
4222 descent path as rsync finds the filenames to send.
4223 .P
4224 The matching rules for the pattern argument take several forms:
4225 .P
4226 .IP o
4227 If a pattern contains a \fB/\fP (not counting a trailing slash) or a "\fB**\fP"
4228 (which can match a slash), then the pattern is matched against the full
4229 pathname, including any leading directories within the transfer. If the
4230 pattern doesn't contain a (non-trailing) \fB/\fP or a "\fB**\fP", then it is matched
4231 only against the final component of the filename or pathname. For example,
4232 \fBfoo\fP means that the final path component must be "foo" while \fBfoo/bar\fP would
4233 match the last 2 elements of the path (as long as both elements are within
4234 the transfer).
4235 .IP o
4236 A pattern that ends with a \fB/\fP only matches a directory, not a regular file,
4237 symlink, or device.
4238 .IP o
4239 A pattern that starts with a \fB/\fP is anchored to the start of the transfer
4240 path instead of the end. For example, \fB/foo/**\fP or \fB/foo/bar/**\fP match only
4241 leading elements in the path. If the rule is read from a per-directory
4242 filter file, the transfer path being matched will begin at the level of the
4243 filter file instead of the top of the transfer. See the section on
4244 ANCHORING INCLUDE/EXCLUDE PATTERNS for a full discussion of how to
4245 specify a pattern that matches at the root of the transfer.
4246 .P
4247 Rsync chooses between doing a simple string match and wildcard matching by
4248 checking if the pattern contains one of these three wildcard characters: '\fB*\fP',
4249 \&'\fB?\fP', and '\fB[\fP' :
4250 .P
4251 .IP o
4252 a '\fB?\fP' matches any single character except a slash (\fB/\fP).
4253 .IP o
4254 a '\fB*\fP' matches zero or more non-slash characters.
4255 .IP o
4256 a '\fB**\fP' matches zero or more characters, including slashes.
4257 .IP o
4258 a '\fB[\fP' introduces a character class, such as \fB[a-z]\fP or \fB[[:alpha:]]\fP, that
4259 must match one character.
4260 .IP o
4261 a trailing \fB***\fP in the pattern is a shorthand that allows you to match a
4262 directory and all its contents using a single rule. For example, specifying
4263 "\fBdir_name/***\fP" will match both the "dir_name" directory (as if "\fBdir_name/\fP"
4264 had been specified) and everything in the directory (as if "\fBdir_name/**\fP"
4265 had been specified).
4266 .IP o
4267 a backslash can be used to escape a wildcard character, but it is only
4268 interpreted as an escape character if at least one wildcard character is
4269 present in the match pattern. For instance, the pattern "\fBfoo\\bar\fP" matches
4270 that single backslash literally, while the pattern "\fBfoo\\bar*\fP" would need to
4271 be changed to "\fBfoo\\\\bar*\fP" to avoid the "\fB\\b\fP" becoming just "b".
4272 .P
4273 Here are some examples of exclude/include matching:
4274 .P
4275 .IP o
4276 Option \fB\-f'\-\ *.o'\fP would exclude all filenames ending with \fB.o\fP
4277 .IP o
4278 Option \fB\-f'\-\ /foo'\fP would exclude a file (or directory) named foo in the
4279 transfer-root directory
4280 .IP o
4281 Option \fB\-f'\-\ foo/'\fP would exclude any directory named foo
4282 .IP o
4283 Option \fB\-f'\-\ foo/*/bar'\fP would exclude any file/dir named bar which is at two
4284 levels below a directory named foo (if foo is in the transfer)
4285 .IP o
4286 Option \fB\-f'\-\ /foo/**/bar'\fP would exclude any file/dir named bar that was two
4287 or more levels below a top-level directory named foo (note that /foo/bar is
4288 \fBnot\fP excluded by this)
4289 .IP o
4290 Options \fB\-f'+\ */'\ \-f'+\ *.c'\ \-f'\-\ *'\fP would include all directories and .c
4291 source files but nothing else
4292 .IP o
4293 Options \fB\-f'+\ foo/'\ \-f'+\ foo/bar.c'\ \-f'\-\ *'\fP would include only the foo
4294 directory and foo/bar.c (the foo directory must be explicitly included or it
4295 would be excluded by the "\fB\-\ *\fP")
4296 .P
4297 .SS "FILTER RULE MODIFIERS"
4298 .P
4299 The following modifiers are accepted after an include (+) or exclude (\-) rule:
4300 .P
4301 .IP o
4302 A \fB/\fP specifies that the include/exclude rule should be matched against the
4303 absolute pathname of the current item. For example, \fB\-f'\-/\ /etc/passwd'\fP
4304 would exclude the passwd file any time the transfer was sending files from
4305 the "/etc" directory, and "\-/ subdir/foo" would always exclude "foo" when it
4306 is in a dir named "subdir", even if "foo" is at the root of the current
4307 transfer.
4308 .IP o
4309 A \fB!\fP specifies that the include/exclude should take effect if the pattern
4310 fails to match. For instance, \fB\-f'\-!\ */'\fP would exclude all non-directories.
4311 .IP o
4312 A \fBC\fP is used to indicate that all the global CVS-exclude rules should be
4313 inserted as excludes in place of the "\-C". No arg should follow.
4314 .IP o
4315 An \fBs\fP is used to indicate that the rule applies to the sending side. When a
4316 rule affects the sending side, it affects what files are put into the
4317 sender's file list. The default is for a rule to affect both sides unless
4318 \fB\-\-delete-excluded\fP was specified, in which case default rules become
4319 sender-side only. See also the hide (H) and show (S) rules, which are an
4320 alternate way to specify sending-side includes/excludes.
4321 .IP o
4322 An \fBr\fP is used to indicate that the rule applies to the receiving side. When
4323 a rule affects the receiving side, it prevents files from being deleted. See
4324 the \fBs\fP modifier for more info. See also the protect (P) and risk (R) rules,
4325 which are an alternate way to specify receiver-side includes/excludes.
4326 .IP o
4327 A \fBp\fP indicates that a rule is perishable, meaning that it is ignored in
4328 directories that are being deleted. For instance, the
4329 \fB\-\-cvs-exclude\fP (\fB\-C\fP) option's default rules that exclude things
4330 like "CVS" and "\fB*.o\fP" are marked as perishable, and will not prevent a
4331 directory that was removed on the source from being deleted on the
4332 destination.
4333 .IP o
4334 An \fBx\fP indicates that a rule affects xattr names in xattr copy/delete
4335 operations (and is thus ignored when matching file/dir names). If no
4336 xattr-matching rules are specified, a default xattr filtering rule is used
4337 (see the \fB\-\-xattrs\fP option).
4338 .P
4339 .SS "MERGE-FILE FILTER RULES"
4340 .P
4341 You can merge whole files into your filter rules by specifying either a merge
4342 (.) or a dir-merge (:) filter rule (as introduced in the FILTER RULES
4343 section above).
4344 .P
4345 There are two kinds of merged files\ \-\- single-instance ('.') and per-directory
4346 (':'). A single-instance merge file is read one time, and its rules are
4347 incorporated into the filter list in the place of the "." rule. For
4348 per-directory merge files, rsync will scan every directory that it traverses
4349 for the named file, merging its contents when the file exists into the current
4350 list of inherited rules. These per-directory rule files must be created on the
4351 sending side because it is the sending side that is being scanned for the
4352 available files to transfer. These rule files may also need to be transferred
4353 to the receiving side if you want them to affect what files don't get deleted
4354 (see PER-DIRECTORY RULES AND DELETE below).
4355 .P
4356 Some examples:
4357 .RS 4
4358 .P
4359 .nf
4360 merge /etc/rsync/default.rules
4361 \&. /etc/rsync/default.rules
4362 dir-merge .per-dir-filter
4363 dir-merge,n- .non-inherited-per-dir-excludes
4364 :n- .non-inherited-per-dir-excludes
4365 .fi
4366 .RE
4367 .P
4368 The following modifiers are accepted after a merge or dir-merge rule:
4369 .P
4370 .IP o
4371 A \fB\-\fP specifies that the file should consist of only exclude patterns, with
4372 no other rule-parsing except for in-file comments.
4373 .IP o
4374 A \fB+\fP specifies that the file should consist of only include patterns, with
4375 no other rule-parsing except for in-file comments.
4376 .IP o
4377 A \fBC\fP is a way to specify that the file should be read in a CVS-compatible
4378 manner. This turns on 'n', 'w', and '\-', but also allows the list-clearing
4379 token (!) to be specified. If no filename is provided, ".cvsignore" is
4380 assumed.
4381 .IP o
4382 A \fBe\fP will exclude the merge-file name from the transfer; e.g. "dir-merge,e
4383 \&.rules" is like "dir-merge .rules" and "\- .rules".
4384 .IP o
4385 An \fBn\fP specifies that the rules are not inherited by subdirectories.
4386 .IP o
4387 A \fBw\fP specifies that the rules are word-split on whitespace instead of the
4388 normal line-splitting. This also turns off comments. Note: the space that
4389 separates the prefix from the rule is treated specially, so "\- foo + bar" is
4390 parsed as two rules (assuming that prefix-parsing wasn't also disabled).
4391 .IP o
4392 You may also specify any of the modifiers for the "+" or "\-" rules (above) in
4393 order to have the rules that are read in from the file default to having that
4394 modifier set (except for the \fB!\fP modifier, which would not be useful). For
4395 instance, "merge,\-/ .excl" would treat the contents of .excl as absolute-path
4396 excludes, while "dir-merge,s .filt" and ":sC" would each make all their
4397 per-directory rules apply only on the sending side. If the merge rule
4398 specifies sides to affect (via the \fBs\fP or \fBr\fP modifier or both), then the
4399 rules in the file must not specify sides (via a modifier or a rule prefix
4400 such as \fBhide\fP).
4401 .P
4402 Per-directory rules are inherited in all subdirectories of the directory where
4403 the merge-file was found unless the 'n' modifier was used. Each subdirectory's
4404 rules are prefixed to the inherited per-directory rules from its parents, which
4405 gives the newest rules a higher priority than the inherited rules. The entire
4406 set of dir-merge rules are grouped together in the spot where the merge-file
4407 was specified, so it is possible to override dir-merge rules via a rule that
4408 got specified earlier in the list of global rules. When the list-clearing rule
4409 ("!") is read from a per-directory file, it only clears the inherited rules for
4410 the current merge file.
4411 .P
4412 Another way to prevent a single rule from a dir-merge file from being inherited
4413 is to anchor it with a leading slash. Anchored rules in a per-directory
4414 merge-file are relative to the merge-file's directory, so a pattern "/foo"
4415 would only match the file "foo" in the directory where the dir-merge filter
4416 file was found.
4417 .P
4418 Here's an example filter file which you'd specify via \fB\-\-filter=".\ file":\fP
4419 .RS 4
4420 .P
4421 .nf
4422 merge /home/user/.global-filter
4423 - *.gz
4424 dir-merge .rules
4425 + *.[ch]
4426 - *.o
4427 - foo*
4428 .fi
4429 .RE
4430 .P
4431 This will merge the contents of the /home/user/.global-filter file at the start
4432 of the list and also turns the ".rules" filename into a per-directory filter
4433 file. All rules read in prior to the start of the directory scan follow the
4434 global anchoring rules (i.e. a leading slash matches at the root of the
4435 transfer).
4436 .P
4437 If a per-directory merge-file is specified with a path that is a parent
4438 directory of the first transfer directory, rsync will scan all the parent dirs
4439 from that starting point to the transfer directory for the indicated
4440 per-directory file. For instance, here is a common filter (see \fB\-F\fP):
4441 .RS 4
4442 .P
4443 .nf
4444 --filter=': /.rsync-filter'
4445 .fi
4446 .RE
4447 .P
4448 That rule tells rsync to scan for the file .rsync-filter in all directories
4449 from the root down through the parent directory of the transfer prior to the
4450 start of the normal directory scan of the file in the directories that are sent
4451 as a part of the transfer. (Note: for an rsync daemon, the root is always the
4452 same as the module's "path".)
4453 .P
4454 Some examples of this pre-scanning for per-directory files:
4455 .RS 4
4456 .P
4457 .nf
4458 rsync -avF /src/path/ /dest/dir
4459 rsync -av --filter=': ../../.rsync-filter' /src/path/ /dest/dir
4460 rsync -av --filter=': .rsync-filter' /src/path/ /dest/dir
4461 .fi
4462 .RE
4463 .P
4464 The first two commands above will look for ".rsync-filter" in "/" and "/src"
4465 before the normal scan begins looking for the file in "/src/path" and its
4466 subdirectories. The last command avoids the parent-dir scan and only looks for
4467 the ".rsync-filter" files in each directory that is a part of the transfer.
4468 .P
4469 If you want to include the contents of a ".cvsignore" in your patterns, you
4470 should use the rule ":C", which creates a dir-merge of the .cvsignore file, but
4471 parsed in a CVS-compatible manner. You can use this to affect where the
4472 \fB\-\-cvs-exclude\fP (\fB\-C\fP) option's inclusion of the per-directory
4473 \&.cvsignore file gets placed into your rules by putting the ":C" wherever you
4474 like in your filter rules. Without this, rsync would add the dir-merge rule
4475 for the .cvsignore file at the end of all your other rules (giving it a lower
4476 priority than your command-line rules). For example:
4477 .RS 4
4478 .P
4479 .nf
4480 cat <<EOT | rsync -avC --filter='. -' a/ b
4481 + foo.o
4482 :C
4483 - *.old
4484 EOT
4485 rsync -avC --include=foo.o -f :C --exclude='*.old' a/ b
4486 .fi
4487 .RE
4488 .P
4489 Both of the above rsync commands are identical. Each one will merge all the
4490 per-directory .cvsignore rules in the middle of the list rather than at the
4491 end. This allows their dir-specific rules to supersede the rules that follow
4492 the :C instead of being subservient to all your rules. To affect the other CVS
4493 exclude rules (i.e. the default list of exclusions, the contents of
4494 $HOME/.cvsignore, and the value of $CVSIGNORE) you should omit the \fB\-C\fP
4495 command-line option and instead insert a "\-C" rule into your filter rules; e.g.
4496 "\fB\-\-filter=\-C\fP".
4497 .P
4498 .SS "LIST-CLEARING FILTER RULE"
4499 .P
4500 You can clear the current include/exclude list by using the "!" filter rule (as
4501 introduced in the FILTER RULES section above). The "current" list is either
4502 the global list of rules (if the rule is encountered while parsing the filter
4503 options) or a set of per-directory rules (which are inherited in their own
4504 sub-list, so a subdirectory can use this to clear out the parent's rules).
4505 .P
4506 .SS "ANCHORING INCLUDE/EXCLUDE PATTERNS"
4507 .P
4508 As mentioned earlier, global include/exclude patterns are anchored at the "root
4509 of the transfer" (as opposed to per-directory patterns, which are anchored at
4510 the merge-file's directory). If you think of the transfer as a subtree of
4511 names that are being sent from sender to receiver, the transfer-root is where
4512 the tree starts to be duplicated in the destination directory. This root
4513 governs where patterns that start with a / match.
4514 .P
4515 Because the matching is relative to the transfer-root, changing the trailing
4516 slash on a source path or changing your use of the \fB\-\-relative\fP option
4517 affects the path you need to use in your matching (in addition to changing how
4518 much of the file tree is duplicated on the destination host). The following
4519 examples demonstrate this.
4520 .P
4521 Let's say that we want to match two source files, one with an absolute
4522 path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz".
4523 Here is how the various command choices differ for a 2-source transfer:
4524 .RS 4
4525 .P
4526 .nf
4527 Example cmd: rsync -a /home/me /home/you /dest
4528 +/- pattern: /me/foo/bar
4529 +/- pattern: /you/bar/baz
4530 Target file: /dest/me/foo/bar
4531 Target file: /dest/you/bar/baz
4532 .fi
4533 .RE
4534 .RS 4
4535 .P
4536 .nf
4537 Example cmd: rsync -a /home/me/ /home/you/ /dest
4538 +/- pattern: /foo/bar (note missing "me")
4539 +/- pattern: /bar/baz (note missing "you")
4540 Target file: /dest/foo/bar
4541 Target file: /dest/bar/baz
4542 .fi
4543 .RE
4544 .RS 4
4545 .P
4546 .nf
4547 Example cmd: rsync -a --relative /home/me/ /home/you /dest
4548 +/- pattern: /home/me/foo/bar (note full path)
4549 +/- pattern: /home/you/bar/baz (ditto)
4550 Target file: /dest/home/me/foo/bar
4551 Target file: /dest/home/you/bar/baz
4552 .fi
4553 .RE
4554 .RS 4
4555 .P
4556 .nf
4557 Example cmd: cd /home; rsync -a --relative me/foo you/ /dest
4558 +/- pattern: /me/foo/bar (starts at specified path)
4559 +/- pattern: /you/bar/baz (ditto)
4560 Target file: /dest/me/foo/bar
4561 Target file: /dest/you/bar/baz
4562 .fi
4563 .RE
4564 .P
4565 The easiest way to see what name you should filter is to just look at the
4566 output when using \fB\-\-verbose\fP and put a / in front of the name (use the
4567 \fB\-\-dry-run\fP option if you're not yet ready to copy any files).
4568 .P
4569 .SS "PER-DIRECTORY RULES AND DELETE"
4570 .P
4571 Without a delete option, per-directory rules are only relevant on the sending
4572 side, so you can feel free to exclude the merge files themselves without
4573 affecting the transfer. To make this easy, the 'e' modifier adds this exclude
4574 for you, as seen in these two equivalent commands:
4575 .RS 4
4576 .P
4577 .nf
4578 rsync -av --filter=': .excl' --exclude=.excl host:src/dir /dest
4579 rsync -av --filter=':e .excl' host:src/dir /dest
4580 .fi
4581 .RE
4582 .P
4583 However, if you want to do a delete on the receiving side AND you want some
4584 files to be excluded from being deleted, you'll need to be sure that the
4585 receiving side knows what files to exclude. The easiest way is to include the
4586 per-directory merge files in the transfer and use \fB\-\-delete-after\fP,
4587 because this ensures that the receiving side gets all the same exclude rules as
4588 the sending side before it tries to delete anything:
4589 .RS 4
4590 .P
4591 .nf
4592 rsync -avF --delete-after host:src/dir /dest
4593 .fi
4594 .RE
4595 .P
4596 However, if the merge files are not a part of the transfer, you'll need to
4597 either specify some global exclude rules (i.e. specified on the command line),
4598 or you'll need to maintain your own per-directory merge files on the receiving
4599 side. An example of the first is this (assume that the remote .rules files
4600 exclude themselves):
4601 .RS 4
4602 .P
4603 .nf
4604 rsync -av --filter=': .rules' --filter='. /my/extra.rules'
4605 --delete host:src/dir /dest
4606 .fi
4607 .RE
4608 .P
4609 In the above example the extra.rules file can affect both sides of the
4610 transfer, but (on the sending side) the rules are subservient to the rules
4611 merged from the .rules files because they were specified after the
4612 per-directory merge rule.
4613 .P
4614 In one final example, the remote side is excluding the .rsync-filter files from
4615 the transfer, but we want to use our own .rsync-filter files to control what
4616 gets deleted on the receiving side. To do this we must specifically exclude
4617 the per-directory merge files (so that they don't get deleted) and then put
4618 rules into the local files to control what else should not get deleted. Like
4619 one of these commands:
4620 .RS 4
4621 .P
4622 .nf
4623 rsync -av --filter=':e /.rsync-filter' --delete \\
4624 host:src/dir /dest
4625 rsync -avFF --delete host:src/dir /dest
4626 .fi
4627 .RE
4628 .P
4629 .SH "TRANSFER RULES"
4630 .P
4631 In addition to the FILTER RULES that affect the recursive file scans that
4632 generate the file list on the sending and (when deleting) receiving sides,
4633 there are transfer rules. These rules affect which files the generator decides
4634 need to be transferred without the side effects of an exclude filter rule.
4635 Transfer rules affect only files and never directories.
4636 .P
4637 Because a transfer rule does not affect what goes into the sender's (and
4638 receiver's) file list, it cannot have any effect on which files get deleted on
4639 the receiving side. For example, if the file "foo" is present in the sender's
4640 list but its size is such that it is omitted due to a transfer rule, the
4641 receiving side does not request the file. However, its presence in the file
4642 list means that a delete pass will not remove a matching file named "foo" on
4643 the receiving side. On the other hand, a server-side exclude (hide) of the
4644 file "foo" leaves the file out of the server's file list, and absent a
4645 receiver-side exclude (protect) the receiver will remove a matching file named
4646 "foo" if deletions are requested.
4647 .P
4648 Given that the files are still in the sender's file list, the
4649 \fB\-\-prune-empty-dirs\fP option will not judge a directory as being empty
4650 even if it contains only files that the transfer rules omitted.
4651 .P
4652 Similarly, a transfer rule does not have any extra effect on which files are
4653 deleted on the receiving side, so setting a maximum file size for the transfer
4654 does not prevent big files from being deleted.
4655 .P
4656 Examples of transfer rules include the default "quick check" algorithm (which
4657 compares size & modify time), the \fB\-\-update\fP option, the
4658 \fB\-\-max-size\fP option, the \fB\-\-ignore-non-existing\fP option, and a
4659 few others.
4660 .P
4661 .SH "BATCH MODE"
4662 .P
4663 Batch mode can be used to apply the same set of updates to many identical
4664 systems. Suppose one has a tree which is replicated on a number of hosts. Now
4665 suppose some changes have been made to this source tree and those changes need
4666 to be propagated to the other hosts. In order to do this using batch mode,
4667 rsync is run with the write-batch option to apply the changes made to the
4668 source tree to one of the destination trees. The write-batch option causes the
4669 rsync client to store in a "batch file" all the information needed to repeat
4670 this operation against other, identical destination trees.
4671 .P
4672 Generating the batch file once saves having to perform the file status,
4673 checksum, and data block generation more than once when updating multiple
4674 destination trees. Multicast transport protocols can be used to transfer the
4675 batch update files in parallel to many hosts at once, instead of sending the
4676 same data to every host individually.
4677 .P
4678 To apply the recorded changes to another destination tree, run rsync with the
4679 read-batch option, specifying the name of the same batch file, and the
4680 destination tree. Rsync updates the destination tree using the information
4681 stored in the batch file.
4682 .P
4683 For your convenience, a script file is also created when the write-batch option
4684 is used: it will be named the same as the batch file with ".sh" appended. This
4685 script file contains a command-line suitable for updating a destination tree
4686 using the associated batch file. It can be executed using a Bourne (or
4687 Bourne-like) shell, optionally passing in an alternate destination tree
4688 pathname which is then used instead of the original destination path. This is
4689 useful when the destination tree path on the current host differs from the one
4690 used to create the batch file.
4691 .P
4692 Examples:
4693 .RS 4
4694 .P
4695 .nf
4696 $ rsync --write-batch=foo -a host:/source/dir/ /adest/dir/
4697 $ scp foo* remote:
4698 $ ssh remote ./foo.sh /bdest/dir/
4699 .fi
4700 .RE
4701 .RS 4
4702 .P
4703 .nf
4704 $ rsync --write-batch=foo -a /source/dir/ /adest/dir/
4705 $ ssh remote rsync --read-batch=- -a /bdest/dir/ <foo
4706 .fi
4707 .RE
4708 .P
4709 In these examples, rsync is used to update /adest/dir/ from /source/dir/ and
4710 the information to repeat this operation is stored in "foo" and "foo.sh". The
4711 host "remote" is then updated with the batched data going into the directory
4712 /bdest/dir. The differences between the two examples reveals some of the
4713 flexibility you have in how you deal with batches:
4714 .P
4715 .IP o
4716 The first example shows that the initial copy doesn't have to be local\ \-\- you
4717 can push or pull data to/from a remote host using either the remote-shell
4718 syntax or rsync daemon syntax, as desired.
4719 .IP o
4720 The first example uses the created "foo.sh" file to get the right rsync
4721 options when running the read-batch command on the remote host.
4722 .IP o
4723 The second example reads the batch data via standard input so that the batch
4724 file doesn't need to be copied to the remote machine first. This example
4725 avoids the foo.sh script because it needed to use a modified
4726 \fB\-\-read-batch\fP option, but you could edit the script file if you
4727 wished to make use of it (just be sure that no other option is trying to use
4728 standard input, such as the \fB\-\-exclude-from=\-\fP option).
4729 .P
4730 Caveats:
4731 .P
4732 The read-batch option expects the destination tree that it is updating to be
4733 identical to the destination tree that was used to create the batch update
4734 fileset. When a difference between the destination trees is encountered the
4735 update might be discarded with a warning (if the file appears to be up-to-date
4736 already) or the file-update may be attempted and then, if the file fails to
4737 verify, the update discarded with an error. This means that it should be safe
4738 to re-run a read-batch operation if the command got interrupted. If you wish
4739 to force the batched-update to always be attempted regardless of the file's
4740 size and date, use the \fB\-I\fP option (when reading the batch). If an
4741 error occurs, the destination tree will probably be in a partially updated
4742 state. In that case, rsync can be used in its regular (non-batch) mode of
4743 operation to fix up the destination tree.
4744 .P
4745 The rsync version used on all destinations must be at least as new as the one
4746 used to generate the batch file. Rsync will die with an error if the protocol
4747 version in the batch file is too new for the batch-reading rsync to handle.
4748 See also the \fB\-\-protocol\fP option for a way to have the creating rsync
4749 generate a batch file that an older rsync can understand. (Note that batch
4750 files changed format in version 2.6.3, so mixing versions older than that with
4751 newer versions will not work.)
4752 .P
4753 When reading a batch file, rsync will force the value of certain options to
4754 match the data in the batch file if you didn't set them to the same as the
4755 batch-writing command. Other options can (and should) be changed. For
4756 instance \fB\-\-write-batch\fP changes to \fB\-\-read-batch\fP,
4757 \fB\-\-files-from\fP is dropped, and the \fB\-\-filter\fP /
4758 \fB\-\-include\fP / \fB\-\-exclude\fP options are not needed unless one of
4759 the \fB\-\-delete\fP options is specified.
4760 .P
4761 The code that creates the BATCH.sh file transforms any filter/include/exclude
4762 options into a single list that is appended as a "here" document to the shell
4763 script file. An advanced user can use this to modify the exclude list if a
4764 change in what gets deleted by \fB\-\-delete\fP is desired. A normal user
4765 can ignore this detail and just use the shell script as an easy way to run the
4766 appropriate \fB\-\-read-batch\fP command for the batched data.
4767 .P
4768 The original batch mode in rsync was based on "rsync+", but the latest
4769 version uses a new implementation.
4770 .P
4771 .SH "SYMBOLIC LINKS"
4772 .P
4773 Three basic behaviors are possible when rsync encounters a symbolic
4774 link in the source directory.
4775 .P
4776 By default, symbolic links are not transferred at all. A message "skipping
4777 non-regular" file is emitted for any symlinks that exist.
4778 .P
4779 If \fB\-\-links\fP is specified, then symlinks are added to the transfer
4780 (instead of being noisily ignored), and the default handling is to recreate
4781 them with the same target on the destination. Note that \fB\-\-archive\fP
4782 implies \fB\-\-links\fP.
4783 .P
4784 If \fB\-\-copy-links\fP is specified, then symlinks are "collapsed" by
4785 copying their referent, rather than the symlink.
4786 .P
4787 Rsync can also distinguish "safe" and "unsafe" symbolic links. An example
4788 where this might be used is a web site mirror that wishes to ensure that the
4789 rsync module that is copied does not include symbolic links to \fB/etc/passwd\fP in
4790 the public section of the site. Using \fB\-\-copy-unsafe-links\fP will cause
4791 any links to be copied as the file they point to on the destination. Using
4792 \fB\-\-safe-links\fP will cause unsafe links to be omitted by the receiver.
4793 (Note that you must specify or imply \fB\-\-links\fP for
4794 \fB\-\-safe-links\fP to have any effect.)
4795 .P
4796 Symbolic links are considered unsafe if they are absolute symlinks (start with
4797 \fB/\fP), empty, or if they contain enough ".." components to ascend from the top
4798 of the transfer.
4799 .P
4800 Here's a summary of how the symlink options are interpreted. The list is in
4801 order of precedence, so if your combination of options isn't mentioned, use the
4802 first line that is a complete subset of your options:
4803 .P
4804 .IP "\fB\-\-copy-links\fP"
4805 Turn all symlinks into normal files and directories
4806 (leaving no symlinks in the transfer for any other options to affect).
4807 .IP "\fB\-\-copy-dirlinks\fP"
4808 Turn just symlinks to directories into real
4809 directories, leaving all other symlinks to be handled as described below.
4810 .IP "\fB\-\-links\ \-\-copy-unsafe-links\fP"
4811 Turn all unsafe symlinks
4812 into files and create all safe symlinks.
4813 .IP "\fB\-\-copy-unsafe-links\fP"
4814 Turn all unsafe symlinks into files, noisily
4815 skip all safe symlinks.
4816 .IP "\fB\-\-links\ \-\-safe-links\fP"
4817 The receiver skips creating
4818 unsafe symlinks found in the transfer and creates the safe ones.
4819 .IP "\fB\-\-links\fP"
4820 Create all symlinks.
4821 .P
4822 For the effect of \fB\-\-munge-links\fP, see the discussion in that option's
4823 section.
4824 .P
4825 Note that the \fB\-\-keep-dirlinks\fP option does not effect symlinks in the
4826 transfer but instead affects how rsync treats a symlink to a directory that
4827 already exists on the receiving side. See that option's section for a warning.
4828 .P
4829 .SH "DIAGNOSTICS"
4830 .P
4831 Rsync occasionally produces error messages that may seem a little cryptic. The
4832 one that seems to cause the most confusion is "protocol version mismatch\ \-\- is
4833 your shell clean?".
4834 .P
4835 This message is usually caused by your startup scripts or remote shell facility
4836 producing unwanted garbage on the stream that rsync is using for its transport.
4837 The way to diagnose this problem is to run your remote shell like this:
4838 .RS 4
4839 .P
4840 .nf
4841 ssh remotehost /bin/true > out.dat
4842 .fi
4843 .RE
4844 .P
4845 then look at out.dat. If everything is working correctly then out.dat should
4846 be a zero length file. If you are getting the above error from rsync then you
4847 will probably find that out.dat contains some text or data. Look at the
4848 contents and try to work out what is producing it. The most common cause is
4849 incorrectly configured shell startup scripts (such as .cshrc or .profile) that
4850 contain output statements for non-interactive logins.
4851 .P
4852 If you are having trouble debugging filter patterns, then try specifying the
4853 \fB\-vv\fP option. At this level of verbosity rsync will show why each individual
4854 file is included or excluded.
4855 .P
4856 .SH "EXIT VALUES"
4857 .P
4858 .IP o
4859 \fB0\fP \- Success
4860 .IP o
4861 \fB1\fP \- Syntax or usage error
4862 .IP o
4863 \fB2\fP \- Protocol incompatibility
4864 .IP o
4865 \fB3\fP \- Errors selecting input/output files, dirs
4866 .IP o
4867 .P
4868 .RS
4869 .IP o
4870 \fB4\fP \- Requested action not supported. Either:
4871
4872 an attempt was made to manipulate 64-bit files on a platform that cannot support them
4873 .IP o
4874 an option was specified that is supported by the client and not by the server
4875 .RE
4876 .IP o
4877 \fB5\fP \- Error starting client-server protocol
4878 .IP o
4879 \fB6\fP \- Daemon unable to append to log-file
4880 .IP o
4881 \fB10\fP \- Error in socket I/O
4882 .IP o
4883 \fB11\fP \- Error in file I/O
4884 .IP o
4885 \fB12\fP \- Error in rsync protocol data stream
4886 .IP o
4887 \fB13\fP \- Errors with program diagnostics
4888 .IP o
4889 \fB14\fP \- Error in IPC code
4890 .IP o
4891 \fB20\fP \- Received SIGUSR1 or SIGINT
4892 .IP o
4893 \fB21\fP \- Some error returned by \fBwaitpid()\fP
4894 .IP o
4895 \fB22\fP \- Error allocating core memory buffers
4896 .IP o
4897 \fB23\fP \- Partial transfer due to error
4898 .IP o
4899 \fB24\fP \- Partial transfer due to vanished source files
4900 .IP o
4901 \fB25\fP \- The \-\-max-delete limit stopped deletions
4902 .IP o
4903 \fB30\fP \- Timeout in data send/receive
4904 .IP o
4905 \fB35\fP \- Timeout waiting for daemon connection
4906 .P
4907 .SH "ENVIRONMENT VARIABLES"
4908 .P
4909 .IP "\fBCVSIGNORE\fP"
4910 The CVSIGNORE environment variable supplements any ignore patterns in
4911 \&.cvsignore files. See the \fB\-\-cvs-exclude\fP option for more details.
4912 .IP "\fBRSYNC_ICONV\fP"
4913 Specify a default \fB\-\-iconv\fP setting using this environment
4914 variable. First supported in 3.0.0.
4915 .IP "\fBRSYNC_OLD_ARGS\fP"
4916 Specify a "1" if you want the \fB\-\-old-args\fP option to be enabled by
4917 default, a "2" (or more) if you want it to be enabled in the
4918 repeated-option state, or a "0" to make sure that it is disabled by
4919 default. When this environment variable is set to a non-zero value, it
4920 supersedes the \fBRSYNC_PROTECT_ARGS\fP variable.
4921 .IP
4922 This variable is ignored if \fB\-\-old-args\fP, \fB\-\-no-old-args\fP, or
4923 \fB\-\-secluded-args\fP is specified on the command line.
4924 .IP
4925 First supported in 3.2.4.
4926 .IP "\fBRSYNC_PROTECT_ARGS\fP"
4927 Specify a non-zero numeric value if you want the \fB\-\-secluded-args\fP
4928 option to be enabled by default, or a zero value to make sure that it is
4929 disabled by default.
4930 .IP
4931 This variable is ignored if \fB\-\-secluded-args\fP, \fB\-\-no-secluded-args\fP,
4932 or \fB\-\-old-args\fP is specified on the command line.
4933 .IP
4934 First supported in 3.1.0. Starting in 3.2.4, this variable is ignored if
4935 \fBRSYNC_OLD_ARGS\fP is set to a non-zero value.
4936 .IP "\fBRSYNC_RSH\fP"
4937 This environment variable allows you to override the default shell used as
4938 the transport for rsync. Command line options are permitted after the
4939 command name, just as in the \fB\-\-rsh\fP (\fB\-e\fP) option.
4940 .IP "\fBRSYNC_PROXY\fP"
4941 This environment variable allows you to redirect your rsync
4942 client to use a web proxy when connecting to an rsync daemon. You should
4943 set \fBRSYNC_PROXY\fP to a hostname:port pair.
4944 .IP "\fBRSYNC_PASSWORD\fP"
4945 This environment variable allows you to set the password for an rsync
4946 \fBdaemon\fP connection, which avoids the password prompt. Note that this
4947 does \fBnot\fP supply a password to a remote shell transport such as ssh
4948 (consult its documentation for how to do that).
4949 .IP "\fBUSER\fP or \fBLOGNAME\fP"
4950 The USER or LOGNAME environment variables are used to determine the default
4951 username sent to an rsync daemon. If neither is set, the username defaults
4952 to "nobody". If both are set, \fBUSER\fP takes precedence.
4953 .IP "\fBRSYNC_PARTIAL_DIR\fP"
4954 This environment variable specifies the directory to use for a
4955 \fB\-\-partial\fP transfer without implying that partial transfers be
4956 enabled. See the \fB\-\-partial-dir\fP option for full details.
4957 .IP "\fBRSYNC_COMPRESS_LIST\fP"
4958 This environment variable allows you to customize the negotiation of the
4959 compression algorithm by specifying an alternate order or a reduced list of
4960 names. Use the command \fBrsync\ \-\-version\fP to see the available compression
4961 names. See the \fB\-\-compress\fP option for full details.
4962 .IP "\fBRSYNC_CHECKSUM_LIST\fP"
4963 This environment variable allows you to customize the negotiation of the
4964 checksum algorithm by specifying an alternate order or a reduced list of
4965 names. Use the command \fBrsync\ \-\-version\fP to see the available checksum
4966 names. See the \fB\-\-checksum-choice\fP option for full details.
4967 .IP "\fBRSYNC_MAX_ALLOC\fP"
4968 This environment variable sets an allocation maximum as if you had used the
4969 \fB\-\-max-alloc\fP option.
4970 .IP "\fBRSYNC_PORT\fP"
4971 This environment variable is not read by rsync, but is instead set in
4972 its sub-environment when rsync is running the remote shell in combination
4973 with a daemon connection. This allows a script such as
4974 \fBrsync-ssl\fP to be able to know the port number that the user
4975 specified on the command line.
4976 .IP "\fBHOME\fP"
4977 This environment variable is used to find the user's default .cvsignore
4978 file.
4979 .IP "\fBRSYNC_CONNECT_PROG\fP"
4980 This environment variable is mainly used in debug setups to set the program
4981 to use when making a daemon connection. See CONNECTING TO AN RSYNC
4982 DAEMON for full details.
4983 .IP "\fBRSYNC_SHELL\fP"
4984 This environment variable is mainly used in debug setups to set the program
4985 to use to run the program specified by \fBRSYNC_CONNECT_PROG\fP. See
4986 CONNECTING TO AN RSYNC DAEMON for full details.
4987 .P
4988 .SH "FILES"
4989 .P
4990 /etc/rsyncd.conf or rsyncd.conf
4991 .P
4992 .SH "SEE ALSO"
4993 .P
4994 \fBrsync-ssl\fP(1), \fBrsyncd.conf\fP(5), \fBrrsync\fP(1)
4995 .P
4996 .SH "BUGS"
4997 .P
4998 .IP o
4999 Times are transferred as *nix time_t values.
5000 .IP o
5001 When transferring to FAT filesystems rsync may re-sync unmodified files. See
5002 the comments on the \fB\-\-modify-window\fP option.
5003 .IP o
5004 File permissions, devices, etc. are transferred as native numerical values.
5005 .IP o
5006 See also the comments on the \fB\-\-delete\fP option.
5007 .P
5008 Please report bugs! See the web site at
5009 .UR https://rsync.samba.org/
5010 .UE .
5011 .P
5012 .SH "VERSION"
5013 .P
5014 This manpage is current for version 3.4.1 of rsync.
5015 .P
5016 .SH "INTERNAL OPTIONS"
5017 .P
5018 The options \fB\-\-server\fP and \fB\-\-sender\fP are used internally by rsync, and should
5019 never be typed by a user under normal circumstances. Some awareness of these
5020 options may be needed in certain scenarios, such as when setting up a login
5021 that can only run an rsync command. For instance, the support directory of the
5022 rsync distribution has an example script named rrsync (for restricted rsync)
5023 that can be used with a restricted ssh login.
5024 .P
5025 .SH "CREDITS"
5026 .P
5027 Rsync is distributed under the GNU General Public License. See the file
5028 COPYING for details.
5029 .P
5030 An rsync web site is available at
5031 .UR https://rsync.samba.org/
5032 .UE .
5033 The site
5034 includes an FAQ-O-Matic which may cover questions unanswered by this manual
5035 page.
5036 .P
5037 The rsync github project is
5038 .UR https://github.com/RsyncProject/rsync
5039 .UE .
5040 .P
5041 We would be delighted to hear from you if you like this program. Please
5042 contact the mailing-list at
5043 .UR mailto:[email protected]
5044 [email protected]
5045 .UE .
5046 .P
5047 This program uses the excellent zlib compression library written by Jean-loup
5048 Gailly and Mark Adler.
5049 .P
5050 .SH "THANKS"
5051 .P
5052 Special thanks go out to: John Van Essen, Matt McCutchen, Wesley W. Terpstra,
5053 David Dykstra, Jos Backus, Sebastian Krahmer, Martin Pool, and our
5054 gone-but-not-forgotten compadre, J.W. Schultz.
5055 .P
5056 Thanks also to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell and
5057 David Bell. I've probably missed some people, my apologies if I have.
5058 .P
5059 .SH "AUTHOR"
5060 .P
5061 Rsync was originally written by Andrew Tridgell and Paul Mackerras. Many
5062 people from around the world have helped to maintain and improve it.
5063 .P
5064 Mailing lists for support and development are available at
5065 .UR https://lists.samba.org/
5066 .UE .