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