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