Document a couple more changes.
[rsync/rsync.git] / options.c
CommitLineData
7a24c346 1/* -*- c-file-style: "linux" -*-
dfa32483 2 *
dafe63ca
MP
3 * Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4 * Copyright (C) 2000, 2001, 2002 by Martin Pool <mbp@samba.org>
dfa32483 5 *
dafe63ca
MP
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
dfa32483 10 *
dafe63ca
MP
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
dfa32483 15 *
dafe63ca
MP
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
7a6421fa 20
7a6421fa 21#include "rsync.h"
2855f61f 22#include "popt.h"
7a6421fa 23
7be73df4
WD
24extern int sanitize_paths;
25extern char curr_dir[MAXPATHLEN];
bf6dcd17 26extern struct exclude_list_struct exclude_list;
8645af1d 27
7a6421fa 28int make_backups = 0;
1bfbf40b
MP
29
30/**
dfa32483 31 * If 1, send the whole file as literal data rather than trying to
dafe63ca 32 * create an incremental diff.
1bfbf40b 33 *
dfa32483 34 * If -1, then look at whether we're local or remote and go by that.
dafe63ca
MP
35 *
36 * @sa disable_deltas_p()
1bfbf40b 37 **/
dfa32483 38int whole_file = -1;
1bfbf40b 39
dfa32483 40int archive_mode = 0;
7a6421fa
AT
41int copy_links = 0;
42int preserve_links = 0;
43int preserve_hard_links = 0;
44int preserve_perms = 0;
45int preserve_devices = 0;
46int preserve_uid = 0;
47int preserve_gid = 0;
48int preserve_times = 0;
49int update_only = 0;
50int cvs_exclude = 0;
a5c11139
WD
51int dry_run = 0;
52int local_server = 0;
53int ignore_times = 0;
54int delete_mode = 0;
55int delete_excluded = 0;
56int one_file_system = 0;
4f3e9a0f 57int protocol_version = PROTOCOL_VERSION;
a5c11139
WD
58int sparse_files = 0;
59int do_compression = 0;
60int am_root = 0;
61int orig_umask = 0;
ea5164d1
WD
62int relative_paths = -1;
63int implied_dirs = 1;
7a6421fa
AT
64int numeric_ids = 0;
65int force_delete = 0;
66int io_timeout = 0;
7a6421fa
AT
67int read_only = 0;
68int module_id = -1;
69int am_server = 0;
30ce7e8a 70int am_sender = 0;
4337c8f8 71int am_generator = 0;
ea5164d1
WD
72char *files_from = NULL;
73int filesfrom_fd = -1;
74char *remote_filesfrom_file = NULL;
75int eol_nulls = 0;
7a6421fa 76int recurse = 0;
1312d9fc
WD
77int am_daemon = 0;
78int daemon_over_rsh = 0;
a5c11139
WD
79int do_stats = 0;
80int do_progress = 0;
81int keep_partial = 0;
82int safe_symlinks = 0;
83int copy_unsafe_links = 0;
84int size_only = 0;
85int bwlimit = 0;
86int delete_after = 0;
87int only_existing = 0;
88int opt_ignore_existing = 0;
89int max_delete = 0;
90int ignore_errors = 0;
91int modify_window = 0;
92int blocking_io = -1;
2289bf64 93int checksum_seed = 0;
da9d12f5 94unsigned int block_size = 0;
7a6421fa 95
b35d0d8e 96
13e29995 97/** Network address family. **/
6ab6d4bf 98#ifdef INET6
13e29995 99int default_af_hint = 0; /* Any protocol */
6ab6d4bf 100#else
13e29995 101int default_af_hint = AF_INET; /* Must use IPv4 */
6ab6d4bf 102#endif
06963d0f 103
13e29995
MP
104/** Do not go into the background when run as --daemon. Good
105 * for debugging and required for running as a service on W32,
106 * or under Unix process-monitors. **/
107int no_detach = 0;
108
088aac85
DD
109int write_batch = 0;
110int read_batch = 0;
d175d7e1
WD
111int backup_dir_len = 0;
112int backup_suffix_len;
e0391f81 113unsigned int backup_dir_remainder;
6902ed17 114
d175d7e1 115char *backup_suffix = NULL;
7a6421fa 116char *tmpdir = NULL;
375a4556 117char *compare_dest = NULL;
30e8c8e1 118char *config_file = NULL;
7a6421fa 119char *shell_cmd = NULL;
b6062654 120char *log_format = NULL;
65575e96 121char *password_file = NULL;
41bd28fe 122char *rsync_path = RSYNC_PATH;
66203a98 123char *backup_dir = NULL;
e0391f81 124char backup_dir_buf[MAXPATHLEN];
7a6421fa 125int rsync_port = RSYNC_PORT;
59c95e42 126int link_dest = 0;
7a6421fa
AT
127
128int verbose = 0;
b86f0cef 129int quiet = 0;
7a6421fa 130int always_checksum = 0;
f7632fc6 131int list_only = 0;
7a6421fa 132
2289bf64 133#define FIXED_CHECKSUM_SEED 32761
beb93684 134#define MAX_BATCH_PREFIX_LEN 256 /* Must be less than MAXPATHLEN-13 */
088aac85 135char *batch_prefix = NULL;
6902ed17 136
e1add893 137static int daemon_opt; /* sets am_daemon after option error-reporting */
5b56cc19
AT
138static int modify_window_set;
139
06963d0f
MP
140/** Local address to bind. As a character string because it's
141 * interpreted by the IPv6 layer: should be a numeric IP4 or ip6
142 * address, or a hostname. **/
143char *bind_address;
5c9730a4 144
7a24c346 145
27a12348 146static void print_rsync_version(enum logcode f)
7a24c346 147{
dfa32483
WD
148 char const *got_socketpair = "no ";
149 char const *hardlinks = "no ";
150 char const *links = "no ";
a358449a 151 char const *ipv6 = "no ";
736a6a29 152 STRUCT_STAT *dumstat;
0c80cd8e
MP
153
154#ifdef HAVE_SOCKETPAIR
dfa32483 155 got_socketpair = "";
0c80cd8e 156#endif
2855f61f
MP
157
158#if SUPPORT_HARD_LINKS
dfa32483 159 hardlinks = "";
2855f61f
MP
160#endif
161
162#if SUPPORT_LINKS
dfa32483 163 links = "";
2855f61f
MP
164#endif
165
a358449a
MP
166#if INET6
167 ipv6 = "";
dfa32483 168#endif
a358449a 169
dfa32483
WD
170 rprintf(f, "%s version %s protocol version %d\n",
171 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
172 rprintf(f,
45ddbf62 173 "Copyright (C) 1996-2004 by Andrew Tridgell and others\n");
3b4b1984 174 rprintf(f, "<http://rsync.samba.org/>\n");
dfa32483
WD
175 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
176 "%shard links, %ssymlinks, batchfiles, \n",
a5c11139 177 (int) (sizeof (OFF_T) * 8),
dfa32483 178 got_socketpair, hardlinks, links);
2855f61f 179
736a6a29
MP
180 /* Note that this field may not have type ino_t. It depends
181 * on the complicated interaction between largefile feature
182 * macros. */
7a52790b 183 rprintf(f, " %sIPv6, %d-bit system inums, %d-bit internal inums\n",
dfa32483 184 ipv6,
a5c11139 185 (int) (sizeof dumstat->st_ino * 8),
5f381268 186 (int) (sizeof (uint64) * 8));
fc0302cf
MP
187#ifdef MAINTAINER_MODE
188 rprintf(f, " panic action: \"%s\"\n",
189 get_panic_action());
190#endif
736a6a29 191
7a24c346 192#ifdef NO_INT64
dfa32483 193 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
7a24c346 194#endif
7b329a2d
MP
195
196 rprintf(f,
197"\n"
198"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
199"are welcome to redistribute it under certain conditions. See the GNU\n"
200"General Public Licence for details.\n"
201 );
7a24c346
MP
202}
203
204
0f3203c3 205void usage(enum logcode F)
7a6421fa 206{
2855f61f 207 print_rsync_version(F);
704f908e 208
3ff984d7 209 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
704f908e 210
9ef53907 211 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
704f908e 212 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
9ef53907 213 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
14d43f1f 214 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
9ef53907 215 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
14d43f1f 216 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
eaa4c150 217 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
9ef53907
DD
218 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
219 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
220 rprintf(F," sources separated by space as long as they have same top-level\n");
704f908e
AT
221 rprintf(F,"\nOptions\n");
222 rprintf(F," -v, --verbose increase verbosity\n");
b86f0cef 223 rprintf(F," -q, --quiet decrease verbosity\n");
704f908e 224 rprintf(F," -c, --checksum always checksum\n");
06891710 225 rprintf(F," -a, --archive archive mode, equivalent to -rlptgoD\n");
704f908e
AT
226 rprintf(F," -r, --recursive recurse into directories\n");
227 rprintf(F," -R, --relative use relative path names\n");
ea5164d1
WD
228 rprintf(F," --no-relative turn off --relative\n");
229 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
6839140e 230 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
e20c5e95 231 rprintf(F," --backup-dir make backups into this directory\n");
6839140e 232 rprintf(F," --suffix=SUFFIX backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
704f908e 233 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
13e29995 234 rprintf(F," -l, --links copy symlinks as symlinks\n");
06d76beb
WD
235 rprintf(F," -L, --copy-links copy the referent of all symlinks\n");
236 rprintf(F," --copy-unsafe-links copy the referent of \"unsafe\" symlinks\n");
237 rprintf(F," --safe-links ignore \"unsafe\" symlinks\n");
704f908e
AT
238 rprintf(F," -H, --hard-links preserve hard links\n");
239 rprintf(F," -p, --perms preserve permissions\n");
240 rprintf(F," -o, --owner preserve owner (root only)\n");
241 rprintf(F," -g, --group preserve group\n");
242 rprintf(F," -D, --devices preserve devices (root only)\n");
dfa32483 243 rprintf(F," -t, --times preserve times\n");
704f908e
AT
244 rprintf(F," -S, --sparse handle sparse files efficiently\n");
245 rprintf(F," -n, --dry-run show what would have been transferred\n");
246 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
93689aa5 247 rprintf(F," --no-whole-file turn off --whole-file\n");
704f908e 248 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
dfa32483 249 rprintf(F," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE);
54170a08 250 rprintf(F," -e, --rsh=COMMAND specify the remote shell\n");
704f908e 251 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
1347d512 252 rprintf(F," --existing only update files that already exist\n");
6839140e 253 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
704f908e 254 rprintf(F," --delete delete files that don't exist on the sending side\n");
b33b791e 255 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
ad1a09a5 256 rprintf(F," --delete-after receiver deletes after transferring, not before\n");
db2b5cb7 257 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
0b73ca12 258 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
c95da96a 259 rprintf(F," --partial keep partially transferred files\n");
704f908e
AT
260 rprintf(F," --force force deletion of directories even if not empty\n");
261 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
db2b5cb7 262 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
6839140e
WD
263 rprintf(F," -I, --ignore-times turn off mod time & file size quick check\n");
264 rprintf(F," --size-only ignore mod time for quick check (use size)\n");
265 rprintf(F," --modify-window=NUM compare mod times with reduced accuracy\n");
704f908e 266 rprintf(F," -T --temp-dir=DIR create temporary files in directory DIR\n");
375a4556 267 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
8294b00c 268 rprintf(F," --link-dest=DIR create hardlinks to DIR for unchanged files\n");
d9fcc198 269 rprintf(F," -P equivalent to --partial --progress\n");
704f908e 270 rprintf(F," -z, --compress compress file data\n");
ea5164d1 271 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
2acf81eb 272 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
858fb9eb 273 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
2acf81eb 274 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
858fb9eb 275 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
ea5164d1 276 rprintf(F," --files-from=FILE read FILE for list of source-file names\n");
6839140e 277 rprintf(F," -0 --from0 all *-from file lists are delimited by nulls\n");
dfa32483 278 rprintf(F," --version print version number\n");
db2b5cb7 279 rprintf(F," --daemon run as an rsync daemon\n");
dfa32483
WD
280 rprintf(F," --no-detach do not detach from the parent\n");
281 rprintf(F," --address=ADDRESS bind to the specified address\n");
282 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
704f908e 283 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
db2b5cb7 284 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
dfa32483
WD
285 rprintf(F," --no-blocking-io turn off --blocking-io\n");
286 rprintf(F," --stats give some file transfer stats\n");
287 rprintf(F," --progress show progress during transfer\n");
288 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
65575e96 289 rprintf(F," --password-file=FILE get password from FILE\n");
ef5d23eb 290 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
088aac85
DD
291 rprintf(F," --write-batch=PREFIX write batch fileset starting with PREFIX\n");
292 rprintf(F," --read-batch=PREFIX read batch fileset starting with PREFIX\n");
06963d0f 293#ifdef INET6
3dd22903
WD
294 rprintf(F," -4 --ipv4 prefer IPv4\n");
295 rprintf(F," -6 --ipv6 prefer IPv6\n");
06963d0f 296#endif
3dd22903 297 rprintf(F," -h, --help show this help screen\n");
7a6421fa
AT
298
299 rprintf(F,"\n");
b72f24c7
AT
300
301 rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
2855f61f 302 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
7a6421fa
AT
303}
304
1f3d6cdd
WD
305enum {OPT_VERSION = 1000, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
306 OPT_DELETE_AFTER, OPT_DELETE_EXCLUDED, OPT_LINK_DEST,
307 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
c67d1386
WD
308 OPT_READ_BATCH, OPT_WRITE_BATCH,
309 OPT_REFUSED_BASE = 9000};
7a6421fa 310
2855f61f
MP
311static struct poptOption long_options[] = {
312 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
dfa32483 313 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
d175d7e1 314 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
3dd22903
WD
315 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
316 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
afb6e945
WD
317 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
318 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
8b54f004 319 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
afb6e945
WD
320 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
321 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
322 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
323 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
1de50993 324 {"delete-after", 0, POPT_ARG_NONE, 0, OPT_DELETE_AFTER, 0, 0 },
8b54f004 325 {"delete-excluded", 0, POPT_ARG_NONE, 0, OPT_DELETE_EXCLUDED, 0, 0 },
afb6e945
WD
326 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
327 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
8b54f004
MP
328 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
329 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
330 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
331 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
afb6e945 332 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
8b54f004 333 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
afb6e945
WD
334 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
335 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
336 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
337 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
338 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
339 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
340 {"copy-links", 'L', POPT_ARG_NONE, &copy_links, 0, 0, 0 },
341 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
342 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
343 {"copy-unsafe-links", 0, POPT_ARG_NONE, &copy_unsafe_links, 0, 0, 0 },
344 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
345 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
346 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
347 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
348 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
349 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
8b54f004
MP
350 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
351 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
dfa32483 352 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
afb6e945 353 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
dfa32483 354 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
afb6e945 355 {"recursive", 'r', POPT_ARG_NONE, &recurse, 0, 0, 0 },
ea5164d1
WD
356 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
357 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
afb6e945
WD
358 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
359 {"block-size", 'B', POPT_ARG_INT, &block_size, 0, 0, 0 },
360 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
361 {"timeout", 0, POPT_ARG_INT, &io_timeout, 0, 0, 0 },
362 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
363 {"compare-dest", 0, POPT_ARG_STRING, &compare_dest, 0, 0, 0 },
7be73df4 364 {"link-dest", 0, POPT_ARG_STRING, &compare_dest, OPT_LINK_DEST, 0, 0 },
2855f61f 365 /* TODO: Should this take an optional int giving the compression level? */
afb6e945 366 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
e1add893 367 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
afb6e945
WD
368 {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 },
369 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
370 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
371 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
372 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
373 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
374 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
dfa32483 375 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
afb6e945
WD
376 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
377 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
378 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
379 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
8b54f004 380 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
afb6e945
WD
381 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
382 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
dfa32483
WD
383 {"read-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_READ_BATCH, 0, 0 },
384 {"write-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_WRITE_BATCH, 0, 0 },
ea5164d1
WD
385 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
386 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
387 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
4f3e9a0f 388 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
06963d0f 389#ifdef INET6
3dd22903
WD
390 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
391 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
06963d0f 392#endif
8b54f004 393 {0,0,0,0, 0, 0, 0}
2855f61f 394};
7a6421fa 395
06963d0f 396
cd8185f2
AT
397static char err_buf[100];
398
2855f61f 399
dafe63ca
MP
400/**
401 * Store the option error message, if any, so that we can log the
402 * connection attempt (which requires parsing the options), and then
403 * show the error later on.
404 **/
cd8185f2
AT
405void option_error(void)
406{
407 if (err_buf[0]) {
2855f61f 408 rprintf(FLOG, "%s", err_buf);
b7b2741f 409 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
cd8185f2 410 } else {
add7e8fb
MP
411 rprintf (FERROR, "Error parsing options: "
412 "option may be supported on client but not on server?\n");
413 rprintf (FERROR, RSYNC_NAME ": Error parsing options: "
414 "option may be supported on client but not on server?\n");
cd8185f2 415 }
cd8185f2
AT
416}
417
dafe63ca
MP
418
419/**
27ed20f7
WD
420 * Tweak the option table to disable all options that the rsyncd.conf
421 * file has told us to refuse.
dafe63ca 422 **/
27ed20f7 423static void set_refuse_options(char *bp)
cd8185f2 424{
27ed20f7
WD
425 struct poptOption *op;
426 char *cp;
427
428 while (1) {
429 if ((cp = strchr(bp, ' ')) != NULL)
430 *cp= '\0';
55afbb52
WD
431 for (op = long_options; ; op++) {
432 if (!op->longName) {
433 rprintf(FLOG,
434 "Unknown option %s in \"refuse options\" setting\n",
435 bp);
436 break;
437 }
27ed20f7 438 if (strcmp(bp, op->longName) == 0) {
c67d1386 439 op->val = (op - long_options)+OPT_REFUSED_BASE;
27ed20f7
WD
440 break;
441 }
cd8185f2 442 }
27ed20f7
WD
443 if (!cp)
444 break;
445 *cp = ' ';
446 bp = cp + 1;
cd8185f2 447 }
cd8185f2
AT
448}
449
450
2855f61f
MP
451static int count_args(char const **argv)
452{
dfa32483 453 int i = 0;
2855f61f 454
dfa32483
WD
455 while (argv[i] != NULL)
456 i++;
457
458 return i;
2855f61f
MP
459}
460
461
dafe63ca
MP
462/**
463 * Process command line arguments. Called on both local and remote.
464 *
465 * @retval 1 if all options are OK; with globals set to appropriate
466 * values
467 *
468 * @retval 0 on error, with err_buf containing an explanation
469 **/
2855f61f 470int parse_arguments(int *argc, const char ***argv, int frommain)
7a6421fa 471{
d853783f 472 int opt;
cd8185f2 473 char *ref = lp_refuse_options(module_id);
7be73df4 474 const char *arg;
dfa32483 475 poptContext pc;
d853783f 476
27ed20f7
WD
477 if (ref && *ref)
478 set_refuse_options(ref);
479
dfa32483 480 /* TODO: Call poptReadDefaultConfig; handle errors. */
cd8185f2 481
dfa32483
WD
482 /* The context leaks in case of an error, but if there's a
483 * problem we always exit anyhow. */
484 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
2855f61f
MP
485
486 while ((opt = poptGetNextOpt(pc)) != -1) {
dfa32483
WD
487 /* most options are handled automatically by popt;
488 * only special cases are returned and listed here. */
2855f61f 489
d853783f
AT
490 switch (opt) {
491 case OPT_VERSION:
dfa32483 492 print_rsync_version(FINFO);
d853783f 493 exit_cleanup(0);
dfa32483 494
5b56cc19 495 case OPT_MODIFY_WINDOW:
dfa32483
WD
496 /* The value has already been set by popt, but
497 * we need to remember that we're using a
498 * non-default setting. */
5b56cc19
AT
499 modify_window_set = 1;
500 break;
1de50993
WD
501
502 case OPT_DELETE_AFTER:
503 delete_after = 1;
504 delete_mode = 1;
505 break;
506
b33b791e
DD
507 case OPT_DELETE_EXCLUDED:
508 delete_excluded = 1;
509 delete_mode = 1;
510 break;
511
d853783f 512 case OPT_EXCLUDE:
357406ec 513 add_exclude(&exclude_list, poptGetOptArg(pc), 0);
d853783f
AT
514 break;
515
516 case OPT_INCLUDE:
8645af1d 517 add_exclude(&exclude_list, poptGetOptArg(pc),
357406ec 518 XFLG_DEF_INCLUDE);
d853783f
AT
519 break;
520
521 case OPT_EXCLUDE_FROM:
7be73df4
WD
522 arg = poptGetOptArg(pc);
523 if (sanitize_paths)
524 arg = alloc_sanitize_path(arg, curr_dir);
525 add_exclude_file(&exclude_list, arg,
357406ec 526 XFLG_FATAL_ERRORS);
d853783f
AT
527 break;
528
93695764 529 case OPT_INCLUDE_FROM:
7be73df4
WD
530 arg = poptGetOptArg(pc);
531 if (sanitize_paths)
532 arg = alloc_sanitize_path(arg, curr_dir);
533 add_exclude_file(&exclude_list, arg,
357406ec 534 XFLG_FATAL_ERRORS | XFLG_DEF_INCLUDE);
93695764
DD
535 break;
536
d853783f
AT
537 case 'h':
538 usage(FINFO);
539 exit_cleanup(0);
540
d853783f
AT
541 case 'v':
542 verbose++;
543 break;
7a6421fa 544
b86f0cef 545 case 'q':
f98c60bf
WD
546 if (frommain)
547 quiet++;
b86f0cef
DD
548 break;
549
d853783f
AT
550 case OPT_SENDER:
551 if (!am_server) {
552 usage(FERROR);
65417579 553 exit_cleanup(RERR_SYNTAX);
d853783f
AT
554 }
555 am_sender = 1;
556 break;
557
d9fcc198
AT
558 case 'P':
559 do_progress = 1;
560 keep_partial = 1;
561 break;
562
088aac85
DD
563 case OPT_WRITE_BATCH:
564 /* popt stores the filename in batch_prefix for us */
565 write_batch = 1;
2289bf64 566 checksum_seed = FIXED_CHECKSUM_SEED;
088aac85
DD
567 break;
568
76f79ba7 569 case OPT_READ_BATCH:
088aac85 570 /* popt stores the filename in batch_prefix for us */
6902ed17 571 read_batch = 1;
2289bf64 572 checksum_seed = FIXED_CHECKSUM_SEED;
6902ed17 573 break;
ea5164d1 574
59c95e42
DD
575 case OPT_LINK_DEST:
576#if HAVE_LINK
59c95e42
DD
577 link_dest = 1;
578 break;
579#else
d175d7e1 580 snprintf(err_buf, sizeof err_buf,
dfa32483 581 "hard links are not supported on this %s\n",
59c95e42 582 am_server ? "server" : "client");
d175d7e1 583 rprintf(FERROR, "ERROR: %s", err_buf);
59c95e42
DD
584 return 0;
585#endif
586
d853783f 587 default:
55afbb52 588 /* A large opt value means that set_refuse_options()
c67d1386
WD
589 * turned this option off (opt-BASE is its index). */
590 if (opt >= OPT_REFUSED_BASE) {
591 struct poptOption *op =
592 &long_options[opt-OPT_REFUSED_BASE];
27ed20f7
WD
593 int n = snprintf(err_buf, sizeof err_buf,
594 "This server does not support --%s\n",
595 op->longName) - 1;
596 if (op->shortName) {
597 snprintf(err_buf+n, sizeof err_buf-n,
598 " (-%c)\n", op->shortName);
599 }
600 } else {
601 snprintf(err_buf, sizeof err_buf,
602 "%s%s: %s\n",
603 am_server ? "on remote machine: " : "",
604 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
605 poptStrerror(opt));
606 }
dfa32483 607 return 0;
d853783f 608 }
7a6421fa 609 }
2855f61f 610
e1add893 611#if !SUPPORT_LINKS
54e87b4b 612 if (preserve_links && !am_sender) {
e1add893
WD
613 snprintf(err_buf, sizeof err_buf,
614 "symlinks are not supported on this %s\n",
615 am_server ? "server" : "client");
616 rprintf(FERROR, "ERROR: %s", err_buf);
617 return 0;
618 }
619#endif
620
621#if !SUPPORT_HARD_LINKS
622 if (preserve_hard_links) {
623 snprintf(err_buf, sizeof err_buf,
624 "hard links are not supported on this %s\n",
625 am_server ? "server" : "client");
626 rprintf(FERROR, "ERROR: %s", err_buf);
627 return 0;
628 }
629#endif
630
088aac85 631 if (write_batch && read_batch) {
d175d7e1
WD
632 rprintf(FERROR,
633 "write-batch and read-batch can not be used together\n");
634 exit_cleanup(RERR_SYNTAX);
088aac85 635 }
beb93684
WD
636 if (batch_prefix && strlen(batch_prefix) > MAX_BATCH_PREFIX_LEN) {
637 rprintf(FERROR,
ce58b1b4 638 "the batch-file prefix must be %d characters or less.\n",
beb93684
WD
639 MAX_BATCH_PREFIX_LEN);
640 exit_cleanup(RERR_SYNTAX);
641 }
088aac85 642
ce58b1b4
WD
643 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
644 rprintf(FERROR, "the --temp-dir path is WAY too long.\n");
645 exit_cleanup(RERR_SYNTAX);
646 }
647
088aac85 648 if (do_compression && (write_batch || read_batch)) {
d175d7e1
WD
649 rprintf(FERROR,
650 "compress can not be used with write-batch or read-batch\n");
651 exit_cleanup(RERR_SYNTAX);
088aac85
DD
652 }
653
dfa32483 654 if (archive_mode) {
ea5164d1
WD
655 if (!files_from)
656 recurse = 1;
dfa32483
WD
657#if SUPPORT_LINKS
658 preserve_links = 1;
659#endif
660 preserve_perms = 1;
661 preserve_times = 1;
662 preserve_gid = 1;
663 preserve_uid = 1;
664 preserve_devices = 1;
665 }
666
ea5164d1
WD
667 if (relative_paths < 0)
668 relative_paths = files_from? 1 : 0;
669
7be73df4
WD
670 *argv = poptGetArgs(pc);
671 if (*argv)
672 *argc = count_args(*argv);
673 else
674 *argc = 0;
675
676 if (sanitize_paths) {
677 int i;
678 for (i = *argc; i-- > 0; )
679 (*argv)[i] = alloc_sanitize_path((*argv)[i], NULL);
680 if (tmpdir)
681 tmpdir = alloc_sanitize_path(tmpdir, curr_dir);
682 if (compare_dest)
683 compare_dest = alloc_sanitize_path(compare_dest, curr_dir);
7be73df4
WD
684 if (backup_dir)
685 backup_dir = alloc_sanitize_path(backup_dir, curr_dir);
686 if (files_from)
687 files_from = alloc_sanitize_path(files_from, curr_dir);
688 }
689
5df1fcf2
WD
690 if (daemon_opt) {
691 daemon_opt = 0;
692 am_daemon = 1;
693 return 1;
694 }
695
d175d7e1 696 if (!backup_suffix)
e0391f81 697 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
d175d7e1 698 backup_suffix_len = strlen(backup_suffix);
80ddadb7
WD
699 if (strchr(backup_suffix, '/') != NULL) {
700 rprintf(FERROR, "--suffix cannot contain slashes: %s\n",
701 backup_suffix);
702 exit_cleanup(RERR_SYNTAX);
703 }
e0391f81
WD
704 if (backup_dir) {
705 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
706 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
707 if (backup_dir_remainder < 32) {
708 rprintf(FERROR, "the --backup-dir path is WAY too long.\n");
709 exit_cleanup(RERR_SYNTAX);
710 }
711 if (backup_dir_buf[backup_dir_len - 1] != '/') {
712 backup_dir_buf[backup_dir_len++] = '/';
713 backup_dir_buf[backup_dir_len] = '\0';
714 }
8dcf9335 715 if (verbose > 1 && !am_sender)
e0391f81 716 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
8dcf9335 717 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
d175d7e1
WD
718 rprintf(FERROR,
719 "--suffix cannot be a null string without --backup-dir\n");
720 exit_cleanup(RERR_SYNTAX);
721 }
722
e2559dbe
S
723 if (do_progress && !verbose)
724 verbose = 1;
725
ea5164d1
WD
726 if (files_from) {
727 char *colon;
3e89da86 728 if (*argc != 2 && !(am_server && am_sender && *argc == 1)) {
ea5164d1
WD
729 usage(FERROR);
730 exit_cleanup(RERR_SYNTAX);
731 }
63596e1c 732 if (strcmp(files_from, "-") == 0) {
ea5164d1 733 filesfrom_fd = 0;
63596e1c
WD
734 if (am_server)
735 remote_filesfrom_file = "-";
736 }
ea5164d1
WD
737 else if ((colon = find_colon(files_from)) != 0) {
738 if (am_server) {
739 usage(FERROR);
740 exit_cleanup(RERR_SYNTAX);
741 }
742 remote_filesfrom_file = colon+1 + (colon[1] == ':');
743 if (strcmp(remote_filesfrom_file, "-") == 0) {
744 rprintf(FERROR, "Invalid --files-from remote filename\n");
745 exit_cleanup(RERR_SYNTAX);
746 }
747 } else {
ea5164d1
WD
748 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
749 if (filesfrom_fd < 0) {
750 rsyserr(FERROR, errno,
751 "failed to open files-from file %s",
752 files_from);
753 exit_cleanup(RERR_FILEIO);
754 }
755 }
756 }
757
b11ed3b1 758 return 1;
7a6421fa
AT
759}
760
761
dafe63ca
MP
762/**
763 * Construct a filtered list of options to pass through from the
764 * client to the server.
765 *
766 * This involves setting options that will tell the server how to
767 * behave, and also filtering out options that are processed only
768 * locally.
769 **/
7a6421fa
AT
770void server_options(char **args,int *argc)
771{
d853783f
AT
772 int ac = *argc;
773 static char argstr[50];
f98c60bf 774 char *arg;
ef5d23eb 775
d853783f
AT
776 int i, x;
777
93689aa5
DD
778 if (blocking_io == -1)
779 blocking_io = 0;
780
d853783f
AT
781 args[ac++] = "--server";
782
1312d9fc
WD
783 if (daemon_over_rsh) {
784 args[ac++] = "--daemon";
785 *argc = ac;
786 /* if we're passing --daemon, we're done */
787 return;
788 }
789
d853783f
AT
790 if (!am_sender)
791 args[ac++] = "--sender";
792
793 x = 1;
794 argstr[0] = '-';
f98c60bf 795 for (i = 0; i < verbose; i++)
d853783f 796 argstr[x++] = 'v';
f0b36a48 797
b86f0cef 798 /* the -q option is intentionally left out */
d853783f
AT
799 if (make_backups)
800 argstr[x++] = 'b';
801 if (update_only)
802 argstr[x++] = 'u';
803 if (dry_run)
804 argstr[x++] = 'n';
805 if (preserve_links)
806 argstr[x++] = 'l';
807 if (copy_links)
808 argstr[x++] = 'L';
1bfbf40b 809
dfa32483 810 if (whole_file > 0)
d853783f 811 argstr[x++] = 'W';
bceec82f
MP
812 /* We don't need to send --no-whole-file, because it's the
813 * default for remote transfers, and in any case old versions
814 * of rsync will not understand it. */
dfa32483 815
d853783f
AT
816 if (preserve_hard_links)
817 argstr[x++] = 'H';
818 if (preserve_uid)
819 argstr[x++] = 'o';
820 if (preserve_gid)
821 argstr[x++] = 'g';
822 if (preserve_devices)
823 argstr[x++] = 'D';
824 if (preserve_times)
825 argstr[x++] = 't';
826 if (preserve_perms)
827 argstr[x++] = 'p';
828 if (recurse)
829 argstr[x++] = 'r';
830 if (always_checksum)
831 argstr[x++] = 'c';
832 if (cvs_exclude)
833 argstr[x++] = 'C';
834 if (ignore_times)
835 argstr[x++] = 'I';
836 if (relative_paths)
837 argstr[x++] = 'R';
838 if (one_file_system)
839 argstr[x++] = 'x';
840 if (sparse_files)
841 argstr[x++] = 'S';
842 if (do_compression)
843 argstr[x++] = 'z';
f0b36a48 844
dfa32483 845 /* this is a complete hack - blame Rusty
f0b36a48
AT
846
847 this is a hack to make the list_only (remote file list)
848 more useful */
dfa32483 849 if (list_only && !recurse)
f0b36a48
AT
850 argstr[x++] = 'r';
851
d853783f
AT
852 argstr[x] = 0;
853
f98c60bf
WD
854 if (x != 1)
855 args[ac++] = argstr;
d853783f 856
195bd906 857 if (block_size) {
f98c60bf
WD
858 if (asprintf(&arg, "-B%u", block_size) < 0)
859 goto oom;
860 args[ac++] = arg;
dfa32483 861 }
d853783f 862
0b73ca12 863 if (max_delete && am_sender) {
f98c60bf
WD
864 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
865 goto oom;
866 args[ac++] = arg;
dfa32483
WD
867 }
868
f98c60bf
WD
869 if (batch_prefix) {
870 char *r_or_w = write_batch ? "write" : "read";
871 if (asprintf(&arg, "--%s-batch=%s", r_or_w, batch_prefix) < 0)
872 goto oom;
873 args[ac++] = arg;
6902ed17 874 }
0b73ca12 875
d853783f 876 if (io_timeout) {
f98c60bf
WD
877 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
878 goto oom;
879 args[ac++] = arg;
dfa32483 880 }
d853783f 881
ef5d23eb 882 if (bwlimit) {
f98c60bf
WD
883 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
884 goto oom;
885 args[ac++] = arg;
ef5d23eb
DD
886 }
887
d175d7e1
WD
888 if (backup_dir) {
889 args[ac++] = "--backup-dir";
890 args[ac++] = backup_dir;
891 }
892
893 /* Only send --suffix if it specifies a non-default value. */
f98c60bf 894 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
191e40da 895 /* We use the following syntax to avoid weirdness with '~'. */
f98c60bf
WD
896 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
897 goto oom;
898 args[ac++] = arg;
d853783f
AT
899 }
900
b33b791e
DD
901 if (delete_excluded)
902 args[ac++] = "--delete-excluded";
f98c60bf
WD
903 else if (delete_mode)
904 args[ac++] = "--delete";
b33b791e 905
f83f0548
AT
906 if (size_only)
907 args[ac++] = "--size-only";
908
5b56cc19 909 if (modify_window_set) {
f98c60bf
WD
910 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
911 goto oom;
912 args[ac++] = arg;
5b56cc19
AT
913 }
914
d853783f
AT
915 if (keep_partial)
916 args[ac++] = "--partial";
917
918 if (force_delete)
919 args[ac++] = "--force";
920
57df171b
AT
921 if (delete_after)
922 args[ac++] = "--delete-after";
923
ef55c686
AT
924 if (ignore_errors)
925 args[ac++] = "--ignore-errors";
926
b5313607
DD
927 if (copy_unsafe_links)
928 args[ac++] = "--copy-unsafe-links";
929
d853783f
AT
930 if (safe_symlinks)
931 args[ac++] = "--safe-links";
932
933 if (numeric_ids)
934 args[ac++] = "--numeric-ids";
935
0b73ca12 936 if (only_existing && am_sender)
1347d512
AT
937 args[ac++] = "--existing";
938
dfa32483 939 if (opt_ignore_existing && am_sender)
3d6feada
MP
940 args[ac++] = "--ignore-existing";
941
d853783f
AT
942 if (tmpdir) {
943 args[ac++] = "--temp-dir";
944 args[ac++] = tmpdir;
945 }
946
375a4556
DD
947 if (compare_dest && am_sender) {
948 /* the server only needs this option if it is not the sender,
949 * and it may be an older version that doesn't know this
950 * option, so don't send it if client is the sender.
951 */
59c95e42 952 args[ac++] = link_dest ? "--link-dest" : "--compare-dest";
375a4556
DD
953 args[ac++] = compare_dest;
954 }
955
ea5164d1
WD
956 if (files_from && (!am_sender || remote_filesfrom_file)) {
957 if (remote_filesfrom_file) {
958 args[ac++] = "--files-from";
959 args[ac++] = remote_filesfrom_file;
960 if (eol_nulls)
961 args[ac++] = "--from0";
962 } else {
963 args[ac++] = "--files-from=-";
964 args[ac++] = "--from0";
965 }
966 }
967
d853783f 968 *argc = ac;
f98c60bf
WD
969 return;
970
971 oom:
972 out_of_memory("server_options");
7a6421fa
AT
973}
974
ea5164d1
WD
975/**
976 * Return the position of a ':' IF it is not part of a filename (i.e. as
977 * long as it doesn't occur after a slash.
978 */
979char *find_colon(char *s)
980{
981 char *p, *p2;
982
983 p = strchr(s,':');
f98c60bf
WD
984 if (!p)
985 return NULL;
ea5164d1
WD
986
987 /* now check to see if there is a / in the string before the : - if there is then
988 discard the colon on the assumption that the : is part of a filename */
989 p2 = strchr(s,'/');
f98c60bf
WD
990 if (p2 && p2 < p)
991 return NULL;
ea5164d1
WD
992
993 return p;
994}