Remove xxhash from capabilities list.
[rsync.git] / options.c
blob9f5a24d6b68d43be91dc4fbab47de0dd6e07c5b6
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 void print_rsync_version(enum logcode f)
571 char tmpbuf[256];
572 char *subprotocol = "";
573 char const *got_socketpair = "no ";
574 char const *have_inplace = "no ";
575 char const *hardlinks = "no ";
576 char const *prealloc = "no ";
577 char const *symtimes = "no ";
578 char const *acls = "no ";
579 char const *xattrs = "no ";
580 char const *links = "no ";
581 char const *iconv = "no ";
582 char const *ipv6 = "no ";
583 char const *simd = "no ";
584 STRUCT_STAT *dumstat;
586 #if SUBPROTOCOL_VERSION != 0
587 if (asprintf(&subprotocol, ".PR%d", SUBPROTOCOL_VERSION) < 0)
588 out_of_memory("print_rsync_version");
589 #endif
590 #ifdef HAVE_SOCKETPAIR
591 got_socketpair = "";
592 #endif
593 #ifdef HAVE_FTRUNCATE
594 have_inplace = "";
595 #endif
596 #ifdef SUPPORT_HARD_LINKS
597 hardlinks = "";
598 #endif
599 #ifdef SUPPORT_PREALLOCATION
600 prealloc = "";
601 #endif
602 #ifdef SUPPORT_ACLS
603 acls = "";
604 #endif
605 #ifdef SUPPORT_XATTRS
606 xattrs = "";
607 #endif
608 #ifdef SUPPORT_LINKS
609 links = "";
610 #endif
611 #ifdef INET6
612 ipv6 = "";
613 #endif
614 #ifdef ICONV_OPTION
615 iconv = "";
616 #endif
617 #ifdef CAN_SET_SYMLINK_TIMES
618 symtimes = "";
619 #endif
620 #ifdef HAVE_SIMD
621 simd = "";
622 #endif
624 rprintf(f, "%s version %s protocol version %d%s\n",
625 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION, subprotocol);
626 rprintf(f, "Copyright (C) 1996-" LATEST_YEAR " by Andrew Tridgell, Wayne Davison, and others.\n");
627 rprintf(f, "Web site: http://rsync.samba.org/\n");
628 rprintf(f, "Capabilities:\n");
629 rprintf(f, " %d-bit files, %d-bit inums, %d-bit timestamps, %d-bit long ints,\n",
630 (int)(sizeof (OFF_T) * 8),
631 (int)(sizeof dumstat->st_ino * 8), /* Don't check ino_t! */
632 (int)(sizeof (time_t) * 8),
633 (int)(sizeof (int64) * 8));
634 rprintf(f, " %ssocketpairs, %shardlinks, %ssymlinks, %sIPv6, batchfiles, %sinplace,\n",
635 got_socketpair, hardlinks, links, ipv6, have_inplace);
636 rprintf(f, " %sappend, %sACLs, %sxattrs, %siconv, %ssymtimes, %sprealloc, %sSIMD\n",
637 have_inplace, acls, xattrs, iconv, symtimes, prealloc, simd);
639 rprintf(f,"\n");
641 get_default_nno_list(&valid_checksums, tmpbuf, sizeof tmpbuf, '(');
642 rprintf(f, "Checksum list: %s\n", tmpbuf);
644 get_default_nno_list(&valid_compressions, tmpbuf, sizeof tmpbuf, '(');
645 rprintf(f, "Compress list: %s\n", tmpbuf);
647 #ifdef MAINTAINER_MODE
648 rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
649 #endif
651 #if SIZEOF_INT64 < 8
652 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
653 #endif
654 if (sizeof (int64) != SIZEOF_INT64) {
655 rprintf(f,
656 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
657 (int) SIZEOF_INT64, (int) sizeof (int64));
660 rprintf(f,"\n");
661 rprintf(f,"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n");
662 rprintf(f,"are welcome to redistribute it under certain conditions. See the GNU\n");
663 rprintf(f,"General Public Licence for details.\n");
667 void usage(enum logcode F)
669 print_rsync_version(F);
671 rprintf(F,"\n");
672 rprintf(F,"rsync is a file transfer program capable of efficient remote update\n");
673 rprintf(F,"via a fast differencing algorithm.\n");
675 rprintf(F,"\n");
676 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... DEST\n");
677 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
678 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
679 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
680 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC [DEST]\n");
681 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
682 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
683 rprintf(F,"The ':' usages connect via remote shell, while '::' & 'rsync://' usages connect\n");
684 rprintf(F,"to an rsync daemon, and require SRC or DEST to start with a module name.\n");
685 rprintf(F,"\n");
686 rprintf(F,"Options\n");
687 rprintf(F," -v, --verbose increase verbosity\n");
688 rprintf(F," --info=FLAGS fine-grained informational verbosity\n");
689 rprintf(F," --debug=FLAGS fine-grained debug verbosity\n");
690 rprintf(F," --msgs2stderr special output handling for debugging\n");
691 rprintf(F," -q, --quiet suppress non-error messages\n");
692 rprintf(F," --no-motd suppress daemon-mode MOTD (see manpage caveat)\n");
693 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
694 rprintf(F," -a, --archive archive mode; equals -rlptgoD (no -H,-A,-X)\n");
695 rprintf(F," --no-OPTION turn off an implied OPTION (e.g. --no-D)\n");
696 rprintf(F," -r, --recursive recurse into directories\n");
697 rprintf(F," -R, --relative use relative path names\n");
698 rprintf(F," --no-implied-dirs don't send implied dirs with --relative\n");
699 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
700 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
701 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
702 rprintf(F," -u, --update skip files that are newer on the receiver\n");
703 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
704 rprintf(F," --append append data onto shorter files\n");
705 rprintf(F," --append-verify like --append, but with old data in file checksum\n");
706 rprintf(F," -d, --dirs transfer directories without recursing\n");
707 rprintf(F," -l, --links copy symlinks as symlinks\n");
708 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
709 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
710 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
711 rprintf(F," --munge-links munge symlinks to make them safer (but unusable)\n");
712 rprintf(F," -k, --copy-dirlinks transform symlink to a dir into referent dir\n");
713 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
714 rprintf(F," -H, --hard-links preserve hard links\n");
715 rprintf(F," -p, --perms preserve permissions\n");
716 rprintf(F," -E, --executability preserve the file's executability\n");
717 rprintf(F," --chmod=CHMOD affect file and/or directory permissions\n");
718 #ifdef SUPPORT_ACLS
719 rprintf(F," -A, --acls preserve ACLs (implies --perms)\n");
720 #endif
721 #ifdef SUPPORT_XATTRS
722 rprintf(F," -X, --xattrs preserve extended attributes\n");
723 #endif
724 rprintf(F," -o, --owner preserve owner (super-user only)\n");
725 rprintf(F," -g, --group preserve group\n");
726 rprintf(F," --devices preserve device files (super-user only)\n");
727 rprintf(F," --specials preserve special files\n");
728 rprintf(F," -D same as --devices --specials\n");
729 rprintf(F," -t, --times preserve modification times\n");
730 rprintf(F," -U, --atimes preserve access (last-used) times\n");
731 rprintf(F," --open-noatime avoid changing the atime on opened files\n");
732 rprintf(F," -O, --omit-dir-times omit directories from --times\n");
733 rprintf(F," -J, --omit-link-times omit symlinks from --times\n");
734 rprintf(F," --super receiver attempts super-user activities\n");
735 #ifdef SUPPORT_XATTRS
736 rprintf(F," --fake-super store/recover privileged attrs using xattrs\n");
737 #endif
738 rprintf(F," -S, --sparse turn sequences of nulls into sparse blocks\n");
739 #ifdef SUPPORT_PREALLOCATION
740 rprintf(F," --preallocate allocate dest files before writing them\n");
741 #else
742 rprintf(F," --preallocate pre-allocate dest files on remote receiver\n");
743 #endif
744 rprintf(F," --write-devices write to devices as files (implies --inplace)\n");
745 rprintf(F," -n, --dry-run perform a trial run with no changes made\n");
746 rprintf(F," -W, --whole-file copy files whole (without delta-xfer algorithm)\n");
747 rprintf(F," --checksum-choice=STR choose the checksum algorithms\n");
748 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
749 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
750 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
751 rprintf(F," --rsync-path=PROGRAM specify the rsync to run on the remote machine\n");
752 rprintf(F," --existing skip creating new files on receiver\n");
753 rprintf(F," --ignore-existing skip updating files that already exist on receiver\n");
754 rprintf(F," --remove-source-files sender removes synchronized files (non-dirs)\n");
755 rprintf(F," --del an alias for --delete-during\n");
756 rprintf(F," --delete delete extraneous files from destination dirs\n");
757 rprintf(F," --delete-before receiver deletes before transfer, not during\n");
758 rprintf(F," --delete-during receiver deletes during the transfer\n");
759 rprintf(F," --delete-delay find deletions during, delete after\n");
760 rprintf(F," --delete-after receiver deletes after transfer, not during\n");
761 rprintf(F," --delete-excluded also delete excluded files from destination dirs\n");
762 rprintf(F," --ignore-missing-args ignore missing source args without error\n");
763 rprintf(F," --delete-missing-args delete missing source args from destination\n");
764 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
765 rprintf(F," --force force deletion of directories even if not empty\n");
766 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
767 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
768 rprintf(F," --min-size=SIZE don't transfer any file smaller than SIZE\n");
769 rprintf(F," --partial keep partially transferred files\n");
770 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
771 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
772 rprintf(F," -m, --prune-empty-dirs prune empty directory chains from the file-list\n");
773 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
774 rprintf(F," --usermap=STRING custom username mapping\n");
775 rprintf(F," --groupmap=STRING custom groupname mapping\n");
776 rprintf(F," --chown=USER:GROUP simple username/groupname mapping\n");
777 rprintf(F," --timeout=SECONDS set I/O timeout in seconds\n");
778 rprintf(F," --contimeout=SECONDS set daemon connection timeout in seconds\n");
779 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
780 rprintf(F," -M, --remote-option=OPTION send OPTION to the remote side only\n");
781 rprintf(F," --size-only skip files that match in size\n");
782 rprintf(F," -@, --modify-window=NUM set the accuracy for mod-time comparisons\n");
783 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
784 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
785 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
786 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
787 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
788 rprintf(F," -z, --compress compress file data during the transfer\n");
789 rprintf(F," --compress-level=NUM explicitly set compression level\n");
790 rprintf(F," --skip-compress=LIST skip compressing files with a suffix in LIST\n");
791 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
792 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
793 rprintf(F," -F same as --filter='dir-merge /.rsync-filter'\n");
794 rprintf(F," repeated: --filter='- .rsync-filter'\n");
795 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
796 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
797 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
798 rprintf(F," --include-from=FILE read include patterns from FILE\n");
799 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
800 rprintf(F," -0, --from0 all *-from/filter files are delimited by 0s\n");
801 rprintf(F," -s, --protect-args no space-splitting; only wildcard special-chars\n");
802 rprintf(F," --copy-as=USER[:GROUP] specify user & optional group for the copy\n");
803 rprintf(F," --address=ADDRESS bind address for outgoing socket to daemon\n");
804 rprintf(F," --port=PORT specify double-colon alternate port number\n");
805 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
806 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
807 rprintf(F," --stats give some file-transfer stats\n");
808 rprintf(F," -8, --8-bit-output leave high-bit chars unescaped in output\n");
809 rprintf(F," -h, --human-readable output numbers in a human-readable format\n");
810 rprintf(F," --progress show progress during transfer\n");
811 rprintf(F," -P same as --partial --progress\n");
812 rprintf(F," -i, --itemize-changes output a change-summary for all updates\n");
813 rprintf(F," --out-format=FORMAT output updates using the specified FORMAT\n");
814 rprintf(F," --log-file=FILE log what we're doing to the specified FILE\n");
815 rprintf(F," --log-file-format=FMT log updates using the specified FMT\n");
816 rprintf(F," --password-file=FILE read daemon-access password from FILE\n");
817 rprintf(F," --list-only list the files instead of copying them\n");
818 rprintf(F," --bwlimit=RATE limit socket I/O bandwidth\n");
819 #ifdef HAVE_SETVBUF
820 rprintf(F," --outbuf=N|L|B set output buffering to None, Line, or Block\n");
821 #endif
822 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
823 rprintf(F," --only-write-batch=FILE like --write-batch but w/o updating destination\n");
824 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
825 rprintf(F," --protocol=NUM force an older protocol version to be used\n");
826 #ifdef ICONV_OPTION
827 rprintf(F," --iconv=CONVERT_SPEC request charset conversion of filenames\n");
828 #endif
829 rprintf(F," --checksum-seed=NUM set block/file checksum seed (advanced)\n");
830 rprintf(F," -4, --ipv4 prefer IPv4\n");
831 rprintf(F," -6, --ipv6 prefer IPv6\n");
832 rprintf(F," --version print version number\n");
833 rprintf(F,"(-h) --help show this help (-h is --help only if used alone)\n");
835 rprintf(F,"\n");
836 rprintf(F,"Use \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
837 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
838 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
841 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
842 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST, OPT_HELP,
843 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW, OPT_MIN_SIZE, OPT_CHMOD,
844 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_ONLY_WRITE_BATCH, OPT_MAX_SIZE,
845 OPT_NO_D, OPT_APPEND, OPT_NO_ICONV, OPT_INFO, OPT_DEBUG,
846 OPT_USERMAP, OPT_GROUPMAP, OPT_CHOWN, OPT_BWLIMIT,
847 OPT_OLD_COMPRESS, OPT_NEW_COMPRESS, OPT_NO_COMPRESS,
848 OPT_SERVER, OPT_REFUSED_BASE = 9000};
850 static struct poptOption long_options[] = {
851 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
852 {"help", 0, POPT_ARG_NONE, 0, OPT_HELP, 0, 0 },
853 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
854 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
855 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
856 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
857 {"info", 0, POPT_ARG_STRING, 0, OPT_INFO, 0, 0 },
858 {"debug", 0, POPT_ARG_STRING, 0, OPT_DEBUG, 0, 0 },
859 {"msgs2stderr", 0, POPT_ARG_NONE, &msgs2stderr, 0, 0, 0 },
860 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
861 {"motd", 0, POPT_ARG_VAL, &output_motd, 1, 0, 0 },
862 {"no-motd", 0, POPT_ARG_VAL, &output_motd, 0, 0, 0 },
863 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
864 {"human-readable", 'h', POPT_ARG_NONE, 0, 'h', 0, 0},
865 {"no-human-readable",0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
866 {"no-h", 0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
867 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
868 {"archive", 'a', POPT_ARG_NONE, 0, 'a', 0, 0 },
869 {"recursive", 'r', POPT_ARG_VAL, &recurse, 2, 0, 0 },
870 {"no-recursive", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
871 {"no-r", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
872 {"inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
873 {"no-inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
874 {"i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
875 {"no-i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
876 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
877 {"no-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
878 {"no-d", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
879 {"old-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
880 {"old-d", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
881 {"perms", 'p', POPT_ARG_VAL, &preserve_perms, 1, 0, 0 },
882 {"no-perms", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
883 {"no-p", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
884 {"executability", 'E', POPT_ARG_NONE, &preserve_executability, 0, 0, 0 },
885 {"acls", 'A', POPT_ARG_NONE, 0, 'A', 0, 0 },
886 {"no-acls", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
887 {"no-A", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
888 {"xattrs", 'X', POPT_ARG_NONE, 0, 'X', 0, 0 },
889 {"no-xattrs", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
890 {"no-X", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
891 {"times", 't', POPT_ARG_VAL, &preserve_times, 1, 0, 0 },
892 {"no-times", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
893 {"no-t", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
894 {"atimes", 'U', POPT_ARG_NONE, 0, 'U', 0, 0 },
895 {"no-atimes", 0, POPT_ARG_VAL, &preserve_atimes, 0, 0, 0 },
896 {"no-U", 0, POPT_ARG_VAL, &preserve_atimes, 0, 0, 0 },
897 {"open-noatime", 0, POPT_ARG_VAL, &open_noatime, 1, 0, 0 },
898 {"no-open-noatime", 0, POPT_ARG_VAL, &open_noatime, 0, 0, 0 },
899 {"omit-dir-times", 'O', POPT_ARG_VAL, &omit_dir_times, 1, 0, 0 },
900 {"no-omit-dir-times",0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
901 {"no-O", 0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
902 {"omit-link-times", 'J', POPT_ARG_VAL, &omit_link_times, 1, 0, 0 },
903 {"no-omit-link-times",0, POPT_ARG_VAL, &omit_link_times, 0, 0, 0 },
904 {"no-J", 0, POPT_ARG_VAL, &omit_link_times, 0, 0, 0 },
905 {"modify-window", '@', POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
906 {"super", 0, POPT_ARG_VAL, &am_root, 2, 0, 0 },
907 {"no-super", 0, POPT_ARG_VAL, &am_root, 0, 0, 0 },
908 {"fake-super", 0, POPT_ARG_VAL, &am_root, -1, 0, 0 },
909 {"owner", 'o', POPT_ARG_VAL, &preserve_uid, 1, 0, 0 },
910 {"no-owner", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
911 {"no-o", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
912 {"group", 'g', POPT_ARG_VAL, &preserve_gid, 1, 0, 0 },
913 {"no-group", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
914 {"no-g", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
915 {0, 'D', POPT_ARG_NONE, 0, 'D', 0, 0 },
916 {"no-D", 0, POPT_ARG_NONE, 0, OPT_NO_D, 0, 0 },
917 {"devices", 0, POPT_ARG_VAL, &preserve_devices, 1, 0, 0 },
918 {"no-devices", 0, POPT_ARG_VAL, &preserve_devices, 0, 0, 0 },
919 {"write-devices", 0, POPT_ARG_VAL, &write_devices, 1, 0, 0 },
920 {"no-write-devices", 0, POPT_ARG_VAL, &write_devices, 0, 0, 0 },
921 {"specials", 0, POPT_ARG_VAL, &preserve_specials, 1, 0, 0 },
922 {"no-specials", 0, POPT_ARG_VAL, &preserve_specials, 0, 0, 0 },
923 {"links", 'l', POPT_ARG_VAL, &preserve_links, 1, 0, 0 },
924 {"no-links", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
925 {"no-l", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
926 {"copy-links", 'L', POPT_ARG_NONE, &copy_links, 0, 0, 0 },
927 {"copy-unsafe-links",0, POPT_ARG_NONE, &copy_unsafe_links, 0, 0, 0 },
928 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
929 {"munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 1, 0, 0 },
930 {"no-munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 0, 0, 0 },
931 {"copy-dirlinks", 'k', POPT_ARG_NONE, &copy_dirlinks, 0, 0, 0 },
932 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
933 {"hard-links", 'H', POPT_ARG_NONE, 0, 'H', 0, 0 },
934 {"no-hard-links", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
935 {"no-H", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
936 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
937 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
938 {"no-R", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
939 {"implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
940 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
941 {"i-d", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
942 {"no-i-d", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
943 {"chmod", 0, POPT_ARG_STRING, 0, OPT_CHMOD, 0, 0 },
944 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
945 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
946 {"one-file-system", 'x', POPT_ARG_NONE, 0, 'x', 0, 0 },
947 {"no-one-file-system",0, POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
948 {"no-x", 0, POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
949 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
950 {"existing", 0, POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
951 {"ignore-non-existing",0,POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
952 {"ignore-existing", 0, POPT_ARG_NONE, &ignore_existing, 0, 0, 0 },
953 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
954 {"min-size", 0, POPT_ARG_STRING, &min_size_arg, OPT_MIN_SIZE, 0, 0 },
955 {"sparse", 'S', POPT_ARG_VAL, &sparse_files, 1, 0, 0 },
956 {"no-sparse", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
957 {"no-S", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
958 {"preallocate", 0, POPT_ARG_NONE, &preallocate_files, 0, 0, 0},
959 {"inplace", 0, POPT_ARG_VAL, &inplace, 1, 0, 0 },
960 {"no-inplace", 0, POPT_ARG_VAL, &inplace, 0, 0, 0 },
961 {"append", 0, POPT_ARG_NONE, 0, OPT_APPEND, 0, 0 },
962 {"append-verify", 0, POPT_ARG_VAL, &append_mode, 2, 0, 0 },
963 {"no-append", 0, POPT_ARG_VAL, &append_mode, 0, 0, 0 },
964 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
965 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
966 {"delete-before", 0, POPT_ARG_NONE, &delete_before, 0, 0, 0 },
967 {"delete-during", 0, POPT_ARG_VAL, &delete_during, 1, 0, 0 },
968 {"delete-delay", 0, POPT_ARG_VAL, &delete_during, 2, 0, 0 },
969 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
970 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
971 {"delete-missing-args",0,POPT_BIT_SET, &missing_args, 2, 0, 0 },
972 {"ignore-missing-args",0,POPT_BIT_SET, &missing_args, 1, 0, 0 },
973 {"remove-sent-files",0, POPT_ARG_VAL, &remove_source_files, 2, 0, 0 }, /* deprecated */
974 {"remove-source-files",0,POPT_ARG_VAL, &remove_source_files, 1, 0, 0 },
975 {"force", 0, POPT_ARG_VAL, &force_delete, 1, 0, 0 },
976 {"no-force", 0, POPT_ARG_VAL, &force_delete, 0, 0, 0 },
977 {"ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 1, 0, 0 },
978 {"no-ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 0, 0, 0 },
979 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
980 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
981 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
982 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
983 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
984 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
985 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
986 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
987 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
988 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
989 {"no-W", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
990 {"checksum", 'c', POPT_ARG_VAL, &always_checksum, 1, 0, 0 },
991 {"no-checksum", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
992 {"no-c", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
993 {"checksum-choice", 0, POPT_ARG_STRING, &checksum_choice, 0, 0, 0 },
994 {"cc", 0, POPT_ARG_STRING, &checksum_choice, 0, 0, 0 },
995 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
996 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
997 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
998 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
999 {"fuzzy", 'y', POPT_ARG_NONE, 0, 'y', 0, 0 },
1000 {"no-fuzzy", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
1001 {"no-y", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
1002 {"compress", 'z', POPT_ARG_NONE, 0, 'z', 0, 0 },
1003 {"old-compress", 0, POPT_ARG_NONE, 0, OPT_OLD_COMPRESS, 0, 0 },
1004 {"new-compress", 0, POPT_ARG_NONE, 0, OPT_NEW_COMPRESS, 0, 0 },
1005 {"no-compress", 0, POPT_ARG_NONE, 0, OPT_NO_COMPRESS, 0, 0 },
1006 {"no-z", 0, POPT_ARG_NONE, 0, OPT_NO_COMPRESS, 0, 0 },
1007 {"compress-choice", 0, POPT_ARG_STRING, &compress_choice, 0, 0, 0 },
1008 {"zc", 0, POPT_ARG_STRING, &compress_choice, 0, 0, 0 },
1009 {"skip-compress", 0, POPT_ARG_STRING, &skip_compress, 0, 0, 0 },
1010 {"compress-level", 0, POPT_ARG_INT, &do_compression_level, 0, 0, 0 },
1011 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
1012 {"progress", 0, POPT_ARG_VAL, &do_progress, 1, 0, 0 },
1013 {"no-progress", 0, POPT_ARG_VAL, &do_progress, 0, 0, 0 },
1014 {"partial", 0, POPT_ARG_VAL, &keep_partial, 1, 0, 0 },
1015 {"no-partial", 0, POPT_ARG_VAL, &keep_partial, 0, 0, 0 },
1016 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
1017 {"delay-updates", 0, POPT_ARG_VAL, &delay_updates, 1, 0, 0 },
1018 {"no-delay-updates", 0, POPT_ARG_VAL, &delay_updates, 0, 0, 0 },
1019 {"prune-empty-dirs",'m', POPT_ARG_VAL, &prune_empty_dirs, 1, 0, 0 },
1020 {"no-prune-empty-dirs",0,POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
1021 {"no-m", 0, POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
1022 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
1023 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
1024 {"out-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 },
1025 {"log-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 }, /* DEPRECATED */
1026 {"itemize-changes", 'i', POPT_ARG_NONE, 0, 'i', 0, 0 },
1027 {"no-itemize-changes",0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
1028 {"no-i", 0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
1029 {"bwlimit", 0, POPT_ARG_STRING, &bwlimit_arg, OPT_BWLIMIT, 0, 0 },
1030 {"no-bwlimit", 0, POPT_ARG_VAL, &bwlimit, 0, 0, 0 },
1031 {"backup", 'b', POPT_ARG_VAL, &make_backups, 1, 0, 0 },
1032 {"no-backup", 0, POPT_ARG_VAL, &make_backups, 0, 0, 0 },
1033 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
1034 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
1035 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
1036 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
1037 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
1038 {"only-write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_ONLY_WRITE_BATCH, 0, 0 },
1039 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
1040 {"from0", '0', POPT_ARG_VAL, &eol_nulls, 1, 0, 0},
1041 {"no-from0", 0, POPT_ARG_VAL, &eol_nulls, 0, 0, 0},
1042 {"protect-args", 's', POPT_ARG_VAL, &protect_args, 1, 0, 0},
1043 {"no-protect-args", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
1044 {"no-s", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
1045 {"numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 1, 0, 0 },
1046 {"no-numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 0, 0, 0 },
1047 {"usermap", 0, POPT_ARG_STRING, 0, OPT_USERMAP, 0, 0 },
1048 {"groupmap", 0, POPT_ARG_STRING, 0, OPT_GROUPMAP, 0, 0 },
1049 {"chown", 0, POPT_ARG_STRING, 0, OPT_CHOWN, 0, 0 },
1050 {"timeout", 0, POPT_ARG_INT, &io_timeout, 0, 0, 0 },
1051 {"no-timeout", 0, POPT_ARG_VAL, &io_timeout, 0, 0, 0 },
1052 {"contimeout", 0, POPT_ARG_INT, &connect_timeout, 0, 0, 0 },
1053 {"no-contimeout", 0, POPT_ARG_VAL, &connect_timeout, 0, 0, 0 },
1054 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
1055 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
1056 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
1057 #ifdef ICONV_OPTION
1058 {"iconv", 0, POPT_ARG_STRING, &iconv_opt, 0, 0, 0 },
1059 {"no-iconv", 0, POPT_ARG_NONE, 0, OPT_NO_ICONV, 0, 0 },
1060 #endif
1061 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
1062 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
1063 {"8-bit-output", '8', POPT_ARG_VAL, &allow_8bit_chars, 1, 0, 0 },
1064 {"no-8-bit-output", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
1065 {"no-8", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
1066 {"qsort", 0, POPT_ARG_NONE, &use_qsort, 0, 0, 0 },
1067 {"copy-as", 0, POPT_ARG_STRING, &copy_as, 0, 0, 0 },
1068 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
1069 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
1070 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
1071 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
1072 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
1073 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
1074 #ifdef HAVE_SETVBUF
1075 {"outbuf", 0, POPT_ARG_STRING, &outbuf_mode, 0, 0, 0 },
1076 #endif
1077 {"remote-option", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
1078 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
1079 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
1080 {"server", 0, POPT_ARG_NONE, 0, OPT_SERVER, 0, 0 },
1081 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
1082 /* All the following options switch us into daemon-mode option-parsing. */
1083 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
1084 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1085 {"dparam", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
1086 {"detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1087 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1088 {0,0,0,0, 0, 0, 0}
1091 static void daemon_usage(enum logcode F)
1093 print_rsync_version(F);
1095 rprintf(F,"\n");
1096 rprintf(F,"Usage: rsync --daemon [OPTION]...\n");
1097 rprintf(F," --address=ADDRESS bind to the specified address\n");
1098 rprintf(F," --bwlimit=RATE limit socket I/O bandwidth\n");
1099 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
1100 rprintf(F," -M, --dparam=OVERRIDE override global daemon config parameter\n");
1101 rprintf(F," --no-detach do not detach from the parent\n");
1102 rprintf(F," --port=PORT listen on alternate port number\n");
1103 rprintf(F," --log-file=FILE override the \"log file\" setting\n");
1104 rprintf(F," --log-file-format=FMT override the \"log format\" setting\n");
1105 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
1106 rprintf(F," -v, --verbose increase verbosity\n");
1107 rprintf(F," -4, --ipv4 prefer IPv4\n");
1108 rprintf(F," -6, --ipv6 prefer IPv6\n");
1109 rprintf(F," --help show this help screen\n");
1111 rprintf(F,"\n");
1112 rprintf(F,"If you were not trying to invoke rsync as a daemon, avoid using any of the\n");
1113 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
1116 static struct poptOption long_daemon_options[] = {
1117 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1118 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
1119 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
1120 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
1121 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
1122 {"dparam", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
1123 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
1124 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
1125 {"detach", 0, POPT_ARG_VAL, &no_detach, 0, 0, 0 },
1126 {"no-detach", 0, POPT_ARG_VAL, &no_detach, 1, 0, 0 },
1127 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
1128 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
1129 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
1130 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
1131 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
1132 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
1133 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
1134 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
1135 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1136 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1137 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
1138 {0,0,0,0, 0, 0, 0}
1142 static char err_buf[200];
1146 * Store the option error message, if any, so that we can log the
1147 * connection attempt (which requires parsing the options), and then
1148 * show the error later on.
1150 void option_error(void)
1152 if (!err_buf[0]) {
1153 strlcpy(err_buf, "Error parsing options: option may "
1154 "be supported on client but not on server?\n",
1155 sizeof err_buf);
1158 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
1159 io_flush(FULL_FLUSH);
1160 msleep(20);
1164 static void parse_one_refuse_match(int negated, const char *ref, const struct poptOption *list_end)
1166 struct poptOption *op;
1167 char shortName[2];
1168 int is_wild = strpbrk(ref, "*?[") != NULL;
1169 int found_match = 0;
1171 shortName[1] = '\0';
1173 if (strcmp("a", ref) == 0 || strcmp("archive", ref) == 0) {
1174 ref = "[ardlptgoD]";
1175 is_wild = 1;
1178 for (op = long_options; op != list_end; op++) {
1179 *shortName = op->shortName;
1180 if ((op->longName && wildmatch(ref, op->longName))
1181 || (*shortName && wildmatch(ref, shortName))) {
1182 if (op->descrip[1] == '*')
1183 op->descrip = negated ? "a*" : "r*";
1184 else if (!is_wild)
1185 op->descrip = negated ? "a=" : "r=";
1186 found_match = 1;
1187 if (!is_wild)
1188 break;
1192 if (!found_match)
1193 rprintf(FLOG, "No match for refuse-options string \"%s\"\n", ref);
1198 * Tweak the option table to disable all options that the rsyncd.conf
1199 * file has told us to refuse.
1201 static void set_refuse_options(void)
1203 struct poptOption *op, *list_end = NULL;
1204 char *cp, *ref = lp_refuse_options(module_id);
1205 int negated;
1207 if (!ref)
1208 ref = "";
1210 if (!*ref && !am_daemon) /* A simple optimization */
1211 return;
1213 /* We abuse the descrip field in poptOption to make it easy to flag which options
1214 * are refused (since we don't use it otherwise). Start by marking all options
1215 * as "a"ccepted with a few options also marked as non-wild. */
1216 for (op = long_options; ; op++) {
1217 const char *longName = op->longName ? op->longName : "";
1218 if (!op->longName && !op->shortName) {
1219 list_end = op;
1220 break;
1222 if (op->shortName == 'e' /* Required for compatibility flags */
1223 || op->shortName == '0' /* --from0 just modifies --files-from, so refuse that instead (or not) */
1224 || op->shortName == 's' /* --protect-args is always OK */
1225 || op->shortName == 'n' /* --dry-run is always OK */
1226 || strcmp("iconv", longName) == 0
1227 || strcmp("no-iconv", longName) == 0
1228 || strcmp("checksum-seed", longName) == 0
1229 || strcmp("write-devices", longName) == 0 /* disable wild-match (it gets refused below) */
1230 || strcmp("log-format", longName) == 0 /* aka out-format (NOT log-file-format) */
1231 || strcmp("sender", longName) == 0
1232 || strcmp("server", longName) == 0)
1233 op->descrip = "a="; /* exact-match only */
1234 else
1235 op->descrip = "a*"; /* wild-card-able */
1237 assert(list_end != NULL);
1239 if (am_daemon) /* Refused by default, but can be accepted via "!write-devices" */
1240 parse_one_refuse_match(0, "write-devices", list_end);
1242 while (1) {
1243 while (*ref == ' ') ref++;
1244 if (!*ref)
1245 break;
1246 if ((cp = strchr(ref, ' ')) != NULL)
1247 *cp = '\0';
1248 negated = *ref == '!';
1249 if (negated && ref[1])
1250 ref++;
1251 parse_one_refuse_match(negated, ref, list_end);
1252 if (!cp)
1253 break;
1254 *cp = ' ';
1255 ref = cp + 1;
1258 if (am_daemon) {
1259 #ifdef ICONV_OPTION
1260 if (!*lp_charset(module_id))
1261 parse_one_refuse_match(0, "iconv", list_end);
1262 #endif
1263 parse_one_refuse_match(0, "log-file*", list_end);
1266 /* Now we use the descrip values to actually mark the options for refusal. */
1267 for (op = long_options; op != list_end; op++) {
1268 int refused = op->descrip[0] == 'r';
1269 op->descrip = NULL;
1270 if (!refused)
1271 continue;
1272 if (op->argInfo == POPT_ARG_VAL)
1273 op->argInfo = POPT_ARG_NONE;
1274 op->val = (op - long_options) + OPT_REFUSED_BASE;
1275 /* The following flags are set to let us easily check an implied option later in the code. */
1276 switch (op->shortName) {
1277 case 'r': case 'd': case 'l': case 'p':
1278 case 't': case 'g': case 'o': case 'D':
1279 refused_archive_part = op->val;
1280 break;
1281 case 'z':
1282 refused_compress = op->val;
1283 break;
1284 case '\0':
1285 if (strcmp("delete", op->longName) == 0)
1286 refused_delete = op->val;
1287 else if (strcmp("delete-before", op->longName) == 0)
1288 refused_delete_before = op->val;
1289 else if (strcmp("delete-during", op->longName) == 0)
1290 refused_delete_during = op->val;
1291 else if (strcmp("partial", op->longName) == 0)
1292 refused_partial = op->val;
1293 else if (strcmp("progress", op->longName) == 0)
1294 refused_progress = op->val;
1295 else if (strcmp("inplace", op->longName) == 0)
1296 refused_inplace = op->val;
1297 else if (strcmp("no-iconv", op->longName) == 0)
1298 refused_no_iconv = op->val;
1299 break;
1305 static int count_args(const char **argv)
1307 int i = 0;
1309 if (argv) {
1310 while (argv[i] != NULL)
1311 i++;
1314 return i;
1318 static OFF_T parse_size_arg(char **size_arg, char def_suf)
1320 int reps, mult, make_compatible = 0;
1321 const char *arg;
1322 OFF_T size = 1;
1324 for (arg = *size_arg; isDigit(arg); arg++) {}
1325 if (*arg == '.')
1326 for (arg++; isDigit(arg); arg++) {}
1327 switch (*arg && *arg != '+' && *arg != '-' ? *arg++ : def_suf) {
1328 case 'b': case 'B':
1329 reps = 0;
1330 break;
1331 case 'k': case 'K':
1332 reps = 1;
1333 break;
1334 case 'm': case 'M':
1335 reps = 2;
1336 break;
1337 case 'g': case 'G':
1338 reps = 3;
1339 break;
1340 default:
1341 return -1;
1343 if (*arg == 'b' || *arg == 'B')
1344 mult = 1000, make_compatible = 1, arg++;
1345 else if (!*arg || *arg == '+' || *arg == '-')
1346 mult = 1024;
1347 else if (strncasecmp(arg, "ib", 2) == 0)
1348 mult = 1024, arg += 2;
1349 else
1350 return -1;
1351 while (reps--)
1352 size *= mult;
1353 size *= atof(*size_arg);
1354 if ((*arg == '+' || *arg == '-') && arg[1] == '1')
1355 size += atoi(arg), make_compatible = 1, arg += 2;
1356 if (*arg)
1357 return -1;
1358 if (size > 0 && make_compatible && def_suf == 'b') {
1359 /* We convert this manually because we may need %lld precision,
1360 * and that's not a portable sprintf() escape. */
1361 char buf[128], *s = buf + sizeof buf - 1;
1362 OFF_T num = size;
1363 *s = '\0';
1364 while (num) {
1365 *--s = (char)(num % 10) + '0';
1366 num /= 10;
1368 if (!(*size_arg = strdup(s)))
1369 out_of_memory("parse_size_arg");
1371 return size;
1375 static void create_refuse_error(int which)
1377 /* The "which" value is the index + OPT_REFUSED_BASE. */
1378 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
1379 int n = snprintf(err_buf, sizeof err_buf,
1380 "The server is configured to refuse --%s\n",
1381 op->longName) - 1;
1382 if (op->shortName) {
1383 snprintf(err_buf + n, sizeof err_buf - n,
1384 " (-%c)\n", op->shortName);
1388 /* This is used to make sure that --daemon & --server cannot be aliased to
1389 * something else. These options have always disabled popt aliases for the
1390 * parsing of a daemon or server command-line, but we have to make sure that
1391 * these options cannot vanish so that the alias disabling can take effect. */
1392 static void popt_unalias(poptContext con, const char *opt)
1394 struct poptAlias unalias;
1396 unalias.longName = opt + 2; /* point past the leading "--" */
1397 unalias.shortName = '\0';
1398 unalias.argc = 1;
1399 unalias.argv = new_array(const char*, 1);
1400 unalias.argv[0] = strdup(opt);
1402 poptAddAlias(con, unalias, 0);
1406 * Process command line arguments. Called on both local and remote.
1408 * @retval 1 if all options are OK; with globals set to appropriate
1409 * values
1411 * @retval 0 on error, with err_buf containing an explanation
1413 int parse_arguments(int *argc_p, const char ***argv_p)
1415 static poptContext pc;
1416 const char *arg, **argv = *argv_p;
1417 int argc = *argc_p;
1418 int opt;
1419 int orig_protect_args = protect_args;
1421 if (argc == 0) {
1422 strlcpy(err_buf, "argc is zero!\n", sizeof err_buf);
1423 return 0;
1426 set_refuse_options();
1428 #ifdef ICONV_OPTION
1429 if (!am_daemon && protect_args <= 0 && (arg = getenv("RSYNC_ICONV")) != NULL && *arg)
1430 iconv_opt = strdup(arg);
1431 #endif
1433 /* TODO: Call poptReadDefaultConfig; handle errors. */
1435 /* The context leaks in case of an error, but if there's a
1436 * problem we always exit anyhow. */
1437 if (pc)
1438 poptFreeContext(pc);
1439 pc = poptGetContext(RSYNC_NAME, argc, argv, long_options, 0);
1440 if (!am_server) {
1441 poptReadDefaultConfig(pc, 0);
1442 popt_unalias(pc, "--daemon");
1443 popt_unalias(pc, "--server");
1446 while ((opt = poptGetNextOpt(pc)) != -1) {
1447 /* most options are handled automatically by popt;
1448 * only special cases are returned and listed here. */
1450 switch (opt) {
1451 case OPT_VERSION:
1452 print_rsync_version(FINFO);
1453 exit_cleanup(0);
1455 case OPT_SERVER:
1456 if (!am_server) {
1457 /* Disable popt aliases on the server side and
1458 * then start parsing the options again. */
1459 poptFreeContext(pc);
1460 pc = poptGetContext(RSYNC_NAME, argc, argv,
1461 long_options, 0);
1462 am_server = 1;
1464 #ifdef ICONV_OPTION
1465 iconv_opt = NULL;
1466 #endif
1467 break;
1469 case OPT_SENDER:
1470 if (!am_server) {
1471 usage(FERROR);
1472 exit_cleanup(RERR_SYNTAX);
1474 am_sender = 1;
1475 break;
1477 case OPT_DAEMON:
1478 if (am_daemon) {
1479 strlcpy(err_buf,
1480 "Attempt to hack rsync thwarted!\n",
1481 sizeof err_buf);
1482 return 0;
1484 #ifdef ICONV_OPTION
1485 iconv_opt = NULL;
1486 #endif
1487 protect_args = 0;
1488 poptFreeContext(pc);
1489 pc = poptGetContext(RSYNC_NAME, argc, argv,
1490 long_daemon_options, 0);
1491 while ((opt = poptGetNextOpt(pc)) != -1) {
1492 char **cpp;
1493 switch (opt) {
1494 case 'h':
1495 daemon_usage(FINFO);
1496 exit_cleanup(0);
1498 case 'M':
1499 arg = poptGetOptArg(pc);
1500 if (!strchr(arg, '=')) {
1501 rprintf(FERROR,
1502 "--dparam value is missing an '=': %s\n",
1503 arg);
1504 goto daemon_error;
1506 cpp = EXPAND_ITEM_LIST(&dparam_list, char *, 4);
1507 *cpp = strdup(arg);
1508 break;
1510 case 'v':
1511 verbose++;
1512 break;
1514 default:
1515 rprintf(FERROR,
1516 "rsync: %s: %s (in daemon mode)\n",
1517 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1518 poptStrerror(opt));
1519 goto daemon_error;
1523 if (dparam_list.count && !set_dparams(1))
1524 exit_cleanup(RERR_SYNTAX);
1526 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
1527 snprintf(err_buf, sizeof err_buf,
1528 "the --temp-dir path is WAY too long.\n");
1529 return 0;
1532 if (!daemon_opt) {
1533 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
1534 daemon_error:
1535 rprintf(FERROR,
1536 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
1537 exit_cleanup(RERR_SYNTAX);
1540 *argv_p = argv = poptGetArgs(pc);
1541 *argc_p = argc = count_args(argv);
1542 am_starting_up = 0;
1543 daemon_opt = 0;
1544 am_daemon = 1;
1545 return 1;
1547 case OPT_MODIFY_WINDOW:
1548 /* The value has already been set by popt, but
1549 * we need to remember that we're using a
1550 * non-default setting. */
1551 modify_window_set = 1;
1552 break;
1554 case OPT_FILTER:
1555 parse_filter_str(&filter_list, poptGetOptArg(pc),
1556 rule_template(0), 0);
1557 break;
1559 case OPT_EXCLUDE:
1560 parse_filter_str(&filter_list, poptGetOptArg(pc),
1561 rule_template(0), XFLG_OLD_PREFIXES);
1562 break;
1564 case OPT_INCLUDE:
1565 parse_filter_str(&filter_list, poptGetOptArg(pc),
1566 rule_template(FILTRULE_INCLUDE), XFLG_OLD_PREFIXES);
1567 break;
1569 case OPT_EXCLUDE_FROM:
1570 case OPT_INCLUDE_FROM:
1571 arg = poptGetOptArg(pc);
1572 if (sanitize_paths)
1573 arg = sanitize_path(NULL, arg, NULL, 0, SP_DEFAULT);
1574 if (daemon_filter_list.head) {
1575 int rej;
1576 char *cp = strdup(arg);
1577 if (!cp)
1578 out_of_memory("parse_arguments");
1579 if (!*cp)
1580 rej = 1;
1581 else {
1582 char *dir = cp + (*cp == '/' ? module_dirlen : 0);
1583 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1584 rej = check_filter(&daemon_filter_list, FLOG, dir, 0) < 0;
1586 free(cp);
1587 if (rej)
1588 goto options_rejected;
1590 parse_filter_file(&filter_list, arg,
1591 rule_template(opt == OPT_INCLUDE_FROM ? FILTRULE_INCLUDE : 0),
1592 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
1593 break;
1595 case 'a':
1596 if (refused_archive_part) {
1597 create_refuse_error(refused_archive_part);
1598 return 0;
1600 if (!recurse) /* preserve recurse == 2 */
1601 recurse = 1;
1602 #ifdef SUPPORT_LINKS
1603 preserve_links = 1;
1604 #endif
1605 preserve_perms = 1;
1606 preserve_times = 1;
1607 preserve_gid = 1;
1608 preserve_uid = 1;
1609 preserve_devices = 1;
1610 preserve_specials = 1;
1611 break;
1613 case 'D':
1614 preserve_devices = preserve_specials = 1;
1615 break;
1617 case OPT_NO_D:
1618 preserve_devices = preserve_specials = 0;
1619 break;
1621 case 'h':
1622 human_readable++;
1623 break;
1625 case 'H':
1626 preserve_hard_links++;
1627 break;
1629 case 'i':
1630 itemize_changes++;
1631 break;
1633 case 'U':
1634 if (++preserve_atimes > 1)
1635 open_noatime = 1;
1636 break;
1638 case 'v':
1639 verbose++;
1640 break;
1642 case 'y':
1643 fuzzy_basis++;
1644 break;
1646 case 'q':
1647 quiet++;
1648 break;
1650 case 'x':
1651 one_file_system++;
1652 break;
1654 case 'F':
1655 switch (++F_option_cnt) {
1656 case 1:
1657 parse_filter_str(&filter_list,": /.rsync-filter",rule_template(0),0);
1658 break;
1659 case 2:
1660 parse_filter_str(&filter_list,"- .rsync-filter",rule_template(0),0);
1661 break;
1663 break;
1665 case 'P':
1666 if (refused_partial || refused_progress) {
1667 create_refuse_error(refused_partial
1668 ? refused_partial : refused_progress);
1669 return 0;
1671 do_progress = 1;
1672 keep_partial = 1;
1673 break;
1675 case 'z':
1676 do_compression++;
1677 break;
1679 case OPT_OLD_COMPRESS:
1680 compress_choice = "zlib";
1681 break;
1683 case OPT_NEW_COMPRESS:
1684 compress_choice = "zlibx";
1685 break;
1687 case OPT_NO_COMPRESS:
1688 do_compression = 0;
1689 compress_choice = NULL;
1690 break;
1692 case 'M':
1693 arg = poptGetOptArg(pc);
1694 if (*arg != '-') {
1695 snprintf(err_buf, sizeof err_buf,
1696 "Remote option must start with a dash: %s\n", arg);
1697 return 0;
1699 if (remote_option_cnt+2 >= remote_option_alloc) {
1700 remote_option_alloc += 16;
1701 remote_options = realloc_array(remote_options,
1702 const char *, remote_option_alloc);
1703 if (!remote_options)
1704 out_of_memory("parse_arguments");
1705 if (!remote_option_cnt)
1706 remote_options[0] = "ARG0";
1708 remote_options[++remote_option_cnt] = arg;
1709 remote_options[remote_option_cnt+1] = NULL;
1710 break;
1712 case OPT_WRITE_BATCH:
1713 /* batch_name is already set */
1714 write_batch = 1;
1715 break;
1717 case OPT_ONLY_WRITE_BATCH:
1718 /* batch_name is already set */
1719 write_batch = -1;
1720 break;
1722 case OPT_READ_BATCH:
1723 /* batch_name is already set */
1724 read_batch = 1;
1725 break;
1727 case OPT_NO_ICONV:
1728 #ifdef ICONV_OPTION
1729 iconv_opt = NULL;
1730 #endif
1731 break;
1733 case OPT_MAX_SIZE:
1734 if ((max_size = parse_size_arg(&max_size_arg, 'b')) < 0) {
1735 snprintf(err_buf, sizeof err_buf,
1736 "--max-size value is invalid: %s\n",
1737 max_size_arg);
1738 return 0;
1740 break;
1742 case OPT_MIN_SIZE:
1743 if ((min_size = parse_size_arg(&min_size_arg, 'b')) < 0) {
1744 snprintf(err_buf, sizeof err_buf,
1745 "--min-size value is invalid: %s\n",
1746 min_size_arg);
1747 return 0;
1749 break;
1751 case OPT_BWLIMIT:
1753 OFF_T limit = parse_size_arg(&bwlimit_arg, 'K');
1754 if (limit < 0) {
1755 snprintf(err_buf, sizeof err_buf,
1756 "--bwlimit value is invalid: %s\n", bwlimit_arg);
1757 return 0;
1759 bwlimit = (limit + 512) / 1024;
1760 if (limit && !bwlimit) {
1761 snprintf(err_buf, sizeof err_buf,
1762 "--bwlimit value is too small: %s\n", bwlimit_arg);
1763 return 0;
1766 break;
1768 case OPT_APPEND:
1769 if (am_server)
1770 append_mode++;
1771 else
1772 append_mode = 1;
1773 break;
1775 case OPT_LINK_DEST:
1776 #ifdef SUPPORT_HARD_LINKS
1777 link_dest = 1;
1778 dest_option = "--link-dest";
1779 goto set_dest_dir;
1780 #else
1781 snprintf(err_buf, sizeof err_buf,
1782 "hard links are not supported on this %s\n",
1783 am_server ? "server" : "client");
1784 return 0;
1785 #endif
1787 case OPT_COPY_DEST:
1788 copy_dest = 1;
1789 dest_option = "--copy-dest";
1790 goto set_dest_dir;
1792 case OPT_COMPARE_DEST:
1793 compare_dest = 1;
1794 dest_option = "--compare-dest";
1795 set_dest_dir:
1796 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
1797 snprintf(err_buf, sizeof err_buf,
1798 "ERROR: at most %d %s args may be specified\n",
1799 MAX_BASIS_DIRS, dest_option);
1800 return 0;
1802 /* We defer sanitizing this arg until we know what
1803 * our destination directory is going to be. */
1804 basis_dir[basis_dir_cnt++] = (char *)poptGetOptArg(pc);
1805 break;
1807 case OPT_CHMOD:
1808 arg = poptGetOptArg(pc);
1809 if (!parse_chmod(arg, &chmod_modes)) {
1810 snprintf(err_buf, sizeof err_buf,
1811 "Invalid argument passed to --chmod (%s)\n",
1812 arg);
1813 return 0;
1815 break;
1817 case OPT_INFO:
1818 arg = poptGetOptArg(pc);
1819 parse_output_words(info_words, info_levels, arg, USER_PRIORITY);
1820 break;
1822 case OPT_DEBUG:
1823 arg = poptGetOptArg(pc);
1824 parse_output_words(debug_words, debug_levels, arg, USER_PRIORITY);
1825 break;
1827 case OPT_USERMAP:
1828 if (usermap) {
1829 if (usermap_via_chown) {
1830 snprintf(err_buf, sizeof err_buf,
1831 "--usermap conflicts with prior --chown.\n");
1832 return 0;
1834 snprintf(err_buf, sizeof err_buf,
1835 "You can only specify --usermap once.\n");
1836 return 0;
1838 usermap = (char *)poptGetOptArg(pc);
1839 usermap_via_chown = False;
1840 break;
1842 case OPT_GROUPMAP:
1843 if (groupmap) {
1844 if (groupmap_via_chown) {
1845 snprintf(err_buf, sizeof err_buf,
1846 "--groupmap conflicts with prior --chown.\n");
1847 return 0;
1849 snprintf(err_buf, sizeof err_buf,
1850 "You can only specify --groupmap once.\n");
1851 return 0;
1853 groupmap = (char *)poptGetOptArg(pc);
1854 groupmap_via_chown = False;
1855 break;
1857 case OPT_CHOWN: {
1858 const char *chown = poptGetOptArg(pc);
1859 int len;
1860 if ((arg = strchr(chown, ':')) != NULL)
1861 len = arg++ - chown;
1862 else
1863 len = strlen(chown);
1864 if (len) {
1865 if (usermap) {
1866 if (!usermap_via_chown) {
1867 snprintf(err_buf, sizeof err_buf,
1868 "--chown conflicts with prior --usermap.\n");
1869 return 0;
1871 snprintf(err_buf, sizeof err_buf,
1872 "You can only specify a user-affecting --chown once.\n");
1873 return 0;
1875 if (asprintf(&usermap, "*:%.*s", len, chown) < 0)
1876 out_of_memory("parse_arguments");
1877 usermap_via_chown = True;
1879 if (arg && *arg) {
1880 if (groupmap) {
1881 if (!groupmap_via_chown) {
1882 snprintf(err_buf, sizeof err_buf,
1883 "--chown conflicts with prior --groupmap.\n");
1884 return 0;
1886 snprintf(err_buf, sizeof err_buf,
1887 "You can only specify a group-affecting --chown once.\n");
1888 return 0;
1890 if (asprintf(&groupmap, "*:%s", arg) < 0)
1891 out_of_memory("parse_arguments");
1892 groupmap_via_chown = True;
1894 break;
1897 case OPT_HELP:
1898 usage(FINFO);
1899 exit_cleanup(0);
1901 case 'A':
1902 #ifdef SUPPORT_ACLS
1903 preserve_acls = 1;
1904 preserve_perms = 1;
1905 break;
1906 #else
1907 /* FIXME: this should probably be ignored with a
1908 * warning and then countermeasures taken to
1909 * restrict group and other access in the presence
1910 * of any more restrictive ACLs, but this is safe
1911 * for now */
1912 snprintf(err_buf,sizeof(err_buf),
1913 "ACLs are not supported on this %s\n",
1914 am_server ? "server" : "client");
1915 return 0;
1916 #endif
1918 case 'X':
1919 #ifdef SUPPORT_XATTRS
1920 preserve_xattrs++;
1921 break;
1922 #else
1923 snprintf(err_buf,sizeof(err_buf),
1924 "extended attributes are not supported on this %s\n",
1925 am_server ? "server" : "client");
1926 return 0;
1927 #endif
1929 default:
1930 /* A large opt value means that set_refuse_options()
1931 * turned this option off. */
1932 if (opt >= OPT_REFUSED_BASE) {
1933 create_refuse_error(opt);
1934 return 0;
1936 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
1937 am_server ? "on remote machine: " : "",
1938 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1939 poptStrerror(opt));
1940 return 0;
1944 if (protect_args < 0) {
1945 if (am_server)
1946 protect_args = 0;
1947 else if ((arg = getenv("RSYNC_PROTECT_ARGS")) != NULL && *arg)
1948 protect_args = atoi(arg) ? 1 : 0;
1949 else {
1950 #ifdef RSYNC_USE_PROTECTED_ARGS
1951 protect_args = 1;
1952 #else
1953 protect_args = 0;
1954 #endif
1958 if (checksum_choice && strcasecmp(checksum_choice, "auto") != 0 && strcasecmp(checksum_choice, "auto,auto") != 0) {
1959 /* Call this early to verify the args and figure out if we need to force
1960 * --whole-file. Note that the parse function will get called again later,
1961 * just in case an "auto" choice needs to know the protocol_version. */
1962 parse_checksum_choice(0);
1963 } else
1964 checksum_choice = NULL;
1966 if (human_readable > 1 && argc == 2 && !am_server) {
1967 /* Allow the old meaning of 'h' (--help) on its own. */
1968 usage(FINFO);
1969 exit_cleanup(0);
1972 if (!compress_choice && do_compression > 1)
1973 compress_choice = "zlibx";
1974 if (compress_choice && strcasecmp(compress_choice, "auto") != 0)
1975 parse_compress_choice(0); /* Twiddles do_compression and can possibly NULL-out compress_choice. */
1976 else
1977 compress_choice = NULL;
1979 if (do_compression || do_compression_level != CLVL_NOT_SPECIFIED) {
1980 if (!do_compression)
1981 do_compression = CPRES_AUTO;
1982 if (do_compression && refused_compress) {
1983 create_refuse_error(refused_compress);
1984 return 0;
1988 #ifdef HAVE_SETVBUF
1989 if (outbuf_mode && !am_server) {
1990 int mode = *(uchar *)outbuf_mode;
1991 if (islower(mode))
1992 mode = toupper(mode);
1993 fflush(stdout); /* Just in case... */
1994 switch (mode) {
1995 case 'N': /* None */
1996 case 'U': /* Unbuffered */
1997 mode = _IONBF;
1998 break;
1999 case 'L': /* Line */
2000 mode = _IOLBF;
2001 break;
2002 case 'B': /* Block */
2003 case 'F': /* Full */
2004 mode = _IOFBF;
2005 break;
2006 default:
2007 snprintf(err_buf, sizeof err_buf,
2008 "Invalid --outbuf setting -- specify N, L, or B.\n");
2009 return 0;
2011 setvbuf(stdout, (char *)NULL, mode, 0);
2014 if (msgs2stderr) {
2015 /* Make stderr line buffered for better sharing of the stream. */
2016 fflush(stderr); /* Just in case... */
2017 setvbuf(stderr, (char *)NULL, _IOLBF, 0);
2019 #endif
2021 set_output_verbosity(verbose, DEFAULT_PRIORITY);
2023 if (do_stats) {
2024 parse_output_words(info_words, info_levels,
2025 verbose > 1 ? "stats3" : "stats2", DEFAULT_PRIORITY);
2028 #ifdef ICONV_OPTION
2029 if (iconv_opt && protect_args != 2) {
2030 if (!am_server && strcmp(iconv_opt, "-") == 0)
2031 iconv_opt = NULL;
2032 else
2033 need_unsorted_flist = 1;
2035 if (refused_no_iconv && !iconv_opt) {
2036 create_refuse_error(refused_no_iconv);
2037 return 0;
2039 #endif
2041 if (fuzzy_basis > 1)
2042 fuzzy_basis = basis_dir_cnt + 1;
2044 /* Don't let the client reset protect_args if it was already processed */
2045 if (orig_protect_args == 2 && am_server)
2046 protect_args = orig_protect_args;
2048 if (protect_args == 1 && am_server)
2049 return 1;
2051 *argv_p = argv = poptGetArgs(pc);
2052 *argc_p = argc = count_args(argv);
2054 #ifndef SUPPORT_LINKS
2055 if (preserve_links && !am_sender) {
2056 snprintf(err_buf, sizeof err_buf,
2057 "symlinks are not supported on this %s\n",
2058 am_server ? "server" : "client");
2059 return 0;
2061 #endif
2063 #ifndef SUPPORT_HARD_LINKS
2064 if (preserve_hard_links) {
2065 snprintf(err_buf, sizeof err_buf,
2066 "hard links are not supported on this %s\n",
2067 am_server ? "server" : "client");
2068 return 0;
2070 #endif
2072 #ifdef SUPPORT_XATTRS
2073 if (am_root < 0 && preserve_xattrs > 1) {
2074 snprintf(err_buf, sizeof err_buf,
2075 "--fake-super conflicts with -XX\n");
2076 return 0;
2078 #else
2079 if (am_root < 0) {
2080 snprintf(err_buf, sizeof err_buf,
2081 "--fake-super requires an rsync with extended attributes enabled\n");
2082 return 0;
2084 #endif
2086 if (block_size) {
2087 /* We may not know the real protocol_version at this point if this is the client
2088 * option parsing, but we still want to check it so that the client can specify
2089 * a --protocol=29 option with a larger block size. */
2090 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
2092 if (block_size > max_blength) {
2093 snprintf(err_buf, sizeof err_buf,
2094 "--block-size=%lu is too large (max: %u)\n", block_size, max_blength);
2095 return 0;
2099 if (write_batch && read_batch) {
2100 snprintf(err_buf, sizeof err_buf,
2101 "--write-batch and --read-batch can not be used together\n");
2102 return 0;
2104 if (write_batch > 0 || read_batch) {
2105 if (am_server) {
2106 rprintf(FINFO,
2107 "ignoring --%s-batch option sent to server\n",
2108 write_batch ? "write" : "read");
2109 /* We don't actually exit_cleanup(), so that we can
2110 * still service older version clients that still send
2111 * batch args to server. */
2112 read_batch = write_batch = 0;
2113 batch_name = NULL;
2114 } else if (dry_run)
2115 write_batch = 0;
2116 } else if (write_batch < 0 && dry_run)
2117 write_batch = 0;
2118 if (read_batch && files_from) {
2119 snprintf(err_buf, sizeof err_buf,
2120 "--read-batch cannot be used with --files-from\n");
2121 return 0;
2123 if (read_batch && remove_source_files) {
2124 snprintf(err_buf, sizeof err_buf,
2125 "--read-batch cannot be used with --remove-%s-files\n",
2126 remove_source_files == 1 ? "source" : "sent");
2127 return 0;
2129 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
2130 snprintf(err_buf, sizeof err_buf,
2131 "the batch-file name must be %d characters or less.\n",
2132 MAX_BATCH_NAME_LEN);
2133 return 0;
2136 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
2137 snprintf(err_buf, sizeof err_buf,
2138 "the --temp-dir path is WAY too long.\n");
2139 return 0;
2142 if (max_delete < 0 && max_delete != INT_MIN) {
2143 /* Negative numbers are treated as "no deletions". */
2144 max_delete = 0;
2147 if (compare_dest + copy_dest + link_dest > 1) {
2148 snprintf(err_buf, sizeof err_buf,
2149 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
2150 return 0;
2153 if (files_from) {
2154 if (recurse == 1) /* preserve recurse == 2 */
2155 recurse = 0;
2156 if (xfer_dirs < 0)
2157 xfer_dirs = 1;
2160 if (argc < 2 && !read_batch && !am_server)
2161 list_only |= 1;
2163 if (xfer_dirs >= 4) {
2164 parse_filter_str(&filter_list, "- /*/*", rule_template(0), 0);
2165 recurse = xfer_dirs = 1;
2166 } else if (recurse)
2167 xfer_dirs = 1;
2168 else if (xfer_dirs < 0)
2169 xfer_dirs = list_only ? 1 : 0;
2171 if (relative_paths < 0)
2172 relative_paths = files_from? 1 : 0;
2173 if (!relative_paths)
2174 implied_dirs = 0;
2176 if (delete_before + !!delete_during + delete_after > 1) {
2177 snprintf(err_buf, sizeof err_buf,
2178 "You may not combine multiple --delete-WHEN options.\n");
2179 return 0;
2181 if (delete_before || delete_during || delete_after)
2182 delete_mode = 1;
2183 else if (delete_mode || delete_excluded) {
2184 /* Only choose now between before & during if one is refused. */
2185 if (refused_delete_before) {
2186 if (!refused_delete_during)
2187 delete_during = 1;
2188 else {
2189 create_refuse_error(refused_delete_before);
2190 return 0;
2192 } else if (refused_delete_during)
2193 delete_before = 1;
2194 delete_mode = 1;
2196 if (!xfer_dirs && delete_mode) {
2197 snprintf(err_buf, sizeof err_buf,
2198 "--delete does not work without --recursive (-r) or --dirs (-d).\n");
2199 return 0;
2202 if (missing_args == 3) /* simplify if both options were specified */
2203 missing_args = 2;
2204 if (refused_delete && (delete_mode || missing_args == 2)) {
2205 create_refuse_error(refused_delete);
2206 return 0;
2209 if (remove_source_files) {
2210 /* We only want to infer this refusal of --remove-source-files
2211 * via the refusal of "delete", not any of the "delete-FOO"
2212 * options. */
2213 if (refused_delete && am_sender) {
2214 create_refuse_error(refused_delete);
2215 return 0;
2217 need_messages_from_generator = 1;
2220 if (munge_symlinks && !am_daemon) {
2221 STRUCT_STAT st;
2222 char prefix[SYMLINK_PREFIX_LEN]; /* NOT +1 ! */
2223 strlcpy(prefix, SYMLINK_PREFIX, sizeof prefix); /* trim the trailing slash */
2224 if (do_stat(prefix, &st) == 0 && S_ISDIR(st.st_mode)) {
2225 rprintf(FERROR, "Symlink munging is unsafe when a %s directory exists.\n",
2226 prefix);
2227 exit_cleanup(RERR_UNSUPPORTED);
2231 if (sanitize_paths) {
2232 int i;
2233 for (i = argc; i-- > 0; )
2234 argv[i] = sanitize_path(NULL, argv[i], "", 0, SP_KEEP_DOT_DIRS);
2235 if (tmpdir)
2236 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0, SP_DEFAULT);
2237 if (backup_dir)
2238 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0, SP_DEFAULT);
2240 if (daemon_filter_list.head && !am_sender) {
2241 filter_rule_list *elp = &daemon_filter_list;
2242 if (tmpdir) {
2243 char *dir;
2244 if (!*tmpdir)
2245 goto options_rejected;
2246 dir = tmpdir + (*tmpdir == '/' ? module_dirlen : 0);
2247 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2248 if (check_filter(elp, FLOG, dir, 1) < 0)
2249 goto options_rejected;
2251 if (backup_dir) {
2252 char *dir;
2253 if (!*backup_dir)
2254 goto options_rejected;
2255 dir = backup_dir + (*backup_dir == '/' ? module_dirlen : 0);
2256 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2257 if (check_filter(elp, FLOG, dir, 1) < 0)
2258 goto options_rejected;
2262 if (!backup_suffix)
2263 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
2264 backup_suffix_len = strlen(backup_suffix);
2265 if (strchr(backup_suffix, '/') != NULL) {
2266 snprintf(err_buf, sizeof err_buf,
2267 "--suffix cannot contain slashes: %s\n",
2268 backup_suffix);
2269 return 0;
2271 if (backup_dir) {
2272 size_t len;
2273 while (*backup_dir == '.' && backup_dir[1] == '/')
2274 backup_dir += 2;
2275 if (*backup_dir == '.' && backup_dir[1] == '\0')
2276 backup_dir++;
2277 len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
2278 if (len > sizeof backup_dir_buf - 128) {
2279 snprintf(err_buf, sizeof err_buf,
2280 "the --backup-dir path is WAY too long.\n");
2281 return 0;
2283 backup_dir_len = (int)len;
2284 if (!backup_dir_len) {
2285 backup_dir_len = -1;
2286 backup_dir = NULL;
2287 } else if (backup_dir_buf[backup_dir_len - 1] != '/') {
2288 backup_dir_buf[backup_dir_len++] = '/';
2289 backup_dir_buf[backup_dir_len] = '\0';
2291 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
2293 if (backup_dir) {
2294 /* No need for a suffix or a protect rule. */
2295 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
2296 snprintf(err_buf, sizeof err_buf,
2297 "--suffix cannot be empty %s\n", backup_dir_len < 0
2298 ? "when --backup-dir is the same as the dest dir"
2299 : "without a --backup-dir");
2300 return 0;
2301 } else if (make_backups && delete_mode && !delete_excluded && !am_server) {
2302 snprintf(backup_dir_buf, sizeof backup_dir_buf,
2303 "P *%s", backup_suffix);
2304 parse_filter_str(&filter_list, backup_dir_buf, rule_template(0), 0);
2307 if (preserve_times) {
2308 preserve_times = PRESERVE_FILE_TIMES;
2309 if (!omit_dir_times)
2310 preserve_times |= PRESERVE_DIR_TIMES;
2311 #ifdef CAN_SET_SYMLINK_TIMES
2312 if (!omit_link_times)
2313 preserve_times |= PRESERVE_LINK_TIMES;
2314 #endif
2317 if (make_backups && !backup_dir) {
2318 omit_dir_times = 0; /* Implied, so avoid -O to sender. */
2319 preserve_times &= ~PRESERVE_DIR_TIMES;
2322 if (stdout_format) {
2323 if (am_server && log_format_has(stdout_format, 'I'))
2324 stdout_format_has_i = 2;
2325 else if (log_format_has(stdout_format, 'i'))
2326 stdout_format_has_i = itemize_changes | 1;
2327 if (!log_format_has(stdout_format, 'b')
2328 && !log_format_has(stdout_format, 'c')
2329 && !log_format_has(stdout_format, 'C'))
2330 log_before_transfer = !am_server;
2331 } else if (itemize_changes) {
2332 stdout_format = "%i %n%L";
2333 stdout_format_has_i = itemize_changes;
2334 log_before_transfer = !am_server;
2337 if (do_progress && !am_server) {
2338 if (!log_before_transfer && INFO_EQ(NAME, 0))
2339 parse_output_words(info_words, info_levels, "name", DEFAULT_PRIORITY);
2340 parse_output_words(info_words, info_levels, "flist2,progress", DEFAULT_PRIORITY);
2343 if (dry_run)
2344 do_xfers = 0;
2346 set_io_timeout(io_timeout);
2348 if (INFO_GTE(NAME, 1) && !stdout_format) {
2349 stdout_format = "%n%L";
2350 log_before_transfer = !am_server;
2352 if (stdout_format_has_i || log_format_has(stdout_format, 'o'))
2353 stdout_format_has_o_or_i = 1;
2355 if (logfile_name && !am_daemon) {
2356 if (!logfile_format) {
2357 logfile_format = "%i %n%L";
2358 logfile_format_has_i = logfile_format_has_o_or_i = 1;
2359 } else {
2360 if (log_format_has(logfile_format, 'i'))
2361 logfile_format_has_i = 1;
2362 if (logfile_format_has_i || log_format_has(logfile_format, 'o'))
2363 logfile_format_has_o_or_i = 1;
2365 log_init(0);
2366 } else if (!am_daemon)
2367 logfile_format = NULL;
2369 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
2370 bwlimit = daemon_bwlimit;
2371 if (bwlimit) {
2372 bwlimit_writemax = (size_t)bwlimit * 128;
2373 if (bwlimit_writemax < 512)
2374 bwlimit_writemax = 512;
2377 if (append_mode) {
2378 if (whole_file > 0) {
2379 snprintf(err_buf, sizeof err_buf,
2380 "--append cannot be used with --whole-file\n");
2381 return 0;
2383 if (refused_inplace) {
2384 create_refuse_error(refused_inplace);
2385 return 0;
2387 inplace = 1;
2390 if (write_devices) {
2391 if (refused_inplace) {
2392 create_refuse_error(refused_inplace);
2393 return 0;
2395 inplace = 1;
2398 if (delay_updates && !partial_dir)
2399 partial_dir = tmp_partialdir;
2401 if (inplace) {
2402 #ifdef HAVE_FTRUNCATE
2403 if (partial_dir) {
2404 snprintf(err_buf, sizeof err_buf,
2405 "--%s cannot be used with --%s\n",
2406 append_mode ? "append" : "inplace",
2407 delay_updates ? "delay-updates" : "partial-dir");
2408 return 0;
2410 /* --inplace implies --partial for refusal purposes, but we
2411 * clear the keep_partial flag for internal logic purposes. */
2412 if (refused_partial) {
2413 create_refuse_error(refused_partial);
2414 return 0;
2416 keep_partial = 0;
2417 #else
2418 snprintf(err_buf, sizeof err_buf,
2419 "--%s is not supported on this %s\n",
2420 append_mode ? "append" : "inplace",
2421 am_server ? "server" : "client");
2422 return 0;
2423 #endif
2424 } else {
2425 if (keep_partial && !partial_dir && !am_server) {
2426 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
2427 partial_dir = strdup(arg);
2429 if (partial_dir) {
2430 if (*partial_dir)
2431 clean_fname(partial_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2432 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
2433 partial_dir = NULL;
2434 if (!partial_dir && refused_partial) {
2435 create_refuse_error(refused_partial);
2436 return 0;
2438 keep_partial = 1;
2442 if (files_from) {
2443 char *h, *p;
2444 int q;
2445 if (argc > 2 || (!am_daemon && !am_server && argc == 1)) {
2446 usage(FERROR);
2447 exit_cleanup(RERR_SYNTAX);
2449 if (strcmp(files_from, "-") == 0) {
2450 filesfrom_fd = 0;
2451 if (am_server)
2452 filesfrom_host = ""; /* reading from socket */
2453 } else if ((p = check_for_hostspec(files_from, &h, &q)) != 0) {
2454 if (am_server) {
2455 snprintf(err_buf, sizeof err_buf,
2456 "The --files-from sent to the server cannot specify a host.\n");
2457 return 0;
2459 files_from = p;
2460 filesfrom_host = h;
2461 if (strcmp(files_from, "-") == 0) {
2462 snprintf(err_buf, sizeof err_buf,
2463 "Invalid --files-from remote filename\n");
2464 return 0;
2466 } else {
2467 if (sanitize_paths)
2468 files_from = sanitize_path(NULL, files_from, NULL, 0, SP_DEFAULT);
2469 if (daemon_filter_list.head) {
2470 char *dir;
2471 if (!*files_from)
2472 goto options_rejected;
2473 dir = files_from + (*files_from == '/' ? module_dirlen : 0);
2474 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2475 if (check_filter(&daemon_filter_list, FLOG, dir, 0) < 0)
2476 goto options_rejected;
2478 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
2479 if (filesfrom_fd < 0) {
2480 snprintf(err_buf, sizeof err_buf,
2481 "failed to open files-from file %s: %s\n",
2482 files_from, strerror(errno));
2483 return 0;
2488 am_starting_up = 0;
2490 return 1;
2492 options_rejected:
2493 snprintf(err_buf, sizeof err_buf,
2494 "Your options have been rejected by the server.\n");
2495 return 0;
2500 * Construct a filtered list of options to pass through from the
2501 * client to the server.
2503 * This involves setting options that will tell the server how to
2504 * behave, and also filtering out options that are processed only
2505 * locally.
2507 void server_options(char **args, int *argc_p)
2509 static char argstr[64];
2510 int ac = *argc_p;
2511 uchar where;
2512 char *arg;
2513 int i, x;
2515 /* This should always remain first on the server's command-line. */
2516 args[ac++] = "--server";
2518 if (daemon_over_rsh > 0) {
2519 args[ac++] = "--daemon";
2520 *argc_p = ac;
2521 /* if we're passing --daemon, we're done */
2522 return;
2525 if (!am_sender)
2526 args[ac++] = "--sender";
2528 x = 1;
2529 argstr[0] = '-';
2531 if (protect_args)
2532 argstr[x++] = 's';
2534 for (i = 0; i < verbose; i++)
2535 argstr[x++] = 'v';
2537 /* the -q option is intentionally left out */
2538 if (make_backups)
2539 argstr[x++] = 'b';
2540 if (update_only)
2541 argstr[x++] = 'u';
2542 if (!do_xfers) /* Note: NOT "dry_run"! */
2543 argstr[x++] = 'n';
2544 if (preserve_links)
2545 argstr[x++] = 'l';
2546 if ((xfer_dirs >= 2 && xfer_dirs < 4)
2547 || (xfer_dirs && !recurse && (list_only || (delete_mode && am_sender))))
2548 argstr[x++] = 'd';
2549 if (am_sender) {
2550 if (keep_dirlinks)
2551 argstr[x++] = 'K';
2552 if (prune_empty_dirs)
2553 argstr[x++] = 'm';
2554 if (omit_dir_times)
2555 argstr[x++] = 'O';
2556 if (omit_link_times)
2557 argstr[x++] = 'J';
2558 if (fuzzy_basis) {
2559 argstr[x++] = 'y';
2560 if (fuzzy_basis > 1)
2561 argstr[x++] = 'y';
2563 } else {
2564 if (copy_links)
2565 argstr[x++] = 'L';
2566 if (copy_dirlinks)
2567 argstr[x++] = 'k';
2570 if (whole_file > 0)
2571 argstr[x++] = 'W';
2572 /* We don't need to send --no-whole-file, because it's the
2573 * default for remote transfers, and in any case old versions
2574 * of rsync will not understand it. */
2576 if (preserve_hard_links) {
2577 argstr[x++] = 'H';
2578 if (preserve_hard_links > 1)
2579 argstr[x++] = 'H';
2581 if (preserve_uid)
2582 argstr[x++] = 'o';
2583 if (preserve_gid)
2584 argstr[x++] = 'g';
2585 if (preserve_devices) /* ignore preserve_specials here */
2586 argstr[x++] = 'D';
2587 if (preserve_times)
2588 argstr[x++] = 't';
2589 if (preserve_atimes) {
2590 argstr[x++] = 'U';
2591 if (preserve_atimes > 1)
2592 argstr[x++] = 'U';
2594 if (preserve_perms)
2595 argstr[x++] = 'p';
2596 else if (preserve_executability && am_sender)
2597 argstr[x++] = 'E';
2598 #ifdef SUPPORT_ACLS
2599 if (preserve_acls)
2600 argstr[x++] = 'A';
2601 #endif
2602 #ifdef SUPPORT_XATTRS
2603 if (preserve_xattrs) {
2604 argstr[x++] = 'X';
2605 if (preserve_xattrs > 1)
2606 argstr[x++] = 'X';
2608 #endif
2609 if (recurse)
2610 argstr[x++] = 'r';
2611 if (always_checksum)
2612 argstr[x++] = 'c';
2613 if (cvs_exclude)
2614 argstr[x++] = 'C';
2615 if (ignore_times)
2616 argstr[x++] = 'I';
2617 if (relative_paths)
2618 argstr[x++] = 'R';
2619 if (one_file_system) {
2620 argstr[x++] = 'x';
2621 if (one_file_system > 1)
2622 argstr[x++] = 'x';
2624 if (sparse_files)
2625 argstr[x++] = 'S';
2626 if (do_compression == CPRES_ZLIB)
2627 argstr[x++] = 'z';
2629 set_allow_inc_recurse();
2631 /* We don't really know the actual protocol_version at this point,
2632 * but checking the pre-negotiated value allows the user to use a
2633 * --protocol=29 override to avoid the use of this -eFLAGS opt. */
2634 if (protocol_version >= 30) {
2635 /* Use "eFlags" alias so that cull_options doesn't think that these are no-arg option letters. */
2636 #define eFlags argstr
2637 /* We make use of the -e option to let the server know about
2638 * any pre-release protocol version && some behavior flags. */
2639 eFlags[x++] = 'e';
2640 #if SUBPROTOCOL_VERSION != 0
2641 if (protocol_version == PROTOCOL_VERSION) {
2642 x += snprintf(argstr+x, sizeof argstr - x,
2643 "%d.%d",
2644 PROTOCOL_VERSION, SUBPROTOCOL_VERSION);
2645 } else
2646 #endif
2647 eFlags[x++] = '.';
2648 if (allow_inc_recurse)
2649 eFlags[x++] = 'i';
2650 #ifdef CAN_SET_SYMLINK_TIMES
2651 eFlags[x++] = 'L'; /* symlink time-setting support */
2652 #endif
2653 #ifdef ICONV_OPTION
2654 eFlags[x++] = 's'; /* symlink iconv translation support */
2655 #endif
2656 eFlags[x++] = 'f'; /* flist I/O-error safety support */
2657 eFlags[x++] = 'x'; /* xattr hardlink optimization not desired */
2658 eFlags[x++] = 'C'; /* support checksum seed order fix */
2659 eFlags[x++] = 'I'; /* support inplace_partial behavior */
2660 eFlags[x++] = 'v'; /* use varint for flist & compat flags; negotiate checksum */
2661 /* NOTE: Avoid using 'V' -- it was the high bit of a write_byte() that became write_varint(). */
2662 #undef eFlags
2665 if (x >= (int)sizeof argstr) { /* Not possible... */
2666 rprintf(FERROR, "argstr overflow in server_options().\n");
2667 exit_cleanup(RERR_MALLOC);
2670 argstr[x] = '\0';
2672 if (x > 1)
2673 args[ac++] = argstr;
2675 #ifdef ICONV_OPTION
2676 if (iconv_opt) {
2677 char *set = strchr(iconv_opt, ',');
2678 if (set)
2679 set++;
2680 else
2681 set = iconv_opt;
2682 if (asprintf(&arg, "--iconv=%s", set) < 0)
2683 goto oom;
2684 args[ac++] = arg;
2686 #endif
2688 if (protect_args && !local_server) /* unprotected args stop here */
2689 args[ac++] = NULL;
2691 if (list_only > 1)
2692 args[ac++] = "--list-only";
2694 /* This makes sure that the remote rsync can handle deleting with -d
2695 * sans -r because the --no-r option was added at the same time. */
2696 if (xfer_dirs && !recurse && delete_mode && am_sender)
2697 args[ac++] = "--no-r";
2699 if (do_compression && do_compression_level != CLVL_NOT_SPECIFIED) {
2700 if (asprintf(&arg, "--compress-level=%d", do_compression_level) < 0)
2701 goto oom;
2702 args[ac++] = arg;
2705 if (preserve_devices) {
2706 /* Note: sending "--devices" would not be backward-compatible. */
2707 if (!preserve_specials)
2708 args[ac++] = "--no-specials"; /* -D is already set. */
2709 } else if (preserve_specials)
2710 args[ac++] = "--specials";
2712 /* The server side doesn't use our log-format, but in certain
2713 * circumstances they need to know a little about the option. */
2714 if (stdout_format && am_sender) {
2715 /* Use --log-format, not --out-format, for compatibility. */
2716 if (stdout_format_has_i > 1)
2717 args[ac++] = "--log-format=%i%I";
2718 else if (stdout_format_has_i)
2719 args[ac++] = "--log-format=%i";
2720 else if (stdout_format_has_o_or_i)
2721 args[ac++] = "--log-format=%o";
2722 else if (!verbose)
2723 args[ac++] = "--log-format=X";
2726 if (block_size) {
2727 if (asprintf(&arg, "-B%lu", block_size) < 0)
2728 goto oom;
2729 args[ac++] = arg;
2732 if (io_timeout) {
2733 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
2734 goto oom;
2735 args[ac++] = arg;
2738 if (bwlimit) {
2739 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
2740 goto oom;
2741 args[ac++] = arg;
2744 if (backup_dir) {
2745 args[ac++] = "--backup-dir";
2746 args[ac++] = backup_dir;
2749 /* Only send --suffix if it specifies a non-default value. */
2750 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
2751 /* We use the following syntax to avoid weirdness with '~'. */
2752 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
2753 goto oom;
2754 args[ac++] = arg;
2757 if (checksum_choice) {
2758 if (asprintf(&arg, "--checksum-choice=%s", checksum_choice) < 0)
2759 goto oom;
2760 args[ac++] = arg;
2763 if (do_compression == CPRES_ZLIBX)
2764 args[ac++] = "--new-compress";
2765 else if (compress_choice && do_compression == CPRES_ZLIB)
2766 args[ac++] = "--old-compress";
2767 else if (compress_choice) {
2768 if (asprintf(&arg, "--compress-choice=%s", compress_choice) < 0)
2769 goto oom;
2770 args[ac++] = arg;
2773 if (am_sender) {
2774 if (max_delete > 0) {
2775 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
2776 goto oom;
2777 args[ac++] = arg;
2778 } else if (max_delete == 0)
2779 args[ac++] = "--max-delete=-1";
2780 if (min_size >= 0) {
2781 args[ac++] = "--min-size";
2782 args[ac++] = min_size_arg;
2784 if (max_size >= 0) {
2785 args[ac++] = "--max-size";
2786 args[ac++] = max_size_arg;
2788 if (delete_before)
2789 args[ac++] = "--delete-before";
2790 else if (delete_during == 2)
2791 args[ac++] = "--delete-delay";
2792 else if (delete_during)
2793 args[ac++] = "--delete-during";
2794 else if (delete_after)
2795 args[ac++] = "--delete-after";
2796 else if (delete_mode && !delete_excluded)
2797 args[ac++] = "--delete";
2798 if (delete_excluded)
2799 args[ac++] = "--delete-excluded";
2800 if (force_delete)
2801 args[ac++] = "--force";
2802 if (write_batch < 0)
2803 args[ac++] = "--only-write-batch=X";
2804 if (am_root > 1)
2805 args[ac++] = "--super";
2806 if (size_only)
2807 args[ac++] = "--size-only";
2808 if (do_stats)
2809 args[ac++] = "--stats";
2810 } else {
2811 if (skip_compress) {
2812 if (asprintf(&arg, "--skip-compress=%s", skip_compress) < 0)
2813 goto oom;
2814 args[ac++] = arg;
2818 /* --delete-missing-args needs the cooperation of both sides, but
2819 * the sender can handle --ignore-missing-args by itself. */
2820 if (missing_args == 2)
2821 args[ac++] = "--delete-missing-args";
2822 else if (missing_args == 1 && !am_sender)
2823 args[ac++] = "--ignore-missing-args";
2825 if (modify_window_set && am_sender) {
2826 char *fmt = modify_window < 0 ? "-@%d" : "--modify-window=%d";
2827 if (asprintf(&arg, fmt, modify_window) < 0)
2828 goto oom;
2829 args[ac++] = arg;
2832 if (checksum_seed) {
2833 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
2834 goto oom;
2835 args[ac++] = arg;
2838 if (partial_dir && am_sender) {
2839 if (partial_dir != tmp_partialdir) {
2840 args[ac++] = "--partial-dir";
2841 args[ac++] = partial_dir;
2843 if (delay_updates)
2844 args[ac++] = "--delay-updates";
2845 } else if (keep_partial && am_sender)
2846 args[ac++] = "--partial";
2848 if (ignore_errors)
2849 args[ac++] = "--ignore-errors";
2851 if (copy_unsafe_links)
2852 args[ac++] = "--copy-unsafe-links";
2854 if (safe_symlinks)
2855 args[ac++] = "--safe-links";
2857 if (numeric_ids)
2858 args[ac++] = "--numeric-ids";
2860 if (use_qsort)
2861 args[ac++] = "--use-qsort";
2863 if (am_sender) {
2864 if (usermap) {
2865 if (asprintf(&arg, "--usermap=%s", usermap) < 0)
2866 goto oom;
2867 args[ac++] = arg;
2870 if (groupmap) {
2871 if (asprintf(&arg, "--groupmap=%s", groupmap) < 0)
2872 goto oom;
2873 args[ac++] = arg;
2876 if (ignore_existing)
2877 args[ac++] = "--ignore-existing";
2879 /* Backward compatibility: send --existing, not --ignore-non-existing. */
2880 if (ignore_non_existing)
2881 args[ac++] = "--existing";
2883 if (tmpdir) {
2884 args[ac++] = "--temp-dir";
2885 args[ac++] = tmpdir;
2888 if (basis_dir[0]) {
2889 /* the server only needs this option if it is not the sender,
2890 * and it may be an older version that doesn't know this
2891 * option, so don't send it if client is the sender.
2893 for (i = 0; i < basis_dir_cnt; i++) {
2894 args[ac++] = dest_option;
2895 args[ac++] = basis_dir[i];
2900 /* What flags do we need to send to the other side? */
2901 where = (am_server ? W_CLI : W_SRV) | (am_sender ? W_REC : W_SND);
2902 arg = make_output_option(info_words, info_levels, where);
2903 if (arg)
2904 args[ac++] = arg;
2906 if (append_mode) {
2907 if (append_mode > 1)
2908 args[ac++] = "--append";
2909 args[ac++] = "--append";
2910 } else if (inplace)
2911 args[ac++] = "--inplace";
2913 if (files_from && (!am_sender || filesfrom_host)) {
2914 if (filesfrom_host) {
2915 args[ac++] = "--files-from";
2916 args[ac++] = files_from;
2917 if (eol_nulls)
2918 args[ac++] = "--from0";
2919 } else {
2920 args[ac++] = "--files-from=-";
2921 args[ac++] = "--from0";
2923 if (!relative_paths)
2924 args[ac++] = "--no-relative";
2926 /* It's OK that this checks the upper-bound of the protocol_version. */
2927 if (relative_paths && !implied_dirs && (!am_sender || protocol_version >= 30))
2928 args[ac++] = "--no-implied-dirs";
2930 if (write_devices && am_sender)
2931 args[ac++] = "--write-devices";
2933 if (remove_source_files == 1)
2934 args[ac++] = "--remove-source-files";
2935 else if (remove_source_files)
2936 args[ac++] = "--remove-sent-files";
2938 if (preallocate_files && am_sender)
2939 args[ac++] = "--preallocate";
2941 if (open_noatime && preserve_atimes <= 1)
2942 args[ac++] = "--open-noatime";
2944 if (ac > MAX_SERVER_ARGS) { /* Not possible... */
2945 rprintf(FERROR, "argc overflow in server_options().\n");
2946 exit_cleanup(RERR_MALLOC);
2949 if (remote_option_cnt) {
2950 int j;
2951 if (ac + remote_option_cnt > MAX_SERVER_ARGS) {
2952 rprintf(FERROR, "too many remote options specified.\n");
2953 exit_cleanup(RERR_SYNTAX);
2955 for (j = 1; j <= remote_option_cnt; j++)
2956 args[ac++] = (char*)remote_options[j];
2959 *argc_p = ac;
2960 return;
2962 oom:
2963 out_of_memory("server_options");
2966 /* If str points to a valid hostspec, return allocated memory containing the
2967 * [USER@]HOST part of the string, and set the path_start_ptr to the part of
2968 * the string after the host part. Otherwise, return NULL. If port_ptr is
2969 * non-NULL, we must be parsing an rsync:// URL hostname, and we will set
2970 * *port_ptr if a port number is found. Note that IPv6 IPs will have their
2971 * (required for parsing) [ and ] chars elided from the returned string. */
2972 static char *parse_hostspec(char *str, char **path_start_ptr, int *port_ptr)
2974 char *s, *host_start = str;
2975 int hostlen = 0, userlen = 0;
2976 char *ret;
2978 for (s = str; ; s++) {
2979 if (!*s) {
2980 /* It is only OK if we run out of string with rsync:// */
2981 if (!port_ptr)
2982 return NULL;
2983 if (!hostlen)
2984 hostlen = s - host_start;
2985 break;
2987 if (*s == ':' || *s == '/') {
2988 if (!hostlen)
2989 hostlen = s - host_start;
2990 if (*s++ == '/') {
2991 if (!port_ptr)
2992 return NULL;
2993 } else if (port_ptr) {
2994 *port_ptr = atoi(s);
2995 while (isDigit(s)) s++;
2996 if (*s && *s++ != '/')
2997 return NULL;
2999 break;
3001 if (*s == '@') {
3002 userlen = s - str + 1;
3003 host_start = s + 1;
3004 } else if (*s == '[') {
3005 if (s != host_start++)
3006 return NULL;
3007 while (*s && *s != ']' && *s != '/') s++; /*SHARED ITERATOR*/
3008 hostlen = s - host_start;
3009 if (*s != ']' || (s[1] && s[1] != '/' && s[1] != ':') || !hostlen)
3010 return NULL;
3014 *path_start_ptr = s;
3015 ret = new_array(char, userlen + hostlen + 1);
3016 if (userlen)
3017 strlcpy(ret, str, userlen + 1);
3018 strlcpy(ret + userlen, host_start, hostlen + 1);
3019 return ret;
3022 /* Look for a HOST specification of the form "HOST:PATH", "HOST::PATH", or
3023 * "rsync://HOST:PORT/PATH". If found, *host_ptr will be set to some allocated
3024 * memory with the HOST. If a daemon-accessing spec was specified, the value
3025 * of *port_ptr will contain a non-0 port number, otherwise it will be set to
3026 * 0. The return value is a pointer to the PATH. Note that the HOST spec can
3027 * be an IPv6 literal address enclosed in '[' and ']' (such as "[::1]" or
3028 * "[::ffff:127.0.0.1]") which is returned without the '[' and ']'. */
3029 char *check_for_hostspec(char *s, char **host_ptr, int *port_ptr)
3031 char *path;
3033 if (port_ptr && strncasecmp(URL_PREFIX, s, strlen(URL_PREFIX)) == 0) {
3034 *host_ptr = parse_hostspec(s + strlen(URL_PREFIX), &path, port_ptr);
3035 if (*host_ptr) {
3036 if (!*port_ptr)
3037 *port_ptr = -1; /* -1 indicates they want the default */
3038 return path;
3042 *host_ptr = parse_hostspec(s, &path, NULL);
3043 if (!*host_ptr)
3044 return NULL;
3046 if (*path == ':') {
3047 if (port_ptr && !*port_ptr)
3048 *port_ptr = -1;
3049 return path + 1;
3051 if (port_ptr)
3052 *port_ptr = 0;
3054 return path;