1 /* Command line parsing.
2 Copyright (C) 1995, 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
4 This file is part of Wget.
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.
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.
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. */
26 #endif /* HAVE_UNISTD_H */
27 #include <sys/types.h>
32 #endif /* HAVE_STRING_H */
39 #endif /* HAVE_LOCALE_H */
43 #define OPTIONS_DEFINED_HERE /* for options.h */
53 #ifndef PATH_SEPARATOR
54 # define PATH_SEPARATOR '/'
57 extern char *version_string;
66 void log_init PARAMS ((const char *, int));
67 void log_close PARAMS ((void));
68 void redirect_output PARAMS ((const char *));
70 static RETSIGTYPE redirect_output_signal PARAMS ((int));
72 const char *exec_name;
74 /* Initialize I18N. The initialization amounts to invoking
75 setlocale(), bindtextdomain() and textdomain().
76 Does nothing if NLS is disabled or missing. */
78 i18n_initialize (void)
80 /* If HAVE_NLS is defined, assume the existence of the three
81 functions invoked here. */
83 /* Set the current locale. */
84 /* Here we use LC_MESSAGES instead of LC_ALL, for two reasons.
85 First, message catalogs are all of I18N Wget uses anyway.
86 Second, setting LC_ALL has a dangerous potential of messing
87 things up. For example, when in a foreign locale, Solaris
88 strptime() fails to handle international dates correctly, which
89 makes http_atotm() malfunction. */
91 setlocale (LC_MESSAGES, "");
92 setlocale (LC_CTYPE, "");
94 setlocale (LC_ALL, "");
96 /* Set the text message domain. */
97 bindtextdomain ("wget", LOCALEDIR);
102 /* It's kosher to declare these here because their interface _has_ to
103 be void foo(void). */
104 void url_init PARAMS ((void));
105 void host_init PARAMS ((void));
107 /* This just calls the various initialization functions from the
108 modules that need one-time initialization. */
110 private_initialize (void)
116 /* Print the usage message. */
120 printf (_("Usage: %s [OPTION]... [URL]...\n"), exec_name);
123 /* Print the help message, describing all the available options. If
124 you add an option, be sure to update this list. */
128 printf (_("GNU Wget %s, a non-interactive network retriever.\n"),
131 /* Had to split this in parts, so the #@@#%# Ultrix compiler and cpp
132 don't bitch. Also, it makes translation much easier. */
135 Mandatory arguments to long options are mandatory for short options too.\n\
139 -V, --version display the version of Wget and exit.\n\
140 -h, --help print this help.\n\
141 -b, --background go to background after startup.\n\
142 -e, --execute=COMMAND execute a `.wgetrc\'-style command.\n\
145 Logging and input file:\n\
146 -o, --output-file=FILE log messages to FILE.\n\
147 -a, --append-output=FILE append messages to FILE.\n\
148 -d, --debug print debug output.\n\
149 -q, --quiet quiet (no output).\n\
150 -v, --verbose be verbose (this is the default).\n\
151 -nv, --non-verbose turn off verboseness, without being quiet.\n\
152 -i, --input-file=FILE download URLs found in FILE.\n\
153 -F, --force-html treat input file as HTML.\n\
154 -B, --base=URL prepends URL to relative links in -F -i file.\n\
155 --sslcertfile=FILE optional client certificate.\n\
156 --sslcertkey=KEYFILE optional keyfile for this certificate.\n\
160 --bind-address=ADDRESS bind to ADDRESS (hostname or IP) on local host.\n\
161 -t, --tries=NUMBER set number of retries to NUMBER (0 unlimits).\n\
162 -O --output-document=FILE write documents to FILE.\n\
163 -nc, --no-clobber don\'t clobber existing files or use .# suffixes.\n\
164 -c, --continue resume getting a partially-downloaded file.\n\
165 --dot-style=STYLE set retrieval display style.\n\
166 -N, --timestamping don\'t re-retrieve files unless newer than local.\n\
167 -S, --server-response print server response.\n\
168 --spider don\'t download anything.\n\
169 -T, --timeout=SECONDS set the read timeout to SECONDS.\n\
170 -w, --wait=SECONDS wait SECONDS between retrievals.\n\
171 --waitretry=SECONDS wait 1...SECONDS between retries of a retrieval.\n\
172 -Y, --proxy=on/off turn proxy on or off.\n\
173 -Q, --quota=NUMBER set retrieval quota to NUMBER.\n\
177 -nd --no-directories don\'t create directories.\n\
178 -x, --force-directories force creation of directories.\n\
179 -nH, --no-host-directories don\'t create host directories.\n\
180 -P, --directory-prefix=PREFIX save files to PREFIX/...\n\
181 --cut-dirs=NUMBER ignore NUMBER remote directory components.\n\
185 --http-user=USER set http user to USER.\n\
186 --http-passwd=PASS set http password to PASS.\n\
187 -C, --cache=on/off (dis)allow server-cached data (normally allowed).\n\
188 -E, --html-extension save all text/html documents with .html extension.\n\
189 --ignore-length ignore `Content-Length\' header field.\n\
190 --header=STRING insert STRING among the headers.\n\
191 --proxy-user=USER set USER as proxy username.\n\
192 --proxy-passwd=PASS set PASS as proxy password.\n\
193 --referer=URL include `Referer: URL\' header in HTTP request.\n\
194 -s, --save-headers save the HTTP headers to file.\n\
195 -U, --user-agent=AGENT identify as AGENT instead of Wget/VERSION.\n\
199 -nr, --dont-remove-listing don\'t remove `.listing\' files.\n\
200 -g, --glob=on/off turn file name globbing on or off.\n\
201 --passive-ftp use the \"passive\" transfer mode.\n\
202 --retr-symlinks when recursing, get linked-to files (not dirs).\n\
205 Recursive retrieval:\n\
206 -r, --recursive recursive web-suck -- use with care!\n\
207 -l, --level=NUMBER maximum recursion depth (inf or 0 for infinite).\n\
208 --delete-after delete files locally after downloading them.\n\
209 -k, --convert-links convert non-relative links to relative.\n\
210 -K, --backup-converted before converting file X, back up as X.orig.\n\
211 -m, --mirror shortcut option equivalent to -r -N -l inf -nr.\n\
212 -p, --page-requisites get all images, etc. needed to display HTML page.\n\
215 Recursive accept/reject:\n\
216 -A, --accept=LIST comma-separated list of accepted extensions.\n\
217 -R, --reject=LIST comma-separated list of rejected extensions.\n\
218 -D, --domains=LIST comma-separated list of accepted domains.\n\
219 --exclude-domains=LIST comma-separated list of rejected domains.\n\
220 --follow-ftp follow FTP links from HTML documents.\n\
221 --follow-tags=LIST comma-separated list of followed HTML tags.\n\
222 -G, --ignore-tags=LIST comma-separated list of ignored HTML tags.\n\
223 -H, --span-hosts go to foreign hosts when recursive.\n\
224 -L, --relative follow relative links only.\n\
225 -I, --include-directories=LIST list of allowed directories.\n\
226 -X, --exclude-directories=LIST list of excluded directories.\n\
227 -nh, --no-host-lookup don\'t DNS-lookup hosts.\n\
228 -np, --no-parent don\'t ascend to the parent directory.\n\
230 fputs (_("Mail bug reports and suggestions to <bug-wget@gnu.org>.\n"),
235 main (int argc, char *const *argv)
238 int i, c, nurl, status, append_to_log;
241 static struct option long_options[] =
243 /* Options without arguments: */
244 { "background", no_argument, NULL, 'b' },
245 { "continue", no_argument, NULL, 'c' },
246 { "convert-links", no_argument, NULL, 'k' },
247 { "backup-converted", no_argument, NULL, 'K' },
248 { "debug", no_argument, NULL, 'd' },
249 { "delete-after", no_argument, NULL, 136 },
250 { "dont-remove-listing", no_argument, NULL, 149 },
251 { "email-address", no_argument, NULL, 154 }, /* undocumented (debug) */
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 { "recursive", no_argument, NULL, 'r' },
271 { "relative", no_argument, NULL, 'L' },
272 { "retr-symlinks", no_argument, NULL, 137 },
273 { "save-headers", no_argument, NULL, 's' },
274 { "server-response", no_argument, NULL, 'S' },
275 { "span-hosts", no_argument, NULL, 'H' },
276 { "spider", no_argument, NULL, 132 },
277 { "timestamping", no_argument, NULL, 'N' },
278 { "verbose", no_argument, NULL, 'v' },
279 { "version", no_argument, NULL, 'V' },
281 /* Options accepting an argument: */
282 { "accept", required_argument, NULL, 'A' },
283 { "append-output", required_argument, NULL, 'a' },
284 { "backups", required_argument, NULL, 151 }, /* undocumented */
285 { "base", required_argument, NULL, 'B' },
286 { "bind-address", required_argument, NULL, 155 },
287 { "cache", required_argument, NULL, 'C' },
288 { "cut-dirs", required_argument, NULL, 145 },
289 { "directory-prefix", required_argument, NULL, 'P' },
290 { "domains", required_argument, NULL, 'D' },
291 { "dot-style", required_argument, NULL, 134 },
292 { "execute", required_argument, NULL, 'e' },
293 { "exclude-directories", required_argument, NULL, 'X' },
294 { "exclude-domains", required_argument, NULL, 140 },
295 { "follow-tags", required_argument, NULL, 153 },
296 { "glob", required_argument, NULL, 'g' },
297 { "header", required_argument, NULL, 131 },
298 { "htmlify", required_argument, NULL, 135 },
299 { "http-passwd", required_argument, NULL, 130 },
300 { "http-user", required_argument, NULL, 129 },
301 { "ignore-tags", required_argument, NULL, 'G' },
302 { "include-directories", required_argument, NULL, 'I' },
303 { "input-file", required_argument, NULL, 'i' },
304 { "level", required_argument, NULL, 'l' },
305 { "no", required_argument, NULL, 'n' },
306 { "output-document", required_argument, NULL, 'O' },
307 { "output-file", required_argument, NULL, 'o' },
308 { "proxy", required_argument, NULL, 'Y' },
309 { "proxy-passwd", required_argument, NULL, 144 },
310 { "proxy-user", required_argument, NULL, 143 },
311 { "quota", required_argument, NULL, 'Q' },
312 { "reject", required_argument, NULL, 'R' },
313 { "timeout", required_argument, NULL, 'T' },
314 { "tries", required_argument, NULL, 't' },
315 { "user-agent", required_argument, NULL, 'U' },
316 { "referer", required_argument, NULL, 157 },
317 { "use-proxy", required_argument, NULL, 'Y' },
319 { "sslcertfile", required_argument, NULL, 158 },
320 { "sslcertkey", required_argument, NULL, 159 },
321 #endif /* HAVE_SSL */
322 { "wait", required_argument, NULL, 'w' },
323 { "waitretry", required_argument, NULL, 152 },
328 private_initialize ();
332 /* Construct the name of the executable, without the directory part. */
333 exec_name = strrchr (argv[0], PATH_SEPARATOR);
340 windows_main_junk (&argc, (char **) argv, (char **) &exec_name);
343 initialize (); /* sets option defaults; reads the system wgetrc and .wgetrc */
345 /* [Is the order of the option letters significant? If not, they should be
346 alphabetized, like the long_options. The only thing I know for sure is
347 that the options with required arguments must be followed by a ':'.
348 -- Dan Harkless <wget@harkless.org>] */
349 while ((c = getopt_long (argc, argv, "\
350 hpVqvdkKsxmNWrHSLcFbEY:G:g:T:U:O:l:n:i:o:a:t:D:A:R:P:B:e:Q:X:I:w:",
351 long_options, (int *)0)) != EOF)
355 /* Options without arguments: */
357 setval ("spider", "on");
360 setval ("noparent", "on");
363 setval ("deleteafter", "on");
366 setval ("retrsymlinks", "on");
369 setval ("ignorelength", "on");
372 setval ("passiveftp", "on");
375 setval ("noclobber", "on");
378 setval ("followftp", "on");
381 setval ("cutdirs", optarg);
384 setval ("verbose", "off");
387 setval ("dirstruct", "off");
390 setval ("addhostdir", "off");
393 setval ("removelisting", "off");
396 setval ("simplehostcheck", "on");
399 /* For debugging purposes. */
400 printf ("%s\n", ftp_getaddress ());
404 setval ("bindaddress", optarg);
407 setval ("httpkeepalive", "off");
410 setval ("background", "on");
413 setval ("continue", "on");
417 setval ("debug", "on");
418 #else /* not DEBUG */
419 fprintf (stderr, _("%s: debug support not compiled in.\n"),
421 #endif /* not DEBUG */
424 setval ("htmlextension", "on");
427 setval ("forcehtml", "on");
430 setval ("spanhosts", "on");
440 setval ("backupconverted", "on");
443 setval ("convertlinks", "on");
446 setval ("relativeonly", "on");
449 setval ("mirror", "on");
452 setval ("timestamping", "on");
455 setval ("pagerequisites", "on");
458 setval ("serverresponse", "on");
461 setval ("saveheaders", "on");
464 setval ("quiet", "on");
467 setval ("recursive", "on");
470 printf ("GNU Wget %s\n\n", version_string);
472 Copyright (C) 1995, 1996, 1997, 1998, 2000 Free Software Foundation, Inc.\n\
473 This program is distributed in the hope that it will be useful,\n\
474 but WITHOUT ANY WARRANTY; without even the implied warranty of\n\
475 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\
476 GNU General Public License for more details.\n"));
477 printf (_("\nOriginally written by Hrvoje Niksic <hniksic@arsdigita.com>.\n"));
481 setval ("verbose", "on");
484 setval ("dirstruct", "on");
487 /* Options accepting an argument: */
489 setval ("httpuser", optarg);
492 setval ("httppasswd", optarg);
495 setval ("header", optarg);
498 setval ("dotstyle", optarg);
501 setval ("htmlify", optarg);
504 setval ("excludedomains", optarg);
507 setval ("proxyuser", optarg);
510 setval ("proxypasswd", optarg);
513 setval ("backups", optarg);
516 setval ("waitretry", optarg);
520 setval ("followtags", optarg);
523 setval ("referer", optarg);
527 setval ("sslcertfile", optarg);
530 setval ("sslcertkey", optarg);
532 #endif /* HAVE_SSL */
534 setval ("accept", optarg);
537 setval ("logfile", optarg);
541 setval ("base", optarg);
544 setval ("cache", optarg);
547 setval ("domains", optarg);
552 if (parse_line (optarg, &com, &val))
554 if (!setval (com, val))
559 fprintf (stderr, _("%s: %s: invalid command\n"), exec_name,
568 setval ("ignoretags", optarg);
571 setval ("glob", optarg);
574 setval ("includedirectories", optarg);
577 setval ("input", optarg);
580 setval ("reclevel", optarg);
584 /* #### The n? options are utter crock! */
587 for (p = optarg; *p; p++)
591 setval ("verbose", "off");
594 setval ("simplehostcheck", "on");
597 setval ("addhostdir", "off");
600 setval ("dirstruct", "off");
603 setval ("noclobber", "on");
606 setval ("removelisting", "off");
609 setval ("noparent", "on");
612 setval ("httpkeepalive", "off");
615 printf (_("%s: illegal option -- `-n%c'\n"), exec_name, *p);
618 printf (_("Try `%s --help\' for more options.\n"), exec_name);
624 setval ("outputdocument", optarg);
627 setval ("logfile", optarg);
630 setval ("dirprefix", optarg);
633 setval ("quota", optarg);
636 setval ("reject", optarg);
639 setval ("timeout", optarg);
642 setval ("tries", optarg);
645 setval ("useragent", optarg);
648 setval ("wait", optarg);
651 setval ("excludedirectories", optarg);
654 setval ("useproxy", optarg);
660 printf (_("Try `%s --help' for more options.\n"), exec_name);
666 /* All user options have now been processed, so it's now safe to do
667 interoption dependency checks. */
669 if (opt.reclevel == 0)
670 opt.reclevel = INFINITE_RECURSION; /* see wget.h for commentary on this */
672 if (opt.page_requisites && !opt.recursive)
674 opt.recursive = TRUE;
676 if (!opt.no_dirstruct)
677 opt.dirstruct = TRUE; /* usually handled by cmd_spec_recursive() */
680 if (opt.verbose == -1)
681 opt.verbose = !opt.quiet;
683 /* Retain compatibility with previous scripts.
684 if wait has been set, but waitretry has not, give it the wait value.
685 A simple check on the values is not enough, I could have set
686 wait to n>0 and waitretry to 0 - HEH */
689 char opt_wait_str[256]; /* bigger than needed buf to prevent overflow */
691 sprintf(opt_wait_str, "%ld", opt.wait);
692 setval ("waitretry", opt_wait_str);
696 if (opt.verbose && opt.quiet)
698 printf (_("Can't be verbose and quiet at the same time.\n"));
702 if (opt.timestamping && opt.noclobber)
705 Can't timestamp and not clobber old files at the same time.\n"));
709 nurl = argc - optind;
710 if (!nurl && !opt.input_filename)
712 /* No URL specified. */
713 printf (_("%s: missing URL\n"), exec_name);
716 /* #### Something nicer should be printed here -- similar to the
717 pre-1.5 `--help' page. */
718 printf (_("Try `%s --help' for more options.\n"), exec_name);
723 fork_to_background ();
725 /* Allocate basic pointer. */
726 url = ALLOCA_ARRAY (char *, nurl + 1);
727 /* Fill in the arguments. */
728 for (i = 0; i < nurl; i++, optind++)
730 char *irix4_cc_needs_this;
731 STRDUP_ALLOCA (irix4_cc_needs_this, argv[optind]);
732 url[i] = irix4_cc_needs_this;
736 /* Change the title of console window on Windows. #### I think this
737 statement should belong to retrieve_url(). --hniksic. */
739 ws_changetitle (*url, nurl);
742 /* Initialize logging. */
743 log_init (opt.lfilename, append_to_log);
745 DEBUGP (("DEBUG output created by Wget %s on %s.\n\n", version_string,
747 /* Open the output filename if necessary. */
748 if (opt.output_document)
750 if (HYPHENP (opt.output_document))
755 opt.dfp = fopen (opt.output_document, "wb");
758 perror (opt.output_document);
761 if (fstat (fileno (opt.dfp), &st) == 0 && S_ISREG (st.st_mode))
762 opt.od_known_regular = 1;
770 /* Setup the signal handler to redirect output when hangup is
773 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
774 signal(SIGHUP, redirect_output_signal);
775 /* ...and do the same for SIGUSR1. */
776 signal (SIGUSR1, redirect_output_signal);
777 /* Writing to a closed socket normally signals SIGPIPE, and the
778 process exits. What we want is to ignore SIGPIPE and just check
779 for the return value of write(). */
780 signal (SIGPIPE, SIG_IGN);
781 #endif /* HAVE_SIGNAL */
783 status = RETROK; /* initialize it, just-in-case */
785 /* Retrieve the URLs from argument list. */
786 for (t = url; *t; t++)
788 char *filename, *redirected_URL;
791 status = retrieve_url (*t, &filename, &redirected_URL, NULL, &dt);
792 if (opt.recursive && status == RETROK && (dt & TEXTHTML))
793 status = recursive_retrieve (filename,
794 redirected_URL ? redirected_URL : *t);
796 if (opt.delete_after && file_exists_p(filename))
798 DEBUGP (("Removing file due to --delete-after in main():\n"));
799 logprintf (LOG_VERBOSE, _("Removing %s.\n"), filename);
800 if (unlink (filename))
801 logprintf (LOG_NOTQUIET, "unlink: %s\n", strerror (errno));
804 FREE_MAYBE (redirected_URL);
805 FREE_MAYBE (filename);
808 /* And then from the input file, if any. */
809 if (opt.input_filename)
812 status = retrieve_from_file (opt.input_filename, opt.force_html, &count);
814 logprintf (LOG_NOTQUIET, _("No URLs found in %s.\n"),
817 /* Print the downloaded sum. */
820 || (opt.input_filename && opt.downloaded != 0))
822 logprintf (LOG_NOTQUIET,
823 _("\nFINISHED --%s--\nDownloaded: %s bytes in %d files\n"),
825 (opt.downloaded_overflow ?
826 "<overflow>" : legible_very_long (opt.downloaded)),
828 /* Print quota warning, if exceeded. */
829 if (downloaded_exceeds_quota ())
830 logprintf (LOG_NOTQUIET,
831 _("Download quota (%s bytes) EXCEEDED!\n"),
832 legible (opt.quota));
834 if (opt.convert_links && !opt.delete_after)
836 convert_all_links ();
841 print_malloc_debug_stats ();
843 if (status == RETROK)
849 /* Hangup signal handler. When wget receives SIGHUP or SIGUSR1, it
850 will proceed operation as usual, trying to write into a log file.
851 If that is impossible, the output will be turned off. */
855 redirect_output_signal (int sig)
858 signal (sig, redirect_output_signal);
859 /* Please note that the double `%' in `%%s' is intentional, because
860 redirect_output passes tmp through printf. */
861 sprintf (tmp, _("%s received, redirecting output to `%%s'.\n"),
862 (sig == SIGHUP ? "SIGHUP" :
863 (sig == SIGUSR1 ? "SIGUSR1" :
865 redirect_output (tmp);
867 #endif /* HAVE_SIGNAL */