1 \input texinfo @c -*-texinfo-*-
5 @settitle GNU Wget Manual
6 @c Disable the monstrous rectangles beside overfull hbox-es.
8 @c Use `odd' to print double-sided.
13 @c Remove this if you don't use A4 paper.
17 @c This should really be auto-generated!
18 @set VERSION 1.5.3+dev
21 @dircategory Net Utilities
22 @dircategory World Wide Web
24 * Wget: (wget). The non-interactive network downloader.
28 This file documents the the GNU Wget utility for downloading network
31 Copyright (C) 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
33 Permission is granted to make and distribute verbatim copies of
34 this manual provided the copyright notice and this permission notice
35 are preserved on all copies.
38 Permission is granted to process this file through TeX and print the
39 results, provided the printed document carries a copying permission
40 notice identical to this one except for the removal of this paragraph
41 (this paragraph not being relevant to the printed manual).
43 Permission is granted to copy and distribute modified versions of this
44 manual under the conditions for verbatim copying, provided also that the
45 sections entitled ``Copying'' and ``GNU General Public License'' are
46 included exactly as in the original, and provided that the entire
47 resulting derived work is distributed under the terms of a permission
48 notice identical to this one.
53 @subtitle The noninteractive downloading utility
54 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
55 @author by Hrvoje Nik@v{s}i@'{c} and the developers
58 @vskip 0pt plus 1filll
59 Copyright @copyright{} 1996, 1997, 1998 Free Software Foundation, Inc.
61 Permission is granted to make and distribute verbatim copies of this
62 manual provided the copyright notice and this permission notice are
63 preserved on all copies.
65 Permission is granted to copy and distribute modified versions of this
66 manual under the conditions for verbatim copying, provided also that the
67 sections entitled ``Copying'' and ``GNU General Public License'' are
68 included exactly as in the original, and provided that the entire
69 resulting derived work is distributed under the terms of a permission
70 notice identical to this one.
72 Permission is granted to copy and distribute translations of this manual
73 into another language, under the above conditions for modified versions,
74 except that this permission notice may be stated in a translation
75 approved by the Free Software Foundation.
79 @node Top, Overview, (dir), (dir)
80 @top Wget @value{VERSION}
82 This manual documents version @value{VERSION} of GNU Wget, the freely
83 available utility for network download.
85 Copyright @copyright{} 1996, 1997, 1998 Free Software Foundation, Inc.
88 * Overview:: Features of Wget.
89 * Invoking:: Wget command-line arguments.
90 * Recursive Retrieval:: Description of recursive retrieval.
91 * Following Links:: The available methods of chasing links.
92 * Time-Stamping:: Mirroring according to time-stamps.
93 * Startup File:: Wget's initialization file.
94 * Examples:: Examples of usage.
95 * Various:: The stuff that doesn't fit anywhere else.
96 * Appendices:: Some useful references.
97 * Copying:: You may give out copies of Wget.
98 * Concept Index:: Topics covered by this manual.
102 @node Overview, Invoking, Top, Top
107 GNU Wget is a freely available network utility to retrieve files from
108 the World Wide Web, using @sc{http} (Hyper Text Transfer Protocol) and
109 @sc{ftp} (File Transfer Protocol), the two most widely used Internet
110 protocols. It has many useful features to make downloading easier, some
115 Wget is non-interactive, meaning that it can work in the background,
116 while the user is not logged on. This allows you to start a retrieval
117 and disconnect from the system, letting Wget finish the work. By
118 contrast, most of the Web browsers require constant user's presence,
119 which can be a great hindrance when transferring a lot of data.
123 Wget is capable of descending recursively through the structure of
124 @sc{html} documents and @sc{ftp} directory trees, making a local copy of
125 the directory hierarchy similar to the one on the remote server. This
126 feature can be used to mirror archives and home pages, or traverse the
127 web in search of data, like a @sc{www} robot (@xref{Robots}). In that
128 spirit, Wget understands the @code{norobots} convention.
132 File name wildcard matching and recursive mirroring of directories are
133 available when retrieving via @sc{ftp}. Wget can read the time-stamp
134 information given by both @sc{http} and @sc{ftp} servers, and store it
135 locally. Thus Wget can see if the remote file has changed since last
136 retrieval, and automatically retrieve the new version if it has. This
137 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
142 Wget works exceedingly well on slow or unstable connections,
143 retrying the document until it is fully retrieved, or until a
144 user-specified retry count is surpassed. It will try to resume the
145 download from the point of interruption, using @code{REST} with @sc{ftp}
146 and @code{Range} with @sc{http} servers that support them.
150 By default, Wget supports proxy servers, which can lighten the network
151 load, speed up retrieval and provide access behind firewalls. However,
152 if you are behind a firewall that requires that you use a socks style
153 gateway, you can get the socks library and build wget with support for
154 socks. Wget also supports the passive @sc{ftp} downloading as an
159 Builtin features offer mechanisms to tune which links you wish to follow
160 (@xref{Following Links}).
164 The retrieval is conveniently traced with printing dots, each dot
165 representing a fixed amount of data received (1KB by default). These
166 representations can be customized to your preferences.
170 Most of the features are fully configurable, either through command line
171 options, or via the initialization file @file{.wgetrc} (@xref{Startup
172 File}). Wget allows you to define @dfn{global} startup files
173 (@file{/usr/local/etc/wgetrc} by default) for site settings.
177 Finally, GNU Wget is free software. This means that everyone may use
178 it, redistribute it and/or modify it under the terms of the GNU General
179 Public License, as published by the Free Software Foundation
183 @node Invoking, Recursive Retrieval, Overview, Top
190 By default, Wget is very simple to invoke. The basic syntax is:
193 wget [@var{option}]@dots{} [@var{URL}]@dots{}
196 Wget will simply download all the @sc{url}s specified on the command
197 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
199 However, you may wish to change some of the default parameters of
200 Wget. You can do it two ways: permanently, adding the appropriate
201 command to @file{.wgetrc} (@xref{Startup File}), or specifying it on
207 * Basic Startup Options::
208 * Logging and Input File Options::
210 * Directory Options::
213 * Recursive Retrieval Options::
214 * Recursive Accept/Reject Options::
217 @node URL Format, Option Syntax, Invoking, Invoking
222 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
223 resource locator is a compact string representation for a resource
224 available via the Internet. Wget recognizes the @sc{url} syntax as per
225 @sc{rfc1738}. This is the most widely used form (square brackets denote
229 http://host[:port]/directory/file
230 ftp://host[:port]/directory/file
233 You can also encode your username and password within a @sc{url}:
236 ftp://user:password@@host/path
237 http://user:password@@host/path
240 Either @var{user} or @var{password}, or both, may be left out. If you
241 leave out either the @sc{http} username or password, no authentication
242 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
243 will be used. If you leave out the @sc{ftp} password, your email
244 address will be supplied as a default password.@footnote{If you have a
245 @file{.netrc} file in your home directory, password will also be
248 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
249 being the hexadecimal representation of the character's @sc{ascii}
250 value. Some common unsafe characters include @samp{%} (quoted as
251 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
252 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
255 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
256 default, @sc{ftp} documents are retrieved in the binary mode (type
257 @samp{i}), which means that they are downloaded unchanged. Another
258 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
259 delimiters between the different operating systems, and is thus useful
260 for text files. Here is an example:
263 ftp://host/directory/file;type=a
266 Two alternative variants of @sc{url} specification are also supported,
267 because of historical (hysterical?) reasons and their widespreaded use.
269 @sc{ftp}-only syntax (supported by @code{NcFTP}):
274 @sc{http}-only syntax (introduced by @code{Netscape}):
279 These two alternative forms are deprecated, and may cease being
280 supported in the future.
282 If you do not understand the difference between these notations, or do
283 not know which one to use, just use the plain ordinary format you use
284 with your favorite browser, like @code{Lynx} or @code{Netscape}.
286 @node Option Syntax, Basic Startup Options, URL Format, Invoking
287 @section Option Syntax
288 @cindex option syntax
289 @cindex syntax of options
291 Since Wget uses GNU getopts to process its arguments, every option has a
292 short form and a long form. Long options are more convenient to
293 remember, but take time to type. You may freely mix different option
294 styles, or specify options after the command-line arguments. Thus you
298 wget -r --tries=10 http://fly.cc.fer.hr/ -o log
301 The space between the option accepting an argument and the argument may
302 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
304 You may put several options that do not require arguments together,
311 This is a complete equivalent of:
314 wget -d -r -c @var{URL}
317 Since the options can be specified after the arguments, you may
318 terminate them with @samp{--}. So the following will try to download
319 @sc{url} @samp{-x}, reporting failure to @file{log}:
325 The options that accept comma-separated lists all respect the convention
326 that specifying an empty list clears its value. This can be useful to
327 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
328 sets @code{exclude_directories} to @file{/cgi-bin}, the following
329 example will first reset it, and then set it to exclude @file{/~nobody}
330 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
331 (@xref{Wgetrc Syntax}).
334 wget -X '' -X /~nobody,/~somebody
337 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
338 @section Basic Startup Options
343 Display the version of Wget.
347 Print a help message describing all of Wget's command-line options.
351 Go to background immediately after startup. If no output file is
352 specified via the @samp{-o}, output is redirected to @file{wget-log}.
354 @cindex execute wgetrc command
355 @item -e @var{command}
356 @itemx --execute @var{command}
357 Execute @var{command} as if it were a part of @file{.wgetrc}
358 (@xref{Startup File}). A command thus invoked will be executed
359 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
363 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
364 @section Logging and Input File Options
369 @item -o @var{logfile}
370 @itemx --output-file=@var{logfile}
371 Log all messages to @var{logfile}. The messages are normally reported
374 @cindex append to log
375 @item -a @var{logfile}
376 @itemx --append-output=@var{logfile}
377 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
378 to @var{logfile} instead of overwriting the old log file. If
379 @var{logfile} does not exist, a new file is created.
384 Turn on debug output, meaning various information important to the
385 developers of Wget if it does not work properly. Your system
386 administrator may have chosen to compile Wget without debug support, in
387 which case @samp{-d} will not work. Please note that compiling with
388 debug support is always safe---Wget compiled with the debug support will
389 @emph{not} print any debug info unless requested with @samp{-d}.
390 @xref{Reporting Bugs} for more information on how to use @samp{-d} for
396 Turn off Wget's output.
401 Turn on verbose output, with all the available data. The default output
406 Non-verbose output---turn off verbose without being completely quiet
407 (use @samp{-q} for that), which means that error messages and basic
408 information still get printed.
412 @itemx --input-file=@var{file}
413 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
414 the command line. If there are @sc{url}s both on the command line and
415 in an input file, those on the command lines will be the first ones to
416 be retrieved. The @var{file} need not be an @sc{html} document (but no
417 harm if it is)---it is enough if the @sc{url}s are just listed
420 However, if you specify @samp{--force-html}, the document will be
421 regarded as @samp{html}. In that case you may have problems with
422 relative links, which you can solve either by adding @code{<base
423 href="@var{url}">} to the documents or by specifying
424 @samp{--base=@var{url}} on the command line.
429 When input is read from a file, force it to be treated as an @sc{html}
430 file. This enables you to retrieve relative links from existing
431 @sc{html} files on your local disk, by adding @code{<base
432 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
435 @cindex base for relative links in input file
437 @itemx --base=@var{URL}
438 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
439 links in the file specified by @samp{-i}.
442 @node Download Options, Directory Options, Logging and Input File Options, Invoking
443 @section Download Options
448 @cindex number of retries
449 @item -t @var{number}
450 @itemx --tries=@var{number}
451 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
455 @itemx --output-document=@var{file}
456 The documents will not be written to the appropriate files, but all will
457 be concatenated together and written to @var{file}. If @var{file}
458 already exists, it will be overwritten. If the @var{file} is @samp{-},
459 the documents will be written to standard output. Including this option
460 automatically sets the number of tries to 1.
462 @cindex clobbering, file
463 @cindex downloading multiple times
467 If a file is downloaded more than once in the same directory, wget's
468 behavior depends on a few options, including @samp{-nc}. In certain
469 cases, the local file will be "clobbered", or overwritten, upon repeated
470 download. In other cases it will be preserved.
472 When running wget without @samp{-N}, @samp{-nc}, or @samp{-r},
473 downloading the same file in the same directory will result in the
474 original copy of @samp{@var{file}} being preserved and the second copy
475 being named @samp{@var{file}.1}. If that file is downloaded yet again,
476 the third copy will be named @samp{@var{file}.2}, and so on. When
477 @samp{-nc} is specified, this behavior is suppressed, and wget will
478 refuse to download newer copies of @samp{@var{file}}. Therefore,
479 "no-clobber" is actually a misnomer in this mode -- it's not clobbering
480 that's prevented (as the numeric suffixes were already preventing
481 clobbering), but rather the multiple version saving that's prevented.
483 When running wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
484 re-downloading a file will result in the new copy simply overwriting the
485 old. Adding @samp{-nc} will prevent this behavior, instead causing the
486 original version to be preserved and any newer copies on the server to
489 When running wget with @samp{-N}, with or without @samp{-r}, the
490 decision as to whether or not to download a newer copy of a file depends
491 on the local and remote timestamp and size of the file
492 (@xref{Time-Stamping}). @samp{-nc} may not be specified at the same
495 Note that when @samp{-nc} is specified, files with the suffixes
496 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
497 and parsed as if they had been retrieved from the Web.
499 @cindex continue retrieval
502 Continue getting an existing file. This is useful when you want to
503 finish up the download started by another program, or a previous
504 instance of Wget. Thus you can write:
507 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
510 If there is a file name @file{ls-lR.Z} in the current directory, Wget
511 will assume that it is the first portion of the remote file, and will
512 require the server to continue the retrieval from an offset equal to the
513 length of the local file.
515 Note that you need not specify this option if all you want is Wget to
516 continue retrieving where it left off when the connection is lost---Wget
517 does this by default. You need this option only when you want to
518 continue retrieval of a file already halfway retrieved, saved by another
519 @sc{ftp} client, or left by Wget being killed.
521 Without @samp{-c}, the previous example would just begin to download the
522 remote file to @file{ls-lR.Z.1}. The @samp{-c} option is also
523 applicable for @sc{http} servers that support the @code{Range} header.
525 Note that if you use @samp{-c} on a file that's already downloaded
526 completely, @samp{@var{file}} will not be changed, nor will a second
527 @samp{@var{file}.1} copy be created.
530 @cindex retrieval tracing style
531 @item --dot-style=@var{style}
532 Set the retrieval style to @var{style}. Wget traces the retrieval of
533 each document by printing dots on the screen, each dot representing a
534 fixed amount of retrieved data. Any number of dots may be separated in
535 a @dfn{cluster}, to make counting easier. This option allows you to
536 choose one of the pre-defined styles, determining the number of bytes
537 represented by a dot, the number of dots in a cluster, and the number of
540 With the @code{default} style each dot represents 1K, there are ten dots
541 in a cluster and 50 dots in a line. The @code{binary} style has a more
542 ``computer''-like orientation---8K dots, 16-dots clusters and 48 dots
543 per line (which makes for 384K lines). The @code{mega} style is
544 suitable for downloading very large files---each dot represents 64K
545 retrieved, there are eight dots in a cluster, and 48 dots on each line
546 (so each line contains 3M). The @code{micro} style is exactly the
547 reverse; it is suitable for downloading small files, with 128-byte dots,
548 8 dots per cluster, and 48 dots (6K) per line.
551 @itemx --timestamping
552 Turn on time-stamping. @xref{Time-Stamping} for details.
554 @cindex server response, print
556 @itemx --server-response
557 Print the headers sent by @sc{http} servers and responses sent by
560 @cindex Wget as spider
563 When invoked with this option, Wget will behave as a Web @dfn{spider},
564 which means that it will not download the pages, just check that they
565 are there. You can use it to check your bookmarks, e.g. with:
568 wget --spider --force-html -i bookmarks.html
571 This feature needs much more work for Wget to get close to the
572 functionality of real @sc{www} spiders.
576 @itemx --timeout=@var{seconds}
577 Set the read timeout to @var{seconds} seconds. Whenever a network read
578 is issued, the file descriptor is checked for a timeout, which could
579 otherwise leave a pending connection (uninterrupted read). The default
580 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
581 disable checking for timeouts.
583 Please do not lower the default timeout value with this option unless
584 you know what you are doing.
588 @item -w @var{seconds}
589 @itemx --wait=@var{seconds}
590 Wait the specified number of seconds between the retrievals. Use of
591 this option is recommended, as it lightens the server load by making the
592 requests less frequent. Instead of in seconds, the time can be
593 specified in minutes using the @code{m} suffix, in hours using @code{h}
594 suffix, or in days using @code{d} suffix.
596 Specifying a large value for this option is useful if the network or the
597 destination host is down, so that Wget can wait long enough to
598 reasonably expect the network error to be fixed before the retry.
600 @cindex retries, waiting between
601 @cindex waiting between retries
602 @item --waitretry=@var{seconds}
603 If you don't want Wget to wait between @emph{every} retrieval, but only
604 between retries of failed downloads, you can use this option. Wget will
605 use "linear backoff", waiting 1 second after the first failure on a
606 given file, then waiting 2 seconds after the second failure on that
607 file, up to the maximum number of @var{seconds} you specify. Therefore,
608 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
611 Note that this option is turned on by default in the global
616 @itemx --proxy=on/off
617 Turn proxy support on or off. The proxy is on by default if the
618 appropriate environmental variable is defined.
622 @itemx --quota=@var{quota}
623 Specify download quota for automatic retrievals. The value can be
624 specified in bytes (default), kilobytes (with @samp{k} suffix), or
625 megabytes (with @samp{m} suffix).
627 Note that quota will never affect downloading a single file. So if you
628 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
629 @file{ls-lR.gz} will be downloaded. The same goes even when several
630 @sc{url}s are specified on the command-line. However, quota is
631 respected when retrieving either recursively, or from an input file.
632 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
633 aborted when the quota is exceeded.
635 Setting quota to 0 or to @samp{inf} unlimits the download quota.
638 @node Directory Options, HTTP Options, Download Options, Invoking
639 @section Directory Options
643 @itemx --no-directories
644 Do not create a hierarchy of directories when retrieving
645 recursively. With this option turned on, all files will get saved to the
646 current directory, without clobbering (if a name shows up more than
647 once, the filenames will get extensions @samp{.n}).
650 @itemx --force-directories
651 The opposite of @samp{-nd}---create a hierarchy of directories, even if
652 one would not have been created otherwise. E.g. @samp{wget -x
653 http://fly.cc.fer.hr/robots.txt} will save the downloaded file to
654 @file{fly.cc.fer.hr/robots.txt}.
657 @itemx --no-host-directories
658 Disable generation of host-prefixed directories. By default, invoking
659 Wget with @samp{-r http://fly.cc.fer.hr/} will create a structure of
660 directories beginning with @file{fly.cc.fer.hr/}. This option disables
663 @cindex cut directories
664 @item --cut-dirs=@var{number}
665 Ignore @var{number} directory components. This is useful for getting a
666 fine-grained control over the directory where recursive retrieval will
669 Take, for example, the directory at
670 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
671 @samp{-r}, it will be saved locally under
672 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
673 remove the @file{ftp.xemacs.org/} part, you are still stuck with
674 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
675 makes Wget not ``see'' @var{number} remote directory components. Here
676 are several examples of how @samp{--cut-dirs} option works.
680 No options -> ftp.xemacs.org/pub/xemacs/
682 -nH --cut-dirs=1 -> xemacs/
683 -nH --cut-dirs=2 -> .
685 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
690 If you just want to get rid of the directory structure, this option is
691 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
692 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
693 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
694 be placed to @file{xemacs/beta}, as one would expect.
696 @cindex directory prefix
697 @item -P @var{prefix}
698 @itemx --directory-prefix=@var{prefix}
699 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
700 directory where all other files and subdirectories will be saved to,
701 i.e. the top of the retrieval tree. The default is @samp{.} (the
705 @node HTTP Options, FTP Options, Directory Options, Invoking
706 @section HTTP Options
709 @cindex .html extension
711 @itemx --html-extension
712 If a file of type @samp{text/html} is downloaded and the URL does not
713 end with the regexp "\.[Hh][Tt][Mm][Ll]?", this option will cause the
714 suffix @samp{.html} to be appended to the local filename. This is
715 useful, for instance, when you're mirroring a remote site that uses
716 @samp{.asp} pages, but you want the mirrored pages to be viewable on
717 your stock Apache server. Another good use for this is when you're
718 downloading the output of CGIs. A URL like
719 @samp{http://site.com/article.cgi?25} will be saved as
720 @file{article.cgi?25.html}.
722 Note that filenames changed in this way will be re-downloaded every time
723 you re-mirror a site, because wget can't tell that the local
724 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
725 it doesn't yet know that the URL produces output of type
726 @samp{text/html}. To prevent this re-downloading, you must use
727 @samp{-k} and @samp{-K} so that the original version of the file will be
728 saved as @file{@var{X}.orig} (@xref{Recursive Retrieval Options}).
731 @cindex http password
732 @cindex authentication
733 @item --http-user=@var{user}
734 @itemx --http-passwd=@var{password}
735 Specify the username @var{user} and password @var{password} on an
736 @sc{http} server. According to the type of the challenge, Wget will
737 encode them using either the @code{basic} (insecure) or the
738 @code{digest} authentication scheme.
740 Another way to specify username and password is in the @sc{url} itself
741 (@xref{URL Format}). For more information about security issues with
742 Wget, @xref{Security Considerations}.
747 @itemx --cache=on/off
748 When set to off, disable server-side cache. In this case, Wget will
749 send the remote server an appropriate directive (@samp{Pragma:
750 no-cache}) to get the file from the remote service, rather than
751 returning the cached version. This is especially useful for retrieving
752 and flushing out-of-date documents on proxy servers.
754 Caching is allowed by default.
756 @cindex Content-Length, ignore
757 @cindex ignore length
758 @item --ignore-length
759 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
760 precise) send out bogus @code{Content-Length} headers, which makes Wget
761 go wild, as it thinks not all the document was retrieved. You can spot
762 this syndrome if Wget retries getting the same document again and again,
763 each time claiming that the (otherwise normal) connection has closed on
766 With this option, Wget will ignore the @code{Content-Length} header---as
770 @item --header=@var{additional-header}
771 Define an @var{additional-header} to be passed to the @sc{http} servers.
772 Headers must contain a @samp{:} preceded by one or more non-blank
773 characters, and must not contain newlines.
775 You may define more than one additional header by specifying
776 @samp{--header} more than once.
780 wget --header='Accept-Charset: iso-8859-2' \
781 --header='Accept-Language: hr' \
782 http://fly.cc.fer.hr/
786 Specification of an empty string as the header value will clear all
787 previous user-defined headers.
790 @cindex proxy password
791 @cindex proxy authentication
792 @item --proxy-user=@var{user}
793 @itemx --proxy-passwd=@var{password}
794 Specify the username @var{user} and password @var{password} for
795 authentication on a proxy server. Wget will encode them using the
796 @code{basic} authentication scheme.
799 @cindex referer, http
800 @item --referer=@var{url}
801 Include `Referer: @var{url}' header in HTTP request. Useful for
802 retrieving documents with server-side processing that assume they are
803 always being retrieved by interactive web browsers and only come out
804 properly when Referer is set to one of the pages that point to them.
806 @cindex server response, save
808 @itemx --save-headers
809 Save the headers sent by the @sc{http} server to the file, preceding the
810 actual contents, with an empty line as the separator.
813 @item -U @var{agent-string}
814 @itemx --user-agent=@var{agent-string}
815 Identify as @var{agent-string} to the @sc{http} server.
817 The @sc{http} protocol allows the clients to identify themselves using a
818 @code{User-Agent} header field. This enables distinguishing the
819 @sc{www} software, usually for statistical purposes or for tracing of
820 protocol violations. Wget normally identifies as
821 @samp{Wget/@var{version}}, @var{version} being the current version
824 However, some sites have been known to impose the policy of tailoring
825 the output according to the @code{User-Agent}-supplied information.
826 While conceptually this is not such a bad idea, it has been abused by
827 servers denying information to clients other than @code{Mozilla} or
828 Microsoft @code{Internet Explorer}. This option allows you to change
829 the @code{User-Agent} line issued by Wget. Use of this option is
830 discouraged, unless you really know what you are doing.
832 @strong{NOTE} that Netscape Communications Corp. has claimed that false
833 transmissions of @samp{Mozilla} as the @code{User-Agent} are a copyright
834 infringement, which will be prosecuted. @strong{DO NOT} misrepresent
838 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
842 @cindex symbolic links, retrieving
843 @item --retr-symlinks
844 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
845 link is encountered, the linked-to file is not downloaded. Instead, a
846 matching symbolic link is created on the local filesystem. The
847 pointed-to file will not be downloaded unless this recursive retrieval
848 would have encountered it separately and downloaded it anyway.
850 When @samp{--retr-symlinks} is specified, however, symbolic links are
851 traversed and the pointed-to files are retrieved. At this time, this
852 option does not cause wget to traverse symlinks to directories and
853 recurse through them, but in the future it should be enhanced to do
856 Note that when retrieving a file (not a directory) because it was
857 specified on the commandline, rather than because it was recursed to,
858 this option has no effect. Symbolic links are always traversed in this
861 @cindex globbing, toggle
864 Turn @sc{ftp} globbing on or off. Globbing means you may use the
865 shell-like special characters (@dfn{wildcards}), like @samp{*},
866 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
867 same directory at once, like:
870 wget ftp://gnjilux.cc.fer.hr/*.msg
873 By default, globbing will be turned on if the @sc{url} contains a
874 globbing character. This option may be used to turn globbing on or off
877 You may have to quote the @sc{url} to protect it from being expanded by
878 your shell. Globbing makes Wget look for a directory listing, which is
879 system-specific. This is why it currently works only with Unix @sc{ftp}
880 servers (and the ones emulating Unix @code{ls} output).
884 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
885 initiates the data connection. This is sometimes required for @sc{ftp}
886 to work behind firewalls.
889 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
890 @section Recursive Retrieval Options
895 Turn on recursive retrieving. @xref{Recursive Retrieval} for more
899 @itemx --level=@var{depth}
900 Specify recursion maximum depth level @var{depth} (@xref{Recursive
901 Retrieval}). The default maximum depth is 5.
903 @cindex proxy filling
904 @cindex delete after retrieval
905 @cindex filling proxy cache
907 This option tells Wget to delete every single file it downloads,
908 @emph{after} having done so. It is useful for pre-fetching popular
909 pages through proxy, e.g.:
912 wget -r -nd --delete-after http://whatever.com/~popular/page/
915 The @samp{-r} option is to retrieve recursively, and @samp{-nd} not to
918 @cindex conversion of links
919 @cindex link conversion
921 @itemx --convert-links
922 Convert the non-relative links to relative ones locally. Only the
923 references to the documents actually downloaded will be converted; the
924 rest will be left unchanged.
926 Note that only at the end of the download can Wget know which links have
927 been downloaded. Because of that, much of the work done by @samp{-k}
928 will be performed at the end of the downloads.
930 @cindex backing up converted files
932 @itemx --backup-converted
933 When converting a file, back up the original version with a @samp{.orig}
934 suffix. Affects the behavior of @samp{-N} (@xref{HTTP Time-Stamping
939 Turn on options suitable for mirroring. This option turns on recursion
940 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
941 directory listings. It is currently equivalent to
942 @samp{-r -N -l inf -nr}.
945 @itemx --dont-remove-listing
946 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
947 retrievals. Normally, these files contain the raw directory listings
948 received from @sc{ftp} servers. Not removing them can be useful to
949 access the full remote file list when running a mirror, or for debugging
952 @cindex page requisites
953 @cindex required images, downloading
955 @itemx --page-requisites
956 This option causes wget to download all the files that are necessary to
957 properly display a given HTML page. This includes such things as
958 inlined images, sounds, and referenced stylesheets.
960 Ordinarily, when downloading a single HTML page, any requisite documents
961 that may be needed to display it properly are not downloaded. Using
962 @samp{-r} together with @samp{-l} can help, but since wget does not
963 ordinarily distinguish between external and inlined documents, one is
964 generally left with "leaf documents" that are missing their requisites.
966 For instance, say document @file{1.html} contains an @code{<IMG>} tag
967 referencing @file{1.gif} and an @code{<A>} tag pointing to external
968 document @file{2.html}. Say that @file{2.html} is the same but that its
969 image is @file{2.gif} and it links to @file{3.html}. Say this
970 continues up to some arbitrarily high number.
972 If one executes the command:
975 wget -r -l 2 http://@var{site}/1.html
978 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
979 @file{3.html} will be downloaded. As you can see, @file{3.html} is
980 without its requisite @file{3.gif} because wget is simply counting the
981 number of hops (up to 2) away from @file{1.html} in order to determine
982 where to stop the recursion. However, with this command:
985 wget -r -l 2 -p http://@var{site}/1.html
988 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
989 will be downloaded. Similarly,
992 wget -r -l 1 -p http://@var{site}/1.html
995 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
996 to be downloaded. One might think that:
999 wget -r -l 0 -p http://@var{site}/1.html
1002 would download just @file{1.html} and @file{1.gif}, but unfortunately
1003 this is not the case, because @samp{-l 0} is equivalent to @samp{-l inf}
1004 -- that is, infinite recursion. To download a single HTML page (or a
1005 handful of them, all specified on the commandline or in a @samp{-i} @sc{url}
1006 input file) and its requisites, simply leave off @samp{-p} and @samp{-l}:
1009 wget -p http://@var{site}/1.html
1012 Note that wget will behave as if @samp{-r} had been specified, but only
1013 that single page and its requisites will be downloaded. Links from that
1014 page to external documents will not be followed. Actually, to download
1015 a single page and all its requisites (even if they exist on separate
1016 websites), and make sure the lot displays properly locally, this author
1017 likes to use a few options in addition to @samp{-p}:
1020 wget -H -k -K -nh -p http://@var{site}/@var{document}
1023 To finish off this topic, it's worth knowing that wget's idea of an
1024 external document link is any URL specified in an @code{<A>} tag, an
1025 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1029 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1030 @section Recursive Accept/Reject Options
1033 @item -A @var{acclist} --accept @var{acclist}
1034 @itemx -R @var{rejlist} --reject @var{rejlist}
1035 Specify comma-separated lists of file name suffixes or patterns to
1036 accept or reject (@xref{Types of Files} for more details).
1038 @item -D @var{domain-list}
1039 @itemx --domains=@var{domain-list}
1040 Set domains to be accepted and @sc{dns} looked-up, where
1041 @var{domain-list} is a comma-separated list. Note that it does
1042 @emph{not} turn on @samp{-H}. This option speeds things up, even if
1043 only one host is spanned (@xref{Domain Acceptance}).
1045 @item --exclude-domains @var{domain-list}
1046 Exclude the domains given in a comma-separated @var{domain-list} from
1047 @sc{dns}-lookup (@xref{Domain Acceptance}).
1049 @cindex follow FTP links
1051 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1052 Wget will ignore all the @sc{ftp} links.
1054 @cindex tag-based recursive pruning
1055 @item --follow-tags=@var{list}
1056 Wget has an internal table of HTML tag / attribute pairs that it
1057 considers when looking for linked documents during a recursive
1058 retrieval. If a user wants only a subset of those tags to be
1059 considered, however, he or she should be specify such tags in a
1060 comma-separated @var{list} with this option.
1063 @itemx --ignore-tags=@var{list}
1064 This is the opposite of the @samp{--follow-tags} option. To skip
1065 certain HTML tags when recursively looking for documents to download,
1066 specify them in a comma-separated @var{list}.
1068 In the past, the @samp{-G} option was the best bet for downloading a
1069 single page and its requisites, using a commandline like:
1072 wget -Ga,area -H -k -K -nh -r http://@var{site}/@var{document}
1075 However, the author of this option came across a page with tags like
1076 @code{<LINK REL="home" HREF="/">} and came to the realization that
1077 @samp{-G} was not enough. One can't just tell wget to ignore
1078 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1079 best bet for downloading a single page and its requisites is the
1080 dedicated @samp{--page-requisites} option.
1084 Enable spanning across hosts when doing recursive retrieving (@xref{All
1089 Follow relative links only. Useful for retrieving a specific home page
1090 without any distractions, not even those from the same hosts
1091 (@xref{Relative Links}).
1094 @itemx --include-directories=@var{list}
1095 Specify a comma-separated list of directories you wish to follow when
1096 downloading (@xref{Directory-Based Limits} for more details.) Elements
1097 of @var{list} may contain wildcards.
1100 @itemx --exclude-directories=@var{list}
1101 Specify a comma-separated list of directories you wish to exclude from
1102 download (@xref{Directory-Based Limits} for more details.) Elements of
1103 @var{list} may contain wildcards.
1106 @itemx --no-host-lookup
1107 Disable the time-consuming @sc{dns} lookup of almost all hosts
1108 (@xref{Host Checking}).
1112 Do not ever ascend to the parent directory when retrieving recursively.
1113 This is a useful option, since it guarantees that only the files
1114 @emph{below} a certain hierarchy will be downloaded.
1115 @xref{Directory-Based Limits} for more details.
1118 @node Recursive Retrieval, Following Links, Invoking, Top
1119 @chapter Recursive Retrieval
1122 @cindex recursive retrieval
1124 GNU Wget is capable of traversing parts of the Web (or a single
1125 @sc{http} or @sc{ftp} server), depth-first following links and directory
1126 structure. This is called @dfn{recursive} retrieving, or
1129 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1130 the given @sc{url}, documents, retrieving the files the @sc{html}
1131 document was referring to, through markups like @code{href}, or
1132 @code{src}. If the freshly downloaded file is also of type
1133 @code{text/html}, it will be parsed and followed further.
1135 The maximum @dfn{depth} to which the retrieval may descend is specified
1136 with the @samp{-l} option (the default maximum depth is five layers).
1137 @xref{Recursive Retrieval}.
1139 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1140 the data from the given directory tree (including the subdirectories up
1141 to the specified depth) on the remote server, creating its mirror image
1142 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1145 By default, Wget will create a local directory tree, corresponding to
1146 the one found on the remote server.
1148 Recursive retrieving can find a number of applications, the most
1149 important of which is mirroring. It is also useful for @sc{www}
1150 presentations, and any other opportunities where slow network
1151 connections should be bypassed by storing the files locally.
1153 You should be warned that invoking recursion may cause grave overloading
1154 on your system, because of the fast exchange of data through the
1155 network; all of this may hamper other users' work. The same stands for
1156 the foreign server you are mirroring---the more requests it gets in a
1157 rows, the greater is its load.
1159 Careless retrieving can also fill your file system uncontrollably, which
1160 can grind the machine to a halt.
1162 The load can be minimized by lowering the maximum recursion level
1163 (@samp{-l}) and/or by lowering the number of retries (@samp{-t}). You
1164 may also consider using the @samp{-w} option to slow down your requests
1165 to the remote servers, as well as the numerous options to narrow the
1166 number of followed links (@xref{Following Links}).
1168 Recursive retrieval is a good thing when used properly. Please take all
1169 precautions not to wreak havoc through carelessness.
1171 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1172 @chapter Following Links
1174 @cindex following links
1176 When retrieving recursively, one does not wish to retrieve loads of
1177 unnecessary data. Most of the time the users bear in mind exactly what
1178 they want to download, and want Wget to follow only specific links.
1180 For example, if you wish to download the music archive from
1181 @samp{fly.cc.fer.hr}, you will not want to download all the home pages
1182 that happen to be referenced by an obscure part of the archive.
1184 Wget possesses several mechanisms that allows you to fine-tune which
1185 links it will follow.
1188 * Relative Links:: Follow relative links only.
1189 * Host Checking:: Follow links on the same host.
1190 * Domain Acceptance:: Check on a list of domains.
1191 * All Hosts:: No host restrictions.
1192 * Types of Files:: Getting only certain files.
1193 * Directory-Based Limits:: Getting only certain directories.
1194 * FTP Links:: Following FTP links.
1197 @node Relative Links, Host Checking, Following Links, Following Links
1198 @section Relative Links
1199 @cindex relative links
1201 When only relative links are followed (option @samp{-L}), recursive
1202 retrieving will never span hosts. No time-expensive @sc{dns}-lookups
1203 will be performed, and the process will be very fast, with the minimum
1204 strain of the network. This will suit your needs often, especially when
1205 mirroring the output of various @code{x2html} converters, since they
1206 generally output relative links.
1208 @node Host Checking, Domain Acceptance, Relative Links, Following Links
1209 @section Host Checking
1212 @cindex host checking
1214 The drawback of following the relative links solely is that humans often
1215 tend to mix them with absolute links to the very same host, and the very
1216 same page. In this mode (which is the default mode for following links)
1217 all @sc{url}s that refer to the same host will be retrieved.
1219 The problem with this option are the aliases of the hosts and domains.
1220 Thus there is no way for Wget to know that @samp{regoc.srce.hr} and
1221 @samp{www.srce.hr} are the same host, or that @samp{fly.cc.fer.hr} is
1222 the same as @samp{fly.cc.etf.hr}. Whenever an absolute link is
1223 encountered, the host is @sc{dns}-looked-up with @code{gethostbyname} to
1224 check whether we are maybe dealing with the same hosts. Although the
1225 results of @code{gethostbyname} are cached, it is still a great
1226 slowdown, e.g. when dealing with large indices of home pages on different
1227 hosts (because each of the hosts must be @sc{dns}-resolved to see
1228 whether it just @emph{might} be an alias of the starting host).
1230 To avoid the overhead you may use @samp{-nh}, which will turn off
1231 @sc{dns}-resolving and make Wget compare hosts literally. This will
1232 make things run much faster, but also much less reliable
1233 (e.g. @samp{www.srce.hr} and @samp{regoc.srce.hr} will be flagged as
1236 Note that modern @sc{http} servers allow one IP address to host several
1237 @dfn{virtual servers}, each having its own directory hierarchy. Such
1238 ``servers'' are distinguished by their hostnames (all of which point to
1239 the same IP address); for this to work, a client must send a @code{Host}
1240 header, which is what Wget does. However, in that case Wget @emph{must
1241 not} try to divine a host's ``real'' address, nor try to use the same
1242 hostname for each access, i.e. @samp{-nh} must be turned on.
1244 In other words, the @samp{-nh} option must be used to enable the
1245 retrieval from virtual servers distinguished by their hostnames. As the
1246 number of such server setups grow, the behavior of @samp{-nh} may become
1247 the default in the future.
1249 @node Domain Acceptance, All Hosts, Host Checking, Following Links
1250 @section Domain Acceptance
1252 With the @samp{-D} option you may specify the domains that will be
1253 followed. The hosts the domain of which is not in this list will not be
1254 @sc{dns}-resolved. Thus you can specify @samp{-Dmit.edu} just to make
1255 sure that @strong{nothing outside of @sc{mit} gets looked up}. This is
1256 very important and useful. It also means that @samp{-D} does @emph{not}
1257 imply @samp{-H} (span all hosts), which must be specified explicitly.
1258 Feel free to use this options since it will speed things up, with almost
1259 all the reliability of checking for all hosts. Thus you could invoke
1262 wget -r -D.hr http://fly.cc.fer.hr/
1265 to make sure that only the hosts in @samp{.hr} domain get
1266 @sc{dns}-looked-up for being equal to @samp{fly.cc.fer.hr}. So
1267 @samp{fly.cc.etf.hr} will be checked (only once!) and found equal, but
1268 @samp{www.gnu.ai.mit.edu} will not even be checked.
1270 Of course, domain acceptance can be used to limit the retrieval to
1271 particular domains with spanning of hosts in them, but then you must
1272 specify @samp{-H} explicitly. E.g.:
1275 wget -r -H -Dmit.edu,stanford.edu http://www.mit.edu/
1278 will start with @samp{http://www.mit.edu/}, following links across
1279 @sc{mit} and Stanford.
1281 If there are domains you want to exclude specifically, you can do it
1282 with @samp{--exclude-domains}, which accepts the same type of arguments
1283 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1284 example, if you want to download all the hosts from @samp{foo.edu}
1285 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1289 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu http://www.foo.edu/
1292 @node All Hosts, Types of Files, Domain Acceptance, Following Links
1297 When @samp{-H} is specified without @samp{-D}, all hosts are freely
1298 spanned. There are no restrictions whatsoever as to what part of the
1299 net Wget will go to fetch documents, other than maximum retrieval depth.
1300 If a page references @samp{www.yahoo.com}, so be it. Such an option is
1301 rarely useful for itself.
1303 @node Types of Files, Directory-Based Limits, All Hosts, Following Links
1304 @section Types of Files
1305 @cindex types of files
1307 When downloading material from the web, you will often want to restrict
1308 the retrieval to only certain file types. For example, if you are
1309 interested in downloading @sc{gif}s, you will not be overjoyed to get
1310 loads of PostScript documents, and vice versa.
1312 Wget offers two options to deal with this problem. Each option
1313 description lists a short name, a long name, and the equivalent command
1316 @cindex accept wildcards
1317 @cindex accept suffixes
1318 @cindex wildcards, accept
1319 @cindex suffixes, accept
1321 @item -A @var{acclist}
1322 @itemx --accept @var{acclist}
1323 @itemx accept = @var{acclist}
1324 The argument to @samp{--accept} option is a list of file suffixes or
1325 patterns that Wget will download during recursive retrieval. A suffix
1326 is the ending part of a file, and consists of ``normal'' letters,
1327 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1328 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1330 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1331 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1332 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1333 download only files beginning with @samp{zelazny} and containing numbers
1334 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1335 a description of how pattern matching works.
1337 Of course, any number of suffixes and patterns can be combined into a
1338 comma-separated list, and given as an argument to @samp{-A}.
1340 @cindex reject wildcards
1341 @cindex reject suffixes
1342 @cindex wildcards, reject
1343 @cindex suffixes, reject
1344 @item -R @var{rejlist}
1345 @itemx --reject @var{rejlist}
1346 @itemx reject = @var{rejlist}
1347 The @samp{--reject} option works the same way as @samp{--accept}, only
1348 its logic is the reverse; Wget will download all files @emph{except} the
1349 ones matching the suffixes (or patterns) in the list.
1351 So, if you want to download a whole page except for the cumbersome
1352 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1353 Analogously, to download all files except the ones beginning with
1354 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1355 expansion by the shell.
1358 The @samp{-A} and @samp{-R} options may be combined to achieve even
1359 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1360 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1361 a part of their name, but @emph{not} the PostScript files.
1363 Note that these two options do not affect the downloading of @sc{html}
1364 files; Wget must load all the @sc{html}s to know where to go at
1365 all---recursive retrieval would make no sense otherwise.
1367 @node Directory-Based Limits, FTP Links, Types of Files, Following Links
1368 @section Directory-Based Limits
1370 @cindex directory limits
1372 Regardless of other link-following facilities, it is often useful to
1373 place the restriction of what files to retrieve based on the directories
1374 those files are placed in. There can be many reasons for this---the
1375 home pages may be organized in a reasonable directory structure; or some
1376 directories may contain useless information, e.g. @file{/cgi-bin} or
1377 @file{/dev} directories.
1379 Wget offers three different options to deal with this requirement. Each
1380 option description lists a short name, a long name, and the equivalent
1381 command in @file{.wgetrc}.
1383 @cindex directories, include
1384 @cindex include directories
1385 @cindex accept directories
1388 @itemx --include @var{list}
1389 @itemx include_directories = @var{list}
1390 @samp{-I} option accepts a comma-separated list of directories included
1391 in the retrieval. Any other directories will simply be ignored. The
1392 directories are absolute paths.
1394 So, if you wish to download from @samp{http://host/people/bozo/}
1395 following only links to bozo's colleagues in the @file{/people}
1396 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1399 wget -I /people,/cgi-bin http://host/people/bozo/
1402 @cindex directories, exclude
1403 @cindex exclude directories
1404 @cindex reject directories
1406 @itemx --exclude @var{list}
1407 @itemx exclude_directories = @var{list}
1408 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1409 directories @emph{excluded} from the download. E.g. if you do not want
1410 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1411 /cgi-bin} on the command line.
1413 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1414 to get a better fine-tuning of downloading subdirectories. E.g. if you
1415 want to load all the files from @file{/pub} hierarchy except for
1416 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1421 @itemx no_parent = on
1422 The simplest, and often very useful way of limiting directories is
1423 disallowing retrieval of the links that refer to the hierarchy
1424 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1425 parent directory/directories.
1427 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1428 Using it guarantees that you will never leave the existing hierarchy.
1429 Supposing you issue Wget with:
1432 wget -r --no-parent http://somehost/~luzer/my-archive/
1435 You may rest assured that none of the references to
1436 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1437 followed. Only the archive you are interested in will be downloaded.
1438 Essentially, @samp{--no-parent} is similar to
1439 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1440 intelligent fashion.
1443 @node FTP Links, , Directory-Based Limits, Following Links
1444 @section Following FTP Links
1445 @cindex following ftp links
1447 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1448 them to be. @sc{ftp} links in @sc{html} documents are often included
1449 for purposes of reference, and it is often inconvenient to download them
1452 To have @sc{ftp} links followed from @sc{html} documents, you need to
1453 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1454 links will span hosts regardless of @samp{-H} setting. This is logical,
1455 as @sc{ftp} links rarely point to the same host where the @sc{http}
1456 server resides. For similar reasons, the @samp{-L} options has no
1457 effect on such downloads. On the other hand, domain acceptance
1458 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1460 Also note that followed links to @sc{ftp} directories will not be
1461 retrieved recursively further.
1463 @node Time-Stamping, Startup File, Following Links, Top
1464 @chapter Time-Stamping
1465 @cindex time-stamping
1466 @cindex timestamping
1467 @cindex updating the archives
1468 @cindex incremental updating
1470 One of the most important aspects of mirroring information from the
1471 Internet is updating your archives.
1473 Downloading the whole archive again and again, just to replace a few
1474 changed files is expensive, both in terms of wasted bandwidth and money,
1475 and the time to do the update. This is why all the mirroring tools
1476 offer the option of incremental updating.
1478 Such an updating mechanism means that the remote server is scanned in
1479 search of @dfn{new} files. Only those new files will be downloaded in
1480 the place of the old ones.
1482 A file is considered new if one of these two conditions are met:
1486 A file of that name does not already exist locally.
1489 A file of that name does exist, but the remote file was modified more
1490 recently than the local file.
1493 To implement this, the program needs to be aware of the time of last
1494 modification of both remote and local files. Such information are
1495 called the @dfn{time-stamps}.
1497 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1498 (@samp{-N}) option, or through @code{timestamping = on} directive in
1499 @file{.wgetrc}. With this option, for each file it intends to download,
1500 Wget will check whether a local file of the same name exists. If it
1501 does, and the remote file is older, Wget will not download it.
1503 If the local file does not exist, or the sizes of the files do not
1504 match, Wget will download the remote file no matter what the time-stamps
1508 * Time-Stamping Usage::
1509 * HTTP Time-Stamping Internals::
1510 * FTP Time-Stamping Internals::
1513 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1514 @section Time-Stamping Usage
1515 @cindex time-stamping usage
1516 @cindex usage, time-stamping
1518 The usage of time-stamping is simple. Say you would like to download a
1519 file so that it keeps its date of modification.
1522 wget -S http://www.gnu.ai.mit.edu/
1525 A simple @code{ls -l} shows that the time stamp on the local file equals
1526 the state of the @code{Last-Modified} header, as returned by the server.
1527 As you can see, the time-stamping info is preserved locally, even
1530 Several days later, you would like Wget to check if the remote file has
1531 changed, and download it if it has.
1534 wget -N http://www.gnu.ai.mit.edu/
1537 Wget will ask the server for the last-modified date. If the local file
1538 is newer, the remote file will not be re-fetched. However, if the remote
1539 file is more recent, Wget will proceed fetching it normally.
1541 The same goes for @sc{ftp}. For example:
1544 wget ftp://ftp.ifi.uio.no/pub/emacs/gnus/*
1547 @code{ls} will show that the timestamps are set according to the state
1548 on the remote server. Reissuing the command with @samp{-N} will make
1549 Wget re-fetch @emph{only} the files that have been modified.
1551 In both @sc{http} and @sc{ftp} retrieval Wget will time-stamp the local
1552 file correctly (with or without @samp{-N}) if it gets the stamps,
1553 i.e. gets the directory listing for @sc{ftp} or the @code{Last-Modified}
1554 header for @sc{http}.
1556 If you wished to mirror the GNU archive every week, you would use the
1557 following command every week:
1560 wget --timestamping -r ftp://prep.ai.mit.edu/pub/gnu/
1563 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1564 @section HTTP Time-Stamping Internals
1565 @cindex http time-stamping
1567 Time-stamping in @sc{http} is implemented by checking of the
1568 @code{Last-Modified} header. If you wish to retrieve the file
1569 @file{foo.html} through @sc{http}, Wget will check whether
1570 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1571 retrieved unconditionally.
1573 If the file does exist locally, Wget will first check its local
1574 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1575 @code{HEAD} request to the remote server, demanding the information on
1578 The @code{Last-Modified} header is examined to find which file was
1579 modified more recently (which makes it ``newer''). If the remote file
1580 is newer, it will be downloaded; if it is older, Wget will give
1581 up.@footnote{As an additional check, Wget will look at the
1582 @code{Content-Length} header, and compare the sizes; if they are not the
1583 same, the remote file will be downloaded no matter what the time-stamp
1586 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1587 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1588 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1589 @samp{@var{X}}, which will always differ if it's been converted by
1590 @samp{--convert-links} (@samp{-k}).
1592 Arguably, @sc{http} time-stamping should be implemented using the
1593 @code{If-Modified-Since} request.
1595 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1596 @section FTP Time-Stamping Internals
1597 @cindex ftp time-stamping
1599 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1600 @sc{ftp} has no headers---time-stamps must be received from the
1603 For each directory files must be retrieved from, Wget will use the
1604 @code{LIST} command to get the listing. It will try to analyze the
1605 listing, assuming that it is a Unix @code{ls -l} listing, and extract
1606 the time-stamps. The rest is exactly the same as for @sc{http}.
1608 Assumption that every directory listing is a Unix-style listing may
1609 sound extremely constraining, but in practice it is not, as many
1610 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1611 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1612 defines no standard way to get a file list, let alone the time-stamps.
1613 We can only hope that a future standard will define this.
1615 Another non-standard solution includes the use of @code{MDTM} command
1616 that is supported by some @sc{ftp} servers (including the popular
1617 @code{wu-ftpd}), which returns the exact time of the specified file.
1618 Wget may support this command in the future.
1620 @node Startup File, Examples, Time-Stamping, Top
1621 @chapter Startup File
1622 @cindex startup file
1628 Once you know how to change default settings of Wget through command
1629 line arguments, you may wish to make some of those settings permanent.
1630 You can do that in a convenient way by creating the Wget startup
1631 file---@file{.wgetrc}.
1633 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1634 convenient to have a special facility for storing passwords. Thus Wget
1635 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1636 it. You can find @file{.netrc} format in your system manuals.
1638 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1642 * Wgetrc Location:: Location of various wgetrc files.
1643 * Wgetrc Syntax:: Syntax of wgetrc.
1644 * Wgetrc Commands:: List of available commands.
1645 * Sample Wgetrc:: A wgetrc example.
1648 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1649 @section Wgetrc Location
1650 @cindex wgetrc location
1651 @cindex location of wgetrc
1653 When initializing, Wget will look for a @dfn{global} startup file,
1654 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1655 @file{/usr/local}, if Wget was not installed there) and read commands
1656 from there, if it exists.
1658 Then it will look for the user's file. If the environmental variable
1659 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1660 further attempts will be made.
1662 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1664 The fact that user's settings are loaded after the system-wide ones
1665 means that in case of collision user's wgetrc @emph{overrides} the
1666 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1667 Fascist admins, away!
1669 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1670 @section Wgetrc Syntax
1671 @cindex wgetrc syntax
1672 @cindex syntax of wgetrc
1674 The syntax of a wgetrc command is simple:
1680 The @dfn{variable} will also be called @dfn{command}. Valid
1681 @dfn{values} are different for different commands.
1683 The commands are case-insensitive and underscore-insensitive. Thus
1684 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1685 beginning with @samp{#} and lines containing white-space only are
1688 Commands that expect a comma-separated list will clear the list on an
1689 empty command. So, if you wish to reset the rejection list specified in
1690 global @file{wgetrc}, you can do it with:
1696 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1697 @section Wgetrc Commands
1698 @cindex wgetrc commands
1700 The complete set of commands is listed below. Legal values are listed
1701 after the @samp{=}. Simple Boolean values can be set or unset using
1702 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
1703 Boolean allowed in some cases is the "lockable" Boolean, which may be
1704 set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
1705 option is set to @samp{always} or @samp{never}, that value will be
1706 locked in for the duration of the wget invocation -- commandline options
1709 Some commands take pseudo-arbitrary values. @var{string} values can be
1710 any non-empty string. @var{n} can be any positive integer, or
1711 @samp{inf} for infinity, where appropriate.
1713 Most of these commands have commandline equivalents (@xref{Invoking}),
1714 though some of the more obscure or rarely used ones do not.
1717 @item accept/reject = @var{string}
1718 Same as @samp{-A}/@samp{-R} (@xref{Types of Files}).
1720 @item add_hostdir = on/off
1721 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1723 @item continue = on/off
1724 Enable/disable continuation of the retrieval -- the same as @samp{-c}
1727 @item background = on/off
1728 Enable/disable going to background -- the same as @samp{-b} (which enables
1731 @item backup_converted = on/off
1732 Enable/disable saving pre-converted files with the suffix @samp{.orig}
1733 -- the same as @samp{-K} (which enables it).
1735 @c @item backups = @var{number}
1736 @c #### Document me!
1738 @item base = @var{string}
1739 Consider relative @sc{url}s in @sc{url} input files forced to be
1740 interpreted as @sc{html} as being relative to @var{string} -- the same
1743 @item cache = on/off
1744 When set to off, disallow server-caching. See the @samp{-C} option.
1746 @item convert links = on/off
1747 Convert non-relative links locally. The same as @samp{-k}.
1749 @item cut_dirs = @var{n}
1750 Ignore @var{n} remote directory components.
1752 @item debug = on/off
1753 Debug mode, same as @samp{-d}.
1755 @item delete_after = on/off
1756 Delete after download -- the same as @samp{--delete-after}.
1758 @item dir_prefix = @var{string}
1759 Top of directory tree -- the same as @samp{-P}.
1761 @item dirstruct = on/off
1762 Turning dirstruct on or off -- the same as @samp{-x} or @samp{-nd},
1765 @item domains = @var{string}
1766 Same as @samp{-D} (@xref{Domain Acceptance}).
1768 @item dot_bytes = @var{n}
1769 Specify the number of bytes ``contained'' in a dot, as seen throughout
1770 the retrieval (1024 by default). You can postfix the value with
1771 @samp{k} or @samp{m}, representing kilobytes and megabytes,
1772 respectively. With dot settings you can tailor the dot retrieval to
1773 suit your needs, or you can use the predefined @dfn{styles}
1774 (@xref{Download Options}).
1776 @item dots_in_line = @var{n}
1777 Specify the number of dots that will be printed in each line throughout
1778 the retrieval (50 by default).
1780 @item dot_spacing = @var{n}
1781 Specify the number of dots in a single cluster (10 by default).
1783 @item dot_style = @var{string}
1784 Specify the dot retrieval @dfn{style}, as with @samp{--dot-style}.
1786 @item exclude_directories = @var{string}
1787 Specify a comma-separated list of directories you wish to exclude from
1788 download -- the same as @samp{-X} (@xref{Directory-Based Limits}).
1790 @item exclude_domains = @var{string}
1791 Same as @samp{--exclude-domains} (@xref{Domain Acceptance}).
1793 @item follow_ftp = on/off
1794 Follow @sc{ftp} links from @sc{html} documents -- the same as @samp{-f}.
1796 @item follow_tags = @var{string}
1797 Only follow certain HTML tags when doing a recursive retrieval, just like
1798 @samp{--follow-tags}.
1800 @item force_html = on/off
1801 If set to on, force the input filename to be regarded as an @sc{html}
1802 document -- the same as @samp{-F}.
1804 @item ftp_proxy = @var{string}
1805 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
1809 Turn globbing on/off -- the same as @samp{-g}.
1811 @item header = @var{string}
1812 Define an additional header, like @samp{--header}.
1814 @item html_extension = on/off
1815 Add a @samp{.html} extension to @samp{text/html} files without it, like
1818 @item http_passwd = @var{string}
1819 Set @sc{http} password.
1821 @item http_proxy = @var{string}
1822 Use @var{string} as @sc{http} proxy, instead of the one specified in
1825 @item http_user = @var{string}
1826 Set @sc{http} user to @var{string}.
1828 @item ignore_length = on/off
1829 When set to on, ignore @code{Content-Length} header; the same as
1830 @samp{--ignore-length}.
1832 @item ignore_tags = @var{string}
1833 Ignore certain HTML tags when doing a recursive retrieval, just like
1834 @samp{-G} / @samp{--ignore-tags}.
1836 @item include_directories = @var{string}
1837 Specify a comma-separated list of directories you wish to follow when
1838 downloading -- the same as @samp{-I}.
1840 @item input = @var{string}
1841 Read the @sc{url}s from @var{string}, like @samp{-i}.
1843 @item kill_longer = on/off
1844 Consider data longer than specified in content-length header
1845 as invalid (and retry getting it). The default behaviour is to save
1846 as much data as there is, provided there is more than or equal
1847 to the value in @code{Content-Length}.
1849 @item logfile = @var{string}
1850 Set logfile -- the same as @samp{-o}.
1852 @item login = @var{string}
1853 Your user name on the remote machine, for @sc{ftp}. Defaults to
1856 @item mirror = on/off
1857 Turn mirroring on/off. The same as @samp{-m}.
1859 @item netrc = on/off
1860 Turn reading netrc on or off.
1862 @item noclobber = on/off
1865 @item no_parent = on/off
1866 Disallow retrieving outside the directory hierarchy, like
1867 @samp{--no-parent} (@xref{Directory-Based Limits}).
1869 @item no_proxy = @var{string}
1870 Use @var{string} as the comma-separated list of domains to avoid in
1871 proxy loading, instead of the one specified in environment.
1873 @item output_document = @var{string}
1874 Set the output filename -- the same as @samp{-O}.
1876 @item page_requisites = on/off
1877 Download all ancillary documents necessary for a single HTML page to
1878 display properly -- the same as @samp{-p}.
1880 @item passive_ftp = on/off/always/never
1881 Set passive @sc{ftp} -- the same as @samp{--passive-ftp}. Some scripts
1882 and @samp{.pm} (Perl module) files download files using @samp{wget
1883 --passive-ftp}. If your firewall does not allow this, you can set
1884 @samp{passive_ftp = never} to override the commandline.
1886 @item passwd = @var{string}
1887 Set your @sc{ftp} password to @var{password}. Without this setting, the
1888 password defaults to @samp{username@@hostname.domainname}.
1890 @item proxy_user = @var{string}
1891 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
1893 @item proxy_passwd = @var{string}
1894 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
1896 @item referer = @var{string}
1897 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
1898 was the folks who wrote the @sc{http} spec who got the spelling of
1901 @item quiet = on/off
1902 Quiet mode -- the same as @samp{-q}.
1904 @item quota = @var{quota}
1905 Specify the download quota, which is useful to put in the global
1906 @file{wgetrc}. When download quota is specified, Wget will stop retrieving
1907 after the download sum has become greater than quota. The quota can be
1908 specified in bytes (default), kbytes @samp{k} appended) or mbytes
1909 (@samp{m} appended). Thus @samp{quota = 5m} will set the quota to 5
1910 mbytes. Note that the user's startup file overrides system settings.
1912 @item reclevel = @var{n}
1913 Recursion level -- the same as @samp{-l}.
1915 @item recursive = on/off
1916 Recursive on/off -- the same as @samp{-r}.
1918 @item relative_only = on/off
1919 Follow only relative links -- the same as @samp{-L} (@xref{Relative
1922 @item remove_listing = on/off
1923 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
1924 to off is the same as @samp{-nr}.
1926 @item retr_symlinks = on/off
1927 When set to on, retrieve symbolic links as if they were plain files; the
1928 same as @samp{--retr-symlinks}.
1930 @item robots = on/off
1931 Use (or not) @file{/robots.txt} file (@xref{Robots}). Be sure to know
1932 what you are doing before changing the default (which is @samp{on}).
1934 @item server_response = on/off
1935 Choose whether or not to print the @sc{http} and @sc{ftp} server
1936 responses -- the same as @samp{-S}.
1938 @item simple_host_check = on/off
1939 Same as @samp{-nh} (@xref{Host Checking}).
1941 @item span_hosts = on/off
1944 @item timeout = @var{n}
1945 Set timeout value -- the same as @samp{-T}.
1947 @item timestamping = on/off
1948 Turn timestamping on/off. The same as @samp{-N} (@xref{Time-Stamping}).
1950 @item tries = @var{n}
1951 Set number of retries per @sc{url} -- the same as @samp{-t}.
1953 @item use_proxy = on/off
1954 Turn proxy support on/off. The same as @samp{-Y}.
1956 @item verbose = on/off
1957 Turn verbose on/off -- the same as @samp{-v}/@samp{-nv}.
1959 @item wait = @var{n}
1960 Wait @var{n} seconds between retrievals -- the same as @samp{-w}.
1962 @item waitretry = @var{n}
1963 Wait up to @var{n} seconds between retries of failed retrievals only --
1964 the same as @samp{--waitretry}. Note that this is turned on by default
1965 in the global @file{wgetrc}.
1968 @node Sample Wgetrc, , Wgetrc Commands, Startup File
1969 @section Sample Wgetrc
1970 @cindex sample wgetrc
1972 This is the sample initialization file, as given in the distribution.
1973 It is divided in two section---one for global usage (suitable for global
1974 startup file), and one for local usage (suitable for
1975 @file{$HOME/.wgetrc}). Be careful about the things you change.
1977 Note that almost all the lines are commented out. For a command to have
1978 any effect, you must remove the @samp{#} character at the beginning of
1982 @include sample.wgetrc.munged_for_texi_inclusion
1985 @node Examples, Various, Startup File, Top
1989 The examples are classified into three sections, because of clarity.
1990 The first section is a tutorial for beginners. The second section
1991 explains some of the more complex program features. The third section
1992 contains advice for mirror administrators, as well as even more complex
1993 features (that some would call perverted).
1996 * Simple Usage:: Simple, basic usage of the program.
1997 * Advanced Usage:: Advanced techniques of usage.
1998 * Guru Usage:: Mirroring and the hairy stuff.
2001 @node Simple Usage, Advanced Usage, Examples, Examples
2002 @section Simple Usage
2006 Say you want to download a @sc{url}. Just type:
2009 wget http://fly.cc.fer.hr/
2012 The response will be something like:
2016 --13:30:45-- http://fly.cc.fer.hr:80/en/
2018 Connecting to fly.cc.fer.hr:80... connected!
2019 HTTP request sent, awaiting response... 200 OK
2020 Length: 4,694 [text/html]
2024 13:30:46 (23.75 KB/s) - `index.html' saved [4694/4694]
2029 But what will happen if the connection is slow, and the file is lengthy?
2030 The connection will probably fail before the whole file is retrieved,
2031 more than once. In this case, Wget will try getting the file until it
2032 either gets the whole of it, or exceeds the default number of retries
2033 (this being 20). It is easy to change the number of tries to 45, to
2034 insure that the whole file will arrive safely:
2037 wget --tries=45 http://fly.cc.fer.hr/jpg/flyweb.jpg
2041 Now let's leave Wget to work in the background, and write its progress
2042 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2043 shall use @samp{-t}.
2046 wget -t 45 -o log http://fly.cc.fer.hr/jpg/flyweb.jpg &
2049 The ampersand at the end of the line makes sure that Wget works in the
2050 background. To unlimit the number of retries, use @samp{-t inf}.
2053 The usage of @sc{ftp} is as simple. Wget will take care of login and
2058 $ wget ftp://gnjilux.cc.fer.hr/welcome.msg
2059 --10:08:47-- ftp://gnjilux.cc.fer.hr:21/welcome.msg
2061 Connecting to gnjilux.cc.fer.hr:21... connected!
2062 Logging in as anonymous ... Logged in!
2063 ==> TYPE I ... done. ==> CWD not needed.
2064 ==> PORT ... done. ==> RETR welcome.msg ... done.
2065 Length: 1,340 (unauthoritative)
2069 10:08:48 (1.28 MB/s) - `welcome.msg' saved [1340]
2074 If you specify a directory, Wget will retrieve the directory listing,
2075 parse it and convert it to @sc{html}. Try:
2078 wget ftp://prep.ai.mit.edu/pub/gnu/
2083 @node Advanced Usage, Guru Usage, Simple Usage, Examples
2084 @section Advanced Usage
2088 You would like to read the list of @sc{url}s from a file? Not a problem
2095 If you specify @samp{-} as file name, the @sc{url}s will be read from
2099 Create a mirror image of GNU @sc{www} site (with the same directory structure
2100 the original has) with only one try per document, saving the log of the
2101 activities to @file{gnulog}:
2104 wget -r -t1 http://www.gnu.ai.mit.edu/ -o gnulog
2108 Retrieve the first layer of yahoo links:
2111 wget -r -l1 http://www.yahoo.com/
2115 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2119 wget -S http://www.lycos.com/
2123 Save the server headers with the file:
2125 wget -s http://www.lycos.com/
2130 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2134 wget -P/tmp -l2 ftp://wuarchive.wustl.edu/
2138 You want to download all the @sc{gif}s from an @sc{http} directory.
2139 @samp{wget http://host/dir/*.gif} doesn't work, since @sc{http}
2140 retrieval does not support globbing. In that case, use:
2143 wget -r -l1 --no-parent -A.gif http://host/dir/
2146 It is a bit of a kludge, but it works. @samp{-r -l1} means to retrieve
2147 recursively (@xref{Recursive Retrieval}), with maximum depth of 1.
2148 @samp{--no-parent} means that references to the parent directory are
2149 ignored (@xref{Directory-Based Limits}), and @samp{-A.gif} means to
2150 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2154 Suppose you were in the middle of downloading, when Wget was
2155 interrupted. Now you do not want to clobber the files already present.
2159 wget -nc -r http://www.gnu.ai.mit.edu/
2163 If you want to encode your own username and password to @sc{http} or
2164 @sc{ftp}, use the appropriate @sc{url} syntax (@xref{URL Format}).
2167 wget ftp://hniksic:mypassword@@jagor.srce.hr/.emacs
2171 If you do not like the default retrieval visualization (1K dots with 10
2172 dots per cluster and 50 dots per line), you can customize it through dot
2173 settings (@xref{Wgetrc Commands}). For example, many people like the
2174 ``binary'' style of retrieval, with 8K dots and 512K lines:
2177 wget --dot-style=binary ftp://prep.ai.mit.edu/pub/gnu/README
2180 You can experiment with other styles, like:
2183 wget --dot-style=mega ftp://ftp.xemacs.org/pub/xemacs/xemacs-20.4/xemacs-20.4.tar.gz
2184 wget --dot-style=micro http://fly.cc.fer.hr/
2187 To make these settings permanent, put them in your @file{.wgetrc}, as
2188 described before (@xref{Sample Wgetrc}).
2191 @node Guru Usage, , Advanced Usage, Examples
2197 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2198 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2199 for @samp{-r -N}. You can put Wget in the crontab file asking it to
2200 recheck a site each Sunday:
2204 0 0 * * 0 wget --mirror ftp://ftp.xemacs.org/pub/xemacs/ -o /home/me/weeklog
2208 You may wish to do the same with someone's home page. But you do not
2209 want to download all those images---you're only interested in @sc{html}.
2212 wget --mirror -A.html http://www.w3.org/
2216 But what about mirroring the hosts networkologically close to you? It
2217 seems so awfully slow because of all that @sc{dns} resolving. Just use
2218 @samp{-D} (@xref{Domain Acceptance}).
2221 wget -rN -Dsrce.hr http://www.srce.hr/
2224 Now Wget will correctly find out that @samp{regoc.srce.hr} is the same
2225 as @samp{www.srce.hr}, but will not even take into consideration the
2226 link to @samp{www.mit.edu}.
2229 You have a presentation and would like the dumb absolute links to be
2230 converted to relative? Use @samp{-k}:
2233 wget -k -r @var{URL}
2236 @cindex redirecting output
2238 You would like the output documents to go to standard output instead of
2239 to files? OK, but Wget will automatically shut up (turn on
2240 @samp{--quiet}) to prevent mixing of Wget output and the retrieved
2244 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2247 You can also combine the two options and make weird pipelines to
2248 retrieve the documents from remote hotlists:
2251 wget -O - http://cool.list.com/ | wget --force-html -i -
2255 @node Various, Appendices, Examples, Top
2259 This chapter contains all the stuff that could not fit anywhere else.
2262 * Proxies:: Support for proxy servers
2263 * Distribution:: Getting the latest version.
2264 * Mailing List:: Wget mailing list for announcements and discussion.
2265 * Reporting Bugs:: How and where to report bugs.
2266 * Portability:: The systems Wget works on.
2267 * Signals:: Signal-handling performed by Wget.
2270 @node Proxies, Distribution, Various, Various
2274 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2275 data from remote servers to local clients. One typical use of proxies
2276 is lightening network load for users behind a slow connection. This is
2277 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2278 proxy which caches the transferred data. When a cached resource is
2279 requested again, proxy will return the data from cache. Another use for
2280 proxies is for companies that separate (for security reasons) their
2281 internal networks from the rest of Internet. In order to obtain
2282 information from the Web, their users connect and retrieve remote data
2283 using an authorized proxy.
2285 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2286 standard way to specify proxy location, which Wget recognizes, is using
2287 the following environment variables:
2291 This variable should contain the @sc{url} of the proxy for @sc{http}
2295 This variable should contain the @sc{url} of the proxy for @sc{http}
2296 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2297 are set to the same @sc{url}.
2300 This variable should contain a comma-separated list of domain extensions
2301 proxy should @emph{not} be used for. For instance, if the value of
2302 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2306 In addition to the environment variables, proxy location and settings
2307 may be specified from within Wget itself.
2311 @itemx --proxy=on/off
2312 @itemx proxy = on/off
2313 This option may be used to turn the proxy support on or off. Proxy
2314 support is on by default, provided that the appropriate environment
2317 @item http_proxy = @var{URL}
2318 @itemx ftp_proxy = @var{URL}
2319 @itemx no_proxy = @var{string}
2320 These startup file variables allow you to override the proxy settings
2321 specified by the environment.
2324 Some proxy servers require authorization to enable you to use them. The
2325 authorization consists of @dfn{username} and @dfn{password}, which must
2326 be sent by Wget. As with @sc{http} authorization, several
2327 authentication schemes exist. For proxy authorization only the
2328 @code{Basic} authentication scheme is currently implemented.
2330 You may specify your username and password either through the proxy
2331 @sc{url} or through the command-line options. Assuming that the
2332 company's proxy is located at @samp{proxy.srce.hr} at port 8001, a proxy
2333 @sc{url} location containing authorization data might look like this:
2336 http://hniksic:mypassword@@proxy.company.com:8001/
2339 Alternatively, you may use the @samp{proxy-user} and
2340 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2341 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2342 username and password.
2344 @node Distribution, Mailing List, Proxies, Various
2345 @section Distribution
2346 @cindex latest version
2348 Like all GNU utilities, the latest version of Wget can be found at the
2349 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2350 Wget @value{VERSION} can be found at
2351 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2353 @node Mailing List, Reporting Bugs, Distribution, Various
2354 @section Mailing List
2355 @cindex mailing list
2358 Wget has its own mailing list at @email{wget@@sunsite.auc.dk}, thanks
2359 to Karsten Thygesen. The mailing list is for discussion of Wget
2360 features and web, reporting Wget bugs (those that you think may be of
2361 interest to the public) and mailing announcements. You are welcome to
2362 subscribe. The more people on the list, the better!
2364 To subscribe, send mail to @email{wget-subscribe@@sunsite.auc.dk}.
2365 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2366 mailing to @email{wget-unsubscribe@@sunsite.auc.dk}.
2368 The mailing list is archived at @url{http://fly.cc.fer.hr/archive/wget}.
2370 @node Reporting Bugs, Portability, Mailing List, Various
2371 @section Reporting Bugs
2373 @cindex reporting bugs
2376 You are welcome to send bug reports about GNU Wget to
2377 @email{bug-wget@@gnu.org}. The bugs that you think are of the
2378 interest to the public (i.e. more people should be informed about them)
2379 can be Cc-ed to the mailing list at @email{wget@@sunsite.auc.dk}.
2381 Before actually submitting a bug report, please try to follow a few
2386 Please try to ascertain that the behaviour you see really is a bug. If
2387 Wget crashes, it's a bug. If Wget does not behave as documented,
2388 it's a bug. If things work strange, but you are not sure about the way
2389 they are supposed to work, it might well be a bug.
2392 Try to repeat the bug in as simple circumstances as possible. E.g. if
2393 Wget crashes on @samp{wget -rLl0 -t5 -Y0 http://yoyodyne.com -o
2394 /tmp/log}, you should try to see if it will crash with a simpler set of
2397 Also, while I will probably be interested to know the contents of your
2398 @file{.wgetrc} file, just dumping it into the debug message is probably
2399 a bad idea. Instead, you should first try to see if the bug repeats
2400 with @file{.wgetrc} moved out of the way. Only if it turns out that
2401 @file{.wgetrc} settings affect the bug, should you mail me the relevant
2405 Please start Wget with @samp{-d} option and send the log (or the
2406 relevant parts of it). If Wget was compiled without debug support,
2407 recompile it. It is @emph{much} easier to trace bugs with debug support
2411 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2412 wget` core} and type @code{where} to get the backtrace.
2415 Find where the bug is, fix it and send me the patches. :-)
2418 @node Portability, Signals, Reporting Bugs, Various
2419 @section Portability
2421 @cindex operating systems
2423 Since Wget uses GNU Autoconf for building and configuring, and avoids
2424 using ``special'' ultra--mega--cool features of any particular Unix, it
2425 should compile (and work) on all common Unix flavors.
2427 Various Wget versions have been compiled and tested under many kinds of
2428 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2429 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2430 distribution directory for a comprehensive list. If you compile it on
2431 an architecture not listed there, please let me know so I can update it.
2433 Wget should also compile on the other Unix systems, not listed in
2434 @file{MACHINES}. If it doesn't, please let me know.
2436 Thanks to kind contributors, this version of Wget compiles and works on
2437 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2438 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2439 with Winsock as networking software. Naturally, it is crippled of some
2440 features available on Unix, but it should work as a substitute for
2441 people stuck with Windows. Note that the Windows port is
2442 @strong{neither tested nor maintained} by me---all questions and
2443 problems should be reported to Wget mailing list at
2444 @email{wget@@sunsite.auc.dk} where the maintainers will look at them.
2446 @node Signals, , Portability, Various
2448 @cindex signal handling
2451 Since the purpose of Wget is background work, it catches the hangup
2452 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2453 output, it will be redirected to a file named @file{wget-log}.
2454 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2455 to redirect the output of Wget after having started it.
2458 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2459 $ kill -HUP %% # Redirect the output to wget-log
2462 Other than that, Wget will not try to interfere with signals in any
2463 way. @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it
2466 @node Appendices, Copying, Various, Top
2469 This chapter contains some references I consider useful, like the Robots
2470 Exclusion Standard specification, as well as a list of contributors to
2474 * Robots:: Wget as a WWW robot.
2475 * Security Considerations:: Security with Wget.
2476 * Contributors:: People who helped.
2479 @node Robots, Security Considerations, Appendices, Appendices
2483 @cindex server maintenance
2485 Since Wget is able to traverse the web, it counts as one of the Web
2486 @dfn{robots}. Thus Wget understands @dfn{Robots Exclusion Standard}
2487 (@sc{res})---contents of @file{/robots.txt}, used by server
2488 administrators to shield parts of their systems from wanderings of Wget.
2490 Norobots support is turned on only when retrieving recursively, and
2491 @emph{never} for the first page. Thus, you may issue:
2494 wget -r http://fly.cc.fer.hr/
2497 First the index of fly.cc.fer.hr will be downloaded. If Wget finds
2498 anything worth downloading on the same host, only @emph{then} will it
2499 load the robots, and decide whether or not to load the links after all.
2500 @file{/robots.txt} is loaded only once per host. Wget does not support
2501 the robots @code{META} tag.
2503 The description of the norobots standard was written, and is maintained
2504 by Martijn Koster @email{m.koster@@webcrawler.com}. With his
2505 permission, I contribute a (slightly modified) TeXified version of the
2509 * Introduction to RES::
2511 * User-Agent Field::
2513 * Norobots Examples::
2516 @node Introduction to RES, RES Format, Robots, Robots
2517 @subsection Introduction to RES
2518 @cindex norobots introduction
2520 @dfn{WWW Robots} (also called @dfn{wanderers} or @dfn{spiders}) are
2521 programs that traverse many pages in the World Wide Web by recursively
2522 retrieving linked pages. For more information see the robots page.
2524 In 1993 and 1994 there have been occasions where robots have visited
2525 @sc{www} servers where they weren't welcome for various
2526 reasons. Sometimes these reasons were robot specific, e.g. certain
2527 robots swamped servers with rapid-fire requests, or retrieved the same
2528 files repeatedly. In other situations robots traversed parts of @sc{www}
2529 servers that weren't suitable, e.g. very deep virtual trees, duplicated
2530 information, temporary information, or cgi-scripts with side-effects
2533 These incidents indicated the need for established mechanisms for
2534 @sc{www} servers to indicate to robots which parts of their server
2535 should not be accessed. This standard addresses this need with an
2536 operational solution.
2538 This document represents a consensus on 30 June 1994 on the robots
2539 mailing list (@code{robots@@webcrawler.com}), between the majority of
2540 robot authors and other people with an interest in robots. It has also
2541 been open for discussion on the Technical World Wide Web mailing list
2542 (@code{www-talk@@info.cern.ch}). This document is based on a previous
2543 working draft under the same title.
2545 It is not an official standard backed by a standards body, or owned by
2546 any commercial organization. It is not enforced by anybody, and there
2547 no guarantee that all current and future robots will use it. Consider
2548 it a common facility the majority of robot authors offer the @sc{www}
2549 community to protect @sc{www} server against unwanted accesses by their
2552 The latest version of this document can be found at
2553 @url{http://info.webcrawler.com/mak/projects/robots/norobots.html}.
2555 @node RES Format, User-Agent Field, Introduction to RES, Robots
2556 @subsection RES Format
2557 @cindex norobots format
2559 The format and semantics of the @file{/robots.txt} file are as follows:
2561 The file consists of one or more records separated by one or more blank
2562 lines (terminated by @code{CR}, @code{CR/NL}, or @code{NL}). Each
2563 record contains lines of the form:
2566 <field>:<optionalspace><value><optionalspace>
2569 The field name is case insensitive.
2571 Comments can be included in file using UNIX Bourne shell conventions:
2572 the @samp{#} character is used to indicate that preceding space (if any)
2573 and the remainder of the line up to the line termination is discarded.
2574 Lines containing only a comment are discarded completely, and therefore
2575 do not indicate a record boundary.
2577 The record starts with one or more User-agent lines, followed by one or
2578 more Disallow lines, as detailed below. Unrecognized headers are
2581 The presence of an empty @file{/robots.txt} file has no explicit
2582 associated semantics, it will be treated as if it was not present,
2583 i.e. all robots will consider themselves welcome.
2585 @node User-Agent Field, Disallow Field, RES Format, Robots
2586 @subsection User-Agent Field
2587 @cindex norobots user-agent
2589 The value of this field is the name of the robot the record is
2590 describing access policy for.
2592 If more than one User-agent field is present the record describes an
2593 identical access policy for more than one robot. At least one field
2594 needs to be present per record.
2596 The robot should be liberal in interpreting this field. A case
2597 insensitive substring match of the name without version information is
2600 If the value is @samp{*}, the record describes the default access policy
2601 for any robot that has not matched any of the other records. It is not
2602 allowed to have multiple such records in the @file{/robots.txt} file.
2604 @node Disallow Field, Norobots Examples, User-Agent Field, Robots
2605 @subsection Disallow Field
2606 @cindex norobots disallow
2608 The value of this field specifies a partial @sc{url} that is not to be
2609 visited. This can be a full path, or a partial path; any @sc{url} that
2610 starts with this value will not be retrieved. For example,
2611 @w{@samp{Disallow: /help}} disallows both @samp{/help.html} and
2612 @samp{/help/index.html}, whereas @w{@samp{Disallow: /help/}} would
2613 disallow @samp{/help/index.html} but allow @samp{/help.html}.
2615 Any empty value, indicates that all @sc{url}s can be retrieved. At least
2616 one Disallow field needs to be present in a record.
2618 @node Norobots Examples, , Disallow Field, Robots
2619 @subsection Norobots Examples
2620 @cindex norobots examples
2622 The following example @samp{/robots.txt} file specifies that no robots
2623 should visit any @sc{url} starting with @samp{/cyberworld/map/} or
2627 # robots.txt for http://www.site.com/
2630 Disallow: /cyberworld/map/ # This is an infinite virtual URL space
2631 Disallow: /tmp/ # these will soon disappear
2634 This example @samp{/robots.txt} file specifies that no robots should
2635 visit any @sc{url} starting with @samp{/cyberworld/map/}, except the
2636 robot called @samp{cybermapper}:
2639 # robots.txt for http://www.site.com/
2642 Disallow: /cyberworld/map/ # This is an infinite virtual URL space
2644 # Cybermapper knows where to go.
2645 User-agent: cybermapper
2649 This example indicates that no robots should visit this site further:
2657 @node Security Considerations, Contributors, Robots, Appendices
2658 @section Security Considerations
2661 When using Wget, you must be aware that it sends unencrypted passwords
2662 through the network, which may present a security problem. Here are the
2663 main issues, and some solutions.
2667 The passwords on the command line are visible using @code{ps}. If this
2668 is a problem, avoid putting passwords from the command line---e.g. you
2669 can use @file{.netrc} for this.
2672 Using the insecure @dfn{basic} authentication scheme, unencrypted
2673 passwords are transmitted through the network routers and gateways.
2676 The @sc{ftp} passwords are also in no way encrypted. There is no good
2677 solution for this at the moment.
2680 Although the ``normal'' output of Wget tries to hide the passwords,
2681 debugging logs show them, in all forms. This problem is avoided by
2682 being careful when you send debug logs (yes, even when you send them to
2686 @node Contributors, , Security Considerations, Appendices
2687 @section Contributors
2688 @cindex contributors
2691 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@iskon.hr}.
2694 GNU Wget was written by Hrvoje Niksic @email{hniksic@@iskon.hr}.
2696 However, its development could never have gone as far as it has, were it
2697 not for the help of many people, either with bug reports, feature
2698 proposals, patches, or letters saying ``Thanks!''.
2700 Special thanks goes to the following people (no particular order):
2704 Karsten Thygesen---donated the mailing list and the initial @sc{ftp}
2708 Shawn McHorse---bug reports and patches.
2711 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization.
2714 Gordon Matzigkeit---@file{.netrc} support.
2718 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2719 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2722 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2723 and ``philosophical'' discussions.
2727 Darko Budor---initial port to Windows.
2730 Antonio Rosella---help and suggestions, plus the Italian translation.
2734 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2738 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2743 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2746 Francois Pinard---many thorough bug reports and discussions.
2750 Karl Eichwalder---lots of help with internationalization and other
2754 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2758 Brian Gough---a generous donation.
2761 The following people have provided patches, bug/build reports, useful
2762 suggestions, beta testing services, fan mail and all the other things
2763 that make maintenance so much fun:
2768 Roger Beeman and the Gurus at Cisco,
2777 Kristijan @v{C}onka@v{s},
2793 Aleksandar Erkalovi@'{c},
2796 Aleksandar Erkalovic,
2809 Erik Magnus Hulthen,
2819 Goran Kezunovi@'{c},
2829 $\Sigma\acute{\iota}\mu o\varsigma\;
2830 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
2831 (Simos KSenitellis),
2848 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
2850 Juan Jos\'{e} Rodr\'{\i}gues,
2853 Juan Jose Rodrigues,
2862 Szakacsits Szabolcs,
2866 Douglas E. Wegscheid,
2876 Apologies to all who I accidentally left out, and many thanks to all the
2877 subscribers of the Wget mailing list.
2879 @node Copying, Concept Index, Appendices, Top
2880 @unnumbered GNU GENERAL PUBLIC LICENSE
2883 @center Version 2, June 1991
2886 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
2887 675 Mass Ave, Cambridge, MA 02139, USA
2889 Everyone is permitted to copy and distribute verbatim copies
2890 of this license document, but changing it is not allowed.
2893 @unnumberedsec Preamble
2895 The licenses for most software are designed to take away your
2896 freedom to share and change it. By contrast, the GNU General Public
2897 License is intended to guarantee your freedom to share and change free
2898 software---to make sure the software is free for all its users. This
2899 General Public License applies to most of the Free Software
2900 Foundation's software and to any other program whose authors commit to
2901 using it. (Some other Free Software Foundation software is covered by
2902 the GNU Library General Public License instead.) You can apply it to
2905 When we speak of free software, we are referring to freedom, not
2906 price. Our General Public Licenses are designed to make sure that you
2907 have the freedom to distribute copies of free software (and charge for
2908 this service if you wish), that you receive source code or can get it
2909 if you want it, that you can change the software or use pieces of it
2910 in new free programs; and that you know you can do these things.
2912 To protect your rights, we need to make restrictions that forbid
2913 anyone to deny you these rights or to ask you to surrender the rights.
2914 These restrictions translate to certain responsibilities for you if you
2915 distribute copies of the software, or if you modify it.
2917 For example, if you distribute copies of such a program, whether
2918 gratis or for a fee, you must give the recipients all the rights that
2919 you have. You must make sure that they, too, receive or can get the
2920 source code. And you must show them these terms so they know their
2923 We protect your rights with two steps: (1) copyright the software, and
2924 (2) offer you this license which gives you legal permission to copy,
2925 distribute and/or modify the software.
2927 Also, for each author's protection and ours, we want to make certain
2928 that everyone understands that there is no warranty for this free
2929 software. If the software is modified by someone else and passed on, we
2930 want its recipients to know that what they have is not the original, so
2931 that any problems introduced by others will not reflect on the original
2932 authors' reputations.
2934 Finally, any free program is threatened constantly by software
2935 patents. We wish to avoid the danger that redistributors of a free
2936 program will individually obtain patent licenses, in effect making the
2937 program proprietary. To prevent this, we have made it clear that any
2938 patent must be licensed for everyone's free use or not licensed at all.
2940 The precise terms and conditions for copying, distribution and
2941 modification follow.
2944 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2947 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2952 This License applies to any program or other work which contains
2953 a notice placed by the copyright holder saying it may be distributed
2954 under the terms of this General Public License. The ``Program'', below,
2955 refers to any such program or work, and a ``work based on the Program''
2956 means either the Program or any derivative work under copyright law:
2957 that is to say, a work containing the Program or a portion of it,
2958 either verbatim or with modifications and/or translated into another
2959 language. (Hereinafter, translation is included without limitation in
2960 the term ``modification''.) Each licensee is addressed as ``you''.
2962 Activities other than copying, distribution and modification are not
2963 covered by this License; they are outside its scope. The act of
2964 running the Program is not restricted, and the output from the Program
2965 is covered only if its contents constitute a work based on the
2966 Program (independent of having been made by running the Program).
2967 Whether that is true depends on what the Program does.
2970 You may copy and distribute verbatim copies of the Program's
2971 source code as you receive it, in any medium, provided that you
2972 conspicuously and appropriately publish on each copy an appropriate
2973 copyright notice and disclaimer of warranty; keep intact all the
2974 notices that refer to this License and to the absence of any warranty;
2975 and give any other recipients of the Program a copy of this License
2976 along with the Program.
2978 You may charge a fee for the physical act of transferring a copy, and
2979 you may at your option offer warranty protection in exchange for a fee.
2982 You may modify your copy or copies of the Program or any portion
2983 of it, thus forming a work based on the Program, and copy and
2984 distribute such modifications or work under the terms of Section 1
2985 above, provided that you also meet all of these conditions:
2989 You must cause the modified files to carry prominent notices
2990 stating that you changed the files and the date of any change.
2993 You must cause any work that you distribute or publish, that in
2994 whole or in part contains or is derived from the Program or any
2995 part thereof, to be licensed as a whole at no charge to all third
2996 parties under the terms of this License.
2999 If the modified program normally reads commands interactively
3000 when run, you must cause it, when started running for such
3001 interactive use in the most ordinary way, to print or display an
3002 announcement including an appropriate copyright notice and a
3003 notice that there is no warranty (or else, saying that you provide
3004 a warranty) and that users may redistribute the program under
3005 these conditions, and telling the user how to view a copy of this
3006 License. (Exception: if the Program itself is interactive but
3007 does not normally print such an announcement, your work based on
3008 the Program is not required to print an announcement.)
3011 These requirements apply to the modified work as a whole. If
3012 identifiable sections of that work are not derived from the Program,
3013 and can be reasonably considered independent and separate works in
3014 themselves, then this License, and its terms, do not apply to those
3015 sections when you distribute them as separate works. But when you
3016 distribute the same sections as part of a whole which is a work based
3017 on the Program, the distribution of the whole must be on the terms of
3018 this License, whose permissions for other licensees extend to the
3019 entire whole, and thus to each and every part regardless of who wrote it.
3021 Thus, it is not the intent of this section to claim rights or contest
3022 your rights to work written entirely by you; rather, the intent is to
3023 exercise the right to control the distribution of derivative or
3024 collective works based on the Program.
3026 In addition, mere aggregation of another work not based on the Program
3027 with the Program (or with a work based on the Program) on a volume of
3028 a storage or distribution medium does not bring the other work under
3029 the scope of this License.
3032 You may copy and distribute the Program (or a work based on it,
3033 under Section 2) in object code or executable form under the terms of
3034 Sections 1 and 2 above provided that you also do one of the following:
3038 Accompany it with the complete corresponding machine-readable
3039 source code, which must be distributed under the terms of Sections
3040 1 and 2 above on a medium customarily used for software interchange; or,
3043 Accompany it with a written offer, valid for at least three
3044 years, to give any third party, for a charge no more than your
3045 cost of physically performing source distribution, a complete
3046 machine-readable copy of the corresponding source code, to be
3047 distributed under the terms of Sections 1 and 2 above on a medium
3048 customarily used for software interchange; or,
3051 Accompany it with the information you received as to the offer
3052 to distribute corresponding source code. (This alternative is
3053 allowed only for noncommercial distribution and only if you
3054 received the program in object code or executable form with such
3055 an offer, in accord with Subsection b above.)
3058 The source code for a work means the preferred form of the work for
3059 making modifications to it. For an executable work, complete source
3060 code means all the source code for all modules it contains, plus any
3061 associated interface definition files, plus the scripts used to
3062 control compilation and installation of the executable. However, as a
3063 special exception, the source code distributed need not include
3064 anything that is normally distributed (in either source or binary
3065 form) with the major components (compiler, kernel, and so on) of the
3066 operating system on which the executable runs, unless that component
3067 itself accompanies the executable.
3069 If distribution of executable or object code is made by offering
3070 access to copy from a designated place, then offering equivalent
3071 access to copy the source code from the same place counts as
3072 distribution of the source code, even though third parties are not
3073 compelled to copy the source along with the object code.
3076 You may not copy, modify, sublicense, or distribute the Program
3077 except as expressly provided under this License. Any attempt
3078 otherwise to copy, modify, sublicense or distribute the Program is
3079 void, and will automatically terminate your rights under this License.
3080 However, parties who have received copies, or rights, from you under
3081 this License will not have their licenses terminated so long as such
3082 parties remain in full compliance.
3085 You are not required to accept this License, since you have not
3086 signed it. However, nothing else grants you permission to modify or
3087 distribute the Program or its derivative works. These actions are
3088 prohibited by law if you do not accept this License. Therefore, by
3089 modifying or distributing the Program (or any work based on the
3090 Program), you indicate your acceptance of this License to do so, and
3091 all its terms and conditions for copying, distributing or modifying
3092 the Program or works based on it.
3095 Each time you redistribute the Program (or any work based on the
3096 Program), the recipient automatically receives a license from the
3097 original licensor to copy, distribute or modify the Program subject to
3098 these terms and conditions. You may not impose any further
3099 restrictions on the recipients' exercise of the rights granted herein.
3100 You are not responsible for enforcing compliance by third parties to
3104 If, as a consequence of a court judgment or allegation of patent
3105 infringement or for any other reason (not limited to patent issues),
3106 conditions are imposed on you (whether by court order, agreement or
3107 otherwise) that contradict the conditions of this License, they do not
3108 excuse you from the conditions of this License. If you cannot
3109 distribute so as to satisfy simultaneously your obligations under this
3110 License and any other pertinent obligations, then as a consequence you
3111 may not distribute the Program at all. For example, if a patent
3112 license would not permit royalty-free redistribution of the Program by
3113 all those who receive copies directly or indirectly through you, then
3114 the only way you could satisfy both it and this License would be to
3115 refrain entirely from distribution of the Program.
3117 If any portion of this section is held invalid or unenforceable under
3118 any particular circumstance, the balance of the section is intended to
3119 apply and the section as a whole is intended to apply in other
3122 It is not the purpose of this section to induce you to infringe any
3123 patents or other property right claims or to contest validity of any
3124 such claims; this section has the sole purpose of protecting the
3125 integrity of the free software distribution system, which is
3126 implemented by public license practices. Many people have made
3127 generous contributions to the wide range of software distributed
3128 through that system in reliance on consistent application of that
3129 system; it is up to the author/donor to decide if he or she is willing
3130 to distribute software through any other system and a licensee cannot
3133 This section is intended to make thoroughly clear what is believed to
3134 be a consequence of the rest of this License.
3137 If the distribution and/or use of the Program is restricted in
3138 certain countries either by patents or by copyrighted interfaces, the
3139 original copyright holder who places the Program under this License
3140 may add an explicit geographical distribution limitation excluding
3141 those countries, so that distribution is permitted only in or among
3142 countries not thus excluded. In such case, this License incorporates
3143 the limitation as if written in the body of this License.
3146 The Free Software Foundation may publish revised and/or new versions
3147 of the General Public License from time to time. Such new versions will
3148 be similar in spirit to the present version, but may differ in detail to
3149 address new problems or concerns.
3151 Each version is given a distinguishing version number. If the Program
3152 specifies a version number of this License which applies to it and ``any
3153 later version'', you have the option of following the terms and conditions
3154 either of that version or of any later version published by the Free
3155 Software Foundation. If the Program does not specify a version number of
3156 this License, you may choose any version ever published by the Free Software
3160 If you wish to incorporate parts of the Program into other free
3161 programs whose distribution conditions are different, write to the author
3162 to ask for permission. For software which is copyrighted by the Free
3163 Software Foundation, write to the Free Software Foundation; we sometimes
3164 make exceptions for this. Our decision will be guided by the two goals
3165 of preserving the free status of all derivatives of our free software and
3166 of promoting the sharing and reuse of software generally.
3169 @heading NO WARRANTY
3177 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3178 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3179 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3180 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3181 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3182 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3183 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3184 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3185 REPAIR OR CORRECTION.
3188 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3189 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3190 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3191 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3192 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3193 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3194 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3195 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3196 POSSIBILITY OF SUCH DAMAGES.
3200 @heading END OF TERMS AND CONDITIONS
3203 @center END OF TERMS AND CONDITIONS
3207 @unnumberedsec How to Apply These Terms to Your New Programs
3209 If you develop a new program, and you want it to be of the greatest
3210 possible use to the public, the best way to achieve this is to make it
3211 free software which everyone can redistribute and change under these terms.
3213 To do so, attach the following notices to the program. It is safest
3214 to attach them to the start of each source file to most effectively
3215 convey the exclusion of warranty; and each file should have at least
3216 the ``copyright'' line and a pointer to where the full notice is found.
3219 @var{one line to give the program's name and an idea of what it does.}
3220 Copyright (C) 19@var{yy} @var{name of author}
3222 This program is free software; you can redistribute it and/or
3223 modify it under the terms of the GNU General Public License
3224 as published by the Free Software Foundation; either version 2
3225 of the License, or (at your option) any later version.
3227 This program is distributed in the hope that it will be useful,
3228 but WITHOUT ANY WARRANTY; without even the implied warranty of
3229 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3230 GNU General Public License for more details.
3232 You should have received a copy of the GNU General Public License
3233 along with this program; if not, write to the Free Software
3234 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3237 Also add information on how to contact you by electronic and paper mail.
3239 If the program is interactive, make it output a short notice like this
3240 when it starts in an interactive mode:
3243 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3244 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3245 type `show w'. This is free software, and you are welcome
3246 to redistribute it under certain conditions; type `show c'
3250 The hypothetical commands @samp{show w} and @samp{show c} should show
3251 the appropriate parts of the General Public License. Of course, the
3252 commands you use may be called something other than @samp{show w} and
3253 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3256 You should also get your employer (if you work as a programmer) or your
3257 school, if any, to sign a ``copyright disclaimer'' for the program, if
3258 necessary. Here is a sample; alter the names:
3262 Yoyodyne, Inc., hereby disclaims all copyright
3263 interest in the program `Gnomovision'
3264 (which makes passes at compilers) written
3267 @var{signature of Ty Coon}, 1 April 1989
3268 Ty Coon, President of Vice
3272 This General Public License does not permit incorporating your program into
3273 proprietary programs. If your program is a subroutine library, you may
3274 consider it more useful to permit linking proprietary applications with the
3275 library. If this is what you want to do, use the GNU Library General
3276 Public License instead of this License.
3278 @node Concept Index, , Copying, Top
3279 @unnumbered Concept Index