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 exclude_list_struct exclude_list;
27 extern struct exclude_list_struct server_exclude_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;
57 int delete_excluded = 0;
58 int one_file_system = 0;
59 int protocol_version = PROTOCOL_VERSION;
61 int do_compression = 0;
64 int relative_paths = -1;
74 char *files_from = NULL;
75 int filesfrom_fd = -1;
76 char *remote_filesfrom_file = NULL;
80 int daemon_over_rsh = 0;
84 int safe_symlinks = 0;
85 int copy_unsafe_links = 0;
87 int daemon_bwlimit = 0;
89 size_t bwlimit_writemax = 0;
91 int only_existing = 0;
92 int opt_ignore_existing = 0;
95 int ignore_errors = 0;
96 int modify_window = 0;
98 int checksum_seed = 0;
100 unsigned int block_size = 0;
103 /** Network address family. **/
105 int default_af_hint = 0; /* Any protocol */
107 int default_af_hint = AF_INET; /* Must use IPv4 */
110 /** Do not go into the background when run as --daemon. Good
111 * for debugging and required for running as a service on W32,
112 * or under Unix process-monitors. **/
117 int backup_dir_len = 0;
118 int backup_suffix_len;
119 unsigned int backup_dir_remainder;
121 char *backup_suffix = NULL;
123 char *partial_dir = NULL;
124 char *basis_dir[MAX_BASIS_DIRS+1];
125 char *config_file = NULL;
126 char *shell_cmd = NULL;
127 char *log_format = NULL;
128 char *password_file = NULL;
129 char *rsync_path = RSYNC_PATH;
130 char *backup_dir = NULL;
131 char backup_dir_buf[MAXPATHLEN];
138 int always_checksum = 0;
141 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
142 char *batch_name = NULL;
144 static int daemon_opt; /* sets am_daemon after option error-reporting */
145 static int modify_window_set;
146 static int compare_dest = 0;
147 static int basis_dir_cnt = 0;
148 static char *dest_option;
149 static char *max_size_arg;
151 /** Local address to bind. As a character string because it's
152 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
153 * address, or a hostname. **/
157 static void print_rsync_version(enum logcode f)
159 char const *got_socketpair = "no ";
160 char const *have_inplace = "no ";
161 char const *hardlinks = "no ";
162 char const *links = "no ";
163 char const *ipv6 = "no ";
164 STRUCT_STAT *dumstat;
166 #ifdef HAVE_SOCKETPAIR
174 #if SUPPORT_HARD_LINKS
186 rprintf(f, "%s version %s protocol version %d\n",
187 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
189 "Copyright (C) 1996-2004 by Andrew Tridgell and others\n");
190 rprintf(f, "<http://rsync.samba.org/>\n");
191 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
192 "%shard links, %ssymlinks, batchfiles, \n",
193 (int) (sizeof (OFF_T) * 8),
194 got_socketpair, hardlinks, links);
196 /* Note that this field may not have type ino_t. It depends
197 * on the complicated interaction between largefile feature
199 rprintf(f, " %sinplace, %sIPv6, %d-bit system inums, %d-bit internal inums\n",
201 (int) (sizeof dumstat->st_ino * 8),
202 (int) (sizeof (uint64) * 8));
203 #ifdef MAINTAINER_MODE
204 rprintf(f, " panic action: \"%s\"\n",
208 #ifdef INT64_IS_OFF_T
209 if (sizeof (int64) < 8)
210 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
215 "rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
216 "are welcome to redistribute it under certain conditions. See the GNU\n"
217 "General Public Licence for details.\n"
222 void usage(enum logcode F)
224 print_rsync_version(F);
226 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
228 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
229 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
230 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
231 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
232 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
233 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
234 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
235 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
236 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
237 rprintf(F," sources separated by space as long as they have same top-level\n");
238 rprintf(F,"\nOptions\n");
239 rprintf(F," -v, --verbose increase verbosity\n");
240 rprintf(F," -q, --quiet decrease verbosity\n");
241 rprintf(F," -c, --checksum always checksum\n");
242 rprintf(F," -a, --archive archive mode, equivalent to -rlptgoD (no -H)\n");
243 rprintf(F," -r, --recursive recurse into directories\n");
244 rprintf(F," -R, --relative use relative path names\n");
245 rprintf(F," --no-relative turn off --relative\n");
246 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
247 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
248 rprintf(F," --backup-dir make backups into this directory\n");
249 rprintf(F," --suffix=SUFFIX backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
250 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
251 rprintf(F," --inplace update destination files inplace (SEE MAN PAGE)\n");
252 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
253 rprintf(F," -l, --links copy symlinks as symlinks\n");
254 rprintf(F," -L, --copy-links copy the referent of all symlinks\n");
255 rprintf(F," --copy-unsafe-links copy the referent of \"unsafe\" symlinks\n");
256 rprintf(F," --safe-links ignore \"unsafe\" symlinks\n");
257 rprintf(F," -H, --hard-links preserve hard links\n");
258 rprintf(F," -p, --perms preserve permissions\n");
259 rprintf(F," -o, --owner preserve owner (root only)\n");
260 rprintf(F," -g, --group preserve group\n");
261 rprintf(F," -D, --devices preserve devices (root only)\n");
262 rprintf(F," -t, --times preserve times\n");
263 rprintf(F," -S, --sparse handle sparse files efficiently\n");
264 rprintf(F," -n, --dry-run show what would have been transferred\n");
265 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
266 rprintf(F," --no-whole-file turn off --whole-file\n");
267 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
268 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
269 rprintf(F," -e, --rsh=COMMAND specify the remote shell\n");
270 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
271 rprintf(F," --existing only update files that already exist\n");
272 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
273 rprintf(F," --delete delete files that don't exist on the sending side\n");
274 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
275 rprintf(F," --delete-after receiver deletes after transferring, not before\n");
276 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
277 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
278 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
279 rprintf(F," --partial keep partially transferred files\n");
280 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
281 rprintf(F," --force force deletion of directories even if not empty\n");
282 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
283 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
284 rprintf(F," -I, --ignore-times turn off mod time & file size quick check\n");
285 rprintf(F," --size-only ignore mod time for quick check (use size)\n");
286 rprintf(F," --modify-window=NUM compare mod times with reduced accuracy\n");
287 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
288 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
289 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
290 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
291 rprintf(F," -P equivalent to --partial --progress\n");
292 rprintf(F," -z, --compress compress file data\n");
293 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
294 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
295 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
296 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
297 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
298 rprintf(F," --files-from=FILE read FILE for list of source-file names\n");
299 rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
300 rprintf(F," --version print version number\n");
301 rprintf(F," --port=PORT specify double-colon alternate port number\n");
302 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
303 rprintf(F," --no-blocking-io turn off --blocking-io\n");
304 rprintf(F," --stats give some file transfer stats\n");
305 rprintf(F," --progress show progress during transfer\n");
306 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
307 rprintf(F," --password-file=FILE get password from FILE\n");
308 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
309 rprintf(F," --write-batch=FILE write a batch to FILE\n");
310 rprintf(F," --read-batch=FILE read a batch from FILE\n");
312 rprintf(F," -4, --ipv4 prefer IPv4\n");
313 rprintf(F," -6, --ipv6 prefer IPv6\n");
315 rprintf(F," -h, --help show this help screen\n");
317 rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
318 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
319 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
322 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
323 OPT_DELETE_AFTER, OPT_DELETE_EXCLUDED,
324 OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
325 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
326 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
327 OPT_REFUSED_BASE = 9000};
329 static struct poptOption long_options[] = {
330 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
331 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
332 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
333 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
334 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
335 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
336 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
337 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
338 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
339 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
340 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
341 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
342 {"delete-after", 0, POPT_ARG_NONE, 0, OPT_DELETE_AFTER, 0, 0 },
343 {"delete-excluded", 0, POPT_ARG_NONE, 0, OPT_DELETE_EXCLUDED, 0, 0 },
344 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
345 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
346 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
347 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
348 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
349 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
350 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
351 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
352 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
353 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
354 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
355 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
356 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
357 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
358 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
359 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
360 {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 },
361 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
362 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
363 {"copy-unsafe-links", 0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 },
364 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
365 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
366 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
367 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
368 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
369 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
370 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
371 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
372 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
373 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
374 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
375 {"recursive", 'r', POPT_ARG_NONE, &recurse, 0, 0, 0 },
376 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
377 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
378 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
379 {"block-size", 'B', POPT_ARG_INT, &block_size, 0, 0, 0 },
380 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
381 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
382 {"timeout", 0, POPT_ARG_INT, &io_timeout, OPT_TIMEOUT, 0, 0 },
383 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
384 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
385 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
386 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
387 /* TODO: Should this take an optional int giving the compression level? */
388 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
389 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
390 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
391 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
392 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
393 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
394 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
395 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
396 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
397 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
398 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
399 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
400 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
401 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
402 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
403 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
404 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
405 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
406 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
407 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
408 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
410 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
411 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
413 /* All these options switch us into daemon-mode option-parsing. */
414 {"address", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
415 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
416 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
417 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
421 static void daemon_usage(enum logcode F)
423 print_rsync_version(F);
425 rprintf(F,"\nUsage: rsync --daemon [OPTION]...\n");
426 rprintf(F," --address=ADDRESS bind to the specified address\n");
427 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
428 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
429 rprintf(F," --no-detach do not detach from the parent\n");
430 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
432 rprintf(F," -4, --ipv4 prefer IPv4\n");
433 rprintf(F," -6, --ipv6 prefer IPv6\n");
435 rprintf(F," -h, --help show this help screen\n");
437 rprintf(F,"\nIf you were not trying to invoke rsync as a daemon, avoid using any of the\n");
438 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
441 static struct poptOption long_daemon_options[] = {
442 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
443 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
444 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
445 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
446 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
448 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
449 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
451 {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 },
452 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
453 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
454 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
455 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
460 static char err_buf[200];
464 * Store the option error message, if any, so that we can log the
465 * connection attempt (which requires parsing the options), and then
466 * show the error later on.
468 void option_error(void)
471 strcpy(err_buf, "Error parsing options: "
472 "option may be supported on client but not on server?\n");
475 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
480 * Tweak the option table to disable all options that the rsyncd.conf
481 * file has told us to refuse.
483 static void set_refuse_options(char *bp)
485 struct poptOption *op;
486 char *cp, shortname[2];
487 int is_wild, found_match;
492 while (*bp == ' ') bp++;
495 if ((cp = strchr(bp, ' ')) != NULL)
497 /* If they specify "delete", reject all delete options. */
498 if (strcmp(bp, "delete") == 0)
500 is_wild = strpbrk(bp, "*?[") != NULL;
502 for (op = long_options; ; op++) {
503 *shortname = op->shortName;
504 if (!op->longName && !*shortname)
506 if ((op->longName && wildmatch(bp, op->longName))
507 || (*shortname && wildmatch(bp, shortname))) {
508 op->val = (op - long_options) + OPT_REFUSED_BASE;
515 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
526 static int count_args(const char **argv)
531 while (argv[i] != NULL)
540 * Process command line arguments. Called on both local and remote.
542 * @retval 1 if all options are OK; with globals set to appropriate
545 * @retval 0 on error, with err_buf containing an explanation
547 int parse_arguments(int *argc, const char ***argv, int frommain)
550 char *ref = lp_refuse_options(module_id);
555 set_refuse_options(ref);
557 /* TODO: Call poptReadDefaultConfig; handle errors. */
559 /* The context leaks in case of an error, but if there's a
560 * problem we always exit anyhow. */
561 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
562 poptReadDefaultConfig(pc, 0);
564 while ((opt = poptGetNextOpt(pc)) != -1) {
565 /* most options are handled automatically by popt;
566 * only special cases are returned and listed here. */
570 print_rsync_version(FINFO);
575 strcpy(err_buf, "Attempt to hack rsync thwarted!\n");
579 pc = poptGetContext(RSYNC_NAME, *argc, *argv,
580 long_daemon_options, 0);
581 while ((opt = poptGetNextOpt(pc)) != -1) {
589 "rsync: %s: %s (in daemon mode)\n",
590 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
596 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
599 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
600 exit_cleanup(RERR_SYNTAX);
602 *argv = poptGetArgs(pc);
603 *argc = count_args(*argv);
608 case OPT_MODIFY_WINDOW:
609 /* The value has already been set by popt, but
610 * we need to remember that we're using a
611 * non-default setting. */
612 modify_window_set = 1;
615 case OPT_DELETE_AFTER:
620 case OPT_DELETE_EXCLUDED:
626 add_exclude(&exclude_list, poptGetOptArg(pc), 0);
630 add_exclude(&exclude_list, poptGetOptArg(pc),
634 case OPT_EXCLUDE_FROM:
635 case OPT_INCLUDE_FROM:
636 arg = poptGetOptArg(pc);
638 arg = sanitize_path(NULL, arg, NULL, 0);
639 if (server_exclude_list.head) {
640 char *cp = (char *)arg;
642 if (check_exclude(&server_exclude_list, cp, 0) < 0)
643 goto options_rejected;
645 add_exclude_file(&exclude_list, arg, XFLG_FATAL_ERRORS
646 | (opt == OPT_INCLUDE_FROM
647 ? XFLG_DEF_INCLUDE : 0));
666 exit_cleanup(RERR_SYNTAX);
676 case OPT_WRITE_BATCH:
677 /* batch_name is already set */
682 /* batch_name is already set */
687 for (arg = max_size_arg; isdigit(*arg); arg++) {}
689 for (arg++; isdigit(*arg); arg++) {}
692 max_size = atof(max_size_arg) * 1024;
695 max_size = atof(max_size_arg) * 1024*1024;
698 max_size = atof(max_size_arg) * 1024*1024*1024;
701 max_size = atof(max_size_arg);
708 snprintf(err_buf, sizeof err_buf,
709 "--max-size value is invalid: %s\n",
716 if (io_timeout && io_timeout < select_timeout)
717 select_timeout = io_timeout;
723 dest_option = "--link-dest";
726 snprintf(err_buf, sizeof err_buf,
727 "hard links are not supported on this %s\n",
728 am_server ? "server" : "client");
734 dest_option = "--copy-dest";
737 case OPT_COMPARE_DEST:
739 dest_option = "--compare-dest";
741 if (basis_dir_cnt >= MAX_BASIS_DIRS-1) {
742 snprintf(err_buf, sizeof err_buf,
743 "ERROR: at most %d %s args may be specified\n",
744 MAX_BASIS_DIRS, dest_option);
747 arg = poptGetOptArg(pc);
749 arg = sanitize_path(NULL, arg, NULL, 0);
750 basis_dir[basis_dir_cnt++] = (char *)arg;
754 /* A large opt value means that set_refuse_options()
755 * turned this option off (opt-BASE is its index). */
756 if (opt >= OPT_REFUSED_BASE) {
757 struct poptOption *op =
758 &long_options[opt-OPT_REFUSED_BASE];
759 int n = snprintf(err_buf, sizeof err_buf,
760 "The server is configured to refuse --%s\n",
763 snprintf(err_buf+n, sizeof err_buf-n,
764 " (-%c)\n", op->shortName);
767 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
768 am_server ? "on remote machine: " : "",
769 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
777 if (preserve_links && !am_sender) {
778 snprintf(err_buf, sizeof err_buf,
779 "symlinks are not supported on this %s\n",
780 am_server ? "server" : "client");
785 #if !SUPPORT_HARD_LINKS
786 if (preserve_hard_links) {
787 snprintf(err_buf, sizeof err_buf,
788 "hard links are not supported on this %s\n",
789 am_server ? "server" : "client");
794 if (write_batch && read_batch) {
795 snprintf(err_buf, sizeof err_buf,
796 "--write-batch and --read-batch can not be used together\n");
799 if (write_batch || read_batch) {
801 snprintf(err_buf, sizeof err_buf,
802 "--%s-batch cannot be used with --dry_run (-n)\n",
803 write_batch ? "write" : "read");
808 "ignoring --%s-batch option sent to server\n",
809 write_batch ? "write" : "read");
810 /* We don't actually exit_cleanup(), so that we can
811 * still service older version clients that still send
812 * batch args to server. */
813 read_batch = write_batch = 0;
817 if (read_batch && files_from) {
818 snprintf(err_buf, sizeof err_buf,
819 "--read-batch cannot be used with --files-from\n");
822 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
823 snprintf(err_buf, sizeof err_buf,
824 "the batch-file name must be %d characters or less.\n",
829 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
830 snprintf(err_buf, sizeof err_buf,
831 "the --temp-dir path is WAY too long.\n");
835 if (compare_dest + copy_dest + link_dest > 1) {
836 snprintf(err_buf, sizeof err_buf,
837 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
851 preserve_devices = 1;
854 if (relative_paths < 0)
855 relative_paths = files_from? 1 : 0;
857 *argv = poptGetArgs(pc);
858 *argc = count_args(*argv);
860 if (sanitize_paths) {
862 for (i = *argc; i-- > 0; )
863 (*argv)[i] = sanitize_path(NULL, (*argv)[i], "", 0);
865 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
867 partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
869 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
871 files_from = sanitize_path(NULL, files_from, NULL, 0);
873 if (server_exclude_list.head && !am_sender) {
874 struct exclude_list_struct *elp = &server_exclude_list;
877 clean_fname(tmpdir, 1);
878 if (check_exclude(elp, tmpdir, 1) < 0)
879 goto options_rejected;
882 clean_fname(partial_dir, 1);
883 if (check_exclude(elp, partial_dir, 1) < 0)
884 goto options_rejected;
886 for (i = 0; i < basis_dir_cnt; i++) {
887 clean_fname(basis_dir[i], 1);
888 if (check_exclude(elp, basis_dir[i], 1) < 0)
889 goto options_rejected;
892 clean_fname(backup_dir, 1);
893 if (check_exclude(elp, backup_dir, 1) < 0)
894 goto options_rejected;
897 if (server_exclude_list.head && files_from) {
898 clean_fname(files_from, 1);
899 if (check_exclude(&server_exclude_list, files_from, 0) < 0) {
901 snprintf(err_buf, sizeof err_buf,
902 "Your options have been rejected by the server.\n");
908 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
909 backup_suffix_len = strlen(backup_suffix);
910 if (strchr(backup_suffix, '/') != NULL) {
911 snprintf(err_buf, sizeof err_buf,
912 "--suffix cannot contain slashes: %s\n",
917 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
918 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
919 if (backup_dir_remainder < 32) {
920 snprintf(err_buf, sizeof err_buf,
921 "the --backup-dir path is WAY too long.\n");
924 if (backup_dir_buf[backup_dir_len - 1] != '/') {
925 backup_dir_buf[backup_dir_len++] = '/';
926 backup_dir_buf[backup_dir_len] = '\0';
928 if (verbose > 1 && !am_sender)
929 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
930 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
931 snprintf(err_buf, sizeof err_buf,
932 "--suffix cannot be a null string without --backup-dir\n");
936 if (do_progress && !verbose)
939 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
940 bwlimit = daemon_bwlimit;
942 bwlimit_writemax = (size_t)bwlimit * 128;
943 if (bwlimit_writemax < 512)
944 bwlimit_writemax = 512;
950 snprintf(err_buf, sizeof err_buf,
951 "--inplace cannot be used with --partial-dir\n");
956 snprintf(err_buf, sizeof err_buf,
957 "--inplace is not supported on this %s\n",
958 am_server ? "server" : "client");
961 if (compare_dest || copy_dest || link_dest) {
962 snprintf(err_buf, sizeof err_buf,
963 "--inplace does not yet work with %s\n",
968 if (keep_partial && !partial_dir)
969 partial_dir = getenv("RSYNC_PARTIAL_DIR");
971 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
973 else if (*partial_dir != '/') {
974 add_exclude(&exclude_list, partial_dir,
983 if (*argc > 2 || (!am_daemon && *argc == 1)) {
985 exit_cleanup(RERR_SYNTAX);
987 if (strcmp(files_from, "-") == 0) {
990 remote_filesfrom_file = "-";
992 else if ((colon = find_colon(files_from)) != 0) {
995 exit_cleanup(RERR_SYNTAX);
997 remote_filesfrom_file = colon+1 + (colon[1] == ':');
998 if (strcmp(remote_filesfrom_file, "-") == 0) {
999 snprintf(err_buf, sizeof err_buf,
1000 "Invalid --files-from remote filename\n");
1004 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1005 if (filesfrom_fd < 0) {
1006 snprintf(err_buf, sizeof err_buf,
1007 "failed to open files-from file %s: %s\n",
1008 files_from, strerror(errno));
1019 * Construct a filtered list of options to pass through from the
1020 * client to the server.
1022 * This involves setting options that will tell the server how to
1023 * behave, and also filtering out options that are processed only
1026 void server_options(char **args,int *argc)
1028 static char argstr[50+MAX_BASIS_DIRS*2];
1034 if (blocking_io == -1)
1037 args[ac++] = "--server";
1039 if (daemon_over_rsh) {
1040 args[ac++] = "--daemon";
1042 /* if we're passing --daemon, we're done */
1047 args[ac++] = "--sender";
1051 for (i = 0; i < verbose; i++)
1054 /* the -q option is intentionally left out */
1065 if (keep_dirlinks && am_sender)
1070 /* We don't need to send --no-whole-file, because it's the
1071 * default for remote transfers, and in any case old versions
1072 * of rsync will not understand it. */
1074 if (preserve_hard_links)
1080 if (preserve_devices)
1088 if (always_checksum)
1096 if (one_file_system)
1103 /* this is a complete hack - blame Rusty
1105 this is a hack to make the list_only (remote file list)
1107 if (list_only && !recurse)
1113 args[ac++] = argstr;
1116 if (asprintf(&arg, "-B%u", block_size) < 0)
1121 if (max_delete && am_sender) {
1122 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1127 if (max_size && am_sender) {
1128 args[ac++] = "--max-size";
1129 args[ac++] = max_size_arg;
1133 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1139 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1145 args[ac++] = "--backup-dir";
1146 args[ac++] = backup_dir;
1149 /* Only send --suffix if it specifies a non-default value. */
1150 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
1151 /* We use the following syntax to avoid weirdness with '~'. */
1152 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1158 if (delete_excluded)
1159 args[ac++] = "--delete-excluded";
1160 else if (delete_mode)
1161 args[ac++] = "--delete";
1164 args[ac++] = "--delete-after";
1167 args[ac++] = "--force";
1171 args[ac++] = "--size-only";
1173 if (modify_window_set) {
1174 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1179 if (checksum_seed) {
1180 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
1185 if (partial_dir && am_sender) {
1186 args[ac++] = "--partial-dir";
1187 args[ac++] = partial_dir;
1188 } else if (keep_partial)
1189 args[ac++] = "--partial";
1192 args[ac++] = "--ignore-errors";
1194 if (copy_unsafe_links)
1195 args[ac++] = "--copy-unsafe-links";
1198 args[ac++] = "--safe-links";
1201 args[ac++] = "--numeric-ids";
1203 if (only_existing && am_sender)
1204 args[ac++] = "--existing";
1206 if (opt_ignore_existing && am_sender)
1207 args[ac++] = "--ignore-existing";
1210 args[ac++] = "--inplace";
1213 args[ac++] = "--temp-dir";
1214 args[ac++] = tmpdir;
1217 if (basis_dir[0] && am_sender) {
1218 /* the server only needs this option if it is not the sender,
1219 * and it may be an older version that doesn't know this
1220 * option, so don't send it if client is the sender.
1223 for (i = 0; i < basis_dir_cnt; i++) {
1224 args[ac++] = dest_option;
1225 args[ac++] = basis_dir[i];
1229 if (files_from && (!am_sender || remote_filesfrom_file)) {
1230 if (remote_filesfrom_file) {
1231 args[ac++] = "--files-from";
1232 args[ac++] = remote_filesfrom_file;
1234 args[ac++] = "--from0";
1236 args[ac++] = "--files-from=-";
1237 args[ac++] = "--from0";
1245 out_of_memory("server_options");
1249 * Return the position of a ':' IF it is not part of a filename (i.e. as
1250 * long as it doesn't occur after a slash.
1252 char *find_colon(char *s)
1260 /* now check to see if there is a / in the string before the : - if there is then
1261 discard the colon on the assumption that the : is part of a filename */