1 /* Command line parsing.
2 Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001
3 Free Software Foundation, Inc.
5 This file is part of GNU Wget.
7 GNU Wget is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GNU Wget is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with Wget; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
27 #endif /* HAVE_UNISTD_H */
28 #include <sys/types.h>
33 #endif /* HAVE_STRING_H */
40 #endif /* HAVE_LOCALE_H */
44 #define OPTIONS_DEFINED_HERE /* for options.h */
54 #include "progress.h" /* for progress_handle_sigwinch */
57 # include "gen_sslfunc.h"
60 /* On GNU system this will include system-wide getopt.h. */
63 #ifndef PATH_SEPARATOR
64 # define PATH_SEPARATOR '/'
67 extern char *version_string;
76 void log_init PARAMS ((const char *, int));
77 void log_close PARAMS ((void));
78 void log_request_redirect_output PARAMS ((const char *));
80 static RETSIGTYPE redirect_output_signal PARAMS ((int));
82 const char *exec_name;
84 /* Initialize I18N. The initialization amounts to invoking
85 setlocale(), bindtextdomain() and textdomain().
86 Does nothing if NLS is disabled or missing. */
88 i18n_initialize (void)
90 /* If HAVE_NLS is defined, assume the existence of the three
91 functions invoked here. */
93 /* Set the current locale. */
94 /* Here we use LC_MESSAGES instead of LC_ALL, for two reasons.
95 First, message catalogs are all of I18N Wget uses anyway.
96 Second, setting LC_ALL has a dangerous potential of messing
97 things up. For example, when in a foreign locale, Solaris
98 strptime() fails to handle international dates correctly, which
99 makes http_atotm() malfunction. */
101 setlocale (LC_MESSAGES, "");
102 setlocale (LC_CTYPE, "");
104 setlocale (LC_ALL, "");
106 /* Set the text message domain. */
107 bindtextdomain ("wget", LOCALEDIR);
109 #endif /* HAVE_NLS */
112 /* Print the usage message. */
116 printf (_("Usage: %s [OPTION]... [URL]...\n"), exec_name);
119 /* Print the help message, describing all the available options. If
120 you add an option, be sure to update this list. */
124 printf (_("GNU Wget %s, a non-interactive network retriever.\n"),
127 /* Had to split this in parts, so the #@@#%# Ultrix compiler and cpp
128 don't bitch. Also, it makes translation much easier. */
131 Mandatory arguments to long options are mandatory for short options too.\n\
135 -V, --version display the version of Wget and exit.\n\
136 -h, --help print this help.\n\
137 -b, --background go to background after startup.\n\
138 -e, --execute=COMMAND execute a `.wgetrc\'-style command.\n\
141 Logging and input file:\n\
142 -o, --output-file=FILE log messages to FILE.\n\
143 -a, --append-output=FILE append messages to FILE.\n\
144 -d, --debug print debug output.\n\
145 -q, --quiet quiet (no output).\n\
146 -v, --verbose be verbose (this is the default).\n\
147 -nv, --non-verbose turn off verboseness, without being quiet.\n\
148 -i, --input-file=FILE download URLs found in FILE.\n\
149 -F, --force-html treat input file as HTML.\n\
150 -B, --base=URL prepends URL to relative links in -F -i file.\n\
151 --sslcertfile=FILE optional client certificate.\n\
152 --sslcertkey=KEYFILE optional keyfile for this certificate.\n\
153 --egd-file=FILE file name of the EGD socket.\n\
157 --bind-address=ADDRESS bind to ADDRESS (hostname or IP) on local host.\n\
158 -t, --tries=NUMBER set number of retries to NUMBER (0 unlimits).\n\
159 -O --output-document=FILE write documents to FILE.\n\
160 -nc, --no-clobber don\'t clobber existing files or use .# suffixes.\n\
161 -c, --continue resume getting a partially-downloaded file.\n\
162 --progress=TYPE select progress gauge type.\n\
163 -N, --timestamping don\'t re-retrieve files unless newer than local.\n\
164 -S, --server-response print server response.\n\
165 --spider don\'t download anything.\n\
166 -T, --timeout=SECONDS set the read timeout to SECONDS.\n\
167 -w, --wait=SECONDS wait SECONDS between retrievals.\n\
168 --waitretry=SECONDS wait 1...SECONDS between retries of a retrieval.\n\
169 --random-wait wait from 0...2*WAIT secs between retrievals.\n\
170 -Y, --proxy=on/off turn proxy on or off.\n\
171 -Q, --quota=NUMBER set retrieval quota to NUMBER.\n\
172 --limit-rate=RATE limit download rate to RATE.\n\
176 -nd --no-directories don\'t create directories.\n\
177 -x, --force-directories force creation of directories.\n\
178 -nH, --no-host-directories don\'t create host directories.\n\
179 -P, --directory-prefix=PREFIX save files to PREFIX/...\n\
180 --cut-dirs=NUMBER ignore NUMBER remote directory components.\n\
184 --http-user=USER set http user to USER.\n\
185 --http-passwd=PASS set http password to PASS.\n\
186 -C, --cache=on/off (dis)allow server-cached data (normally allowed).\n\
187 -E, --html-extension save all text/html documents with .html extension.\n\
188 --ignore-length ignore `Content-Length\' header field.\n\
189 --header=STRING insert STRING among the headers.\n\
190 --proxy-user=USER set USER as proxy username.\n\
191 --proxy-passwd=PASS set PASS as proxy password.\n\
192 --referer=URL include `Referer: URL\' header in HTTP request.\n\
193 -s, --save-headers save the HTTP headers to file.\n\
194 -U, --user-agent=AGENT identify as AGENT instead of Wget/VERSION.\n\
195 --no-http-keep-alive disable HTTP keep-alive (persistent connections).\n\
196 --cookies=off don't use cookies.\n\
197 --load-cookies=FILE load cookies from FILE before session.\n\
198 --save-cookies=FILE save cookies to FILE after session.\n\
202 -nr, --dont-remove-listing don\'t remove `.listing\' files.\n\
203 -g, --glob=on/off turn file name globbing on or off.\n\
204 --passive-ftp use the \"passive\" transfer mode.\n\
205 --retr-symlinks when recursing, get linked-to files (not dirs).\n\
208 Recursive retrieval:\n\
209 -r, --recursive recursive web-suck -- use with care!\n\
210 -l, --level=NUMBER maximum recursion depth (inf or 0 for infinite).\n\
211 --delete-after delete files locally after downloading them.\n\
212 -k, --convert-links convert non-relative links to relative.\n\
213 -K, --backup-converted before converting file X, back up as X.orig.\n\
214 -m, --mirror shortcut option equivalent to -r -N -l inf -nr.\n\
215 -p, --page-requisites get all images, etc. needed to display HTML page.\n\
218 Recursive accept/reject:\n\
219 -A, --accept=LIST comma-separated list of accepted extensions.\n\
220 -R, --reject=LIST comma-separated list of rejected extensions.\n\
221 -D, --domains=LIST comma-separated list of accepted domains.\n\
222 --exclude-domains=LIST comma-separated list of rejected domains.\n\
223 --follow-ftp follow FTP links from HTML documents.\n\
224 --follow-tags=LIST comma-separated list of followed HTML tags.\n\
225 -G, --ignore-tags=LIST comma-separated list of ignored HTML tags.\n\
226 -H, --span-hosts go to foreign hosts when recursive.\n\
227 -L, --relative follow relative links only.\n\
228 -I, --include-directories=LIST list of allowed directories.\n\
229 -X, --exclude-directories=LIST list of excluded directories.\n\
230 -np, --no-parent don\'t ascend to the parent directory.\n\
232 fputs (_("Mail bug reports and suggestions to <bug-wget@gnu.org>.\n"),
237 main (int argc, char *const *argv)
240 int i, c, nurl, status, append_to_log;
242 static struct option long_options[] =
244 /* Options without arguments: */
245 { "background", no_argument, NULL, 'b' },
246 { "backup-converted", no_argument, NULL, 'K' },
247 { "continue", no_argument, NULL, 'c' },
248 { "convert-links", no_argument, NULL, 'k' },
249 { "debug", no_argument, NULL, 'd' },
250 { "delete-after", no_argument, NULL, 136 },
251 { "dont-remove-listing", no_argument, NULL, 149 },
252 { "follow-ftp", no_argument, NULL, 142 },
253 { "force-directories", no_argument, NULL, 'x' },
254 { "force-hier", no_argument, NULL, 'x' }, /* obsolete */
255 { "force-html", no_argument, NULL, 'F'},
256 { "help", no_argument, NULL, 'h' },
257 { "html-extension", no_argument, NULL, 'E' },
258 { "ignore-length", no_argument, NULL, 138 },
259 { "mirror", no_argument, NULL, 'm' },
260 { "no-clobber", no_argument, NULL, 141 },
261 { "no-directories", no_argument, NULL, 147 },
262 { "no-host-directories", no_argument, NULL, 148 },
263 { "no-host-lookup", no_argument, NULL, 150 },
264 { "no-http-keep-alive", no_argument, NULL, 156 },
265 { "no-parent", no_argument, NULL, 133 },
266 { "non-verbose", no_argument, NULL, 146 },
267 { "passive-ftp", no_argument, NULL, 139 },
268 { "page-requisites", no_argument, NULL, 'p' },
269 { "quiet", no_argument, NULL, 'q' },
270 { "random-wait", no_argument, NULL, 165 },
271 { "recursive", no_argument, NULL, 'r' },
272 { "relative", no_argument, NULL, 'L' },
273 { "retr-symlinks", no_argument, NULL, 137 },
274 { "save-headers", no_argument, NULL, 's' },
275 { "server-response", no_argument, NULL, 'S' },
276 { "span-hosts", no_argument, NULL, 'H' },
277 { "spider", no_argument, NULL, 132 },
278 { "timestamping", no_argument, NULL, 'N' },
279 { "verbose", no_argument, NULL, 'v' },
280 { "version", no_argument, NULL, 'V' },
282 /* Options accepting an argument: */
283 { "accept", required_argument, NULL, 'A' },
284 { "append-output", required_argument, NULL, 'a' },
285 { "backups", required_argument, NULL, 151 }, /* undocumented */
286 { "base", required_argument, NULL, 'B' },
287 { "bind-address", required_argument, NULL, 155 },
288 { "cache", required_argument, NULL, 'C' },
289 { "cookies", required_argument, NULL, 160 },
290 { "cut-dirs", required_argument, NULL, 145 },
291 { "directory-prefix", required_argument, NULL, 'P' },
292 { "domains", required_argument, NULL, 'D' },
293 { "dot-style", required_argument, NULL, 134 },
294 { "execute", required_argument, NULL, 'e' },
295 { "exclude-directories", required_argument, NULL, 'X' },
296 { "exclude-domains", required_argument, NULL, 140 },
297 { "follow-tags", required_argument, NULL, 153 },
298 { "glob", required_argument, NULL, 'g' },
299 { "header", required_argument, NULL, 131 },
300 { "htmlify", required_argument, NULL, 135 },
301 { "http-passwd", required_argument, NULL, 130 },
302 { "http-user", required_argument, NULL, 129 },
303 { "ignore-tags", required_argument, NULL, 'G' },
304 { "include-directories", required_argument, NULL, 'I' },
305 { "input-file", required_argument, NULL, 'i' },
306 { "level", required_argument, NULL, 'l' },
307 { "limit-rate", required_argument, NULL, 164 },
308 { "load-cookies", required_argument, NULL, 161 },
309 { "no", required_argument, NULL, 'n' },
310 { "output-document", required_argument, NULL, 'O' },
311 { "output-file", required_argument, NULL, 'o' },
312 { "progress", required_argument, NULL, 163 },
313 { "proxy", required_argument, NULL, 'Y' },
314 { "proxy-passwd", required_argument, NULL, 144 },
315 { "proxy-user", required_argument, NULL, 143 },
316 { "quota", required_argument, NULL, 'Q' },
317 { "reject", required_argument, NULL, 'R' },
318 { "save-cookies", required_argument, NULL, 162 },
319 { "timeout", required_argument, NULL, 'T' },
320 { "tries", required_argument, NULL, 't' },
321 { "user-agent", required_argument, NULL, 'U' },
322 { "referer", required_argument, NULL, 157 },
323 { "use-proxy", required_argument, NULL, 'Y' },
325 { "sslcertfile", required_argument, NULL, 158 },
326 { "sslcertkey", required_argument, NULL, 159 },
327 { "egd-file", required_argument, NULL, 166 },
328 #endif /* HAVE_SSL */
329 { "wait", required_argument, NULL, 'w' },
330 { "waitretry", required_argument, NULL, 152 },
338 /* Construct the name of the executable, without the directory part. */
339 exec_name = strrchr (argv[0], PATH_SEPARATOR);
346 windows_main_junk (&argc, (char **) argv, (char **) &exec_name);
349 initialize (); /* sets option defaults; reads the system wgetrc and .wgetrc */
351 /* [Is the order of the option letters significant? If not, they should be
352 alphabetized, like the long_options. The only thing I know for sure is
353 that the options with required arguments must be followed by a ':'.
354 -- Dan Harkless <wget@harkless.org>] */
355 while ((c = getopt_long (argc, argv, "\
356 hpVqvdkKsxmNWrHSLcFbEY:G:g:T:U:O:l:n:i:o:a:t:D:A:R:P:B:e:Q:X:I:w:C:",
357 long_options, (int *)0)) != EOF)
361 /* Options without arguments: */
363 setval ("spider", "on");
366 setval ("noparent", "on");
369 setval ("deleteafter", "on");
372 setval ("retrsymlinks", "on");
375 setval ("ignorelength", "on");
378 setval ("passiveftp", "on");
381 setval ("noclobber", "on");
384 setval ("followftp", "on");
387 setval ("cutdirs", optarg);
390 setval ("verbose", "off");
393 setval ("dirstruct", "off");
396 setval ("addhostdir", "off");
399 setval ("removelisting", "off");
402 setval ("bindaddress", optarg);
405 setval ("httpkeepalive", "off");
408 setval ("randomwait", "on");
411 setval ("background", "on");
414 setval ("continue", "on");
418 setval ("debug", "on");
419 #else /* not DEBUG */
420 fprintf (stderr, _("%s: debug support not compiled in.\n"),
422 #endif /* not DEBUG */
425 setval ("htmlextension", "on");
428 setval ("forcehtml", "on");
431 setval ("spanhosts", "on");
441 setval ("backupconverted", "on");
444 setval ("convertlinks", "on");
447 setval ("relativeonly", "on");
450 setval ("mirror", "on");
453 setval ("timestamping", "on");
456 setval ("pagerequisites", "on");
459 setval ("serverresponse", "on");
462 setval ("saveheaders", "on");
465 setval ("quiet", "on");
468 setval ("recursive", "on");
471 printf ("GNU Wget %s\n\n", version_string);
473 Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001 Free Software Foundation, Inc.\n"));
475 This program is distributed in the hope that it will be useful,\n\
476 but WITHOUT ANY WARRANTY; without even the implied warranty of\n\
477 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\
478 GNU General Public License for more details.\n"));
479 printf (_("\nOriginally written by Hrvoje Niksic <hniksic@arsdigita.com>.\n"));
483 setval ("verbose", "on");
486 setval ("dirstruct", "on");
489 /* Options accepting an argument: */
491 setval ("httpuser", optarg);
494 setval ("httppasswd", optarg);
497 setval ("header", optarg);
500 setval ("dotstyle", optarg);
503 setval ("htmlify", optarg);
506 setval ("excludedomains", optarg);
509 setval ("proxyuser", optarg);
512 setval ("proxypasswd", optarg);
515 setval ("backups", optarg);
518 setval ("waitretry", optarg);
521 setval ("followtags", optarg);
524 setval ("cookies", optarg);
527 setval ("loadcookies", optarg);
530 setval ("savecookies", optarg);
533 setval ("progress", optarg);
536 setval ("limitrate", optarg);
539 setval ("referer", optarg);
543 setval ("sslcertfile", optarg);
546 setval ("sslcertkey", optarg);
549 setval ("egdfile", optarg);
551 #endif /* HAVE_SSL */
553 setval ("accept", optarg);
556 setval ("logfile", optarg);
560 setval ("base", optarg);
563 setval ("cache", optarg);
566 setval ("domains", optarg);
571 if (parse_line (optarg, &com, &val))
573 if (!setval (com, val))
578 fprintf (stderr, _("%s: %s: invalid command\n"), exec_name,
587 setval ("ignoretags", optarg);
590 setval ("glob", optarg);
593 setval ("includedirectories", optarg);
596 setval ("input", optarg);
599 setval ("reclevel", optarg);
603 /* #### What we really want here is --no-foo. */
606 for (p = optarg; *p; p++)
610 setval ("verbose", "off");
613 setval ("addhostdir", "off");
616 setval ("dirstruct", "off");
619 setval ("noclobber", "on");
622 setval ("removelisting", "off");
625 setval ("noparent", "on");
628 setval ("httpkeepalive", "off");
631 printf (_("%s: illegal option -- `-n%c'\n"), exec_name, *p);
634 printf (_("Try `%s --help\' for more options.\n"), exec_name);
640 setval ("outputdocument", optarg);
643 setval ("logfile", optarg);
646 setval ("dirprefix", optarg);
649 setval ("quota", optarg);
652 setval ("reject", optarg);
655 setval ("timeout", optarg);
658 setval ("tries", optarg);
661 setval ("useragent", optarg);
664 setval ("wait", optarg);
667 setval ("excludedirectories", optarg);
670 setval ("useproxy", optarg);
676 printf (_("Try `%s --help' for more options.\n"), exec_name);
682 /* All user options have now been processed, so it's now safe to do
683 interoption dependency checks. */
685 if (opt.reclevel == 0)
686 opt.reclevel = INFINITE_RECURSION; /* see wget.h for commentary on this */
688 if (opt.page_requisites && !opt.recursive)
690 opt.recursive = TRUE;
692 if (!opt.no_dirstruct)
693 opt.dirstruct = TRUE; /* usually handled by cmd_spec_recursive() */
696 if (opt.verbose == -1)
697 opt.verbose = !opt.quiet;
700 if (opt.verbose && opt.quiet)
702 printf (_("Can't be verbose and quiet at the same time.\n"));
706 if (opt.timestamping && opt.noclobber)
709 Can't timestamp and not clobber old files at the same time.\n"));
713 nurl = argc - optind;
714 if (!nurl && !opt.input_filename)
716 /* No URL specified. */
717 printf (_("%s: missing URL\n"), exec_name);
720 /* #### Something nicer should be printed here -- similar to the
721 pre-1.5 `--help' page. */
722 printf (_("Try `%s --help' for more options.\n"), exec_name);
727 fork_to_background ();
729 /* Initialize progress. Have to do this after the options are
730 processed so we know where the log file is. */
732 set_progress_implementation (opt.progress_type);
734 /* Allocate basic pointer. */
735 url = ALLOCA_ARRAY (char *, nurl + 1);
736 /* Fill in the arguments. */
737 for (i = 0; i < nurl; i++, optind++)
739 char *rewritten = rewrite_shorthand_url (argv[optind]);
743 url[i] = xstrdup (argv[optind]);
747 /* Change the title of console window on Windows. #### I think this
748 statement should belong to retrieve_url(). --hniksic. */
750 ws_changetitle (*url, nurl);
753 /* Initialize logging. */
754 log_init (opt.lfilename, append_to_log);
756 DEBUGP (("DEBUG output created by Wget %s on %s.\n\n", version_string,
759 /* Open the output filename if necessary. */
760 if (opt.output_document)
762 if (HYPHENP (opt.output_document))
767 opt.dfp = fopen (opt.output_document, opt.always_rest ? "ab" : "wb");
770 perror (opt.output_document);
773 if (fstat (fileno (opt.dfp), &st) == 0 && S_ISREG (st.st_mode))
774 opt.od_known_regular = 1;
782 /* Setup the signal handler to redirect output when hangup is
785 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
786 signal(SIGHUP, redirect_output_signal);
787 /* ...and do the same for SIGUSR1. */
788 signal (SIGUSR1, redirect_output_signal);
789 /* Writing to a closed socket normally signals SIGPIPE, and the
790 process exits. What we want is to ignore SIGPIPE and just check
791 for the return value of write(). */
792 signal (SIGPIPE, SIG_IGN);
794 signal (SIGWINCH, progress_handle_sigwinch);
796 #endif /* HAVE_SIGNAL */
799 /* Must call this before resolving any URLs because it has the power
800 to disable `https'. */
804 status = RETROK; /* initialize it, just-in-case */
805 /* Retrieve the URLs from argument list. */
806 for (t = url; *t; t++)
808 char *filename = NULL, *redirected_URL = NULL;
811 if (opt.recursive && url_scheme (*t) != SCHEME_FTP)
812 status = retrieve_tree (*t);
814 status = retrieve_url (*t, &filename, &redirected_URL, NULL, &dt);
816 if (opt.delete_after && file_exists_p(filename))
818 DEBUGP (("Removing file due to --delete-after in main():\n"));
819 logprintf (LOG_VERBOSE, _("Removing %s.\n"), filename);
820 if (unlink (filename))
821 logprintf (LOG_NOTQUIET, "unlink: %s\n", strerror (errno));
824 FREE_MAYBE (redirected_URL);
825 FREE_MAYBE (filename);
828 /* And then from the input file, if any. */
829 if (opt.input_filename)
832 status = retrieve_from_file (opt.input_filename, opt.force_html, &count);
834 logprintf (LOG_NOTQUIET, _("No URLs found in %s.\n"),
837 /* Print the downloaded sum. */
840 || (opt.input_filename && opt.downloaded != 0))
842 logprintf (LOG_NOTQUIET,
843 _("\nFINISHED --%s--\nDownloaded: %s bytes in %d files\n"),
845 (opt.downloaded_overflow ?
846 "<overflow>" : legible_very_long (opt.downloaded)),
848 /* Print quota warning, if exceeded. */
849 if (downloaded_exceeds_quota ())
850 logprintf (LOG_NOTQUIET,
851 _("Download quota (%s bytes) EXCEEDED!\n"),
852 legible (opt.quota));
855 if (opt.cookies_output)
856 save_cookies (opt.cookies_output);
858 if (opt.convert_links && !opt.delete_after)
860 convert_all_links ();
864 for (i = 0; i < nurl; i++)
869 print_malloc_debug_stats ();
871 if (status == RETROK)
878 /* Hangup signal handler. When wget receives SIGHUP or SIGUSR1, it
879 will proceed operation as usual, trying to write into a log file.
880 If that is impossible, the output will be turned off.
882 #### It is unsafe to do call libc functions from a signal handler.
883 What we should do is, set a global variable, and have the code in
887 redirect_output_signal (int sig)
889 char *signal_name = (sig == SIGHUP ? "SIGHUP" :
890 (sig == SIGUSR1 ? "SIGUSR1" :
892 log_request_redirect_output (signal_name);
893 progress_schedule_redirect ();
894 signal (sig, redirect_output_signal);
896 #endif /* HAVE_SIGNAL */