2 * Command-line (and received via daemon-socket) option parsing.
4 * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 2000, 2001, 2002 Martin Pool <mbp@samba.org>
6 * Copyright (C) 2002-2020 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
24 #include "latest-year.h"
29 extern int local_server;
30 extern int sanitize_paths;
31 extern int daemon_over_rsh;
32 extern unsigned int module_dirlen;
33 extern filter_rule_list filter_list;
34 extern filter_rule_list daemon_filter_list;
36 #define NOT_SPECIFIED (-42)
41 * If 1, send the whole file as literal data rather than trying to
42 * create an incremental diff.
44 * If -1, then look at whether we're local or remote and go by that.
46 * @sa disable_deltas_p()
51 int keep_dirlinks = 0;
52 int copy_dirlinks = 0;
54 int write_devices = 0;
55 int preserve_links = 0;
56 int preserve_hard_links = 0;
57 int preserve_acls = 0;
58 int preserve_xattrs = 0;
59 int preserve_perms = 0;
60 int preserve_executability = 0;
61 int preserve_devices = 0;
62 int preserve_specials = 0;
65 int preserve_times = 0;
66 int preserve_atimes = 0;
74 int delete_during = 0;
75 int delete_before = 0;
77 int delete_excluded = 0;
78 int remove_source_files = 0;
79 int one_file_system = 0;
80 int protocol_version = PROTOCOL_VERSION;
82 int preallocate_files = 0;
83 int do_compression = 0;
84 int def_compress_level = NOT_SPECIFIED;
85 int am_root = 0; /* 0 = normal, 1 = root, 2 = --super, -1 = --fake-super */
88 int am_starting_up = 1;
89 int relative_paths = -1;
91 int missing_args = 0; /* 0 = FERROR_XFER, 1 = ignore, 2 = delete */
94 int allow_8bit_chars = 0;
97 int prune_empty_dirs = 0;
99 char *files_from = NULL;
100 int filesfrom_fd = -1;
101 char *filesfrom_host = NULL;
103 int protect_args = -1;
104 int human_readable = 1;
106 int allow_inc_recurse = 1;
109 int connect_timeout = 0;
110 int keep_partial = 0;
111 int safe_symlinks = 0;
112 int copy_unsafe_links = 0;
113 int munge_symlinks = 0;
115 int daemon_bwlimit = 0;
118 size_t bwlimit_writemax = 0;
119 int ignore_existing = 0;
120 int ignore_non_existing = 0;
121 int need_messages_from_generator = 0;
122 int max_delete = INT_MIN;
125 int ignore_errors = 0;
126 int modify_window = 0;
127 int blocking_io = -1;
128 int checksum_seed = 0;
130 int delay_updates = 0;
131 long block_size = 0; /* "long" because popt can't set an int32. */
132 char *skip_compress = NULL;
133 char *copy_as = NULL;
134 item_list dparam_list = EMPTY_ITEM_LIST;
136 /** Network address family. **/
139 = 0; /* Any protocol */
141 = AF_INET; /* Must use IPv4 */
145 # define AF_INET6 AF_INET /* make -6 option a no-op */
148 /** Do not go into the background when run as --daemon. Good
149 * for debugging and required for running as a service on W32,
150 * or under Unix process-monitors. **/
152 #if defined _WIN32 || defined __WIN32__
160 int backup_dir_len = 0;
161 int backup_suffix_len;
162 unsigned int backup_dir_remainder;
164 char *backup_suffix = NULL;
166 char *partial_dir = NULL;
167 char *basis_dir[MAX_BASIS_DIRS+1];
168 char *config_file = NULL;
169 char *shell_cmd = NULL;
170 char *logfile_name = NULL;
171 char *logfile_format = NULL;
172 char *stdout_format = NULL;
173 char *password_file = NULL;
174 char *rsync_path = RSYNC_PATH;
175 char *backup_dir = NULL;
176 char backup_dir_buf[MAXPATHLEN];
177 char *sockopts = NULL;
178 char *usermap = NULL;
179 char *groupmap = NULL;
181 int compare_dest = 0;
184 int basis_dir_cnt = 0;
185 char *dest_option = NULL;
187 static int remote_option_alloc = 0;
188 int remote_option_cnt = 0;
189 const char **remote_options = NULL;
190 const char *checksum_choice = NULL;
191 const char *compress_choice = NULL;
195 int log_before_transfer = 0;
196 int stdout_format_has_i = 0;
197 int stdout_format_has_o_or_i = 0;
198 int logfile_format_has_i = 0;
199 int logfile_format_has_o_or_i = 0;
200 int always_checksum = 0;
203 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
204 char *batch_name = NULL;
206 int need_unsorted_flist = 0;
208 char *iconv_opt = ICONV_OPTION;
211 struct chmod_mode_struct *chmod_modes = NULL;
213 static const char *debug_verbosity[] = {
216 /*2*/ "BIND,CMD,CONNECT,DEL,DELTASUM,DUP,FILTER,FLIST,ICONV",
217 /*3*/ "ACL,BACKUP,CONNECT2,DELTASUM2,DEL2,EXIT,FILTER2,FLIST2,FUZZY,GENR,OWN,RECV,SEND,TIME",
218 /*4*/ "CMD2,DELTASUM3,DEL3,EXIT2,FLIST3,ICONV2,OWN2,PROTO,TIME2",
219 /*5*/ "CHDIR,DELTASUM4,FLIST4,FUZZY2,HASH,HLINK",
222 #define MAX_VERBOSITY ((int)(sizeof debug_verbosity / sizeof debug_verbosity[0]) - 1)
224 static const char *info_verbosity[1+MAX_VERBOSITY] = {
226 /*1*/ "COPY,DEL,FLIST,MISC,NAME,STATS,SYMSAFE",
227 /*2*/ "BACKUP,MISC2,MOUNT,NAME2,REMOVE,SKIP",
230 #define MAX_OUT_LEVEL 4 /* The largest N allowed for any flagN word. */
232 short info_levels[COUNT_INFO], debug_levels[COUNT_DEBUG];
234 #define DEFAULT_PRIORITY 0 /* Default/implied/--verbose set values. */
235 #define HELP_PRIORITY 1 /* The help output uses this level. */
236 #define USER_PRIORITY 2 /* User-specified via --info or --debug */
237 #define LIMIT_PRIORITY 3 /* Overriding priority when limiting values. */
239 #define W_CLI (1<<0) /* client side */
240 #define W_SRV (1<<1) /* server side */
241 #define W_SND (1<<2) /* sending side */
242 #define W_REC (1<<3) /* receiving side */
244 struct output_struct {
245 char *name; /* The name of the info/debug flag. */
246 char *help; /* The description of the info/debug flag. */
247 uchar namelen; /* The length of the name string. */
248 uchar flag; /* The flag's value, for consistency check. */
249 uchar where; /* Bits indicating where the flag is used. */
250 uchar priority; /* See *_PRIORITY defines. */
253 #define INFO_WORD(flag, where, help) { #flag, help, sizeof #flag - 1, INFO_##flag, where, 0 }
255 static struct output_struct info_words[COUNT_INFO+1] = {
256 INFO_WORD(BACKUP, W_REC, "Mention files backed up"),
257 INFO_WORD(COPY, W_REC, "Mention files copied locally on the receiving side"),
258 INFO_WORD(DEL, W_REC, "Mention deletions on the receiving side"),
259 INFO_WORD(FLIST, W_CLI, "Mention file-list receiving/sending (levels 1-2)"),
260 INFO_WORD(MISC, W_SND|W_REC, "Mention miscellaneous information (levels 1-2)"),
261 INFO_WORD(MOUNT, W_SND|W_REC, "Mention mounts that were found or skipped"),
262 INFO_WORD(NAME, W_SND|W_REC, "Mention 1) updated file/dir names, 2) unchanged names"),
263 INFO_WORD(PROGRESS, W_CLI, "Mention 1) per-file progress or 2) total transfer progress"),
264 INFO_WORD(REMOVE, W_SND, "Mention files removed on the sending side"),
265 INFO_WORD(SKIP, W_REC, "Mention files that are skipped due to options used"),
266 INFO_WORD(STATS, W_CLI|W_SRV, "Mention statistics at end of run (levels 1-3)"),
267 INFO_WORD(SYMSAFE, W_SND|W_REC, "Mention symlinks that are unsafe"),
268 { NULL, "--info", 0, 0, 0, 0 }
271 #define DEBUG_WORD(flag, where, help) { #flag, help, sizeof #flag - 1, DEBUG_##flag, where, 0 }
273 static struct output_struct debug_words[COUNT_DEBUG+1] = {
274 DEBUG_WORD(ACL, W_SND|W_REC, "Debug extra ACL info"),
275 DEBUG_WORD(BACKUP, W_REC, "Debug backup actions (levels 1-2)"),
276 DEBUG_WORD(BIND, W_CLI, "Debug socket bind actions"),
277 DEBUG_WORD(CHDIR, W_CLI|W_SRV, "Debug when the current directory changes"),
278 DEBUG_WORD(CONNECT, W_CLI, "Debug connection events (levels 1-2)"),
279 DEBUG_WORD(CMD, W_CLI, "Debug commands+options that are issued (levels 1-2)"),
280 DEBUG_WORD(DEL, W_REC, "Debug delete actions (levels 1-3)"),
281 DEBUG_WORD(DELTASUM, W_SND|W_REC, "Debug delta-transfer checksumming (levels 1-4)"),
282 DEBUG_WORD(DUP, W_REC, "Debug weeding of duplicate names"),
283 DEBUG_WORD(EXIT, W_CLI|W_SRV, "Debug exit events (levels 1-3)"),
284 DEBUG_WORD(FILTER, W_SND|W_REC, "Debug filter actions (levels 1-2)"),
285 DEBUG_WORD(FLIST, W_SND|W_REC, "Debug file-list operations (levels 1-4)"),
286 DEBUG_WORD(FUZZY, W_REC, "Debug fuzzy scoring (levels 1-2)"),
287 DEBUG_WORD(GENR, W_REC, "Debug generator functions"),
288 DEBUG_WORD(HASH, W_SND|W_REC, "Debug hashtable code"),
289 DEBUG_WORD(HLINK, W_SND|W_REC, "Debug hard-link actions (levels 1-3)"),
290 DEBUG_WORD(ICONV, W_CLI|W_SRV, "Debug iconv character conversions (levels 1-2)"),
291 DEBUG_WORD(IO, W_CLI|W_SRV, "Debug I/O routines (levels 1-4)"),
292 DEBUG_WORD(NSTR, W_CLI|W_SRV, "Debug negotiation strings"),
293 DEBUG_WORD(OWN, W_REC, "Debug ownership changes in users & groups (levels 1-2)"),
294 DEBUG_WORD(PROTO, W_CLI|W_SRV, "Debug protocol information"),
295 DEBUG_WORD(RECV, W_REC, "Debug receiver functions"),
296 DEBUG_WORD(SEND, W_SND, "Debug sender functions"),
297 DEBUG_WORD(TIME, W_REC, "Debug setting of modified times (levels 1-2)"),
298 { NULL, "--debug", 0, 0, 0, 0 }
301 static int verbose = 0;
302 static int do_stats = 0;
303 static int do_progress = 0;
304 static int daemon_opt; /* sets am_daemon after option error-reporting */
305 static int omit_dir_times = 0;
306 static int omit_link_times = 0;
307 static int F_option_cnt = 0;
308 static int modify_window_set;
309 static int itemize_changes = 0;
310 static int refused_delete, refused_archive_part, refused_compress;
311 static int refused_partial, refused_progress, refused_delete_before;
312 static int refused_delete_during;
313 static int refused_inplace, refused_no_iconv;
314 static BOOL usermap_via_chown, groupmap_via_chown;
316 static char *outbuf_mode;
318 static char *bwlimit_arg, *max_size_arg, *min_size_arg;
319 static char tmp_partialdir[] = ".~tmp~";
321 /** Local address to bind. As a character string because it's
322 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
323 * address, or a hostname. **/
326 static void output_item_help(struct output_struct *words);
328 /* This constructs a string that represents all the options set for either
329 * the --info or --debug setting, skipping any implied options (by -v, etc.).
330 * This is used both when conveying the user's options to the server, and
331 * when the help output wants to tell the user what options are implied. */
332 static char *make_output_option(struct output_struct *words, short *levels, uchar where)
334 char *str = words == info_words ? "--info=" : "--debug=";
335 int j, counts[MAX_OUT_LEVEL+1], pos, skipped = 0, len = 0, max = 0, lev = 0;
336 int word_count = words == info_words ? COUNT_INFO : COUNT_DEBUG;
339 memset(counts, 0, sizeof counts);
341 for (j = 0; words[j].name; j++) {
342 if (words[j].flag != j) {
343 rprintf(FERROR, "rsync: internal error on %s%s: %d != %d\n",
344 words == info_words ? "INFO_" : "DEBUG_",
345 words[j].name, words[j].flag, j);
346 exit_cleanup(RERR_UNSUPPORTED);
348 if (!(words[j].where & where))
350 if (words[j].priority == DEFAULT_PRIORITY) {
351 /* Implied items don't need to be mentioned. */
355 len += len ? 1 : strlen(str);
356 len += strlen(words[j].name);
357 len += levels[j] == 1 ? 0 : 1;
359 if (words[j].priority == HELP_PRIORITY)
360 continue; /* no abbreviating for help */
362 assert(levels[j] <= MAX_OUT_LEVEL);
363 if (++counts[levels[j]] > max) {
364 /* Determine which level has the most items. */
370 /* Sanity check the COUNT_* define against the length of the table. */
371 if (j != word_count) {
372 rprintf(FERROR, "rsync: internal error: %s is wrong! (%d != %d)\n",
373 words == info_words ? "COUNT_INFO" : "COUNT_DEBUG",
375 exit_cleanup(RERR_UNSUPPORTED);
382 if (!(buf = new_array(char, len)))
383 out_of_memory("make_output_option");
386 if (skipped || max < 5)
390 pos += snprintf(buf, len, "%sNONE", str);
392 pos += snprintf(buf, len, "%sALL", str);
394 pos += snprintf(buf, len, "%sALL%d", str, lev);
397 for (j = 0; words[j].name && pos < len; j++) {
398 if (words[j].priority == DEFAULT_PRIORITY || levels[j] == lev || !(words[j].where & where))
403 pos += strlcpy(buf+pos, str, len-pos);
405 pos += strlcpy(buf+pos, words[j].name, len-pos);
406 /* Level 1 is implied by the name alone. */
407 if (levels[j] != 1 && pos < len)
408 buf[pos++] = '0' + levels[j];
416 static void parse_output_words(struct output_struct *words, short *levels,
417 const char *str, uchar priority)
422 for ( ; str; str = s) {
423 if ((s = strchr(str, ',')) != NULL)
430 while (len && isDigit(str+len-1))
433 lev = isDigit(str+len) ? atoi(str+len) : 1;
434 if (lev > MAX_OUT_LEVEL)
436 if (len == 4 && strncasecmp(str, "help", 4) == 0) {
437 output_item_help(words);
440 if (len == 4 && strncasecmp(str, "none", 4) == 0)
442 else if (len == 3 && strncasecmp(str, "all", 3) == 0)
444 for (j = 0; words[j].name; j++) {
446 || (len == words[j].namelen && strncasecmp(str, words[j].name, len) == 0)) {
447 if (priority >= words[j].priority) {
448 words[j].priority = priority;
455 if (len && !words[j].name && !am_server) {
456 rprintf(FERROR, "Unknown %s item: \"%.*s\"\n",
457 words[j].help, len, str);
458 exit_cleanup(RERR_SYNTAX);
463 /* Tell the user what all the info or debug flags mean. */
464 static void output_item_help(struct output_struct *words)
466 short *levels = words == info_words ? info_levels : debug_levels;
467 const char **verbosity = words == info_words ? info_verbosity : debug_verbosity;
468 char buf[128], *opt, *fmt = "%-10s %s\n";
471 reset_output_levels();
473 rprintf(FINFO, "Use OPT or OPT1 for level 1 output, OPT2 for level 2, etc.; OPT0 silences.\n");
474 rprintf(FINFO, "\n");
475 for (j = 0; words[j].name; j++)
476 rprintf(FINFO, fmt, words[j].name, words[j].help);
477 rprintf(FINFO, "\n");
479 snprintf(buf, sizeof buf, "Set all %s options (e.g. all%d)",
480 words[j].help, MAX_OUT_LEVEL);
481 rprintf(FINFO, fmt, "ALL", buf);
483 snprintf(buf, sizeof buf, "Silence all %s options (same as all0)",
485 rprintf(FINFO, fmt, "NONE", buf);
487 rprintf(FINFO, fmt, "HELP", "Output this help message");
488 rprintf(FINFO, "\n");
489 rprintf(FINFO, "Options added for each increase in verbose level:\n");
491 for (j = 1; j <= MAX_VERBOSITY; j++) {
492 parse_output_words(words, levels, verbosity[j], HELP_PRIORITY);
493 opt = make_output_option(words, levels, W_CLI|W_SRV|W_SND|W_REC);
495 rprintf(FINFO, "%d) %s\n", j, strchr(opt, '=')+1);
498 reset_output_levels();
502 /* The --verbose option now sets info+debug flags. */
503 static void set_output_verbosity(int level, uchar priority)
507 if (level > MAX_VERBOSITY)
508 level = MAX_VERBOSITY;
510 for (j = 1; j <= level; j++) {
511 parse_output_words(info_words, info_levels, info_verbosity[j], priority);
512 parse_output_words(debug_words, debug_levels, debug_verbosity[j], priority);
516 /* Limit the info+debug flag levels given a verbose-option level limit. */
517 void limit_output_verbosity(int level)
519 short info_limits[COUNT_INFO], debug_limits[COUNT_DEBUG];
522 if (level > MAX_VERBOSITY)
525 memset(info_limits, 0, sizeof info_limits);
526 memset(debug_limits, 0, sizeof debug_limits);
528 /* Compute the level limits in the above arrays. */
529 for (j = 1; j <= level; j++) {
530 parse_output_words(info_words, info_limits, info_verbosity[j], LIMIT_PRIORITY);
531 parse_output_words(debug_words, debug_limits, debug_verbosity[j], LIMIT_PRIORITY);
534 for (j = 0; j < COUNT_INFO; j++) {
535 if (info_levels[j] > info_limits[j])
536 info_levels[j] = info_limits[j];
539 for (j = 0; j < COUNT_DEBUG; j++) {
540 if (debug_levels[j] > debug_limits[j])
541 debug_levels[j] = debug_limits[j];
545 void reset_output_levels(void)
549 memset(info_levels, 0, sizeof info_levels);
550 memset(debug_levels, 0, sizeof debug_levels);
552 for (j = 0; j < COUNT_INFO; j++)
553 info_words[j].priority = DEFAULT_PRIORITY;
555 for (j = 0; j < COUNT_DEBUG; j++)
556 debug_words[j].priority = DEFAULT_PRIORITY;
559 void negate_output_levels(void)
563 for (j = 0; j < COUNT_INFO; j++)
564 info_levels[j] *= -1;
566 for (j = 0; j < COUNT_DEBUG; j++)
567 debug_levels[j] *= -1;
570 static void print_rsync_version(enum logcode f)
572 char *subprotocol = "";
573 char const *got_socketpair = "no ";
574 char const *have_inplace = "no ";
575 char const *hardlinks = "no ";
576 char const *prealloc = "no ";
577 char const *symtimes = "no ";
578 char const *acls = "no ";
579 char const *xattrs = "no ";
580 char const *links = "no ";
581 char const *iconv = "no ";
582 char const *ipv6 = "no ";
583 char const *simd = "no ";
584 char const *xxhash = "no ";
585 STRUCT_STAT *dumstat;
587 #if SUBPROTOCOL_VERSION != 0
588 if (asprintf(&subprotocol, ".PR%d", SUBPROTOCOL_VERSION) < 0)
589 out_of_memory("print_rsync_version");
591 #ifdef HAVE_SOCKETPAIR
594 #ifdef HAVE_FTRUNCATE
597 #ifdef SUPPORT_HARD_LINKS
600 #ifdef SUPPORT_PREALLOCATION
606 #ifdef SUPPORT_XATTRS
618 #ifdef CAN_SET_SYMLINK_TIMES
624 #ifdef SUPPORT_XXHASH
628 rprintf(f, "%s version %s protocol version %d%s\n",
629 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION, subprotocol);
630 rprintf(f, "Copyright (C) 1996-" LATEST_YEAR " by Andrew Tridgell, Wayne Davison, and others.\n");
631 rprintf(f, "Web site: http://rsync.samba.org/\n");
632 rprintf(f, "Capabilities:\n");
633 rprintf(f, " %d-bit files, %d-bit inums, %d-bit timestamps, %d-bit long ints,\n",
634 (int)(sizeof (OFF_T) * 8),
635 (int)(sizeof dumstat->st_ino * 8), /* Don't check ino_t! */
636 (int)(sizeof (time_t) * 8),
637 (int)(sizeof (int64) * 8));
638 rprintf(f, " %ssocketpairs, %shardlinks, %ssymlinks, %sIPv6, batchfiles, %sinplace,\n",
639 got_socketpair, hardlinks, links, ipv6, have_inplace);
640 rprintf(f, " %sappend, %sACLs, %sxattrs, %siconv, %ssymtimes, %sprealloc, %sSIMD, %sxxhash\n",
641 have_inplace, acls, xattrs, iconv, symtimes, prealloc, simd, xxhash);
643 #ifdef MAINTAINER_MODE
644 rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
648 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
650 if (sizeof (int64) != SIZEOF_INT64) {
652 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
653 (int) SIZEOF_INT64, (int) sizeof (int64));
657 rprintf(f,"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n");
658 rprintf(f,"are welcome to redistribute it under certain conditions. See the GNU\n");
659 rprintf(f,"General Public Licence for details.\n");
663 void usage(enum logcode F)
665 print_rsync_version(F);
668 rprintf(F,"rsync is a file transfer program capable of efficient remote update\n");
669 rprintf(F,"via a fast differencing algorithm.\n");
672 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... DEST\n");
673 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
674 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
675 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
676 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC [DEST]\n");
677 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
678 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
679 rprintf(F,"The ':' usages connect via remote shell, while '::' & 'rsync://' usages connect\n");
680 rprintf(F,"to an rsync daemon, and require SRC or DEST to start with a module name.\n");
682 rprintf(F,"Options\n");
683 rprintf(F," -v, --verbose increase verbosity\n");
684 rprintf(F," --info=FLAGS fine-grained informational verbosity\n");
685 rprintf(F," --debug=FLAGS fine-grained debug verbosity\n");
686 rprintf(F," --msgs2stderr special output handling for debugging\n");
687 rprintf(F," -q, --quiet suppress non-error messages\n");
688 rprintf(F," --no-motd suppress daemon-mode MOTD (see manpage caveat)\n");
689 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
690 rprintf(F," -a, --archive archive mode; equals -rlptgoD (no -H,-A,-X)\n");
691 rprintf(F," --no-OPTION turn off an implied OPTION (e.g. --no-D)\n");
692 rprintf(F," -r, --recursive recurse into directories\n");
693 rprintf(F," -R, --relative use relative path names\n");
694 rprintf(F," --no-implied-dirs don't send implied dirs with --relative\n");
695 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
696 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
697 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
698 rprintf(F," -u, --update skip files that are newer on the receiver\n");
699 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
700 rprintf(F," --append append data onto shorter files\n");
701 rprintf(F," --append-verify like --append, but with old data in file checksum\n");
702 rprintf(F," -d, --dirs transfer directories without recursing\n");
703 rprintf(F," -l, --links copy symlinks as symlinks\n");
704 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
705 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
706 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
707 rprintf(F," --munge-links munge symlinks to make them safer (but unusable)\n");
708 rprintf(F," -k, --copy-dirlinks transform symlink to a dir into referent dir\n");
709 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
710 rprintf(F," -H, --hard-links preserve hard links\n");
711 rprintf(F," -p, --perms preserve permissions\n");
712 rprintf(F," -E, --executability preserve the file's executability\n");
713 rprintf(F," --chmod=CHMOD affect file and/or directory permissions\n");
715 rprintf(F," -A, --acls preserve ACLs (implies --perms)\n");
717 #ifdef SUPPORT_XATTRS
718 rprintf(F," -X, --xattrs preserve extended attributes\n");
720 rprintf(F," -o, --owner preserve owner (super-user only)\n");
721 rprintf(F," -g, --group preserve group\n");
722 rprintf(F," --devices preserve device files (super-user only)\n");
723 rprintf(F," --specials preserve special files\n");
724 rprintf(F," -D same as --devices --specials\n");
725 rprintf(F," -t, --times preserve modification times\n");
726 rprintf(F," -U, --atimes preserve access (last-used) times\n");
727 rprintf(F," --open-noatime avoid changing the atime on opened files\n");
728 rprintf(F," -O, --omit-dir-times omit directories from --times\n");
729 rprintf(F," -J, --omit-link-times omit symlinks from --times\n");
730 rprintf(F," --super receiver attempts super-user activities\n");
731 #ifdef SUPPORT_XATTRS
732 rprintf(F," --fake-super store/recover privileged attrs using xattrs\n");
734 rprintf(F," -S, --sparse turn sequences of nulls into sparse blocks\n");
735 #ifdef SUPPORT_PREALLOCATION
736 rprintf(F," --preallocate allocate dest files before writing them\n");
738 rprintf(F," --preallocate pre-allocate dest files on remote receiver\n");
740 rprintf(F," --write-devices write to devices as files (implies --inplace)\n");
741 rprintf(F," -n, --dry-run perform a trial run with no changes made\n");
742 rprintf(F," -W, --whole-file copy files whole (without delta-xfer algorithm)\n");
743 rprintf(F," --checksum-choice=STR choose the checksum algorithms\n");
744 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
745 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
746 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
747 rprintf(F," --rsync-path=PROGRAM specify the rsync to run on the remote machine\n");
748 rprintf(F," --existing skip creating new files on receiver\n");
749 rprintf(F," --ignore-existing skip updating files that already exist on receiver\n");
750 rprintf(F," --remove-source-files sender removes synchronized files (non-dirs)\n");
751 rprintf(F," --del an alias for --delete-during\n");
752 rprintf(F," --delete delete extraneous files from destination dirs\n");
753 rprintf(F," --delete-before receiver deletes before transfer, not during\n");
754 rprintf(F," --delete-during receiver deletes during the transfer\n");
755 rprintf(F," --delete-delay find deletions during, delete after\n");
756 rprintf(F," --delete-after receiver deletes after transfer, not during\n");
757 rprintf(F," --delete-excluded also delete excluded files from destination dirs\n");
758 rprintf(F," --ignore-missing-args ignore missing source args without error\n");
759 rprintf(F," --delete-missing-args delete missing source args from destination\n");
760 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
761 rprintf(F," --force force deletion of directories even if not empty\n");
762 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
763 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
764 rprintf(F," --min-size=SIZE don't transfer any file smaller than SIZE\n");
765 rprintf(F," --partial keep partially transferred files\n");
766 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
767 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
768 rprintf(F," -m, --prune-empty-dirs prune empty directory chains from the file-list\n");
769 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
770 rprintf(F," --usermap=STRING custom username mapping\n");
771 rprintf(F," --groupmap=STRING custom groupname mapping\n");
772 rprintf(F," --chown=USER:GROUP simple username/groupname mapping\n");
773 rprintf(F," --timeout=SECONDS set I/O timeout in seconds\n");
774 rprintf(F," --contimeout=SECONDS set daemon connection timeout in seconds\n");
775 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
776 rprintf(F," -M, --remote-option=OPTION send OPTION to the remote side only\n");
777 rprintf(F," --size-only skip files that match in size\n");
778 rprintf(F," -@, --modify-window=NUM set the accuracy for mod-time comparisons\n");
779 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
780 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
781 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
782 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
783 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
784 rprintf(F," -z, --compress compress file data during the transfer\n");
785 rprintf(F," --compress-level=NUM explicitly set compression level\n");
786 rprintf(F," --skip-compress=LIST skip compressing files with a suffix in LIST\n");
787 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
788 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
789 rprintf(F," -F same as --filter='dir-merge /.rsync-filter'\n");
790 rprintf(F," repeated: --filter='- .rsync-filter'\n");
791 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
792 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
793 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
794 rprintf(F," --include-from=FILE read include patterns from FILE\n");
795 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
796 rprintf(F," -0, --from0 all *-from/filter files are delimited by 0s\n");
797 rprintf(F," -s, --protect-args no space-splitting; only wildcard special-chars\n");
798 rprintf(F," --copy-as=USER[:GROUP] specify user & optional group for the copy\n");
799 rprintf(F," --address=ADDRESS bind address for outgoing socket to daemon\n");
800 rprintf(F," --port=PORT specify double-colon alternate port number\n");
801 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
802 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
803 rprintf(F," --stats give some file-transfer stats\n");
804 rprintf(F," -8, --8-bit-output leave high-bit chars unescaped in output\n");
805 rprintf(F," -h, --human-readable output numbers in a human-readable format\n");
806 rprintf(F," --progress show progress during transfer\n");
807 rprintf(F," -P same as --partial --progress\n");
808 rprintf(F," -i, --itemize-changes output a change-summary for all updates\n");
809 rprintf(F," --out-format=FORMAT output updates using the specified FORMAT\n");
810 rprintf(F," --log-file=FILE log what we're doing to the specified FILE\n");
811 rprintf(F," --log-file-format=FMT log updates using the specified FMT\n");
812 rprintf(F," --password-file=FILE read daemon-access password from FILE\n");
813 rprintf(F," --list-only list the files instead of copying them\n");
814 rprintf(F," --bwlimit=RATE limit socket I/O bandwidth\n");
816 rprintf(F," --outbuf=N|L|B set output buffering to None, Line, or Block\n");
818 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
819 rprintf(F," --only-write-batch=FILE like --write-batch but w/o updating destination\n");
820 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
821 rprintf(F," --protocol=NUM force an older protocol version to be used\n");
823 rprintf(F," --iconv=CONVERT_SPEC request charset conversion of filenames\n");
825 rprintf(F," --checksum-seed=NUM set block/file checksum seed (advanced)\n");
826 rprintf(F," -4, --ipv4 prefer IPv4\n");
827 rprintf(F," -6, --ipv6 prefer IPv6\n");
828 rprintf(F," --version print version number\n");
829 rprintf(F,"(-h) --help show this help (-h is --help only if used alone)\n");
832 rprintf(F,"Use \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
833 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
834 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
837 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
838 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST, OPT_HELP,
839 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW, OPT_MIN_SIZE, OPT_CHMOD,
840 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_ONLY_WRITE_BATCH, OPT_MAX_SIZE,
841 OPT_NO_D, OPT_APPEND, OPT_NO_ICONV, OPT_INFO, OPT_DEBUG,
842 OPT_USERMAP, OPT_GROUPMAP, OPT_CHOWN, OPT_BWLIMIT,
843 OPT_OLD_COMPRESS, OPT_NEW_COMPRESS, OPT_NO_COMPRESS,
844 OPT_SERVER, OPT_REFUSED_BASE = 9000};
846 static struct poptOption long_options[] = {
847 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
848 {"help", 0, POPT_ARG_NONE, 0, OPT_HELP, 0, 0 },
849 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
850 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
851 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
852 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
853 {"info", 0, POPT_ARG_STRING, 0, OPT_INFO, 0, 0 },
854 {"debug", 0, POPT_ARG_STRING, 0, OPT_DEBUG, 0, 0 },
855 {"msgs2stderr", 0, POPT_ARG_NONE, &msgs2stderr, 0, 0, 0 },
856 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
857 {"motd", 0, POPT_ARG_VAL, &output_motd, 1, 0, 0 },
858 {"no-motd", 0, POPT_ARG_VAL, &output_motd, 0, 0, 0 },
859 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
860 {"human-readable", 'h', POPT_ARG_NONE, 0, 'h', 0, 0},
861 {"no-human-readable",0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
862 {"no-h", 0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
863 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
864 {"archive", 'a', POPT_ARG_NONE, 0, 'a', 0, 0 },
865 {"recursive", 'r', POPT_ARG_VAL, &recurse, 2, 0, 0 },
866 {"no-recursive", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
867 {"no-r", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
868 {"inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
869 {"no-inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
870 {"i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
871 {"no-i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
872 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
873 {"no-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
874 {"no-d", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
875 {"old-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
876 {"old-d", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
877 {"perms", 'p', POPT_ARG_VAL, &preserve_perms, 1, 0, 0 },
878 {"no-perms", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
879 {"no-p", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
880 {"executability", 'E', POPT_ARG_NONE, &preserve_executability, 0, 0, 0 },
881 {"acls", 'A', POPT_ARG_NONE, 0, 'A', 0, 0 },
882 {"no-acls", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
883 {"no-A", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
884 {"xattrs", 'X', POPT_ARG_NONE, 0, 'X', 0, 0 },
885 {"no-xattrs", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
886 {"no-X", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
887 {"times", 't', POPT_ARG_VAL, &preserve_times, 1, 0, 0 },
888 {"no-times", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
889 {"no-t", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
890 {"atimes", 'U', POPT_ARG_NONE, 0, 'U', 0, 0 },
891 {"no-atimes", 0, POPT_ARG_VAL, &preserve_atimes, 0, 0, 0 },
892 {"no-U", 0, POPT_ARG_VAL, &preserve_atimes, 0, 0, 0 },
893 {"open-noatime", 0, POPT_ARG_VAL, &open_noatime, 1, 0, 0 },
894 {"no-open-noatime", 0, POPT_ARG_VAL, &open_noatime, 0, 0, 0 },
895 {"omit-dir-times", 'O', POPT_ARG_VAL, &omit_dir_times, 1, 0, 0 },
896 {"no-omit-dir-times",0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
897 {"no-O", 0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
898 {"omit-link-times", 'J', POPT_ARG_VAL, &omit_link_times, 1, 0, 0 },
899 {"no-omit-link-times",0, POPT_ARG_VAL, &omit_link_times, 0, 0, 0 },
900 {"no-J", 0, POPT_ARG_VAL, &omit_link_times, 0, 0, 0 },
901 {"modify-window", '@', POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
902 {"super", 0, POPT_ARG_VAL, &am_root, 2, 0, 0 },
903 {"no-super", 0, POPT_ARG_VAL, &am_root, 0, 0, 0 },
904 {"fake-super", 0, POPT_ARG_VAL, &am_root, -1, 0, 0 },
905 {"owner", 'o', POPT_ARG_VAL, &preserve_uid, 1, 0, 0 },
906 {"no-owner", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
907 {"no-o", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
908 {"group", 'g', POPT_ARG_VAL, &preserve_gid, 1, 0, 0 },
909 {"no-group", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
910 {"no-g", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
911 {0, 'D', POPT_ARG_NONE, 0, 'D', 0, 0 },
912 {"no-D", 0, POPT_ARG_NONE, 0, OPT_NO_D, 0, 0 },
913 {"devices", 0, POPT_ARG_VAL, &preserve_devices, 1, 0, 0 },
914 {"no-devices", 0, POPT_ARG_VAL, &preserve_devices, 0, 0, 0 },
915 {"write-devices", 0, POPT_ARG_VAL, &write_devices, 1, 0, 0 },
916 {"no-write-devices", 0, POPT_ARG_VAL, &write_devices, 0, 0, 0 },
917 {"specials", 0, POPT_ARG_VAL, &preserve_specials, 1, 0, 0 },
918 {"no-specials", 0, POPT_ARG_VAL, &preserve_specials, 0, 0, 0 },
919 {"links", 'l', POPT_ARG_VAL, &preserve_links, 1, 0, 0 },
920 {"no-links", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
921 {"no-l", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
922 {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 },
923 {"copy-unsafe-links",0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 },
924 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
925 {"munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 1, 0, 0 },
926 {"no-munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 0, 0, 0 },
927 {"copy-dirlinks", 'k', POPT_ARG_NONE, ©_dirlinks, 0, 0, 0 },
928 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
929 {"hard-links", 'H', POPT_ARG_NONE, 0, 'H', 0, 0 },
930 {"no-hard-links", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
931 {"no-H", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
932 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
933 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
934 {"no-R", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
935 {"implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
936 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
937 {"i-d", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
938 {"no-i-d", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
939 {"chmod", 0, POPT_ARG_STRING, 0, OPT_CHMOD, 0, 0 },
940 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
941 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
942 {"one-file-system", 'x', POPT_ARG_NONE, 0, 'x', 0, 0 },
943 {"no-one-file-system",0, POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
944 {"no-x", 0, POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
945 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
946 {"existing", 0, POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
947 {"ignore-non-existing",0,POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
948 {"ignore-existing", 0, POPT_ARG_NONE, &ignore_existing, 0, 0, 0 },
949 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
950 {"min-size", 0, POPT_ARG_STRING, &min_size_arg, OPT_MIN_SIZE, 0, 0 },
951 {"sparse", 'S', POPT_ARG_VAL, &sparse_files, 1, 0, 0 },
952 {"no-sparse", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
953 {"no-S", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
954 {"preallocate", 0, POPT_ARG_NONE, &preallocate_files, 0, 0, 0},
955 {"inplace", 0, POPT_ARG_VAL, &inplace, 1, 0, 0 },
956 {"no-inplace", 0, POPT_ARG_VAL, &inplace, 0, 0, 0 },
957 {"append", 0, POPT_ARG_NONE, 0, OPT_APPEND, 0, 0 },
958 {"append-verify", 0, POPT_ARG_VAL, &append_mode, 2, 0, 0 },
959 {"no-append", 0, POPT_ARG_VAL, &append_mode, 0, 0, 0 },
960 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
961 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
962 {"delete-before", 0, POPT_ARG_NONE, &delete_before, 0, 0, 0 },
963 {"delete-during", 0, POPT_ARG_VAL, &delete_during, 1, 0, 0 },
964 {"delete-delay", 0, POPT_ARG_VAL, &delete_during, 2, 0, 0 },
965 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
966 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
967 {"delete-missing-args",0,POPT_BIT_SET, &missing_args, 2, 0, 0 },
968 {"ignore-missing-args",0,POPT_BIT_SET, &missing_args, 1, 0, 0 },
969 {"remove-sent-files",0, POPT_ARG_VAL, &remove_source_files, 2, 0, 0 }, /* deprecated */
970 {"remove-source-files",0,POPT_ARG_VAL, &remove_source_files, 1, 0, 0 },
971 {"force", 0, POPT_ARG_VAL, &force_delete, 1, 0, 0 },
972 {"no-force", 0, POPT_ARG_VAL, &force_delete, 0, 0, 0 },
973 {"ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 1, 0, 0 },
974 {"no-ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 0, 0, 0 },
975 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
976 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
977 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
978 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
979 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
980 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
981 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
982 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
983 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
984 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
985 {"no-W", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
986 {"checksum", 'c', POPT_ARG_VAL, &always_checksum, 1, 0, 0 },
987 {"no-checksum", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
988 {"no-c", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
989 {"checksum-choice", 0, POPT_ARG_STRING, &checksum_choice, 0, 0, 0 },
990 {"cc", 0, POPT_ARG_STRING, &checksum_choice, 0, 0, 0 },
991 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
992 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
993 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
994 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
995 {"fuzzy", 'y', POPT_ARG_NONE, 0, 'y', 0, 0 },
996 {"no-fuzzy", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
997 {"no-y", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
998 {"compress", 'z', POPT_ARG_NONE, 0, 'z', 0, 0 },
999 {"old-compress", 0, POPT_ARG_NONE, 0, OPT_OLD_COMPRESS, 0, 0 },
1000 {"new-compress", 0, POPT_ARG_NONE, 0, OPT_NEW_COMPRESS, 0, 0 },
1001 {"no-compress", 0, POPT_ARG_NONE, 0, OPT_NO_COMPRESS, 0, 0 },
1002 {"no-z", 0, POPT_ARG_NONE, 0, OPT_NO_COMPRESS, 0, 0 },
1003 {"compress-choice", 0, POPT_ARG_STRING, &compress_choice, 0, 0, 0 },
1004 {"zz", 0, POPT_ARG_STRING, &compress_choice, 0, 0, 0 },
1005 {"skip-compress", 0, POPT_ARG_STRING, &skip_compress, 0, 0, 0 },
1006 {"compress-level", 0, POPT_ARG_INT, &def_compress_level, 0, 0, 0 },
1007 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
1008 {"progress", 0, POPT_ARG_VAL, &do_progress, 1, 0, 0 },
1009 {"no-progress", 0, POPT_ARG_VAL, &do_progress, 0, 0, 0 },
1010 {"partial", 0, POPT_ARG_VAL, &keep_partial, 1, 0, 0 },
1011 {"no-partial", 0, POPT_ARG_VAL, &keep_partial, 0, 0, 0 },
1012 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
1013 {"delay-updates", 0, POPT_ARG_VAL, &delay_updates, 1, 0, 0 },
1014 {"no-delay-updates", 0, POPT_ARG_VAL, &delay_updates, 0, 0, 0 },
1015 {"prune-empty-dirs",'m', POPT_ARG_VAL, &prune_empty_dirs, 1, 0, 0 },
1016 {"no-prune-empty-dirs",0,POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
1017 {"no-m", 0, POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
1018 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
1019 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
1020 {"out-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 },
1021 {"log-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 }, /* DEPRECATED */
1022 {"itemize-changes", 'i', POPT_ARG_NONE, 0, 'i', 0, 0 },
1023 {"no-itemize-changes",0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
1024 {"no-i", 0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
1025 {"bwlimit", 0, POPT_ARG_STRING, &bwlimit_arg, OPT_BWLIMIT, 0, 0 },
1026 {"no-bwlimit", 0, POPT_ARG_VAL, &bwlimit, 0, 0, 0 },
1027 {"backup", 'b', POPT_ARG_VAL, &make_backups, 1, 0, 0 },
1028 {"no-backup", 0, POPT_ARG_VAL, &make_backups, 0, 0, 0 },
1029 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
1030 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
1031 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
1032 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
1033 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
1034 {"only-write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_ONLY_WRITE_BATCH, 0, 0 },
1035 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
1036 {"from0", '0', POPT_ARG_VAL, &eol_nulls, 1, 0, 0},
1037 {"no-from0", 0, POPT_ARG_VAL, &eol_nulls, 0, 0, 0},
1038 {"protect-args", 's', POPT_ARG_VAL, &protect_args, 1, 0, 0},
1039 {"no-protect-args", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
1040 {"no-s", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
1041 {"numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 1, 0, 0 },
1042 {"no-numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 0, 0, 0 },
1043 {"usermap", 0, POPT_ARG_STRING, 0, OPT_USERMAP, 0, 0 },
1044 {"groupmap", 0, POPT_ARG_STRING, 0, OPT_GROUPMAP, 0, 0 },
1045 {"chown", 0, POPT_ARG_STRING, 0, OPT_CHOWN, 0, 0 },
1046 {"timeout", 0, POPT_ARG_INT, &io_timeout, 0, 0, 0 },
1047 {"no-timeout", 0, POPT_ARG_VAL, &io_timeout, 0, 0, 0 },
1048 {"contimeout", 0, POPT_ARG_INT, &connect_timeout, 0, 0, 0 },
1049 {"no-contimeout", 0, POPT_ARG_VAL, &connect_timeout, 0, 0, 0 },
1050 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
1051 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
1052 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
1054 {"iconv", 0, POPT_ARG_STRING, &iconv_opt, 0, 0, 0 },
1055 {"no-iconv", 0, POPT_ARG_NONE, 0, OPT_NO_ICONV, 0, 0 },
1057 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
1058 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
1059 {"8-bit-output", '8', POPT_ARG_VAL, &allow_8bit_chars, 1, 0, 0 },
1060 {"no-8-bit-output", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
1061 {"no-8", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
1062 {"qsort", 0, POPT_ARG_NONE, &use_qsort, 0, 0, 0 },
1063 {"copy-as", 0, POPT_ARG_STRING, ©_as, 0, 0, 0 },
1064 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
1065 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
1066 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
1067 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
1068 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
1069 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
1071 {"outbuf", 0, POPT_ARG_STRING, &outbuf_mode, 0, 0, 0 },
1073 {"remote-option", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
1074 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
1075 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
1076 {"server", 0, POPT_ARG_NONE, 0, OPT_SERVER, 0, 0 },
1077 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
1078 /* All the following options switch us into daemon-mode option-parsing. */
1079 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
1080 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1081 {"dparam", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
1082 {"detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1083 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1087 static void daemon_usage(enum logcode F)
1089 print_rsync_version(F);
1092 rprintf(F,"Usage: rsync --daemon [OPTION]...\n");
1093 rprintf(F," --address=ADDRESS bind to the specified address\n");
1094 rprintf(F," --bwlimit=RATE limit socket I/O bandwidth\n");
1095 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
1096 rprintf(F," -M, --dparam=OVERRIDE override global daemon config parameter\n");
1097 rprintf(F," --no-detach do not detach from the parent\n");
1098 rprintf(F," --port=PORT listen on alternate port number\n");
1099 rprintf(F," --log-file=FILE override the \"log file\" setting\n");
1100 rprintf(F," --log-file-format=FMT override the \"log format\" setting\n");
1101 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
1102 rprintf(F," -v, --verbose increase verbosity\n");
1103 rprintf(F," -4, --ipv4 prefer IPv4\n");
1104 rprintf(F," -6, --ipv6 prefer IPv6\n");
1105 rprintf(F," --help show this help screen\n");
1108 rprintf(F,"If you were not trying to invoke rsync as a daemon, avoid using any of the\n");
1109 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
1112 static struct poptOption long_daemon_options[] = {
1113 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1114 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
1115 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
1116 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
1117 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
1118 {"dparam", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
1119 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
1120 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
1121 {"detach", 0, POPT_ARG_VAL, &no_detach, 0, 0, 0 },
1122 {"no-detach", 0, POPT_ARG_VAL, &no_detach, 1, 0, 0 },
1123 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
1124 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
1125 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
1126 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
1127 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
1128 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
1129 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
1130 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
1131 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1132 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1133 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
1138 static char err_buf[200];
1142 * Store the option error message, if any, so that we can log the
1143 * connection attempt (which requires parsing the options), and then
1144 * show the error later on.
1146 void option_error(void)
1149 strlcpy(err_buf, "Error parsing options: option may "
1150 "be supported on client but not on server?\n",
1154 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
1155 io_flush(FULL_FLUSH);
1160 static void parse_one_refuse_match(int negated, const char *ref, const struct poptOption *list_end)
1162 struct poptOption *op;
1164 int is_wild = strpbrk(ref, "*?[") != NULL;
1165 int found_match = 0;
1167 shortName[1] = '\0';
1169 if (strcmp("a", ref) == 0 || strcmp("archive", ref) == 0) {
1170 ref = "[ardlptgoD]";
1174 for (op = long_options; op != list_end; op++) {
1175 *shortName = op->shortName;
1176 if ((op->longName && wildmatch(ref, op->longName))
1177 || (*shortName && wildmatch(ref, shortName))) {
1178 if (op->descrip[1] == '*')
1179 op->descrip = negated ? "a*" : "r*";
1181 op->descrip = negated ? "a=" : "r=";
1189 rprintf(FLOG, "No match for refuse-options string \"%s\"\n", ref);
1194 * Tweak the option table to disable all options that the rsyncd.conf
1195 * file has told us to refuse.
1197 static void set_refuse_options(void)
1199 struct poptOption *op, *list_end = NULL;
1200 char *cp, *ref = lp_refuse_options(module_id);
1206 if (!*ref && !am_daemon) /* A simple optimization */
1209 /* We abuse the descrip field in poptOption to make it easy to flag which options
1210 * are refused (since we don't use it otherwise). Start by marking all options
1211 * as "a"ccepted with a few options also marked as non-wild. */
1212 for (op = long_options; ; op++) {
1213 const char *longName = op->longName ? op->longName : "";
1214 if (!op->longName && !op->shortName) {
1218 if (op->shortName == 'e' /* Required for compatibility flags */
1219 || op->shortName == '0' /* --from0 just modifies --files-from, so refuse that instead (or not) */
1220 || op->shortName == 's' /* --protect-args is always OK */
1221 || op->shortName == 'n' /* --dry-run is always OK */
1222 || strcmp("iconv", longName) == 0
1223 || strcmp("no-iconv", longName) == 0
1224 || strcmp("checksum-seed", longName) == 0
1225 || strcmp("write-devices", longName) == 0 /* disable wild-match (it gets refused below) */
1226 || strcmp("log-format", longName) == 0 /* aka out-format (NOT log-file-format) */
1227 || strcmp("sender", longName) == 0
1228 || strcmp("server", longName) == 0)
1229 op->descrip = "a="; /* exact-match only */
1231 op->descrip = "a*"; /* wild-card-able */
1233 assert(list_end != NULL);
1235 if (am_daemon) /* Refused by default, but can be accepted via "!write-devices" */
1236 parse_one_refuse_match(0, "write-devices", list_end);
1239 while (*ref == ' ') ref++;
1242 if ((cp = strchr(ref, ' ')) != NULL)
1244 negated = *ref == '!';
1245 if (negated && ref[1])
1247 parse_one_refuse_match(negated, ref, list_end);
1256 if (!*lp_charset(module_id))
1257 parse_one_refuse_match(0, "iconv", list_end);
1259 parse_one_refuse_match(0, "log-file*", list_end);
1262 /* Now we use the descrip values to actually mark the options for refusal. */
1263 for (op = long_options; op != list_end; op++) {
1264 int refused = op->descrip[0] == 'r';
1268 if (op->argInfo == POPT_ARG_VAL)
1269 op->argInfo = POPT_ARG_NONE;
1270 op->val = (op - long_options) + OPT_REFUSED_BASE;
1271 /* The following flags are set to let us easily check an implied option later in the code. */
1272 switch (op->shortName) {
1273 case 'r': case 'd': case 'l': case 'p':
1274 case 't': case 'g': case 'o': case 'D':
1275 refused_archive_part = op->val;
1278 refused_compress = op->val;
1281 if (strcmp("delete", op->longName) == 0)
1282 refused_delete = op->val;
1283 else if (strcmp("delete-before", op->longName) == 0)
1284 refused_delete_before = op->val;
1285 else if (strcmp("delete-during", op->longName) == 0)
1286 refused_delete_during = op->val;
1287 else if (strcmp("partial", op->longName) == 0)
1288 refused_partial = op->val;
1289 else if (strcmp("progress", op->longName) == 0)
1290 refused_progress = op->val;
1291 else if (strcmp("inplace", op->longName) == 0)
1292 refused_inplace = op->val;
1293 else if (strcmp("no-iconv", op->longName) == 0)
1294 refused_no_iconv = op->val;
1301 static int count_args(const char **argv)
1306 while (argv[i] != NULL)
1314 static OFF_T parse_size_arg(char **size_arg, char def_suf)
1316 int reps, mult, make_compatible = 0;
1320 for (arg = *size_arg; isDigit(arg); arg++) {}
1322 for (arg++; isDigit(arg); arg++) {}
1323 switch (*arg && *arg != '+' && *arg != '-' ? *arg++ : def_suf) {
1339 if (*arg == 'b' || *arg == 'B')
1340 mult = 1000, make_compatible = 1, arg++;
1341 else if (!*arg || *arg == '+' || *arg == '-')
1343 else if (strncasecmp(arg, "ib", 2) == 0)
1344 mult = 1024, arg += 2;
1349 size *= atof(*size_arg);
1350 if ((*arg == '+' || *arg == '-') && arg[1] == '1')
1351 size += atoi(arg), make_compatible = 1, arg += 2;
1354 if (size > 0 && make_compatible && def_suf == 'b') {
1355 /* We convert this manually because we may need %lld precision,
1356 * and that's not a portable sprintf() escape. */
1357 char buf[128], *s = buf + sizeof buf - 1;
1361 *--s = (char)(num % 10) + '0';
1364 if (!(*size_arg = strdup(s)))
1365 out_of_memory("parse_size_arg");
1371 static void create_refuse_error(int which)
1373 /* The "which" value is the index + OPT_REFUSED_BASE. */
1374 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
1375 int n = snprintf(err_buf, sizeof err_buf,
1376 "The server is configured to refuse --%s\n",
1378 if (op->shortName) {
1379 snprintf(err_buf + n, sizeof err_buf - n,
1380 " (-%c)\n", op->shortName);
1384 /* This is used to make sure that --daemon & --server cannot be aliased to
1385 * something else. These options have always disabled popt aliases for the
1386 * parsing of a daemon or server command-line, but we have to make sure that
1387 * these options cannot vanish so that the alias disabling can take effect. */
1388 static void popt_unalias(poptContext con, const char *opt)
1390 struct poptAlias unalias;
1392 unalias.longName = opt + 2; /* point past the leading "--" */
1393 unalias.shortName = '\0';
1395 unalias.argv = new_array(const char*, 1);
1396 unalias.argv[0] = strdup(opt);
1398 poptAddAlias(con, unalias, 0);
1402 * Process command line arguments. Called on both local and remote.
1404 * @retval 1 if all options are OK; with globals set to appropriate
1407 * @retval 0 on error, with err_buf containing an explanation
1409 int parse_arguments(int *argc_p, const char ***argv_p)
1411 static poptContext pc;
1412 const char *arg, **argv = *argv_p;
1415 int orig_protect_args = protect_args;
1418 strlcpy(err_buf, "argc is zero!\n", sizeof err_buf);
1422 set_refuse_options();
1425 if (!am_daemon && protect_args <= 0 && (arg = getenv("RSYNC_ICONV")) != NULL && *arg)
1426 iconv_opt = strdup(arg);
1429 /* TODO: Call poptReadDefaultConfig; handle errors. */
1431 /* The context leaks in case of an error, but if there's a
1432 * problem we always exit anyhow. */
1434 poptFreeContext(pc);
1435 pc = poptGetContext(RSYNC_NAME, argc, argv, long_options, 0);
1437 poptReadDefaultConfig(pc, 0);
1438 popt_unalias(pc, "--daemon");
1439 popt_unalias(pc, "--server");
1442 while ((opt = poptGetNextOpt(pc)) != -1) {
1443 /* most options are handled automatically by popt;
1444 * only special cases are returned and listed here. */
1448 print_rsync_version(FINFO);
1453 /* Disable popt aliases on the server side and
1454 * then start parsing the options again. */
1455 poptFreeContext(pc);
1456 pc = poptGetContext(RSYNC_NAME, argc, argv,
1468 exit_cleanup(RERR_SYNTAX);
1476 "Attempt to hack rsync thwarted!\n",
1484 poptFreeContext(pc);
1485 pc = poptGetContext(RSYNC_NAME, argc, argv,
1486 long_daemon_options, 0);
1487 while ((opt = poptGetNextOpt(pc)) != -1) {
1491 daemon_usage(FINFO);
1495 arg = poptGetOptArg(pc);
1496 if (!strchr(arg, '=')) {
1498 "--dparam value is missing an '=': %s\n",
1502 cpp = EXPAND_ITEM_LIST(&dparam_list, char *, 4);
1512 "rsync: %s: %s (in daemon mode)\n",
1513 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1519 if (dparam_list.count && !set_dparams(1))
1520 exit_cleanup(RERR_SYNTAX);
1522 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
1523 snprintf(err_buf, sizeof err_buf,
1524 "the --temp-dir path is WAY too long.\n");
1529 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
1532 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
1533 exit_cleanup(RERR_SYNTAX);
1536 *argv_p = argv = poptGetArgs(pc);
1537 *argc_p = argc = count_args(argv);
1543 case OPT_MODIFY_WINDOW:
1544 /* The value has already been set by popt, but
1545 * we need to remember that we're using a
1546 * non-default setting. */
1547 modify_window_set = 1;
1551 parse_filter_str(&filter_list, poptGetOptArg(pc),
1552 rule_template(0), 0);
1556 parse_filter_str(&filter_list, poptGetOptArg(pc),
1557 rule_template(0), XFLG_OLD_PREFIXES);
1561 parse_filter_str(&filter_list, poptGetOptArg(pc),
1562 rule_template(FILTRULE_INCLUDE), XFLG_OLD_PREFIXES);
1565 case OPT_EXCLUDE_FROM:
1566 case OPT_INCLUDE_FROM:
1567 arg = poptGetOptArg(pc);
1569 arg = sanitize_path(NULL, arg, NULL, 0, SP_DEFAULT);
1570 if (daemon_filter_list.head) {
1572 char *cp = strdup(arg);
1574 out_of_memory("parse_arguments");
1578 char *dir = cp + (*cp == '/' ? module_dirlen : 0);
1579 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1580 rej = check_filter(&daemon_filter_list, FLOG, dir, 0) < 0;
1584 goto options_rejected;
1586 parse_filter_file(&filter_list, arg,
1587 rule_template(opt == OPT_INCLUDE_FROM ? FILTRULE_INCLUDE : 0),
1588 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
1592 if (refused_archive_part) {
1593 create_refuse_error(refused_archive_part);
1596 if (!recurse) /* preserve recurse == 2 */
1598 #ifdef SUPPORT_LINKS
1605 preserve_devices = 1;
1606 preserve_specials = 1;
1610 preserve_devices = preserve_specials = 1;
1614 preserve_devices = preserve_specials = 0;
1622 preserve_hard_links++;
1630 if (++preserve_atimes > 1)
1651 switch (++F_option_cnt) {
1653 parse_filter_str(&filter_list,": /.rsync-filter",rule_template(0),0);
1656 parse_filter_str(&filter_list,"- .rsync-filter",rule_template(0),0);
1662 if (refused_partial || refused_progress) {
1663 create_refuse_error(refused_partial
1664 ? refused_partial : refused_progress);
1675 case OPT_OLD_COMPRESS:
1676 compress_choice = "zlib";
1679 case OPT_NEW_COMPRESS:
1680 compress_choice = "zlibx";
1683 case OPT_NO_COMPRESS:
1685 compress_choice = NULL;
1689 arg = poptGetOptArg(pc);
1691 snprintf(err_buf, sizeof err_buf,
1692 "Remote option must start with a dash: %s\n", arg);
1695 if (remote_option_cnt+2 >= remote_option_alloc) {
1696 remote_option_alloc += 16;
1697 remote_options = realloc_array(remote_options,
1698 const char *, remote_option_alloc);
1699 if (!remote_options)
1700 out_of_memory("parse_arguments");
1701 if (!remote_option_cnt)
1702 remote_options[0] = "ARG0";
1704 remote_options[++remote_option_cnt] = arg;
1705 remote_options[remote_option_cnt+1] = NULL;
1708 case OPT_WRITE_BATCH:
1709 /* batch_name is already set */
1713 case OPT_ONLY_WRITE_BATCH:
1714 /* batch_name is already set */
1718 case OPT_READ_BATCH:
1719 /* batch_name is already set */
1730 if ((max_size = parse_size_arg(&max_size_arg, 'b')) < 0) {
1731 snprintf(err_buf, sizeof err_buf,
1732 "--max-size value is invalid: %s\n",
1739 if ((min_size = parse_size_arg(&min_size_arg, 'b')) < 0) {
1740 snprintf(err_buf, sizeof err_buf,
1741 "--min-size value is invalid: %s\n",
1749 OFF_T limit = parse_size_arg(&bwlimit_arg, 'K');
1751 snprintf(err_buf, sizeof err_buf,
1752 "--bwlimit value is invalid: %s\n", bwlimit_arg);
1755 bwlimit = (limit + 512) / 1024;
1756 if (limit && !bwlimit) {
1757 snprintf(err_buf, sizeof err_buf,
1758 "--bwlimit value is too small: %s\n", bwlimit_arg);
1772 #ifdef SUPPORT_HARD_LINKS
1774 dest_option = "--link-dest";
1777 snprintf(err_buf, sizeof err_buf,
1778 "hard links are not supported on this %s\n",
1779 am_server ? "server" : "client");
1785 dest_option = "--copy-dest";
1788 case OPT_COMPARE_DEST:
1790 dest_option = "--compare-dest";
1792 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
1793 snprintf(err_buf, sizeof err_buf,
1794 "ERROR: at most %d %s args may be specified\n",
1795 MAX_BASIS_DIRS, dest_option);
1798 /* We defer sanitizing this arg until we know what
1799 * our destination directory is going to be. */
1800 basis_dir[basis_dir_cnt++] = (char *)poptGetOptArg(pc);
1804 arg = poptGetOptArg(pc);
1805 if (!parse_chmod(arg, &chmod_modes)) {
1806 snprintf(err_buf, sizeof err_buf,
1807 "Invalid argument passed to --chmod (%s)\n",
1814 arg = poptGetOptArg(pc);
1815 parse_output_words(info_words, info_levels, arg, USER_PRIORITY);
1819 arg = poptGetOptArg(pc);
1820 parse_output_words(debug_words, debug_levels, arg, USER_PRIORITY);
1825 if (usermap_via_chown) {
1826 snprintf(err_buf, sizeof err_buf,
1827 "--usermap conflicts with prior --chown.\n");
1830 snprintf(err_buf, sizeof err_buf,
1831 "You can only specify --usermap once.\n");
1834 usermap = (char *)poptGetOptArg(pc);
1835 usermap_via_chown = False;
1840 if (groupmap_via_chown) {
1841 snprintf(err_buf, sizeof err_buf,
1842 "--groupmap conflicts with prior --chown.\n");
1845 snprintf(err_buf, sizeof err_buf,
1846 "You can only specify --groupmap once.\n");
1849 groupmap = (char *)poptGetOptArg(pc);
1850 groupmap_via_chown = False;
1854 const char *chown = poptGetOptArg(pc);
1856 if ((arg = strchr(chown, ':')) != NULL)
1857 len = arg++ - chown;
1859 len = strlen(chown);
1862 if (!usermap_via_chown) {
1863 snprintf(err_buf, sizeof err_buf,
1864 "--chown conflicts with prior --usermap.\n");
1867 snprintf(err_buf, sizeof err_buf,
1868 "You can only specify a user-affecting --chown once.\n");
1871 if (asprintf(&usermap, "*:%.*s", len, chown) < 0)
1872 out_of_memory("parse_arguments");
1873 usermap_via_chown = True;
1877 if (!groupmap_via_chown) {
1878 snprintf(err_buf, sizeof err_buf,
1879 "--chown conflicts with prior --groupmap.\n");
1882 snprintf(err_buf, sizeof err_buf,
1883 "You can only specify a group-affecting --chown once.\n");
1886 if (asprintf(&groupmap, "*:%s", arg) < 0)
1887 out_of_memory("parse_arguments");
1888 groupmap_via_chown = True;
1903 /* FIXME: this should probably be ignored with a
1904 * warning and then countermeasures taken to
1905 * restrict group and other access in the presence
1906 * of any more restrictive ACLs, but this is safe
1908 snprintf(err_buf,sizeof(err_buf),
1909 "ACLs are not supported on this %s\n",
1910 am_server ? "server" : "client");
1915 #ifdef SUPPORT_XATTRS
1919 snprintf(err_buf,sizeof(err_buf),
1920 "extended attributes are not supported on this %s\n",
1921 am_server ? "server" : "client");
1926 /* A large opt value means that set_refuse_options()
1927 * turned this option off. */
1928 if (opt >= OPT_REFUSED_BASE) {
1929 create_refuse_error(opt);
1932 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
1933 am_server ? "on remote machine: " : "",
1934 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1940 if (protect_args < 0) {
1943 else if ((arg = getenv("RSYNC_PROTECT_ARGS")) != NULL && *arg)
1944 protect_args = atoi(arg) ? 1 : 0;
1946 #ifdef RSYNC_USE_PROTECTED_ARGS
1954 if (checksum_choice && strcasecmp(checksum_choice, "auto") != 0 && strcasecmp(checksum_choice, "auto,auto") != 0) {
1955 /* Call this early to verify the args and figure out if we need to force
1956 * --whole-file. Note that the parse function will get called again later,
1957 * just in case an "auto" choice needs to know the protocol_version. */
1958 parse_checksum_choice(0);
1960 checksum_choice = NULL;
1962 if (human_readable > 1 && argc == 2 && !am_server) {
1963 /* Allow the old meaning of 'h' (--help) on its own. */
1968 if (!compress_choice && do_compression > 1)
1969 compress_choice = "zlibx";
1970 if (compress_choice && strcasecmp(compress_choice, "auto") != 0)
1971 parse_compress_choice(0); /* Twiddles do_compression and can possibly NULL-out compress_choice. */
1973 compress_choice = NULL;
1975 if (do_compression || def_compress_level != NOT_SPECIFIED) {
1976 if (def_compress_level == NOT_SPECIFIED)
1977 def_compress_level = Z_DEFAULT_COMPRESSION;
1978 else if (def_compress_level < Z_DEFAULT_COMPRESSION || def_compress_level > Z_BEST_COMPRESSION) {
1979 snprintf(err_buf, sizeof err_buf, "--compress-level value is invalid: %d\n",
1980 def_compress_level);
1982 } else if (def_compress_level == Z_NO_COMPRESSION) {
1984 compress_choice = NULL;
1985 } else if (!do_compression)
1986 do_compression = CPRES_ZLIB;
1987 if (do_compression && refused_compress) {
1988 create_refuse_error(refused_compress);
1994 if (outbuf_mode && !am_server) {
1995 int mode = *(uchar *)outbuf_mode;
1997 mode = toupper(mode);
1998 fflush(stdout); /* Just in case... */
2000 case 'N': /* None */
2001 case 'U': /* Unbuffered */
2004 case 'L': /* Line */
2007 case 'B': /* Block */
2008 case 'F': /* Full */
2012 snprintf(err_buf, sizeof err_buf,
2013 "Invalid --outbuf setting -- specify N, L, or B.\n");
2016 setvbuf(stdout, (char *)NULL, mode, 0);
2020 /* Make stderr line buffered for better sharing of the stream. */
2021 fflush(stderr); /* Just in case... */
2022 setvbuf(stderr, (char *)NULL, _IOLBF, 0);
2026 set_output_verbosity(verbose, DEFAULT_PRIORITY);
2029 parse_output_words(info_words, info_levels,
2030 verbose > 1 ? "stats3" : "stats2", DEFAULT_PRIORITY);
2034 if (iconv_opt && protect_args != 2) {
2035 if (!am_server && strcmp(iconv_opt, "-") == 0)
2038 need_unsorted_flist = 1;
2040 if (refused_no_iconv && !iconv_opt) {
2041 create_refuse_error(refused_no_iconv);
2046 if (fuzzy_basis > 1)
2047 fuzzy_basis = basis_dir_cnt + 1;
2049 /* Don't let the client reset protect_args if it was already processed */
2050 if (orig_protect_args == 2 && am_server)
2051 protect_args = orig_protect_args;
2053 if (protect_args == 1 && am_server)
2056 *argv_p = argv = poptGetArgs(pc);
2057 *argc_p = argc = count_args(argv);
2059 #ifndef SUPPORT_LINKS
2060 if (preserve_links && !am_sender) {
2061 snprintf(err_buf, sizeof err_buf,
2062 "symlinks are not supported on this %s\n",
2063 am_server ? "server" : "client");
2068 #ifndef SUPPORT_HARD_LINKS
2069 if (preserve_hard_links) {
2070 snprintf(err_buf, sizeof err_buf,
2071 "hard links are not supported on this %s\n",
2072 am_server ? "server" : "client");
2077 #ifdef SUPPORT_XATTRS
2078 if (am_root < 0 && preserve_xattrs > 1) {
2079 snprintf(err_buf, sizeof err_buf,
2080 "--fake-super conflicts with -XX\n");
2085 snprintf(err_buf, sizeof err_buf,
2086 "--fake-super requires an rsync with extended attributes enabled\n");
2092 /* We may not know the real protocol_version at this point if this is the client
2093 * option parsing, but we still want to check it so that the client can specify
2094 * a --protocol=29 option with a larger block size. */
2095 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
2097 if (block_size > max_blength) {
2098 snprintf(err_buf, sizeof err_buf,
2099 "--block-size=%lu is too large (max: %u)\n", block_size, max_blength);
2104 if (write_batch && read_batch) {
2105 snprintf(err_buf, sizeof err_buf,
2106 "--write-batch and --read-batch can not be used together\n");
2109 if (write_batch > 0 || read_batch) {
2112 "ignoring --%s-batch option sent to server\n",
2113 write_batch ? "write" : "read");
2114 /* We don't actually exit_cleanup(), so that we can
2115 * still service older version clients that still send
2116 * batch args to server. */
2117 read_batch = write_batch = 0;
2121 } else if (write_batch < 0 && dry_run)
2123 if (read_batch && files_from) {
2124 snprintf(err_buf, sizeof err_buf,
2125 "--read-batch cannot be used with --files-from\n");
2128 if (read_batch && remove_source_files) {
2129 snprintf(err_buf, sizeof err_buf,
2130 "--read-batch cannot be used with --remove-%s-files\n",
2131 remove_source_files == 1 ? "source" : "sent");
2134 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
2135 snprintf(err_buf, sizeof err_buf,
2136 "the batch-file name must be %d characters or less.\n",
2137 MAX_BATCH_NAME_LEN);
2141 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
2142 snprintf(err_buf, sizeof err_buf,
2143 "the --temp-dir path is WAY too long.\n");
2147 if (max_delete < 0 && max_delete != INT_MIN) {
2148 /* Negative numbers are treated as "no deletions". */
2152 if (compare_dest + copy_dest + link_dest > 1) {
2153 snprintf(err_buf, sizeof err_buf,
2154 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
2159 if (recurse == 1) /* preserve recurse == 2 */
2165 if (argc < 2 && !read_batch && !am_server)
2168 if (xfer_dirs >= 4) {
2169 parse_filter_str(&filter_list, "- /*/*", rule_template(0), 0);
2170 recurse = xfer_dirs = 1;
2173 else if (xfer_dirs < 0)
2174 xfer_dirs = list_only ? 1 : 0;
2176 if (relative_paths < 0)
2177 relative_paths = files_from? 1 : 0;
2178 if (!relative_paths)
2181 if (delete_before + !!delete_during + delete_after > 1) {
2182 snprintf(err_buf, sizeof err_buf,
2183 "You may not combine multiple --delete-WHEN options.\n");
2186 if (delete_before || delete_during || delete_after)
2188 else if (delete_mode || delete_excluded) {
2189 /* Only choose now between before & during if one is refused. */
2190 if (refused_delete_before) {
2191 if (!refused_delete_during)
2194 create_refuse_error(refused_delete_before);
2197 } else if (refused_delete_during)
2201 if (!xfer_dirs && delete_mode) {
2202 snprintf(err_buf, sizeof err_buf,
2203 "--delete does not work without --recursive (-r) or --dirs (-d).\n");
2207 if (missing_args == 3) /* simplify if both options were specified */
2209 if (refused_delete && (delete_mode || missing_args == 2)) {
2210 create_refuse_error(refused_delete);
2214 if (remove_source_files) {
2215 /* We only want to infer this refusal of --remove-source-files
2216 * via the refusal of "delete", not any of the "delete-FOO"
2218 if (refused_delete && am_sender) {
2219 create_refuse_error(refused_delete);
2222 need_messages_from_generator = 1;
2225 if (munge_symlinks && !am_daemon) {
2227 char prefix[SYMLINK_PREFIX_LEN]; /* NOT +1 ! */
2228 strlcpy(prefix, SYMLINK_PREFIX, sizeof prefix); /* trim the trailing slash */
2229 if (do_stat(prefix, &st) == 0 && S_ISDIR(st.st_mode)) {
2230 rprintf(FERROR, "Symlink munging is unsafe when a %s directory exists.\n",
2232 exit_cleanup(RERR_UNSUPPORTED);
2236 if (sanitize_paths) {
2238 for (i = argc; i-- > 0; )
2239 argv[i] = sanitize_path(NULL, argv[i], "", 0, SP_KEEP_DOT_DIRS);
2241 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0, SP_DEFAULT);
2243 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0, SP_DEFAULT);
2245 if (daemon_filter_list.head && !am_sender) {
2246 filter_rule_list *elp = &daemon_filter_list;
2250 goto options_rejected;
2251 dir = tmpdir + (*tmpdir == '/' ? module_dirlen : 0);
2252 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2253 if (check_filter(elp, FLOG, dir, 1) < 0)
2254 goto options_rejected;
2259 goto options_rejected;
2260 dir = backup_dir + (*backup_dir == '/' ? module_dirlen : 0);
2261 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2262 if (check_filter(elp, FLOG, dir, 1) < 0)
2263 goto options_rejected;
2268 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
2269 backup_suffix_len = strlen(backup_suffix);
2270 if (strchr(backup_suffix, '/') != NULL) {
2271 snprintf(err_buf, sizeof err_buf,
2272 "--suffix cannot contain slashes: %s\n",
2278 while (*backup_dir == '.' && backup_dir[1] == '/')
2280 if (*backup_dir == '.' && backup_dir[1] == '\0')
2282 len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
2283 if (len > sizeof backup_dir_buf - 128) {
2284 snprintf(err_buf, sizeof err_buf,
2285 "the --backup-dir path is WAY too long.\n");
2288 backup_dir_len = (int)len;
2289 if (!backup_dir_len) {
2290 backup_dir_len = -1;
2292 } else if (backup_dir_buf[backup_dir_len - 1] != '/') {
2293 backup_dir_buf[backup_dir_len++] = '/';
2294 backup_dir_buf[backup_dir_len] = '\0';
2296 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
2299 /* No need for a suffix or a protect rule. */
2300 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
2301 snprintf(err_buf, sizeof err_buf,
2302 "--suffix cannot be empty %s\n", backup_dir_len < 0
2303 ? "when --backup-dir is the same as the dest dir"
2304 : "without a --backup-dir");
2306 } else if (make_backups && delete_mode && !delete_excluded && !am_server) {
2307 snprintf(backup_dir_buf, sizeof backup_dir_buf,
2308 "P *%s", backup_suffix);
2309 parse_filter_str(&filter_list, backup_dir_buf, rule_template(0), 0);
2312 if (preserve_times) {
2313 preserve_times = PRESERVE_FILE_TIMES;
2314 if (!omit_dir_times)
2315 preserve_times |= PRESERVE_DIR_TIMES;
2316 #ifdef CAN_SET_SYMLINK_TIMES
2317 if (!omit_link_times)
2318 preserve_times |= PRESERVE_LINK_TIMES;
2322 if (make_backups && !backup_dir) {
2323 omit_dir_times = 0; /* Implied, so avoid -O to sender. */
2324 preserve_times &= ~PRESERVE_DIR_TIMES;
2327 if (stdout_format) {
2328 if (am_server && log_format_has(stdout_format, 'I'))
2329 stdout_format_has_i = 2;
2330 else if (log_format_has(stdout_format, 'i'))
2331 stdout_format_has_i = itemize_changes | 1;
2332 if (!log_format_has(stdout_format, 'b')
2333 && !log_format_has(stdout_format, 'c')
2334 && !log_format_has(stdout_format, 'C'))
2335 log_before_transfer = !am_server;
2336 } else if (itemize_changes) {
2337 stdout_format = "%i %n%L";
2338 stdout_format_has_i = itemize_changes;
2339 log_before_transfer = !am_server;
2342 if (do_progress && !am_server) {
2343 if (!log_before_transfer && INFO_EQ(NAME, 0))
2344 parse_output_words(info_words, info_levels, "name", DEFAULT_PRIORITY);
2345 parse_output_words(info_words, info_levels, "flist2,progress", DEFAULT_PRIORITY);
2351 set_io_timeout(io_timeout);
2353 if (INFO_GTE(NAME, 1) && !stdout_format) {
2354 stdout_format = "%n%L";
2355 log_before_transfer = !am_server;
2357 if (stdout_format_has_i || log_format_has(stdout_format, 'o'))
2358 stdout_format_has_o_or_i = 1;
2360 if (logfile_name && !am_daemon) {
2361 if (!logfile_format) {
2362 logfile_format = "%i %n%L";
2363 logfile_format_has_i = logfile_format_has_o_or_i = 1;
2365 if (log_format_has(logfile_format, 'i'))
2366 logfile_format_has_i = 1;
2367 if (logfile_format_has_i || log_format_has(logfile_format, 'o'))
2368 logfile_format_has_o_or_i = 1;
2371 } else if (!am_daemon)
2372 logfile_format = NULL;
2374 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
2375 bwlimit = daemon_bwlimit;
2377 bwlimit_writemax = (size_t)bwlimit * 128;
2378 if (bwlimit_writemax < 512)
2379 bwlimit_writemax = 512;
2383 if (whole_file > 0) {
2384 snprintf(err_buf, sizeof err_buf,
2385 "--append cannot be used with --whole-file\n");
2388 if (refused_inplace) {
2389 create_refuse_error(refused_inplace);
2395 if (write_devices) {
2396 if (refused_inplace) {
2397 create_refuse_error(refused_inplace);
2403 if (delay_updates && !partial_dir)
2404 partial_dir = tmp_partialdir;
2407 #ifdef HAVE_FTRUNCATE
2409 snprintf(err_buf, sizeof err_buf,
2410 "--%s cannot be used with --%s\n",
2411 append_mode ? "append" : "inplace",
2412 delay_updates ? "delay-updates" : "partial-dir");
2415 /* --inplace implies --partial for refusal purposes, but we
2416 * clear the keep_partial flag for internal logic purposes. */
2417 if (refused_partial) {
2418 create_refuse_error(refused_partial);
2423 snprintf(err_buf, sizeof err_buf,
2424 "--%s is not supported on this %s\n",
2425 append_mode ? "append" : "inplace",
2426 am_server ? "server" : "client");
2430 if (keep_partial && !partial_dir && !am_server) {
2431 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
2432 partial_dir = strdup(arg);
2436 clean_fname(partial_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2437 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
2439 if (!partial_dir && refused_partial) {
2440 create_refuse_error(refused_partial);
2450 if (argc > 2 || (!am_daemon && !am_server && argc == 1)) {
2452 exit_cleanup(RERR_SYNTAX);
2454 if (strcmp(files_from, "-") == 0) {
2457 filesfrom_host = ""; /* reading from socket */
2458 } else if ((p = check_for_hostspec(files_from, &h, &q)) != 0) {
2460 snprintf(err_buf, sizeof err_buf,
2461 "The --files-from sent to the server cannot specify a host.\n");
2466 if (strcmp(files_from, "-") == 0) {
2467 snprintf(err_buf, sizeof err_buf,
2468 "Invalid --files-from remote filename\n");
2473 files_from = sanitize_path(NULL, files_from, NULL, 0, SP_DEFAULT);
2474 if (daemon_filter_list.head) {
2477 goto options_rejected;
2478 dir = files_from + (*files_from == '/' ? module_dirlen : 0);
2479 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2480 if (check_filter(&daemon_filter_list, FLOG, dir, 0) < 0)
2481 goto options_rejected;
2483 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
2484 if (filesfrom_fd < 0) {
2485 snprintf(err_buf, sizeof err_buf,
2486 "failed to open files-from file %s: %s\n",
2487 files_from, strerror(errno));
2498 snprintf(err_buf, sizeof err_buf,
2499 "Your options have been rejected by the server.\n");
2505 * Construct a filtered list of options to pass through from the
2506 * client to the server.
2508 * This involves setting options that will tell the server how to
2509 * behave, and also filtering out options that are processed only
2512 void server_options(char **args, int *argc_p)
2514 static char argstr[64];
2520 /* This should always remain first on the server's command-line. */
2521 args[ac++] = "--server";
2523 if (daemon_over_rsh > 0) {
2524 args[ac++] = "--daemon";
2526 /* if we're passing --daemon, we're done */
2531 args[ac++] = "--sender";
2539 for (i = 0; i < verbose; i++)
2542 /* the -q option is intentionally left out */
2547 if (!do_xfers) /* Note: NOT "dry_run"! */
2551 if ((xfer_dirs >= 2 && xfer_dirs < 4)
2552 || (xfer_dirs && !recurse && (list_only || (delete_mode && am_sender))))
2557 if (prune_empty_dirs)
2561 if (omit_link_times)
2565 if (fuzzy_basis > 1)
2577 /* We don't need to send --no-whole-file, because it's the
2578 * default for remote transfers, and in any case old versions
2579 * of rsync will not understand it. */
2581 if (preserve_hard_links) {
2583 if (preserve_hard_links > 1)
2590 if (preserve_devices) /* ignore preserve_specials here */
2594 if (preserve_atimes) {
2596 if (preserve_atimes > 1)
2601 else if (preserve_executability && am_sender)
2607 #ifdef SUPPORT_XATTRS
2608 if (preserve_xattrs) {
2610 if (preserve_xattrs > 1)
2616 if (always_checksum)
2624 if (one_file_system) {
2626 if (one_file_system > 1)
2631 if (do_compression == CPRES_ZLIB)
2634 set_allow_inc_recurse();
2636 /* We don't really know the actual protocol_version at this point,
2637 * but checking the pre-negotiated value allows the user to use a
2638 * --protocol=29 override to avoid the use of this -eFLAGS opt. */
2639 if (protocol_version >= 30) {
2640 /* Use "eFlags" alias so that cull_options doesn't think that these are no-arg option letters. */
2641 #define eFlags argstr
2642 /* We make use of the -e option to let the server know about
2643 * any pre-release protocol version && some behavior flags. */
2645 #if SUBPROTOCOL_VERSION != 0
2646 if (protocol_version == PROTOCOL_VERSION) {
2647 x += snprintf(argstr+x, sizeof argstr - x,
2649 PROTOCOL_VERSION, SUBPROTOCOL_VERSION);
2653 if (allow_inc_recurse)
2655 #ifdef CAN_SET_SYMLINK_TIMES
2656 eFlags[x++] = 'L'; /* symlink time-setting support */
2659 eFlags[x++] = 's'; /* symlink iconv translation support */
2661 eFlags[x++] = 'f'; /* flist I/O-error safety support */
2662 eFlags[x++] = 'x'; /* xattr hardlink optimization not desired */
2663 eFlags[x++] = 'C'; /* support checksum seed order fix */
2664 eFlags[x++] = 'I'; /* support inplace_partial behavior */
2665 eFlags[x++] = 'v'; /* use varint for flist & compat flags; negotiate checksum */
2666 /* NOTE: Avoid using 'V' -- it was the high bit of a write_byte() that became write_varint(). */
2670 if (x >= (int)sizeof argstr) { /* Not possible... */
2671 rprintf(FERROR, "argstr overflow in server_options().\n");
2672 exit_cleanup(RERR_MALLOC);
2678 args[ac++] = argstr;
2682 char *set = strchr(iconv_opt, ',');
2687 if (asprintf(&arg, "--iconv=%s", set) < 0)
2693 if (protect_args && !local_server) /* unprotected args stop here */
2697 args[ac++] = "--list-only";
2699 /* This makes sure that the remote rsync can handle deleting with -d
2700 * sans -r because the --no-r option was added at the same time. */
2701 if (xfer_dirs && !recurse && delete_mode && am_sender)
2702 args[ac++] = "--no-r";
2704 if (do_compression && def_compress_level != Z_DEFAULT_COMPRESSION) {
2705 if (asprintf(&arg, "--compress-level=%d", def_compress_level) < 0)
2710 if (preserve_devices) {
2711 /* Note: sending "--devices" would not be backward-compatible. */
2712 if (!preserve_specials)
2713 args[ac++] = "--no-specials"; /* -D is already set. */
2714 } else if (preserve_specials)
2715 args[ac++] = "--specials";
2717 /* The server side doesn't use our log-format, but in certain
2718 * circumstances they need to know a little about the option. */
2719 if (stdout_format && am_sender) {
2720 /* Use --log-format, not --out-format, for compatibility. */
2721 if (stdout_format_has_i > 1)
2722 args[ac++] = "--log-format=%i%I";
2723 else if (stdout_format_has_i)
2724 args[ac++] = "--log-format=%i";
2725 else if (stdout_format_has_o_or_i)
2726 args[ac++] = "--log-format=%o";
2728 args[ac++] = "--log-format=X";
2732 if (asprintf(&arg, "-B%lu", block_size) < 0)
2738 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
2744 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
2750 args[ac++] = "--backup-dir";
2751 args[ac++] = backup_dir;
2754 /* Only send --suffix if it specifies a non-default value. */
2755 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
2756 /* We use the following syntax to avoid weirdness with '~'. */
2757 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
2762 if (checksum_choice) {
2763 if (asprintf(&arg, "--checksum-choice=%s", checksum_choice) < 0)
2768 if (do_compression == CPRES_ZLIBX)
2769 args[ac++] = "--new-compress";
2770 else if (compress_choice && do_compression == CPRES_ZLIB)
2771 args[ac++] = "--old-compress";
2772 else if (compress_choice) {
2773 if (asprintf(&arg, "--compress-choice=%s", compress_choice) < 0)
2779 if (max_delete > 0) {
2780 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
2783 } else if (max_delete == 0)
2784 args[ac++] = "--max-delete=-1";
2785 if (min_size >= 0) {
2786 args[ac++] = "--min-size";
2787 args[ac++] = min_size_arg;
2789 if (max_size >= 0) {
2790 args[ac++] = "--max-size";
2791 args[ac++] = max_size_arg;
2794 args[ac++] = "--delete-before";
2795 else if (delete_during == 2)
2796 args[ac++] = "--delete-delay";
2797 else if (delete_during)
2798 args[ac++] = "--delete-during";
2799 else if (delete_after)
2800 args[ac++] = "--delete-after";
2801 else if (delete_mode && !delete_excluded)
2802 args[ac++] = "--delete";
2803 if (delete_excluded)
2804 args[ac++] = "--delete-excluded";
2806 args[ac++] = "--force";
2807 if (write_batch < 0)
2808 args[ac++] = "--only-write-batch=X";
2810 args[ac++] = "--super";
2812 args[ac++] = "--size-only";
2814 args[ac++] = "--stats";
2816 if (skip_compress) {
2817 if (asprintf(&arg, "--skip-compress=%s", skip_compress) < 0)
2823 /* --delete-missing-args needs the cooperation of both sides, but
2824 * the sender can handle --ignore-missing-args by itself. */
2825 if (missing_args == 2)
2826 args[ac++] = "--delete-missing-args";
2827 else if (missing_args == 1 && !am_sender)
2828 args[ac++] = "--ignore-missing-args";
2830 if (modify_window_set && am_sender) {
2831 char *fmt = modify_window < 0 ? "-@%d" : "--modify-window=%d";
2832 if (asprintf(&arg, fmt, modify_window) < 0)
2837 if (checksum_seed) {
2838 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
2843 if (partial_dir && am_sender) {
2844 if (partial_dir != tmp_partialdir) {
2845 args[ac++] = "--partial-dir";
2846 args[ac++] = partial_dir;
2849 args[ac++] = "--delay-updates";
2850 } else if (keep_partial && am_sender)
2851 args[ac++] = "--partial";
2854 args[ac++] = "--ignore-errors";
2856 if (copy_unsafe_links)
2857 args[ac++] = "--copy-unsafe-links";
2860 args[ac++] = "--safe-links";
2863 args[ac++] = "--numeric-ids";
2866 args[ac++] = "--use-qsort";
2870 if (asprintf(&arg, "--usermap=%s", usermap) < 0)
2876 if (asprintf(&arg, "--groupmap=%s", groupmap) < 0)
2881 if (ignore_existing)
2882 args[ac++] = "--ignore-existing";
2884 /* Backward compatibility: send --existing, not --ignore-non-existing. */
2885 if (ignore_non_existing)
2886 args[ac++] = "--existing";
2889 args[ac++] = "--temp-dir";
2890 args[ac++] = tmpdir;
2894 /* the server only needs this option if it is not the sender,
2895 * and it may be an older version that doesn't know this
2896 * option, so don't send it if client is the sender.
2898 for (i = 0; i < basis_dir_cnt; i++) {
2899 args[ac++] = dest_option;
2900 args[ac++] = basis_dir[i];
2905 /* What flags do we need to send to the other side? */
2906 where = (am_server ? W_CLI : W_SRV) | (am_sender ? W_REC : W_SND);
2907 arg = make_output_option(info_words, info_levels, where);
2912 if (append_mode > 1)
2913 args[ac++] = "--append";
2914 args[ac++] = "--append";
2916 args[ac++] = "--inplace";
2918 if (files_from && (!am_sender || filesfrom_host)) {
2919 if (filesfrom_host) {
2920 args[ac++] = "--files-from";
2921 args[ac++] = files_from;
2923 args[ac++] = "--from0";
2925 args[ac++] = "--files-from=-";
2926 args[ac++] = "--from0";
2928 if (!relative_paths)
2929 args[ac++] = "--no-relative";
2931 /* It's OK that this checks the upper-bound of the protocol_version. */
2932 if (relative_paths && !implied_dirs && (!am_sender || protocol_version >= 30))
2933 args[ac++] = "--no-implied-dirs";
2935 if (write_devices && am_sender)
2936 args[ac++] = "--write-devices";
2938 if (remove_source_files == 1)
2939 args[ac++] = "--remove-source-files";
2940 else if (remove_source_files)
2941 args[ac++] = "--remove-sent-files";
2943 if (preallocate_files && am_sender)
2944 args[ac++] = "--preallocate";
2946 if (open_noatime && preserve_atimes <= 1)
2947 args[ac++] = "--open-noatime";
2949 if (ac > MAX_SERVER_ARGS) { /* Not possible... */
2950 rprintf(FERROR, "argc overflow in server_options().\n");
2951 exit_cleanup(RERR_MALLOC);
2954 if (remote_option_cnt) {
2956 if (ac + remote_option_cnt > MAX_SERVER_ARGS) {
2957 rprintf(FERROR, "too many remote options specified.\n");
2958 exit_cleanup(RERR_SYNTAX);
2960 for (j = 1; j <= remote_option_cnt; j++)
2961 args[ac++] = (char*)remote_options[j];
2968 out_of_memory("server_options");
2971 /* If str points to a valid hostspec, return allocated memory containing the
2972 * [USER@]HOST part of the string, and set the path_start_ptr to the part of
2973 * the string after the host part. Otherwise, return NULL. If port_ptr is
2974 * non-NULL, we must be parsing an rsync:// URL hostname, and we will set
2975 * *port_ptr if a port number is found. Note that IPv6 IPs will have their
2976 * (required for parsing) [ and ] chars elided from the returned string. */
2977 static char *parse_hostspec(char *str, char **path_start_ptr, int *port_ptr)
2979 char *s, *host_start = str;
2980 int hostlen = 0, userlen = 0;
2983 for (s = str; ; s++) {
2985 /* It is only OK if we run out of string with rsync:// */
2989 hostlen = s - host_start;
2992 if (*s == ':' || *s == '/') {
2994 hostlen = s - host_start;
2998 } else if (port_ptr) {
2999 *port_ptr = atoi(s);
3000 while (isDigit(s)) s++;
3001 if (*s && *s++ != '/')
3007 userlen = s - str + 1;
3009 } else if (*s == '[') {
3010 if (s != host_start++)
3012 while (*s && *s != ']' && *s != '/') s++; /*SHARED ITERATOR*/
3013 hostlen = s - host_start;
3014 if (*s != ']' || (s[1] && s[1] != '/' && s[1] != ':') || !hostlen)
3019 *path_start_ptr = s;
3020 ret = new_array(char, userlen + hostlen + 1);
3022 strlcpy(ret, str, userlen + 1);
3023 strlcpy(ret + userlen, host_start, hostlen + 1);
3027 /* Look for a HOST specification of the form "HOST:PATH", "HOST::PATH", or
3028 * "rsync://HOST:PORT/PATH". If found, *host_ptr will be set to some allocated
3029 * memory with the HOST. If a daemon-accessing spec was specified, the value
3030 * of *port_ptr will contain a non-0 port number, otherwise it will be set to
3031 * 0. The return value is a pointer to the PATH. Note that the HOST spec can
3032 * be an IPv6 literal address enclosed in '[' and ']' (such as "[::1]" or
3033 * "[::ffff:127.0.0.1]") which is returned without the '[' and ']'. */
3034 char *check_for_hostspec(char *s, char **host_ptr, int *port_ptr)
3038 if (port_ptr && strncasecmp(URL_PREFIX, s, strlen(URL_PREFIX)) == 0) {
3039 *host_ptr = parse_hostspec(s + strlen(URL_PREFIX), &path, port_ptr);
3042 *port_ptr = -1; /* -1 indicates they want the default */
3047 *host_ptr = parse_hostspec(s, &path, NULL);
3052 if (port_ptr && !*port_ptr)