Convert a couple files to UTF-8; more Copyright years.
[rsync.git] / options.c
blobb60884051aa6446e740d28c23b114bfac7cd8793
1 /*
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.
22 #include "rsync.h"
23 #include "itypes.h"
24 #include "latest-year.h"
25 #include <popt.h>
27 extern int module_id;
28 extern int local_server;
29 extern int sanitize_paths;
30 extern int daemon_over_rsh;
31 extern unsigned int module_dirlen;
32 extern struct name_num_obj valid_checksums;
33 extern struct name_num_obj valid_compressions;
34 extern filter_rule_list filter_list;
35 extern filter_rule_list daemon_filter_list;
37 int make_backups = 0;
39 /**
40 * If 1, send the whole file as literal data rather than trying to
41 * create an incremental diff.
43 * If -1, then look at whether we're local or remote and go by that.
45 * @sa disable_deltas_p()
46 **/
47 int whole_file = -1;
49 int append_mode = 0;
50 int keep_dirlinks = 0;
51 int copy_dirlinks = 0;
52 int copy_links = 0;
53 int write_devices = 0;
54 int preserve_links = 0;
55 int preserve_hard_links = 0;
56 int preserve_acls = 0;
57 int preserve_xattrs = 0;
58 int preserve_perms = 0;
59 int preserve_executability = 0;
60 int preserve_devices = 0;
61 int preserve_specials = 0;
62 int preserve_uid = 0;
63 int preserve_gid = 0;
64 int preserve_times = 0;
65 int preserve_atimes = 0;
66 int update_only = 0;
67 int open_noatime = 0;
68 int cvs_exclude = 0;
69 int dry_run = 0;
70 int do_xfers = 1;
71 int ignore_times = 0;
72 int delete_mode = 0;
73 int delete_during = 0;
74 int delete_before = 0;
75 int delete_after = 0;
76 int delete_excluded = 0;
77 int remove_source_files = 0;
78 int one_file_system = 0;
79 int protocol_version = PROTOCOL_VERSION;
80 int sparse_files = 0;
81 int preallocate_files = 0;
82 int do_compression = 0;
83 int do_compression_level = CLVL_NOT_SPECIFIED;
84 int am_root = 0; /* 0 = normal, 1 = root, 2 = --super, -1 = --fake-super */
85 int am_server = 0;
86 int am_sender = 0;
87 int am_starting_up = 1;
88 int relative_paths = -1;
89 int implied_dirs = 1;
90 int missing_args = 0; /* 0 = FERROR_XFER, 1 = ignore, 2 = delete */
91 int numeric_ids = 0;
92 int msgs2stderr = 0;
93 int allow_8bit_chars = 0;
94 int force_delete = 0;
95 int io_timeout = 0;
96 int prune_empty_dirs = 0;
97 int use_qsort = 0;
98 char *files_from = NULL;
99 int filesfrom_fd = -1;
100 char *filesfrom_host = NULL;
101 int eol_nulls = 0;
102 int protect_args = -1;
103 int human_readable = 1;
104 int recurse = 0;
105 int allow_inc_recurse = 1;
106 int xfer_dirs = -1;
107 int am_daemon = 0;
108 int connect_timeout = 0;
109 int keep_partial = 0;
110 int safe_symlinks = 0;
111 int copy_unsafe_links = 0;
112 int munge_symlinks = 0;
113 int size_only = 0;
114 int daemon_bwlimit = 0;
115 int bwlimit = 0;
116 int fuzzy_basis = 0;
117 size_t bwlimit_writemax = 0;
118 int ignore_existing = 0;
119 int ignore_non_existing = 0;
120 int need_messages_from_generator = 0;
121 int max_delete = INT_MIN;
122 OFF_T max_size = -1;
123 OFF_T min_size = -1;
124 int ignore_errors = 0;
125 int modify_window = 0;
126 int blocking_io = -1;
127 int checksum_seed = 0;
128 int inplace = 0;
129 int delay_updates = 0;
130 long block_size = 0; /* "long" because popt can't set an int32. */
131 char *skip_compress = NULL;
132 char *copy_as = NULL;
133 item_list dparam_list = EMPTY_ITEM_LIST;
135 /** Network address family. **/
136 int default_af_hint
137 #ifdef INET6
138 = 0; /* Any protocol */
139 #else
140 = AF_INET; /* Must use IPv4 */
141 # ifdef AF_INET6
142 # undef AF_INET6
143 # endif
144 # define AF_INET6 AF_INET /* make -6 option a no-op */
145 #endif
147 /** Do not go into the background when run as --daemon. Good
148 * for debugging and required for running as a service on W32,
149 * or under Unix process-monitors. **/
150 int no_detach
151 #if defined _WIN32 || defined __WIN32__
152 = 1;
153 #else
154 = 0;
155 #endif
157 int write_batch = 0;
158 int read_batch = 0;
159 int backup_dir_len = 0;
160 int backup_suffix_len;
161 unsigned int backup_dir_remainder;
163 char *backup_suffix = NULL;
164 char *tmpdir = NULL;
165 char *partial_dir = NULL;
166 char *basis_dir[MAX_BASIS_DIRS+1];
167 char *config_file = NULL;
168 char *shell_cmd = NULL;
169 char *logfile_name = NULL;
170 char *logfile_format = NULL;
171 char *stdout_format = NULL;
172 char *password_file = NULL;
173 char *rsync_path = RSYNC_PATH;
174 char *backup_dir = NULL;
175 char backup_dir_buf[MAXPATHLEN];
176 char *sockopts = NULL;
177 char *usermap = NULL;
178 char *groupmap = NULL;
179 int rsync_port = 0;
180 int compare_dest = 0;
181 int copy_dest = 0;
182 int link_dest = 0;
183 int basis_dir_cnt = 0;
184 char *dest_option = NULL;
186 static int remote_option_alloc = 0;
187 int remote_option_cnt = 0;
188 const char **remote_options = NULL;
189 const char *checksum_choice = NULL;
190 const char *compress_choice = NULL;
192 int quiet = 0;
193 int output_motd = 1;
194 int log_before_transfer = 0;
195 int stdout_format_has_i = 0;
196 int stdout_format_has_o_or_i = 0;
197 int logfile_format_has_i = 0;
198 int logfile_format_has_o_or_i = 0;
199 int always_checksum = 0;
200 int list_only = 0;
202 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
203 char *batch_name = NULL;
205 int need_unsorted_flist = 0;
206 #ifdef ICONV_OPTION
207 char *iconv_opt = ICONV_OPTION;
208 #endif
210 struct chmod_mode_struct *chmod_modes = NULL;
212 static const char *debug_verbosity[] = {
213 /*0*/ NULL,
214 /*1*/ NULL,
215 /*2*/ "BIND,CMD,CONNECT,DEL,DELTASUM,DUP,FILTER,FLIST,ICONV",
216 /*3*/ "ACL,BACKUP,CONNECT2,DELTASUM2,DEL2,EXIT,FILTER2,FLIST2,FUZZY,GENR,OWN,RECV,SEND,TIME",
217 /*4*/ "CMD2,DELTASUM3,DEL3,EXIT2,FLIST3,ICONV2,OWN2,PROTO,TIME2",
218 /*5*/ "CHDIR,DELTASUM4,FLIST4,FUZZY2,HASH,HLINK",
221 #define MAX_VERBOSITY ((int)(sizeof debug_verbosity / sizeof debug_verbosity[0]) - 1)
223 static const char *info_verbosity[1+MAX_VERBOSITY] = {
224 /*0*/ NULL,
225 /*1*/ "COPY,DEL,FLIST,MISC,NAME,STATS,SYMSAFE",
226 /*2*/ "BACKUP,MISC2,MOUNT,NAME2,REMOVE,SKIP",
229 #define MAX_OUT_LEVEL 4 /* The largest N allowed for any flagN word. */
231 short info_levels[COUNT_INFO], debug_levels[COUNT_DEBUG];
233 #define DEFAULT_PRIORITY 0 /* Default/implied/--verbose set values. */
234 #define HELP_PRIORITY 1 /* The help output uses this level. */
235 #define USER_PRIORITY 2 /* User-specified via --info or --debug */
236 #define LIMIT_PRIORITY 3 /* Overriding priority when limiting values. */
238 #define W_CLI (1<<0) /* client side */
239 #define W_SRV (1<<1) /* server side */
240 #define W_SND (1<<2) /* sending side */
241 #define W_REC (1<<3) /* receiving side */
243 struct output_struct {
244 char *name; /* The name of the info/debug flag. */
245 char *help; /* The description of the info/debug flag. */
246 uchar namelen; /* The length of the name string. */
247 uchar flag; /* The flag's value, for consistency check. */
248 uchar where; /* Bits indicating where the flag is used. */
249 uchar priority; /* See *_PRIORITY defines. */
252 #define INFO_WORD(flag, where, help) { #flag, help, sizeof #flag - 1, INFO_##flag, where, 0 }
254 static struct output_struct info_words[COUNT_INFO+1] = {
255 INFO_WORD(BACKUP, W_REC, "Mention files backed up"),
256 INFO_WORD(COPY, W_REC, "Mention files copied locally on the receiving side"),
257 INFO_WORD(DEL, W_REC, "Mention deletions on the receiving side"),
258 INFO_WORD(FLIST, W_CLI, "Mention file-list receiving/sending (levels 1-2)"),
259 INFO_WORD(MISC, W_SND|W_REC, "Mention miscellaneous information (levels 1-2)"),
260 INFO_WORD(MOUNT, W_SND|W_REC, "Mention mounts that were found or skipped"),
261 INFO_WORD(NAME, W_SND|W_REC, "Mention 1) updated file/dir names, 2) unchanged names"),
262 INFO_WORD(PROGRESS, W_CLI, "Mention 1) per-file progress or 2) total transfer progress"),
263 INFO_WORD(REMOVE, W_SND, "Mention files removed on the sending side"),
264 INFO_WORD(SKIP, W_REC, "Mention files that are skipped due to options used"),
265 INFO_WORD(STATS, W_CLI|W_SRV, "Mention statistics at end of run (levels 1-3)"),
266 INFO_WORD(SYMSAFE, W_SND|W_REC, "Mention symlinks that are unsafe"),
267 { NULL, "--info", 0, 0, 0, 0 }
270 #define DEBUG_WORD(flag, where, help) { #flag, help, sizeof #flag - 1, DEBUG_##flag, where, 0 }
272 static struct output_struct debug_words[COUNT_DEBUG+1] = {
273 DEBUG_WORD(ACL, W_SND|W_REC, "Debug extra ACL info"),
274 DEBUG_WORD(BACKUP, W_REC, "Debug backup actions (levels 1-2)"),
275 DEBUG_WORD(BIND, W_CLI, "Debug socket bind actions"),
276 DEBUG_WORD(CHDIR, W_CLI|W_SRV, "Debug when the current directory changes"),
277 DEBUG_WORD(CONNECT, W_CLI, "Debug connection events (levels 1-2)"),
278 DEBUG_WORD(CMD, W_CLI, "Debug commands+options that are issued (levels 1-2)"),
279 DEBUG_WORD(DEL, W_REC, "Debug delete actions (levels 1-3)"),
280 DEBUG_WORD(DELTASUM, W_SND|W_REC, "Debug delta-transfer checksumming (levels 1-4)"),
281 DEBUG_WORD(DUP, W_REC, "Debug weeding of duplicate names"),
282 DEBUG_WORD(EXIT, W_CLI|W_SRV, "Debug exit events (levels 1-3)"),
283 DEBUG_WORD(FILTER, W_SND|W_REC, "Debug filter actions (levels 1-2)"),
284 DEBUG_WORD(FLIST, W_SND|W_REC, "Debug file-list operations (levels 1-4)"),
285 DEBUG_WORD(FUZZY, W_REC, "Debug fuzzy scoring (levels 1-2)"),
286 DEBUG_WORD(GENR, W_REC, "Debug generator functions"),
287 DEBUG_WORD(HASH, W_SND|W_REC, "Debug hashtable code"),
288 DEBUG_WORD(HLINK, W_SND|W_REC, "Debug hard-link actions (levels 1-3)"),
289 DEBUG_WORD(ICONV, W_CLI|W_SRV, "Debug iconv character conversions (levels 1-2)"),
290 DEBUG_WORD(IO, W_CLI|W_SRV, "Debug I/O routines (levels 1-4)"),
291 DEBUG_WORD(NSTR, W_CLI|W_SRV, "Debug negotiation strings"),
292 DEBUG_WORD(OWN, W_REC, "Debug ownership changes in users & groups (levels 1-2)"),
293 DEBUG_WORD(PROTO, W_CLI|W_SRV, "Debug protocol information"),
294 DEBUG_WORD(RECV, W_REC, "Debug receiver functions"),
295 DEBUG_WORD(SEND, W_SND, "Debug sender functions"),
296 DEBUG_WORD(TIME, W_REC, "Debug setting of modified times (levels 1-2)"),
297 { NULL, "--debug", 0, 0, 0, 0 }
300 static int verbose = 0;
301 static int do_stats = 0;
302 static int do_progress = 0;
303 static int daemon_opt; /* sets am_daemon after option error-reporting */
304 static int omit_dir_times = 0;
305 static int omit_link_times = 0;
306 static int F_option_cnt = 0;
307 static int modify_window_set;
308 static int itemize_changes = 0;
309 static int refused_delete, refused_archive_part, refused_compress;
310 static int refused_partial, refused_progress, refused_delete_before;
311 static int refused_delete_during;
312 static int refused_inplace, refused_no_iconv;
313 static BOOL usermap_via_chown, groupmap_via_chown;
314 #ifdef HAVE_SETVBUF
315 static char *outbuf_mode;
316 #endif
317 static char *bwlimit_arg, *max_size_arg, *min_size_arg;
318 static char tmp_partialdir[] = ".~tmp~";
320 /** Local address to bind. As a character string because it's
321 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
322 * address, or a hostname. **/
323 char *bind_address;
325 static void output_item_help(struct output_struct *words);
327 /* This constructs a string that represents all the options set for either
328 * the --info or --debug setting, skipping any implied options (by -v, etc.).
329 * This is used both when conveying the user's options to the server, and
330 * when the help output wants to tell the user what options are implied. */
331 static char *make_output_option(struct output_struct *words, short *levels, uchar where)
333 char *str = words == info_words ? "--info=" : "--debug=";
334 int j, counts[MAX_OUT_LEVEL+1], pos, skipped = 0, len = 0, max = 0, lev = 0;
335 int word_count = words == info_words ? COUNT_INFO : COUNT_DEBUG;
336 char *buf;
338 memset(counts, 0, sizeof counts);
340 for (j = 0; words[j].name; j++) {
341 if (words[j].flag != j) {
342 rprintf(FERROR, "rsync: internal error on %s%s: %d != %d\n",
343 words == info_words ? "INFO_" : "DEBUG_",
344 words[j].name, words[j].flag, j);
345 exit_cleanup(RERR_UNSUPPORTED);
347 if (!(words[j].where & where))
348 continue;
349 if (words[j].priority == DEFAULT_PRIORITY) {
350 /* Implied items don't need to be mentioned. */
351 skipped++;
352 continue;
354 len += len ? 1 : strlen(str);
355 len += strlen(words[j].name);
356 len += levels[j] == 1 ? 0 : 1;
358 if (words[j].priority == HELP_PRIORITY)
359 continue; /* no abbreviating for help */
361 assert(levels[j] <= MAX_OUT_LEVEL);
362 if (++counts[levels[j]] > max) {
363 /* Determine which level has the most items. */
364 lev = levels[j];
365 max = counts[lev];
369 /* Sanity check the COUNT_* define against the length of the table. */
370 if (j != word_count) {
371 rprintf(FERROR, "rsync: internal error: %s is wrong! (%d != %d)\n",
372 words == info_words ? "COUNT_INFO" : "COUNT_DEBUG",
373 j, word_count);
374 exit_cleanup(RERR_UNSUPPORTED);
377 if (!len)
378 return NULL;
380 len++;
381 if (!(buf = new_array(char, len)))
382 out_of_memory("make_output_option");
383 pos = 0;
385 if (skipped || max < 5)
386 lev = -1;
387 else {
388 if (lev == 0)
389 pos += snprintf(buf, len, "%sNONE", str);
390 else if (lev == 1)
391 pos += snprintf(buf, len, "%sALL", str);
392 else
393 pos += snprintf(buf, len, "%sALL%d", str, lev);
396 for (j = 0; words[j].name && pos < len; j++) {
397 if (words[j].priority == DEFAULT_PRIORITY || levels[j] == lev || !(words[j].where & where))
398 continue;
399 if (pos)
400 buf[pos++] = ',';
401 else
402 pos += strlcpy(buf+pos, str, len-pos);
403 if (pos < len)
404 pos += strlcpy(buf+pos, words[j].name, len-pos);
405 /* Level 1 is implied by the name alone. */
406 if (levels[j] != 1 && pos < len)
407 buf[pos++] = '0' + levels[j];
410 buf[pos] = '\0';
412 return buf;
415 static void parse_output_words(struct output_struct *words, short *levels,
416 const char *str, uchar priority)
418 const char *s;
419 int j, len, lev;
421 for ( ; str; str = s) {
422 if ((s = strchr(str, ',')) != NULL)
423 len = s++ - str;
424 else
425 len = strlen(str);
426 if (!len)
427 continue;
428 if (!isDigit(str)) {
429 while (len && isDigit(str+len-1))
430 len--;
432 lev = isDigit(str+len) ? atoi(str+len) : 1;
433 if (lev > MAX_OUT_LEVEL)
434 lev = MAX_OUT_LEVEL;
435 if (len == 4 && strncasecmp(str, "help", 4) == 0) {
436 output_item_help(words);
437 exit_cleanup(0);
439 if (len == 4 && strncasecmp(str, "none", 4) == 0)
440 len = lev = 0;
441 else if (len == 3 && strncasecmp(str, "all", 3) == 0)
442 len = 0;
443 for (j = 0; words[j].name; j++) {
444 if (!len
445 || (len == words[j].namelen && strncasecmp(str, words[j].name, len) == 0)) {
446 if (priority >= words[j].priority) {
447 words[j].priority = priority;
448 levels[j] = lev;
450 if (len)
451 break;
454 if (len && !words[j].name && !am_server) {
455 rprintf(FERROR, "Unknown %s item: \"%.*s\"\n",
456 words[j].help, len, str);
457 exit_cleanup(RERR_SYNTAX);
462 /* Tell the user what all the info or debug flags mean. */
463 static void output_item_help(struct output_struct *words)
465 short *levels = words == info_words ? info_levels : debug_levels;
466 const char **verbosity = words == info_words ? info_verbosity : debug_verbosity;
467 char buf[128], *opt, *fmt = "%-10s %s\n";
468 int j;
470 reset_output_levels();
472 rprintf(FINFO, "Use OPT or OPT1 for level 1 output, OPT2 for level 2, etc.; OPT0 silences.\n");
473 rprintf(FINFO, "\n");
474 for (j = 0; words[j].name; j++)
475 rprintf(FINFO, fmt, words[j].name, words[j].help);
476 rprintf(FINFO, "\n");
478 snprintf(buf, sizeof buf, "Set all %s options (e.g. all%d)",
479 words[j].help, MAX_OUT_LEVEL);
480 rprintf(FINFO, fmt, "ALL", buf);
482 snprintf(buf, sizeof buf, "Silence all %s options (same as all0)",
483 words[j].help);
484 rprintf(FINFO, fmt, "NONE", buf);
486 rprintf(FINFO, fmt, "HELP", "Output this help message");
487 rprintf(FINFO, "\n");
488 rprintf(FINFO, "Options added for each increase in verbose level:\n");
490 for (j = 1; j <= MAX_VERBOSITY; j++) {
491 parse_output_words(words, levels, verbosity[j], HELP_PRIORITY);
492 opt = make_output_option(words, levels, W_CLI|W_SRV|W_SND|W_REC);
493 if (opt) {
494 rprintf(FINFO, "%d) %s\n", j, strchr(opt, '=')+1);
495 free(opt);
497 reset_output_levels();
501 /* The --verbose option now sets info+debug flags. */
502 static void set_output_verbosity(int level, uchar priority)
504 int j;
506 if (level > MAX_VERBOSITY)
507 level = MAX_VERBOSITY;
509 for (j = 1; j <= level; j++) {
510 parse_output_words(info_words, info_levels, info_verbosity[j], priority);
511 parse_output_words(debug_words, debug_levels, debug_verbosity[j], priority);
515 /* Limit the info+debug flag levels given a verbose-option level limit. */
516 void limit_output_verbosity(int level)
518 short info_limits[COUNT_INFO], debug_limits[COUNT_DEBUG];
519 int j;
521 if (level > MAX_VERBOSITY)
522 return;
524 memset(info_limits, 0, sizeof info_limits);
525 memset(debug_limits, 0, sizeof debug_limits);
527 /* Compute the level limits in the above arrays. */
528 for (j = 1; j <= level; j++) {
529 parse_output_words(info_words, info_limits, info_verbosity[j], LIMIT_PRIORITY);
530 parse_output_words(debug_words, debug_limits, debug_verbosity[j], LIMIT_PRIORITY);
533 for (j = 0; j < COUNT_INFO; j++) {
534 if (info_levels[j] > info_limits[j])
535 info_levels[j] = info_limits[j];
538 for (j = 0; j < COUNT_DEBUG; j++) {
539 if (debug_levels[j] > debug_limits[j])
540 debug_levels[j] = debug_limits[j];
544 void reset_output_levels(void)
546 int j;
548 memset(info_levels, 0, sizeof info_levels);
549 memset(debug_levels, 0, sizeof debug_levels);
551 for (j = 0; j < COUNT_INFO; j++)
552 info_words[j].priority = DEFAULT_PRIORITY;
554 for (j = 0; j < COUNT_DEBUG; j++)
555 debug_words[j].priority = DEFAULT_PRIORITY;
558 void negate_output_levels(void)
560 int j;
562 for (j = 0; j < COUNT_INFO; j++)
563 info_levels[j] *= -1;
565 for (j = 0; j < COUNT_DEBUG; j++)
566 debug_levels[j] *= -1;
569 static char *istring(const char *fmt, int val)
571 char *str;
572 if (asprintf(&str, fmt, val) < 0)
573 out_of_memory("istring");
574 return str;
577 static void print_capabilities(enum logcode f)
579 STRUCT_STAT *dumstat;
580 char line_buf[75];
581 int line_len, j;
582 char *capabilities[] = {
583 istring("%d-bit files", (int)(sizeof (OFF_T) * 8)),
584 istring("%d-bit inums", (int)(sizeof dumstat->st_ino * 8)), /* Don't check ino_t! */
585 istring("%d-bit timestamps", (int)(sizeof (time_t) * 8)),
586 istring("%d-bit long ints", (int)(sizeof (int64) * 8)),
588 #ifndef HAVE_SOCKETPAIR
589 "no "
590 #endif
591 "socketpairs",
593 #ifndef SUPPORT_HARD_LINKS
594 "no "
595 #endif
596 "hardlinks",
598 #ifndef SUPPORT_LINKS
599 "no "
600 #endif
601 "symlinks",
603 #ifndef INET6
604 "no "
605 #endif
606 "IPv6",
608 "batchfiles",
610 #ifndef HAVE_FTRUNCATE
611 "no "
612 #endif
613 "inplace",
615 #ifndef HAVE_FTRUNCATE
616 "no "
617 #endif
618 "append",
620 #ifndef SUPPORT_ACLS
621 "no "
622 #endif
623 "ACLs",
625 #ifndef SUPPORT_XATTRS
626 "no "
627 #endif
628 "xattrs",
630 #ifndef ICONV_OPTION
631 "no "
632 #endif
633 "iconv",
635 #ifndef CAN_SET_SYMLINK_TIMES
636 "no "
637 #endif
638 "symtimes",
640 #ifndef SUPPORT_PREALLOCATION
641 "no "
642 #endif
643 "prealloc",
645 #ifndef HAVE_SIMD
646 "no "
647 #endif
648 "SIMD",
650 NULL
653 for (line_len = 0, j = 0; ; j++) {
654 char *cap = capabilities[j];
655 int cap_len = cap ? strlen(cap) : 1000;
656 int need_comma = cap && capabilities[j+1] != NULL ? 1 : 0;
657 if (line_len + 1 + cap_len + need_comma >= (int)sizeof line_buf) {
658 rprintf(f, " %s\n", line_buf);
659 line_len = 0;
661 if (!cap)
662 break;
663 line_len += snprintf(line_buf+line_len, sizeof line_buf - line_len, " %s%s", cap, need_comma ? "," : "");
667 static void print_rsync_version(enum logcode f)
669 char tmpbuf[256], *subprotocol = "";
671 #if SUBPROTOCOL_VERSION != 0
672 subprotocol = istring(".PR%d", SUBPROTOCOL_VERSION);
673 #endif
674 rprintf(f, "%s version %s protocol version %d%s\n",
675 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION, subprotocol);
677 rprintf(f, "Copyright (C) 1996-" LATEST_YEAR " by Andrew Tridgell, Wayne Davison, and others.\n");
678 rprintf(f, "Web site: http://rsync.samba.org/\n");
680 rprintf(f, "Capabilities:\n");
681 print_capabilities(f);
683 rprintf(f, "Checksum list:\n");
684 get_default_nno_list(&valid_checksums, tmpbuf, sizeof tmpbuf, '(');
685 rprintf(f, " %s\n", tmpbuf);
687 rprintf(f, "Compress list:\n");
688 get_default_nno_list(&valid_compressions, tmpbuf, sizeof tmpbuf, '(');
689 rprintf(f, " %s\n", tmpbuf);
691 #ifdef MAINTAINER_MODE
692 rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
693 #endif
695 #if SIZEOF_INT64 < 8
696 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
697 #endif
698 if (sizeof (int64) != SIZEOF_INT64) {
699 rprintf(f,
700 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
701 (int) SIZEOF_INT64, (int) sizeof (int64));
704 rprintf(f,"\n");
705 rprintf(f,"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n");
706 rprintf(f,"are welcome to redistribute it under certain conditions. See the GNU\n");
707 rprintf(f,"General Public Licence for details.\n");
711 void usage(enum logcode F)
713 print_rsync_version(F);
715 rprintf(F,"\n");
716 rprintf(F,"rsync is a file transfer program capable of efficient remote update\n");
717 rprintf(F,"via a fast differencing algorithm.\n");
719 rprintf(F,"\n");
720 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... DEST\n");
721 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
722 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
723 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
724 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC [DEST]\n");
725 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
726 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
727 rprintf(F,"The ':' usages connect via remote shell, while '::' & 'rsync://' usages connect\n");
728 rprintf(F,"to an rsync daemon, and require SRC or DEST to start with a module name.\n");
729 rprintf(F,"\n");
730 rprintf(F,"Options\n");
731 #include "help-rsync.h"
732 rprintf(F,"\n");
733 rprintf(F,"Use \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
734 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
735 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
738 enum {OPT_SERVER = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
739 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST, OPT_HELP,
740 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW, OPT_MIN_SIZE, OPT_CHMOD,
741 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_ONLY_WRITE_BATCH, OPT_MAX_SIZE,
742 OPT_NO_D, OPT_APPEND, OPT_NO_ICONV, OPT_INFO, OPT_DEBUG,
743 OPT_USERMAP, OPT_GROUPMAP, OPT_CHOWN, OPT_BWLIMIT,
744 OPT_OLD_COMPRESS, OPT_NEW_COMPRESS, OPT_NO_COMPRESS,
745 OPT_REFUSED_BASE = 9000};
747 static struct poptOption long_options[] = {
748 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
749 {"help", 0, POPT_ARG_NONE, 0, OPT_HELP, 0, 0 },
750 {"version", 'V', POPT_ARG_NONE, 0, 'V', 0, 0},
751 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
752 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
753 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
754 {"info", 0, POPT_ARG_STRING, 0, OPT_INFO, 0, 0 },
755 {"debug", 0, POPT_ARG_STRING, 0, OPT_DEBUG, 0, 0 },
756 {"msgs2stderr", 0, POPT_ARG_NONE, &msgs2stderr, 0, 0, 0 },
757 {"no-msgs2stderr", 0, POPT_ARG_VAL, &msgs2stderr, 0, 0, 0 },
758 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
759 {"motd", 0, POPT_ARG_VAL, &output_motd, 1, 0, 0 },
760 {"no-motd", 0, POPT_ARG_VAL, &output_motd, 0, 0, 0 },
761 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
762 {"human-readable", 'h', POPT_ARG_NONE, 0, 'h', 0, 0},
763 {"no-human-readable",0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
764 {"no-h", 0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
765 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
766 {"archive", 'a', POPT_ARG_NONE, 0, 'a', 0, 0 },
767 {"recursive", 'r', POPT_ARG_VAL, &recurse, 2, 0, 0 },
768 {"no-recursive", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
769 {"no-r", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
770 {"inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
771 {"no-inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
772 {"i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
773 {"no-i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
774 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
775 {"no-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
776 {"no-d", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
777 {"old-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
778 {"old-d", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
779 {"perms", 'p', POPT_ARG_VAL, &preserve_perms, 1, 0, 0 },
780 {"no-perms", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
781 {"no-p", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
782 {"executability", 'E', POPT_ARG_NONE, &preserve_executability, 0, 0, 0 },
783 {"acls", 'A', POPT_ARG_NONE, 0, 'A', 0, 0 },
784 {"no-acls", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
785 {"no-A", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
786 {"xattrs", 'X', POPT_ARG_NONE, 0, 'X', 0, 0 },
787 {"no-xattrs", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
788 {"no-X", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
789 {"times", 't', POPT_ARG_VAL, &preserve_times, 1, 0, 0 },
790 {"no-times", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
791 {"no-t", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
792 {"atimes", 'U', POPT_ARG_NONE, 0, 'U', 0, 0 },
793 {"no-atimes", 0, POPT_ARG_VAL, &preserve_atimes, 0, 0, 0 },
794 {"no-U", 0, POPT_ARG_VAL, &preserve_atimes, 0, 0, 0 },
795 {"open-noatime", 0, POPT_ARG_VAL, &open_noatime, 1, 0, 0 },
796 {"no-open-noatime", 0, POPT_ARG_VAL, &open_noatime, 0, 0, 0 },
797 {"omit-dir-times", 'O', POPT_ARG_VAL, &omit_dir_times, 1, 0, 0 },
798 {"no-omit-dir-times",0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
799 {"no-O", 0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
800 {"omit-link-times", 'J', POPT_ARG_VAL, &omit_link_times, 1, 0, 0 },
801 {"no-omit-link-times",0, POPT_ARG_VAL, &omit_link_times, 0, 0, 0 },
802 {"no-J", 0, POPT_ARG_VAL, &omit_link_times, 0, 0, 0 },
803 {"modify-window", '@', POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
804 {"super", 0, POPT_ARG_VAL, &am_root, 2, 0, 0 },
805 {"no-super", 0, POPT_ARG_VAL, &am_root, 0, 0, 0 },
806 {"fake-super", 0, POPT_ARG_VAL, &am_root, -1, 0, 0 },
807 {"owner", 'o', POPT_ARG_VAL, &preserve_uid, 1, 0, 0 },
808 {"no-owner", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
809 {"no-o", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
810 {"group", 'g', POPT_ARG_VAL, &preserve_gid, 1, 0, 0 },
811 {"no-group", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
812 {"no-g", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
813 {0, 'D', POPT_ARG_NONE, 0, 'D', 0, 0 },
814 {"no-D", 0, POPT_ARG_NONE, 0, OPT_NO_D, 0, 0 },
815 {"devices", 0, POPT_ARG_VAL, &preserve_devices, 1, 0, 0 },
816 {"no-devices", 0, POPT_ARG_VAL, &preserve_devices, 0, 0, 0 },
817 {"write-devices", 0, POPT_ARG_VAL, &write_devices, 1, 0, 0 },
818 {"no-write-devices", 0, POPT_ARG_VAL, &write_devices, 0, 0, 0 },
819 {"specials", 0, POPT_ARG_VAL, &preserve_specials, 1, 0, 0 },
820 {"no-specials", 0, POPT_ARG_VAL, &preserve_specials, 0, 0, 0 },
821 {"links", 'l', POPT_ARG_VAL, &preserve_links, 1, 0, 0 },
822 {"no-links", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
823 {"no-l", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
824 {"copy-links", 'L', POPT_ARG_NONE, &copy_links, 0, 0, 0 },
825 {"copy-unsafe-links",0, POPT_ARG_NONE, &copy_unsafe_links, 0, 0, 0 },
826 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
827 {"munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 1, 0, 0 },
828 {"no-munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 0, 0, 0 },
829 {"copy-dirlinks", 'k', POPT_ARG_NONE, &copy_dirlinks, 0, 0, 0 },
830 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
831 {"hard-links", 'H', POPT_ARG_NONE, 0, 'H', 0, 0 },
832 {"no-hard-links", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
833 {"no-H", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
834 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
835 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
836 {"no-R", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
837 {"implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
838 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
839 {"i-d", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
840 {"no-i-d", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
841 {"chmod", 0, POPT_ARG_STRING, 0, OPT_CHMOD, 0, 0 },
842 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
843 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
844 {"one-file-system", 'x', POPT_ARG_NONE, 0, 'x', 0, 0 },
845 {"no-one-file-system",0, POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
846 {"no-x", 0, POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
847 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
848 {"existing", 0, POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
849 {"ignore-non-existing",0,POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
850 {"ignore-existing", 0, POPT_ARG_NONE, &ignore_existing, 0, 0, 0 },
851 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
852 {"min-size", 0, POPT_ARG_STRING, &min_size_arg, OPT_MIN_SIZE, 0, 0 },
853 {"sparse", 'S', POPT_ARG_VAL, &sparse_files, 1, 0, 0 },
854 {"no-sparse", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
855 {"no-S", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
856 {"preallocate", 0, POPT_ARG_NONE, &preallocate_files, 0, 0, 0},
857 {"inplace", 0, POPT_ARG_VAL, &inplace, 1, 0, 0 },
858 {"no-inplace", 0, POPT_ARG_VAL, &inplace, 0, 0, 0 },
859 {"append", 0, POPT_ARG_NONE, 0, OPT_APPEND, 0, 0 },
860 {"append-verify", 0, POPT_ARG_VAL, &append_mode, 2, 0, 0 },
861 {"no-append", 0, POPT_ARG_VAL, &append_mode, 0, 0, 0 },
862 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
863 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
864 {"delete-before", 0, POPT_ARG_NONE, &delete_before, 0, 0, 0 },
865 {"delete-during", 0, POPT_ARG_VAL, &delete_during, 1, 0, 0 },
866 {"delete-delay", 0, POPT_ARG_VAL, &delete_during, 2, 0, 0 },
867 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
868 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
869 {"delete-missing-args",0,POPT_BIT_SET, &missing_args, 2, 0, 0 },
870 {"ignore-missing-args",0,POPT_BIT_SET, &missing_args, 1, 0, 0 },
871 {"remove-sent-files",0, POPT_ARG_VAL, &remove_source_files, 2, 0, 0 }, /* deprecated */
872 {"remove-source-files",0,POPT_ARG_VAL, &remove_source_files, 1, 0, 0 },
873 {"force", 0, POPT_ARG_VAL, &force_delete, 1, 0, 0 },
874 {"no-force", 0, POPT_ARG_VAL, &force_delete, 0, 0, 0 },
875 {"ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 1, 0, 0 },
876 {"no-ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 0, 0, 0 },
877 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
878 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
879 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
880 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
881 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
882 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
883 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
884 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
885 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
886 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
887 {"no-W", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
888 {"checksum", 'c', POPT_ARG_VAL, &always_checksum, 1, 0, 0 },
889 {"no-checksum", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
890 {"no-c", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
891 {"checksum-choice", 0, POPT_ARG_STRING, &checksum_choice, 0, 0, 0 },
892 {"cc", 0, POPT_ARG_STRING, &checksum_choice, 0, 0, 0 },
893 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
894 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
895 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
896 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
897 {"fuzzy", 'y', POPT_ARG_NONE, 0, 'y', 0, 0 },
898 {"no-fuzzy", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
899 {"no-y", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
900 {"compress", 'z', POPT_ARG_NONE, 0, 'z', 0, 0 },
901 {"old-compress", 0, POPT_ARG_NONE, 0, OPT_OLD_COMPRESS, 0, 0 },
902 {"new-compress", 0, POPT_ARG_NONE, 0, OPT_NEW_COMPRESS, 0, 0 },
903 {"no-compress", 0, POPT_ARG_NONE, 0, OPT_NO_COMPRESS, 0, 0 },
904 {"no-z", 0, POPT_ARG_NONE, 0, OPT_NO_COMPRESS, 0, 0 },
905 {"compress-choice", 0, POPT_ARG_STRING, &compress_choice, 0, 0, 0 },
906 {"zc", 0, POPT_ARG_STRING, &compress_choice, 0, 0, 0 },
907 {"skip-compress", 0, POPT_ARG_STRING, &skip_compress, 0, 0, 0 },
908 {"compress-level", 0, POPT_ARG_INT, &do_compression_level, 0, 0, 0 },
909 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
910 {"progress", 0, POPT_ARG_VAL, &do_progress, 1, 0, 0 },
911 {"no-progress", 0, POPT_ARG_VAL, &do_progress, 0, 0, 0 },
912 {"partial", 0, POPT_ARG_VAL, &keep_partial, 1, 0, 0 },
913 {"no-partial", 0, POPT_ARG_VAL, &keep_partial, 0, 0, 0 },
914 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
915 {"delay-updates", 0, POPT_ARG_VAL, &delay_updates, 1, 0, 0 },
916 {"no-delay-updates", 0, POPT_ARG_VAL, &delay_updates, 0, 0, 0 },
917 {"prune-empty-dirs",'m', POPT_ARG_VAL, &prune_empty_dirs, 1, 0, 0 },
918 {"no-prune-empty-dirs",0,POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
919 {"no-m", 0, POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
920 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
921 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
922 {"out-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 },
923 {"log-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 }, /* DEPRECATED */
924 {"itemize-changes", 'i', POPT_ARG_NONE, 0, 'i', 0, 0 },
925 {"no-itemize-changes",0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
926 {"no-i", 0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
927 {"bwlimit", 0, POPT_ARG_STRING, &bwlimit_arg, OPT_BWLIMIT, 0, 0 },
928 {"no-bwlimit", 0, POPT_ARG_VAL, &bwlimit, 0, 0, 0 },
929 {"backup", 'b', POPT_ARG_VAL, &make_backups, 1, 0, 0 },
930 {"no-backup", 0, POPT_ARG_VAL, &make_backups, 0, 0, 0 },
931 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
932 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
933 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
934 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
935 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
936 {"only-write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_ONLY_WRITE_BATCH, 0, 0 },
937 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
938 {"from0", '0', POPT_ARG_VAL, &eol_nulls, 1, 0, 0},
939 {"no-from0", 0, POPT_ARG_VAL, &eol_nulls, 0, 0, 0},
940 {"protect-args", 's', POPT_ARG_VAL, &protect_args, 1, 0, 0},
941 {"no-protect-args", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
942 {"no-s", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
943 {"numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 1, 0, 0 },
944 {"no-numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 0, 0, 0 },
945 {"usermap", 0, POPT_ARG_STRING, 0, OPT_USERMAP, 0, 0 },
946 {"groupmap", 0, POPT_ARG_STRING, 0, OPT_GROUPMAP, 0, 0 },
947 {"chown", 0, POPT_ARG_STRING, 0, OPT_CHOWN, 0, 0 },
948 {"timeout", 0, POPT_ARG_INT, &io_timeout, 0, 0, 0 },
949 {"no-timeout", 0, POPT_ARG_VAL, &io_timeout, 0, 0, 0 },
950 {"contimeout", 0, POPT_ARG_INT, &connect_timeout, 0, 0, 0 },
951 {"no-contimeout", 0, POPT_ARG_VAL, &connect_timeout, 0, 0, 0 },
952 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
953 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
954 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
955 {"iconv", 0, POPT_ARG_STRING, &iconv_opt, 0, 0, 0 },
956 {"no-iconv", 0, POPT_ARG_NONE, 0, OPT_NO_ICONV, 0, 0 },
957 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
958 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
959 {"8-bit-output", '8', POPT_ARG_VAL, &allow_8bit_chars, 1, 0, 0 },
960 {"no-8-bit-output", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
961 {"no-8", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
962 {"qsort", 0, POPT_ARG_NONE, &use_qsort, 0, 0, 0 },
963 {"copy-as", 0, POPT_ARG_STRING, &copy_as, 0, 0, 0 },
964 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
965 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
966 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
967 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
968 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
969 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
970 {"outbuf", 0, POPT_ARG_STRING, &outbuf_mode, 0, 0, 0 },
971 {"remote-option", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
972 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
973 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
974 {"server", 0, POPT_ARG_NONE, 0, OPT_SERVER, 0, 0 },
975 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
976 /* All the following options switch us into daemon-mode option-parsing. */
977 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
978 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
979 {"dparam", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
980 {"detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
981 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
982 {0,0,0,0, 0, 0, 0}
985 static void daemon_usage(enum logcode F)
987 print_rsync_version(F);
989 rprintf(F,"\n");
990 rprintf(F,"Usage: rsync --daemon [OPTION]...\n");
991 #include "help-rsyncd.h"
992 rprintf(F,"\n");
993 rprintf(F,"If you were not trying to invoke rsync as a daemon, avoid using any of the\n");
994 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
997 static struct poptOption long_daemon_options[] = {
998 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
999 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
1000 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
1001 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
1002 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
1003 {"dparam", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
1004 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
1005 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
1006 {"detach", 0, POPT_ARG_VAL, &no_detach, 0, 0, 0 },
1007 {"no-detach", 0, POPT_ARG_VAL, &no_detach, 1, 0, 0 },
1008 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
1009 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
1010 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
1011 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
1012 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
1013 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
1014 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
1015 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
1016 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1017 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1018 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
1019 {0,0,0,0, 0, 0, 0}
1023 static char err_buf[200];
1027 * Store the option error message, if any, so that we can log the
1028 * connection attempt (which requires parsing the options), and then
1029 * show the error later on.
1031 void option_error(void)
1033 if (!err_buf[0]) {
1034 strlcpy(err_buf, "Error parsing options: option may "
1035 "be supported on client but not on server?\n",
1036 sizeof err_buf);
1039 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
1040 io_flush(MSG_FLUSH);
1041 msleep(20);
1045 static void parse_one_refuse_match(int negated, const char *ref, const struct poptOption *list_end)
1047 struct poptOption *op;
1048 char shortName[2];
1049 int is_wild = strpbrk(ref, "*?[") != NULL;
1050 int found_match = 0;
1052 shortName[1] = '\0';
1054 if (strcmp("a", ref) == 0 || strcmp("archive", ref) == 0) {
1055 ref = "[ardlptgoD]";
1056 is_wild = 1;
1059 for (op = long_options; op != list_end; op++) {
1060 *shortName = op->shortName;
1061 if ((op->longName && wildmatch(ref, op->longName))
1062 || (*shortName && wildmatch(ref, shortName))) {
1063 if (op->descrip[1] == '*')
1064 op->descrip = negated ? "a*" : "r*";
1065 else if (!is_wild)
1066 op->descrip = negated ? "a=" : "r=";
1067 found_match = 1;
1068 if (!is_wild)
1069 break;
1073 if (!found_match)
1074 rprintf(FLOG, "No match for refuse-options string \"%s\"\n", ref);
1079 * Tweak the option table to disable all options that the rsyncd.conf
1080 * file has told us to refuse.
1082 static void set_refuse_options(void)
1084 struct poptOption *op, *list_end = NULL;
1085 char *cp, *ref = lp_refuse_options(module_id);
1086 int negated;
1088 if (!ref)
1089 ref = "";
1091 if (!am_daemon)
1092 ref = "";
1094 /* We abuse the descrip field in poptOption to make it easy to flag which options
1095 * are refused (since we don't use it otherwise). Start by marking all options
1096 * as "a"ccepted with a few options also marked as non-wild. */
1097 for (op = long_options; ; op++) {
1098 const char *longName = op->longName ? op->longName : "";
1099 if (!op->longName && !op->shortName) {
1100 list_end = op;
1101 break;
1103 if (!am_daemon
1104 || op->shortName == 'e' /* Required for compatibility flags */
1105 || op->shortName == '0' /* --from0 just modifies --files-from, so refuse that instead (or not) */
1106 || op->shortName == 's' /* --protect-args is always OK */
1107 || op->shortName == 'n' /* --dry-run is always OK */
1108 || strcmp("iconv", longName) == 0
1109 || strcmp("no-iconv", longName) == 0
1110 || strcmp("checksum-seed", longName) == 0
1111 || strcmp("write-devices", longName) == 0 /* disable wild-match (it gets refused below) */
1112 || strcmp("log-format", longName) == 0 /* aka out-format (NOT log-file-format) */
1113 || strcmp("sender", longName) == 0
1114 || strcmp("server", longName) == 0)
1115 op->descrip = "a="; /* exact-match only */
1116 else
1117 op->descrip = "a*"; /* wild-card-able */
1119 assert(list_end != NULL);
1121 if (am_daemon) { /* Refused by default, but can be accepted via a negated exact match. */
1122 parse_one_refuse_match(0, "write-devices", list_end);
1125 while (1) {
1126 while (*ref == ' ') ref++;
1127 if (!*ref)
1128 break;
1129 if ((cp = strchr(ref, ' ')) != NULL)
1130 *cp = '\0';
1131 negated = *ref == '!';
1132 if (negated && ref[1])
1133 ref++;
1134 parse_one_refuse_match(negated, ref, list_end);
1135 if (!cp)
1136 break;
1137 *cp = ' ';
1138 ref = cp + 1;
1141 if (am_daemon) {
1142 #ifdef ICONV_OPTION
1143 if (!*lp_charset(module_id))
1144 parse_one_refuse_match(0, "iconv", list_end);
1145 #endif
1146 parse_one_refuse_match(0, "log-file*", list_end);
1149 #ifndef ICONV_OPTION
1150 parse_one_refuse_match(0, "iconv", list_end);
1151 #endif
1152 #ifndef HAVE_SETVBUF
1153 parse_one_refuse_match(0, "outbuf", list_end);
1154 #endif
1156 /* Now we use the descrip values to actually mark the options for refusal. */
1157 for (op = long_options; op != list_end; op++) {
1158 int refused = op->descrip[0] == 'r';
1159 op->descrip = NULL;
1160 if (!refused)
1161 continue;
1162 if (op->argInfo == POPT_ARG_VAL)
1163 op->argInfo = POPT_ARG_NONE;
1164 op->val = (op - long_options) + OPT_REFUSED_BASE;
1165 /* The following flags are set to let us easily check an implied option later in the code. */
1166 switch (op->shortName) {
1167 case 'r': case 'd': case 'l': case 'p':
1168 case 't': case 'g': case 'o': case 'D':
1169 refused_archive_part = op->val;
1170 break;
1171 case 'z':
1172 refused_compress = op->val;
1173 break;
1174 case '\0':
1175 if (strcmp("delete", op->longName) == 0)
1176 refused_delete = op->val;
1177 else if (strcmp("delete-before", op->longName) == 0)
1178 refused_delete_before = op->val;
1179 else if (strcmp("delete-during", op->longName) == 0)
1180 refused_delete_during = op->val;
1181 else if (strcmp("partial", op->longName) == 0)
1182 refused_partial = op->val;
1183 else if (strcmp("progress", op->longName) == 0)
1184 refused_progress = op->val;
1185 else if (strcmp("inplace", op->longName) == 0)
1186 refused_inplace = op->val;
1187 else if (strcmp("no-iconv", op->longName) == 0)
1188 refused_no_iconv = op->val;
1189 break;
1195 static int count_args(const char **argv)
1197 int i = 0;
1199 if (argv) {
1200 while (argv[i] != NULL)
1201 i++;
1204 return i;
1208 static OFF_T parse_size_arg(char **size_arg, char def_suf)
1210 int reps, mult, make_compatible = 0;
1211 const char *arg;
1212 OFF_T size = 1;
1214 for (arg = *size_arg; isDigit(arg); arg++) {}
1215 if (*arg == '.')
1216 for (arg++; isDigit(arg); arg++) {}
1217 switch (*arg && *arg != '+' && *arg != '-' ? *arg++ : def_suf) {
1218 case 'b': case 'B':
1219 reps = 0;
1220 break;
1221 case 'k': case 'K':
1222 reps = 1;
1223 break;
1224 case 'm': case 'M':
1225 reps = 2;
1226 break;
1227 case 'g': case 'G':
1228 reps = 3;
1229 break;
1230 default:
1231 return -1;
1233 if (*arg == 'b' || *arg == 'B')
1234 mult = 1000, make_compatible = 1, arg++;
1235 else if (!*arg || *arg == '+' || *arg == '-')
1236 mult = 1024;
1237 else if (strncasecmp(arg, "ib", 2) == 0)
1238 mult = 1024, arg += 2;
1239 else
1240 return -1;
1241 while (reps--)
1242 size *= mult;
1243 size *= atof(*size_arg);
1244 if ((*arg == '+' || *arg == '-') && arg[1] == '1')
1245 size += atoi(arg), make_compatible = 1, arg += 2;
1246 if (*arg)
1247 return -1;
1248 if (size > 0 && make_compatible && def_suf == 'b') {
1249 /* We convert this manually because we may need %lld precision,
1250 * and that's not a portable sprintf() escape. */
1251 char buf[128], *s = buf + sizeof buf - 1;
1252 OFF_T num = size;
1253 *s = '\0';
1254 while (num) {
1255 *--s = (char)(num % 10) + '0';
1256 num /= 10;
1258 if (!(*size_arg = strdup(s)))
1259 out_of_memory("parse_size_arg");
1261 return size;
1265 static void create_refuse_error(int which)
1267 const char *msg;
1268 if (am_daemon)
1269 msg = "The server is configured to refuse";
1270 else if (am_server)
1271 msg = "The server does not support";
1272 else
1273 msg = "This rsync does not support";
1275 /* The "which" value is the index + OPT_REFUSED_BASE. */
1276 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
1277 int n = snprintf(err_buf, sizeof err_buf, "%s --%s\n", msg, op->longName) - 1;
1278 if (op->shortName)
1279 snprintf(err_buf + n, sizeof err_buf - n, " (-%c)\n", op->shortName);
1282 /* This is used to make sure that --daemon & --server cannot be aliased to
1283 * something else. These options have always disabled popt aliases for the
1284 * parsing of a daemon or server command-line, but we have to make sure that
1285 * these options cannot vanish so that the alias disabling can take effect. */
1286 static void popt_unalias(poptContext con, const char *opt)
1288 struct poptAlias unalias;
1290 memset(&unalias, 0, sizeof unalias);
1292 unalias.longName = opt + 2; /* point past the leading "--" */
1293 unalias.argc = 1;
1294 unalias.argv = new_array0(const char*, 2);
1295 unalias.argv[0] = strdup(opt);
1297 poptAddAlias(con, unalias, 0);
1301 * Process command line arguments. Called on both local and remote.
1303 * @retval 1 if all options are OK; with globals set to appropriate
1304 * values
1306 * @retval 0 on error, with err_buf containing an explanation
1308 int parse_arguments(int *argc_p, const char ***argv_p)
1310 static poptContext pc;
1311 const char *arg, **argv = *argv_p;
1312 int argc = *argc_p;
1313 int opt;
1314 int orig_protect_args = protect_args;
1316 if (argc == 0) {
1317 strlcpy(err_buf, "argc is zero!\n", sizeof err_buf);
1318 return 0;
1321 set_refuse_options();
1323 #ifdef ICONV_OPTION
1324 if (!am_daemon && protect_args <= 0 && (arg = getenv("RSYNC_ICONV")) != NULL && *arg)
1325 iconv_opt = strdup(arg);
1326 #endif
1328 /* TODO: Call poptReadDefaultConfig; handle errors. */
1330 /* The context leaks in case of an error, but if there's a
1331 * problem we always exit anyhow. */
1332 if (pc)
1333 poptFreeContext(pc);
1334 pc = poptGetContext(RSYNC_NAME, argc, argv, long_options, 0);
1335 if (!am_server) {
1336 poptReadDefaultConfig(pc, 0);
1337 popt_unalias(pc, "--daemon");
1338 popt_unalias(pc, "--server");
1341 while ((opt = poptGetNextOpt(pc)) != -1) {
1342 /* most options are handled automatically by popt;
1343 * only special cases are returned and listed here. */
1345 switch (opt) {
1346 case 'V':
1347 print_rsync_version(FINFO);
1348 exit_cleanup(0);
1350 case OPT_SERVER:
1351 if (!am_server) {
1352 /* Disable popt aliases on the server side and
1353 * then start parsing the options again. */
1354 poptFreeContext(pc);
1355 pc = poptGetContext(RSYNC_NAME, argc, argv,
1356 long_options, 0);
1357 am_server = 1;
1359 #ifdef ICONV_OPTION
1360 iconv_opt = NULL;
1361 #endif
1362 break;
1364 case OPT_SENDER:
1365 if (!am_server) {
1366 usage(FERROR);
1367 exit_cleanup(RERR_SYNTAX);
1369 am_sender = 1;
1370 break;
1372 case OPT_DAEMON:
1373 if (am_daemon) {
1374 strlcpy(err_buf,
1375 "Attempt to hack rsync thwarted!\n",
1376 sizeof err_buf);
1377 return 0;
1379 #ifdef ICONV_OPTION
1380 iconv_opt = NULL;
1381 #endif
1382 protect_args = 0;
1383 poptFreeContext(pc);
1384 pc = poptGetContext(RSYNC_NAME, argc, argv,
1385 long_daemon_options, 0);
1386 while ((opt = poptGetNextOpt(pc)) != -1) {
1387 char **cpp;
1388 switch (opt) {
1389 case 'h':
1390 daemon_usage(FINFO);
1391 exit_cleanup(0);
1393 case 'M':
1394 arg = poptGetOptArg(pc);
1395 if (!strchr(arg, '=')) {
1396 rprintf(FERROR,
1397 "--dparam value is missing an '=': %s\n",
1398 arg);
1399 goto daemon_error;
1401 cpp = EXPAND_ITEM_LIST(&dparam_list, char *, 4);
1402 *cpp = strdup(arg);
1403 break;
1405 case 'v':
1406 verbose++;
1407 break;
1409 default:
1410 rprintf(FERROR,
1411 "rsync: %s: %s (in daemon mode)\n",
1412 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1413 poptStrerror(opt));
1414 goto daemon_error;
1418 if (dparam_list.count && !set_dparams(1))
1419 exit_cleanup(RERR_SYNTAX);
1421 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
1422 snprintf(err_buf, sizeof err_buf,
1423 "the --temp-dir path is WAY too long.\n");
1424 return 0;
1427 if (!daemon_opt) {
1428 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
1429 daemon_error:
1430 rprintf(FERROR,
1431 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
1432 exit_cleanup(RERR_SYNTAX);
1435 *argv_p = argv = poptGetArgs(pc);
1436 *argc_p = argc = count_args(argv);
1437 am_starting_up = 0;
1438 daemon_opt = 0;
1439 am_daemon = 1;
1440 return 1;
1442 case OPT_MODIFY_WINDOW:
1443 /* The value has already been set by popt, but
1444 * we need to remember that we're using a
1445 * non-default setting. */
1446 modify_window_set = 1;
1447 break;
1449 case OPT_FILTER:
1450 parse_filter_str(&filter_list, poptGetOptArg(pc),
1451 rule_template(0), 0);
1452 break;
1454 case OPT_EXCLUDE:
1455 parse_filter_str(&filter_list, poptGetOptArg(pc),
1456 rule_template(0), XFLG_OLD_PREFIXES);
1457 break;
1459 case OPT_INCLUDE:
1460 parse_filter_str(&filter_list, poptGetOptArg(pc),
1461 rule_template(FILTRULE_INCLUDE), XFLG_OLD_PREFIXES);
1462 break;
1464 case OPT_EXCLUDE_FROM:
1465 case OPT_INCLUDE_FROM:
1466 arg = poptGetOptArg(pc);
1467 if (sanitize_paths)
1468 arg = sanitize_path(NULL, arg, NULL, 0, SP_DEFAULT);
1469 if (daemon_filter_list.head) {
1470 int rej;
1471 char *cp = strdup(arg);
1472 if (!cp)
1473 out_of_memory("parse_arguments");
1474 if (!*cp)
1475 rej = 1;
1476 else {
1477 char *dir = cp + (*cp == '/' ? module_dirlen : 0);
1478 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1479 rej = check_filter(&daemon_filter_list, FLOG, dir, 0) < 0;
1481 free(cp);
1482 if (rej)
1483 goto options_rejected;
1485 parse_filter_file(&filter_list, arg,
1486 rule_template(opt == OPT_INCLUDE_FROM ? FILTRULE_INCLUDE : 0),
1487 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
1488 break;
1490 case 'a':
1491 if (refused_archive_part) {
1492 create_refuse_error(refused_archive_part);
1493 return 0;
1495 if (!recurse) /* preserve recurse == 2 */
1496 recurse = 1;
1497 #ifdef SUPPORT_LINKS
1498 preserve_links = 1;
1499 #endif
1500 preserve_perms = 1;
1501 preserve_times = 1;
1502 preserve_gid = 1;
1503 preserve_uid = 1;
1504 preserve_devices = 1;
1505 preserve_specials = 1;
1506 break;
1508 case 'D':
1509 preserve_devices = preserve_specials = 1;
1510 break;
1512 case OPT_NO_D:
1513 preserve_devices = preserve_specials = 0;
1514 break;
1516 case 'h':
1517 human_readable++;
1518 break;
1520 case 'H':
1521 preserve_hard_links++;
1522 break;
1524 case 'i':
1525 itemize_changes++;
1526 break;
1528 case 'U':
1529 if (++preserve_atimes > 1)
1530 open_noatime = 1;
1531 break;
1533 case 'v':
1534 verbose++;
1535 break;
1537 case 'y':
1538 fuzzy_basis++;
1539 break;
1541 case 'q':
1542 quiet++;
1543 break;
1545 case 'x':
1546 one_file_system++;
1547 break;
1549 case 'F':
1550 switch (++F_option_cnt) {
1551 case 1:
1552 parse_filter_str(&filter_list,": /.rsync-filter",rule_template(0),0);
1553 break;
1554 case 2:
1555 parse_filter_str(&filter_list,"- .rsync-filter",rule_template(0),0);
1556 break;
1558 break;
1560 case 'P':
1561 if (refused_partial || refused_progress) {
1562 create_refuse_error(refused_partial
1563 ? refused_partial : refused_progress);
1564 return 0;
1566 do_progress = 1;
1567 keep_partial = 1;
1568 break;
1570 case 'z':
1571 do_compression++;
1572 break;
1574 case OPT_OLD_COMPRESS:
1575 compress_choice = "zlib";
1576 break;
1578 case OPT_NEW_COMPRESS:
1579 compress_choice = "zlibx";
1580 break;
1582 case OPT_NO_COMPRESS:
1583 do_compression = 0;
1584 compress_choice = NULL;
1585 break;
1587 case 'M':
1588 arg = poptGetOptArg(pc);
1589 if (*arg != '-') {
1590 snprintf(err_buf, sizeof err_buf,
1591 "Remote option must start with a dash: %s\n", arg);
1592 return 0;
1594 if (remote_option_cnt+2 >= remote_option_alloc) {
1595 remote_option_alloc += 16;
1596 remote_options = realloc_array(remote_options,
1597 const char *, remote_option_alloc);
1598 if (!remote_options)
1599 out_of_memory("parse_arguments");
1600 if (!remote_option_cnt)
1601 remote_options[0] = "ARG0";
1603 remote_options[++remote_option_cnt] = arg;
1604 remote_options[remote_option_cnt+1] = NULL;
1605 break;
1607 case OPT_WRITE_BATCH:
1608 /* batch_name is already set */
1609 write_batch = 1;
1610 break;
1612 case OPT_ONLY_WRITE_BATCH:
1613 /* batch_name is already set */
1614 write_batch = -1;
1615 break;
1617 case OPT_READ_BATCH:
1618 /* batch_name is already set */
1619 read_batch = 1;
1620 break;
1622 case OPT_NO_ICONV:
1623 #ifdef ICONV_OPTION
1624 iconv_opt = NULL;
1625 #endif
1626 break;
1628 case OPT_MAX_SIZE:
1629 if ((max_size = parse_size_arg(&max_size_arg, 'b')) < 0) {
1630 snprintf(err_buf, sizeof err_buf,
1631 "--max-size value is invalid: %s\n",
1632 max_size_arg);
1633 return 0;
1635 break;
1637 case OPT_MIN_SIZE:
1638 if ((min_size = parse_size_arg(&min_size_arg, 'b')) < 0) {
1639 snprintf(err_buf, sizeof err_buf,
1640 "--min-size value is invalid: %s\n",
1641 min_size_arg);
1642 return 0;
1644 break;
1646 case OPT_BWLIMIT:
1648 OFF_T limit = parse_size_arg(&bwlimit_arg, 'K');
1649 if (limit < 0) {
1650 snprintf(err_buf, sizeof err_buf,
1651 "--bwlimit value is invalid: %s\n", bwlimit_arg);
1652 return 0;
1654 bwlimit = (limit + 512) / 1024;
1655 if (limit && !bwlimit) {
1656 snprintf(err_buf, sizeof err_buf,
1657 "--bwlimit value is too small: %s\n", bwlimit_arg);
1658 return 0;
1661 break;
1663 case OPT_APPEND:
1664 if (am_server)
1665 append_mode++;
1666 else
1667 append_mode = 1;
1668 break;
1670 case OPT_LINK_DEST:
1671 #ifdef SUPPORT_HARD_LINKS
1672 link_dest = 1;
1673 dest_option = "--link-dest";
1674 goto set_dest_dir;
1675 #else
1676 snprintf(err_buf, sizeof err_buf,
1677 "hard links are not supported on this %s\n",
1678 am_server ? "server" : "client");
1679 return 0;
1680 #endif
1682 case OPT_COPY_DEST:
1683 copy_dest = 1;
1684 dest_option = "--copy-dest";
1685 goto set_dest_dir;
1687 case OPT_COMPARE_DEST:
1688 compare_dest = 1;
1689 dest_option = "--compare-dest";
1690 set_dest_dir:
1691 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
1692 snprintf(err_buf, sizeof err_buf,
1693 "ERROR: at most %d %s args may be specified\n",
1694 MAX_BASIS_DIRS, dest_option);
1695 return 0;
1697 /* We defer sanitizing this arg until we know what
1698 * our destination directory is going to be. */
1699 basis_dir[basis_dir_cnt++] = (char *)poptGetOptArg(pc);
1700 break;
1702 case OPT_CHMOD:
1703 arg = poptGetOptArg(pc);
1704 if (!parse_chmod(arg, &chmod_modes)) {
1705 snprintf(err_buf, sizeof err_buf,
1706 "Invalid argument passed to --chmod (%s)\n",
1707 arg);
1708 return 0;
1710 break;
1712 case OPT_INFO:
1713 arg = poptGetOptArg(pc);
1714 parse_output_words(info_words, info_levels, arg, USER_PRIORITY);
1715 break;
1717 case OPT_DEBUG:
1718 arg = poptGetOptArg(pc);
1719 parse_output_words(debug_words, debug_levels, arg, USER_PRIORITY);
1720 break;
1722 case OPT_USERMAP:
1723 if (usermap) {
1724 if (usermap_via_chown) {
1725 snprintf(err_buf, sizeof err_buf,
1726 "--usermap conflicts with prior --chown.\n");
1727 return 0;
1729 snprintf(err_buf, sizeof err_buf,
1730 "You can only specify --usermap once.\n");
1731 return 0;
1733 usermap = (char *)poptGetOptArg(pc);
1734 usermap_via_chown = False;
1735 break;
1737 case OPT_GROUPMAP:
1738 if (groupmap) {
1739 if (groupmap_via_chown) {
1740 snprintf(err_buf, sizeof err_buf,
1741 "--groupmap conflicts with prior --chown.\n");
1742 return 0;
1744 snprintf(err_buf, sizeof err_buf,
1745 "You can only specify --groupmap once.\n");
1746 return 0;
1748 groupmap = (char *)poptGetOptArg(pc);
1749 groupmap_via_chown = False;
1750 break;
1752 case OPT_CHOWN: {
1753 const char *chown = poptGetOptArg(pc);
1754 int len;
1755 if ((arg = strchr(chown, ':')) != NULL)
1756 len = arg++ - chown;
1757 else
1758 len = strlen(chown);
1759 if (len) {
1760 if (usermap) {
1761 if (!usermap_via_chown) {
1762 snprintf(err_buf, sizeof err_buf,
1763 "--chown conflicts with prior --usermap.\n");
1764 return 0;
1766 snprintf(err_buf, sizeof err_buf,
1767 "You can only specify a user-affecting --chown once.\n");
1768 return 0;
1770 if (asprintf(&usermap, "*:%.*s", len, chown) < 0)
1771 out_of_memory("parse_arguments");
1772 usermap_via_chown = True;
1774 if (arg && *arg) {
1775 if (groupmap) {
1776 if (!groupmap_via_chown) {
1777 snprintf(err_buf, sizeof err_buf,
1778 "--chown conflicts with prior --groupmap.\n");
1779 return 0;
1781 snprintf(err_buf, sizeof err_buf,
1782 "You can only specify a group-affecting --chown once.\n");
1783 return 0;
1785 if (asprintf(&groupmap, "*:%s", arg) < 0)
1786 out_of_memory("parse_arguments");
1787 groupmap_via_chown = True;
1789 break;
1792 case OPT_HELP:
1793 usage(FINFO);
1794 exit_cleanup(0);
1796 case 'A':
1797 #ifdef SUPPORT_ACLS
1798 preserve_acls = 1;
1799 preserve_perms = 1;
1800 break;
1801 #else
1802 /* FIXME: this should probably be ignored with a
1803 * warning and then countermeasures taken to
1804 * restrict group and other access in the presence
1805 * of any more restrictive ACLs, but this is safe
1806 * for now */
1807 snprintf(err_buf,sizeof(err_buf),
1808 "ACLs are not supported on this %s\n",
1809 am_server ? "server" : "client");
1810 return 0;
1811 #endif
1813 case 'X':
1814 #ifdef SUPPORT_XATTRS
1815 preserve_xattrs++;
1816 break;
1817 #else
1818 snprintf(err_buf,sizeof(err_buf),
1819 "extended attributes are not supported on this %s\n",
1820 am_server ? "server" : "client");
1821 return 0;
1822 #endif
1824 default:
1825 /* A large opt value means that set_refuse_options()
1826 * turned this option off. */
1827 if (opt >= OPT_REFUSED_BASE) {
1828 create_refuse_error(opt);
1829 return 0;
1831 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
1832 am_server ? "on remote machine: " : "",
1833 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1834 poptStrerror(opt));
1835 return 0;
1839 if (protect_args < 0) {
1840 if (am_server)
1841 protect_args = 0;
1842 else if ((arg = getenv("RSYNC_PROTECT_ARGS")) != NULL && *arg)
1843 protect_args = atoi(arg) ? 1 : 0;
1844 else {
1845 #ifdef RSYNC_USE_PROTECTED_ARGS
1846 protect_args = 1;
1847 #else
1848 protect_args = 0;
1849 #endif
1853 if (checksum_choice && strcasecmp(checksum_choice, "auto") != 0 && strcasecmp(checksum_choice, "auto,auto") != 0) {
1854 /* Call this early to verify the args and figure out if we need to force
1855 * --whole-file. Note that the parse function will get called again later,
1856 * just in case an "auto" choice needs to know the protocol_version. */
1857 parse_checksum_choice(0);
1858 } else
1859 checksum_choice = NULL;
1861 if (human_readable > 1 && argc == 2 && !am_server) {
1862 /* Allow the old meaning of 'h' (--help) on its own. */
1863 usage(FINFO);
1864 exit_cleanup(0);
1867 if (!compress_choice && do_compression > 1)
1868 compress_choice = "zlibx";
1869 if (compress_choice && strcasecmp(compress_choice, "auto") != 0)
1870 parse_compress_choice(0); /* Twiddles do_compression and can possibly NULL-out compress_choice. */
1871 else
1872 compress_choice = NULL;
1874 if (do_compression || do_compression_level != CLVL_NOT_SPECIFIED) {
1875 if (!do_compression)
1876 do_compression = CPRES_AUTO;
1877 if (do_compression && refused_compress) {
1878 create_refuse_error(refused_compress);
1879 return 0;
1883 #ifdef HAVE_SETVBUF
1884 if (outbuf_mode && !am_server) {
1885 int mode = *(uchar *)outbuf_mode;
1886 if (islower(mode))
1887 mode = toupper(mode);
1888 fflush(stdout); /* Just in case... */
1889 switch (mode) {
1890 case 'N': /* None */
1891 case 'U': /* Unbuffered */
1892 mode = _IONBF;
1893 break;
1894 case 'L': /* Line */
1895 mode = _IOLBF;
1896 break;
1897 case 'B': /* Block */
1898 case 'F': /* Full */
1899 mode = _IOFBF;
1900 break;
1901 default:
1902 snprintf(err_buf, sizeof err_buf,
1903 "Invalid --outbuf setting -- specify N, L, or B.\n");
1904 return 0;
1906 setvbuf(stdout, (char *)NULL, mode, 0);
1909 if (msgs2stderr) {
1910 /* Make stderr line buffered for better sharing of the stream. */
1911 fflush(stderr); /* Just in case... */
1912 setvbuf(stderr, (char *)NULL, _IOLBF, 0);
1914 #endif
1916 set_output_verbosity(verbose, DEFAULT_PRIORITY);
1918 if (do_stats) {
1919 parse_output_words(info_words, info_levels,
1920 verbose > 1 ? "stats3" : "stats2", DEFAULT_PRIORITY);
1923 #ifdef ICONV_OPTION
1924 if (iconv_opt && protect_args != 2) {
1925 if (!am_server && strcmp(iconv_opt, "-") == 0)
1926 iconv_opt = NULL;
1927 else
1928 need_unsorted_flist = 1;
1930 if (refused_no_iconv && !iconv_opt) {
1931 create_refuse_error(refused_no_iconv);
1932 return 0;
1934 #endif
1936 if (fuzzy_basis > 1)
1937 fuzzy_basis = basis_dir_cnt + 1;
1939 /* Don't let the client reset protect_args if it was already processed */
1940 if (orig_protect_args == 2 && am_server)
1941 protect_args = orig_protect_args;
1943 if (protect_args == 1 && am_server)
1944 return 1;
1946 *argv_p = argv = poptGetArgs(pc);
1947 *argc_p = argc = count_args(argv);
1949 #ifndef SUPPORT_LINKS
1950 if (preserve_links && !am_sender) {
1951 snprintf(err_buf, sizeof err_buf,
1952 "symlinks are not supported on this %s\n",
1953 am_server ? "server" : "client");
1954 return 0;
1956 #endif
1958 #ifndef SUPPORT_HARD_LINKS
1959 if (preserve_hard_links) {
1960 snprintf(err_buf, sizeof err_buf,
1961 "hard links are not supported on this %s\n",
1962 am_server ? "server" : "client");
1963 return 0;
1965 #endif
1967 #ifdef SUPPORT_XATTRS
1968 if (am_root < 0 && preserve_xattrs > 1) {
1969 snprintf(err_buf, sizeof err_buf,
1970 "--fake-super conflicts with -XX\n");
1971 return 0;
1973 #else
1974 if (am_root < 0) {
1975 snprintf(err_buf, sizeof err_buf,
1976 "--fake-super requires an rsync with extended attributes enabled\n");
1977 return 0;
1979 #endif
1981 if (block_size) {
1982 /* We may not know the real protocol_version at this point if this is the client
1983 * option parsing, but we still want to check it so that the client can specify
1984 * a --protocol=29 option with a larger block size. */
1985 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
1987 if (block_size > max_blength) {
1988 snprintf(err_buf, sizeof err_buf,
1989 "--block-size=%lu is too large (max: %u)\n", block_size, max_blength);
1990 return 0;
1994 if (write_batch && read_batch) {
1995 snprintf(err_buf, sizeof err_buf,
1996 "--write-batch and --read-batch can not be used together\n");
1997 return 0;
1999 if (write_batch > 0 || read_batch) {
2000 if (am_server) {
2001 rprintf(FINFO,
2002 "ignoring --%s-batch option sent to server\n",
2003 write_batch ? "write" : "read");
2004 /* We don't actually exit_cleanup(), so that we can
2005 * still service older version clients that still send
2006 * batch args to server. */
2007 read_batch = write_batch = 0;
2008 batch_name = NULL;
2009 } else if (dry_run)
2010 write_batch = 0;
2011 } else if (write_batch < 0 && dry_run)
2012 write_batch = 0;
2013 if (read_batch && files_from) {
2014 snprintf(err_buf, sizeof err_buf,
2015 "--read-batch cannot be used with --files-from\n");
2016 return 0;
2018 if (read_batch && remove_source_files) {
2019 snprintf(err_buf, sizeof err_buf,
2020 "--read-batch cannot be used with --remove-%s-files\n",
2021 remove_source_files == 1 ? "source" : "sent");
2022 return 0;
2024 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
2025 snprintf(err_buf, sizeof err_buf,
2026 "the batch-file name must be %d characters or less.\n",
2027 MAX_BATCH_NAME_LEN);
2028 return 0;
2031 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
2032 snprintf(err_buf, sizeof err_buf,
2033 "the --temp-dir path is WAY too long.\n");
2034 return 0;
2037 if (max_delete < 0 && max_delete != INT_MIN) {
2038 /* Negative numbers are treated as "no deletions". */
2039 max_delete = 0;
2042 if (compare_dest + copy_dest + link_dest > 1) {
2043 snprintf(err_buf, sizeof err_buf,
2044 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
2045 return 0;
2048 if (files_from) {
2049 if (recurse == 1) /* preserve recurse == 2 */
2050 recurse = 0;
2051 if (xfer_dirs < 0)
2052 xfer_dirs = 1;
2055 if (argc < 2 && !read_batch && !am_server)
2056 list_only |= 1;
2058 if (xfer_dirs >= 4) {
2059 parse_filter_str(&filter_list, "- /*/*", rule_template(0), 0);
2060 recurse = xfer_dirs = 1;
2061 } else if (recurse)
2062 xfer_dirs = 1;
2063 else if (xfer_dirs < 0)
2064 xfer_dirs = list_only ? 1 : 0;
2066 if (relative_paths < 0)
2067 relative_paths = files_from? 1 : 0;
2068 if (!relative_paths)
2069 implied_dirs = 0;
2071 if (delete_before + !!delete_during + delete_after > 1) {
2072 snprintf(err_buf, sizeof err_buf,
2073 "You may not combine multiple --delete-WHEN options.\n");
2074 return 0;
2076 if (delete_before || delete_during || delete_after)
2077 delete_mode = 1;
2078 else if (delete_mode || delete_excluded) {
2079 /* Only choose now between before & during if one is refused. */
2080 if (refused_delete_before) {
2081 if (!refused_delete_during)
2082 delete_during = 1;
2083 else {
2084 create_refuse_error(refused_delete_before);
2085 return 0;
2087 } else if (refused_delete_during)
2088 delete_before = 1;
2089 delete_mode = 1;
2091 if (!xfer_dirs && delete_mode) {
2092 snprintf(err_buf, sizeof err_buf,
2093 "--delete does not work without --recursive (-r) or --dirs (-d).\n");
2094 return 0;
2097 if (missing_args == 3) /* simplify if both options were specified */
2098 missing_args = 2;
2099 if (refused_delete && (delete_mode || missing_args == 2)) {
2100 create_refuse_error(refused_delete);
2101 return 0;
2104 if (remove_source_files) {
2105 /* We only want to infer this refusal of --remove-source-files
2106 * via the refusal of "delete", not any of the "delete-FOO"
2107 * options. */
2108 if (refused_delete && am_sender) {
2109 create_refuse_error(refused_delete);
2110 return 0;
2112 need_messages_from_generator = 1;
2115 if (munge_symlinks && !am_daemon) {
2116 STRUCT_STAT st;
2117 char prefix[SYMLINK_PREFIX_LEN]; /* NOT +1 ! */
2118 strlcpy(prefix, SYMLINK_PREFIX, sizeof prefix); /* trim the trailing slash */
2119 if (do_stat(prefix, &st) == 0 && S_ISDIR(st.st_mode)) {
2120 rprintf(FERROR, "Symlink munging is unsafe when a %s directory exists.\n",
2121 prefix);
2122 exit_cleanup(RERR_UNSUPPORTED);
2126 if (sanitize_paths) {
2127 int i;
2128 for (i = argc; i-- > 0; )
2129 argv[i] = sanitize_path(NULL, argv[i], "", 0, SP_KEEP_DOT_DIRS);
2130 if (tmpdir)
2131 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0, SP_DEFAULT);
2132 if (backup_dir)
2133 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0, SP_DEFAULT);
2135 if (daemon_filter_list.head && !am_sender) {
2136 filter_rule_list *elp = &daemon_filter_list;
2137 if (tmpdir) {
2138 char *dir;
2139 if (!*tmpdir)
2140 goto options_rejected;
2141 dir = tmpdir + (*tmpdir == '/' ? module_dirlen : 0);
2142 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2143 if (check_filter(elp, FLOG, dir, 1) < 0)
2144 goto options_rejected;
2146 if (backup_dir) {
2147 char *dir;
2148 if (!*backup_dir)
2149 goto options_rejected;
2150 dir = backup_dir + (*backup_dir == '/' ? module_dirlen : 0);
2151 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2152 if (check_filter(elp, FLOG, dir, 1) < 0)
2153 goto options_rejected;
2157 if (!backup_suffix)
2158 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
2159 backup_suffix_len = strlen(backup_suffix);
2160 if (strchr(backup_suffix, '/') != NULL) {
2161 snprintf(err_buf, sizeof err_buf,
2162 "--suffix cannot contain slashes: %s\n",
2163 backup_suffix);
2164 return 0;
2166 if (backup_dir) {
2167 size_t len;
2168 while (*backup_dir == '.' && backup_dir[1] == '/')
2169 backup_dir += 2;
2170 if (*backup_dir == '.' && backup_dir[1] == '\0')
2171 backup_dir++;
2172 len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
2173 if (len > sizeof backup_dir_buf - 128) {
2174 snprintf(err_buf, sizeof err_buf,
2175 "the --backup-dir path is WAY too long.\n");
2176 return 0;
2178 backup_dir_len = (int)len;
2179 if (!backup_dir_len) {
2180 backup_dir_len = -1;
2181 backup_dir = NULL;
2182 } else if (backup_dir_buf[backup_dir_len - 1] != '/') {
2183 backup_dir_buf[backup_dir_len++] = '/';
2184 backup_dir_buf[backup_dir_len] = '\0';
2186 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
2188 if (backup_dir) {
2189 /* No need for a suffix or a protect rule. */
2190 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
2191 snprintf(err_buf, sizeof err_buf,
2192 "--suffix cannot be empty %s\n", backup_dir_len < 0
2193 ? "when --backup-dir is the same as the dest dir"
2194 : "without a --backup-dir");
2195 return 0;
2196 } else if (make_backups && delete_mode && !delete_excluded && !am_server) {
2197 snprintf(backup_dir_buf, sizeof backup_dir_buf,
2198 "P *%s", backup_suffix);
2199 parse_filter_str(&filter_list, backup_dir_buf, rule_template(0), 0);
2202 if (preserve_times) {
2203 preserve_times = PRESERVE_FILE_TIMES;
2204 if (!omit_dir_times)
2205 preserve_times |= PRESERVE_DIR_TIMES;
2206 #ifdef CAN_SET_SYMLINK_TIMES
2207 if (!omit_link_times)
2208 preserve_times |= PRESERVE_LINK_TIMES;
2209 #endif
2212 if (make_backups && !backup_dir) {
2213 omit_dir_times = 0; /* Implied, so avoid -O to sender. */
2214 preserve_times &= ~PRESERVE_DIR_TIMES;
2217 if (stdout_format) {
2218 if (am_server && log_format_has(stdout_format, 'I'))
2219 stdout_format_has_i = 2;
2220 else if (log_format_has(stdout_format, 'i'))
2221 stdout_format_has_i = itemize_changes | 1;
2222 if (!log_format_has(stdout_format, 'b')
2223 && !log_format_has(stdout_format, 'c')
2224 && !log_format_has(stdout_format, 'C'))
2225 log_before_transfer = !am_server;
2226 } else if (itemize_changes) {
2227 stdout_format = "%i %n%L";
2228 stdout_format_has_i = itemize_changes;
2229 log_before_transfer = !am_server;
2232 if (do_progress && !am_server) {
2233 if (!log_before_transfer && INFO_EQ(NAME, 0))
2234 parse_output_words(info_words, info_levels, "name", DEFAULT_PRIORITY);
2235 parse_output_words(info_words, info_levels, "flist2,progress", DEFAULT_PRIORITY);
2238 if (dry_run)
2239 do_xfers = 0;
2241 set_io_timeout(io_timeout);
2243 if (INFO_GTE(NAME, 1) && !stdout_format) {
2244 stdout_format = "%n%L";
2245 log_before_transfer = !am_server;
2247 if (stdout_format_has_i || log_format_has(stdout_format, 'o'))
2248 stdout_format_has_o_or_i = 1;
2250 if (logfile_name && !am_daemon) {
2251 if (!logfile_format) {
2252 logfile_format = "%i %n%L";
2253 logfile_format_has_i = logfile_format_has_o_or_i = 1;
2254 } else {
2255 if (log_format_has(logfile_format, 'i'))
2256 logfile_format_has_i = 1;
2257 if (logfile_format_has_i || log_format_has(logfile_format, 'o'))
2258 logfile_format_has_o_or_i = 1;
2260 log_init(0);
2261 } else if (!am_daemon)
2262 logfile_format = NULL;
2264 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
2265 bwlimit = daemon_bwlimit;
2266 if (bwlimit) {
2267 bwlimit_writemax = (size_t)bwlimit * 128;
2268 if (bwlimit_writemax < 512)
2269 bwlimit_writemax = 512;
2272 if (append_mode) {
2273 if (whole_file > 0) {
2274 snprintf(err_buf, sizeof err_buf,
2275 "--append cannot be used with --whole-file\n");
2276 return 0;
2278 if (refused_inplace) {
2279 create_refuse_error(refused_inplace);
2280 return 0;
2282 inplace = 1;
2285 if (write_devices) {
2286 if (refused_inplace) {
2287 create_refuse_error(refused_inplace);
2288 return 0;
2290 inplace = 1;
2293 if (delay_updates && !partial_dir)
2294 partial_dir = tmp_partialdir;
2296 if (inplace) {
2297 #ifdef HAVE_FTRUNCATE
2298 if (partial_dir) {
2299 snprintf(err_buf, sizeof err_buf,
2300 "--%s cannot be used with --%s\n",
2301 append_mode ? "append" : "inplace",
2302 delay_updates ? "delay-updates" : "partial-dir");
2303 return 0;
2305 /* --inplace implies --partial for refusal purposes, but we
2306 * clear the keep_partial flag for internal logic purposes. */
2307 if (refused_partial) {
2308 create_refuse_error(refused_partial);
2309 return 0;
2311 keep_partial = 0;
2312 #else
2313 snprintf(err_buf, sizeof err_buf,
2314 "--%s is not supported on this %s\n",
2315 append_mode ? "append" : "inplace",
2316 am_server ? "server" : "client");
2317 return 0;
2318 #endif
2319 } else {
2320 if (keep_partial && !partial_dir && !am_server) {
2321 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
2322 partial_dir = strdup(arg);
2324 if (partial_dir) {
2325 if (*partial_dir)
2326 clean_fname(partial_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2327 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
2328 partial_dir = NULL;
2329 if (!partial_dir && refused_partial) {
2330 create_refuse_error(refused_partial);
2331 return 0;
2333 keep_partial = 1;
2337 if (files_from) {
2338 char *h, *p;
2339 int q;
2340 if (argc > 2 || (!am_daemon && !am_server && argc == 1)) {
2341 usage(FERROR);
2342 exit_cleanup(RERR_SYNTAX);
2344 if (strcmp(files_from, "-") == 0) {
2345 filesfrom_fd = 0;
2346 if (am_server)
2347 filesfrom_host = ""; /* reading from socket */
2348 } else if ((p = check_for_hostspec(files_from, &h, &q)) != 0) {
2349 if (am_server) {
2350 snprintf(err_buf, sizeof err_buf,
2351 "The --files-from sent to the server cannot specify a host.\n");
2352 return 0;
2354 files_from = p;
2355 filesfrom_host = h;
2356 if (strcmp(files_from, "-") == 0) {
2357 snprintf(err_buf, sizeof err_buf,
2358 "Invalid --files-from remote filename\n");
2359 return 0;
2361 } else {
2362 if (sanitize_paths)
2363 files_from = sanitize_path(NULL, files_from, NULL, 0, SP_DEFAULT);
2364 if (daemon_filter_list.head) {
2365 char *dir;
2366 if (!*files_from)
2367 goto options_rejected;
2368 dir = files_from + (*files_from == '/' ? module_dirlen : 0);
2369 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2370 if (check_filter(&daemon_filter_list, FLOG, dir, 0) < 0)
2371 goto options_rejected;
2373 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
2374 if (filesfrom_fd < 0) {
2375 snprintf(err_buf, sizeof err_buf,
2376 "failed to open files-from file %s: %s\n",
2377 files_from, strerror(errno));
2378 return 0;
2383 am_starting_up = 0;
2385 return 1;
2387 options_rejected:
2388 snprintf(err_buf, sizeof err_buf,
2389 "Your options have been rejected by the server.\n");
2390 return 0;
2395 * Construct a filtered list of options to pass through from the
2396 * client to the server.
2398 * This involves setting options that will tell the server how to
2399 * behave, and also filtering out options that are processed only
2400 * locally.
2402 void server_options(char **args, int *argc_p)
2404 static char argstr[64];
2405 int ac = *argc_p;
2406 uchar where;
2407 char *arg;
2408 int i, x;
2410 /* This should always remain first on the server's command-line. */
2411 args[ac++] = "--server";
2413 if (daemon_over_rsh > 0) {
2414 args[ac++] = "--daemon";
2415 *argc_p = ac;
2416 /* if we're passing --daemon, we're done */
2417 return;
2420 if (!am_sender)
2421 args[ac++] = "--sender";
2423 x = 1;
2424 argstr[0] = '-';
2426 if (protect_args)
2427 argstr[x++] = 's';
2429 for (i = 0; i < verbose; i++)
2430 argstr[x++] = 'v';
2432 if (quiet && msgs2stderr)
2433 argstr[x++] = 'q';
2434 if (make_backups)
2435 argstr[x++] = 'b';
2436 if (update_only)
2437 argstr[x++] = 'u';
2438 if (!do_xfers) /* Note: NOT "dry_run"! */
2439 argstr[x++] = 'n';
2440 if (preserve_links)
2441 argstr[x++] = 'l';
2442 if ((xfer_dirs >= 2 && xfer_dirs < 4)
2443 || (xfer_dirs && !recurse && (list_only || (delete_mode && am_sender))))
2444 argstr[x++] = 'd';
2445 if (am_sender) {
2446 if (keep_dirlinks)
2447 argstr[x++] = 'K';
2448 if (prune_empty_dirs)
2449 argstr[x++] = 'm';
2450 if (omit_dir_times)
2451 argstr[x++] = 'O';
2452 if (omit_link_times)
2453 argstr[x++] = 'J';
2454 if (fuzzy_basis) {
2455 argstr[x++] = 'y';
2456 if (fuzzy_basis > 1)
2457 argstr[x++] = 'y';
2459 } else {
2460 if (copy_links)
2461 argstr[x++] = 'L';
2462 if (copy_dirlinks)
2463 argstr[x++] = 'k';
2466 if (whole_file > 0)
2467 argstr[x++] = 'W';
2468 /* We don't need to send --no-whole-file, because it's the
2469 * default for remote transfers, and in any case old versions
2470 * of rsync will not understand it. */
2472 if (preserve_hard_links) {
2473 argstr[x++] = 'H';
2474 if (preserve_hard_links > 1)
2475 argstr[x++] = 'H';
2477 if (preserve_uid)
2478 argstr[x++] = 'o';
2479 if (preserve_gid)
2480 argstr[x++] = 'g';
2481 if (preserve_devices) /* ignore preserve_specials here */
2482 argstr[x++] = 'D';
2483 if (preserve_times)
2484 argstr[x++] = 't';
2485 if (preserve_atimes) {
2486 argstr[x++] = 'U';
2487 if (preserve_atimes > 1)
2488 argstr[x++] = 'U';
2490 if (preserve_perms)
2491 argstr[x++] = 'p';
2492 else if (preserve_executability && am_sender)
2493 argstr[x++] = 'E';
2494 #ifdef SUPPORT_ACLS
2495 if (preserve_acls)
2496 argstr[x++] = 'A';
2497 #endif
2498 #ifdef SUPPORT_XATTRS
2499 if (preserve_xattrs) {
2500 argstr[x++] = 'X';
2501 if (preserve_xattrs > 1)
2502 argstr[x++] = 'X';
2504 #endif
2505 if (recurse)
2506 argstr[x++] = 'r';
2507 if (always_checksum)
2508 argstr[x++] = 'c';
2509 if (cvs_exclude)
2510 argstr[x++] = 'C';
2511 if (ignore_times)
2512 argstr[x++] = 'I';
2513 if (relative_paths)
2514 argstr[x++] = 'R';
2515 if (one_file_system) {
2516 argstr[x++] = 'x';
2517 if (one_file_system > 1)
2518 argstr[x++] = 'x';
2520 if (sparse_files)
2521 argstr[x++] = 'S';
2522 if (do_compression == CPRES_ZLIB)
2523 argstr[x++] = 'z';
2525 set_allow_inc_recurse();
2527 /* We don't really know the actual protocol_version at this point,
2528 * but checking the pre-negotiated value allows the user to use a
2529 * --protocol=29 override to avoid the use of this -eFLAGS opt. */
2530 if (protocol_version >= 30) {
2531 /* Use "eFlags" alias so that cull_options doesn't think that these are no-arg option letters. */
2532 #define eFlags argstr
2533 /* We make use of the -e option to let the server know about
2534 * any pre-release protocol version && some behavior flags. */
2535 eFlags[x++] = 'e';
2536 #if SUBPROTOCOL_VERSION != 0
2537 if (protocol_version == PROTOCOL_VERSION) {
2538 x += snprintf(argstr+x, sizeof argstr - x,
2539 "%d.%d",
2540 PROTOCOL_VERSION, SUBPROTOCOL_VERSION);
2541 } else
2542 #endif
2543 eFlags[x++] = '.';
2544 if (allow_inc_recurse)
2545 eFlags[x++] = 'i';
2546 #ifdef CAN_SET_SYMLINK_TIMES
2547 eFlags[x++] = 'L'; /* symlink time-setting support */
2548 #endif
2549 #ifdef ICONV_OPTION
2550 eFlags[x++] = 's'; /* symlink iconv translation support */
2551 #endif
2552 eFlags[x++] = 'f'; /* flist I/O-error safety support */
2553 eFlags[x++] = 'x'; /* xattr hardlink optimization not desired */
2554 eFlags[x++] = 'C'; /* support checksum seed order fix */
2555 eFlags[x++] = 'I'; /* support inplace_partial behavior */
2556 eFlags[x++] = 'v'; /* use varint for flist & compat flags; negotiate checksum */
2557 /* NOTE: Avoid using 'V' -- it was the high bit of a write_byte() that became write_varint(). */
2558 #undef eFlags
2561 if (x >= (int)sizeof argstr) { /* Not possible... */
2562 rprintf(FERROR, "argstr overflow in server_options().\n");
2563 exit_cleanup(RERR_MALLOC);
2566 argstr[x] = '\0';
2568 if (x > 1)
2569 args[ac++] = argstr;
2571 #ifdef ICONV_OPTION
2572 if (iconv_opt) {
2573 char *set = strchr(iconv_opt, ',');
2574 if (set)
2575 set++;
2576 else
2577 set = iconv_opt;
2578 if (asprintf(&arg, "--iconv=%s", set) < 0)
2579 goto oom;
2580 args[ac++] = arg;
2582 #endif
2584 if (protect_args && !local_server) /* unprotected args stop here */
2585 args[ac++] = NULL;
2587 if (list_only > 1)
2588 args[ac++] = "--list-only";
2590 /* This makes sure that the remote rsync can handle deleting with -d
2591 * sans -r because the --no-r option was added at the same time. */
2592 if (xfer_dirs && !recurse && delete_mode && am_sender)
2593 args[ac++] = "--no-r";
2595 if (do_compression && do_compression_level != CLVL_NOT_SPECIFIED) {
2596 if (asprintf(&arg, "--compress-level=%d", do_compression_level) < 0)
2597 goto oom;
2598 args[ac++] = arg;
2601 if (preserve_devices) {
2602 /* Note: sending "--devices" would not be backward-compatible. */
2603 if (!preserve_specials)
2604 args[ac++] = "--no-specials"; /* -D is already set. */
2605 } else if (preserve_specials)
2606 args[ac++] = "--specials";
2608 /* The server side doesn't use our log-format, but in certain
2609 * circumstances they need to know a little about the option. */
2610 if (stdout_format && am_sender) {
2611 /* Use --log-format, not --out-format, for compatibility. */
2612 if (stdout_format_has_i > 1)
2613 args[ac++] = "--log-format=%i%I";
2614 else if (stdout_format_has_i)
2615 args[ac++] = "--log-format=%i";
2616 else if (stdout_format_has_o_or_i)
2617 args[ac++] = "--log-format=%o";
2618 else if (!verbose)
2619 args[ac++] = "--log-format=X";
2622 if (block_size) {
2623 if (asprintf(&arg, "-B%lu", block_size) < 0)
2624 goto oom;
2625 args[ac++] = arg;
2628 if (io_timeout) {
2629 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
2630 goto oom;
2631 args[ac++] = arg;
2634 if (bwlimit) {
2635 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
2636 goto oom;
2637 args[ac++] = arg;
2640 if (backup_dir) {
2641 args[ac++] = "--backup-dir";
2642 args[ac++] = backup_dir;
2645 /* Only send --suffix if it specifies a non-default value. */
2646 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
2647 /* We use the following syntax to avoid weirdness with '~'. */
2648 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
2649 goto oom;
2650 args[ac++] = arg;
2653 if (checksum_choice) {
2654 if (asprintf(&arg, "--checksum-choice=%s", checksum_choice) < 0)
2655 goto oom;
2656 args[ac++] = arg;
2659 if (do_compression == CPRES_ZLIBX)
2660 args[ac++] = "--new-compress";
2661 else if (compress_choice && do_compression == CPRES_ZLIB)
2662 args[ac++] = "--old-compress";
2663 else if (compress_choice) {
2664 if (asprintf(&arg, "--compress-choice=%s", compress_choice) < 0)
2665 goto oom;
2666 args[ac++] = arg;
2669 if (am_sender) {
2670 if (max_delete > 0) {
2671 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
2672 goto oom;
2673 args[ac++] = arg;
2674 } else if (max_delete == 0)
2675 args[ac++] = "--max-delete=-1";
2676 if (min_size >= 0) {
2677 args[ac++] = "--min-size";
2678 args[ac++] = min_size_arg;
2680 if (max_size >= 0) {
2681 args[ac++] = "--max-size";
2682 args[ac++] = max_size_arg;
2684 if (delete_before)
2685 args[ac++] = "--delete-before";
2686 else if (delete_during == 2)
2687 args[ac++] = "--delete-delay";
2688 else if (delete_during)
2689 args[ac++] = "--delete-during";
2690 else if (delete_after)
2691 args[ac++] = "--delete-after";
2692 else if (delete_mode && !delete_excluded)
2693 args[ac++] = "--delete";
2694 if (delete_excluded)
2695 args[ac++] = "--delete-excluded";
2696 if (force_delete)
2697 args[ac++] = "--force";
2698 if (write_batch < 0)
2699 args[ac++] = "--only-write-batch=X";
2700 if (am_root > 1)
2701 args[ac++] = "--super";
2702 if (size_only)
2703 args[ac++] = "--size-only";
2704 if (do_stats)
2705 args[ac++] = "--stats";
2706 } else {
2707 if (skip_compress) {
2708 if (asprintf(&arg, "--skip-compress=%s", skip_compress) < 0)
2709 goto oom;
2710 args[ac++] = arg;
2714 /* --delete-missing-args needs the cooperation of both sides, but
2715 * the sender can handle --ignore-missing-args by itself. */
2716 if (missing_args == 2)
2717 args[ac++] = "--delete-missing-args";
2718 else if (missing_args == 1 && !am_sender)
2719 args[ac++] = "--ignore-missing-args";
2721 if (modify_window_set && am_sender) {
2722 char *fmt = modify_window < 0 ? "-@%d" : "--modify-window=%d";
2723 if (asprintf(&arg, fmt, modify_window) < 0)
2724 goto oom;
2725 args[ac++] = arg;
2728 if (checksum_seed) {
2729 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
2730 goto oom;
2731 args[ac++] = arg;
2734 if (partial_dir && am_sender) {
2735 if (partial_dir != tmp_partialdir) {
2736 args[ac++] = "--partial-dir";
2737 args[ac++] = partial_dir;
2739 if (delay_updates)
2740 args[ac++] = "--delay-updates";
2741 } else if (keep_partial && am_sender)
2742 args[ac++] = "--partial";
2744 if (ignore_errors)
2745 args[ac++] = "--ignore-errors";
2747 if (copy_unsafe_links)
2748 args[ac++] = "--copy-unsafe-links";
2750 if (safe_symlinks)
2751 args[ac++] = "--safe-links";
2753 if (numeric_ids)
2754 args[ac++] = "--numeric-ids";
2756 if (use_qsort)
2757 args[ac++] = "--use-qsort";
2759 if (am_sender) {
2760 if (usermap) {
2761 if (asprintf(&arg, "--usermap=%s", usermap) < 0)
2762 goto oom;
2763 args[ac++] = arg;
2766 if (groupmap) {
2767 if (asprintf(&arg, "--groupmap=%s", groupmap) < 0)
2768 goto oom;
2769 args[ac++] = arg;
2772 if (ignore_existing)
2773 args[ac++] = "--ignore-existing";
2775 /* Backward compatibility: send --existing, not --ignore-non-existing. */
2776 if (ignore_non_existing)
2777 args[ac++] = "--existing";
2779 if (tmpdir) {
2780 args[ac++] = "--temp-dir";
2781 args[ac++] = tmpdir;
2784 if (basis_dir[0]) {
2785 /* the server only needs this option if it is not the sender,
2786 * and it may be an older version that doesn't know this
2787 * option, so don't send it if client is the sender.
2789 for (i = 0; i < basis_dir_cnt; i++) {
2790 args[ac++] = dest_option;
2791 args[ac++] = basis_dir[i];
2796 /* What flags do we need to send to the other side? */
2797 where = (am_server ? W_CLI : W_SRV) | (am_sender ? W_REC : W_SND);
2798 arg = make_output_option(info_words, info_levels, where);
2799 if (arg)
2800 args[ac++] = arg;
2802 if (append_mode) {
2803 if (append_mode > 1)
2804 args[ac++] = "--append";
2805 args[ac++] = "--append";
2806 } else if (inplace)
2807 args[ac++] = "--inplace";
2809 if (files_from && (!am_sender || filesfrom_host)) {
2810 if (filesfrom_host) {
2811 args[ac++] = "--files-from";
2812 args[ac++] = files_from;
2813 if (eol_nulls)
2814 args[ac++] = "--from0";
2815 } else {
2816 args[ac++] = "--files-from=-";
2817 args[ac++] = "--from0";
2819 if (!relative_paths)
2820 args[ac++] = "--no-relative";
2822 /* It's OK that this checks the upper-bound of the protocol_version. */
2823 if (relative_paths && !implied_dirs && (!am_sender || protocol_version >= 30))
2824 args[ac++] = "--no-implied-dirs";
2826 if (write_devices && am_sender)
2827 args[ac++] = "--write-devices";
2829 if (remove_source_files == 1)
2830 args[ac++] = "--remove-source-files";
2831 else if (remove_source_files)
2832 args[ac++] = "--remove-sent-files";
2834 if (preallocate_files && am_sender)
2835 args[ac++] = "--preallocate";
2837 if (open_noatime && preserve_atimes <= 1)
2838 args[ac++] = "--open-noatime";
2840 if (ac > MAX_SERVER_ARGS) { /* Not possible... */
2841 rprintf(FERROR, "argc overflow in server_options().\n");
2842 exit_cleanup(RERR_MALLOC);
2845 if (remote_option_cnt) {
2846 int j;
2847 if (ac + remote_option_cnt > MAX_SERVER_ARGS) {
2848 rprintf(FERROR, "too many remote options specified.\n");
2849 exit_cleanup(RERR_SYNTAX);
2851 for (j = 1; j <= remote_option_cnt; j++)
2852 args[ac++] = (char*)remote_options[j];
2855 *argc_p = ac;
2856 return;
2858 oom:
2859 out_of_memory("server_options");
2862 /* If str points to a valid hostspec, return allocated memory containing the
2863 * [USER@]HOST part of the string, and set the path_start_ptr to the part of
2864 * the string after the host part. Otherwise, return NULL. If port_ptr is
2865 * non-NULL, we must be parsing an rsync:// URL hostname, and we will set
2866 * *port_ptr if a port number is found. Note that IPv6 IPs will have their
2867 * (required for parsing) [ and ] chars elided from the returned string. */
2868 static char *parse_hostspec(char *str, char **path_start_ptr, int *port_ptr)
2870 char *s, *host_start = str;
2871 int hostlen = 0, userlen = 0;
2872 char *ret;
2874 for (s = str; ; s++) {
2875 if (!*s) {
2876 /* It is only OK if we run out of string with rsync:// */
2877 if (!port_ptr)
2878 return NULL;
2879 if (!hostlen)
2880 hostlen = s - host_start;
2881 break;
2883 if (*s == ':' || *s == '/') {
2884 if (!hostlen)
2885 hostlen = s - host_start;
2886 if (*s++ == '/') {
2887 if (!port_ptr)
2888 return NULL;
2889 } else if (port_ptr) {
2890 *port_ptr = atoi(s);
2891 while (isDigit(s)) s++;
2892 if (*s && *s++ != '/')
2893 return NULL;
2895 break;
2897 if (*s == '@') {
2898 userlen = s - str + 1;
2899 host_start = s + 1;
2900 } else if (*s == '[') {
2901 if (s != host_start++)
2902 return NULL;
2903 while (*s && *s != ']' && *s != '/') s++; /*SHARED ITERATOR*/
2904 hostlen = s - host_start;
2905 if (*s != ']' || (s[1] && s[1] != '/' && s[1] != ':') || !hostlen)
2906 return NULL;
2910 *path_start_ptr = s;
2911 ret = new_array(char, userlen + hostlen + 1);
2912 if (userlen)
2913 strlcpy(ret, str, userlen + 1);
2914 strlcpy(ret + userlen, host_start, hostlen + 1);
2915 return ret;
2918 /* Look for a HOST specification of the form "HOST:PATH", "HOST::PATH", or
2919 * "rsync://HOST:PORT/PATH". If found, *host_ptr will be set to some allocated
2920 * memory with the HOST. If a daemon-accessing spec was specified, the value
2921 * of *port_ptr will contain a non-0 port number, otherwise it will be set to
2922 * 0. The return value is a pointer to the PATH. Note that the HOST spec can
2923 * be an IPv6 literal address enclosed in '[' and ']' (such as "[::1]" or
2924 * "[::ffff:127.0.0.1]") which is returned without the '[' and ']'. */
2925 char *check_for_hostspec(char *s, char **host_ptr, int *port_ptr)
2927 char *path;
2929 if (port_ptr && strncasecmp(URL_PREFIX, s, strlen(URL_PREFIX)) == 0) {
2930 *host_ptr = parse_hostspec(s + strlen(URL_PREFIX), &path, port_ptr);
2931 if (*host_ptr) {
2932 if (!*port_ptr)
2933 *port_ptr = -1; /* -1 indicates they want the default */
2934 return path;
2938 *host_ptr = parse_hostspec(s, &path, NULL);
2939 if (!*host_ptr)
2940 return NULL;
2942 if (*path == ':') {
2943 if (port_ptr && !*port_ptr)
2944 *port_ptr = -1;
2945 return path + 1;
2947 if (port_ptr)
2948 *port_ptr = 0;
2950 return path;