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