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.
24 extern int sanitize_paths;
25 extern int select_timeout;
26 extern struct filter_list_struct filter_list;
27 extern struct filter_list_struct server_filter_list;
32 * If 1, send the whole file as literal data rather than trying to
33 * create an incremental diff.
35 * If -1, then look at whether we're local or remote and go by that.
37 * @sa disable_deltas_p()
42 int keep_dirlinks = 0;
44 int preserve_links = 0;
45 int preserve_hard_links = 0;
46 int preserve_perms = 0;
47 int preserve_devices = 0;
50 int preserve_times = 0;
51 int omit_dir_times = 0;
58 int delete_during = 0;
59 int delete_before = 0;
61 int delete_excluded = 0;
62 int one_file_system = 0;
63 int protocol_version = PROTOCOL_VERSION;
65 int do_compression = 0;
68 int relative_paths = -1;
78 char *files_from = NULL;
79 int filesfrom_fd = -1;
80 char *remote_filesfrom_file = NULL;
85 int daemon_over_rsh = 0;
89 int safe_symlinks = 0;
90 int copy_unsafe_links = 0;
92 int daemon_bwlimit = 0;
94 size_t bwlimit_writemax = 0;
95 int only_existing = 0;
96 int opt_ignore_existing = 0;
99 int ignore_errors = 0;
100 int modify_window = 0;
101 int blocking_io = -1;
102 int checksum_seed = 0;
104 int delay_updates = 0;
105 long block_size = 0; /* "long" because popt can't set an int32. */
108 /** Network address family. **/
110 int default_af_hint = 0; /* Any protocol */
112 int default_af_hint = AF_INET; /* Must use IPv4 */
115 /** Do not go into the background when run as --daemon. Good
116 * for debugging and required for running as a service on W32,
117 * or under Unix process-monitors. **/
122 int backup_dir_len = 0;
123 int backup_suffix_len;
124 unsigned int backup_dir_remainder;
126 char *backup_suffix = NULL;
128 char *partial_dir = NULL;
129 char *basis_dir[MAX_BASIS_DIRS+1];
130 char *config_file = NULL;
131 char *shell_cmd = NULL;
132 char *log_format = NULL;
133 char *password_file = NULL;
134 char *rsync_path = RSYNC_PATH;
135 char *backup_dir = NULL;
136 char backup_dir_buf[MAXPATHLEN];
138 int compare_dest = 0;
141 int basis_dir_cnt = 0;
145 int always_checksum = 0;
148 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
149 char *batch_name = NULL;
151 static int daemon_opt; /* sets am_daemon after option error-reporting */
152 static int F_option_cnt = 0;
153 static int modify_window_set;
154 static char *dest_option = NULL;
155 static char *max_size_arg;
157 /** Local address to bind. As a character string because it's
158 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
159 * address, or a hostname. **/
163 static void print_rsync_version(enum logcode f)
165 char const *got_socketpair = "no ";
166 char const *have_inplace = "no ";
167 char const *hardlinks = "no ";
168 char const *links = "no ";
169 char const *ipv6 = "no ";
170 STRUCT_STAT *dumstat;
172 #ifdef HAVE_SOCKETPAIR
180 #if SUPPORT_HARD_LINKS
192 rprintf(f, "%s version %s protocol version %d\n",
193 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
195 "Copyright (C) 1996-2005 by Andrew Tridgell and others\n");
196 rprintf(f, "<http://rsync.samba.org/>\n");
197 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
198 "%shard links, %ssymlinks, batchfiles, \n",
199 (int) (sizeof (OFF_T) * 8),
200 got_socketpair, hardlinks, links);
202 /* Note that this field may not have type ino_t. It depends
203 * on the complicated interaction between largefile feature
205 rprintf(f, " %sinplace, %sIPv6, %d-bit system inums, %d-bit internal inums\n",
207 (int) (sizeof dumstat->st_ino * 8),
208 (int) (sizeof (int64) * 8));
209 #ifdef MAINTAINER_MODE
210 rprintf(f, " panic action: \"%s\"\n",
215 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
217 if (sizeof (int64) != SIZEOF_INT64) {
219 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
220 (int) SIZEOF_INT64, (int) sizeof (int64));
225 "rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
226 "are welcome to redistribute it under certain conditions. See the GNU\n"
227 "General Public Licence for details.\n"
232 void usage(enum logcode F)
234 print_rsync_version(F);
236 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
238 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
239 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
240 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
241 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
242 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
243 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
244 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
245 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
246 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
247 rprintf(F," sources separated by space as long as they have same top-level\n");
248 rprintf(F,"\nOptions\n");
249 rprintf(F," -v, --verbose increase verbosity\n");
250 rprintf(F," -q, --quiet suppress non-error messages\n");
251 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
252 rprintf(F," -a, --archive archive mode; same as -rlptgoD (no -H)\n");
253 rprintf(F," -r, --recursive recurse into directories\n");
254 rprintf(F," -R, --relative use relative path names\n");
255 rprintf(F," --no-relative turn off --relative\n");
256 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
257 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
258 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
259 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
260 rprintf(F," -u, --update skip files that are newer on the receiver\n");
261 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
262 rprintf(F," -d, --dirs transfer directories without recursing\n");
263 rprintf(F," -l, --links copy symlinks as symlinks\n");
264 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
265 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
266 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
267 rprintf(F," -H, --hard-links preserve hard links\n");
268 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
269 rprintf(F," -p, --perms preserve permissions\n");
270 rprintf(F," -o, --owner preserve owner (root only)\n");
271 rprintf(F," -g, --group preserve group\n");
272 rprintf(F," -D, --devices preserve devices (root only)\n");
273 rprintf(F," -t, --times preserve times\n");
274 rprintf(F," -O, --omit-dir-times omit directories when preserving times\n");
275 rprintf(F," -S, --sparse handle sparse files efficiently\n");
276 rprintf(F," -n, --dry-run show what would have been transferred\n");
277 rprintf(F," -W, --whole-file copy files whole\n");
278 rprintf(F," --no-whole-file always use incremental rsync algorithm\n");
279 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
280 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
281 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
282 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
283 rprintf(F," --existing only update files that already exist on receiver\n");
284 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
285 rprintf(F," --del an alias for --delete-during\n");
286 rprintf(F," --delete delete files that don't exist on the sending side\n");
287 rprintf(F," --delete-before receiver deletes before transfer (default)\n");
288 rprintf(F," --delete-during receiver deletes during transfer, not before\n");
289 rprintf(F," --delete-after receiver deletes after transfer, not before\n");
290 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
291 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
292 rprintf(F," --force force deletion of directories even if not empty\n");
293 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
294 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
295 rprintf(F," --partial keep partially transferred files\n");
296 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
297 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
298 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
299 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
300 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
301 rprintf(F," --size-only skip files that match in size\n");
302 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
303 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
304 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
305 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
306 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
307 rprintf(F," -z, --compress compress file data\n");
308 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
309 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
310 rprintf(F," -F same as --filter=': /.rsync-filter'\n");
311 rprintf(F," repeated: --filter='- .rsync-filter'\n");
312 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
313 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
314 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
315 rprintf(F," --include-from=FILE read include patterns from FILE\n");
316 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
317 rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
318 rprintf(F," --version print version number\n");
319 rprintf(F," --port=PORT specify double-colon alternate port number\n");
320 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
321 rprintf(F," --no-blocking-io turn off blocking I/O when it is the default\n");
322 rprintf(F," --stats give some file-transfer stats\n");
323 rprintf(F," --progress show progress during transfer\n");
324 rprintf(F," -P same as --partial --progress\n");
325 rprintf(F," --log-format=FORMAT log file-transfers using specified format\n");
326 rprintf(F," --password-file=FILE read password from FILE\n");
327 rprintf(F," --list-only list the files instead of copying them\n");
328 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
329 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
330 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
332 rprintf(F," -4, --ipv4 prefer IPv4\n");
333 rprintf(F," -6, --ipv6 prefer IPv6\n");
335 rprintf(F," -h, --help show this help screen\n");
337 rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
338 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
339 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
342 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
343 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
344 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
345 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
346 OPT_REFUSED_BASE = 9000};
348 static struct poptOption long_options[] = {
349 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
350 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
351 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
352 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
353 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
354 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
355 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
356 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
357 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
358 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
359 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
360 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
361 {"delete-before", 0, POPT_ARG_VAL, &delete_before, 2, 0, 0 },
362 {"delete-during", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
363 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
364 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
365 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
366 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
367 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
368 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
369 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
370 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
371 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
372 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
373 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
374 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
375 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
376 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
377 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
378 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
379 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
380 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
381 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
382 {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 },
383 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
384 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
385 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
386 {"copy-unsafe-links", 0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 },
387 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
388 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
389 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
390 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
391 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
392 {"omit-dir-times", 'O', POPT_ARG_NONE, &omit_dir_times, 0, 0, 0 },
393 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
394 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
395 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
396 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
397 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
398 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
399 {"recursive", 'r', POPT_ARG_VAL, &recurse, -1, 0, 0 },
400 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
401 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
402 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
403 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
404 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
405 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
406 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
407 {"timeout", 0, POPT_ARG_INT, &io_timeout, OPT_TIMEOUT, 0, 0 },
408 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
409 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
410 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
411 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
412 /* TODO: Should this take an optional int giving the compression level? */
413 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
414 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
415 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
416 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
417 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
418 {"delay-updates", 0, POPT_ARG_NONE, &delay_updates, 0, 0, 0 },
419 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
420 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
421 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
422 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
423 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
424 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
425 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
426 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
427 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
428 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
429 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
430 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
431 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
432 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
433 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
434 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
435 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
437 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
438 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
440 /* All these options switch us into daemon-mode option-parsing. */
441 {"address", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
442 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
443 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
444 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
448 static void daemon_usage(enum logcode F)
450 print_rsync_version(F);
452 rprintf(F,"\nUsage: rsync --daemon [OPTION]...\n");
453 rprintf(F," --address=ADDRESS bind to the specified address\n");
454 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
455 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
456 rprintf(F," --no-detach do not detach from the parent\n");
457 rprintf(F," --port=PORT listen on alternate port number\n");
459 rprintf(F," -4, --ipv4 prefer IPv4\n");
460 rprintf(F," -6, --ipv6 prefer IPv6\n");
462 rprintf(F," -h, --help show this help screen\n");
464 rprintf(F,"\nIf you were not trying to invoke rsync as a daemon, avoid using any of the\n");
465 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
468 static struct poptOption long_daemon_options[] = {
469 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
470 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
471 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
472 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
473 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
475 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
476 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
478 {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 },
479 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
480 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
481 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
482 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
487 static char err_buf[200];
491 * Store the option error message, if any, so that we can log the
492 * connection attempt (which requires parsing the options), and then
493 * show the error later on.
495 void option_error(void)
498 strcpy(err_buf, "Error parsing options: "
499 "option may be supported on client but not on server?\n");
502 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
507 * Tweak the option table to disable all options that the rsyncd.conf
508 * file has told us to refuse.
510 static void set_refuse_options(char *bp)
512 struct poptOption *op;
513 char *cp, shortname[2];
514 int is_wild, found_match;
519 while (*bp == ' ') bp++;
522 if ((cp = strchr(bp, ' ')) != NULL)
524 /* If they specify "delete", reject all delete options. */
525 if (strcmp(bp, "delete") == 0)
527 is_wild = strpbrk(bp, "*?[") != NULL;
529 for (op = long_options; ; op++) {
530 *shortname = op->shortName;
531 if (!op->longName && !*shortname)
533 if ((op->longName && wildmatch(bp, op->longName))
534 || (*shortname && wildmatch(bp, shortname))) {
535 if (op->argInfo == POPT_ARG_VAL)
536 op->argInfo = POPT_ARG_NONE;
537 op->val = (op - long_options) + OPT_REFUSED_BASE;
544 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
555 static int count_args(const char **argv)
560 while (argv[i] != NULL)
569 * Process command line arguments. Called on both local and remote.
571 * @retval 1 if all options are OK; with globals set to appropriate
574 * @retval 0 on error, with err_buf containing an explanation
576 int parse_arguments(int *argc, const char ***argv, int frommain)
579 char *ref = lp_refuse_options(module_id);
584 set_refuse_options(ref);
586 /* TODO: Call poptReadDefaultConfig; handle errors. */
588 /* The context leaks in case of an error, but if there's a
589 * problem we always exit anyhow. */
590 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
592 struct poptAlias my_alias;
593 char **argv = new_array(char *, 1);
594 argv[0] = strdup("--delete-during");
595 my_alias.longName = "del", my_alias.shortName = '\0';
597 my_alias.argv = (const char **)argv;
599 poptAddAlias(pc, my_alias, 0);
601 poptReadDefaultConfig(pc, 0);
603 while ((opt = poptGetNextOpt(pc)) != -1) {
604 /* most options are handled automatically by popt;
605 * only special cases are returned and listed here. */
609 print_rsync_version(FINFO);
614 strcpy(err_buf, "Attempt to hack rsync thwarted!\n");
618 pc = poptGetContext(RSYNC_NAME, *argc, *argv,
619 long_daemon_options, 0);
620 while ((opt = poptGetNextOpt(pc)) != -1) {
628 "rsync: %s: %s (in daemon mode)\n",
629 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
635 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
638 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
639 exit_cleanup(RERR_SYNTAX);
641 *argv = poptGetArgs(pc);
642 *argc = count_args(*argv);
647 case OPT_MODIFY_WINDOW:
648 /* The value has already been set by popt, but
649 * we need to remember that we're using a
650 * non-default setting. */
651 modify_window_set = 1;
655 add_filter(&filter_list, poptGetOptArg(pc), 0);
659 add_filter(&filter_list, poptGetOptArg(pc),
664 add_filter(&filter_list, poptGetOptArg(pc),
668 case OPT_EXCLUDE_FROM:
669 case OPT_INCLUDE_FROM:
670 arg = poptGetOptArg(pc);
672 arg = sanitize_path(NULL, arg, NULL, 0);
673 if (server_filter_list.head) {
674 char *cp = (char *)arg;
676 if (check_filter(&server_filter_list, cp, 0) < 0)
677 goto options_rejected;
679 add_filter_file(&filter_list, arg, XFLG_FATAL_ERRORS
680 | (opt == OPT_INCLUDE_FROM ? XFLG_DEF_INCLUDE
681 : XFLG_DEF_EXCLUDE));
700 exit_cleanup(RERR_SYNTAX);
706 switch (++F_option_cnt) {
708 add_filter(&filter_list,
709 ": /.rsync-filter", 0);
712 add_filter(&filter_list,
713 "- .rsync-filter", 0);
723 case OPT_WRITE_BATCH:
724 /* batch_name is already set */
729 /* batch_name is already set */
734 for (arg = max_size_arg; isdigit(*arg); arg++) {}
736 for (arg++; isdigit(*arg); arg++) {}
739 max_size = atof(max_size_arg) * 1024;
742 max_size = atof(max_size_arg) * 1024*1024;
745 max_size = atof(max_size_arg) * 1024*1024*1024;
748 max_size = atof(max_size_arg);
755 snprintf(err_buf, sizeof err_buf,
756 "--max-size value is invalid: %s\n",
763 if (io_timeout && io_timeout < select_timeout)
764 select_timeout = io_timeout;
770 dest_option = "--link-dest";
773 snprintf(err_buf, sizeof err_buf,
774 "hard links are not supported on this %s\n",
775 am_server ? "server" : "client");
781 dest_option = "--copy-dest";
784 case OPT_COMPARE_DEST:
786 dest_option = "--compare-dest";
788 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
789 snprintf(err_buf, sizeof err_buf,
790 "ERROR: at most %d %s args may be specified\n",
791 MAX_BASIS_DIRS, dest_option);
794 arg = poptGetOptArg(pc);
796 arg = sanitize_path(NULL, arg, NULL, 0);
797 basis_dir[basis_dir_cnt++] = (char *)arg;
801 /* A large opt value means that set_refuse_options()
802 * turned this option off (opt-BASE is its index). */
803 if (opt >= OPT_REFUSED_BASE) {
804 struct poptOption *op =
805 &long_options[opt-OPT_REFUSED_BASE];
806 int n = snprintf(err_buf, sizeof err_buf,
807 "The server is configured to refuse --%s\n",
810 snprintf(err_buf+n, sizeof err_buf-n,
811 " (-%c)\n", op->shortName);
814 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
815 am_server ? "on remote machine: " : "",
816 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
824 if (preserve_links && !am_sender) {
825 snprintf(err_buf, sizeof err_buf,
826 "symlinks are not supported on this %s\n",
827 am_server ? "server" : "client");
832 #if !SUPPORT_HARD_LINKS
833 if (preserve_hard_links) {
834 snprintf(err_buf, sizeof err_buf,
835 "hard links are not supported on this %s\n",
836 am_server ? "server" : "client");
841 if (write_batch && read_batch) {
842 snprintf(err_buf, sizeof err_buf,
843 "--write-batch and --read-batch can not be used together\n");
846 if (write_batch || read_batch) {
848 snprintf(err_buf, sizeof err_buf,
849 "--%s-batch cannot be used with --dry_run (-n)\n",
850 write_batch ? "write" : "read");
855 "ignoring --%s-batch option sent to server\n",
856 write_batch ? "write" : "read");
857 /* We don't actually exit_cleanup(), so that we can
858 * still service older version clients that still send
859 * batch args to server. */
860 read_batch = write_batch = 0;
864 if (read_batch && files_from) {
865 snprintf(err_buf, sizeof err_buf,
866 "--read-batch cannot be used with --files-from\n");
869 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
870 snprintf(err_buf, sizeof err_buf,
871 "the batch-file name must be %d characters or less.\n",
876 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
877 snprintf(err_buf, sizeof err_buf,
878 "the --temp-dir path is WAY too long.\n");
882 if (compare_dest + copy_dest + link_dest > 1) {
883 snprintf(err_buf, sizeof err_buf,
884 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
890 recurse = -1; /* infinite recursion */
898 preserve_devices = 1;
901 if (recurse || list_only || files_from)
904 if (relative_paths < 0)
905 relative_paths = files_from? 1 : 0;
907 if (!!delete_before + delete_during + delete_after > 1) {
908 snprintf(err_buf, sizeof err_buf,
909 "You may not combine multiple --delete-WHEN options.\n");
912 if (delete_before || delete_during || delete_after)
914 else if (delete_mode || delete_excluded)
915 delete_mode = delete_before = 1;
917 *argv = poptGetArgs(pc);
918 *argc = count_args(*argv);
920 if (sanitize_paths) {
922 for (i = *argc; i-- > 0; )
923 (*argv)[i] = sanitize_path(NULL, (*argv)[i], "", 0);
925 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
927 partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
929 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
931 files_from = sanitize_path(NULL, files_from, NULL, 0);
933 if (server_filter_list.head && !am_sender) {
934 struct filter_list_struct *elp = &server_filter_list;
937 clean_fname(tmpdir, 1);
938 if (check_filter(elp, tmpdir, 1) < 0)
939 goto options_rejected;
942 clean_fname(partial_dir, 1);
943 if (check_filter(elp, partial_dir, 1) < 0)
944 goto options_rejected;
946 for (i = 0; i < basis_dir_cnt; i++) {
947 clean_fname(basis_dir[i], 1);
948 if (check_filter(elp, basis_dir[i], 1) < 0)
949 goto options_rejected;
952 clean_fname(backup_dir, 1);
953 if (check_filter(elp, backup_dir, 1) < 0)
954 goto options_rejected;
957 if (server_filter_list.head && files_from) {
958 clean_fname(files_from, 1);
959 if (check_filter(&server_filter_list, files_from, 0) < 0) {
961 snprintf(err_buf, sizeof err_buf,
962 "Your options have been rejected by the server.\n");
968 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
969 backup_suffix_len = strlen(backup_suffix);
970 if (strchr(backup_suffix, '/') != NULL) {
971 snprintf(err_buf, sizeof err_buf,
972 "--suffix cannot contain slashes: %s\n",
977 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
978 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
979 if (backup_dir_remainder < 32) {
980 snprintf(err_buf, sizeof err_buf,
981 "the --backup-dir path is WAY too long.\n");
984 if (backup_dir_buf[backup_dir_len - 1] != '/') {
985 backup_dir_buf[backup_dir_len++] = '/';
986 backup_dir_buf[backup_dir_len] = '\0';
988 if (verbose > 1 && !am_sender)
989 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
990 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
991 snprintf(err_buf, sizeof err_buf,
992 "--suffix cannot be a null string without --backup-dir\n");
996 if (do_progress && !verbose)
999 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
1000 bwlimit = daemon_bwlimit;
1002 bwlimit_writemax = (size_t)bwlimit * 128;
1003 if (bwlimit_writemax < 512)
1004 bwlimit_writemax = 512;
1007 if (delay_updates && !partial_dir)
1008 partial_dir = ".~tmp~";
1013 snprintf(err_buf, sizeof err_buf,
1014 "--inplace cannot be used with --%s\n",
1015 delay_updates ? "delay-updates" : "partial-dir");
1020 snprintf(err_buf, sizeof err_buf,
1021 "--inplace is not supported on this %s\n",
1022 am_server ? "server" : "client");
1026 if (keep_partial && !partial_dir)
1027 partial_dir = getenv("RSYNC_PARTIAL_DIR");
1029 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1031 else if (*partial_dir != '/') {
1032 add_filter(&filter_list, partial_dir,
1033 XFLG_DIRECTORY | XFLG_DEF_EXCLUDE);
1041 if (*argc > 2 || (!am_daemon && *argc == 1)) {
1043 exit_cleanup(RERR_SYNTAX);
1045 if (strcmp(files_from, "-") == 0) {
1048 remote_filesfrom_file = "-";
1050 else if ((colon = find_colon(files_from)) != 0) {
1053 exit_cleanup(RERR_SYNTAX);
1055 remote_filesfrom_file = colon+1 + (colon[1] == ':');
1056 if (strcmp(remote_filesfrom_file, "-") == 0) {
1057 snprintf(err_buf, sizeof err_buf,
1058 "Invalid --files-from remote filename\n");
1062 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1063 if (filesfrom_fd < 0) {
1064 snprintf(err_buf, sizeof err_buf,
1065 "failed to open files-from file %s: %s\n",
1066 files_from, strerror(errno));
1077 * Construct a filtered list of options to pass through from the
1078 * client to the server.
1080 * This involves setting options that will tell the server how to
1081 * behave, and also filtering out options that are processed only
1084 void server_options(char **args,int *argc)
1086 static char argstr[50+MAX_BASIS_DIRS*2];
1092 if (blocking_io == -1)
1095 args[ac++] = "--server";
1097 if (daemon_over_rsh) {
1098 args[ac++] = "--daemon";
1100 /* if we're passing --daemon, we're done */
1105 args[ac++] = "--sender";
1109 for (i = 0; i < verbose; i++)
1112 /* the -q option is intentionally left out */
1125 if (keep_dirlinks && am_sender)
1130 /* We don't need to send --no-whole-file, because it's the
1131 * default for remote transfers, and in any case old versions
1132 * of rsync will not understand it. */
1134 if (preserve_hard_links)
1140 if (preserve_devices)
1144 if (omit_dir_times && am_sender)
1150 if (always_checksum)
1158 if (one_file_system)
1165 /* This is a complete hack - blame Rusty. FIXME!
1166 * This hack is only needed for older rsync versions that
1167 * don't understand the --list-only option. */
1168 if (list_only == 1 && recurse >= 0)
1174 args[ac++] = argstr;
1177 args[ac++] = "--list-only";
1180 if (asprintf(&arg, "-B%lu", block_size) < 0)
1185 if (max_delete && am_sender) {
1186 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1191 if (max_size && am_sender) {
1192 args[ac++] = "--max-size";
1193 args[ac++] = max_size_arg;
1197 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1203 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1209 args[ac++] = "--backup-dir";
1210 args[ac++] = backup_dir;
1213 /* Only send --suffix if it specifies a non-default value. */
1214 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
1215 /* We use the following syntax to avoid weirdness with '~'. */
1216 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1222 if (delete_excluded)
1223 args[ac++] = "--delete-excluded";
1224 else if (delete_before == 1 || delete_after)
1225 args[ac++] = "--delete";
1226 if (delete_before > 1)
1227 args[ac++] = "--delete-before";
1229 args[ac++] = "--delete-during";
1231 args[ac++] = "--delete-after";
1233 args[ac++] = "--force";
1237 args[ac++] = "--size-only";
1239 if (modify_window_set) {
1240 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1245 if (checksum_seed) {
1246 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
1251 if (partial_dir && am_sender) {
1252 args[ac++] = "--partial-dir";
1253 args[ac++] = partial_dir;
1255 args[ac++] = "--delay-updates";
1256 } else if (keep_partial)
1257 args[ac++] = "--partial";
1260 args[ac++] = "--ignore-errors";
1262 if (copy_unsafe_links)
1263 args[ac++] = "--copy-unsafe-links";
1266 args[ac++] = "--safe-links";
1269 args[ac++] = "--numeric-ids";
1271 if (only_existing && am_sender)
1272 args[ac++] = "--existing";
1274 if (opt_ignore_existing && am_sender)
1275 args[ac++] = "--ignore-existing";
1278 args[ac++] = "--inplace";
1281 args[ac++] = "--temp-dir";
1282 args[ac++] = tmpdir;
1285 if (basis_dir[0] && am_sender) {
1286 /* the server only needs this option if it is not the sender,
1287 * and it may be an older version that doesn't know this
1288 * option, so don't send it if client is the sender.
1291 for (i = 0; i < basis_dir_cnt; i++) {
1292 args[ac++] = dest_option;
1293 args[ac++] = basis_dir[i];
1297 if (files_from && (!am_sender || remote_filesfrom_file)) {
1298 if (remote_filesfrom_file) {
1299 args[ac++] = "--files-from";
1300 args[ac++] = remote_filesfrom_file;
1302 args[ac++] = "--from0";
1304 args[ac++] = "--files-from=-";
1305 args[ac++] = "--from0";
1307 if (!relative_paths)
1308 args[ac++] = "--no-relative";
1310 if (!implied_dirs && !am_sender)
1311 args[ac++] = "--no-implied-dirs";
1317 out_of_memory("server_options");
1321 * Return the position of a ':' IF it is not part of a filename (i.e. as
1322 * long as it doesn't occur after a slash.
1324 char *find_colon(char *s)
1332 /* now check to see if there is a / in the string before the : - if there is then
1333 discard the colon on the assumption that the : is part of a filename */