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 */
56 /* On GNU system this will include system-wide getopt.h. */
59 #ifndef PATH_SEPARATOR
60 # define PATH_SEPARATOR '/'
63 extern char *version_string;
72 void log_init PARAMS ((const char *, int));
73 void log_close PARAMS ((void));
74 void redirect_output PARAMS ((const char *));
76 static RETSIGTYPE redirect_output_signal PARAMS ((int));
78 const char *exec_name;
80 /* Initialize I18N. The initialization amounts to invoking
81 setlocale(), bindtextdomain() and textdomain().
82 Does nothing if NLS is disabled or missing. */
84 i18n_initialize (void)
86 /* If HAVE_NLS is defined, assume the existence of the three
87 functions invoked here. */
89 /* Set the current locale. */
90 /* Here we use LC_MESSAGES instead of LC_ALL, for two reasons.
91 First, message catalogs are all of I18N Wget uses anyway.
92 Second, setting LC_ALL has a dangerous potential of messing
93 things up. For example, when in a foreign locale, Solaris
94 strptime() fails to handle international dates correctly, which
95 makes http_atotm() malfunction. */
97 setlocale (LC_MESSAGES, "");
98 setlocale (LC_CTYPE, "");
100 setlocale (LC_ALL, "");
102 /* Set the text message domain. */
103 bindtextdomain ("wget", LOCALEDIR);
105 #endif /* HAVE_NLS */
108 /* It's kosher to declare these here because their interface _has_ to
109 be void foo(void). */
110 void host_init PARAMS ((void));
112 /* This just calls the various initialization functions from the
113 modules that need one-time initialization. */
115 private_initialize (void)
120 /* Print the usage message. */
124 printf (_("Usage: %s [OPTION]... [URL]...\n"), exec_name);
127 /* Print the help message, describing all the available options. If
128 you add an option, be sure to update this list. */
132 printf (_("GNU Wget %s, a non-interactive network retriever.\n"),
135 /* Had to split this in parts, so the #@@#%# Ultrix compiler and cpp
136 don't bitch. Also, it makes translation much easier. */
139 Mandatory arguments to long options are mandatory for short options too.\n\
143 -V, --version display the version of Wget and exit.\n\
144 -h, --help print this help.\n\
145 -b, --background go to background after startup.\n\
146 -e, --execute=COMMAND execute a `.wgetrc\'-style command.\n\
149 Logging and input file:\n\
150 -o, --output-file=FILE log messages to FILE.\n\
151 -a, --append-output=FILE append messages to FILE.\n\
152 -d, --debug print debug output.\n\
153 -q, --quiet quiet (no output).\n\
154 -v, --verbose be verbose (this is the default).\n\
155 -nv, --non-verbose turn off verboseness, without being quiet.\n\
156 -i, --input-file=FILE download URLs found in FILE.\n\
157 -F, --force-html treat input file as HTML.\n\
158 -B, --base=URL prepends URL to relative links in -F -i file.\n\
159 --sslcertfile=FILE optional client certificate.\n\
160 --sslcertkey=KEYFILE optional keyfile for this certificate.\n\
164 --bind-address=ADDRESS bind to ADDRESS (hostname or IP) on local host.\n\
165 -t, --tries=NUMBER set number of retries to NUMBER (0 unlimits).\n\
166 -O --output-document=FILE write documents to FILE.\n\
167 -nc, --no-clobber don\'t clobber existing files or use .# suffixes.\n\
168 -c, --continue resume getting a partially-downloaded file.\n\
169 --progress=TYPE select progress gauge type.\n\
170 -N, --timestamping don\'t re-retrieve files unless newer than local.\n\
171 -S, --server-response print server response.\n\
172 --spider don\'t download anything.\n\
173 -T, --timeout=SECONDS set the read timeout to SECONDS.\n\
174 -w, --wait=SECONDS wait SECONDS between retrievals.\n\
175 --waitretry=SECONDS wait 1...SECONDS between retries of a retrieval.\n\
176 -Y, --proxy=on/off turn proxy on or off.\n\
177 -Q, --quota=NUMBER set retrieval quota to NUMBER.\n\
181 -nd --no-directories don\'t create directories.\n\
182 -x, --force-directories force creation of directories.\n\
183 -nH, --no-host-directories don\'t create host directories.\n\
184 -P, --directory-prefix=PREFIX save files to PREFIX/...\n\
185 --cut-dirs=NUMBER ignore NUMBER remote directory components.\n\
189 --http-user=USER set http user to USER.\n\
190 --http-passwd=PASS set http password to PASS.\n\
191 -C, --cache=on/off (dis)allow server-cached data (normally allowed).\n\
192 -E, --html-extension save all text/html documents with .html extension.\n\
193 --ignore-length ignore `Content-Length\' header field.\n\
194 --header=STRING insert STRING among the headers.\n\
195 --proxy-user=USER set USER as proxy username.\n\
196 --proxy-passwd=PASS set PASS as proxy password.\n\
197 --referer=URL include `Referer: URL\' header in HTTP request.\n\
198 -s, --save-headers save the HTTP headers to file.\n\
199 -U, --user-agent=AGENT identify as AGENT instead of Wget/VERSION.\n\
200 --no-http-keep-alive disable HTTP keep-alive (persistent connections).\n\
201 --cookies=off don't use cookies.\n\
202 --load-cookies=FILE load cookies from FILE before session.\n\
203 --save-cookies=FILE save cookies to FILE after session.\n\
207 -nr, --dont-remove-listing don\'t remove `.listing\' files.\n\
208 -g, --glob=on/off turn file name globbing on or off.\n\
209 --passive-ftp use the \"passive\" transfer mode.\n\
210 --retr-symlinks when recursing, get linked-to files (not dirs).\n\
213 Recursive retrieval:\n\
214 -r, --recursive recursive web-suck -- use with care!\n\
215 -l, --level=NUMBER maximum recursion depth (inf or 0 for infinite).\n\
216 --delete-after delete files locally after downloading them.\n\
217 -k, --convert-links convert non-relative links to relative.\n\
218 -K, --backup-converted before converting file X, back up as X.orig.\n\
219 -m, --mirror shortcut option equivalent to -r -N -l inf -nr.\n\
220 -p, --page-requisites get all images, etc. needed to display HTML page.\n\
223 Recursive accept/reject:\n\
224 -A, --accept=LIST comma-separated list of accepted extensions.\n\
225 -R, --reject=LIST comma-separated list of rejected extensions.\n\
226 -D, --domains=LIST comma-separated list of accepted domains.\n\
227 --exclude-domains=LIST comma-separated list of rejected domains.\n\
228 --follow-ftp follow FTP links from HTML documents.\n\
229 --follow-tags=LIST comma-separated list of followed HTML tags.\n\
230 -G, --ignore-tags=LIST comma-separated list of ignored HTML tags.\n\
231 -H, --span-hosts go to foreign hosts when recursive.\n\
232 -L, --relative follow relative links only.\n\
233 -I, --include-directories=LIST list of allowed directories.\n\
234 -X, --exclude-directories=LIST list of excluded directories.\n\
235 -nh, --no-host-lookup don\'t DNS-lookup hosts.\n\
236 -np, --no-parent don\'t ascend to the parent directory.\n\
238 fputs (_("Mail bug reports and suggestions to <bug-wget@gnu.org>.\n"),
243 main (int argc, char *const *argv)
246 int i, c, nurl, status, append_to_log;
248 static struct option long_options[] =
250 /* Options without arguments: */
251 { "background", no_argument, NULL, 'b' },
252 { "backup-converted", no_argument, NULL, 'K' },
253 { "continue", no_argument, NULL, 'c' },
254 { "convert-links", no_argument, NULL, 'k' },
255 { "debug", no_argument, NULL, 'd' },
256 { "delete-after", no_argument, NULL, 136 },
257 { "dont-remove-listing", no_argument, NULL, 149 },
258 { "follow-ftp", no_argument, NULL, 142 },
259 { "force-directories", no_argument, NULL, 'x' },
260 { "force-hier", no_argument, NULL, 'x' }, /* obsolete */
261 { "force-html", no_argument, NULL, 'F'},
262 { "help", no_argument, NULL, 'h' },
263 { "html-extension", no_argument, NULL, 'E' },
264 { "ignore-length", no_argument, NULL, 138 },
265 { "mirror", no_argument, NULL, 'm' },
266 { "no-clobber", no_argument, NULL, 141 },
267 { "no-directories", no_argument, NULL, 147 },
268 { "no-host-directories", no_argument, NULL, 148 },
269 { "no-host-lookup", no_argument, NULL, 150 },
270 { "no-http-keep-alive", no_argument, NULL, 156 },
271 { "no-parent", no_argument, NULL, 133 },
272 { "non-verbose", no_argument, NULL, 146 },
273 { "passive-ftp", no_argument, NULL, 139 },
274 { "page-requisites", no_argument, NULL, 'p' },
275 { "quiet", no_argument, NULL, 'q' },
276 { "recursive", no_argument, NULL, 'r' },
277 { "relative", no_argument, NULL, 'L' },
278 { "retr-symlinks", no_argument, NULL, 137 },
279 { "save-headers", no_argument, NULL, 's' },
280 { "server-response", no_argument, NULL, 'S' },
281 { "span-hosts", no_argument, NULL, 'H' },
282 { "spider", no_argument, NULL, 132 },
283 { "timestamping", no_argument, NULL, 'N' },
284 { "verbose", no_argument, NULL, 'v' },
285 { "version", no_argument, NULL, 'V' },
287 /* Options accepting an argument: */
288 { "accept", required_argument, NULL, 'A' },
289 { "append-output", required_argument, NULL, 'a' },
290 { "backups", required_argument, NULL, 151 }, /* undocumented */
291 { "base", required_argument, NULL, 'B' },
292 { "bind-address", required_argument, NULL, 155 },
293 { "cache", required_argument, NULL, 'C' },
294 { "cookies", required_argument, NULL, 160 },
295 { "cut-dirs", required_argument, NULL, 145 },
296 { "directory-prefix", required_argument, NULL, 'P' },
297 { "domains", required_argument, NULL, 'D' },
298 { "dot-style", required_argument, NULL, 134 },
299 { "execute", required_argument, NULL, 'e' },
300 { "exclude-directories", required_argument, NULL, 'X' },
301 { "exclude-domains", required_argument, NULL, 140 },
302 { "follow-tags", required_argument, NULL, 153 },
303 { "glob", required_argument, NULL, 'g' },
304 { "header", required_argument, NULL, 131 },
305 { "htmlify", required_argument, NULL, 135 },
306 { "http-passwd", required_argument, NULL, 130 },
307 { "http-user", required_argument, NULL, 129 },
308 { "ignore-tags", required_argument, NULL, 'G' },
309 { "include-directories", required_argument, NULL, 'I' },
310 { "input-file", required_argument, NULL, 'i' },
311 { "level", required_argument, NULL, 'l' },
312 { "load-cookies", required_argument, NULL, 161 },
313 { "no", required_argument, NULL, 'n' },
314 { "output-document", required_argument, NULL, 'O' },
315 { "output-file", required_argument, NULL, 'o' },
316 { "progress", required_argument, NULL, 163 },
317 { "proxy", required_argument, NULL, 'Y' },
318 { "proxy-passwd", required_argument, NULL, 144 },
319 { "proxy-user", required_argument, NULL, 143 },
320 { "quota", required_argument, NULL, 'Q' },
321 { "reject", required_argument, NULL, 'R' },
322 { "save-cookies", required_argument, NULL, 162 },
323 { "timeout", required_argument, NULL, 'T' },
324 { "tries", required_argument, NULL, 't' },
325 { "user-agent", required_argument, NULL, 'U' },
326 { "referer", required_argument, NULL, 157 },
327 { "use-proxy", required_argument, NULL, 'Y' },
329 { "sslcertfile", required_argument, NULL, 158 },
330 { "sslcertkey", required_argument, NULL, 159 },
331 #endif /* HAVE_SSL */
332 { "wait", required_argument, NULL, 'w' },
333 { "waitretry", required_argument, NULL, 152 },
338 private_initialize ();
342 /* Construct the name of the executable, without the directory part. */
343 exec_name = strrchr (argv[0], PATH_SEPARATOR);
350 windows_main_junk (&argc, (char **) argv, (char **) &exec_name);
353 initialize (); /* sets option defaults; reads the system wgetrc and .wgetrc */
355 /* [Is the order of the option letters significant? If not, they should be
356 alphabetized, like the long_options. The only thing I know for sure is
357 that the options with required arguments must be followed by a ':'.
358 -- Dan Harkless <wget@harkless.org>] */
359 while ((c = getopt_long (argc, argv, "\
360 hpVqvdkKsxmNWrHSLcFbEY:G:g:T:U:O:l:n:i:o:a:t:D:A:R:P:B:e:Q:X:I:w:C:",
361 long_options, (int *)0)) != EOF)
365 /* Options without arguments: */
367 setval ("spider", "on");
370 setval ("noparent", "on");
373 setval ("deleteafter", "on");
376 setval ("retrsymlinks", "on");
379 setval ("ignorelength", "on");
382 setval ("passiveftp", "on");
385 setval ("noclobber", "on");
388 setval ("followftp", "on");
391 setval ("cutdirs", optarg);
394 setval ("verbose", "off");
397 setval ("dirstruct", "off");
400 setval ("addhostdir", "off");
403 setval ("removelisting", "off");
406 setval ("bindaddress", optarg);
409 setval ("httpkeepalive", "off");
412 setval ("background", "on");
415 setval ("continue", "on");
419 setval ("debug", "on");
420 #else /* not DEBUG */
421 fprintf (stderr, _("%s: debug support not compiled in.\n"),
423 #endif /* not DEBUG */
426 setval ("htmlextension", "on");
429 setval ("forcehtml", "on");
432 setval ("spanhosts", "on");
442 setval ("backupconverted", "on");
445 setval ("convertlinks", "on");
448 setval ("relativeonly", "on");
451 setval ("mirror", "on");
454 setval ("timestamping", "on");
457 setval ("pagerequisites", "on");
460 setval ("serverresponse", "on");
463 setval ("saveheaders", "on");
466 setval ("quiet", "on");
469 setval ("recursive", "on");
472 printf ("GNU Wget %s\n\n", version_string);
474 Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001 Free Software Foundation, Inc.\n"));
476 This program is distributed in the hope that it will be useful,\n\
477 but WITHOUT ANY WARRANTY; without even the implied warranty of\n\
478 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\
479 GNU General Public License for more details.\n"));
480 printf (_("\nOriginally written by Hrvoje Niksic <hniksic@arsdigita.com>.\n"));
484 setval ("verbose", "on");
487 setval ("dirstruct", "on");
490 /* Options accepting an argument: */
492 setval ("httpuser", optarg);
495 setval ("httppasswd", optarg);
498 setval ("header", optarg);
501 /* Supported for compatibility; --dot-style=foo equivalent
502 to --progress=dot:foo. */
504 char *tmp = alloca (3 + 1 + strlen (optarg));
505 sprintf (tmp, "dot:%s", optarg);
506 setval ("progress", tmp);
510 setval ("htmlify", optarg);
513 setval ("excludedomains", optarg);
516 setval ("proxyuser", optarg);
519 setval ("proxypasswd", optarg);
522 setval ("backups", optarg);
525 setval ("waitretry", optarg);
528 setval ("followtags", optarg);
531 setval ("cookies", optarg);
534 setval ("loadcookies", optarg);
537 setval ("savecookies", optarg);
540 setval ("progress", optarg);
543 setval ("referer", optarg);
547 setval ("sslcertfile", optarg);
550 setval ("sslcertkey", optarg);
552 #endif /* HAVE_SSL */
554 setval ("accept", optarg);
557 setval ("logfile", optarg);
561 setval ("base", optarg);
564 setval ("cache", optarg);
567 setval ("domains", optarg);
572 if (parse_line (optarg, &com, &val))
574 if (!setval (com, val))
579 fprintf (stderr, _("%s: %s: invalid command\n"), exec_name,
588 setval ("ignoretags", optarg);
591 setval ("glob", optarg);
594 setval ("includedirectories", optarg);
597 setval ("input", optarg);
600 setval ("reclevel", optarg);
604 /* #### What we really want here is --no-foo. */
607 for (p = optarg; *p; p++)
611 setval ("verbose", "off");
614 setval ("addhostdir", "off");
617 setval ("dirstruct", "off");
620 setval ("noclobber", "on");
623 setval ("removelisting", "off");
626 setval ("noparent", "on");
629 setval ("httpkeepalive", "off");
632 printf (_("%s: illegal option -- `-n%c'\n"), exec_name, *p);
635 printf (_("Try `%s --help\' for more options.\n"), exec_name);
641 setval ("outputdocument", optarg);
644 setval ("logfile", optarg);
647 setval ("dirprefix", optarg);
650 setval ("quota", optarg);
653 setval ("reject", optarg);
656 setval ("timeout", optarg);
659 setval ("tries", optarg);
662 setval ("useragent", optarg);
665 setval ("wait", optarg);
668 setval ("excludedirectories", optarg);
671 setval ("useproxy", optarg);
677 printf (_("Try `%s --help' for more options.\n"), exec_name);
683 /* Initialize progress. Have to do this after the options are
684 processed so we know where the log file is. */
686 set_progress_implementation (opt.progress_type);
688 /* All user options have now been processed, so it's now safe to do
689 interoption dependency checks. */
691 if (opt.reclevel == 0)
692 opt.reclevel = INFINITE_RECURSION; /* see wget.h for commentary on this */
694 if (opt.page_requisites && !opt.recursive)
696 opt.recursive = TRUE;
698 if (!opt.no_dirstruct)
699 opt.dirstruct = TRUE; /* usually handled by cmd_spec_recursive() */
702 if (opt.verbose == -1)
703 opt.verbose = !opt.quiet;
706 if (opt.verbose && opt.quiet)
708 printf (_("Can't be verbose and quiet at the same time.\n"));
712 if (opt.timestamping && opt.noclobber)
715 Can't timestamp and not clobber old files at the same time.\n"));
719 nurl = argc - optind;
720 if (!nurl && !opt.input_filename)
722 /* No URL specified. */
723 printf (_("%s: missing URL\n"), exec_name);
726 /* #### Something nicer should be printed here -- similar to the
727 pre-1.5 `--help' page. */
728 printf (_("Try `%s --help' for more options.\n"), exec_name);
733 fork_to_background ();
735 /* Allocate basic pointer. */
736 url = ALLOCA_ARRAY (char *, nurl + 1);
737 /* Fill in the arguments. */
738 for (i = 0; i < nurl; i++, optind++)
740 char *rewritten = rewrite_shorthand_url (argv[optind]);
743 printf ("Converted %s to %s\n", argv[optind], rewritten);
747 url[i] = xstrdup (argv[optind]);
751 /* Change the title of console window on Windows. #### I think this
752 statement should belong to retrieve_url(). --hniksic. */
754 ws_changetitle (*url, nurl);
757 /* Initialize logging. */
758 log_init (opt.lfilename, append_to_log);
760 DEBUGP (("DEBUG output created by Wget %s on %s.\n\n", version_string,
763 /* Open the output filename if necessary. */
764 if (opt.output_document)
766 if (HYPHENP (opt.output_document))
771 opt.dfp = fopen (opt.output_document, opt.always_rest ? "ab" : "wb");
774 perror (opt.output_document);
777 if (fstat (fileno (opt.dfp), &st) == 0 && S_ISREG (st.st_mode))
778 opt.od_known_regular = 1;
786 /* Setup the signal handler to redirect output when hangup is
789 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
790 signal(SIGHUP, redirect_output_signal);
791 /* ...and do the same for SIGUSR1. */
792 signal (SIGUSR1, redirect_output_signal);
793 /* Writing to a closed socket normally signals SIGPIPE, and the
794 process exits. What we want is to ignore SIGPIPE and just check
795 for the return value of write(). */
796 signal (SIGPIPE, SIG_IGN);
798 signal (SIGWINCH, progress_handle_sigwinch);
800 #endif /* HAVE_SIGNAL */
802 status = RETROK; /* initialize it, just-in-case */
803 /*recursive_reset ();*/
804 /* Retrieve the URLs from argument list. */
805 for (t = url; *t; t++)
807 char *filename = NULL, *redirected_URL = NULL;
810 if (opt.recursive && url_scheme (*t) != SCHEME_FTP)
811 status = retrieve_tree (*t);
813 status = retrieve_url (*t, &filename, &redirected_URL, NULL, &dt);
815 if (opt.delete_after && file_exists_p(filename))
817 DEBUGP (("Removing file due to --delete-after in main():\n"));
818 logprintf (LOG_VERBOSE, _("Removing %s.\n"), filename);
819 if (unlink (filename))
820 logprintf (LOG_NOTQUIET, "unlink: %s\n", strerror (errno));
823 FREE_MAYBE (redirected_URL);
824 FREE_MAYBE (filename);
827 /* And then from the input file, if any. */
828 if (opt.input_filename)
831 status = retrieve_from_file (opt.input_filename, opt.force_html, &count);
833 logprintf (LOG_NOTQUIET, _("No URLs found in %s.\n"),
836 /* Print the downloaded sum. */
839 || (opt.input_filename && opt.downloaded != 0))
841 logprintf (LOG_NOTQUIET,
842 _("\nFINISHED --%s--\nDownloaded: %s bytes in %d files\n"),
844 (opt.downloaded_overflow ?
845 "<overflow>" : legible_very_long (opt.downloaded)),
847 /* Print quota warning, if exceeded. */
848 if (downloaded_exceeds_quota ())
849 logprintf (LOG_NOTQUIET,
850 _("Download quota (%s bytes) EXCEEDED!\n"),
851 legible (opt.quota));
854 if (opt.cookies_output)
855 save_cookies (opt.cookies_output);
857 if (opt.convert_links && !opt.delete_after)
859 convert_all_links ();
863 for (i = 0; i < nurl; i++)
868 print_malloc_debug_stats ();
870 if (status == RETROK)
877 /* Hangup signal handler. When wget receives SIGHUP or SIGUSR1, it
878 will proceed operation as usual, trying to write into a log file.
879 If that is impossible, the output will be turned off. */
882 redirect_output_signal (int sig)
885 signal (sig, redirect_output_signal);
886 /* Please note that the double `%' in `%%s' is intentional, because
887 redirect_output passes tmp through printf. */
888 sprintf (tmp, _("%s received, redirecting output to `%%s'.\n"),
889 (sig == SIGHUP ? "SIGHUP" :
890 (sig == SIGUSR1 ? "SIGUSR1" :
892 redirect_output (tmp);
894 #endif /* HAVE_SIGNAL */