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