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;
146 int basis_dir_cnt = 0;
150 int itemize_changes = 0;
151 int log_before_transfer = 0;
152 int log_format_has_i = 0;
153 int log_format_has_o_or_i = 0;
154 int always_checksum = 0;
157 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
158 char *batch_name = NULL;
160 static int daemon_opt; /* sets am_daemon after option error-reporting */
161 static int F_option_cnt = 0;
162 static int modify_window_set;
163 static int refused_delete, refused_archive_part;
164 static int refused_partial, refused_progress, refused_delete_before;
165 static char *dest_option = NULL;
166 static char *max_size_arg;
167 static char partialdir_for_delayupdate[] = ".~tmp~";
169 /** Local address to bind. As a character string because it's
170 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
171 * address, or a hostname. **/
175 static void print_rsync_version(enum logcode f)
177 char const *got_socketpair = "no ";
178 char const *have_inplace = "no ";
179 char const *hardlinks = "no ";
180 char const *links = "no ";
181 char const *ipv6 = "no ";
182 STRUCT_STAT *dumstat;
184 #ifdef HAVE_SOCKETPAIR
188 #ifdef HAVE_FTRUNCATE
192 #ifdef SUPPORT_HARD_LINKS
204 rprintf(f, "%s version %s protocol version %d\n",
205 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
207 "Copyright (C) 1996-2005 by Andrew Tridgell and others\n");
208 rprintf(f, "<http://rsync.samba.org/>\n");
209 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
210 "%shard links, %ssymlinks, batchfiles, \n",
211 (int) (sizeof (OFF_T) * 8),
212 got_socketpair, hardlinks, links);
214 /* Note that this field may not have type ino_t. It depends
215 * on the complicated interaction between largefile feature
217 rprintf(f, " %sinplace, %sIPv6, %d-bit system inums, %d-bit internal inums\n",
219 (int) (sizeof dumstat->st_ino * 8),
220 (int) (sizeof (int64) * 8));
221 #ifdef MAINTAINER_MODE
222 rprintf(f, " panic action: \"%s\"\n",
227 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
229 if (sizeof (int64) != SIZEOF_INT64) {
231 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
232 (int) SIZEOF_INT64, (int) sizeof (int64));
237 "rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
238 "are welcome to redistribute it under certain conditions. See the GNU\n"
239 "General Public Licence for details.\n"
244 void usage(enum logcode F)
246 print_rsync_version(F);
248 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
250 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
251 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
252 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
253 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
254 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
255 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
256 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
257 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
258 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
259 rprintf(F," sources separated by space as long as they have same top-level\n");
260 rprintf(F,"\nOptions\n");
261 rprintf(F," -v, --verbose increase verbosity\n");
262 rprintf(F," -q, --quiet suppress non-error messages\n");
263 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
264 rprintf(F," -a, --archive archive mode; same as -rlptgoD (no -H)\n");
265 rprintf(F," -r, --recursive recurse into directories\n");
266 rprintf(F," -R, --relative use relative path names\n");
267 rprintf(F," --no-relative turn off --relative\n");
268 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
269 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
270 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
271 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
272 rprintf(F," -u, --update skip files that are newer on the receiver\n");
273 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
274 rprintf(F," -d, --dirs transfer directories without recursing\n");
275 rprintf(F," -l, --links copy symlinks as symlinks\n");
276 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
277 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
278 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
279 rprintf(F," -H, --hard-links preserve hard links\n");
280 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
281 rprintf(F," -p, --perms preserve permissions\n");
282 rprintf(F," -o, --owner preserve owner (root only)\n");
283 rprintf(F," -g, --group preserve group\n");
284 rprintf(F," -D, --devices preserve devices (root only)\n");
285 rprintf(F," -t, --times preserve times\n");
286 rprintf(F," -O, --omit-dir-times omit directories when preserving times\n");
287 rprintf(F," -S, --sparse handle sparse files efficiently\n");
288 rprintf(F," -n, --dry-run show what would have been transferred\n");
289 rprintf(F," -W, --whole-file copy files whole (without rsync algorithm)\n");
290 rprintf(F," --no-whole-file always use incremental rsync algorithm\n");
291 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
292 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
293 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
294 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
295 rprintf(F," --existing only update files that already exist on receiver\n");
296 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
297 rprintf(F," --remove-sent-files sent files/symlinks are removed from sending side\n");
298 rprintf(F," --del an alias for --delete-during\n");
299 rprintf(F," --delete delete files that don't exist on the sending side\n");
300 rprintf(F," --delete-before receiver deletes before transfer (default)\n");
301 rprintf(F," --delete-during receiver deletes during transfer, not before\n");
302 rprintf(F," --delete-after receiver deletes after transfer, not before\n");
303 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
304 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
305 rprintf(F," --force force deletion of directories even if not empty\n");
306 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
307 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
308 rprintf(F," --partial keep partially transferred files\n");
309 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
310 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
311 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
312 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
313 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
314 rprintf(F," --size-only skip files that match in size\n");
315 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
316 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
317 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
318 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
319 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
320 rprintf(F," -z, --compress compress file data during the transfer\n");
321 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
322 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
323 rprintf(F," -F same as --filter='dir-merge /.rsync-filter'\n");
324 rprintf(F," repeated: --filter='- .rsync-filter'\n");
325 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
326 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
327 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
328 rprintf(F," --include-from=FILE read include patterns from FILE\n");
329 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
330 rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
331 rprintf(F," --version print version number\n");
332 rprintf(F," --port=PORT specify double-colon alternate port number\n");
333 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
334 rprintf(F," --no-blocking-io turn off blocking I/O when it is the default\n");
335 rprintf(F," --stats give some file-transfer stats\n");
336 rprintf(F," --progress show progress during transfer\n");
337 rprintf(F," -P same as --partial --progress\n");
338 rprintf(F," -i, --itemize-changes output a change-summary for all updates\n");
339 rprintf(F," --log-format=FORMAT log file-transfers using specified format\n");
340 rprintf(F," --password-file=FILE read password from FILE\n");
341 rprintf(F," --list-only list the files instead of copying them\n");
342 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
343 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
344 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
346 rprintf(F," -4, --ipv4 prefer IPv4\n");
347 rprintf(F," -6, --ipv6 prefer IPv6\n");
349 rprintf(F," -h, --help show this help screen\n");
351 rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
352 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
353 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
356 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
357 OPT_FILTER, OPT_COMPARE_DEST, OPT_LINK_DEST,
358 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
359 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
360 OPT_REFUSED_BASE = 9000};
362 static struct poptOption long_options[] = {
363 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
364 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
365 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
366 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
367 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
368 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
369 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
370 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
371 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
372 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
373 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
374 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
375 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
376 {"delete-before", 0, POPT_ARG_VAL, &delete_before, 2, 0, 0 },
377 {"delete-during", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
378 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
379 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
380 {"remove-sent-files",0, POPT_ARG_NONE, &remove_sent_files, 0, 0, 0 },
381 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
382 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
383 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
384 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
385 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
386 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
387 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
388 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
389 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
390 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
391 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
392 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
393 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
394 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
395 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
396 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
397 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
398 {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 },
399 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
400 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
401 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
402 {"copy-unsafe-links",0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 },
403 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
404 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
405 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
406 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
407 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
408 {"omit-dir-times", 'O', POPT_ARG_VAL, &omit_dir_times, 2, 0, 0 },
409 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
410 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
411 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
412 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
413 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
414 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
415 {"recursive", 'r', POPT_ARG_VAL, &recurse, -1, 0, 0 },
416 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
417 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
418 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
419 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
420 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
421 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
422 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
423 {"timeout", 0, POPT_ARG_INT, &io_timeout, OPT_TIMEOUT, 0, 0 },
424 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
425 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
426 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
427 {"fuzzy", 'y', POPT_ARG_NONE, &fuzzy_basis, 0, 0, 0 },
428 /* TODO: Should this take an optional int giving the compression level? */
429 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
430 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
431 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
432 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
433 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
434 {"delay-updates", 0, POPT_ARG_NONE, &delay_updates, 0, 0, 0 },
435 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
436 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
437 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
438 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
439 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
440 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
441 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
442 {"itemize-changes", 'i', POPT_ARG_NONE, &itemize_changes, 0, 0, 0 },
443 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
444 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
445 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
446 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
447 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
448 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
449 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
450 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
451 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
452 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
454 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
455 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
457 /* All these options switch us into daemon-mode option-parsing. */
458 {"address", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
459 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
460 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
461 {"detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
462 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
466 static void daemon_usage(enum logcode F)
468 print_rsync_version(F);
470 rprintf(F,"\nUsage: rsync --daemon [OPTION]...\n");
471 rprintf(F," --address=ADDRESS bind to the specified address\n");
472 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
473 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
474 rprintf(F," --no-detach do not detach from the parent\n");
475 rprintf(F," --port=PORT listen on alternate port number\n");
476 rprintf(F," -v, --verbose increase verbosity\n");
478 rprintf(F," -4, --ipv4 prefer IPv4\n");
479 rprintf(F," -6, --ipv6 prefer IPv6\n");
481 rprintf(F," -h, --help show this help screen\n");
483 rprintf(F,"\nIf you were not trying to invoke rsync as a daemon, avoid using any of the\n");
484 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
487 static struct poptOption long_daemon_options[] = {
488 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
489 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
490 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
491 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
492 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
494 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
495 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
497 {"detach", 0, POPT_ARG_VAL, &no_detach, 0, 0, 0 },
498 {"no-detach", 0, POPT_ARG_VAL, &no_detach, 1, 0, 0 },
499 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
500 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
501 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
502 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
503 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
508 static char err_buf[200];
512 * Store the option error message, if any, so that we can log the
513 * connection attempt (which requires parsing the options), and then
514 * show the error later on.
516 void option_error(void)
519 strcpy(err_buf, "Error parsing options: "
520 "option may be supported on client but not on server?\n");
523 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
528 * Tweak the option table to disable all options that the rsyncd.conf
529 * file has told us to refuse.
531 static void set_refuse_options(char *bp)
533 struct poptOption *op;
534 char *cp, shortname[2];
535 int is_wild, found_match;
540 while (*bp == ' ') bp++;
543 if ((cp = strchr(bp, ' ')) != NULL)
545 is_wild = strpbrk(bp, "*?[") != NULL;
547 for (op = long_options; ; op++) {
548 *shortname = op->shortName;
549 if (!op->longName && !*shortname)
551 if ((op->longName && wildmatch(bp, op->longName))
552 || (*shortname && wildmatch(bp, shortname))) {
553 if (op->argInfo == POPT_ARG_VAL)
554 op->argInfo = POPT_ARG_NONE;
555 op->val = (op - long_options) + OPT_REFUSED_BASE;
557 /* These flags are set to let us easily check
558 * an implied option later in the code. */
559 switch (*shortname) {
560 case 'r': case 'd': case 'l': case 'p':
561 case 't': case 'g': case 'o': case 'D':
562 refused_archive_part = op->val;
565 if (wildmatch("delete", op->longName))
566 refused_delete = op->val;
567 else if (wildmatch("delete-before", op->longName))
568 refused_delete_before = op->val;
569 else if (wildmatch("partial", op->longName))
570 refused_partial = op->val;
571 else if (wildmatch("progress", op->longName))
572 refused_progress = op->val;
580 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
589 for (op = long_options; ; op++) {
590 *shortname = op->shortName;
591 if (!op->longName && !*shortname)
593 if (op->val == OPT_DAEMON) {
594 if (op->argInfo == POPT_ARG_VAL)
595 op->argInfo = POPT_ARG_NONE;
596 op->val = (op - long_options) + OPT_REFUSED_BASE;
602 static int count_args(const char **argv)
607 while (argv[i] != NULL)
615 static void create_refuse_error(int which)
617 /* The "which" value is the index + OPT_REFUSED_BASE. */
618 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
619 int n = snprintf(err_buf, sizeof err_buf,
620 "The server is configured to refuse --%s\n",
623 snprintf(err_buf + n, sizeof err_buf - n,
624 " (-%c)\n", op->shortName);
630 * Process command line arguments. Called on both local and remote.
632 * @retval 1 if all options are OK; with globals set to appropriate
635 * @retval 0 on error, with err_buf containing an explanation
637 int parse_arguments(int *argc, const char ***argv, int frommain)
640 char *ref = lp_refuse_options(module_id);
645 set_refuse_options(ref);
647 /* TODO: Call poptReadDefaultConfig; handle errors. */
649 /* The context leaks in case of an error, but if there's a
650 * problem we always exit anyhow. */
651 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
652 poptReadDefaultConfig(pc, 0);
654 while ((opt = poptGetNextOpt(pc)) != -1) {
655 /* most options are handled automatically by popt;
656 * only special cases are returned and listed here. */
660 print_rsync_version(FINFO);
665 strcpy(err_buf, "Attempt to hack rsync thwarted!\n");
669 pc = poptGetContext(RSYNC_NAME, *argc, *argv,
670 long_daemon_options, 0);
671 while ((opt = poptGetNextOpt(pc)) != -1) {
683 "rsync: %s: %s (in daemon mode)\n",
684 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
690 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
693 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
694 exit_cleanup(RERR_SYNTAX);
696 *argv = poptGetArgs(pc);
697 *argc = count_args(*argv);
702 case OPT_MODIFY_WINDOW:
703 /* The value has already been set by popt, but
704 * we need to remember that we're using a
705 * non-default setting. */
706 modify_window_set = 1;
710 parse_rule(&filter_list, poptGetOptArg(pc), 0, 0);
714 parse_rule(&filter_list, poptGetOptArg(pc),
715 0, XFLG_OLD_PREFIXES);
719 parse_rule(&filter_list, poptGetOptArg(pc),
720 MATCHFLG_INCLUDE, XFLG_OLD_PREFIXES);
723 case OPT_EXCLUDE_FROM:
724 case OPT_INCLUDE_FROM:
725 arg = poptGetOptArg(pc);
727 arg = sanitize_path(NULL, arg, NULL, 0);
728 if (server_filter_list.head) {
729 char *cp = (char *)arg;
731 goto options_rejected;
733 if (check_filter(&server_filter_list, cp, 0) < 0)
734 goto options_rejected;
736 parse_filter_file(&filter_list, arg,
737 opt == OPT_INCLUDE_FROM ? MATCHFLG_INCLUDE : 0,
738 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
757 exit_cleanup(RERR_SYNTAX);
763 switch (++F_option_cnt) {
765 parse_rule(&filter_list,": /.rsync-filter",0,0);
768 parse_rule(&filter_list,"- .rsync-filter",0,0);
774 if (refused_partial || refused_progress) {
775 create_refuse_error(refused_partial
776 ? refused_partial : refused_progress);
783 case OPT_WRITE_BATCH:
784 /* batch_name is already set */
789 /* batch_name is already set */
794 for (arg = max_size_arg; isdigit(*(uchar*)arg); arg++) {}
796 for (arg++; isdigit(*(uchar*)arg); arg++) {}
799 max_size = atof(max_size_arg) * 1024;
802 max_size = atof(max_size_arg) * 1024*1024;
805 max_size = atof(max_size_arg) * 1024*1024*1024;
808 max_size = atof(max_size_arg);
815 snprintf(err_buf, sizeof err_buf,
816 "--max-size value is invalid: %s\n",
823 if (io_timeout && io_timeout < select_timeout)
824 select_timeout = io_timeout;
830 dest_option = "--link-dest";
833 snprintf(err_buf, sizeof err_buf,
834 "hard links are not supported on this %s\n",
835 am_server ? "server" : "client");
839 case OPT_COMPARE_DEST:
841 dest_option = "--compare-dest";
843 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
844 snprintf(err_buf, sizeof err_buf,
845 "ERROR: at most %d %s args may be specified\n",
846 MAX_BASIS_DIRS, dest_option);
849 arg = poptGetOptArg(pc);
851 arg = sanitize_path(NULL, arg, NULL, 0);
852 basis_dir[basis_dir_cnt++] = (char *)arg;
856 /* A large opt value means that set_refuse_options()
857 * turned this option off. */
858 if (opt >= OPT_REFUSED_BASE) {
859 create_refuse_error(opt);
862 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
863 am_server ? "on remote machine: " : "",
864 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
873 #ifndef SUPPORT_LINKS
874 if (preserve_links && !am_sender) {
875 snprintf(err_buf, sizeof err_buf,
876 "symlinks are not supported on this %s\n",
877 am_server ? "server" : "client");
882 #ifndef SUPPORT_HARD_LINKS
883 if (preserve_hard_links) {
884 snprintf(err_buf, sizeof err_buf,
885 "hard links are not supported on this %s\n",
886 am_server ? "server" : "client");
891 if (write_batch && read_batch) {
892 snprintf(err_buf, sizeof err_buf,
893 "--write-batch and --read-batch can not be used together\n");
896 if (write_batch || read_batch) {
898 snprintf(err_buf, sizeof err_buf,
899 "--%s-batch cannot be used with --dry_run (-n)\n",
900 write_batch ? "write" : "read");
905 "ignoring --%s-batch option sent to server\n",
906 write_batch ? "write" : "read");
907 /* We don't actually exit_cleanup(), so that we can
908 * still service older version clients that still send
909 * batch args to server. */
910 read_batch = write_batch = 0;
914 if (read_batch && files_from) {
915 snprintf(err_buf, sizeof err_buf,
916 "--read-batch cannot be used with --files-from\n");
919 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
920 snprintf(err_buf, sizeof err_buf,
921 "the batch-file name must be %d characters or less.\n",
926 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
927 snprintf(err_buf, sizeof err_buf,
928 "the --temp-dir path is WAY too long.\n");
932 if (compare_dest + link_dest > 1) {
933 snprintf(err_buf, sizeof err_buf,
934 "You may not mix --compare-dest and --link-dest.\n");
939 if (refused_archive_part) {
940 create_refuse_error(refused_archive_part);
944 recurse = -1; /* infinite recursion */
952 preserve_devices = 1;
955 if (recurse || list_only || files_from)
958 if (relative_paths < 0)
959 relative_paths = files_from? 1 : 0;
961 if (!!delete_before + delete_during + delete_after > 1) {
962 snprintf(err_buf, sizeof err_buf,
963 "You may not combine multiple --delete-WHEN options.\n");
967 delete_before = delete_during = delete_after = 0;
968 delete_mode = delete_excluded = 0;
969 } else if (delete_before || delete_during || delete_after)
971 else if (delete_mode || delete_excluded) {
972 if (refused_delete_before) {
973 create_refuse_error(refused_delete_before);
976 delete_mode = delete_before = 1;
979 if (delete_mode && refused_delete) {
980 create_refuse_error(refused_delete);
984 if (remove_sent_files) {
985 /* We only want to infer this refusal of --remove-sent-files
986 * via the refusal of "delete", not any of the "delete-FOO"
988 if (refused_delete && am_sender) {
989 create_refuse_error(refused_delete);
992 need_messages_from_generator = 1;
995 *argv = poptGetArgs(pc);
996 *argc = count_args(*argv);
998 if (sanitize_paths) {
1000 for (i = *argc; i-- > 0; )
1001 (*argv)[i] = sanitize_path(NULL, (*argv)[i], "", 0);
1003 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
1005 partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
1007 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
1009 files_from = sanitize_path(NULL, files_from, NULL, 0);
1011 if (server_filter_list.head && !am_sender) {
1012 struct filter_list_struct *elp = &server_filter_list;
1016 goto options_rejected;
1017 clean_fname(tmpdir, 1);
1018 if (check_filter(elp, tmpdir, 1) < 0)
1019 goto options_rejected;
1021 if (partial_dir && *partial_dir) {
1022 clean_fname(partial_dir, 1);
1023 if (check_filter(elp, partial_dir, 1) < 0)
1024 goto options_rejected;
1026 for (i = 0; i < basis_dir_cnt; i++) {
1028 goto options_rejected;
1029 clean_fname(basis_dir[i], 1);
1030 if (check_filter(elp, basis_dir[i], 1) < 0)
1031 goto options_rejected;
1035 goto options_rejected;
1036 clean_fname(backup_dir, 1);
1037 if (check_filter(elp, backup_dir, 1) < 0)
1038 goto options_rejected;
1041 if (server_filter_list.head && files_from) {
1043 goto options_rejected;
1044 clean_fname(files_from, 1);
1045 if (check_filter(&server_filter_list, files_from, 0) < 0) {
1047 snprintf(err_buf, sizeof err_buf,
1048 "Your options have been rejected by the server.\n");
1054 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
1055 backup_suffix_len = strlen(backup_suffix);
1056 if (strchr(backup_suffix, '/') != NULL) {
1057 snprintf(err_buf, sizeof err_buf,
1058 "--suffix cannot contain slashes: %s\n",
1063 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
1064 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
1065 if (backup_dir_remainder < 32) {
1066 snprintf(err_buf, sizeof err_buf,
1067 "the --backup-dir path is WAY too long.\n");
1070 if (backup_dir_buf[backup_dir_len - 1] != '/') {
1071 backup_dir_buf[backup_dir_len++] = '/';
1072 backup_dir_buf[backup_dir_len] = '\0';
1074 if (verbose > 1 && !am_sender) {
1075 rprintf(FINFO, "backup_dir is %s\n",
1076 safe_fname(backup_dir_buf));
1078 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
1079 snprintf(err_buf, sizeof err_buf,
1080 "--suffix cannot be a null string without --backup-dir\n");
1083 if (make_backups && !backup_dir)
1087 if (strstr(log_format, "%i") != NULL)
1088 log_format_has_i = 1;
1089 if (strstr(log_format, "%b") == NULL
1090 && strstr(log_format, "%c") == NULL)
1091 log_before_transfer = !am_server;
1092 } else if (itemize_changes) {
1093 log_format = "%i %n%L";
1094 log_format_has_i = 1;
1095 log_before_transfer = !am_server;
1098 if ((do_progress || dry_run) && !verbose && !log_before_transfer
1102 if (verbose && !log_format) {
1103 log_format = "%n%L";
1104 log_before_transfer = !am_server;
1106 if (log_format_has_i
1107 || (log_format && strstr(log_format, "%o") != NULL))
1108 log_format_has_o_or_i = 1;
1110 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
1111 bwlimit = daemon_bwlimit;
1113 bwlimit_writemax = (size_t)bwlimit * 128;
1114 if (bwlimit_writemax < 512)
1115 bwlimit_writemax = 512;
1118 if (delay_updates && !partial_dir)
1119 partial_dir = partialdir_for_delayupdate;
1122 #ifdef HAVE_FTRUNCATE
1124 snprintf(err_buf, sizeof err_buf,
1125 "--inplace cannot be used with --%s\n",
1126 delay_updates ? "delay-updates" : "partial-dir");
1129 /* --inplace implies --partial for refusal purposes, but we
1130 * clear the keep_partial flag for internal logic purposes. */
1131 if (refused_partial) {
1132 create_refuse_error(refused_partial);
1137 snprintf(err_buf, sizeof err_buf,
1138 "--inplace is not supported on this %s\n",
1139 am_server ? "server" : "client");
1143 if (keep_partial && !partial_dir) {
1144 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
1145 partial_dir = strdup(arg);
1149 clean_fname(partial_dir, 1);
1150 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1152 else if (*partial_dir != '/') {
1153 parse_rule(&filter_list, partial_dir,
1154 MATCHFLG_NO_PREFIXES|MATCHFLG_DIRECTORY, 0);
1156 if (!partial_dir && refused_partial) {
1157 create_refuse_error(refused_partial);
1166 if (*argc > 2 || (!am_daemon && *argc == 1)) {
1168 exit_cleanup(RERR_SYNTAX);
1170 if (strcmp(files_from, "-") == 0) {
1173 remote_filesfrom_file = "-";
1175 else if ((colon = find_colon(files_from)) != 0) {
1178 exit_cleanup(RERR_SYNTAX);
1180 remote_filesfrom_file = colon+1 + (colon[1] == ':');
1181 if (strcmp(remote_filesfrom_file, "-") == 0) {
1182 snprintf(err_buf, sizeof err_buf,
1183 "Invalid --files-from remote filename\n");
1187 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1188 if (filesfrom_fd < 0) {
1189 snprintf(err_buf, sizeof err_buf,
1190 "failed to open files-from file %s: %s\n",
1191 files_from, strerror(errno));
1202 * Construct a filtered list of options to pass through from the
1203 * client to the server.
1205 * This involves setting options that will tell the server how to
1206 * behave, and also filtering out options that are processed only
1209 void server_options(char **args,int *argc)
1211 static char argstr[50+MAX_BASIS_DIRS*2];
1217 if (blocking_io == -1)
1220 args[ac++] = "--server";
1222 if (daemon_over_rsh) {
1223 args[ac++] = "--daemon";
1225 /* if we're passing --daemon, we're done */
1230 args[ac++] = "--sender";
1234 for (i = 0; i < verbose; i++)
1237 /* the -q option is intentionally left out */
1250 if (keep_dirlinks && am_sender)
1255 /* We don't need to send --no-whole-file, because it's the
1256 * default for remote transfers, and in any case old versions
1257 * of rsync will not understand it. */
1259 if (preserve_hard_links)
1265 if (preserve_devices)
1269 if (omit_dir_times == 2 && am_sender)
1275 if (always_checksum)
1283 if (one_file_system)
1290 /* This is a complete hack - blame Rusty. FIXME!
1291 * This hack is only needed for older rsync versions that
1292 * don't understand the --list-only option. */
1293 if (list_only == 1 && recurse >= 0)
1299 args[ac++] = argstr;
1302 args[ac++] = "--list-only";
1304 /* The server side doesn't use our log-format, but in certain
1305 * circumstances they need to know a little about the option. */
1306 if (log_format && am_sender) {
1307 if (log_format_has_i)
1308 args[ac++] = "--log-format=%i";
1309 else if (log_format_has_o_or_i)
1310 args[ac++] = "--log-format=%o";
1312 args[ac++] = "--log-format=X";
1316 if (asprintf(&arg, "-B%lu", block_size) < 0)
1321 if (max_delete && am_sender) {
1322 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1327 if (max_size && am_sender) {
1328 args[ac++] = "--max-size";
1329 args[ac++] = max_size_arg;
1333 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1339 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1345 args[ac++] = "--backup-dir";
1346 args[ac++] = backup_dir;
1349 /* Only send --suffix if it specifies a non-default value. */
1350 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
1351 /* We use the following syntax to avoid weirdness with '~'. */
1352 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1358 if (delete_excluded)
1359 args[ac++] = "--delete-excluded";
1360 else if (delete_before == 1 || delete_after)
1361 args[ac++] = "--delete";
1362 if (delete_before > 1)
1363 args[ac++] = "--delete-before";
1365 args[ac++] = "--delete-during";
1367 args[ac++] = "--delete-after";
1369 args[ac++] = "--force";
1373 args[ac++] = "--size-only";
1375 if (modify_window_set) {
1376 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1381 if (checksum_seed) {
1382 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
1387 if (partial_dir && am_sender) {
1388 if (partial_dir != partialdir_for_delayupdate) {
1389 args[ac++] = "--partial-dir";
1390 args[ac++] = partial_dir;
1393 args[ac++] = "--delay-updates";
1394 } else if (keep_partial)
1395 args[ac++] = "--partial";
1398 args[ac++] = "--ignore-errors";
1400 if (copy_unsafe_links)
1401 args[ac++] = "--copy-unsafe-links";
1404 args[ac++] = "--safe-links";
1407 args[ac++] = "--numeric-ids";
1409 if (only_existing && am_sender)
1410 args[ac++] = "--existing";
1412 if (opt_ignore_existing && am_sender)
1413 args[ac++] = "--ignore-existing";
1416 args[ac++] = "--inplace";
1419 args[ac++] = "--temp-dir";
1420 args[ac++] = tmpdir;
1423 if (basis_dir[0] && am_sender) {
1424 /* the server only needs this option if it is not the sender,
1425 * and it may be an older version that doesn't know this
1426 * option, so don't send it if client is the sender.
1429 for (i = 0; i < basis_dir_cnt; i++) {
1430 args[ac++] = dest_option;
1431 args[ac++] = basis_dir[i];
1435 if (files_from && (!am_sender || remote_filesfrom_file)) {
1436 if (remote_filesfrom_file) {
1437 args[ac++] = "--files-from";
1438 args[ac++] = remote_filesfrom_file;
1440 args[ac++] = "--from0";
1442 args[ac++] = "--files-from=-";
1443 args[ac++] = "--from0";
1445 if (!relative_paths)
1446 args[ac++] = "--no-relative";
1448 if (!implied_dirs && !am_sender)
1449 args[ac++] = "--no-implied-dirs";
1451 if (fuzzy_basis && am_sender)
1452 args[ac++] = "--fuzzy";
1454 if (remove_sent_files)
1455 args[ac++] = "--remove-sent-files";
1461 out_of_memory("server_options");
1465 * Return the position of a ':' IF it is not part of a filename (i.e. as
1466 * long as it doesn't occur after a slash.
1468 char *find_colon(char *s)
1476 /* now check to see if there is a / in the string before the : - if there is then
1477 discard the colon on the assumption that the : is part of a filename */