- for protocol version >= 27, mdfour_tail() is called when the block size
[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;
7a6421fa 80int block_size=BLOCK_SIZE;
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");
d9fcc198 257 rprintf(F," -P equivalent to --partial --progress\n");
704f908e 258 rprintf(F," -z, --compress compress file data\n");
ea5164d1 259 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
2acf81eb 260 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
858fb9eb 261 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
2acf81eb 262 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
858fb9eb 263 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
ea5164d1
WD
264 rprintf(F," --files-from=FILE read FILE for list of source-file names\n");
265 rprintf(F," -0 --from0 file names we read are separated by nulls, not newlines\n");
dfa32483
WD
266 rprintf(F," --version print version number\n");
267 rprintf(F," --daemon run as a rsync daemon\n");
268 rprintf(F," --no-detach do not detach from the parent\n");
269 rprintf(F," --address=ADDRESS bind to the specified address\n");
270 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
704f908e 271 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
dfa32483
WD
272 rprintf(F," --blocking-io use blocking IO for the remote shell\n");
273 rprintf(F," --no-blocking-io turn off --blocking-io\n");
274 rprintf(F," --stats give some file transfer stats\n");
275 rprintf(F," --progress show progress during transfer\n");
276 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
65575e96 277 rprintf(F," --password-file=FILE get password from FILE\n");
ef5d23eb 278 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
088aac85
DD
279 rprintf(F," --write-batch=PREFIX write batch fileset starting with PREFIX\n");
280 rprintf(F," --read-batch=PREFIX read batch fileset starting with PREFIX\n");
704f908e 281 rprintf(F," -h, --help show this help screen\n");
06963d0f
MP
282#ifdef INET6
283 rprintf(F," -4 prefer IPv4\n");
284 rprintf(F," -6 prefer IPv6\n");
285#endif
7a6421fa
AT
286
287 rprintf(F,"\n");
b72f24c7
AT
288
289 rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
2855f61f 290 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
7a6421fa
AT
291}
292
2855f61f 293enum {OPT_VERSION = 1000, OPT_SUFFIX, OPT_SENDER, OPT_SERVER, OPT_EXCLUDE,
b33b791e
DD
294 OPT_EXCLUDE_FROM, OPT_DELETE, OPT_DELETE_EXCLUDED, OPT_NUMERIC_IDS,
295 OPT_RSYNC_PATH, OPT_FORCE, OPT_TIMEOUT, OPT_DAEMON, OPT_CONFIG, OPT_PORT,
d853783f 296 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_STATS, OPT_PARTIAL, OPT_PROGRESS,
59c95e42 297 OPT_COPY_UNSAFE_LINKS, OPT_SAFE_LINKS, OPT_COMPARE_DEST, OPT_LINK_DEST,
57df171b 298 OPT_LOG_FORMAT, OPT_PASSWORD_FILE, OPT_SIZE_ONLY, OPT_ADDRESS,
dfa32483 299 OPT_DELETE_AFTER, OPT_EXISTING, OPT_MAX_DELETE, OPT_BACKUP_DIR,
afb6e945 300 OPT_IGNORE_ERRORS, OPT_BWLIMIT,
3d6feada 301 OPT_MODIFY_WINDOW, OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_IGNORE_EXISTING};
7a6421fa 302
2855f61f
MP
303static struct poptOption long_options[] = {
304 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
dfa32483
WD
305 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
306 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, OPT_SUFFIX, 0, 0 },
8b54f004
MP
307 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
308 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
afb6e945
WD
309 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
310 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
8b54f004 311 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
afb6e945
WD
312 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
313 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
314 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
315 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
1de50993 316 {"delete-after", 0, POPT_ARG_NONE, 0, OPT_DELETE_AFTER, 0, 0 },
8b54f004 317 {"delete-excluded", 0, POPT_ARG_NONE, 0, OPT_DELETE_EXCLUDED, 0, 0 },
afb6e945
WD
318 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
319 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
8b54f004
MP
320 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
321 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
322 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
323 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
afb6e945 324 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
8b54f004 325 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
afb6e945
WD
326 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
327 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
328 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
329 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
330 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
331 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
332 {"copy-links", 'L', POPT_ARG_NONE, &copy_links, 0, 0, 0 },
333 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
334 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
335 {"copy-unsafe-links", 0, POPT_ARG_NONE, &copy_unsafe_links, 0, 0, 0 },
336 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
337 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
338 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
339 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
340 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
341 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
8b54f004
MP
342 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
343 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
dfa32483 344 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
afb6e945 345 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
dfa32483 346 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
afb6e945 347 {"recursive", 'r', POPT_ARG_NONE, &recurse, 0, 0, 0 },
ea5164d1
WD
348 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
349 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
afb6e945
WD
350 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
351 {"block-size", 'B', POPT_ARG_INT, &block_size, 0, 0, 0 },
352 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
353 {"timeout", 0, POPT_ARG_INT, &io_timeout, 0, 0, 0 },
354 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
355 {"compare-dest", 0, POPT_ARG_STRING, &compare_dest, 0, 0, 0 },
dfa32483 356 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
2855f61f 357 /* TODO: Should this take an optional int giving the compression level? */
afb6e945
WD
358 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
359 {"daemon", 0, POPT_ARG_NONE, &am_daemon, 0, 0, 0 },
360 {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 },
361 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
362 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
363 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
364 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
365 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
366 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
dfa32483 367 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
afb6e945
WD
368 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
369 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
370 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
371 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
8b54f004 372 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
afb6e945
WD
373 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
374 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
dfa32483
WD
375 {"read-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_READ_BATCH, 0, 0 },
376 {"write-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_WRITE_BATCH, 0, 0 },
ea5164d1
WD
377 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
378 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
379 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
06963d0f 380#ifdef INET6
afb6e945
WD
381 {0, '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
382 {0, '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
06963d0f 383#endif
8b54f004 384 {0,0,0,0, 0, 0, 0}
2855f61f 385};
7a6421fa 386
06963d0f 387
cd8185f2
AT
388static char err_buf[100];
389
2855f61f 390
dafe63ca
MP
391/**
392 * Store the option error message, if any, so that we can log the
393 * connection attempt (which requires parsing the options), and then
394 * show the error later on.
395 **/
cd8185f2
AT
396void option_error(void)
397{
398 if (err_buf[0]) {
2855f61f
MP
399 rprintf(FLOG, "%s", err_buf);
400 rprintf(FERROR, "%s: %s", RSYNC_NAME, err_buf);
cd8185f2 401 } else {
add7e8fb
MP
402 rprintf (FERROR, "Error parsing options: "
403 "option may be supported on client but not on server?\n");
404 rprintf (FERROR, RSYNC_NAME ": Error parsing options: "
405 "option may be supported on client but not on server?\n");
cd8185f2 406 }
cd8185f2
AT
407}
408
dafe63ca
MP
409
410/**
411 * Check to see if we should refuse this option
412 **/
cd8185f2
AT
413static int check_refuse_options(char *ref, int opt)
414{
415 int i, len;
416 char *p;
417 const char *name;
418
2855f61f 419 for (i=0; long_options[i].longName; i++) {
cd8185f2
AT
420 if (long_options[i].val == opt) break;
421 }
dfa32483 422
2855f61f 423 if (!long_options[i].longName) return 0;
cd8185f2 424
2855f61f 425 name = long_options[i].longName;
cd8185f2
AT
426 len = strlen(name);
427
428 while ((p = strstr(ref,name))) {
055af776
AT
429 if ((p==ref || p[-1]==' ') &&
430 (p[len] == ' ' || p[len] == 0)) {
8950ac03 431 snprintf(err_buf,sizeof(err_buf),
cd8185f2
AT
432 "The '%s' option is not supported by this server\n", name);
433 return 1;
434 }
435 ref += len;
436 }
437 return 0;
438}
439
440
2855f61f
MP
441static int count_args(char const **argv)
442{
dfa32483 443 int i = 0;
2855f61f 444
dfa32483
WD
445 while (argv[i] != NULL)
446 i++;
447
448 return i;
2855f61f
MP
449}
450
451
dafe63ca
MP
452/**
453 * Process command line arguments. Called on both local and remote.
454 *
455 * @retval 1 if all options are OK; with globals set to appropriate
456 * values
457 *
458 * @retval 0 on error, with err_buf containing an explanation
459 **/
2855f61f 460int parse_arguments(int *argc, const char ***argv, int frommain)
7a6421fa 461{
d853783f 462 int opt;
cd8185f2 463 char *ref = lp_refuse_options(module_id);
dfa32483 464 poptContext pc;
d853783f 465
dfa32483 466 /* TODO: Call poptReadDefaultConfig; handle errors. */
cd8185f2 467
dfa32483
WD
468 /* The context leaks in case of an error, but if there's a
469 * problem we always exit anyhow. */
470 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
2855f61f
MP
471
472 while ((opt = poptGetNextOpt(pc)) != -1) {
cd8185f2
AT
473 if (ref) {
474 if (check_refuse_options(ref, opt)) return 0;
475 }
476
dfa32483
WD
477 /* most options are handled automatically by popt;
478 * only special cases are returned and listed here. */
2855f61f 479
d853783f
AT
480 switch (opt) {
481 case OPT_VERSION:
dfa32483 482 print_rsync_version(FINFO);
d853783f 483 exit_cleanup(0);
dfa32483 484
759ac870 485 case OPT_SUFFIX:
dfa32483
WD
486 /* The value has already been set by popt, but
487 * we need to remember that a suffix was specified
488 * in case a backup-directory is used. */
489 suffix_specified = 1;
759ac870 490 break;
dfa32483 491
5b56cc19 492 case OPT_MODIFY_WINDOW:
dfa32483
WD
493 /* The value has already been set by popt, but
494 * we need to remember that we're using a
495 * non-default setting. */
5b56cc19
AT
496 modify_window_set = 1;
497 break;
1de50993
WD
498
499 case OPT_DELETE_AFTER:
500 delete_after = 1;
501 delete_mode = 1;
502 break;
503
b33b791e
DD
504 case OPT_DELETE_EXCLUDED:
505 delete_excluded = 1;
506 delete_mode = 1;
507 break;
508
d853783f 509 case OPT_EXCLUDE:
2855f61f 510 add_exclude(poptGetOptArg(pc), 0);
d853783f
AT
511 break;
512
513 case OPT_INCLUDE:
2855f61f 514 add_exclude(poptGetOptArg(pc), 1);
d853783f
AT
515 break;
516
517 case OPT_EXCLUDE_FROM:
2855f61f 518 add_exclude_file(poptGetOptArg(pc), 1, 0);
d853783f
AT
519 break;
520
93695764
DD
521 case OPT_INCLUDE_FROM:
522 add_exclude_file(poptGetOptArg(pc), 1, 1);
523 break;
524
d853783f
AT
525 case 'h':
526 usage(FINFO);
527 exit_cleanup(0);
528
d853783f 529 case 'H':
7a6421fa 530#if SUPPORT_HARD_LINKS
d853783f 531 preserve_hard_links=1;
2855f61f 532#else
dfa32483
WD
533 /* FIXME: Don't say "server" if this is
534 * happening on the client. */
535 /* FIXME: Why do we have the duplicated
536 * rprintf? Everybody who gets this message
537 * ought to send it to the client and also to
538 * the logs. */
8950ac03 539 snprintf(err_buf,sizeof(err_buf),
dfa32483 540 "hard links are not supported on this %s\n",
2855f61f 541 am_server ? "server" : "client");
d853783f 542 rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
b11ed3b1 543 return 0;
2855f61f 544#endif /* SUPPORT_HARD_LINKS */
d853783f 545 break;
7a6421fa 546
d853783f
AT
547 case 'v':
548 verbose++;
549 break;
7a6421fa 550
b86f0cef
DD
551 case 'q':
552 if (frommain) quiet++;
553 break;
554
d853783f
AT
555 case OPT_SENDER:
556 if (!am_server) {
557 usage(FERROR);
65417579 558 exit_cleanup(RERR_SYNTAX);
d853783f
AT
559 }
560 am_sender = 1;
561 break;
562
d9fcc198
AT
563 case 'P':
564 do_progress = 1;
565 keep_partial = 1;
566 break;
567
088aac85
DD
568 case OPT_WRITE_BATCH:
569 /* popt stores the filename in batch_prefix for us */
570 write_batch = 1;
571 break;
572
76f79ba7 573 case OPT_READ_BATCH:
088aac85 574 /* popt stores the filename in batch_prefix for us */
6902ed17
MP
575 read_batch = 1;
576 break;
ea5164d1 577
59c95e42
DD
578 case OPT_LINK_DEST:
579#if HAVE_LINK
9680f811 580 compare_dest = (char *)poptGetOptArg(pc);
59c95e42
DD
581 link_dest = 1;
582 break;
583#else
584 snprintf(err_buf,sizeof(err_buf),
dfa32483 585 "hard links are not supported on this %s\n",
59c95e42
DD
586 am_server ? "server" : "client");
587 rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
588 return 0;
589#endif
590
6902ed17 591
d853783f 592 default:
dfa32483
WD
593 /* FIXME: If --daemon is specified, then errors for later
594 * parameters seem to disappear. */
595 snprintf(err_buf, sizeof(err_buf),
596 "%s%s: %s\n",
597 am_server ? "on remote machine: " : "",
598 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
599 poptStrerror(opt));
600 return 0;
d853783f 601 }
7a6421fa 602 }
2855f61f 603
088aac85 604 if (write_batch && read_batch) {
dfa32483
WD
605 snprintf(err_buf,sizeof(err_buf),
606 "write-batch and read-batch can not be used together\n");
607 rprintf(FERROR,"ERROR: write-batch and read-batch"
608 " can not be used together\n");
609 return 0;
088aac85
DD
610 }
611
612 if (do_compression && (write_batch || read_batch)) {
dfa32483
WD
613 snprintf(err_buf,sizeof(err_buf),
614 "compress can not be used with write-batch or read-batch\n");
615 rprintf(FERROR,"ERROR: compress can not be used with"
616 " write-batch or read-batch\n");
617 return 0;
088aac85
DD
618 }
619
dfa32483 620 if (archive_mode) {
ea5164d1
WD
621 if (!files_from)
622 recurse = 1;
dfa32483
WD
623#if SUPPORT_LINKS
624 preserve_links = 1;
625#endif
626 preserve_perms = 1;
627 preserve_times = 1;
628 preserve_gid = 1;
629 preserve_uid = 1;
630 preserve_devices = 1;
631 }
632
ea5164d1
WD
633 if (relative_paths < 0)
634 relative_paths = files_from? 1 : 0;
635
dfa32483
WD
636 *argv = poptGetArgs(pc);
637 if (*argv)
638 *argc = count_args(*argv);
639 else
640 *argc = 0;
2855f61f 641
ea5164d1
WD
642 if (files_from) {
643 char *colon;
644 if (*argc != 2) {
645 usage(FERROR);
646 exit_cleanup(RERR_SYNTAX);
647 }
648 if (strcmp(files_from, "-") == 0)
649 filesfrom_fd = 0;
650 else if ((colon = find_colon(files_from)) != 0) {
651 if (am_server) {
652 usage(FERROR);
653 exit_cleanup(RERR_SYNTAX);
654 }
655 remote_filesfrom_file = colon+1 + (colon[1] == ':');
656 if (strcmp(remote_filesfrom_file, "-") == 0) {
657 rprintf(FERROR, "Invalid --files-from remote filename\n");
658 exit_cleanup(RERR_SYNTAX);
659 }
660 } else {
661 extern int sanitize_paths;
662 if (sanitize_paths)
663 sanitize_path(strdup(files_from), NULL);
664 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
665 if (filesfrom_fd < 0) {
666 rsyserr(FERROR, errno,
667 "failed to open files-from file %s",
668 files_from);
669 exit_cleanup(RERR_FILEIO);
670 }
671 }
672 }
673
b11ed3b1 674 return 1;
7a6421fa
AT
675}
676
677
dafe63ca
MP
678/**
679 * Construct a filtered list of options to pass through from the
680 * client to the server.
681 *
682 * This involves setting options that will tell the server how to
683 * behave, and also filtering out options that are processed only
684 * locally.
685 **/
7a6421fa
AT
686void server_options(char **args,int *argc)
687{
d853783f
AT
688 int ac = *argc;
689 static char argstr[50];
690 static char bsize[30];
691 static char iotime[30];
0b73ca12 692 static char mdelete[30];
5b56cc19 693 static char mwindow[30];
ef5d23eb 694 static char bw[50];
088aac85
DD
695 /* Leave room for ``--(write|read)-batch='' */
696 static char fext[MAXPATHLEN + 15];
ef5d23eb 697
d853783f
AT
698 int i, x;
699
93689aa5
DD
700 if (blocking_io == -1)
701 blocking_io = 0;
702
d853783f
AT
703 args[ac++] = "--server";
704
1312d9fc
WD
705 if (daemon_over_rsh) {
706 args[ac++] = "--daemon";
707 *argc = ac;
708 /* if we're passing --daemon, we're done */
709 return;
710 }
711
d853783f
AT
712 if (!am_sender)
713 args[ac++] = "--sender";
714
715 x = 1;
716 argstr[0] = '-';
717 for (i=0;i<verbose;i++)
718 argstr[x++] = 'v';
f0b36a48 719
b86f0cef 720 /* the -q option is intentionally left out */
d853783f
AT
721 if (make_backups)
722 argstr[x++] = 'b';
723 if (update_only)
724 argstr[x++] = 'u';
725 if (dry_run)
726 argstr[x++] = 'n';
727 if (preserve_links)
728 argstr[x++] = 'l';
729 if (copy_links)
730 argstr[x++] = 'L';
1bfbf40b 731
dfa32483 732 if (whole_file > 0)
d853783f 733 argstr[x++] = 'W';
bceec82f
MP
734 /* We don't need to send --no-whole-file, because it's the
735 * default for remote transfers, and in any case old versions
736 * of rsync will not understand it. */
dfa32483 737
d853783f
AT
738 if (preserve_hard_links)
739 argstr[x++] = 'H';
740 if (preserve_uid)
741 argstr[x++] = 'o';
742 if (preserve_gid)
743 argstr[x++] = 'g';
744 if (preserve_devices)
745 argstr[x++] = 'D';
746 if (preserve_times)
747 argstr[x++] = 't';
748 if (preserve_perms)
749 argstr[x++] = 'p';
750 if (recurse)
751 argstr[x++] = 'r';
752 if (always_checksum)
753 argstr[x++] = 'c';
754 if (cvs_exclude)
755 argstr[x++] = 'C';
756 if (ignore_times)
757 argstr[x++] = 'I';
758 if (relative_paths)
759 argstr[x++] = 'R';
760 if (one_file_system)
761 argstr[x++] = 'x';
762 if (sparse_files)
763 argstr[x++] = 'S';
764 if (do_compression)
765 argstr[x++] = 'z';
f0b36a48 766
dfa32483 767 /* this is a complete hack - blame Rusty
f0b36a48
AT
768
769 this is a hack to make the list_only (remote file list)
770 more useful */
dfa32483 771 if (list_only && !recurse)
f0b36a48
AT
772 argstr[x++] = 'r';
773
d853783f
AT
774 argstr[x] = 0;
775
776 if (x != 1) args[ac++] = argstr;
777
778 if (block_size != BLOCK_SIZE) {
8950ac03 779 snprintf(bsize,sizeof(bsize),"-B%d",block_size);
d853783f 780 args[ac++] = bsize;
dfa32483 781 }
d853783f 782
0b73ca12 783 if (max_delete && am_sender) {
8950ac03 784 snprintf(mdelete,sizeof(mdelete),"--max-delete=%d",max_delete);
0b73ca12 785 args[ac++] = mdelete;
dfa32483
WD
786 }
787
088aac85
DD
788 if (batch_prefix != NULL) {
789 char *fmt = "";
790 if (write_batch)
dfa32483 791 fmt = "--write-batch=%s";
088aac85
DD
792 else
793 if (read_batch)
dfa32483 794 fmt = "--read-batch=%s";
088aac85 795 snprintf(fext,sizeof(fext),fmt,batch_prefix);
6902ed17
MP
796 args[ac++] = fext;
797 }
0b73ca12 798
d853783f 799 if (io_timeout) {
8950ac03 800 snprintf(iotime,sizeof(iotime),"--timeout=%d",io_timeout);
d853783f 801 args[ac++] = iotime;
dfa32483 802 }
d853783f 803
ef5d23eb 804 if (bwlimit) {
8950ac03 805 snprintf(bw,sizeof(bw),"--bwlimit=%d",bwlimit);
ef5d23eb
DD
806 args[ac++] = bw;
807 }
808
d853783f
AT
809 if (strcmp(backup_suffix, BACKUP_SUFFIX)) {
810 args[ac++] = "--suffix";
811 args[ac++] = backup_suffix;
812 }
813
b33b791e 814 if (delete_mode && !delete_excluded)
d853783f
AT
815 args[ac++] = "--delete";
816
b33b791e
DD
817 if (delete_excluded)
818 args[ac++] = "--delete-excluded";
819
f83f0548
AT
820 if (size_only)
821 args[ac++] = "--size-only";
822
5b56cc19 823 if (modify_window_set) {
dfa32483 824 snprintf(mwindow,sizeof(mwindow),"--modify-window=%d",
5b56cc19
AT
825 modify_window);
826 args[ac++] = mwindow;
827 }
828
d853783f
AT
829 if (keep_partial)
830 args[ac++] = "--partial";
831
832 if (force_delete)
833 args[ac++] = "--force";
834
57df171b
AT
835 if (delete_after)
836 args[ac++] = "--delete-after";
837
ef55c686
AT
838 if (ignore_errors)
839 args[ac++] = "--ignore-errors";
840
b5313607
DD
841 if (copy_unsafe_links)
842 args[ac++] = "--copy-unsafe-links";
843
d853783f
AT
844 if (safe_symlinks)
845 args[ac++] = "--safe-links";
846
847 if (numeric_ids)
848 args[ac++] = "--numeric-ids";
849
0b73ca12 850 if (only_existing && am_sender)
1347d512
AT
851 args[ac++] = "--existing";
852
dfa32483 853 if (opt_ignore_existing && am_sender)
3d6feada
MP
854 args[ac++] = "--ignore-existing";
855
d853783f
AT
856 if (tmpdir) {
857 args[ac++] = "--temp-dir";
858 args[ac++] = tmpdir;
859 }
860
66203a98
AT
861 if (backup_dir && am_sender) {
862 /* only the receiver needs this option, if we are the sender
863 * then we need to send it to the receiver.
864 */
865 args[ac++] = "--backup-dir";
866 args[ac++] = backup_dir;
867 }
868
375a4556
DD
869 if (compare_dest && am_sender) {
870 /* the server only needs this option if it is not the sender,
871 * and it may be an older version that doesn't know this
872 * option, so don't send it if client is the sender.
873 */
59c95e42 874 args[ac++] = link_dest ? "--link-dest" : "--compare-dest";
375a4556
DD
875 args[ac++] = compare_dest;
876 }
877
ea5164d1
WD
878 if (files_from && (!am_sender || remote_filesfrom_file)) {
879 if (remote_filesfrom_file) {
880 args[ac++] = "--files-from";
881 args[ac++] = remote_filesfrom_file;
882 if (eol_nulls)
883 args[ac++] = "--from0";
884 } else {
885 args[ac++] = "--files-from=-";
886 args[ac++] = "--from0";
887 }
888 }
889
d853783f 890 *argc = ac;
7a6421fa
AT
891}
892
ea5164d1
WD
893/**
894 * Return the position of a ':' IF it is not part of a filename (i.e. as
895 * long as it doesn't occur after a slash.
896 */
897char *find_colon(char *s)
898{
899 char *p, *p2;
900
901 p = strchr(s,':');
902 if (!p) return NULL;
903
904 /* now check to see if there is a / in the string before the : - if there is then
905 discard the colon on the assumption that the : is part of a filename */
906 p2 = strchr(s,'/');
907 if (p2 && p2 < p) return NULL;
908
909 return p;
910}
911
912