1 /* -*- c-file-style: "linux" -*-
3 Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4 Copyright (C) 2000, 2001, 2002 by Martin Pool <mbp@samba.org>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 * Should we send the whole file as literal data rather than trying to
28 * create an incremental diff? This is on by default when both source
29 * and destination are local and we're not doing a batch delta,
30 * because there it's no cheaper to read the whole basis file than to
33 * If both are 0, then look at whether we're local or remote and go by
37 int no_whole_file = 0;
40 int preserve_links = 0;
41 int preserve_hard_links = 0;
42 int preserve_perms = 0;
43 int preserve_devices = 0;
46 int preserve_times = 0;
53 int delete_excluded=0;
54 int one_file_system=0;
75 int copy_unsafe_links=0;
76 int block_size=BLOCK_SIZE;
81 int opt_ignore_existing=0;
91 /** Network address family. **/
93 int default_af_hint = 0; /* Any protocol */
95 int default_af_hint = AF_INET; /* Must use IPv4 */
98 /** Do not go into the background when run as --daemon. Good
99 * for debugging and required for running as a service on W32,
100 * or under Unix process-monitors. **/
106 char *backup_suffix = BACKUP_SUFFIX;
108 char *compare_dest = NULL;
109 char *config_file = RSYNCD_CONF;
110 char *shell_cmd = NULL;
111 char *log_format = NULL;
112 char *password_file = NULL;
113 char *rsync_path = RSYNC_PATH;
114 char *backup_dir = NULL;
115 int rsync_port = RSYNC_PORT;
119 int always_checksum = 0;
122 char *batch_prefix = NULL;
124 static int modify_window_set;
126 /** Local address to bind. As a character string because it's
127 * interpreted by the IPv6 layer: should be a numeric IP4 or ip6
128 * address, or a hostname. **/
132 static void print_rsync_version(enum logcode f)
134 char const *got_socketpair = "no ";
135 char const *hardlinks = "no ";
136 char const *links = "no ";
137 char const *ipv6 = "no ";
138 STRUCT_STAT *dumstat;
140 #ifdef HAVE_SOCKETPAIR
144 #if SUPPORT_HARD_LINKS
156 rprintf(f, "%s version %s protocol version %d\n",
157 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
159 "Copyright (C) 1996-2002 by Andrew Tridgell and others\n");
160 rprintf(f, "<http://rsync.samba.org/>\n");
161 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
162 "%shard links, %ssymlinks, batchfiles, %sIPv6,\n",
163 (int) (sizeof(OFF_T) * 8),
164 got_socketpair, hardlinks, links, ipv6);
166 /* Note that this field may not have type ino_t. It depends
167 * on the complicated interaction between largefile feature
169 rprintf(f, " %d-bit system inums, %d-bit internal inums\n",
170 (int) (sizeof(dumstat->st_ino) * 8),
171 (int) (sizeof(INO64_T) * 8));
174 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
179 void usage(enum logcode F)
181 print_rsync_version(F);
183 rprintf(F,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
185 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
186 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
187 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
188 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
189 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
190 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
191 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
192 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
193 rprintf(F," sources separated by space as long as they have same top-level\n");
194 rprintf(F,"\nOptions\n");
195 rprintf(F," -v, --verbose increase verbosity\n");
196 rprintf(F," -q, --quiet decrease verbosity\n");
197 rprintf(F," -c, --checksum always checksum\n");
198 rprintf(F," -a, --archive archive mode\n");
199 rprintf(F," -r, --recursive recurse into directories\n");
200 rprintf(F," -R, --relative use relative path names\n");
201 rprintf(F," -b, --backup make backups (default %s suffix)\n",BACKUP_SUFFIX);
202 rprintf(F," --backup-dir make backups into this directory\n");
203 rprintf(F," --suffix=SUFFIX override backup suffix\n");
204 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
205 rprintf(F," -l, --links copy symlinks as symlinks\n");
206 rprintf(F," -L, --copy-links copy the referent of symlinks\n");
207 rprintf(F," --copy-unsafe-links copy links outside the source tree\n");
208 rprintf(F," --safe-links ignore links outside the destination tree\n");
209 rprintf(F," -H, --hard-links preserve hard links\n");
210 rprintf(F," -p, --perms preserve permissions\n");
211 rprintf(F," -o, --owner preserve owner (root only)\n");
212 rprintf(F," -g, --group preserve group\n");
213 rprintf(F," -D, --devices preserve devices (root only)\n");
214 rprintf(F," -t, --times preserve times\n");
215 rprintf(F," -S, --sparse handle sparse files efficiently\n");
216 rprintf(F," -n, --dry-run show what would have been transferred\n");
217 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
218 rprintf(F," --no-whole-file turn off --whole-file\n");
219 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
220 rprintf(F," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE);
221 rprintf(F," -e, --rsh=COMMAND specify rsh replacement\n");
222 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
223 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
224 rprintf(F," --existing only update files that already exist\n");
225 rprintf(F," --ignore-existing ignore files that already exist on the receiving side\n");
226 rprintf(F," --delete delete files that don't exist on the sending side\n");
227 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
228 rprintf(F," --delete-after delete after transferring, not before\n");
229 rprintf(F," --ignore-errors delete even if there are IO errors\n");
230 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
231 rprintf(F," --partial keep partially transferred files\n");
232 rprintf(F," --force force deletion of directories even if not empty\n");
233 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
234 rprintf(F," --timeout=TIME set IO timeout in seconds\n");
235 rprintf(F," -I, --ignore-times don't exclude files that match length and time\n");
236 rprintf(F," --size-only only use file size when determining if a file should be transferred\n");
237 rprintf(F," --modify-window=NUM Timestamp window (seconds) for file match (default=%d)\n",modify_window);
238 rprintf(F," -T --temp-dir=DIR create temporary files in directory DIR\n");
239 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
240 rprintf(F," -P equivalent to --partial --progress\n");
241 rprintf(F," -z, --compress compress file data\n");
242 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
243 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
244 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
245 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
246 rprintf(F," --version print version number\n");
247 rprintf(F," --daemon run as a rsync daemon\n");
248 rprintf(F," --no-detach do not detach from the parent\n");
249 rprintf(F," --address=ADDRESS bind to the specified address\n");
250 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
251 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
252 rprintf(F," --blocking-io use blocking IO for the remote shell\n");
253 rprintf(F," --no-blocking-io turn off --blocking-io\n");
254 rprintf(F," --stats give some file transfer stats\n");
255 rprintf(F," --progress show progress during transfer\n");
256 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
257 rprintf(F," --password-file=FILE get password from FILE\n");
258 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
259 rprintf(F," --write-batch=PREFIX write batch fileset starting with PREFIX\n");
260 rprintf(F," --read-batch=PREFIX read batch fileset starting with PREFIX\n");
261 rprintf(F," -h, --help show this help screen\n");
263 rprintf(F," -4 prefer IPv4\n");
264 rprintf(F," -6 prefer IPv6\n");
269 rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
270 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
273 enum {OPT_VERSION = 1000, OPT_SUFFIX, OPT_SENDER, OPT_SERVER, OPT_EXCLUDE,
274 OPT_EXCLUDE_FROM, OPT_DELETE, OPT_DELETE_EXCLUDED, OPT_NUMERIC_IDS,
275 OPT_RSYNC_PATH, OPT_FORCE, OPT_TIMEOUT, OPT_DAEMON, OPT_CONFIG, OPT_PORT,
276 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_STATS, OPT_PARTIAL, OPT_PROGRESS,
277 OPT_COPY_UNSAFE_LINKS, OPT_SAFE_LINKS, OPT_COMPARE_DEST,
278 OPT_LOG_FORMAT, OPT_PASSWORD_FILE, OPT_SIZE_ONLY, OPT_ADDRESS,
279 OPT_DELETE_AFTER, OPT_EXISTING, OPT_MAX_DELETE, OPT_BACKUP_DIR,
280 OPT_IGNORE_ERRORS, OPT_BWLIMIT, OPT_BLOCKING_IO,
281 OPT_NO_BLOCKING_IO, OPT_NO_WHOLE_FILE,
282 OPT_MODIFY_WINDOW, OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_IGNORE_EXISTING};
284 static struct poptOption long_options[] = {
285 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
286 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION},
287 {"suffix", 0, POPT_ARG_STRING, &backup_suffix},
288 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path},
289 {"password-file", 0, POPT_ARG_STRING, &password_file},
290 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times},
291 {"size-only", 0, POPT_ARG_NONE, &size_only},
292 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW},
293 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system},
294 {"delete", 0, POPT_ARG_NONE, &delete_mode},
295 {"existing", 0, POPT_ARG_NONE, &only_existing},
296 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing},
297 {"delete-after", 0, POPT_ARG_NONE, &delete_after},
298 {"delete-excluded", 0, POPT_ARG_NONE, 0, OPT_DELETE_EXCLUDED},
299 {"force", 0, POPT_ARG_NONE, &force_delete},
300 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids},
301 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE},
302 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE},
303 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM},
304 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM},
305 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks},
306 {"help", 'h', POPT_ARG_NONE, 0, 'h'},
307 {"backup", 'b', POPT_ARG_NONE, &make_backups},
308 {"dry-run", 'n', POPT_ARG_NONE, &dry_run},
309 {"sparse", 'S', POPT_ARG_NONE, &sparse_files},
310 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude},
311 {"update", 'u', POPT_ARG_NONE, &update_only},
312 {"links", 'l', POPT_ARG_NONE, &preserve_links},
313 {"copy-links", 'L', POPT_ARG_NONE, ©_links},
314 {"whole-file", 'W', POPT_ARG_NONE, &whole_file},
315 {"no-whole-file", 0, POPT_ARG_NONE, &no_whole_file},
316 {"copy-unsafe-links", 0, POPT_ARG_NONE, ©_unsafe_links},
317 {"perms", 'p', POPT_ARG_NONE, &preserve_perms},
318 {"owner", 'o', POPT_ARG_NONE, &preserve_uid},
319 {"group", 'g', POPT_ARG_NONE, &preserve_gid},
320 {"devices", 'D', POPT_ARG_NONE, &preserve_devices},
321 {"times", 't', POPT_ARG_NONE, &preserve_times},
322 {"checksum", 'c', POPT_ARG_NONE, &always_checksum},
323 {"verbose", 'v', POPT_ARG_NONE, 0, 'v'},
324 {"quiet", 'q', POPT_ARG_NONE, 0, 'q'},
325 {"archive", 'a', POPT_ARG_NONE, 0, 'a'},
326 {"server", 0, POPT_ARG_NONE, &am_server},
327 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER},
328 {"recursive", 'r', POPT_ARG_NONE, &recurse},
329 {"relative", 'R', POPT_ARG_NONE, &relative_paths},
330 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd},
331 {"block-size", 'B', POPT_ARG_INT, &block_size},
332 {"max-delete", 0, POPT_ARG_INT, &max_delete},
333 {"timeout", 0, POPT_ARG_INT, &io_timeout},
334 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir},
335 {"compare-dest", 0, POPT_ARG_STRING, &compare_dest},
336 /* TODO: Should this take an optional int giving the compression level? */
337 {"compress", 'z', POPT_ARG_NONE, &do_compression},
338 {"daemon", 0, POPT_ARG_NONE, &am_daemon},
339 {"no-detach", 0, POPT_ARG_NONE, &no_detach},
340 {"stats", 0, POPT_ARG_NONE, &do_stats},
341 {"progress", 0, POPT_ARG_NONE, &do_progress},
342 {"partial", 0, POPT_ARG_NONE, &keep_partial},
343 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors},
344 {"blocking-io", 0, POPT_ARG_NONE, &blocking_io},
345 {"no-blocking-io", 0, POPT_ARG_NONE, 0, OPT_NO_BLOCKING_IO},
346 {0, 'P', POPT_ARG_NONE, 0, 'P'},
347 {"config", 0, POPT_ARG_STRING, &config_file},
348 {"port", 0, POPT_ARG_INT, &rsync_port},
349 {"log-format", 0, POPT_ARG_STRING, &log_format},
350 {"bwlimit", 0, POPT_ARG_INT, &bwlimit},
351 {"address", 0, POPT_ARG_STRING, &bind_address, 0},
352 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir},
353 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links},
354 {"read-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_READ_BATCH},
355 {"write-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_WRITE_BATCH},
357 {0, '4', POPT_ARG_VAL, &default_af_hint, AF_INET },
358 {0, '6', POPT_ARG_VAL, &default_af_hint, AF_INET6 },
364 static char err_buf[100];
367 /* We store the option error message, if any, so that we can log the
368 connection attempt (which requires parsing the options), and then
369 show the error later on. */
370 void option_error(void)
373 rprintf(FLOG, "%s", err_buf);
374 rprintf(FERROR, "%s: %s", RSYNC_NAME, err_buf);
376 rprintf (FERROR, "Error parsing options: "
377 "option may be supported on client but not on server?\n");
378 rprintf (FERROR, RSYNC_NAME ": Error parsing options: "
379 "option may be supported on client but not on server?\n");
383 /* check to see if we should refuse this option */
384 static int check_refuse_options(char *ref, int opt)
390 for (i=0; long_options[i].longName; i++) {
391 if (long_options[i].val == opt) break;
394 if (!long_options[i].longName) return 0;
396 name = long_options[i].longName;
399 while ((p = strstr(ref,name))) {
400 if ((p==ref || p[-1]==' ') &&
401 (p[len] == ' ' || p[len] == 0)) {
402 snprintf(err_buf,sizeof(err_buf),
403 "The '%s' option is not supported by this server\n", name);
412 static int count_args(char const **argv)
416 while (argv[i] != NULL)
423 /* Process command line arguments. Called on both local and remote.
424 * Returns if all options are OK, otherwise fills in err_buf and
426 int parse_arguments(int *argc, const char ***argv, int frommain)
429 char *ref = lp_refuse_options(module_id);
432 /* TODO: Call poptReadDefaultConfig; handle errors. */
434 /* The context leaks in case of an error, but if there's a
435 * problem we always exit anyhow. */
436 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
438 while ((opt = poptGetNextOpt(pc)) != -1) {
440 if (check_refuse_options(ref, opt)) return 0;
443 /* most options are handled automatically by popt;
444 * only special cases are returned and listed here. */
448 print_rsync_version(FINFO);
451 case OPT_MODIFY_WINDOW:
452 /* The value has already been set by popt, but
453 * we need to remember that we're using a
454 * non-default setting. */
455 modify_window_set = 1;
458 case OPT_DELETE_EXCLUDED:
464 add_exclude(poptGetOptArg(pc), 0);
468 add_exclude(poptGetOptArg(pc), 1);
471 case OPT_EXCLUDE_FROM:
472 add_exclude_file(poptGetOptArg(pc), 1, 0);
475 case OPT_INCLUDE_FROM:
476 add_exclude_file(poptGetOptArg(pc), 1, 1);
479 case OPT_NO_BLOCKING_IO:
488 #if SUPPORT_HARD_LINKS
489 preserve_hard_links=1;
491 /* FIXME: Don't say "server" if this is
492 * happening on the client. */
493 /* FIXME: Why do we have the duplicated
494 * rprintf? Everybody who gets this message
495 * ought to send it to the client and also to
497 snprintf(err_buf,sizeof(err_buf),
498 "hard links are not supported on this %s\n",
499 am_server ? "server" : "client");
500 rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
502 #endif /* SUPPORT_HARD_LINKS */
510 if (frommain) quiet++;
528 exit_cleanup(RERR_SYNTAX);
538 case OPT_WRITE_BATCH:
539 /* popt stores the filename in batch_prefix for us */
544 /* popt stores the filename in batch_prefix for us */
549 /* FIXME: If --daemon is specified, then errors for later
550 * parameters seem to disappear. */
551 snprintf(err_buf, sizeof(err_buf),
553 am_server ? "on remote machine: " : "",
554 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
560 if (write_batch && read_batch) {
561 snprintf(err_buf,sizeof(err_buf),
562 "write-batch and read-batch can not be used together\n");
563 rprintf(FERROR,"ERROR: write-batch and read-batch"
564 " can not be used together\n");
568 if (do_compression && (write_batch || read_batch)) {
569 snprintf(err_buf,sizeof(err_buf),
570 "compress can not be used with write-batch or read-batch\n");
571 rprintf(FERROR,"ERROR: compress can not be used with"
572 " write-batch or read-batch\n");
576 *argv = poptGetArgs(pc);
578 *argc = count_args(*argv);
586 /* Construct a filtered list of options to pass through from the
587 * client to the server */
588 void server_options(char **args,int *argc)
591 static char argstr[50];
592 static char bsize[30];
593 static char iotime[30];
594 static char mdelete[30];
595 static char mwindow[30];
597 /* Leave room for ``--(write|read)-batch='' */
598 static char fext[MAXPATHLEN + 15];
602 if (blocking_io == -1)
605 args[ac++] = "--server";
608 args[ac++] = "--sender";
612 for (i=0;i<verbose;i++)
615 /* the -q option is intentionally left out */
627 assert(whole_file == 0 || whole_file == 1);
630 /* We don't need to send --no-whole-file, because it's the
631 * default for remote transfers, and in any case old versions
632 * of rsync will not understand it. */
634 if (preserve_hard_links)
640 if (preserve_devices)
663 /* this is a complete hack - blame Rusty
665 this is a hack to make the list_only (remote file list)
667 if (list_only && !recurse)
672 if (x != 1) args[ac++] = argstr;
674 if (block_size != BLOCK_SIZE) {
675 snprintf(bsize,sizeof(bsize),"-B%d",block_size);
679 if (max_delete && am_sender) {
680 snprintf(mdelete,sizeof(mdelete),"--max-delete=%d",max_delete);
681 args[ac++] = mdelete;
684 if (batch_prefix != NULL) {
687 fmt = "--write-batch=%s";
690 fmt = "--read-batch=%s";
691 snprintf(fext,sizeof(fext),fmt,batch_prefix);
696 snprintf(iotime,sizeof(iotime),"--timeout=%d",io_timeout);
701 snprintf(bw,sizeof(bw),"--bwlimit=%d",bwlimit);
705 if (strcmp(backup_suffix, BACKUP_SUFFIX)) {
706 args[ac++] = "--suffix";
707 args[ac++] = backup_suffix;
710 if (delete_mode && !delete_excluded)
711 args[ac++] = "--delete";
714 args[ac++] = "--delete-excluded";
717 args[ac++] = "--size-only";
719 if (modify_window_set) {
720 snprintf(mwindow,sizeof(mwindow),"--modify-window=%d",
722 args[ac++] = mwindow;
726 args[ac++] = "--partial";
729 args[ac++] = "--force";
732 args[ac++] = "--delete-after";
735 args[ac++] = "--ignore-errors";
737 if (copy_unsafe_links)
738 args[ac++] = "--copy-unsafe-links";
741 args[ac++] = "--safe-links";
744 args[ac++] = "--numeric-ids";
746 if (only_existing && am_sender)
747 args[ac++] = "--existing";
749 if (opt_ignore_existing && am_sender)
750 args[ac++] = "--ignore-existing";
753 args[ac++] = "--temp-dir";
757 if (backup_dir && am_sender) {
758 /* only the receiver needs this option, if we are the sender
759 * then we need to send it to the receiver.
761 args[ac++] = "--backup-dir";
762 args[ac++] = backup_dir;
765 if (compare_dest && am_sender) {
766 /* the server only needs this option if it is not the sender,
767 * and it may be an older version that doesn't know this
768 * option, so don't send it if client is the sender.
770 args[ac++] = "--compare-dest";
771 args[ac++] = compare_dest;