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. **/
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(int f
)
111 char const *got_socketpair
= "no ";
112 char const *hardlinks
= "no ";
113 char const *links
= "no ";
115 #ifdef HAVE_SOCKETPAIR
119 #if SUPPORT_HARD_LINKS
127 rprintf(f
, "%s version %s protocol version %d\n",
128 RSYNC_NAME
, VERSION
, PROTOCOL_VERSION
);
130 "Copyright (C) 1996-2001 by Andrew Tridgell and others\n");
131 rprintf(f
, "<http://rsync.samba.org/>\n");
132 rprintf(f
, "Capabilities: %d-bit files, %ssocketpairs, "
133 "%shard links, %ssymlinks, batchfiles\n\n",
134 (int) (sizeof(OFF_T
) * 8),
139 rprintf(f
, "WARNING: no 64-bit integers on this platform!\n");
144 void usage(enum logcode F
)
146 print_rsync_version(F
);
148 rprintf(F
,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
150 rprintf(F
,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
151 rprintf(F
," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
152 rprintf(F
," or rsync [OPTION]... SRC [SRC]... DEST\n");
153 rprintf(F
," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
154 rprintf(F
," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
155 rprintf(F
," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
156 rprintf(F
,"SRC on single-colon remote HOST will be expanded by remote shell\n");
157 rprintf(F
,"SRC on server remote HOST may contain shell wildcards or multiple\n");
158 rprintf(F
," sources separated by space as long as they have same top-level\n");
159 rprintf(F
,"\nOptions\n");
160 rprintf(F
," -v, --verbose increase verbosity\n");
161 rprintf(F
," -q, --quiet decrease verbosity\n");
162 rprintf(F
," -c, --checksum always checksum\n");
163 rprintf(F
," -a, --archive archive mode\n");
164 rprintf(F
," -r, --recursive recurse into directories\n");
165 rprintf(F
," -R, --relative use relative path names\n");
166 rprintf(F
," -b, --backup make backups (default %s suffix)\n",BACKUP_SUFFIX
);
167 rprintf(F
," --backup-dir make backups into this directory\n");
168 rprintf(F
," --suffix=SUFFIX override backup suffix\n");
169 rprintf(F
," -u, --update update only (don't overwrite newer files)\n");
170 rprintf(F
," -l, --links preserve soft links\n");
171 rprintf(F
," -L, --copy-links treat soft links like regular files\n");
172 rprintf(F
," --copy-unsafe-links copy links outside the source tree\n");
173 rprintf(F
," --safe-links ignore links outside the destination tree\n");
174 rprintf(F
," -H, --hard-links preserve hard links\n");
175 rprintf(F
," -p, --perms preserve permissions\n");
176 rprintf(F
," -o, --owner preserve owner (root only)\n");
177 rprintf(F
," -g, --group preserve group\n");
178 rprintf(F
," -D, --devices preserve devices (root only)\n");
179 rprintf(F
," -t, --times preserve times\n");
180 rprintf(F
," -S, --sparse handle sparse files efficiently\n");
181 rprintf(F
," -n, --dry-run show what would have been transferred\n");
182 rprintf(F
," -W, --whole-file copy whole files, no incremental checks\n");
183 rprintf(F
," -x, --one-file-system don't cross filesystem boundaries\n");
184 rprintf(F
," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE
);
185 rprintf(F
," -e, --rsh=COMMAND specify rsh replacement\n");
186 rprintf(F
," --rsync-path=PATH specify path to rsync on the remote machine\n");
187 rprintf(F
," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
188 rprintf(F
," --existing only update files that already exist\n");
189 rprintf(F
," --delete delete files that don't exist on the sending side\n");
190 rprintf(F
," --delete-excluded also delete excluded files on the receiving side\n");
191 rprintf(F
," --delete-after delete after transferring, not before\n");
192 rprintf(F
," --ignore-errors delete even if there are IO errors\n");
193 rprintf(F
," --max-delete=NUM don't delete more than NUM files\n");
194 rprintf(F
," --partial keep partially transferred files\n");
195 rprintf(F
," --force force deletion of directories even if not empty\n");
196 rprintf(F
," --numeric-ids don't map uid/gid values by user/group name\n");
197 rprintf(F
," --timeout=TIME set IO timeout in seconds\n");
198 rprintf(F
," -I, --ignore-times don't exclude files that match length and time\n");
199 rprintf(F
," --size-only only use file size when determining if a file should be transferred\n");
200 rprintf(F
," --modify-window=NUM Timestamp window (seconds) for file match (default=%d)\n",modify_window
);
201 rprintf(F
," -T --temp-dir=DIR create temporary files in directory DIR\n");
202 rprintf(F
," --compare-dest=DIR also compare destination files relative to DIR\n");
203 rprintf(F
," -P equivalent to --partial --progress\n");
204 rprintf(F
," -z, --compress compress file data\n");
205 rprintf(F
," --exclude=PATTERN exclude files matching PATTERN\n");
206 rprintf(F
," --exclude-from=FILE exclude patterns listed in FILE\n");
207 rprintf(F
," --include=PATTERN don't exclude files matching PATTERN\n");
208 rprintf(F
," --include-from=FILE don't exclude patterns listed in FILE\n");
209 rprintf(F
," --version print version number\n");
210 rprintf(F
," --daemon run as a rsync daemon\n");
211 rprintf(F
," --address bind to the specified address\n");
212 rprintf(F
," --config=FILE specify alternate rsyncd.conf file\n");
213 rprintf(F
," --port=PORT specify alternate rsyncd port number\n");
214 rprintf(F
," --blocking-io use blocking IO for the remote shell\n");
215 rprintf(F
," --stats give some file transfer stats\n");
216 rprintf(F
," --progress show progress during transfer\n");
217 rprintf(F
," --log-format=FORMAT log file transfers using specified format\n");
218 rprintf(F
," --password-file=FILE get password from FILE\n");
219 rprintf(F
," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
220 rprintf(F
," -f --read-batch=EXT read batch file\n");
221 rprintf(F
," -F --write-batch write batch file\n");
222 rprintf(F
," -h, --help show this help screen\n");
224 rprintf(F
," -4 prefer IPv4\n");
225 rprintf(F
," -6 prefer IPv6\n");
230 rprintf(F
,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
231 rprintf(F
,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
234 enum {OPT_VERSION
= 1000, OPT_SUFFIX
, OPT_SENDER
, OPT_SERVER
, OPT_EXCLUDE
,
235 OPT_EXCLUDE_FROM
, OPT_DELETE
, OPT_DELETE_EXCLUDED
, OPT_NUMERIC_IDS
,
236 OPT_RSYNC_PATH
, OPT_FORCE
, OPT_TIMEOUT
, OPT_DAEMON
, OPT_CONFIG
, OPT_PORT
,
237 OPT_INCLUDE
, OPT_INCLUDE_FROM
, OPT_STATS
, OPT_PARTIAL
, OPT_PROGRESS
,
238 OPT_COPY_UNSAFE_LINKS
, OPT_SAFE_LINKS
, OPT_COMPARE_DEST
,
239 OPT_LOG_FORMAT
, OPT_PASSWORD_FILE
, OPT_SIZE_ONLY
, OPT_ADDRESS
,
240 OPT_DELETE_AFTER
, OPT_EXISTING
, OPT_MAX_DELETE
, OPT_BACKUP_DIR
,
241 OPT_IGNORE_ERRORS
, OPT_BWLIMIT
, OPT_BLOCKING_IO
,
244 static struct poptOption long_options
[] = {
245 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
246 {"version", 0, POPT_ARG_NONE
, 0, OPT_VERSION
},
247 {"suffix", 0, POPT_ARG_STRING
, &backup_suffix
},
248 {"rsync-path", 0, POPT_ARG_STRING
, &rsync_path
},
249 {"password-file", 0, POPT_ARG_STRING
, &password_file
},
250 {"ignore-times", 'I', POPT_ARG_NONE
, &ignore_times
},
251 {"size-only", 0, POPT_ARG_NONE
, &size_only
},
252 {"modify-window", 0, POPT_ARG_INT
, &modify_window
, OPT_MODIFY_WINDOW
},
253 {"one-file-system", 'x', POPT_ARG_NONE
, &one_file_system
},
254 {"delete", 0, POPT_ARG_NONE
, &delete_mode
},
255 {"existing", 0, POPT_ARG_NONE
, &only_existing
},
256 {"delete-after", 0, POPT_ARG_NONE
, &delete_after
},
257 {"delete-excluded", 0, POPT_ARG_NONE
, 0, OPT_DELETE_EXCLUDED
},
258 {"force", 0, POPT_ARG_NONE
, &force_delete
},
259 {"numeric-ids", 0, POPT_ARG_NONE
, &numeric_ids
},
260 {"exclude", 0, POPT_ARG_STRING
, 0, OPT_EXCLUDE
},
261 {"include", 0, POPT_ARG_STRING
, 0, OPT_INCLUDE
},
262 {"exclude-from", 0, POPT_ARG_STRING
, 0, OPT_EXCLUDE_FROM
},
263 {"include-from", 0, POPT_ARG_STRING
, 0, OPT_INCLUDE_FROM
},
264 {"safe-links", 0, POPT_ARG_NONE
, &safe_symlinks
},
265 {"help", 'h', POPT_ARG_NONE
, 0, 'h'},
266 {"backup", 'b', POPT_ARG_NONE
, &make_backups
},
267 {"dry-run", 'n', POPT_ARG_NONE
, &dry_run
},
268 {"sparse", 'S', POPT_ARG_NONE
, &sparse_files
},
269 {"cvs-exclude", 'C', POPT_ARG_NONE
, &cvs_exclude
},
270 {"update", 'u', POPT_ARG_NONE
, &update_only
},
271 {"links", 'l', POPT_ARG_NONE
, &preserve_links
},
272 {"copy-links", 'L', POPT_ARG_NONE
, ©_links
},
273 {"whole", 'W', POPT_ARG_NONE
, &whole_file
},
274 {"copy-unsafe-links", 0, POPT_ARG_NONE
, ©_unsafe_links
},
275 {"perms", 'p', POPT_ARG_NONE
, &preserve_perms
},
276 {"owner", 'o', POPT_ARG_NONE
, &preserve_uid
},
277 {"group", 'g', POPT_ARG_NONE
, &preserve_gid
},
278 {"devices", 'D', POPT_ARG_NONE
, &preserve_devices
},
279 {"times", 't', POPT_ARG_NONE
, &preserve_times
},
280 {"checksum", 'c', POPT_ARG_NONE
, &always_checksum
},
281 {"verbose", 'v', POPT_ARG_NONE
, 0, 'v'},
282 {"quiet", 'q', POPT_ARG_NONE
, 0, 'q'},
283 {"archive", 'a', POPT_ARG_NONE
, 0, 'a'},
284 {"server", 0, POPT_ARG_NONE
, &am_server
},
285 {"sender", 0, POPT_ARG_NONE
, 0, OPT_SENDER
},
286 {"recursive", 'r', POPT_ARG_NONE
, &recurse
},
287 {"relative", 'R', POPT_ARG_NONE
, &relative_paths
},
288 {"rsh", 'e', POPT_ARG_STRING
, &shell_cmd
},
289 {"block-size", 'B', POPT_ARG_INT
, &block_size
},
290 {"max-delete", 0, POPT_ARG_INT
, &max_delete
},
291 {"timeout", 0, POPT_ARG_INT
, &io_timeout
},
292 {"temp-dir", 'T', POPT_ARG_STRING
, &tmpdir
},
293 {"compare-dest", 0, POPT_ARG_STRING
, &compare_dest
},
294 /* TODO: Should this take an optional int giving the compression level? */
295 {"compress", 'z', POPT_ARG_NONE
, &do_compression
},
296 {"daemon", 0, POPT_ARG_NONE
, &am_daemon
},
297 {"stats", 0, POPT_ARG_NONE
, &do_stats
},
298 {"progress", 0, POPT_ARG_NONE
, &do_progress
},
299 {"partial", 0, POPT_ARG_NONE
, &keep_partial
},
300 {"ignore-errors", 0, POPT_ARG_NONE
, &ignore_errors
},
301 {"blocking-io", 0, POPT_ARG_NONE
, &blocking_io
},
302 {0, 'P', POPT_ARG_NONE
, 0, 'P'},
303 {"config", 0, POPT_ARG_STRING
, &config_file
},
304 {"port", 0, POPT_ARG_INT
, &rsync_port
},
305 {"log-format", 0, POPT_ARG_STRING
, &log_format
},
306 {"bwlimit", 0, POPT_ARG_INT
, &bwlimit
},
307 {"address", 0, POPT_ARG_STRING
, &bind_address
, 0},
308 {"backup-dir", 0, POPT_ARG_STRING
, &backup_dir
},
309 {"hard-links", 'H', POPT_ARG_NONE
, &preserve_hard_links
},
310 {"read-batch", 'f', POPT_ARG_STRING
, &batch_ext
, 'f'},
311 {"write-batch", 'F', POPT_ARG_NONE
, &write_batch
, 0},
313 {0, '4', POPT_ARG_VAL
, &af
, AF_INET
},
314 {0, '6', POPT_ARG_VAL
, &af
, AF_INET6
},
320 static char err_buf
[100];
323 /* We store the option error message, if any, so that we can log the
324 connection attempt (which requires parsing the options), and then
325 show the error later on. */
326 void option_error(void)
329 rprintf(FLOG
, "%s", err_buf
);
330 rprintf(FERROR
, "%s: %s", RSYNC_NAME
, err_buf
);
332 rprintf (FERROR
, "Error parsing options: "
333 "option may be supported on client but not on server?\n");
334 rprintf (FERROR
, RSYNC_NAME
": Error parsing options: "
335 "option may be supported on client but not on server?\n");
339 /* check to see if we should refuse this option */
340 static int check_refuse_options(char *ref
, int opt
)
346 for (i
=0; long_options
[i
].longName
; i
++) {
347 if (long_options
[i
].val
== opt
) break;
350 if (!long_options
[i
].longName
) return 0;
352 name
= long_options
[i
].longName
;
355 while ((p
= strstr(ref
,name
))) {
356 if ((p
==ref
|| p
[-1]==' ') &&
357 (p
[len
] == ' ' || p
[len
] == 0)) {
358 snprintf(err_buf
,sizeof(err_buf
),
359 "The '%s' option is not supported by this server\n", name
);
368 static int count_args(char const **argv
)
372 while (argv
[i
] != NULL
)
379 /* Process command line arguments. Called on both local and remote.
380 * Returns if all options are OK, otherwise fills in err_buf and
382 int parse_arguments(int *argc
, const char ***argv
, int frommain
)
385 char *ref
= lp_refuse_options(module_id
);
388 /* TODO: Call poptReadDefaultConfig; handle errors. */
390 /* The context leaks in case of an error, but if there's a
391 * problem we always exit anyhow. */
392 pc
= poptGetContext(RSYNC_NAME
, *argc
, *argv
, long_options
, 0);
394 while ((opt
= poptGetNextOpt(pc
)) != -1) {
396 if (check_refuse_options(ref
, opt
)) return 0;
399 /* most options are handled automatically by popt;
400 * only special cases are returned and listed here. */
404 print_rsync_version(FINFO
);
407 case OPT_MODIFY_WINDOW
:
408 /* The value has already been set by popt, but
409 * we need to remember that we're using a
410 * non-default setting. */
411 modify_window_set
= 1;
414 case OPT_DELETE_EXCLUDED
:
420 add_exclude(poptGetOptArg(pc
), 0);
424 add_exclude(poptGetOptArg(pc
), 1);
427 case OPT_EXCLUDE_FROM
:
428 add_exclude_file(poptGetOptArg(pc
), 1, 0);
431 case OPT_INCLUDE_FROM
:
432 add_exclude_file(poptGetOptArg(pc
), 1, 1);
440 #if SUPPORT_HARD_LINKS
441 preserve_hard_links
=1;
443 /* FIXME: Don't say "server" if this is
444 * happening on the client. */
445 /* FIXME: Why do we have the duplicated
446 * rprintf? Everybody who gets this message
447 * ought to send it to the client and also to
449 snprintf(err_buf
,sizeof(err_buf
),
450 "hard links are not supported on this %s\n",
451 am_server
? "server" : "client");
452 rprintf(FERROR
,"ERROR: hard links not supported on this platform\n");
454 #endif /* SUPPORT_HARD_LINKS */
462 if (frommain
) quiet
++;
480 exit_cleanup(RERR_SYNTAX
);
492 /* The filename is stored for us by popt */
497 /* FIXME: If --daemon is specified, then errors for later
498 * parameters seem to disappear. */
499 snprintf(err_buf
, sizeof(err_buf
),
501 am_server
? "on remote machine: " : "",
502 poptBadOption(pc
, POPT_BADOPTION_NOALIAS
),
508 *argv
= poptGetArgs(pc
);
510 *argc
= count_args(*argv
);
518 /* Construct a filtered list of options to pass through from the
519 * client to the server */
520 void server_options(char **args
,int *argc
)
523 static char argstr
[50];
524 static char bsize
[30];
525 static char iotime
[30];
526 static char mdelete
[30];
527 static char mwindow
[30];
529 static char fext
[20]; /* dw */
533 args
[ac
++] = "--server";
536 args
[ac
++] = "--sender";
540 for (i
=0;i
<verbose
;i
++)
543 /* the -q option is intentionally left out */
556 if (preserve_hard_links
)
562 if (preserve_devices
)
585 argstr
[x
++] = 'F'; /* dw */
587 /* this is a complete hack - blame Rusty
589 this is a hack to make the list_only (remote file list)
591 if (list_only
&& !recurse
)
596 if (x
!= 1) args
[ac
++] = argstr
;
598 if (block_size
!= BLOCK_SIZE
) {
599 snprintf(bsize
,sizeof(bsize
),"-B%d",block_size
);
603 if (max_delete
&& am_sender
) {
604 snprintf(mdelete
,sizeof(mdelete
),"--max-delete=%d",max_delete
);
605 args
[ac
++] = mdelete
;
608 if (batch_ext
!= NULL
) {
609 sprintf(fext
,"-f%s",batch_ext
);
614 snprintf(iotime
,sizeof(iotime
),"--timeout=%d",io_timeout
);
619 snprintf(bw
,sizeof(bw
),"--bwlimit=%d",bwlimit
);
623 if (strcmp(backup_suffix
, BACKUP_SUFFIX
)) {
624 args
[ac
++] = "--suffix";
625 args
[ac
++] = backup_suffix
;
628 if (delete_mode
&& !delete_excluded
)
629 args
[ac
++] = "--delete";
632 args
[ac
++] = "--delete-excluded";
635 args
[ac
++] = "--size-only";
637 if (modify_window_set
) {
638 snprintf(mwindow
,sizeof(mwindow
),"--modify-window=%d",
640 args
[ac
++] = mwindow
;
644 args
[ac
++] = "--partial";
647 args
[ac
++] = "--force";
650 args
[ac
++] = "--delete-after";
653 args
[ac
++] = "--ignore-errors";
655 if (copy_unsafe_links
)
656 args
[ac
++] = "--copy-unsafe-links";
659 args
[ac
++] = "--safe-links";
662 args
[ac
++] = "--numeric-ids";
664 if (only_existing
&& am_sender
)
665 args
[ac
++] = "--existing";
668 args
[ac
++] = "--temp-dir";
672 if (backup_dir
&& am_sender
) {
673 /* only the receiver needs this option, if we are the sender
674 * then we need to send it to the receiver.
676 args
[ac
++] = "--backup-dir";
677 args
[ac
++] = backup_dir
;
680 if (compare_dest
&& am_sender
) {
681 /* the server only needs this option if it is not the sender,
682 * and it may be an older version that doesn't know this
683 * option, so don't send it if client is the sender.
685 args
[ac
++] = "--compare-dest";
686 args
[ac
++] = compare_dest
;