1 /* -*- c-file-style: "linux" -*-
3 Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4 Copyright (C) 2000-2001 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 int preserve_links = 0;
28 int preserve_hard_links = 0;
29 int preserve_perms = 0;
30 int preserve_devices = 0;
33 int preserve_times = 0;
40 int delete_excluded=0;
41 int one_file_system=0;
62 int copy_unsafe_links=0;
63 int block_size=BLOCK_SIZE;
77 /** Network address family. **/
79 int default_af_hint = 0; /* Any protocol */
81 int default_af_hint = AF_INET; /* Must use IPv4 */
84 /** Do not go into the background when run as --daemon. Good
85 * for debugging and required for running as a service on W32,
86 * or under Unix process-monitors. **/
93 char *backup_suffix = BACKUP_SUFFIX;
95 char *compare_dest = NULL;
96 char *config_file = RSYNCD_CONF;
97 char *shell_cmd = NULL;
98 char *log_format = NULL;
99 char *password_file = NULL;
100 char *rsync_path = RSYNC_PATH;
101 char *backup_dir = NULL;
102 int rsync_port = RSYNC_PORT;
106 int always_checksum = 0;
109 char *batch_ext = NULL;
111 static int modify_window_set;
113 /** Local address to bind. As a character string because it's
114 * interpreted by the IPv6 layer: should be a numeric IP4 or ip6
115 * address, or a hostname. **/
119 static void print_rsync_version(enum logcode f)
121 char const *got_socketpair = "no ";
122 char const *hardlinks = "no ";
123 char const *links = "no ";
124 char const *ipv6 = "no ";
126 #ifdef HAVE_SOCKETPAIR
130 #if SUPPORT_HARD_LINKS
142 rprintf(f, "%s version %s protocol version %d\n",
143 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
145 "Copyright (C) 1996-2001 by Andrew Tridgell and others\n");
146 rprintf(f, "<http://rsync.samba.org/>\n");
147 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
148 "%shard links, %ssymlinks, batchfiles, %sIPv6\n\n",
149 (int) (sizeof(OFF_T) * 8),
150 got_socketpair, hardlinks, links, ipv6);
153 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
158 void usage(enum logcode F)
160 print_rsync_version(F);
162 rprintf(F,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
164 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
165 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
166 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
167 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
168 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
169 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
170 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
171 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
172 rprintf(F," sources separated by space as long as they have same top-level\n");
173 rprintf(F,"\nOptions\n");
174 rprintf(F," -v, --verbose increase verbosity\n");
175 rprintf(F," -q, --quiet decrease verbosity\n");
176 rprintf(F," -c, --checksum always checksum\n");
177 rprintf(F," -a, --archive archive mode\n");
178 rprintf(F," -r, --recursive recurse into directories\n");
179 rprintf(F," -R, --relative use relative path names\n");
180 rprintf(F," -b, --backup make backups (default %s suffix)\n",BACKUP_SUFFIX);
181 rprintf(F," --backup-dir make backups into this directory\n");
182 rprintf(F," --suffix=SUFFIX override backup suffix\n");
183 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
184 rprintf(F," -l, --links copy symlinks as symlinks\n");
185 rprintf(F," -L, --copy-links copy the referent of symlinks\n");
186 rprintf(F," --copy-unsafe-links copy links outside the source tree\n");
187 rprintf(F," --safe-links ignore links outside the destination tree\n");
188 rprintf(F," -H, --hard-links preserve hard links\n");
189 rprintf(F," -p, --perms preserve permissions\n");
190 rprintf(F," -o, --owner preserve owner (root only)\n");
191 rprintf(F," -g, --group preserve group\n");
192 rprintf(F," -D, --devices preserve devices (root only)\n");
193 rprintf(F," -t, --times preserve times\n");
194 rprintf(F," -S, --sparse handle sparse files efficiently\n");
195 rprintf(F," -n, --dry-run show what would have been transferred\n");
196 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
197 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
198 rprintf(F," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE);
199 rprintf(F," -e, --rsh=COMMAND specify rsh replacement\n");
200 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
201 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
202 rprintf(F," --existing only update files that already exist\n");
203 rprintf(F," --delete delete files that don't exist on the sending side\n");
204 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
205 rprintf(F," --delete-after delete after transferring, not before\n");
206 rprintf(F," --ignore-errors delete even if there are IO errors\n");
207 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
208 rprintf(F," --partial keep partially transferred files\n");
209 rprintf(F," --force force deletion of directories even if not empty\n");
210 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
211 rprintf(F," --timeout=TIME set IO timeout in seconds\n");
212 rprintf(F," -I, --ignore-times don't exclude files that match length and time\n");
213 rprintf(F," --size-only only use file size when determining if a file should be transferred\n");
214 rprintf(F," --modify-window=NUM Timestamp window (seconds) for file match (default=%d)\n",modify_window);
215 rprintf(F," -T --temp-dir=DIR create temporary files in directory DIR\n");
216 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
217 rprintf(F," -P equivalent to --partial --progress\n");
218 rprintf(F," -z, --compress compress file data\n");
219 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
220 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
221 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
222 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
223 rprintf(F," --version print version number\n");
224 rprintf(F," --daemon run as a rsync daemon\n");
225 rprintf(F," --no-detach do not detach from the parent\n");
226 rprintf(F," --address=ADDRESS bind to the specified address\n");
227 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
228 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
229 rprintf(F," --blocking-io use blocking IO for the remote shell\n");
230 rprintf(F," --stats give some file transfer stats\n");
231 rprintf(F," --progress show progress during transfer\n");
232 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
233 rprintf(F," --password-file=FILE get password from FILE\n");
234 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
235 rprintf(F," -f --read-batch=EXT read batch file\n");
236 rprintf(F," -F --write-batch write batch file\n");
237 rprintf(F," -h, --help show this help screen\n");
239 rprintf(F," -4 prefer IPv4\n");
240 rprintf(F," -6 prefer IPv6\n");
245 rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
246 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
249 enum {OPT_VERSION = 1000, OPT_SUFFIX, OPT_SENDER, OPT_SERVER, OPT_EXCLUDE,
250 OPT_EXCLUDE_FROM, OPT_DELETE, OPT_DELETE_EXCLUDED, OPT_NUMERIC_IDS,
251 OPT_RSYNC_PATH, OPT_FORCE, OPT_TIMEOUT, OPT_DAEMON, OPT_CONFIG, OPT_PORT,
252 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_STATS, OPT_PARTIAL, OPT_PROGRESS,
253 OPT_COPY_UNSAFE_LINKS, OPT_SAFE_LINKS, OPT_COMPARE_DEST,
254 OPT_LOG_FORMAT, OPT_PASSWORD_FILE, OPT_SIZE_ONLY, OPT_ADDRESS,
255 OPT_DELETE_AFTER, OPT_EXISTING, OPT_MAX_DELETE, OPT_BACKUP_DIR,
256 OPT_IGNORE_ERRORS, OPT_BWLIMIT, OPT_BLOCKING_IO,
259 static struct poptOption long_options[] = {
260 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
261 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION},
262 {"suffix", 0, POPT_ARG_STRING, &backup_suffix},
263 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path},
264 {"password-file", 0, POPT_ARG_STRING, &password_file},
265 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times},
266 {"size-only", 0, POPT_ARG_NONE, &size_only},
267 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW},
268 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system},
269 {"delete", 0, POPT_ARG_NONE, &delete_mode},
270 {"existing", 0, POPT_ARG_NONE, &only_existing},
271 {"delete-after", 0, POPT_ARG_NONE, &delete_after},
272 {"delete-excluded", 0, POPT_ARG_NONE, 0, OPT_DELETE_EXCLUDED},
273 {"force", 0, POPT_ARG_NONE, &force_delete},
274 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids},
275 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE},
276 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE},
277 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM},
278 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM},
279 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks},
280 {"help", 'h', POPT_ARG_NONE, 0, 'h'},
281 {"backup", 'b', POPT_ARG_NONE, &make_backups},
282 {"dry-run", 'n', POPT_ARG_NONE, &dry_run},
283 {"sparse", 'S', POPT_ARG_NONE, &sparse_files},
284 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude},
285 {"update", 'u', POPT_ARG_NONE, &update_only},
286 {"links", 'l', POPT_ARG_NONE, &preserve_links},
287 {"copy-links", 'L', POPT_ARG_NONE, ©_links},
288 {"whole", 'W', POPT_ARG_NONE, &whole_file},
289 {"copy-unsafe-links", 0, POPT_ARG_NONE, ©_unsafe_links},
290 {"perms", 'p', POPT_ARG_NONE, &preserve_perms},
291 {"owner", 'o', POPT_ARG_NONE, &preserve_uid},
292 {"group", 'g', POPT_ARG_NONE, &preserve_gid},
293 {"devices", 'D', POPT_ARG_NONE, &preserve_devices},
294 {"times", 't', POPT_ARG_NONE, &preserve_times},
295 {"checksum", 'c', POPT_ARG_NONE, &always_checksum},
296 {"verbose", 'v', POPT_ARG_NONE, 0, 'v'},
297 {"quiet", 'q', POPT_ARG_NONE, 0, 'q'},
298 {"archive", 'a', POPT_ARG_NONE, 0, 'a'},
299 {"server", 0, POPT_ARG_NONE, &am_server},
300 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER},
301 {"recursive", 'r', POPT_ARG_NONE, &recurse},
302 {"relative", 'R', POPT_ARG_NONE, &relative_paths},
303 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd},
304 {"block-size", 'B', POPT_ARG_INT, &block_size},
305 {"max-delete", 0, POPT_ARG_INT, &max_delete},
306 {"timeout", 0, POPT_ARG_INT, &io_timeout},
307 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir},
308 {"compare-dest", 0, POPT_ARG_STRING, &compare_dest},
309 /* TODO: Should this take an optional int giving the compression level? */
310 {"compress", 'z', POPT_ARG_NONE, &do_compression},
311 {"daemon", 0, POPT_ARG_NONE, &am_daemon},
312 {"no-detach", 0, POPT_ARG_NONE, &no_detach},
313 {"stats", 0, POPT_ARG_NONE, &do_stats},
314 {"progress", 0, POPT_ARG_NONE, &do_progress},
315 {"partial", 0, POPT_ARG_NONE, &keep_partial},
316 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors},
317 {"blocking-io", 0, POPT_ARG_NONE, &blocking_io},
318 {0, 'P', POPT_ARG_NONE, 0, 'P'},
319 {"config", 0, POPT_ARG_STRING, &config_file},
320 {"port", 0, POPT_ARG_INT, &rsync_port},
321 {"log-format", 0, POPT_ARG_STRING, &log_format},
322 {"bwlimit", 0, POPT_ARG_INT, &bwlimit},
323 {"address", 0, POPT_ARG_STRING, &bind_address, 0},
324 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir},
325 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links},
326 {"read-batch", 'f', POPT_ARG_STRING, &batch_ext, 'f'},
327 {"write-batch", 'F', POPT_ARG_NONE, &write_batch, 0},
329 {0, '4', POPT_ARG_VAL, &default_af_hint, AF_INET },
330 {0, '6', POPT_ARG_VAL, &default_af_hint, AF_INET6 },
336 static char err_buf[100];
339 /* We store the option error message, if any, so that we can log the
340 connection attempt (which requires parsing the options), and then
341 show the error later on. */
342 void option_error(void)
345 rprintf(FLOG, "%s", err_buf);
346 rprintf(FERROR, "%s: %s", RSYNC_NAME, err_buf);
348 rprintf (FERROR, "Error parsing options: "
349 "option may be supported on client but not on server?\n");
350 rprintf (FERROR, RSYNC_NAME ": Error parsing options: "
351 "option may be supported on client but not on server?\n");
355 /* check to see if we should refuse this option */
356 static int check_refuse_options(char *ref, int opt)
362 for (i=0; long_options[i].longName; i++) {
363 if (long_options[i].val == opt) break;
366 if (!long_options[i].longName) return 0;
368 name = long_options[i].longName;
371 while ((p = strstr(ref,name))) {
372 if ((p==ref || p[-1]==' ') &&
373 (p[len] == ' ' || p[len] == 0)) {
374 snprintf(err_buf,sizeof(err_buf),
375 "The '%s' option is not supported by this server\n", name);
384 static int count_args(char const **argv)
388 while (argv[i] != NULL)
395 /* Process command line arguments. Called on both local and remote.
396 * Returns if all options are OK, otherwise fills in err_buf and
398 int parse_arguments(int *argc, const char ***argv, int frommain)
401 char *ref = lp_refuse_options(module_id);
404 /* TODO: Call poptReadDefaultConfig; handle errors. */
406 /* The context leaks in case of an error, but if there's a
407 * problem we always exit anyhow. */
408 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
410 while ((opt = poptGetNextOpt(pc)) != -1) {
412 if (check_refuse_options(ref, opt)) return 0;
415 /* most options are handled automatically by popt;
416 * only special cases are returned and listed here. */
420 print_rsync_version(FINFO);
423 case OPT_MODIFY_WINDOW:
424 /* The value has already been set by popt, but
425 * we need to remember that we're using a
426 * non-default setting. */
427 modify_window_set = 1;
430 case OPT_DELETE_EXCLUDED:
436 add_exclude(poptGetOptArg(pc), 0);
440 add_exclude(poptGetOptArg(pc), 1);
443 case OPT_EXCLUDE_FROM:
444 add_exclude_file(poptGetOptArg(pc), 1, 0);
447 case OPT_INCLUDE_FROM:
448 add_exclude_file(poptGetOptArg(pc), 1, 1);
456 #if SUPPORT_HARD_LINKS
457 preserve_hard_links=1;
459 /* FIXME: Don't say "server" if this is
460 * happening on the client. */
461 /* FIXME: Why do we have the duplicated
462 * rprintf? Everybody who gets this message
463 * ought to send it to the client and also to
465 snprintf(err_buf,sizeof(err_buf),
466 "hard links are not supported on this %s\n",
467 am_server ? "server" : "client");
468 rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
470 #endif /* SUPPORT_HARD_LINKS */
478 if (frommain) quiet++;
496 exit_cleanup(RERR_SYNTAX);
508 /* The filename is stored for us by popt */
513 /* FIXME: If --daemon is specified, then errors for later
514 * parameters seem to disappear. */
515 snprintf(err_buf, sizeof(err_buf),
517 am_server ? "on remote machine: " : "",
518 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
524 *argv = poptGetArgs(pc);
526 *argc = count_args(*argv);
534 /* Construct a filtered list of options to pass through from the
535 * client to the server */
536 void server_options(char **args,int *argc)
539 static char argstr[50];
540 static char bsize[30];
541 static char iotime[30];
542 static char mdelete[30];
543 static char mwindow[30];
545 static char fext[20]; /* dw */
549 args[ac++] = "--server";
552 args[ac++] = "--sender";
556 for (i=0;i<verbose;i++)
559 /* the -q option is intentionally left out */
572 if (preserve_hard_links)
578 if (preserve_devices)
601 argstr[x++] = 'F'; /* dw */
603 /* this is a complete hack - blame Rusty
605 this is a hack to make the list_only (remote file list)
607 if (list_only && !recurse)
612 if (x != 1) args[ac++] = argstr;
614 if (block_size != BLOCK_SIZE) {
615 snprintf(bsize,sizeof(bsize),"-B%d",block_size);
619 if (max_delete && am_sender) {
620 snprintf(mdelete,sizeof(mdelete),"--max-delete=%d",max_delete);
621 args[ac++] = mdelete;
624 if (batch_ext != NULL) {
625 sprintf(fext,"-f%s",batch_ext);
630 snprintf(iotime,sizeof(iotime),"--timeout=%d",io_timeout);
635 snprintf(bw,sizeof(bw),"--bwlimit=%d",bwlimit);
639 if (strcmp(backup_suffix, BACKUP_SUFFIX)) {
640 args[ac++] = "--suffix";
641 args[ac++] = backup_suffix;
644 if (delete_mode && !delete_excluded)
645 args[ac++] = "--delete";
648 args[ac++] = "--delete-excluded";
651 args[ac++] = "--size-only";
653 if (modify_window_set) {
654 snprintf(mwindow,sizeof(mwindow),"--modify-window=%d",
656 args[ac++] = mwindow;
660 args[ac++] = "--partial";
663 args[ac++] = "--force";
666 args[ac++] = "--delete-after";
669 args[ac++] = "--ignore-errors";
671 if (copy_unsafe_links)
672 args[ac++] = "--copy-unsafe-links";
675 args[ac++] = "--safe-links";
678 args[ac++] = "--numeric-ids";
680 if (only_existing && am_sender)
681 args[ac++] = "--existing";
684 args[ac++] = "--temp-dir";
688 if (backup_dir && am_sender) {
689 /* only the receiver needs this option, if we are the sender
690 * then we need to send it to the receiver.
692 args[ac++] = "--backup-dir";
693 args[ac++] = backup_dir;
696 if (compare_dest && am_sender) {
697 /* the server only needs this option if it is not the sender,
698 * and it may be an older version that doesn't know this
699 * option, so don't send it if client is the sender.
701 args[ac++] = "--compare-dest";
702 args[ac++] = compare_dest;