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