Debian Codegraph @

upstream/fedora-44/man1/rsync.1

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