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;
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 long block_size = 0; /* "long" because popt can't set an int32. */
107 /** Network address family. **/
109 int default_af_hint = 0; /* Any protocol */
111 int default_af_hint = AF_INET; /* Must use IPv4 */
114 /** Do not go into the background when run as --daemon. Good
115 * for debugging and required for running as a service on W32,
116 * or under Unix process-monitors. **/
121 int backup_dir_len = 0;
122 int backup_suffix_len;
123 unsigned int backup_dir_remainder;
125 char *backup_suffix = NULL;
127 char *partial_dir = NULL;
128 char *basis_dir[MAX_BASIS_DIRS+1];
129 char *config_file = NULL;
130 char *shell_cmd = NULL;
131 char *log_format = NULL;
132 char *password_file = NULL;
133 char *rsync_path = RSYNC_PATH;
134 char *backup_dir = NULL;
135 char backup_dir_buf[MAXPATHLEN];
137 int compare_dest = 0;
140 int basis_dir_cnt = 0;
144 int always_checksum = 0;
147 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
148 char *batch_name = NULL;
150 static int daemon_opt; /* sets am_daemon after option error-reporting */
151 static int F_option_cnt = 0;
152 static int modify_window_set;
153 static char *dest_option = NULL;
154 static char *max_size_arg;
156 /** Local address to bind. As a character string because it's
157 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
158 * address, or a hostname. **/
162 static void print_rsync_version(enum logcode f)
164 char const *got_socketpair = "no ";
165 char const *have_inplace = "no ";
166 char const *hardlinks = "no ";
167 char const *links = "no ";
168 char const *ipv6 = "no ";
169 STRUCT_STAT *dumstat;
171 #ifdef HAVE_SOCKETPAIR
179 #if SUPPORT_HARD_LINKS
191 rprintf(f, "%s version %s protocol version %d\n",
192 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
194 "Copyright (C) 1996-2004 by Andrew Tridgell and others\n");
195 rprintf(f, "<http://rsync.samba.org/>\n");
196 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
197 "%shard links, %ssymlinks, batchfiles, \n",
198 (int) (sizeof (OFF_T) * 8),
199 got_socketpair, hardlinks, links);
201 /* Note that this field may not have type ino_t. It depends
202 * on the complicated interaction between largefile feature
204 rprintf(f, " %sinplace, %sIPv6, %d-bit system inums, %d-bit internal inums\n",
206 (int) (sizeof dumstat->st_ino * 8),
207 (int) (sizeof (int64) * 8));
208 #ifdef MAINTAINER_MODE
209 rprintf(f, " panic action: \"%s\"\n",
213 #ifdef INT64_IS_OFF_T
214 if (sizeof (int64) < 8)
215 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
220 "rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
221 "are welcome to redistribute it under certain conditions. See the GNU\n"
222 "General Public Licence for details.\n"
227 void usage(enum logcode F)
229 print_rsync_version(F);
231 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
233 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
234 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
235 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
236 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
237 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
238 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
239 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
240 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
241 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
242 rprintf(F," sources separated by space as long as they have same top-level\n");
243 rprintf(F,"\nOptions\n");
244 rprintf(F," -v, --verbose increase verbosity\n");
245 rprintf(F," -q, --quiet decrease verbosity\n");
246 rprintf(F," -c, --checksum always checksum\n");
247 rprintf(F," -a, --archive archive mode, equivalent to -rlptgoD (no -H)\n");
248 rprintf(F," -r, --recursive recurse into directories\n");
249 rprintf(F," -R, --relative use relative path names\n");
250 rprintf(F," --no-relative turn off --relative\n");
251 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
252 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
253 rprintf(F," --backup-dir make backups into this directory\n");
254 rprintf(F," --suffix=SUFFIX backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
255 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
256 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
257 rprintf(F," -d, --dirs transfer directories without recursing\n");
258 rprintf(F," -l, --links copy symlinks as symlinks\n");
259 rprintf(F," -L, --copy-links copy the referent of all symlinks\n");
260 rprintf(F," --copy-unsafe-links copy the referent of \"unsafe\" symlinks\n");
261 rprintf(F," --safe-links ignore \"unsafe\" symlinks\n");
262 rprintf(F," -H, --hard-links preserve hard links\n");
263 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
264 rprintf(F," -p, --perms preserve permissions\n");
265 rprintf(F," -o, --owner preserve owner (root only)\n");
266 rprintf(F," -g, --group preserve group\n");
267 rprintf(F," -D, --devices preserve devices (root only)\n");
268 rprintf(F," -t, --times preserve times\n");
269 rprintf(F," -O, --omit-dir-times omit directories when preserving times\n");
270 rprintf(F," -S, --sparse handle sparse files efficiently\n");
271 rprintf(F," -n, --dry-run show what would have been transferred\n");
272 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
273 rprintf(F," --no-whole-file turn off --whole-file\n");
274 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
275 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
276 rprintf(F," -e, --rsh=COMMAND specify the remote shell\n");
277 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
278 rprintf(F," --existing only update files that already exist\n");
279 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
280 rprintf(F," --delete delete files that don't exist on the sending side\n");
281 rprintf(F," --delete-before receiver deletes before transfer, not during\n");
282 rprintf(F," --delete-after receiver deletes after transfer, not during\n");
283 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
284 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
285 rprintf(F," --force force deletion of directories even if not empty\n");
286 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
287 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
288 rprintf(F," --partial keep partially transferred files\n");
289 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
290 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
291 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
292 rprintf(F," -I, --ignore-times turn off mod time & file size quick check\n");
293 rprintf(F," --size-only ignore mod time for quick check (use size)\n");
294 rprintf(F," --modify-window=NUM compare mod times with reduced accuracy\n");
295 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
296 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
297 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
298 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
299 rprintf(F," -P equivalent to --partial --progress\n");
300 rprintf(F," -z, --compress compress file data\n");
301 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
302 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
303 rprintf(F," -F same as --filter=': /.rsync-filter'\n");
304 rprintf(F," repeated: --filter='- .rsync-filter'\n");
305 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
306 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
307 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
308 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
309 rprintf(F," --files-from=FILE read FILE for list of source-file names\n");
310 rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
311 rprintf(F," --version print version number\n");
312 rprintf(F," --port=PORT specify double-colon alternate port number\n");
313 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
314 rprintf(F," --no-blocking-io turn off --blocking-io\n");
315 rprintf(F," --stats give some file transfer stats\n");
316 rprintf(F," --progress show progress during transfer\n");
317 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
318 rprintf(F," --password-file=FILE get password from FILE\n");
319 rprintf(F," --list-only list the files instead of copying them\n");
320 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
321 rprintf(F," --write-batch=FILE write a batch to FILE\n");
322 rprintf(F," --read-batch=FILE read a batch from FILE\n");
324 rprintf(F," -4, --ipv4 prefer IPv4\n");
325 rprintf(F," -6, --ipv6 prefer IPv6\n");
327 rprintf(F," -h, --help show this help screen\n");
329 rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
330 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
331 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
334 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
335 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
336 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
337 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
338 OPT_REFUSED_BASE = 9000};
340 static struct poptOption long_options[] = {
341 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
342 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
343 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
344 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
345 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
346 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
347 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
348 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
349 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
350 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
351 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
352 {"delete", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
353 {"delete-before", 0, POPT_ARG_NONE, &delete_before, 0, 0, 0 },
354 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
355 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
356 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
357 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
358 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
359 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
360 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
361 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
362 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
363 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
364 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
365 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
366 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
367 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
368 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
369 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
370 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
371 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
372 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
373 {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 },
374 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
375 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
376 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
377 {"copy-unsafe-links", 0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 },
378 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
379 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
380 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
381 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
382 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
383 {"omit-dir-times", 'O', POPT_ARG_NONE, &omit_dir_times, 0, 0, 0 },
384 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
385 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
386 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
387 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
388 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
389 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
390 {"recursive", 'r', POPT_ARG_VAL, &recurse, -1, 0, 0 },
391 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
392 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
393 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
394 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
395 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
396 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
397 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
398 {"timeout", 0, POPT_ARG_INT, &io_timeout, OPT_TIMEOUT, 0, 0 },
399 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
400 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
401 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
402 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
403 /* TODO: Should this take an optional int giving the compression level? */
404 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
405 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
406 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
407 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
408 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
409 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
410 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
411 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
412 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
413 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
414 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
415 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
416 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
417 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
418 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
419 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
420 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
421 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
422 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
423 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
424 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
425 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
427 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
428 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
430 /* All these options switch us into daemon-mode option-parsing. */
431 {"address", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
432 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
433 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
434 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
438 static void daemon_usage(enum logcode F)
440 print_rsync_version(F);
442 rprintf(F,"\nUsage: rsync --daemon [OPTION]...\n");
443 rprintf(F," --address=ADDRESS bind to the specified address\n");
444 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
445 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
446 rprintf(F," --no-detach do not detach from the parent\n");
447 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
449 rprintf(F," -4, --ipv4 prefer IPv4\n");
450 rprintf(F," -6, --ipv6 prefer IPv6\n");
452 rprintf(F," -h, --help show this help screen\n");
454 rprintf(F,"\nIf you were not trying to invoke rsync as a daemon, avoid using any of the\n");
455 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
458 static struct poptOption long_daemon_options[] = {
459 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
460 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
461 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
462 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
463 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
465 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
466 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
468 {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 },
469 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
470 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
471 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
472 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
477 static char err_buf[200];
481 * Store the option error message, if any, so that we can log the
482 * connection attempt (which requires parsing the options), and then
483 * show the error later on.
485 void option_error(void)
488 strcpy(err_buf, "Error parsing options: "
489 "option may be supported on client but not on server?\n");
492 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
497 * Tweak the option table to disable all options that the rsyncd.conf
498 * file has told us to refuse.
500 static void set_refuse_options(char *bp)
502 struct poptOption *op;
503 char *cp, shortname[2];
504 int is_wild, found_match;
509 while (*bp == ' ') bp++;
512 if ((cp = strchr(bp, ' ')) != NULL)
514 /* If they specify "delete", reject all delete options. */
515 if (strcmp(bp, "delete") == 0)
517 is_wild = strpbrk(bp, "*?[") != NULL;
519 for (op = long_options; ; op++) {
520 *shortname = op->shortName;
521 if (!op->longName && !*shortname)
523 if ((op->longName && wildmatch(bp, op->longName))
524 || (*shortname && wildmatch(bp, shortname))) {
525 if (op->argInfo == POPT_ARG_VAL)
526 op->argInfo = POPT_ARG_NONE;
527 op->val = (op - long_options) + OPT_REFUSED_BASE;
534 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
545 static int count_args(const char **argv)
550 while (argv[i] != NULL)
559 * Process command line arguments. Called on both local and remote.
561 * @retval 1 if all options are OK; with globals set to appropriate
564 * @retval 0 on error, with err_buf containing an explanation
566 int parse_arguments(int *argc, const char ***argv, int frommain)
569 char *ref = lp_refuse_options(module_id);
574 set_refuse_options(ref);
576 /* TODO: Call poptReadDefaultConfig; handle errors. */
578 /* The context leaks in case of an error, but if there's a
579 * problem we always exit anyhow. */
580 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
581 poptReadDefaultConfig(pc, 0);
583 while ((opt = poptGetNextOpt(pc)) != -1) {
584 /* most options are handled automatically by popt;
585 * only special cases are returned and listed here. */
589 print_rsync_version(FINFO);
594 strcpy(err_buf, "Attempt to hack rsync thwarted!\n");
598 pc = poptGetContext(RSYNC_NAME, *argc, *argv,
599 long_daemon_options, 0);
600 while ((opt = poptGetNextOpt(pc)) != -1) {
608 "rsync: %s: %s (in daemon mode)\n",
609 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
615 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
618 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
619 exit_cleanup(RERR_SYNTAX);
621 *argv = poptGetArgs(pc);
622 *argc = count_args(*argv);
627 case OPT_MODIFY_WINDOW:
628 /* The value has already been set by popt, but
629 * we need to remember that we're using a
630 * non-default setting. */
631 modify_window_set = 1;
635 add_exclude(&exclude_list, poptGetOptArg(pc), 0);
639 add_exclude(&exclude_list, poptGetOptArg(pc),
644 add_exclude(&exclude_list, poptGetOptArg(pc),
648 case OPT_EXCLUDE_FROM:
649 case OPT_INCLUDE_FROM:
650 arg = poptGetOptArg(pc);
652 arg = sanitize_path(NULL, arg, NULL, 0);
653 if (server_exclude_list.head) {
654 char *cp = (char *)arg;
656 if (check_exclude(&server_exclude_list, cp, 0) < 0)
657 goto options_rejected;
659 add_exclude_file(&exclude_list, arg, XFLG_FATAL_ERRORS
660 | (opt == OPT_INCLUDE_FROM ? XFLG_DEF_INCLUDE
661 : XFLG_DEF_EXCLUDE));
680 exit_cleanup(RERR_SYNTAX);
686 switch (++F_option_cnt) {
688 add_exclude(&exclude_list,
689 ": /.rsync-filter", 0);
692 add_exclude(&exclude_list,
693 "- .rsync-filter", 0);
703 case OPT_WRITE_BATCH:
704 /* batch_name is already set */
709 /* batch_name is already set */
714 for (arg = max_size_arg; isdigit(*arg); arg++) {}
716 for (arg++; isdigit(*arg); arg++) {}
719 max_size = atof(max_size_arg) * 1024;
722 max_size = atof(max_size_arg) * 1024*1024;
725 max_size = atof(max_size_arg) * 1024*1024*1024;
728 max_size = atof(max_size_arg);
735 snprintf(err_buf, sizeof err_buf,
736 "--max-size value is invalid: %s\n",
743 if (io_timeout && io_timeout < select_timeout)
744 select_timeout = io_timeout;
750 dest_option = "--link-dest";
753 snprintf(err_buf, sizeof err_buf,
754 "hard links are not supported on this %s\n",
755 am_server ? "server" : "client");
761 dest_option = "--copy-dest";
764 case OPT_COMPARE_DEST:
766 dest_option = "--compare-dest";
768 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
769 snprintf(err_buf, sizeof err_buf,
770 "ERROR: at most %d %s args may be specified\n",
771 MAX_BASIS_DIRS, dest_option);
774 arg = poptGetOptArg(pc);
776 arg = sanitize_path(NULL, arg, NULL, 0);
777 basis_dir[basis_dir_cnt++] = (char *)arg;
781 /* A large opt value means that set_refuse_options()
782 * turned this option off (opt-BASE is its index). */
783 if (opt >= OPT_REFUSED_BASE) {
784 struct poptOption *op =
785 &long_options[opt-OPT_REFUSED_BASE];
786 int n = snprintf(err_buf, sizeof err_buf,
787 "The server is configured to refuse --%s\n",
790 snprintf(err_buf+n, sizeof err_buf-n,
791 " (-%c)\n", op->shortName);
794 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
795 am_server ? "on remote machine: " : "",
796 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
804 if (preserve_links && !am_sender) {
805 snprintf(err_buf, sizeof err_buf,
806 "symlinks are not supported on this %s\n",
807 am_server ? "server" : "client");
812 #if !SUPPORT_HARD_LINKS
813 if (preserve_hard_links) {
814 snprintf(err_buf, sizeof err_buf,
815 "hard links are not supported on this %s\n",
816 am_server ? "server" : "client");
821 if (write_batch && read_batch) {
822 snprintf(err_buf, sizeof err_buf,
823 "--write-batch and --read-batch can not be used together\n");
826 if (write_batch || read_batch) {
828 snprintf(err_buf, sizeof err_buf,
829 "--%s-batch cannot be used with --dry_run (-n)\n",
830 write_batch ? "write" : "read");
835 "ignoring --%s-batch option sent to server\n",
836 write_batch ? "write" : "read");
837 /* We don't actually exit_cleanup(), so that we can
838 * still service older version clients that still send
839 * batch args to server. */
840 read_batch = write_batch = 0;
844 if (read_batch && files_from) {
845 snprintf(err_buf, sizeof err_buf,
846 "--read-batch cannot be used with --files-from\n");
849 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
850 snprintf(err_buf, sizeof err_buf,
851 "the batch-file name must be %d characters or less.\n",
856 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
857 snprintf(err_buf, sizeof err_buf,
858 "the --temp-dir path is WAY too long.\n");
862 if (compare_dest + copy_dest + link_dest > 1) {
863 snprintf(err_buf, sizeof err_buf,
864 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
870 recurse = -1; /* infinite recursion */
878 preserve_devices = 1;
881 if (recurse || list_only || files_from)
884 if (relative_paths < 0)
885 relative_paths = files_from? 1 : 0;
887 if (delete_during || delete_before || delete_after)
889 if (delete_excluded && !delete_mode)
890 delete_mode = delete_during = 1;
892 *argv = poptGetArgs(pc);
893 *argc = count_args(*argv);
895 if (sanitize_paths) {
897 for (i = *argc; i-- > 0; )
898 (*argv)[i] = sanitize_path(NULL, (*argv)[i], "", 0);
900 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
902 partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
904 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
906 files_from = sanitize_path(NULL, files_from, NULL, 0);
908 if (server_exclude_list.head && !am_sender) {
909 struct exclude_list_struct *elp = &server_exclude_list;
912 clean_fname(tmpdir, 1);
913 if (check_exclude(elp, tmpdir, 1) < 0)
914 goto options_rejected;
917 clean_fname(partial_dir, 1);
918 if (check_exclude(elp, partial_dir, 1) < 0)
919 goto options_rejected;
921 for (i = 0; i < basis_dir_cnt; i++) {
922 clean_fname(basis_dir[i], 1);
923 if (check_exclude(elp, basis_dir[i], 1) < 0)
924 goto options_rejected;
927 clean_fname(backup_dir, 1);
928 if (check_exclude(elp, backup_dir, 1) < 0)
929 goto options_rejected;
932 if (server_exclude_list.head && files_from) {
933 clean_fname(files_from, 1);
934 if (check_exclude(&server_exclude_list, files_from, 0) < 0) {
936 snprintf(err_buf, sizeof err_buf,
937 "Your options have been rejected by the server.\n");
943 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
944 backup_suffix_len = strlen(backup_suffix);
945 if (strchr(backup_suffix, '/') != NULL) {
946 snprintf(err_buf, sizeof err_buf,
947 "--suffix cannot contain slashes: %s\n",
952 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
953 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
954 if (backup_dir_remainder < 32) {
955 snprintf(err_buf, sizeof err_buf,
956 "the --backup-dir path is WAY too long.\n");
959 if (backup_dir_buf[backup_dir_len - 1] != '/') {
960 backup_dir_buf[backup_dir_len++] = '/';
961 backup_dir_buf[backup_dir_len] = '\0';
963 if (verbose > 1 && !am_sender)
964 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
965 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
966 snprintf(err_buf, sizeof err_buf,
967 "--suffix cannot be a null string without --backup-dir\n");
971 if (do_progress && !verbose)
974 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
975 bwlimit = daemon_bwlimit;
977 bwlimit_writemax = (size_t)bwlimit * 128;
978 if (bwlimit_writemax < 512)
979 bwlimit_writemax = 512;
985 snprintf(err_buf, sizeof err_buf,
986 "--inplace cannot be used with --partial-dir\n");
991 snprintf(err_buf, sizeof err_buf,
992 "--inplace is not supported on this %s\n",
993 am_server ? "server" : "client");
997 if (keep_partial && !partial_dir)
998 partial_dir = getenv("RSYNC_PARTIAL_DIR");
1000 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1002 else if (*partial_dir != '/') {
1003 add_exclude(&exclude_list, partial_dir,
1004 XFLG_DIRECTORY | XFLG_DEF_EXCLUDE);
1012 if (*argc > 2 || (!am_daemon && *argc == 1)) {
1014 exit_cleanup(RERR_SYNTAX);
1016 if (strcmp(files_from, "-") == 0) {
1019 remote_filesfrom_file = "-";
1021 else if ((colon = find_colon(files_from)) != 0) {
1024 exit_cleanup(RERR_SYNTAX);
1026 remote_filesfrom_file = colon+1 + (colon[1] == ':');
1027 if (strcmp(remote_filesfrom_file, "-") == 0) {
1028 snprintf(err_buf, sizeof err_buf,
1029 "Invalid --files-from remote filename\n");
1033 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1034 if (filesfrom_fd < 0) {
1035 snprintf(err_buf, sizeof err_buf,
1036 "failed to open files-from file %s: %s\n",
1037 files_from, strerror(errno));
1048 * Construct a filtered list of options to pass through from the
1049 * client to the server.
1051 * This involves setting options that will tell the server how to
1052 * behave, and also filtering out options that are processed only
1055 void server_options(char **args,int *argc)
1057 static char argstr[50+MAX_BASIS_DIRS*2];
1063 if (blocking_io == -1)
1066 args[ac++] = "--server";
1068 if (daemon_over_rsh) {
1069 args[ac++] = "--daemon";
1071 /* if we're passing --daemon, we're done */
1076 args[ac++] = "--sender";
1080 for (i = 0; i < verbose; i++)
1083 /* the -q option is intentionally left out */
1096 if (keep_dirlinks && am_sender)
1101 /* We don't need to send --no-whole-file, because it's the
1102 * default for remote transfers, and in any case old versions
1103 * of rsync will not understand it. */
1105 if (preserve_hard_links)
1111 if (preserve_devices)
1115 if (omit_dir_times && am_sender)
1121 if (always_checksum)
1129 if (one_file_system)
1136 /* This is a complete hack - blame Rusty. FIXME!
1137 * This hack is only needed for older rsync versions that
1138 * don't understand the --list-only option. */
1139 if (list_only == 1 && recurse >= 0)
1145 args[ac++] = argstr;
1148 args[ac++] = "--list-only";
1151 if (asprintf(&arg, "-B%lu", block_size) < 0)
1156 if (max_delete && am_sender) {
1157 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1162 if (max_size && am_sender) {
1163 args[ac++] = "--max-size";
1164 args[ac++] = max_size_arg;
1168 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1174 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1180 args[ac++] = "--backup-dir";
1181 args[ac++] = backup_dir;
1184 /* Only send --suffix if it specifies a non-default value. */
1185 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
1186 /* We use the following syntax to avoid weirdness with '~'. */
1187 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1193 if (delete_excluded)
1194 args[ac++] = "--delete-excluded";
1195 else if (delete_before)
1196 args[ac++] = "--delete-before";
1197 else if (delete_during || delete_after)
1198 args[ac++] = "--delete";
1201 args[ac++] = "--delete-after";
1204 args[ac++] = "--force";
1208 args[ac++] = "--size-only";
1210 if (modify_window_set) {
1211 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1216 if (checksum_seed) {
1217 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
1222 if (partial_dir && am_sender) {
1223 args[ac++] = "--partial-dir";
1224 args[ac++] = partial_dir;
1225 } else if (keep_partial)
1226 args[ac++] = "--partial";
1229 args[ac++] = "--ignore-errors";
1231 if (copy_unsafe_links)
1232 args[ac++] = "--copy-unsafe-links";
1235 args[ac++] = "--safe-links";
1238 args[ac++] = "--numeric-ids";
1240 if (only_existing && am_sender)
1241 args[ac++] = "--existing";
1243 if (opt_ignore_existing && am_sender)
1244 args[ac++] = "--ignore-existing";
1247 args[ac++] = "--inplace";
1250 args[ac++] = "--temp-dir";
1251 args[ac++] = tmpdir;
1254 if (basis_dir[0] && am_sender) {
1255 /* the server only needs this option if it is not the sender,
1256 * and it may be an older version that doesn't know this
1257 * option, so don't send it if client is the sender.
1260 for (i = 0; i < basis_dir_cnt; i++) {
1261 args[ac++] = dest_option;
1262 args[ac++] = basis_dir[i];
1266 if (files_from && (!am_sender || remote_filesfrom_file)) {
1267 if (remote_filesfrom_file) {
1268 args[ac++] = "--files-from";
1269 args[ac++] = remote_filesfrom_file;
1271 args[ac++] = "--from0";
1273 args[ac++] = "--files-from=-";
1274 args[ac++] = "--from0";
1276 if (!relative_paths)
1277 args[ac++] = "--no-relative";
1279 if (!implied_dirs && !am_sender)
1280 args[ac++] = "--no-implied-dirs";
1286 out_of_memory("server_options");
1290 * Return the position of a ':' IF it is not part of a filename (i.e. as
1291 * long as it doesn't occur after a slash.
1293 char *find_colon(char *s)
1301 /* now check to see if there is a / in the string before the : - if there is then
1302 discard the colon on the assumption that the : is part of a filename */