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 /** Global options set from command line. **/
78 struct global_opts global_opts
;
80 int read_batch
=0; /* dw */
81 int write_batch
=0; /* dw */
83 char *backup_suffix
= BACKUP_SUFFIX
;
85 char *compare_dest
= NULL
;
86 char *config_file
= RSYNCD_CONF
;
87 char *shell_cmd
= NULL
;
88 char *log_format
= NULL
;
89 char *password_file
= NULL
;
90 char *rsync_path
= RSYNC_PATH
;
91 char *backup_dir
= NULL
;
92 int rsync_port
= RSYNC_PORT
;
96 int always_checksum
= 0;
99 char *batch_ext
= NULL
;
101 static int modify_window_set
;
103 /** Local address to bind. As a character string because it's
104 * interpreted by the IPv6 layer: should be a numeric IP4 or ip6
105 * address, or a hostname. **/
109 static void print_rsync_version(enum logcode f
)
111 char const *got_socketpair
= "no ";
112 char const *hardlinks
= "no ";
113 char const *links
= "no ";
114 char const *ipv6
= "no ";
116 #ifdef HAVE_SOCKETPAIR
120 #if SUPPORT_HARD_LINKS
132 rprintf(f
, "%s version %s protocol version %d\n",
133 RSYNC_NAME
, RSYNC_VERSION
, PROTOCOL_VERSION
);
135 "Copyright (C) 1996-2001 by Andrew Tridgell and others\n");
136 rprintf(f
, "<http://rsync.samba.org/>\n");
137 rprintf(f
, "Capabilities: %d-bit files, %ssocketpairs, "
138 "%shard links, %ssymlinks, batchfiles, %sIPv6\n\n",
139 (int) (sizeof(OFF_T
) * 8),
140 got_socketpair
, hardlinks
, links
, ipv6
);
143 rprintf(f
, "WARNING: no 64-bit integers on this platform!\n");
148 void usage(enum logcode F
)
150 print_rsync_version(F
);
152 rprintf(F
,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
154 rprintf(F
,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
155 rprintf(F
," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
156 rprintf(F
," or rsync [OPTION]... SRC [SRC]... DEST\n");
157 rprintf(F
," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
158 rprintf(F
," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
159 rprintf(F
," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
160 rprintf(F
,"SRC on single-colon remote HOST will be expanded by remote shell\n");
161 rprintf(F
,"SRC on server remote HOST may contain shell wildcards or multiple\n");
162 rprintf(F
," sources separated by space as long as they have same top-level\n");
163 rprintf(F
,"\nOptions\n");
164 rprintf(F
," -v, --verbose increase verbosity\n");
165 rprintf(F
," -q, --quiet decrease verbosity\n");
166 rprintf(F
," -c, --checksum always checksum\n");
167 rprintf(F
," -a, --archive archive mode\n");
168 rprintf(F
," -r, --recursive recurse into directories\n");
169 rprintf(F
," -R, --relative use relative path names\n");
170 rprintf(F
," -b, --backup make backups (default %s suffix)\n",BACKUP_SUFFIX
);
171 rprintf(F
," --backup-dir make backups into this directory\n");
172 rprintf(F
," --suffix=SUFFIX override backup suffix\n");
173 rprintf(F
," -u, --update update only (don't overwrite newer files)\n");
174 rprintf(F
," -l, --links preserve soft links\n");
175 rprintf(F
," -L, --copy-links treat soft links like regular files\n");
176 rprintf(F
," --copy-unsafe-links copy links outside the source tree\n");
177 rprintf(F
," --safe-links ignore links outside the destination tree\n");
178 rprintf(F
," -H, --hard-links preserve hard links\n");
179 rprintf(F
," -p, --perms preserve permissions\n");
180 rprintf(F
," -o, --owner preserve owner (root only)\n");
181 rprintf(F
," -g, --group preserve group\n");
182 rprintf(F
," -D, --devices preserve devices (root only)\n");
183 rprintf(F
," -t, --times preserve times\n");
184 rprintf(F
," -S, --sparse handle sparse files efficiently\n");
185 rprintf(F
," -n, --dry-run show what would have been transferred\n");
186 rprintf(F
," -W, --whole-file copy whole files, no incremental checks\n");
187 rprintf(F
," -x, --one-file-system don't cross filesystem boundaries\n");
188 rprintf(F
," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE
);
189 rprintf(F
," -e, --rsh=COMMAND specify rsh replacement\n");
190 rprintf(F
," --rsync-path=PATH specify path to rsync on the remote machine\n");
191 rprintf(F
," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
192 rprintf(F
," --existing only update files that already exist\n");
193 rprintf(F
," --delete delete files that don't exist on the sending side\n");
194 rprintf(F
," --delete-excluded also delete excluded files on the receiving side\n");
195 rprintf(F
," --delete-after delete after transferring, not before\n");
196 rprintf(F
," --ignore-errors delete even if there are IO errors\n");
197 rprintf(F
," --max-delete=NUM don't delete more than NUM files\n");
198 rprintf(F
," --partial keep partially transferred files\n");
199 rprintf(F
," --force force deletion of directories even if not empty\n");
200 rprintf(F
," --numeric-ids don't map uid/gid values by user/group name\n");
201 rprintf(F
," --timeout=TIME set IO timeout in seconds\n");
202 rprintf(F
," -I, --ignore-times don't exclude files that match length and time\n");
203 rprintf(F
," --size-only only use file size when determining if a file should be transferred\n");
204 rprintf(F
," --modify-window=NUM Timestamp window (seconds) for file match (default=%d)\n",modify_window
);
205 rprintf(F
," -T --temp-dir=DIR create temporary files in directory DIR\n");
206 rprintf(F
," --compare-dest=DIR also compare destination files relative to DIR\n");
207 rprintf(F
," -P equivalent to --partial --progress\n");
208 rprintf(F
," -z, --compress compress file data\n");
209 rprintf(F
," --exclude=PATTERN exclude files matching PATTERN\n");
210 rprintf(F
," --exclude-from=FILE exclude patterns listed in FILE\n");
211 rprintf(F
," --include=PATTERN don't exclude files matching PATTERN\n");
212 rprintf(F
," --include-from=FILE don't exclude patterns listed in FILE\n");
213 rprintf(F
," --version print version number\n");
214 rprintf(F
," --daemon run as a rsync daemon\n");
215 rprintf(F
," --no-detach do not detach from the parent\n");
216 rprintf(F
," --address=ADDRESS bind to the specified address\n");
217 rprintf(F
," --config=FILE specify alternate rsyncd.conf file\n");
218 rprintf(F
," --port=PORT specify alternate rsyncd port number\n");
219 rprintf(F
," --blocking-io use blocking IO for the remote shell\n");
220 rprintf(F
," --stats give some file transfer stats\n");
221 rprintf(F
," --progress show progress during transfer\n");
222 rprintf(F
," --log-format=FORMAT log file transfers using specified format\n");
223 rprintf(F
," --password-file=FILE get password from FILE\n");
224 rprintf(F
," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
225 rprintf(F
," -f --read-batch=EXT read batch file\n");
226 rprintf(F
," -F --write-batch write batch file\n");
227 rprintf(F
," -h, --help show this help screen\n");
229 rprintf(F
," -4 prefer IPv4\n");
230 rprintf(F
," -6 prefer IPv6\n");
235 rprintf(F
,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
236 rprintf(F
,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
239 enum {OPT_VERSION
= 1000, OPT_SUFFIX
, OPT_SENDER
, OPT_SERVER
, OPT_EXCLUDE
,
240 OPT_EXCLUDE_FROM
, OPT_DELETE
, OPT_DELETE_EXCLUDED
, OPT_NUMERIC_IDS
,
241 OPT_RSYNC_PATH
, OPT_FORCE
, OPT_TIMEOUT
, OPT_DAEMON
, OPT_CONFIG
, OPT_PORT
,
242 OPT_INCLUDE
, OPT_INCLUDE_FROM
, OPT_STATS
, OPT_PARTIAL
, OPT_PROGRESS
,
243 OPT_COPY_UNSAFE_LINKS
, OPT_SAFE_LINKS
, OPT_COMPARE_DEST
,
244 OPT_LOG_FORMAT
, OPT_PASSWORD_FILE
, OPT_SIZE_ONLY
, OPT_ADDRESS
,
245 OPT_DELETE_AFTER
, OPT_EXISTING
, OPT_MAX_DELETE
, OPT_BACKUP_DIR
,
246 OPT_IGNORE_ERRORS
, OPT_BWLIMIT
, OPT_BLOCKING_IO
,
249 static struct poptOption long_options
[] = {
250 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
251 {"version", 0, POPT_ARG_NONE
, 0, OPT_VERSION
},
252 {"suffix", 0, POPT_ARG_STRING
, &backup_suffix
},
253 {"rsync-path", 0, POPT_ARG_STRING
, &rsync_path
},
254 {"password-file", 0, POPT_ARG_STRING
, &password_file
},
255 {"ignore-times", 'I', POPT_ARG_NONE
, &ignore_times
},
256 {"size-only", 0, POPT_ARG_NONE
, &size_only
},
257 {"modify-window", 0, POPT_ARG_INT
, &modify_window
, OPT_MODIFY_WINDOW
},
258 {"one-file-system", 'x', POPT_ARG_NONE
, &one_file_system
},
259 {"delete", 0, POPT_ARG_NONE
, &delete_mode
},
260 {"existing", 0, POPT_ARG_NONE
, &only_existing
},
261 {"delete-after", 0, POPT_ARG_NONE
, &delete_after
},
262 {"delete-excluded", 0, POPT_ARG_NONE
, 0, OPT_DELETE_EXCLUDED
},
263 {"force", 0, POPT_ARG_NONE
, &force_delete
},
264 {"numeric-ids", 0, POPT_ARG_NONE
, &numeric_ids
},
265 {"exclude", 0, POPT_ARG_STRING
, 0, OPT_EXCLUDE
},
266 {"include", 0, POPT_ARG_STRING
, 0, OPT_INCLUDE
},
267 {"exclude-from", 0, POPT_ARG_STRING
, 0, OPT_EXCLUDE_FROM
},
268 {"include-from", 0, POPT_ARG_STRING
, 0, OPT_INCLUDE_FROM
},
269 {"safe-links", 0, POPT_ARG_NONE
, &safe_symlinks
},
270 {"help", 'h', POPT_ARG_NONE
, 0, 'h'},
271 {"backup", 'b', POPT_ARG_NONE
, &make_backups
},
272 {"dry-run", 'n', POPT_ARG_NONE
, &dry_run
},
273 {"sparse", 'S', POPT_ARG_NONE
, &sparse_files
},
274 {"cvs-exclude", 'C', POPT_ARG_NONE
, &cvs_exclude
},
275 {"update", 'u', POPT_ARG_NONE
, &update_only
},
276 {"links", 'l', POPT_ARG_NONE
, &preserve_links
},
277 {"copy-links", 'L', POPT_ARG_NONE
, ©_links
},
278 {"whole", 'W', POPT_ARG_NONE
, &whole_file
},
279 {"copy-unsafe-links", 0, POPT_ARG_NONE
, ©_unsafe_links
},
280 {"perms", 'p', POPT_ARG_NONE
, &preserve_perms
},
281 {"owner", 'o', POPT_ARG_NONE
, &preserve_uid
},
282 {"group", 'g', POPT_ARG_NONE
, &preserve_gid
},
283 {"devices", 'D', POPT_ARG_NONE
, &preserve_devices
},
284 {"times", 't', POPT_ARG_NONE
, &preserve_times
},
285 {"checksum", 'c', POPT_ARG_NONE
, &always_checksum
},
286 {"verbose", 'v', POPT_ARG_NONE
, 0, 'v'},
287 {"quiet", 'q', POPT_ARG_NONE
, 0, 'q'},
288 {"archive", 'a', POPT_ARG_NONE
, 0, 'a'},
289 {"server", 0, POPT_ARG_NONE
, &am_server
},
290 {"sender", 0, POPT_ARG_NONE
, 0, OPT_SENDER
},
291 {"recursive", 'r', POPT_ARG_NONE
, &recurse
},
292 {"relative", 'R', POPT_ARG_NONE
, &relative_paths
},
293 {"rsh", 'e', POPT_ARG_STRING
, &shell_cmd
},
294 {"block-size", 'B', POPT_ARG_INT
, &block_size
},
295 {"max-delete", 0, POPT_ARG_INT
, &max_delete
},
296 {"timeout", 0, POPT_ARG_INT
, &io_timeout
},
297 {"temp-dir", 'T', POPT_ARG_STRING
, &tmpdir
},
298 {"compare-dest", 0, POPT_ARG_STRING
, &compare_dest
},
299 /* TODO: Should this take an optional int giving the compression level? */
300 {"compress", 'z', POPT_ARG_NONE
, &do_compression
},
301 {"daemon", 0, POPT_ARG_NONE
, &am_daemon
},
302 {"no-detach", 0, POPT_ARG_NONE
, &global_opts
.no_detach
},
303 {"stats", 0, POPT_ARG_NONE
, &do_stats
},
304 {"progress", 0, POPT_ARG_NONE
, &do_progress
},
305 {"partial", 0, POPT_ARG_NONE
, &keep_partial
},
306 {"ignore-errors", 0, POPT_ARG_NONE
, &ignore_errors
},
307 {"blocking-io", 0, POPT_ARG_NONE
, &blocking_io
},
308 {0, 'P', POPT_ARG_NONE
, 0, 'P'},
309 {"config", 0, POPT_ARG_STRING
, &config_file
},
310 {"port", 0, POPT_ARG_INT
, &rsync_port
},
311 {"log-format", 0, POPT_ARG_STRING
, &log_format
},
312 {"bwlimit", 0, POPT_ARG_INT
, &bwlimit
},
313 {"address", 0, POPT_ARG_STRING
, &bind_address
, 0},
314 {"backup-dir", 0, POPT_ARG_STRING
, &backup_dir
},
315 {"hard-links", 'H', POPT_ARG_NONE
, &preserve_hard_links
},
316 {"read-batch", 'f', POPT_ARG_STRING
, &batch_ext
, 'f'},
317 {"write-batch", 'F', POPT_ARG_NONE
, &write_batch
, 0},
319 {0, '4', POPT_ARG_VAL
, &global_opts
.af_hint
, AF_INET
},
320 {0, '6', POPT_ARG_VAL
, &global_opts
.af_hint
, AF_INET6
},
326 static char err_buf
[100];
329 /* We store the option error message, if any, so that we can log the
330 connection attempt (which requires parsing the options), and then
331 show the error later on. */
332 void option_error(void)
335 rprintf(FLOG
, "%s", err_buf
);
336 rprintf(FERROR
, "%s: %s", RSYNC_NAME
, err_buf
);
338 rprintf (FERROR
, "Error parsing options: "
339 "option may be supported on client but not on server?\n");
340 rprintf (FERROR
, RSYNC_NAME
": Error parsing options: "
341 "option may be supported on client but not on server?\n");
345 /* check to see if we should refuse this option */
346 static int check_refuse_options(char *ref
, int opt
)
352 for (i
=0; long_options
[i
].longName
; i
++) {
353 if (long_options
[i
].val
== opt
) break;
356 if (!long_options
[i
].longName
) return 0;
358 name
= long_options
[i
].longName
;
361 while ((p
= strstr(ref
,name
))) {
362 if ((p
==ref
|| p
[-1]==' ') &&
363 (p
[len
] == ' ' || p
[len
] == 0)) {
364 snprintf(err_buf
,sizeof(err_buf
),
365 "The '%s' option is not supported by this server\n", name
);
374 static int count_args(char const **argv
)
378 while (argv
[i
] != NULL
)
385 /* Process command line arguments. Called on both local and remote.
386 * Returns if all options are OK, otherwise fills in err_buf and
388 int parse_arguments(int *argc
, const char ***argv
, int frommain
)
391 char *ref
= lp_refuse_options(module_id
);
394 /* TODO: Call poptReadDefaultConfig; handle errors. */
396 /* The context leaks in case of an error, but if there's a
397 * problem we always exit anyhow. */
398 pc
= poptGetContext(RSYNC_NAME
, *argc
, *argv
, long_options
, 0);
400 while ((opt
= poptGetNextOpt(pc
)) != -1) {
402 if (check_refuse_options(ref
, opt
)) return 0;
405 /* most options are handled automatically by popt;
406 * only special cases are returned and listed here. */
410 print_rsync_version(FINFO
);
413 case OPT_MODIFY_WINDOW
:
414 /* The value has already been set by popt, but
415 * we need to remember that we're using a
416 * non-default setting. */
417 modify_window_set
= 1;
420 case OPT_DELETE_EXCLUDED
:
426 add_exclude(poptGetOptArg(pc
), 0);
430 add_exclude(poptGetOptArg(pc
), 1);
433 case OPT_EXCLUDE_FROM
:
434 add_exclude_file(poptGetOptArg(pc
), 1, 0);
437 case OPT_INCLUDE_FROM
:
438 add_exclude_file(poptGetOptArg(pc
), 1, 1);
446 #if SUPPORT_HARD_LINKS
447 preserve_hard_links
=1;
449 /* FIXME: Don't say "server" if this is
450 * happening on the client. */
451 /* FIXME: Why do we have the duplicated
452 * rprintf? Everybody who gets this message
453 * ought to send it to the client and also to
455 snprintf(err_buf
,sizeof(err_buf
),
456 "hard links are not supported on this %s\n",
457 am_server
? "server" : "client");
458 rprintf(FERROR
,"ERROR: hard links not supported on this platform\n");
460 #endif /* SUPPORT_HARD_LINKS */
468 if (frommain
) quiet
++;
486 exit_cleanup(RERR_SYNTAX
);
498 /* The filename is stored for us by popt */
503 /* FIXME: If --daemon is specified, then errors for later
504 * parameters seem to disappear. */
505 snprintf(err_buf
, sizeof(err_buf
),
507 am_server
? "on remote machine: " : "",
508 poptBadOption(pc
, POPT_BADOPTION_NOALIAS
),
514 *argv
= poptGetArgs(pc
);
516 *argc
= count_args(*argv
);
524 /* Construct a filtered list of options to pass through from the
525 * client to the server */
526 void server_options(char **args
,int *argc
)
529 static char argstr
[50];
530 static char bsize
[30];
531 static char iotime
[30];
532 static char mdelete
[30];
533 static char mwindow
[30];
535 static char fext
[20]; /* dw */
539 args
[ac
++] = "--server";
542 args
[ac
++] = "--sender";
546 for (i
=0;i
<verbose
;i
++)
549 /* the -q option is intentionally left out */
562 if (preserve_hard_links
)
568 if (preserve_devices
)
591 argstr
[x
++] = 'F'; /* dw */
593 /* this is a complete hack - blame Rusty
595 this is a hack to make the list_only (remote file list)
597 if (list_only
&& !recurse
)
602 if (x
!= 1) args
[ac
++] = argstr
;
604 if (block_size
!= BLOCK_SIZE
) {
605 snprintf(bsize
,sizeof(bsize
),"-B%d",block_size
);
609 if (max_delete
&& am_sender
) {
610 snprintf(mdelete
,sizeof(mdelete
),"--max-delete=%d",max_delete
);
611 args
[ac
++] = mdelete
;
614 if (batch_ext
!= NULL
) {
615 sprintf(fext
,"-f%s",batch_ext
);
620 snprintf(iotime
,sizeof(iotime
),"--timeout=%d",io_timeout
);
625 snprintf(bw
,sizeof(bw
),"--bwlimit=%d",bwlimit
);
629 if (strcmp(backup_suffix
, BACKUP_SUFFIX
)) {
630 args
[ac
++] = "--suffix";
631 args
[ac
++] = backup_suffix
;
634 if (delete_mode
&& !delete_excluded
)
635 args
[ac
++] = "--delete";
638 args
[ac
++] = "--delete-excluded";
641 args
[ac
++] = "--size-only";
643 if (modify_window_set
) {
644 snprintf(mwindow
,sizeof(mwindow
),"--modify-window=%d",
646 args
[ac
++] = mwindow
;
650 args
[ac
++] = "--partial";
653 args
[ac
++] = "--force";
656 args
[ac
++] = "--delete-after";
659 args
[ac
++] = "--ignore-errors";
661 if (copy_unsafe_links
)
662 args
[ac
++] = "--copy-unsafe-links";
665 args
[ac
++] = "--safe-links";
668 args
[ac
++] = "--numeric-ids";
670 if (only_existing
&& am_sender
)
671 args
[ac
++] = "--existing";
674 args
[ac
++] = "--temp-dir";
678 if (backup_dir
&& am_sender
) {
679 /* only the receiver needs this option, if we are the sender
680 * then we need to send it to the receiver.
682 args
[ac
++] = "--backup-dir";
683 args
[ac
++] = backup_dir
;
686 if (compare_dest
&& am_sender
) {
687 /* the server only needs this option if it is not the sender,
688 * and it may be an older version that doesn't know this
689 * option, so don't send it if client is the sender.
691 args
[ac
++] = "--compare-dest";
692 args
[ac
++] = compare_dest
;