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