Fix a comment.
[rsync/qnx.git] / options.c
bloba8c5b49f4f99472fa0403df83e717b1037edb250
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-2011 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 <popt.h>
25 #include "zlib/zlib.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 filter_rule_list filter_list;
33 extern filter_rule_list daemon_filter_list;
35 int make_backups = 0;
37 /**
38 * If 1, send the whole file as literal data rather than trying to
39 * create an incremental diff.
41 * If -1, then look at whether we're local or remote and go by that.
43 * @sa disable_deltas_p()
44 **/
45 int whole_file = -1;
47 int append_mode = 0;
48 int keep_dirlinks = 0;
49 int copy_dirlinks = 0;
50 int copy_links = 0;
51 int preserve_links = 0;
52 int preserve_hard_links = 0;
53 int preserve_acls = 0;
54 int preserve_xattrs = 0;
55 int preserve_perms = 0;
56 int preserve_executability = 0;
57 int preserve_devices = 0;
58 int preserve_specials = 0;
59 int preserve_uid = 0;
60 int preserve_gid = 0;
61 int preserve_times = 0;
62 int update_only = 0;
63 int cvs_exclude = 0;
64 int dry_run = 0;
65 int do_xfers = 1;
66 int ignore_times = 0;
67 int delete_mode = 0;
68 int delete_during = 0;
69 int delete_before = 0;
70 int delete_after = 0;
71 int delete_excluded = 0;
72 int remove_source_files = 0;
73 int one_file_system = 0;
74 int protocol_version = PROTOCOL_VERSION;
75 int sparse_files = 0;
76 int preallocate_files = 0;
77 int do_compression = 0;
78 int def_compress_level = Z_DEFAULT_COMPRESSION;
79 int am_root = 0; /* 0 = normal, 1 = root, 2 = --super, -1 = --fake-super */
80 int am_server = 0;
81 int am_sender = 0;
82 int am_starting_up = 1;
83 int relative_paths = -1;
84 int implied_dirs = 1;
85 int missing_args = 0; /* 0 = FERROR_XFER, 1 = ignore, 2 = delete */
86 int numeric_ids = 0;
87 int msgs2stderr = 0;
88 int allow_8bit_chars = 0;
89 int force_delete = 0;
90 int io_timeout = 0;
91 int prune_empty_dirs = 0;
92 int use_qsort = 0;
93 char *files_from = NULL;
94 int filesfrom_fd = -1;
95 char *filesfrom_host = NULL;
96 int eol_nulls = 0;
97 int protect_args = -1;
98 int human_readable = 1;
99 int recurse = 0;
100 int allow_inc_recurse = 1;
101 int xfer_dirs = -1;
102 int am_daemon = 0;
103 int connect_timeout = 0;
104 int keep_partial = 0;
105 int safe_symlinks = 0;
106 int copy_unsafe_links = 0;
107 int munge_symlinks = 0;
108 int size_only = 0;
109 int daemon_bwlimit = 0;
110 int bwlimit = 0;
111 int fuzzy_basis = 0;
112 size_t bwlimit_writemax = 0;
113 int ignore_existing = 0;
114 int ignore_non_existing = 0;
115 int need_messages_from_generator = 0;
116 int max_delete = INT_MIN;
117 OFF_T max_size = 0;
118 OFF_T min_size = 0;
119 int ignore_errors = 0;
120 int modify_window = 0;
121 int blocking_io = -1;
122 int checksum_seed = 0;
123 int inplace = 0;
124 int delay_updates = 0;
125 long block_size = 0; /* "long" because popt can't set an int32. */
126 char number_separator;
127 char *skip_compress = NULL;
128 item_list dparam_list = EMPTY_ITEM_LIST;
130 /** Network address family. **/
131 int default_af_hint
132 #ifdef INET6
133 = 0; /* Any protocol */
134 #else
135 = AF_INET; /* Must use IPv4 */
136 # ifdef AF_INET6
137 # undef AF_INET6
138 # endif
139 # define AF_INET6 AF_INET /* make -6 option a no-op */
140 #endif
142 /** Do not go into the background when run as --daemon. Good
143 * for debugging and required for running as a service on W32,
144 * or under Unix process-monitors. **/
145 int no_detach
146 #if defined _WIN32 || defined __WIN32__
147 = 1;
148 #else
149 = 0;
150 #endif
152 int write_batch = 0;
153 int read_batch = 0;
154 int backup_dir_len = 0;
155 int backup_suffix_len;
156 unsigned int backup_dir_remainder;
158 char *backup_suffix = NULL;
159 char *tmpdir = NULL;
160 char *partial_dir = NULL;
161 char *basis_dir[MAX_BASIS_DIRS+1];
162 char *config_file = NULL;
163 char *shell_cmd = NULL;
164 char *logfile_name = NULL;
165 char *logfile_format = NULL;
166 char *stdout_format = NULL;
167 char *password_file = NULL;
168 char *rsync_path = RSYNC_PATH;
169 char *backup_dir = NULL;
170 char backup_dir_buf[MAXPATHLEN];
171 char *sockopts = NULL;
172 char *usermap = NULL;
173 char *groupmap = NULL;
174 int rsync_port = 0;
175 int compare_dest = 0;
176 int copy_dest = 0;
177 int link_dest = 0;
178 int basis_dir_cnt = 0;
179 char *dest_option = NULL;
181 static int remote_option_alloc = 0;
182 int remote_option_cnt = 0;
183 const char **remote_options = NULL;
185 int quiet = 0;
186 int output_motd = 1;
187 int log_before_transfer = 0;
188 int stdout_format_has_i = 0;
189 int stdout_format_has_o_or_i = 0;
190 int logfile_format_has_i = 0;
191 int logfile_format_has_o_or_i = 0;
192 int always_checksum = 0;
193 int list_only = 0;
195 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
196 char *batch_name = NULL;
198 int need_unsorted_flist = 0;
199 #ifdef ICONV_OPTION
200 char *iconv_opt = ICONV_OPTION;
201 #endif
203 struct chmod_mode_struct *chmod_modes = NULL;
205 static const char *debug_verbosity[] = {
206 /*0*/ NULL,
207 /*1*/ NULL,
208 /*2*/ "BIND,CMD,CONNECT,DEL,DELTASUM,DUP,FILTER,FLIST,ICONV",
209 /*3*/ "ACL,BACKUP,DELTASUM2,DEL2,EXIT,FILTER2,FLIST2,FUZZY,GENR,OWN,RECV,SEND,TIME",
210 /*4*/ "CMD2,DELTASUM3,DEL3,EXIT2,FLIST3,ICONV2,OWN2,PROTO,TIME2",
211 /*5*/ "CHDIR,DELTASUM4,FLIST4,FUZZY2,HASH,HLINK",
214 #define MAX_VERBOSITY ((int)(sizeof debug_verbosity / sizeof debug_verbosity[0]) - 1)
216 static const char *info_verbosity[1+MAX_VERBOSITY] = {
217 /*0*/ NULL,
218 /*1*/ "COPY,DEL,FLIST,MISC,NAME,STATS,SYMSAFE",
219 /*2*/ "BACKUP,MISC2,MOUNT,NAME2,REMOVE,SKIP",
222 #define MAX_OUT_LEVEL 4 /* The largest N allowed for any flagN word. */
224 short info_levels[COUNT_INFO], debug_levels[COUNT_DEBUG];
226 #define DEFAULT_PRIORITY 0 /* Default/implied/--verbose set values. */
227 #define HELP_PRIORITY 1 /* The help output uses this level. */
228 #define USER_PRIORITY 2 /* User-specified via --info or --debug */
229 #define LIMIT_PRIORITY 3 /* Overriding priority when limiting values. */
231 #define W_CLI (1<<0) /* client side */
232 #define W_SRV (1<<1) /* server side */
233 #define W_SND (1<<2) /* sending side */
234 #define W_REC (1<<3) /* receiving side */
236 struct output_struct {
237 char *name; /* The name of the info/debug flag. */
238 char *help; /* The description of the info/debug flag. */
239 uchar namelen; /* The length of the name string. */
240 uchar flag; /* The flag's value, for consistency check. */
241 uchar where; /* Bits indicating where the flag is used. */
242 uchar priority; /* See *_PRIORITY defines. */
245 #define INFO_WORD(flag, where, help) { #flag, help, sizeof #flag - 1, INFO_##flag, where, 0 }
247 static struct output_struct info_words[COUNT_INFO+1] = {
248 INFO_WORD(BACKUP, W_REC, "Mention files backed up"),
249 INFO_WORD(COPY, W_REC, "Mention files copied locally on the receiving side"),
250 INFO_WORD(DEL, W_REC, "Mention deletions on the receiving side"),
251 INFO_WORD(FLIST, W_CLI, "Mention file-list receiving/sending (levels 1-2)"),
252 INFO_WORD(MISC, W_SND|W_REC, "Mention miscellaneous information (levels 1-2)"),
253 INFO_WORD(MOUNT, W_SND|W_REC, "Mention mounts that were found or skipped"),
254 INFO_WORD(NAME, W_SND|W_REC, "Mention 1) updated file/dir names, 2) unchanged names"),
255 INFO_WORD(PROGRESS, W_CLI, "Mention 1) per-file progress or 2) total transfer progress"),
256 INFO_WORD(REMOVE, W_SND, "Mention files removed on the sending side"),
257 INFO_WORD(SKIP, W_REC, "Mention files that are skipped due to options used"),
258 INFO_WORD(STATS, W_CLI|W_SRV, "Mention statistics at end of run (levels 1-3)"),
259 INFO_WORD(SYMSAFE, W_SND|W_REC, "Mention symlinks that are unsafe"),
260 { NULL, "--info", 0, 0, 0, 0 }
263 #define DEBUG_WORD(flag, where, help) { #flag, help, sizeof #flag - 1, DEBUG_##flag, where, 0 }
265 static struct output_struct debug_words[COUNT_DEBUG+1] = {
266 DEBUG_WORD(ACL, W_SND|W_REC, "Debug extra ACL info"),
267 DEBUG_WORD(BACKUP, W_REC, "Debug backup actions (levels 1-2)"),
268 DEBUG_WORD(BIND, W_CLI, "Debug socket bind actions"),
269 DEBUG_WORD(CHDIR, W_CLI|W_SRV, "Debug when the current directory changes"),
270 DEBUG_WORD(CONNECT, W_CLI, "Debug connection events"),
271 DEBUG_WORD(CMD, W_CLI, "Debug commands+options that are issued (levels 1-2)"),
272 DEBUG_WORD(DEL, W_REC, "Debug delete actions (levels 1-3)"),
273 DEBUG_WORD(DELTASUM, W_SND|W_REC, "Debug delta-transfer checksumming (levels 1-4)"),
274 DEBUG_WORD(DUP, W_REC, "Debug weeding of duplicate names"),
275 DEBUG_WORD(EXIT, W_CLI|W_SRV, "Debug exit events (levels 1-3)"),
276 DEBUG_WORD(FILTER, W_SND|W_REC, "Debug filter actions (levels 1-2)"),
277 DEBUG_WORD(FLIST, W_SND|W_REC, "Debug file-list operations (levels 1-4)"),
278 DEBUG_WORD(FUZZY, W_REC, "Debug fuzzy scoring (levels 1-2)"),
279 DEBUG_WORD(GENR, W_REC, "Debug generator functions"),
280 DEBUG_WORD(HASH, W_SND|W_REC, "Debug hashtable code"),
281 DEBUG_WORD(HLINK, W_SND|W_REC, "Debug hard-link actions (levels 1-3)"),
282 DEBUG_WORD(ICONV, W_CLI|W_SRV, "Debug iconv character conversions (levels 1-2)"),
283 DEBUG_WORD(IO, W_CLI|W_SRV, "Debug I/O routines (levels 1-4)"),
284 DEBUG_WORD(OWN, W_REC, "Debug ownership changes in users & groups (levels 1-2)"),
285 DEBUG_WORD(PROTO, W_CLI|W_SRV, "Debug protocol information"),
286 DEBUG_WORD(RECV, W_REC, "Debug receiver functions"),
287 DEBUG_WORD(SEND, W_SND, "Debug sender functions"),
288 DEBUG_WORD(TIME, W_REC, "Debug setting of modified times (levels 1-2)"),
289 { NULL, "--debug", 0, 0, 0, 0 }
292 static int verbose = 0;
293 static int do_stats = 0;
294 static int do_progress = 0;
295 static int daemon_opt; /* sets am_daemon after option error-reporting */
296 static int omit_dir_times = 0;
297 static int omit_link_times = 0;
298 static int F_option_cnt = 0;
299 static int modify_window_set;
300 static int itemize_changes = 0;
301 static int refused_delete, refused_archive_part, refused_compress;
302 static int refused_partial, refused_progress, refused_delete_before;
303 static int refused_delete_during;
304 static int refused_inplace, refused_no_iconv;
305 static BOOL usermap_via_chown, groupmap_via_chown;
306 static char *bwlimit_arg, *max_size_arg, *min_size_arg;
307 static char tmp_partialdir[] = ".~tmp~";
309 /** Local address to bind. As a character string because it's
310 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
311 * address, or a hostname. **/
312 char *bind_address;
314 static void output_item_help(struct output_struct *words);
316 /* This constructs a string that represents all the options set for either
317 * the --info or --debug setting, skipping any implied options (by -v, etc.).
318 * This is used both when conveying the user's options to the server, and
319 * when the help output wants to tell the user what options are implied. */
320 static char *make_output_option(struct output_struct *words, short *levels, uchar where)
322 char *str = words == info_words ? "--info=" : "--debug=";
323 int j, counts[MAX_OUT_LEVEL+1], pos, skipped = 0, len = 0, max = 0, lev = 0;
324 int word_count = words == info_words ? COUNT_INFO : COUNT_DEBUG;
325 char *buf;
327 memset(counts, 0, sizeof counts);
329 for (j = 0; words[j].name; j++) {
330 if (words[j].flag != j) {
331 rprintf(FERROR, "rsync: internal error on %s%s: %d != %d\n",
332 words == info_words ? "INFO_" : "DEBUG_",
333 words[j].name, words[j].flag, j);
334 exit_cleanup(RERR_UNSUPPORTED);
336 if (!(words[j].where & where))
337 continue;
338 if (words[j].priority == DEFAULT_PRIORITY) {
339 /* Implied items don't need to be mentioned. */
340 skipped++;
341 continue;
343 len += len ? 1 : strlen(str);
344 len += strlen(words[j].name);
345 len += levels[j] == 1 ? 0 : 1;
347 if (words[j].priority == HELP_PRIORITY)
348 continue; /* no abbreviating for help */
350 assert(levels[j] <= MAX_OUT_LEVEL);
351 if (++counts[levels[j]] > max) {
352 /* Determine which level has the most items. */
353 lev = levels[j];
354 max = counts[lev];
358 /* Sanity check the COUNT_* define against the length of the table. */
359 if (j != word_count) {
360 rprintf(FERROR, "rsync: internal error: %s is wrong! (%d != %d)\n",
361 words == info_words ? "COUNT_INFO" : "COUNT_DEBUG",
362 j, word_count);
363 exit_cleanup(RERR_UNSUPPORTED);
366 if (!len)
367 return NULL;
369 len++;
370 if (!(buf = new_array(char, len)))
371 out_of_memory("make_output_option");
372 pos = 0;
374 if (skipped || max < 5)
375 lev = -1;
376 else {
377 if (lev == 0)
378 pos += snprintf(buf, len, "%sNONE", str);
379 else if (lev == 1)
380 pos += snprintf(buf, len, "%sALL", str);
381 else
382 pos += snprintf(buf, len, "%sALL%d", str, lev);
385 for (j = 0; words[j].name && pos < len; j++) {
386 if (words[j].priority == DEFAULT_PRIORITY || levels[j] == lev || !(words[j].where & where))
387 continue;
388 if (pos)
389 buf[pos++] = ',';
390 else
391 pos += strlcpy(buf+pos, str, len-pos);
392 if (pos < len)
393 pos += strlcpy(buf+pos, words[j].name, len-pos);
394 /* Level 1 is implied by the name alone. */
395 if (levels[j] != 1 && pos < len)
396 buf[pos++] = '0' + levels[j];
399 buf[pos] = '\0';
401 return buf;
404 static void parse_output_words(struct output_struct *words, short *levels,
405 const char *str, uchar priority)
407 const char *s;
408 int j, len, lev;
410 if (!str)
411 return;
413 while (*str) {
414 if ((s = strchr(str, ',')) != NULL)
415 len = s++ - str;
416 else
417 len = strlen(str);
418 while (len && isDigit(str+len-1))
419 len--;
420 lev = isDigit(str+len) ? atoi(str+len) : 1;
421 if (lev > MAX_OUT_LEVEL)
422 lev = MAX_OUT_LEVEL;
423 if (len == 4 && strncasecmp(str, "help", 4) == 0) {
424 output_item_help(words);
425 exit_cleanup(0);
427 if (len == 4 && strncasecmp(str, "none", 4) == 0)
428 len = lev = 0;
429 else if (len == 3 && strncasecmp(str, "all", 3) == 0)
430 len = 0;
431 for (j = 0; words[j].name; j++) {
432 if (!len
433 || (len == words[j].namelen && strncasecmp(str, words[j].name, len) == 0)) {
434 if (priority >= words[j].priority) {
435 words[j].priority = priority;
436 levels[j] = lev;
438 if (len)
439 break;
442 if (len && !words[j].name) {
443 rprintf(FERROR, "Unknown %s item: \"%.*s\"\n",
444 words[j].help, len, str);
445 exit_cleanup(RERR_SYNTAX);
447 if (!s)
448 break;
449 str = s;
453 /* Tell the user what all the info or debug flags mean. */
454 static void output_item_help(struct output_struct *words)
456 short *levels = words == info_words ? info_levels : debug_levels;
457 const char **verbosity = words == info_words ? info_verbosity : debug_verbosity;
458 char buf[128], *opt, *fmt = "%-10s %s\n";
459 int j;
461 reset_output_levels();
463 rprintf(FINFO, "Use OPT or OPT1 for level 1 output, OPT2 for level 2, etc.; OPT0 silences.\n");
464 rprintf(FINFO, "\n");
465 for (j = 0; words[j].name; j++)
466 rprintf(FINFO, fmt, words[j].name, words[j].help);
467 rprintf(FINFO, "\n");
469 snprintf(buf, sizeof buf, "Set all %s options (e.g. all%d)",
470 words[j].help, MAX_OUT_LEVEL);
471 rprintf(FINFO, fmt, "ALL", buf);
473 snprintf(buf, sizeof buf, "Silence all %s options (same as all0)",
474 words[j].help);
475 rprintf(FINFO, fmt, "NONE", buf);
477 rprintf(FINFO, fmt, "HELP", "Output this help message");
478 rprintf(FINFO, "\n");
479 rprintf(FINFO, "Options added for each increase in verbose level:\n");
481 for (j = 1; j <= MAX_VERBOSITY; j++) {
482 parse_output_words(words, levels, verbosity[j], HELP_PRIORITY);
483 opt = make_output_option(words, levels, W_CLI|W_SRV|W_SND|W_REC);
484 if (opt) {
485 rprintf(FINFO, "%d) %s\n", j, strchr(opt, '=')+1);
486 free(opt);
488 reset_output_levels();
492 /* The --verbose option now sets info+debug flags. */
493 static void set_output_verbosity(int level, uchar priority)
495 int j;
497 if (level > MAX_VERBOSITY)
498 level = MAX_VERBOSITY;
500 for (j = 1; j <= level; j++) {
501 parse_output_words(info_words, info_levels, info_verbosity[j], priority);
502 parse_output_words(debug_words, debug_levels, debug_verbosity[j], priority);
506 /* Limit the info+debug flag levels given a verbose-option level limit. */
507 void limit_output_verbosity(int level)
509 short info_limits[COUNT_INFO], debug_limits[COUNT_DEBUG];
510 int j;
512 if (level > MAX_VERBOSITY)
513 return;
515 memset(info_limits, 0, sizeof info_limits);
516 memset(debug_limits, 0, sizeof debug_limits);
518 /* Compute the level limits in the above arrays. */
519 for (j = 1; j <= level; j++) {
520 parse_output_words(info_words, info_limits, info_verbosity[j], LIMIT_PRIORITY);
521 parse_output_words(debug_words, debug_limits, debug_verbosity[j], LIMIT_PRIORITY);
524 for (j = 0; j < COUNT_INFO; j++) {
525 if (info_levels[j] > info_limits[j])
526 info_levels[j] = info_limits[j];
529 for (j = 0; j < COUNT_DEBUG; j++) {
530 if (debug_levels[j] > debug_limits[j])
531 debug_levels[j] = debug_limits[j];
535 void reset_output_levels(void)
537 int j;
539 memset(info_levels, 0, sizeof info_levels);
540 memset(debug_levels, 0, sizeof debug_levels);
542 for (j = 0; j < COUNT_INFO; j++)
543 info_words[j].priority = DEFAULT_PRIORITY;
545 for (j = 0; j < COUNT_DEBUG; j++)
546 debug_words[j].priority = DEFAULT_PRIORITY;
549 void negate_output_levels(void)
551 int j;
553 for (j = 0; j < COUNT_INFO; j++)
554 info_levels[j] *= -1;
556 for (j = 0; j < COUNT_DEBUG; j++)
557 debug_levels[j] *= -1;
560 static void print_rsync_version(enum logcode f)
562 char *subprotocol = "";
563 char const *got_socketpair = "no ";
564 char const *have_inplace = "no ";
565 char const *hardlinks = "no ";
566 char const *prealloc = "no ";
567 char const *symtimes = "no ";
568 char const *acls = "no ";
569 char const *xattrs = "no ";
570 char const *links = "no ";
571 char const *iconv = "no ";
572 char const *ipv6 = "no ";
573 STRUCT_STAT *dumstat;
575 #if SUBPROTOCOL_VERSION != 0
576 if (asprintf(&subprotocol, ".PR%d", SUBPROTOCOL_VERSION) < 0)
577 out_of_memory("print_rsync_version");
578 #endif
579 #ifdef HAVE_SOCKETPAIR
580 got_socketpair = "";
581 #endif
582 #ifdef HAVE_FTRUNCATE
583 have_inplace = "";
584 #endif
585 #ifdef SUPPORT_HARD_LINKS
586 hardlinks = "";
587 #endif
588 #ifdef SUPPORT_PREALLOCATION
589 prealloc = "";
590 #endif
591 #ifdef SUPPORT_ACLS
592 acls = "";
593 #endif
594 #ifdef SUPPORT_XATTRS
595 xattrs = "";
596 #endif
597 #ifdef SUPPORT_LINKS
598 links = "";
599 #endif
600 #ifdef INET6
601 ipv6 = "";
602 #endif
603 #ifdef ICONV_OPTION
604 iconv = "";
605 #endif
606 #ifdef CAN_SET_SYMLINK_TIMES
607 symtimes = "";
608 #endif
610 rprintf(f, "%s version %s protocol version %d%s\n",
611 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION, subprotocol);
612 rprintf(f, "Copyright (C) 1996-2011 by Andrew Tridgell, Wayne Davison, and others.\n");
613 rprintf(f, "Web site: http://rsync.samba.org/\n");
614 rprintf(f, "Capabilities:\n");
615 rprintf(f, " %d-bit files, %d-bit inums, %d-bit timestamps, %d-bit long ints,\n",
616 (int)(sizeof (OFF_T) * 8),
617 (int)(sizeof dumstat->st_ino * 8), /* Don't check ino_t! */
618 (int)(sizeof (time_t) * 8),
619 (int)(sizeof (int64) * 8));
620 rprintf(f, " %ssocketpairs, %shardlinks, %ssymlinks, %sIPv6, batchfiles, %sinplace,\n",
621 got_socketpair, hardlinks, links, ipv6, have_inplace);
622 rprintf(f, " %sappend, %sACLs, %sxattrs, %siconv, %ssymtimes, %sprealloc\n",
623 have_inplace, acls, xattrs, iconv, symtimes, prealloc);
625 #ifdef MAINTAINER_MODE
626 rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
627 #endif
629 #if SIZEOF_INT64 < 8
630 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
631 #endif
632 if (sizeof (int64) != SIZEOF_INT64) {
633 rprintf(f,
634 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
635 (int) SIZEOF_INT64, (int) sizeof (int64));
638 rprintf(f,"\n");
639 rprintf(f,"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n");
640 rprintf(f,"are welcome to redistribute it under certain conditions. See the GNU\n");
641 rprintf(f,"General Public Licence for details.\n");
645 void usage(enum logcode F)
647 print_rsync_version(F);
649 rprintf(F,"\n");
650 rprintf(F,"rsync is a file transfer program capable of efficient remote update\n");
651 rprintf(F,"via a fast differencing algorithm.\n");
653 rprintf(F,"\n");
654 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... DEST\n");
655 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
656 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
657 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
658 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC [DEST]\n");
659 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
660 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
661 rprintf(F,"The ':' usages connect via remote shell, while '::' & 'rsync://' usages connect\n");
662 rprintf(F,"to an rsync daemon, and require SRC or DEST to start with a module name.\n");
663 rprintf(F,"\n");
664 rprintf(F,"Options\n");
665 rprintf(F," -v, --verbose increase verbosity\n");
666 rprintf(F," --info=FLAGS fine-grained informational verbosity\n");
667 rprintf(F," --debug=FLAGS fine-grained debug verbosity\n");
668 rprintf(F," -q, --quiet suppress non-error messages\n");
669 rprintf(F," --no-motd suppress daemon-mode MOTD (see manpage caveat)\n");
670 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
671 rprintf(F," -a, --archive archive mode; equals -rlptgoD (no -H,-A,-X)\n");
672 rprintf(F," --no-OPTION turn off an implied OPTION (e.g. --no-D)\n");
673 rprintf(F," -r, --recursive recurse into directories\n");
674 rprintf(F," -R, --relative use relative path names\n");
675 rprintf(F," --no-implied-dirs don't send implied dirs with --relative\n");
676 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
677 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
678 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
679 rprintf(F," -u, --update skip files that are newer on the receiver\n");
680 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
681 rprintf(F," --append append data onto shorter files\n");
682 rprintf(F," --append-verify like --append, but with old data in file checksum\n");
683 rprintf(F," -d, --dirs transfer directories without recursing\n");
684 rprintf(F," -l, --links copy symlinks as symlinks\n");
685 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
686 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
687 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
688 rprintf(F," --munge-links munge symlinks to make them safer (but unusable)\n");
689 rprintf(F," -k, --copy-dirlinks transform symlink to a dir into referent dir\n");
690 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
691 rprintf(F," -H, --hard-links preserve hard links\n");
692 rprintf(F," -p, --perms preserve permissions\n");
693 rprintf(F," -E, --executability preserve the file's executability\n");
694 rprintf(F," --chmod=CHMOD affect file and/or directory permissions\n");
695 #ifdef SUPPORT_ACLS
696 rprintf(F," -A, --acls preserve ACLs (implies --perms)\n");
697 #endif
698 #ifdef SUPPORT_XATTRS
699 rprintf(F," -X, --xattrs preserve extended attributes\n");
700 #endif
701 rprintf(F," -o, --owner preserve owner (super-user only)\n");
702 rprintf(F," -g, --group preserve group\n");
703 rprintf(F," --devices preserve device files (super-user only)\n");
704 rprintf(F," --specials preserve special files\n");
705 rprintf(F," -D same as --devices --specials\n");
706 rprintf(F," -t, --times preserve modification times\n");
707 rprintf(F," -O, --omit-dir-times omit directories from --times\n");
708 rprintf(F," -J, --omit-link-times omit symlinks from --times\n");
709 rprintf(F," --super receiver attempts super-user activities\n");
710 #ifdef SUPPORT_XATTRS
711 rprintf(F," --fake-super store/recover privileged attrs using xattrs\n");
712 #endif
713 rprintf(F," -S, --sparse handle sparse files efficiently\n");
714 #ifdef SUPPORT_PREALLOCATION
715 rprintf(F," --preallocate allocate dest files before writing them\n");
716 #else
717 rprintf(F," --preallocate pre-allocate dest files on remote receiver\n");
718 #endif
719 rprintf(F," -n, --dry-run perform a trial run with no changes made\n");
720 rprintf(F," -W, --whole-file copy files whole (without delta-xfer algorithm)\n");
721 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
722 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
723 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
724 rprintf(F," --rsync-path=PROGRAM specify the rsync to run on the remote machine\n");
725 rprintf(F," --existing skip creating new files on receiver\n");
726 rprintf(F," --ignore-existing skip updating files that already exist on receiver\n");
727 rprintf(F," --remove-source-files sender removes synchronized files (non-dirs)\n");
728 rprintf(F," --del an alias for --delete-during\n");
729 rprintf(F," --delete delete extraneous files from destination dirs\n");
730 rprintf(F," --delete-before receiver deletes before transfer, not during\n");
731 rprintf(F," --delete-during receiver deletes during transfer (default)\n");
732 rprintf(F," --delete-delay find deletions during, delete after\n");
733 rprintf(F," --delete-after receiver deletes after transfer, not during\n");
734 rprintf(F," --delete-excluded also delete excluded files from destination dirs\n");
735 rprintf(F," --ignore-missing-args ignore missing source args without error\n");
736 rprintf(F," --delete-missing-args delete missing source args from destination\n");
737 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
738 rprintf(F," --force force deletion of directories even if not empty\n");
739 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
740 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
741 rprintf(F," --min-size=SIZE don't transfer any file smaller than SIZE\n");
742 rprintf(F," --partial keep partially transferred files\n");
743 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
744 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
745 rprintf(F," -m, --prune-empty-dirs prune empty directory chains from the file-list\n");
746 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
747 rprintf(F," --usermap=STRING custom username mapping\n");
748 rprintf(F," --groupmap=STRING custom groupname mapping\n");
749 rprintf(F," --chown=USER:GROUP simple username/groupname mapping\n");
750 rprintf(F," --timeout=SECONDS set I/O timeout in seconds\n");
751 rprintf(F," --contimeout=SECONDS set daemon connection timeout in seconds\n");
752 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
753 rprintf(F," -M, --remote-option=OPTION send OPTION to the remote side only\n");
754 rprintf(F," --size-only skip files that match in size\n");
755 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
756 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
757 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
758 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
759 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
760 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
761 rprintf(F," -z, --compress compress file data during the transfer\n");
762 rprintf(F," --compress-level=NUM explicitly set compression level\n");
763 rprintf(F," --skip-compress=LIST skip compressing files with a suffix in LIST\n");
764 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
765 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
766 rprintf(F," -F same as --filter='dir-merge /.rsync-filter'\n");
767 rprintf(F," repeated: --filter='- .rsync-filter'\n");
768 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
769 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
770 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
771 rprintf(F," --include-from=FILE read include patterns from FILE\n");
772 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
773 rprintf(F," -0, --from0 all *-from/filter files are delimited by 0s\n");
774 rprintf(F," -s, --protect-args no space-splitting; only wildcard special-chars\n");
775 rprintf(F," --address=ADDRESS bind address for outgoing socket to daemon\n");
776 rprintf(F," --port=PORT specify double-colon alternate port number\n");
777 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
778 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
779 rprintf(F," --stats give some file-transfer stats\n");
780 rprintf(F," -8, --8-bit-output leave high-bit chars unescaped in output\n");
781 rprintf(F," -h, --human-readable output numbers in a human-readable format\n");
782 rprintf(F," --progress show progress during transfer\n");
783 rprintf(F," -P same as --partial --progress\n");
784 rprintf(F," -i, --itemize-changes output a change-summary for all updates\n");
785 rprintf(F," --out-format=FORMAT output updates using the specified FORMAT\n");
786 rprintf(F," --log-file=FILE log what we're doing to the specified FILE\n");
787 rprintf(F," --log-file-format=FMT log updates using the specified FMT\n");
788 rprintf(F," --password-file=FILE read daemon-access password from FILE\n");
789 rprintf(F," --list-only list the files instead of copying them\n");
790 rprintf(F," --bwlimit=RATE limit socket I/O bandwidth\n");
791 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
792 rprintf(F," --only-write-batch=FILE like --write-batch but w/o updating destination\n");
793 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
794 rprintf(F," --protocol=NUM force an older protocol version to be used\n");
795 #ifdef ICONV_OPTION
796 rprintf(F," --iconv=CONVERT_SPEC request charset conversion of filenames\n");
797 #endif
798 rprintf(F," -4, --ipv4 prefer IPv4\n");
799 rprintf(F," -6, --ipv6 prefer IPv6\n");
800 rprintf(F," --version print version number\n");
801 rprintf(F,"(-h) --help show this help (-h works with no other options)\n");
803 rprintf(F,"\n");
804 rprintf(F,"Use \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
805 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
806 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
809 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
810 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST, OPT_HELP,
811 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW, OPT_MIN_SIZE, OPT_CHMOD,
812 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_ONLY_WRITE_BATCH, OPT_MAX_SIZE,
813 OPT_NO_D, OPT_APPEND, OPT_NO_ICONV, OPT_INFO, OPT_DEBUG,
814 OPT_USERMAP, OPT_GROUPMAP, OPT_CHOWN, OPT_BWLIMIT,
815 OPT_SERVER, OPT_REFUSED_BASE = 9000};
817 static struct poptOption long_options[] = {
818 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
819 {"help", 0, POPT_ARG_NONE, 0, OPT_HELP, 0, 0 },
820 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
821 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
822 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
823 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
824 {"info", 0, POPT_ARG_STRING, 0, OPT_INFO, 0, 0 },
825 {"debug", 0, POPT_ARG_STRING, 0, OPT_DEBUG, 0, 0 },
826 {"msgs2stderr", 0, POPT_ARG_NONE, &msgs2stderr, 0, 0, 0 },
827 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
828 {"motd", 0, POPT_ARG_VAL, &output_motd, 1, 0, 0 },
829 {"no-motd", 0, POPT_ARG_VAL, &output_motd, 0, 0, 0 },
830 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
831 {"human-readable", 'h', POPT_ARG_NONE, 0, 'h', 0, 0},
832 {"no-human-readable",0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
833 {"no-h", 0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
834 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
835 {"archive", 'a', POPT_ARG_NONE, 0, 'a', 0, 0 },
836 {"recursive", 'r', POPT_ARG_VAL, &recurse, 2, 0, 0 },
837 {"no-recursive", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
838 {"no-r", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
839 {"inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
840 {"no-inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
841 {"i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
842 {"no-i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
843 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
844 {"no-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
845 {"no-d", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
846 {"old-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
847 {"old-d", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
848 {"perms", 'p', POPT_ARG_VAL, &preserve_perms, 1, 0, 0 },
849 {"no-perms", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
850 {"no-p", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
851 {"executability", 'E', POPT_ARG_NONE, &preserve_executability, 0, 0, 0 },
852 {"acls", 'A', POPT_ARG_NONE, 0, 'A', 0, 0 },
853 {"no-acls", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
854 {"no-A", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
855 {"xattrs", 'X', POPT_ARG_NONE, 0, 'X', 0, 0 },
856 {"no-xattrs", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
857 {"no-X", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
858 {"times", 't', POPT_ARG_VAL, &preserve_times, 1, 0, 0 },
859 {"no-times", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
860 {"no-t", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
861 {"omit-dir-times", 'O', POPT_ARG_VAL, &omit_dir_times, 1, 0, 0 },
862 {"no-omit-dir-times",0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
863 {"no-O", 0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
864 {"omit-link-times", 'J', POPT_ARG_VAL, &omit_link_times, 1, 0, 0 },
865 {"no-omit-link-times",0, POPT_ARG_VAL, &omit_link_times, 0, 0, 0 },
866 {"no-J", 0, POPT_ARG_VAL, &omit_link_times, 0, 0, 0 },
867 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
868 {"super", 0, POPT_ARG_VAL, &am_root, 2, 0, 0 },
869 {"no-super", 0, POPT_ARG_VAL, &am_root, 0, 0, 0 },
870 {"fake-super", 0, POPT_ARG_VAL, &am_root, -1, 0, 0 },
871 {"owner", 'o', POPT_ARG_VAL, &preserve_uid, 1, 0, 0 },
872 {"no-owner", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
873 {"no-o", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
874 {"group", 'g', POPT_ARG_VAL, &preserve_gid, 1, 0, 0 },
875 {"no-group", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
876 {"no-g", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
877 {0, 'D', POPT_ARG_NONE, 0, 'D', 0, 0 },
878 {"no-D", 0, POPT_ARG_NONE, 0, OPT_NO_D, 0, 0 },
879 {"devices", 0, POPT_ARG_VAL, &preserve_devices, 1, 0, 0 },
880 {"no-devices", 0, POPT_ARG_VAL, &preserve_devices, 0, 0, 0 },
881 {"specials", 0, POPT_ARG_VAL, &preserve_specials, 1, 0, 0 },
882 {"no-specials", 0, POPT_ARG_VAL, &preserve_specials, 0, 0, 0 },
883 {"links", 'l', POPT_ARG_VAL, &preserve_links, 1, 0, 0 },
884 {"no-links", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
885 {"no-l", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
886 {"copy-links", 'L', POPT_ARG_NONE, &copy_links, 0, 0, 0 },
887 {"copy-unsafe-links",0, POPT_ARG_NONE, &copy_unsafe_links, 0, 0, 0 },
888 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
889 {"munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 1, 0, 0 },
890 {"no-munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 0, 0, 0 },
891 {"copy-dirlinks", 'k', POPT_ARG_NONE, &copy_dirlinks, 0, 0, 0 },
892 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
893 {"hard-links", 'H', POPT_ARG_NONE, 0, 'H', 0, 0 },
894 {"no-hard-links", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
895 {"no-H", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
896 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
897 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
898 {"no-R", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
899 {"implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
900 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
901 {"i-d", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
902 {"no-i-d", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
903 {"chmod", 0, POPT_ARG_STRING, 0, OPT_CHMOD, 0, 0 },
904 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
905 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
906 {"one-file-system", 'x', POPT_ARG_NONE, 0, 'x', 0, 0 },
907 {"no-one-file-system",0, POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
908 {"no-x", 0, POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
909 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
910 {"existing", 0, POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
911 {"ignore-non-existing",0,POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
912 {"ignore-existing", 0, POPT_ARG_NONE, &ignore_existing, 0, 0, 0 },
913 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
914 {"min-size", 0, POPT_ARG_STRING, &min_size_arg, OPT_MIN_SIZE, 0, 0 },
915 {"sparse", 'S', POPT_ARG_VAL, &sparse_files, 1, 0, 0 },
916 {"no-sparse", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
917 {"no-S", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
918 {"preallocate", 0, POPT_ARG_NONE, &preallocate_files, 0, 0, 0},
919 {"inplace", 0, POPT_ARG_VAL, &inplace, 1, 0, 0 },
920 {"no-inplace", 0, POPT_ARG_VAL, &inplace, 0, 0, 0 },
921 {"append", 0, POPT_ARG_NONE, 0, OPT_APPEND, 0, 0 },
922 {"append-verify", 0, POPT_ARG_VAL, &append_mode, 2, 0, 0 },
923 {"no-append", 0, POPT_ARG_VAL, &append_mode, 0, 0, 0 },
924 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
925 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
926 {"delete-before", 0, POPT_ARG_NONE, &delete_before, 0, 0, 0 },
927 {"delete-during", 0, POPT_ARG_VAL, &delete_during, 1, 0, 0 },
928 {"delete-delay", 0, POPT_ARG_VAL, &delete_during, 2, 0, 0 },
929 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
930 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
931 {"delete-missing-args",0,POPT_BIT_SET, &missing_args, 2, 0, 0 },
932 {"ignore-missing-args",0,POPT_BIT_SET, &missing_args, 1, 0, 0 },
933 {"remove-sent-files",0, POPT_ARG_VAL, &remove_source_files, 2, 0, 0 }, /* deprecated */
934 {"remove-source-files",0,POPT_ARG_VAL, &remove_source_files, 1, 0, 0 },
935 {"force", 0, POPT_ARG_VAL, &force_delete, 1, 0, 0 },
936 {"no-force", 0, POPT_ARG_VAL, &force_delete, 0, 0, 0 },
937 {"ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 1, 0, 0 },
938 {"no-ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 0, 0, 0 },
939 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
940 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
941 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
942 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
943 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
944 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
945 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
946 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
947 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
948 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
949 {"no-W", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
950 {"checksum", 'c', POPT_ARG_VAL, &always_checksum, 1, 0, 0 },
951 {"no-checksum", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
952 {"no-c", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
953 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
954 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
955 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
956 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
957 {"fuzzy", 'y', POPT_ARG_VAL, &fuzzy_basis, 1, 0, 0 },
958 {"no-fuzzy", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
959 {"no-y", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
960 {"compress", 'z', POPT_ARG_NONE, 0, 'z', 0, 0 },
961 {"no-compress", 0, POPT_ARG_VAL, &do_compression, 0, 0, 0 },
962 {"no-z", 0, POPT_ARG_VAL, &do_compression, 0, 0, 0 },
963 {"skip-compress", 0, POPT_ARG_STRING, &skip_compress, 0, 0, 0 },
964 {"compress-level", 0, POPT_ARG_INT, &def_compress_level, 'z', 0, 0 },
965 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
966 {"progress", 0, POPT_ARG_VAL, &do_progress, 1, 0, 0 },
967 {"no-progress", 0, POPT_ARG_VAL, &do_progress, 0, 0, 0 },
968 {"partial", 0, POPT_ARG_VAL, &keep_partial, 1, 0, 0 },
969 {"no-partial", 0, POPT_ARG_VAL, &keep_partial, 0, 0, 0 },
970 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
971 {"delay-updates", 0, POPT_ARG_VAL, &delay_updates, 1, 0, 0 },
972 {"no-delay-updates", 0, POPT_ARG_VAL, &delay_updates, 0, 0, 0 },
973 {"prune-empty-dirs",'m', POPT_ARG_VAL, &prune_empty_dirs, 1, 0, 0 },
974 {"no-prune-empty-dirs",0,POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
975 {"no-m", 0, POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
976 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
977 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
978 {"out-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 },
979 {"log-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 }, /* DEPRECATED */
980 {"itemize-changes", 'i', POPT_ARG_NONE, 0, 'i', 0, 0 },
981 {"no-itemize-changes",0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
982 {"no-i", 0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
983 {"bwlimit", 0, POPT_ARG_STRING, &bwlimit_arg, OPT_BWLIMIT, 0, 0 },
984 {"no-bwlimit", 0, POPT_ARG_VAL, &bwlimit, 0, 0, 0 },
985 {"backup", 'b', POPT_ARG_VAL, &make_backups, 1, 0, 0 },
986 {"no-backup", 0, POPT_ARG_VAL, &make_backups, 0, 0, 0 },
987 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
988 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
989 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
990 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
991 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
992 {"only-write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_ONLY_WRITE_BATCH, 0, 0 },
993 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
994 {"from0", '0', POPT_ARG_VAL, &eol_nulls, 1, 0, 0},
995 {"no-from0", 0, POPT_ARG_VAL, &eol_nulls, 0, 0, 0},
996 {"protect-args", 's', POPT_ARG_VAL, &protect_args, 1, 0, 0},
997 {"no-protect-args", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
998 {"no-s", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
999 {"numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 1, 0, 0 },
1000 {"no-numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 0, 0, 0 },
1001 {"usermap", 0, POPT_ARG_STRING, 0, OPT_USERMAP, 0, 0 },
1002 {"groupmap", 0, POPT_ARG_STRING, 0, OPT_GROUPMAP, 0, 0 },
1003 {"chown", 0, POPT_ARG_STRING, 0, OPT_CHOWN, 0, 0 },
1004 {"timeout", 0, POPT_ARG_INT, &io_timeout, 0, 0, 0 },
1005 {"no-timeout", 0, POPT_ARG_VAL, &io_timeout, 0, 0, 0 },
1006 {"contimeout", 0, POPT_ARG_INT, &connect_timeout, 0, 0, 0 },
1007 {"no-contimeout", 0, POPT_ARG_VAL, &connect_timeout, 0, 0, 0 },
1008 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
1009 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
1010 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
1011 #ifdef ICONV_OPTION
1012 {"iconv", 0, POPT_ARG_STRING, &iconv_opt, 0, 0, 0 },
1013 {"no-iconv", 0, POPT_ARG_NONE, 0, OPT_NO_ICONV, 0, 0 },
1014 #endif
1015 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
1016 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
1017 {"8-bit-output", '8', POPT_ARG_VAL, &allow_8bit_chars, 1, 0, 0 },
1018 {"no-8-bit-output", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
1019 {"no-8", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
1020 {"qsort", 0, POPT_ARG_NONE, &use_qsort, 0, 0, 0 },
1021 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
1022 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
1023 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
1024 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
1025 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
1026 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
1027 {"remote-option", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
1028 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
1029 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
1030 {"server", 0, POPT_ARG_NONE, 0, OPT_SERVER, 0, 0 },
1031 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
1032 /* All the following options switch us into daemon-mode option-parsing. */
1033 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
1034 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1035 {"dparam", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
1036 {"detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1037 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1038 {0,0,0,0, 0, 0, 0}
1041 static void daemon_usage(enum logcode F)
1043 print_rsync_version(F);
1045 rprintf(F,"\n");
1046 rprintf(F,"Usage: rsync --daemon [OPTION]...\n");
1047 rprintf(F," --address=ADDRESS bind to the specified address\n");
1048 rprintf(F," --bwlimit=RATE limit socket I/O bandwidth\n");
1049 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
1050 rprintf(F," -M, --dparam=OVERRIDE override global daemon config parameter\n");
1051 rprintf(F," --no-detach do not detach from the parent\n");
1052 rprintf(F," --port=PORT listen on alternate port number\n");
1053 rprintf(F," --log-file=FILE override the \"log file\" setting\n");
1054 rprintf(F," --log-file-format=FMT override the \"log format\" setting\n");
1055 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
1056 rprintf(F," -v, --verbose increase verbosity\n");
1057 rprintf(F," -4, --ipv4 prefer IPv4\n");
1058 rprintf(F," -6, --ipv6 prefer IPv6\n");
1059 rprintf(F," --help show this help screen\n");
1061 rprintf(F,"\n");
1062 rprintf(F,"If you were not trying to invoke rsync as a daemon, avoid using any of the\n");
1063 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
1066 static struct poptOption long_daemon_options[] = {
1067 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1068 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
1069 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
1070 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
1071 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
1072 {"dparam", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
1073 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
1074 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
1075 {"detach", 0, POPT_ARG_VAL, &no_detach, 0, 0, 0 },
1076 {"no-detach", 0, POPT_ARG_VAL, &no_detach, 1, 0, 0 },
1077 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
1078 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
1079 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
1080 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
1081 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
1082 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
1083 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
1084 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
1085 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1086 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1087 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
1088 {0,0,0,0, 0, 0, 0}
1092 static char err_buf[200];
1096 * Store the option error message, if any, so that we can log the
1097 * connection attempt (which requires parsing the options), and then
1098 * show the error later on.
1100 void option_error(void)
1102 if (!err_buf[0]) {
1103 strlcpy(err_buf, "Error parsing options: option may "
1104 "be supported on client but not on server?\n",
1105 sizeof err_buf);
1108 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
1109 msleep(20);
1114 * Tweak the option table to disable all options that the rsyncd.conf
1115 * file has told us to refuse.
1117 static void set_refuse_options(char *bp)
1119 struct poptOption *op;
1120 char *cp, shortname[2];
1121 int is_wild, found_match;
1123 shortname[1] = '\0';
1125 while (1) {
1126 while (*bp == ' ') bp++;
1127 if (!*bp)
1128 break;
1129 if ((cp = strchr(bp, ' ')) != NULL)
1130 *cp= '\0';
1131 is_wild = strpbrk(bp, "*?[") != NULL;
1132 found_match = 0;
1133 for (op = long_options; ; op++) {
1134 *shortname = op->shortName;
1135 if (!op->longName && !*shortname)
1136 break;
1137 if ((op->longName && wildmatch(bp, op->longName))
1138 || (*shortname && wildmatch(bp, shortname))) {
1139 if (op->argInfo == POPT_ARG_VAL)
1140 op->argInfo = POPT_ARG_NONE;
1141 op->val = (op - long_options) + OPT_REFUSED_BASE;
1142 found_match = 1;
1143 /* These flags are set to let us easily check
1144 * an implied option later in the code. */
1145 switch (*shortname) {
1146 case 'r': case 'd': case 'l': case 'p':
1147 case 't': case 'g': case 'o': case 'D':
1148 refused_archive_part = op->val;
1149 break;
1150 case 'z':
1151 refused_compress = op->val;
1152 break;
1153 case '\0':
1154 if (wildmatch("delete", op->longName))
1155 refused_delete = op->val;
1156 else if (wildmatch("delete-before", op->longName))
1157 refused_delete_before = op->val;
1158 else if (wildmatch("delete-during", op->longName))
1159 refused_delete_during = op->val;
1160 else if (wildmatch("partial", op->longName))
1161 refused_partial = op->val;
1162 else if (wildmatch("progress", op->longName))
1163 refused_progress = op->val;
1164 else if (wildmatch("inplace", op->longName))
1165 refused_inplace = op->val;
1166 else if (wildmatch("no-iconv", op->longName))
1167 refused_no_iconv = op->val;
1168 break;
1170 if (!is_wild)
1171 break;
1174 if (!found_match) {
1175 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
1176 bp);
1178 if (!cp)
1179 break;
1180 *cp = ' ';
1181 bp = cp + 1;
1186 static int count_args(const char **argv)
1188 int i = 0;
1190 if (argv) {
1191 while (argv[i] != NULL)
1192 i++;
1195 return i;
1199 static OFF_T parse_size_arg(char **size_arg, char def_suf)
1201 int reps, mult, make_compatible = 0;
1202 const char *arg;
1203 OFF_T size = 1;
1205 for (arg = *size_arg; isDigit(arg); arg++) {}
1206 if (*arg == '.')
1207 for (arg++; isDigit(arg); arg++) {}
1208 switch (*arg && *arg != '+' && *arg != '-' ? *arg++ : def_suf) {
1209 case 'b': case 'B':
1210 reps = 0;
1211 break;
1212 case 'k': case 'K':
1213 reps = 1;
1214 break;
1215 case 'm': case 'M':
1216 reps = 2;
1217 break;
1218 case 'g': case 'G':
1219 reps = 3;
1220 break;
1221 default:
1222 return -1;
1224 if (*arg == 'b' || *arg == 'B')
1225 mult = 1000, make_compatible = 1, arg++;
1226 else if (!*arg || *arg == '+' || *arg == '-')
1227 mult = 1024;
1228 else if (strncasecmp(arg, "ib", 2) == 0)
1229 mult = 1024, arg += 2;
1230 else
1231 return -1;
1232 while (reps--)
1233 size *= mult;
1234 size *= atof(*size_arg);
1235 if ((*arg == '+' || *arg == '-') && arg[1] == '1')
1236 size += atoi(arg), make_compatible = 1, arg += 2;
1237 if (*arg)
1238 return -1;
1239 if (size > 0 && make_compatible && def_suf == 'b') {
1240 /* We convert this manually because we may need %lld precision,
1241 * and that's not a portable sprintf() escape. */
1242 char buf[128], *s = buf + sizeof buf - 1;
1243 OFF_T num = size;
1244 *s = '\0';
1245 while (num) {
1246 *--s = (char)(num % 10) + '0';
1247 num /= 10;
1249 if (!(*size_arg = strdup(s)))
1250 out_of_memory("parse_size_arg");
1252 return size;
1256 static void create_refuse_error(int which)
1258 /* The "which" value is the index + OPT_REFUSED_BASE. */
1259 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
1260 int n = snprintf(err_buf, sizeof err_buf,
1261 "The server is configured to refuse --%s\n",
1262 op->longName) - 1;
1263 if (op->shortName) {
1264 snprintf(err_buf + n, sizeof err_buf - n,
1265 " (-%c)\n", op->shortName);
1271 * Process command line arguments. Called on both local and remote.
1273 * @retval 1 if all options are OK; with globals set to appropriate
1274 * values
1276 * @retval 0 on error, with err_buf containing an explanation
1278 int parse_arguments(int *argc_p, const char ***argv_p)
1280 static poptContext pc;
1281 char *ref = lp_refuse_options(module_id);
1282 const char *arg, **argv = *argv_p;
1283 int argc = *argc_p;
1284 int opt;
1286 if (ref && *ref)
1287 set_refuse_options(ref);
1288 if (am_daemon) {
1289 set_refuse_options("log-file*");
1290 #ifdef ICONV_OPTION
1291 if (!*lp_charset(module_id))
1292 set_refuse_options("iconv");
1293 #endif
1296 #ifdef ICONV_OPTION
1297 if (!am_daemon && protect_args <= 0 && (arg = getenv("RSYNC_ICONV")) != NULL && *arg)
1298 iconv_opt = strdup(arg);
1299 #endif
1301 /* TODO: Call poptReadDefaultConfig; handle errors. */
1303 /* The context leaks in case of an error, but if there's a
1304 * problem we always exit anyhow. */
1305 if (pc)
1306 poptFreeContext(pc);
1307 pc = poptGetContext(RSYNC_NAME, argc, argv, long_options, 0);
1308 if (!am_server)
1309 poptReadDefaultConfig(pc, 0);
1311 while ((opt = poptGetNextOpt(pc)) != -1) {
1312 /* most options are handled automatically by popt;
1313 * only special cases are returned and listed here. */
1315 switch (opt) {
1316 case OPT_VERSION:
1317 print_rsync_version(FINFO);
1318 exit_cleanup(0);
1320 case OPT_SERVER:
1321 if (!am_server) {
1322 /* Disable popt aliases on the server side and
1323 * then start parsing the options again. */
1324 poptFreeContext(pc);
1325 pc = poptGetContext(RSYNC_NAME, argc, argv,
1326 long_options, 0);
1327 am_server = 1;
1329 #ifdef ICONV_OPTION
1330 iconv_opt = NULL;
1331 #endif
1332 break;
1334 case OPT_SENDER:
1335 if (!am_server) {
1336 usage(FERROR);
1337 exit_cleanup(RERR_SYNTAX);
1339 am_sender = 1;
1340 break;
1342 case OPT_DAEMON:
1343 if (am_daemon) {
1344 strlcpy(err_buf,
1345 "Attempt to hack rsync thwarted!\n",
1346 sizeof err_buf);
1347 return 0;
1349 #ifdef ICONV_OPTION
1350 iconv_opt = NULL;
1351 #endif
1352 protect_args = 0;
1353 poptFreeContext(pc);
1354 pc = poptGetContext(RSYNC_NAME, argc, argv,
1355 long_daemon_options, 0);
1356 while ((opt = poptGetNextOpt(pc)) != -1) {
1357 char **cpp;
1358 switch (opt) {
1359 case 'h':
1360 daemon_usage(FINFO);
1361 exit_cleanup(0);
1363 case 'M':
1364 arg = poptGetOptArg(pc);
1365 if (!strchr(arg, '=')) {
1366 rprintf(FERROR,
1367 "--dparam value is missing an '=': %s\n",
1368 arg);
1369 goto daemon_error;
1371 cpp = EXPAND_ITEM_LIST(&dparam_list, char *, 4);
1372 *cpp = strdup(arg);
1373 break;
1375 case 'v':
1376 verbose++;
1377 break;
1379 default:
1380 rprintf(FERROR,
1381 "rsync: %s: %s (in daemon mode)\n",
1382 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1383 poptStrerror(opt));
1384 goto daemon_error;
1388 if (dparam_list.count && !set_dparams(1))
1389 exit_cleanup(RERR_SYNTAX);
1391 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
1392 snprintf(err_buf, sizeof err_buf,
1393 "the --temp-dir path is WAY too long.\n");
1394 return 0;
1397 if (!daemon_opt) {
1398 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
1399 daemon_error:
1400 rprintf(FERROR,
1401 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
1402 exit_cleanup(RERR_SYNTAX);
1405 *argv_p = argv = poptGetArgs(pc);
1406 *argc_p = argc = count_args(argv);
1407 am_starting_up = 0;
1408 daemon_opt = 0;
1409 am_daemon = 1;
1410 return 1;
1412 case OPT_MODIFY_WINDOW:
1413 /* The value has already been set by popt, but
1414 * we need to remember that we're using a
1415 * non-default setting. */
1416 modify_window_set = 1;
1417 break;
1419 case OPT_FILTER:
1420 parse_filter_str(&filter_list, poptGetOptArg(pc),
1421 rule_template(0), 0);
1422 break;
1424 case OPT_EXCLUDE:
1425 parse_filter_str(&filter_list, poptGetOptArg(pc),
1426 rule_template(0), XFLG_OLD_PREFIXES);
1427 break;
1429 case OPT_INCLUDE:
1430 parse_filter_str(&filter_list, poptGetOptArg(pc),
1431 rule_template(FILTRULE_INCLUDE), XFLG_OLD_PREFIXES);
1432 break;
1434 case OPT_EXCLUDE_FROM:
1435 case OPT_INCLUDE_FROM:
1436 arg = poptGetOptArg(pc);
1437 if (sanitize_paths)
1438 arg = sanitize_path(NULL, arg, NULL, 0, SP_DEFAULT);
1439 if (daemon_filter_list.head) {
1440 int rej;
1441 char *cp = strdup(arg);
1442 if (!cp)
1443 out_of_memory("parse_arguments");
1444 if (!*cp)
1445 rej = 1;
1446 else {
1447 char *dir = cp + (*cp == '/' ? module_dirlen : 0);
1448 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1449 rej = check_filter(&daemon_filter_list, FLOG, dir, 0) < 0;
1451 free(cp);
1452 if (rej)
1453 goto options_rejected;
1455 parse_filter_file(&filter_list, arg,
1456 rule_template(opt == OPT_INCLUDE_FROM ? FILTRULE_INCLUDE : 0),
1457 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
1458 break;
1460 case 'a':
1461 if (refused_archive_part) {
1462 create_refuse_error(refused_archive_part);
1463 return 0;
1465 if (!recurse) /* preserve recurse == 2 */
1466 recurse = 1;
1467 #ifdef SUPPORT_LINKS
1468 preserve_links = 1;
1469 #endif
1470 preserve_perms = 1;
1471 preserve_times = 1;
1472 preserve_gid = 1;
1473 preserve_uid = 1;
1474 preserve_devices = 1;
1475 preserve_specials = 1;
1476 break;
1478 case 'D':
1479 preserve_devices = preserve_specials = 1;
1480 break;
1482 case OPT_NO_D:
1483 preserve_devices = preserve_specials = 0;
1484 break;
1486 case 'h':
1487 human_readable++;
1488 break;
1490 case 'H':
1491 preserve_hard_links++;
1492 break;
1494 case 'i':
1495 itemize_changes++;
1496 break;
1498 case 'v':
1499 verbose++;
1500 break;
1502 case 'q':
1503 quiet++;
1504 break;
1506 case 'x':
1507 one_file_system++;
1508 break;
1510 case 'F':
1511 switch (++F_option_cnt) {
1512 case 1:
1513 parse_filter_str(&filter_list,": /.rsync-filter",rule_template(0),0);
1514 break;
1515 case 2:
1516 parse_filter_str(&filter_list,"- .rsync-filter",rule_template(0),0);
1517 break;
1519 break;
1521 case 'P':
1522 if (refused_partial || refused_progress) {
1523 create_refuse_error(refused_partial
1524 ? refused_partial : refused_progress);
1525 return 0;
1527 do_progress = 1;
1528 keep_partial = 1;
1529 break;
1531 case 'z':
1532 if (def_compress_level < Z_DEFAULT_COMPRESSION
1533 || def_compress_level > Z_BEST_COMPRESSION) {
1534 snprintf(err_buf, sizeof err_buf,
1535 "--compress-level value is invalid: %d\n",
1536 def_compress_level);
1537 return 0;
1539 do_compression = def_compress_level != Z_NO_COMPRESSION;
1540 if (do_compression && refused_compress) {
1541 create_refuse_error(refused_compress);
1542 return 0;
1544 break;
1546 case 'M':
1547 arg = poptGetOptArg(pc);
1548 if (*arg != '-') {
1549 snprintf(err_buf, sizeof err_buf,
1550 "Remote option must start with a dash: %s\n", arg);
1551 return 0;
1553 if (remote_option_cnt+2 >= remote_option_alloc) {
1554 remote_option_alloc += 16;
1555 remote_options = realloc_array(remote_options,
1556 const char *, remote_option_alloc);
1557 if (!remote_options)
1558 out_of_memory("parse_arguments");
1559 if (!remote_option_cnt)
1560 remote_options[0] = "ARG0";
1562 remote_options[++remote_option_cnt] = arg;
1563 remote_options[remote_option_cnt+1] = NULL;
1564 break;
1566 case OPT_WRITE_BATCH:
1567 /* batch_name is already set */
1568 write_batch = 1;
1569 break;
1571 case OPT_ONLY_WRITE_BATCH:
1572 /* batch_name is already set */
1573 write_batch = -1;
1574 break;
1576 case OPT_READ_BATCH:
1577 /* batch_name is already set */
1578 read_batch = 1;
1579 break;
1581 case OPT_NO_ICONV:
1582 #ifdef ICONV_OPTION
1583 iconv_opt = NULL;
1584 #endif
1585 break;
1587 case OPT_MAX_SIZE:
1588 if ((max_size = parse_size_arg(&max_size_arg, 'b')) <= 0) {
1589 snprintf(err_buf, sizeof err_buf,
1590 "--max-size value is invalid: %s\n",
1591 max_size_arg);
1592 return 0;
1594 break;
1596 case OPT_MIN_SIZE:
1597 if ((min_size = parse_size_arg(&min_size_arg, 'b')) <= 0) {
1598 snprintf(err_buf, sizeof err_buf,
1599 "--min-size value is invalid: %s\n",
1600 min_size_arg);
1601 return 0;
1603 break;
1605 case OPT_BWLIMIT:
1607 OFF_T limit = parse_size_arg(&bwlimit_arg, 'K');
1608 if (limit < 0) {
1609 snprintf(err_buf, sizeof err_buf,
1610 "--bwlimit value is invalid: %s\n", bwlimit_arg);
1611 return 0;
1613 bwlimit = (limit + 512) / 1024;
1614 if (limit && !bwlimit) {
1615 snprintf(err_buf, sizeof err_buf,
1616 "--bwlimit value is too small: %s\n", bwlimit_arg);
1617 return 0;
1620 break;
1622 case OPT_APPEND:
1623 if (am_server)
1624 append_mode++;
1625 else
1626 append_mode = 1;
1627 break;
1629 case OPT_LINK_DEST:
1630 #ifdef SUPPORT_HARD_LINKS
1631 link_dest = 1;
1632 dest_option = "--link-dest";
1633 goto set_dest_dir;
1634 #else
1635 snprintf(err_buf, sizeof err_buf,
1636 "hard links are not supported on this %s\n",
1637 am_server ? "server" : "client");
1638 return 0;
1639 #endif
1641 case OPT_COPY_DEST:
1642 copy_dest = 1;
1643 dest_option = "--copy-dest";
1644 goto set_dest_dir;
1646 case OPT_COMPARE_DEST:
1647 compare_dest = 1;
1648 dest_option = "--compare-dest";
1649 set_dest_dir:
1650 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
1651 snprintf(err_buf, sizeof err_buf,
1652 "ERROR: at most %d %s args may be specified\n",
1653 MAX_BASIS_DIRS, dest_option);
1654 return 0;
1656 /* We defer sanitizing this arg until we know what
1657 * our destination directory is going to be. */
1658 basis_dir[basis_dir_cnt++] = (char *)poptGetOptArg(pc);
1659 break;
1661 case OPT_CHMOD:
1662 arg = poptGetOptArg(pc);
1663 if (!parse_chmod(arg, &chmod_modes)) {
1664 snprintf(err_buf, sizeof err_buf,
1665 "Invalid argument passed to --chmod (%s)\n",
1666 arg);
1667 return 0;
1669 break;
1671 case OPT_INFO:
1672 arg = poptGetOptArg(pc);
1673 parse_output_words(info_words, info_levels, arg, USER_PRIORITY);
1674 break;
1676 case OPT_DEBUG:
1677 arg = poptGetOptArg(pc);
1678 parse_output_words(debug_words, debug_levels, arg, USER_PRIORITY);
1679 break;
1681 case OPT_USERMAP:
1682 if (usermap) {
1683 if (usermap_via_chown) {
1684 snprintf(err_buf, sizeof err_buf,
1685 "--usermap conflicts with prior --chown.\n");
1686 return 0;
1688 snprintf(err_buf, sizeof err_buf,
1689 "You can only specify --usermap once.\n");
1690 return 0;
1692 usermap = (char *)poptGetOptArg(pc);
1693 usermap_via_chown = False;
1694 break;
1696 case OPT_GROUPMAP:
1697 if (groupmap) {
1698 if (groupmap_via_chown) {
1699 snprintf(err_buf, sizeof err_buf,
1700 "--groupmap conflicts with prior --chown.\n");
1701 return 0;
1703 snprintf(err_buf, sizeof err_buf,
1704 "You can only specify --groupmap once.\n");
1705 return 0;
1707 groupmap = (char *)poptGetOptArg(pc);
1708 groupmap_via_chown = False;
1709 break;
1711 case OPT_CHOWN: {
1712 const char *chown = poptGetOptArg(pc);
1713 int len;
1714 if ((arg = strchr(chown, ':')) != NULL)
1715 len = arg++ - chown;
1716 else
1717 len = strlen(chown);
1718 if (len) {
1719 if (usermap) {
1720 if (!usermap_via_chown) {
1721 snprintf(err_buf, sizeof err_buf,
1722 "--chown conflicts with prior --usermap.\n");
1723 return 0;
1725 snprintf(err_buf, sizeof err_buf,
1726 "You can only specify a user-affecting --chown once.\n");
1727 return 0;
1729 if (asprintf(&usermap, "*:%.*s", len, chown) < 0)
1730 out_of_memory("parse_arguments");
1731 usermap_via_chown = True;
1733 if (arg && *arg) {
1734 if (groupmap) {
1735 if (!groupmap_via_chown) {
1736 snprintf(err_buf, sizeof err_buf,
1737 "--chown conflicts with prior --groupmap.\n");
1738 return 0;
1740 snprintf(err_buf, sizeof err_buf,
1741 "You can only specify a group-affecting --chown once.\n");
1742 return 0;
1744 if (asprintf(&groupmap, "*:%s", arg) < 0)
1745 out_of_memory("parse_arguments");
1746 groupmap_via_chown = True;
1748 break;
1751 case OPT_HELP:
1752 usage(FINFO);
1753 exit_cleanup(0);
1755 case 'A':
1756 #ifdef SUPPORT_ACLS
1757 preserve_acls = 1;
1758 preserve_perms = 1;
1759 break;
1760 #else
1761 /* FIXME: this should probably be ignored with a
1762 * warning and then countermeasures taken to
1763 * restrict group and other access in the presence
1764 * of any more restrictive ACLs, but this is safe
1765 * for now */
1766 snprintf(err_buf,sizeof(err_buf),
1767 "ACLs are not supported on this %s\n",
1768 am_server ? "server" : "client");
1769 return 0;
1770 #endif
1772 case 'X':
1773 #ifdef SUPPORT_XATTRS
1774 preserve_xattrs++;
1775 break;
1776 #else
1777 snprintf(err_buf,sizeof(err_buf),
1778 "extended attributes are not supported on this %s\n",
1779 am_server ? "server" : "client");
1780 return 0;
1781 #endif
1783 default:
1784 /* A large opt value means that set_refuse_options()
1785 * turned this option off. */
1786 if (opt >= OPT_REFUSED_BASE) {
1787 create_refuse_error(opt);
1788 return 0;
1790 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
1791 am_server ? "on remote machine: " : "",
1792 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1793 poptStrerror(opt));
1794 return 0;
1798 if (protect_args < 0) {
1799 if (am_server)
1800 protect_args = 0;
1801 else if ((arg = getenv("RSYNC_PROTECT_ARGS")) != NULL && *arg)
1802 protect_args = atoi(arg) ? 1 : 0;
1803 else {
1804 #ifdef RSYNC_USE_PROTECTED_ARGS
1805 protect_args = 1;
1806 #else
1807 protect_args = 0;
1808 #endif
1812 if (human_readable > 1 && argc == 2 && !am_server) {
1813 /* Allow the old meaning of 'h' (--help) on its own. */
1814 usage(FINFO);
1815 exit_cleanup(0);
1818 set_output_verbosity(verbose, DEFAULT_PRIORITY);
1820 if (do_stats) {
1821 parse_output_words(info_words, info_levels,
1822 verbose > 1 ? "stats3" : "stats2", DEFAULT_PRIORITY);
1825 if (human_readable) {
1826 char buf[32];
1827 snprintf(buf, sizeof buf, "%f", 3.14);
1828 if (strchr(buf, '.') != NULL)
1829 number_separator = ',';
1830 else
1831 number_separator = '.';
1834 #ifdef ICONV_OPTION
1835 if (iconv_opt && protect_args != 2) {
1836 if (!am_server && strcmp(iconv_opt, "-") == 0)
1837 iconv_opt = NULL;
1838 else
1839 need_unsorted_flist = 1;
1841 if (refused_no_iconv && !iconv_opt) {
1842 create_refuse_error(refused_no_iconv);
1843 return 0;
1845 #endif
1847 if (protect_args == 1 && am_server)
1848 return 1;
1850 *argv_p = argv = poptGetArgs(pc);
1851 *argc_p = argc = count_args(argv);
1853 #ifndef SUPPORT_LINKS
1854 if (preserve_links && !am_sender) {
1855 snprintf(err_buf, sizeof err_buf,
1856 "symlinks are not supported on this %s\n",
1857 am_server ? "server" : "client");
1858 return 0;
1860 #endif
1862 #ifndef SUPPORT_HARD_LINKS
1863 if (preserve_hard_links) {
1864 snprintf(err_buf, sizeof err_buf,
1865 "hard links are not supported on this %s\n",
1866 am_server ? "server" : "client");
1867 return 0;
1869 #endif
1871 #ifdef SUPPORT_XATTRS
1872 if (am_root < 0 && preserve_xattrs > 1) {
1873 snprintf(err_buf, sizeof err_buf,
1874 "--fake-super conflicts with -XX\n");
1875 return 0;
1877 #else
1878 if (am_root < 0) {
1879 snprintf(err_buf, sizeof err_buf,
1880 "--fake-super requires an rsync with extended attributes enabled\n");
1881 return 0;
1883 #endif
1885 if (write_batch && read_batch) {
1886 snprintf(err_buf, sizeof err_buf,
1887 "--write-batch and --read-batch can not be used together\n");
1888 return 0;
1890 if (write_batch > 0 || read_batch) {
1891 if (am_server) {
1892 rprintf(FINFO,
1893 "ignoring --%s-batch option sent to server\n",
1894 write_batch ? "write" : "read");
1895 /* We don't actually exit_cleanup(), so that we can
1896 * still service older version clients that still send
1897 * batch args to server. */
1898 read_batch = write_batch = 0;
1899 batch_name = NULL;
1900 } else if (dry_run)
1901 write_batch = 0;
1902 } else if (write_batch < 0 && dry_run)
1903 write_batch = 0;
1904 if (read_batch && files_from) {
1905 snprintf(err_buf, sizeof err_buf,
1906 "--read-batch cannot be used with --files-from\n");
1907 return 0;
1909 if (read_batch && remove_source_files) {
1910 snprintf(err_buf, sizeof err_buf,
1911 "--read-batch cannot be used with --remove-%s-files\n",
1912 remove_source_files == 1 ? "source" : "sent");
1913 return 0;
1915 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
1916 snprintf(err_buf, sizeof err_buf,
1917 "the batch-file name must be %d characters or less.\n",
1918 MAX_BATCH_NAME_LEN);
1919 return 0;
1922 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
1923 snprintf(err_buf, sizeof err_buf,
1924 "the --temp-dir path is WAY too long.\n");
1925 return 0;
1928 if (max_delete < 0 && max_delete != INT_MIN) {
1929 /* Negative numbers are treated as "no deletions". */
1930 max_delete = 0;
1933 if (compare_dest + copy_dest + link_dest > 1) {
1934 snprintf(err_buf, sizeof err_buf,
1935 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
1936 return 0;
1939 if (files_from) {
1940 if (recurse == 1) /* preserve recurse == 2 */
1941 recurse = 0;
1942 if (xfer_dirs < 0)
1943 xfer_dirs = 1;
1946 if (argc < 2 && !read_batch && !am_server)
1947 list_only |= 1;
1949 if (xfer_dirs >= 4) {
1950 parse_filter_str(&filter_list, "- /*/*", rule_template(0), 0);
1951 recurse = xfer_dirs = 1;
1952 } else if (recurse)
1953 xfer_dirs = 1;
1954 else if (xfer_dirs < 0)
1955 xfer_dirs = list_only ? 1 : 0;
1957 if (relative_paths < 0)
1958 relative_paths = files_from? 1 : 0;
1959 if (!relative_paths)
1960 implied_dirs = 0;
1962 if (delete_before + !!delete_during + delete_after > 1) {
1963 snprintf(err_buf, sizeof err_buf,
1964 "You may not combine multiple --delete-WHEN options.\n");
1965 return 0;
1967 if (delete_before || delete_during || delete_after)
1968 delete_mode = 1;
1969 else if (delete_mode || delete_excluded) {
1970 /* Only choose now between before & during if one is refused. */
1971 if (refused_delete_before) {
1972 if (!refused_delete_during)
1973 delete_during = 1;
1974 else {
1975 create_refuse_error(refused_delete_before);
1976 return 0;
1978 } else if (refused_delete_during)
1979 delete_before = 1;
1980 delete_mode = 1;
1982 if (!xfer_dirs && delete_mode) {
1983 snprintf(err_buf, sizeof err_buf,
1984 "--delete does not work without --recursive (-r) or --dirs (-d).\n");
1985 return 0;
1988 if (missing_args == 3) /* simplify if both options were specified */
1989 missing_args = 2;
1990 if (refused_delete && (delete_mode || missing_args == 2)) {
1991 create_refuse_error(refused_delete);
1992 return 0;
1995 if (remove_source_files) {
1996 /* We only want to infer this refusal of --remove-source-files
1997 * via the refusal of "delete", not any of the "delete-FOO"
1998 * options. */
1999 if (refused_delete && am_sender) {
2000 create_refuse_error(refused_delete);
2001 return 0;
2003 need_messages_from_generator = 1;
2006 if (munge_symlinks && !am_daemon) {
2007 STRUCT_STAT st;
2008 char prefix[SYMLINK_PREFIX_LEN]; /* NOT +1 ! */
2009 strlcpy(prefix, SYMLINK_PREFIX, sizeof prefix); /* trim the trailing slash */
2010 if (do_stat(prefix, &st) == 0 && S_ISDIR(st.st_mode)) {
2011 rprintf(FERROR, "Symlink munging is unsafe when a %s directory exists.\n",
2012 prefix);
2013 exit_cleanup(RERR_UNSUPPORTED);
2017 if (sanitize_paths) {
2018 int i;
2019 for (i = argc; i-- > 0; )
2020 argv[i] = sanitize_path(NULL, argv[i], "", 0, SP_KEEP_DOT_DIRS);
2021 if (tmpdir)
2022 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0, SP_DEFAULT);
2023 if (backup_dir)
2024 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0, SP_DEFAULT);
2026 if (daemon_filter_list.head && !am_sender) {
2027 filter_rule_list *elp = &daemon_filter_list;
2028 if (tmpdir) {
2029 char *dir;
2030 if (!*tmpdir)
2031 goto options_rejected;
2032 dir = tmpdir + (*tmpdir == '/' ? module_dirlen : 0);
2033 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2034 if (check_filter(elp, FLOG, dir, 1) < 0)
2035 goto options_rejected;
2037 if (backup_dir) {
2038 char *dir;
2039 if (!*backup_dir)
2040 goto options_rejected;
2041 dir = backup_dir + (*backup_dir == '/' ? module_dirlen : 0);
2042 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2043 if (check_filter(elp, FLOG, dir, 1) < 0)
2044 goto options_rejected;
2048 if (!backup_suffix)
2049 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
2050 backup_suffix_len = strlen(backup_suffix);
2051 if (strchr(backup_suffix, '/') != NULL) {
2052 snprintf(err_buf, sizeof err_buf,
2053 "--suffix cannot contain slashes: %s\n",
2054 backup_suffix);
2055 return 0;
2057 if (backup_dir) {
2058 size_t len;
2059 while (*backup_dir == '.' && backup_dir[1] == '/')
2060 backup_dir += 2;
2061 if (*backup_dir == '.' && backup_dir[1] == '\0')
2062 backup_dir++;
2063 len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
2064 if (len > sizeof backup_dir_buf - 128) {
2065 snprintf(err_buf, sizeof err_buf,
2066 "the --backup-dir path is WAY too long.\n");
2067 return 0;
2069 backup_dir_len = (int)len;
2070 if (!backup_dir_len) {
2071 backup_dir_len = -1;
2072 backup_dir = NULL;
2073 } else if (backup_dir_buf[backup_dir_len - 1] != '/') {
2074 backup_dir_buf[backup_dir_len++] = '/';
2075 backup_dir_buf[backup_dir_len] = '\0';
2077 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
2079 if (backup_dir) {
2080 /* No need for a suffix or a protect rule. */
2081 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
2082 snprintf(err_buf, sizeof err_buf,
2083 "--suffix cannot be empty %s\n", backup_dir_len < 0
2084 ? "when --backup-dir is the same as the dest dir"
2085 : "without a --backup-dir");
2086 return 0;
2087 } else if (make_backups && delete_mode && !delete_excluded && !am_server) {
2088 snprintf(backup_dir_buf, sizeof backup_dir_buf,
2089 "P *%s", backup_suffix);
2090 parse_filter_str(&filter_list, backup_dir_buf, rule_template(0), 0);
2093 if (preserve_times) {
2094 preserve_times = PRESERVE_FILE_TIMES;
2095 if (!omit_dir_times)
2096 preserve_times |= PRESERVE_DIR_TIMES;
2097 #ifdef CAN_SET_SYMLINK_TIMES
2098 if (!omit_link_times)
2099 preserve_times |= PRESERVE_LINK_TIMES;
2100 #endif
2103 if (make_backups && !backup_dir) {
2104 omit_dir_times = 0; /* Implied, so avoid -O to sender. */
2105 preserve_times &= ~PRESERVE_DIR_TIMES;
2108 if (stdout_format) {
2109 if (am_server && log_format_has(stdout_format, 'I'))
2110 stdout_format_has_i = 2;
2111 else if (log_format_has(stdout_format, 'i'))
2112 stdout_format_has_i = itemize_changes | 1;
2113 if (!log_format_has(stdout_format, 'b')
2114 && !log_format_has(stdout_format, 'c')
2115 && !log_format_has(stdout_format, 'C'))
2116 log_before_transfer = !am_server;
2117 } else if (itemize_changes) {
2118 stdout_format = "%i %n%L";
2119 stdout_format_has_i = itemize_changes;
2120 log_before_transfer = !am_server;
2123 if (do_progress && !am_server) {
2124 if (!log_before_transfer && INFO_EQ(NAME, 0))
2125 parse_output_words(info_words, info_levels, "name", DEFAULT_PRIORITY);
2126 parse_output_words(info_words, info_levels, "flist2,progress", DEFAULT_PRIORITY);
2129 if (dry_run)
2130 do_xfers = 0;
2132 set_io_timeout(io_timeout);
2134 if (INFO_GTE(NAME, 1) && !stdout_format) {
2135 stdout_format = "%n%L";
2136 log_before_transfer = !am_server;
2138 if (stdout_format_has_i || log_format_has(stdout_format, 'o'))
2139 stdout_format_has_o_or_i = 1;
2141 if (logfile_name && !am_daemon) {
2142 if (!logfile_format) {
2143 logfile_format = "%i %n%L";
2144 logfile_format_has_i = logfile_format_has_o_or_i = 1;
2145 } else {
2146 if (log_format_has(logfile_format, 'i'))
2147 logfile_format_has_i = 1;
2148 if (logfile_format_has_i || log_format_has(logfile_format, 'o'))
2149 logfile_format_has_o_or_i = 1;
2151 log_init(0);
2152 } else if (!am_daemon)
2153 logfile_format = NULL;
2155 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
2156 bwlimit = daemon_bwlimit;
2157 if (bwlimit) {
2158 bwlimit_writemax = (size_t)bwlimit * 128;
2159 if (bwlimit_writemax < 512)
2160 bwlimit_writemax = 512;
2163 if (sparse_files && inplace) {
2164 /* Note: we don't check for this below, because --append is
2165 * OK with --sparse (as long as redos are handled right). */
2166 snprintf(err_buf, sizeof err_buf,
2167 "--sparse cannot be used with --inplace\n");
2168 return 0;
2171 if (append_mode) {
2172 if (whole_file > 0) {
2173 snprintf(err_buf, sizeof err_buf,
2174 "--append cannot be used with --whole-file\n");
2175 return 0;
2177 if (refused_inplace) {
2178 create_refuse_error(refused_inplace);
2179 return 0;
2181 inplace = 1;
2184 if (delay_updates && !partial_dir)
2185 partial_dir = tmp_partialdir;
2187 if (inplace) {
2188 #ifdef HAVE_FTRUNCATE
2189 if (partial_dir) {
2190 snprintf(err_buf, sizeof err_buf,
2191 "--%s cannot be used with --%s\n",
2192 append_mode ? "append" : "inplace",
2193 delay_updates ? "delay-updates" : "partial-dir");
2194 return 0;
2196 /* --inplace implies --partial for refusal purposes, but we
2197 * clear the keep_partial flag for internal logic purposes. */
2198 if (refused_partial) {
2199 create_refuse_error(refused_partial);
2200 return 0;
2202 keep_partial = 0;
2203 #else
2204 snprintf(err_buf, sizeof err_buf,
2205 "--%s is not supported on this %s\n",
2206 append_mode ? "append" : "inplace",
2207 am_server ? "server" : "client");
2208 return 0;
2209 #endif
2210 } else {
2211 if (keep_partial && !partial_dir && !am_server) {
2212 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
2213 partial_dir = strdup(arg);
2215 if (partial_dir) {
2216 if (*partial_dir)
2217 clean_fname(partial_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2218 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
2219 partial_dir = NULL;
2220 if (!partial_dir && refused_partial) {
2221 create_refuse_error(refused_partial);
2222 return 0;
2224 keep_partial = 1;
2228 if (files_from) {
2229 char *h, *p;
2230 int q;
2231 if (argc > 2 || (!am_daemon && !am_server && argc == 1)) {
2232 usage(FERROR);
2233 exit_cleanup(RERR_SYNTAX);
2235 if (strcmp(files_from, "-") == 0) {
2236 filesfrom_fd = 0;
2237 if (am_server)
2238 filesfrom_host = ""; /* reading from socket */
2239 } else if ((p = check_for_hostspec(files_from, &h, &q)) != 0) {
2240 if (am_server) {
2241 snprintf(err_buf, sizeof err_buf,
2242 "The --files-from sent to the server cannot specify a host.\n");
2243 return 0;
2245 files_from = p;
2246 filesfrom_host = h;
2247 if (strcmp(files_from, "-") == 0) {
2248 snprintf(err_buf, sizeof err_buf,
2249 "Invalid --files-from remote filename\n");
2250 return 0;
2252 } else {
2253 if (sanitize_paths)
2254 files_from = sanitize_path(NULL, files_from, NULL, 0, SP_DEFAULT);
2255 if (daemon_filter_list.head) {
2256 char *dir;
2257 if (!*files_from)
2258 goto options_rejected;
2259 dir = files_from + (*files_from == '/' ? module_dirlen : 0);
2260 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2261 if (check_filter(&daemon_filter_list, FLOG, dir, 0) < 0)
2262 goto options_rejected;
2264 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
2265 if (filesfrom_fd < 0) {
2266 snprintf(err_buf, sizeof err_buf,
2267 "failed to open files-from file %s: %s\n",
2268 files_from, strerror(errno));
2269 return 0;
2274 am_starting_up = 0;
2276 return 1;
2278 options_rejected:
2279 snprintf(err_buf, sizeof err_buf,
2280 "Your options have been rejected by the server.\n");
2281 return 0;
2286 * Construct a filtered list of options to pass through from the
2287 * client to the server.
2289 * This involves setting options that will tell the server how to
2290 * behave, and also filtering out options that are processed only
2291 * locally.
2293 void server_options(char **args, int *argc_p)
2295 static char argstr[64];
2296 int ac = *argc_p;
2297 uchar where;
2298 char *arg;
2299 int i, x;
2301 /* This should always remain first on the server's command-line. */
2302 args[ac++] = "--server";
2304 if (daemon_over_rsh > 0) {
2305 args[ac++] = "--daemon";
2306 *argc_p = ac;
2307 /* if we're passing --daemon, we're done */
2308 return;
2311 if (!am_sender)
2312 args[ac++] = "--sender";
2314 x = 1;
2315 argstr[0] = '-';
2317 if (protect_args)
2318 argstr[x++] = 's';
2320 for (i = 0; i < verbose; i++)
2321 argstr[x++] = 'v';
2323 /* the -q option is intentionally left out */
2324 if (make_backups)
2325 argstr[x++] = 'b';
2326 if (update_only)
2327 argstr[x++] = 'u';
2328 if (!do_xfers) /* Note: NOT "dry_run"! */
2329 argstr[x++] = 'n';
2330 if (preserve_links)
2331 argstr[x++] = 'l';
2332 if ((xfer_dirs >= 2 && xfer_dirs < 4)
2333 || (xfer_dirs && !recurse && (list_only || (delete_mode && am_sender))))
2334 argstr[x++] = 'd';
2335 if (am_sender) {
2336 if (keep_dirlinks)
2337 argstr[x++] = 'K';
2338 if (prune_empty_dirs)
2339 argstr[x++] = 'm';
2340 if (omit_dir_times)
2341 argstr[x++] = 'O';
2342 if (omit_link_times)
2343 argstr[x++] = 'J';
2344 } else {
2345 if (copy_links)
2346 argstr[x++] = 'L';
2347 if (copy_dirlinks)
2348 argstr[x++] = 'k';
2351 if (whole_file > 0)
2352 argstr[x++] = 'W';
2353 /* We don't need to send --no-whole-file, because it's the
2354 * default for remote transfers, and in any case old versions
2355 * of rsync will not understand it. */
2357 if (preserve_hard_links) {
2358 argstr[x++] = 'H';
2359 if (preserve_hard_links > 1)
2360 argstr[x++] = 'H';
2362 if (preserve_uid)
2363 argstr[x++] = 'o';
2364 if (preserve_gid)
2365 argstr[x++] = 'g';
2366 if (preserve_devices) /* ignore preserve_specials here */
2367 argstr[x++] = 'D';
2368 if (preserve_times)
2369 argstr[x++] = 't';
2370 if (preserve_perms)
2371 argstr[x++] = 'p';
2372 else if (preserve_executability && am_sender)
2373 argstr[x++] = 'E';
2374 #ifdef SUPPORT_ACLS
2375 if (preserve_acls)
2376 argstr[x++] = 'A';
2377 #endif
2378 #ifdef SUPPORT_XATTRS
2379 if (preserve_xattrs) {
2380 argstr[x++] = 'X';
2381 if (preserve_xattrs > 1)
2382 argstr[x++] = 'X';
2384 #endif
2385 if (recurse)
2386 argstr[x++] = 'r';
2387 if (always_checksum)
2388 argstr[x++] = 'c';
2389 if (cvs_exclude)
2390 argstr[x++] = 'C';
2391 if (ignore_times)
2392 argstr[x++] = 'I';
2393 if (relative_paths)
2394 argstr[x++] = 'R';
2395 if (one_file_system) {
2396 argstr[x++] = 'x';
2397 if (one_file_system > 1)
2398 argstr[x++] = 'x';
2400 if (sparse_files)
2401 argstr[x++] = 'S';
2402 if (do_compression)
2403 argstr[x++] = 'z';
2405 set_allow_inc_recurse();
2407 /* Checking the pre-negotiated value allows --protocol=29 override. */
2408 if (protocol_version >= 30) {
2409 /* We make use of the -e option to let the server know about
2410 * any pre-release protocol version && some behavior flags. */
2411 argstr[x++] = 'e';
2412 #if SUBPROTOCOL_VERSION != 0
2413 if (protocol_version == PROTOCOL_VERSION) {
2414 x += snprintf(argstr+x, sizeof argstr - x,
2415 "%d.%d",
2416 PROTOCOL_VERSION, SUBPROTOCOL_VERSION);
2417 } else
2418 #endif
2419 argstr[x++] = '.';
2420 if (allow_inc_recurse)
2421 argstr[x++] = 'i';
2422 #ifdef CAN_SET_SYMLINK_TIMES
2423 argstr[x++] = 'L';
2424 #endif
2425 #ifdef ICONV_OPTION
2426 argstr[x++] = 's';
2427 #endif
2430 if (x >= (int)sizeof argstr) { /* Not possible... */
2431 rprintf(FERROR, "argstr overflow in server_options().\n");
2432 exit_cleanup(RERR_MALLOC);
2435 argstr[x] = '\0';
2437 if (x > 1)
2438 args[ac++] = argstr;
2440 #ifdef ICONV_OPTION
2441 if (iconv_opt) {
2442 char *set = strchr(iconv_opt, ',');
2443 if (set)
2444 set++;
2445 else
2446 set = iconv_opt;
2447 if (asprintf(&arg, "--iconv=%s", set) < 0)
2448 goto oom;
2449 args[ac++] = arg;
2451 #endif
2453 if (protect_args && !local_server) /* unprotected args stop here */
2454 args[ac++] = NULL;
2456 if (list_only > 1)
2457 args[ac++] = "--list-only";
2459 /* This makes sure that the remote rsync can handle deleting with -d
2460 * sans -r because the --no-r option was added at the same time. */
2461 if (xfer_dirs && !recurse && delete_mode && am_sender)
2462 args[ac++] = "--no-r";
2464 if (do_compression && def_compress_level != Z_DEFAULT_COMPRESSION) {
2465 if (asprintf(&arg, "--compress-level=%d", def_compress_level) < 0)
2466 goto oom;
2467 args[ac++] = arg;
2470 if (preserve_devices) {
2471 /* Note: sending "--devices" would not be backward-compatible. */
2472 if (!preserve_specials)
2473 args[ac++] = "--no-specials"; /* -D is already set. */
2474 } else if (preserve_specials)
2475 args[ac++] = "--specials";
2477 /* The server side doesn't use our log-format, but in certain
2478 * circumstances they need to know a little about the option. */
2479 if (stdout_format && am_sender) {
2480 /* Use --log-format, not --out-format, for compatibility. */
2481 if (stdout_format_has_i > 1)
2482 args[ac++] = "--log-format=%i%I";
2483 else if (stdout_format_has_i)
2484 args[ac++] = "--log-format=%i";
2485 else if (stdout_format_has_o_or_i)
2486 args[ac++] = "--log-format=%o";
2487 else if (!verbose)
2488 args[ac++] = "--log-format=X";
2491 if (block_size) {
2492 if (asprintf(&arg, "-B%lu", block_size) < 0)
2493 goto oom;
2494 args[ac++] = arg;
2497 if (io_timeout) {
2498 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
2499 goto oom;
2500 args[ac++] = arg;
2503 if (bwlimit) {
2504 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
2505 goto oom;
2506 args[ac++] = arg;
2509 if (backup_dir) {
2510 args[ac++] = "--backup-dir";
2511 args[ac++] = backup_dir;
2514 /* Only send --suffix if it specifies a non-default value. */
2515 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
2516 /* We use the following syntax to avoid weirdness with '~'. */
2517 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
2518 goto oom;
2519 args[ac++] = arg;
2522 if (am_sender) {
2523 if (max_delete > 0) {
2524 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
2525 goto oom;
2526 args[ac++] = arg;
2527 } else if (max_delete == 0)
2528 args[ac++] = "--max-delete=-1";
2529 if (min_size) {
2530 args[ac++] = "--min-size";
2531 args[ac++] = min_size_arg;
2533 if (max_size) {
2534 args[ac++] = "--max-size";
2535 args[ac++] = max_size_arg;
2537 if (delete_before)
2538 args[ac++] = "--delete-before";
2539 else if (delete_during == 2)
2540 args[ac++] = "--delete-delay";
2541 else if (delete_during)
2542 args[ac++] = "--delete-during";
2543 else if (delete_after)
2544 args[ac++] = "--delete-after";
2545 else if (delete_mode && !delete_excluded)
2546 args[ac++] = "--delete";
2547 if (delete_excluded)
2548 args[ac++] = "--delete-excluded";
2549 if (force_delete)
2550 args[ac++] = "--force";
2551 if (write_batch < 0)
2552 args[ac++] = "--only-write-batch=X";
2553 if (am_root > 1)
2554 args[ac++] = "--super";
2555 if (size_only)
2556 args[ac++] = "--size-only";
2557 if (do_stats)
2558 args[ac++] = "--stats";
2559 } else {
2560 if (skip_compress) {
2561 if (asprintf(&arg, "--skip-compress=%s", skip_compress) < 0)
2562 goto oom;
2563 args[ac++] = arg;
2567 /* --delete-missing-args needs the cooperation of both sides, but
2568 * the sender can handle --ignore-missing-args by itself. */
2569 if (missing_args == 2)
2570 args[ac++] = "--delete-missing-args";
2571 else if (missing_args == 1 && !am_sender)
2572 args[ac++] = "--ignore-missing-args";
2574 if (modify_window_set) {
2575 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
2576 goto oom;
2577 args[ac++] = arg;
2580 if (checksum_seed) {
2581 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
2582 goto oom;
2583 args[ac++] = arg;
2586 if (partial_dir && am_sender) {
2587 if (partial_dir != tmp_partialdir) {
2588 args[ac++] = "--partial-dir";
2589 args[ac++] = partial_dir;
2591 if (delay_updates)
2592 args[ac++] = "--delay-updates";
2593 } else if (keep_partial && am_sender)
2594 args[ac++] = "--partial";
2596 if (ignore_errors)
2597 args[ac++] = "--ignore-errors";
2599 if (copy_unsafe_links)
2600 args[ac++] = "--copy-unsafe-links";
2602 if (safe_symlinks)
2603 args[ac++] = "--safe-links";
2605 if (numeric_ids)
2606 args[ac++] = "--numeric-ids";
2608 if (use_qsort)
2609 args[ac++] = "--use-qsort";
2611 if (am_sender) {
2612 if (usermap) {
2613 if (asprintf(&arg, "--usermap=%s", usermap) < 0)
2614 goto oom;
2615 args[ac++] = arg;
2618 if (groupmap) {
2619 if (asprintf(&arg, "--groupmap=%s", groupmap) < 0)
2620 goto oom;
2621 args[ac++] = arg;
2624 if (ignore_existing)
2625 args[ac++] = "--ignore-existing";
2627 /* Backward compatibility: send --existing, not --ignore-non-existing. */
2628 if (ignore_non_existing)
2629 args[ac++] = "--existing";
2631 if (tmpdir) {
2632 args[ac++] = "--temp-dir";
2633 args[ac++] = tmpdir;
2636 if (basis_dir[0]) {
2637 /* the server only needs this option if it is not the sender,
2638 * and it may be an older version that doesn't know this
2639 * option, so don't send it if client is the sender.
2641 for (i = 0; i < basis_dir_cnt; i++) {
2642 args[ac++] = dest_option;
2643 args[ac++] = basis_dir[i];
2648 /* What flags do we need to send to the other side? */
2649 where = (am_server ? W_CLI : W_SRV) | (am_sender ? W_REC : W_SND);
2650 arg = make_output_option(info_words, info_levels, where);
2651 if (arg)
2652 args[ac++] = arg;
2654 arg = make_output_option(debug_words, debug_levels, where);
2655 if (arg)
2656 args[ac++] = arg;
2658 if (append_mode) {
2659 if (append_mode > 1)
2660 args[ac++] = "--append";
2661 args[ac++] = "--append";
2662 } else if (inplace)
2663 args[ac++] = "--inplace";
2665 if (files_from && (!am_sender || filesfrom_host)) {
2666 if (filesfrom_host) {
2667 args[ac++] = "--files-from";
2668 args[ac++] = files_from;
2669 if (eol_nulls)
2670 args[ac++] = "--from0";
2671 } else {
2672 args[ac++] = "--files-from=-";
2673 args[ac++] = "--from0";
2675 if (!relative_paths)
2676 args[ac++] = "--no-relative";
2678 /* It's OK that this checks the upper-bound of the protocol_version. */
2679 if (relative_paths && !implied_dirs && (!am_sender || protocol_version >= 30))
2680 args[ac++] = "--no-implied-dirs";
2682 if (fuzzy_basis && am_sender)
2683 args[ac++] = "--fuzzy";
2685 if (remove_source_files == 1)
2686 args[ac++] = "--remove-source-files";
2687 else if (remove_source_files)
2688 args[ac++] = "--remove-sent-files";
2690 if (preallocate_files && am_sender)
2691 args[ac++] = "--preallocate";
2693 if (ac > MAX_SERVER_ARGS) { /* Not possible... */
2694 rprintf(FERROR, "argc overflow in server_options().\n");
2695 exit_cleanup(RERR_MALLOC);
2698 if (remote_option_cnt) {
2699 int j;
2700 if (ac + remote_option_cnt > MAX_SERVER_ARGS) {
2701 rprintf(FERROR, "too many remote options specified.\n");
2702 exit_cleanup(RERR_SYNTAX);
2704 for (j = 1; j <= remote_option_cnt; j++)
2705 args[ac++] = (char*)remote_options[j];
2708 *argc_p = ac;
2709 return;
2711 oom:
2712 out_of_memory("server_options");
2715 /* If str points to a valid hostspec, return allocated memory containing the
2716 * [USER@]HOST part of the string, and set the path_start_ptr to the part of
2717 * the string after the host part. Otherwise, return NULL. If port_ptr is
2718 * non-NULL, we must be parsing an rsync:// URL hostname, and we will set
2719 * *port_ptr if a port number is found. Note that IPv6 IPs will have their
2720 * (required for parsing) [ and ] chars elided from the returned string. */
2721 static char *parse_hostspec(char *str, char **path_start_ptr, int *port_ptr)
2723 char *s, *host_start = str;
2724 int hostlen = 0, userlen = 0;
2725 char *ret;
2727 for (s = str; ; s++) {
2728 if (!*s) {
2729 /* It is only OK if we run out of string with rsync:// */
2730 if (!port_ptr)
2731 return NULL;
2732 if (!hostlen)
2733 hostlen = s - host_start;
2734 break;
2736 if (*s == ':' || *s == '/') {
2737 if (!hostlen)
2738 hostlen = s - host_start;
2739 if (*s++ == '/') {
2740 if (!port_ptr)
2741 return NULL;
2742 } else if (port_ptr) {
2743 *port_ptr = atoi(s);
2744 while (isDigit(s)) s++;
2745 if (*s && *s++ != '/')
2746 return NULL;
2748 break;
2750 if (*s == '@') {
2751 userlen = s - str + 1;
2752 host_start = s + 1;
2753 } else if (*s == '[') {
2754 if (s != host_start++)
2755 return NULL;
2756 while (*s && *s != ']' && *s != '/') s++; /*SHARED ITERATOR*/
2757 hostlen = s - host_start;
2758 if (*s != ']' || (s[1] && s[1] != '/' && s[1] != ':') || !hostlen)
2759 return NULL;
2763 *path_start_ptr = s;
2764 ret = new_array(char, userlen + hostlen + 1);
2765 if (userlen)
2766 strlcpy(ret, str, userlen + 1);
2767 strlcpy(ret + userlen, host_start, hostlen + 1);
2768 return ret;
2771 /* Look for a HOST specfication of the form "HOST:PATH", "HOST::PATH", or
2772 * "rsync://HOST:PORT/PATH". If found, *host_ptr will be set to some allocated
2773 * memory with the HOST. If a daemon-accessing spec was specified, the value
2774 * of *port_ptr will contain a non-0 port number, otherwise it will be set to
2775 * 0. The return value is a pointer to the PATH. Note that the HOST spec can
2776 * be an IPv6 literal address enclosed in '[' and ']' (such as "[::1]" or
2777 * "[::ffff:127.0.0.1]") which is returned without the '[' and ']'. */
2778 char *check_for_hostspec(char *s, char **host_ptr, int *port_ptr)
2780 char *path;
2782 if (port_ptr && strncasecmp(URL_PREFIX, s, strlen(URL_PREFIX)) == 0) {
2783 *host_ptr = parse_hostspec(s + strlen(URL_PREFIX), &path, port_ptr);
2784 if (*host_ptr) {
2785 if (!*port_ptr)
2786 *port_ptr = RSYNC_PORT;
2787 return path;
2791 *host_ptr = parse_hostspec(s, &path, NULL);
2792 if (!*host_ptr)
2793 return NULL;
2795 if (*path == ':') {
2796 if (port_ptr && !*port_ptr)
2797 *port_ptr = RSYNC_PORT;
2798 return path + 1;
2800 if (port_ptr)
2801 *port_ptr = 0;
2803 return path;