Improved the description of the --compress (-z) option.
[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 23
7bc90b30 24extern int module_id;
7be73df4 25extern int sanitize_paths;
99218d82 26extern int select_timeout;
7842418b
WD
27extern struct filter_list_struct filter_list;
28extern struct filter_list_struct server_filter_list;
8645af1d 29
7a6421fa 30int make_backups = 0;
1bfbf40b
MP
31
32/**
dfa32483 33 * If 1, send the whole file as literal data rather than trying to
dafe63ca 34 * create an incremental diff.
1bfbf40b 35 *
dfa32483 36 * If -1, then look at whether we're local or remote and go by that.
dafe63ca
MP
37 *
38 * @sa disable_deltas_p()
1bfbf40b 39 **/
dfa32483 40int whole_file = -1;
1bfbf40b 41
dfa32483 42int archive_mode = 0;
716e73d4 43int keep_dirlinks = 0;
7a6421fa
AT
44int copy_links = 0;
45int preserve_links = 0;
46int preserve_hard_links = 0;
47int preserve_perms = 0;
48int preserve_devices = 0;
49int preserve_uid = 0;
50int preserve_gid = 0;
51int preserve_times = 0;
20fb7b91 52int omit_dir_times = 0;
7a6421fa
AT
53int update_only = 0;
54int cvs_exclude = 0;
a5c11139 55int dry_run = 0;
a5c11139
WD
56int ignore_times = 0;
57int delete_mode = 0;
a51b3168 58int delete_during = 0;
51d48398
WD
59int delete_before = 0;
60int delete_after = 0;
a5c11139
WD
61int delete_excluded = 0;
62int one_file_system = 0;
4f3e9a0f 63int protocol_version = PROTOCOL_VERSION;
a5c11139
WD
64int sparse_files = 0;
65int do_compression = 0;
66int am_root = 0;
67int orig_umask = 0;
ea5164d1
WD
68int relative_paths = -1;
69int implied_dirs = 1;
7a6421fa
AT
70int numeric_ids = 0;
71int force_delete = 0;
72int io_timeout = 0;
7a6421fa 73int am_server = 0;
f1d5ba40 74int am_sender = -1;
4337c8f8 75int am_generator = 0;
ea5164d1
WD
76char *files_from = NULL;
77int filesfrom_fd = -1;
78char *remote_filesfrom_file = NULL;
79int eol_nulls = 0;
7a6421fa 80int recurse = 0;
65e4cda0 81int xfer_dirs = 0;
1312d9fc
WD
82int am_daemon = 0;
83int daemon_over_rsh = 0;
a5c11139
WD
84int do_stats = 0;
85int do_progress = 0;
86int keep_partial = 0;
87int safe_symlinks = 0;
88int copy_unsafe_links = 0;
89int size_only = 0;
9fb08441 90int daemon_bwlimit = 0;
a5c11139 91int bwlimit = 0;
3c74c3a3 92size_t bwlimit_writemax = 0;
a5c11139
WD
93int only_existing = 0;
94int opt_ignore_existing = 0;
95int max_delete = 0;
7d5acf1d 96OFF_T max_size = 0;
a5c11139
WD
97int ignore_errors = 0;
98int modify_window = 0;
99int blocking_io = -1;
2289bf64 100int checksum_seed = 0;
a3221d2a 101int inplace = 0;
f06e7082 102int delay_updates = 0;
a06b419d 103long block_size = 0; /* "long" because popt can't set an int32. */
7a6421fa 104
b35d0d8e 105
13e29995 106/** Network address family. **/
25ff0441 107#if INET6
13e29995 108int default_af_hint = 0; /* Any protocol */
6ab6d4bf 109#else
13e29995 110int default_af_hint = AF_INET; /* Must use IPv4 */
6ab6d4bf 111#endif
06963d0f 112
13e29995
MP
113/** Do not go into the background when run as --daemon. Good
114 * for debugging and required for running as a service on W32,
115 * or under Unix process-monitors. **/
116int no_detach = 0;
117
088aac85
DD
118int write_batch = 0;
119int read_batch = 0;
d175d7e1
WD
120int backup_dir_len = 0;
121int backup_suffix_len;
e0391f81 122unsigned int backup_dir_remainder;
6902ed17 123
d175d7e1 124char *backup_suffix = NULL;
7a6421fa 125char *tmpdir = NULL;
a7260c40 126char *partial_dir = NULL;
e012f858 127char *basis_dir[MAX_BASIS_DIRS+1];
30e8c8e1 128char *config_file = NULL;
7a6421fa 129char *shell_cmd = NULL;
b6062654 130char *log_format = NULL;
65575e96 131char *password_file = NULL;
41bd28fe 132char *rsync_path = RSYNC_PATH;
66203a98 133char *backup_dir = NULL;
e0391f81 134char backup_dir_buf[MAXPATHLEN];
0c56b1ad 135int rsync_port = 0;
dfd7d541 136int compare_dest = 0;
e012f858 137int copy_dest = 0;
59c95e42 138int link_dest = 0;
ce0b384f 139int basis_dir_cnt = 0;
7a6421fa
AT
140
141int verbose = 0;
b86f0cef 142int quiet = 0;
7a6421fa 143int always_checksum = 0;
f7632fc6 144int list_only = 0;
7a6421fa 145
9b3318b0
WD
146#define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
147char *batch_name = NULL;
6902ed17 148
e1add893 149static int daemon_opt; /* sets am_daemon after option error-reporting */
aa4d3b4c 150static int F_option_cnt = 0;
5b56cc19 151static int modify_window_set;
3671987f
WD
152static int refused_verbose, refused_delete, refused_archive_part;
153static int refused_partial, refused_progress;
12a79db2 154static char *dest_option = NULL;
7d5acf1d 155static char *max_size_arg;
3671987f 156static char partialdir_for_delayupdate[] = ".~tmp~";
5b56cc19 157
06963d0f 158/** Local address to bind. As a character string because it's
fdf57ede 159 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
06963d0f
MP
160 * address, or a hostname. **/
161char *bind_address;
5c9730a4 162
7a24c346 163
27a12348 164static void print_rsync_version(enum logcode f)
7a24c346 165{
dfa32483 166 char const *got_socketpair = "no ";
a3221d2a 167 char const *have_inplace = "no ";
dfa32483
WD
168 char const *hardlinks = "no ";
169 char const *links = "no ";
a358449a 170 char const *ipv6 = "no ";
736a6a29 171 STRUCT_STAT *dumstat;
0c80cd8e 172
25ff0441 173#if HAVE_SOCKETPAIR
dfa32483 174 got_socketpair = "";
0c80cd8e 175#endif
2855f61f 176
a3221d2a
WD
177#if HAVE_FTRUNCATE
178 have_inplace = "";
179#endif
180
2855f61f 181#if SUPPORT_HARD_LINKS
dfa32483 182 hardlinks = "";
2855f61f
MP
183#endif
184
185#if SUPPORT_LINKS
dfa32483 186 links = "";
2855f61f
MP
187#endif
188
a358449a
MP
189#if INET6
190 ipv6 = "";
dfa32483 191#endif
a358449a 192
dfa32483
WD
193 rprintf(f, "%s version %s protocol version %d\n",
194 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
195 rprintf(f,
72a90c75 196 "Copyright (C) 1996-2005 by Andrew Tridgell and others\n");
3b4b1984 197 rprintf(f, "<http://rsync.samba.org/>\n");
dfa32483
WD
198 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
199 "%shard links, %ssymlinks, batchfiles, \n",
a5c11139 200 (int) (sizeof (OFF_T) * 8),
dfa32483 201 got_socketpair, hardlinks, links);
2855f61f 202
736a6a29
MP
203 /* Note that this field may not have type ino_t. It depends
204 * on the complicated interaction between largefile feature
205 * macros. */
a3221d2a
WD
206 rprintf(f, " %sinplace, %sIPv6, %d-bit system inums, %d-bit internal inums\n",
207 have_inplace, ipv6,
a5c11139 208 (int) (sizeof dumstat->st_ino * 8),
1490812a 209 (int) (sizeof (int64) * 8));
fc0302cf
MP
210#ifdef MAINTAINER_MODE
211 rprintf(f, " panic action: \"%s\"\n",
212 get_panic_action());
213#endif
736a6a29 214
031fa9ad
WD
215#if SIZEOF_INT64 < 8
216 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
7a24c346 217#endif
c561edaa
WD
218 if (sizeof (int64) != SIZEOF_INT64) {
219 rprintf(f,
220 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
221 (int) SIZEOF_INT64, (int) sizeof (int64));
222 }
7b329a2d
MP
223
224 rprintf(f,
225"\n"
226"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
227"are welcome to redistribute it under certain conditions. See the GNU\n"
228"General Public Licence for details.\n"
229 );
7a24c346
MP
230}
231
232
0f3203c3 233void usage(enum logcode F)
7a6421fa 234{
2855f61f 235 print_rsync_version(F);
704f908e 236
3ff984d7 237 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
704f908e 238
9ef53907 239 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
704f908e 240 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
9ef53907 241 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
14d43f1f 242 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
9ef53907 243 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
14d43f1f 244 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
eaa4c150 245 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
9ef53907
DD
246 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
247 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
248 rprintf(F," sources separated by space as long as they have same top-level\n");
704f908e
AT
249 rprintf(F,"\nOptions\n");
250 rprintf(F," -v, --verbose increase verbosity\n");
b3708acf
WD
251 rprintf(F," -q, --quiet suppress non-error messages\n");
252 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
253 rprintf(F," -a, --archive archive mode; same as -rlptgoD (no -H)\n");
704f908e
AT
254 rprintf(F," -r, --recursive recurse into directories\n");
255 rprintf(F," -R, --relative use relative path names\n");
ea5164d1
WD
256 rprintf(F," --no-relative turn off --relative\n");
257 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
6839140e 258 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
b3708acf
WD
259 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
260 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
261 rprintf(F," -u, --update skip files that are newer on the receiver\n");
4ce838e1 262 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
65e4cda0 263 rprintf(F," -d, --dirs transfer directories without recursing\n");
13e29995 264 rprintf(F," -l, --links copy symlinks as symlinks\n");
b3708acf
WD
265 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
266 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
267 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
704f908e 268 rprintf(F," -H, --hard-links preserve hard links\n");
65e4cda0 269 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
704f908e
AT
270 rprintf(F," -p, --perms preserve permissions\n");
271 rprintf(F," -o, --owner preserve owner (root only)\n");
272 rprintf(F," -g, --group preserve group\n");
273 rprintf(F," -D, --devices preserve devices (root only)\n");
dfa32483 274 rprintf(F," -t, --times preserve times\n");
20fb7b91 275 rprintf(F," -O, --omit-dir-times omit directories when preserving times\n");
704f908e
AT
276 rprintf(F," -S, --sparse handle sparse files efficiently\n");
277 rprintf(F," -n, --dry-run show what would have been transferred\n");
b3708acf
WD
278 rprintf(F," -W, --whole-file copy files whole\n");
279 rprintf(F," --no-whole-file always use incremental rsync algorithm\n");
704f908e 280 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
9cd339eb 281 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
b3708acf 282 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
704f908e 283 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
b3708acf 284 rprintf(F," --existing only update files that already exist on receiver\n");
6839140e 285 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
3359acb8 286 rprintf(F," --del an alias for --delete-during\n");
704f908e 287 rprintf(F," --delete delete files that don't exist on the sending side\n");
c6eb7fad 288 rprintf(F," --delete-before receiver deletes before transfer (default)\n");
3359acb8
WD
289 rprintf(F," --delete-during receiver deletes during transfer, not before\n");
290 rprintf(F," --delete-after receiver deletes after transfer, not before\n");
51d48398 291 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
db2b5cb7 292 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
51d48398 293 rprintf(F," --force force deletion of directories even if not empty\n");
0b73ca12 294 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
7d5acf1d 295 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
c95da96a 296 rprintf(F," --partial keep partially transferred files\n");
a7260c40 297 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
b3708acf 298 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
704f908e 299 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
db2b5cb7 300 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
b3708acf
WD
301 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
302 rprintf(F," --size-only skip files that match in size\n");
303 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
4db88e5b 304 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
375a4556 305 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
e012f858
WD
306 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
307 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
f924946e 308 rprintf(F," -z, --compress compress file data during the transfer\n");
b3708acf 309 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
aa4d3b4c
WD
310 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
311 rprintf(F," -F same as --filter=': /.rsync-filter'\n");
312 rprintf(F," repeated: --filter='- .rsync-filter'\n");
2acf81eb 313 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
b3708acf 314 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
2acf81eb 315 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
b3708acf
WD
316 rprintf(F," --include-from=FILE read include patterns from FILE\n");
317 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
4db88e5b 318 rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
dfa32483 319 rprintf(F," --version print version number\n");
b4713295 320 rprintf(F," --port=PORT specify double-colon alternate port number\n");
db2b5cb7 321 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
b3708acf
WD
322 rprintf(F," --no-blocking-io turn off blocking I/O when it is the default\n");
323 rprintf(F," --stats give some file-transfer stats\n");
dfa32483 324 rprintf(F," --progress show progress during transfer\n");
b3708acf
WD
325 rprintf(F," -P same as --partial --progress\n");
326 rprintf(F," --log-format=FORMAT log file-transfers using specified format\n");
327 rprintf(F," --password-file=FILE read password from FILE\n");
65e4cda0 328 rprintf(F," --list-only list the files instead of copying them\n");
b3708acf
WD
329 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
330 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
331 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
25ff0441 332#if INET6
4db88e5b
WD
333 rprintf(F," -4, --ipv4 prefer IPv4\n");
334 rprintf(F," -6, --ipv6 prefer IPv6\n");
06963d0f 335#endif
3dd22903 336 rprintf(F," -h, --help show this help screen\n");
7a6421fa 337
3ac7f5d4
WD
338 rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
339 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
2855f61f 340 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
7a6421fa
AT
341}
342
3ac7f5d4 343enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
aa4d3b4c 344 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
1f3d6cdd 345 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
7d5acf1d 346 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
c67d1386 347 OPT_REFUSED_BASE = 9000};
7a6421fa 348
2855f61f
MP
349static struct poptOption long_options[] = {
350 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
8db7cc2c 351 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
d175d7e1 352 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
3dd22903
WD
353 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
354 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
afb6e945
WD
355 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
356 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
8b54f004 357 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
afb6e945 358 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
afb6e945
WD
359 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
360 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
3671987f 361 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
3359acb8 362 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
c6eb7fad 363 {"delete-before", 0, POPT_ARG_VAL, &delete_before, 2, 0, 0 },
3359acb8 364 {"delete-during", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
51d48398
WD
365 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
366 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
afb6e945
WD
367 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
368 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
aa4d3b4c 369 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
8db7cc2c
WD
370 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
371 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
372 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
373 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
afb6e945 374 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
8db7cc2c 375 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
afb6e945
WD
376 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
377 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
378 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
379 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
380 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
a3221d2a 381 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
65e4cda0 382 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
afb6e945
WD
383 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
384 {"copy-links", 'L', POPT_ARG_NONE, &copy_links, 0, 0, 0 },
65e4cda0 385 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
afb6e945
WD
386 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
387 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
388 {"copy-unsafe-links", 0, POPT_ARG_NONE, &copy_unsafe_links, 0, 0, 0 },
389 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
390 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
391 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
392 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
393 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
20fb7b91 394 {"omit-dir-times", 'O', POPT_ARG_NONE, &omit_dir_times, 0, 0, 0 },
afb6e945 395 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
8db7cc2c
WD
396 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
397 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
dfa32483 398 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
afb6e945 399 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
8db7cc2c 400 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
51d48398
WD
401 {"recursive", 'r', POPT_ARG_VAL, &recurse, -1, 0, 0 },
402 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
ea5164d1
WD
403 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
404 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
afb6e945 405 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
a06b419d 406 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
afb6e945 407 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
7d5acf1d 408 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
99218d82 409 {"timeout", 0, POPT_ARG_INT, &io_timeout, OPT_TIMEOUT, 0, 0 },
afb6e945 410 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
e012f858
WD
411 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
412 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
413 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
2855f61f 414 /* TODO: Should this take an optional int giving the compression level? */
afb6e945 415 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
afb6e945
WD
416 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
417 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
418 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
a7260c40 419 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
f06e7082 420 {"delay-updates", 0, POPT_ARG_NONE, &delay_updates, 0, 0, 0 },
afb6e945
WD
421 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
422 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
423 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
aa4d3b4c 424 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
8db7cc2c 425 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
b4713295 426 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
afb6e945
WD
427 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
428 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
afb6e945
WD
429 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
430 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
8db7cc2c
WD
431 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
432 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
ea5164d1
WD
433 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
434 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
435 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
4f3e9a0f 436 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
c8d895de 437 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
25ff0441 438#if INET6
3dd22903
WD
439 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
440 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
06963d0f 441#endif
3ac7f5d4
WD
442 /* All these options switch us into daemon-mode option-parsing. */
443 {"address", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
444 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
445 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
446 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
3ac7f5d4
WD
447 {0,0,0,0, 0, 0, 0}
448};
449
450static void daemon_usage(enum logcode F)
451{
452 print_rsync_version(F);
453
454 rprintf(F,"\nUsage: rsync --daemon [OPTION]...\n");
455 rprintf(F," --address=ADDRESS bind to the specified address\n");
b3708acf 456 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
3ac7f5d4
WD
457 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
458 rprintf(F," --no-detach do not detach from the parent\n");
b3708acf 459 rprintf(F," --port=PORT listen on alternate port number\n");
1bd9db74 460 rprintf(F," -v, --verbose increase verbosity\n");
25ff0441 461#if INET6
3ac7f5d4
WD
462 rprintf(F," -4, --ipv4 prefer IPv4\n");
463 rprintf(F," -6, --ipv6 prefer IPv6\n");
464#endif
465 rprintf(F," -h, --help show this help screen\n");
466
467 rprintf(F,"\nIf you were not trying to invoke rsync as a daemon, avoid using any of the\n");
468 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
469}
470
471static struct poptOption long_daemon_options[] = {
472 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
473 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
9fb08441 474 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
3ac7f5d4
WD
475 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
476 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
25ff0441 477#if INET6
3ac7f5d4
WD
478 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
479 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
480#endif
481 {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 },
482 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
483 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
484 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
1bd9db74 485 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
3ac7f5d4 486 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
ad715008 487 {0,0,0,0, 0, 0, 0}
2855f61f 488};
7a6421fa 489
06963d0f 490
e51094b7 491static char err_buf[200];
cd8185f2 492
2855f61f 493
dafe63ca
MP
494/**
495 * Store the option error message, if any, so that we can log the
496 * connection attempt (which requires parsing the options), and then
497 * show the error later on.
498 **/
cd8185f2
AT
499void option_error(void)
500{
e51094b7
WD
501 if (!err_buf[0]) {
502 strcpy(err_buf, "Error parsing options: "
503 "option may be supported on client but not on server?\n");
cd8185f2 504 }
e51094b7 505
e51094b7 506 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
cd8185f2
AT
507}
508
dafe63ca
MP
509
510/**
27ed20f7
WD
511 * Tweak the option table to disable all options that the rsyncd.conf
512 * file has told us to refuse.
dafe63ca 513 **/
27ed20f7 514static void set_refuse_options(char *bp)
cd8185f2 515{
27ed20f7 516 struct poptOption *op;
093e816c 517 char *cp, shortname[2];
d73e7f6e 518 int is_wild, found_match;
093e816c
WD
519
520 shortname[1] = '\0';
27ed20f7
WD
521
522 while (1) {
06a50542
WD
523 while (*bp == ' ') bp++;
524 if (!*bp)
525 break;
27ed20f7
WD
526 if ((cp = strchr(bp, ' ')) != NULL)
527 *cp= '\0';
093e816c 528 is_wild = strpbrk(bp, "*?[") != NULL;
d73e7f6e 529 found_match = 0;
55afbb52 530 for (op = long_options; ; op++) {
093e816c 531 *shortname = op->shortName;
d73e7f6e
WD
532 if (!op->longName && !*shortname)
533 break;
534 if ((op->longName && wildmatch(bp, op->longName))
3671987f
WD
535 || (*shortname && wildmatch(bp, shortname))
536 || op->val == OPT_DAEMON) {
e57211c5
WD
537 if (op->argInfo == POPT_ARG_VAL)
538 op->argInfo = POPT_ARG_NONE;
06a50542 539 op->val = (op - long_options) + OPT_REFUSED_BASE;
d73e7f6e 540 found_match = 1;
3671987f
WD
541 /* These flags are set to let us easily check
542 * an implied option later in the code. */
543 switch (*shortname) {
544 case 'v':
545 refused_verbose = op->val;
546 break;
547 case 'r': case 'd': case 'l': case 'p':
548 case 't': case 'g': case 'o': case 'D':
549 refused_archive_part = op->val;
550 break;
551 case '\0':
552 if (wildmatch("delete", op->longName))
553 refused_delete = op->val;
554 else if (wildmatch("partial", op->longName))
555 refused_partial = op->val;
556 else if (wildmatch("progress", op->longName))
557 refused_progress = op->val;
558 break;
559 }
06a50542
WD
560 if (!is_wild)
561 break;
27ed20f7 562 }
cd8185f2 563 }
d73e7f6e
WD
564 if (!found_match) {
565 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
566 bp);
567 }
27ed20f7
WD
568 if (!cp)
569 break;
570 *cp = ' ';
571 bp = cp + 1;
cd8185f2 572 }
cd8185f2
AT
573}
574
575
8db7cc2c 576static int count_args(const char **argv)
2855f61f 577{
dfa32483 578 int i = 0;
2855f61f 579
8db7cc2c
WD
580 if (argv) {
581 while (argv[i] != NULL)
582 i++;
583 }
dfa32483
WD
584
585 return i;
2855f61f
MP
586}
587
588
3671987f
WD
589static void create_refuse_error(int which)
590{
591 /* The "which" value is the index + OPT_REFUSED_BASE. */
592 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
593 int n = snprintf(err_buf, sizeof err_buf,
594 "The server is configured to refuse --%s\n",
595 op->longName) - 1;
596 if (op->shortName) {
597 snprintf(err_buf + n, sizeof err_buf - n,
598 " (-%c)\n", op->shortName);
599 }
600}
601
602
dafe63ca
MP
603/**
604 * Process command line arguments. Called on both local and remote.
605 *
606 * @retval 1 if all options are OK; with globals set to appropriate
607 * values
608 *
609 * @retval 0 on error, with err_buf containing an explanation
610 **/
2855f61f 611int parse_arguments(int *argc, const char ***argv, int frommain)
7a6421fa 612{
d853783f 613 int opt;
cd8185f2 614 char *ref = lp_refuse_options(module_id);
7be73df4 615 const char *arg;
dfa32483 616 poptContext pc;
d853783f 617
27ed20f7
WD
618 if (ref && *ref)
619 set_refuse_options(ref);
620
dfa32483 621 /* TODO: Call poptReadDefaultConfig; handle errors. */
cd8185f2 622
dfa32483
WD
623 /* The context leaks in case of an error, but if there's a
624 * problem we always exit anyhow. */
625 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
9fb08441 626 poptReadDefaultConfig(pc, 0);
2855f61f
MP
627
628 while ((opt = poptGetNextOpt(pc)) != -1) {
dfa32483
WD
629 /* most options are handled automatically by popt;
630 * only special cases are returned and listed here. */
2855f61f 631
d853783f
AT
632 switch (opt) {
633 case OPT_VERSION:
dfa32483 634 print_rsync_version(FINFO);
d853783f 635 exit_cleanup(0);
dfa32483 636
3ac7f5d4
WD
637 case OPT_DAEMON:
638 if (am_daemon) {
639 strcpy(err_buf, "Attempt to hack rsync thwarted!\n");
640 return 0;
641 }
642 poptFreeContext(pc);
643 pc = poptGetContext(RSYNC_NAME, *argc, *argv,
644 long_daemon_options, 0);
645 while ((opt = poptGetNextOpt(pc)) != -1) {
646 switch (opt) {
647 case 'h':
648 daemon_usage(FINFO);
649 exit_cleanup(0);
650
1bd9db74
WD
651 case 'v':
652 verbose++;
653 break;
654
3ac7f5d4
WD
655 default:
656 rprintf(FERROR,
657 "rsync: %s: %s (in daemon mode)\n",
658 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
659 poptStrerror(opt));
660 goto daemon_error;
661 }
662 }
663 if (!daemon_opt) {
664 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
665 daemon_error:
666 rprintf(FERROR,
667 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
668 exit_cleanup(RERR_SYNTAX);
669 }
670 *argv = poptGetArgs(pc);
671 *argc = count_args(*argv);
672 daemon_opt = 0;
673 am_daemon = 1;
674 return 1;
675
5b56cc19 676 case OPT_MODIFY_WINDOW:
dfa32483
WD
677 /* The value has already been set by popt, but
678 * we need to remember that we're using a
679 * non-default setting. */
5b56cc19
AT
680 modify_window_set = 1;
681 break;
1de50993 682
aa4d3b4c 683 case OPT_FILTER:
3a5e9224 684 parse_rule(&filter_list, poptGetOptArg(pc), 0, 0);
d853783f
AT
685 break;
686
aa4d3b4c 687 case OPT_EXCLUDE:
3a5e9224 688 parse_rule(&filter_list, poptGetOptArg(pc),
0a68f869 689 0, XFLG_OLD_PREFIXES);
aa4d3b4c
WD
690 break;
691
d853783f 692 case OPT_INCLUDE:
3a5e9224 693 parse_rule(&filter_list, poptGetOptArg(pc),
0a68f869 694 MATCHFLG_INCLUDE, XFLG_OLD_PREFIXES);
d853783f
AT
695 break;
696
697 case OPT_EXCLUDE_FROM:
93695764 698 case OPT_INCLUDE_FROM:
7be73df4 699 arg = poptGetOptArg(pc);
ba3db479
WD
700 if (sanitize_paths)
701 arg = sanitize_path(NULL, arg, NULL, 0);
7842418b 702 if (server_filter_list.head) {
ba3db479 703 char *cp = (char *)arg;
3671987f
WD
704 if (!*cp)
705 goto options_rejected;
ba3db479 706 clean_fname(cp, 1);
7842418b 707 if (check_filter(&server_filter_list, cp, 0) < 0)
ba3db479
WD
708 goto options_rejected;
709 }
3a5e9224
WD
710 parse_filter_file(&filter_list, arg,
711 opt == OPT_INCLUDE_FROM ? MATCHFLG_INCLUDE : 0,
712 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
93695764
DD
713 break;
714
d853783f
AT
715 case 'h':
716 usage(FINFO);
717 exit_cleanup(0);
718
d853783f
AT
719 case 'v':
720 verbose++;
721 break;
7a6421fa 722
b86f0cef 723 case 'q':
f98c60bf
WD
724 if (frommain)
725 quiet++;
b86f0cef
DD
726 break;
727
d853783f
AT
728 case OPT_SENDER:
729 if (!am_server) {
730 usage(FERROR);
65417579 731 exit_cleanup(RERR_SYNTAX);
d853783f
AT
732 }
733 am_sender = 1;
734 break;
735
aa4d3b4c
WD
736 case 'F':
737 switch (++F_option_cnt) {
738 case 1:
3a5e9224 739 parse_rule(&filter_list,": /.rsync-filter",0,0);
aa4d3b4c
WD
740 break;
741 case 2:
3a5e9224 742 parse_rule(&filter_list,"- .rsync-filter",0,0);
aa4d3b4c
WD
743 break;
744 }
745 break;
746
d9fcc198 747 case 'P':
3671987f
WD
748 if (refused_partial || refused_progress) {
749 create_refuse_error(refused_partial
750 ? refused_partial : refused_progress);
751 return 0;
752 }
d9fcc198
AT
753 do_progress = 1;
754 keep_partial = 1;
755 break;
756
088aac85 757 case OPT_WRITE_BATCH:
9b3318b0 758 /* batch_name is already set */
088aac85
DD
759 write_batch = 1;
760 break;
761
76f79ba7 762 case OPT_READ_BATCH:
9b3318b0 763 /* batch_name is already set */
6902ed17
MP
764 read_batch = 1;
765 break;
ea5164d1 766
7d5acf1d 767 case OPT_MAX_SIZE:
cc80022e 768 for (arg = max_size_arg; isdigit(*(uchar*)arg); arg++) {}
7d5acf1d 769 if (*arg == '.')
cc80022e 770 for (arg++; isdigit(*(uchar*)arg); arg++) {}
7d5acf1d
WD
771 switch (*arg) {
772 case 'k': case 'K':
773 max_size = atof(max_size_arg) * 1024;
774 break;
775 case 'm': case 'M':
776 max_size = atof(max_size_arg) * 1024*1024;
777 break;
778 case 'g': case 'G':
779 max_size = atof(max_size_arg) * 1024*1024*1024;
780 break;
781 case '\0':
782 max_size = atof(max_size_arg);
783 break;
784 default:
785 max_size = 0;
786 break;
787 }
788 if (max_size <= 0) {
e012f858 789 snprintf(err_buf, sizeof err_buf,
7d5acf1d
WD
790 "--max-size value is invalid: %s\n",
791 max_size_arg);
e012f858 792 return 0;
7d5acf1d
WD
793 }
794 break;
795
99218d82
WD
796 case OPT_TIMEOUT:
797 if (io_timeout && io_timeout < select_timeout)
798 select_timeout = io_timeout;
799 break;
800
59c95e42
DD
801 case OPT_LINK_DEST:
802#if HAVE_LINK
59c95e42 803 link_dest = 1;
e012f858
WD
804 dest_option = "--link-dest";
805 goto set_dest_dir;
59c95e42 806#else
d175d7e1 807 snprintf(err_buf, sizeof err_buf,
dfa32483 808 "hard links are not supported on this %s\n",
59c95e42 809 am_server ? "server" : "client");
59c95e42
DD
810 return 0;
811#endif
812
e012f858
WD
813 case OPT_COPY_DEST:
814 copy_dest = 1;
815 dest_option = "--copy-dest";
816 goto set_dest_dir;
817
818 case OPT_COMPARE_DEST:
819 compare_dest = 1;
820 dest_option = "--compare-dest";
821 set_dest_dir:
3b26bba0 822 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
e012f858
WD
823 snprintf(err_buf, sizeof err_buf,
824 "ERROR: at most %d %s args may be specified\n",
825 MAX_BASIS_DIRS, dest_option);
826 return 0;
827 }
828 arg = poptGetOptArg(pc);
829 if (sanitize_paths)
830 arg = sanitize_path(NULL, arg, NULL, 0);
831 basis_dir[basis_dir_cnt++] = (char *)arg;
832 break;
833
d853783f 834 default:
55afbb52 835 /* A large opt value means that set_refuse_options()
3671987f 836 * turned this option off. */
c67d1386 837 if (opt >= OPT_REFUSED_BASE) {
3671987f
WD
838 create_refuse_error(opt);
839 return 0;
27ed20f7 840 }
3671987f
WD
841 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
842 am_server ? "on remote machine: " : "",
843 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
844 poptStrerror(opt));
dfa32483 845 return 0;
d853783f 846 }
7a6421fa 847 }
2855f61f 848
f1d5ba40
WD
849 if (am_sender < 0)
850 am_sender = 0;
851
e1add893 852#if !SUPPORT_LINKS
54e87b4b 853 if (preserve_links && !am_sender) {
e1add893
WD
854 snprintf(err_buf, sizeof err_buf,
855 "symlinks are not supported on this %s\n",
856 am_server ? "server" : "client");
e1add893
WD
857 return 0;
858 }
859#endif
860
861#if !SUPPORT_HARD_LINKS
862 if (preserve_hard_links) {
863 snprintf(err_buf, sizeof err_buf,
864 "hard links are not supported on this %s\n",
865 am_server ? "server" : "client");
e1add893
WD
866 return 0;
867 }
868#endif
869
088aac85 870 if (write_batch && read_batch) {
c3ea0990 871 snprintf(err_buf, sizeof err_buf,
36119893 872 "--write-batch and --read-batch can not be used together\n");
c3ea0990 873 return 0;
088aac85 874 }
94327ff0
WD
875 if (write_batch || read_batch) {
876 if (dry_run) {
c3ea0990 877 snprintf(err_buf, sizeof err_buf,
94327ff0
WD
878 "--%s-batch cannot be used with --dry_run (-n)\n",
879 write_batch ? "write" : "read");
c3ea0990 880 return 0;
94327ff0
WD
881 }
882 if (am_server) {
883 rprintf(FINFO,
884 "ignoring --%s-batch option sent to server\n",
885 write_batch ? "write" : "read");
886 /* We don't actually exit_cleanup(), so that we can
887 * still service older version clients that still send
888 * batch args to server. */
889 read_batch = write_batch = 0;
890 batch_name = NULL;
891 }
b9f592fb 892 }
36119893 893 if (read_batch && files_from) {
c3ea0990 894 snprintf(err_buf, sizeof err_buf,
36119893 895 "--read-batch cannot be used with --files-from\n");
c3ea0990 896 return 0;
36119893 897 }
9b3318b0 898 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
c3ea0990 899 snprintf(err_buf, sizeof err_buf,
9b3318b0
WD
900 "the batch-file name must be %d characters or less.\n",
901 MAX_BATCH_NAME_LEN);
c3ea0990 902 return 0;
beb93684 903 }
088aac85 904
ce58b1b4 905 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
c3ea0990
WD
906 snprintf(err_buf, sizeof err_buf,
907 "the --temp-dir path is WAY too long.\n");
908 return 0;
ce58b1b4
WD
909 }
910
e012f858
WD
911 if (compare_dest + copy_dest + link_dest > 1) {
912 snprintf(err_buf, sizeof err_buf,
913 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
914 return 0;
915 }
916
dfa32483 917 if (archive_mode) {
3671987f
WD
918 if (refused_archive_part) {
919 create_refuse_error(refused_archive_part);
920 return 0;
921 }
ea5164d1 922 if (!files_from)
51d48398 923 recurse = -1; /* infinite recursion */
dfa32483
WD
924#if SUPPORT_LINKS
925 preserve_links = 1;
926#endif
927 preserve_perms = 1;
928 preserve_times = 1;
929 preserve_gid = 1;
930 preserve_uid = 1;
931 preserve_devices = 1;
932 }
51d48398
WD
933
934 if (recurse || list_only || files_from)
65e4cda0 935 xfer_dirs |= 1;
dfa32483 936
ea5164d1
WD
937 if (relative_paths < 0)
938 relative_paths = files_from? 1 : 0;
939
c6eb7fad 940 if (!!delete_before + delete_during + delete_after > 1) {
3359acb8 941 snprintf(err_buf, sizeof err_buf,
c6eb7fad 942 "You may not combine multiple --delete-WHEN options.\n");
3359acb8
WD
943 return 0;
944 }
78fc60cd
WD
945 if (!recurse) {
946 delete_before = delete_during = delete_after = 0;
947 delete_mode = delete_excluded = 0;
948 } else if (delete_before || delete_during || delete_after)
51d48398 949 delete_mode = 1;
3359acb8
WD
950 else if (delete_mode || delete_excluded)
951 delete_mode = delete_before = 1;
51d48398 952
3671987f
WD
953 if (delete_mode && refused_delete) {
954 create_refuse_error(refused_delete);
955 return 0;
956 }
957
7be73df4 958 *argv = poptGetArgs(pc);
8db7cc2c 959 *argc = count_args(*argv);
7be73df4
WD
960
961 if (sanitize_paths) {
962 int i;
963 for (i = *argc; i-- > 0; )
10796f4b 964 (*argv)[i] = sanitize_path(NULL, (*argv)[i], "", 0);
7be73df4 965 if (tmpdir)
10796f4b 966 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
a7260c40 967 if (partial_dir)
10796f4b 968 partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
7be73df4 969 if (backup_dir)
10796f4b 970 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
7be73df4 971 if (files_from)
10796f4b 972 files_from = sanitize_path(NULL, files_from, NULL, 0);
7be73df4 973 }
7842418b
WD
974 if (server_filter_list.head && !am_sender) {
975 struct filter_list_struct *elp = &server_filter_list;
e012f858 976 int i;
c3ea0990 977 if (tmpdir) {
3671987f
WD
978 if (!*tmpdir)
979 goto options_rejected;
58b1999e 980 clean_fname(tmpdir, 1);
7842418b 981 if (check_filter(elp, tmpdir, 1) < 0)
c3ea0990
WD
982 goto options_rejected;
983 }
3671987f 984 if (partial_dir && *partial_dir) {
58b1999e 985 clean_fname(partial_dir, 1);
7842418b 986 if (check_filter(elp, partial_dir, 1) < 0)
c3ea0990
WD
987 goto options_rejected;
988 }
e012f858 989 for (i = 0; i < basis_dir_cnt; i++) {
3671987f
WD
990 if (!*basis_dir[i])
991 goto options_rejected;
e012f858 992 clean_fname(basis_dir[i], 1);
7842418b 993 if (check_filter(elp, basis_dir[i], 1) < 0)
c3ea0990
WD
994 goto options_rejected;
995 }
996 if (backup_dir) {
3671987f
WD
997 if (!*backup_dir)
998 goto options_rejected;
58b1999e 999 clean_fname(backup_dir, 1);
7842418b 1000 if (check_filter(elp, backup_dir, 1) < 0)
c3ea0990
WD
1001 goto options_rejected;
1002 }
1003 }
7842418b 1004 if (server_filter_list.head && files_from) {
3671987f
WD
1005 if (!*files_from)
1006 goto options_rejected;
58b1999e 1007 clean_fname(files_from, 1);
7842418b 1008 if (check_filter(&server_filter_list, files_from, 0) < 0) {
c3ea0990
WD
1009 options_rejected:
1010 snprintf(err_buf, sizeof err_buf,
1011 "Your options have been rejected by the server.\n");
1012 return 0;
1013 }
1014 }
7be73df4 1015
d175d7e1 1016 if (!backup_suffix)
e0391f81 1017 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
d175d7e1 1018 backup_suffix_len = strlen(backup_suffix);
80ddadb7 1019 if (strchr(backup_suffix, '/') != NULL) {
c3ea0990
WD
1020 snprintf(err_buf, sizeof err_buf,
1021 "--suffix cannot contain slashes: %s\n",
80ddadb7 1022 backup_suffix);
c3ea0990 1023 return 0;
80ddadb7 1024 }
e0391f81
WD
1025 if (backup_dir) {
1026 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
1027 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
1028 if (backup_dir_remainder < 32) {
c3ea0990
WD
1029 snprintf(err_buf, sizeof err_buf,
1030 "the --backup-dir path is WAY too long.\n");
1031 return 0;
e0391f81
WD
1032 }
1033 if (backup_dir_buf[backup_dir_len - 1] != '/') {
1034 backup_dir_buf[backup_dir_len++] = '/';
1035 backup_dir_buf[backup_dir_len] = '\0';
1036 }
4875d6b6
WD
1037 if (verbose > 1 && !am_sender) {
1038 rprintf(FINFO, "backup_dir is %s\n",
1039 safe_fname(backup_dir_buf));
1040 }
8dcf9335 1041 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
c3ea0990 1042 snprintf(err_buf, sizeof err_buf,
d175d7e1 1043 "--suffix cannot be a null string without --backup-dir\n");
c3ea0990 1044 return 0;
d175d7e1
WD
1045 }
1046
3671987f
WD
1047 if (do_progress && !verbose) {
1048 if (refused_verbose) {
1049 create_refuse_error(refused_verbose);
1050 return 0;
1051 }
e2559dbe 1052 verbose = 1;
3671987f 1053 }
e2559dbe 1054
9fb08441
WD
1055 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
1056 bwlimit = daemon_bwlimit;
3c74c3a3
WD
1057 if (bwlimit) {
1058 bwlimit_writemax = (size_t)bwlimit * 128;
1059 if (bwlimit_writemax < 512)
1060 bwlimit_writemax = 512;
1061 }
1062
f06e7082 1063 if (delay_updates && !partial_dir)
3671987f 1064 partial_dir = partialdir_for_delayupdate;
f06e7082 1065
a3221d2a
WD
1066 if (inplace) {
1067#if HAVE_FTRUNCATE
a7260c40
WD
1068 if (partial_dir) {
1069 snprintf(err_buf, sizeof err_buf,
f06e7082
WD
1070 "--inplace cannot be used with --%s\n",
1071 delay_updates ? "delay-updates" : "partial-dir");
a7260c40
WD
1072 return 0;
1073 }
3671987f
WD
1074 /* --inplace implies --partial for refusal purposes, but we
1075 * clear the keep_partial flag for internal logic purposes. */
1076 if (refused_partial) {
1077 create_refuse_error(refused_partial);
1078 return 0;
1079 }
a3221d2a 1080 keep_partial = 0;
ded4daf0
WD
1081#else
1082 snprintf(err_buf, sizeof err_buf,
1083 "--inplace is not supported on this %s\n",
1084 am_server ? "server" : "client");
1085 return 0;
1086#endif
075aa18f 1087 } else {
3671987f
WD
1088 if (keep_partial && !partial_dir) {
1089 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
1090 partial_dir = strdup(arg);
1091 }
075aa18f 1092 if (partial_dir) {
3671987f
WD
1093 if (*partial_dir)
1094 clean_fname(partial_dir, 1);
075aa18f
WD
1095 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1096 partial_dir = NULL;
13791b1e 1097 else if (*partial_dir != '/') {
3a5e9224 1098 parse_rule(&filter_list, partial_dir,
0a68f869 1099 MATCHFLG_NO_PREFIXES|MATCHFLG_DIRECTORY, 0);
13791b1e 1100 }
3671987f
WD
1101 if (!partial_dir && refused_partial) {
1102 create_refuse_error(refused_partial);
1103 return 0;
1104 }
075aa18f
WD
1105 keep_partial = 1;
1106 }
a3221d2a
WD
1107 }
1108
ea5164d1
WD
1109 if (files_from) {
1110 char *colon;
c3ea0990 1111 if (*argc > 2 || (!am_daemon && *argc == 1)) {
ea5164d1
WD
1112 usage(FERROR);
1113 exit_cleanup(RERR_SYNTAX);
1114 }
63596e1c 1115 if (strcmp(files_from, "-") == 0) {
ea5164d1 1116 filesfrom_fd = 0;
63596e1c
WD
1117 if (am_server)
1118 remote_filesfrom_file = "-";
1119 }
ea5164d1
WD
1120 else if ((colon = find_colon(files_from)) != 0) {
1121 if (am_server) {
1122 usage(FERROR);
1123 exit_cleanup(RERR_SYNTAX);
1124 }
1125 remote_filesfrom_file = colon+1 + (colon[1] == ':');
1126 if (strcmp(remote_filesfrom_file, "-") == 0) {
c3ea0990
WD
1127 snprintf(err_buf, sizeof err_buf,
1128 "Invalid --files-from remote filename\n");
1129 return 0;
ea5164d1
WD
1130 }
1131 } else {
ea5164d1
WD
1132 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1133 if (filesfrom_fd < 0) {
c3ea0990
WD
1134 snprintf(err_buf, sizeof err_buf,
1135 "failed to open files-from file %s: %s\n",
1136 files_from, strerror(errno));
1137 return 0;
ea5164d1
WD
1138 }
1139 }
1140 }
1141
b11ed3b1 1142 return 1;
7a6421fa
AT
1143}
1144
1145
dafe63ca
MP
1146/**
1147 * Construct a filtered list of options to pass through from the
1148 * client to the server.
1149 *
1150 * This involves setting options that will tell the server how to
1151 * behave, and also filtering out options that are processed only
1152 * locally.
1153 **/
7a6421fa
AT
1154void server_options(char **args,int *argc)
1155{
e012f858 1156 static char argstr[50+MAX_BASIS_DIRS*2];
d853783f 1157 int ac = *argc;
f98c60bf 1158 char *arg;
ef5d23eb 1159
d853783f
AT
1160 int i, x;
1161
93689aa5
DD
1162 if (blocking_io == -1)
1163 blocking_io = 0;
1164
d853783f
AT
1165 args[ac++] = "--server";
1166
1312d9fc
WD
1167 if (daemon_over_rsh) {
1168 args[ac++] = "--daemon";
1169 *argc = ac;
1170 /* if we're passing --daemon, we're done */
1171 return;
1172 }
1173
d853783f
AT
1174 if (!am_sender)
1175 args[ac++] = "--sender";
1176
1177 x = 1;
1178 argstr[0] = '-';
f98c60bf 1179 for (i = 0; i < verbose; i++)
d853783f 1180 argstr[x++] = 'v';
f0b36a48 1181
b86f0cef 1182 /* the -q option is intentionally left out */
d853783f
AT
1183 if (make_backups)
1184 argstr[x++] = 'b';
1185 if (update_only)
1186 argstr[x++] = 'u';
1187 if (dry_run)
1188 argstr[x++] = 'n';
1189 if (preserve_links)
1190 argstr[x++] = 'l';
1191 if (copy_links)
1192 argstr[x++] = 'L';
65e4cda0 1193 if (xfer_dirs > 1)
5454d22a 1194 argstr[x++] = 'd';
716e73d4
WD
1195 if (keep_dirlinks && am_sender)
1196 argstr[x++] = 'K';
1bfbf40b 1197
dfa32483 1198 if (whole_file > 0)
d853783f 1199 argstr[x++] = 'W';
bceec82f
MP
1200 /* We don't need to send --no-whole-file, because it's the
1201 * default for remote transfers, and in any case old versions
1202 * of rsync will not understand it. */
dfa32483 1203
d853783f
AT
1204 if (preserve_hard_links)
1205 argstr[x++] = 'H';
1206 if (preserve_uid)
1207 argstr[x++] = 'o';
1208 if (preserve_gid)
1209 argstr[x++] = 'g';
1210 if (preserve_devices)
1211 argstr[x++] = 'D';
1212 if (preserve_times)
1213 argstr[x++] = 't';
20fb7b91
WD
1214 if (omit_dir_times && am_sender)
1215 argstr[x++] = 'O';
d853783f
AT
1216 if (preserve_perms)
1217 argstr[x++] = 'p';
51d48398 1218 if (recurse < 0)
d853783f
AT
1219 argstr[x++] = 'r';
1220 if (always_checksum)
1221 argstr[x++] = 'c';
1222 if (cvs_exclude)
1223 argstr[x++] = 'C';
1224 if (ignore_times)
1225 argstr[x++] = 'I';
1226 if (relative_paths)
1227 argstr[x++] = 'R';
1228 if (one_file_system)
1229 argstr[x++] = 'x';
1230 if (sparse_files)
1231 argstr[x++] = 'S';
1232 if (do_compression)
1233 argstr[x++] = 'z';
f0b36a48 1234
51d48398
WD
1235 /* This is a complete hack - blame Rusty. FIXME!
1236 * This hack is only needed for older rsync versions that
1237 * don't understand the --list-only option. */
1238 if (list_only == 1 && recurse >= 0)
f0b36a48
AT
1239 argstr[x++] = 'r';
1240
d853783f
AT
1241 argstr[x] = 0;
1242
f98c60bf
WD
1243 if (x != 1)
1244 args[ac++] = argstr;
d853783f 1245
51d48398
WD
1246 if (list_only > 1)
1247 args[ac++] = "--list-only";
1248
195bd906 1249 if (block_size) {
a06b419d 1250 if (asprintf(&arg, "-B%lu", block_size) < 0)
f98c60bf
WD
1251 goto oom;
1252 args[ac++] = arg;
dfa32483 1253 }
d853783f 1254
0b73ca12 1255 if (max_delete && am_sender) {
f98c60bf
WD
1256 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1257 goto oom;
1258 args[ac++] = arg;
dfa32483
WD
1259 }
1260
7d5acf1d
WD
1261 if (max_size && am_sender) {
1262 args[ac++] = "--max-size";
1263 args[ac++] = max_size_arg;
1264 }
1265
d853783f 1266 if (io_timeout) {
f98c60bf
WD
1267 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1268 goto oom;
1269 args[ac++] = arg;
dfa32483 1270 }
d853783f 1271
ef5d23eb 1272 if (bwlimit) {
f98c60bf
WD
1273 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1274 goto oom;
1275 args[ac++] = arg;
ef5d23eb
DD
1276 }
1277
d175d7e1
WD
1278 if (backup_dir) {
1279 args[ac++] = "--backup-dir";
1280 args[ac++] = backup_dir;
1281 }
1282
1283 /* Only send --suffix if it specifies a non-default value. */
f98c60bf 1284 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
191e40da 1285 /* We use the following syntax to avoid weirdness with '~'. */
f98c60bf
WD
1286 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1287 goto oom;
1288 args[ac++] = arg;
d853783f
AT
1289 }
1290
06a50542
WD
1291 if (am_sender) {
1292 if (delete_excluded)
1293 args[ac++] = "--delete-excluded";
c6eb7fad 1294 else if (delete_before == 1 || delete_after)
06a50542 1295 args[ac++] = "--delete";
57f74bd1 1296 if (delete_before > 1)
c6eb7fad 1297 args[ac++] = "--delete-before";
3359acb8
WD
1298 if (delete_during)
1299 args[ac++] = "--delete-during";
06a50542
WD
1300 if (delete_after)
1301 args[ac++] = "--delete-after";
06a50542
WD
1302 if (force_delete)
1303 args[ac++] = "--force";
1304 }
b33b791e 1305
f83f0548
AT
1306 if (size_only)
1307 args[ac++] = "--size-only";
1308
5b56cc19 1309 if (modify_window_set) {
f98c60bf
WD
1310 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1311 goto oom;
1312 args[ac++] = arg;
5b56cc19
AT
1313 }
1314
c8d895de 1315 if (checksum_seed) {
221ddb94 1316 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
c8d895de
WD
1317 goto oom;
1318 args[ac++] = arg;
1319 }
1320
a7260c40 1321 if (partial_dir && am_sender) {
3671987f
WD
1322 if (partial_dir != partialdir_for_delayupdate) {
1323 args[ac++] = "--partial-dir";
1324 args[ac++] = partial_dir;
1325 }
f06e7082
WD
1326 if (delay_updates)
1327 args[ac++] = "--delay-updates";
a7260c40 1328 } else if (keep_partial)
d853783f
AT
1329 args[ac++] = "--partial";
1330
ef55c686
AT
1331 if (ignore_errors)
1332 args[ac++] = "--ignore-errors";
1333
b5313607
DD
1334 if (copy_unsafe_links)
1335 args[ac++] = "--copy-unsafe-links";
1336
d853783f
AT
1337 if (safe_symlinks)
1338 args[ac++] = "--safe-links";
1339
1340 if (numeric_ids)
1341 args[ac++] = "--numeric-ids";
1342
0b73ca12 1343 if (only_existing && am_sender)
1347d512
AT
1344 args[ac++] = "--existing";
1345
dfa32483 1346 if (opt_ignore_existing && am_sender)
3d6feada
MP
1347 args[ac++] = "--ignore-existing";
1348
a3221d2a
WD
1349 if (inplace)
1350 args[ac++] = "--inplace";
1351
d853783f
AT
1352 if (tmpdir) {
1353 args[ac++] = "--temp-dir";
1354 args[ac++] = tmpdir;
1355 }
1356
e012f858 1357 if (basis_dir[0] && am_sender) {
375a4556
DD
1358 /* the server only needs this option if it is not the sender,
1359 * and it may be an older version that doesn't know this
1360 * option, so don't send it if client is the sender.
1361 */
e012f858
WD
1362 int i;
1363 for (i = 0; i < basis_dir_cnt; i++) {
1364 args[ac++] = dest_option;
1365 args[ac++] = basis_dir[i];
1366 }
375a4556
DD
1367 }
1368
ea5164d1
WD
1369 if (files_from && (!am_sender || remote_filesfrom_file)) {
1370 if (remote_filesfrom_file) {
1371 args[ac++] = "--files-from";
1372 args[ac++] = remote_filesfrom_file;
1373 if (eol_nulls)
1374 args[ac++] = "--from0";
1375 } else {
1376 args[ac++] = "--files-from=-";
1377 args[ac++] = "--from0";
1378 }
c0ab28d1
WD
1379 if (!relative_paths)
1380 args[ac++] = "--no-relative";
ea5164d1 1381 }
c72f5bd9 1382 if (!implied_dirs && !am_sender)
3a90ea0a 1383 args[ac++] = "--no-implied-dirs";
ea5164d1 1384
d853783f 1385 *argc = ac;
f98c60bf
WD
1386 return;
1387
1388 oom:
1389 out_of_memory("server_options");
7a6421fa
AT
1390}
1391
ea5164d1
WD
1392/**
1393 * Return the position of a ':' IF it is not part of a filename (i.e. as
1394 * long as it doesn't occur after a slash.
1395 */
1396char *find_colon(char *s)
1397{
1398 char *p, *p2;
1399
1400 p = strchr(s,':');
f98c60bf
WD
1401 if (!p)
1402 return NULL;
ea5164d1
WD
1403
1404 /* now check to see if there is a / in the string before the : - if there is then
1405 discard the colon on the assumption that the : is part of a filename */
1406 p2 = strchr(s,'/');
f98c60bf
WD
1407 if (p2 && p2 < p)
1408 return NULL;
ea5164d1
WD
1409
1410 return p;
1411}