Doc: Pipe program that makes slow/jerky connections.
[rsync/rsync.git] / options.c
CommitLineData
7a24c346
MP
1/* -*- c-file-style: "linux" -*-
2
2855f61f 3 Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
736a6a29 4 Copyright (C) 2000, 2001, 2002 by Martin Pool <mbp@samba.org>
7a6421fa
AT
5
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.
10
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.
15
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.
19*/
20
7a6421fa 21#include "rsync.h"
2855f61f 22#include "popt.h"
7a6421fa
AT
23
24int make_backups = 0;
1bfbf40b
MP
25
26/**
27 * Should we send the whole file as literal data rather than trying to
28 * create an incremental diff? This is on by default when both source
29 * and destination are local and we're not doing a batch delta,
30 * because there it's no cheaper to read the whole basis file than to
31 * just rewrite it.
32 *
bceec82f
MP
33 * If both are 0, then look at whether we're local or remote and go by
34 * that.
1bfbf40b 35 **/
bceec82f
MP
36int whole_file = 0;
37int no_whole_file = 0;
1bfbf40b 38
7a6421fa
AT
39int copy_links = 0;
40int preserve_links = 0;
41int preserve_hard_links = 0;
42int preserve_perms = 0;
43int preserve_devices = 0;
44int preserve_uid = 0;
45int preserve_gid = 0;
46int preserve_times = 0;
47int update_only = 0;
48int cvs_exclude = 0;
49int dry_run=0;
50int local_server=0;
51int ignore_times=0;
52int delete_mode=0;
b33b791e 53int delete_excluded=0;
7a6421fa
AT
54int one_file_system=0;
55int remote_version=0;
56int sparse_files=0;
57int do_compression=0;
58int am_root=0;
59int orig_umask=0;
60int relative_paths=0;
61int numeric_ids = 0;
62int force_delete = 0;
63int io_timeout = 0;
64int io_error = 0;
65int read_only = 0;
66int module_id = -1;
67int am_server = 0;
30ce7e8a 68int am_sender = 0;
7a6421fa
AT
69int recurse = 0;
70int am_daemon=0;
a800434a 71int do_stats=0;
eb86d661 72int do_progress=0;
c95da96a 73int keep_partial=0;
d853783f 74int safe_symlinks=0;
b5313607 75int copy_unsafe_links=0;
7a6421fa 76int block_size=BLOCK_SIZE;
f83f0548 77int size_only=0;
ef5d23eb 78int bwlimit=0;
57df171b 79int delete_after=0;
1347d512 80int only_existing=0;
3d6feada 81int opt_ignore_existing=0;
0b73ca12 82int max_delete=0;
ef55c686 83int ignore_errors=0;
5b56cc19
AT
84#ifdef _WIN32
85int modify_window=2;
86#else
87int modify_window=0;
88#endif
93689aa5 89int blocking_io=-1;
7a6421fa 90
13e29995 91/** Network address family. **/
6ab6d4bf 92#ifdef INET6
13e29995 93int default_af_hint = 0; /* Any protocol */
6ab6d4bf 94#else
13e29995 95int default_af_hint = AF_INET; /* Must use IPv4 */
6ab6d4bf 96#endif
06963d0f 97
13e29995
MP
98/** Do not go into the background when run as --daemon. Good
99 * for debugging and required for running as a service on W32,
100 * or under Unix process-monitors. **/
101int no_detach = 0;
102
088aac85
DD
103int write_batch = 0;
104int read_batch = 0;
6902ed17 105
7a6421fa
AT
106char *backup_suffix = BACKUP_SUFFIX;
107char *tmpdir = NULL;
375a4556 108char *compare_dest = NULL;
7a6421fa
AT
109char *config_file = RSYNCD_CONF;
110char *shell_cmd = NULL;
b6062654 111char *log_format = NULL;
65575e96 112char *password_file = NULL;
41bd28fe 113char *rsync_path = RSYNC_PATH;
66203a98 114char *backup_dir = NULL;
7a6421fa
AT
115int rsync_port = RSYNC_PORT;
116
117int verbose = 0;
b86f0cef 118int quiet = 0;
7a6421fa 119int always_checksum = 0;
f7632fc6 120int list_only = 0;
7a6421fa 121
088aac85 122char *batch_prefix = NULL;
6902ed17 123
5b56cc19
AT
124static int modify_window_set;
125
06963d0f
MP
126/** Local address to bind. As a character string because it's
127 * interpreted by the IPv6 layer: should be a numeric IP4 or ip6
128 * address, or a hostname. **/
129char *bind_address;
5c9730a4 130
7a24c346 131
27a12348 132static void print_rsync_version(enum logcode f)
7a24c346 133{
0c80cd8e 134 char const *got_socketpair = "no ";
2855f61f
MP
135 char const *hardlinks = "no ";
136 char const *links = "no ";
a358449a 137 char const *ipv6 = "no ";
736a6a29 138 STRUCT_STAT *dumstat;
0c80cd8e
MP
139
140#ifdef HAVE_SOCKETPAIR
141 got_socketpair = "";
142#endif
2855f61f
MP
143
144#if SUPPORT_HARD_LINKS
145 hardlinks = "";
146#endif
147
148#if SUPPORT_LINKS
149 links = "";
150#endif
151
a358449a
MP
152#if INET6
153 ipv6 = "";
154#endif
155
2855f61f 156 rprintf(f, "%s version %s protocol version %d\n",
a358449a 157 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
2855f61f 158 rprintf(f,
0413e160 159 "Copyright (C) 1996-2002 by Andrew Tridgell and others\n");
3b4b1984 160 rprintf(f, "<http://rsync.samba.org/>\n");
2855f61f 161 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
736a6a29 162 "%shard links, %ssymlinks, batchfiles, %sIPv6,\n",
30ce7e8a 163 (int) (sizeof(OFF_T) * 8),
a358449a 164 got_socketpair, hardlinks, links, ipv6);
2855f61f 165
736a6a29
MP
166 /* Note that this field may not have type ino_t. It depends
167 * on the complicated interaction between largefile feature
168 * macros. */
6abd193f 169 rprintf(f, " %d-bit system inums, %d-bit internal inums\n",
736a6a29 170 (int) (sizeof(dumstat->st_ino) * 8),
6abd193f 171 (int) (sizeof(INO64_T) * 8));
736a6a29 172
7a24c346 173#ifdef NO_INT64
4db41492 174 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
7a24c346
MP
175#endif
176}
177
178
0f3203c3 179void usage(enum logcode F)
7a6421fa 180{
2855f61f 181 print_rsync_version(F);
704f908e
AT
182
183 rprintf(F,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
184
9ef53907 185 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
704f908e 186 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
9ef53907 187 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
14d43f1f 188 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
9ef53907 189 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
14d43f1f 190 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
9ef53907
DD
191 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
192 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
193 rprintf(F," sources separated by space as long as they have same top-level\n");
704f908e
AT
194 rprintf(F,"\nOptions\n");
195 rprintf(F," -v, --verbose increase verbosity\n");
b86f0cef 196 rprintf(F," -q, --quiet decrease verbosity\n");
704f908e
AT
197 rprintf(F," -c, --checksum always checksum\n");
198 rprintf(F," -a, --archive archive mode\n");
199 rprintf(F," -r, --recursive recurse into directories\n");
200 rprintf(F," -R, --relative use relative path names\n");
9ef53907 201 rprintf(F," -b, --backup make backups (default %s suffix)\n",BACKUP_SUFFIX);
e20c5e95 202 rprintf(F," --backup-dir make backups into this directory\n");
9ef53907 203 rprintf(F," --suffix=SUFFIX override backup suffix\n");
704f908e 204 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
13e29995
MP
205 rprintf(F," -l, --links copy symlinks as symlinks\n");
206 rprintf(F," -L, --copy-links copy the referent of symlinks\n");
b5313607 207 rprintf(F," --copy-unsafe-links copy links outside the source tree\n");
d853783f 208 rprintf(F," --safe-links ignore links outside the destination tree\n");
704f908e
AT
209 rprintf(F," -H, --hard-links preserve hard links\n");
210 rprintf(F," -p, --perms preserve permissions\n");
211 rprintf(F," -o, --owner preserve owner (root only)\n");
212 rprintf(F," -g, --group preserve group\n");
213 rprintf(F," -D, --devices preserve devices (root only)\n");
214 rprintf(F," -t, --times preserve times\n");
215 rprintf(F," -S, --sparse handle sparse files efficiently\n");
216 rprintf(F," -n, --dry-run show what would have been transferred\n");
217 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
93689aa5 218 rprintf(F," --no-whole-file turn off --whole-file\n");
704f908e 219 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
9ef53907 220 rprintf(F," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE);
704f908e
AT
221 rprintf(F," -e, --rsh=COMMAND specify rsh replacement\n");
222 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
223 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
1347d512 224 rprintf(F," --existing only update files that already exist\n");
3d6feada 225 rprintf(F," --ignore-existing ignore files that already exist on the receiving side\n");
704f908e 226 rprintf(F," --delete delete files that don't exist on the sending side\n");
b33b791e 227 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
57df171b 228 rprintf(F," --delete-after delete after transferring, not before\n");
ef55c686 229 rprintf(F," --ignore-errors delete even if there are IO errors\n");
0b73ca12 230 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
c95da96a 231 rprintf(F," --partial keep partially transferred files\n");
704f908e
AT
232 rprintf(F," --force force deletion of directories even if not empty\n");
233 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
234 rprintf(F," --timeout=TIME set IO timeout in seconds\n");
235 rprintf(F," -I, --ignore-times don't exclude files that match length and time\n");
f83f0548 236 rprintf(F," --size-only only use file size when determining if a file should be transferred\n");
5b56cc19 237 rprintf(F," --modify-window=NUM Timestamp window (seconds) for file match (default=%d)\n",modify_window);
704f908e 238 rprintf(F," -T --temp-dir=DIR create temporary files in directory DIR\n");
375a4556 239 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
d9fcc198 240 rprintf(F," -P equivalent to --partial --progress\n");
704f908e 241 rprintf(F," -z, --compress compress file data\n");
2acf81eb 242 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
858fb9eb 243 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
2acf81eb 244 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
858fb9eb 245 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
704f908e
AT
246 rprintf(F," --version print version number\n");
247 rprintf(F," --daemon run as a rsync daemon\n");
a538066d 248 rprintf(F," --no-detach do not detach from the parent\n");
2a951cd2 249 rprintf(F," --address=ADDRESS bind to the specified address\n");
704f908e
AT
250 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
251 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
c80ccabb 252 rprintf(F," --blocking-io use blocking IO for the remote shell\n");
93689aa5 253 rprintf(F," --no-blocking-io turn off --blocking-io\n");
704f908e 254 rprintf(F," --stats give some file transfer stats\n");
eb86d661 255 rprintf(F," --progress show progress during transfer\n");
b6062654 256 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
65575e96 257 rprintf(F," --password-file=FILE get password from FILE\n");
ef5d23eb 258 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
088aac85
DD
259 rprintf(F," --write-batch=PREFIX write batch fileset starting with PREFIX\n");
260 rprintf(F," --read-batch=PREFIX read batch fileset starting with PREFIX\n");
704f908e 261 rprintf(F," -h, --help show this help screen\n");
06963d0f
MP
262#ifdef INET6
263 rprintf(F," -4 prefer IPv4\n");
264 rprintf(F," -6 prefer IPv6\n");
265#endif
7a6421fa
AT
266
267 rprintf(F,"\n");
b72f24c7
AT
268
269 rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
2855f61f 270 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
7a6421fa
AT
271}
272
2855f61f 273enum {OPT_VERSION = 1000, OPT_SUFFIX, OPT_SENDER, OPT_SERVER, OPT_EXCLUDE,
b33b791e
DD
274 OPT_EXCLUDE_FROM, OPT_DELETE, OPT_DELETE_EXCLUDED, OPT_NUMERIC_IDS,
275 OPT_RSYNC_PATH, OPT_FORCE, OPT_TIMEOUT, OPT_DAEMON, OPT_CONFIG, OPT_PORT,
d853783f 276 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_STATS, OPT_PARTIAL, OPT_PROGRESS,
b5313607 277 OPT_COPY_UNSAFE_LINKS, OPT_SAFE_LINKS, OPT_COMPARE_DEST,
57df171b 278 OPT_LOG_FORMAT, OPT_PASSWORD_FILE, OPT_SIZE_ONLY, OPT_ADDRESS,
ef55c686 279 OPT_DELETE_AFTER, OPT_EXISTING, OPT_MAX_DELETE, OPT_BACKUP_DIR,
5b56cc19 280 OPT_IGNORE_ERRORS, OPT_BWLIMIT, OPT_BLOCKING_IO,
93689aa5 281 OPT_NO_BLOCKING_IO, OPT_NO_WHOLE_FILE,
3d6feada 282 OPT_MODIFY_WINDOW, OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_IGNORE_EXISTING};
7a6421fa 283
2855f61f
MP
284static struct poptOption long_options[] = {
285 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
8b54f004
MP
286 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
287 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
288 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
289 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
290 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times , 0, 0, 0 },
291 {"size-only", 0, POPT_ARG_NONE, &size_only , 0, 0, 0 },
292 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
293 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system , 0, 0, 0 },
294 {"delete", 0, POPT_ARG_NONE, &delete_mode , 0, 0, 0 },
295 {"existing", 0, POPT_ARG_NONE, &only_existing , 0, 0, 0 },
296 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing , 0, 0, 0 },
297 {"delete-after", 0, POPT_ARG_NONE, &delete_after , 0, 0, 0 },
298 {"delete-excluded", 0, POPT_ARG_NONE, 0, OPT_DELETE_EXCLUDED, 0, 0 },
299 {"force", 0, POPT_ARG_NONE, &force_delete , 0, 0, 0 },
300 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids , 0, 0, 0 },
301 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
302 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
303 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
304 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
305 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks , 0, 0, 0 },
306 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
307 {"backup", 'b', POPT_ARG_NONE, &make_backups , 0, 0, 0 },
308 {"dry-run", 'n', POPT_ARG_NONE, &dry_run , 0, 0, 0 },
309 {"sparse", 'S', POPT_ARG_NONE, &sparse_files , 0, 0, 0 },
310 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude , 0, 0, 0 },
311 {"update", 'u', POPT_ARG_NONE, &update_only , 0, 0, 0 },
312 {"links", 'l', POPT_ARG_NONE, &preserve_links , 0, 0, 0 },
313 {"copy-links", 'L', POPT_ARG_NONE, &copy_links , 0, 0, 0 },
314 {"whole-file", 'W', POPT_ARG_NONE, &whole_file , 0, 0, 0 },
315 {"no-whole-file", 0, POPT_ARG_NONE, &no_whole_file , 0, 0, 0 },
316 {"copy-unsafe-links", 0, POPT_ARG_NONE, &copy_unsafe_links , 0, 0, 0 },
317 {"perms", 'p', POPT_ARG_NONE, &preserve_perms , 0, 0, 0 },
318 {"owner", 'o', POPT_ARG_NONE, &preserve_uid , 0, 0, 0 },
319 {"group", 'g', POPT_ARG_NONE, &preserve_gid , 0, 0, 0 },
320 {"devices", 'D', POPT_ARG_NONE, &preserve_devices , 0, 0, 0 },
321 {"times", 't', POPT_ARG_NONE, &preserve_times , 0, 0, 0 },
322 {"checksum", 'c', POPT_ARG_NONE, &always_checksum , 0, 0, 0 },
323 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
324 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
325 {"archive", 'a', POPT_ARG_NONE, 0, 'a', 0, 0 },
326 {"server", 0, POPT_ARG_NONE, &am_server , 0, 0, 0 },
327 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
328 {"recursive", 'r', POPT_ARG_NONE, &recurse , 0, 0, 0 },
329 {"relative", 'R', POPT_ARG_NONE, &relative_paths , 0, 0, 0 },
330 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd , 0, 0, 0 },
331 {"block-size", 'B', POPT_ARG_INT, &block_size , 0, 0, 0 },
332 {"max-delete", 0, POPT_ARG_INT, &max_delete , 0, 0, 0 },
333 {"timeout", 0, POPT_ARG_INT, &io_timeout , 0, 0, 0 },
334 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir , 0, 0, 0 },
335 {"compare-dest", 0, POPT_ARG_STRING, &compare_dest , 0, 0, 0 },
2855f61f 336 /* TODO: Should this take an optional int giving the compression level? */
8b54f004
MP
337 {"compress", 'z', POPT_ARG_NONE, &do_compression , 0, 0, 0 },
338 {"daemon", 0, POPT_ARG_NONE, &am_daemon , 0, 0, 0 },
339 {"no-detach", 0, POPT_ARG_NONE, &no_detach , 0, 0, 0 },
340 {"stats", 0, POPT_ARG_NONE, &do_stats , 0, 0, 0 },
341 {"progress", 0, POPT_ARG_NONE, &do_progress , 0, 0, 0 },
342 {"partial", 0, POPT_ARG_NONE, &keep_partial , 0, 0, 0 },
343 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors , 0, 0, 0 },
344 {"blocking-io", 0, POPT_ARG_NONE, &blocking_io , 0, 0, 0 },
345 {"no-blocking-io", 0, POPT_ARG_NONE, 0, OPT_NO_BLOCKING_IO, 0, 0 },
346 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
347 {"config", 0, POPT_ARG_STRING, &config_file , 0, 0, 0 },
348 {"port", 0, POPT_ARG_INT, &rsync_port , 0, 0, 0 },
349 {"log-format", 0, POPT_ARG_STRING, &log_format , 0, 0, 0 },
350 {"bwlimit", 0, POPT_ARG_INT, &bwlimit , 0, 0, 0 },
351 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
352 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir , 0, 0, 0 },
353 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links , 0, 0, 0 },
354 {"read-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_READ_BATCH, 0, 0 },
355 {"write-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_WRITE_BATCH, 0, 0 },
06963d0f 356#ifdef INET6
8b54f004
MP
357 {0, '4', POPT_ARG_VAL, &default_af_hint, AF_INET , 0, 0 },
358 {0, '6', POPT_ARG_VAL, &default_af_hint, AF_INET6 , 0, 0 },
06963d0f 359#endif
8b54f004 360 {0,0,0,0, 0, 0, 0}
2855f61f 361};
7a6421fa 362
06963d0f 363
cd8185f2
AT
364static char err_buf[100];
365
2855f61f 366
add7e8fb
MP
367/* We store the option error message, if any, so that we can log the
368 connection attempt (which requires parsing the options), and then
369 show the error later on. */
cd8185f2
AT
370void option_error(void)
371{
372 if (err_buf[0]) {
2855f61f
MP
373 rprintf(FLOG, "%s", err_buf);
374 rprintf(FERROR, "%s: %s", RSYNC_NAME, err_buf);
cd8185f2 375 } else {
add7e8fb
MP
376 rprintf (FERROR, "Error parsing options: "
377 "option may be supported on client but not on server?\n");
378 rprintf (FERROR, RSYNC_NAME ": Error parsing options: "
379 "option may be supported on client but not on server?\n");
cd8185f2 380 }
cd8185f2
AT
381}
382
383/* check to see if we should refuse this option */
384static int check_refuse_options(char *ref, int opt)
385{
386 int i, len;
387 char *p;
388 const char *name;
389
2855f61f 390 for (i=0; long_options[i].longName; i++) {
cd8185f2
AT
391 if (long_options[i].val == opt) break;
392 }
393
2855f61f 394 if (!long_options[i].longName) return 0;
cd8185f2 395
2855f61f 396 name = long_options[i].longName;
cd8185f2
AT
397 len = strlen(name);
398
399 while ((p = strstr(ref,name))) {
055af776
AT
400 if ((p==ref || p[-1]==' ') &&
401 (p[len] == ' ' || p[len] == 0)) {
8950ac03 402 snprintf(err_buf,sizeof(err_buf),
cd8185f2
AT
403 "The '%s' option is not supported by this server\n", name);
404 return 1;
405 }
406 ref += len;
407 }
408 return 0;
409}
410
411
2855f61f
MP
412static int count_args(char const **argv)
413{
414 int i = 0;
415
416 while (argv[i] != NULL)
417 i++;
418
419 return i;
420}
421
422
423/* Process command line arguments. Called on both local and remote.
424 * Returns if all options are OK, otherwise fills in err_buf and
425 * returns 0. */
426int parse_arguments(int *argc, const char ***argv, int frommain)
7a6421fa 427{
d853783f 428 int opt;
cd8185f2 429 char *ref = lp_refuse_options(module_id);
2855f61f 430 poptContext pc;
d853783f 431
2855f61f 432 /* TODO: Call poptReadDefaultConfig; handle errors. */
cd8185f2 433
2855f61f
MP
434 /* The context leaks in case of an error, but if there's a
435 * problem we always exit anyhow. */
4db41492 436 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
2855f61f
MP
437
438 while ((opt = poptGetNextOpt(pc)) != -1) {
cd8185f2
AT
439 if (ref) {
440 if (check_refuse_options(ref, opt)) return 0;
441 }
442
2855f61f
MP
443 /* most options are handled automatically by popt;
444 * only special cases are returned and listed here. */
445
d853783f
AT
446 switch (opt) {
447 case OPT_VERSION:
2855f61f 448 print_rsync_version(FINFO);
d853783f
AT
449 exit_cleanup(0);
450
5b56cc19 451 case OPT_MODIFY_WINDOW:
2855f61f
MP
452 /* The value has already been set by popt, but
453 * we need to remember that we're using a
454 * non-default setting. */
5b56cc19
AT
455 modify_window_set = 1;
456 break;
457
b33b791e
DD
458 case OPT_DELETE_EXCLUDED:
459 delete_excluded = 1;
460 delete_mode = 1;
461 break;
462
d853783f 463 case OPT_EXCLUDE:
2855f61f 464 add_exclude(poptGetOptArg(pc), 0);
d853783f
AT
465 break;
466
467 case OPT_INCLUDE:
2855f61f 468 add_exclude(poptGetOptArg(pc), 1);
d853783f
AT
469 break;
470
471 case OPT_EXCLUDE_FROM:
2855f61f 472 add_exclude_file(poptGetOptArg(pc), 1, 0);
d853783f
AT
473 break;
474
93695764
DD
475 case OPT_INCLUDE_FROM:
476 add_exclude_file(poptGetOptArg(pc), 1, 1);
477 break;
478
93689aa5
DD
479 case OPT_NO_BLOCKING_IO:
480 blocking_io = 0;
d853783f
AT
481 break;
482
483 case 'h':
484 usage(FINFO);
485 exit_cleanup(0);
486
d853783f 487 case 'H':
7a6421fa 488#if SUPPORT_HARD_LINKS
d853783f 489 preserve_hard_links=1;
2855f61f
MP
490#else
491 /* FIXME: Don't say "server" if this is
492 * happening on the client. */
493 /* FIXME: Why do we have the duplicated
494 * rprintf? Everybody who gets this message
495 * ought to send it to the client and also to
496 * the logs. */
8950ac03 497 snprintf(err_buf,sizeof(err_buf),
2855f61f
MP
498 "hard links are not supported on this %s\n",
499 am_server ? "server" : "client");
d853783f 500 rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
b11ed3b1 501 return 0;
2855f61f 502#endif /* SUPPORT_HARD_LINKS */
d853783f 503 break;
7a6421fa 504
d853783f
AT
505 case 'v':
506 verbose++;
507 break;
7a6421fa 508
b86f0cef
DD
509 case 'q':
510 if (frommain) quiet++;
511 break;
512
d853783f
AT
513 case 'a':
514 recurse=1;
7a6421fa 515#if SUPPORT_LINKS
d853783f 516 preserve_links=1;
7a6421fa 517#endif
d853783f
AT
518 preserve_perms=1;
519 preserve_times=1;
520 preserve_gid=1;
e20c5e95
AT
521 preserve_uid=1;
522 preserve_devices=1;
d853783f
AT
523 break;
524
d853783f
AT
525 case OPT_SENDER:
526 if (!am_server) {
527 usage(FERROR);
65417579 528 exit_cleanup(RERR_SYNTAX);
d853783f
AT
529 }
530 am_sender = 1;
531 break;
532
d9fcc198
AT
533 case 'P':
534 do_progress = 1;
535 keep_partial = 1;
536 break;
537
088aac85
DD
538 case OPT_WRITE_BATCH:
539 /* popt stores the filename in batch_prefix for us */
540 write_batch = 1;
541 break;
542
76f79ba7 543 case OPT_READ_BATCH:
088aac85 544 /* popt stores the filename in batch_prefix for us */
6902ed17
MP
545 read_batch = 1;
546 break;
547
d853783f 548 default:
2855f61f
MP
549 /* FIXME: If --daemon is specified, then errors for later
550 * parameters seem to disappear. */
8950ac03 551 snprintf(err_buf, sizeof(err_buf),
2855f61f
MP
552 "%s%s: %s\n",
553 am_server ? "on remote machine: " : "",
554 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
555 poptStrerror(opt));
556 return 0;
d853783f 557 }
7a6421fa 558 }
2855f61f 559
088aac85
DD
560 if (write_batch && read_batch) {
561 snprintf(err_buf,sizeof(err_buf),
562 "write-batch and read-batch can not be used together\n");
563 rprintf(FERROR,"ERROR: write-batch and read-batch"
564 " can not be used together\n");
565 return 0;
566 }
567
568 if (do_compression && (write_batch || read_batch)) {
569 snprintf(err_buf,sizeof(err_buf),
570 "compress can not be used with write-batch or read-batch\n");
571 rprintf(FERROR,"ERROR: compress can not be used with"
572 " write-batch or read-batch\n");
573 return 0;
574 }
575
2855f61f
MP
576 *argv = poptGetArgs(pc);
577 if (*argv)
578 *argc = count_args(*argv);
579 else
580 *argc = 0;
581
b11ed3b1 582 return 1;
7a6421fa
AT
583}
584
585
2855f61f
MP
586/* Construct a filtered list of options to pass through from the
587 * client to the server */
7a6421fa
AT
588void server_options(char **args,int *argc)
589{
d853783f
AT
590 int ac = *argc;
591 static char argstr[50];
592 static char bsize[30];
593 static char iotime[30];
0b73ca12 594 static char mdelete[30];
5b56cc19 595 static char mwindow[30];
ef5d23eb 596 static char bw[50];
088aac85
DD
597 /* Leave room for ``--(write|read)-batch='' */
598 static char fext[MAXPATHLEN + 15];
ef5d23eb 599
d853783f
AT
600 int i, x;
601
93689aa5
DD
602 if (blocking_io == -1)
603 blocking_io = 0;
604
d853783f
AT
605 args[ac++] = "--server";
606
607 if (!am_sender)
608 args[ac++] = "--sender";
609
610 x = 1;
611 argstr[0] = '-';
612 for (i=0;i<verbose;i++)
613 argstr[x++] = 'v';
f0b36a48 614
b86f0cef 615 /* the -q option is intentionally left out */
d853783f
AT
616 if (make_backups)
617 argstr[x++] = 'b';
618 if (update_only)
619 argstr[x++] = 'u';
620 if (dry_run)
621 argstr[x++] = 'n';
622 if (preserve_links)
623 argstr[x++] = 'l';
624 if (copy_links)
625 argstr[x++] = 'L';
1bfbf40b 626
8469faef 627 assert(whole_file == 0 || whole_file == 1);
d853783f
AT
628 if (whole_file)
629 argstr[x++] = 'W';
bceec82f
MP
630 /* We don't need to send --no-whole-file, because it's the
631 * default for remote transfers, and in any case old versions
632 * of rsync will not understand it. */
1bfbf40b 633
d853783f
AT
634 if (preserve_hard_links)
635 argstr[x++] = 'H';
636 if (preserve_uid)
637 argstr[x++] = 'o';
638 if (preserve_gid)
639 argstr[x++] = 'g';
640 if (preserve_devices)
641 argstr[x++] = 'D';
642 if (preserve_times)
643 argstr[x++] = 't';
644 if (preserve_perms)
645 argstr[x++] = 'p';
646 if (recurse)
647 argstr[x++] = 'r';
648 if (always_checksum)
649 argstr[x++] = 'c';
650 if (cvs_exclude)
651 argstr[x++] = 'C';
652 if (ignore_times)
653 argstr[x++] = 'I';
654 if (relative_paths)
655 argstr[x++] = 'R';
656 if (one_file_system)
657 argstr[x++] = 'x';
658 if (sparse_files)
659 argstr[x++] = 'S';
660 if (do_compression)
661 argstr[x++] = 'z';
f0b36a48
AT
662
663 /* this is a complete hack - blame Rusty
664
665 this is a hack to make the list_only (remote file list)
666 more useful */
667 if (list_only && !recurse)
668 argstr[x++] = 'r';
669
d853783f
AT
670 argstr[x] = 0;
671
672 if (x != 1) args[ac++] = argstr;
673
674 if (block_size != BLOCK_SIZE) {
8950ac03 675 snprintf(bsize,sizeof(bsize),"-B%d",block_size);
d853783f
AT
676 args[ac++] = bsize;
677 }
678
0b73ca12 679 if (max_delete && am_sender) {
8950ac03 680 snprintf(mdelete,sizeof(mdelete),"--max-delete=%d",max_delete);
0b73ca12
AT
681 args[ac++] = mdelete;
682 }
6902ed17 683
088aac85
DD
684 if (batch_prefix != NULL) {
685 char *fmt = "";
686 if (write_batch)
687 fmt = "--write-batch=%s";
688 else
689 if (read_batch)
690 fmt = "--read-batch=%s";
691 snprintf(fext,sizeof(fext),fmt,batch_prefix);
6902ed17
MP
692 args[ac++] = fext;
693 }
0b73ca12 694
d853783f 695 if (io_timeout) {
8950ac03 696 snprintf(iotime,sizeof(iotime),"--timeout=%d",io_timeout);
d853783f
AT
697 args[ac++] = iotime;
698 }
699
ef5d23eb 700 if (bwlimit) {
8950ac03 701 snprintf(bw,sizeof(bw),"--bwlimit=%d",bwlimit);
ef5d23eb
DD
702 args[ac++] = bw;
703 }
704
d853783f
AT
705 if (strcmp(backup_suffix, BACKUP_SUFFIX)) {
706 args[ac++] = "--suffix";
707 args[ac++] = backup_suffix;
708 }
709
b33b791e 710 if (delete_mode && !delete_excluded)
d853783f
AT
711 args[ac++] = "--delete";
712
b33b791e
DD
713 if (delete_excluded)
714 args[ac++] = "--delete-excluded";
715
f83f0548
AT
716 if (size_only)
717 args[ac++] = "--size-only";
718
5b56cc19 719 if (modify_window_set) {
8950ac03 720 snprintf(mwindow,sizeof(mwindow),"--modify-window=%d",
5b56cc19
AT
721 modify_window);
722 args[ac++] = mwindow;
723 }
724
d853783f
AT
725 if (keep_partial)
726 args[ac++] = "--partial";
727
728 if (force_delete)
729 args[ac++] = "--force";
730
57df171b
AT
731 if (delete_after)
732 args[ac++] = "--delete-after";
733
ef55c686
AT
734 if (ignore_errors)
735 args[ac++] = "--ignore-errors";
736
b5313607
DD
737 if (copy_unsafe_links)
738 args[ac++] = "--copy-unsafe-links";
739
d853783f
AT
740 if (safe_symlinks)
741 args[ac++] = "--safe-links";
742
743 if (numeric_ids)
744 args[ac++] = "--numeric-ids";
745
0b73ca12 746 if (only_existing && am_sender)
1347d512
AT
747 args[ac++] = "--existing";
748
3d6feada
MP
749 if (opt_ignore_existing && am_sender)
750 args[ac++] = "--ignore-existing";
751
d853783f
AT
752 if (tmpdir) {
753 args[ac++] = "--temp-dir";
754 args[ac++] = tmpdir;
755 }
756
66203a98
AT
757 if (backup_dir && am_sender) {
758 /* only the receiver needs this option, if we are the sender
759 * then we need to send it to the receiver.
760 */
761 args[ac++] = "--backup-dir";
762 args[ac++] = backup_dir;
763 }
764
375a4556
DD
765 if (compare_dest && am_sender) {
766 /* the server only needs this option if it is not the sender,
767 * and it may be an older version that doesn't know this
768 * option, so don't send it if client is the sender.
769 */
770 args[ac++] = "--compare-dest";
771 args[ac++] = compare_dest;
772 }
773
d853783f 774 *argc = ac;
7a6421fa
AT
775}
776