1 /* -*- c-file-style: "linux" -*-
3 * Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4 * Copyright (C) 2000, 2001, 2002 by Martin Pool <mbp@samba.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 extern int sanitize_paths;
26 extern int select_timeout;
27 extern struct filter_list_struct filter_list;
28 extern struct filter_list_struct server_filter_list;
33 * If 1, send the whole file as literal data rather than trying to
34 * create an incremental diff.
36 * If -1, then look at whether we're local or remote and go by that.
38 * @sa disable_deltas_p()
43 int keep_dirlinks = 0;
45 int preserve_links = 0;
46 int preserve_hard_links = 0;
47 int preserve_perms = 0;
48 int preserve_devices = 0;
51 int preserve_times = 0;
52 int omit_dir_times = 0;
58 int delete_during = 0;
59 int delete_before = 0;
61 int delete_excluded = 0;
62 int remove_sent_files = 0;
63 int one_file_system = 0;
64 int protocol_version = PROTOCOL_VERSION;
66 int do_compression = 0;
69 int relative_paths = -1;
77 char *files_from = NULL;
78 int filesfrom_fd = -1;
79 char *remote_filesfrom_file = NULL;
84 int daemon_over_rsh = 0;
88 int safe_symlinks = 0;
89 int copy_unsafe_links = 0;
91 int daemon_bwlimit = 0;
94 size_t bwlimit_writemax = 0;
95 int only_existing = 0;
96 int opt_ignore_existing = 0;
97 int need_messages_from_generator = 0;
100 int ignore_errors = 0;
101 int modify_window = 0;
102 int blocking_io = -1;
103 int checksum_seed = 0;
105 int delay_updates = 0;
106 long block_size = 0; /* "long" because popt can't set an int32. */
109 /** Network address family. **/
111 int default_af_hint = 0; /* Any protocol */
113 int default_af_hint = AF_INET; /* Must use IPv4 */
116 /** Do not go into the background when run as --daemon. Good
117 * for debugging and required for running as a service on W32,
118 * or under Unix process-monitors. **/
120 #if defined _WIN32 || defined __WIN32__
128 int backup_dir_len = 0;
129 int backup_suffix_len;
130 unsigned int backup_dir_remainder;
132 char *backup_suffix = NULL;
134 char *partial_dir = NULL;
135 char *basis_dir[MAX_BASIS_DIRS+1];
136 char *config_file = NULL;
137 char *shell_cmd = NULL;
138 char *log_format = NULL;
139 char *password_file = NULL;
140 char *rsync_path = RSYNC_PATH;
141 char *backup_dir = NULL;
142 char backup_dir_buf[MAXPATHLEN];
144 int compare_dest = 0;
147 int basis_dir_cnt = 0;
151 int itemize_changes = 0;
152 int log_before_transfer = 0;
153 int log_format_has_i = 0;
154 int log_format_has_o_or_i = 0;
155 int always_checksum = 0;
158 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
159 char *batch_name = NULL;
161 static int daemon_opt; /* sets am_daemon after option error-reporting */
162 static int F_option_cnt = 0;
163 static int modify_window_set;
164 static int refused_delete, refused_archive_part;
165 static int refused_partial, refused_progress, refused_delete_before;
166 static char *dest_option = NULL;
167 static char *max_size_arg;
168 static char partialdir_for_delayupdate[] = ".~tmp~";
170 /** Local address to bind. As a character string because it's
171 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
172 * address, or a hostname. **/
176 static void print_rsync_version(enum logcode f)
178 char const *got_socketpair = "no ";
179 char const *have_inplace = "no ";
180 char const *hardlinks = "no ";
181 char const *links = "no ";
182 char const *ipv6 = "no ";
183 STRUCT_STAT *dumstat;
185 #ifdef HAVE_SOCKETPAIR
189 #ifdef HAVE_FTRUNCATE
193 #ifdef SUPPORT_HARD_LINKS
205 rprintf(f, "%s version %s protocol version %d\n",
206 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
208 "Copyright (C) 1996-2005 by Andrew Tridgell and others\n");
209 rprintf(f, "<http://rsync.samba.org/>\n");
210 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
211 "%shard links, %ssymlinks, batchfiles, \n",
212 (int) (sizeof (OFF_T) * 8),
213 got_socketpair, hardlinks, links);
215 /* Note that this field may not have type ino_t. It depends
216 * on the complicated interaction between largefile feature
218 rprintf(f, " %sinplace, %sIPv6, %d-bit system inums, %d-bit internal inums\n",
220 (int) (sizeof dumstat->st_ino * 8),
221 (int) (sizeof (int64) * 8));
222 #ifdef MAINTAINER_MODE
223 rprintf(f, " panic action: \"%s\"\n",
228 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
230 if (sizeof (int64) != SIZEOF_INT64) {
232 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
233 (int) SIZEOF_INT64, (int) sizeof (int64));
238 "rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
239 "are welcome to redistribute it under certain conditions. See the GNU\n"
240 "General Public Licence for details.\n"
245 void usage(enum logcode F)
247 print_rsync_version(F);
249 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
251 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
252 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
253 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
254 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
255 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
256 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
257 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
258 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
259 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
260 rprintf(F," sources separated by space as long as they have same top-level\n");
261 rprintf(F,"\nOptions\n");
262 rprintf(F," -v, --verbose increase verbosity\n");
263 rprintf(F," -q, --quiet suppress non-error messages\n");
264 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
265 rprintf(F," -a, --archive archive mode; same as -rlptgoD (no -H)\n");
266 rprintf(F," -r, --recursive recurse into directories\n");
267 rprintf(F," -R, --relative use relative path names\n");
268 rprintf(F," --no-relative turn off --relative\n");
269 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
270 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
271 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
272 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
273 rprintf(F," -u, --update skip files that are newer on the receiver\n");
274 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
275 rprintf(F," -d, --dirs transfer directories without recursing\n");
276 rprintf(F," -l, --links copy symlinks as symlinks\n");
277 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
278 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
279 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
280 rprintf(F," -H, --hard-links preserve hard links\n");
281 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
282 rprintf(F," -p, --perms preserve permissions\n");
283 rprintf(F," -o, --owner preserve owner (root only)\n");
284 rprintf(F," -g, --group preserve group\n");
285 rprintf(F," -D, --devices preserve devices (root only)\n");
286 rprintf(F," -t, --times preserve times\n");
287 rprintf(F," -O, --omit-dir-times omit directories when preserving times\n");
288 rprintf(F," -S, --sparse handle sparse files efficiently\n");
289 rprintf(F," -n, --dry-run show what would have been transferred\n");
290 rprintf(F," -W, --whole-file copy files whole (without rsync algorithm)\n");
291 rprintf(F," --no-whole-file always use incremental rsync algorithm\n");
292 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
293 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
294 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
295 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
296 rprintf(F," --existing only update files that already exist on receiver\n");
297 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
298 rprintf(F," --remove-sent-files sent files/symlinks are removed from sending side\n");
299 rprintf(F," --del an alias for --delete-during\n");
300 rprintf(F," --delete delete files that don't exist on the sending side\n");
301 rprintf(F," --delete-before receiver deletes before transfer (default)\n");
302 rprintf(F," --delete-during receiver deletes during transfer, not before\n");
303 rprintf(F," --delete-after receiver deletes after transfer, not before\n");
304 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
305 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
306 rprintf(F," --force force deletion of directories even if not empty\n");
307 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
308 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
309 rprintf(F," --partial keep partially transferred files\n");
310 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
311 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
312 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
313 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
314 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
315 rprintf(F," --size-only skip files that match in size\n");
316 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
317 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
318 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
319 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
320 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
321 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
322 rprintf(F," -z, --compress compress file data during the transfer\n");
323 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
324 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
325 rprintf(F," -F same as --filter='dir-merge /.rsync-filter'\n");
326 rprintf(F," repeated: --filter='- .rsync-filter'\n");
327 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
328 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
329 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
330 rprintf(F," --include-from=FILE read include patterns from FILE\n");
331 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
332 rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
333 rprintf(F," --version print version number\n");
334 rprintf(F," --port=PORT specify double-colon alternate port number\n");
335 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
336 rprintf(F," --no-blocking-io turn off blocking I/O when it is the default\n");
337 rprintf(F," --stats give some file-transfer stats\n");
338 rprintf(F," --progress show progress during transfer\n");
339 rprintf(F," -P same as --partial --progress\n");
340 rprintf(F," -i, --itemize-changes output a change-summary for all updates\n");
341 rprintf(F," --log-format=FORMAT log file-transfers using specified format\n");
342 rprintf(F," --password-file=FILE read password from FILE\n");
343 rprintf(F," --list-only list the files instead of copying them\n");
344 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
345 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
346 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
348 rprintf(F," -4, --ipv4 prefer IPv4\n");
349 rprintf(F," -6, --ipv6 prefer IPv6\n");
351 rprintf(F," -h, --help show this help screen\n");
353 rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
354 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
355 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
358 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
359 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
360 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
361 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
362 OPT_REFUSED_BASE = 9000};
364 static struct poptOption long_options[] = {
365 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
366 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
367 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
368 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
369 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
370 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
371 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
372 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
373 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
374 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
375 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
376 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
377 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
378 {"delete-before", 0, POPT_ARG_VAL, &delete_before, 2, 0, 0 },
379 {"delete-during", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
380 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
381 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
382 {"remove-sent-files",0, POPT_ARG_NONE, &remove_sent_files, 0, 0, 0 },
383 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
384 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
385 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
386 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
387 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
388 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
389 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
390 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
391 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
392 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
393 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
394 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
395 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
396 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
397 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
398 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
399 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
400 {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 },
401 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
402 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
403 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
404 {"copy-unsafe-links",0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 },
405 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
406 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
407 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
408 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
409 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
410 {"omit-dir-times", 'O', POPT_ARG_VAL, &omit_dir_times, 2, 0, 0 },
411 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
412 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
413 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
414 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
415 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
416 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
417 {"recursive", 'r', POPT_ARG_VAL, &recurse, -1, 0, 0 },
418 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
419 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
420 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
421 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
422 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
423 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
424 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
425 {"timeout", 0, POPT_ARG_INT, &io_timeout, OPT_TIMEOUT, 0, 0 },
426 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
427 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
428 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
429 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
430 {"fuzzy", 'y', POPT_ARG_NONE, &fuzzy_basis, 0, 0, 0 },
431 /* TODO: Should this take an optional int giving the compression level? */
432 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
433 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
434 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
435 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
436 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
437 {"delay-updates", 0, POPT_ARG_NONE, &delay_updates, 0, 0, 0 },
438 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
439 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
440 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
441 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
442 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
443 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
444 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
445 {"itemize-changes", 'i', POPT_ARG_NONE, &itemize_changes, 0, 0, 0 },
446 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
447 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
448 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
449 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
450 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
451 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
452 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
453 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
454 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
455 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
457 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
458 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
460 /* All these options switch us into daemon-mode option-parsing. */
461 {"address", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
462 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
463 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
464 {"detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
465 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
469 static void daemon_usage(enum logcode F)
471 print_rsync_version(F);
473 rprintf(F,"\nUsage: rsync --daemon [OPTION]...\n");
474 rprintf(F," --address=ADDRESS bind to the specified address\n");
475 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
476 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
477 rprintf(F," --no-detach do not detach from the parent\n");
478 rprintf(F," --port=PORT listen on alternate port number\n");
479 rprintf(F," -v, --verbose increase verbosity\n");
481 rprintf(F," -4, --ipv4 prefer IPv4\n");
482 rprintf(F," -6, --ipv6 prefer IPv6\n");
484 rprintf(F," -h, --help show this help screen\n");
486 rprintf(F,"\nIf you were not trying to invoke rsync as a daemon, avoid using any of the\n");
487 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
490 static struct poptOption long_daemon_options[] = {
491 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
492 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
493 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
494 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
495 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
497 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
498 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
500 {"detach", 0, POPT_ARG_VAL, &no_detach, 0, 0, 0 },
501 {"no-detach", 0, POPT_ARG_VAL, &no_detach, 1, 0, 0 },
502 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
503 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
504 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
505 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
506 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
511 static char err_buf[200];
515 * Store the option error message, if any, so that we can log the
516 * connection attempt (which requires parsing the options), and then
517 * show the error later on.
519 void option_error(void)
522 strcpy(err_buf, "Error parsing options: "
523 "option may be supported on client but not on server?\n");
526 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
531 * Tweak the option table to disable all options that the rsyncd.conf
532 * file has told us to refuse.
534 static void set_refuse_options(char *bp)
536 struct poptOption *op;
537 char *cp, shortname[2];
538 int is_wild, found_match;
543 while (*bp == ' ') bp++;
546 if ((cp = strchr(bp, ' ')) != NULL)
548 is_wild = strpbrk(bp, "*?[") != NULL;
550 for (op = long_options; ; op++) {
551 *shortname = op->shortName;
552 if (!op->longName && !*shortname)
554 if ((op->longName && wildmatch(bp, op->longName))
555 || (*shortname && wildmatch(bp, shortname))) {
556 if (op->argInfo == POPT_ARG_VAL)
557 op->argInfo = POPT_ARG_NONE;
558 op->val = (op - long_options) + OPT_REFUSED_BASE;
560 /* These flags are set to let us easily check
561 * an implied option later in the code. */
562 switch (*shortname) {
563 case 'r': case 'd': case 'l': case 'p':
564 case 't': case 'g': case 'o': case 'D':
565 refused_archive_part = op->val;
568 if (wildmatch("delete", op->longName))
569 refused_delete = op->val;
570 else if (wildmatch("delete-before", op->longName))
571 refused_delete_before = op->val;
572 else if (wildmatch("partial", op->longName))
573 refused_partial = op->val;
574 else if (wildmatch("progress", op->longName))
575 refused_progress = op->val;
583 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
592 for (op = long_options; ; op++) {
593 *shortname = op->shortName;
594 if (!op->longName && !*shortname)
596 if (op->val == OPT_DAEMON) {
597 if (op->argInfo == POPT_ARG_VAL)
598 op->argInfo = POPT_ARG_NONE;
599 op->val = (op - long_options) + OPT_REFUSED_BASE;
605 static int count_args(const char **argv)
610 while (argv[i] != NULL)
618 static void create_refuse_error(int which)
620 /* The "which" value is the index + OPT_REFUSED_BASE. */
621 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
622 int n = snprintf(err_buf, sizeof err_buf,
623 "The server is configured to refuse --%s\n",
626 snprintf(err_buf + n, sizeof err_buf - n,
627 " (-%c)\n", op->shortName);
633 * Process command line arguments. Called on both local and remote.
635 * @retval 1 if all options are OK; with globals set to appropriate
638 * @retval 0 on error, with err_buf containing an explanation
640 int parse_arguments(int *argc, const char ***argv, int frommain)
643 char *ref = lp_refuse_options(module_id);
648 set_refuse_options(ref);
650 /* TODO: Call poptReadDefaultConfig; handle errors. */
652 /* The context leaks in case of an error, but if there's a
653 * problem we always exit anyhow. */
654 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
655 poptReadDefaultConfig(pc, 0);
657 while ((opt = poptGetNextOpt(pc)) != -1) {
658 /* most options are handled automatically by popt;
659 * only special cases are returned and listed here. */
663 print_rsync_version(FINFO);
668 strcpy(err_buf, "Attempt to hack rsync thwarted!\n");
672 pc = poptGetContext(RSYNC_NAME, *argc, *argv,
673 long_daemon_options, 0);
674 while ((opt = poptGetNextOpt(pc)) != -1) {
686 "rsync: %s: %s (in daemon mode)\n",
687 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
693 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
696 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
697 exit_cleanup(RERR_SYNTAX);
699 *argv = poptGetArgs(pc);
700 *argc = count_args(*argv);
705 case OPT_MODIFY_WINDOW:
706 /* The value has already been set by popt, but
707 * we need to remember that we're using a
708 * non-default setting. */
709 modify_window_set = 1;
713 parse_rule(&filter_list, poptGetOptArg(pc), 0, 0);
717 parse_rule(&filter_list, poptGetOptArg(pc),
718 0, XFLG_OLD_PREFIXES);
722 parse_rule(&filter_list, poptGetOptArg(pc),
723 MATCHFLG_INCLUDE, XFLG_OLD_PREFIXES);
726 case OPT_EXCLUDE_FROM:
727 case OPT_INCLUDE_FROM:
728 arg = poptGetOptArg(pc);
730 arg = sanitize_path(NULL, arg, NULL, 0);
731 if (server_filter_list.head) {
732 char *cp = (char *)arg;
734 goto options_rejected;
736 if (check_filter(&server_filter_list, cp, 0) < 0)
737 goto options_rejected;
739 parse_filter_file(&filter_list, arg,
740 opt == OPT_INCLUDE_FROM ? MATCHFLG_INCLUDE : 0,
741 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
760 exit_cleanup(RERR_SYNTAX);
766 switch (++F_option_cnt) {
768 parse_rule(&filter_list,": /.rsync-filter",0,0);
771 parse_rule(&filter_list,"- .rsync-filter",0,0);
777 if (refused_partial || refused_progress) {
778 create_refuse_error(refused_partial
779 ? refused_partial : refused_progress);
786 case OPT_WRITE_BATCH:
787 /* batch_name is already set */
792 /* batch_name is already set */
797 for (arg = max_size_arg; isdigit(*(uchar*)arg); arg++) {}
799 for (arg++; isdigit(*(uchar*)arg); arg++) {}
802 max_size = atof(max_size_arg) * 1024;
805 max_size = atof(max_size_arg) * 1024*1024;
808 max_size = atof(max_size_arg) * 1024*1024*1024;
811 max_size = atof(max_size_arg);
818 snprintf(err_buf, sizeof err_buf,
819 "--max-size value is invalid: %s\n",
826 if (io_timeout && io_timeout < select_timeout)
827 select_timeout = io_timeout;
833 dest_option = "--link-dest";
836 snprintf(err_buf, sizeof err_buf,
837 "hard links are not supported on this %s\n",
838 am_server ? "server" : "client");
844 dest_option = "--copy-dest";
847 case OPT_COMPARE_DEST:
849 dest_option = "--compare-dest";
851 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
852 snprintf(err_buf, sizeof err_buf,
853 "ERROR: at most %d %s args may be specified\n",
854 MAX_BASIS_DIRS, dest_option);
857 arg = poptGetOptArg(pc);
859 arg = sanitize_path(NULL, arg, NULL, 0);
860 basis_dir[basis_dir_cnt++] = (char *)arg;
864 /* A large opt value means that set_refuse_options()
865 * turned this option off. */
866 if (opt >= OPT_REFUSED_BASE) {
867 create_refuse_error(opt);
870 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
871 am_server ? "on remote machine: " : "",
872 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
881 #ifndef SUPPORT_LINKS
882 if (preserve_links && !am_sender) {
883 snprintf(err_buf, sizeof err_buf,
884 "symlinks are not supported on this %s\n",
885 am_server ? "server" : "client");
890 #ifndef SUPPORT_HARD_LINKS
891 if (preserve_hard_links) {
892 snprintf(err_buf, sizeof err_buf,
893 "hard links are not supported on this %s\n",
894 am_server ? "server" : "client");
899 if (write_batch && read_batch) {
900 snprintf(err_buf, sizeof err_buf,
901 "--write-batch and --read-batch can not be used together\n");
904 if (write_batch || read_batch) {
906 snprintf(err_buf, sizeof err_buf,
907 "--%s-batch cannot be used with --dry_run (-n)\n",
908 write_batch ? "write" : "read");
913 "ignoring --%s-batch option sent to server\n",
914 write_batch ? "write" : "read");
915 /* We don't actually exit_cleanup(), so that we can
916 * still service older version clients that still send
917 * batch args to server. */
918 read_batch = write_batch = 0;
922 if (read_batch && files_from) {
923 snprintf(err_buf, sizeof err_buf,
924 "--read-batch cannot be used with --files-from\n");
927 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
928 snprintf(err_buf, sizeof err_buf,
929 "the batch-file name must be %d characters or less.\n",
934 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
935 snprintf(err_buf, sizeof err_buf,
936 "the --temp-dir path is WAY too long.\n");
940 if (compare_dest + copy_dest + link_dest > 1) {
941 snprintf(err_buf, sizeof err_buf,
942 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
947 if (refused_archive_part) {
948 create_refuse_error(refused_archive_part);
952 recurse = -1; /* infinite recursion */
960 preserve_devices = 1;
963 if (recurse || list_only || files_from)
966 if (relative_paths < 0)
967 relative_paths = files_from? 1 : 0;
969 if (!!delete_before + delete_during + delete_after > 1) {
970 snprintf(err_buf, sizeof err_buf,
971 "You may not combine multiple --delete-WHEN options.\n");
975 delete_before = delete_during = delete_after = 0;
976 delete_mode = delete_excluded = 0;
977 } else if (delete_before || delete_during || delete_after)
979 else if (delete_mode || delete_excluded) {
980 if (refused_delete_before) {
981 create_refuse_error(refused_delete_before);
984 delete_mode = delete_before = 1;
987 if (delete_mode && refused_delete) {
988 create_refuse_error(refused_delete);
992 if (remove_sent_files) {
993 /* We only want to infer this refusal of --remove-sent-files
994 * via the refusal of "delete", not any of the "delete-FOO"
996 if (refused_delete && am_sender) {
997 create_refuse_error(refused_delete);
1000 need_messages_from_generator = 1;
1003 *argv = poptGetArgs(pc);
1004 *argc = count_args(*argv);
1006 if (sanitize_paths) {
1008 for (i = *argc; i-- > 0; )
1009 (*argv)[i] = sanitize_path(NULL, (*argv)[i], "", 0);
1011 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
1013 partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
1015 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
1017 files_from = sanitize_path(NULL, files_from, NULL, 0);
1019 if (server_filter_list.head && !am_sender) {
1020 struct filter_list_struct *elp = &server_filter_list;
1024 goto options_rejected;
1025 clean_fname(tmpdir, 1);
1026 if (check_filter(elp, tmpdir, 1) < 0)
1027 goto options_rejected;
1029 if (partial_dir && *partial_dir) {
1030 clean_fname(partial_dir, 1);
1031 if (check_filter(elp, partial_dir, 1) < 0)
1032 goto options_rejected;
1034 for (i = 0; i < basis_dir_cnt; i++) {
1036 goto options_rejected;
1037 clean_fname(basis_dir[i], 1);
1038 if (check_filter(elp, basis_dir[i], 1) < 0)
1039 goto options_rejected;
1043 goto options_rejected;
1044 clean_fname(backup_dir, 1);
1045 if (check_filter(elp, backup_dir, 1) < 0)
1046 goto options_rejected;
1049 if (server_filter_list.head && files_from) {
1051 goto options_rejected;
1052 clean_fname(files_from, 1);
1053 if (check_filter(&server_filter_list, files_from, 0) < 0) {
1055 snprintf(err_buf, sizeof err_buf,
1056 "Your options have been rejected by the server.\n");
1062 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
1063 backup_suffix_len = strlen(backup_suffix);
1064 if (strchr(backup_suffix, '/') != NULL) {
1065 snprintf(err_buf, sizeof err_buf,
1066 "--suffix cannot contain slashes: %s\n",
1071 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
1072 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
1073 if (backup_dir_remainder < 32) {
1074 snprintf(err_buf, sizeof err_buf,
1075 "the --backup-dir path is WAY too long.\n");
1078 if (backup_dir_buf[backup_dir_len - 1] != '/') {
1079 backup_dir_buf[backup_dir_len++] = '/';
1080 backup_dir_buf[backup_dir_len] = '\0';
1082 if (verbose > 1 && !am_sender) {
1083 rprintf(FINFO, "backup_dir is %s\n",
1084 safe_fname(backup_dir_buf));
1086 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
1087 snprintf(err_buf, sizeof err_buf,
1088 "--suffix cannot be a null string without --backup-dir\n");
1091 if (make_backups && !backup_dir)
1095 if (strstr(log_format, "%i") != NULL)
1096 log_format_has_i = 1;
1097 if (strstr(log_format, "%b") == NULL
1098 && strstr(log_format, "%c") == NULL)
1099 log_before_transfer = !am_server;
1100 } else if (itemize_changes) {
1101 log_format = "%i %n%L";
1102 log_format_has_i = 1;
1103 log_before_transfer = !am_server;
1106 if ((do_progress || dry_run) && !verbose && !log_before_transfer
1110 if (verbose && !log_format) {
1111 log_format = "%n%L";
1112 log_before_transfer = !am_server;
1114 if (log_format_has_i
1115 || (log_format && strstr(log_format, "%o") != NULL))
1116 log_format_has_o_or_i = 1;
1118 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
1119 bwlimit = daemon_bwlimit;
1121 bwlimit_writemax = (size_t)bwlimit * 128;
1122 if (bwlimit_writemax < 512)
1123 bwlimit_writemax = 512;
1126 if (delay_updates && !partial_dir)
1127 partial_dir = partialdir_for_delayupdate;
1130 #ifdef HAVE_FTRUNCATE
1132 snprintf(err_buf, sizeof err_buf,
1133 "--inplace cannot be used with --%s\n",
1134 delay_updates ? "delay-updates" : "partial-dir");
1137 /* --inplace implies --partial for refusal purposes, but we
1138 * clear the keep_partial flag for internal logic purposes. */
1139 if (refused_partial) {
1140 create_refuse_error(refused_partial);
1145 snprintf(err_buf, sizeof err_buf,
1146 "--inplace is not supported on this %s\n",
1147 am_server ? "server" : "client");
1151 if (keep_partial && !partial_dir) {
1152 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
1153 partial_dir = strdup(arg);
1157 clean_fname(partial_dir, 1);
1158 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1160 else if (*partial_dir != '/') {
1161 parse_rule(&filter_list, partial_dir,
1162 MATCHFLG_NO_PREFIXES|MATCHFLG_DIRECTORY, 0);
1164 if (!partial_dir && refused_partial) {
1165 create_refuse_error(refused_partial);
1174 if (*argc > 2 || (!am_daemon && *argc == 1)) {
1176 exit_cleanup(RERR_SYNTAX);
1178 if (strcmp(files_from, "-") == 0) {
1181 remote_filesfrom_file = "-";
1183 else if ((colon = find_colon(files_from)) != 0) {
1186 exit_cleanup(RERR_SYNTAX);
1188 remote_filesfrom_file = colon+1 + (colon[1] == ':');
1189 if (strcmp(remote_filesfrom_file, "-") == 0) {
1190 snprintf(err_buf, sizeof err_buf,
1191 "Invalid --files-from remote filename\n");
1195 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1196 if (filesfrom_fd < 0) {
1197 snprintf(err_buf, sizeof err_buf,
1198 "failed to open files-from file %s: %s\n",
1199 files_from, strerror(errno));
1210 * Construct a filtered list of options to pass through from the
1211 * client to the server.
1213 * This involves setting options that will tell the server how to
1214 * behave, and also filtering out options that are processed only
1217 void server_options(char **args,int *argc)
1219 static char argstr[50+MAX_BASIS_DIRS*2];
1225 if (blocking_io == -1)
1228 args[ac++] = "--server";
1230 if (daemon_over_rsh) {
1231 args[ac++] = "--daemon";
1233 /* if we're passing --daemon, we're done */
1238 args[ac++] = "--sender";
1242 for (i = 0; i < verbose; i++)
1245 /* the -q option is intentionally left out */
1258 if (keep_dirlinks && am_sender)
1263 /* We don't need to send --no-whole-file, because it's the
1264 * default for remote transfers, and in any case old versions
1265 * of rsync will not understand it. */
1267 if (preserve_hard_links)
1273 if (preserve_devices)
1277 if (omit_dir_times == 2 && am_sender)
1283 if (always_checksum)
1291 if (one_file_system)
1298 /* This is a complete hack - blame Rusty. FIXME!
1299 * This hack is only needed for older rsync versions that
1300 * don't understand the --list-only option. */
1301 if (list_only == 1 && recurse >= 0)
1307 args[ac++] = argstr;
1310 args[ac++] = "--list-only";
1312 /* The server side doesn't use our log-format, but in certain
1313 * circumstances they need to know a little about the option. */
1314 if (log_format && am_sender) {
1315 if (log_format_has_i)
1316 args[ac++] = "--log-format=%i";
1317 else if (log_format_has_o_or_i)
1318 args[ac++] = "--log-format=%o";
1320 args[ac++] = "--log-format=X";
1324 if (asprintf(&arg, "-B%lu", block_size) < 0)
1329 if (max_delete && am_sender) {
1330 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1335 if (max_size && am_sender) {
1336 args[ac++] = "--max-size";
1337 args[ac++] = max_size_arg;
1341 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1347 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1353 args[ac++] = "--backup-dir";
1354 args[ac++] = backup_dir;
1357 /* Only send --suffix if it specifies a non-default value. */
1358 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
1359 /* We use the following syntax to avoid weirdness with '~'. */
1360 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1366 if (delete_excluded)
1367 args[ac++] = "--delete-excluded";
1368 else if (delete_before == 1 || delete_after)
1369 args[ac++] = "--delete";
1370 if (delete_before > 1)
1371 args[ac++] = "--delete-before";
1373 args[ac++] = "--delete-during";
1375 args[ac++] = "--delete-after";
1377 args[ac++] = "--force";
1381 args[ac++] = "--size-only";
1383 if (modify_window_set) {
1384 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1389 if (checksum_seed) {
1390 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
1395 if (partial_dir && am_sender) {
1396 if (partial_dir != partialdir_for_delayupdate) {
1397 args[ac++] = "--partial-dir";
1398 args[ac++] = partial_dir;
1401 args[ac++] = "--delay-updates";
1402 } else if (keep_partial)
1403 args[ac++] = "--partial";
1406 args[ac++] = "--ignore-errors";
1408 if (copy_unsafe_links)
1409 args[ac++] = "--copy-unsafe-links";
1412 args[ac++] = "--safe-links";
1415 args[ac++] = "--numeric-ids";
1417 if (only_existing && am_sender)
1418 args[ac++] = "--existing";
1420 if (opt_ignore_existing && am_sender)
1421 args[ac++] = "--ignore-existing";
1424 args[ac++] = "--inplace";
1427 args[ac++] = "--temp-dir";
1428 args[ac++] = tmpdir;
1431 if (basis_dir[0] && am_sender) {
1432 /* the server only needs this option if it is not the sender,
1433 * and it may be an older version that doesn't know this
1434 * option, so don't send it if client is the sender.
1437 for (i = 0; i < basis_dir_cnt; i++) {
1438 args[ac++] = dest_option;
1439 args[ac++] = basis_dir[i];
1443 if (files_from && (!am_sender || remote_filesfrom_file)) {
1444 if (remote_filesfrom_file) {
1445 args[ac++] = "--files-from";
1446 args[ac++] = remote_filesfrom_file;
1448 args[ac++] = "--from0";
1450 args[ac++] = "--files-from=-";
1451 args[ac++] = "--from0";
1453 if (!relative_paths)
1454 args[ac++] = "--no-relative";
1456 if (!implied_dirs && !am_sender)
1457 args[ac++] = "--no-implied-dirs";
1459 if (fuzzy_basis && am_sender)
1460 args[ac++] = "--fuzzy";
1462 if (remove_sent_files)
1463 args[ac++] = "--remove-sent-files";
1469 out_of_memory("server_options");
1473 * Return the position of a ':' IF it is not part of a filename (i.e. as
1474 * long as it doesn't occur after a slash.
1476 char *find_colon(char *s)
1484 /* now check to see if there is a / in the string before the : - if there is then
1485 discard the colon on the assumption that the : is part of a filename */