Matt McCutchen's Web Site / rsync / rsync.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
added "refuse options" option
[rsync/rsync.git] / options.c
CommitLineData
7a6421fa
AT		 1/*
2 Copyright (C) Andrew Tridgell 1998
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17*/
18
19/* options parsing code */
20
21#include "rsync.h"
22
23
24int make_backups = 0;
25int whole_file = 0;
26int copy_links = 0;
27int preserve_links = 0;
28int preserve_hard_links = 0;
29int preserve_perms = 0;
30int preserve_devices = 0;
31int preserve_uid = 0;
32int preserve_gid = 0;
33int preserve_times = 0;
34int update_only = 0;
35int cvs_exclude = 0;
36int dry_run=0;
37int local_server=0;
38int ignore_times=0;
39int delete_mode=0;
40int one_file_system=0;
41int remote_version=0;
42int sparse_files=0;
43int do_compression=0;
44int am_root=0;
45int orig_umask=0;
46int relative_paths=0;
47int numeric_ids = 0;
48int force_delete = 0;
49int io_timeout = 0;
50int io_error = 0;
51int read_only = 0;
52int module_id = -1;
53int am_server = 0;
54int am_sender=0;
55int recurse = 0;
56int am_daemon=0;
8d9dc9f9 57int am_client=0;
a800434a 58int do_stats=0;
eb86d661 59int do_progress=0;
c95da96a 60int keep_partial=0;
d853783f 61int safe_symlinks=0;
7a6421fa
AT		 62
63int block_size=BLOCK_SIZE;
64
65char *backup_suffix = BACKUP_SUFFIX;
66char *tmpdir = NULL;
375a4556 67char *compare_dest = NULL;
7a6421fa
AT		 68char *config_file = RSYNCD_CONF;
69char *shell_cmd = NULL;
b6062654 70char *log_format = NULL;
7a6421fa
AT		 71
72char *rsync_path = RSYNC_NAME;
73int rsync_port = RSYNC_PORT;
74
75int verbose = 0;
76int always_checksum = 0;
f7632fc6 77int list_only = 0;
7a6421fa
AT		 78
79void usage(int F)
80{
81 rprintf(F,"rsync version %s Copyright Andrew Tridgell and Paul Mackerras\n\n",
82 VERSION);
704f908e
AT		 83
84 rprintf(F,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
85
86 rprintf(F,"Usage: rsync [OPTION]... SRC [USER@]HOST:DEST\n");
87 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
88 rprintf(F," or rsync [OPTION]... SRC DEST\n");
14d43f1f 89 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
704f908e 90 rprintf(F," or rsync [OPTION]... SRC [USER@]HOST::DEST\n");
14d43f1f 91 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
704f908e
AT		 92 rprintf(F,"\nOptions\n");
93 rprintf(F," -v, --verbose increase verbosity\n");
94 rprintf(F," -c, --checksum always checksum\n");
95 rprintf(F," -a, --archive archive mode\n");
96 rprintf(F," -r, --recursive recurse into directories\n");
97 rprintf(F," -R, --relative use relative path names\n");
98 rprintf(F," -b, --backup make backups (default ~ extension)\n");
99 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
100 rprintf(F," -l, --links preserve soft links\n");
101 rprintf(F," -L, --copy-links treat soft links like regular files\n");
d853783f 102 rprintf(F," --safe-links ignore links outside the destination tree\n");
704f908e
AT		 103 rprintf(F," -H, --hard-links preserve hard links\n");
104 rprintf(F," -p, --perms preserve permissions\n");
105 rprintf(F," -o, --owner preserve owner (root only)\n");
106 rprintf(F," -g, --group preserve group\n");
107 rprintf(F," -D, --devices preserve devices (root only)\n");
108 rprintf(F," -t, --times preserve times\n");
109 rprintf(F," -S, --sparse handle sparse files efficiently\n");
110 rprintf(F," -n, --dry-run show what would have been transferred\n");
111 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
112 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
113 rprintf(F," -B, --block-size=SIZE checksum blocking size\n");
114 rprintf(F," -e, --rsh=COMMAND specify rsh replacement\n");
115 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
116 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
117 rprintf(F," --delete delete files that don't exist on the sending side\n");
c95da96a 118 rprintf(F," --partial keep partially transferred files\n");
704f908e
AT		 119 rprintf(F," --force force deletion of directories even if not empty\n");
120 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
121 rprintf(F," --timeout=TIME set IO timeout in seconds\n");
122 rprintf(F," -I, --ignore-times don't exclude files that match length and time\n");
123 rprintf(F," -T --temp-dir=DIR create temporary files in directory DIR\n");
375a4556 124 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
704f908e 125 rprintf(F," -z, --compress compress file data\n");
2acf81eb 126 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
858fb9eb 127 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
2acf81eb 128 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
858fb9eb 129 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
704f908e
AT		 130 rprintf(F," --suffix=SUFFIX override backup suffix\n");
131 rprintf(F," --version print version number\n");
132 rprintf(F," --daemon run as a rsync daemon\n");
133 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
134 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
135 rprintf(F," --stats give some file transfer stats\n");
eb86d661 136 rprintf(F," --progress show progress during transfer\n");
b6062654 137 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
704f908e 138 rprintf(F," -h, --help show this help screen\n");
7a6421fa
AT		 139
140 rprintf(F,"\n");
141 rprintf(F,"the backup suffix defaults to %s\n",BACKUP_SUFFIX);
142 rprintf(F,"the block size defaults to %d\n",BLOCK_SIZE);
b72f24c7
AT		 143
144 rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
145 rprintf(F,"See http://samba.anu.edu.au/rsync/ for updates and bug reports\n");
7a6421fa
AT		 146}
147
148enum {OPT_VERSION,OPT_SUFFIX,OPT_SENDER,OPT_SERVER,OPT_EXCLUDE,
149 OPT_EXCLUDE_FROM,OPT_DELETE,OPT_NUMERIC_IDS,OPT_RSYNC_PATH,
2b6b4d53 150 OPT_FORCE,OPT_TIMEOUT,OPT_DAEMON,OPT_CONFIG,OPT_PORT,
d853783f 151 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_STATS, OPT_PARTIAL, OPT_PROGRESS,
b6062654 152 OPT_SAFE_LINKS, OPT_COMPARE_DEST, OPT_LOG_FORMAT};
7a6421fa
AT		 153
154static char *short_options = "oblLWHpguDCtcahvrRIxnSe:B:T:z";
155
156static struct option long_options[] = {
157 {"version", 0, 0, OPT_VERSION},
158 {"server", 0, 0, OPT_SERVER},
159 {"sender", 0, 0, OPT_SENDER},
160 {"delete", 0, 0, OPT_DELETE},
161 {"force", 0, 0, OPT_FORCE},
162 {"numeric-ids", 0, 0, OPT_NUMERIC_IDS},
163 {"exclude", 1, 0, OPT_EXCLUDE},
164 {"exclude-from",1, 0, OPT_EXCLUDE_FROM},
2b6b4d53
AT		 165 {"include", 1, 0, OPT_INCLUDE},
166 {"include-from",1, 0, OPT_INCLUDE_FROM},
7a6421fa
AT		 167 {"rsync-path", 1, 0, OPT_RSYNC_PATH},
168 {"one-file-system",0, 0, 'x'},
169 {"ignore-times",0, 0, 'I'},
170 {"help", 0, 0, 'h'},
171 {"dry-run", 0, 0, 'n'},
172 {"sparse", 0, 0, 'S'},
173 {"cvs-exclude", 0, 0, 'C'},
174 {"archive", 0, 0, 'a'},
175 {"checksum", 0, 0, 'c'},
176 {"backup", 0, 0, 'b'},
177 {"update", 0, 0, 'u'},
178 {"verbose", 0, 0, 'v'},
179 {"recursive", 0, 0, 'r'},
180 {"relative", 0, 0, 'R'},
181 {"devices", 0, 0, 'D'},
182 {"perms", 0, 0, 'p'},
183 {"links", 0, 0, 'l'},
184 {"copy-links", 0, 0, 'L'},
d853783f 185 {"safe-links", 0, 0, OPT_SAFE_LINKS},
7a6421fa
AT		 186 {"whole-file", 0, 0, 'W'},
187 {"hard-links", 0, 0, 'H'},
188 {"owner", 0, 0, 'o'},
189 {"group", 0, 0, 'g'},
190 {"times", 0, 0, 't'},
191 {"rsh", 1, 0, 'e'},
192 {"suffix", 1, 0, OPT_SUFFIX},
193 {"block-size", 1, 0, 'B'},
194 {"timeout", 1, 0, OPT_TIMEOUT},
195 {"temp-dir", 1, 0, 'T'},
375a4556 196 {"compare-dest", 1, 0, OPT_COMPARE_DEST},
7a6421fa
AT		 197 {"compress", 0, 0, 'z'},
198 {"daemon", 0, 0, OPT_DAEMON},
a800434a 199 {"stats", 0, 0, OPT_STATS},
eb86d661 200 {"progress", 0, 0, OPT_PROGRESS},
c95da96a 201 {"partial", 0, 0, OPT_PARTIAL},
7a6421fa
AT		 202 {"config", 1, 0, OPT_CONFIG},
203 {"port", 1, 0, OPT_PORT},
b6062654 204 {"log-format", 1, 0, OPT_LOG_FORMAT},
7a6421fa
AT		 205 {0,0,0,0}};
206
b11ed3b1 207
cd8185f2
AT		 208static char err_buf[100];
209
210void option_error(void)
211{
212 if (err_buf[0]) {
213 rprintf(FLOG,"%s", err_buf);
214 rprintf(FERROR,"%s", err_buf);
215 } else {
216 rprintf(FLOG,"Error parsing options - unsupported option?\n");
217 rprintf(FERROR,"Error parsing options - unsupported option?\n");
218 }
219 exit_cleanup(RERR_UNSUPPORTED);
220}
221
222/* check to see if we should refuse this option */
223static int check_refuse_options(char *ref, int opt)
224{
225 int i, len;
226 char *p;
227 const char *name;
228
229 for (i=0; long_options[i].name; i++) {
230 if (long_options[i].val == opt) break;
231 }
232
233 if (!long_options[i].name) return 0;
234
235 name = long_options[i].name;
236 len = strlen(name);
237
238 while ((p = strstr(ref,name))) {
239 if (p[len] == ' ' || p[len] == 0) {
240 slprintf(err_buf,sizeof(err_buf),
241 "The '%s' option is not supported by this server\n", name);
242 return 1;
243 }
244 ref += len;
245 }
246 return 0;
247}
248
249
b11ed3b1 250int parse_arguments(int argc, char *argv[])
7a6421fa 251{
d853783f
AT		 252 int opt;
253 int option_index;
cd8185f2 254 char *ref = lp_refuse_options(module_id);
d853783f
AT		 255
256 while ((opt = getopt_long(argc, argv,
257 short_options, long_options, &option_index))
258 != -1) {
cd8185f2
AT		 259
260 if (ref) {
261 if (check_refuse_options(ref, opt)) return 0;
262 }
263
d853783f
AT		 264 switch (opt) {
265 case OPT_VERSION:
266 rprintf(FINFO,"rsync version %s protocol version %d\n\n",
267 VERSION,PROTOCOL_VERSION);
268 rprintf(FINFO,"Written by Andrew Tridgell and Paul Mackerras\n");
269 exit_cleanup(0);
270
271 case OPT_SUFFIX:
272 backup_suffix = optarg;
273 break;
274
275 case OPT_RSYNC_PATH:
276 rsync_path = optarg;
277 break;
278
279 case 'I':
280 ignore_times = 1;
281 break;
282
283 case 'x':
284 one_file_system=1;
285 break;
286
287 case OPT_DELETE:
288 delete_mode = 1;
289 break;
290
291 case OPT_FORCE:
292 force_delete = 1;
293 break;
294
295 case OPT_NUMERIC_IDS:
296 numeric_ids = 1;
297 break;
298
299 case OPT_EXCLUDE:
300 add_exclude(optarg, 0);
301 break;
302
303 case OPT_INCLUDE:
304 add_exclude(optarg, 1);
305 break;
306
307 case OPT_EXCLUDE_FROM:
308 add_exclude_file(optarg,1, 0);
309 break;
310
311 case OPT_INCLUDE_FROM:
312 add_exclude_file(optarg,1, 1);
313 break;
314
315 case OPT_SAFE_LINKS:
316 safe_symlinks=1;
317 break;
318
319 case 'h':
320 usage(FINFO);
321 exit_cleanup(0);
322
323 case 'b':
324 make_backups=1;
325 break;
326
327 case 'n':
328 dry_run=1;
329 break;
330
331 case 'S':
332 sparse_files=1;
333 break;
334
335 case 'C':
336 cvs_exclude=1;
337 break;
338
339 case 'u':
340 update_only=1;
341 break;
342
343 case 'l':
344 preserve_links=1;
345 break;
346
347 case 'L':
348 copy_links=1;
349 break;
350
351 case 'W':
352 whole_file=1;
353 break;
354
355 case 'H':
7a6421fa 356#if SUPPORT_HARD_LINKS
d853783f 357 preserve_hard_links=1;
7a6421fa 358#else
cd8185f2 359 slprintf(err_buf,sizeof(err_buf),"hard links are not supported on this server\n");
d853783f 360 rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
b11ed3b1 361 return 0;
7a6421fa 362#endif
d853783f 363 break;
7a6421fa 364
d853783f
AT		 365 case 'p':
366 preserve_perms=1;
367 break;
7a6421fa 368
d853783f
AT		 369 case 'o':
370 preserve_uid=1;
371 break;
7a6421fa 372
d853783f
AT		 373 case 'g':
374 preserve_gid=1;
375 break;
7a6421fa 376
d853783f
AT		 377 case 'D':
378 preserve_devices=1;
379 break;
7a6421fa 380
d853783f
AT		 381 case 't':
382 preserve_times=1;
383 break;
7a6421fa 384
d853783f
AT		 385 case 'c':
386 always_checksum=1;
387 break;
7a6421fa 388
d853783f
AT		 389 case 'v':
390 verbose++;
391 break;
7a6421fa 392
d853783f
AT		 393 case 'a':
394 recurse=1;
7a6421fa 395#if SUPPORT_LINKS
d853783f 396 preserve_links=1;
7a6421fa 397#endif
d853783f
AT		 398 preserve_perms=1;
399 preserve_times=1;
400 preserve_gid=1;
401 if (am_root) {
402 preserve_devices=1;
403 preserve_uid=1;
404 }
405 break;
406
407 case OPT_SERVER:
408 am_server = 1;
409 break;
410
411 case OPT_SENDER:
412 if (!am_server) {
413 usage(FERROR);
65417579 414 exit_cleanup(RERR_SYNTAX);
d853783f
AT		 415 }
416 am_sender = 1;
417 break;
418
419 case 'r':
420 recurse = 1;
421 break;
422
423 case 'R':
424 relative_paths = 1;
425 break;
426
427 case 'e':
428 shell_cmd = optarg;
429 break;
430
431 case 'B':
432 block_size = atoi(optarg);
433 break;
434
435 case OPT_TIMEOUT:
436 io_timeout = atoi(optarg);
437 break;
438
439 case 'T':
440 tmpdir = optarg;
441 break;
442
375a4556
DD		 443 case OPT_COMPARE_DEST:
444 compare_dest = optarg;
445 break;
446
d853783f
AT		 447 case 'z':
448 do_compression = 1;
449 break;
450
451 case OPT_DAEMON:
452 am_daemon = 1;
453 break;
454
455 case OPT_STATS:
456 do_stats = 1;
457 break;
458
459 case OPT_PROGRESS:
460 do_progress = 1;
461 break;
462
463 case OPT_PARTIAL:
464 keep_partial = 1;
465 break;
466
467 case OPT_CONFIG:
468 config_file = optarg;
469 break;
470
471 case OPT_PORT:
472 rsync_port = atoi(optarg);
473 break;
474
b6062654
AT		 475 case OPT_LOG_FORMAT:
476 log_format = optarg;
477 break;
478
d853783f 479 default:
cd8185f2 480 slprintf(err_buf,sizeof(err_buf),"unrecognised option\n");
b11ed3b1 481 return 0;
d853783f 482 }
7a6421fa 483 }
b11ed3b1 484 return 1;
7a6421fa
AT		 485}
486
487
488void server_options(char **args,int *argc)
489{
d853783f
AT		 490 int ac = *argc;
491 static char argstr[50];
492 static char bsize[30];
493 static char iotime[30];
494 int i, x;
495
496 args[ac++] = "--server";
497
498 if (!am_sender)
499 args[ac++] = "--sender";
500
501 x = 1;
502 argstr[0] = '-';
503 for (i=0;i<verbose;i++)
504 argstr[x++] = 'v';
505 if (make_backups)
506 argstr[x++] = 'b';
507 if (update_only)
508 argstr[x++] = 'u';
509 if (dry_run)
510 argstr[x++] = 'n';
511 if (preserve_links)
512 argstr[x++] = 'l';
513 if (copy_links)
514 argstr[x++] = 'L';
515 if (whole_file)
516 argstr[x++] = 'W';
517 if (preserve_hard_links)
518 argstr[x++] = 'H';
519 if (preserve_uid)
520 argstr[x++] = 'o';
521 if (preserve_gid)
522 argstr[x++] = 'g';
523 if (preserve_devices)
524 argstr[x++] = 'D';
525 if (preserve_times)
526 argstr[x++] = 't';
527 if (preserve_perms)
528 argstr[x++] = 'p';
529 if (recurse)
530 argstr[x++] = 'r';
531 if (always_checksum)
532 argstr[x++] = 'c';
533 if (cvs_exclude)
534 argstr[x++] = 'C';
535 if (ignore_times)
536 argstr[x++] = 'I';
537 if (relative_paths)
538 argstr[x++] = 'R';
539 if (one_file_system)
540 argstr[x++] = 'x';
541 if (sparse_files)
542 argstr[x++] = 'S';
543 if (do_compression)
544 argstr[x++] = 'z';
545 argstr[x] = 0;
546
547 if (x != 1) args[ac++] = argstr;
548
549 if (block_size != BLOCK_SIZE) {
550 sprintf(bsize,"-B%d",block_size);
551 args[ac++] = bsize;
552 }
553
554 if (io_timeout) {
555 sprintf(iotime,"--timeout=%d",io_timeout);
556 args[ac++] = iotime;
557 }
558
559 if (strcmp(backup_suffix, BACKUP_SUFFIX)) {
560 args[ac++] = "--suffix";
561 args[ac++] = backup_suffix;
562 }
563
564 if (delete_mode)
565 args[ac++] = "--delete";
566
567 if (keep_partial)
568 args[ac++] = "--partial";
569
570 if (force_delete)
571 args[ac++] = "--force";
572
573 if (safe_symlinks)
574 args[ac++] = "--safe-links";
575
576 if (numeric_ids)
577 args[ac++] = "--numeric-ids";
578
579 if (tmpdir) {
580 args[ac++] = "--temp-dir";
581 args[ac++] = tmpdir;
582 }
583
375a4556
DD		 584 if (compare_dest && am_sender) {
585 /* the server only needs this option if it is not the sender,
586 * and it may be an older version that doesn't know this
587 * option, so don't send it if client is the sender.
588 */
589 args[ac++] = "--compare-dest";
590 args[ac++] = compare_dest;
591 }
592
593
d853783f 594 *argc = ac;
7a6421fa
AT		 595}
596
Matt McCutchen's repository for rsync, the fast and versatile remote file copier