1 /* -*- c-file-style: "linux" -*-
3 * Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4 * Copyright (C) 2000, 2001, 2002 by Martin Pool <mbp@samba.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 extern int sanitize_paths;
26 extern int select_timeout;
27 extern struct filter_list_struct filter_list;
28 extern struct filter_list_struct server_filter_list;
33 * If 1, send the whole file as literal data rather than trying to
34 * create an incremental diff.
36 * If -1, then look at whether we're local or remote and go by that.
38 * @sa disable_deltas_p()
43 int keep_dirlinks = 0;
45 int preserve_links = 0;
46 int preserve_hard_links = 0;
47 int preserve_perms = 0;
48 int preserve_devices = 0;
51 int preserve_times = 0;
52 int omit_dir_times = 0;
58 int delete_during = 0;
59 int delete_before = 0;
61 int delete_excluded = 0;
62 int one_file_system = 0;
63 int protocol_version = PROTOCOL_VERSION;
65 int do_compression = 0;
68 int relative_paths = -1;
76 char *files_from = NULL;
77 int filesfrom_fd = -1;
78 char *remote_filesfrom_file = NULL;
83 int daemon_over_rsh = 0;
87 int safe_symlinks = 0;
88 int copy_unsafe_links = 0;
90 int daemon_bwlimit = 0;
93 size_t bwlimit_writemax = 0;
94 int only_existing = 0;
95 int opt_ignore_existing = 0;
98 int ignore_errors = 0;
99 int modify_window = 0;
100 int blocking_io = -1;
101 int checksum_seed = 0;
103 int delay_updates = 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 itemize_changes = 0;
145 int log_before_transfer = 0;
146 int always_checksum = 0;
149 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
150 char *batch_name = NULL;
152 static int daemon_opt; /* sets am_daemon after option error-reporting */
153 static int F_option_cnt = 0;
154 static int modify_window_set;
155 static int refused_delete, refused_archive_part;
156 static int refused_partial, refused_progress, refused_delete_before;
157 static char *dest_option = NULL;
158 static char *max_size_arg;
159 static char partialdir_for_delayupdate[] = ".~tmp~";
161 /** Local address to bind. As a character string because it's
162 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
163 * address, or a hostname. **/
167 static void print_rsync_version(enum logcode f)
169 char const *got_socketpair = "no ";
170 char const *have_inplace = "no ";
171 char const *hardlinks = "no ";
172 char const *links = "no ";
173 char const *ipv6 = "no ";
174 STRUCT_STAT *dumstat;
176 #ifdef HAVE_SOCKETPAIR
180 #ifdef HAVE_FTRUNCATE
184 #ifdef SUPPORT_HARD_LINKS
196 rprintf(f, "%s version %s protocol version %d\n",
197 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
199 "Copyright (C) 1996-2005 by Andrew Tridgell and others\n");
200 rprintf(f, "<http://rsync.samba.org/>\n");
201 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
202 "%shard links, %ssymlinks, batchfiles, \n",
203 (int) (sizeof (OFF_T) * 8),
204 got_socketpair, hardlinks, links);
206 /* Note that this field may not have type ino_t. It depends
207 * on the complicated interaction between largefile feature
209 rprintf(f, " %sinplace, %sIPv6, %d-bit system inums, %d-bit internal inums\n",
211 (int) (sizeof dumstat->st_ino * 8),
212 (int) (sizeof (int64) * 8));
213 #ifdef MAINTAINER_MODE
214 rprintf(f, " panic action: \"%s\"\n",
219 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
221 if (sizeof (int64) != SIZEOF_INT64) {
223 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
224 (int) SIZEOF_INT64, (int) sizeof (int64));
229 "rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
230 "are welcome to redistribute it under certain conditions. See the GNU\n"
231 "General Public Licence for details.\n"
236 void usage(enum logcode F)
238 print_rsync_version(F);
240 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
242 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
243 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
244 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
245 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
246 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
247 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
248 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
249 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
250 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
251 rprintf(F," sources separated by space as long as they have same top-level\n");
252 rprintf(F,"\nOptions\n");
253 rprintf(F," -v, --verbose increase verbosity\n");
254 rprintf(F," -q, --quiet suppress non-error messages\n");
255 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
256 rprintf(F," -a, --archive archive mode; same as -rlptgoD (no -H)\n");
257 rprintf(F," -r, --recursive recurse into directories\n");
258 rprintf(F," -R, --relative use relative path names\n");
259 rprintf(F," --no-relative turn off --relative\n");
260 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
261 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
262 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
263 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
264 rprintf(F," -u, --update skip files that are newer on the receiver\n");
265 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
266 rprintf(F," -d, --dirs transfer directories without recursing\n");
267 rprintf(F," -l, --links copy symlinks as symlinks\n");
268 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
269 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
270 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
271 rprintf(F," -H, --hard-links preserve hard links\n");
272 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
273 rprintf(F," -p, --perms preserve permissions\n");
274 rprintf(F," -o, --owner preserve owner (root only)\n");
275 rprintf(F," -g, --group preserve group\n");
276 rprintf(F," -D, --devices preserve devices (root only)\n");
277 rprintf(F," -t, --times preserve times\n");
278 rprintf(F," -O, --omit-dir-times omit directories when preserving times\n");
279 rprintf(F," -S, --sparse handle sparse files efficiently\n");
280 rprintf(F," -n, --dry-run show what would have been transferred\n");
281 rprintf(F," -W, --whole-file copy files whole (without rsync algorithm)\n");
282 rprintf(F," --no-whole-file always use incremental rsync algorithm\n");
283 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
284 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
285 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
286 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
287 rprintf(F," --existing only update files that already exist on receiver\n");
288 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
289 rprintf(F," --del an alias for --delete-during\n");
290 rprintf(F," --delete delete files that don't exist on the sending side\n");
291 rprintf(F," --delete-before receiver deletes before transfer (default)\n");
292 rprintf(F," --delete-during receiver deletes during transfer, not before\n");
293 rprintf(F," --delete-after receiver deletes after transfer, not before\n");
294 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
295 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
296 rprintf(F," --force force deletion of directories even if not empty\n");
297 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
298 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
299 rprintf(F," --partial keep partially transferred files\n");
300 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
301 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
302 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
303 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
304 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
305 rprintf(F," --size-only skip files that match in size\n");
306 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
307 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
308 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
309 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
310 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
311 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
312 rprintf(F," -z, --compress compress file data during the transfer\n");
313 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
314 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
315 rprintf(F," -F same as --filter='dir-merge /.rsync-filter'\n");
316 rprintf(F," repeated: --filter='- .rsync-filter'\n");
317 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
318 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
319 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
320 rprintf(F," --include-from=FILE read include patterns from FILE\n");
321 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
322 rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
323 rprintf(F," --version print version number\n");
324 rprintf(F," --port=PORT specify double-colon alternate port number\n");
325 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
326 rprintf(F," --no-blocking-io turn off blocking I/O when it is the default\n");
327 rprintf(F," --stats give some file-transfer stats\n");
328 rprintf(F," --progress show progress during transfer\n");
329 rprintf(F," -P same as --partial --progress\n");
330 rprintf(F," -i, --itemize-changes output a change-summary for all updates\n");
331 rprintf(F," --log-format=FORMAT log file-transfers using specified format\n");
332 rprintf(F," --password-file=FILE read password from FILE\n");
333 rprintf(F," --list-only list the files instead of copying them\n");
334 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
335 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
336 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
338 rprintf(F," -4, --ipv4 prefer IPv4\n");
339 rprintf(F," -6, --ipv6 prefer IPv6\n");
341 rprintf(F," -h, --help show this help screen\n");
343 rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
344 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
345 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
348 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
349 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
350 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
351 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
352 OPT_REFUSED_BASE = 9000};
354 static struct poptOption long_options[] = {
355 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
356 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
357 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
358 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
359 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
360 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
361 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
362 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
363 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
364 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
365 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
366 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
367 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
368 {"delete-before", 0, POPT_ARG_VAL, &delete_before, 2, 0, 0 },
369 {"delete-during", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
370 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
371 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
372 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
373 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
374 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
375 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
376 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
377 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
378 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
379 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
380 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
381 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
382 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
383 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
384 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
385 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
386 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
387 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
388 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
389 {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 },
390 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
391 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
392 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
393 {"copy-unsafe-links",0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 },
394 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
395 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
396 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
397 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
398 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
399 {"omit-dir-times", 'O', POPT_ARG_NONE, &omit_dir_times, 0, 0, 0 },
400 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
401 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
402 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
403 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
404 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
405 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
406 {"recursive", 'r', POPT_ARG_VAL, &recurse, -1, 0, 0 },
407 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
408 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
409 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
410 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
411 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
412 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
413 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
414 {"timeout", 0, POPT_ARG_INT, &io_timeout, OPT_TIMEOUT, 0, 0 },
415 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
416 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
417 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
418 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
419 {"fuzzy", 'y', POPT_ARG_NONE, &fuzzy_basis, 0, 0, 0 },
420 /* TODO: Should this take an optional int giving the compression level? */
421 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
422 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
423 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
424 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
425 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
426 {"delay-updates", 0, POPT_ARG_NONE, &delay_updates, 0, 0, 0 },
427 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
428 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
429 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
430 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
431 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
432 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
433 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
434 {"itemize-changes", 'i', POPT_ARG_NONE, &itemize_changes, 0, 0, 0 },
435 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
436 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
437 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
438 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
439 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
440 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
441 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
442 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
443 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
444 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
446 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
447 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
449 /* All these options switch us into daemon-mode option-parsing. */
450 {"address", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
451 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
452 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
453 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
457 static void daemon_usage(enum logcode F)
459 print_rsync_version(F);
461 rprintf(F,"\nUsage: rsync --daemon [OPTION]...\n");
462 rprintf(F," --address=ADDRESS bind to the specified address\n");
463 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
464 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
465 rprintf(F," --no-detach do not detach from the parent\n");
466 rprintf(F," --port=PORT listen on alternate port number\n");
467 rprintf(F," -v, --verbose increase verbosity\n");
469 rprintf(F," -4, --ipv4 prefer IPv4\n");
470 rprintf(F," -6, --ipv6 prefer IPv6\n");
472 rprintf(F," -h, --help show this help screen\n");
474 rprintf(F,"\nIf you were not trying to invoke rsync as a daemon, avoid using any of the\n");
475 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
478 static struct poptOption long_daemon_options[] = {
479 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
480 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
481 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
482 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
483 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
485 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
486 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
488 {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 },
489 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
490 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
491 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
492 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
493 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
498 static char err_buf[200];
502 * Store the option error message, if any, so that we can log the
503 * connection attempt (which requires parsing the options), and then
504 * show the error later on.
506 void option_error(void)
509 strcpy(err_buf, "Error parsing options: "
510 "option may be supported on client but not on server?\n");
513 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
518 * Tweak the option table to disable all options that the rsyncd.conf
519 * file has told us to refuse.
521 static void set_refuse_options(char *bp)
523 struct poptOption *op;
524 char *cp, shortname[2];
525 int is_wild, found_match;
530 while (*bp == ' ') bp++;
533 if ((cp = strchr(bp, ' ')) != NULL)
535 is_wild = strpbrk(bp, "*?[") != NULL;
537 for (op = long_options; ; op++) {
538 *shortname = op->shortName;
539 if (!op->longName && !*shortname)
541 if ((op->longName && wildmatch(bp, op->longName))
542 || (*shortname && wildmatch(bp, shortname))
543 || op->val == OPT_DAEMON) {
544 if (op->argInfo == POPT_ARG_VAL)
545 op->argInfo = POPT_ARG_NONE;
546 op->val = (op - long_options) + OPT_REFUSED_BASE;
548 /* These flags are set to let us easily check
549 * an implied option later in the code. */
550 switch (*shortname) {
551 case 'r': case 'd': case 'l': case 'p':
552 case 't': case 'g': case 'o': case 'D':
553 refused_archive_part = op->val;
556 if (wildmatch("delete", op->longName))
557 refused_delete = op->val;
558 else if (wildmatch("delete-before", op->longName))
559 refused_delete_before = op->val;
560 else if (wildmatch("partial", op->longName))
561 refused_partial = op->val;
562 else if (wildmatch("progress", op->longName))
563 refused_progress = op->val;
571 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
582 static int count_args(const char **argv)
587 while (argv[i] != NULL)
595 static void create_refuse_error(int which)
597 /* The "which" value is the index + OPT_REFUSED_BASE. */
598 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
599 int n = snprintf(err_buf, sizeof err_buf,
600 "The server is configured to refuse --%s\n",
603 snprintf(err_buf + n, sizeof err_buf - n,
604 " (-%c)\n", op->shortName);
610 * Process command line arguments. Called on both local and remote.
612 * @retval 1 if all options are OK; with globals set to appropriate
615 * @retval 0 on error, with err_buf containing an explanation
617 int parse_arguments(int *argc, const char ***argv, int frommain)
620 char *ref = lp_refuse_options(module_id);
625 set_refuse_options(ref);
627 /* TODO: Call poptReadDefaultConfig; handle errors. */
629 /* The context leaks in case of an error, but if there's a
630 * problem we always exit anyhow. */
631 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
632 poptReadDefaultConfig(pc, 0);
634 while ((opt = poptGetNextOpt(pc)) != -1) {
635 /* most options are handled automatically by popt;
636 * only special cases are returned and listed here. */
640 print_rsync_version(FINFO);
645 strcpy(err_buf, "Attempt to hack rsync thwarted!\n");
649 pc = poptGetContext(RSYNC_NAME, *argc, *argv,
650 long_daemon_options, 0);
651 while ((opt = poptGetNextOpt(pc)) != -1) {
663 "rsync: %s: %s (in daemon mode)\n",
664 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
670 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
673 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
674 exit_cleanup(RERR_SYNTAX);
676 *argv = poptGetArgs(pc);
677 *argc = count_args(*argv);
682 case OPT_MODIFY_WINDOW:
683 /* The value has already been set by popt, but
684 * we need to remember that we're using a
685 * non-default setting. */
686 modify_window_set = 1;
690 parse_rule(&filter_list, poptGetOptArg(pc), 0, 0);
694 parse_rule(&filter_list, poptGetOptArg(pc),
695 0, XFLG_OLD_PREFIXES);
699 parse_rule(&filter_list, poptGetOptArg(pc),
700 MATCHFLG_INCLUDE, XFLG_OLD_PREFIXES);
703 case OPT_EXCLUDE_FROM:
704 case OPT_INCLUDE_FROM:
705 arg = poptGetOptArg(pc);
707 arg = sanitize_path(NULL, arg, NULL, 0);
708 if (server_filter_list.head) {
709 char *cp = (char *)arg;
711 goto options_rejected;
713 if (check_filter(&server_filter_list, cp, 0) < 0)
714 goto options_rejected;
716 parse_filter_file(&filter_list, arg,
717 opt == OPT_INCLUDE_FROM ? MATCHFLG_INCLUDE : 0,
718 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
737 exit_cleanup(RERR_SYNTAX);
743 switch (++F_option_cnt) {
745 parse_rule(&filter_list,": /.rsync-filter",0,0);
748 parse_rule(&filter_list,"- .rsync-filter",0,0);
754 if (refused_partial || refused_progress) {
755 create_refuse_error(refused_partial
756 ? refused_partial : refused_progress);
763 case OPT_WRITE_BATCH:
764 /* batch_name is already set */
769 /* batch_name is already set */
774 for (arg = max_size_arg; isdigit(*(uchar*)arg); arg++) {}
776 for (arg++; isdigit(*(uchar*)arg); arg++) {}
779 max_size = atof(max_size_arg) * 1024;
782 max_size = atof(max_size_arg) * 1024*1024;
785 max_size = atof(max_size_arg) * 1024*1024*1024;
788 max_size = atof(max_size_arg);
795 snprintf(err_buf, sizeof err_buf,
796 "--max-size value is invalid: %s\n",
803 if (io_timeout && io_timeout < select_timeout)
804 select_timeout = io_timeout;
810 dest_option = "--link-dest";
813 snprintf(err_buf, sizeof err_buf,
814 "hard links are not supported on this %s\n",
815 am_server ? "server" : "client");
821 dest_option = "--copy-dest";
824 case OPT_COMPARE_DEST:
826 dest_option = "--compare-dest";
828 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
829 snprintf(err_buf, sizeof err_buf,
830 "ERROR: at most %d %s args may be specified\n",
831 MAX_BASIS_DIRS, dest_option);
834 arg = poptGetOptArg(pc);
836 arg = sanitize_path(NULL, arg, NULL, 0);
837 basis_dir[basis_dir_cnt++] = (char *)arg;
841 /* A large opt value means that set_refuse_options()
842 * turned this option off. */
843 if (opt >= OPT_REFUSED_BASE) {
844 create_refuse_error(opt);
847 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
848 am_server ? "on remote machine: " : "",
849 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
858 #ifndef SUPPORT_LINKS
859 if (preserve_links && !am_sender) {
860 snprintf(err_buf, sizeof err_buf,
861 "symlinks are not supported on this %s\n",
862 am_server ? "server" : "client");
867 #ifndef SUPPORT_HARD_LINKS
868 if (preserve_hard_links) {
869 snprintf(err_buf, sizeof err_buf,
870 "hard links are not supported on this %s\n",
871 am_server ? "server" : "client");
876 if (write_batch && read_batch) {
877 snprintf(err_buf, sizeof err_buf,
878 "--write-batch and --read-batch can not be used together\n");
881 if (write_batch || read_batch) {
883 snprintf(err_buf, sizeof err_buf,
884 "--%s-batch cannot be used with --dry_run (-n)\n",
885 write_batch ? "write" : "read");
890 "ignoring --%s-batch option sent to server\n",
891 write_batch ? "write" : "read");
892 /* We don't actually exit_cleanup(), so that we can
893 * still service older version clients that still send
894 * batch args to server. */
895 read_batch = write_batch = 0;
899 if (read_batch && files_from) {
900 snprintf(err_buf, sizeof err_buf,
901 "--read-batch cannot be used with --files-from\n");
904 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
905 snprintf(err_buf, sizeof err_buf,
906 "the batch-file name must be %d characters or less.\n",
911 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
912 snprintf(err_buf, sizeof err_buf,
913 "the --temp-dir path is WAY too long.\n");
917 if (compare_dest + copy_dest + link_dest > 1) {
918 snprintf(err_buf, sizeof err_buf,
919 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
924 if (refused_archive_part) {
925 create_refuse_error(refused_archive_part);
929 recurse = -1; /* infinite recursion */
937 preserve_devices = 1;
940 if (recurse || list_only || files_from)
943 if (relative_paths < 0)
944 relative_paths = files_from? 1 : 0;
946 if (!!delete_before + delete_during + delete_after > 1) {
947 snprintf(err_buf, sizeof err_buf,
948 "You may not combine multiple --delete-WHEN options.\n");
952 delete_before = delete_during = delete_after = 0;
953 delete_mode = delete_excluded = 0;
954 } else if (delete_before || delete_during || delete_after)
956 else if (delete_mode || delete_excluded) {
957 if (refused_delete_before) {
958 create_refuse_error(refused_delete_before);
961 delete_mode = delete_before = 1;
964 if (delete_mode && refused_delete) {
965 create_refuse_error(refused_delete);
969 *argv = poptGetArgs(pc);
970 *argc = count_args(*argv);
972 if (sanitize_paths) {
974 for (i = *argc; i-- > 0; )
975 (*argv)[i] = sanitize_path(NULL, (*argv)[i], "", 0);
977 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
979 partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
981 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
983 files_from = sanitize_path(NULL, files_from, NULL, 0);
985 if (server_filter_list.head && !am_sender) {
986 struct filter_list_struct *elp = &server_filter_list;
990 goto options_rejected;
991 clean_fname(tmpdir, 1);
992 if (check_filter(elp, tmpdir, 1) < 0)
993 goto options_rejected;
995 if (partial_dir && *partial_dir) {
996 clean_fname(partial_dir, 1);
997 if (check_filter(elp, partial_dir, 1) < 0)
998 goto options_rejected;
1000 for (i = 0; i < basis_dir_cnt; i++) {
1002 goto options_rejected;
1003 clean_fname(basis_dir[i], 1);
1004 if (check_filter(elp, basis_dir[i], 1) < 0)
1005 goto options_rejected;
1009 goto options_rejected;
1010 clean_fname(backup_dir, 1);
1011 if (check_filter(elp, backup_dir, 1) < 0)
1012 goto options_rejected;
1015 if (server_filter_list.head && files_from) {
1017 goto options_rejected;
1018 clean_fname(files_from, 1);
1019 if (check_filter(&server_filter_list, files_from, 0) < 0) {
1021 snprintf(err_buf, sizeof err_buf,
1022 "Your options have been rejected by the server.\n");
1028 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
1029 backup_suffix_len = strlen(backup_suffix);
1030 if (strchr(backup_suffix, '/') != NULL) {
1031 snprintf(err_buf, sizeof err_buf,
1032 "--suffix cannot contain slashes: %s\n",
1037 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
1038 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
1039 if (backup_dir_remainder < 32) {
1040 snprintf(err_buf, sizeof err_buf,
1041 "the --backup-dir path is WAY too long.\n");
1044 if (backup_dir_buf[backup_dir_len - 1] != '/') {
1045 backup_dir_buf[backup_dir_len++] = '/';
1046 backup_dir_buf[backup_dir_len] = '\0';
1048 if (verbose > 1 && !am_sender) {
1049 rprintf(FINFO, "backup_dir is %s\n",
1050 safe_fname(backup_dir_buf));
1052 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
1053 snprintf(err_buf, sizeof err_buf,
1054 "--suffix cannot be a null string without --backup-dir\n");
1059 if (strstr(log_format, "%i") != NULL)
1060 itemize_changes = 1;
1061 if (strstr(log_format, "%b") == NULL
1062 && strstr(log_format, "%c") == NULL)
1063 log_before_transfer = !am_server;
1064 } else if (itemize_changes) {
1065 log_format = "%i %n%L";
1066 log_before_transfer = !am_server;
1069 if ((do_progress || dry_run) && !verbose && !log_before_transfer
1073 if (verbose && !log_format) {
1074 log_format = "%n%L";
1075 log_before_transfer = !am_server;
1078 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
1079 bwlimit = daemon_bwlimit;
1081 bwlimit_writemax = (size_t)bwlimit * 128;
1082 if (bwlimit_writemax < 512)
1083 bwlimit_writemax = 512;
1086 if (delay_updates && !partial_dir)
1087 partial_dir = partialdir_for_delayupdate;
1090 #ifdef HAVE_FTRUNCATE
1092 snprintf(err_buf, sizeof err_buf,
1093 "--inplace cannot be used with --%s\n",
1094 delay_updates ? "delay-updates" : "partial-dir");
1097 /* --inplace implies --partial for refusal purposes, but we
1098 * clear the keep_partial flag for internal logic purposes. */
1099 if (refused_partial) {
1100 create_refuse_error(refused_partial);
1105 snprintf(err_buf, sizeof err_buf,
1106 "--inplace is not supported on this %s\n",
1107 am_server ? "server" : "client");
1111 if (keep_partial && !partial_dir) {
1112 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
1113 partial_dir = strdup(arg);
1117 clean_fname(partial_dir, 1);
1118 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1120 else if (*partial_dir != '/') {
1121 parse_rule(&filter_list, partial_dir,
1122 MATCHFLG_NO_PREFIXES|MATCHFLG_DIRECTORY, 0);
1124 if (!partial_dir && refused_partial) {
1125 create_refuse_error(refused_partial);
1134 if (*argc > 2 || (!am_daemon && *argc == 1)) {
1136 exit_cleanup(RERR_SYNTAX);
1138 if (strcmp(files_from, "-") == 0) {
1141 remote_filesfrom_file = "-";
1143 else if ((colon = find_colon(files_from)) != 0) {
1146 exit_cleanup(RERR_SYNTAX);
1148 remote_filesfrom_file = colon+1 + (colon[1] == ':');
1149 if (strcmp(remote_filesfrom_file, "-") == 0) {
1150 snprintf(err_buf, sizeof err_buf,
1151 "Invalid --files-from remote filename\n");
1155 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1156 if (filesfrom_fd < 0) {
1157 snprintf(err_buf, sizeof err_buf,
1158 "failed to open files-from file %s: %s\n",
1159 files_from, strerror(errno));
1170 * Construct a filtered list of options to pass through from the
1171 * client to the server.
1173 * This involves setting options that will tell the server how to
1174 * behave, and also filtering out options that are processed only
1177 void server_options(char **args,int *argc)
1179 static char argstr[50+MAX_BASIS_DIRS*2];
1185 if (blocking_io == -1)
1188 args[ac++] = "--server";
1190 if (daemon_over_rsh) {
1191 args[ac++] = "--daemon";
1193 /* if we're passing --daemon, we're done */
1198 args[ac++] = "--sender";
1202 for (i = 0; i < verbose; i++)
1205 /* the -q option is intentionally left out */
1218 if (keep_dirlinks && am_sender)
1223 /* We don't need to send --no-whole-file, because it's the
1224 * default for remote transfers, and in any case old versions
1225 * of rsync will not understand it. */
1227 if (preserve_hard_links)
1233 if (preserve_devices)
1237 if (omit_dir_times && am_sender)
1243 if (always_checksum)
1251 if (one_file_system)
1258 /* This is a complete hack - blame Rusty. FIXME!
1259 * This hack is only needed for older rsync versions that
1260 * don't understand the --list-only option. */
1261 if (list_only == 1 && recurse >= 0)
1267 args[ac++] = argstr;
1270 args[ac++] = "--list-only";
1273 if (asprintf(&arg, "-B%lu", block_size) < 0)
1278 if (max_delete && am_sender) {
1279 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1284 if (max_size && am_sender) {
1285 args[ac++] = "--max-size";
1286 args[ac++] = max_size_arg;
1290 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1296 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1302 args[ac++] = "--backup-dir";
1303 args[ac++] = backup_dir;
1306 /* Only send --suffix if it specifies a non-default value. */
1307 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
1308 /* We use the following syntax to avoid weirdness with '~'. */
1309 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1315 if (delete_excluded)
1316 args[ac++] = "--delete-excluded";
1317 else if (delete_before == 1 || delete_after)
1318 args[ac++] = "--delete";
1319 if (delete_before > 1)
1320 args[ac++] = "--delete-before";
1322 args[ac++] = "--delete-during";
1324 args[ac++] = "--delete-after";
1326 args[ac++] = "--force";
1330 args[ac++] = "--size-only";
1332 if (modify_window_set) {
1333 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1338 if (checksum_seed) {
1339 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
1344 if (partial_dir && am_sender) {
1345 if (partial_dir != partialdir_for_delayupdate) {
1346 args[ac++] = "--partial-dir";
1347 args[ac++] = partial_dir;
1350 args[ac++] = "--delay-updates";
1351 } else if (keep_partial)
1352 args[ac++] = "--partial";
1355 args[ac++] = "--ignore-errors";
1357 if (copy_unsafe_links)
1358 args[ac++] = "--copy-unsafe-links";
1361 args[ac++] = "--safe-links";
1364 args[ac++] = "--numeric-ids";
1366 if (only_existing && am_sender)
1367 args[ac++] = "--existing";
1369 if (opt_ignore_existing && am_sender)
1370 args[ac++] = "--ignore-existing";
1373 args[ac++] = "--inplace";
1376 args[ac++] = "--temp-dir";
1377 args[ac++] = tmpdir;
1380 if (basis_dir[0] && am_sender) {
1381 /* the server only needs this option if it is not the sender,
1382 * and it may be an older version that doesn't know this
1383 * option, so don't send it if client is the sender.
1386 for (i = 0; i < basis_dir_cnt; i++) {
1387 args[ac++] = dest_option;
1388 args[ac++] = basis_dir[i];
1392 if (files_from && (!am_sender || remote_filesfrom_file)) {
1393 if (remote_filesfrom_file) {
1394 args[ac++] = "--files-from";
1395 args[ac++] = remote_filesfrom_file;
1397 args[ac++] = "--from0";
1399 args[ac++] = "--files-from=-";
1400 args[ac++] = "--from0";
1402 if (!relative_paths)
1403 args[ac++] = "--no-relative";
1405 if (!implied_dirs && !am_sender)
1406 args[ac++] = "--no-implied-dirs";
1408 if (fuzzy_basis && am_sender)
1409 args[ac++] = "--fuzzy";
1415 out_of_memory("server_options");
1419 * Return the position of a ':' IF it is not part of a filename (i.e. as
1420 * long as it doesn't occur after a slash.
1422 char *find_colon(char *s)
1430 /* now check to see if there is a / in the string before the : - if there is then
1431 discard the colon on the assumption that the : is part of a filename */