Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
c8d771a0 | 2 | manpage(rsync)(1)(30 Apr 2004)()() |
41059f75 AT |
3 | manpagename(rsync)(faster, flexible replacement for rcp) |
4 | manpagesynopsis() | |
5 | ||
9ef53907 | 6 | rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST |
41059f75 | 7 | |
9ef53907 | 8 | rsync [OPTION]... [USER@]HOST:SRC DEST |
41059f75 | 9 | |
9ef53907 | 10 | rsync [OPTION]... SRC [SRC]... DEST |
41059f75 | 11 | |
9ef53907 | 12 | rsync [OPTION]... [USER@]HOST::SRC [DEST] |
41059f75 | 13 | |
9ef53907 | 14 | rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST |
41059f75 | 15 | |
9ef53907 | 16 | rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST] |
039faa86 | 17 | |
8d69d571 WD |
18 | rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST |
19 | ||
41059f75 AT |
20 | manpagedescription() |
21 | ||
22 | rsync is a program that behaves in much the same way that rcp does, | |
23 | but has many more options and uses the rsync remote-update protocol to | |
eb06fa95 | 24 | greatly speed up file transfers when the destination file already |
41059f75 AT |
25 | exists. |
26 | ||
27 | The rsync remote-update protocol allows rsync to transfer just the | |
f39281ae | 28 | differences between two sets of files across the network connection, using |
41059f75 AT |
29 | an efficient checksum-search algorithm described in the technical |
30 | report that accompanies this package. | |
31 | ||
32 | Some of the additional features of rsync are: | |
33 | ||
34 | itemize( | |
b9f592fb | 35 | it() support for copying links, devices, owners, groups, and permissions |
41059f75 AT |
36 | it() exclude and exclude-from options similar to GNU tar |
37 | it() a CVS exclude mode for ignoring the same files that CVS would ignore | |
43cd760f | 38 | it() can use any transparent remote shell, including ssh or rsh |
41059f75 AT |
39 | it() does not require root privileges |
40 | it() pipelining of file transfers to minimize latency costs | |
41 | it() support for anonymous or authenticated rsync servers (ideal for | |
42 | mirroring) | |
43 | ) | |
44 | ||
45 | manpagesection(GENERAL) | |
46 | ||
bef49340 | 47 | There are eight different ways of using rsync. They are: |
41059f75 AT |
48 | |
49 | itemize( | |
50 | it() for copying local files. This is invoked when neither | |
51 | source nor destination path contains a : separator | |
52 | ||
53 | it() for copying from the local machine to a remote machine using | |
43cd760f WD |
54 | a remote shell program as the transport (such as ssh or |
55 | rsh). This is invoked when the destination path contains a | |
41059f75 AT |
56 | single : separator. |
57 | ||
58 | it() for copying from a remote machine to the local machine | |
6c7c2ef3 | 59 | using a remote shell program. This is invoked when the source |
41059f75 AT |
60 | contains a : separator. |
61 | ||
62 | it() for copying from a remote rsync server to the local | |
63 | machine. This is invoked when the source path contains a :: | |
bb18e755 | 64 | separator or an rsync:// URL. |
41059f75 AT |
65 | |
66 | it() for copying from the local machine to a remote rsync | |
67 | server. This is invoked when the destination path contains a :: | |
bb18e755 | 68 | separator or an rsync:// URL. |
039faa86 | 69 | |
bef49340 WD |
70 | it() for copying from a remote machine using a remote shell |
71 | program as the transport, using rsync server on the remote | |
72 | machine. This is invoked when the source path contains a :: | |
73 | separator and the --rsh=COMMAND (aka "-e COMMAND") option is | |
74 | also provided. | |
75 | ||
76 | it() for copying from the local machine to a remote machine | |
77 | using a remote shell program as the transport, using rsync | |
78 | server on the remote machine. This is invoked when the | |
79 | destination path contains a :: separator and the | |
4d888108 | 80 | --rsh=COMMAND option is also provided. |
bef49340 | 81 | |
039faa86 AT |
82 | it() for listing files on a remote machine. This is done the |
83 | same way as rsync transfers except that you leave off the | |
84 | local destination. | |
41059f75 AT |
85 | ) |
86 | ||
14d43f1f DD |
87 | Note that in all cases (other than listing) at least one of the source |
88 | and destination paths must be local. | |
41059f75 AT |
89 | |
90 | manpagesection(SETUP) | |
91 | ||
92 | See the file README for installation instructions. | |
93 | ||
1bbf83c0 WD |
94 | Once installed, you can use rsync to any machine that you can access via |
95 | a remote shell (as well as some that you can access using the rsync | |
43cd760f | 96 | daemon-mode protocol). For remote transfers, a modern rsync uses ssh |
1bbf83c0 | 97 | for its communications, but it may have been configured to use a |
43cd760f | 98 | different remote shell by default, such as rsh or remsh. |
41059f75 | 99 | |
1bbf83c0 | 100 | You can also specify any remote shell you like, either by using the -e |
41059f75 AT |
101 | command line option, or by setting the RSYNC_RSH environment variable. |
102 | ||
103 | One common substitute is to use ssh, which offers a high degree of | |
104 | security. | |
105 | ||
8e987130 AT |
106 | Note that rsync must be installed on both the source and destination |
107 | machines. | |
108 | ||
41059f75 AT |
109 | manpagesection(USAGE) |
110 | ||
111 | You use rsync in the same way you use rcp. You must specify a source | |
112 | and a destination, one of which may be remote. | |
113 | ||
4d888108 | 114 | Perhaps the best way to explain the syntax is with some examples: |
41059f75 AT |
115 | |
116 | quote(rsync *.c foo:src/) | |
117 | ||
8a97fc2e | 118 | This would transfer all files matching the pattern *.c from the |
41059f75 AT |
119 | current directory to the directory src on the machine foo. If any of |
120 | the files already exist on the remote system then the rsync | |
121 | remote-update protocol is used to update the file by sending only the | |
122 | differences. See the tech report for details. | |
123 | ||
124 | quote(rsync -avz foo:src/bar /data/tmp) | |
125 | ||
8a97fc2e | 126 | This would recursively transfer all files from the directory src/bar on the |
41059f75 AT |
127 | machine foo into the /data/tmp/bar directory on the local machine. The |
128 | files are transferred in "archive" mode, which ensures that symbolic | |
b5accaba | 129 | links, devices, attributes, permissions, ownerships, etc. are preserved |
14d43f1f | 130 | in the transfer. Additionally, compression will be used to reduce the |
41059f75 AT |
131 | size of data portions of the transfer. |
132 | ||
133 | quote(rsync -avz foo:src/bar/ /data/tmp) | |
134 | ||
8a97fc2e WD |
135 | A trailing slash on the source changes this behavior to avoid creating an |
136 | additional directory level at the destination. You can think of a trailing | |
137 | / on a source as meaning "copy the contents of this directory" as opposed | |
138 | to "copy the directory by name", but in both cases the attributes of the | |
139 | containing directory are transferred to the containing directory on the | |
140 | destination. In other words, each of the following commands copies the | |
141 | files in the same way, including their setting of the attributes of | |
142 | /dest/foo: | |
143 | ||
144 | quote(rsync -avz /src/foo /dest) | |
145 | quote(rsync -avz /src/foo/ /dest/foo) | |
41059f75 AT |
146 | |
147 | You can also use rsync in local-only mode, where both the source and | |
148 | destination don't have a ':' in the name. In this case it behaves like | |
149 | an improved copy command. | |
150 | ||
14d43f1f DD |
151 | quote(rsync somehost.mydomain.com::) |
152 | ||
8a97fc2e | 153 | This would list all the anonymous rsync modules available on the host |
14d43f1f DD |
154 | somehost.mydomain.com. (See the following section for more details.) |
155 | ||
41059f75 AT |
156 | |
157 | manpagesection(CONNECTING TO AN RSYNC SERVER) | |
158 | ||
1bbf83c0 | 159 | It is also possible to use rsync without a remote shell as the |
41059f75 AT |
160 | transport. In this case you will connect to a remote rsync server |
161 | running on TCP port 873. | |
162 | ||
eb06fa95 | 163 | You may establish the connection via a web proxy by setting the |
4c3b4b25 | 164 | environment variable RSYNC_PROXY to a hostname:port pair pointing to |
4d888108 WD |
165 | your web proxy. Note that your web proxy's configuration must support |
166 | proxy connections to port 873. | |
4c3b4b25 | 167 | |
1bbf83c0 | 168 | Using rsync in this way is the same as using it with a remote shell except |
41059f75 AT |
169 | that: |
170 | ||
171 | itemize( | |
172 | it() you use a double colon :: instead of a single colon to | |
bb18e755 | 173 | separate the hostname from the path or an rsync:// URL. |
41059f75 AT |
174 | |
175 | it() the remote server may print a message of the day when you | |
14d43f1f | 176 | connect. |
41059f75 AT |
177 | |
178 | it() if you specify no path name on the remote server then the | |
179 | list of accessible paths on the server will be shown. | |
14d43f1f | 180 | |
f7632fc6 | 181 | it() if you specify no local destination then a listing of the |
14d43f1f | 182 | specified files on the remote server is provided. |
41059f75 AT |
183 | ) |
184 | ||
4c3d16be AT |
185 | Some paths on the remote server may require authentication. If so then |
186 | you will receive a password prompt when you connect. You can avoid the | |
187 | password prompt by setting the environment variable RSYNC_PASSWORD to | |
65575e96 AT |
188 | the password you want to use or using the --password-file option. This |
189 | may be useful when scripting rsync. | |
4c3d16be | 190 | |
3bc67f0c | 191 | WARNING: On some systems environment variables are visible to all |
65575e96 | 192 | users. On those systems using --password-file is recommended. |
3bc67f0c | 193 | |
bef49340 WD |
194 | manpagesection(CONNECTING TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) |
195 | ||
196 | It is sometimes useful to be able to set up file transfers using rsync | |
43cd760f WD |
197 | server capabilities on the remote machine, while still using ssh or |
198 | rsh for transport. This is especially useful when you want to connect | |
bef49340 WD |
199 | to a remote machine via ssh (for encryption or to get through a |
200 | firewall), but you still want to have access to the rsync server | |
201 | features (see RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM, | |
202 | below). | |
203 | ||
204 | From the user's perspective, using rsync in this way is the same as | |
205 | using it to connect to an rsync server, except that you must | |
206 | explicitly set the remote shell program on the command line with | |
207 | --rsh=COMMAND. (Setting RSYNC_RSH in the environment will not turn on | |
208 | this functionality.) | |
209 | ||
210 | In order to distinguish between the remote-shell user and the rsync | |
211 | server user, you can use '-l user' on your remote-shell command: | |
212 | ||
213 | quote(rsync -av --rsh="ssh -l ssh-user" rsync-user@host::module[/path] local-path) | |
214 | ||
215 | The "ssh-user" will be used at the ssh level; the "rsync-user" will be | |
216 | used to check against the rsyncd.conf on the remote host. | |
217 | ||
41059f75 AT |
218 | manpagesection(RUNNING AN RSYNC SERVER) |
219 | ||
4d888108 | 220 | An rsync server is configured using a configuration file. Please see the |
30e8c8e1 DD |
221 | rsyncd.conf(5) man page for more information. By default the configuration |
222 | file is called /etc/rsyncd.conf, unless rsync is running over a remote | |
223 | shell program and is not running as root; in that case, the default name | |
224 | is rsyncd.conf in the current directory on the remote computer | |
225 | (typically $HOME). | |
41059f75 | 226 | |
bef49340 WD |
227 | manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) |
228 | ||
229 | See the rsyncd.conf(5) man page for full information on the rsync | |
230 | server configuration file. | |
231 | ||
232 | Several configuration options will not be available unless the remote | |
233 | user is root (e.g. chroot, setuid/setgid, etc.). There is no need to | |
234 | configure inetd or the services map to include the rsync server port | |
235 | if you run an rsync server only via a remote shell program. | |
236 | ||
e6f9e388 WD |
237 | To run an rsync server out of a single-use ssh key, see this section |
238 | in the rsyncd.conf(5) man page. | |
bef49340 | 239 | |
41059f75 AT |
240 | manpagesection(EXAMPLES) |
241 | ||
242 | Here are some examples of how I use rsync. | |
243 | ||
14d43f1f DD |
244 | To backup my wife's home directory, which consists of large MS Word |
245 | files and mail folders, I use a cron job that runs | |
41059f75 AT |
246 | |
247 | quote(rsync -Cavz . arvidsjaur:backup) | |
248 | ||
f39281ae | 249 | each night over a PPP connection to a duplicate directory on my machine |
41059f75 AT |
250 | "arvidsjaur". |
251 | ||
252 | To synchronize my samba source trees I use the following Makefile | |
253 | targets: | |
254 | ||
255 | quote( get:nl() | |
256 | rsync -avuzb --exclude '*~' samba:samba/ . | |
257 | ||
258 | put:nl() | |
259 | rsync -Cavuzb . samba:samba/ | |
260 | ||
261 | sync: get put) | |
262 | ||
263 | this allows me to sync with a CVS directory at the other end of the | |
f39281ae | 264 | connection. I then do cvs operations on the remote machine, which saves a |
41059f75 AT |
265 | lot of time as the remote cvs protocol isn't very efficient. |
266 | ||
267 | I mirror a directory between my "old" and "new" ftp sites with the | |
268 | command | |
269 | ||
270 | quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba") | |
271 | ||
272 | this is launched from cron every few hours. | |
273 | ||
c95da96a AT |
274 | manpagesection(OPTIONS SUMMARY) |
275 | ||
14d43f1f | 276 | Here is a short summary of the options available in rsync. Please refer |
c95da96a AT |
277 | to the detailed description below for a complete description. |
278 | ||
279 | verb( | |
280 | -v, --verbose increase verbosity | |
b86f0cef | 281 | -q, --quiet decrease verbosity |
c95da96a | 282 | -c, --checksum always checksum |
06891710 | 283 | -a, --archive archive mode, equivalent to -rlptgoD |
c95da96a AT |
284 | -r, --recursive recurse into directories |
285 | -R, --relative use relative path names | |
f177b7cc WD |
286 | --no-relative turn off --relative |
287 | --no-implied-dirs don't send implied dirs with -R | |
915dd207 | 288 | -b, --backup make backups (see --suffix & --backup-dir) |
5b56cc19 | 289 | --backup-dir make backups into this directory |
915dd207 | 290 | --suffix=SUFFIX backup suffix (default ~ w/o --backup-dir) |
c95da96a | 291 | -u, --update update only (don't overwrite newer files) |
a3221d2a | 292 | --inplace update the destination file inplace |
716e73d4 | 293 | -K, --keep-dirlinks treat symlinked dir on receiver as dir |
eb06fa95 | 294 | -l, --links copy symlinks as symlinks |
7af4227a WD |
295 | -L, --copy-links copy the referent of all symlinks |
296 | --copy-unsafe-links copy the referent of "unsafe" symlinks | |
297 | --safe-links ignore "unsafe" symlinks | |
c95da96a AT |
298 | -H, --hard-links preserve hard links |
299 | -p, --perms preserve permissions | |
300 | -o, --owner preserve owner (root only) | |
301 | -g, --group preserve group | |
302 | -D, --devices preserve devices (root only) | |
303 | -t, --times preserve times | |
304 | -S, --sparse handle sparse files efficiently | |
305 | -n, --dry-run show what would have been transferred | |
306 | -W, --whole-file copy whole files, no incremental checks | |
93689aa5 | 307 | --no-whole-file turn off --whole-file |
c95da96a | 308 | -x, --one-file-system don't cross filesystem boundaries |
9ef53907 | 309 | -B, --block-size=SIZE checksum blocking size (default 700) |
915dd207 | 310 | -e, --rsh=COMMAND specify the remote shell |
d9fcc198 | 311 | --rsync-path=PATH specify path to rsync on the remote machine |
1347d512 | 312 | --existing only update files that already exist |
915dd207 WD |
313 | --ignore-existing ignore files that already exist on receiver |
314 | --delete delete files that don't exist on sender | |
315 | --delete-excluded also delete excluded files on receiver | |
d48c8065 | 316 | --delete-after receiver deletes after transfer, not before |
b5accaba | 317 | --ignore-errors delete even if there are I/O errors |
0b73ca12 | 318 | --max-delete=NUM don't delete more than NUM files |
c95da96a | 319 | --partial keep partially transferred files |
915dd207 | 320 | --force force deletion of dirs even if not empty |
c95da96a | 321 | --numeric-ids don't map uid/gid values by user/group name |
b5accaba | 322 | --timeout=TIME set I/O timeout in seconds |
915dd207 WD |
323 | -I, --ignore-times turn off mod time & file size quick check |
324 | --size-only ignore mod time for quick check (use size) | |
f6aeaa74 | 325 | --modify-window=NUM compare mod times with reduced accuracy |
c95da96a | 326 | -T --temp-dir=DIR create temporary files in directory DIR |
915dd207 | 327 | --compare-dest=DIR also compare received files relative to DIR |
59c95e42 | 328 | --link-dest=DIR create hardlinks to DIR for unchanged files |
d9fcc198 | 329 | -P equivalent to --partial --progress |
c95da96a | 330 | -z, --compress compress file data |
f177b7cc | 331 | -C, --cvs-exclude auto ignore files in the same way CVS does |
2acf81eb | 332 | --exclude=PATTERN exclude files matching PATTERN |
9ef53907 | 333 | --exclude-from=FILE exclude patterns listed in FILE |
2acf81eb | 334 | --include=PATTERN don't exclude files matching PATTERN |
9ef53907 | 335 | --include-from=FILE don't exclude patterns listed in FILE |
f177b7cc | 336 | --files-from=FILE read FILE for list of source-file names |
915dd207 | 337 | -0 --from0 all file lists are delimited by nulls |
c95da96a | 338 | --version print version number |
bb18e755 | 339 | --daemon run as an rsync daemon |
bbd6f4ba | 340 | --no-detach do not detach from the parent |
2a951cd2 | 341 | --address=ADDRESS bind to the specified address |
c95da96a AT |
342 | --config=FILE specify alternate rsyncd.conf file |
343 | --port=PORT specify alternate rsyncd port number | |
b5accaba | 344 | --blocking-io use blocking I/O for the remote shell |
93689aa5 | 345 | --no-blocking-io turn off --blocking-io |
c95da96a | 346 | --stats give some file transfer stats |
eb86d661 | 347 | --progress show progress during transfer |
b6062654 | 348 | --log-format=FORMAT log file transfers using specified format |
9ef53907 | 349 | --password-file=FILE get password from FILE |
ef5d23eb | 350 | --bwlimit=KBPS limit I/O bandwidth, KBytes per second |
b9f592fb WD |
351 | --write-batch=FILE write a batch to FILE |
352 | --read-batch=FILE read a batch from FILE | |
c8d895de | 353 | --checksum-seed=NUM set block/file checksum seed |
e40a46de WD |
354 | -4 --ipv4 prefer IPv4 |
355 | -6 --ipv6 prefer IPv6 | |
c95da96a | 356 | -h, --help show this help screen |
6902ed17 MP |
357 | |
358 | ||
c95da96a AT |
359 | ) |
360 | ||
41059f75 AT |
361 | manpageoptions() |
362 | ||
363 | rsync uses the GNU long options package. Many of the command line | |
364 | options have two variants, one short and one long. These are shown | |
14d43f1f | 365 | below, separated by commas. Some options only have a long variant. |
b5679335 DD |
366 | The '=' for options that take a parameter is optional; whitespace |
367 | can be used instead. | |
41059f75 AT |
368 | |
369 | startdit() | |
370 | dit(bf(-h, --help)) Print a short help page describing the options | |
371 | available in rsync | |
372 | ||
373 | dit(bf(--version)) print the rsync version number and exit | |
374 | ||
375 | dit(bf(-v, --verbose)) This option increases the amount of information you | |
14d43f1f | 376 | are given during the transfer. By default, rsync works silently. A |
41059f75 AT |
377 | single -v will give you information about what files are being |
378 | transferred and a brief summary at the end. Two -v flags will give you | |
379 | information on what files are being skipped and slightly more | |
380 | information at the end. More than two -v flags should only be used if | |
14d43f1f | 381 | you are debugging rsync. |
41059f75 | 382 | |
b86f0cef DD |
383 | dit(bf(-q, --quiet)) This option decreases the amount of information you |
384 | are given during the transfer, notably suppressing information messages | |
385 | from the remote server. This flag is useful when invoking rsync from | |
386 | cron. | |
387 | ||
41059f75 | 388 | dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are |
915dd207 WD |
389 | already the same size and have the same modification time-stamp. |
390 | This option turns off this "quick check" behavior. | |
41059f75 | 391 | |
a03a9f4e | 392 | dit(bf(--size-only)) Normally rsync will not transfer any files that are |
915dd207 | 393 | already the same size and have the same modification time-stamp. With the |
a03a9f4e | 394 | --size-only option, files will not be transferred if they have the same size, |
f83f0548 AT |
395 | regardless of timestamp. This is useful when starting to use rsync |
396 | after using another mirroring system which may not preserve timestamps | |
397 | exactly. | |
398 | ||
5b56cc19 AT |
399 | dit(bf(--modify-window)) When comparing two timestamps rsync treats |
400 | the timestamps as being equal if they are within the value of | |
401 | modify_window. This is normally zero, but you may find it useful to | |
402 | set this to a larger value in some situations. In particular, when | |
38843171 DD |
403 | transferring to Windows FAT filesystems which cannot represent times |
404 | with a 1 second resolution --modify-window=1 is useful. | |
5b56cc19 | 405 | |
41059f75 AT |
406 | dit(bf(-c, --checksum)) This forces the sender to checksum all files using |
407 | a 128-bit MD4 checksum before transfer. The checksum is then | |
408 | explicitly checked on the receiver and any files of the same name | |
409 | which already exist and have the same checksum and size on the | |
a03a9f4e | 410 | receiver are not transferred. This option can be quite slow. |
41059f75 | 411 | |
e7bf3e5e MP |
412 | dit(bf(-a, --archive)) This is equivalent to -rlptgoD. It is a quick |
413 | way of saying you want recursion and want to preserve almost | |
414 | everything. | |
415 | ||
416 | Note however that bf(-a) bf(does not preserve hardlinks), because | |
417 | finding multiply-linked files is expensive. You must separately | |
418 | specify bf(-H). | |
41059f75 | 419 | |
24986abd AT |
420 | dit(bf(-r, --recursive)) This tells rsync to copy directories |
421 | recursively. If you don't specify this then rsync won't copy | |
422 | directories at all. | |
41059f75 AT |
423 | |
424 | dit(bf(-R, --relative)) Use relative paths. This means that the full path | |
425 | names specified on the command line are sent to the server rather than | |
426 | just the last parts of the filenames. This is particularly useful when | |
14d43f1f DD |
427 | you want to send several different directories at the same time. For |
428 | example, if you used the command | |
41059f75 AT |
429 | |
430 | verb(rsync foo/bar/foo.c remote:/tmp/) | |
431 | ||
432 | then this would create a file called foo.c in /tmp/ on the remote | |
433 | machine. If instead you used | |
434 | ||
435 | verb(rsync -R foo/bar/foo.c remote:/tmp/) | |
436 | ||
437 | then a file called /tmp/foo/bar/foo.c would be created on the remote | |
f177b7cc WD |
438 | machine -- the full path name is preserved. |
439 | ||
440 | dit(bf(--no-relative)) Turn off the --relative option. This is only | |
441 | needed if you want to use --files-from without its implied --relative | |
442 | file processing. | |
443 | ||
444 | dit(bf(--no-implied-dirs)) When combined with the --relative option, the | |
445 | implied directories in each path are not explicitly duplicated as part | |
446 | of the transfer. This makes the transfer more optimal and also allows | |
447 | the two sides to have non-matching symlinks in the implied part of the | |
448 | path. For instance, if you transfer the file "/path/foo/file" with -R, | |
449 | the default is for rsync to ensure that "/path" and "/path/foo" on the | |
450 | destination exactly match the directories/symlinks of the source. Using | |
451 | the --no-implied-dirs option would omit both of these implied dirs, | |
452 | which means that if "/path" was a real directory on one machine and a | |
453 | symlink of the other machine, rsync would not try to change this. | |
41059f75 | 454 | |
b19fd07c WD |
455 | dit(bf(-b, --backup)) With this option, preexisting destination files are |
456 | renamed as each file is transferred or deleted. You can control where the | |
457 | backup file goes and what (if any) suffix gets appended using the | |
458 | --backup-dir and --suffix options. | |
41059f75 | 459 | |
66203a98 AT |
460 | dit(bf(--backup-dir=DIR)) In combination with the --backup option, this |
461 | tells rsync to store all backups in the specified directory. This is | |
759ac870 DD |
462 | very useful for incremental backups. You can additionally |
463 | specify a backup suffix using the --suffix option | |
464 | (otherwise the files backed up in the specified directory | |
465 | will keep their original filenames). | |
0b79c324 WD |
466 | If DIR is a relative path, it is relative to the destination directory |
467 | (which changes in a recursive transfer). | |
66203a98 | 468 | |
b5679335 | 469 | dit(bf(--suffix=SUFFIX)) This option allows you to override the default |
b19fd07c WD |
470 | backup suffix used with the --backup (-b) option. The default suffix is a ~ |
471 | if no --backup-dir was specified, otherwise it is an empty string. | |
9ef53907 | 472 | |
41059f75 AT |
473 | dit(bf(-u, --update)) This forces rsync to skip any files for which the |
474 | destination file already exists and has a date later than the source | |
475 | file. | |
476 | ||
adddd075 WD |
477 | In the currently implementation, a difference of file format is always |
478 | considered to be important enough for an update, no matter what date | |
479 | is on the objects. In other words, if the source has a directory or a | |
480 | symlink where the destination has a file, the transfer would occur | |
481 | regardless of the timestamps. This might change in the future (feel | |
482 | free to comment on this on the mailing list if you have an opinion). | |
483 | ||
716e73d4 WD |
484 | dit(bf(-K, --keep-dirlinks)) On the receiving side, if a symlink is |
485 | pointing to a directory, it will be treated as matching a directory | |
486 | from the sender. | |
487 | ||
a3221d2a WD |
488 | dit(bf(--inplace)) This causes rsync not to create a new copy of the file |
489 | and then move it into place. Instead rsync will overwrite the existing | |
490 | file, meaning that the rsync algorithm can't extract the full ammount of | |
491 | network reduction it might otherwise. | |
492 | ||
493 | This option is useful for transfer of large files with block based changes | |
494 | and also on systems that are disk bound not network bound. | |
495 | ||
399371e7 WD |
496 | WARNING: The file's data will be in an inconsistent state during the |
497 | transfer (and possibly afterwards if the transfer gets interrupted), so you | |
498 | should not use this option to update files that are in use. Also note that | |
499 | rsync will not update a file inplace that is not writable by the receiving | |
500 | user. | |
a3221d2a | 501 | |
eb06fa95 MP |
502 | dit(bf(-l, --links)) When symlinks are encountered, recreate the |
503 | symlink on the destination. | |
41059f75 | 504 | |
eb06fa95 | 505 | dit(bf(-L, --copy-links)) When symlinks are encountered, the file that |
7af4227a | 506 | they point to (the referent) is copied, rather than the symlink. |
b5313607 | 507 | |
eb06fa95 | 508 | dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of |
7af4227a | 509 | symbolic links that point outside the copied tree. Absolute symlinks |
eb06fa95 MP |
510 | are also treated like ordinary files, and so are any symlinks in the |
511 | source path itself when --relative is used. | |
41059f75 | 512 | |
d310a212 | 513 | dit(bf(--safe-links)) This tells rsync to ignore any symbolic links |
7af4227a | 514 | which point outside the copied tree. All absolute symlinks are |
d310a212 | 515 | also ignored. Using this option in conjunction with --relative may |
14d43f1f | 516 | give unexpected results. |
d310a212 | 517 | |
41059f75 AT |
518 | dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on |
519 | the remote system to be the same as the local system. Without this | |
520 | option hard links are treated like regular files. | |
521 | ||
522 | Note that rsync can only detect hard links if both parts of the link | |
523 | are in the list of files being sent. | |
524 | ||
525 | This option can be quite slow, so only use it if you need it. | |
526 | ||
527 | dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm | |
a1a440c2 DD |
528 | is not used and the whole file is sent as-is instead. The transfer may be |
529 | faster if this option is used when the bandwidth between the source and | |
6eb770bb | 530 | destination machines is higher than the bandwidth to disk (especially when the |
4d888108 | 531 | "disk" is actually a networked filesystem). This is the default when both |
6eb770bb | 532 | the source and destination are specified as local paths. |
41059f75 | 533 | |
93689aa5 DD |
534 | dit(bf(--no-whole-file)) Turn off --whole-file, for use when it is the |
535 | default. | |
536 | ||
8dc74608 WD |
537 | dit(bf(-p, --perms)) This option causes rsync to set the destination |
538 | permissions to be the same as the source permissions. | |
539 | ||
540 | Without this option, each new file gets its permissions set based on the | |
541 | source file's permissions and the umask at the receiving end, while all | |
542 | other files (including updated files) retain their existing permissions | |
543 | (which is the same behavior as other file-copy utilities, such as cp). | |
41059f75 | 544 | |
eb06fa95 MP |
545 | dit(bf(-o, --owner)) This option causes rsync to set the owner of the |
546 | destination file to be the same as the source file. On most systems, | |
a2b0471f WD |
547 | only the super-user can set file ownership. By default, the preservation |
548 | is done by name, but may fall back to using the ID number in some | |
549 | circumstances. See the --numeric-ids option for a full discussion. | |
41059f75 | 550 | |
eb06fa95 MP |
551 | dit(bf(-g, --group)) This option causes rsync to set the group of the |
552 | destination file to be the same as the source file. If the receiving | |
553 | program is not running as the super-user, only groups that the | |
a2b0471f WD |
554 | receiver is a member of will be preserved. By default, the preservation |
555 | is done by name, but may fall back to using the ID number in some | |
556 | circumstances. See the --numeric-ids option for a full discussion. | |
41059f75 AT |
557 | |
558 | dit(bf(-D, --devices)) This option causes rsync to transfer character and | |
559 | block device information to the remote system to recreate these | |
560 | devices. This option is only available to the super-user. | |
561 | ||
562 | dit(bf(-t, --times)) This tells rsync to transfer modification times along | |
baf3e504 DD |
563 | with the files and update them on the remote system. Note that if this |
564 | option is not used, the optimization that excludes files that have not been | |
565 | modified cannot be effective; in other words, a missing -t or -a will | |
566 | cause the next transfer to behave as if it used -I, and all files will have | |
567 | their checksums compared and show up in log messages even if they haven't | |
568 | changed. | |
41059f75 AT |
569 | |
570 | dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers, | |
571 | instead it will just report the actions it would have taken. | |
572 | ||
573 | dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take | |
574 | up less space on the destination. | |
575 | ||
d310a212 AT |
576 | NOTE: Don't use this option when the destination is a Solaris "tmpfs" |
577 | filesystem. It doesn't seem to handle seeks over null regions | |
578 | correctly and ends up corrupting the files. | |
579 | ||
41059f75 AT |
580 | dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem |
581 | boundaries when recursing. This is useful for transferring the | |
582 | contents of only one filesystem. | |
583 | ||
1347d512 AT |
584 | dit(bf(--existing)) This tells rsync not to create any new files - |
585 | only update files that already exist on the destination. | |
586 | ||
3d6feada MP |
587 | dit(bf(--ignore-existing)) |
588 | This tells rsync not to update files that already exist on | |
589 | the destination. | |
590 | ||
0b73ca12 AT |
591 | dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM |
592 | files or directories. This is useful when mirroring very large trees | |
593 | to prevent disasters. | |
594 | ||
41059f75 | 595 | dit(bf(--delete)) This tells rsync to delete any files on the receiving |
b33b791e DD |
596 | side that aren't on the sending side. Files that are excluded from |
597 | transfer are excluded from being deleted unless you use --delete-excluded. | |
41059f75 | 598 | |
24986abd AT |
599 | This option has no effect if directory recursion is not selected. |
600 | ||
b33b791e DD |
601 | This option can be dangerous if used incorrectly! It is a very good idea |
602 | to run first using the dry run option (-n) to see what files would be | |
603 | deleted to make sure important files aren't listed. | |
41059f75 | 604 | |
b5accaba | 605 | If the sending side detects any I/O errors then the deletion of any |
3e578a19 AT |
606 | files at the destination will be automatically disabled. This is to |
607 | prevent temporary filesystem failures (such as NFS errors) on the | |
608 | sending side causing a massive deletion of files on the | |
2c5548d2 | 609 | destination. You can override this with the --ignore-errors option. |
41059f75 | 610 | |
b33b791e DD |
611 | dit(bf(--delete-excluded)) In addition to deleting the files on the |
612 | receiving side that are not on the sending side, this tells rsync to also | |
613 | delete any files on the receiving side that are excluded (see --exclude). | |
786c3687 | 614 | Implies --delete. |
b33b791e | 615 | |
d48c8065 WD |
616 | dit(bf(--delete-after)) By default rsync does file deletions on the |
617 | receiving side before transferring files to try to ensure that there is | |
618 | sufficient space on the receiving filesystem. If you want to delete | |
619 | after transferring, use the --delete-after switch. Implies --delete. | |
57df171b | 620 | |
2c5548d2 | 621 | dit(bf(--ignore-errors)) Tells --delete to go ahead and delete files |
b5accaba | 622 | even when there are I/O errors. |
2c5548d2 | 623 | |
b695d088 DD |
624 | dit(bf(--force)) This options tells rsync to delete directories even if |
625 | they are not empty when they are to be replaced by non-directories. This | |
626 | is only relevant without --delete because deletions are now done depth-first. | |
627 | Requires the --recursive option (which is implied by -a) to have any effect. | |
41059f75 | 628 | |
e40a46de | 629 | dit(bf(-B, --block-size=BLOCKSIZE)) This controls the block size used in |
41059f75 AT |
630 | the rsync algorithm. See the technical report for details. |
631 | ||
b5679335 | 632 | dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative |
41059f75 | 633 | remote shell program to use for communication between the local and |
43cd760f WD |
634 | remote copies of rsync. Typically, rsync is configured to use ssh by |
635 | default, but you may prefer to use rsh on a local network. | |
41059f75 | 636 | |
bef49340 | 637 | If this option is used with bf([user@]host::module/path), then the |
4d888108 | 638 | remote shell em(COMMAND) will be used to run an rsync server on the |
bef49340 WD |
639 | remote host, and all data will be transmitted through that remote |
640 | shell connection, rather than through a direct socket connection to a | |
2d4ca358 DD |
641 | running rsync server on the remote host. See the section "CONNECTING |
642 | TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM" above. | |
bef49340 | 643 | |
ea7f8108 WD |
644 | Command-line arguments are permitted in COMMAND provided that COMMAND is |
645 | presented to rsync as a single argument. For example: | |
98393ae2 | 646 | |
ea7f8108 | 647 | quote(-e "ssh -p 2234") |
98393ae2 WD |
648 | |
649 | (Note that ssh users can alternately customize site-specific connect | |
650 | options in their .ssh/config file.) | |
651 | ||
41059f75 | 652 | You can also choose the remote shell program using the RSYNC_RSH |
ea7f8108 | 653 | environment variable, which accepts the same range of values as -e. |
41059f75 | 654 | |
735a816e DD |
655 | See also the --blocking-io option which is affected by this option. |
656 | ||
b5679335 | 657 | dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of |
d73ee7b7 AT |
658 | rsync on the remote machine. Useful when it's not in your path. Note |
659 | that this is the full path to the binary, not just the directory that | |
660 | the binary is in. | |
41059f75 | 661 | |
f177b7cc WD |
662 | dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a |
663 | broad range of files that you often don't want to transfer between | |
664 | systems. It uses the same algorithm that CVS uses to determine if | |
665 | a file should be ignored. | |
666 | ||
667 | The exclude list is initialized to: | |
668 | ||
2a383be0 WD |
669 | quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state |
670 | .nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej | |
671 | .del-* *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/) | |
f177b7cc WD |
672 | |
673 | then files listed in a $HOME/.cvsignore are added to the list and any | |
2a383be0 WD |
674 | files listed in the CVSIGNORE environment variable (all cvsignore names |
675 | are delimited by whitespace). | |
676 | ||
f177b7cc | 677 | Finally, any file is ignored if it is in the same directory as a |
2a383be0 | 678 | .cvsignore file and matches one of the patterns listed therein. |
2a383be0 | 679 | See the bf(cvs(1)) manual for more information. |
f177b7cc | 680 | |
b5679335 | 681 | dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude |
41059f75 AT |
682 | certain files from the list of files to be transferred. This is most |
683 | useful in combination with a recursive transfer. | |
684 | ||
41059f75 AT |
685 | You may use as many --exclude options on the command line as you like |
686 | to build up the list of files to exclude. | |
687 | ||
6156e72f | 688 | See the EXCLUDE PATTERNS section for detailed information on this option. |
41059f75 | 689 | |
b5679335 | 690 | dit(bf(--exclude-from=FILE)) This option is similar to the --exclude |
c48b22c8 AT |
691 | option, but instead it adds all exclude patterns listed in the file |
692 | FILE to the exclude list. Blank lines in FILE and lines starting with | |
693 | ';' or '#' are ignored. | |
f8a94f0d DD |
694 | If em(FILE) is bf(-) the list will be read from standard input. |
695 | ||
b5679335 | 696 | dit(bf(--include=PATTERN)) This option tells rsync to not exclude the |
43bd68e5 AT |
697 | specified pattern of filenames. This is useful as it allows you to |
698 | build up quite complex exclude/include rules. | |
699 | ||
6156e72f | 700 | See the EXCLUDE PATTERNS section for detailed information on this option. |
43bd68e5 | 701 | |
b5679335 | 702 | dit(bf(--include-from=FILE)) This specifies a list of include patterns |
43bd68e5 | 703 | from a file. |
c769702f | 704 | If em(FILE) is "-" the list will be read from standard input. |
f8a94f0d | 705 | |
f177b7cc WD |
706 | dit(bf(--files-from=FILE)) Using this option allows you to specify the |
707 | exact list of files to transfer (as read from the specified FILE or "-" | |
c769702f | 708 | for standard input). It also tweaks the default behavior of rsync to make |
f177b7cc WD |
709 | transferring just the specified files and directories easier. For |
710 | instance, the --relative option is enabled by default when this option | |
711 | is used (use --no-relative if you want to turn that off), all | |
712 | directories specified in the list are created on the destination (rather | |
713 | than being noisily skipped without -r), and the -a (--archive) option's | |
714 | behavior does not imply -r (--recursive) -- specify it explicitly, if | |
715 | you want it. | |
716 | ||
717 | The file names that are read from the FILE are all relative to the | |
718 | source dir -- any leading slashes are removed and no ".." references are | |
719 | allowed to go higher than the source dir. For example, take this | |
720 | command: | |
721 | ||
722 | quote(rsync -a --files-from=/tmp/foo /usr remote:/backup) | |
723 | ||
724 | If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin | |
725 | directory will be created as /backup/bin on the remote host (but the | |
726 | contents of the /usr/bin dir would not be sent unless you specified -r | |
727 | or the names were explicitly listed in /tmp/foo). Also keep in mind | |
728 | that the effect of the (enabled by default) --relative option is to | |
729 | duplicate only the path info that is read from the file -- it does not | |
730 | force the duplication of the source-spec path (/usr in this case). | |
731 | ||
732 | In addition, the --files-from file can be read from the remote host | |
733 | instead of the local host if you specify a "host:" in front of the file | |
734 | (the host must match one end of the transfer). As a short-cut, you can | |
735 | specify just a prefix of ":" to mean "use the remote end of the | |
736 | transfer". For example: | |
737 | ||
738 | quote(rsync -a --files-from=:/path/file-list src:/ /tmp/copy) | |
739 | ||
740 | This would copy all the files specified in the /path/file-list file that | |
741 | was located on the remote "src" host. | |
742 | ||
743 | dit(bf(-0, --from0)) This tells rsync that the filenames it reads from a | |
744 | file are terminated by a null ('\0') character, not a NL, CR, or CR+LF. | |
745 | This affects --exclude-from, --include-from, and --files-from. | |
f01b6368 WD |
746 | It does not affect --cvs-exclude (since all names read from a .cvsignore |
747 | file are split on whitespace). | |
41059f75 | 748 | |
b5679335 | 749 | dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a |
375a4556 | 750 | scratch directory when creating temporary copies of the files |
41059f75 AT |
751 | transferred on the receiving side. The default behavior is to create |
752 | the temporary files in the receiving directory. | |
753 | ||
3473b5b4 DD |
754 | dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR on |
755 | the destination machine as an additional directory to compare destination | |
d53d7795 DD |
756 | files against when doing transfers if the files are missing in the |
757 | destination directory. This is useful for doing transfers to a new | |
758 | destination while leaving existing files intact, and then doing a | |
3473b5b4 DD |
759 | flash-cutover when all files have been successfully transferred (for |
760 | example by moving directories around and removing the old directory, | |
d53d7795 DD |
761 | although this skips files that haven't changed; see also --link-dest). |
762 | This option increases the usefulness of --partial because partially | |
763 | transferred files will remain in the new temporary destination until they | |
764 | have a chance to be completed. If DIR is a relative path, it is relative | |
0b79c324 | 765 | to the destination directory (which changes in a recursive transfer). |
375a4556 | 766 | |
59c95e42 DD |
767 | dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but |
768 | also will create hard links from em(DIR) to the destination directory for | |
769 | unchanged files. Files with changed ownership or permissions will not be | |
770 | linked. | |
d31c09c8 | 771 | Like bf(--compare-dest) if DIR is a relative path, it is relative |
0b79c324 | 772 | to the destination directory (which changes in a recursive transfer). |
8429aa9e WD |
773 | An example: |
774 | ||
775 | verb( | |
776 | rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/ | |
777 | ) | |
59c95e42 | 778 | |
41059f75 | 779 | dit(bf(-z, --compress)) With this option, rsync compresses any data from |
089e73f8 | 780 | the files that it sends to the destination machine. This |
f39281ae | 781 | option is useful on slow connections. The compression method used is the |
41059f75 AT |
782 | same method that gzip uses. |
783 | ||
784 | Note this this option typically achieves better compression ratios | |
785 | that can be achieved by using a compressing remote shell, or a | |
786 | compressing transport, as it takes advantage of the implicit | |
787 | information sent for matching data blocks. | |
788 | ||
789 | dit(bf(--numeric-ids)) With this option rsync will transfer numeric group | |
4d888108 | 790 | and user IDs rather than using user and group names and mapping them |
41059f75 AT |
791 | at both ends. |
792 | ||
4d888108 | 793 | By default rsync will use the username and groupname to determine |
41059f75 | 794 | what ownership to give files. The special uid 0 and the special group |
14d43f1f | 795 | 0 are never mapped via user/group names even if the --numeric-ids |
41059f75 AT |
796 | option is not specified. |
797 | ||
ec40899b WD |
798 | If a user or group has no name on the source system or it has no match |
799 | on the destination system, then the numeric ID | |
800 | from the source system is used instead. See also the comments on the | |
a2b0471f WD |
801 | "use chroot" setting in the rsyncd.conf manpage for information on how |
802 | the chroot setting affects rsync's ability to look up the names of the | |
803 | users and groups and what you can do about it. | |
41059f75 | 804 | |
b5accaba | 805 | dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O |
de2fd20e AT |
806 | timeout in seconds. If no data is transferred for the specified time |
807 | then rsync will exit. The default is 0, which means no timeout. | |
41059f75 | 808 | |
eb06fa95 MP |
809 | dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The |
810 | daemon may be accessed using the bf(host::module) or | |
811 | bf(rsync://host/module/) syntax. | |
812 | ||
813 | If standard input is a socket then rsync will assume that it is being | |
814 | run via inetd, otherwise it will detach from the current terminal and | |
815 | become a background daemon. The daemon will read the config file | |
30e8c8e1 | 816 | (rsyncd.conf) on each connect made by a client and respond to |
eb06fa95 MP |
817 | requests accordingly. See the rsyncd.conf(5) man page for more |
818 | details. | |
41059f75 | 819 | |
bbd6f4ba MP |
820 | dit(bf(--no-detach)) When running as a daemon, this option instructs |
821 | rsync to not detach itself and become a background process. This | |
822 | option is required when running as a service on Cygwin, and may also | |
823 | be useful when rsync is supervised by a program such as | |
824 | bf(daemontools) or AIX's bf(System Resource Controller). | |
825 | bf(--no-detach) is also recommended when rsync is run under a | |
826 | debugger. This option has no effect if rsync is run from inetd or | |
827 | sshd. | |
828 | ||
5c9730a4 | 829 | dit(bf(--address)) By default rsync will bind to the wildcard address |
e30f0657 AT |
830 | when run as a daemon with the --daemon option or when connecting to a |
831 | rsync server. The --address option allows you to specify a specific IP | |
832 | address (or hostname) to bind to. This makes virtual hosting possible | |
833 | in conjunction with the --config option. | |
5c9730a4 | 834 | |
b5679335 | 835 | dit(bf(--config=FILE)) This specifies an alternate config file than |
30e8c8e1 DD |
836 | the default. This is only relevant when --daemon is specified. |
837 | The default is /etc/rsyncd.conf unless the daemon is running over | |
838 | a remote shell program and the remote user is not root; in that case | |
839 | the default is rsyncd.conf in the current directory (typically $HOME). | |
41059f75 | 840 | |
b5679335 | 841 | dit(bf(--port=PORT)) This specifies an alternate TCP port number to use |
14d43f1f | 842 | rather than the default port 873. |
41059f75 | 843 | |
b5accaba | 844 | dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching |
314a74d7 WD |
845 | a remote shell transport. If the remote shell is either rsh or remsh, |
846 | rsync defaults to using | |
b5accaba WD |
847 | blocking I/O, otherwise it defaults to using non-blocking I/O. (Note that |
848 | ssh prefers non-blocking I/O.) | |
64c704f0 | 849 | |
93689aa5 DD |
850 | dit(bf(--no-blocking-io)) Turn off --blocking-io, for use when it is the |
851 | default. | |
852 | ||
3a64ad1f | 853 | dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the |
14d43f1f | 854 | rsync client logs to stdout on a per-file basis. The log format is |
3a64ad1f DD |
855 | specified using the same format conventions as the log format option in |
856 | rsyncd.conf. | |
b6062654 | 857 | |
b72f24c7 AT |
858 | dit(bf(--stats)) This tells rsync to print a verbose set of statistics |
859 | on the file transfer, allowing you to tell how effective the rsync | |
e19452a9 | 860 | algorithm is for your data. |
b72f24c7 | 861 | |
d9fcc198 AT |
862 | dit(bf(--partial)) By default, rsync will delete any partially |
863 | transferred file if the transfer is interrupted. In some circumstances | |
864 | it is more desirable to keep partially transferred files. Using the | |
865 | --partial option tells rsync to keep the partial file which should | |
866 | make a subsequent transfer of the rest of the file much faster. | |
867 | ||
eb86d661 AT |
868 | dit(bf(--progress)) This option tells rsync to print information |
869 | showing the progress of the transfer. This gives a bored user | |
870 | something to watch. | |
e2559dbe | 871 | Implies --verbose without incrementing verbosity. |
7b10f91d | 872 | |
68f9910d WD |
873 | When the file is transferring, the data looks like this: |
874 | ||
875 | verb( | |
876 | 782448 63% 110.64kB/s 0:00:04 | |
877 | ) | |
878 | ||
879 | This tells you the current file size, the percentage of the transfer that | |
880 | is complete, the current calculated file-completion rate (including both | |
881 | data over the wire and data being matched locally), and the estimated time | |
882 | remaining in this transfer. | |
883 | ||
884 | After the a file is complete, it the data looks like this: | |
885 | ||
886 | verb( | |
887 | 1238099 100% 146.38kB/s 0:00:08 (5, 57.1% of 396) | |
888 | ) | |
889 | ||
890 | This tells you the final file size, that it's 100% complete, the final | |
891 | transfer rate for the file, the amount of elapsed time it took to transfer | |
892 | the file, and the addition of a total-transfer summary in parentheses. | |
893 | These additional numbers tell you how many files have been updated, and | |
894 | what percent of the total number of files has been scanned. | |
895 | ||
d9fcc198 AT |
896 | dit(bf(-P)) The -P option is equivalent to --partial --progress. I |
897 | found myself typing that combination quite often so I created an | |
898 | option to make it easier. | |
899 | ||
65575e96 AT |
900 | dit(bf(--password-file)) This option allows you to provide a password |
901 | in a file for accessing a remote rsync server. Note that this option | |
bb18e755 | 902 | is only useful when accessing an rsync server using the built in |
65575e96 | 903 | transport, not when using a remote shell as the transport. The file |
fc7952e7 AT |
904 | must not be world readable. It should contain just the password as a |
905 | single line. | |
65575e96 | 906 | |
ef5d23eb DD |
907 | dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum |
908 | transfer rate in kilobytes per second. This option is most effective when | |
909 | using rsync with large files (several megabytes and up). Due to the nature | |
910 | of rsync transfers, blocks of data are sent, then if rsync determines the | |
911 | transfer was too fast, it will wait before sending the next data block. The | |
4d888108 | 912 | result is an average transfer rate equaling the specified limit. A value |
ef5d23eb DD |
913 | of zero specifies no limit. |
914 | ||
b9f592fb WD |
915 | dit(bf(--write-batch=FILE)) Record a file that can later be applied to |
916 | anonther identical destination with --read-batch. See the "BATCH MODE" | |
917 | section for details. | |
6902ed17 | 918 | |
b9f592fb | 919 | dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a |
c769702f | 920 | file previously generated by --write-batch. |
399371e7 | 921 | If em(FILE) is "-" the batch data will be read from standard input. |
c769702f | 922 | See the "BATCH MODE" section for details. |
6902ed17 | 923 | |
e40a46de WD |
924 | dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6 |
925 | when creating sockets. This only affects sockets that rsync has direct | |
926 | control over, such as the outgoing socket when directly contacting an | |
927 | rsync daemon, or the incoming sockets that an rsync daemon uses to | |
928 | listen for connections. One of these options may be required in older | |
929 | versions of Linux to work around an IPv6 bug in the kernel (if you see | |
930 | an "address already in use" error when nothing else is using the port, | |
931 | try specifying --ipv6 or --ipv4 when starting the daemon). | |
932 | ||
c8d895de WD |
933 | dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer |
934 | NUM. This 4 byte checksum seed is included in each block and file | |
935 | MD4 checksum calculation. By default the checksum seed is generated | |
b9f592fb | 936 | by the server and defaults to the current time(). This option |
c8d895de WD |
937 | is used to set a specific checksum seed, which is useful for |
938 | applications that want repeatable block and file checksums, or | |
939 | in the case where the user wants a more random checksum seed. | |
940 | Note that setting NUM to 0 causes rsync to use the default of time() | |
b9f592fb | 941 | for checksum seed. |
c8d895de | 942 | |
41059f75 AT |
943 | enddit() |
944 | ||
43bd68e5 AT |
945 | manpagesection(EXCLUDE PATTERNS) |
946 | ||
947 | The exclude and include patterns specified to rsync allow for flexible | |
14d43f1f | 948 | selection of which files to transfer and which files to skip. |
43bd68e5 | 949 | |
be92ac6c | 950 | Rsync builds an ordered list of include/exclude options as specified on |
98606687 | 951 | the command line. Rsync checks each file and directory |
43bd68e5 | 952 | name against each exclude/include pattern in turn. The first matching |
23489269 | 953 | pattern is acted on. If it is an exclude pattern, then that file is |
43bd68e5 AT |
954 | skipped. If it is an include pattern then that filename is not |
955 | skipped. If no matching include/exclude pattern is found then the | |
956 | filename is not skipped. | |
957 | ||
a4b6f305 WD |
958 | The filenames matched against the exclude/include patterns are relative |
959 | to the "root of the transfer". If you think of the transfer as a | |
960 | subtree of names that are being sent from sender to receiver, the root | |
961 | is where the tree starts to be duplicated in the destination directory. | |
962 | This root governs where patterns that start with a / match (see below). | |
963 | ||
964 | Because the matching is relative to the transfer-root, changing the | |
20af605e | 965 | trailing slash on a source path or changing your use of the --relative |
a4b6f305 WD |
966 | option affects the path you need to use in your matching (in addition to |
967 | changing how much of the file tree is duplicated on the destination | |
968 | system). The following examples demonstrate this. | |
969 | ||
b5ebe6d9 WD |
970 | Let's say that we want to match two source files, one with an absolute |
971 | path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz". | |
972 | Here is how the various command choices differ for a 2-source transfer: | |
a4b6f305 WD |
973 | |
974 | verb( | |
b5ebe6d9 | 975 | Example cmd: rsync -a /home/me /home/you /dest |
a4b6f305 | 976 | +/- pattern: /me/foo/bar |
b5ebe6d9 | 977 | +/- pattern: /you/bar/baz |
a4b6f305 | 978 | Target file: /dest/me/foo/bar |
b5ebe6d9 | 979 | Target file: /dest/you/bar/baz |
a4b6f305 | 980 | |
b5ebe6d9 | 981 | Example cmd: rsync -a /home/me/ /home/you/ /dest |
b5ebe6d9 WD |
982 | +/- pattern: /foo/bar (note missing "me") |
983 | +/- pattern: /bar/baz (note missing "you") | |
a4b6f305 | 984 | Target file: /dest/foo/bar |
b5ebe6d9 | 985 | Target file: /dest/bar/baz |
a4b6f305 | 986 | |
b5ebe6d9 | 987 | Example cmd: rsync -a --relative /home/me/ /home/you /dest |
b5ebe6d9 WD |
988 | +/- pattern: /home/me/foo/bar (note full path) |
989 | +/- pattern: /home/you/bar/baz (ditto) | |
a4b6f305 | 990 | Target file: /dest/home/me/foo/bar |
b5ebe6d9 | 991 | Target file: /dest/home/you/bar/baz |
be92ac6c | 992 | |
b5ebe6d9 | 993 | Example cmd: cd /home; rsync -a --relative me/foo you/ /dest |
b5ebe6d9 WD |
994 | +/- pattern: /me/foo/bar (starts at specified path) |
995 | +/- pattern: /you/bar/baz (ditto) | |
be92ac6c | 996 | Target file: /dest/me/foo/bar |
b5ebe6d9 | 997 | Target file: /dest/you/bar/baz |
a4b6f305 WD |
998 | ) |
999 | ||
1000 | The easiest way to see what name you should include/exclude is to just | |
1001 | look at the output when using --verbose and put a / in front of the name | |
1002 | (use the --dry-run option if you're not yet ready to copy any files). | |
d1cce1dd | 1003 | |
be92ac6c WD |
1004 | Note that, when using the --recursive (-r) option (which is implied by -a), |
1005 | every subcomponent of | |
a4b6f305 | 1006 | every path is visited from the top down, so include/exclude patterns get |
27b9a19b | 1007 | applied recursively to each subcomponent. |
20af605e WD |
1008 | The exclude patterns actually short-circuit the directory traversal stage |
1009 | when rsync finds the files to send. If a pattern excludes a particular | |
1010 | parent directory, it can render a deeper include pattern ineffectual | |
1011 | because rsync did not descend through that excluded section of the | |
1012 | hierarchy. | |
27b9a19b DD |
1013 | |
1014 | Note also that the --include and --exclude options take one pattern | |
2fb139c1 AT |
1015 | each. To add multiple patterns use the --include-from and |
1016 | --exclude-from options or multiple --include and --exclude options. | |
1017 | ||
14d43f1f | 1018 | The patterns can take several forms. The rules are: |
43bd68e5 AT |
1019 | |
1020 | itemize( | |
d1cce1dd | 1021 | |
43bd68e5 AT |
1022 | it() if the pattern starts with a / then it is matched against the |
1023 | start of the filename, otherwise it is matched against the end of | |
d1cce1dd S |
1024 | the filename. |
1025 | This is the equivalent of a leading ^ in regular expressions. | |
a4b6f305 WD |
1026 | Thus "/foo" would match a file called "foo" at the transfer-root |
1027 | (see above for how this is different from the filesystem-root). | |
d1cce1dd | 1028 | On the other hand, "foo" would match any file called "foo" |
27b9a19b DD |
1029 | anywhere in the tree because the algorithm is applied recursively from |
1030 | top down; it behaves as if each path component gets a turn at being the | |
1031 | end of the file name. | |
43bd68e5 AT |
1032 | |
1033 | it() if the pattern ends with a / then it will only match a | |
a4b6f305 | 1034 | directory, not a file, link, or device. |
43bd68e5 AT |
1035 | |
1036 | it() if the pattern contains a wildcard character from the set | |
a8b9d4ed DD |
1037 | *?[ then expression matching is applied using the shell filename |
1038 | matching rules. Otherwise a simple string match is used. | |
43bd68e5 | 1039 | |
8a7846f9 WD |
1040 | it() the double asterisk pattern "**" will match slashes while a |
1041 | single asterisk pattern "*" will stop at slashes. | |
27b9a19b | 1042 | |
38499c1a WD |
1043 | it() if the pattern contains a / (not counting a trailing /) or a "**" |
1044 | then it is matched against the full filename, including any leading | |
1045 | directory. If the pattern doesn't contain a / or a "**", then it is | |
1046 | matched only against the final component of the filename. Again, | |
1047 | remember that the algorithm is applied recursively so "full filename" can | |
8a7846f9 | 1048 | actually be any portion of a path below the starting directory. |
43bd68e5 AT |
1049 | |
1050 | it() if the pattern starts with "+ " (a plus followed by a space) | |
5a554d5b | 1051 | then it is always considered an include pattern, even if specified as |
a03a9f4e | 1052 | part of an exclude option. The prefix is discarded before matching. |
43bd68e5 AT |
1053 | |
1054 | it() if the pattern starts with "- " (a minus followed by a space) | |
5a554d5b | 1055 | then it is always considered an exclude pattern, even if specified as |
a03a9f4e | 1056 | part of an include option. The prefix is discarded before matching. |
de2fd20e AT |
1057 | |
1058 | it() if the pattern is a single exclamation mark ! then the current | |
eb06fa95 | 1059 | include/exclude list is reset, removing all previously defined patterns. |
43bd68e5 AT |
1060 | ) |
1061 | ||
b7dc46c0 WD |
1062 | The +/- rules are most useful in a list that was read from a file, allowing |
1063 | you to have a single exclude list that contains both include and exclude | |
20af605e | 1064 | options in the proper order. |
27b9a19b | 1065 | |
20af605e WD |
1066 | Remember that the matching occurs at every step in the traversal of the |
1067 | directory hierarchy, so you must be sure that all the parent directories of | |
1068 | the files you want to include are not excluded. This is particularly | |
1069 | important when using a trailing '*' rule. For instance, this won't work: | |
43bd68e5 | 1070 | |
20af605e WD |
1071 | verb( |
1072 | + /some/path/this-file-will-not-be-found | |
1073 | + /file-is-included | |
1074 | - * | |
1075 | ) | |
1076 | ||
1077 | This fails because the parent directory "some" is excluded by the '*' rule, | |
1078 | so rsync never visits any of the files in the "some" or "some/path" | |
1079 | directories. One solution is to ask for all directories in the hierarchy | |
1080 | to be included by using a single rule: --include='*/' (put it somewhere | |
f28bd833 | 1081 | before the --exclude='*' rule). Another solution is to add specific |
20af605e WD |
1082 | include rules for all the parent dirs that need to be visited. For |
1083 | instance, this set of rules works fine: | |
1084 | ||
1085 | verb( | |
1086 | + /some/ | |
1087 | + /some/path/ | |
1088 | + /some/path/this-file-is-found | |
1089 | + /file-also-included | |
1090 | - * | |
1091 | ) | |
1092 | ||
1093 | Here are some examples of exclude/include matching: | |
43bd68e5 AT |
1094 | |
1095 | itemize( | |
1096 | it() --exclude "*.o" would exclude all filenames matching *.o | |
a4b6f305 | 1097 | it() --exclude "/foo" would exclude a file called foo in the transfer-root directory |
43bd68e5 | 1098 | it() --exclude "foo/" would exclude any directory called foo |
a8b9d4ed | 1099 | it() --exclude "/foo/*/bar" would exclude any file called bar two |
a4b6f305 | 1100 | levels below a directory called foo in the transfer-root directory |
a8b9d4ed | 1101 | it() --exclude "/foo/**/bar" would exclude any file called bar two |
a4b6f305 | 1102 | or more levels below a directory called foo in the transfer-root directory |
43bd68e5 | 1103 | it() --include "*/" --include "*.c" --exclude "*" would include all |
5d5811f7 DD |
1104 | directories and C source files |
1105 | it() --include "foo/" --include "foo/bar.c" --exclude "*" would include | |
1106 | only foo/bar.c (the foo/ directory must be explicitly included or | |
1107 | it would be excluded by the "*") | |
43bd68e5 AT |
1108 | ) |
1109 | ||
6902ed17 MP |
1110 | manpagesection(BATCH MODE) |
1111 | ||
2e3c1417 | 1112 | bf(Note:) Batch mode should be considered experimental in this version |
f28bd833 | 1113 | of rsync. The interface or behavior may change before it stabilizes. |
088aac85 DD |
1114 | |
1115 | Batch mode can be used to apply the same set of updates to many | |
1116 | identical systems. Suppose one has a tree which is replicated on a | |
1117 | number of hosts. Now suppose some changes have been made to this | |
1118 | source tree and those changes need to be propagated to the other | |
1119 | hosts. In order to do this using batch mode, rsync is run with the | |
1120 | write-batch option to apply the changes made to the source tree to one | |
1121 | of the destination trees. The write-batch option causes the rsync | |
b9f592fb WD |
1122 | client to store in a "batch file" all the information needed to repeat |
1123 | this operation against other, identical destination trees. | |
1124 | ||
1125 | To apply the recorded changes to another destination tree, run rsync | |
1126 | with the read-batch option, specifying the name of the same batch | |
1127 | file, and the destination tree. Rsync updates the destination tree | |
1128 | using the information stored in the batch file. | |
1129 | ||
1130 | For convenience, one additional file is creating when the write-batch | |
1131 | option is used. This file's name is created by appending | |
73e01568 | 1132 | ".sh" to the batch filename. The .sh file contains |
b9f592fb WD |
1133 | a command-line suitable for updating a destination tree using that |
1134 | batch file. It can be executed using a Bourne(-like) shell, optionally | |
1135 | passing in an alternate destination tree pathname which is then used | |
1136 | instead of the original path. This is useful when the destination tree | |
1137 | path differs from the original destination tree path. | |
1138 | ||
1139 | Generating the batch file once saves having to perform the file | |
1140 | status, checksum, and data block generation more than once when | |
088aac85 | 1141 | updating multiple destination trees. Multicast transport protocols can |
b9f592fb WD |
1142 | be used to transfer the batch update files in parallel to many hosts |
1143 | at once, instead of sending the same data to every host individually. | |
088aac85 | 1144 | |
4602eafa | 1145 | Examples: |
088aac85 DD |
1146 | |
1147 | verb( | |
b9f592fb | 1148 | $ rsync --write-batch=batch -a /source/dir/ /adest/dir/ |
4602eafa WD |
1149 | $ ssh remote rsync --read-batch=- -a /bdest/dir/ <batch |
1150 | ) | |
1151 | ||
1152 | verb( | |
1153 | $ rsync --write-batch=batch -a host:/source/dir/ /adest/dir/ | |
1154 | $ scp batch remote: | |
b9f592fb | 1155 | $ ssh remote rsync --read-batch=batch -a /bdest/dir/ |
4602eafa WD |
1156 | ) |
1157 | ||
1158 | verb( | |
1159 | $ rsync --write-batch=batch -a /source/dir/ host:/adest/dir/ | |
1160 | $ scp batch* remote: | |
73e01568 | 1161 | $ ssh remote ./batch.sh /bdest/dir/ |
6902ed17 MP |
1162 | ) |
1163 | ||
4602eafa | 1164 | In these examples, rsync is used to update /adest/dir/ with /source/dir/ |
b9f592fb | 1165 | and the information to repeat this operation is stored in "batch" and |
73e01568 | 1166 | "batch.sh". The host "remote" is then updated with the batched |
4602eafa WD |
1167 | update going into the directory /bdest/dir. The differences between the |
1168 | three examples is in how the batch gets to the remote machine (via remote | |
1169 | stdin or by being copied first), whether the initial transfer was local or | |
1170 | remote, and in how the batch-reading rsync command is invoked. | |
088aac85 DD |
1171 | |
1172 | Caveats: | |
1173 | ||
1174 | The read-batch option expects the destination tree it is meant to update | |
1175 | to be identical to the destination tree that was used to create the | |
1176 | batch update fileset. When a difference between the destination trees | |
1177 | is encountered the update will fail at that point, leaving the | |
1178 | destination tree in a partially updated state. In that case, rsync can | |
1179 | be used in its regular (non-batch) mode of operation to fix up the | |
1180 | destination tree. | |
1181 | ||
b9f592fb WD |
1182 | The rsync version used on all destinations must be at least as new as the |
1183 | one used to generate the batch file. | |
088aac85 DD |
1184 | |
1185 | The -n/--dryrun option does not work in batch mode and yields a runtime | |
1186 | error. | |
1187 | ||
b9f592fb WD |
1188 | You should use an equivalent set of options when reading a batch file that |
1189 | you used when generating it with a few exceptions. For instance | |
1190 | --write-batch changes to --read-batch, --files-from is dropped, and the | |
1191 | --include/--exclude options are not needed unless --delete is specified | |
1192 | without --delete-excluded. Other options that affect how the update | |
1193 | happens should generally remain the same as it is possible to confuse rsync | |
1194 | into expecting a different data stream than the one that is contained in | |
1195 | the batch file. For example, it would not work to change the setting of | |
1196 | the -H or -c option, but it would work to add or remove the --delete | |
1197 | option. | |
1198 | ||
6902ed17 MP |
1199 | See bf(http://www.ils.unc.edu/i2dsi/unc_rsync+.html) for papers and technical |
1200 | reports. | |
1201 | ||
eb06fa95 MP |
1202 | manpagesection(SYMBOLIC LINKS) |
1203 | ||
f28bd833 | 1204 | Three basic behaviors are possible when rsync encounters a symbolic |
eb06fa95 MP |
1205 | link in the source directory. |
1206 | ||
1207 | By default, symbolic links are not transferred at all. A message | |
1208 | "skipping non-regular" file is emitted for any symlinks that exist. | |
1209 | ||
1210 | If bf(--links) is specified, then symlinks are recreated with the same | |
1211 | target on the destination. Note that bf(--archive) implies | |
1212 | bf(--links). | |
1213 | ||
1214 | If bf(--copy-links) is specified, then symlinks are "collapsed" by | |
1215 | copying their referent, rather than the symlink. | |
1216 | ||
1217 | rsync also distinguishes "safe" and "unsafe" symbolic links. An | |
1218 | example where this might be used is a web site mirror that wishes | |
1219 | ensure the rsync module they copy does not include symbolic links to | |
1220 | bf(/etc/passwd) in the public section of the site. Using | |
1221 | bf(--copy-unsafe-links) will cause any links to be copied as the file | |
1222 | they point to on the destination. Using bf(--safe-links) will cause | |
4d888108 | 1223 | unsafe links to be omitted altogether. |
eb06fa95 | 1224 | |
7bd0cf5b MP |
1225 | Symbolic links are considered unsafe if they are absolute symlinks |
1226 | (start with bf(/)), empty, or if they contain enough bf("..") | |
1227 | components to ascend from the directory being copied. | |
1228 | ||
d310a212 AT |
1229 | manpagesection(DIAGNOSTICS) |
1230 | ||
14d43f1f | 1231 | rsync occasionally produces error messages that may seem a little |
d310a212 AT |
1232 | cryptic. The one that seems to cause the most confusion is "protocol |
1233 | version mismatch - is your shell clean?". | |
1234 | ||
1235 | This message is usually caused by your startup scripts or remote shell | |
1236 | facility producing unwanted garbage on the stream that rsync is using | |
14d43f1f | 1237 | for its transport. The way to diagnose this problem is to run your |
d310a212 AT |
1238 | remote shell like this: |
1239 | ||
1240 | verb( | |
43cd760f | 1241 | ssh remotehost /bin/true > out.dat |
d310a212 AT |
1242 | ) |
1243 | ||
1244 | then look at out.dat. If everything is working correctly then out.dat | |
2cfeab21 | 1245 | should be a zero length file. If you are getting the above error from |
d310a212 AT |
1246 | rsync then you will probably find that out.dat contains some text or |
1247 | data. Look at the contents and try to work out what is producing | |
14d43f1f | 1248 | it. The most common cause is incorrectly configured shell startup |
d310a212 AT |
1249 | scripts (such as .cshrc or .profile) that contain output statements |
1250 | for non-interactive logins. | |
1251 | ||
e6c64e79 MP |
1252 | If you are having trouble debugging include and exclude patterns, then |
1253 | try specifying the -vv option. At this level of verbosity rsync will | |
1254 | show why each individual file is included or excluded. | |
1255 | ||
55b64e4b MP |
1256 | manpagesection(EXIT VALUES) |
1257 | ||
1258 | startdit() | |
a73de5f3 WD |
1259 | dit(bf(0)) Success |
1260 | dit(bf(1)) Syntax or usage error | |
1261 | dit(bf(2)) Protocol incompatibility | |
1262 | dit(bf(3)) Errors selecting input/output files, dirs | |
1263 | dit(bf(4)) Requested action not supported: an attempt | |
8212336a | 1264 | was made to manipulate 64-bit files on a platform that cannot support |
f28bd833 | 1265 | them; or an option was specified that is supported by the client and |
8212336a | 1266 | not by the server. |
a73de5f3 | 1267 | dit(bf(5)) Error starting client-server protocol |
b5accaba WD |
1268 | dit(bf(10)) Error in socket I/O |
1269 | dit(bf(11)) Error in file I/O | |
a73de5f3 WD |
1270 | dit(bf(12)) Error in rsync protocol data stream |
1271 | dit(bf(13)) Errors with program diagnostics | |
1272 | dit(bf(14)) Error in IPC code | |
1273 | dit(bf(20)) Received SIGUSR1 or SIGINT | |
1274 | dit(bf(21)) Some error returned by waitpid() | |
1275 | dit(bf(22)) Error allocating core memory buffers | |
3c1e2ad9 WD |
1276 | dit(bf(23)) Partial transfer due to error |
1277 | dit(bf(24)) Partial transfer due to vanished source files | |
a73de5f3 | 1278 | dit(bf(30)) Timeout in data send/receive |
55b64e4b MP |
1279 | enddit() |
1280 | ||
de2fd20e AT |
1281 | manpagesection(ENVIRONMENT VARIABLES) |
1282 | ||
1283 | startdit() | |
1284 | ||
1285 | dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any | |
1286 | ignore patterns in .cvsignore files. See the --cvs-exclude option for | |
1287 | more details. | |
1288 | ||
1289 | dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to | |
ea7f8108 WD |
1290 | override the default shell used as the transport for rsync. Command line |
1291 | options are permitted after the command name, just as in the -e option. | |
de2fd20e | 1292 | |
4c3b4b25 AT |
1293 | dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to |
1294 | redirect your rsync client to use a web proxy when connecting to a | |
1295 | rsync daemon. You should set RSYNC_PROXY to a hostname:port pair. | |
1296 | ||
de2fd20e | 1297 | dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required |
bb18e755 | 1298 | password allows you to run authenticated rsync connections to an rsync |
de2fd20e AT |
1299 | daemon without user intervention. Note that this does not supply a |
1300 | password to a shell transport such as ssh. | |
1301 | ||
1302 | dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables | |
bb18e755 | 1303 | are used to determine the default username sent to an rsync server. |
4b2f6a7c | 1304 | If neither is set, the username defaults to "nobody". |
de2fd20e | 1305 | |
14d43f1f | 1306 | dit(bf(HOME)) The HOME environment variable is used to find the user's |
de2fd20e AT |
1307 | default .cvsignore file. |
1308 | ||
1309 | enddit() | |
1310 | ||
41059f75 AT |
1311 | manpagefiles() |
1312 | ||
30e8c8e1 | 1313 | /etc/rsyncd.conf or rsyncd.conf |
41059f75 AT |
1314 | |
1315 | manpageseealso() | |
1316 | ||
1317 | rsyncd.conf(5) | |
1318 | ||
1319 | manpagediagnostics() | |
1320 | ||
1321 | manpagebugs() | |
1322 | ||
1323 | times are transferred as unix time_t values | |
1324 | ||
f28bd833 | 1325 | When transferring to FAT filesystems rsync may re-sync |
38843171 DD |
1326 | unmodified files. |
1327 | See the comments on the --modify-window option. | |
1328 | ||
b5accaba | 1329 | file permissions, devices, etc. are transferred as native numerical |
41059f75 AT |
1330 | values |
1331 | ||
a87b3b2a | 1332 | see also the comments on the --delete option |
41059f75 | 1333 | |
38843171 DD |
1334 | Please report bugs! See the website at |
1335 | url(http://rsync.samba.org/)(http://rsync.samba.org/) | |
41059f75 AT |
1336 | |
1337 | manpagesection(CREDITS) | |
1338 | ||
1339 | rsync is distributed under the GNU public license. See the file | |
1340 | COPYING for details. | |
1341 | ||
41059f75 | 1342 | A WEB site is available at |
3cd5eb3b MP |
1343 | url(http://rsync.samba.org/)(http://rsync.samba.org/). The site |
1344 | includes an FAQ-O-Matic which may cover questions unanswered by this | |
1345 | manual page. | |
9e3c856a AT |
1346 | |
1347 | The primary ftp site for rsync is | |
1348 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). | |
41059f75 AT |
1349 | |
1350 | We would be delighted to hear from you if you like this program. | |
1351 | ||
9e3c856a AT |
1352 | This program uses the excellent zlib compression library written by |
1353 | Jean-loup Gailly and Mark Adler. | |
41059f75 AT |
1354 | |
1355 | manpagesection(THANKS) | |
1356 | ||
1357 | Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell | |
7ff701e8 MP |
1358 | and David Bell for helpful suggestions, patches and testing of rsync. |
1359 | I've probably missed some people, my apologies if I have. | |
1360 | ||
ce5f2732 MP |
1361 | Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer, |
1362 | Martin Pool, Wayne Davison. | |
41059f75 AT |
1363 | |
1364 | manpageauthor() | |
1365 | ||
ce5f2732 MP |
1366 | rsync was originally written by Andrew Tridgell and Paul Mackerras. |
1367 | Many people have later contributed to it. | |
3cd5eb3b | 1368 | |
a5d74a18 | 1369 | Mailing lists for support and development are available at |
7ff701e8 | 1370 | url(http://lists.samba.org)(lists.samba.org) |