Print strerror when a system error occurs; add a new function rsyserr
[rsync.git] / options.c
index 2a46a5b71c72577fc33090c03b3706e325a53250..4176b328e4004a0d3145f176e5bdcb6f3a05ee69 100644 (file)
--- a/options.c
+++ b/options.c
@@ -37,6 +37,7 @@ int dry_run=0;
 int local_server=0;
 int ignore_times=0;
 int delete_mode=0;
+int delete_excluded=0;
 int one_file_system=0;
 int remote_version=0;
 int sparse_files=0;
@@ -54,13 +55,24 @@ int am_server = 0;
 int am_sender=0;
 int recurse = 0;
 int am_daemon=0;
-int am_client=0;
 int do_stats=0;
 int do_progress=0;
 int keep_partial=0;
 int safe_symlinks=0;
-
+int copy_unsafe_links=0;
 int block_size=BLOCK_SIZE;
+int size_only=0;
+int bwlimit=0;
+int delete_after=0;
+int only_existing=0;
+int max_delete=0;
+int ignore_errors=0;
+#ifdef _WIN32
+int modify_window=2;
+#else
+int modify_window=0;
+#endif
+int blocking_io=0;
 
 char *backup_suffix = BACKUP_SUFFIX;
 char *tmpdir = NULL;
@@ -68,37 +80,51 @@ char *compare_dest = NULL;
 char *config_file = RSYNCD_CONF;
 char *shell_cmd = NULL;
 char *log_format = NULL;
-
+char *password_file = NULL;
 char *rsync_path = RSYNC_NAME;
+char *backup_dir = NULL;
 int rsync_port = RSYNC_PORT;
 
 int verbose = 0;
+int quiet = 0;
 int always_checksum = 0;
 int list_only = 0;
 
-void usage(int F)
+static int modify_window_set;
+
+
+struct in_addr socket_address = {INADDR_ANY};
+
+void usage(enum logcode F)
 {
   rprintf(F,"rsync version %s Copyright Andrew Tridgell and Paul Mackerras\n\n",
          VERSION);
 
   rprintf(F,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
 
-  rprintf(F,"Usage: rsync [OPTION]... SRC [USER@]HOST:DEST\n");
+  rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
   rprintf(F,"  or   rsync [OPTION]... [USER@]HOST:SRC DEST\n");
-  rprintf(F,"  or   rsync [OPTION]... SRC DEST\n");
-  rprintf(F,"  or   rsync [OPTION]... [USER@]HOST::SRC DEST\n");
-  rprintf(F,"  or   rsync [OPTION]... SRC [USER@]HOST::DEST\n");
-  rprintf(F,"  or   rsync [OPTION]... rsync://HOST[:PORT]/SRC DEST\n");
+  rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... DEST\n");
+  rprintf(F,"  or   rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
+  rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
+  rprintf(F,"  or   rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
+  rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
+  rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
+  rprintf(F,"  sources separated by space as long as they have same top-level\n");
   rprintf(F,"\nOptions\n");
   rprintf(F," -v, --verbose               increase verbosity\n");
+  rprintf(F," -q, --quiet                 decrease verbosity\n");
   rprintf(F," -c, --checksum              always checksum\n");
   rprintf(F," -a, --archive               archive mode\n");
   rprintf(F," -r, --recursive             recurse into directories\n");
   rprintf(F," -R, --relative              use relative path names\n");
-  rprintf(F," -b, --backup                make backups (default ~ extension)\n");
+  rprintf(F," -b, --backup                make backups (default %s suffix)\n",BACKUP_SUFFIX);
+  rprintf(F,"     --backup-dir            make backups into this directory\n");
+  rprintf(F,"     --suffix=SUFFIX         override backup suffix\n");  
   rprintf(F," -u, --update                update only (don't overwrite newer files)\n");
   rprintf(F," -l, --links                 preserve soft links\n");
   rprintf(F," -L, --copy-links            treat soft links like regular files\n");
+  rprintf(F,"     --copy-unsafe-links     copy links outside the source tree\n");
   rprintf(F,"     --safe-links            ignore links outside the destination tree\n");
   rprintf(F," -H, --hard-links            preserve hard links\n");
   rprintf(F," -p, --perms                 preserve permissions\n");
@@ -110,54 +136,69 @@ void usage(int F)
   rprintf(F," -n, --dry-run               show what would have been transferred\n");
   rprintf(F," -W, --whole-file            copy whole files, no incremental checks\n");
   rprintf(F," -x, --one-file-system       don't cross filesystem boundaries\n");
-  rprintf(F," -B, --block-size=SIZE       checksum blocking size\n");  
+  rprintf(F," -B, --block-size=SIZE       checksum blocking size (default %d)\n",BLOCK_SIZE);  
   rprintf(F," -e, --rsh=COMMAND           specify rsh replacement\n");
   rprintf(F,"     --rsync-path=PATH       specify path to rsync on the remote machine\n");
   rprintf(F," -C, --cvs-exclude           auto ignore files in the same way CVS does\n");
+  rprintf(F,"     --existing              only update files that already exist\n");
   rprintf(F,"     --delete                delete files that don't exist on the sending side\n");
+  rprintf(F,"     --delete-excluded       also delete excluded files on the receiving side\n");
+  rprintf(F,"     --delete-after          delete after transferring, not before\n");
+  rprintf(F,"     --ignore-errors         delete even if there are IO errors\n");
+  rprintf(F,"     --max-delete=NUM        don't delete more than NUM files\n");
   rprintf(F,"     --partial               keep partially transferred files\n");
   rprintf(F,"     --force                 force deletion of directories even if not empty\n");
   rprintf(F,"     --numeric-ids           don't map uid/gid values by user/group name\n");
   rprintf(F,"     --timeout=TIME          set IO timeout in seconds\n");
   rprintf(F," -I, --ignore-times          don't exclude files that match length and time\n");
+  rprintf(F,"     --size-only             only use file size when determining if a file should be transferred\n");
+  rprintf(F,"     --modify-window=NUM     Timestamp window (seconds) for file match (default=%d)\n",modify_window);
   rprintf(F," -T  --temp-dir=DIR          create temporary files in directory DIR\n");
   rprintf(F,"     --compare-dest=DIR      also compare destination files relative to DIR\n");
+  rprintf(F," -P                          equivalent to --partial --progress\n");
   rprintf(F," -z, --compress              compress file data\n");
   rprintf(F,"     --exclude=PATTERN       exclude files matching PATTERN\n");
   rprintf(F,"     --exclude-from=FILE     exclude patterns listed in FILE\n");
   rprintf(F,"     --include=PATTERN       don't exclude files matching PATTERN\n");
   rprintf(F,"     --include-from=FILE     don't exclude patterns listed in FILE\n");
-  rprintf(F,"     --suffix=SUFFIX         override backup suffix\n");  
   rprintf(F,"     --version               print version number\n");  
   rprintf(F,"     --daemon                run as a rsync daemon\n");  
+  rprintf(F,"     --address               bind to the specified address\n");  
   rprintf(F,"     --config=FILE           specify alternate rsyncd.conf file\n");  
   rprintf(F,"     --port=PORT             specify alternate rsyncd port number\n");
+  rprintf(F,"     --blocking-io           use blocking IO for the remote shell\n");  
   rprintf(F,"     --stats                 give some file transfer stats\n");  
   rprintf(F,"     --progress              show progress during transfer\n");  
   rprintf(F,"     --log-format=FORMAT     log file transfers using specified format\n");  
+  rprintf(F,"     --password-file=FILE    get password from FILE\n");
+  rprintf(F,"     --bwlimit=KBPS          limit I/O bandwidth, KBytes per second\n");
   rprintf(F," -h, --help                  show this help screen\n");
 
   rprintf(F,"\n");
-  rprintf(F,"the backup suffix defaults to %s\n",BACKUP_SUFFIX);
-  rprintf(F,"the block size defaults to %d\n",BLOCK_SIZE);  
 
   rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
-  rprintf(F,"See http://samba.anu.edu.au/rsync/ for updates and bug reports\n");
+  rprintf(F,"See http://rsync.samba.org/ for updates and bug reports\n");
 }
 
-enum {OPT_VERSION,OPT_SUFFIX,OPT_SENDER,OPT_SERVER,OPT_EXCLUDE,
-      OPT_EXCLUDE_FROM,OPT_DELETE,OPT_NUMERIC_IDS,OPT_RSYNC_PATH,
-      OPT_FORCE,OPT_TIMEOUT,OPT_DAEMON,OPT_CONFIG,OPT_PORT,
+enum {OPT_VERSION, OPT_SUFFIX, OPT_SENDER, OPT_SERVER, OPT_EXCLUDE,
+      OPT_EXCLUDE_FROM, OPT_DELETE, OPT_DELETE_EXCLUDED, OPT_NUMERIC_IDS,
+      OPT_RSYNC_PATH, OPT_FORCE, OPT_TIMEOUT, OPT_DAEMON, OPT_CONFIG, OPT_PORT,
       OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_STATS, OPT_PARTIAL, OPT_PROGRESS,
-      OPT_SAFE_LINKS, OPT_COMPARE_DEST, OPT_LOG_FORMAT};
+      OPT_COPY_UNSAFE_LINKS, OPT_SAFE_LINKS, OPT_COMPARE_DEST,
+      OPT_LOG_FORMAT, OPT_PASSWORD_FILE, OPT_SIZE_ONLY, OPT_ADDRESS,
+      OPT_DELETE_AFTER, OPT_EXISTING, OPT_MAX_DELETE, OPT_BACKUP_DIR, 
+      OPT_IGNORE_ERRORS, OPT_BWLIMIT, OPT_BLOCKING_IO,
+      OPT_MODIFY_WINDOW};
 
-static char *short_options = "oblLWHpguDCtcahvrRIxnSe:B:T:z";
+static char *short_options = "oblLWHpguDCtcahvqrRIxnSe:B:T:zP";
 
 static struct option long_options[] = {
   {"version",     0,     0,    OPT_VERSION},
   {"server",      0,     0,    OPT_SERVER},
   {"sender",      0,     0,    OPT_SENDER},
+  {"existing",    0,     0,    OPT_EXISTING},
   {"delete",      0,     0,    OPT_DELETE},
+  {"delete-excluded", 0, 0,    OPT_DELETE_EXCLUDED},
   {"force",       0,     0,    OPT_FORCE},
   {"numeric-ids", 0,     0,    OPT_NUMERIC_IDS},
   {"exclude",     1,     0,    OPT_EXCLUDE},
@@ -165,8 +206,11 @@ static struct option long_options[] = {
   {"include",     1,     0,    OPT_INCLUDE},
   {"include-from",1,     0,    OPT_INCLUDE_FROM},
   {"rsync-path",  1,     0,    OPT_RSYNC_PATH},
+  {"password-file", 1, 0,     OPT_PASSWORD_FILE},
   {"one-file-system",0,  0,    'x'},
   {"ignore-times",0,     0,    'I'},
+  {"size-only",   0,     0,    OPT_SIZE_ONLY},
+  {"modify-window",1,    0,    OPT_MODIFY_WINDOW},
   {"help",        0,     0,    'h'},
   {"dry-run",     0,     0,    'n'},
   {"sparse",      0,     0,    'S'},
@@ -176,12 +220,14 @@ static struct option long_options[] = {
   {"backup",      0,     0,    'b'},
   {"update",      0,     0,    'u'},
   {"verbose",     0,     0,    'v'},
+  {"quiet",       0,     0,    'q'},
   {"recursive",   0,     0,    'r'},
   {"relative",    0,     0,    'R'},
   {"devices",     0,     0,    'D'},
   {"perms",       0,     0,    'p'},
   {"links",       0,     0,    'l'},
   {"copy-links",  0,     0,    'L'},
+  {"copy-unsafe-links", 0, 0,  OPT_COPY_UNSAFE_LINKS},
   {"safe-links",  0,     0,    OPT_SAFE_LINKS},
   {"whole-file",  0,     0,    'W'},
   {"hard-links",  0,     0,    'H'},
@@ -199,20 +245,76 @@ static struct option long_options[] = {
   {"stats",       0,     0,    OPT_STATS},
   {"progress",    0,     0,    OPT_PROGRESS},
   {"partial",     0,     0,    OPT_PARTIAL},
+  {"delete-after",0,     0,    OPT_DELETE_AFTER},
+  {"ignore-errors",0,     0,   OPT_IGNORE_ERRORS},
+  {"blocking-io" ,0,     0,    OPT_BLOCKING_IO},
   {"config",      1,     0,    OPT_CONFIG},
   {"port",        1,     0,    OPT_PORT},
   {"log-format",  1,     0,    OPT_LOG_FORMAT},
+  {"bwlimit",    1,     0,    OPT_BWLIMIT},
+  {"address",     1,     0,    OPT_ADDRESS},
+  {"max-delete",  1,     0,    OPT_MAX_DELETE},
+  {"backup-dir",  1,     0,    OPT_BACKUP_DIR},
   {0,0,0,0}};
 
 
-int parse_arguments(int argc, char *argv[])
+static char err_buf[100];
+
+void option_error(void)
+{
+       if (err_buf[0]) {
+               rprintf(FLOG,"%s", err_buf);
+               rprintf(FERROR,"%s", err_buf);
+       } else {
+               rprintf(FLOG,"Error parsing options - unsupported option?\n");
+               rprintf(FERROR,"Error parsing options - unsupported option?\n");
+       }
+       exit_cleanup(RERR_UNSUPPORTED);
+}
+
+/* check to see if we should refuse this option */
+static int check_refuse_options(char *ref, int opt)
+{
+       int i, len;
+       char *p;
+       const char *name;
+
+       for (i=0; long_options[i].name; i++) {
+               if (long_options[i].val == opt) break;
+       }
+       
+       if (!long_options[i].name) return 0;
+
+       name = long_options[i].name;
+       len = strlen(name);
+
+       while ((p = strstr(ref,name))) {
+               if ((p==ref || p[-1]==' ') &&
+                   (p[len] == ' ' || p[len] == 0)) {
+                       slprintf(err_buf,sizeof(err_buf),
+                                "The '%s' option is not supported by this server\n", name);
+                       return 1;
+               }
+               ref += len;
+       }
+       return 0;
+}
+
+
+int parse_arguments(int argc, char *argv[], int frommain)
 {
        int opt;
        int option_index;
+       char *ref = lp_refuse_options(module_id);
 
        while ((opt = getopt_long(argc, argv, 
                                  short_options, long_options, &option_index)) 
               != -1) {
+
+               if (ref) {
+                       if (check_refuse_options(ref, opt)) return 0;
+               }
+
                switch (opt) {
                case OPT_VERSION:
                        rprintf(FINFO,"rsync version %s  protocol version %d\n\n",
@@ -227,11 +329,24 @@ int parse_arguments(int argc, char *argv[])
                case OPT_RSYNC_PATH:
                        rsync_path = optarg;
                        break;
-                       
+       
+               case OPT_PASSWORD_FILE:
+                       password_file =optarg;
+                       break;          
+
                case 'I':
                        ignore_times = 1;
                        break;
 
+               case OPT_SIZE_ONLY:
+                       size_only = 1;
+                       break;
+
+               case OPT_MODIFY_WINDOW:
+                       modify_window = atoi(optarg);
+                       modify_window_set = 1;
+                       break;
+                       
                case 'x':
                        one_file_system=1;
                        break;
@@ -240,6 +355,19 @@ int parse_arguments(int argc, char *argv[])
                        delete_mode = 1;
                        break;
 
+               case OPT_EXISTING:
+                       only_existing = 1;
+                       break;
+
+               case OPT_DELETE_AFTER:
+                       delete_after = 1;
+                       break;
+
+               case OPT_DELETE_EXCLUDED:
+                       delete_excluded = 1;
+                       delete_mode = 1;
+                       break;
+
                case OPT_FORCE:
                        force_delete = 1;
                        break;
@@ -264,6 +392,10 @@ int parse_arguments(int argc, char *argv[])
                        add_exclude_file(optarg,1, 1);
                        break;
 
+               case OPT_COPY_UNSAFE_LINKS:
+                       copy_unsafe_links=1;
+                       break;
+
                case OPT_SAFE_LINKS:
                        safe_symlinks=1;
                        break;
@@ -308,6 +440,7 @@ int parse_arguments(int argc, char *argv[])
 #if SUPPORT_HARD_LINKS
                        preserve_hard_links=1;
 #else 
+                       slprintf(err_buf,sizeof(err_buf),"hard links are not supported on this server\n");
                        rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
                        return 0;
 #endif
@@ -341,6 +474,10 @@ int parse_arguments(int argc, char *argv[])
                        verbose++;
                        break;
 
+               case 'q':
+                       if (frommain) quiet++;
+                       break;
+
                case 'a':
                        recurse=1;
 #if SUPPORT_LINKS
@@ -349,10 +486,8 @@ int parse_arguments(int argc, char *argv[])
                        preserve_perms=1;
                        preserve_times=1;
                        preserve_gid=1;
-                       if (am_root) {
-                               preserve_devices=1;
-                               preserve_uid=1;
-                       }
+                       preserve_uid=1;
+                       preserve_devices=1;
                        break;
 
                case OPT_SERVER:
@@ -383,6 +518,10 @@ int parse_arguments(int argc, char *argv[])
                        block_size = atoi(optarg);
                        break;
 
+               case OPT_MAX_DELETE:
+                       max_delete = atoi(optarg);
+                       break;
+
                case OPT_TIMEOUT:
                        io_timeout = atoi(optarg);
                        break;
@@ -415,6 +554,19 @@ int parse_arguments(int argc, char *argv[])
                        keep_partial = 1;
                        break;
 
+               case OPT_IGNORE_ERRORS:
+                       ignore_errors = 1;
+                       break;
+
+               case OPT_BLOCKING_IO:
+                       blocking_io = 1;
+                       break;
+
+               case 'P':
+                       do_progress = 1;
+                       keep_partial = 1;
+                       break;
+
                case OPT_CONFIG:
                        config_file = optarg;
                        break;
@@ -426,8 +578,26 @@ int parse_arguments(int argc, char *argv[])
                case OPT_LOG_FORMAT:
                        log_format = optarg;
                        break;
+       
+               case OPT_BWLIMIT:
+                       bwlimit = atoi(optarg);
+                       break;
+
+               case OPT_ADDRESS:
+                       {
+                               struct in_addr *ia;
+                               if ((ia = ip_address(optarg))) {
+                                       socket_address = *ia;
+                               }
+                       }
+                       break;
+
+               case OPT_BACKUP_DIR:
+                       backup_dir = optarg;
+                       break;
 
                default:
+                       slprintf(err_buf,sizeof(err_buf),"unrecognised option\n");
                        return 0;
                }
        }
@@ -435,12 +605,18 @@ int parse_arguments(int argc, char *argv[])
 }
 
 
+/* need to pass all the valid options from the client to the server */
+
 void server_options(char **args,int *argc)
 {
        int ac = *argc;
        static char argstr[50];
        static char bsize[30];
        static char iotime[30];
+       static char mdelete[30];
+       static char mwindow[30];
+       static char bw[50];
+
        int i, x;
 
        args[ac++] = "--server";
@@ -452,6 +628,8 @@ void server_options(char **args,int *argc)
        argstr[0] = '-';
        for (i=0;i<verbose;i++)
                argstr[x++] = 'v';
+
+       /* the -q option is intentionally left out */
        if (make_backups)
                argstr[x++] = 'b';
        if (update_only)
@@ -492,45 +670,95 @@ void server_options(char **args,int *argc)
                argstr[x++] = 'S';
        if (do_compression)
                argstr[x++] = 'z';
+
+       /* this is a complete hack - blame Rusty 
+
+          this is a hack to make the list_only (remote file list)
+          more useful */
+       if (list_only && !recurse) 
+               argstr[x++] = 'r';
+
        argstr[x] = 0;
 
        if (x != 1) args[ac++] = argstr;
 
        if (block_size != BLOCK_SIZE) {
-               sprintf(bsize,"-B%d",block_size);
+               slprintf(bsize,sizeof(bsize),"-B%d",block_size);
                args[ac++] = bsize;
        }    
 
+       if (max_delete && am_sender) {
+               slprintf(mdelete,sizeof(mdelete),"--max-delete=%d",max_delete);
+               args[ac++] = mdelete;
+       }    
+
        if (io_timeout) {
-               sprintf(iotime,"--timeout=%d",io_timeout);
+               slprintf(iotime,sizeof(iotime),"--timeout=%d",io_timeout);
                args[ac++] = iotime;
        }    
 
+       if (bwlimit) {
+               slprintf(bw,sizeof(bw),"--bwlimit=%d",bwlimit);
+               args[ac++] = bw;
+       }
+
        if (strcmp(backup_suffix, BACKUP_SUFFIX)) {
                args[ac++] = "--suffix";
                args[ac++] = backup_suffix;
        }
 
-       if (delete_mode)
+       if (delete_mode && !delete_excluded)
                args[ac++] = "--delete";
 
+       if (delete_excluded)
+               args[ac++] = "--delete-excluded";
+
+       if (size_only)
+               args[ac++] = "--size-only";
+
+       if (modify_window_set) {
+               slprintf(mwindow,sizeof(mwindow),"--modify-window=%d",
+                        modify_window);
+               args[ac++] = mwindow;
+       }
+
        if (keep_partial)
                args[ac++] = "--partial";
 
        if (force_delete)
                args[ac++] = "--force";
 
+       if (delete_after)
+               args[ac++] = "--delete-after";
+
+       if (ignore_errors)
+               args[ac++] = "--ignore-errors";
+
+       if (copy_unsafe_links)
+               args[ac++] = "--copy-unsafe-links";
+
        if (safe_symlinks)
                args[ac++] = "--safe-links";
 
        if (numeric_ids)
                args[ac++] = "--numeric-ids";
 
+       if (only_existing && am_sender)
+               args[ac++] = "--existing";
+
        if (tmpdir) {
                args[ac++] = "--temp-dir";
                args[ac++] = tmpdir;
        }
 
+       if (backup_dir && am_sender) {
+               /* only the receiver needs this option, if we are the sender
+                *   then we need to send it to the receiver.
+                */
+               args[ac++] = "--backup-dir";
+               args[ac++] = backup_dir;
+       }
+
        if (compare_dest && am_sender) {
                /* the server only needs this option if it is not the sender,
                 *   and it may be an older version that doesn't know this