1 /* Command line parsing.
2 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation,
6 This file is part of GNU Wget.
8 GNU Wget is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 GNU Wget is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with Wget. If not, see <http://www.gnu.org/licenses/>.
21 Additional permission under GNU GPL version 3 section 7
23 If you modify this program, or any covered work, by linking or
24 combining it with the OpenSSL project's OpenSSL library (or a
25 modified version of that library), containing parts covered by the
26 terms of the OpenSSL or SSLeay licenses, the Free Software Foundation
27 grants you additional permission to convey the resulting work.
28 Corresponding Source for a non-source form of such a combination
29 shall include the source code for the parts of OpenSSL used as well
30 as that of the covered work. */
53 #include "progress.h" /* for progress_handle_sigwinch */
56 #include "http.h" /* for save_cookies */
72 #ifndef PATH_SEPARATOR
73 # define PATH_SEPARATOR '/'
82 /* defined in version.c */
83 extern char *version_string;
84 extern char *compilation_string;
85 extern char *system_getrc;
86 extern char *link_string;
87 /* defined in build_info.c */
88 extern const char *compiled_features[];
89 /* Used for --version output in print_version */
90 #define MAX_CHARS_PER_LINE 72
93 #if defined(SIGHUP) || defined(SIGUSR1)
94 static void redirect_output_signal (int);
97 const char *exec_name;
99 /* Number of successfully downloaded URLs */
103 /* Initialize I18N/L10N. That amounts to invoking setlocale, and
104 setting up gettext's message catalog using bindtextdomain and
105 textdomain. Does nothing if NLS is disabled or missing. */
108 i18n_initialize (void)
110 /* ENABLE_NLS implies existence of functions invoked here. */
112 /* Set the current locale. */
113 setlocale (LC_ALL, "");
114 /* Set the text message domain. */
115 bindtextdomain ("wget", LOCALEDIR);
117 #endif /* ENABLE_NLS */
120 /* Definition of command-line options. */
122 static void print_help (void);
123 static void print_version (void);
128 # define IF_SSL(x) NULL
132 # define WHEN_DEBUG(x) x
134 # define WHEN_DEBUG(x) NULL
137 struct cmdline_option {
138 const char *long_name;
144 /* Non-standard options that have to be handled specially in
148 OPT__DONT_REMOVE_LISTING,
153 const void *data; /* for standard options */
154 int argtype; /* for non-standard options */
157 static struct cmdline_option option_data[] =
159 { "accept", 'A', OPT_VALUE, "accept", -1 },
160 { "adjust-extension", 'E', OPT_BOOLEAN, "adjustextension", -1 },
161 { "append-output", 'a', OPT__APPEND_OUTPUT, NULL, required_argument },
162 { "ask-password", 0, OPT_BOOLEAN, "askpassword", -1 },
163 { "auth-no-challenge", 0, OPT_BOOLEAN, "authnochallenge", -1 },
164 { "background", 'b', OPT_BOOLEAN, "background", -1 },
165 { "backup-converted", 'K', OPT_BOOLEAN, "backupconverted", -1 },
166 { "backups", 0, OPT_BOOLEAN, "backups", -1 },
167 { "base", 'B', OPT_VALUE, "base", -1 },
168 { "bind-address", 0, OPT_VALUE, "bindaddress", -1 },
169 { IF_SSL ("ca-certificate"), 0, OPT_VALUE, "cacertificate", -1 },
170 { IF_SSL ("ca-directory"), 0, OPT_VALUE, "cadirectory", -1 },
171 { "cache", 0, OPT_BOOLEAN, "cache", -1 },
172 { IF_SSL ("certificate"), 0, OPT_VALUE, "certificate", -1 },
173 { IF_SSL ("certificate-type"), 0, OPT_VALUE, "certificatetype", -1 },
174 { IF_SSL ("check-certificate"), 0, OPT_BOOLEAN, "checkcertificate", -1 },
175 { "clobber", 0, OPT__CLOBBER, NULL, optional_argument },
176 { "config", 0, OPT_VALUE, "chooseconfig", -1 },
177 { "connect-timeout", 0, OPT_VALUE, "connecttimeout", -1 },
178 { "continue", 'c', OPT_BOOLEAN, "continue", -1 },
179 { "convert-links", 'k', OPT_BOOLEAN, "convertlinks", -1 },
180 { "content-disposition", 0, OPT_BOOLEAN, "contentdisposition", -1 },
181 { "content-on-error", 0, OPT_BOOLEAN, "contentonerror", -1 },
182 { "cookies", 0, OPT_BOOLEAN, "cookies", -1 },
183 { "cut-dirs", 0, OPT_VALUE, "cutdirs", -1 },
184 { WHEN_DEBUG ("debug"), 'd', OPT_BOOLEAN, "debug", -1 },
185 { "default-page", 0, OPT_VALUE, "defaultpage", -1 },
186 { "delete-after", 0, OPT_BOOLEAN, "deleteafter", -1 },
187 { "directories", 0, OPT_BOOLEAN, "dirstruct", -1 },
188 { "directory-prefix", 'P', OPT_VALUE, "dirprefix", -1 },
189 { "dns-cache", 0, OPT_BOOLEAN, "dnscache", -1 },
190 { "dns-timeout", 0, OPT_VALUE, "dnstimeout", -1 },
191 { "domains", 'D', OPT_VALUE, "domains", -1 },
192 { "dont-remove-listing", 0, OPT__DONT_REMOVE_LISTING, NULL, no_argument },
193 { "dot-style", 0, OPT_VALUE, "dotstyle", -1 }, /* deprecated */
194 { "egd-file", 0, OPT_VALUE, "egdfile", -1 },
195 { "exclude-directories", 'X', OPT_VALUE, "excludedirectories", -1 },
196 { "exclude-domains", 0, OPT_VALUE, "excludedomains", -1 },
197 { "execute", 'e', OPT__EXECUTE, NULL, required_argument },
198 { "follow-ftp", 0, OPT_BOOLEAN, "followftp", -1 },
199 { "follow-tags", 0, OPT_VALUE, "followtags", -1 },
200 { "force-directories", 'x', OPT_BOOLEAN, "dirstruct", -1 },
201 { "force-html", 'F', OPT_BOOLEAN, "forcehtml", -1 },
202 { "ftp-password", 0, OPT_VALUE, "ftppassword", -1 },
204 { "ftp-stmlf", 0, OPT_BOOLEAN, "ftpstmlf", -1 },
205 #endif /* def __VMS */
206 { "ftp-user", 0, OPT_VALUE, "ftpuser", -1 },
207 { "glob", 0, OPT_BOOLEAN, "glob", -1 },
208 { "header", 0, OPT_VALUE, "header", -1 },
209 { "help", 'h', OPT_FUNCALL, (void *)print_help, no_argument },
210 { "host-directories", 0, OPT_BOOLEAN, "addhostdir", -1 },
211 { "html-extension", 'E', OPT_BOOLEAN, "adjustextension", -1 }, /* deprecated */
212 { "htmlify", 0, OPT_BOOLEAN, "htmlify", -1 },
213 { "http-keep-alive", 0, OPT_BOOLEAN, "httpkeepalive", -1 },
214 { "http-passwd", 0, OPT_VALUE, "httppassword", -1 }, /* deprecated */
215 { "http-password", 0, OPT_VALUE, "httppassword", -1 },
216 { "http-user", 0, OPT_VALUE, "httpuser", -1 },
217 { "ignore-case", 0, OPT_BOOLEAN, "ignorecase", -1 },
218 { "ignore-length", 0, OPT_BOOLEAN, "ignorelength", -1 },
219 { "ignore-tags", 0, OPT_VALUE, "ignoretags", -1 },
220 { "include-directories", 'I', OPT_VALUE, "includedirectories", -1 },
222 { "inet4-only", '4', OPT_BOOLEAN, "inet4only", -1 },
223 { "inet6-only", '6', OPT_BOOLEAN, "inet6only", -1 },
225 { "input-file", 'i', OPT_VALUE, "input", -1 },
226 { "iri", 0, OPT_BOOLEAN, "iri", -1 },
227 { "keep-session-cookies", 0, OPT_BOOLEAN, "keepsessioncookies", -1 },
228 { "level", 'l', OPT_VALUE, "reclevel", -1 },
229 { "limit-rate", 0, OPT_VALUE, "limitrate", -1 },
230 { "load-cookies", 0, OPT_VALUE, "loadcookies", -1 },
231 { "local-encoding", 0, OPT_VALUE, "localencoding", -1 },
232 { "max-redirect", 0, OPT_VALUE, "maxredirect", -1 },
233 { "mirror", 'm', OPT_BOOLEAN, "mirror", -1 },
234 { "no", 'n', OPT__NO, NULL, required_argument },
235 { "no-clobber", 0, OPT_BOOLEAN, "noclobber", -1 },
236 { "no-parent", 0, OPT_BOOLEAN, "noparent", -1 },
237 { "output-document", 'O', OPT_VALUE, "outputdocument", -1 },
238 { "output-file", 'o', OPT_VALUE, "logfile", -1 },
239 { "page-requisites", 'p', OPT_BOOLEAN, "pagerequisites", -1 },
240 { "parent", 0, OPT__PARENT, NULL, optional_argument },
241 { "passive-ftp", 0, OPT_BOOLEAN, "passiveftp", -1 },
242 { "password", 0, OPT_VALUE, "password", -1 },
243 { "post-data", 0, OPT_VALUE, "postdata", -1 },
244 { "post-file", 0, OPT_VALUE, "postfile", -1 },
245 { "prefer-family", 0, OPT_VALUE, "preferfamily", -1 },
246 { "preserve-permissions", 0, OPT_BOOLEAN, "preservepermissions", -1 }, /* deprecated */
247 { IF_SSL ("private-key"), 0, OPT_VALUE, "privatekey", -1 },
248 { IF_SSL ("private-key-type"), 0, OPT_VALUE, "privatekeytype", -1 },
249 { "progress", 0, OPT_VALUE, "progress", -1 },
250 { "protocol-directories", 0, OPT_BOOLEAN, "protocoldirectories", -1 },
251 { "proxy", 0, OPT_BOOLEAN, "useproxy", -1 },
252 { "proxy__compat", 'Y', OPT_VALUE, "useproxy", -1 }, /* back-compatible */
253 { "proxy-passwd", 0, OPT_VALUE, "proxypassword", -1 }, /* deprecated */
254 { "proxy-password", 0, OPT_VALUE, "proxypassword", -1 },
255 { "proxy-user", 0, OPT_VALUE, "proxyuser", -1 },
256 { "quiet", 'q', OPT_BOOLEAN, "quiet", -1 },
257 { "quota", 'Q', OPT_VALUE, "quota", -1 },
258 { "random-file", 0, OPT_VALUE, "randomfile", -1 },
259 { "random-wait", 0, OPT_BOOLEAN, "randomwait", -1 },
260 { "read-timeout", 0, OPT_VALUE, "readtimeout", -1 },
261 { "recursive", 'r', OPT_BOOLEAN, "recursive", -1 },
262 { "referer", 0, OPT_VALUE, "referer", -1 },
263 { "reject", 'R', OPT_VALUE, "reject", -1 },
264 { "relative", 'L', OPT_BOOLEAN, "relativeonly", -1 },
265 { "remote-encoding", 0, OPT_VALUE, "remoteencoding", -1 },
266 { "remove-listing", 0, OPT_BOOLEAN, "removelisting", -1 },
267 { "restrict-file-names", 0, OPT_BOOLEAN, "restrictfilenames", -1 },
268 { "retr-symlinks", 0, OPT_BOOLEAN, "retrsymlinks", -1 },
269 { "retry-connrefused", 0, OPT_BOOLEAN, "retryconnrefused", -1 },
270 { "save-cookies", 0, OPT_VALUE, "savecookies", -1 },
271 { "save-headers", 0, OPT_BOOLEAN, "saveheaders", -1 },
272 { IF_SSL ("secure-protocol"), 0, OPT_VALUE, "secureprotocol", -1 },
273 { "server-response", 'S', OPT_BOOLEAN, "serverresponse", -1 },
274 { "span-hosts", 'H', OPT_BOOLEAN, "spanhosts", -1 },
275 { "spider", 0, OPT_BOOLEAN, "spider", -1 },
276 { "strict-comments", 0, OPT_BOOLEAN, "strictcomments", -1 },
277 { "timeout", 'T', OPT_VALUE, "timeout", -1 },
278 { "timestamping", 'N', OPT_BOOLEAN, "timestamping", -1 },
279 { "tries", 't', OPT_VALUE, "tries", -1 },
280 { "unlink", 0, OPT_BOOLEAN, "unlink", -1 },
281 { "trust-server-names", 0, OPT_BOOLEAN, "trustservernames", -1 },
282 { "use-server-timestamps", 0, OPT_BOOLEAN, "useservertimestamps", -1 },
283 { "user", 0, OPT_VALUE, "user", -1 },
284 { "user-agent", 'U', OPT_VALUE, "useragent", -1 },
285 { "verbose", 'v', OPT_BOOLEAN, "verbose", -1 },
286 { "verbose", 0, OPT_BOOLEAN, "verbose", -1 },
287 { "version", 'V', OPT_FUNCALL, (void *) print_version, no_argument },
288 { "wait", 'w', OPT_VALUE, "wait", -1 },
289 { "waitretry", 0, OPT_VALUE, "waitretry", -1 },
291 { "wdebug", 0, OPT_BOOLEAN, "wdebug", -1 },
298 /* Return a string that contains S with "no-" prepended. The string
299 is NUL-terminated and allocated off static storage at Wget
303 no_prefix (const char *s)
305 static char buffer[1024];
306 static char *p = buffer;
309 int size = 3 + strlen (s) + 1; /* "no-STRING\0" */
310 if (p + size >= buffer + sizeof (buffer))
313 cp[0] = 'n', cp[1] = 'o', cp[2] = '-';
319 /* The arguments that that main passes to getopt_long. */
320 static struct option long_options[2 * countof (option_data) + 1];
321 static char short_options[128];
323 /* Mapping between short option chars and option_data indices. */
324 static unsigned char optmap[96];
326 /* Marker for `--no-FOO' values in long_options. */
327 #define BOOLEAN_NEG_MARKER 1024
329 /* Initialize the long_options array used by getopt_long from the data
335 char *p = short_options;
337 for (i = 0; i < countof (option_data); i++)
339 struct cmdline_option *opt = &option_data[i];
340 struct option *longopt;
343 /* The option is disabled. */
346 longopt = &long_options[o++];
347 longopt->name = opt->long_name;
351 *p++ = opt->short_name;
352 optmap[opt->short_name - 32] = longopt - long_options;
357 longopt->has_arg = required_argument;
362 /* Specify an optional argument for long options, so that
363 --option=off works the same as --no-option, for
364 compatibility with pre-1.10 Wget. However, don't specify
365 optional arguments short-option booleans because they
366 prevent combining of short options. */
367 longopt->has_arg = optional_argument;
368 /* For Boolean options, add the "--no-FOO" variant, which is
369 identical to "--foo", except it has opposite meaning and
370 it doesn't allow an argument. */
371 longopt = &long_options[o++];
372 longopt->name = no_prefix (opt->long_name);
373 longopt->has_arg = no_argument;
374 /* Mask the value so we'll be able to recognize that we're
375 dealing with the false value. */
376 longopt->val = i | BOOLEAN_NEG_MARKER;
379 assert (opt->argtype != -1);
380 longopt->has_arg = opt->argtype;
383 if (longopt->has_arg == required_argument)
385 /* Don't handle optional_argument */
389 /* Terminate short_options. */
391 /* No need for xzero(long_options[o]) because its storage is static
392 and it will be zeroed by default. */
393 assert (o <= countof (long_options));
396 /* Print the usage message. */
398 print_usage (int error)
400 return fprintf (error ? stderr : stdout,
401 _("Usage: %s [OPTION]... [URL]...\n"), exec_name);
404 /* Print the help message, describing all the available options. If
405 you add an option, be sure to update this list. */
409 /* We split the help text this way to ease translation of individual
411 static const char *help[] = {
414 Mandatory arguments to long options are mandatory for short options too.\n\n"),
418 -V, --version display the version of Wget and exit.\n"),
420 -h, --help print this help.\n"),
422 -b, --background go to background after startup.\n"),
424 -e, --execute=COMMAND execute a `.wgetrc'-style command.\n"),
428 Logging and input file:\n"),
430 -o, --output-file=FILE log messages to FILE.\n"),
432 -a, --append-output=FILE append messages to FILE.\n"),
435 -d, --debug print lots of debugging information.\n"),
439 --wdebug print Watt-32 debug output.\n"),
442 -q, --quiet quiet (no output).\n"),
444 -v, --verbose be verbose (this is the default).\n"),
446 -nv, --no-verbose turn off verboseness, without being quiet.\n"),
448 -i, --input-file=FILE download URLs found in local or external FILE.\n"),
450 -F, --force-html treat input file as HTML.\n"),
452 -B, --base=URL resolves HTML input-file links (-i -F)\n\
453 relative to URL.\n"),
455 --config=FILE Specify config file to use.\n"),
461 -t, --tries=NUMBER set number of retries to NUMBER (0 unlimits).\n"),
463 --retry-connrefused retry even if connection is refused.\n"),
465 -O, --output-document=FILE write documents to FILE.\n"),
467 -nc, --no-clobber skip downloads that would download to\n\
468 existing files (overwriting them).\n"),
470 -c, --continue resume getting a partially-downloaded file.\n"),
472 --progress=TYPE select progress gauge type.\n"),
474 -N, --timestamping don't re-retrieve files unless newer than\n\
477 --no-use-server-timestamps don't set the local file's timestamp by\n\
478 the one on the server.\n"),
480 -S, --server-response print server response.\n"),
482 --spider don't download anything.\n"),
484 -T, --timeout=SECONDS set all timeout values to SECONDS.\n"),
486 --dns-timeout=SECS set the DNS lookup timeout to SECS.\n"),
488 --connect-timeout=SECS set the connect timeout to SECS.\n"),
490 --read-timeout=SECS set the read timeout to SECS.\n"),
492 -w, --wait=SECONDS wait SECONDS between retrievals.\n"),
494 --waitretry=SECONDS wait 1..SECONDS between retries of a retrieval.\n"),
496 --random-wait wait from 0.5*WAIT...1.5*WAIT secs between retrievals.\n"),
498 --no-proxy explicitly turn off proxy.\n"),
500 -Q, --quota=NUMBER set retrieval quota to NUMBER.\n"),
502 --bind-address=ADDRESS bind to ADDRESS (hostname or IP) on local host.\n"),
504 --limit-rate=RATE limit download rate to RATE.\n"),
506 --no-dns-cache disable caching DNS lookups.\n"),
508 --restrict-file-names=OS restrict chars in file names to ones OS allows.\n"),
510 --ignore-case ignore case when matching files/directories.\n"),
513 -4, --inet4-only connect only to IPv4 addresses.\n"),
515 -6, --inet6-only connect only to IPv6 addresses.\n"),
517 --prefer-family=FAMILY connect first to addresses of specified family,\n\
518 one of IPv6, IPv4, or none.\n"),
521 --user=USER set both ftp and http user to USER.\n"),
523 --password=PASS set both ftp and http password to PASS.\n"),
525 --ask-password prompt for passwords.\n"),
527 --no-iri turn off IRI support.\n"),
529 --local-encoding=ENC use ENC as the local encoding for IRIs.\n"),
531 --remote-encoding=ENC use ENC as the default remote encoding.\n"),
533 --unlink remove file before clobber.\n"),
539 -nd, --no-directories don't create directories.\n"),
541 -x, --force-directories force creation of directories.\n"),
543 -nH, --no-host-directories don't create host directories.\n"),
545 --protocol-directories use protocol name in directories.\n"),
547 -P, --directory-prefix=PREFIX save files to PREFIX/...\n"),
549 --cut-dirs=NUMBER ignore NUMBER remote directory components.\n"),
555 --http-user=USER set http user to USER.\n"),
557 --http-password=PASS set http password to PASS.\n"),
559 --no-cache disallow server-cached data.\n"),
561 --default-page=NAME Change the default page name (normally\n\
562 this is `index.html'.).\n"),
564 -E, --adjust-extension save HTML/CSS documents with proper extensions.\n"),
566 --ignore-length ignore `Content-Length' header field.\n"),
568 --header=STRING insert STRING among the headers.\n"),
570 --max-redirect maximum redirections allowed per page.\n"),
572 --proxy-user=USER set USER as proxy username.\n"),
574 --proxy-password=PASS set PASS as proxy password.\n"),
576 --referer=URL include `Referer: URL' header in HTTP request.\n"),
578 --save-headers save the HTTP headers to file.\n"),
580 -U, --user-agent=AGENT identify as AGENT instead of Wget/VERSION.\n"),
582 --no-http-keep-alive disable HTTP keep-alive (persistent connections).\n"),
584 --no-cookies don't use cookies.\n"),
586 --load-cookies=FILE load cookies from FILE before session.\n"),
588 --save-cookies=FILE save cookies to FILE after session.\n"),
590 --keep-session-cookies load and save session (non-permanent) cookies.\n"),
592 --post-data=STRING use the POST method; send STRING as the data.\n"),
594 --post-file=FILE use the POST method; send contents of FILE.\n"),
596 --content-disposition honor the Content-Disposition header when\n\
597 choosing local file names (EXPERIMENTAL).\n"),
599 --content-on-error output the received content on server errors.\n"),
601 --auth-no-challenge send Basic HTTP authentication information\n\
602 without first waiting for the server's\n\
608 HTTPS (SSL/TLS) options:\n"),
610 --secure-protocol=PR choose secure protocol, one of auto, SSLv2,\n\
611 SSLv3, and TLSv1.\n"),
613 --no-check-certificate don't validate the server's certificate.\n"),
615 --certificate=FILE client certificate file.\n"),
617 --certificate-type=TYPE client certificate type, PEM or DER.\n"),
619 --private-key=FILE private key file.\n"),
621 --private-key-type=TYPE private key type, PEM or DER.\n"),
623 --ca-certificate=FILE file with the bundle of CA's.\n"),
625 --ca-directory=DIR directory where hash list of CA's is stored.\n"),
627 --random-file=FILE file with random data for seeding the SSL PRNG.\n"),
629 --egd-file=FILE file naming the EGD socket with random data.\n"),
631 #endif /* HAVE_SSL */
637 --ftp-stmlf Use Stream_LF format for all binary FTP files.\n"),
638 #endif /* def __VMS */
640 --ftp-user=USER set ftp user to USER.\n"),
642 --ftp-password=PASS set ftp password to PASS.\n"),
644 --no-remove-listing don't remove `.listing' files.\n"),
646 --no-glob turn off FTP file name globbing.\n"),
648 --no-passive-ftp disable the \"passive\" transfer mode.\n"),
650 --retr-symlinks when recursing, get linked-to files (not dir).\n"),
654 Recursive download:\n"),
656 -r, --recursive specify recursive download.\n"),
658 -l, --level=NUMBER maximum recursion depth (inf or 0 for infinite).\n"),
660 --delete-after delete files locally after downloading them.\n"),
662 -k, --convert-links make links in downloaded HTML or CSS point to\n\
666 -K, --backup-converted before converting file X, back up as X_orig.\n"),
667 #else /* def __VMS */
669 -K, --backup-converted before converting file X, back up as X.orig.\n"),
670 #endif /* def __VMS [else] */
672 -m, --mirror shortcut for -N -r -l inf --no-remove-listing.\n"),
674 -p, --page-requisites get all images, etc. needed to display HTML page.\n"),
676 --strict-comments turn on strict (SGML) handling of HTML comments.\n"),
680 Recursive accept/reject:\n"),
682 -A, --accept=LIST comma-separated list of accepted extensions.\n"),
684 -R, --reject=LIST comma-separated list of rejected extensions.\n"),
686 -D, --domains=LIST comma-separated list of accepted domains.\n"),
688 --exclude-domains=LIST comma-separated list of rejected domains.\n"),
690 --follow-ftp follow FTP links from HTML documents.\n"),
692 --follow-tags=LIST comma-separated list of followed HTML tags.\n"),
694 --ignore-tags=LIST comma-separated list of ignored HTML tags.\n"),
696 -H, --span-hosts go to foreign hosts when recursive.\n"),
698 -L, --relative follow relative links only.\n"),
700 -I, --include-directories=LIST list of allowed directories.\n"),
702 --trust-server-names use the name specified by the redirection\n\
703 url last component.\n"),
705 -X, --exclude-directories=LIST list of excluded directories.\n"),
707 -np, --no-parent don't ascend to the parent directory.\n"),
710 N_("Mail bug reports and suggestions to <bug-wget@gnu.org>.\n")
715 if (printf (_("GNU Wget %s, a non-interactive network retriever.\n"),
718 if (print_usage (0) < 0)
721 for (i = 0; i < countof (help); i++)
722 if (fputs (_(help[i]), stdout) < 0)
728 /* Return a human-readable printed representation of INTERVAL,
729 measured in seconds. */
732 secs_to_human_time (double interval)
735 int secs = (int) (interval + 0.5);
736 int hours, mins, days;
738 days = secs / 86400, secs %= 86400;
739 hours = secs / 3600, secs %= 3600;
740 mins = secs / 60, secs %= 60;
743 sprintf (buf, "%dd %dh %dm %ds", days, hours, mins, secs);
745 sprintf (buf, "%dh %dm %ds", hours, mins, secs);
747 sprintf (buf, "%dm %ds", mins, secs);
749 sprintf (buf, "%ss", print_decimal (interval));
755 prompt_for_password (void)
758 fprintf (stderr, _("Password for user %s: "), quote (opt.user));
760 fprintf (stderr, _("Password: "));
764 /* Function that prints the line argument while limiting it
765 to at most line_length. prefix is printed on the first line
766 and an appropriate number of spaces are added on subsequent
769 format_and_print_line (const char *prefix, const char *line,
773 char *line_dup, *token;
775 assert (prefix != NULL);
776 assert (line != NULL);
778 line_dup = xstrdup (line);
780 if (line_length <= 0)
781 line_length = MAX_CHARS_PER_LINE - TABULATION;
783 if (printf ("%s", prefix) < 0)
785 remaining_chars = line_length;
786 /* We break on spaces. */
787 token = strtok (line_dup, " ");
788 while (token != NULL)
790 /* If however a token is much larger than the maximum
791 line length, all bets are off and we simply print the
792 token on the next line. */
793 if (remaining_chars <= strlen (token))
795 if (printf ("\n%*c", TABULATION, ' ') < 0)
797 remaining_chars = line_length - TABULATION;
799 if (printf ("%s ", token) < 0)
801 remaining_chars -= strlen (token) + 1; /* account for " " */
802 token = strtok (NULL, " ");
805 if (printf ("\n") < 0)
815 const char *wgetrc_title = _("Wgetrc: ");
816 const char *locale_title = _("Locale: ");
817 const char *compile_title = _("Compile: ");
818 const char *link_title = _("Link: ");
819 char *env_wgetrc, *user_wgetrc;
822 if (printf (_("GNU Wget %s built on %s.\n\n"), version_string, OS_TYPE) < 0)
825 for (i = 0; compiled_features[i] != NULL; )
827 int line_length = MAX_CHARS_PER_LINE;
828 while ((line_length > 0) && (compiled_features[i] != NULL))
830 if (printf ("%s ", compiled_features[i]) < 0)
832 line_length -= strlen (compiled_features[i]) + 2;
835 if (printf ("\n") < 0)
838 if (printf ("\n") < 0)
841 /* Handle the case when $WGETRC is unset and $HOME/.wgetrc is
843 if (printf ("%s\n", wgetrc_title) < 0)
846 env_wgetrc = wgetrc_env_file_name ();
847 if (env_wgetrc && *env_wgetrc)
849 if (printf (_(" %s (env)\n"), env_wgetrc) < 0)
853 user_wgetrc = wgetrc_user_file_name ();
856 if (printf (_(" %s (user)\n"), user_wgetrc) < 0)
861 if (printf (_(" %s (system)\n"), SYSTEM_WGETRC) < 0)
866 if (format_and_print_line (locale_title,
868 MAX_CHARS_PER_LINE) < 0)
870 #endif /* def ENABLE_NLS */
872 if (compilation_string != NULL)
873 if (format_and_print_line (compile_title,
875 MAX_CHARS_PER_LINE) < 0)
878 if (link_string != NULL)
879 if (format_and_print_line (link_title,
881 MAX_CHARS_PER_LINE) < 0)
884 if (printf ("\n") < 0)
887 /* TRANSLATORS: When available, an actual copyright character
888 (circle-c) should be used in preference to "(C)". */
890 Copyright (C) 2011 Free Software Foundation, Inc.\n"), stdout) < 0)
893 License GPLv3+: GNU GPL version 3 or later\n\
894 <http://www.gnu.org/licenses/gpl.html>.\n\
895 This is free software: you are free to change and redistribute it.\n\
896 There is NO WARRANTY, to the extent permitted by law.\n"), stdout) < 0)
898 /* TRANSLATORS: When available, please use the proper diacritics for
899 names such as this one. See en_US.po for reference. */
900 if (fputs (_("\nOriginally written by Hrvoje Niksic <hniksic@xemacs.org>.\n"),
903 if (fputs (_("Please send bug reports and questions to <bug-wget@gnu.org>.\n"),
910 char *program_name; /* Needed by lib/error.c. */
913 main (int argc, char **argv)
916 int i, ret, longindex;
918 bool append_to_log = false;
920 total_downloaded_bytes = 0;
922 program_name = argv[0];
924 struct ptimer *timer = ptimer_new ();
925 double start_time = ptimer_measure (timer);
929 /* Construct the name of the executable, without the directory part. */
931 /* On VMS, lose the "dev:[dir]" prefix and the ".EXE;nnn" suffix. */
932 exec_name = vms_basename (argv[0]);
933 #else /* def __VMS */
934 exec_name = strrchr (argv[0], PATH_SEPARATOR);
939 #endif /* def __VMS [else] */
942 /* Drop extension (typically .EXE) from executable filename. */
943 windows_main ((char **) &exec_name);
946 /* Load the hard-coded defaults. */
951 /* This seperate getopt_long is needed to find the user config
952 and parse it before the other user options. */
955 bool use_userconfig = false;
957 while ((retconf = getopt_long (argc, argv,
958 short_options, long_options, &longindex)) != -1)
961 bool userrc_ret = true;
962 struct cmdline_option *config_opt;
963 confval = long_options[longindex].val;
964 config_opt = &option_data[confval & ~BOOLEAN_NEG_MARKER];
965 if (strcmp (config_opt->long_name, "config") == 0)
967 userrc_ret &= run_wgetrc (optarg);
968 use_userconfig = true;
972 printf ("Exiting due to error in %s\n", optarg);
979 /* If the user did not specify a config, read the system wgetrc and ~/.wgetrc. */
980 if (use_userconfig == false)
987 while ((ret = getopt_long (argc, argv,
988 short_options, long_options, &longindex)) != -1)
991 struct cmdline_option *opt;
993 /* If LONGINDEX is unchanged, it means RET is referring a short
1001 printf (_("Try `%s --help' for more options.\n"), exec_name);
1004 /* Find the short option character in the mapping. */
1005 longindex = optmap[ret - 32];
1007 val = long_options[longindex].val;
1009 /* Use the retrieved value to locate the option in the
1010 option_data array, and to see if we're dealing with the
1011 negated "--no-FOO" variant of the boolean option "--foo". */
1012 opt = &option_data[val & ~BOOLEAN_NEG_MARKER];
1016 setoptval (opt->data, optarg, opt->long_name);
1020 /* The user has specified a value -- use it. */
1021 setoptval (opt->data, optarg, opt->long_name);
1024 /* NEG is true for `--no-FOO' style boolean options. */
1025 bool neg = !!(val & BOOLEAN_NEG_MARKER);
1026 setoptval (opt->data, neg ? "0" : "1", opt->long_name);
1031 void (*func) (void) = (void (*) (void)) opt->data;
1035 case OPT__APPEND_OUTPUT:
1036 setoptval ("logfile", optarg, opt->long_name);
1037 append_to_log = true;
1040 run_command (optarg);
1044 /* We support real --no-FOO flags now, but keep these
1045 short options for convenience and backward
1048 for (p = optarg; p && *p; p++)
1052 setoptval ("verbose", "0", opt->long_name);
1055 setoptval ("addhostdir", "0", opt->long_name);
1058 setoptval ("dirstruct", "0", opt->long_name);
1061 setoptval ("noclobber", "1", opt->long_name);
1064 setoptval ("noparent", "1", opt->long_name);
1067 fprintf (stderr, _("%s: illegal option -- `-n%c'\n"),
1070 fprintf (stderr, "\n");
1071 fprintf (stderr, _("Try `%s --help' for more options.\n"),
1080 /* The wgetrc commands are named noparent and noclobber,
1081 so we must revert the meaning of the cmdline options
1082 before passing the value to setoptval. */
1085 flag = (*optarg == '1' || c_tolower (*optarg) == 'y'
1086 || (c_tolower (optarg[0]) == 'o'
1087 && c_tolower (optarg[1]) == 'n'));
1088 setoptval (opt->type == OPT__PARENT ? "noparent" : "noclobber",
1089 flag ? "0" : "1", opt->long_name);
1092 case OPT__DONT_REMOVE_LISTING:
1093 setoptval ("removelisting", "0", opt->long_name);
1100 nurl = argc - optind;
1102 /* All user options have now been processed, so it's now safe to do
1103 interoption dependency checks. */
1105 if (opt.noclobber && opt.convert_links)
1108 _("Both --no-clobber and --convert-links were specified,"
1109 "only --convert-links will be used.\n"));
1110 opt.noclobber = false;
1113 if (opt.reclevel == 0)
1114 opt.reclevel = INFINITE_RECURSION; /* see recur.h for commentary */
1116 if (opt.spider || opt.delete_after)
1117 opt.no_dirstruct = true;
1119 if (opt.page_requisites && !opt.recursive)
1121 /* Don't set opt.recursive here because it would confuse the FTP
1122 code. Instead, call retrieve_tree below when either
1123 page_requisites or recursive is requested. */
1125 if (!opt.no_dirstruct)
1126 opt.dirstruct = 1; /* normally handled by cmd_spec_recursive() */
1129 if (opt.verbose == -1)
1130 opt.verbose = !opt.quiet;
1132 /* Sanity checks. */
1133 if (opt.verbose && opt.quiet)
1135 fprintf (stderr, _("Can't be verbose and quiet at the same time.\n"));
1139 if (opt.timestamping && opt.noclobber)
1141 fprintf (stderr, _("\
1142 Can't timestamp and not clobber old files at the same time.\n"));
1147 if (opt.ipv4_only && opt.ipv6_only)
1150 _("Cannot specify both --inet4-only and --inet6-only.\n"));
1155 if (opt.output_document)
1157 if (opt.convert_links
1158 && (nurl > 1 || opt.page_requisites || opt.recursive))
1161 Cannot specify both -k and -O if multiple URLs are given, or in combination\n\
1162 with -p or -r. See the manual for details.\n\n"), stderr);
1166 if (opt.page_requisites
1169 logprintf (LOG_NOTQUIET, "%s", _("\
1170 WARNING: combining -O with -r or -p will mean that all downloaded content\n\
1171 will be placed in the single file you specified.\n\n"));
1173 if (opt.timestamping)
1175 logprintf (LOG_NOTQUIET, "%s", _("\
1176 WARNING: timestamping does nothing in combination with -O. See the manual\n\
1177 for details.\n\n"));
1178 opt.timestamping = false;
1180 if (opt.noclobber && file_exists_p(opt.output_document))
1182 /* Check if output file exists; if it does, exit. */
1183 logprintf (LOG_VERBOSE,
1184 _("File `%s' already there; not retrieving.\n"),
1185 opt.output_document);
1190 if (opt.ask_passwd && opt.passwd)
1193 _("Cannot specify both --ask-password and --password.\n"));
1198 if (!nurl && !opt.input_filename)
1200 /* No URL specified. */
1201 fprintf (stderr, _("%s: missing URL\n"), exec_name);
1204 /* #### Something nicer should be printed here -- similar to the
1205 pre-1.5 `--help' page. */
1206 fprintf (stderr, _("Try `%s --help' for more options.\n"), exec_name);
1213 if (opt.locale && !check_encoding_name (opt.locale))
1217 opt.locale = find_locale ();
1219 if (opt.encoding_remote && !check_encoding_name (opt.encoding_remote))
1220 opt.encoding_remote = NULL;
1223 memset (&dummy_iri, 0, sizeof (dummy_iri));
1224 if (opt.enable_iri || opt.locale || opt.encoding_remote)
1226 /* sXXXav : be more specific... */
1227 fprintf (stderr, _("This version does not have support for IRIs\n"));
1234 opt.passwd = prompt_for_password ();
1236 if (opt.passwd == NULL || opt.passwd[0] == '\0')
1246 fork_to_background ();
1249 /* Initialize progress. Have to do this after the options are
1250 processed so we know where the log file is. */
1252 set_progress_implementation (opt.progress_type);
1254 /* Fill in the arguments. */
1255 url = alloca_array (char *, nurl + 1);
1256 for (i = 0; i < nurl; i++, optind++)
1258 char *rewritten = rewrite_shorthand_url (argv[optind]);
1262 url[i] = xstrdup (argv[optind]);
1266 /* Initialize logging. */
1267 log_init (opt.lfilename, append_to_log);
1269 DEBUGP (("DEBUG output created by Wget %s on %s.\n\n",
1270 version_string, OS_TYPE));
1272 /* Open the output filename if necessary. */
1275 Note that having the output_stream ("-O") file opened here for an FTP
1276 URL rather than in getftp() (ftp.c) (and the http equivalent) rather
1277 limits the ability in VMS to open the file differently for ASCII
1278 versus binary FTP there. (Of course, doing it here allows a open
1279 failure to be detected immediately, without first connecting to the
1282 if (opt.output_document)
1284 if (HYPHENP (opt.output_document))
1287 _setmode (_fileno (stdout), _O_BINARY);
1289 output_stream = stdout;
1296 /* Common fopen() optional arguments:
1297 sequential access only, access callback function.
1299 # define FOPEN_OPT_ARGS , "fop=sqo", "acc", acc_cb, &open_id
1301 #else /* def __VMS */
1302 # define FOPEN_OPT_ARGS
1303 #endif /* def __VMS [else] */
1305 output_stream = fopen (opt.output_document,
1306 opt.always_rest ? "ab" : "wb"
1308 if (output_stream == NULL)
1310 perror (opt.output_document);
1313 if (fstat (fileno (output_stream), &st) == 0 && S_ISREG (st.st_mode))
1314 output_stream_regular = true;
1316 if (!output_stream_regular && opt.convert_links)
1318 fprintf (stderr, _("-k can be used together with -O only if \
1319 outputting to a regular file.\n"));
1326 /* Set global ODS5 flag according to the specified destination (if
1327 any), otherwise according to the current default device.
1329 if (output_stream == NULL)
1330 set_ods5_dest( "SYS$DISK");
1331 else if (output_stream != stdout)
1332 set_ods5_dest( opt.output_document);
1333 #endif /* def __VMS */
1340 /* Setup the signal handler to redirect output when hangup is
1342 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
1343 signal(SIGHUP, redirect_output_signal);
1345 /* ...and do the same for SIGUSR1. */
1347 signal (SIGUSR1, redirect_output_signal);
1350 /* Writing to a closed socket normally signals SIGPIPE, and the
1351 process exits. What we want is to ignore SIGPIPE and just check
1352 for the return value of write(). */
1353 signal (SIGPIPE, SIG_IGN);
1356 signal (SIGWINCH, progress_handle_sigwinch);
1359 /* Retrieve the URLs from argument list. */
1360 for (t = url; *t; t++)
1362 char *filename = NULL, *redirected_URL = NULL;
1364 /* Need to do a new struct iri every time, because
1365 * retrieve_url may modify it in some circumstances,
1367 struct iri *iri = iri_new ();
1368 struct url *url_parsed;
1370 set_uri_encoding (iri, opt.locale, true);
1371 url_parsed = url_parse (*t, &url_err, iri, true);
1375 char *error = url_error (*t, url_err);
1376 logprintf (LOG_NOTQUIET, "%s: %s.\n",*t, error);
1378 inform_exit_status (URLERROR);
1382 if ((opt.recursive || opt.page_requisites)
1383 && (url_scheme (*t) != SCHEME_FTP || url_uses_proxy (url_parsed)))
1385 int old_follow_ftp = opt.follow_ftp;
1387 /* Turn opt.follow_ftp on in case of recursive FTP retrieval */
1388 if (url_scheme (*t) == SCHEME_FTP)
1391 retrieve_tree (url_parsed, NULL);
1393 opt.follow_ftp = old_follow_ftp;
1397 retrieve_url (url_parsed, *t, &filename, &redirected_URL, NULL,
1398 &dt, opt.recursive, iri, true);
1401 if (opt.delete_after && file_exists_p(filename))
1403 DEBUGP (("Removing file due to --delete-after in main():\n"));
1404 logprintf (LOG_VERBOSE, _("Removing %s.\n"), filename);
1405 if (unlink (filename))
1406 logprintf (LOG_NOTQUIET, "unlink: %s\n", strerror (errno));
1408 xfree_null (redirected_URL);
1409 xfree_null (filename);
1410 url_free (url_parsed);
1415 /* And then from the input file, if any. */
1416 if (opt.input_filename)
1420 status = retrieve_from_file (opt.input_filename, opt.force_html, &count);
1421 inform_exit_status (status);
1423 logprintf (LOG_NOTQUIET, _("No URLs found in %s.\n"),
1424 opt.input_filename);
1427 /* Print broken links. */
1428 if (opt.recursive && opt.spider)
1429 print_broken_links ();
1431 /* Print the downloaded sum. */
1432 if ((opt.recursive || opt.page_requisites
1434 || (opt.input_filename && total_downloaded_bytes != 0))
1436 total_downloaded_bytes != 0)
1438 double end_time = ptimer_measure (timer);
1439 ptimer_destroy (timer);
1441 char *wall_time = xstrdup (secs_to_human_time (end_time - start_time));
1442 char *download_time = xstrdup (secs_to_human_time (total_download_time));
1443 logprintf (LOG_NOTQUIET,
1444 _("FINISHED --%s--\nTotal wall clock time: %s\n"
1445 "Downloaded: %d files, %s in %s (%s)\n"),
1446 datetime_str (time (NULL)),
1449 human_readable (total_downloaded_bytes),
1451 retr_rate (total_downloaded_bytes, total_download_time));
1453 xfree (download_time);
1455 /* Print quota warning, if exceeded. */
1456 if (opt.quota && total_downloaded_bytes > opt.quota)
1457 logprintf (LOG_NOTQUIET,
1458 _("Download quota of %s EXCEEDED!\n"),
1459 human_readable (opt.quota));
1462 if (opt.cookies_output)
1465 if (opt.convert_links && !opt.delete_after)
1466 convert_all_links ();
1469 for (i = 0; i < nurl; i++)
1473 return get_exit_status ();
1475 #endif /* TESTING */
1477 #if defined(SIGHUP) || defined(SIGUSR1)
1479 /* So the signal_name check doesn't blow when only one is available. */
1487 /* Hangup signal handler. When wget receives SIGHUP or SIGUSR1, it
1488 will proceed operation as usual, trying to write into a log file.
1489 If that is impossible, the output will be turned off. */
1492 redirect_output_signal (int sig)
1494 const char *signal_name = (sig == SIGHUP ? "SIGHUP" :
1495 (sig == SIGUSR1 ? "SIGUSR1" :
1497 log_request_redirect_output (signal_name);
1498 progress_schedule_redirect ();
1499 signal (sig, redirect_output_signal);