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
436 @node Download Options, Directory Options, Logging and Input File Options, Invoking
437 @section Download Options
442 @cindex number of retries
443 @item -t @var{number}
444 @itemx --tries=@var{number}
445 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
449 @itemx --output-document=@var{file}
450 The documents will not be written to the appropriate files, but all will
451 be concatenated together and written to @var{file}. If @var{file}
452 already exists, it will be overwritten. If the @var{file} is @samp{-},
453 the documents will be written to standard output. Including this option
454 automatically sets the number of tries to 1.
459 Do not clobber existing files when saving to directory hierarchy within
460 recursive retrieval of several files. This option is @emph{extremely}
461 useful when you wish to continue where you left off with retrieval of
462 many files. If the files have the @samp{.html} or (yuck) @samp{.htm}
463 suffix, they will be loaded from the local disk, and parsed as if they
464 have been retrieved from the Web.
466 @cindex continue retrieval
469 Continue getting an existing file. This is useful when you want to
470 finish up the download started by another program, or a previous
471 instance of Wget. Thus you can write:
474 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
477 If there is a file name @file{ls-lR.Z} in the current directory, Wget
478 will assume that it is the first portion of the remote file, and will
479 require the server to continue the retrieval from an offset equal to the
480 length of the local file.
482 Note that you need not specify this option if all you want is Wget to
483 continue retrieving where it left off when the connection is lost---Wget
484 does this by default. You need this option only when you want to
485 continue retrieval of a file already halfway retrieved, saved by another
486 @sc{ftp} client, or left by Wget being killed.
488 Without @samp{-c}, the previous example would just begin to download the
489 remote file to @file{ls-lR.Z.1}. The @samp{-c} option is also
490 applicable for @sc{http} servers that support the @code{Range} header.
493 @cindex retrieval tracing style
494 @item --dot-style=@var{style}
495 Set the retrieval style to @var{style}. Wget traces the retrieval of
496 each document by printing dots on the screen, each dot representing a
497 fixed amount of retrieved data. Any number of dots may be separated in
498 a @dfn{cluster}, to make counting easier. This option allows you to
499 choose one of the pre-defined styles, determining the number of bytes
500 represented by a dot, the number of dots in a cluster, and the number of
503 With the @code{default} style each dot represents 1K, there are ten dots
504 in a cluster and 50 dots in a line. The @code{binary} style has a more
505 ``computer''-like orientation---8K dots, 16-dots clusters and 48 dots
506 per line (which makes for 384K lines). The @code{mega} style is
507 suitable for downloading very large files---each dot represents 64K
508 retrieved, there are eight dots in a cluster, and 48 dots on each line
509 (so each line contains 3M). The @code{micro} style is exactly the
510 reverse; it is suitable for downloading small files, with 128-byte dots,
511 8 dots per cluster, and 48 dots (6K) per line.
514 @itemx --timestamping
515 Turn on time-stamping. @xref{Time-Stamping} for details.
517 @cindex server response, print
519 @itemx --server-response
520 Print the headers sent by @sc{http} servers and responses sent by
523 @cindex Wget as spider
526 When invoked with this option, Wget will behave as a Web @dfn{spider},
527 which means that it will not download the pages, just check that they
528 are there. You can use it to check your bookmarks, e.g. with:
531 wget --spider --force-html -i bookmarks.html
534 This feature needs much more work for Wget to get close to the
535 functionality of real @sc{www} spiders.
539 @itemx --timeout=@var{seconds}
540 Set the read timeout to @var{seconds} seconds. Whenever a network read
541 is issued, the file descriptor is checked for a timeout, which could
542 otherwise leave a pending connection (uninterrupted read). The default
543 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
544 disable checking for timeouts.
546 Please do not lower the default timeout value with this option unless
547 you know what you are doing.
551 @item -w @var{seconds}
552 @itemx --wait=@var{seconds}
553 Wait the specified number of seconds between the retrievals. Use of
554 this option is recommended, as it lightens the server load by making the
555 requests less frequent. Instead of in seconds, the time can be
556 specified in minutes using the @code{m} suffix, in hours using @code{h}
557 suffix, or in days using @code{d} suffix.
559 Specifying a large value for this option is useful if the network or the
560 destination host is down, so that Wget can wait long enough to
561 reasonably expect the network error to be fixed before the retry.
563 @cindex retries, waiting between
564 @cindex waiting between retries
565 @item --waitretry=@var{seconds}
566 If you don't want Wget to wait between @emph{every} retrieval, but only
567 between retries of failed downloads, you can use this option. Wget will
568 use "linear backoff", waiting 1 second after the first failure on a
569 given file, then waiting 2 seconds after the second failure on that
570 file, up to the maximum number of @var{seconds} you specify. Therefore,
571 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
574 Note that this option is turned on by default in the global
579 @itemx --proxy=on/off
580 Turn proxy support on or off. The proxy is on by default if the
581 appropriate environmental variable is defined.
585 @itemx --quota=@var{quota}
586 Specify download quota for automatic retrievals. The value can be
587 specified in bytes (default), kilobytes (with @samp{k} suffix), or
588 megabytes (with @samp{m} suffix).
590 Note that quota will never affect downloading a single file. So if you
591 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
592 @file{ls-lR.gz} will be downloaded. The same goes even when several
593 @sc{url}s are specified on the command-line. However, quota is
594 respected when retrieving either recursively, or from an input file.
595 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
596 aborted when the quota is exceeded.
598 Setting quota to 0 or to @samp{inf} unlimits the download quota.
601 @node Directory Options, HTTP Options, Download Options, Invoking
602 @section Directory Options
606 @itemx --no-directories
607 Do not create a hierarchy of directories when retrieving
608 recursively. With this option turned on, all files will get saved to the
609 current directory, without clobbering (if a name shows up more than
610 once, the filenames will get extensions @samp{.n}).
613 @itemx --force-directories
614 The opposite of @samp{-nd}---create a hierarchy of directories, even if
615 one would not have been created otherwise. E.g. @samp{wget -x
616 http://fly.cc.fer.hr/robots.txt} will save the downloaded file to
617 @file{fly.cc.fer.hr/robots.txt}.
620 @itemx --no-host-directories
621 Disable generation of host-prefixed directories. By default, invoking
622 Wget with @samp{-r http://fly.cc.fer.hr/} will create a structure of
623 directories beginning with @file{fly.cc.fer.hr/}. This option disables
626 @cindex cut directories
627 @item --cut-dirs=@var{number}
628 Ignore @var{number} directory components. This is useful for getting a
629 fine-grained control over the directory where recursive retrieval will
632 Take, for example, the directory at
633 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
634 @samp{-r}, it will be saved locally under
635 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
636 remove the @file{ftp.xemacs.org/} part, you are still stuck with
637 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
638 makes Wget not ``see'' @var{number} remote directory components. Here
639 are several examples of how @samp{--cut-dirs} option works.
643 No options -> ftp.xemacs.org/pub/xemacs/
645 -nH --cut-dirs=1 -> xemacs/
646 -nH --cut-dirs=2 -> .
648 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
653 If you just want to get rid of the directory structure, this option is
654 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
655 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
656 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
657 be placed to @file{xemacs/beta}, as one would expect.
659 @cindex directory prefix
660 @item -P @var{prefix}
661 @itemx --directory-prefix=@var{prefix}
662 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
663 directory where all other files and subdirectories will be saved to,
664 i.e. the top of the retrieval tree. The default is @samp{.} (the
668 @node HTTP Options, FTP Options, Directory Options, Invoking
669 @section HTTP Options
673 @cindex http password
674 @cindex authentication
675 @item --http-user=@var{user}
676 @itemx --http-passwd=@var{password}
677 Specify the username @var{user} and password @var{password} on an
678 @sc{http} server. According to the type of the challenge, Wget will
679 encode them using either the @code{basic} (insecure) or the
680 @code{digest} authentication scheme.
682 Another way to specify username and password is in the @sc{url} itself
683 (@xref{URL Format}). For more information about security issues with
684 Wget, @xref{Security Considerations}.
689 @itemx --cache=on/off
690 When set to off, disable server-side cache. In this case, Wget will
691 send the remote server an appropriate directive (@samp{Pragma:
692 no-cache}) to get the file from the remote service, rather than
693 returning the cached version. This is especially useful for retrieving
694 and flushing out-of-date documents on proxy servers.
696 Caching is allowed by default.
698 @cindex Content-Length, ignore
699 @cindex ignore length
700 @item --ignore-length
701 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
702 precise) send out bogus @code{Content-Length} headers, which makes Wget
703 go wild, as it thinks not all the document was retrieved. You can spot
704 this syndrome if Wget retries getting the same document again and again,
705 each time claiming that the (otherwise normal) connection has closed on
708 With this option, Wget will ignore the @code{Content-Length} header---as
712 @item --header=@var{additional-header}
713 Define an @var{additional-header} to be passed to the @sc{http} servers.
714 Headers must contain a @samp{:} preceded by one or more non-blank
715 characters, and must not contain newlines.
717 You may define more than one additional header by specifying
718 @samp{--header} more than once.
722 wget --header='Accept-Charset: iso-8859-2' \
723 --header='Accept-Language: hr' \
724 http://fly.cc.fer.hr/
728 Specification of an empty string as the header value will clear all
729 previous user-defined headers.
732 @cindex proxy password
733 @cindex proxy authentication
734 @item --proxy-user=@var{user}
735 @itemx --proxy-passwd=@var{password}
736 Specify the username @var{user} and password @var{password} for
737 authentication on a proxy server. Wget will encode them using the
738 @code{basic} authentication scheme.
741 @cindex referer, http
742 @item --referer=@var{url}
743 Include `Referer: @var{url}' header in HTTP request. Useful for
744 retrieving documents with server-side processing that assume they are
745 always being retrieved by interactive web browsers and only come out
746 properly when Referer is set to one of the pages that point to them.
748 @cindex server response, save
750 @itemx --save-headers
751 Save the headers sent by the @sc{http} server to the file, preceding the
752 actual contents, with an empty line as the separator.
755 @item -U @var{agent-string}
756 @itemx --user-agent=@var{agent-string}
757 Identify as @var{agent-string} to the @sc{http} server.
759 The @sc{http} protocol allows the clients to identify themselves using a
760 @code{User-Agent} header field. This enables distinguishing the
761 @sc{www} software, usually for statistical purposes or for tracing of
762 protocol violations. Wget normally identifies as
763 @samp{Wget/@var{version}}, @var{version} being the current version
766 However, some sites have been known to impose the policy of tailoring
767 the output according to the @code{User-Agent}-supplied information.
768 While conceptually this is not such a bad idea, it has been abused by
769 servers denying information to clients other than @code{Mozilla} or
770 Microsoft @code{Internet Explorer}. This option allows you to change
771 the @code{User-Agent} line issued by Wget. Use of this option is
772 discouraged, unless you really know what you are doing.
774 @strong{NOTE} that Netscape Communications Corp. has claimed that false
775 transmissions of @samp{Mozilla} as the @code{User-Agent} are a copyright
776 infringement, which will be prosecuted. @strong{DO NOT} misrepresent
780 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
784 @cindex retrieve symbolic links
785 @item --retr-symlinks
786 Retrieve symbolic links on @sc{ftp} sites as if they were plain files,
787 i.e. don't just create links locally.
789 @cindex globbing, toggle
792 Turn @sc{ftp} globbing on or off. Globbing means you may use the
793 shell-like special characters (@dfn{wildcards}), like @samp{*},
794 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
795 same directory at once, like:
798 wget ftp://gnjilux.cc.fer.hr/*.msg
801 By default, globbing will be turned on if the @sc{url} contains a
802 globbing character. This option may be used to turn globbing on or off
805 You may have to quote the @sc{url} to protect it from being expanded by
806 your shell. Globbing makes Wget look for a directory listing, which is
807 system-specific. This is why it currently works only with Unix @sc{ftp}
808 servers (and the ones emulating Unix @code{ls} output).
812 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
813 initiates the data connection. This is sometimes required for @sc{ftp}
814 to work behind firewalls.
817 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
818 @section Recursive Retrieval Options
823 Turn on recursive retrieving. @xref{Recursive Retrieval} for more
827 @itemx --level=@var{depth}
828 Specify recursion maximum depth level @var{depth} (@xref{Recursive
829 Retrieval}). The default maximum depth is 5.
831 @cindex proxy filling
832 @cindex delete after retrieval
833 @cindex filling proxy cache
835 This option tells Wget to delete every single file it downloads,
836 @emph{after} having done so. It is useful for pre-fetching popular
837 pages through proxy, e.g.:
840 wget -r -nd --delete-after http://whatever.com/~popular/page/
843 The @samp{-r} option is to retrieve recursively, and @samp{-nd} not to
846 @cindex conversion of links
847 @cindex link conversion
849 @itemx --convert-links
850 Convert the non-relative links to relative ones locally. Only the
851 references to the documents actually downloaded will be converted; the
852 rest will be left unchanged.
854 Note that only at the end of the download can Wget know which links have
855 been downloaded. Because of that, much of the work done by @samp{-k}
856 will be performed at the end of the downloads.
858 @cindex backing up converted files
860 @itemx --backup-converted
861 When converting a file, back up the original version with a @samp{.orig}
862 suffix. Affects the behavior of @samp{-N} (@xref{HTTP Time-Stamping
867 Turn on options suitable for mirroring. This option turns on recursion
868 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
869 directory listings. It is currently equivalent to
870 @samp{-r -N -l inf -nr}.
873 @itemx --dont-remove-listing
874 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
875 retrievals. Normally, these files contain the raw directory listings
876 received from @sc{ftp} servers. Not removing them can be useful to
877 access the full remote file list when running a mirror, or for debugging
881 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
882 @section Recursive Accept/Reject Options
885 @item -A @var{acclist} --accept @var{acclist}
886 @itemx -R @var{rejlist} --reject @var{rejlist}
887 Specify comma-separated lists of file name suffixes or patterns to
888 accept or reject (@xref{Types of Files} for more details).
890 @item -D @var{domain-list}
891 @itemx --domains=@var{domain-list}
892 Set domains to be accepted and @sc{dns} looked-up, where
893 @var{domain-list} is a comma-separated list. Note that it does
894 @emph{not} turn on @samp{-H}. This option speeds things up, even if
895 only one host is spanned (@xref{Domain Acceptance}).
897 @item --exclude-domains @var{domain-list}
898 Exclude the domains given in a comma-separated @var{domain-list} from
899 @sc{dns}-lookup (@xref{Domain Acceptance}).
901 @cindex follow FTP links
903 Follow @sc{ftp} links from @sc{html} documents. Without this option,
904 Wget will ignore all the @sc{ftp} links.
906 @cindex tag-based recursive pruning
907 @item --follow-tags=@var{list}
908 Wget has an internal table of HTML tag / attribute pairs that it
909 considers when looking for linked documents during a recursive
910 retrieval. If a user wants only a subset of those tags to be
911 considered, however, he or she should be specify such tags in a
912 comma-separated @var{list} with this option.
915 @itemx --ignore-tags=@var{list}
916 This is the opposite of the @samp{--follow-tags} option. To skip
917 certain HTML tags when recursively looking for documents to download,
918 specify them in a comma-separated @var{list}. The author of this option
919 likes to use the following command to download a single HTML page and
920 all files (e.g. images, sounds, and stylesheets) necessary to display it
924 wget -Ga,area -H -k -K -nh -r http://@var{site}/@var{document}
929 Enable spanning across hosts when doing recursive retrieving (@xref{All
934 Follow relative links only. Useful for retrieving a specific home page
935 without any distractions, not even those from the same hosts
936 (@xref{Relative Links}).
939 @itemx --include-directories=@var{list}
940 Specify a comma-separated list of directories you wish to follow when
941 downloading (@xref{Directory-Based Limits} for more details.) Elements
942 of @var{list} may contain wildcards.
945 @itemx --exclude-directories=@var{list}
946 Specify a comma-separated list of directories you wish to exclude from
947 download (@xref{Directory-Based Limits} for more details.) Elements of
948 @var{list} may contain wildcards.
951 @itemx --no-host-lookup
952 Disable the time-consuming @sc{dns} lookup of almost all hosts
953 (@xref{Host Checking}).
957 Do not ever ascend to the parent directory when retrieving recursively.
958 This is a useful option, since it guarantees that only the files
959 @emph{below} a certain hierarchy will be downloaded.
960 @xref{Directory-Based Limits} for more details.
963 @node Recursive Retrieval, Following Links, Invoking, Top
964 @chapter Recursive Retrieval
967 @cindex recursive retrieval
969 GNU Wget is capable of traversing parts of the Web (or a single
970 @sc{http} or @sc{ftp} server), depth-first following links and directory
971 structure. This is called @dfn{recursive} retrieving, or
974 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
975 the given @sc{url}, documents, retrieving the files the @sc{html}
976 document was referring to, through markups like @code{href}, or
977 @code{src}. If the freshly downloaded file is also of type
978 @code{text/html}, it will be parsed and followed further.
980 The maximum @dfn{depth} to which the retrieval may descend is specified
981 with the @samp{-l} option (the default maximum depth is five layers).
982 @xref{Recursive Retrieval}.
984 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
985 the data from the given directory tree (including the subdirectories up
986 to the specified depth) on the remote server, creating its mirror image
987 locally. @sc{ftp} retrieval is also limited by the @code{depth}
990 By default, Wget will create a local directory tree, corresponding to
991 the one found on the remote server.
993 Recursive retrieving can find a number of applications, the most
994 important of which is mirroring. It is also useful for @sc{www}
995 presentations, and any other opportunities where slow network
996 connections should be bypassed by storing the files locally.
998 You should be warned that invoking recursion may cause grave overloading
999 on your system, because of the fast exchange of data through the
1000 network; all of this may hamper other users' work. The same stands for
1001 the foreign server you are mirroring---the more requests it gets in a
1002 rows, the greater is its load.
1004 Careless retrieving can also fill your file system uncontrollably, which
1005 can grind the machine to a halt.
1007 The load can be minimized by lowering the maximum recursion level
1008 (@samp{-l}) and/or by lowering the number of retries (@samp{-t}). You
1009 may also consider using the @samp{-w} option to slow down your requests
1010 to the remote servers, as well as the numerous options to narrow the
1011 number of followed links (@xref{Following Links}).
1013 Recursive retrieval is a good thing when used properly. Please take all
1014 precautions not to wreak havoc through carelessness.
1016 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1017 @chapter Following Links
1019 @cindex following links
1021 When retrieving recursively, one does not wish to retrieve loads of
1022 unnecessary data. Most of the time the users bear in mind exactly what
1023 they want to download, and want Wget to follow only specific links.
1025 For example, if you wish to download the music archive from
1026 @samp{fly.cc.fer.hr}, you will not want to download all the home pages
1027 that happen to be referenced by an obscure part of the archive.
1029 Wget possesses several mechanisms that allows you to fine-tune which
1030 links it will follow.
1033 * Relative Links:: Follow relative links only.
1034 * Host Checking:: Follow links on the same host.
1035 * Domain Acceptance:: Check on a list of domains.
1036 * All Hosts:: No host restrictions.
1037 * Types of Files:: Getting only certain files.
1038 * Directory-Based Limits:: Getting only certain directories.
1039 * FTP Links:: Following FTP links.
1042 @node Relative Links, Host Checking, Following Links, Following Links
1043 @section Relative Links
1044 @cindex relative links
1046 When only relative links are followed (option @samp{-L}), recursive
1047 retrieving will never span hosts. No time-expensive @sc{dns}-lookups
1048 will be performed, and the process will be very fast, with the minimum
1049 strain of the network. This will suit your needs often, especially when
1050 mirroring the output of various @code{x2html} converters, since they
1051 generally output relative links.
1053 @node Host Checking, Domain Acceptance, Relative Links, Following Links
1054 @section Host Checking
1057 @cindex host checking
1059 The drawback of following the relative links solely is that humans often
1060 tend to mix them with absolute links to the very same host, and the very
1061 same page. In this mode (which is the default mode for following links)
1062 all @sc{url}s that refer to the same host will be retrieved.
1064 The problem with this option are the aliases of the hosts and domains.
1065 Thus there is no way for Wget to know that @samp{regoc.srce.hr} and
1066 @samp{www.srce.hr} are the same host, or that @samp{fly.cc.fer.hr} is
1067 the same as @samp{fly.cc.etf.hr}. Whenever an absolute link is
1068 encountered, the host is @sc{dns}-looked-up with @code{gethostbyname} to
1069 check whether we are maybe dealing with the same hosts. Although the
1070 results of @code{gethostbyname} are cached, it is still a great
1071 slowdown, e.g. when dealing with large indices of home pages on different
1072 hosts (because each of the hosts must be @sc{dns}-resolved to see
1073 whether it just @emph{might} be an alias of the starting host).
1075 To avoid the overhead you may use @samp{-nh}, which will turn off
1076 @sc{dns}-resolving and make Wget compare hosts literally. This will
1077 make things run much faster, but also much less reliable
1078 (e.g. @samp{www.srce.hr} and @samp{regoc.srce.hr} will be flagged as
1081 Note that modern @sc{http} servers allow one IP address to host several
1082 @dfn{virtual servers}, each having its own directory hierarchy. Such
1083 ``servers'' are distinguished by their hostnames (all of which point to
1084 the same IP address); for this to work, a client must send a @code{Host}
1085 header, which is what Wget does. However, in that case Wget @emph{must
1086 not} try to divine a host's ``real'' address, nor try to use the same
1087 hostname for each access, i.e. @samp{-nh} must be turned on.
1089 In other words, the @samp{-nh} option must be used to enable the
1090 retrieval from virtual servers distinguished by their hostnames. As the
1091 number of such server setups grow, the behavior of @samp{-nh} may become
1092 the default in the future.
1094 @node Domain Acceptance, All Hosts, Host Checking, Following Links
1095 @section Domain Acceptance
1097 With the @samp{-D} option you may specify the domains that will be
1098 followed. The hosts the domain of which is not in this list will not be
1099 @sc{dns}-resolved. Thus you can specify @samp{-Dmit.edu} just to make
1100 sure that @strong{nothing outside of @sc{mit} gets looked up}. This is
1101 very important and useful. It also means that @samp{-D} does @emph{not}
1102 imply @samp{-H} (span all hosts), which must be specified explicitly.
1103 Feel free to use this options since it will speed things up, with almost
1104 all the reliability of checking for all hosts. Thus you could invoke
1107 wget -r -D.hr http://fly.cc.fer.hr/
1110 to make sure that only the hosts in @samp{.hr} domain get
1111 @sc{dns}-looked-up for being equal to @samp{fly.cc.fer.hr}. So
1112 @samp{fly.cc.etf.hr} will be checked (only once!) and found equal, but
1113 @samp{www.gnu.ai.mit.edu} will not even be checked.
1115 Of course, domain acceptance can be used to limit the retrieval to
1116 particular domains with spanning of hosts in them, but then you must
1117 specify @samp{-H} explicitly. E.g.:
1120 wget -r -H -Dmit.edu,stanford.edu http://www.mit.edu/
1123 will start with @samp{http://www.mit.edu/}, following links across
1124 @sc{mit} and Stanford.
1126 If there are domains you want to exclude specifically, you can do it
1127 with @samp{--exclude-domains}, which accepts the same type of arguments
1128 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1129 example, if you want to download all the hosts from @samp{foo.edu}
1130 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1134 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu http://www.foo.edu/
1137 @node All Hosts, Types of Files, Domain Acceptance, Following Links
1142 When @samp{-H} is specified without @samp{-D}, all hosts are freely
1143 spanned. There are no restrictions whatsoever as to what part of the
1144 net Wget will go to fetch documents, other than maximum retrieval depth.
1145 If a page references @samp{www.yahoo.com}, so be it. Such an option is
1146 rarely useful for itself.
1148 @node Types of Files, Directory-Based Limits, All Hosts, Following Links
1149 @section Types of Files
1150 @cindex types of files
1152 When downloading material from the web, you will often want to restrict
1153 the retrieval to only certain file types. For example, if you are
1154 interested in downloading @sc{gif}s, you will not be overjoyed to get
1155 loads of PostScript documents, and vice versa.
1157 Wget offers two options to deal with this problem. Each option
1158 description lists a short name, a long name, and the equivalent command
1161 @cindex accept wildcards
1162 @cindex accept suffixes
1163 @cindex wildcards, accept
1164 @cindex suffixes, accept
1166 @item -A @var{acclist}
1167 @itemx --accept @var{acclist}
1168 @itemx accept = @var{acclist}
1169 The argument to @samp{--accept} option is a list of file suffixes or
1170 patterns that Wget will download during recursive retrieval. A suffix
1171 is the ending part of a file, and consists of ``normal'' letters,
1172 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1173 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1175 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1176 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1177 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1178 download only files beginning with @samp{zelazny} and containing numbers
1179 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1180 a description of how pattern matching works.
1182 Of course, any number of suffixes and patterns can be combined into a
1183 comma-separated list, and given as an argument to @samp{-A}.
1185 @cindex reject wildcards
1186 @cindex reject suffixes
1187 @cindex wildcards, reject
1188 @cindex suffixes, reject
1189 @item -R @var{rejlist}
1190 @itemx --reject @var{rejlist}
1191 @itemx reject = @var{rejlist}
1192 The @samp{--reject} option works the same way as @samp{--accept}, only
1193 its logic is the reverse; Wget will download all files @emph{except} the
1194 ones matching the suffixes (or patterns) in the list.
1196 So, if you want to download a whole page except for the cumbersome
1197 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1198 Analogously, to download all files except the ones beginning with
1199 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1200 expansion by the shell.
1203 The @samp{-A} and @samp{-R} options may be combined to achieve even
1204 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1205 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1206 a part of their name, but @emph{not} the PostScript files.
1208 Note that these two options do not affect the downloading of @sc{html}
1209 files; Wget must load all the @sc{html}s to know where to go at
1210 all---recursive retrieval would make no sense otherwise.
1212 @node Directory-Based Limits, FTP Links, Types of Files, Following Links
1213 @section Directory-Based Limits
1215 @cindex directory limits
1217 Regardless of other link-following facilities, it is often useful to
1218 place the restriction of what files to retrieve based on the directories
1219 those files are placed in. There can be many reasons for this---the
1220 home pages may be organized in a reasonable directory structure; or some
1221 directories may contain useless information, e.g. @file{/cgi-bin} or
1222 @file{/dev} directories.
1224 Wget offers three different options to deal with this requirement. Each
1225 option description lists a short name, a long name, and the equivalent
1226 command in @file{.wgetrc}.
1228 @cindex directories, include
1229 @cindex include directories
1230 @cindex accept directories
1233 @itemx --include @var{list}
1234 @itemx include_directories = @var{list}
1235 @samp{-I} option accepts a comma-separated list of directories included
1236 in the retrieval. Any other directories will simply be ignored. The
1237 directories are absolute paths.
1239 So, if you wish to download from @samp{http://host/people/bozo/}
1240 following only links to bozo's colleagues in the @file{/people}
1241 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1244 wget -I /people,/cgi-bin http://host/people/bozo/
1247 @cindex directories, exclude
1248 @cindex exclude directories
1249 @cindex reject directories
1251 @itemx --exclude @var{list}
1252 @itemx exclude_directories = @var{list}
1253 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1254 directories @emph{excluded} from the download. E.g. if you do not want
1255 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1256 /cgi-bin} on the command line.
1258 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1259 to get a better fine-tuning of downloading subdirectories. E.g. if you
1260 want to load all the files from @file{/pub} hierarchy except for
1261 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1266 @itemx no_parent = on
1267 The simplest, and often very useful way of limiting directories is
1268 disallowing retrieval of the links that refer to the hierarchy
1269 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1270 parent directory/directories.
1272 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1273 Using it guarantees that you will never leave the existing hierarchy.
1274 Supposing you issue Wget with:
1277 wget -r --no-parent http://somehost/~luzer/my-archive/
1280 You may rest assured that none of the references to
1281 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1282 followed. Only the archive you are interested in will be downloaded.
1283 Essentially, @samp{--no-parent} is similar to
1284 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1285 intelligent fashion.
1288 @node FTP Links, , Directory-Based Limits, Following Links
1289 @section Following FTP Links
1290 @cindex following ftp links
1292 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1293 them to be. @sc{ftp} links in @sc{html} documents are often included
1294 for purposes of reference, and it is often inconvenient to download them
1297 To have @sc{ftp} links followed from @sc{html} documents, you need to
1298 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1299 links will span hosts regardless of @samp{-H} setting. This is logical,
1300 as @sc{ftp} links rarely point to the same host where the @sc{http}
1301 server resides. For similar reasons, the @samp{-L} options has no
1302 effect on such downloads. On the other hand, domain acceptance
1303 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1305 Also note that followed links to @sc{ftp} directories will not be
1306 retrieved recursively further.
1308 @node Time-Stamping, Startup File, Following Links, Top
1309 @chapter Time-Stamping
1310 @cindex time-stamping
1311 @cindex timestamping
1312 @cindex updating the archives
1313 @cindex incremental updating
1315 One of the most important aspects of mirroring information from the
1316 Internet is updating your archives.
1318 Downloading the whole archive again and again, just to replace a few
1319 changed files is expensive, both in terms of wasted bandwidth and money,
1320 and the time to do the update. This is why all the mirroring tools
1321 offer the option of incremental updating.
1323 Such an updating mechanism means that the remote server is scanned in
1324 search of @dfn{new} files. Only those new files will be downloaded in
1325 the place of the old ones.
1327 A file is considered new if one of these two conditions are met:
1331 A file of that name does not already exist locally.
1334 A file of that name does exist, but the remote file was modified more
1335 recently than the local file.
1338 To implement this, the program needs to be aware of the time of last
1339 modification of both remote and local files. Such information are
1340 called the @dfn{time-stamps}.
1342 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1343 (@samp{-N}) option, or through @code{timestamping = on} directive in
1344 @file{.wgetrc}. With this option, for each file it intends to download,
1345 Wget will check whether a local file of the same name exists. If it
1346 does, and the remote file is older, Wget will not download it.
1348 If the local file does not exist, or the sizes of the files do not
1349 match, Wget will download the remote file no matter what the time-stamps
1353 * Time-Stamping Usage::
1354 * HTTP Time-Stamping Internals::
1355 * FTP Time-Stamping Internals::
1358 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1359 @section Time-Stamping Usage
1360 @cindex time-stamping usage
1361 @cindex usage, time-stamping
1363 The usage of time-stamping is simple. Say you would like to download a
1364 file so that it keeps its date of modification.
1367 wget -S http://www.gnu.ai.mit.edu/
1370 A simple @code{ls -l} shows that the time stamp on the local file equals
1371 the state of the @code{Last-Modified} header, as returned by the server.
1372 As you can see, the time-stamping info is preserved locally, even
1375 Several days later, you would like Wget to check if the remote file has
1376 changed, and download it if it has.
1379 wget -N http://www.gnu.ai.mit.edu/
1382 Wget will ask the server for the last-modified date. If the local file
1383 is newer, the remote file will not be re-fetched. However, if the remote
1384 file is more recent, Wget will proceed fetching it normally.
1386 The same goes for @sc{ftp}. For example:
1389 wget ftp://ftp.ifi.uio.no/pub/emacs/gnus/*
1392 @code{ls} will show that the timestamps are set according to the state
1393 on the remote server. Reissuing the command with @samp{-N} will make
1394 Wget re-fetch @emph{only} the files that have been modified.
1396 In both @sc{http} and @sc{ftp} retrieval Wget will time-stamp the local
1397 file correctly (with or without @samp{-N}) if it gets the stamps,
1398 i.e. gets the directory listing for @sc{ftp} or the @code{Last-Modified}
1399 header for @sc{http}.
1401 If you wished to mirror the GNU archive every week, you would use the
1402 following command every week:
1405 wget --timestamping -r ftp://prep.ai.mit.edu/pub/gnu/
1408 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1409 @section HTTP Time-Stamping Internals
1410 @cindex http time-stamping
1412 Time-stamping in @sc{http} is implemented by checking of the
1413 @code{Last-Modified} header. If you wish to retrieve the file
1414 @file{foo.html} through @sc{http}, Wget will check whether
1415 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1416 retrieved unconditionally.
1418 If the file does exist locally, Wget will first check its local
1419 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1420 @code{HEAD} request to the remote server, demanding the information on
1423 The @code{Last-Modified} header is examined to find which file was
1424 modified more recently (which makes it ``newer''). If the remote file
1425 is newer, it will be downloaded; if it is older, Wget will give
1426 up.@footnote{As an additional check, Wget will look at the
1427 @code{Content-Length} header, and compare the sizes; if they are not the
1428 same, the remote file will be downloaded no matter what the time-stamp
1431 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1432 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1433 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1434 @samp{@var{X}}, which will always differ if it's been converted by
1435 @samp{--convert-links} (@samp{-k}).
1437 Arguably, @sc{http} time-stamping should be implemented using the
1438 @code{If-Modified-Since} request.
1440 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1441 @section FTP Time-Stamping Internals
1442 @cindex ftp time-stamping
1444 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1445 @sc{ftp} has no headers---time-stamps must be received from the
1448 For each directory files must be retrieved from, Wget will use the
1449 @code{LIST} command to get the listing. It will try to analyze the
1450 listing, assuming that it is a Unix @code{ls -l} listing, and extract
1451 the time-stamps. The rest is exactly the same as for @sc{http}.
1453 Assumption that every directory listing is a Unix-style listing may
1454 sound extremely constraining, but in practice it is not, as many
1455 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1456 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1457 defines no standard way to get a file list, let alone the time-stamps.
1458 We can only hope that a future standard will define this.
1460 Another non-standard solution includes the use of @code{MDTM} command
1461 that is supported by some @sc{ftp} servers (including the popular
1462 @code{wu-ftpd}), which returns the exact time of the specified file.
1463 Wget may support this command in the future.
1465 @node Startup File, Examples, Time-Stamping, Top
1466 @chapter Startup File
1467 @cindex startup file
1473 Once you know how to change default settings of Wget through command
1474 line arguments, you may wish to make some of those settings permanent.
1475 You can do that in a convenient way by creating the Wget startup
1476 file---@file{.wgetrc}.
1478 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1479 convenient to have a special facility for storing passwords. Thus Wget
1480 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1481 it. You can find @file{.netrc} format in your system manuals.
1483 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1487 * Wgetrc Location:: Location of various wgetrc files.
1488 * Wgetrc Syntax:: Syntax of wgetrc.
1489 * Wgetrc Commands:: List of available commands.
1490 * Sample Wgetrc:: A wgetrc example.
1493 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1494 @section Wgetrc Location
1495 @cindex wgetrc location
1496 @cindex location of wgetrc
1498 When initializing, Wget will look for a @dfn{global} startup file,
1499 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1500 @file{/usr/local}, if Wget was not installed there) and read commands
1501 from there, if it exists.
1503 Then it will look for the user's file. If the environmental variable
1504 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1505 further attempts will be made.
1507 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1509 The fact that user's settings are loaded after the system-wide ones
1510 means that in case of collision user's wgetrc @emph{overrides} the
1511 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1512 Fascist admins, away!
1514 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1515 @section Wgetrc Syntax
1516 @cindex wgetrc syntax
1517 @cindex syntax of wgetrc
1519 The syntax of a wgetrc command is simple:
1525 The @dfn{variable} will also be called @dfn{command}. Valid
1526 @dfn{values} are different for different commands.
1528 The commands are case-insensitive and underscore-insensitive. Thus
1529 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1530 beginning with @samp{#} and lines containing white-space only are
1533 Commands that expect a comma-separated list will clear the list on an
1534 empty command. So, if you wish to reset the rejection list specified in
1535 global @file{wgetrc}, you can do it with:
1541 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1542 @section Wgetrc Commands
1543 @cindex wgetrc commands
1545 The complete set of commands is listed below, the letter after @samp{=}
1546 denoting the value the command takes. It is @samp{on/off} for @samp{on}
1547 or @samp{off} (which can also be @samp{1} or @samp{0}), @var{string} for
1548 any non-empty string or @var{n} for a positive integer. For example,
1549 you may specify @samp{use_proxy = off} to disable use of proxy servers
1550 by default. You may use @samp{inf} for infinite values, where
1553 Most of the commands have their equivalent command-line option
1554 (@xref{Invoking}), except some more obscure or rarely used ones.
1557 @item accept/reject = @var{string}
1558 Same as @samp{-A}/@samp{-R} (@xref{Types of Files}).
1560 @item add_hostdir = on/off
1561 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1563 @item continue = on/off
1564 Enable/disable continuation of the retrieval, the same as @samp{-c}
1567 @item background = on/off
1568 Enable/disable going to background, the same as @samp{-b} (which enables
1571 @item backup_converted = on/off
1572 Enable/disable saving pre-converted files with the suffix @samp{.orig}
1573 -- the same as @samp{-K} (which enables it).
1575 @c @item backups = @var{number}
1576 @c #### Document me!
1577 @item base = @var{string}
1578 Set base for relative @sc{url}s, the same as @samp{-B}.
1580 @item cache = on/off
1581 When set to off, disallow server-caching. See the @samp{-C} option.
1583 @item convert links = on/off
1584 Convert non-relative links locally. The same as @samp{-k}.
1586 @item cut_dirs = @var{n}
1587 Ignore @var{n} remote directory components.
1589 @item debug = on/off
1590 Debug mode, same as @samp{-d}.
1592 @item delete_after = on/off
1593 Delete after download, the same as @samp{--delete-after}.
1595 @item dir_prefix = @var{string}
1596 Top of directory tree, the same as @samp{-P}.
1598 @item dirstruct = on/off
1599 Turning dirstruct on or off, the same as @samp{-x} or @samp{-nd},
1602 @item domains = @var{string}
1603 Same as @samp{-D} (@xref{Domain Acceptance}).
1605 @item dot_bytes = @var{n}
1606 Specify the number of bytes ``contained'' in a dot, as seen throughout
1607 the retrieval (1024 by default). You can postfix the value with
1608 @samp{k} or @samp{m}, representing kilobytes and megabytes,
1609 respectively. With dot settings you can tailor the dot retrieval to
1610 suit your needs, or you can use the predefined @dfn{styles}
1611 (@xref{Download Options}).
1613 @item dots_in_line = @var{n}
1614 Specify the number of dots that will be printed in each line throughout
1615 the retrieval (50 by default).
1617 @item dot_spacing = @var{n}
1618 Specify the number of dots in a single cluster (10 by default).
1620 @item dot_style = @var{string}
1621 Specify the dot retrieval @dfn{style}, as with @samp{--dot-style}.
1623 @item exclude_directories = @var{string}
1624 Specify a comma-separated list of directories you wish to exclude from
1625 download, the same as @samp{-X} (@xref{Directory-Based Limits}).
1627 @item exclude_domains = @var{string}
1628 Same as @samp{--exclude-domains} (@xref{Domain Acceptance}).
1630 @item follow_ftp = on/off
1631 Follow @sc{ftp} links from @sc{html} documents, the same as @samp{-f}.
1633 @item follow_tags = @var{string}
1634 Only follow certain HTML tags when doing a recursive retrieval, just like
1635 @samp{--follow-tags}.
1637 @item force_html = on/off
1638 If set to on, force the input filename to be regarded as an @sc{html}
1639 document, the same as @samp{-F}.
1641 @item ftp_proxy = @var{string}
1642 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
1646 Turn globbing on/off, the same as @samp{-g}.
1648 @item header = @var{string}
1649 Define an additional header, like @samp{--header}.
1651 @item http_passwd = @var{string}
1652 Set @sc{http} password.
1654 @item http_proxy = @var{string}
1655 Use @var{string} as @sc{http} proxy, instead of the one specified in
1658 @item http_user = @var{string}
1659 Set @sc{http} user to @var{string}.
1661 @item ignore_length = on/off
1662 When set to on, ignore @code{Content-Length} header; the same as
1663 @samp{--ignore-length}.
1665 @item ignore_tags = @var{string}
1666 Ignore certain HTML tags when doing a recursive retrieval, just like
1667 @samp{-G} / @samp{--ignore-tags}.
1669 @item include_directories = @var{string}
1670 Specify a comma-separated list of directories you wish to follow when
1671 downloading, the same as @samp{-I}.
1673 @item input = @var{string}
1674 Read the @sc{url}s from @var{string}, like @samp{-i}.
1676 @item kill_longer = on/off
1677 Consider data longer than specified in content-length header
1678 as invalid (and retry getting it). The default behaviour is to save
1679 as much data as there is, provided there is more than or equal
1680 to the value in @code{Content-Length}.
1682 @item logfile = @var{string}
1683 Set logfile, the same as @samp{-o}.
1685 @item login = @var{string}
1686 Your user name on the remote machine, for @sc{ftp}. Defaults to
1689 @item mirror = on/off
1690 Turn mirroring on/off. The same as @samp{-m}.
1692 @item netrc = on/off
1693 Turn reading netrc on or off.
1695 @item noclobber = on/off
1698 @item no_parent = on/off
1699 Disallow retrieving outside the directory hierarchy, like
1700 @samp{--no-parent} (@xref{Directory-Based Limits}).
1702 @item no_proxy = @var{string}
1703 Use @var{string} as the comma-separated list of domains to avoid in
1704 proxy loading, instead of the one specified in environment.
1706 @item output_document = @var{string}
1707 Set the output filename, the same as @samp{-O}.
1709 @item passive_ftp = on/off
1710 Set passive @sc{ftp}, the same as @samp{--passive-ftp}.
1712 @item passwd = @var{string}
1713 Set your @sc{ftp} password to @var{password}. Without this setting, the
1714 password defaults to @samp{username@@hostname.domainname}.
1716 @item proxy_user = @var{string}
1717 Set proxy authentication user name to @var{string}, like
1718 @samp{--proxy-user}.
1720 @item proxy_passwd = @var{string}
1721 Set proxy authentication password to @var{string}, like
1722 @samp{--proxy-passwd}.
1724 @item quiet = on/off
1725 Quiet mode, the same as @samp{-q}.
1727 @item quota = @var{quota}
1728 Specify the download quota, which is useful to put in the global
1729 @file{wgetrc}. When download quota is specified, Wget will stop retrieving
1730 after the download sum has become greater than quota. The quota can be
1731 specified in bytes (default), kbytes @samp{k} appended) or mbytes
1732 (@samp{m} appended). Thus @samp{quota = 5m} will set the quota to 5
1733 mbytes. Note that the user's startup file overrides system settings.
1735 @item reclevel = @var{n}
1736 Recursion level, the same as @samp{-l}.
1738 @item recursive = on/off
1739 Recursive on/off, the same as @samp{-r}.
1741 @item relative_only = on/off
1742 Follow only relative links, the same as @samp{-L} (@xref{Relative
1745 @item remove_listing = on/off
1746 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
1747 to off is the same as @samp{-nr}.
1749 @item retr_symlinks = on/off
1750 When set to on, retrieve symbolic links as if they were plain files; the
1751 same as @samp{--retr-symlinks}.
1753 @item robots = on/off
1754 Use (or not) @file{/robots.txt} file (@xref{Robots}). Be sure to know
1755 what you are doing before changing the default (which is @samp{on}).
1757 @item server_response = on/off
1758 Choose whether or not to print the @sc{http} and @sc{ftp} server
1759 responses, the same as @samp{-S}.
1761 @item simple_host_check = on/off
1762 Same as @samp{-nh} (@xref{Host Checking}).
1764 @item span_hosts = on/off
1767 @item timeout = @var{n}
1768 Set timeout value, the same as @samp{-T}.
1770 @item timestamping = on/off
1771 Turn timestamping on/off. The same as @samp{-N} (@xref{Time-Stamping}).
1773 @item tries = @var{n}
1774 Set number of retries per @sc{url}, the same as @samp{-t}.
1776 @item use_proxy = on/off
1777 Turn proxy support on/off. The same as @samp{-Y}.
1779 @item verbose = on/off
1780 Turn verbose on/off, the same as @samp{-v}/@samp{-nv}.
1782 @item wait = @var{n}
1783 Wait @var{n} seconds between retrievals, the same as @samp{-w}.
1785 @item waitretry = @var{n}
1786 Wait up to @var{n} seconds between retries of failed retrievals only --
1787 the same as @samp{--waitretry}. Note that this is turned on by default
1788 in the global @file{wgetrc}.
1791 @node Sample Wgetrc, , Wgetrc Commands, Startup File
1792 @section Sample Wgetrc
1793 @cindex sample wgetrc
1795 This is the sample initialization file, as given in the distribution.
1796 It is divided in two section---one for global usage (suitable for global
1797 startup file), and one for local usage (suitable for
1798 @file{$HOME/.wgetrc}). Be careful about the things you change.
1800 Note that almost all the lines are commented out. For a command to have
1801 any effect, you must remove the @samp{#} character at the beginning of
1805 @include sample.wgetrc.munged_for_texi_inclusion
1808 @node Examples, Various, Startup File, Top
1812 The examples are classified into three sections, because of clarity.
1813 The first section is a tutorial for beginners. The second section
1814 explains some of the more complex program features. The third section
1815 contains advice for mirror administrators, as well as even more complex
1816 features (that some would call perverted).
1819 * Simple Usage:: Simple, basic usage of the program.
1820 * Advanced Usage:: Advanced techniques of usage.
1821 * Guru Usage:: Mirroring and the hairy stuff.
1824 @node Simple Usage, Advanced Usage, Examples, Examples
1825 @section Simple Usage
1829 Say you want to download a @sc{url}. Just type:
1832 wget http://fly.cc.fer.hr/
1835 The response will be something like:
1839 --13:30:45-- http://fly.cc.fer.hr:80/en/
1841 Connecting to fly.cc.fer.hr:80... connected!
1842 HTTP request sent, awaiting response... 200 OK
1843 Length: 4,694 [text/html]
1847 13:30:46 (23.75 KB/s) - `index.html' saved [4694/4694]
1852 But what will happen if the connection is slow, and the file is lengthy?
1853 The connection will probably fail before the whole file is retrieved,
1854 more than once. In this case, Wget will try getting the file until it
1855 either gets the whole of it, or exceeds the default number of retries
1856 (this being 20). It is easy to change the number of tries to 45, to
1857 insure that the whole file will arrive safely:
1860 wget --tries=45 http://fly.cc.fer.hr/jpg/flyweb.jpg
1864 Now let's leave Wget to work in the background, and write its progress
1865 to log file @file{log}. It is tiring to type @samp{--tries}, so we
1866 shall use @samp{-t}.
1869 wget -t 45 -o log http://fly.cc.fer.hr/jpg/flyweb.jpg &
1872 The ampersand at the end of the line makes sure that Wget works in the
1873 background. To unlimit the number of retries, use @samp{-t inf}.
1876 The usage of @sc{ftp} is as simple. Wget will take care of login and
1881 $ wget ftp://gnjilux.cc.fer.hr/welcome.msg
1882 --10:08:47-- ftp://gnjilux.cc.fer.hr:21/welcome.msg
1884 Connecting to gnjilux.cc.fer.hr:21... connected!
1885 Logging in as anonymous ... Logged in!
1886 ==> TYPE I ... done. ==> CWD not needed.
1887 ==> PORT ... done. ==> RETR welcome.msg ... done.
1888 Length: 1,340 (unauthoritative)
1892 10:08:48 (1.28 MB/s) - `welcome.msg' saved [1340]
1897 If you specify a directory, Wget will retrieve the directory listing,
1898 parse it and convert it to @sc{html}. Try:
1901 wget ftp://prep.ai.mit.edu/pub/gnu/
1906 @node Advanced Usage, Guru Usage, Simple Usage, Examples
1907 @section Advanced Usage
1911 You would like to read the list of @sc{url}s from a file? Not a problem
1918 If you specify @samp{-} as file name, the @sc{url}s will be read from
1922 Create a mirror image of GNU @sc{www} site (with the same directory structure
1923 the original has) with only one try per document, saving the log of the
1924 activities to @file{gnulog}:
1927 wget -r -t1 http://www.gnu.ai.mit.edu/ -o gnulog
1931 Retrieve the first layer of yahoo links:
1934 wget -r -l1 http://www.yahoo.com/
1938 Retrieve the index.html of @samp{www.lycos.com}, showing the original
1942 wget -S http://www.lycos.com/
1946 Save the server headers with the file:
1948 wget -s http://www.lycos.com/
1953 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
1957 wget -P/tmp -l2 ftp://wuarchive.wustl.edu/
1961 You want to download all the @sc{gif}s from an @sc{http} directory.
1962 @samp{wget http://host/dir/*.gif} doesn't work, since @sc{http}
1963 retrieval does not support globbing. In that case, use:
1966 wget -r -l1 --no-parent -A.gif http://host/dir/
1969 It is a bit of a kludge, but it works. @samp{-r -l1} means to retrieve
1970 recursively (@xref{Recursive Retrieval}), with maximum depth of 1.
1971 @samp{--no-parent} means that references to the parent directory are
1972 ignored (@xref{Directory-Based Limits}), and @samp{-A.gif} means to
1973 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
1977 Suppose you were in the middle of downloading, when Wget was
1978 interrupted. Now you do not want to clobber the files already present.
1982 wget -nc -r http://www.gnu.ai.mit.edu/
1986 If you want to encode your own username and password to @sc{http} or
1987 @sc{ftp}, use the appropriate @sc{url} syntax (@xref{URL Format}).
1990 wget ftp://hniksic:mypassword@@jagor.srce.hr/.emacs
1994 If you do not like the default retrieval visualization (1K dots with 10
1995 dots per cluster and 50 dots per line), you can customize it through dot
1996 settings (@xref{Wgetrc Commands}). For example, many people like the
1997 ``binary'' style of retrieval, with 8K dots and 512K lines:
2000 wget --dot-style=binary ftp://prep.ai.mit.edu/pub/gnu/README
2003 You can experiment with other styles, like:
2006 wget --dot-style=mega ftp://ftp.xemacs.org/pub/xemacs/xemacs-20.4/xemacs-20.4.tar.gz
2007 wget --dot-style=micro http://fly.cc.fer.hr/
2010 To make these settings permanent, put them in your @file{.wgetrc}, as
2011 described before (@xref{Sample Wgetrc}).
2014 @node Guru Usage, , Advanced Usage, Examples
2020 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2021 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2022 for @samp{-r -N}. You can put Wget in the crontab file asking it to
2023 recheck a site each Sunday:
2027 0 0 * * 0 wget --mirror ftp://ftp.xemacs.org/pub/xemacs/ -o /home/me/weeklog
2031 You may wish to do the same with someone's home page. But you do not
2032 want to download all those images---you're only interested in @sc{html}.
2035 wget --mirror -A.html http://www.w3.org/
2039 But what about mirroring the hosts networkologically close to you? It
2040 seems so awfully slow because of all that @sc{dns} resolving. Just use
2041 @samp{-D} (@xref{Domain Acceptance}).
2044 wget -rN -Dsrce.hr http://www.srce.hr/
2047 Now Wget will correctly find out that @samp{regoc.srce.hr} is the same
2048 as @samp{www.srce.hr}, but will not even take into consideration the
2049 link to @samp{www.mit.edu}.
2052 You have a presentation and would like the dumb absolute links to be
2053 converted to relative? Use @samp{-k}:
2056 wget -k -r @var{URL}
2059 @cindex redirecting output
2061 You would like the output documents to go to standard output instead of
2062 to files? OK, but Wget will automatically shut up (turn on
2063 @samp{--quiet}) to prevent mixing of Wget output and the retrieved
2067 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2070 You can also combine the two options and make weird pipelines to
2071 retrieve the documents from remote hotlists:
2074 wget -O - http://cool.list.com/ | wget --force-html -i -
2078 @node Various, Appendices, Examples, Top
2082 This chapter contains all the stuff that could not fit anywhere else.
2085 * Proxies:: Support for proxy servers
2086 * Distribution:: Getting the latest version.
2087 * Mailing List:: Wget mailing list for announcements and discussion.
2088 * Reporting Bugs:: How and where to report bugs.
2089 * Portability:: The systems Wget works on.
2090 * Signals:: Signal-handling performed by Wget.
2093 @node Proxies, Distribution, Various, Various
2097 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2098 data from remote servers to local clients. One typical use of proxies
2099 is lightening network load for users behind a slow connection. This is
2100 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2101 proxy which caches the transferred data. When a cached resource is
2102 requested again, proxy will return the data from cache. Another use for
2103 proxies is for companies that separate (for security reasons) their
2104 internal networks from the rest of Internet. In order to obtain
2105 information from the Web, their users connect and retrieve remote data
2106 using an authorized proxy.
2108 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2109 standard way to specify proxy location, which Wget recognizes, is using
2110 the following environment variables:
2114 This variable should contain the @sc{url} of the proxy for @sc{http}
2118 This variable should contain the @sc{url} of the proxy for @sc{http}
2119 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2120 are set to the same @sc{url}.
2123 This variable should contain a comma-separated list of domain extensions
2124 proxy should @emph{not} be used for. For instance, if the value of
2125 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2129 In addition to the environment variables, proxy location and settings
2130 may be specified from within Wget itself.
2134 @itemx --proxy=on/off
2135 @itemx proxy = on/off
2136 This option may be used to turn the proxy support on or off. Proxy
2137 support is on by default, provided that the appropriate environment
2140 @item http_proxy = @var{URL}
2141 @itemx ftp_proxy = @var{URL}
2142 @itemx no_proxy = @var{string}
2143 These startup file variables allow you to override the proxy settings
2144 specified by the environment.
2147 Some proxy servers require authorization to enable you to use them. The
2148 authorization consists of @dfn{username} and @dfn{password}, which must
2149 be sent by Wget. As with @sc{http} authorization, several
2150 authentication schemes exist. For proxy authorization only the
2151 @code{Basic} authentication scheme is currently implemented.
2153 You may specify your username and password either through the proxy
2154 @sc{url} or through the command-line options. Assuming that the
2155 company's proxy is located at @samp{proxy.srce.hr} at port 8001, a proxy
2156 @sc{url} location containing authorization data might look like this:
2159 http://hniksic:mypassword@@proxy.company.com:8001/
2162 Alternatively, you may use the @samp{proxy-user} and
2163 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2164 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2165 username and password.
2167 @node Distribution, Mailing List, Proxies, Various
2168 @section Distribution
2169 @cindex latest version
2171 Like all GNU utilities, the latest version of Wget can be found at the
2172 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2173 Wget @value{VERSION} can be found at
2174 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2176 @node Mailing List, Reporting Bugs, Distribution, Various
2177 @section Mailing List
2178 @cindex mailing list
2181 Wget has its own mailing list at @email{wget@@sunsite.auc.dk}, thanks
2182 to Karsten Thygesen. The mailing list is for discussion of Wget
2183 features and web, reporting Wget bugs (those that you think may be of
2184 interest to the public) and mailing announcements. You are welcome to
2185 subscribe. The more people on the list, the better!
2187 To subscribe, send mail to @email{wget-subscribe@@sunsite.auc.dk}.
2188 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2189 mailing to @email{wget-unsubscribe@@sunsite.auc.dk}.
2191 The mailing list is archived at @url{http://fly.cc.fer.hr/archive/wget}.
2193 @node Reporting Bugs, Portability, Mailing List, Various
2194 @section Reporting Bugs
2196 @cindex reporting bugs
2199 You are welcome to send bug reports about GNU Wget to
2200 @email{bug-wget@@gnu.org}. The bugs that you think are of the
2201 interest to the public (i.e. more people should be informed about them)
2202 can be Cc-ed to the mailing list at @email{wget@@sunsite.auc.dk}.
2204 Before actually submitting a bug report, please try to follow a few
2209 Please try to ascertain that the behaviour you see really is a bug. If
2210 Wget crashes, it's a bug. If Wget does not behave as documented,
2211 it's a bug. If things work strange, but you are not sure about the way
2212 they are supposed to work, it might well be a bug.
2215 Try to repeat the bug in as simple circumstances as possible. E.g. if
2216 Wget crashes on @samp{wget -rLl0 -t5 -Y0 http://yoyodyne.com -o
2217 /tmp/log}, you should try to see if it will crash with a simpler set of
2220 Also, while I will probably be interested to know the contents of your
2221 @file{.wgetrc} file, just dumping it into the debug message is probably
2222 a bad idea. Instead, you should first try to see if the bug repeats
2223 with @file{.wgetrc} moved out of the way. Only if it turns out that
2224 @file{.wgetrc} settings affect the bug, should you mail me the relevant
2228 Please start Wget with @samp{-d} option and send the log (or the
2229 relevant parts of it). If Wget was compiled without debug support,
2230 recompile it. It is @emph{much} easier to trace bugs with debug support
2234 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2235 wget` core} and type @code{where} to get the backtrace.
2238 Find where the bug is, fix it and send me the patches. :-)
2241 @node Portability, Signals, Reporting Bugs, Various
2242 @section Portability
2244 @cindex operating systems
2246 Since Wget uses GNU Autoconf for building and configuring, and avoids
2247 using ``special'' ultra--mega--cool features of any particular Unix, it
2248 should compile (and work) on all common Unix flavors.
2250 Various Wget versions have been compiled and tested under many kinds of
2251 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2252 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2253 distribution directory for a comprehensive list. If you compile it on
2254 an architecture not listed there, please let me know so I can update it.
2256 Wget should also compile on the other Unix systems, not listed in
2257 @file{MACHINES}. If it doesn't, please let me know.
2259 Thanks to kind contributors, this version of Wget compiles and works on
2260 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2261 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2262 with Winsock as networking software. Naturally, it is crippled of some
2263 features available on Unix, but it should work as a substitute for
2264 people stuck with Windows. Note that the Windows port is
2265 @strong{neither tested nor maintained} by me---all questions and
2266 problems should be reported to Wget mailing list at
2267 @email{wget@@sunsite.auc.dk} where the maintainers will look at them.
2269 @node Signals, , Portability, Various
2271 @cindex signal handling
2274 Since the purpose of Wget is background work, it catches the hangup
2275 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2276 output, it will be redirected to a file named @file{wget-log}.
2277 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2278 to redirect the output of Wget after having started it.
2281 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2282 $ kill -HUP %% # Redirect the output to wget-log
2285 Other than that, Wget will not try to interfere with signals in any
2286 way. @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it
2289 @node Appendices, Copying, Various, Top
2292 This chapter contains some references I consider useful, like the Robots
2293 Exclusion Standard specification, as well as a list of contributors to
2297 * Robots:: Wget as a WWW robot.
2298 * Security Considerations:: Security with Wget.
2299 * Contributors:: People who helped.
2302 @node Robots, Security Considerations, Appendices, Appendices
2306 @cindex server maintenance
2308 Since Wget is able to traverse the web, it counts as one of the Web
2309 @dfn{robots}. Thus Wget understands @dfn{Robots Exclusion Standard}
2310 (@sc{res})---contents of @file{/robots.txt}, used by server
2311 administrators to shield parts of their systems from wanderings of Wget.
2313 Norobots support is turned on only when retrieving recursively, and
2314 @emph{never} for the first page. Thus, you may issue:
2317 wget -r http://fly.cc.fer.hr/
2320 First the index of fly.cc.fer.hr will be downloaded. If Wget finds
2321 anything worth downloading on the same host, only @emph{then} will it
2322 load the robots, and decide whether or not to load the links after all.
2323 @file{/robots.txt} is loaded only once per host. Wget does not support
2324 the robots @code{META} tag.
2326 The description of the norobots standard was written, and is maintained
2327 by Martijn Koster @email{m.koster@@webcrawler.com}. With his
2328 permission, I contribute a (slightly modified) TeXified version of the
2332 * Introduction to RES::
2334 * User-Agent Field::
2336 * Norobots Examples::
2339 @node Introduction to RES, RES Format, Robots, Robots
2340 @subsection Introduction to RES
2341 @cindex norobots introduction
2343 @dfn{WWW Robots} (also called @dfn{wanderers} or @dfn{spiders}) are
2344 programs that traverse many pages in the World Wide Web by recursively
2345 retrieving linked pages. For more information see the robots page.
2347 In 1993 and 1994 there have been occasions where robots have visited
2348 @sc{www} servers where they weren't welcome for various
2349 reasons. Sometimes these reasons were robot specific, e.g. certain
2350 robots swamped servers with rapid-fire requests, or retrieved the same
2351 files repeatedly. In other situations robots traversed parts of @sc{www}
2352 servers that weren't suitable, e.g. very deep virtual trees, duplicated
2353 information, temporary information, or cgi-scripts with side-effects
2356 These incidents indicated the need for established mechanisms for
2357 @sc{www} servers to indicate to robots which parts of their server
2358 should not be accessed. This standard addresses this need with an
2359 operational solution.
2361 This document represents a consensus on 30 June 1994 on the robots
2362 mailing list (@code{robots@@webcrawler.com}), between the majority of
2363 robot authors and other people with an interest in robots. It has also
2364 been open for discussion on the Technical World Wide Web mailing list
2365 (@code{www-talk@@info.cern.ch}). This document is based on a previous
2366 working draft under the same title.
2368 It is not an official standard backed by a standards body, or owned by
2369 any commercial organization. It is not enforced by anybody, and there
2370 no guarantee that all current and future robots will use it. Consider
2371 it a common facility the majority of robot authors offer the @sc{www}
2372 community to protect @sc{www} server against unwanted accesses by their
2375 The latest version of this document can be found at
2376 @url{http://info.webcrawler.com/mak/projects/robots/norobots.html}.
2378 @node RES Format, User-Agent Field, Introduction to RES, Robots
2379 @subsection RES Format
2380 @cindex norobots format
2382 The format and semantics of the @file{/robots.txt} file are as follows:
2384 The file consists of one or more records separated by one or more blank
2385 lines (terminated by @code{CR}, @code{CR/NL}, or @code{NL}). Each
2386 record contains lines of the form:
2389 <field>:<optionalspace><value><optionalspace>
2392 The field name is case insensitive.
2394 Comments can be included in file using UNIX Bourne shell conventions:
2395 the @samp{#} character is used to indicate that preceding space (if any)
2396 and the remainder of the line up to the line termination is discarded.
2397 Lines containing only a comment are discarded completely, and therefore
2398 do not indicate a record boundary.
2400 The record starts with one or more User-agent lines, followed by one or
2401 more Disallow lines, as detailed below. Unrecognized headers are
2404 The presence of an empty @file{/robots.txt} file has no explicit
2405 associated semantics, it will be treated as if it was not present,
2406 i.e. all robots will consider themselves welcome.
2408 @node User-Agent Field, Disallow Field, RES Format, Robots
2409 @subsection User-Agent Field
2410 @cindex norobots user-agent
2412 The value of this field is the name of the robot the record is
2413 describing access policy for.
2415 If more than one User-agent field is present the record describes an
2416 identical access policy for more than one robot. At least one field
2417 needs to be present per record.
2419 The robot should be liberal in interpreting this field. A case
2420 insensitive substring match of the name without version information is
2423 If the value is @samp{*}, the record describes the default access policy
2424 for any robot that has not matched any of the other records. It is not
2425 allowed to have multiple such records in the @file{/robots.txt} file.
2427 @node Disallow Field, Norobots Examples, User-Agent Field, Robots
2428 @subsection Disallow Field
2429 @cindex norobots disallow
2431 The value of this field specifies a partial @sc{url} that is not to be
2432 visited. This can be a full path, or a partial path; any @sc{url} that
2433 starts with this value will not be retrieved. For example,
2434 @w{@samp{Disallow: /help}} disallows both @samp{/help.html} and
2435 @samp{/help/index.html}, whereas @w{@samp{Disallow: /help/}} would
2436 disallow @samp{/help/index.html} but allow @samp{/help.html}.
2438 Any empty value, indicates that all @sc{url}s can be retrieved. At least
2439 one Disallow field needs to be present in a record.
2441 @node Norobots Examples, , Disallow Field, Robots
2442 @subsection Norobots Examples
2443 @cindex norobots examples
2445 The following example @samp{/robots.txt} file specifies that no robots
2446 should visit any @sc{url} starting with @samp{/cyberworld/map/} or
2450 # robots.txt for http://www.site.com/
2453 Disallow: /cyberworld/map/ # This is an infinite virtual URL space
2454 Disallow: /tmp/ # these will soon disappear
2457 This example @samp{/robots.txt} file specifies that no robots should
2458 visit any @sc{url} starting with @samp{/cyberworld/map/}, except the
2459 robot called @samp{cybermapper}:
2462 # robots.txt for http://www.site.com/
2465 Disallow: /cyberworld/map/ # This is an infinite virtual URL space
2467 # Cybermapper knows where to go.
2468 User-agent: cybermapper
2472 This example indicates that no robots should visit this site further:
2480 @node Security Considerations, Contributors, Robots, Appendices
2481 @section Security Considerations
2484 When using Wget, you must be aware that it sends unencrypted passwords
2485 through the network, which may present a security problem. Here are the
2486 main issues, and some solutions.
2490 The passwords on the command line are visible using @code{ps}. If this
2491 is a problem, avoid putting passwords from the command line---e.g. you
2492 can use @file{.netrc} for this.
2495 Using the insecure @dfn{basic} authentication scheme, unencrypted
2496 passwords are transmitted through the network routers and gateways.
2499 The @sc{ftp} passwords are also in no way encrypted. There is no good
2500 solution for this at the moment.
2503 Although the ``normal'' output of Wget tries to hide the passwords,
2504 debugging logs show them, in all forms. This problem is avoided by
2505 being careful when you send debug logs (yes, even when you send them to
2509 @node Contributors, , Security Considerations, Appendices
2510 @section Contributors
2511 @cindex contributors
2514 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@iskon.hr}.
2517 GNU Wget was written by Hrvoje Niksic @email{hniksic@@iskon.hr}.
2519 However, its development could never have gone as far as it has, were it
2520 not for the help of many people, either with bug reports, feature
2521 proposals, patches, or letters saying ``Thanks!''.
2523 Special thanks goes to the following people (no particular order):
2527 Karsten Thygesen---donated the mailing list and the initial @sc{ftp}
2531 Shawn McHorse---bug reports and patches.
2534 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization.
2537 Gordon Matzigkeit---@file{.netrc} support.
2541 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2542 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2545 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2546 and ``philosophical'' discussions.
2550 Darko Budor---initial port to Windows.
2553 Antonio Rosella---help and suggestions, plus the Italian translation.
2557 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2561 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2566 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2569 Francois Pinard---many thorough bug reports and discussions.
2573 Karl Eichwalder---lots of help with internationalization and other
2577 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2581 Brian Gough---a generous donation.
2584 The following people have provided patches, bug/build reports, useful
2585 suggestions, beta testing services, fan mail and all the other things
2586 that make maintenance so much fun:
2591 Roger Beeman and the Gurus at Cisco,
2600 Kristijan @v{C}onka@v{s},
2616 Aleksandar Erkalovi@'{c},
2619 Aleksandar Erkalovic,
2632 Erik Magnus Hulthen,
2642 Goran Kezunovi@'{c},
2652 $\Sigma\acute{\iota}\mu o\varsigma\;
2653 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
2654 (Simos KSenitellis),
2671 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
2673 Juan Jos\'{e} Rodr\'{\i}gues,
2676 Juan Jose Rodrigues,
2685 Szakacsits Szabolcs,
2689 Douglas E. Wegscheid,
2699 Apologies to all who I accidentally left out, and many thanks to all the
2700 subscribers of the Wget mailing list.
2702 @node Copying, Concept Index, Appendices, Top
2703 @unnumbered GNU GENERAL PUBLIC LICENSE
2706 @center Version 2, June 1991
2709 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
2710 675 Mass Ave, Cambridge, MA 02139, USA
2712 Everyone is permitted to copy and distribute verbatim copies
2713 of this license document, but changing it is not allowed.
2716 @unnumberedsec Preamble
2718 The licenses for most software are designed to take away your
2719 freedom to share and change it. By contrast, the GNU General Public
2720 License is intended to guarantee your freedom to share and change free
2721 software---to make sure the software is free for all its users. This
2722 General Public License applies to most of the Free Software
2723 Foundation's software and to any other program whose authors commit to
2724 using it. (Some other Free Software Foundation software is covered by
2725 the GNU Library General Public License instead.) You can apply it to
2728 When we speak of free software, we are referring to freedom, not
2729 price. Our General Public Licenses are designed to make sure that you
2730 have the freedom to distribute copies of free software (and charge for
2731 this service if you wish), that you receive source code or can get it
2732 if you want it, that you can change the software or use pieces of it
2733 in new free programs; and that you know you can do these things.
2735 To protect your rights, we need to make restrictions that forbid
2736 anyone to deny you these rights or to ask you to surrender the rights.
2737 These restrictions translate to certain responsibilities for you if you
2738 distribute copies of the software, or if you modify it.
2740 For example, if you distribute copies of such a program, whether
2741 gratis or for a fee, you must give the recipients all the rights that
2742 you have. You must make sure that they, too, receive or can get the
2743 source code. And you must show them these terms so they know their
2746 We protect your rights with two steps: (1) copyright the software, and
2747 (2) offer you this license which gives you legal permission to copy,
2748 distribute and/or modify the software.
2750 Also, for each author's protection and ours, we want to make certain
2751 that everyone understands that there is no warranty for this free
2752 software. If the software is modified by someone else and passed on, we
2753 want its recipients to know that what they have is not the original, so
2754 that any problems introduced by others will not reflect on the original
2755 authors' reputations.
2757 Finally, any free program is threatened constantly by software
2758 patents. We wish to avoid the danger that redistributors of a free
2759 program will individually obtain patent licenses, in effect making the
2760 program proprietary. To prevent this, we have made it clear that any
2761 patent must be licensed for everyone's free use or not licensed at all.
2763 The precise terms and conditions for copying, distribution and
2764 modification follow.
2767 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2770 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2775 This License applies to any program or other work which contains
2776 a notice placed by the copyright holder saying it may be distributed
2777 under the terms of this General Public License. The ``Program'', below,
2778 refers to any such program or work, and a ``work based on the Program''
2779 means either the Program or any derivative work under copyright law:
2780 that is to say, a work containing the Program or a portion of it,
2781 either verbatim or with modifications and/or translated into another
2782 language. (Hereinafter, translation is included without limitation in
2783 the term ``modification''.) Each licensee is addressed as ``you''.
2785 Activities other than copying, distribution and modification are not
2786 covered by this License; they are outside its scope. The act of
2787 running the Program is not restricted, and the output from the Program
2788 is covered only if its contents constitute a work based on the
2789 Program (independent of having been made by running the Program).
2790 Whether that is true depends on what the Program does.
2793 You may copy and distribute verbatim copies of the Program's
2794 source code as you receive it, in any medium, provided that you
2795 conspicuously and appropriately publish on each copy an appropriate
2796 copyright notice and disclaimer of warranty; keep intact all the
2797 notices that refer to this License and to the absence of any warranty;
2798 and give any other recipients of the Program a copy of this License
2799 along with the Program.
2801 You may charge a fee for the physical act of transferring a copy, and
2802 you may at your option offer warranty protection in exchange for a fee.
2805 You may modify your copy or copies of the Program or any portion
2806 of it, thus forming a work based on the Program, and copy and
2807 distribute such modifications or work under the terms of Section 1
2808 above, provided that you also meet all of these conditions:
2812 You must cause the modified files to carry prominent notices
2813 stating that you changed the files and the date of any change.
2816 You must cause any work that you distribute or publish, that in
2817 whole or in part contains or is derived from the Program or any
2818 part thereof, to be licensed as a whole at no charge to all third
2819 parties under the terms of this License.
2822 If the modified program normally reads commands interactively
2823 when run, you must cause it, when started running for such
2824 interactive use in the most ordinary way, to print or display an
2825 announcement including an appropriate copyright notice and a
2826 notice that there is no warranty (or else, saying that you provide
2827 a warranty) and that users may redistribute the program under
2828 these conditions, and telling the user how to view a copy of this
2829 License. (Exception: if the Program itself is interactive but
2830 does not normally print such an announcement, your work based on
2831 the Program is not required to print an announcement.)
2834 These requirements apply to the modified work as a whole. If
2835 identifiable sections of that work are not derived from the Program,
2836 and can be reasonably considered independent and separate works in
2837 themselves, then this License, and its terms, do not apply to those
2838 sections when you distribute them as separate works. But when you
2839 distribute the same sections as part of a whole which is a work based
2840 on the Program, the distribution of the whole must be on the terms of
2841 this License, whose permissions for other licensees extend to the
2842 entire whole, and thus to each and every part regardless of who wrote it.
2844 Thus, it is not the intent of this section to claim rights or contest
2845 your rights to work written entirely by you; rather, the intent is to
2846 exercise the right to control the distribution of derivative or
2847 collective works based on the Program.
2849 In addition, mere aggregation of another work not based on the Program
2850 with the Program (or with a work based on the Program) on a volume of
2851 a storage or distribution medium does not bring the other work under
2852 the scope of this License.
2855 You may copy and distribute the Program (or a work based on it,
2856 under Section 2) in object code or executable form under the terms of
2857 Sections 1 and 2 above provided that you also do one of the following:
2861 Accompany it with the complete corresponding machine-readable
2862 source code, which must be distributed under the terms of Sections
2863 1 and 2 above on a medium customarily used for software interchange; or,
2866 Accompany it with a written offer, valid for at least three
2867 years, to give any third party, for a charge no more than your
2868 cost of physically performing source distribution, a complete
2869 machine-readable copy of the corresponding source code, to be
2870 distributed under the terms of Sections 1 and 2 above on a medium
2871 customarily used for software interchange; or,
2874 Accompany it with the information you received as to the offer
2875 to distribute corresponding source code. (This alternative is
2876 allowed only for noncommercial distribution and only if you
2877 received the program in object code or executable form with such
2878 an offer, in accord with Subsection b above.)
2881 The source code for a work means the preferred form of the work for
2882 making modifications to it. For an executable work, complete source
2883 code means all the source code for all modules it contains, plus any
2884 associated interface definition files, plus the scripts used to
2885 control compilation and installation of the executable. However, as a
2886 special exception, the source code distributed need not include
2887 anything that is normally distributed (in either source or binary
2888 form) with the major components (compiler, kernel, and so on) of the
2889 operating system on which the executable runs, unless that component
2890 itself accompanies the executable.
2892 If distribution of executable or object code is made by offering
2893 access to copy from a designated place, then offering equivalent
2894 access to copy the source code from the same place counts as
2895 distribution of the source code, even though third parties are not
2896 compelled to copy the source along with the object code.
2899 You may not copy, modify, sublicense, or distribute the Program
2900 except as expressly provided under this License. Any attempt
2901 otherwise to copy, modify, sublicense or distribute the Program is
2902 void, and will automatically terminate your rights under this License.
2903 However, parties who have received copies, or rights, from you under
2904 this License will not have their licenses terminated so long as such
2905 parties remain in full compliance.
2908 You are not required to accept this License, since you have not
2909 signed it. However, nothing else grants you permission to modify or
2910 distribute the Program or its derivative works. These actions are
2911 prohibited by law if you do not accept this License. Therefore, by
2912 modifying or distributing the Program (or any work based on the
2913 Program), you indicate your acceptance of this License to do so, and
2914 all its terms and conditions for copying, distributing or modifying
2915 the Program or works based on it.
2918 Each time you redistribute the Program (or any work based on the
2919 Program), the recipient automatically receives a license from the
2920 original licensor to copy, distribute or modify the Program subject to
2921 these terms and conditions. You may not impose any further
2922 restrictions on the recipients' exercise of the rights granted herein.
2923 You are not responsible for enforcing compliance by third parties to
2927 If, as a consequence of a court judgment or allegation of patent
2928 infringement or for any other reason (not limited to patent issues),
2929 conditions are imposed on you (whether by court order, agreement or
2930 otherwise) that contradict the conditions of this License, they do not
2931 excuse you from the conditions of this License. If you cannot
2932 distribute so as to satisfy simultaneously your obligations under this
2933 License and any other pertinent obligations, then as a consequence you
2934 may not distribute the Program at all. For example, if a patent
2935 license would not permit royalty-free redistribution of the Program by
2936 all those who receive copies directly or indirectly through you, then
2937 the only way you could satisfy both it and this License would be to
2938 refrain entirely from distribution of the Program.
2940 If any portion of this section is held invalid or unenforceable under
2941 any particular circumstance, the balance of the section is intended to
2942 apply and the section as a whole is intended to apply in other
2945 It is not the purpose of this section to induce you to infringe any
2946 patents or other property right claims or to contest validity of any
2947 such claims; this section has the sole purpose of protecting the
2948 integrity of the free software distribution system, which is
2949 implemented by public license practices. Many people have made
2950 generous contributions to the wide range of software distributed
2951 through that system in reliance on consistent application of that
2952 system; it is up to the author/donor to decide if he or she is willing
2953 to distribute software through any other system and a licensee cannot
2956 This section is intended to make thoroughly clear what is believed to
2957 be a consequence of the rest of this License.
2960 If the distribution and/or use of the Program is restricted in
2961 certain countries either by patents or by copyrighted interfaces, the
2962 original copyright holder who places the Program under this License
2963 may add an explicit geographical distribution limitation excluding
2964 those countries, so that distribution is permitted only in or among
2965 countries not thus excluded. In such case, this License incorporates
2966 the limitation as if written in the body of this License.
2969 The Free Software Foundation may publish revised and/or new versions
2970 of the General Public License from time to time. Such new versions will
2971 be similar in spirit to the present version, but may differ in detail to
2972 address new problems or concerns.
2974 Each version is given a distinguishing version number. If the Program
2975 specifies a version number of this License which applies to it and ``any
2976 later version'', you have the option of following the terms and conditions
2977 either of that version or of any later version published by the Free
2978 Software Foundation. If the Program does not specify a version number of
2979 this License, you may choose any version ever published by the Free Software
2983 If you wish to incorporate parts of the Program into other free
2984 programs whose distribution conditions are different, write to the author
2985 to ask for permission. For software which is copyrighted by the Free
2986 Software Foundation, write to the Free Software Foundation; we sometimes
2987 make exceptions for this. Our decision will be guided by the two goals
2988 of preserving the free status of all derivatives of our free software and
2989 of promoting the sharing and reuse of software generally.
2992 @heading NO WARRANTY
3000 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3001 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3002 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3003 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3004 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3005 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3006 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3007 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3008 REPAIR OR CORRECTION.
3011 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3012 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3013 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3014 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3015 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3016 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3017 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3018 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3019 POSSIBILITY OF SUCH DAMAGES.
3023 @heading END OF TERMS AND CONDITIONS
3026 @center END OF TERMS AND CONDITIONS
3030 @unnumberedsec How to Apply These Terms to Your New Programs
3032 If you develop a new program, and you want it to be of the greatest
3033 possible use to the public, the best way to achieve this is to make it
3034 free software which everyone can redistribute and change under these terms.
3036 To do so, attach the following notices to the program. It is safest
3037 to attach them to the start of each source file to most effectively
3038 convey the exclusion of warranty; and each file should have at least
3039 the ``copyright'' line and a pointer to where the full notice is found.
3042 @var{one line to give the program's name and an idea of what it does.}
3043 Copyright (C) 19@var{yy} @var{name of author}
3045 This program is free software; you can redistribute it and/or
3046 modify it under the terms of the GNU General Public License
3047 as published by the Free Software Foundation; either version 2
3048 of the License, or (at your option) any later version.
3050 This program is distributed in the hope that it will be useful,
3051 but WITHOUT ANY WARRANTY; without even the implied warranty of
3052 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3053 GNU General Public License for more details.
3055 You should have received a copy of the GNU General Public License
3056 along with this program; if not, write to the Free Software
3057 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3060 Also add information on how to contact you by electronic and paper mail.
3062 If the program is interactive, make it output a short notice like this
3063 when it starts in an interactive mode:
3066 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3067 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3068 type `show w'. This is free software, and you are welcome
3069 to redistribute it under certain conditions; type `show c'
3073 The hypothetical commands @samp{show w} and @samp{show c} should show
3074 the appropriate parts of the General Public License. Of course, the
3075 commands you use may be called something other than @samp{show w} and
3076 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3079 You should also get your employer (if you work as a programmer) or your
3080 school, if any, to sign a ``copyright disclaimer'' for the program, if
3081 necessary. Here is a sample; alter the names:
3085 Yoyodyne, Inc., hereby disclaims all copyright
3086 interest in the program `Gnomovision'
3087 (which makes passes at compilers) written
3090 @var{signature of Ty Coon}, 1 April 1989
3091 Ty Coon, President of Vice
3095 This General Public License does not permit incorporating your program into
3096 proprietary programs. If your program is a subroutine library, you may
3097 consider it more useful to permit linking proprietary applications with the
3098 library. If this is what you want to do, use the GNU Library General
3099 Public License instead of this License.
3101 @node Concept Index, , Copying, Top
3102 @unnumbered Concept Index