1 \input texinfo @c -*-texinfo-*-
6 @settitle GNU Wget @value{VERSION} Manual
7 @c Disable the monstrous rectangles beside overfull hbox-es.
9 @c Use `odd' to print double-sided.
14 @c Remove this if you don't use A4 paper.
18 @c Title for man page. The weird way texi2pod.pl is written requires
19 @c the preceding @set.
21 @c man title Wget The non-interactive network downloader.
23 @dircategory Network Applications
25 * Wget: (wget). The non-interactive network downloader.
29 This file documents the GNU Wget utility for downloading network
32 @c man begin COPYRIGHT
33 Copyright @copyright{} 1996, 1997, 1998, 1999, 2000, 2001, 2002,
34 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
37 Permission is granted to make and distribute verbatim copies of
38 this manual provided the copyright notice and this permission notice
39 are preserved on all copies.
43 Permission is granted to process this file through TeX and print the
44 results, provided the printed document carries a copying permission
45 notice identical to this one except for the removal of this paragraph
46 (this paragraph not being relevant to the printed manual).
48 Permission is granted to copy, distribute and/or modify this document
49 under the terms of the GNU Free Documentation License, Version 1.2 or
50 any later version published by the Free Software Foundation; with no
51 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
52 copy of the license is included in the section entitled ``GNU Free
53 Documentation License''.
58 @title GNU Wget @value{VERSION}
59 @subtitle The non-interactive download utility
60 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
61 @author by Hrvoje Nik@v{s}i@'{c} and others
65 Originally written by Hrvoje Niksic <hniksic@xemacs.org>.
66 Currently maintained by Micah Cowan <micah@cowan.name>.
69 This is @strong{not} the complete manual for GNU Wget.
70 For more complete information, including more detailed explanations of
71 some of the options, and a number of commands available
72 for use with @file{.wgetrc} files and the @samp{-e} option, see the GNU
73 Info entry for @file{wget}.
78 @vskip 0pt plus 1filll
86 @top Wget @value{VERSION}
92 * Overview:: Features of Wget.
93 * Invoking:: Wget command-line arguments.
94 * Recursive Download:: Downloading interlinked pages.
95 * Following Links:: The available methods of chasing links.
96 * Time-Stamping:: Mirroring according to time-stamps.
97 * Startup File:: Wget's initialization file.
98 * Examples:: Examples of usage.
99 * Various:: The stuff that doesn't fit anywhere else.
100 * Appendices:: Some useful references.
101 * Copying this manual:: You may give out copies of Wget and of this manual.
102 * Concept Index:: Topics covered by this manual.
110 @c man begin DESCRIPTION
111 GNU Wget is a free utility for non-interactive download of files from
112 the Web. It supports @sc{http}, @sc{https}, and @sc{ftp} protocols, as
113 well as retrieval through @sc{http} proxies.
116 This chapter is a partial overview of Wget's features.
120 @c man begin DESCRIPTION
121 Wget is non-interactive, meaning that it can work in the background,
122 while the user is not logged on. This allows you to start a retrieval
123 and disconnect from the system, letting Wget finish the work. By
124 contrast, most of the Web browsers require constant user's presence,
125 which can be a great hindrance when transferring a lot of data.
130 @c man begin DESCRIPTION
134 @c man begin DESCRIPTION
135 Wget can follow links in @sc{html}, @sc{xhtml}, and @sc{css} pages, to
136 create local versions of remote web sites, fully recreating the
137 directory structure of the original site. This is sometimes referred to
138 as ``recursive downloading.'' While doing that, Wget respects the Robot
139 Exclusion Standard (@file{/robots.txt}). Wget can be instructed to
140 convert the links in downloaded files to point at the local files, for
145 File name wildcard matching and recursive mirroring of directories are
146 available when retrieving via @sc{ftp}. Wget can read the time-stamp
147 information given by both @sc{http} and @sc{ftp} servers, and store it
148 locally. Thus Wget can see if the remote file has changed since last
149 retrieval, and automatically retrieve the new version if it has. This
150 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
155 @c man begin DESCRIPTION
159 @c man begin DESCRIPTION
160 Wget has been designed for robustness over slow or unstable network
161 connections; if a download fails due to a network problem, it will
162 keep retrying until the whole file has been retrieved. If the server
163 supports regetting, it will instruct the server to continue the
164 download from where it left off.
168 Wget supports proxy servers, which can lighten the network load, speed
169 up retrieval and provide access behind firewalls. Wget uses the passive
170 @sc{ftp} downloading by default, active @sc{ftp} being an option.
173 Wget supports IP version 6, the next generation of IP. IPv6 is
174 autodetected at compile-time, and can be disabled at either build or
175 run time. Binaries built with IPv6 support work well in both
176 IPv4-only and dual family environments.
179 Built-in features offer mechanisms to tune which links you wish to follow
180 (@pxref{Following Links}).
183 The progress of individual downloads is traced using a progress gauge.
184 Interactive downloads are tracked using a ``thermometer''-style gauge,
185 whereas non-interactive ones are traced with dots, each dot
186 representing a fixed amount of data received (1KB by default). Either
187 gauge can be customized to your preferences.
190 Most of the features are fully configurable, either through command line
191 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
192 File}). Wget allows you to define @dfn{global} startup files
193 (@file{/usr/local/etc/wgetrc} by default) for site settings.
198 @item /usr/local/etc/wgetrc
199 Default location of the @dfn{global} startup file.
208 Finally, GNU Wget is free software. This means that everyone may use
209 it, redistribute it and/or modify it under the terms of the GNU General
210 Public License, as published by the Free Software Foundation (see the
211 file @file{COPYING} that came with GNU Wget, for details).
221 By default, Wget is very simple to invoke. The basic syntax is:
224 @c man begin SYNOPSIS
225 wget [@var{option}]@dots{} [@var{URL}]@dots{}
229 Wget will simply download all the @sc{url}s specified on the command
230 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
232 However, you may wish to change some of the default parameters of
233 Wget. You can do it two ways: permanently, adding the appropriate
234 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
240 * Basic Startup Options::
241 * Logging and Input File Options::
243 * Directory Options::
245 * HTTPS (SSL/TLS) Options::
247 * Recursive Retrieval Options::
248 * Recursive Accept/Reject Options::
256 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
257 resource locator is a compact string representation for a resource
258 available via the Internet. Wget recognizes the @sc{url} syntax as per
259 @sc{rfc1738}. This is the most widely used form (square brackets denote
263 http://host[:port]/directory/file
264 ftp://host[:port]/directory/file
267 You can also encode your username and password within a @sc{url}:
270 ftp://user:password@@host/path
271 http://user:password@@host/path
274 Either @var{user} or @var{password}, or both, may be left out. If you
275 leave out either the @sc{http} username or password, no authentication
276 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
277 will be used. If you leave out the @sc{ftp} password, your email
278 address will be supplied as a default password.@footnote{If you have a
279 @file{.netrc} file in your home directory, password will also be
282 @strong{Important Note}: if you specify a password-containing @sc{url}
283 on the command line, the username and password will be plainly visible
284 to all users on the system, by way of @code{ps}. On multi-user systems,
285 this is a big security risk. To work around it, use @code{wget -i -}
286 and feed the @sc{url}s to Wget's standard input, each on a separate
287 line, terminated by @kbd{C-d}.
289 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
290 being the hexadecimal representation of the character's @sc{ascii}
291 value. Some common unsafe characters include @samp{%} (quoted as
292 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
293 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
296 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
297 default, @sc{ftp} documents are retrieved in the binary mode (type
298 @samp{i}), which means that they are downloaded unchanged. Another
299 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
300 delimiters between the different operating systems, and is thus useful
301 for text files. Here is an example:
304 ftp://host/directory/file;type=a
307 Two alternative variants of @sc{url} specification are also supported,
308 because of historical (hysterical?) reasons and their widespreaded use.
310 @sc{ftp}-only syntax (supported by @code{NcFTP}):
315 @sc{http}-only syntax (introduced by @code{Netscape}):
320 These two alternative forms are deprecated, and may cease being
321 supported in the future.
323 If you do not understand the difference between these notations, or do
324 not know which one to use, just use the plain ordinary format you use
325 with your favorite browser, like @code{Lynx} or @code{Netscape}.
330 @section Option Syntax
331 @cindex option syntax
332 @cindex syntax of options
334 Since Wget uses GNU getopt to process command-line arguments, every
335 option has a long form along with the short one. Long options are
336 more convenient to remember, but take time to type. You may freely
337 mix different option styles, or specify options after the command-line
338 arguments. Thus you may write:
341 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
344 The space between the option accepting an argument and the argument may
345 be omitted. Instead of @samp{-o log} you can write @samp{-olog}.
347 You may put several options that do not require arguments together,
354 This is a complete equivalent of:
357 wget -d -r -c @var{URL}
360 Since the options can be specified after the arguments, you may
361 terminate them with @samp{--}. So the following will try to download
362 @sc{url} @samp{-x}, reporting failure to @file{log}:
368 The options that accept comma-separated lists all respect the convention
369 that specifying an empty list clears its value. This can be useful to
370 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
371 sets @code{exclude_directories} to @file{/cgi-bin}, the following
372 example will first reset it, and then set it to exclude @file{/~nobody}
373 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
374 (@pxref{Wgetrc Syntax}).
377 wget -X '' -X /~nobody,/~somebody
380 Most options that do not accept arguments are @dfn{boolean} options,
381 so named because their state can be captured with a yes-or-no
382 (``boolean'') variable. For example, @samp{--follow-ftp} tells Wget
383 to follow FTP links from HTML files and, on the other hand,
384 @samp{--no-glob} tells it not to perform file globbing on FTP URLs. A
385 boolean option is either @dfn{affirmative} or @dfn{negative}
386 (beginning with @samp{--no}). All such options share several
389 Unless stated otherwise, it is assumed that the default behavior is
390 the opposite of what the option accomplishes. For example, the
391 documented existence of @samp{--follow-ftp} assumes that the default
392 is to @emph{not} follow FTP links from HTML pages.
394 Affirmative options can be negated by prepending the @samp{--no-} to
395 the option name; negative options can be negated by omitting the
396 @samp{--no-} prefix. This might seem superfluous---if the default for
397 an affirmative option is to not do something, then why provide a way
398 to explicitly turn it off? But the startup file may in fact change
399 the default. For instance, using @code{follow_ftp = off} in
400 @file{.wgetrc} makes Wget @emph{not} follow FTP links by default, and
401 using @samp{--no-follow-ftp} is the only way to restore the factory
402 default from the command line.
404 @node Basic Startup Options
405 @section Basic Startup Options
410 Display the version of Wget.
414 Print a help message describing all of Wget's command-line options.
418 Go to background immediately after startup. If no output file is
419 specified via the @samp{-o}, output is redirected to @file{wget-log}.
421 @cindex execute wgetrc command
422 @item -e @var{command}
423 @itemx --execute @var{command}
424 Execute @var{command} as if it were a part of @file{.wgetrc}
425 (@pxref{Startup File}). A command thus invoked will be executed
426 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
427 them. If you need to specify more than one wgetrc command, use multiple
428 instances of @samp{-e}.
432 @node Logging and Input File Options
433 @section Logging and Input File Options
438 @item -o @var{logfile}
439 @itemx --output-file=@var{logfile}
440 Log all messages to @var{logfile}. The messages are normally reported
443 @cindex append to log
444 @item -a @var{logfile}
445 @itemx --append-output=@var{logfile}
446 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
447 to @var{logfile} instead of overwriting the old log file. If
448 @var{logfile} does not exist, a new file is created.
453 Turn on debug output, meaning various information important to the
454 developers of Wget if it does not work properly. Your system
455 administrator may have chosen to compile Wget without debug support, in
456 which case @samp{-d} will not work. Please note that compiling with
457 debug support is always safe---Wget compiled with the debug support will
458 @emph{not} print any debug info unless requested with @samp{-d}.
459 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
465 Turn off Wget's output.
470 Turn on verbose output, with all the available data. The default output
475 Turn off verbose without being completely quiet (use @samp{-q} for
476 that), which means that error messages and basic information still get
481 @itemx --input-file=@var{file}
482 Read @sc{url}s from a local or external @var{file}. If @samp{-} is
483 specified as @var{file}, @sc{url}s are read from the standard input.
484 (Use @samp{./-} to read from a file literally named @samp{-}.)
486 If this function is used, no @sc{url}s need be present on the command
487 line. If there are @sc{url}s both on the command line and in an input
488 file, those on the command lines will be the first ones to be
489 retrieved. The @var{file} need not be an @sc{html} document (but no
490 harm if it is)---it is enough if the @sc{url}s are just listed
493 However, if you specify @samp{--force-html}, the document will be
494 regarded as @samp{html}. In that case you may have problems with
495 relative links, which you can solve either by adding @code{<base
496 href="@var{url}">} to the documents or by specifying
497 @samp{--base=@var{url}} on the command line.
499 If the @var{file} is an external one, the document will be automatically
500 treated as @samp{html} if the Content-Type matches @samp{text/html}.
501 Furthermore, the @var{file}'s location will be implicitly used as base
502 href if none was specified.
507 When input is read from a file, force it to be treated as an @sc{html}
508 file. This enables you to retrieve relative links from existing
509 @sc{html} files on your local disk, by adding @code{<base
510 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
513 @cindex base for relative links in input file
515 @itemx --base=@var{URL}
516 Prepends @var{URL} to relative links read from the file specified with
517 the @samp{-i} option.
520 @node Download Options
521 @section Download Options
525 @cindex client IP address
526 @cindex IP address, client
527 @item --bind-address=@var{ADDRESS}
528 When making client TCP/IP connections, bind to @var{ADDRESS} on
529 the local machine. @var{ADDRESS} may be specified as a hostname or IP
530 address. This option can be useful if your machine is bound to multiple
535 @cindex number of retries
536 @item -t @var{number}
537 @itemx --tries=@var{number}
538 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
539 infinite retrying. The default is to retry 20 times, with the exception
540 of fatal errors like ``connection refused'' or ``not found'' (404),
541 which are not retried.
544 @itemx --output-document=@var{file}
545 The documents will not be written to the appropriate files, but all
546 will be concatenated together and written to @var{file}. If @samp{-}
547 is used as @var{file}, documents will be printed to standard output,
548 disabling link conversion. (Use @samp{./-} to print to a file
549 literally named @samp{-}.)
551 Use of @samp{-O} is @emph{not} intended to mean simply ``use the name
552 @var{file} instead of the one in the URL;'' rather, it is
553 analogous to shell redirection:
554 @samp{wget -O file http://foo} is intended to work like
555 @samp{wget -O - http://foo > file}; @file{file} will be truncated
556 immediately, and @emph{all} downloaded content will be written there.
558 For this reason, @samp{-N} (for timestamp-checking) is not supported
559 in combination with @samp{-O}: since @var{file} is always newly
560 created, it will always have a very new timestamp. A warning will be
561 issued if this combination is used.
563 Similarly, using @samp{-r} or @samp{-p} with @samp{-O} may not work as
564 you expect: Wget won't just download the first file to @var{file} and
565 then download the rest to their normal names: @emph{all} downloaded
566 content will be placed in @var{file}. This was disabled in version
567 1.11, but has been reinstated (with a warning) in 1.11.2, as there are
568 some cases where this behavior can actually have some use.
570 Note that a combination with @samp{-k} is only permitted when
571 downloading a single document, as in that case it will just convert
572 all relative URIs to external ones; @samp{-k} makes no sense for
573 multiple URIs when they're all being downloaded to a single file.
575 @cindex clobbering, file
576 @cindex downloading multiple times
580 If a file is downloaded more than once in the same directory, Wget's
581 behavior depends on a few options, including @samp{-nc}. In certain
582 cases, the local file will be @dfn{clobbered}, or overwritten, upon
583 repeated download. In other cases it will be preserved.
585 When running Wget without @samp{-N}, @samp{-nc}, @samp{-r}, or @samp{p},
586 downloading the same file in the same directory will result in the
587 original copy of @var{file} being preserved and the second copy being
588 named @samp{@var{file}.1}. If that file is downloaded yet again, the
589 third copy will be named @samp{@var{file}.2}, and so on. When
590 @samp{-nc} is specified, this behavior is suppressed, and Wget will
591 refuse to download newer copies of @samp{@var{file}}. Therefore,
592 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
593 clobbering that's prevented (as the numeric suffixes were already
594 preventing clobbering), but rather the multiple version saving that's
597 When running Wget with @samp{-r} or @samp{-p}, but without @samp{-N}
598 or @samp{-nc}, re-downloading a file will result in the new copy
599 simply overwriting the old. Adding @samp{-nc} will prevent this
600 behavior, instead causing the original version to be preserved and any
601 newer copies on the server to be ignored.
603 When running Wget with @samp{-N}, with or without @samp{-r} or
604 @samp{-p}, the decision as to whether or not to download a newer copy
605 of a file depends on the local and remote timestamp and size of the
606 file (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the
607 same time as @samp{-N}.
609 Note that when @samp{-nc} is specified, files with the suffixes
610 @samp{.html} or @samp{.htm} will be loaded from the local disk and
611 parsed as if they had been retrieved from the Web.
613 @cindex continue retrieval
614 @cindex incomplete downloads
615 @cindex resume download
618 Continue getting a partially-downloaded file. This is useful when you
619 want to finish up a download started by a previous instance of Wget, or
620 by another program. For instance:
623 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
626 If there is a file named @file{ls-lR.Z} in the current directory, Wget
627 will assume that it is the first portion of the remote file, and will
628 ask the server to continue the retrieval from an offset equal to the
629 length of the local file.
631 Note that you don't need to specify this option if you just want the
632 current invocation of Wget to retry downloading a file should the
633 connection be lost midway through. This is the default behavior.
634 @samp{-c} only affects resumption of downloads started @emph{prior} to
635 this invocation of Wget, and whose local files are still sitting around.
637 Without @samp{-c}, the previous example would just download the remote
638 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
641 Beginning with Wget 1.7, if you use @samp{-c} on a non-empty file, and
642 it turns out that the server does not support continued downloading,
643 Wget will refuse to start the download from scratch, which would
644 effectively ruin existing contents. If you really want the download to
645 start from scratch, remove the file.
647 Also beginning with Wget 1.7, if you use @samp{-c} on a file which is of
648 equal size as the one on the server, Wget will refuse to download the
649 file and print an explanatory message. The same happens when the file
650 is smaller on the server than locally (presumably because it was changed
651 on the server since your last download attempt)---because ``continuing''
652 is not meaningful, no download occurs.
654 On the other side of the coin, while using @samp{-c}, any file that's
655 bigger on the server than locally will be considered an incomplete
656 download and only @code{(length(remote) - length(local))} bytes will be
657 downloaded and tacked onto the end of the local file. This behavior can
658 be desirable in certain cases---for instance, you can use @samp{wget -c}
659 to download just the new portion that's been appended to a data
660 collection or log file.
662 However, if the file is bigger on the server because it's been
663 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
664 with a garbled file. Wget has no way of verifying that the local file
665 is really a valid prefix of the remote file. You need to be especially
666 careful of this when using @samp{-c} in conjunction with @samp{-r},
667 since every file will be considered as an "incomplete download" candidate.
669 Another instance where you'll get a garbled file if you try to use
670 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
671 ``transfer interrupted'' string into the local file. In the future a
672 ``rollback'' option may be added to deal with this case.
674 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
675 servers that support the @code{Range} header.
677 @cindex progress indicator
679 @item --progress=@var{type}
680 Select the type of the progress indicator you wish to use. Legal
681 indicators are ``dot'' and ``bar''.
683 The ``bar'' indicator is used by default. It draws an @sc{ascii} progress
684 bar graphics (a.k.a ``thermometer'' display) indicating the status of
685 retrieval. If the output is not a TTY, the ``dot'' bar will be used by
688 Use @samp{--progress=dot} to switch to the ``dot'' display. It traces
689 the retrieval by printing dots on the screen, each dot representing a
690 fixed amount of downloaded data.
692 When using the dotted retrieval, you may also set the @dfn{style} by
693 specifying the type as @samp{dot:@var{style}}. Different styles assign
694 different meaning to one dot. With the @code{default} style each dot
695 represents 1K, there are ten dots in a cluster and 50 dots in a line.
696 The @code{binary} style has a more ``computer''-like orientation---8K
697 dots, 16-dots clusters and 48 dots per line (which makes for 384K
698 lines). The @code{mega} style is suitable for downloading very large
699 files---each dot represents 64K retrieved, there are eight dots in a
700 cluster, and 48 dots on each line (so each line contains 3M).
702 Note that you can set the default style using the @code{progress}
703 command in @file{.wgetrc}. That setting may be overridden from the
704 command line. The exception is that, when the output is not a TTY, the
705 ``dot'' progress will be favored over ``bar''. To force the bar output,
706 use @samp{--progress=bar:force}.
709 @itemx --timestamping
710 Turn on time-stamping. @xref{Time-Stamping}, for details.
712 @cindex server response, print
714 @itemx --server-response
715 Print the headers sent by @sc{http} servers and responses sent by
718 @cindex Wget as spider
721 When invoked with this option, Wget will behave as a Web @dfn{spider},
722 which means that it will not download the pages, just check that they
723 are there. For example, you can use Wget to check your bookmarks:
726 wget --spider --force-html -i bookmarks.html
729 This feature needs much more work for Wget to get close to the
730 functionality of real web spiders.
734 @itemx --timeout=@var{seconds}
735 Set the network timeout to @var{seconds} seconds. This is equivalent
736 to specifying @samp{--dns-timeout}, @samp{--connect-timeout}, and
737 @samp{--read-timeout}, all at the same time.
739 When interacting with the network, Wget can check for timeout and
740 abort the operation if it takes too long. This prevents anomalies
741 like hanging reads and infinite connects. The only timeout enabled by
742 default is a 900-second read timeout. Setting a timeout to 0 disables
743 it altogether. Unless you know what you are doing, it is best not to
744 change the default timeout settings.
746 All timeout-related options accept decimal values, as well as
747 subsecond values. For example, @samp{0.1} seconds is a legal (though
748 unwise) choice of timeout. Subsecond timeouts are useful for checking
749 server response times or for testing network latency.
753 @item --dns-timeout=@var{seconds}
754 Set the DNS lookup timeout to @var{seconds} seconds. DNS lookups that
755 don't complete within the specified time will fail. By default, there
756 is no timeout on DNS lookups, other than that implemented by system
759 @cindex connect timeout
760 @cindex timeout, connect
761 @item --connect-timeout=@var{seconds}
762 Set the connect timeout to @var{seconds} seconds. TCP connections that
763 take longer to establish will be aborted. By default, there is no
764 connect timeout, other than that implemented by system libraries.
767 @cindex timeout, read
768 @item --read-timeout=@var{seconds}
769 Set the read (and write) timeout to @var{seconds} seconds. The
770 ``time'' of this timeout refers to @dfn{idle time}: if, at any point in
771 the download, no data is received for more than the specified number
772 of seconds, reading fails and the download is restarted. This option
773 does not directly affect the duration of the entire download.
775 Of course, the remote server may choose to terminate the connection
776 sooner than this option requires. The default read timeout is 900
779 @cindex bandwidth, limit
781 @cindex limit bandwidth
782 @item --limit-rate=@var{amount}
783 Limit the download speed to @var{amount} bytes per second. Amount may
784 be expressed in bytes, kilobytes with the @samp{k} suffix, or megabytes
785 with the @samp{m} suffix. For example, @samp{--limit-rate=20k} will
786 limit the retrieval rate to 20KB/s. This is useful when, for whatever
787 reason, you don't want Wget to consume the entire available bandwidth.
789 This option allows the use of decimal numbers, usually in conjunction
790 with power suffixes; for example, @samp{--limit-rate=2.5k} is a legal
793 Note that Wget implements the limiting by sleeping the appropriate
794 amount of time after a network read that took less time than specified
795 by the rate. Eventually this strategy causes the TCP transfer to slow
796 down to approximately the specified rate. However, it may take some
797 time for this balance to be achieved, so don't be surprised if limiting
798 the rate doesn't work well with very small files.
802 @item -w @var{seconds}
803 @itemx --wait=@var{seconds}
804 Wait the specified number of seconds between the retrievals. Use of
805 this option is recommended, as it lightens the server load by making the
806 requests less frequent. Instead of in seconds, the time can be
807 specified in minutes using the @code{m} suffix, in hours using @code{h}
808 suffix, or in days using @code{d} suffix.
810 Specifying a large value for this option is useful if the network or the
811 destination host is down, so that Wget can wait long enough to
812 reasonably expect the network error to be fixed before the retry. The
813 waiting interval specified by this function is influenced by
814 @code{--random-wait}, which see.
816 @cindex retries, waiting between
817 @cindex waiting between retries
818 @item --waitretry=@var{seconds}
819 If you don't want Wget to wait between @emph{every} retrieval, but only
820 between retries of failed downloads, you can use this option. Wget will
821 use @dfn{linear backoff}, waiting 1 second after the first failure on a
822 given file, then waiting 2 seconds after the second failure on that
823 file, up to the maximum number of @var{seconds} you specify. Therefore,
824 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
827 Note that this option is turned on by default in the global
833 Some web sites may perform log analysis to identify retrieval programs
834 such as Wget by looking for statistically significant similarities in
835 the time between requests. This option causes the time between requests
836 to vary between 0.5 and 1.5 * @var{wait} seconds, where @var{wait} was
837 specified using the @samp{--wait} option, in order to mask Wget's
838 presence from such analysis.
840 A 2001 article in a publication devoted to development on a popular
841 consumer platform provided code to perform this analysis on the fly.
842 Its author suggested blocking at the class C address level to ensure
843 automated retrieval programs were blocked despite changing DHCP-supplied
846 The @samp{--random-wait} option was inspired by this ill-advised
847 recommendation to block many unrelated users from a web site due to the
852 Don't use proxies, even if the appropriate @code{*_proxy} environment
856 For more information about the use of proxies with Wget, @xref{Proxies}.
861 @itemx --quota=@var{quota}
862 Specify download quota for automatic retrievals. The value can be
863 specified in bytes (default), kilobytes (with @samp{k} suffix), or
864 megabytes (with @samp{m} suffix).
866 Note that quota will never affect downloading a single file. So if you
867 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
868 @file{ls-lR.gz} will be downloaded. The same goes even when several
869 @sc{url}s are specified on the command-line. However, quota is
870 respected when retrieving either recursively, or from an input file.
871 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
872 aborted when the quota is exceeded.
874 Setting quota to 0 or to @samp{inf} unlimits the download quota.
877 @cindex caching of DNS lookups
879 Turn off caching of DNS lookups. Normally, Wget remembers the IP
880 addresses it looked up from DNS so it doesn't have to repeatedly
881 contact the DNS server for the same (typically small) set of hosts it
882 retrieves from. This cache exists in memory only; a new Wget run will
885 However, it has been reported that in some situations it is not
886 desirable to cache host names, even for the duration of a
887 short-running application like Wget. With this option Wget issues a
888 new DNS lookup (more precisely, a new call to @code{gethostbyname} or
889 @code{getaddrinfo}) each time it makes a new connection. Please note
890 that this option will @emph{not} affect caching that might be
891 performed by the resolving library or by an external caching layer,
894 If you don't understand exactly what this option does, you probably
897 @cindex file names, restrict
898 @cindex Windows file names
899 @item --restrict-file-names=@var{mode}
900 Change which characters found in remote URLs may show up in local file
901 names generated from those URLs. Characters that are @dfn{restricted}
902 by this option are escaped, i.e. replaced with @samp{%HH}, where
903 @samp{HH} is the hexadecimal number that corresponds to the restricted
906 By default, Wget escapes the characters that are not valid as part of
907 file names on your operating system, as well as control characters that
908 are typically unprintable. This option is useful for changing these
909 defaults, either because you are downloading to a non-native partition,
910 or because you want to disable escaping of the control characters.
912 When mode is set to ``unix'', Wget escapes the character @samp{/} and
913 the control characters in the ranges 0--31 and 128--159. This is the
914 default on Unix-like OS'es.
916 When mode is set to ``windows'', Wget escapes the characters @samp{\},
917 @samp{|}, @samp{/}, @samp{:}, @samp{?}, @samp{"}, @samp{*}, @samp{<},
918 @samp{>}, and the control characters in the ranges 0--31 and 128--159.
919 In addition to this, Wget in Windows mode uses @samp{+} instead of
920 @samp{:} to separate host and port in local file names, and uses
921 @samp{@@} instead of @samp{?} to separate the query portion of the file
922 name from the rest. Therefore, a URL that would be saved as
923 @samp{www.xemacs.org:4300/search.pl?input=blah} in Unix mode would be
924 saved as @samp{www.xemacs.org+4300/search.pl@@input=blah} in Windows
925 mode. This mode is the default on Windows.
927 If you append @samp{,nocontrol} to the mode, as in
928 @samp{unix,nocontrol}, escaping of the control characters is also
929 switched off. You can use @samp{--restrict-file-names=nocontrol} to
930 turn off escaping of control characters without affecting the choice of
931 the OS to use as file name restriction mode.
938 Force connecting to IPv4 or IPv6 addresses. With @samp{--inet4-only}
939 or @samp{-4}, Wget will only connect to IPv4 hosts, ignoring AAAA
940 records in DNS, and refusing to connect to IPv6 addresses specified in
941 URLs. Conversely, with @samp{--inet6-only} or @samp{-6}, Wget will
942 only connect to IPv6 hosts and ignore A records and IPv4 addresses.
944 Neither options should be needed normally. By default, an IPv6-aware
945 Wget will use the address family specified by the host's DNS record.
946 If the DNS responds with both IPv4 and IPv6 addresses, Wget will try
947 them in sequence until it finds one it can connect to. (Also see
948 @code{--prefer-family} option described below.)
950 These options can be used to deliberately force the use of IPv4 or
951 IPv6 address families on dual family systems, usually to aid debugging
952 or to deal with broken network configuration. Only one of
953 @samp{--inet6-only} and @samp{--inet4-only} may be specified at the
954 same time. Neither option is available in Wget compiled without IPv6
957 @item --prefer-family=none/IPv4/IPv6
958 When given a choice of several addresses, connect to the addresses
959 with specified address family first. The address order returned by
960 DNS is used without change by default.
962 This avoids spurious errors and connect attempts when accessing hosts
963 that resolve to both IPv6 and IPv4 addresses from IPv4 networks. For
964 example, @samp{www.kame.net} resolves to
965 @samp{2001:200:0:8002:203:47ff:fea5:3085} and to
966 @samp{203.178.141.194}. When the preferred family is @code{IPv4}, the
967 IPv4 address is used first; when the preferred family is @code{IPv6},
968 the IPv6 address is used first; if the specified value is @code{none},
969 the address order returned by DNS is used without change.
971 Unlike @samp{-4} and @samp{-6}, this option doesn't inhibit access to
972 any address family, it only changes the @emph{order} in which the
973 addresses are accessed. Also note that the reordering performed by
974 this option is @dfn{stable}---it doesn't affect order of addresses of
975 the same family. That is, the relative order of all IPv4 addresses
976 and of all IPv6 addresses remains intact in all cases.
978 @item --retry-connrefused
979 Consider ``connection refused'' a transient error and try again.
980 Normally Wget gives up on a URL when it is unable to connect to the
981 site because failure to connect is taken as a sign that the server is
982 not running at all and that retries would not help. This option is
983 for mirroring unreliable sites whose servers tend to disappear for
984 short periods of time.
988 @cindex authentication
989 @item --user=@var{user}
990 @itemx --password=@var{password}
991 Specify the username @var{user} and password @var{password} for both
992 @sc{ftp} and @sc{http} file retrieval. These parameters can be overridden
993 using the @samp{--ftp-user} and @samp{--ftp-password} options for
994 @sc{ftp} connections and the @samp{--http-user} and @samp{--http-password}
995 options for @sc{http} connections.
998 Prompt for a password for each connection established. Cannot be specified
999 when @samp{--password} is being used, because they are mutually exclusive.
1002 @node Directory Options
1003 @section Directory Options
1007 @itemx --no-directories
1008 Do not create a hierarchy of directories when retrieving recursively.
1009 With this option turned on, all files will get saved to the current
1010 directory, without clobbering (if a name shows up more than once, the
1011 filenames will get extensions @samp{.n}).
1014 @itemx --force-directories
1015 The opposite of @samp{-nd}---create a hierarchy of directories, even if
1016 one would not have been created otherwise. E.g. @samp{wget -x
1017 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
1018 @file{fly.srk.fer.hr/robots.txt}.
1021 @itemx --no-host-directories
1022 Disable generation of host-prefixed directories. By default, invoking
1023 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
1024 directories beginning with @file{fly.srk.fer.hr/}. This option disables
1027 @item --protocol-directories
1028 Use the protocol name as a directory component of local file names. For
1029 example, with this option, @samp{wget -r http://@var{host}} will save to
1030 @samp{http/@var{host}/...} rather than just to @samp{@var{host}/...}.
1032 @cindex cut directories
1033 @item --cut-dirs=@var{number}
1034 Ignore @var{number} directory components. This is useful for getting a
1035 fine-grained control over the directory where recursive retrieval will
1038 Take, for example, the directory at
1039 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
1040 @samp{-r}, it will be saved locally under
1041 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
1042 remove the @file{ftp.xemacs.org/} part, you are still stuck with
1043 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
1044 makes Wget not ``see'' @var{number} remote directory components. Here
1045 are several examples of how @samp{--cut-dirs} option works.
1049 No options -> ftp.xemacs.org/pub/xemacs/
1051 -nH --cut-dirs=1 -> xemacs/
1052 -nH --cut-dirs=2 -> .
1054 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
1059 If you just want to get rid of the directory structure, this option is
1060 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
1061 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
1062 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
1063 be placed to @file{xemacs/beta}, as one would expect.
1065 @cindex directory prefix
1066 @item -P @var{prefix}
1067 @itemx --directory-prefix=@var{prefix}
1068 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
1069 directory where all other files and subdirectories will be saved to,
1070 i.e. the top of the retrieval tree. The default is @samp{.} (the
1075 @section HTTP Options
1078 @cindex .html extension
1080 @itemx --html-extension
1081 If a file of type @samp{application/xhtml+xml} or @samp{text/html} is
1082 downloaded and the URL does not end with the regexp
1083 @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause the suffix @samp{.html}
1084 to be appended to the local filename. This is useful, for instance, when
1085 you're mirroring a remote site that uses @samp{.asp} pages, but you want
1086 the mirrored pages to be viewable on your stock Apache server. Another
1087 good use for this is when you're downloading CGI-generated materials. A URL
1088 like @samp{http://site.com/article.cgi?25} will be saved as
1089 @file{article.cgi?25.html}.
1091 Note that filenames changed in this way will be re-downloaded every time
1092 you re-mirror a site, because Wget can't tell that the local
1093 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
1094 it doesn't yet know that the URL produces output of type
1095 @samp{text/html} or @samp{application/xhtml+xml}. To prevent this
1096 re-downloading, you must use @samp{-k} and @samp{-K} so that the original
1097 version of the file will be saved as @file{@var{X}.orig} (@pxref{Recursive
1098 Retrieval Options}).
1100 As of version 1.12, Wget will also ensure that any downloaded files of
1101 type @samp{text/css} end in the suffix @samp{.css}. Obviously, this
1102 makes the name @samp{--html-extension} misleading; a better name is
1103 expected to be offered as an alternative in the near future.
1106 @cindex http password
1107 @cindex authentication
1108 @item --http-user=@var{user}
1109 @itemx --http-password=@var{password}
1110 Specify the username @var{user} and password @var{password} on an
1111 @sc{http} server. According to the type of the challenge, Wget will
1112 encode them using either the @code{basic} (insecure),
1113 the @code{digest}, or the Windows @code{NTLM} authentication scheme.
1115 Another way to specify username and password is in the @sc{url} itself
1116 (@pxref{URL Format}). Either method reveals your password to anyone who
1117 bothers to run @code{ps}. To prevent the passwords from being seen,
1118 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
1119 those files from other users with @code{chmod}. If the passwords are
1120 really important, do not leave them lying in those files either---edit
1121 the files and delete them after Wget has started the download.
1124 For more information about security issues with Wget, @xref{Security
1131 Disable server-side cache. In this case, Wget will send the remote
1132 server an appropriate directive (@samp{Pragma: no-cache}) to get the
1133 file from the remote service, rather than returning the cached version.
1134 This is especially useful for retrieving and flushing out-of-date
1135 documents on proxy servers.
1137 Caching is allowed by default.
1141 Disable the use of cookies. Cookies are a mechanism for maintaining
1142 server-side state. The server sends the client a cookie using the
1143 @code{Set-Cookie} header, and the client responds with the same cookie
1144 upon further requests. Since cookies allow the server owners to keep
1145 track of visitors and for sites to exchange this information, some
1146 consider them a breach of privacy. The default is to use cookies;
1147 however, @emph{storing} cookies is not on by default.
1149 @cindex loading cookies
1150 @cindex cookies, loading
1151 @item --load-cookies @var{file}
1152 Load cookies from @var{file} before the first HTTP retrieval.
1153 @var{file} is a textual file in the format originally used by Netscape's
1154 @file{cookies.txt} file.
1156 You will typically use this option when mirroring sites that require
1157 that you be logged in to access some or all of their content. The login
1158 process typically works by the web server issuing an @sc{http} cookie
1159 upon receiving and verifying your credentials. The cookie is then
1160 resent by the browser when accessing that part of the site, and so
1161 proves your identity.
1163 Mirroring such a site requires Wget to send the same cookies your
1164 browser sends when communicating with the site. This is achieved by
1165 @samp{--load-cookies}---simply point Wget to the location of the
1166 @file{cookies.txt} file, and it will send the same cookies your browser
1167 would send in the same situation. Different browsers keep textual
1168 cookie files in different locations:
1172 The cookies are in @file{~/.netscape/cookies.txt}.
1174 @item Mozilla and Netscape 6.x.
1175 Mozilla's cookie file is also named @file{cookies.txt}, located
1176 somewhere under @file{~/.mozilla}, in the directory of your profile.
1177 The full path usually ends up looking somewhat like
1178 @file{~/.mozilla/default/@var{some-weird-string}/cookies.txt}.
1180 @item Internet Explorer.
1181 You can produce a cookie file Wget can use by using the File menu,
1182 Import and Export, Export Cookies. This has been tested with Internet
1183 Explorer 5; it is not guaranteed to work with earlier versions.
1185 @item Other browsers.
1186 If you are using a different browser to create your cookies,
1187 @samp{--load-cookies} will only work if you can locate or produce a
1188 cookie file in the Netscape format that Wget expects.
1191 If you cannot use @samp{--load-cookies}, there might still be an
1192 alternative. If your browser supports a ``cookie manager'', you can use
1193 it to view the cookies used when accessing the site you're mirroring.
1194 Write down the name and value of the cookie, and manually instruct Wget
1195 to send those cookies, bypassing the ``official'' cookie support:
1198 wget --no-cookies --header "Cookie: @var{name}=@var{value}"
1201 @cindex saving cookies
1202 @cindex cookies, saving
1203 @item --save-cookies @var{file}
1204 Save cookies to @var{file} before exiting. This will not save cookies
1205 that have expired or that have no expiry time (so-called ``session
1206 cookies''), but also see @samp{--keep-session-cookies}.
1208 @cindex cookies, session
1209 @cindex session cookies
1210 @item --keep-session-cookies
1211 When specified, causes @samp{--save-cookies} to also save session
1212 cookies. Session cookies are normally not saved because they are
1213 meant to be kept in memory and forgotten when you exit the browser.
1214 Saving them is useful on sites that require you to log in or to visit
1215 the home page before you can access some pages. With this option,
1216 multiple Wget runs are considered a single browser session as far as
1217 the site is concerned.
1219 Since the cookie file format does not normally carry session cookies,
1220 Wget marks them with an expiry timestamp of 0. Wget's
1221 @samp{--load-cookies} recognizes those as session cookies, but it might
1222 confuse other browsers. Also note that cookies so loaded will be
1223 treated as other session cookies, which means that if you want
1224 @samp{--save-cookies} to preserve them again, you must use
1225 @samp{--keep-session-cookies} again.
1227 @cindex Content-Length, ignore
1228 @cindex ignore length
1229 @item --ignore-length
1230 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
1231 precise) send out bogus @code{Content-Length} headers, which makes Wget
1232 go wild, as it thinks not all the document was retrieved. You can spot
1233 this syndrome if Wget retries getting the same document again and again,
1234 each time claiming that the (otherwise normal) connection has closed on
1237 With this option, Wget will ignore the @code{Content-Length} header---as
1238 if it never existed.
1241 @item --header=@var{header-line}
1242 Send @var{header-line} along with the rest of the headers in each
1243 @sc{http} request. The supplied header is sent as-is, which means it
1244 must contain name and value separated by colon, and must not contain
1247 You may define more than one additional header by specifying
1248 @samp{--header} more than once.
1252 wget --header='Accept-Charset: iso-8859-2' \
1253 --header='Accept-Language: hr' \
1254 http://fly.srk.fer.hr/
1258 Specification of an empty string as the header value will clear all
1259 previous user-defined headers.
1261 As of Wget 1.10, this option can be used to override headers otherwise
1262 generated automatically. This example instructs Wget to connect to
1263 localhost, but to specify @samp{foo.bar} in the @code{Host} header:
1266 wget --header="Host: foo.bar" http://localhost/
1269 In versions of Wget prior to 1.10 such use of @samp{--header} caused
1270 sending of duplicate headers.
1273 @item --max-redirect=@var{number}
1274 Specifies the maximum number of redirections to follow for a resource.
1275 The default is 20, which is usually far more than necessary. However, on
1276 those occasions where you want to allow more (or fewer), this is the
1280 @cindex proxy password
1281 @cindex proxy authentication
1282 @item --proxy-user=@var{user}
1283 @itemx --proxy-password=@var{password}
1284 Specify the username @var{user} and password @var{password} for
1285 authentication on a proxy server. Wget will encode them using the
1286 @code{basic} authentication scheme.
1288 Security considerations similar to those with @samp{--http-password}
1289 pertain here as well.
1291 @cindex http referer
1292 @cindex referer, http
1293 @item --referer=@var{url}
1294 Include `Referer: @var{url}' header in HTTP request. Useful for
1295 retrieving documents with server-side processing that assume they are
1296 always being retrieved by interactive web browsers and only come out
1297 properly when Referer is set to one of the pages that point to them.
1299 @cindex server response, save
1300 @item --save-headers
1301 Save the headers sent by the @sc{http} server to the file, preceding the
1302 actual contents, with an empty line as the separator.
1305 @item -U @var{agent-string}
1306 @itemx --user-agent=@var{agent-string}
1307 Identify as @var{agent-string} to the @sc{http} server.
1309 The @sc{http} protocol allows the clients to identify themselves using a
1310 @code{User-Agent} header field. This enables distinguishing the
1311 @sc{www} software, usually for statistical purposes or for tracing of
1312 protocol violations. Wget normally identifies as
1313 @samp{Wget/@var{version}}, @var{version} being the current version
1316 However, some sites have been known to impose the policy of tailoring
1317 the output according to the @code{User-Agent}-supplied information.
1318 While this is not such a bad idea in theory, it has been abused by
1319 servers denying information to clients other than (historically)
1320 Netscape or, more frequently, Microsoft Internet Explorer. This
1321 option allows you to change the @code{User-Agent} line issued by Wget.
1322 Use of this option is discouraged, unless you really know what you are
1325 Specifying empty user agent with @samp{--user-agent=""} instructs Wget
1326 not to send the @code{User-Agent} header in @sc{http} requests.
1329 @item --post-data=@var{string}
1330 @itemx --post-file=@var{file}
1331 Use POST as the method for all HTTP requests and send the specified data
1332 in the request body. @code{--post-data} sends @var{string} as data,
1333 whereas @code{--post-file} sends the contents of @var{file}. Other than
1334 that, they work in exactly the same way.
1336 Please be aware that Wget needs to know the size of the POST data in
1337 advance. Therefore the argument to @code{--post-file} must be a regular
1338 file; specifying a FIFO or something like @file{/dev/stdin} won't work.
1339 It's not quite clear how to work around this limitation inherent in
1340 HTTP/1.0. Although HTTP/1.1 introduces @dfn{chunked} transfer that
1341 doesn't require knowing the request length in advance, a client can't
1342 use chunked unless it knows it's talking to an HTTP/1.1 server. And it
1343 can't know that until it receives a response, which in turn requires the
1344 request to have been completed -- a chicken-and-egg problem.
1346 Note: if Wget is redirected after the POST request is completed, it
1347 will not send the POST data to the redirected URL. This is because
1348 URLs that process POST often respond with a redirection to a regular
1349 page, which does not desire or accept POST. It is not completely
1350 clear that this behavior is optimal; if it doesn't work out, it might
1351 be changed in the future.
1353 This example shows how to log to a server using POST and then proceed to
1354 download the desired pages, presumably only accessible to authorized
1359 # @r{Log in to the server. This can be done only once.}
1360 wget --save-cookies cookies.txt \
1361 --post-data 'user=foo&password=bar' \
1362 http://server.com/auth.php
1364 # @r{Now grab the page or pages we care about.}
1365 wget --load-cookies cookies.txt \
1366 -p http://server.com/interesting/article.php
1370 If the server is using session cookies to track user authentication,
1371 the above will not work because @samp{--save-cookies} will not save
1372 them (and neither will browsers) and the @file{cookies.txt} file will
1373 be empty. In that case use @samp{--keep-session-cookies} along with
1374 @samp{--save-cookies} to force saving of session cookies.
1376 @cindex Content-Disposition
1377 @item --content-disposition
1379 If this is set to on, experimental (not fully-functional) support for
1380 @code{Content-Disposition} headers is enabled. This can currently result in
1381 extra round-trips to the server for a @code{HEAD} request, and is known
1382 to suffer from a few bugs, which is why it is not currently enabled by default.
1384 This option is useful for some file-downloading CGI programs that use
1385 @code{Content-Disposition} headers to describe what the name of a
1386 downloaded file should be.
1388 @cindex authentication
1389 @item --auth-no-challenge
1391 If this option is given, Wget will send Basic HTTP authentication
1392 information (plaintext username and password) for all requests, just
1393 like Wget 1.10.2 and prior did by default.
1395 Use of this option is not recommended, and is intended only to support
1396 some few obscure servers, which never send HTTP authentication
1397 challenges, but accept unsolicited auth info, say, in addition to
1398 form-based authentication.
1402 @node HTTPS (SSL/TLS) Options
1403 @section HTTPS (SSL/TLS) Options
1406 To support encrypted HTTP (HTTPS) downloads, Wget must be compiled
1407 with an external SSL library, currently OpenSSL. If Wget is compiled
1408 without SSL support, none of these options are available.
1411 @cindex SSL protocol, choose
1412 @item --secure-protocol=@var{protocol}
1413 Choose the secure protocol to be used. Legal values are @samp{auto},
1414 @samp{SSLv2}, @samp{SSLv3}, and @samp{TLSv1}. If @samp{auto} is used,
1415 the SSL library is given the liberty of choosing the appropriate
1416 protocol automatically, which is achieved by sending an SSLv2 greeting
1417 and announcing support for SSLv3 and TLSv1. This is the default.
1419 Specifying @samp{SSLv2}, @samp{SSLv3}, or @samp{TLSv1} forces the use
1420 of the corresponding protocol. This is useful when talking to old and
1421 buggy SSL server implementations that make it hard for OpenSSL to
1422 choose the correct protocol version. Fortunately, such servers are
1425 @cindex SSL certificate, check
1426 @item --no-check-certificate
1427 Don't check the server certificate against the available certificate
1428 authorities. Also don't require the URL host name to match the common
1429 name presented by the certificate.
1431 As of Wget 1.10, the default is to verify the server's certificate
1432 against the recognized certificate authorities, breaking the SSL
1433 handshake and aborting the download if the verification fails.
1434 Although this provides more secure downloads, it does break
1435 interoperability with some sites that worked with previous Wget
1436 versions, particularly those using self-signed, expired, or otherwise
1437 invalid certificates. This option forces an ``insecure'' mode of
1438 operation that turns the certificate verification errors into warnings
1439 and allows you to proceed.
1441 If you encounter ``certificate verification'' errors or ones saying
1442 that ``common name doesn't match requested host name'', you can use
1443 this option to bypass the verification and proceed with the download.
1444 @emph{Only use this option if you are otherwise convinced of the
1445 site's authenticity, or if you really don't care about the validity of
1446 its certificate.} It is almost always a bad idea not to check the
1447 certificates when transmitting confidential or important data.
1449 @cindex SSL certificate
1450 @item --certificate=@var{file}
1451 Use the client certificate stored in @var{file}. This is needed for
1452 servers that are configured to require certificates from the clients
1453 that connect to them. Normally a certificate is not required and this
1456 @cindex SSL certificate type, specify
1457 @item --certificate-type=@var{type}
1458 Specify the type of the client certificate. Legal values are
1459 @samp{PEM} (assumed by default) and @samp{DER}, also known as
1462 @item --private-key=@var{file}
1463 Read the private key from @var{file}. This allows you to provide the
1464 private key in a file separate from the certificate.
1466 @item --private-key-type=@var{type}
1467 Specify the type of the private key. Accepted values are @samp{PEM}
1468 (the default) and @samp{DER}.
1470 @item --ca-certificate=@var{file}
1471 Use @var{file} as the file with the bundle of certificate authorities
1472 (``CA'') to verify the peers. The certificates must be in PEM format.
1474 Without this option Wget looks for CA certificates at the
1475 system-specified locations, chosen at OpenSSL installation time.
1477 @cindex SSL certificate authority
1478 @item --ca-directory=@var{directory}
1479 Specifies directory containing CA certificates in PEM format. Each
1480 file contains one CA certificate, and the file name is based on a hash
1481 value derived from the certificate. This is achieved by processing a
1482 certificate directory with the @code{c_rehash} utility supplied with
1483 OpenSSL. Using @samp{--ca-directory} is more efficient than
1484 @samp{--ca-certificate} when many certificates are installed because
1485 it allows Wget to fetch certificates on demand.
1487 Without this option Wget looks for CA certificates at the
1488 system-specified locations, chosen at OpenSSL installation time.
1490 @cindex entropy, specifying source of
1491 @cindex randomness, specifying source of
1492 @item --random-file=@var{file}
1493 Use @var{file} as the source of random data for seeding the
1494 pseudo-random number generator on systems without @file{/dev/random}.
1496 On such systems the SSL library needs an external source of randomness
1497 to initialize. Randomness may be provided by EGD (see
1498 @samp{--egd-file} below) or read from an external source specified by
1499 the user. If this option is not specified, Wget looks for random data
1500 in @code{$RANDFILE} or, if that is unset, in @file{$HOME/.rnd}. If
1501 none of those are available, it is likely that SSL encryption will not
1504 If you're getting the ``Could not seed OpenSSL PRNG; disabling SSL.''
1505 error, you should provide random data using some of the methods
1509 @item --egd-file=@var{file}
1510 Use @var{file} as the EGD socket. EGD stands for @dfn{Entropy
1511 Gathering Daemon}, a user-space program that collects data from
1512 various unpredictable system sources and makes it available to other
1513 programs that might need it. Encryption software, such as the SSL
1514 library, needs sources of non-repeating randomness to seed the random
1515 number generator used to produce cryptographically strong keys.
1517 OpenSSL allows the user to specify his own source of entropy using the
1518 @code{RAND_FILE} environment variable. If this variable is unset, or
1519 if the specified file does not produce enough randomness, OpenSSL will
1520 read random data from EGD socket specified using this option.
1522 If this option is not specified (and the equivalent startup command is
1523 not used), EGD is never contacted. EGD is not needed on modern Unix
1524 systems that support @file{/dev/random}.
1528 @section FTP Options
1532 @cindex ftp password
1533 @cindex ftp authentication
1534 @item --ftp-user=@var{user}
1535 @itemx --ftp-password=@var{password}
1536 Specify the username @var{user} and password @var{password} on an
1537 @sc{ftp} server. Without this, or the corresponding startup option,
1538 the password defaults to @samp{-wget@@}, normally used for anonymous
1541 Another way to specify username and password is in the @sc{url} itself
1542 (@pxref{URL Format}). Either method reveals your password to anyone who
1543 bothers to run @code{ps}. To prevent the passwords from being seen,
1544 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
1545 those files from other users with @code{chmod}. If the passwords are
1546 really important, do not leave them lying in those files either---edit
1547 the files and delete them after Wget has started the download.
1550 For more information about security issues with Wget, @xref{Security
1554 @cindex .listing files, removing
1555 @item --no-remove-listing
1556 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1557 retrievals. Normally, these files contain the raw directory listings
1558 received from @sc{ftp} servers. Not removing them can be useful for
1559 debugging purposes, or when you want to be able to easily check on the
1560 contents of remote server directories (e.g. to verify that a mirror
1561 you're running is complete).
1563 Note that even though Wget writes to a known filename for this file,
1564 this is not a security hole in the scenario of a user making
1565 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1566 asking @code{root} to run Wget in his or her directory. Depending on
1567 the options used, either Wget will refuse to write to @file{.listing},
1568 making the globbing/recursion/time-stamping operation fail, or the
1569 symbolic link will be deleted and replaced with the actual
1570 @file{.listing} file, or the listing will be written to a
1571 @file{.listing.@var{number}} file.
1573 Even though this situation isn't a problem, though, @code{root} should
1574 never run Wget in a non-trusted user's directory. A user could do
1575 something as simple as linking @file{index.html} to @file{/etc/passwd}
1576 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1577 will be overwritten.
1579 @cindex globbing, toggle
1581 Turn off @sc{ftp} globbing. Globbing refers to the use of shell-like
1582 special characters (@dfn{wildcards}), like @samp{*}, @samp{?}, @samp{[}
1583 and @samp{]} to retrieve more than one file from the same directory at
1587 wget ftp://gnjilux.srk.fer.hr/*.msg
1590 By default, globbing will be turned on if the @sc{url} contains a
1591 globbing character. This option may be used to turn globbing on or off
1594 You may have to quote the @sc{url} to protect it from being expanded by
1595 your shell. Globbing makes Wget look for a directory listing, which is
1596 system-specific. This is why it currently works only with Unix @sc{ftp}
1597 servers (and the ones emulating Unix @code{ls} output).
1600 @item --no-passive-ftp
1601 Disable the use of the @dfn{passive} FTP transfer mode. Passive FTP
1602 mandates that the client connect to the server to establish the data
1603 connection rather than the other way around.
1605 If the machine is connected to the Internet directly, both passive and
1606 active FTP should work equally well. Behind most firewall and NAT
1607 configurations passive FTP has a better chance of working. However,
1608 in some rare firewall configurations, active FTP actually works when
1609 passive FTP doesn't. If you suspect this to be the case, use this
1610 option, or set @code{passive_ftp=off} in your init file.
1612 @cindex symbolic links, retrieving
1613 @item --retr-symlinks
1614 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1615 link is encountered, the linked-to file is not downloaded. Instead, a
1616 matching symbolic link is created on the local filesystem. The
1617 pointed-to file will not be downloaded unless this recursive retrieval
1618 would have encountered it separately and downloaded it anyway.
1620 When @samp{--retr-symlinks} is specified, however, symbolic links are
1621 traversed and the pointed-to files are retrieved. At this time, this
1622 option does not cause Wget to traverse symlinks to directories and
1623 recurse through them, but in the future it should be enhanced to do
1626 Note that when retrieving a file (not a directory) because it was
1627 specified on the command-line, rather than because it was recursed to,
1628 this option has no effect. Symbolic links are always traversed in this
1631 @cindex Keep-Alive, turning off
1632 @cindex Persistent Connections, disabling
1633 @item --no-http-keep-alive
1634 Turn off the ``keep-alive'' feature for HTTP downloads. Normally, Wget
1635 asks the server to keep the connection open so that, when you download
1636 more than one document from the same server, they get transferred over
1637 the same TCP connection. This saves time and at the same time reduces
1638 the load on the server.
1640 This option is useful when, for some reason, persistent (keep-alive)
1641 connections don't work for you, for example due to a server bug or due
1642 to the inability of server-side scripts to cope with the connections.
1645 @node Recursive Retrieval Options
1646 @section Recursive Retrieval Options
1651 Turn on recursive retrieving. @xref{Recursive Download}, for more
1654 @item -l @var{depth}
1655 @itemx --level=@var{depth}
1656 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1657 Download}). The default maximum depth is 5.
1659 @cindex proxy filling
1660 @cindex delete after retrieval
1661 @cindex filling proxy cache
1662 @item --delete-after
1663 This option tells Wget to delete every single file it downloads,
1664 @emph{after} having done so. It is useful for pre-fetching popular
1665 pages through a proxy, e.g.:
1668 wget -r -nd --delete-after http://whatever.com/~popular/page/
1671 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1674 Note that @samp{--delete-after} deletes files on the local machine. It
1675 does not issue the @samp{DELE} command to remote FTP sites, for
1676 instance. Also note that when @samp{--delete-after} is specified,
1677 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1678 created in the first place.
1680 @cindex conversion of links
1681 @cindex link conversion
1683 @itemx --convert-links
1684 After the download is complete, convert the links in the document to
1685 make them suitable for local viewing. This affects not only the visible
1686 hyperlinks, but any part of the document that links to external content,
1687 such as embedded images, links to style sheets, hyperlinks to non-@sc{html}
1690 Each link will be changed in one of the two ways:
1694 The links to files that have been downloaded by Wget will be changed to
1695 refer to the file they point to as a relative link.
1697 Example: if the downloaded file @file{/foo/doc.html} links to
1698 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1699 will be modified to point to @samp{../bar/img.gif}. This kind of
1700 transformation works reliably for arbitrary combinations of directories.
1703 The links to files that have not been downloaded by Wget will be changed
1704 to include host name and absolute path of the location they point to.
1706 Example: if the downloaded file @file{/foo/doc.html} links to
1707 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1708 @file{doc.html} will be modified to point to
1709 @file{http://@var{hostname}/bar/img.gif}.
1712 Because of this, local browsing works reliably: if a linked file was
1713 downloaded, the link will refer to its local name; if it was not
1714 downloaded, the link will refer to its full Internet address rather than
1715 presenting a broken link. The fact that the former links are converted
1716 to relative links ensures that you can move the downloaded hierarchy to
1719 Note that only at the end of the download can Wget know which links have
1720 been downloaded. Because of that, the work done by @samp{-k} will be
1721 performed at the end of all the downloads.
1723 @cindex backing up converted files
1725 @itemx --backup-converted
1726 When converting a file, back up the original version with a @samp{.orig}
1727 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1732 Turn on options suitable for mirroring. This option turns on recursion
1733 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1734 directory listings. It is currently equivalent to
1735 @samp{-r -N -l inf --no-remove-listing}.
1737 @cindex page requisites
1738 @cindex required images, downloading
1740 @itemx --page-requisites
1741 This option causes Wget to download all the files that are necessary to
1742 properly display a given @sc{html} page. This includes such things as
1743 inlined images, sounds, and referenced stylesheets.
1745 Ordinarily, when downloading a single @sc{html} page, any requisite documents
1746 that may be needed to display it properly are not downloaded. Using
1747 @samp{-r} together with @samp{-l} can help, but since Wget does not
1748 ordinarily distinguish between external and inlined documents, one is
1749 generally left with ``leaf documents'' that are missing their
1752 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1753 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1754 document @file{2.html}. Say that @file{2.html} is similar but that its
1755 image is @file{2.gif} and it links to @file{3.html}. Say this
1756 continues up to some arbitrarily high number.
1758 If one executes the command:
1761 wget -r -l 2 http://@var{site}/1.html
1764 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1765 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1766 without its requisite @file{3.gif} because Wget is simply counting the
1767 number of hops (up to 2) away from @file{1.html} in order to determine
1768 where to stop the recursion. However, with this command:
1771 wget -r -l 2 -p http://@var{site}/1.html
1774 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1775 will be downloaded. Similarly,
1778 wget -r -l 1 -p http://@var{site}/1.html
1781 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1782 to be downloaded. One might think that:
1785 wget -r -l 0 -p http://@var{site}/1.html
1788 would download just @file{1.html} and @file{1.gif}, but unfortunately
1789 this is not the case, because @samp{-l 0} is equivalent to
1790 @samp{-l inf}---that is, infinite recursion. To download a single @sc{html}
1791 page (or a handful of them, all specified on the command-line or in a
1792 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1793 @samp{-r} and @samp{-l}:
1796 wget -p http://@var{site}/1.html
1799 Note that Wget will behave as if @samp{-r} had been specified, but only
1800 that single page and its requisites will be downloaded. Links from that
1801 page to external documents will not be followed. Actually, to download
1802 a single page and all its requisites (even if they exist on separate
1803 websites), and make sure the lot displays properly locally, this author
1804 likes to use a few options in addition to @samp{-p}:
1807 wget -E -H -k -K -p http://@var{site}/@var{document}
1810 To finish off this topic, it's worth knowing that Wget's idea of an
1811 external document link is any URL specified in an @code{<A>} tag, an
1812 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1815 @cindex @sc{html} comments
1816 @cindex comments, @sc{html}
1817 @item --strict-comments
1818 Turn on strict parsing of @sc{html} comments. The default is to terminate
1819 comments at the first occurrence of @samp{-->}.
1821 According to specifications, @sc{html} comments are expressed as @sc{sgml}
1822 @dfn{declarations}. Declaration is special markup that begins with
1823 @samp{<!} and ends with @samp{>}, such as @samp{<!DOCTYPE ...>}, that
1824 may contain comments between a pair of @samp{--} delimiters. @sc{html}
1825 comments are ``empty declarations'', @sc{sgml} declarations without any
1826 non-comment text. Therefore, @samp{<!--foo-->} is a valid comment, and
1827 so is @samp{<!--one-- --two-->}, but @samp{<!--1--2-->} is not.
1829 On the other hand, most @sc{html} writers don't perceive comments as anything
1830 other than text delimited with @samp{<!--} and @samp{-->}, which is not
1831 quite the same. For example, something like @samp{<!------------>}
1832 works as a valid comment as long as the number of dashes is a multiple
1833 of four (!). If not, the comment technically lasts until the next
1834 @samp{--}, which may be at the other end of the document. Because of
1835 this, many popular browsers completely ignore the specification and
1836 implement what users have come to expect: comments delimited with
1837 @samp{<!--} and @samp{-->}.
1839 Until version 1.9, Wget interpreted comments strictly, which resulted in
1840 missing links in many web pages that displayed fine in browsers, but had
1841 the misfortune of containing non-compliant comments. Beginning with
1842 version 1.9, Wget has joined the ranks of clients that implements
1843 ``naive'' comments, terminating each comment at the first occurrence of
1846 If, for whatever reason, you want strict comment parsing, use this
1847 option to turn it on.
1850 @node Recursive Accept/Reject Options
1851 @section Recursive Accept/Reject Options
1854 @item -A @var{acclist} --accept @var{acclist}
1855 @itemx -R @var{rejlist} --reject @var{rejlist}
1856 Specify comma-separated lists of file name suffixes or patterns to
1857 accept or reject (@pxref{Types of Files}). Note that if
1858 any of the wildcard characters, @samp{*}, @samp{?}, @samp{[} or
1859 @samp{]}, appear in an element of @var{acclist} or @var{rejlist},
1860 it will be treated as a pattern, rather than a suffix.
1862 @item -D @var{domain-list}
1863 @itemx --domains=@var{domain-list}
1864 Set domains to be followed. @var{domain-list} is a comma-separated list
1865 of domains. Note that it does @emph{not} turn on @samp{-H}.
1867 @item --exclude-domains @var{domain-list}
1868 Specify the domains that are @emph{not} to be followed.
1869 (@pxref{Spanning Hosts}).
1871 @cindex follow FTP links
1873 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1874 Wget will ignore all the @sc{ftp} links.
1876 @cindex tag-based recursive pruning
1877 @item --follow-tags=@var{list}
1878 Wget has an internal table of @sc{html} tag / attribute pairs that it
1879 considers when looking for linked documents during a recursive
1880 retrieval. If a user wants only a subset of those tags to be
1881 considered, however, he or she should be specify such tags in a
1882 comma-separated @var{list} with this option.
1884 @item --ignore-tags=@var{list}
1885 This is the opposite of the @samp{--follow-tags} option. To skip
1886 certain @sc{html} tags when recursively looking for documents to download,
1887 specify them in a comma-separated @var{list}.
1889 In the past, this option was the best bet for downloading a single page
1890 and its requisites, using a command-line like:
1893 wget --ignore-tags=a,area -H -k -K -r http://@var{site}/@var{document}
1896 However, the author of this option came across a page with tags like
1897 @code{<LINK REL="home" HREF="/">} and came to the realization that
1898 specifying tags to ignore was not enough. One can't just tell Wget to
1899 ignore @code{<LINK>}, because then stylesheets will not be downloaded.
1900 Now the best bet for downloading a single page and its requisites is the
1901 dedicated @samp{--page-requisites} option.
1906 Ignore case when matching files and directories. This influences the
1907 behavior of -R, -A, -I, and -X options, as well as globbing
1908 implemented when downloading from FTP sites. For example, with this
1909 option, @samp{-A *.txt} will match @samp{file1.txt}, but also
1910 @samp{file2.TXT}, @samp{file3.TxT}, and so on.
1914 Enable spanning across hosts when doing recursive retrieving
1915 (@pxref{Spanning Hosts}).
1919 Follow relative links only. Useful for retrieving a specific home page
1920 without any distractions, not even those from the same hosts
1921 (@pxref{Relative Links}).
1924 @itemx --include-directories=@var{list}
1925 Specify a comma-separated list of directories you wish to follow when
1926 downloading (@pxref{Directory-Based Limits}). Elements
1927 of @var{list} may contain wildcards.
1930 @itemx --exclude-directories=@var{list}
1931 Specify a comma-separated list of directories you wish to exclude from
1932 download (@pxref{Directory-Based Limits}). Elements of
1933 @var{list} may contain wildcards.
1937 Do not ever ascend to the parent directory when retrieving recursively.
1938 This is a useful option, since it guarantees that only the files
1939 @emph{below} a certain hierarchy will be downloaded.
1940 @xref{Directory-Based Limits}, for more details.
1945 @node Recursive Download
1946 @chapter Recursive Download
1949 @cindex recursive download
1951 GNU Wget is capable of traversing parts of the Web (or a single
1952 @sc{http} or @sc{ftp} server), following links and directory structure.
1953 We refer to this as to @dfn{recursive retrieval}, or @dfn{recursion}.
1955 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} or
1956 @sc{css} from the given @sc{url}, retrieving the files the document
1957 refers to, through markup like @code{href} or @code{src}, or @sc{css}
1958 @sc{uri} values specified using the @samp{url()} functional notation.
1959 If the freshly downloaded file is also of type @code{text/html},
1960 @code{application/xhtml+xml}, or @code{text/css}, it will be parsed
1961 and followed further.
1963 Recursive retrieval of @sc{http} and @sc{html}/@sc{css} content is
1964 @dfn{breadth-first}. This means that Wget first downloads the requested
1965 document, then the documents linked from that document, then the
1966 documents linked by them, and so on. In other words, Wget first
1967 downloads the documents at depth 1, then those at depth 2, and so on
1968 until the specified maximum depth.
1970 The maximum @dfn{depth} to which the retrieval may descend is specified
1971 with the @samp{-l} option. The default maximum depth is five layers.
1973 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1974 the data from the given directory tree (including the subdirectories up
1975 to the specified depth) on the remote server, creating its mirror image
1976 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1977 parameter. Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1980 By default, Wget will create a local directory tree, corresponding to
1981 the one found on the remote server.
1983 Recursive retrieving can find a number of applications, the most
1984 important of which is mirroring. It is also useful for @sc{www}
1985 presentations, and any other opportunities where slow network
1986 connections should be bypassed by storing the files locally.
1988 You should be warned that recursive downloads can overload the remote
1989 servers. Because of that, many administrators frown upon them and may
1990 ban access from your site if they detect very fast downloads of big
1991 amounts of content. When downloading from Internet servers, consider
1992 using the @samp{-w} option to introduce a delay between accesses to the
1993 server. The download will take a while longer, but the server
1994 administrator will not be alarmed by your rudeness.
1996 Of course, recursive download may cause problems on your machine. If
1997 left to run unchecked, it can easily fill up the disk. If downloading
1998 from local network, it can also take bandwidth on the system, as well as
1999 consume memory and CPU.
2001 Try to specify the criteria that match the kind of download you are
2002 trying to achieve. If you want to download only one page, use
2003 @samp{--page-requisites} without any additional recursion. If you want
2004 to download things under one directory, use @samp{-np} to avoid
2005 downloading things from other directories. If you want to download all
2006 the files from one directory, use @samp{-l 1} to make sure the recursion
2007 depth never exceeds one. @xref{Following Links}, for more information
2010 Recursive retrieval should be used with care. Don't say you were not
2013 @node Following Links
2014 @chapter Following Links
2016 @cindex following links
2018 When retrieving recursively, one does not wish to retrieve loads of
2019 unnecessary data. Most of the time the users bear in mind exactly what
2020 they want to download, and want Wget to follow only specific links.
2022 For example, if you wish to download the music archive from
2023 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
2024 that happen to be referenced by an obscure part of the archive.
2026 Wget possesses several mechanisms that allows you to fine-tune which
2027 links it will follow.
2030 * Spanning Hosts:: (Un)limiting retrieval based on host name.
2031 * Types of Files:: Getting only certain files.
2032 * Directory-Based Limits:: Getting only certain directories.
2033 * Relative Links:: Follow relative links only.
2034 * FTP Links:: Following FTP links.
2037 @node Spanning Hosts
2038 @section Spanning Hosts
2039 @cindex spanning hosts
2040 @cindex hosts, spanning
2042 Wget's recursive retrieval normally refuses to visit hosts different
2043 than the one you specified on the command line. This is a reasonable
2044 default; without it, every retrieval would have the potential to turn
2045 your Wget into a small version of google.
2047 However, visiting different hosts, or @dfn{host spanning,} is sometimes
2048 a useful option. Maybe the images are served from a different server.
2049 Maybe you're mirroring a site that consists of pages interlinked between
2050 three servers. Maybe the server has two equivalent names, and the @sc{html}
2051 pages refer to both interchangeably.
2054 @item Span to any host---@samp{-H}
2056 The @samp{-H} option turns on host spanning, thus allowing Wget's
2057 recursive run to visit any host referenced by a link. Unless sufficient
2058 recursion-limiting criteria are applied depth, these foreign hosts will
2059 typically link to yet more hosts, and so on until Wget ends up sucking
2060 up much more data than you have intended.
2062 @item Limit spanning to certain domains---@samp{-D}
2064 The @samp{-D} option allows you to specify the domains that will be
2065 followed, thus limiting the recursion only to the hosts that belong to
2066 these domains. Obviously, this makes sense only in conjunction with
2067 @samp{-H}. A typical example would be downloading the contents of
2068 @samp{www.server.com}, but allowing downloads from
2069 @samp{images.server.com}, etc.:
2072 wget -rH -Dserver.com http://www.server.com/
2075 You can specify more than one address by separating them with a comma,
2076 e.g. @samp{-Ddomain1.com,domain2.com}.
2078 @item Keep download off certain domains---@samp{--exclude-domains}
2080 If there are domains you want to exclude specifically, you can do it
2081 with @samp{--exclude-domains}, which accepts the same type of arguments
2082 of @samp{-D}, but will @emph{exclude} all the listed domains. For
2083 example, if you want to download all the hosts from @samp{foo.edu}
2084 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
2088 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
2094 @node Types of Files
2095 @section Types of Files
2096 @cindex types of files
2098 When downloading material from the web, you will often want to restrict
2099 the retrieval to only certain file types. For example, if you are
2100 interested in downloading @sc{gif}s, you will not be overjoyed to get
2101 loads of PostScript documents, and vice versa.
2103 Wget offers two options to deal with this problem. Each option
2104 description lists a short name, a long name, and the equivalent command
2107 @cindex accept wildcards
2108 @cindex accept suffixes
2109 @cindex wildcards, accept
2110 @cindex suffixes, accept
2112 @item -A @var{acclist}
2113 @itemx --accept @var{acclist}
2114 @itemx accept = @var{acclist}
2115 The argument to @samp{--accept} option is a list of file suffixes or
2116 patterns that Wget will download during recursive retrieval. A suffix
2117 is the ending part of a file, and consists of ``normal'' letters,
2118 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
2119 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
2121 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
2122 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
2123 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
2124 download only files beginning with @samp{zelazny} and containing numbers
2125 from 1960 to 1969 anywhere within. Look up the manual of your shell for
2126 a description of how pattern matching works.
2128 Of course, any number of suffixes and patterns can be combined into a
2129 comma-separated list, and given as an argument to @samp{-A}.
2131 @cindex reject wildcards
2132 @cindex reject suffixes
2133 @cindex wildcards, reject
2134 @cindex suffixes, reject
2135 @item -R @var{rejlist}
2136 @itemx --reject @var{rejlist}
2137 @itemx reject = @var{rejlist}
2138 The @samp{--reject} option works the same way as @samp{--accept}, only
2139 its logic is the reverse; Wget will download all files @emph{except} the
2140 ones matching the suffixes (or patterns) in the list.
2142 So, if you want to download a whole page except for the cumbersome
2143 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
2144 Analogously, to download all files except the ones beginning with
2145 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
2146 expansion by the shell.
2150 The @samp{-A} and @samp{-R} options may be combined to achieve even
2151 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
2152 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
2153 a part of their name, but @emph{not} the PostScript files.
2155 Note that these two options do not affect the downloading of @sc{html}
2156 files (as determined by a @samp{.htm} or @samp{.html} filename
2157 prefix). This behavior may not be desirable for all users, and may be
2158 changed for future versions of Wget.
2160 Note, too, that query strings (strings at the end of a URL beginning
2161 with a question mark (@samp{?}) are not included as part of the
2162 filename for accept/reject rules, even though these will actually
2163 contribute to the name chosen for the local file. It is expected that
2164 a future version of Wget will provide an option to allow matching
2165 against query strings.
2167 Finally, it's worth noting that the accept/reject lists are matched
2168 @emph{twice} against downloaded files: once against the URL's filename
2169 portion, to determine if the file should be downloaded in the first
2170 place; then, after it has been accepted and successfully downloaded,
2171 the local file's name is also checked against the accept/reject lists
2172 to see if it should be removed. The rationale was that, since
2173 @samp{.htm} and @samp{.html} files are always downloaded regardless of
2174 accept/reject rules, they should be removed @emph{after} being
2175 downloaded and scanned for links, if they did match the accept/reject
2176 lists. However, this can lead to unexpected results, since the local
2177 filenames can differ from the original URL filenames in the following
2178 ways, all of which can change whether an accept/reject rule matches:
2182 If the local file already exists and @samp{--no-directories} was
2183 specified, a numeric suffix will be appended to the original name.
2185 If @samp{--html-extension} was specified, the local filename will have
2186 @samp{.html} appended to it. If Wget is invoked with @samp{-E -A.php},
2187 a filename such as @samp{index.php} will match be accepted, but upon
2188 download will be named @samp{index.php.html}, which no longer matches,
2189 and so the file will be deleted.
2191 Query strings do not contribute to URL matching, but are included in
2192 local filenames, and so @emph{do} contribute to filename matching.
2196 This behavior, too, is considered less-than-desirable, and may change
2197 in a future version of Wget.
2199 @node Directory-Based Limits
2200 @section Directory-Based Limits
2202 @cindex directory limits
2204 Regardless of other link-following facilities, it is often useful to
2205 place the restriction of what files to retrieve based on the directories
2206 those files are placed in. There can be many reasons for this---the
2207 home pages may be organized in a reasonable directory structure; or some
2208 directories may contain useless information, e.g. @file{/cgi-bin} or
2209 @file{/dev} directories.
2211 Wget offers three different options to deal with this requirement. Each
2212 option description lists a short name, a long name, and the equivalent
2213 command in @file{.wgetrc}.
2215 @cindex directories, include
2216 @cindex include directories
2217 @cindex accept directories
2220 @itemx --include @var{list}
2221 @itemx include_directories = @var{list}
2222 @samp{-I} option accepts a comma-separated list of directories included
2223 in the retrieval. Any other directories will simply be ignored. The
2224 directories are absolute paths.
2226 So, if you wish to download from @samp{http://host/people/bozo/}
2227 following only links to bozo's colleagues in the @file{/people}
2228 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
2231 wget -I /people,/cgi-bin http://host/people/bozo/
2234 @cindex directories, exclude
2235 @cindex exclude directories
2236 @cindex reject directories
2238 @itemx --exclude @var{list}
2239 @itemx exclude_directories = @var{list}
2240 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
2241 directories @emph{excluded} from the download. E.g. if you do not want
2242 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
2243 /cgi-bin} on the command line.
2245 The same as with @samp{-A}/@samp{-R}, these two options can be combined
2246 to get a better fine-tuning of downloading subdirectories. E.g. if you
2247 want to load all the files from @file{/pub} hierarchy except for
2248 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
2253 @itemx no_parent = on
2254 The simplest, and often very useful way of limiting directories is
2255 disallowing retrieval of the links that refer to the hierarchy
2256 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
2257 parent directory/directories.
2259 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
2260 Using it guarantees that you will never leave the existing hierarchy.
2261 Supposing you issue Wget with:
2264 wget -r --no-parent http://somehost/~luzer/my-archive/
2267 You may rest assured that none of the references to
2268 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
2269 followed. Only the archive you are interested in will be downloaded.
2270 Essentially, @samp{--no-parent} is similar to
2271 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
2272 intelligent fashion.
2274 @strong{Note} that, for HTTP (and HTTPS), the trailing slash is very
2275 important to @samp{--no-parent}. HTTP has no concept of a ``directory''---Wget
2276 relies on you to indicate what's a directory and what isn't. In
2277 @samp{http://foo/bar/}, Wget will consider @samp{bar} to be a
2278 directory, while in @samp{http://foo/bar} (no trailing slash),
2279 @samp{bar} will be considered a filename (so @samp{--no-parent} would be
2280 meaningless, as its parent is @samp{/}).
2283 @node Relative Links
2284 @section Relative Links
2285 @cindex relative links
2287 When @samp{-L} is turned on, only the relative links are ever followed.
2288 Relative links are here defined those that do not refer to the web
2289 server root. For example, these links are relative:
2293 <a href="foo/bar.gif">
2294 <a href="../foo/bar.gif">
2297 These links are not relative:
2301 <a href="/foo/bar.gif">
2302 <a href="http://www.server.com/foo/bar.gif">
2305 Using this option guarantees that recursive retrieval will not span
2306 hosts, even without @samp{-H}. In simple cases it also allows downloads
2307 to ``just work'' without having to convert links.
2309 This option is probably not very useful and might be removed in a future
2313 @section Following FTP Links
2314 @cindex following ftp links
2316 The rules for @sc{ftp} are somewhat specific, as it is necessary for
2317 them to be. @sc{ftp} links in @sc{html} documents are often included
2318 for purposes of reference, and it is often inconvenient to download them
2321 To have @sc{ftp} links followed from @sc{html} documents, you need to
2322 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
2323 links will span hosts regardless of @samp{-H} setting. This is logical,
2324 as @sc{ftp} links rarely point to the same host where the @sc{http}
2325 server resides. For similar reasons, the @samp{-L} options has no
2326 effect on such downloads. On the other hand, domain acceptance
2327 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
2329 Also note that followed links to @sc{ftp} directories will not be
2330 retrieved recursively further.
2333 @chapter Time-Stamping
2334 @cindex time-stamping
2335 @cindex timestamping
2336 @cindex updating the archives
2337 @cindex incremental updating
2339 One of the most important aspects of mirroring information from the
2340 Internet is updating your archives.
2342 Downloading the whole archive again and again, just to replace a few
2343 changed files is expensive, both in terms of wasted bandwidth and money,
2344 and the time to do the update. This is why all the mirroring tools
2345 offer the option of incremental updating.
2347 Such an updating mechanism means that the remote server is scanned in
2348 search of @dfn{new} files. Only those new files will be downloaded in
2349 the place of the old ones.
2351 A file is considered new if one of these two conditions are met:
2355 A file of that name does not already exist locally.
2358 A file of that name does exist, but the remote file was modified more
2359 recently than the local file.
2362 To implement this, the program needs to be aware of the time of last
2363 modification of both local and remote files. We call this information the
2364 @dfn{time-stamp} of a file.
2366 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
2367 (@samp{-N}) option, or through @code{timestamping = on} directive in
2368 @file{.wgetrc}. With this option, for each file it intends to download,
2369 Wget will check whether a local file of the same name exists. If it
2370 does, and the remote file is older, Wget will not download it.
2372 If the local file does not exist, or the sizes of the files do not
2373 match, Wget will download the remote file no matter what the time-stamps
2377 * Time-Stamping Usage::
2378 * HTTP Time-Stamping Internals::
2379 * FTP Time-Stamping Internals::
2382 @node Time-Stamping Usage
2383 @section Time-Stamping Usage
2384 @cindex time-stamping usage
2385 @cindex usage, time-stamping
2387 The usage of time-stamping is simple. Say you would like to download a
2388 file so that it keeps its date of modification.
2391 wget -S http://www.gnu.ai.mit.edu/
2394 A simple @code{ls -l} shows that the time stamp on the local file equals
2395 the state of the @code{Last-Modified} header, as returned by the server.
2396 As you can see, the time-stamping info is preserved locally, even
2397 without @samp{-N} (at least for @sc{http}).
2399 Several days later, you would like Wget to check if the remote file has
2400 changed, and download it if it has.
2403 wget -N http://www.gnu.ai.mit.edu/
2406 Wget will ask the server for the last-modified date. If the local file
2407 has the same timestamp as the server, or a newer one, the remote file
2408 will not be re-fetched. However, if the remote file is more recent,
2409 Wget will proceed to fetch it.
2411 The same goes for @sc{ftp}. For example:
2414 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
2417 (The quotes around that URL are to prevent the shell from trying to
2418 interpret the @samp{*}.)
2420 After download, a local directory listing will show that the timestamps
2421 match those on the remote server. Reissuing the command with @samp{-N}
2422 will make Wget re-fetch @emph{only} the files that have been modified
2423 since the last download.
2425 If you wished to mirror the GNU archive every week, you would use a
2426 command like the following, weekly:
2429 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
2432 Note that time-stamping will only work for files for which the server
2433 gives a timestamp. For @sc{http}, this depends on getting a
2434 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
2435 directory listing with dates in a format that Wget can parse
2436 (@pxref{FTP Time-Stamping Internals}).
2438 @node HTTP Time-Stamping Internals
2439 @section HTTP Time-Stamping Internals
2440 @cindex http time-stamping
2442 Time-stamping in @sc{http} is implemented by checking of the
2443 @code{Last-Modified} header. If you wish to retrieve the file
2444 @file{foo.html} through @sc{http}, Wget will check whether
2445 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
2446 retrieved unconditionally.
2448 If the file does exist locally, Wget will first check its local
2449 time-stamp (similar to the way @code{ls -l} checks it), and then send a
2450 @code{HEAD} request to the remote server, demanding the information on
2453 The @code{Last-Modified} header is examined to find which file was
2454 modified more recently (which makes it ``newer''). If the remote file
2455 is newer, it will be downloaded; if it is older, Wget will give
2456 up.@footnote{As an additional check, Wget will look at the
2457 @code{Content-Length} header, and compare the sizes; if they are not the
2458 same, the remote file will be downloaded no matter what the time-stamp
2461 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
2462 with @samp{-N}, server file @samp{@var{X}} is compared to local file
2463 @samp{@var{X}.orig}, if extant, rather than being compared to local file
2464 @samp{@var{X}}, which will always differ if it's been converted by
2465 @samp{--convert-links} (@samp{-k}).
2467 Arguably, @sc{http} time-stamping should be implemented using the
2468 @code{If-Modified-Since} request.
2470 @node FTP Time-Stamping Internals
2471 @section FTP Time-Stamping Internals
2472 @cindex ftp time-stamping
2474 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
2475 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
2478 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
2479 @sc{ftp} @code{LIST} command to get a file listing for the directory
2480 containing the desired file(s). It will try to analyze the listing,
2481 treating it like Unix @code{ls -l} output, extracting the time-stamps.
2482 The rest is exactly the same as for @sc{http}. Note that when
2483 retrieving individual files from an @sc{ftp} server without using
2484 globbing or recursion, listing files will not be downloaded (and thus
2485 files will not be time-stamped) unless @samp{-N} is specified.
2487 Assumption that every directory listing is a Unix-style listing may
2488 sound extremely constraining, but in practice it is not, as many
2489 non-Unix @sc{ftp} servers use the Unixoid listing format because most
2490 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
2491 defines no standard way to get a file list, let alone the time-stamps.
2492 We can only hope that a future standard will define this.
2494 Another non-standard solution includes the use of @code{MDTM} command
2495 that is supported by some @sc{ftp} servers (including the popular
2496 @code{wu-ftpd}), which returns the exact time of the specified file.
2497 Wget may support this command in the future.
2500 @chapter Startup File
2501 @cindex startup file
2507 Once you know how to change default settings of Wget through command
2508 line arguments, you may wish to make some of those settings permanent.
2509 You can do that in a convenient way by creating the Wget startup
2510 file---@file{.wgetrc}.
2512 Besides @file{.wgetrc} is the ``main'' initialization file, it is
2513 convenient to have a special facility for storing passwords. Thus Wget
2514 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
2515 it. You can find @file{.netrc} format in your system manuals.
2517 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
2521 * Wgetrc Location:: Location of various wgetrc files.
2522 * Wgetrc Syntax:: Syntax of wgetrc.
2523 * Wgetrc Commands:: List of available commands.
2524 * Sample Wgetrc:: A wgetrc example.
2527 @node Wgetrc Location
2528 @section Wgetrc Location
2529 @cindex wgetrc location
2530 @cindex location of wgetrc
2532 When initializing, Wget will look for a @dfn{global} startup file,
2533 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
2534 @file{/usr/local}, if Wget was not installed there) and read commands
2535 from there, if it exists.
2537 Then it will look for the user's file. If the environmental variable
2538 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
2539 further attempts will be made.
2541 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
2543 The fact that user's settings are loaded after the system-wide ones
2544 means that in case of collision user's wgetrc @emph{overrides} the
2545 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
2546 Fascist admins, away!
2549 @section Wgetrc Syntax
2550 @cindex wgetrc syntax
2551 @cindex syntax of wgetrc
2553 The syntax of a wgetrc command is simple:
2559 The @dfn{variable} will also be called @dfn{command}. Valid
2560 @dfn{values} are different for different commands.
2562 The commands are case-insensitive and underscore-insensitive. Thus
2563 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
2564 beginning with @samp{#} and lines containing white-space only are
2567 Commands that expect a comma-separated list will clear the list on an
2568 empty command. So, if you wish to reset the rejection list specified in
2569 global @file{wgetrc}, you can do it with:
2575 @node Wgetrc Commands
2576 @section Wgetrc Commands
2577 @cindex wgetrc commands
2579 The complete set of commands is listed below. Legal values are listed
2580 after the @samp{=}. Simple Boolean values can be set or unset using
2581 @samp{on} and @samp{off} or @samp{1} and @samp{0}.
2583 Some commands take pseudo-arbitrary values. @var{address} values can be
2584 hostnames or dotted-quad IP addresses. @var{n} can be any positive
2585 integer, or @samp{inf} for infinity, where appropriate. @var{string}
2586 values can be any non-empty string.
2588 Most of these commands have direct command-line equivalents. Also, any
2589 wgetrc command can be specified on the command line using the
2590 @samp{--execute} switch (@pxref{Basic Startup Options}.)
2593 @item accept/reject = @var{string}
2594 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
2596 @item add_hostdir = on/off
2597 Enable/disable host-prefixed file names. @samp{-nH} disables it.
2599 @item background = on/off
2600 Enable/disable going to background---the same as @samp{-b} (which
2603 @item backup_converted = on/off
2604 Enable/disable saving pre-converted files with the suffix
2605 @samp{.orig}---the same as @samp{-K} (which enables it).
2607 @c @item backups = @var{number}
2608 @c #### Document me!
2610 @item base = @var{string}
2611 Consider relative @sc{url}s in @sc{url} input files forced to be
2612 interpreted as @sc{html} as being relative to @var{string}---the same as
2613 @samp{--base=@var{string}}.
2615 @item bind_address = @var{address}
2616 Bind to @var{address}, like the @samp{--bind-address=@var{address}}.
2618 @item ca_certificate = @var{file}
2619 Set the certificate authority bundle file to @var{file}. The same
2620 as @samp{--ca-certificate=@var{file}}.
2622 @item ca_directory = @var{directory}
2623 Set the directory used for certificate authorities. The same as
2624 @samp{--ca-directory=@var{directory}}.
2626 @item cache = on/off
2627 When set to off, disallow server-caching. See the @samp{--no-cache}
2630 @item certificate = @var{file}
2631 Set the client certificate file name to @var{file}. The same as
2632 @samp{--certificate=@var{file}}.
2634 @item certificate_type = @var{string}
2635 Specify the type of the client certificate, legal values being
2636 @samp{PEM} (the default) and @samp{DER} (aka ASN1). The same as
2637 @samp{--certificate-type=@var{string}}.
2639 @item check_certificate = on/off
2640 If this is set to off, the server certificate is not checked against
2641 the specified client authorities. The default is ``on''. The same as
2642 @samp{--check-certificate}.
2644 @item connect_timeout = @var{n}
2645 Set the connect timeout---the same as @samp{--connect-timeout}.
2647 @item content_disposition = on/off
2648 Turn on recognition of the (non-standard) @samp{Content-Disposition}
2649 HTTP header---if set to @samp{on}, the same as @samp{--content-disposition}.
2651 @item continue = on/off
2652 If set to on, force continuation of preexistent partially retrieved
2653 files. See @samp{-c} before setting it.
2655 @item convert_links = on/off
2656 Convert non-relative links locally. The same as @samp{-k}.
2658 @item cookies = on/off
2659 When set to off, disallow cookies. See the @samp{--cookies} option.
2661 @item cut_dirs = @var{n}
2662 Ignore @var{n} remote directory components. Equivalent to
2663 @samp{--cut-dirs=@var{n}}.
2665 @item debug = on/off
2666 Debug mode, same as @samp{-d}.
2668 @item delete_after = on/off
2669 Delete after download---the same as @samp{--delete-after}.
2671 @item dir_prefix = @var{string}
2672 Top of directory tree---the same as @samp{-P @var{string}}.
2674 @item dirstruct = on/off
2675 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2678 @item dns_cache = on/off
2679 Turn DNS caching on/off. Since DNS caching is on by default, this
2680 option is normally used to turn it off and is equivalent to
2681 @samp{--no-dns-cache}.
2683 @item dns_timeout = @var{n}
2684 Set the DNS timeout---the same as @samp{--dns-timeout}.
2686 @item domains = @var{string}
2687 Same as @samp{-D} (@pxref{Spanning Hosts}).
2689 @item dot_bytes = @var{n}
2690 Specify the number of bytes ``contained'' in a dot, as seen throughout
2691 the retrieval (1024 by default). You can postfix the value with
2692 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2693 respectively. With dot settings you can tailor the dot retrieval to
2694 suit your needs, or you can use the predefined @dfn{styles}
2695 (@pxref{Download Options}).
2697 @item dot_spacing = @var{n}
2698 Specify the number of dots in a single cluster (10 by default).
2700 @item dots_in_line = @var{n}
2701 Specify the number of dots that will be printed in each line throughout
2702 the retrieval (50 by default).
2704 @item egd_file = @var{file}
2705 Use @var{string} as the EGD socket file name. The same as
2706 @samp{--egd-file=@var{file}}.
2708 @item exclude_directories = @var{string}
2709 Specify a comma-separated list of directories you wish to exclude from
2710 download---the same as @samp{-X @var{string}} (@pxref{Directory-Based
2713 @item exclude_domains = @var{string}
2714 Same as @samp{--exclude-domains=@var{string}} (@pxref{Spanning
2717 @item follow_ftp = on/off
2718 Follow @sc{ftp} links from @sc{html} documents---the same as
2719 @samp{--follow-ftp}.
2721 @item follow_tags = @var{string}
2722 Only follow certain @sc{html} tags when doing a recursive retrieval,
2723 just like @samp{--follow-tags=@var{string}}.
2725 @item force_html = on/off
2726 If set to on, force the input filename to be regarded as an @sc{html}
2727 document---the same as @samp{-F}.
2729 @item ftp_password = @var{string}
2730 Set your @sc{ftp} password to @var{string}. Without this setting, the
2731 password defaults to @samp{-wget@@}, which is a useful default for
2732 anonymous @sc{ftp} access.
2734 This command used to be named @code{passwd} prior to Wget 1.10.
2736 @item ftp_proxy = @var{string}
2737 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2740 @item ftp_user = @var{string}
2741 Set @sc{ftp} user to @var{string}.
2743 This command used to be named @code{login} prior to Wget 1.10.
2746 Turn globbing on/off---the same as @samp{--glob} and @samp{--no-glob}.
2748 @item header = @var{string}
2749 Define a header for HTTP downloads, like using
2750 @samp{--header=@var{string}}.
2752 @item html_extension = on/off
2753 Add a @samp{.html} extension to @samp{text/html} or
2754 @samp{application/xhtml+xml} files without it, or a @samp{.css}
2755 extension to @samp{text/css} files without it, like @samp{-E}.
2757 @item http_keep_alive = on/off
2758 Turn the keep-alive feature on or off (defaults to on). Turning it
2759 off is equivalent to @samp{--no-http-keep-alive}.
2761 @item http_password = @var{string}
2762 Set @sc{http} password, equivalent to
2763 @samp{--http-password=@var{string}}.
2765 @item http_proxy = @var{string}
2766 Use @var{string} as @sc{http} proxy, instead of the one specified in
2769 @item http_user = @var{string}
2770 Set @sc{http} user to @var{string}, equivalent to
2771 @samp{--http-user=@var{string}}.
2773 @item https_proxy = @var{string}
2774 Use @var{string} as @sc{https} proxy, instead of the one specified in
2777 @item ignore_case = on/off
2778 When set to on, match files and directories case insensitively; the
2779 same as @samp{--ignore-case}.
2781 @item ignore_length = on/off
2782 When set to on, ignore @code{Content-Length} header; the same as
2783 @samp{--ignore-length}.
2785 @item ignore_tags = @var{string}
2786 Ignore certain @sc{html} tags when doing a recursive retrieval, like
2787 @samp{--ignore-tags=@var{string}}.
2789 @item include_directories = @var{string}
2790 Specify a comma-separated list of directories you wish to follow when
2791 downloading---the same as @samp{-I @var{string}}.
2793 @item inet4_only = on/off
2794 Force connecting to IPv4 addresses, off by default. You can put this
2795 in the global init file to disable Wget's attempts to resolve and
2796 connect to IPv6 hosts. Available only if Wget was compiled with IPv6
2797 support. The same as @samp{--inet4-only} or @samp{-4}.
2799 @item inet6_only = on/off
2800 Force connecting to IPv6 addresses, off by default. Available only if
2801 Wget was compiled with IPv6 support. The same as @samp{--inet6-only}
2804 @item input = @var{file}
2805 Read the @sc{url}s from @var{string}, like @samp{-i @var{file}}.
2807 @item limit_rate = @var{rate}
2808 Limit the download speed to no more than @var{rate} bytes per second.
2809 The same as @samp{--limit-rate=@var{rate}}.
2811 @item load_cookies = @var{file}
2812 Load cookies from @var{file}. See @samp{--load-cookies @var{file}}.
2814 @item logfile = @var{file}
2815 Set logfile to @var{file}, the same as @samp{-o @var{file}}.
2817 @item max_redirect = @var{number}
2818 Specifies the maximum number of redirections to follow for a resource.
2819 See @samp{--max-redirect=@var{number}}.
2821 @item mirror = on/off
2822 Turn mirroring on/off. The same as @samp{-m}.
2824 @item netrc = on/off
2825 Turn reading netrc on or off.
2827 @item no_clobber = on/off
2830 @item no_parent = on/off
2831 Disallow retrieving outside the directory hierarchy, like
2832 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2834 @item no_proxy = @var{string}
2835 Use @var{string} as the comma-separated list of domains to avoid in
2836 proxy loading, instead of the one specified in environment.
2838 @item output_document = @var{file}
2839 Set the output filename---the same as @samp{-O @var{file}}.
2841 @item page_requisites = on/off
2842 Download all ancillary documents necessary for a single @sc{html} page to
2843 display properly---the same as @samp{-p}.
2845 @item passive_ftp = on/off
2846 Change setting of passive @sc{ftp}, equivalent to the
2847 @samp{--passive-ftp} option.
2849 @itemx password = @var{string}
2850 Specify password @var{string} for both @sc{ftp} and @sc{http} file retrieval.
2851 This command can be overridden using the @samp{ftp_password} and
2852 @samp{http_password} command for @sc{ftp} and @sc{http} respectively.
2854 @item post_data = @var{string}
2855 Use POST as the method for all HTTP requests and send @var{string} in
2856 the request body. The same as @samp{--post-data=@var{string}}.
2858 @item post_file = @var{file}
2859 Use POST as the method for all HTTP requests and send the contents of
2860 @var{file} in the request body. The same as
2861 @samp{--post-file=@var{file}}.
2863 @item prefer_family = none/IPv4/IPv6
2864 When given a choice of several addresses, connect to the addresses
2865 with specified address family first. The address order returned by
2866 DNS is used without change by default. The same as @samp{--prefer-family},
2867 which see for a detailed discussion of why this is useful.
2869 @item private_key = @var{file}
2870 Set the private key file to @var{file}. The same as
2871 @samp{--private-key=@var{file}}.
2873 @item private_key_type = @var{string}
2874 Specify the type of the private key, legal values being @samp{PEM}
2875 (the default) and @samp{DER} (aka ASN1). The same as
2876 @samp{--private-type=@var{string}}.
2878 @item progress = @var{string}
2879 Set the type of the progress indicator. Legal types are @samp{dot}
2880 and @samp{bar}. Equivalent to @samp{--progress=@var{string}}.
2882 @item protocol_directories = on/off
2883 When set, use the protocol name as a directory component of local file
2884 names. The same as @samp{--protocol-directories}.
2886 @item proxy_password = @var{string}
2887 Set proxy authentication password to @var{string}, like
2888 @samp{--proxy-password=@var{string}}.
2890 @item proxy_user = @var{string}
2891 Set proxy authentication user name to @var{string}, like
2892 @samp{--proxy-user=@var{string}}.
2894 @item quiet = on/off
2895 Quiet mode---the same as @samp{-q}.
2897 @item quota = @var{quota}
2898 Specify the download quota, which is useful to put in the global
2899 @file{wgetrc}. When download quota is specified, Wget will stop
2900 retrieving after the download sum has become greater than quota. The
2901 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2902 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2903 to 5 megabytes. Note that the user's startup file overrides system
2906 @item random_file = @var{file}
2907 Use @var{file} as a source of randomness on systems lacking
2910 @item random_wait = on/off
2911 Turn random between-request wait times on or off. The same as
2912 @samp{--random-wait}.
2914 @item read_timeout = @var{n}
2915 Set the read (and write) timeout---the same as
2916 @samp{--read-timeout=@var{n}}.
2918 @item reclevel = @var{n}
2919 Recursion level (depth)---the same as @samp{-l @var{n}}.
2921 @item recursive = on/off
2922 Recursive on/off---the same as @samp{-r}.
2924 @item referer = @var{string}
2925 Set HTTP @samp{Referer:} header just like
2926 @samp{--referer=@var{string}}. (Note that it was the folks who wrote
2927 the @sc{http} spec who got the spelling of ``referrer'' wrong.)
2929 @item relative_only = on/off
2930 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2933 @item remove_listing = on/off
2934 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2935 to off is the same as @samp{--no-remove-listing}.
2937 @item restrict_file_names = unix/windows
2938 Restrict the file names generated by Wget from URLs. See
2939 @samp{--restrict-file-names} for a more detailed description.
2941 @item retr_symlinks = on/off
2942 When set to on, retrieve symbolic links as if they were plain files; the
2943 same as @samp{--retr-symlinks}.
2945 @item retry_connrefused = on/off
2946 When set to on, consider ``connection refused'' a transient
2947 error---the same as @samp{--retry-connrefused}.
2949 @item robots = on/off
2950 Specify whether the norobots convention is respected by Wget, ``on'' by
2951 default. This switch controls both the @file{/robots.txt} and the
2952 @samp{nofollow} aspect of the spec. @xref{Robot Exclusion}, for more
2953 details about this. Be sure you know what you are doing before turning
2956 @item save_cookies = @var{file}
2957 Save cookies to @var{file}. The same as @samp{--save-cookies
2960 @item secure_protocol = @var{string}
2961 Choose the secure protocol to be used. Legal values are @samp{auto}
2962 (the default), @samp{SSLv2}, @samp{SSLv3}, and @samp{TLSv1}. The same
2963 as @samp{--secure-protocol=@var{string}}.
2965 @item server_response = on/off
2966 Choose whether or not to print the @sc{http} and @sc{ftp} server
2967 responses---the same as @samp{-S}.
2969 @item span_hosts = on/off
2972 @item strict_comments = on/off
2973 Same as @samp{--strict-comments}.
2975 @item timeout = @var{n}
2976 Set all applicable timeout values to @var{n}, the same as @samp{-T
2979 @item timestamping = on/off
2980 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2982 @item tries = @var{n}
2983 Set number of retries per @sc{url}---the same as @samp{-t @var{n}}.
2985 @item use_proxy = on/off
2986 When set to off, don't use proxy even when proxy-related environment
2987 variables are set. In that case it is the same as using
2990 @item user = @var{string}
2991 Specify username @var{string} for both @sc{ftp} and @sc{http} file retrieval.
2992 This command can be overridden using the @samp{ftp_user} and
2993 @samp{http_user} command for @sc{ftp} and @sc{http} respectively.
2995 @item verbose = on/off
2996 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2998 @item wait = @var{n}
2999 Wait @var{n} seconds between retrievals---the same as @samp{-w
3002 @item wait_retry = @var{n}
3003 Wait up to @var{n} seconds between retries of failed retrievals
3004 only---the same as @samp{--waitretry=@var{n}}. Note that this is
3005 turned on by default in the global @file{wgetrc}.
3009 @section Sample Wgetrc
3010 @cindex sample wgetrc
3012 This is the sample initialization file, as given in the distribution.
3013 It is divided in two section---one for global usage (suitable for global
3014 startup file), and one for local usage (suitable for
3015 @file{$HOME/.wgetrc}). Be careful about the things you change.
3017 Note that almost all the lines are commented out. For a command to have
3018 any effect, you must remove the @samp{#} character at the beginning of
3022 @include sample.wgetrc.munged_for_texi_inclusion
3029 @c man begin EXAMPLES
3030 The examples are divided into three sections loosely based on their
3034 * Simple Usage:: Simple, basic usage of the program.
3035 * Advanced Usage:: Advanced tips.
3036 * Very Advanced Usage:: The hairy stuff.
3040 @section Simple Usage
3044 Say you want to download a @sc{url}. Just type:
3047 wget http://fly.srk.fer.hr/
3051 But what will happen if the connection is slow, and the file is lengthy?
3052 The connection will probably fail before the whole file is retrieved,
3053 more than once. In this case, Wget will try getting the file until it
3054 either gets the whole of it, or exceeds the default number of retries
3055 (this being 20). It is easy to change the number of tries to 45, to
3056 insure that the whole file will arrive safely:
3059 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
3063 Now let's leave Wget to work in the background, and write its progress
3064 to log file @file{log}. It is tiring to type @samp{--tries}, so we
3065 shall use @samp{-t}.
3068 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
3071 The ampersand at the end of the line makes sure that Wget works in the
3072 background. To unlimit the number of retries, use @samp{-t inf}.
3075 The usage of @sc{ftp} is as simple. Wget will take care of login and
3079 wget ftp://gnjilux.srk.fer.hr/welcome.msg
3083 If you specify a directory, Wget will retrieve the directory listing,
3084 parse it and convert it to @sc{html}. Try:
3087 wget ftp://ftp.gnu.org/pub/gnu/
3092 @node Advanced Usage
3093 @section Advanced Usage
3097 You have a file that contains the URLs you want to download? Use the
3104 If you specify @samp{-} as file name, the @sc{url}s will be read from
3108 Create a five levels deep mirror image of the GNU web site, with the
3109 same directory structure the original has, with only one try per
3110 document, saving the log of the activities to @file{gnulog}:
3113 wget -r http://www.gnu.org/ -o gnulog
3117 The same as the above, but convert the links in the downloaded files to
3118 point to local files, so you can view the documents off-line:
3121 wget --convert-links -r http://www.gnu.org/ -o gnulog
3125 Retrieve only one @sc{html} page, but make sure that all the elements needed
3126 for the page to be displayed, such as inline images and external style
3127 sheets, are also downloaded. Also make sure the downloaded page
3128 references the downloaded links.
3131 wget -p --convert-links http://www.server.com/dir/page.html
3134 The @sc{html} page will be saved to @file{www.server.com/dir/page.html}, and
3135 the images, stylesheets, etc., somewhere under @file{www.server.com/},
3136 depending on where they were on the remote server.
3139 The same as the above, but without the @file{www.server.com/} directory.
3140 In fact, I don't want to have all those random server directories
3141 anyway---just save @emph{all} those files under a @file{download/}
3142 subdirectory of the current directory.
3145 wget -p --convert-links -nH -nd -Pdownload \
3146 http://www.server.com/dir/page.html
3150 Retrieve the index.html of @samp{www.lycos.com}, showing the original
3154 wget -S http://www.lycos.com/
3158 Save the server headers with the file, perhaps for post-processing.
3161 wget --save-headers http://www.lycos.com/
3166 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
3170 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
3174 You want to download all the @sc{gif}s from a directory on an @sc{http}
3175 server. You tried @samp{wget http://www.server.com/dir/*.gif}, but that
3176 didn't work because @sc{http} retrieval does not support globbing. In
3180 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
3183 More verbose, but the effect is the same. @samp{-r -l1} means to
3184 retrieve recursively (@pxref{Recursive Download}), with maximum depth
3185 of 1. @samp{--no-parent} means that references to the parent directory
3186 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
3187 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
3191 Suppose you were in the middle of downloading, when Wget was
3192 interrupted. Now you do not want to clobber the files already present.
3196 wget -nc -r http://www.gnu.org/
3200 If you want to encode your own username and password to @sc{http} or
3201 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
3204 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
3207 Note, however, that this usage is not advisable on multi-user systems
3208 because it reveals your password to anyone who looks at the output of
3211 @cindex redirecting output
3213 You would like the output documents to go to standard output instead of
3217 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
3220 You can also combine the two options and make pipelines to retrieve the
3221 documents from remote hotlists:
3224 wget -O - http://cool.list.com/ | wget --force-html -i -
3228 @node Very Advanced Usage
3229 @section Very Advanced Usage
3234 If you wish Wget to keep a mirror of a page (or @sc{ftp}
3235 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
3236 for @samp{-r -l inf -N}. You can put Wget in the crontab file asking it
3237 to recheck a site each Sunday:
3241 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
3245 In addition to the above, you want the links to be converted for local
3246 viewing. But, after having read this manual, you know that link
3247 conversion doesn't play well with timestamping, so you also want Wget to
3248 back up the original @sc{html} files before the conversion. Wget invocation
3249 would look like this:
3252 wget --mirror --convert-links --backup-converted \
3253 http://www.gnu.org/ -o /home/me/weeklog
3257 But you've also noticed that local viewing doesn't work all that well
3258 when @sc{html} files are saved under extensions other than @samp{.html},
3259 perhaps because they were served as @file{index.cgi}. So you'd like
3260 Wget to rename all the files served with content-type @samp{text/html}
3261 or @samp{application/xhtml+xml} to @file{@var{name}.html}.
3264 wget --mirror --convert-links --backup-converted \
3265 --html-extension -o /home/me/weeklog \
3269 Or, with less typing:
3272 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
3281 This chapter contains all the stuff that could not fit anywhere else.
3284 * Proxies:: Support for proxy servers.
3285 * Distribution:: Getting the latest version.
3286 * Web Site:: GNU Wget's presence on the World Wide Web.
3287 * Mailing List:: Wget mailing list for announcements and discussion.
3288 * Internet Relay Chat:: Wget's presence on IRC.
3289 * Reporting Bugs:: How and where to report bugs.
3290 * Portability:: The systems Wget works on.
3291 * Signals:: Signal-handling performed by Wget.
3298 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
3299 data from remote servers to local clients. One typical use of proxies
3300 is lightening network load for users behind a slow connection. This is
3301 achieved by channeling all @sc{http} and @sc{ftp} requests through the
3302 proxy which caches the transferred data. When a cached resource is
3303 requested again, proxy will return the data from cache. Another use for
3304 proxies is for companies that separate (for security reasons) their
3305 internal networks from the rest of Internet. In order to obtain
3306 information from the Web, their users connect and retrieve remote data
3307 using an authorized proxy.
3309 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
3310 standard way to specify proxy location, which Wget recognizes, is using
3311 the following environment variables:
3316 If set, the @code{http_proxy} and @code{https_proxy} variables should
3317 contain the @sc{url}s of the proxies for @sc{http} and @sc{https}
3318 connections respectively.
3321 This variable should contain the @sc{url} of the proxy for @sc{ftp}
3322 connections. It is quite common that @code{http_proxy} and
3323 @code{ftp_proxy} are set to the same @sc{url}.
3326 This variable should contain a comma-separated list of domain extensions
3327 proxy should @emph{not} be used for. For instance, if the value of
3328 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
3332 In addition to the environment variables, proxy location and settings
3333 may be specified from within Wget itself.
3337 @itemx proxy = on/off
3338 This option and the corresponding command may be used to suppress the
3339 use of proxy, even if the appropriate environment variables are set.
3341 @item http_proxy = @var{URL}
3342 @itemx https_proxy = @var{URL}
3343 @itemx ftp_proxy = @var{URL}
3344 @itemx no_proxy = @var{string}
3345 These startup file variables allow you to override the proxy settings
3346 specified by the environment.
3349 Some proxy servers require authorization to enable you to use them. The
3350 authorization consists of @dfn{username} and @dfn{password}, which must
3351 be sent by Wget. As with @sc{http} authorization, several
3352 authentication schemes exist. For proxy authorization only the
3353 @code{Basic} authentication scheme is currently implemented.
3355 You may specify your username and password either through the proxy
3356 @sc{url} or through the command-line options. Assuming that the
3357 company's proxy is located at @samp{proxy.company.com} at port 8001, a
3358 proxy @sc{url} location containing authorization data might look like
3362 http://hniksic:mypassword@@proxy.company.com:8001/
3365 Alternatively, you may use the @samp{proxy-user} and
3366 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
3367 settings @code{proxy_user} and @code{proxy_password} to set the proxy
3368 username and password.
3371 @section Distribution
3372 @cindex latest version
3374 Like all GNU utilities, the latest version of Wget can be found at the
3375 master GNU archive site ftp.gnu.org, and its mirrors. For example,
3376 Wget @value{VERSION} can be found at
3377 @url{ftp://ftp.gnu.org/pub/gnu/wget/wget-@value{VERSION}.tar.gz}
3383 The official web site for GNU Wget is at
3384 @url{http://www.gnu.org/software/wget/}. However, most useful
3385 information resides at ``The Wget Wgiki'',
3386 @url{http://wget.addictivecode.org/}.
3389 @section Mailing List
3390 @cindex mailing list
3393 There are several Wget-related mailing lists. The general discussion
3394 list is at @email{wget@@sunsite.dk}. It is the preferred place for
3395 support requests and suggestions, as well as for discussion of
3396 development. You are invited to subscribe.
3398 To subscribe, simply send mail to @email{wget-subscribe@@sunsite.dk}
3399 and follow the instructions. Unsubscribe by mailing to
3400 @email{wget-unsubscribe@@sunsite.dk}. The mailing list is archived at
3401 @url{http://www.mail-archive.com/wget%40sunsite.dk/} and at
3402 @url{http://news.gmane.org/gmane.comp.web.wget.general}.
3404 Another mailing list is at @email{wget-patches@@sunsite.dk}, and is
3405 used to submit patches for review by Wget developers. A ``patch'' is
3406 a textual representation of change to source code, readable by both
3407 humans and programs. The
3408 @url{http://wget.addictivecode.org/PatchGuidelines} page
3409 covers the creation and submitting of patches in detail. Please don't
3410 send general suggestions or bug reports to @samp{wget-patches}; use it
3411 only for patch submissions.
3413 Subscription is the same as above for @email{wget@@sunsite.dk}, except
3414 that you send to @email{wget-patches-subscribe@@sunsite.dk}, instead.
3415 The mailing list is archived at
3416 @url{http://news.gmane.org/gmane.comp.web.wget.patches}.
3418 Finally, there is the @email{wget-notify@@addictivecode.org} mailing
3419 list. This is a non-discussion list that receives bug report-change
3420 notifications from the bug-tracker. Unlike for the other mailing lists,
3421 subscription is through the @code{mailman} interface at
3422 @url{http://addictivecode.org/mailman/listinfo/wget-notify}.
3424 @node Internet Relay Chat
3425 @section Internet Relay Chat
3426 @cindex Internet Relay Chat
3430 In addition to the mailinglists, we also have a support channel set up
3431 via IRC at @code{irc.freenode.org}, @code{#wget}. Come check it out!
3433 @node Reporting Bugs
3434 @section Reporting Bugs
3436 @cindex reporting bugs
3440 You are welcome to submit bug reports via the GNU Wget bug tracker (see
3441 @url{http://wget.addictivecode.org/BugTracker}).
3443 Before actually submitting a bug report, please try to follow a few
3448 Please try to ascertain that the behavior you see really is a bug. If
3449 Wget crashes, it's a bug. If Wget does not behave as documented,
3450 it's a bug. If things work strange, but you are not sure about the way
3451 they are supposed to work, it might well be a bug, but you might want to
3452 double-check the documentation and the mailing lists (@pxref{Mailing
3456 Try to repeat the bug in as simple circumstances as possible. E.g. if
3457 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 --no-proxy
3458 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
3459 repeatable, and if will occur with a simpler set of options. You might
3460 even try to start the download at the page where the crash occurred to
3461 see if that page somehow triggered the crash.
3463 Also, while I will probably be interested to know the contents of your
3464 @file{.wgetrc} file, just dumping it into the debug message is probably
3465 a bad idea. Instead, you should first try to see if the bug repeats
3466 with @file{.wgetrc} moved out of the way. Only if it turns out that
3467 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
3471 Please start Wget with @samp{-d} option and send us the resulting
3472 output (or relevant parts thereof). If Wget was compiled without
3473 debug support, recompile it---it is @emph{much} easier to trace bugs
3474 with debug support on.
3476 Note: please make sure to remove any potentially sensitive information
3477 from the debug log before sending it to the bug address. The
3478 @code{-d} won't go out of its way to collect sensitive information,
3479 but the log @emph{will} contain a fairly complete transcript of Wget's
3480 communication with the server, which may include passwords and pieces
3481 of downloaded data. Since the bug address is publically archived, you
3482 may assume that all bug reports are visible to the public.
3485 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
3486 wget` core} and type @code{where} to get the backtrace. This may not
3487 work if the system administrator has disabled core files, but it is
3493 @section Portability
3495 @cindex operating systems
3497 Like all GNU software, Wget works on the GNU system. However, since it
3498 uses GNU Autoconf for building and configuring, and mostly avoids using
3499 ``special'' features of any particular Unix, it should compile (and
3500 work) on all common Unix flavors.
3502 Various Wget versions have been compiled and tested under many kinds of
3503 Unix systems, including GNU/Linux, Solaris, SunOS 4.x, Mac OS X, OSF
3504 (aka Digital Unix or Tru64), Ultrix, *BSD, IRIX, AIX, and others. Some
3505 of those systems are no longer in widespread use and may not be able to
3506 support recent versions of Wget. If Wget fails to compile on your
3507 system, we would like to know about it.
3509 Thanks to kind contributors, this version of Wget compiles and works
3510 on 32-bit Microsoft Windows platforms. It has been compiled
3511 successfully using MS Visual C++ 6.0, Watcom, Borland C, and GCC
3512 compilers. Naturally, it is crippled of some features available on
3513 Unix, but it should work as a substitute for people stuck with
3514 Windows. Note that Windows-specific portions of Wget are not
3515 guaranteed to be supported in the future, although this has been the
3516 case in practice for many years now. All questions and problems in
3517 Windows usage should be reported to Wget mailing list at
3518 @email{wget@@sunsite.dk} where the volunteers who maintain the
3519 Windows-related features might look at them.
3521 Support for building on MS-DOS via DJGPP has been contributed by Gisle
3522 Vanem; a port to VMS is maintained by Steven Schweda, and is available
3523 at @url{http://antinode.org/}.
3527 @cindex signal handling
3530 Since the purpose of Wget is background work, it catches the hangup
3531 signal (@code{SIGHUP}) and ignores it. If the output was on standard
3532 output, it will be redirected to a file named @file{wget-log}.
3533 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
3534 to redirect the output of Wget after having started it.
3537 $ wget http://www.gnus.org/dist/gnus.tar.gz &
3540 SIGHUP received, redirecting output to `wget-log'.
3543 Other than that, Wget will not try to interfere with signals in any way.
3544 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
3549 This chapter contains some references I consider useful.
3552 * Robot Exclusion:: Wget's support for RES.
3553 * Security Considerations:: Security with Wget.
3554 * Contributors:: People who helped.
3557 @node Robot Exclusion
3558 @section Robot Exclusion
3559 @cindex robot exclusion
3561 @cindex server maintenance
3563 It is extremely easy to make Wget wander aimlessly around a web site,
3564 sucking all the available data in progress. @samp{wget -r @var{site}},
3565 and you're set. Great? Not for the server admin.
3567 As long as Wget is only retrieving static pages, and doing it at a
3568 reasonable rate (see the @samp{--wait} option), there's not much of a
3569 problem. The trouble is that Wget can't tell the difference between the
3570 smallest static page and the most demanding CGI. A site I know has a
3571 section handled by a CGI Perl script that converts Info files to @sc{html} on
3572 the fly. The script is slow, but works well enough for human users
3573 viewing an occasional Info file. However, when someone's recursive Wget
3574 download stumbles upon the index page that links to all the Info files
3575 through the script, the system is brought to its knees without providing
3576 anything useful to the user (This task of converting Info files could be
3577 done locally and access to Info documentation for all installed GNU
3578 software on a system is available from the @code{info} command).
3580 To avoid this kind of accident, as well as to preserve privacy for
3581 documents that need to be protected from well-behaved robots, the
3582 concept of @dfn{robot exclusion} was invented. The idea is that
3583 the server administrators and document authors can specify which
3584 portions of the site they wish to protect from robots and those
3585 they will permit access.
3587 The most popular mechanism, and the @i{de facto} standard supported by
3588 all the major robots, is the ``Robots Exclusion Standard'' (RES) written
3589 by Martijn Koster et al. in 1994. It specifies the format of a text
3590 file containing directives that instruct the robots which URL paths to
3591 avoid. To be found by the robots, the specifications must be placed in
3592 @file{/robots.txt} in the server root, which the robots are expected to
3595 Although Wget is not a web robot in the strictest sense of the word, it
3596 can downloads large parts of the site without the user's intervention to
3597 download an individual page. Because of that, Wget honors RES when
3598 downloading recursively. For instance, when you issue:
3601 wget -r http://www.server.com/
3604 First the index of @samp{www.server.com} will be downloaded. If Wget
3605 finds that it wants to download more documents from that server, it will
3606 request @samp{http://www.server.com/robots.txt} and, if found, use it
3607 for further downloads. @file{robots.txt} is loaded only once per each
3610 Until version 1.8, Wget supported the first version of the standard,
3611 written by Martijn Koster in 1994 and available at
3612 @url{http://www.robotstxt.org/wc/norobots.html}. As of version 1.8,
3613 Wget has supported the additional directives specified in the internet
3614 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
3615 Robots Control''. The draft, which has as far as I know never made to
3616 an @sc{rfc}, is available at
3617 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
3619 This manual no longer includes the text of the Robot Exclusion Standard.
3621 The second, less known mechanism, enables the author of an individual
3622 document to specify whether they want the links from the file to be
3623 followed by a robot. This is achieved using the @code{META} tag, like
3627 <meta name="robots" content="nofollow">
3630 This is explained in some detail at
3631 @url{http://www.robotstxt.org/wc/meta-user.html}. Wget supports this
3632 method of robot exclusion in addition to the usual @file{/robots.txt}
3635 If you know what you are doing and really really wish to turn off the
3636 robot exclusion, set the @code{robots} variable to @samp{off} in your
3637 @file{.wgetrc}. You can achieve the same effect from the command line
3638 using the @code{-e} switch, e.g. @samp{wget -e robots=off @var{url}...}.
3640 @node Security Considerations
3641 @section Security Considerations
3644 When using Wget, you must be aware that it sends unencrypted passwords
3645 through the network, which may present a security problem. Here are the
3646 main issues, and some solutions.
3650 The passwords on the command line are visible using @code{ps}. The best
3651 way around it is to use @code{wget -i -} and feed the @sc{url}s to
3652 Wget's standard input, each on a separate line, terminated by @kbd{C-d}.
3653 Another workaround is to use @file{.netrc} to store passwords; however,
3654 storing unencrypted passwords is also considered a security risk.
3657 Using the insecure @dfn{basic} authentication scheme, unencrypted
3658 passwords are transmitted through the network routers and gateways.
3661 The @sc{ftp} passwords are also in no way encrypted. There is no good
3662 solution for this at the moment.
3665 Although the ``normal'' output of Wget tries to hide the passwords,
3666 debugging logs show them, in all forms. This problem is avoided by
3667 being careful when you send debug logs (yes, even when you send them to
3672 @section Contributors
3673 @cindex contributors
3676 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@xemacs.org},
3679 GNU Wget was written by Hrvoje Niksic @email{hniksic@@xemacs.org},
3681 and it is currently maintained by Micah Cowan @email{micah@@cowan.name}.
3683 However, the development of Wget could never have gone as far as it has, were
3684 it not for the help of many people, either with bug reports, feature proposals,
3685 patches, or letters saying ``Thanks!''.
3687 Special thanks goes to the following people (no particular order):
3690 @item Dan Harkless---contributed a lot of code and documentation of
3691 extremely high quality, as well as the @code{--page-requisites} and
3692 related options. He was the principal maintainer for some time and
3695 @item Ian Abbott---contributed bug fixes, Windows-related fixes, and
3696 provided a prototype implementation of the breadth-first recursive
3697 download. Co-maintained Wget during the 1.8 release cycle.
3700 The dotsrc.org crew, in particular Karsten Thygesen---donated system
3701 resources such as the mailing list, web space, @sc{ftp} space, and
3702 version control repositories, along with a lot of time to make these
3703 actually work. Christian Reiniger was of invaluable help with setting
3707 Heiko Herold---provided high-quality Windows builds and contributed
3708 bug and build reports for many years.
3711 Shawn McHorse---bug reports and patches.
3714 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
3718 Gordon Matzigkeit---@file{.netrc} support.
3722 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
3723 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
3726 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
3727 and ``philosophical'' discussions.
3731 Darko Budor---initial port to Windows.
3734 Antonio Rosella---help and suggestions, plus the initial Italian
3739 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
3743 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
3748 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
3751 Francois Pinard---many thorough bug reports and discussions.
3755 Karl Eichwalder---lots of help with internationalization, Makefile
3756 layout and many other things.
3759 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
3763 Mauro Tortonesi---improved IPv6 support, adding support for dual
3764 family systems. Refactored and enhanced FTP IPv6 code. Maintained GNU
3765 Wget from 2004--2007.
3768 Christopher G.@: Lewis---maintenance of the Windows version of GNU WGet.
3771 Gisle Vanem---many helpful patches and improvements, especially for
3772 Windows and MS-DOS support.
3775 Ralf Wildenhues---contributed patches to convert Wget to use Automake as
3776 part of its build process, and various bugfixes.
3779 Steven Schubiger---Many helpful patches, bugfixes and improvements.
3780 Notably, conversion of Wget to use the Gnulib quotes and quoteargs
3781 modules, and the addition of password prompts at the console, via the
3782 Gnulib getpasswd-gnu module.
3785 Ted Mielczarek---donated support for CSS.
3788 People who provided donations for development---including Brian Gough.
3791 The following people have provided patches, bug/build reports, useful
3792 suggestions, beta testing services, fan mail and all the other things
3793 that make maintenance so much fun:
3813 Kristijan @v{C}onka@v{s},
3822 Bertrand Demiddelaer,
3823 Alexander Dergachev,
3836 Aleksandar Erkalovi@'{c},
3839 Aleksandar Erkalovic,
3863 Madhusudan Hosaagrahara,
3867 Erik Magnus Hulthen,
3886 Goran Kezunovi@'{c},
3899 $\Sigma\acute{\iota}\mu o\varsigma\;
3900 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
3901 (Simos KSenitellis),
3910 Nicol@'{a}s Lichtmeier,
3916 Alexander V.@: Lukyanov,
3925 Matthew J.@: Mellon,
3960 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3962 Juan Jos\'{e} Rodr\'{\i}guez,
3965 Juan Jose Rodriguez,
3967 Maciej W.@: Rozycki,
3974 Steven M.@: Schweda,
3985 Szakacsits Szabolcs,
4000 Douglas E.@: Wegscheid,
4002 Joshua David Williams,
4013 Apologies to all who I accidentally left out, and many thanks to all the
4014 subscribers of the Wget mailing list.
4016 @node Copying this manual
4017 @appendix Copying this manual
4020 * GNU Free Documentation License:: Licnse for copying this manual.
4027 @unnumbered Concept Index