2 Copyright (C) Andrew Tridgell 1998
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.
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.
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.
19 /* options parsing code */
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;
69 char *backup_suffix = BACKUP_SUFFIX;
71 char *compare_dest = NULL;
72 char *config_file = RSYNCD_CONF;
73 char *shell_cmd = NULL;
74 char *log_format = NULL;
75 char *password_file = NULL;
76 char *rsync_path = RSYNC_NAME;
77 char *backup_dir = NULL;
78 int rsync_port = RSYNC_PORT;
82 int always_checksum = 0;
85 struct in_addr socket_address = {INADDR_ANY};
89 rprintf(F,"rsync version %s Copyright Andrew Tridgell and Paul Mackerras\n\n",
92 rprintf(F,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
94 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
95 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
96 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
97 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
98 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
99 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
100 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
101 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
102 rprintf(F," sources separated by space as long as they have same top-level\n");
103 rprintf(F,"\nOptions\n");
104 rprintf(F," -v, --verbose increase verbosity\n");
105 rprintf(F," -q, --quiet decrease verbosity\n");
106 rprintf(F," -c, --checksum always checksum\n");
107 rprintf(F," -a, --archive archive mode\n");
108 rprintf(F," -r, --recursive recurse into directories\n");
109 rprintf(F," -R, --relative use relative path names\n");
110 rprintf(F," -b, --backup make backups (default %s suffix)\n",BACKUP_SUFFIX);
111 rprintf(F," --backup-dir make backups into this directory\n");
112 rprintf(F," --suffix=SUFFIX override backup suffix\n");
113 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
114 rprintf(F," -l, --links preserve soft links\n");
115 rprintf(F," -L, --copy-links treat soft links like regular files\n");
116 rprintf(F," --copy-unsafe-links copy links outside the source tree\n");
117 rprintf(F," --safe-links ignore links outside the destination tree\n");
118 rprintf(F," -H, --hard-links preserve hard links\n");
119 rprintf(F," -p, --perms preserve permissions\n");
120 rprintf(F," -o, --owner preserve owner (root only)\n");
121 rprintf(F," -g, --group preserve group\n");
122 rprintf(F," -D, --devices preserve devices (root only)\n");
123 rprintf(F," -t, --times preserve times\n");
124 rprintf(F," -S, --sparse handle sparse files efficiently\n");
125 rprintf(F," -n, --dry-run show what would have been transferred\n");
126 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
127 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
128 rprintf(F," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE);
129 rprintf(F," -e, --rsh=COMMAND specify rsh replacement\n");
130 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
131 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
132 rprintf(F," --existing only update files that already exist\n");
133 rprintf(F," --delete delete files that don't exist on the sending side\n");
134 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
135 rprintf(F," --delete-after delete after transferring, not before\n");
136 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
137 rprintf(F," --partial keep partially transferred files\n");
138 rprintf(F," --force force deletion of directories even if not empty\n");
139 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
140 rprintf(F," --timeout=TIME set IO timeout in seconds\n");
141 rprintf(F," -I, --ignore-times don't exclude files that match length and time\n");
142 rprintf(F," --size-only only use file size when determining if a file should be transferred\n");
143 rprintf(F," -T --temp-dir=DIR create temporary files in directory DIR\n");
144 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
145 rprintf(F," -P equivalent to --partial --progress\n");
146 rprintf(F," -z, --compress compress file data\n");
147 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
148 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
149 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
150 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
151 rprintf(F," --version print version number\n");
152 rprintf(F," --daemon run as a rsync daemon\n");
153 rprintf(F," --address bind to the specified address\n");
154 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
155 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
156 rprintf(F," --stats give some file transfer stats\n");
157 rprintf(F," --progress show progress during transfer\n");
158 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
159 rprintf(F," --password-file=FILE get password from FILE\n");
160 rprintf(F," -h, --help show this help screen\n");
164 rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
165 rprintf(F,"See http://rsync.samba.org/ for updates and bug reports\n");
168 enum {OPT_VERSION, OPT_SUFFIX, OPT_SENDER, OPT_SERVER, OPT_EXCLUDE,
169 OPT_EXCLUDE_FROM, OPT_DELETE, OPT_DELETE_EXCLUDED, OPT_NUMERIC_IDS,
170 OPT_RSYNC_PATH, OPT_FORCE, OPT_TIMEOUT, OPT_DAEMON, OPT_CONFIG, OPT_PORT,
171 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_STATS, OPT_PARTIAL, OPT_PROGRESS,
172 OPT_COPY_UNSAFE_LINKS, OPT_SAFE_LINKS, OPT_COMPARE_DEST,
173 OPT_LOG_FORMAT, OPT_PASSWORD_FILE, OPT_SIZE_ONLY, OPT_ADDRESS,
174 OPT_DELETE_AFTER, OPT_EXISTING, OPT_MAX_DELETE, OPT_BACKUP_DIR};
176 static char *short_options = "oblLWHpguDCtcahvqrRIxnSe:B:T:zP";
178 static struct option long_options[] = {
179 {"version", 0, 0, OPT_VERSION},
180 {"server", 0, 0, OPT_SERVER},
181 {"sender", 0, 0, OPT_SENDER},
182 {"existing", 0, 0, OPT_EXISTING},
183 {"delete", 0, 0, OPT_DELETE},
184 {"delete-excluded", 0, 0, OPT_DELETE_EXCLUDED},
185 {"force", 0, 0, OPT_FORCE},
186 {"numeric-ids", 0, 0, OPT_NUMERIC_IDS},
187 {"exclude", 1, 0, OPT_EXCLUDE},
188 {"exclude-from",1, 0, OPT_EXCLUDE_FROM},
189 {"include", 1, 0, OPT_INCLUDE},
190 {"include-from",1, 0, OPT_INCLUDE_FROM},
191 {"rsync-path", 1, 0, OPT_RSYNC_PATH},
192 {"password-file", 1, 0, OPT_PASSWORD_FILE},
193 {"one-file-system",0, 0, 'x'},
194 {"ignore-times",0, 0, 'I'},
195 {"size-only", 0, 0, OPT_SIZE_ONLY},
197 {"dry-run", 0, 0, 'n'},
198 {"sparse", 0, 0, 'S'},
199 {"cvs-exclude", 0, 0, 'C'},
200 {"archive", 0, 0, 'a'},
201 {"checksum", 0, 0, 'c'},
202 {"backup", 0, 0, 'b'},
203 {"update", 0, 0, 'u'},
204 {"verbose", 0, 0, 'v'},
205 {"quiet", 0, 0, 'q'},
206 {"recursive", 0, 0, 'r'},
207 {"relative", 0, 0, 'R'},
208 {"devices", 0, 0, 'D'},
209 {"perms", 0, 0, 'p'},
210 {"links", 0, 0, 'l'},
211 {"copy-links", 0, 0, 'L'},
212 {"copy-unsafe-links", 0, 0, OPT_COPY_UNSAFE_LINKS},
213 {"safe-links", 0, 0, OPT_SAFE_LINKS},
214 {"whole-file", 0, 0, 'W'},
215 {"hard-links", 0, 0, 'H'},
216 {"owner", 0, 0, 'o'},
217 {"group", 0, 0, 'g'},
218 {"times", 0, 0, 't'},
220 {"suffix", 1, 0, OPT_SUFFIX},
221 {"block-size", 1, 0, 'B'},
222 {"timeout", 1, 0, OPT_TIMEOUT},
223 {"temp-dir", 1, 0, 'T'},
224 {"compare-dest", 1, 0, OPT_COMPARE_DEST},
225 {"compress", 0, 0, 'z'},
226 {"daemon", 0, 0, OPT_DAEMON},
227 {"stats", 0, 0, OPT_STATS},
228 {"progress", 0, 0, OPT_PROGRESS},
229 {"partial", 0, 0, OPT_PARTIAL},
230 {"delete-after",0, 0, OPT_DELETE_AFTER},
231 {"config", 1, 0, OPT_CONFIG},
232 {"port", 1, 0, OPT_PORT},
233 {"log-format", 1, 0, OPT_LOG_FORMAT},
234 {"address", 1, 0, OPT_ADDRESS},
235 {"max-delete", 1, 0, OPT_MAX_DELETE},
236 {"backup-dir", 1, 0, OPT_BACKUP_DIR},
240 static char err_buf[100];
242 void option_error(void)
245 rprintf(FLOG,"%s", err_buf);
246 rprintf(FERROR,"%s", err_buf);
248 rprintf(FLOG,"Error parsing options - unsupported option?\n");
249 rprintf(FERROR,"Error parsing options - unsupported option?\n");
251 exit_cleanup(RERR_UNSUPPORTED);
254 /* check to see if we should refuse this option */
255 static int check_refuse_options(char *ref, int opt)
261 for (i=0; long_options[i].name; i++) {
262 if (long_options[i].val == opt) break;
265 if (!long_options[i].name) return 0;
267 name = long_options[i].name;
270 while ((p = strstr(ref,name))) {
271 if ((p==ref || p[-1]==' ') &&
272 (p[len] == ' ' || p[len] == 0)) {
273 slprintf(err_buf,sizeof(err_buf),
274 "The '%s' option is not supported by this server\n", name);
283 int parse_arguments(int argc, char *argv[], int frommain)
287 char *ref = lp_refuse_options(module_id);
289 while ((opt = getopt_long(argc, argv,
290 short_options, long_options, &option_index))
294 if (check_refuse_options(ref, opt)) return 0;
299 rprintf(FINFO,"rsync version %s protocol version %d\n\n",
300 VERSION,PROTOCOL_VERSION);
301 rprintf(FINFO,"Written by Andrew Tridgell and Paul Mackerras\n");
305 backup_suffix = optarg;
312 case OPT_PASSWORD_FILE:
313 password_file =optarg;
336 case OPT_DELETE_AFTER:
340 case OPT_DELETE_EXCLUDED:
349 case OPT_NUMERIC_IDS:
354 add_exclude(optarg, 0);
358 add_exclude(optarg, 1);
361 case OPT_EXCLUDE_FROM:
362 add_exclude_file(optarg,1, 0);
365 case OPT_INCLUDE_FROM:
366 add_exclude_file(optarg,1, 1);
369 case OPT_COPY_UNSAFE_LINKS:
414 #if SUPPORT_HARD_LINKS
415 preserve_hard_links=1;
417 slprintf(err_buf,sizeof(err_buf),"hard links are not supported on this server\n");
418 rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
452 if (frommain) quiet++;
474 exit_cleanup(RERR_SYNTAX);
492 block_size = atoi(optarg);
496 max_delete = atoi(optarg);
500 io_timeout = atoi(optarg);
507 case OPT_COMPARE_DEST:
508 compare_dest = optarg;
537 config_file = optarg;
541 rsync_port = atoi(optarg);
551 if ((ia = ip_address(optarg))) {
552 socket_address = *ia;
562 slprintf(err_buf,sizeof(err_buf),"unrecognised option\n");
570 /* need to pass all the valid options from the client to the server */
572 void server_options(char **args,int *argc)
575 static char argstr[50];
576 static char bsize[30];
577 static char iotime[30];
578 static char mdelete[30];
581 args[ac++] = "--server";
584 args[ac++] = "--sender";
588 for (i=0;i<verbose;i++)
590 /* the -q option is intentionally left out */
603 if (preserve_hard_links)
609 if (preserve_devices)
633 if (x != 1) args[ac++] = argstr;
635 if (block_size != BLOCK_SIZE) {
636 slprintf(bsize,sizeof(bsize),"-B%d",block_size);
640 if (max_delete && am_sender) {
641 slprintf(mdelete,sizeof(mdelete),"--max-delete=%d",max_delete);
642 args[ac++] = mdelete;
646 slprintf(iotime,sizeof(iotime),"--timeout=%d",io_timeout);
650 if (strcmp(backup_suffix, BACKUP_SUFFIX)) {
651 args[ac++] = "--suffix";
652 args[ac++] = backup_suffix;
655 if (delete_mode && !delete_excluded)
656 args[ac++] = "--delete";
659 args[ac++] = "--delete-excluded";
662 args[ac++] = "--size-only";
665 args[ac++] = "--partial";
668 args[ac++] = "--force";
671 args[ac++] = "--delete-after";
673 if (copy_unsafe_links)
674 args[ac++] = "--copy-unsafe-links";
677 args[ac++] = "--safe-links";
680 args[ac++] = "--numeric-ids";
682 if (only_existing && am_sender)
683 args[ac++] = "--existing";
686 args[ac++] = "--temp-dir";
690 if (backup_dir && am_sender) {
691 /* only the receiver needs this option, if we are the sender
692 * then we need to send it to the receiver.
694 args[ac++] = "--backup-dir";
695 args[ac++] = backup_dir;
698 if (compare_dest && am_sender) {
699 /* the server only needs this option if it is not the sender,
700 * and it may be an older version that doesn't know this
701 * option, so don't send it if client is the sender.
703 args[ac++] = "--compare-dest";
704 args[ac++] = compare_dest;