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",
214 #ifdef INT64_IS_OFF_T
215 if (sizeof (int64) < 8)
216 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
221 "rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
222 "are welcome to redistribute it under certain conditions. See the GNU\n"
223 "General Public Licence for details.\n"
228 void usage(enum logcode F)
230 print_rsync_version(F);
232 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
234 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
235 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
236 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
237 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
238 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
239 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
240 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
241 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
242 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
243 rprintf(F," sources separated by space as long as they have same top-level\n");
244 rprintf(F,"\nOptions\n");
245 rprintf(F," -v, --verbose increase verbosity\n");
246 rprintf(F," -q, --quiet decrease verbosity\n");
247 rprintf(F," -c, --checksum always checksum\n");
248 rprintf(F," -a, --archive archive mode, equivalent to -rlptgoD (no -H)\n");
249 rprintf(F," -r, --recursive recurse into directories\n");
250 rprintf(F," -R, --relative use relative path names\n");
251 rprintf(F," --no-relative turn off --relative\n");
252 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
253 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
254 rprintf(F," --backup-dir make backups into this directory\n");
255 rprintf(F," --suffix=SUFFIX backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
256 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
257 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
258 rprintf(F," -d, --dirs transfer directories without recursing\n");
259 rprintf(F," -l, --links copy symlinks as symlinks\n");
260 rprintf(F," -L, --copy-links copy the referent of all symlinks\n");
261 rprintf(F," --copy-unsafe-links copy the referent of \"unsafe\" symlinks\n");
262 rprintf(F," --safe-links ignore \"unsafe\" symlinks\n");
263 rprintf(F," -H, --hard-links preserve hard links\n");
264 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
265 rprintf(F," -p, --perms preserve permissions\n");
266 rprintf(F," -o, --owner preserve owner (root only)\n");
267 rprintf(F," -g, --group preserve group\n");
268 rprintf(F," -D, --devices preserve devices (root only)\n");
269 rprintf(F," -t, --times preserve times\n");
270 rprintf(F," -O, --omit-dir-times omit directories when preserving times\n");
271 rprintf(F," -S, --sparse handle sparse files efficiently\n");
272 rprintf(F," -n, --dry-run show what would have been transferred\n");
273 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
274 rprintf(F," --no-whole-file turn off --whole-file\n");
275 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
276 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
277 rprintf(F," -e, --rsh=COMMAND specify the remote shell\n");
278 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
279 rprintf(F," --existing only update files that already exist\n");
280 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
281 rprintf(F," --del an alias for --delete-during\n");
282 rprintf(F," --delete delete files that don't exist on the sending side\n");
283 rprintf(F," --delete-during receiver deletes during transfer, not before\n");
284 rprintf(F," --delete-after receiver deletes after transfer, not before\n");
285 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
286 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
287 rprintf(F," --force force deletion of directories even if not empty\n");
288 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
289 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
290 rprintf(F," --partial keep partially transferred files\n");
291 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
292 rprintf(F," --delay-updates update all transferred files into place at end\n");
293 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
294 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
295 rprintf(F," -I, --ignore-times turn off mod time & file size quick check\n");
296 rprintf(F," --size-only ignore mod time for quick check (use size)\n");
297 rprintf(F," --modify-window=NUM compare mod times with reduced accuracy\n");
298 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
299 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
300 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
301 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
302 rprintf(F," -P equivalent to --partial --progress\n");
303 rprintf(F," -z, --compress compress file data\n");
304 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
305 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
306 rprintf(F," -F same as --filter=': /.rsync-filter'\n");
307 rprintf(F," repeated: --filter='- .rsync-filter'\n");
308 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
309 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
310 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
311 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
312 rprintf(F," --files-from=FILE read FILE for list of source-file names\n");
313 rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
314 rprintf(F," --version print version number\n");
315 rprintf(F," --port=PORT specify double-colon alternate port number\n");
316 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
317 rprintf(F," --no-blocking-io turn off --blocking-io\n");
318 rprintf(F," --stats give some file transfer stats\n");
319 rprintf(F," --progress show progress during transfer\n");
320 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
321 rprintf(F," --password-file=FILE get password from FILE\n");
322 rprintf(F," --list-only list the files instead of copying them\n");
323 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
324 rprintf(F," --write-batch=FILE write a batch to FILE\n");
325 rprintf(F," --read-batch=FILE read a batch from FILE\n");
327 rprintf(F," -4, --ipv4 prefer IPv4\n");
328 rprintf(F," -6, --ipv6 prefer IPv6\n");
330 rprintf(F," -h, --help show this help screen\n");
332 rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
333 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
334 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
337 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
338 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
339 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
340 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
341 OPT_REFUSED_BASE = 9000};
343 static struct poptOption long_options[] = {
344 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
345 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
346 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
347 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
348 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
349 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
350 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
351 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
352 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
353 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
354 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
355 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
356 {"delete-during", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
357 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
358 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
359 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
360 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
361 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
362 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
363 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
364 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
365 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
366 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
367 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
368 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
369 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
370 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
371 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
372 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
373 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
374 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
375 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
376 {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 },
377 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
378 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
379 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
380 {"copy-unsafe-links", 0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 },
381 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
382 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
383 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
384 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
385 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
386 {"omit-dir-times", 'O', POPT_ARG_NONE, &omit_dir_times, 0, 0, 0 },
387 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
388 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
389 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
390 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
391 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
392 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
393 {"recursive", 'r', POPT_ARG_VAL, &recurse, -1, 0, 0 },
394 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
395 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
396 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
397 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
398 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
399 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
400 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
401 {"timeout", 0, POPT_ARG_INT, &io_timeout, OPT_TIMEOUT, 0, 0 },
402 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
403 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
404 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
405 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
406 /* TODO: Should this take an optional int giving the compression level? */
407 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
408 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
409 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
410 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
411 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
412 {"delay-updates", 0, POPT_ARG_NONE, &delay_updates, 0, 0, 0 },
413 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
414 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
415 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
416 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
417 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
418 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
419 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
420 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
421 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
422 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
423 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
424 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
425 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
426 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
427 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
428 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
429 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
431 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
432 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
434 /* All these options switch us into daemon-mode option-parsing. */
435 {"address", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
436 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
437 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
438 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
442 static void daemon_usage(enum logcode F)
444 print_rsync_version(F);
446 rprintf(F,"\nUsage: rsync --daemon [OPTION]...\n");
447 rprintf(F," --address=ADDRESS bind to the specified address\n");
448 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
449 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
450 rprintf(F," --no-detach do not detach from the parent\n");
451 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
453 rprintf(F," -4, --ipv4 prefer IPv4\n");
454 rprintf(F," -6, --ipv6 prefer IPv6\n");
456 rprintf(F," -h, --help show this help screen\n");
458 rprintf(F,"\nIf you were not trying to invoke rsync as a daemon, avoid using any of the\n");
459 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
462 static struct poptOption long_daemon_options[] = {
463 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
464 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
465 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
466 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
467 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
469 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
470 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
472 {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 },
473 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
474 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
475 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
476 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
481 static char err_buf[200];
485 * Store the option error message, if any, so that we can log the
486 * connection attempt (which requires parsing the options), and then
487 * show the error later on.
489 void option_error(void)
492 strcpy(err_buf, "Error parsing options: "
493 "option may be supported on client but not on server?\n");
496 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
501 * Tweak the option table to disable all options that the rsyncd.conf
502 * file has told us to refuse.
504 static void set_refuse_options(char *bp)
506 struct poptOption *op;
507 char *cp, shortname[2];
508 int is_wild, found_match;
513 while (*bp == ' ') bp++;
516 if ((cp = strchr(bp, ' ')) != NULL)
518 /* If they specify "delete", reject all delete options. */
519 if (strcmp(bp, "delete") == 0)
521 is_wild = strpbrk(bp, "*?[") != NULL;
523 for (op = long_options; ; op++) {
524 *shortname = op->shortName;
525 if (!op->longName && !*shortname)
527 if ((op->longName && wildmatch(bp, op->longName))
528 || (*shortname && wildmatch(bp, shortname))) {
529 if (op->argInfo == POPT_ARG_VAL)
530 op->argInfo = POPT_ARG_NONE;
531 op->val = (op - long_options) + OPT_REFUSED_BASE;
538 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
549 static int count_args(const char **argv)
554 while (argv[i] != NULL)
563 * Process command line arguments. Called on both local and remote.
565 * @retval 1 if all options are OK; with globals set to appropriate
568 * @retval 0 on error, with err_buf containing an explanation
570 int parse_arguments(int *argc, const char ***argv, int frommain)
573 char *ref = lp_refuse_options(module_id);
578 set_refuse_options(ref);
580 /* TODO: Call poptReadDefaultConfig; handle errors. */
582 /* The context leaks in case of an error, but if there's a
583 * problem we always exit anyhow. */
584 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
586 struct poptAlias my_alias;
587 char **argv = new_array(char *, 1);
588 argv[0] = strdup("--delete-during");
589 my_alias.longName = "del", my_alias.shortName = '\0';
591 my_alias.argv = (const char **)argv;
593 poptAddAlias(pc, my_alias, 0);
595 poptReadDefaultConfig(pc, 0);
597 while ((opt = poptGetNextOpt(pc)) != -1) {
598 /* most options are handled automatically by popt;
599 * only special cases are returned and listed here. */
603 print_rsync_version(FINFO);
608 strcpy(err_buf, "Attempt to hack rsync thwarted!\n");
612 pc = poptGetContext(RSYNC_NAME, *argc, *argv,
613 long_daemon_options, 0);
614 while ((opt = poptGetNextOpt(pc)) != -1) {
622 "rsync: %s: %s (in daemon mode)\n",
623 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
629 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
632 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
633 exit_cleanup(RERR_SYNTAX);
635 *argv = poptGetArgs(pc);
636 *argc = count_args(*argv);
641 case OPT_MODIFY_WINDOW:
642 /* The value has already been set by popt, but
643 * we need to remember that we're using a
644 * non-default setting. */
645 modify_window_set = 1;
649 add_filter(&filter_list, poptGetOptArg(pc), 0);
653 add_filter(&filter_list, poptGetOptArg(pc),
658 add_filter(&filter_list, poptGetOptArg(pc),
662 case OPT_EXCLUDE_FROM:
663 case OPT_INCLUDE_FROM:
664 arg = poptGetOptArg(pc);
666 arg = sanitize_path(NULL, arg, NULL, 0);
667 if (server_filter_list.head) {
668 char *cp = (char *)arg;
670 if (check_filter(&server_filter_list, cp, 0) < 0)
671 goto options_rejected;
673 add_filter_file(&filter_list, arg, XFLG_FATAL_ERRORS
674 | (opt == OPT_INCLUDE_FROM ? XFLG_DEF_INCLUDE
675 : XFLG_DEF_EXCLUDE));
694 exit_cleanup(RERR_SYNTAX);
700 switch (++F_option_cnt) {
702 add_filter(&filter_list,
703 ": /.rsync-filter", 0);
706 add_filter(&filter_list,
707 "- .rsync-filter", 0);
717 case OPT_WRITE_BATCH:
718 /* batch_name is already set */
723 /* batch_name is already set */
728 for (arg = max_size_arg; isdigit(*arg); arg++) {}
730 for (arg++; isdigit(*arg); arg++) {}
733 max_size = atof(max_size_arg) * 1024;
736 max_size = atof(max_size_arg) * 1024*1024;
739 max_size = atof(max_size_arg) * 1024*1024*1024;
742 max_size = atof(max_size_arg);
749 snprintf(err_buf, sizeof err_buf,
750 "--max-size value is invalid: %s\n",
757 if (io_timeout && io_timeout < select_timeout)
758 select_timeout = io_timeout;
764 dest_option = "--link-dest";
767 snprintf(err_buf, sizeof err_buf,
768 "hard links are not supported on this %s\n",
769 am_server ? "server" : "client");
775 dest_option = "--copy-dest";
778 case OPT_COMPARE_DEST:
780 dest_option = "--compare-dest";
782 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
783 snprintf(err_buf, sizeof err_buf,
784 "ERROR: at most %d %s args may be specified\n",
785 MAX_BASIS_DIRS, dest_option);
788 arg = poptGetOptArg(pc);
790 arg = sanitize_path(NULL, arg, NULL, 0);
791 basis_dir[basis_dir_cnt++] = (char *)arg;
795 /* A large opt value means that set_refuse_options()
796 * turned this option off (opt-BASE is its index). */
797 if (opt >= OPT_REFUSED_BASE) {
798 struct poptOption *op =
799 &long_options[opt-OPT_REFUSED_BASE];
800 int n = snprintf(err_buf, sizeof err_buf,
801 "The server is configured to refuse --%s\n",
804 snprintf(err_buf+n, sizeof err_buf-n,
805 " (-%c)\n", op->shortName);
808 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
809 am_server ? "on remote machine: " : "",
810 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
818 if (preserve_links && !am_sender) {
819 snprintf(err_buf, sizeof err_buf,
820 "symlinks are not supported on this %s\n",
821 am_server ? "server" : "client");
826 #if !SUPPORT_HARD_LINKS
827 if (preserve_hard_links) {
828 snprintf(err_buf, sizeof err_buf,
829 "hard links are not supported on this %s\n",
830 am_server ? "server" : "client");
835 if (write_batch && read_batch) {
836 snprintf(err_buf, sizeof err_buf,
837 "--write-batch and --read-batch can not be used together\n");
840 if (write_batch || read_batch) {
842 snprintf(err_buf, sizeof err_buf,
843 "--%s-batch cannot be used with --dry_run (-n)\n",
844 write_batch ? "write" : "read");
849 "ignoring --%s-batch option sent to server\n",
850 write_batch ? "write" : "read");
851 /* We don't actually exit_cleanup(), so that we can
852 * still service older version clients that still send
853 * batch args to server. */
854 read_batch = write_batch = 0;
858 if (read_batch && files_from) {
859 snprintf(err_buf, sizeof err_buf,
860 "--read-batch cannot be used with --files-from\n");
863 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
864 snprintf(err_buf, sizeof err_buf,
865 "the batch-file name must be %d characters or less.\n",
870 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
871 snprintf(err_buf, sizeof err_buf,
872 "the --temp-dir path is WAY too long.\n");
876 if (compare_dest + copy_dest + link_dest > 1) {
877 snprintf(err_buf, sizeof err_buf,
878 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
884 recurse = -1; /* infinite recursion */
892 preserve_devices = 1;
895 if (recurse || list_only || files_from)
898 if (relative_paths < 0)
899 relative_paths = files_from? 1 : 0;
901 if (delete_during && delete_after) {
902 snprintf(err_buf, sizeof err_buf,
903 "You may not combine --delete-during (--del) and --delete-after.\n");
906 if (delete_during || delete_after)
908 else if (delete_mode || delete_excluded)
909 delete_mode = delete_before = 1;
911 *argv = poptGetArgs(pc);
912 *argc = count_args(*argv);
914 if (sanitize_paths) {
916 for (i = *argc; i-- > 0; )
917 (*argv)[i] = sanitize_path(NULL, (*argv)[i], "", 0);
919 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
921 partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
923 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
925 files_from = sanitize_path(NULL, files_from, NULL, 0);
927 if (server_filter_list.head && !am_sender) {
928 struct filter_list_struct *elp = &server_filter_list;
931 clean_fname(tmpdir, 1);
932 if (check_filter(elp, tmpdir, 1) < 0)
933 goto options_rejected;
936 clean_fname(partial_dir, 1);
937 if (check_filter(elp, partial_dir, 1) < 0)
938 goto options_rejected;
940 for (i = 0; i < basis_dir_cnt; i++) {
941 clean_fname(basis_dir[i], 1);
942 if (check_filter(elp, basis_dir[i], 1) < 0)
943 goto options_rejected;
946 clean_fname(backup_dir, 1);
947 if (check_filter(elp, backup_dir, 1) < 0)
948 goto options_rejected;
951 if (server_filter_list.head && files_from) {
952 clean_fname(files_from, 1);
953 if (check_filter(&server_filter_list, files_from, 0) < 0) {
955 snprintf(err_buf, sizeof err_buf,
956 "Your options have been rejected by the server.\n");
962 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
963 backup_suffix_len = strlen(backup_suffix);
964 if (strchr(backup_suffix, '/') != NULL) {
965 snprintf(err_buf, sizeof err_buf,
966 "--suffix cannot contain slashes: %s\n",
971 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
972 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
973 if (backup_dir_remainder < 32) {
974 snprintf(err_buf, sizeof err_buf,
975 "the --backup-dir path is WAY too long.\n");
978 if (backup_dir_buf[backup_dir_len - 1] != '/') {
979 backup_dir_buf[backup_dir_len++] = '/';
980 backup_dir_buf[backup_dir_len] = '\0';
982 if (verbose > 1 && !am_sender)
983 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
984 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
985 snprintf(err_buf, sizeof err_buf,
986 "--suffix cannot be a null string without --backup-dir\n");
990 if (do_progress && !verbose)
993 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
994 bwlimit = daemon_bwlimit;
996 bwlimit_writemax = (size_t)bwlimit * 128;
997 if (bwlimit_writemax < 512)
998 bwlimit_writemax = 512;
1001 if (delay_updates && !partial_dir)
1002 partial_dir = ".~tmp~";
1007 snprintf(err_buf, sizeof err_buf,
1008 "--inplace cannot be used with --%s\n",
1009 delay_updates ? "delay-updates" : "partial-dir");
1014 snprintf(err_buf, sizeof err_buf,
1015 "--inplace is not supported on this %s\n",
1016 am_server ? "server" : "client");
1020 if (keep_partial && !partial_dir)
1021 partial_dir = getenv("RSYNC_PARTIAL_DIR");
1023 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1025 else if (*partial_dir != '/') {
1026 add_filter(&filter_list, partial_dir,
1027 XFLG_DIRECTORY | XFLG_DEF_EXCLUDE);
1035 if (*argc > 2 || (!am_daemon && *argc == 1)) {
1037 exit_cleanup(RERR_SYNTAX);
1039 if (strcmp(files_from, "-") == 0) {
1042 remote_filesfrom_file = "-";
1044 else if ((colon = find_colon(files_from)) != 0) {
1047 exit_cleanup(RERR_SYNTAX);
1049 remote_filesfrom_file = colon+1 + (colon[1] == ':');
1050 if (strcmp(remote_filesfrom_file, "-") == 0) {
1051 snprintf(err_buf, sizeof err_buf,
1052 "Invalid --files-from remote filename\n");
1056 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1057 if (filesfrom_fd < 0) {
1058 snprintf(err_buf, sizeof err_buf,
1059 "failed to open files-from file %s: %s\n",
1060 files_from, strerror(errno));
1071 * Construct a filtered list of options to pass through from the
1072 * client to the server.
1074 * This involves setting options that will tell the server how to
1075 * behave, and also filtering out options that are processed only
1078 void server_options(char **args,int *argc)
1080 static char argstr[50+MAX_BASIS_DIRS*2];
1086 if (blocking_io == -1)
1089 args[ac++] = "--server";
1091 if (daemon_over_rsh) {
1092 args[ac++] = "--daemon";
1094 /* if we're passing --daemon, we're done */
1099 args[ac++] = "--sender";
1103 for (i = 0; i < verbose; i++)
1106 /* the -q option is intentionally left out */
1119 if (keep_dirlinks && am_sender)
1124 /* We don't need to send --no-whole-file, because it's the
1125 * default for remote transfers, and in any case old versions
1126 * of rsync will not understand it. */
1128 if (preserve_hard_links)
1134 if (preserve_devices)
1138 if (omit_dir_times && am_sender)
1144 if (always_checksum)
1152 if (one_file_system)
1159 /* This is a complete hack - blame Rusty. FIXME!
1160 * This hack is only needed for older rsync versions that
1161 * don't understand the --list-only option. */
1162 if (list_only == 1 && recurse >= 0)
1168 args[ac++] = argstr;
1171 args[ac++] = "--list-only";
1174 if (asprintf(&arg, "-B%lu", block_size) < 0)
1179 if (max_delete && am_sender) {
1180 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1185 if (max_size && am_sender) {
1186 args[ac++] = "--max-size";
1187 args[ac++] = max_size_arg;
1191 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1197 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1203 args[ac++] = "--backup-dir";
1204 args[ac++] = backup_dir;
1207 /* Only send --suffix if it specifies a non-default value. */
1208 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
1209 /* We use the following syntax to avoid weirdness with '~'. */
1210 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1216 if (delete_excluded)
1217 args[ac++] = "--delete-excluded";
1218 else if (delete_before || delete_after)
1219 args[ac++] = "--delete";
1221 args[ac++] = "--delete-during";
1223 args[ac++] = "--delete-after";
1225 args[ac++] = "--force";
1229 args[ac++] = "--size-only";
1231 if (modify_window_set) {
1232 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1237 if (checksum_seed) {
1238 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
1243 if (partial_dir && am_sender) {
1244 args[ac++] = "--partial-dir";
1245 args[ac++] = partial_dir;
1247 args[ac++] = "--delay-updates";
1248 } else if (keep_partial)
1249 args[ac++] = "--partial";
1252 args[ac++] = "--ignore-errors";
1254 if (copy_unsafe_links)
1255 args[ac++] = "--copy-unsafe-links";
1258 args[ac++] = "--safe-links";
1261 args[ac++] = "--numeric-ids";
1263 if (only_existing && am_sender)
1264 args[ac++] = "--existing";
1266 if (opt_ignore_existing && am_sender)
1267 args[ac++] = "--ignore-existing";
1270 args[ac++] = "--inplace";
1273 args[ac++] = "--temp-dir";
1274 args[ac++] = tmpdir;
1277 if (basis_dir[0] && am_sender) {
1278 /* the server only needs this option if it is not the sender,
1279 * and it may be an older version that doesn't know this
1280 * option, so don't send it if client is the sender.
1283 for (i = 0; i < basis_dir_cnt; i++) {
1284 args[ac++] = dest_option;
1285 args[ac++] = basis_dir[i];
1289 if (files_from && (!am_sender || remote_filesfrom_file)) {
1290 if (remote_filesfrom_file) {
1291 args[ac++] = "--files-from";
1292 args[ac++] = remote_filesfrom_file;
1294 args[ac++] = "--from0";
1296 args[ac++] = "--files-from=-";
1297 args[ac++] = "--from0";
1299 if (!relative_paths)
1300 args[ac++] = "--no-relative";
1302 if (!implied_dirs && !am_sender)
1303 args[ac++] = "--no-implied-dirs";
1309 out_of_memory("server_options");
1313 * Return the position of a ':' IF it is not part of a filename (i.e. as
1314 * long as it doesn't occur after a slash.
1316 char *find_colon(char *s)
1324 /* now check to see if there is a / in the string before the : - if there is then
1325 discard the colon on the assumption that the : is part of a filename */