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 Title for man page. The weird way texi2pod.pl is written requires
18 @c the preceding @set.
20 @c man title Wget The non-interactive network downloader.
22 @c This should really be generated automatically, possibly by including
23 @c an auto-generated file.
25 @set UPDATED September 2003
27 @dircategory Net Utilities
28 @dircategory World Wide Web
30 * Wget: (wget). The non-interactive network downloader.
34 This file documents the the GNU Wget utility for downloading network
37 @c man begin COPYRIGHT
38 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001, 2002, 2003 Free
39 Software Foundation, Inc.
41 Permission is granted to make and distribute verbatim copies of
42 this manual provided the copyright notice and this permission notice
43 are preserved on all copies.
46 Permission is granted to process this file through TeX and print the
47 results, provided the printed document carries a copying permission
48 notice identical to this one except for the removal of this paragraph
49 (this paragraph not being relevant to the printed manual).
51 Permission is granted to copy, distribute and/or modify this document
52 under the terms of the GNU Free Documentation License, Version 1.1 or
53 any later version published by the Free Software Foundation; with the
54 Invariant Sections being ``GNU General Public License'' and ``GNU Free
55 Documentation License'', with no Front-Cover Texts, and with no
56 Back-Cover Texts. A copy of the license is included in the section
57 entitled ``GNU Free Documentation License''.
63 @subtitle The noninteractive downloading utility
64 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
65 @author by Hrvoje Nik@v{s}i@'{c} and the developers
69 Originally written by Hrvoje Niksic <hniksic@arsdigita.com>.
72 GNU Info entry for @file{wget}.
77 @vskip 0pt plus 1filll
78 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
81 Permission is granted to copy, distribute and/or modify this document
82 under the terms of the GNU Free Documentation License, Version 1.1 or
83 any later version published by the Free Software Foundation; with the
84 Invariant Sections being ``GNU General Public License'' and ``GNU Free
85 Documentation License'', with no Front-Cover Texts, and with no
86 Back-Cover Texts. A copy of the license is included in the section
87 entitled ``GNU Free Documentation License''.
91 @node Top, Overview, (dir), (dir)
92 @top Wget @value{VERSION}
94 This manual documents version @value{VERSION} of GNU Wget, the freely
95 available utility for network download.
97 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
101 * Overview:: Features of Wget.
102 * Invoking:: Wget command-line arguments.
103 * Recursive Retrieval:: Description of recursive retrieval.
104 * Following Links:: The available methods of chasing links.
105 * Time-Stamping:: Mirroring according to time-stamps.
106 * Startup File:: Wget's initialization file.
107 * Examples:: Examples of usage.
108 * Various:: The stuff that doesn't fit anywhere else.
109 * Appendices:: Some useful references.
110 * Copying:: You may give out copies of Wget and of this manual.
111 * Concept Index:: Topics covered by this manual.
115 @node Overview, Invoking, Top, Top
120 @c man begin DESCRIPTION
121 GNU Wget is a free utility for non-interactive download of files from
122 the Web. It supports @sc{http}, @sc{https}, and @sc{ftp} protocols, as
123 well as retrieval through @sc{http} proxies.
126 This chapter is a partial overview of Wget's features.
130 @c man begin DESCRIPTION
131 Wget is non-interactive, meaning that it can work in the background,
132 while the user is not logged on. This allows you to start a retrieval
133 and disconnect from the system, letting Wget finish the work. By
134 contrast, most of the Web browsers require constant user's presence,
135 which can be a great hindrance when transferring a lot of data.
141 @c man begin DESCRIPTION
145 @c man begin DESCRIPTION
146 Wget can follow links in @sc{html} pages and create local versions of
147 remote web sites, fully recreating the directory structure of the
148 original site. This is sometimes referred to as ``recursive
149 downloading.'' While doing that, Wget respects the Robot Exclusion
150 Standard (@file{/robots.txt}). Wget can be instructed to convert the
151 links in downloaded @sc{html} files to the local files for offline
157 File name wildcard matching and recursive mirroring of directories are
158 available when retrieving via @sc{ftp}. Wget can read the time-stamp
159 information given by both @sc{http} and @sc{ftp} servers, and store it
160 locally. Thus Wget can see if the remote file has changed since last
161 retrieval, and automatically retrieve the new version if it has. This
162 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
168 @c man begin DESCRIPTION
172 @c man begin DESCRIPTION
173 Wget has been designed for robustness over slow or unstable network
174 connections; if a download fails due to a network problem, it will
175 keep retrying until the whole file has been retrieved. If the server
176 supports regetting, it will instruct the server to continue the
177 download from where it left off.
182 Wget supports proxy servers, which can lighten the network load, speed
183 up retrieval and provide access behind firewalls. However, if you are
184 behind a firewall that requires that you use a socks style gateway, you
185 can get the socks library and build Wget with support for socks. Wget
186 also supports the passive @sc{ftp} downloading as an option.
190 Builtin features offer mechanisms to tune which links you wish to follow
191 (@pxref{Following Links}).
195 The retrieval is conveniently traced with printing dots, each dot
196 representing a fixed amount of data received (1KB by default). These
197 representations can be customized to your preferences.
201 Most of the features are fully configurable, either through command line
202 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
203 File}). Wget allows you to define @dfn{global} startup files
204 (@file{/usr/local/etc/wgetrc} by default) for site settings.
209 @item /usr/local/etc/wgetrc
210 Default location of the @dfn{global} startup file.
220 Finally, GNU Wget is free software. This means that everyone may use
221 it, redistribute it and/or modify it under the terms of the GNU General
222 Public License, as published by the Free Software Foundation
226 @node Invoking, Recursive Retrieval, Overview, Top
233 By default, Wget is very simple to invoke. The basic syntax is:
236 @c man begin SYNOPSIS
237 wget [@var{option}]@dots{} [@var{URL}]@dots{}
241 Wget will simply download all the @sc{url}s specified on the command
242 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
244 However, you may wish to change some of the default parameters of
245 Wget. You can do it two ways: permanently, adding the appropriate
246 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
252 * Basic Startup Options::
253 * Logging and Input File Options::
255 * Directory Options::
258 * Recursive Retrieval Options::
259 * Recursive Accept/Reject Options::
262 @node URL Format, Option Syntax, Invoking, Invoking
267 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
268 resource locator is a compact string representation for a resource
269 available via the Internet. Wget recognizes the @sc{url} syntax as per
270 @sc{rfc1738}. This is the most widely used form (square brackets denote
274 http://host[:port]/directory/file
275 ftp://host[:port]/directory/file
278 You can also encode your username and password within a @sc{url}:
281 ftp://user:password@@host/path
282 http://user:password@@host/path
285 Either @var{user} or @var{password}, or both, may be left out. If you
286 leave out either the @sc{http} username or password, no authentication
287 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
288 will be used. If you leave out the @sc{ftp} password, your email
289 address will be supplied as a default password.@footnote{If you have a
290 @file{.netrc} file in your home directory, password will also be
293 @strong{Important Note}: if you specify a password-containing @sc{url}
294 on the command line, the username and password will be plainly visible
295 to all users on the system, by way of @code{ps}. On multi-user systems,
296 this is a big security risk. To work around it, use @code{wget -i -}
297 and feed the @sc{url}s to Wget's standard input, each on a separate
298 line, terminated by @kbd{C-d}.
300 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
301 being the hexadecimal representation of the character's @sc{ascii}
302 value. Some common unsafe characters include @samp{%} (quoted as
303 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
304 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
307 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
308 default, @sc{ftp} documents are retrieved in the binary mode (type
309 @samp{i}), which means that they are downloaded unchanged. Another
310 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
311 delimiters between the different operating systems, and is thus useful
312 for text files. Here is an example:
315 ftp://host/directory/file;type=a
318 Two alternative variants of @sc{url} specification are also supported,
319 because of historical (hysterical?) reasons and their widespreaded use.
321 @sc{ftp}-only syntax (supported by @code{NcFTP}):
326 @sc{http}-only syntax (introduced by @code{Netscape}):
331 These two alternative forms are deprecated, and may cease being
332 supported in the future.
334 If you do not understand the difference between these notations, or do
335 not know which one to use, just use the plain ordinary format you use
336 with your favorite browser, like @code{Lynx} or @code{Netscape}.
338 @node Option Syntax, Basic Startup Options, URL Format, Invoking
339 @section Option Syntax
340 @cindex option syntax
341 @cindex syntax of options
343 Since Wget uses GNU getopts to process its arguments, every option has a
344 short form and a long form. Long options are more convenient to
345 remember, but take time to type. You may freely mix different option
346 styles, or specify options after the command-line arguments. Thus you
350 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
353 The space between the option accepting an argument and the argument may
354 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
356 You may put several options that do not require arguments together,
363 This is a complete equivalent of:
366 wget -d -r -c @var{URL}
369 Since the options can be specified after the arguments, you may
370 terminate them with @samp{--}. So the following will try to download
371 @sc{url} @samp{-x}, reporting failure to @file{log}:
377 The options that accept comma-separated lists all respect the convention
378 that specifying an empty list clears its value. This can be useful to
379 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
380 sets @code{exclude_directories} to @file{/cgi-bin}, the following
381 example will first reset it, and then set it to exclude @file{/~nobody}
382 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
383 (@pxref{Wgetrc Syntax}).
386 wget -X '' -X /~nobody,/~somebody
391 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
392 @section Basic Startup Options
397 Display the version of Wget.
401 Print a help message describing all of Wget's command-line options.
405 Go to background immediately after startup. If no output file is
406 specified via the @samp{-o}, output is redirected to @file{wget-log}.
408 @cindex execute wgetrc command
409 @item -e @var{command}
410 @itemx --execute @var{command}
411 Execute @var{command} as if it were a part of @file{.wgetrc}
412 (@pxref{Startup File}). A command thus invoked will be executed
413 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
417 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
418 @section Logging and Input File Options
423 @item -o @var{logfile}
424 @itemx --output-file=@var{logfile}
425 Log all messages to @var{logfile}. The messages are normally reported
428 @cindex append to log
429 @item -a @var{logfile}
430 @itemx --append-output=@var{logfile}
431 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
432 to @var{logfile} instead of overwriting the old log file. If
433 @var{logfile} does not exist, a new file is created.
438 Turn on debug output, meaning various information important to the
439 developers of Wget if it does not work properly. Your system
440 administrator may have chosen to compile Wget without debug support, in
441 which case @samp{-d} will not work. Please note that compiling with
442 debug support is always safe---Wget compiled with the debug support will
443 @emph{not} print any debug info unless requested with @samp{-d}.
444 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
450 Turn off Wget's output.
455 Turn on verbose output, with all the available data. The default output
460 Non-verbose output---turn off verbose without being completely quiet
461 (use @samp{-q} for that), which means that error messages and basic
462 information still get printed.
466 @itemx --input-file=@var{file}
467 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
468 the command line. If there are @sc{url}s both on the command line and
469 in an input file, those on the command lines will be the first ones to
470 be retrieved. The @var{file} need not be an @sc{html} document (but no
471 harm if it is)---it is enough if the @sc{url}s are just listed
474 However, if you specify @samp{--force-html}, the document will be
475 regarded as @samp{html}. In that case you may have problems with
476 relative links, which you can solve either by adding @code{<base
477 href="@var{url}">} to the documents or by specifying
478 @samp{--base=@var{url}} on the command line.
483 When input is read from a file, force it to be treated as an @sc{html}
484 file. This enables you to retrieve relative links from existing
485 @sc{html} files on your local disk, by adding @code{<base
486 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
489 @cindex base for relative links in input file
491 @itemx --base=@var{URL}
492 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
493 links in the file specified by @samp{-i}.
496 @node Download Options, Directory Options, Logging and Input File Options, Invoking
497 @section Download Options
500 @cindex bind() address
501 @cindex client IP address
502 @cindex IP address, client
503 @item --bind-address=@var{ADDRESS}
504 When making client TCP/IP connections, @code{bind()} to @var{ADDRESS} on
505 the local machine. @var{ADDRESS} may be specified as a hostname or IP
506 address. This option can be useful if your machine is bound to multiple
511 @cindex number of retries
512 @item -t @var{number}
513 @itemx --tries=@var{number}
514 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
515 infinite retrying. The default is to retry 20 times, with the exception
516 of fatal errors like ``connection refused'' or ``not found'' (404),
517 which are not retried.
520 @itemx --output-document=@var{file}
521 The documents will not be written to the appropriate files, but all will
522 be concatenated together and written to @var{file}. If @var{file}
523 already exists, it will be overwritten. If the @var{file} is @samp{-},
524 the documents will be written to standard output. Including this option
525 automatically sets the number of tries to 1.
527 @cindex clobbering, file
528 @cindex downloading multiple times
532 If a file is downloaded more than once in the same directory, Wget's
533 behavior depends on a few options, including @samp{-nc}. In certain
534 cases, the local file will be @dfn{clobbered}, or overwritten, upon
535 repeated download. In other cases it will be preserved.
537 When running Wget without @samp{-N}, @samp{-nc}, or @samp{-r},
538 downloading the same file in the same directory will result in the
539 original copy of @var{file} being preserved and the second copy being
540 named @samp{@var{file}.1}. If that file is downloaded yet again, the
541 third copy will be named @samp{@var{file}.2}, and so on. When
542 @samp{-nc} is specified, this behavior is suppressed, and Wget will
543 refuse to download newer copies of @samp{@var{file}}. Therefore,
544 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
545 clobbering that's prevented (as the numeric suffixes were already
546 preventing clobbering), but rather the multiple version saving that's
549 When running Wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
550 re-downloading a file will result in the new copy simply overwriting the
551 old. Adding @samp{-nc} will prevent this behavior, instead causing the
552 original version to be preserved and any newer copies on the server to
555 When running Wget with @samp{-N}, with or without @samp{-r}, the
556 decision as to whether or not to download a newer copy of a file depends
557 on the local and remote timestamp and size of the file
558 (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the same
561 Note that when @samp{-nc} is specified, files with the suffixes
562 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
563 and parsed as if they had been retrieved from the Web.
565 @cindex continue retrieval
566 @cindex incomplete downloads
567 @cindex resume download
570 Continue getting a partially-downloaded file. This is useful when you
571 want to finish up a download started by a previous instance of Wget, or
572 by another program. For instance:
575 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
578 If there is a file named @file{ls-lR.Z} in the current directory, Wget
579 will assume that it is the first portion of the remote file, and will
580 ask the server to continue the retrieval from an offset equal to the
581 length of the local file.
583 Note that you don't need to specify this option if you just want the
584 current invocation of Wget to retry downloading a file should the
585 connection be lost midway through. This is the default behavior.
586 @samp{-c} only affects resumption of downloads started @emph{prior} to
587 this invocation of Wget, and whose local files are still sitting around.
589 Without @samp{-c}, the previous example would just download the remote
590 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
593 Beginning with Wget 1.7, if you use @samp{-c} on a non-empty file, and
594 it turns out that the server does not support continued downloading,
595 Wget will refuse to start the download from scratch, which would
596 effectively ruin existing contents. If you really want the download to
597 start from scratch, remove the file.
599 Also beginning with Wget 1.7, if you use @samp{-c} on a file which is of
600 equal size as the one on the server, Wget will refuse to download the
601 file and print an explanatory message. The same happens when the file
602 is smaller on the server than locally (presumably because it was changed
603 on the server since your last download attempt)---because ``continuing''
604 is not meaningful, no download occurs.
606 On the other side of the coin, while using @samp{-c}, any file that's
607 bigger on the server than locally will be considered an incomplete
608 download and only @code{(length(remote) - length(local))} bytes will be
609 downloaded and tacked onto the end of the local file. This behavior can
610 be desirable in certain cases---for instance, you can use @samp{wget -c}
611 to download just the new portion that's been appended to a data
612 collection or log file.
614 However, if the file is bigger on the server because it's been
615 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
616 with a garbled file. Wget has no way of verifying that the local file
617 is really a valid prefix of the remote file. You need to be especially
618 careful of this when using @samp{-c} in conjunction with @samp{-r},
619 since every file will be considered as an "incomplete download" candidate.
621 Another instance where you'll get a garbled file if you try to use
622 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
623 ``transfer interrupted'' string into the local file. In the future a
624 ``rollback'' option may be added to deal with this case.
626 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
627 servers that support the @code{Range} header.
629 @cindex progress indicator
631 @item --progress=@var{type}
632 Select the type of the progress indicator you wish to use. Legal
633 indicators are ``dot'' and ``bar''.
635 The ``bar'' indicator is used by default. It draws an ASCII progress
636 bar graphics (a.k.a ``thermometer'' display) indicating the status of
637 retrieval. If the output is not a TTY, the ``dot'' bar will be used by
640 Use @samp{--progress=dot} to switch to the ``dot'' display. It traces
641 the retrieval by printing dots on the screen, each dot representing a
642 fixed amount of downloaded data.
644 When using the dotted retrieval, you may also set the @dfn{style} by
645 specifying the type as @samp{dot:@var{style}}. Different styles assign
646 different meaning to one dot. With the @code{default} style each dot
647 represents 1K, there are ten dots in a cluster and 50 dots in a line.
648 The @code{binary} style has a more ``computer''-like orientation---8K
649 dots, 16-dots clusters and 48 dots per line (which makes for 384K
650 lines). The @code{mega} style is suitable for downloading very large
651 files---each dot represents 64K retrieved, there are eight dots in a
652 cluster, and 48 dots on each line (so each line contains 3M).
654 Note that you can set the default style using the @code{progress}
655 command in @file{.wgetrc}. That setting may be overridden from the
656 command line. The exception is that, when the output is not a TTY, the
657 ``dot'' progress will be favored over ``bar''. To force the bar output,
658 use @samp{--progress=bar:force}.
661 @itemx --timestamping
662 Turn on time-stamping. @xref{Time-Stamping}, for details.
664 @cindex server response, print
666 @itemx --server-response
667 Print the headers sent by @sc{http} servers and responses sent by
670 @cindex Wget as spider
673 When invoked with this option, Wget will behave as a Web @dfn{spider},
674 which means that it will not download the pages, just check that they
675 are there. You can use it to check your bookmarks, e.g. with:
678 wget --spider --force-html -i bookmarks.html
681 This feature needs much more work for Wget to get close to the
682 functionality of real @sc{www} spiders.
686 @itemx --timeout=@var{seconds}
687 Set the network timeout to @var{seconds} seconds. Whenever Wget
688 connects to or reads from a remote host, it checks for a timeout and
689 aborts the operation if the time expires. This prevents anomalous
690 occurrences such as hanging reads or infinite connects. The default
691 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
692 disable checking for timeouts.
694 Please do not lower the default timeout value with this option unless
695 you know what you are doing.
697 @cindex bandwidth, limit
699 @cindex limit bandwidth
700 @item --limit-rate=@var{amount}
701 Limit the download speed to @var{amount} bytes per second. Amount may
702 be expressed in bytes, kilobytes with the @samp{k} suffix, or megabytes
703 with the @samp{m} suffix. For example, @samp{--limit-rate=20k} will
704 limit the retrieval rate to 20KB/s. This kind of thing is useful when,
705 for whatever reason, you don't want Wget to consume the entire available
708 Note that Wget implements the limiting by sleeping the appropriate
709 amount of time after a network read that took less time than specified
710 by the rate. Eventually this strategy causes the TCP transfer to slow
711 down to approximately the specified rate. However, it takes some time
712 for this balance to be achieved, so don't be surprised if limiting the
713 rate doesn't work well with very small files.
717 @item -w @var{seconds}
718 @itemx --wait=@var{seconds}
719 Wait the specified number of seconds between the retrievals. Use of
720 this option is recommended, as it lightens the server load by making the
721 requests less frequent. Instead of in seconds, the time can be
722 specified in minutes using the @code{m} suffix, in hours using @code{h}
723 suffix, or in days using @code{d} suffix.
725 Specifying a large value for this option is useful if the network or the
726 destination host is down, so that Wget can wait long enough to
727 reasonably expect the network error to be fixed before the retry.
729 @cindex retries, waiting between
730 @cindex waiting between retries
731 @item --waitretry=@var{seconds}
732 If you don't want Wget to wait between @emph{every} retrieval, but only
733 between retries of failed downloads, you can use this option. Wget will
734 use @dfn{linear backoff}, waiting 1 second after the first failure on a
735 given file, then waiting 2 seconds after the second failure on that
736 file, up to the maximum number of @var{seconds} you specify. Therefore,
737 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
740 Note that this option is turned on by default in the global
746 Some web sites may perform log analysis to identify retrieval programs
747 such as Wget by looking for statistically significant similarities in
748 the time between requests. This option causes the time between requests
749 to vary between 0 and 2 * @var{wait} seconds, where @var{wait} was
750 specified using the @samp{-w} or @samp{--wait} options, in order to mask
751 Wget's presence from such analysis.
753 A recent article in a publication devoted to development on a popular
754 consumer platform provided code to perform this analysis on the fly.
755 Its author suggested blocking at the class C address level to ensure
756 automated retrieval programs were blocked despite changing DHCP-supplied
759 The @samp{--random-wait} option was inspired by this ill-advised
760 recommendation to block many unrelated users from a web site due to the
765 @itemx --proxy=on/off
766 Turn proxy support on or off. The proxy is on by default if the
767 appropriate environment variable is defined.
769 For more information about the use of proxies with Wget, @xref{Proxies}.
773 @itemx --quota=@var{quota}
774 Specify download quota for automatic retrievals. The value can be
775 specified in bytes (default), kilobytes (with @samp{k} suffix), or
776 megabytes (with @samp{m} suffix).
778 Note that quota will never affect downloading a single file. So if you
779 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
780 @file{ls-lR.gz} will be downloaded. The same goes even when several
781 @sc{url}s are specified on the command-line. However, quota is
782 respected when retrieving either recursively, or from an input file.
783 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
784 aborted when the quota is exceeded.
786 Setting quota to 0 or to @samp{inf} unlimits the download quota.
789 @cindex caching of DNS lookups
790 @item --dns-cache=off
791 Turn off caching of DNS lookups. Normally, Wget remembers the addresses
792 it looked up from DNS so it doesn't have to repeatedly contact the DNS
793 server for the same (typically small) set of addresses it retrieves
794 from. This cache exists in memory only; a new Wget run will contact DNS
797 However, in some cases it is not desirable to cache host names, even for
798 the duration of a short-running application like Wget. For example,
799 some HTTP servers are hosted on machines with dynamically allocated IP
800 addresses that change from time to time. Their DNS entries are updated
801 along with each change. When Wget's download from such a host gets
802 interrupted by IP address change, Wget retries the download, but (due to
803 DNS caching) it contacts the old address. With the DNS cache turned
804 off, Wget will repeat the DNS lookup for every connect and will thus get
805 the correct dynamic address every time---at the cost of additional DNS
806 lookups where they're probably not needed.
808 If you don't understand the above description, you probably won't need
811 @cindex file names, restrict
812 @cindex Windows file names
813 @item --restrict-file-names=@var{mode}
814 Change which characters found in remote URLs may show up in local file
815 names generated from those URLs. Characters that are @dfn{restricted}
816 by this option are escaped, i.e. replaced with @samp{%HH}, where
817 @samp{HH} is the hexadecimal number that corresponds to the restricted
820 By default, Wget escapes the characters that are not valid as part of
821 file names on your operating system, as well as control characters that
822 are typically unprintable. This option is useful for changing these
823 defaults, either because you are downloading to a non-native partition,
824 or because you want to disable escaping of the control characters.
826 When mode is set to ``unix'', Wget escapes the character @samp{/} and
827 the control characters in the ranges 0--31 and 128--159. This is the
828 default on Unix-like OS'es.
830 When mode is seto to ``windows'', Wget escapes the characters @samp{\},
831 @samp{|}, @samp{/}, @samp{:}, @samp{?}, @samp{"}, @samp{*}, @samp{<},
832 @samp{>}, and the control characters in the ranges 0--31 and 128--159.
833 In addition to this, Wget in Windows mode uses @samp{+} instead of
834 @samp{:} to separate host and port in local file names, and uses
835 @samp{@@} instead of @samp{?} to separate the query portion of the file
836 name from the rest. Therefore, a URL that would be saved as
837 @samp{www.xemacs.org:4300/search.pl?input=blah} in Unix mode would be
838 saved as @samp{www.xemacs.org+4300/search.pl@@input=blah} in Windows
839 mode. This mode is the default on Windows.
841 If you append @samp{,nocontrol} to the mode, as in
842 @samp{unix,nocontrol}, escaping of the control characters is also
843 switched off. You can use @samp{--restrict-file-names=nocontrol} to
844 turn off escaping of control characters without affecting the choice of
845 the OS to use as file name restriction mode.
848 @node Directory Options, HTTP Options, Download Options, Invoking
849 @section Directory Options
853 @itemx --no-directories
854 Do not create a hierarchy of directories when retrieving recursively.
855 With this option turned on, all files will get saved to the current
856 directory, without clobbering (if a name shows up more than once, the
857 filenames will get extensions @samp{.n}).
860 @itemx --force-directories
861 The opposite of @samp{-nd}---create a hierarchy of directories, even if
862 one would not have been created otherwise. E.g. @samp{wget -x
863 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
864 @file{fly.srk.fer.hr/robots.txt}.
867 @itemx --no-host-directories
868 Disable generation of host-prefixed directories. By default, invoking
869 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
870 directories beginning with @file{fly.srk.fer.hr/}. This option disables
873 @cindex cut directories
874 @item --cut-dirs=@var{number}
875 Ignore @var{number} directory components. This is useful for getting a
876 fine-grained control over the directory where recursive retrieval will
879 Take, for example, the directory at
880 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
881 @samp{-r}, it will be saved locally under
882 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
883 remove the @file{ftp.xemacs.org/} part, you are still stuck with
884 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
885 makes Wget not ``see'' @var{number} remote directory components. Here
886 are several examples of how @samp{--cut-dirs} option works.
890 No options -> ftp.xemacs.org/pub/xemacs/
892 -nH --cut-dirs=1 -> xemacs/
893 -nH --cut-dirs=2 -> .
895 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
900 If you just want to get rid of the directory structure, this option is
901 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
902 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
903 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
904 be placed to @file{xemacs/beta}, as one would expect.
906 @cindex directory prefix
907 @item -P @var{prefix}
908 @itemx --directory-prefix=@var{prefix}
909 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
910 directory where all other files and subdirectories will be saved to,
911 i.e. the top of the retrieval tree. The default is @samp{.} (the
915 @node HTTP Options, FTP Options, Directory Options, Invoking
916 @section HTTP Options
919 @cindex .html extension
921 @itemx --html-extension
922 If a file of type @samp{text/html} is downloaded and the URL does not
923 end with the regexp @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause
924 the suffix @samp{.html} to be appended to the local filename. This is
925 useful, for instance, when you're mirroring a remote site that uses
926 @samp{.asp} pages, but you want the mirrored pages to be viewable on
927 your stock Apache server. Another good use for this is when you're
928 downloading the output of CGIs. A URL like
929 @samp{http://site.com/article.cgi?25} will be saved as
930 @file{article.cgi?25.html}.
932 Note that filenames changed in this way will be re-downloaded every time
933 you re-mirror a site, because Wget can't tell that the local
934 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
935 it doesn't yet know that the URL produces output of type
936 @samp{text/html}. To prevent this re-downloading, you must use
937 @samp{-k} and @samp{-K} so that the original version of the file will be
938 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
941 @cindex http password
942 @cindex authentication
943 @item --http-user=@var{user}
944 @itemx --http-passwd=@var{password}
945 Specify the username @var{user} and password @var{password} on an
946 @sc{http} server. According to the type of the challenge, Wget will
947 encode them using either the @code{basic} (insecure) or the
948 @code{digest} authentication scheme.
950 Another way to specify username and password is in the @sc{url} itself
951 (@pxref{URL Format}). Either method reveals your password to anyone who
952 bothers to run @code{ps}. To prevent the passwords from being seen,
953 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
954 those files from other users with @code{chmod}. If the passwords are
955 really important, do not leave them lying in those files either---edit
956 the files and delete them after Wget has started the download.
958 For more information about security issues with Wget, @xref{Security
964 @itemx --cache=on/off
965 When set to off, disable server-side cache. In this case, Wget will
966 send the remote server an appropriate directive (@samp{Pragma:
967 no-cache}) to get the file from the remote service, rather than
968 returning the cached version. This is especially useful for retrieving
969 and flushing out-of-date documents on proxy servers.
971 Caching is allowed by default.
974 @item --cookies=on/off
975 When set to off, disable the use of cookies. Cookies are a mechanism
976 for maintaining server-side state. The server sends the client a cookie
977 using the @code{Set-Cookie} header, and the client responds with the
978 same cookie upon further requests. Since cookies allow the server
979 owners to keep track of visitors and for sites to exchange this
980 information, some consider them a breach of privacy. The default is to
981 use cookies; however, @emph{storing} cookies is not on by default.
983 @cindex loading cookies
984 @cindex cookies, loading
985 @item --load-cookies @var{file}
986 Load cookies from @var{file} before the first HTTP retrieval.
987 @var{file} is a textual file in the format originally used by Netscape's
988 @file{cookies.txt} file.
990 You will typically use this option when mirroring sites that require
991 that you be logged in to access some or all of their content. The login
992 process typically works by the web server issuing an @sc{http} cookie
993 upon receiving and verifying your credentials. The cookie is then
994 resent by the browser when accessing that part of the site, and so
995 proves your identity.
997 Mirroring such a site requires Wget to send the same cookies your
998 browser sends when communicating with the site. This is achieved by
999 @samp{--load-cookies}---simply point Wget to the location of the
1000 @file{cookies.txt} file, and it will send the same cookies your browser
1001 would send in the same situation. Different browsers keep textual
1002 cookie files in different locations:
1006 The cookies are in @file{~/.netscape/cookies.txt}.
1008 @item Mozilla and Netscape 6.x.
1009 Mozilla's cookie file is also named @file{cookies.txt}, located
1010 somewhere under @file{~/.mozilla}, in the directory of your profile.
1011 The full path usually ends up looking somewhat like
1012 @file{~/.mozilla/default/@var{some-weird-string}/cookies.txt}.
1014 @item Internet Explorer.
1015 You can produce a cookie file Wget can use by using the File menu,
1016 Import and Export, Export Cookies. This has been tested with Internet
1017 Explorer 5; it is not guaranteed to work with earlier versions.
1019 @item Other browsers.
1020 If you are using a different browser to create your cookies,
1021 @samp{--load-cookies} will only work if you can locate or produce a
1022 cookie file in the Netscape format that Wget expects.
1025 If you cannot use @samp{--load-cookies}, there might still be an
1026 alternative. If your browser supports a ``cookie manager'', you can use
1027 it to view the cookies used when accessing the site you're mirroring.
1028 Write down the name and value of the cookie, and manually instruct Wget
1029 to send those cookies, bypassing the ``official'' cookie support:
1032 wget --cookies=off --header "Cookie: @var{name}=@var{value}"
1035 @cindex saving cookies
1036 @cindex cookies, saving
1037 @item --save-cookies @var{file}
1038 Save cookies from @var{file} at the end of session. Cookies whose
1039 expiry time is not specified, or those that have already expired, are
1042 @cindex Content-Length, ignore
1043 @cindex ignore length
1044 @item --ignore-length
1045 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
1046 precise) send out bogus @code{Content-Length} headers, which makes Wget
1047 go wild, as it thinks not all the document was retrieved. You can spot
1048 this syndrome if Wget retries getting the same document again and again,
1049 each time claiming that the (otherwise normal) connection has closed on
1052 With this option, Wget will ignore the @code{Content-Length} header---as
1053 if it never existed.
1056 @item --header=@var{additional-header}
1057 Define an @var{additional-header} to be passed to the @sc{http} servers.
1058 Headers must contain a @samp{:} preceded by one or more non-blank
1059 characters, and must not contain newlines.
1061 You may define more than one additional header by specifying
1062 @samp{--header} more than once.
1066 wget --header='Accept-Charset: iso-8859-2' \
1067 --header='Accept-Language: hr' \
1068 http://fly.srk.fer.hr/
1072 Specification of an empty string as the header value will clear all
1073 previous user-defined headers.
1076 @cindex proxy password
1077 @cindex proxy authentication
1078 @item --proxy-user=@var{user}
1079 @itemx --proxy-passwd=@var{password}
1080 Specify the username @var{user} and password @var{password} for
1081 authentication on a proxy server. Wget will encode them using the
1082 @code{basic} authentication scheme.
1084 Security considerations similar to those with @samp{--http-passwd}
1085 pertain here as well.
1087 @cindex http referer
1088 @cindex referer, http
1089 @item --referer=@var{url}
1090 Include `Referer: @var{url}' header in HTTP request. Useful for
1091 retrieving documents with server-side processing that assume they are
1092 always being retrieved by interactive web browsers and only come out
1093 properly when Referer is set to one of the pages that point to them.
1095 @cindex server response, save
1097 @itemx --save-headers
1098 Save the headers sent by the @sc{http} server to the file, preceding the
1099 actual contents, with an empty line as the separator.
1102 @item -U @var{agent-string}
1103 @itemx --user-agent=@var{agent-string}
1104 Identify as @var{agent-string} to the @sc{http} server.
1106 The @sc{http} protocol allows the clients to identify themselves using a
1107 @code{User-Agent} header field. This enables distinguishing the
1108 @sc{www} software, usually for statistical purposes or for tracing of
1109 protocol violations. Wget normally identifies as
1110 @samp{Wget/@var{version}}, @var{version} being the current version
1113 However, some sites have been known to impose the policy of tailoring
1114 the output according to the @code{User-Agent}-supplied information.
1115 While conceptually this is not such a bad idea, it has been abused by
1116 servers denying information to clients other than @code{Mozilla} or
1117 Microsoft @code{Internet Explorer}. This option allows you to change
1118 the @code{User-Agent} line issued by Wget. Use of this option is
1119 discouraged, unless you really know what you are doing.
1122 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
1123 @section FTP Options
1126 @cindex .listing files, removing
1128 @itemx --dont-remove-listing
1129 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1130 retrievals. Normally, these files contain the raw directory listings
1131 received from @sc{ftp} servers. Not removing them can be useful for
1132 debugging purposes, or when you want to be able to easily check on the
1133 contents of remote server directories (e.g. to verify that a mirror
1134 you're running is complete).
1136 Note that even though Wget writes to a known filename for this file,
1137 this is not a security hole in the scenario of a user making
1138 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1139 asking @code{root} to run Wget in his or her directory. Depending on
1140 the options used, either Wget will refuse to write to @file{.listing},
1141 making the globbing/recursion/time-stamping operation fail, or the
1142 symbolic link will be deleted and replaced with the actual
1143 @file{.listing} file, or the listing will be written to a
1144 @file{.listing.@var{number}} file.
1146 Even though this situation isn't a problem, though, @code{root} should
1147 never run Wget in a non-trusted user's directory. A user could do
1148 something as simple as linking @file{index.html} to @file{/etc/passwd}
1149 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1150 will be overwritten.
1152 @cindex globbing, toggle
1154 @itemx --glob=on/off
1155 Turn @sc{ftp} globbing on or off. Globbing means you may use the
1156 shell-like special characters (@dfn{wildcards}), like @samp{*},
1157 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
1158 same directory at once, like:
1161 wget ftp://gnjilux.srk.fer.hr/*.msg
1164 By default, globbing will be turned on if the @sc{url} contains a
1165 globbing character. This option may be used to turn globbing on or off
1168 You may have to quote the @sc{url} to protect it from being expanded by
1169 your shell. Globbing makes Wget look for a directory listing, which is
1170 system-specific. This is why it currently works only with Unix @sc{ftp}
1171 servers (and the ones emulating Unix @code{ls} output).
1175 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
1176 initiates the data connection. This is sometimes required for @sc{ftp}
1177 to work behind firewalls.
1179 @cindex symbolic links, retrieving
1180 @item --retr-symlinks
1181 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1182 link is encountered, the linked-to file is not downloaded. Instead, a
1183 matching symbolic link is created on the local filesystem. The
1184 pointed-to file will not be downloaded unless this recursive retrieval
1185 would have encountered it separately and downloaded it anyway.
1187 When @samp{--retr-symlinks} is specified, however, symbolic links are
1188 traversed and the pointed-to files are retrieved. At this time, this
1189 option does not cause Wget to traverse symlinks to directories and
1190 recurse through them, but in the future it should be enhanced to do
1193 Note that when retrieving a file (not a directory) because it was
1194 specified on the commandline, rather than because it was recursed to,
1195 this option has no effect. Symbolic links are always traversed in this
1199 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
1200 @section Recursive Retrieval Options
1205 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
1208 @item -l @var{depth}
1209 @itemx --level=@var{depth}
1210 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1211 Retrieval}). The default maximum depth is 5.
1213 @cindex proxy filling
1214 @cindex delete after retrieval
1215 @cindex filling proxy cache
1216 @item --delete-after
1217 This option tells Wget to delete every single file it downloads,
1218 @emph{after} having done so. It is useful for pre-fetching popular
1219 pages through a proxy, e.g.:
1222 wget -r -nd --delete-after http://whatever.com/~popular/page/
1225 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1228 Note that @samp{--delete-after} deletes files on the local machine. It
1229 does not issue the @samp{DELE} command to remote FTP sites, for
1230 instance. Also note that when @samp{--delete-after} is specified,
1231 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1232 created in the first place.
1234 @cindex conversion of links
1235 @cindex link conversion
1237 @itemx --convert-links
1238 After the download is complete, convert the links in the document to
1239 make them suitable for local viewing. This affects not only the visible
1240 hyperlinks, but any part of the document that links to external content,
1241 such as embedded images, links to style sheets, hyperlinks to non-HTML
1244 Each link will be changed in one of the two ways:
1248 The links to files that have been downloaded by Wget will be changed to
1249 refer to the file they point to as a relative link.
1251 Example: if the downloaded file @file{/foo/doc.html} links to
1252 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1253 will be modified to point to @samp{../bar/img.gif}. This kind of
1254 transformation works reliably for arbitrary combinations of directories.
1257 The links to files that have not been downloaded by Wget will be changed
1258 to include host name and absolute path of the location they point to.
1260 Example: if the downloaded file @file{/foo/doc.html} links to
1261 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1262 @file{doc.html} will be modified to point to
1263 @file{http://@var{hostname}/bar/img.gif}.
1266 Because of this, local browsing works reliably: if a linked file was
1267 downloaded, the link will refer to its local name; if it was not
1268 downloaded, the link will refer to its full Internet address rather than
1269 presenting a broken link. The fact that the former links are converted
1270 to relative links ensures that you can move the downloaded hierarchy to
1273 Note that only at the end of the download can Wget know which links have
1274 been downloaded. Because of that, the work done by @samp{-k} will be
1275 performed at the end of all the downloads.
1277 @cindex backing up converted files
1279 @itemx --backup-converted
1280 When converting a file, back up the original version with a @samp{.orig}
1281 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1286 Turn on options suitable for mirroring. This option turns on recursion
1287 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1288 directory listings. It is currently equivalent to
1289 @samp{-r -N -l inf -nr}.
1291 @cindex page requisites
1292 @cindex required images, downloading
1294 @itemx --page-requisites
1295 This option causes Wget to download all the files that are necessary to
1296 properly display a given HTML page. This includes such things as
1297 inlined images, sounds, and referenced stylesheets.
1299 Ordinarily, when downloading a single HTML page, any requisite documents
1300 that may be needed to display it properly are not downloaded. Using
1301 @samp{-r} together with @samp{-l} can help, but since Wget does not
1302 ordinarily distinguish between external and inlined documents, one is
1303 generally left with ``leaf documents'' that are missing their
1306 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1307 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1308 document @file{2.html}. Say that @file{2.html} is similar but that its
1309 image is @file{2.gif} and it links to @file{3.html}. Say this
1310 continues up to some arbitrarily high number.
1312 If one executes the command:
1315 wget -r -l 2 http://@var{site}/1.html
1318 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1319 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1320 without its requisite @file{3.gif} because Wget is simply counting the
1321 number of hops (up to 2) away from @file{1.html} in order to determine
1322 where to stop the recursion. However, with this command:
1325 wget -r -l 2 -p http://@var{site}/1.html
1328 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1329 will be downloaded. Similarly,
1332 wget -r -l 1 -p http://@var{site}/1.html
1335 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1336 to be downloaded. One might think that:
1339 wget -r -l 0 -p http://@var{site}/1.html
1342 would download just @file{1.html} and @file{1.gif}, but unfortunately
1343 this is not the case, because @samp{-l 0} is equivalent to
1344 @samp{-l inf}---that is, infinite recursion. To download a single HTML
1345 page (or a handful of them, all specified on the commandline or in a
1346 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1347 @samp{-r} and @samp{-l}:
1350 wget -p http://@var{site}/1.html
1353 Note that Wget will behave as if @samp{-r} had been specified, but only
1354 that single page and its requisites will be downloaded. Links from that
1355 page to external documents will not be followed. Actually, to download
1356 a single page and all its requisites (even if they exist on separate
1357 websites), and make sure the lot displays properly locally, this author
1358 likes to use a few options in addition to @samp{-p}:
1361 wget -E -H -k -K -p http://@var{site}/@var{document}
1364 To finish off this topic, it's worth knowing that Wget's idea of an
1365 external document link is any URL specified in an @code{<A>} tag, an
1366 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1369 @cindex HTML comments
1370 @cindex comments, HTML
1371 @item --strict-comments
1372 Turn on strict parsing of HTML comments. The default is to terminate
1373 comments at the first occurrence of @samp{-->}.
1375 According to specifications, HTML comments are expressed as SGML
1376 @dfn{declarations}. Declaration is special markup that begins with
1377 @samp{<!} and ends with @samp{>}, such as @samp{<!DOCTYPE ...>}, that
1378 may contain comments between a pair of @samp{--} delimiters. HTML
1379 comments are ``empty declarations'', SGML declarations without any
1380 non-comment text. Therefore, @samp{<!--foo-->} is a valid comment, and
1381 so is @samp{<!--one-- --two-->}, but @samp{<!--1--2-->} is not.
1383 On the other hand, most HTML writers don't perceive comments as anything
1384 other than text delimited with @samp{<!--} and @samp{-->}, which is not
1385 quite the same. For example, something like @samp{<!------------>}
1386 works as a valid comment as long as the number of dashes is a multiple
1387 of four (!). If not, the comment technically lasts until the next
1388 @samp{--}, which may be at the other end of the document. Because of
1389 this, many popular browsers completely ignore the specification and
1390 implement what users have come to expect: comments delimited with
1391 @samp{<!--} and @samp{-->}.
1393 Until version 1.9, Wget interpreted comments strictly, which resulted in
1394 missing links in many web pages that displayed fine in browsers, but had
1395 the misfortune of containing non-compliant comments. Beginning with
1396 version 1.9, Wget has joined the ranks of clients that implements
1397 ``naive'' comments, terminating each comment at the first occurrence of
1400 If, for whatever reason, you want strict comment parsing, use this
1401 option to turn it on.
1404 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1405 @section Recursive Accept/Reject Options
1408 @item -A @var{acclist} --accept @var{acclist}
1409 @itemx -R @var{rejlist} --reject @var{rejlist}
1410 Specify comma-separated lists of file name suffixes or patterns to
1411 accept or reject (@pxref{Types of Files} for more details).
1413 @item -D @var{domain-list}
1414 @itemx --domains=@var{domain-list}
1415 Set domains to be followed. @var{domain-list} is a comma-separated list
1416 of domains. Note that it does @emph{not} turn on @samp{-H}.
1418 @item --exclude-domains @var{domain-list}
1419 Specify the domains that are @emph{not} to be followed.
1420 (@pxref{Spanning Hosts}).
1422 @cindex follow FTP links
1424 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1425 Wget will ignore all the @sc{ftp} links.
1427 @cindex tag-based recursive pruning
1428 @item --follow-tags=@var{list}
1429 Wget has an internal table of HTML tag / attribute pairs that it
1430 considers when looking for linked documents during a recursive
1431 retrieval. If a user wants only a subset of those tags to be
1432 considered, however, he or she should be specify such tags in a
1433 comma-separated @var{list} with this option.
1436 @itemx --ignore-tags=@var{list}
1437 This is the opposite of the @samp{--follow-tags} option. To skip
1438 certain HTML tags when recursively looking for documents to download,
1439 specify them in a comma-separated @var{list}.
1441 In the past, the @samp{-G} option was the best bet for downloading a
1442 single page and its requisites, using a commandline like:
1445 wget -Ga,area -H -k -K -r http://@var{site}/@var{document}
1448 However, the author of this option came across a page with tags like
1449 @code{<LINK REL="home" HREF="/">} and came to the realization that
1450 @samp{-G} was not enough. One can't just tell Wget to ignore
1451 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1452 best bet for downloading a single page and its requisites is the
1453 dedicated @samp{--page-requisites} option.
1457 Enable spanning across hosts when doing recursive retrieving
1458 (@pxref{Spanning Hosts}).
1462 Follow relative links only. Useful for retrieving a specific home page
1463 without any distractions, not even those from the same hosts
1464 (@pxref{Relative Links}).
1467 @itemx --include-directories=@var{list}
1468 Specify a comma-separated list of directories you wish to follow when
1469 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1470 of @var{list} may contain wildcards.
1473 @itemx --exclude-directories=@var{list}
1474 Specify a comma-separated list of directories you wish to exclude from
1475 download (@pxref{Directory-Based Limits} for more details.) Elements of
1476 @var{list} may contain wildcards.
1480 Do not ever ascend to the parent directory when retrieving recursively.
1481 This is a useful option, since it guarantees that only the files
1482 @emph{below} a certain hierarchy will be downloaded.
1483 @xref{Directory-Based Limits}, for more details.
1488 @node Recursive Retrieval, Following Links, Invoking, Top
1489 @chapter Recursive Retrieval
1492 @cindex recursive retrieval
1494 GNU Wget is capable of traversing parts of the Web (or a single
1495 @sc{http} or @sc{ftp} server), following links and directory structure.
1496 We refer to this as to @dfn{recursive retrieving}, or @dfn{recursion}.
1498 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1499 the given @sc{url}, documents, retrieving the files the @sc{html}
1500 document was referring to, through markups like @code{href}, or
1501 @code{src}. If the freshly downloaded file is also of type
1502 @code{text/html}, it will be parsed and followed further.
1504 Recursive retrieval of @sc{http} and @sc{html} content is
1505 @dfn{breadth-first}. This means that Wget first downloads the requested
1506 HTML document, then the documents linked from that document, then the
1507 documents linked by them, and so on. In other words, Wget first
1508 downloads the documents at depth 1, then those at depth 2, and so on
1509 until the specified maximum depth.
1511 The maximum @dfn{depth} to which the retrieval may descend is specified
1512 with the @samp{-l} option. The default maximum depth is five layers.
1514 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1515 the data from the given directory tree (including the subdirectories up
1516 to the specified depth) on the remote server, creating its mirror image
1517 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1518 parameter. Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1521 By default, Wget will create a local directory tree, corresponding to
1522 the one found on the remote server.
1524 Recursive retrieving can find a number of applications, the most
1525 important of which is mirroring. It is also useful for @sc{www}
1526 presentations, and any other opportunities where slow network
1527 connections should be bypassed by storing the files locally.
1529 You should be warned that recursive downloads can overload the remote
1530 servers. Because of that, many administrators frown upon them and may
1531 ban access from your site if they detect very fast downloads of big
1532 amounts of content. When downloading from Internet servers, consider
1533 using the @samp{-w} option to introduce a delay between accesses to the
1534 server. The download will take a while longer, but the server
1535 administrator will not be alarmed by your rudeness.
1537 Of course, recursive download may cause problems on your machine. If
1538 left to run unchecked, it can easily fill up the disk. If downloading
1539 from local network, it can also take bandwidth on the system, as well as
1540 consume memory and CPU.
1542 Try to specify the criteria that match the kind of download you are
1543 trying to achieve. If you want to download only one page, use
1544 @samp{--page-requisites} without any additional recursion. If you want
1545 to download things under one directory, use @samp{-np} to avoid
1546 downloading things from other directories. If you want to download all
1547 the files from one directory, use @samp{-l 1} to make sure the recursion
1548 depth never exceeds one. @xref{Following Links}, for more information
1551 Recursive retrieval should be used with care. Don't say you were not
1554 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1555 @chapter Following Links
1557 @cindex following links
1559 When retrieving recursively, one does not wish to retrieve loads of
1560 unnecessary data. Most of the time the users bear in mind exactly what
1561 they want to download, and want Wget to follow only specific links.
1563 For example, if you wish to download the music archive from
1564 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1565 that happen to be referenced by an obscure part of the archive.
1567 Wget possesses several mechanisms that allows you to fine-tune which
1568 links it will follow.
1571 * Spanning Hosts:: (Un)limiting retrieval based on host name.
1572 * Types of Files:: Getting only certain files.
1573 * Directory-Based Limits:: Getting only certain directories.
1574 * Relative Links:: Follow relative links only.
1575 * FTP Links:: Following FTP links.
1578 @node Spanning Hosts, Types of Files, Following Links, Following Links
1579 @section Spanning Hosts
1580 @cindex spanning hosts
1581 @cindex hosts, spanning
1583 Wget's recursive retrieval normally refuses to visit hosts different
1584 than the one you specified on the command line. This is a reasonable
1585 default; without it, every retrieval would have the potential to turn
1586 your Wget into a small version of google.
1588 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1589 a useful option. Maybe the images are served from a different server.
1590 Maybe you're mirroring a site that consists of pages interlinked between
1591 three servers. Maybe the server has two equivalent names, and the HTML
1592 pages refer to both interchangeably.
1595 @item Span to any host---@samp{-H}
1597 The @samp{-H} option turns on host spanning, thus allowing Wget's
1598 recursive run to visit any host referenced by a link. Unless sufficient
1599 recursion-limiting criteria are applied depth, these foreign hosts will
1600 typically link to yet more hosts, and so on until Wget ends up sucking
1601 up much more data than you have intended.
1603 @item Limit spanning to certain domains---@samp{-D}
1605 The @samp{-D} option allows you to specify the domains that will be
1606 followed, thus limiting the recursion only to the hosts that belong to
1607 these domains. Obviously, this makes sense only in conjunction with
1608 @samp{-H}. A typical example would be downloading the contents of
1609 @samp{www.server.com}, but allowing downloads from
1610 @samp{images.server.com}, etc.:
1613 wget -rH -Dserver.com http://www.server.com/
1616 You can specify more than one address by separating them with a comma,
1617 e.g. @samp{-Ddomain1.com,domain2.com}.
1619 @item Keep download off certain domains---@samp{--exclude-domains}
1621 If there are domains you want to exclude specifically, you can do it
1622 with @samp{--exclude-domains}, which accepts the same type of arguments
1623 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1624 example, if you want to download all the hosts from @samp{foo.edu}
1625 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1629 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
1635 @node Types of Files, Directory-Based Limits, Spanning Hosts, Following Links
1636 @section Types of Files
1637 @cindex types of files
1639 When downloading material from the web, you will often want to restrict
1640 the retrieval to only certain file types. For example, if you are
1641 interested in downloading @sc{gif}s, you will not be overjoyed to get
1642 loads of PostScript documents, and vice versa.
1644 Wget offers two options to deal with this problem. Each option
1645 description lists a short name, a long name, and the equivalent command
1648 @cindex accept wildcards
1649 @cindex accept suffixes
1650 @cindex wildcards, accept
1651 @cindex suffixes, accept
1653 @item -A @var{acclist}
1654 @itemx --accept @var{acclist}
1655 @itemx accept = @var{acclist}
1656 The argument to @samp{--accept} option is a list of file suffixes or
1657 patterns that Wget will download during recursive retrieval. A suffix
1658 is the ending part of a file, and consists of ``normal'' letters,
1659 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1660 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1662 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1663 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1664 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1665 download only files beginning with @samp{zelazny} and containing numbers
1666 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1667 a description of how pattern matching works.
1669 Of course, any number of suffixes and patterns can be combined into a
1670 comma-separated list, and given as an argument to @samp{-A}.
1672 @cindex reject wildcards
1673 @cindex reject suffixes
1674 @cindex wildcards, reject
1675 @cindex suffixes, reject
1676 @item -R @var{rejlist}
1677 @itemx --reject @var{rejlist}
1678 @itemx reject = @var{rejlist}
1679 The @samp{--reject} option works the same way as @samp{--accept}, only
1680 its logic is the reverse; Wget will download all files @emph{except} the
1681 ones matching the suffixes (or patterns) in the list.
1683 So, if you want to download a whole page except for the cumbersome
1684 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1685 Analogously, to download all files except the ones beginning with
1686 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1687 expansion by the shell.
1690 The @samp{-A} and @samp{-R} options may be combined to achieve even
1691 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1692 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1693 a part of their name, but @emph{not} the PostScript files.
1695 Note that these two options do not affect the downloading of @sc{html}
1696 files; Wget must load all the @sc{html}s to know where to go at
1697 all---recursive retrieval would make no sense otherwise.
1699 @node Directory-Based Limits, Relative Links, Types of Files, Following Links
1700 @section Directory-Based Limits
1702 @cindex directory limits
1704 Regardless of other link-following facilities, it is often useful to
1705 place the restriction of what files to retrieve based on the directories
1706 those files are placed in. There can be many reasons for this---the
1707 home pages may be organized in a reasonable directory structure; or some
1708 directories may contain useless information, e.g. @file{/cgi-bin} or
1709 @file{/dev} directories.
1711 Wget offers three different options to deal with this requirement. Each
1712 option description lists a short name, a long name, and the equivalent
1713 command in @file{.wgetrc}.
1715 @cindex directories, include
1716 @cindex include directories
1717 @cindex accept directories
1720 @itemx --include @var{list}
1721 @itemx include_directories = @var{list}
1722 @samp{-I} option accepts a comma-separated list of directories included
1723 in the retrieval. Any other directories will simply be ignored. The
1724 directories are absolute paths.
1726 So, if you wish to download from @samp{http://host/people/bozo/}
1727 following only links to bozo's colleagues in the @file{/people}
1728 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1731 wget -I /people,/cgi-bin http://host/people/bozo/
1734 @cindex directories, exclude
1735 @cindex exclude directories
1736 @cindex reject directories
1738 @itemx --exclude @var{list}
1739 @itemx exclude_directories = @var{list}
1740 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1741 directories @emph{excluded} from the download. E.g. if you do not want
1742 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1743 /cgi-bin} on the command line.
1745 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1746 to get a better fine-tuning of downloading subdirectories. E.g. if you
1747 want to load all the files from @file{/pub} hierarchy except for
1748 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1753 @itemx no_parent = on
1754 The simplest, and often very useful way of limiting directories is
1755 disallowing retrieval of the links that refer to the hierarchy
1756 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1757 parent directory/directories.
1759 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1760 Using it guarantees that you will never leave the existing hierarchy.
1761 Supposing you issue Wget with:
1764 wget -r --no-parent http://somehost/~luzer/my-archive/
1767 You may rest assured that none of the references to
1768 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1769 followed. Only the archive you are interested in will be downloaded.
1770 Essentially, @samp{--no-parent} is similar to
1771 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1772 intelligent fashion.
1775 @node Relative Links, FTP Links, Directory-Based Limits, Following Links
1776 @section Relative Links
1777 @cindex relative links
1779 When @samp{-L} is turned on, only the relative links are ever followed.
1780 Relative links are here defined those that do not refer to the web
1781 server root. For example, these links are relative:
1785 <a href="foo/bar.gif">
1786 <a href="../foo/bar.gif">
1789 These links are not relative:
1793 <a href="/foo/bar.gif">
1794 <a href="http://www.server.com/foo/bar.gif">
1797 Using this option guarantees that recursive retrieval will not span
1798 hosts, even without @samp{-H}. In simple cases it also allows downloads
1799 to ``just work'' without having to convert links.
1801 This option is probably not very useful and might be removed in a future
1804 @node FTP Links, , Relative Links, Following Links
1805 @section Following FTP Links
1806 @cindex following ftp links
1808 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1809 them to be. @sc{ftp} links in @sc{html} documents are often included
1810 for purposes of reference, and it is often inconvenient to download them
1813 To have @sc{ftp} links followed from @sc{html} documents, you need to
1814 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1815 links will span hosts regardless of @samp{-H} setting. This is logical,
1816 as @sc{ftp} links rarely point to the same host where the @sc{http}
1817 server resides. For similar reasons, the @samp{-L} options has no
1818 effect on such downloads. On the other hand, domain acceptance
1819 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1821 Also note that followed links to @sc{ftp} directories will not be
1822 retrieved recursively further.
1824 @node Time-Stamping, Startup File, Following Links, Top
1825 @chapter Time-Stamping
1826 @cindex time-stamping
1827 @cindex timestamping
1828 @cindex updating the archives
1829 @cindex incremental updating
1831 One of the most important aspects of mirroring information from the
1832 Internet is updating your archives.
1834 Downloading the whole archive again and again, just to replace a few
1835 changed files is expensive, both in terms of wasted bandwidth and money,
1836 and the time to do the update. This is why all the mirroring tools
1837 offer the option of incremental updating.
1839 Such an updating mechanism means that the remote server is scanned in
1840 search of @dfn{new} files. Only those new files will be downloaded in
1841 the place of the old ones.
1843 A file is considered new if one of these two conditions are met:
1847 A file of that name does not already exist locally.
1850 A file of that name does exist, but the remote file was modified more
1851 recently than the local file.
1854 To implement this, the program needs to be aware of the time of last
1855 modification of both local and remote files. We call this information the
1856 @dfn{time-stamp} of a file.
1858 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1859 (@samp{-N}) option, or through @code{timestamping = on} directive in
1860 @file{.wgetrc}. With this option, for each file it intends to download,
1861 Wget will check whether a local file of the same name exists. If it
1862 does, and the remote file is older, Wget will not download it.
1864 If the local file does not exist, or the sizes of the files do not
1865 match, Wget will download the remote file no matter what the time-stamps
1869 * Time-Stamping Usage::
1870 * HTTP Time-Stamping Internals::
1871 * FTP Time-Stamping Internals::
1874 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1875 @section Time-Stamping Usage
1876 @cindex time-stamping usage
1877 @cindex usage, time-stamping
1879 The usage of time-stamping is simple. Say you would like to download a
1880 file so that it keeps its date of modification.
1883 wget -S http://www.gnu.ai.mit.edu/
1886 A simple @code{ls -l} shows that the time stamp on the local file equals
1887 the state of the @code{Last-Modified} header, as returned by the server.
1888 As you can see, the time-stamping info is preserved locally, even
1889 without @samp{-N} (at least for @sc{http}).
1891 Several days later, you would like Wget to check if the remote file has
1892 changed, and download it if it has.
1895 wget -N http://www.gnu.ai.mit.edu/
1898 Wget will ask the server for the last-modified date. If the local file
1899 has the same timestamp as the server, or a newer one, the remote file
1900 will not be re-fetched. However, if the remote file is more recent,
1901 Wget will proceed to fetch it.
1903 The same goes for @sc{ftp}. For example:
1906 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
1909 (The quotes around that URL are to prevent the shell from trying to
1910 interpret the @samp{*}.)
1912 After download, a local directory listing will show that the timestamps
1913 match those on the remote server. Reissuing the command with @samp{-N}
1914 will make Wget re-fetch @emph{only} the files that have been modified
1915 since the last download.
1917 If you wished to mirror the GNU archive every week, you would use a
1918 command like the following, weekly:
1921 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
1924 Note that time-stamping will only work for files for which the server
1925 gives a timestamp. For @sc{http}, this depends on getting a
1926 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
1927 directory listing with dates in a format that Wget can parse
1928 (@pxref{FTP Time-Stamping Internals}).
1930 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1931 @section HTTP Time-Stamping Internals
1932 @cindex http time-stamping
1934 Time-stamping in @sc{http} is implemented by checking of the
1935 @code{Last-Modified} header. If you wish to retrieve the file
1936 @file{foo.html} through @sc{http}, Wget will check whether
1937 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1938 retrieved unconditionally.
1940 If the file does exist locally, Wget will first check its local
1941 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1942 @code{HEAD} request to the remote server, demanding the information on
1945 The @code{Last-Modified} header is examined to find which file was
1946 modified more recently (which makes it ``newer''). If the remote file
1947 is newer, it will be downloaded; if it is older, Wget will give
1948 up.@footnote{As an additional check, Wget will look at the
1949 @code{Content-Length} header, and compare the sizes; if they are not the
1950 same, the remote file will be downloaded no matter what the time-stamp
1953 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1954 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1955 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1956 @samp{@var{X}}, which will always differ if it's been converted by
1957 @samp{--convert-links} (@samp{-k}).
1959 Arguably, @sc{http} time-stamping should be implemented using the
1960 @code{If-Modified-Since} request.
1962 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1963 @section FTP Time-Stamping Internals
1964 @cindex ftp time-stamping
1966 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1967 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
1970 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
1971 @sc{ftp} @code{LIST} command to get a file listing for the directory
1972 containing the desired file(s). It will try to analyze the listing,
1973 treating it like Unix @code{ls -l} output, extracting the time-stamps.
1974 The rest is exactly the same as for @sc{http}. Note that when
1975 retrieving individual files from an @sc{ftp} server without using
1976 globbing or recursion, listing files will not be downloaded (and thus
1977 files will not be time-stamped) unless @samp{-N} is specified.
1979 Assumption that every directory listing is a Unix-style listing may
1980 sound extremely constraining, but in practice it is not, as many
1981 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1982 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1983 defines no standard way to get a file list, let alone the time-stamps.
1984 We can only hope that a future standard will define this.
1986 Another non-standard solution includes the use of @code{MDTM} command
1987 that is supported by some @sc{ftp} servers (including the popular
1988 @code{wu-ftpd}), which returns the exact time of the specified file.
1989 Wget may support this command in the future.
1991 @node Startup File, Examples, Time-Stamping, Top
1992 @chapter Startup File
1993 @cindex startup file
1999 Once you know how to change default settings of Wget through command
2000 line arguments, you may wish to make some of those settings permanent.
2001 You can do that in a convenient way by creating the Wget startup
2002 file---@file{.wgetrc}.
2004 Besides @file{.wgetrc} is the ``main'' initialization file, it is
2005 convenient to have a special facility for storing passwords. Thus Wget
2006 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
2007 it. You can find @file{.netrc} format in your system manuals.
2009 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
2013 * Wgetrc Location:: Location of various wgetrc files.
2014 * Wgetrc Syntax:: Syntax of wgetrc.
2015 * Wgetrc Commands:: List of available commands.
2016 * Sample Wgetrc:: A wgetrc example.
2019 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
2020 @section Wgetrc Location
2021 @cindex wgetrc location
2022 @cindex location of wgetrc
2024 When initializing, Wget will look for a @dfn{global} startup file,
2025 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
2026 @file{/usr/local}, if Wget was not installed there) and read commands
2027 from there, if it exists.
2029 Then it will look for the user's file. If the environmental variable
2030 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
2031 further attempts will be made.
2033 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
2035 The fact that user's settings are loaded after the system-wide ones
2036 means that in case of collision user's wgetrc @emph{overrides} the
2037 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
2038 Fascist admins, away!
2040 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
2041 @section Wgetrc Syntax
2042 @cindex wgetrc syntax
2043 @cindex syntax of wgetrc
2045 The syntax of a wgetrc command is simple:
2051 The @dfn{variable} will also be called @dfn{command}. Valid
2052 @dfn{values} are different for different commands.
2054 The commands are case-insensitive and underscore-insensitive. Thus
2055 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
2056 beginning with @samp{#} and lines containing white-space only are
2059 Commands that expect a comma-separated list will clear the list on an
2060 empty command. So, if you wish to reset the rejection list specified in
2061 global @file{wgetrc}, you can do it with:
2067 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
2068 @section Wgetrc Commands
2069 @cindex wgetrc commands
2071 The complete set of commands is listed below. Legal values are listed
2072 after the @samp{=}. Simple Boolean values can be set or unset using
2073 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
2074 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
2075 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
2076 option is set to @samp{always} or @samp{never}, that value will be
2077 locked in for the duration of the Wget invocation---commandline options
2080 Some commands take pseudo-arbitrary values. @var{address} values can be
2081 hostnames or dotted-quad IP addresses. @var{n} can be any positive
2082 integer, or @samp{inf} for infinity, where appropriate. @var{string}
2083 values can be any non-empty string.
2085 Most of these commands have commandline equivalents (@pxref{Invoking}),
2086 though some of the more obscure or rarely used ones do not.
2089 @item accept/reject = @var{string}
2090 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
2092 @item add_hostdir = on/off
2093 Enable/disable host-prefixed file names. @samp{-nH} disables it.
2095 @item continue = on/off
2096 If set to on, force continuation of preexistent partially retrieved
2097 files. See @samp{-c} before setting it.
2099 @item background = on/off
2100 Enable/disable going to background---the same as @samp{-b} (which
2103 @item backup_converted = on/off
2104 Enable/disable saving pre-converted files with the suffix
2105 @samp{.orig}---the same as @samp{-K} (which enables it).
2107 @c @item backups = @var{number}
2108 @c #### Document me!
2110 @item base = @var{string}
2111 Consider relative @sc{url}s in @sc{url} input files forced to be
2112 interpreted as @sc{html} as being relative to @var{string}---the same as
2115 @item bind_address = @var{address}
2116 Bind to @var{address}, like the @samp{--bind-address} option.
2118 @item cache = on/off
2119 When set to off, disallow server-caching. See the @samp{-C} option.
2121 @item convert links = on/off
2122 Convert non-relative links locally. The same as @samp{-k}.
2124 @item cookies = on/off
2125 When set to off, disallow cookies. See the @samp{--cookies} option.
2127 @item load_cookies = @var{file}
2128 Load cookies from @var{file}. See @samp{--load-cookies}.
2130 @item save_cookies = @var{file}
2131 Save cookies to @var{file}. See @samp{--save-cookies}.
2133 @item cut_dirs = @var{n}
2134 Ignore @var{n} remote directory components.
2136 @item debug = on/off
2137 Debug mode, same as @samp{-d}.
2139 @item delete_after = on/off
2140 Delete after download---the same as @samp{--delete-after}.
2142 @item dir_prefix = @var{string}
2143 Top of directory tree---the same as @samp{-P}.
2145 @item dirstruct = on/off
2146 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2149 @item dns_cache = on/off
2150 Turn DNS caching on/off. Since DNS caching is on by default, this
2151 option is normally used to turn it off. Same as @samp{--dns-cache}.
2153 @item domains = @var{string}
2154 Same as @samp{-D} (@pxref{Spanning Hosts}).
2156 @item dot_bytes = @var{n}
2157 Specify the number of bytes ``contained'' in a dot, as seen throughout
2158 the retrieval (1024 by default). You can postfix the value with
2159 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2160 respectively. With dot settings you can tailor the dot retrieval to
2161 suit your needs, or you can use the predefined @dfn{styles}
2162 (@pxref{Download Options}).
2164 @item dots_in_line = @var{n}
2165 Specify the number of dots that will be printed in each line throughout
2166 the retrieval (50 by default).
2168 @item dot_spacing = @var{n}
2169 Specify the number of dots in a single cluster (10 by default).
2171 @item exclude_directories = @var{string}
2172 Specify a comma-separated list of directories you wish to exclude from
2173 download---the same as @samp{-X} (@pxref{Directory-Based Limits}).
2175 @item exclude_domains = @var{string}
2176 Same as @samp{--exclude-domains} (@pxref{Spanning Hosts}).
2178 @item follow_ftp = on/off
2179 Follow @sc{ftp} links from @sc{html} documents---the same as
2180 @samp{--follow-ftp}.
2182 @item follow_tags = @var{string}
2183 Only follow certain HTML tags when doing a recursive retrieval, just like
2184 @samp{--follow-tags}.
2186 @item force_html = on/off
2187 If set to on, force the input filename to be regarded as an @sc{html}
2188 document---the same as @samp{-F}.
2190 @item ftp_proxy = @var{string}
2191 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2195 Turn globbing on/off---the same as @samp{-g}.
2197 @item header = @var{string}
2198 Define an additional header, like @samp{--header}.
2200 @item html_extension = on/off
2201 Add a @samp{.html} extension to @samp{text/html} files without it, like
2204 @item http_passwd = @var{string}
2205 Set @sc{http} password.
2207 @item http_proxy = @var{string}
2208 Use @var{string} as @sc{http} proxy, instead of the one specified in
2211 @item http_user = @var{string}
2212 Set @sc{http} user to @var{string}.
2214 @item ignore_length = on/off
2215 When set to on, ignore @code{Content-Length} header; the same as
2216 @samp{--ignore-length}.
2218 @item ignore_tags = @var{string}
2219 Ignore certain HTML tags when doing a recursive retrieval, just like
2220 @samp{-G} / @samp{--ignore-tags}.
2222 @item include_directories = @var{string}
2223 Specify a comma-separated list of directories you wish to follow when
2224 downloading---the same as @samp{-I}.
2226 @item input = @var{string}
2227 Read the @sc{url}s from @var{string}, like @samp{-i}.
2229 @item kill_longer = on/off
2230 Consider data longer than specified in content-length header as invalid
2231 (and retry getting it). The default behaviour is to save as much data
2232 as there is, provided there is more than or equal to the value in
2233 @code{Content-Length}.
2235 @item limit_rate = @var{rate}
2236 Limit the download speed to no more than @var{rate} bytes per second.
2237 The same as @samp{--limit-rate}.
2239 @item logfile = @var{string}
2240 Set logfile---the same as @samp{-o}.
2242 @item login = @var{string}
2243 Your user name on the remote machine, for @sc{ftp}. Defaults to
2246 @item mirror = on/off
2247 Turn mirroring on/off. The same as @samp{-m}.
2249 @item netrc = on/off
2250 Turn reading netrc on or off.
2252 @item noclobber = on/off
2255 @item no_parent = on/off
2256 Disallow retrieving outside the directory hierarchy, like
2257 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2259 @item no_proxy = @var{string}
2260 Use @var{string} as the comma-separated list of domains to avoid in
2261 proxy loading, instead of the one specified in environment.
2263 @item output_document = @var{string}
2264 Set the output filename---the same as @samp{-O}.
2266 @item page_requisites = on/off
2267 Download all ancillary documents necessary for a single HTML page to
2268 display properly---the same as @samp{-p}.
2270 @item passive_ftp = on/off/always/never
2271 Set passive @sc{ftp}---the same as @samp{--passive-ftp}. Some scripts
2272 and @samp{.pm} (Perl module) files download files using @samp{wget
2273 --passive-ftp}. If your firewall does not allow this, you can set
2274 @samp{passive_ftp = never} to override the commandline.
2276 @item passwd = @var{string}
2277 Set your @sc{ftp} password to @var{password}. Without this setting, the
2278 password defaults to @samp{username@@hostname.domainname}.
2280 @item progress = @var{string}
2281 Set the type of the progress indicator. Legal types are ``dot'' and
2284 @item proxy_user = @var{string}
2285 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
2287 @item proxy_passwd = @var{string}
2288 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
2290 @item referer = @var{string}
2291 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
2292 was the folks who wrote the @sc{http} spec who got the spelling of
2293 ``referrer'' wrong.)
2295 @item quiet = on/off
2296 Quiet mode---the same as @samp{-q}.
2298 @item quota = @var{quota}
2299 Specify the download quota, which is useful to put in the global
2300 @file{wgetrc}. When download quota is specified, Wget will stop
2301 retrieving after the download sum has become greater than quota. The
2302 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2303 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2304 to 5 mbytes. Note that the user's startup file overrides system
2307 @item reclevel = @var{n}
2308 Recursion level---the same as @samp{-l}.
2310 @item recursive = on/off
2311 Recursive on/off---the same as @samp{-r}.
2313 @item relative_only = on/off
2314 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2317 @item remove_listing = on/off
2318 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2319 to off is the same as @samp{-nr}.
2321 @item restrict_file_names = unix/windows
2322 Restrict the file names generated by Wget from URLs. See
2323 @samp{--restrict-file-names} for a more detailed description.
2325 @item retr_symlinks = on/off
2326 When set to on, retrieve symbolic links as if they were plain files; the
2327 same as @samp{--retr-symlinks}.
2329 @item robots = on/off
2330 Specify whether the norobots convention is respected by Wget, ``on'' by
2331 default. This switch controls both the @file{/robots.txt} and the
2332 @samp{nofollow} aspect of the spec. @xref{Robot Exclusion}, for more
2333 details about this. Be sure you know what you are doing before turning
2336 @item server_response = on/off
2337 Choose whether or not to print the @sc{http} and @sc{ftp} server
2338 responses---the same as @samp{-S}.
2340 @item span_hosts = on/off
2343 @item strict_comments = on/off
2344 Same as @samp{--strict-comments}.
2346 @item timeout = @var{n}
2347 Set timeout value---the same as @samp{-T}.
2349 @item timestamping = on/off
2350 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2352 @item tries = @var{n}
2353 Set number of retries per @sc{url}---the same as @samp{-t}.
2355 @item use_proxy = on/off
2356 Turn proxy support on/off. The same as @samp{-Y}.
2358 @item verbose = on/off
2359 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2361 @item wait = @var{n}
2362 Wait @var{n} seconds between retrievals---the same as @samp{-w}.
2364 @item waitretry = @var{n}
2365 Wait up to @var{n} seconds between retries of failed retrievals
2366 only---the same as @samp{--waitretry}. Note that this is turned on by
2367 default in the global @file{wgetrc}.
2369 @item randomwait = on/off
2370 Turn random between-request wait times on or off. The same as
2371 @samp{--random-wait}.
2374 @node Sample Wgetrc, , Wgetrc Commands, Startup File
2375 @section Sample Wgetrc
2376 @cindex sample wgetrc
2378 This is the sample initialization file, as given in the distribution.
2379 It is divided in two section---one for global usage (suitable for global
2380 startup file), and one for local usage (suitable for
2381 @file{$HOME/.wgetrc}). Be careful about the things you change.
2383 Note that almost all the lines are commented out. For a command to have
2384 any effect, you must remove the @samp{#} character at the beginning of
2388 @include sample.wgetrc.munged_for_texi_inclusion
2391 @node Examples, Various, Startup File, Top
2395 @c man begin EXAMPLES
2396 The examples are divided into three sections loosely based on their
2400 * Simple Usage:: Simple, basic usage of the program.
2401 * Advanced Usage:: Advanced tips.
2402 * Very Advanced Usage:: The hairy stuff.
2405 @node Simple Usage, Advanced Usage, Examples, Examples
2406 @section Simple Usage
2410 Say you want to download a @sc{url}. Just type:
2413 wget http://fly.srk.fer.hr/
2417 But what will happen if the connection is slow, and the file is lengthy?
2418 The connection will probably fail before the whole file is retrieved,
2419 more than once. In this case, Wget will try getting the file until it
2420 either gets the whole of it, or exceeds the default number of retries
2421 (this being 20). It is easy to change the number of tries to 45, to
2422 insure that the whole file will arrive safely:
2425 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2429 Now let's leave Wget to work in the background, and write its progress
2430 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2431 shall use @samp{-t}.
2434 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2437 The ampersand at the end of the line makes sure that Wget works in the
2438 background. To unlimit the number of retries, use @samp{-t inf}.
2441 The usage of @sc{ftp} is as simple. Wget will take care of login and
2445 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2449 If you specify a directory, Wget will retrieve the directory listing,
2450 parse it and convert it to @sc{html}. Try:
2453 wget ftp://prep.ai.mit.edu/pub/gnu/
2458 @node Advanced Usage, Very Advanced Usage, Simple Usage, Examples
2459 @section Advanced Usage
2463 You have a file that contains the URLs you want to download? Use the
2470 If you specify @samp{-} as file name, the @sc{url}s will be read from
2474 Create a five levels deep mirror image of the GNU web site, with the
2475 same directory structure the original has, with only one try per
2476 document, saving the log of the activities to @file{gnulog}:
2479 wget -r http://www.gnu.org/ -o gnulog
2483 The same as the above, but convert the links in the @sc{html} files to
2484 point to local files, so you can view the documents off-line:
2487 wget --convert-links -r http://www.gnu.org/ -o gnulog
2491 Retrieve only one HTML page, but make sure that all the elements needed
2492 for the page to be displayed, such as inline images and external style
2493 sheets, are also downloaded. Also make sure the downloaded page
2494 references the downloaded links.
2497 wget -p --convert-links http://www.server.com/dir/page.html
2500 The HTML page will be saved to @file{www.server.com/dir/page.html}, and
2501 the images, stylesheets, etc., somewhere under @file{www.server.com/},
2502 depending on where they were on the remote server.
2505 The same as the above, but without the @file{www.server.com/} directory.
2506 In fact, I don't want to have all those random server directories
2507 anyway---just save @emph{all} those files under a @file{download/}
2508 subdirectory of the current directory.
2511 wget -p --convert-links -nH -nd -Pdownload \
2512 http://www.server.com/dir/page.html
2516 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2520 wget -S http://www.lycos.com/
2524 Save the server headers with the file, perhaps for post-processing.
2527 wget -s http://www.lycos.com/
2532 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2536 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
2540 You want to download all the @sc{gif}s from a directory on an @sc{http}
2541 server. You tried @samp{wget http://www.server.com/dir/*.gif}, but that
2542 didn't work because @sc{http} retrieval does not support globbing. In
2546 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
2549 More verbose, but the effect is the same. @samp{-r -l1} means to
2550 retrieve recursively (@pxref{Recursive Retrieval}), with maximum depth
2551 of 1. @samp{--no-parent} means that references to the parent directory
2552 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2553 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2557 Suppose you were in the middle of downloading, when Wget was
2558 interrupted. Now you do not want to clobber the files already present.
2562 wget -nc -r http://www.gnu.org/
2566 If you want to encode your own username and password to @sc{http} or
2567 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2570 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
2573 Note, however, that this usage is not advisable on multi-user systems
2574 because it reveals your password to anyone who looks at the output of
2577 @cindex redirecting output
2579 You would like the output documents to go to standard output instead of
2583 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2586 You can also combine the two options and make pipelines to retrieve the
2587 documents from remote hotlists:
2590 wget -O - http://cool.list.com/ | wget --force-html -i -
2594 @node Very Advanced Usage, , Advanced Usage, Examples
2595 @section Very Advanced Usage
2600 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2601 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2602 for @samp{-r -l inf -N}. You can put Wget in the crontab file asking it
2603 to recheck a site each Sunday:
2607 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
2611 In addition to the above, you want the links to be converted for local
2612 viewing. But, after having read this manual, you know that link
2613 conversion doesn't play well with timestamping, so you also want Wget to
2614 back up the original HTML files before the conversion. Wget invocation
2615 would look like this:
2618 wget --mirror --convert-links --backup-converted \
2619 http://www.gnu.org/ -o /home/me/weeklog
2623 But you've also noticed that local viewing doesn't work all that well
2624 when HTML files are saved under extensions other than @samp{.html},
2625 perhaps because they were served as @file{index.cgi}. So you'd like
2626 Wget to rename all the files served with content-type @samp{text/html}
2627 to @file{@var{name}.html}.
2630 wget --mirror --convert-links --backup-converted \
2631 --html-extension -o /home/me/weeklog \
2635 Or, with less typing:
2638 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
2643 @node Various, Appendices, Examples, Top
2647 This chapter contains all the stuff that could not fit anywhere else.
2650 * Proxies:: Support for proxy servers
2651 * Distribution:: Getting the latest version.
2652 * Mailing List:: Wget mailing list for announcements and discussion.
2653 * Reporting Bugs:: How and where to report bugs.
2654 * Portability:: The systems Wget works on.
2655 * Signals:: Signal-handling performed by Wget.
2658 @node Proxies, Distribution, Various, Various
2662 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2663 data from remote servers to local clients. One typical use of proxies
2664 is lightening network load for users behind a slow connection. This is
2665 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2666 proxy which caches the transferred data. When a cached resource is
2667 requested again, proxy will return the data from cache. Another use for
2668 proxies is for companies that separate (for security reasons) their
2669 internal networks from the rest of Internet. In order to obtain
2670 information from the Web, their users connect and retrieve remote data
2671 using an authorized proxy.
2673 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2674 standard way to specify proxy location, which Wget recognizes, is using
2675 the following environment variables:
2679 This variable should contain the @sc{url} of the proxy for @sc{http}
2683 This variable should contain the @sc{url} of the proxy for @sc{ftp}
2684 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2685 are set to the same @sc{url}.
2688 This variable should contain a comma-separated list of domain extensions
2689 proxy should @emph{not} be used for. For instance, if the value of
2690 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2694 In addition to the environment variables, proxy location and settings
2695 may be specified from within Wget itself.
2699 @itemx --proxy=on/off
2700 @itemx proxy = on/off
2701 This option may be used to turn the proxy support on or off. Proxy
2702 support is on by default, provided that the appropriate environment
2705 @item http_proxy = @var{URL}
2706 @itemx ftp_proxy = @var{URL}
2707 @itemx no_proxy = @var{string}
2708 These startup file variables allow you to override the proxy settings
2709 specified by the environment.
2712 Some proxy servers require authorization to enable you to use them. The
2713 authorization consists of @dfn{username} and @dfn{password}, which must
2714 be sent by Wget. As with @sc{http} authorization, several
2715 authentication schemes exist. For proxy authorization only the
2716 @code{Basic} authentication scheme is currently implemented.
2718 You may specify your username and password either through the proxy
2719 @sc{url} or through the command-line options. Assuming that the
2720 company's proxy is located at @samp{proxy.company.com} at port 8001, a
2721 proxy @sc{url} location containing authorization data might look like
2725 http://hniksic:mypassword@@proxy.company.com:8001/
2728 Alternatively, you may use the @samp{proxy-user} and
2729 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2730 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2731 username and password.
2733 @node Distribution, Mailing List, Proxies, Various
2734 @section Distribution
2735 @cindex latest version
2737 Like all GNU utilities, the latest version of Wget can be found at the
2738 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2739 Wget @value{VERSION} can be found at
2740 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2742 @node Mailing List, Reporting Bugs, Distribution, Various
2743 @section Mailing List
2744 @cindex mailing list
2747 Wget has its own mailing list at @email{wget@@sunsite.dk}, thanks
2748 to Karsten Thygesen. The mailing list is for discussion of Wget
2749 features and web, reporting Wget bugs (those that you think may be of
2750 interest to the public) and mailing announcements. You are welcome to
2751 subscribe. The more people on the list, the better!
2753 To subscribe, send mail to @email{wget-subscribe@@sunsite.dk}.
2754 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2755 mailing to @email{wget-unsubscribe@@sunsite.dk}.
2757 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2758 Alternative archive is available at
2759 @url{http://www.mail-archive.com/wget%40sunsite.auc.dk/}.
2761 @node Reporting Bugs, Portability, Mailing List, Various
2762 @section Reporting Bugs
2764 @cindex reporting bugs
2768 You are welcome to send bug reports about GNU Wget to
2769 @email{bug-wget@@gnu.org}.
2771 Before actually submitting a bug report, please try to follow a few
2776 Please try to ascertain that the behaviour you see really is a bug. If
2777 Wget crashes, it's a bug. If Wget does not behave as documented,
2778 it's a bug. If things work strange, but you are not sure about the way
2779 they are supposed to work, it might well be a bug.
2782 Try to repeat the bug in as simple circumstances as possible. E.g. if
2783 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
2784 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
2785 repeatable, and if will occur with a simpler set of options. You might
2786 even try to start the download at the page where the crash occurred to
2787 see if that page somehow triggered the crash.
2789 Also, while I will probably be interested to know the contents of your
2790 @file{.wgetrc} file, just dumping it into the debug message is probably
2791 a bad idea. Instead, you should first try to see if the bug repeats
2792 with @file{.wgetrc} moved out of the way. Only if it turns out that
2793 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
2797 Please start Wget with @samp{-d} option and send the log (or the
2798 relevant parts of it). If Wget was compiled without debug support,
2799 recompile it. It is @emph{much} easier to trace bugs with debug support
2803 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2804 wget` core} and type @code{where} to get the backtrace.
2808 @node Portability, Signals, Reporting Bugs, Various
2809 @section Portability
2811 @cindex operating systems
2813 Since Wget uses GNU Autoconf for building and configuring, and avoids
2814 using ``special'' ultra--mega--cool features of any particular Unix, it
2815 should compile (and work) on all common Unix flavors.
2817 Various Wget versions have been compiled and tested under many kinds of
2818 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2819 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2820 distribution directory for a comprehensive list. If you compile it on
2821 an architecture not listed there, please let me know so I can update it.
2823 Wget should also compile on the other Unix systems, not listed in
2824 @file{MACHINES}. If it doesn't, please let me know.
2826 Thanks to kind contributors, this version of Wget compiles and works on
2827 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2828 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2829 with Winsock as networking software. Naturally, it is crippled of some
2830 features available on Unix, but it should work as a substitute for
2831 people stuck with Windows. Note that the Windows port is
2832 @strong{neither tested nor maintained} by me---all questions and
2833 problems should be reported to Wget mailing list at
2834 @email{wget@@sunsite.dk} where the maintainers will look at them.
2836 @node Signals, , Portability, Various
2838 @cindex signal handling
2841 Since the purpose of Wget is background work, it catches the hangup
2842 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2843 output, it will be redirected to a file named @file{wget-log}.
2844 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2845 to redirect the output of Wget after having started it.
2848 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2849 $ kill -HUP %% # Redirect the output to wget-log
2852 Other than that, Wget will not try to interfere with signals in any way.
2853 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
2855 @node Appendices, Copying, Various, Top
2858 This chapter contains some references I consider useful.
2861 * Robot Exclusion:: Wget's support for RES.
2862 * Security Considerations:: Security with Wget.
2863 * Contributors:: People who helped.
2866 @node Robot Exclusion, Security Considerations, Appendices, Appendices
2867 @section Robot Exclusion
2868 @cindex robot exclusion
2870 @cindex server maintenance
2872 It is extremely easy to make Wget wander aimlessly around a web site,
2873 sucking all the available data in progress. @samp{wget -r @var{site}},
2874 and you're set. Great? Not for the server admin.
2876 As long as Wget is only retrieving static pages, and doing it at a
2877 reasonable rate (see the @samp{--wait} option), there's not much of a
2878 problem. The trouble is that Wget can't tell the difference between the
2879 smallest static page and the most demanding CGI. A site I know has a
2880 section handled by an, uh, @dfn{bitchin'} CGI Perl script that converts
2881 Info files to HTML on the fly. The script is slow, but works well
2882 enough for human users viewing an occasional Info file. However, when
2883 someone's recursive Wget download stumbles upon the index page that
2884 links to all the Info files through the script, the system is brought to
2885 its knees without providing anything useful to the downloader.
2887 To avoid this kind of accident, as well as to preserve privacy for
2888 documents that need to be protected from well-behaved robots, the
2889 concept of @dfn{robot exclusion} has been invented. The idea is that
2890 the server administrators and document authors can specify which
2891 portions of the site they wish to protect from the robots.
2893 The most popular mechanism, and the de facto standard supported by all
2894 the major robots, is the ``Robots Exclusion Standard'' (RES) written by
2895 Martijn Koster et al. in 1994. It specifies the format of a text file
2896 containing directives that instruct the robots which URL paths to avoid.
2897 To be found by the robots, the specifications must be placed in
2898 @file{/robots.txt} in the server root, which the robots are supposed to
2901 Although Wget is not a web robot in the strictest sense of the word, it
2902 can downloads large parts of the site without the user's intervention to
2903 download an individual page. Because of that, Wget honors RES when
2904 downloading recursively. For instance, when you issue:
2907 wget -r http://www.server.com/
2910 First the index of @samp{www.server.com} will be downloaded. If Wget
2911 finds that it wants to download more documents from that server, it will
2912 request @samp{http://www.server.com/robots.txt} and, if found, use it
2913 for further downloads. @file{robots.txt} is loaded only once per each
2916 Until version 1.8, Wget supported the first version of the standard,
2917 written by Martijn Koster in 1994 and available at
2918 @url{http://www.robotstxt.org/wc/norobots.html}. As of version 1.8,
2919 Wget has supported the additional directives specified in the internet
2920 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
2921 Robots Control''. The draft, which has as far as I know never made to
2922 an @sc{rfc}, is available at
2923 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
2925 This manual no longer includes the text of the Robot Exclusion Standard.
2927 The second, less known mechanism, enables the author of an individual
2928 document to specify whether they want the links from the file to be
2929 followed by a robot. This is achieved using the @code{META} tag, like
2933 <meta name="robots" content="nofollow">
2936 This is explained in some detail at
2937 @url{http://www.robotstxt.org/wc/meta-user.html}. Wget supports this
2938 method of robot exclusion in addition to the usual @file{/robots.txt}
2941 If you know what you are doing and really really wish to turn off the
2942 robot exclusion, set the @code{robots} variable to @samp{off} in your
2943 @file{.wgetrc}. You can achieve the same effect from the command line
2944 using the @code{-e} switch, e.g. @samp{wget -e robots=off @var{url}...}.
2946 @node Security Considerations, Contributors, Robot Exclusion, Appendices
2947 @section Security Considerations
2950 When using Wget, you must be aware that it sends unencrypted passwords
2951 through the network, which may present a security problem. Here are the
2952 main issues, and some solutions.
2955 @item The passwords on the command line are visible using @code{ps}.
2956 The best way around it is to use @code{wget -i -} and feed the @sc{url}s
2957 to Wget's standard input, each on a separate line, terminated by
2958 @kbd{C-d}. Another workaround is to use @file{.netrc} to store
2959 passwords; however, storing unencrypted passwords is also considered a
2963 Using the insecure @dfn{basic} authentication scheme, unencrypted
2964 passwords are transmitted through the network routers and gateways.
2967 The @sc{ftp} passwords are also in no way encrypted. There is no good
2968 solution for this at the moment.
2971 Although the ``normal'' output of Wget tries to hide the passwords,
2972 debugging logs show them, in all forms. This problem is avoided by
2973 being careful when you send debug logs (yes, even when you send them to
2977 @node Contributors, , Security Considerations, Appendices
2978 @section Contributors
2979 @cindex contributors
2982 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
2985 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
2987 However, its development could never have gone as far as it has, were it
2988 not for the help of many people, either with bug reports, feature
2989 proposals, patches, or letters saying ``Thanks!''.
2991 Special thanks goes to the following people (no particular order):
2995 Karsten Thygesen---donated system resources such as the mailing list,
2996 web space, and @sc{ftp} space, along with a lot of time to make these
3000 Shawn McHorse---bug reports and patches.
3003 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
3007 Gordon Matzigkeit---@file{.netrc} support.
3011 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
3012 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
3015 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
3016 and ``philosophical'' discussions.
3020 Darko Budor---initial port to Windows.
3023 Antonio Rosella---help and suggestions, plus the Italian translation.
3027 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
3031 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
3036 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
3039 Francois Pinard---many thorough bug reports and discussions.
3043 Karl Eichwalder---lots of help with internationalization and other
3047 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
3051 The people who provided donations for development, including Brian
3055 The following people have provided patches, bug/build reports, useful
3056 suggestions, beta testing services, fan mail and all the other things
3057 that make maintenance so much fun:
3076 Kristijan @v{C}onka@v{s},
3094 Aleksandar Erkalovi@'{c},
3097 Aleksandar Erkalovic,
3113 Erik Magnus Hulthen,
3131 Goran Kezunovi@'{c},
3142 $\Sigma\acute{\iota}\mu o\varsigma\;
3143 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
3144 (Simos KSenitellis),
3152 Nicol@'{a}s Lichtmeier,
3158 Alexander V. Lukyanov,
3183 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3185 Juan Jos\'{e} Rodr\'{\i}gues,
3188 Juan Jose Rodrigues,
3200 Szakacsits Szabolcs,
3206 Douglas E. Wegscheid,
3216 Apologies to all who I accidentally left out, and many thanks to all the
3217 subscribers of the Wget mailing list.
3219 @node Copying, Concept Index, Appendices, Top
3224 @cindex free software
3226 GNU Wget is licensed under the GNU GPL, which makes it @dfn{free
3229 Please note that ``free'' in ``free software'' refers to liberty, not
3230 price. As some GNU project advocates like to point out, think of ``free
3231 speech'' rather than ``free beer''. The exact and legally binding
3232 distribution terms are spelled out below; in short, you have the right
3233 (freedom) to run and change Wget and distribute it to other people, and
3234 even---if you want---charge money for doing either. The important
3235 restriction is that you have to grant your recipients the same rights
3236 and impose the same restrictions.
3238 This method of licensing software is also known as @dfn{open source}
3239 because, among other things, it makes sure that all recipients will
3240 receive the source code along with the program, and be able to improve
3241 it. The GNU project prefers the term ``free software'' for reasons
3243 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3245 The exact license terms are defined by this paragraph and the GNU
3246 General Public License it refers to:
3249 GNU Wget is free software; you can redistribute it and/or modify it
3250 under the terms of the GNU General Public License as published by the
3251 Free Software Foundation; either version 2 of the License, or (at your
3252 option) any later version.
3254 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3255 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3256 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3259 A copy of the GNU General Public License is included as part of this
3260 manual; if you did not receive it, write to the Free Software
3261 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3264 In addition to this, this manual is free in the same sense:
3267 Permission is granted to copy, distribute and/or modify this document
3268 under the terms of the GNU Free Documentation License, Version 1.1 or
3269 any later version published by the Free Software Foundation; with the
3270 Invariant Sections being ``GNU General Public License'' and ``GNU Free
3271 Documentation License'', with no Front-Cover Texts, and with no
3272 Back-Cover Texts. A copy of the license is included in the section
3273 entitled ``GNU Free Documentation License''.
3276 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
3277 @c that the GFDL needs to be present in the manual, and to me it would
3278 @c suck to include the license for the manual and not the license for
3281 The full texts of the GNU General Public License and of the GNU Free
3282 Documentation License are available below.
3285 * GNU General Public License::
3286 * GNU Free Documentation License::
3289 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
3290 @section GNU General Public License
3291 @center Version 2, June 1991
3294 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3295 675 Mass Ave, Cambridge, MA 02139, USA
3297 Everyone is permitted to copy and distribute verbatim copies
3298 of this license document, but changing it is not allowed.
3301 @unnumberedsec Preamble
3303 The licenses for most software are designed to take away your
3304 freedom to share and change it. By contrast, the GNU General Public
3305 License is intended to guarantee your freedom to share and change free
3306 software---to make sure the software is free for all its users. This
3307 General Public License applies to most of the Free Software
3308 Foundation's software and to any other program whose authors commit to
3309 using it. (Some other Free Software Foundation software is covered by
3310 the GNU Library General Public License instead.) You can apply it to
3313 When we speak of free software, we are referring to freedom, not
3314 price. Our General Public Licenses are designed to make sure that you
3315 have the freedom to distribute copies of free software (and charge for
3316 this service if you wish), that you receive source code or can get it
3317 if you want it, that you can change the software or use pieces of it
3318 in new free programs; and that you know you can do these things.
3320 To protect your rights, we need to make restrictions that forbid
3321 anyone to deny you these rights or to ask you to surrender the rights.
3322 These restrictions translate to certain responsibilities for you if you
3323 distribute copies of the software, or if you modify it.
3325 For example, if you distribute copies of such a program, whether
3326 gratis or for a fee, you must give the recipients all the rights that
3327 you have. You must make sure that they, too, receive or can get the
3328 source code. And you must show them these terms so they know their
3331 We protect your rights with two steps: (1) copyright the software, and
3332 (2) offer you this license which gives you legal permission to copy,
3333 distribute and/or modify the software.
3335 Also, for each author's protection and ours, we want to make certain
3336 that everyone understands that there is no warranty for this free
3337 software. If the software is modified by someone else and passed on, we
3338 want its recipients to know that what they have is not the original, so
3339 that any problems introduced by others will not reflect on the original
3340 authors' reputations.
3342 Finally, any free program is threatened constantly by software
3343 patents. We wish to avoid the danger that redistributors of a free
3344 program will individually obtain patent licenses, in effect making the
3345 program proprietary. To prevent this, we have made it clear that any
3346 patent must be licensed for everyone's free use or not licensed at all.
3348 The precise terms and conditions for copying, distribution and
3349 modification follow.
3352 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3355 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3360 This License applies to any program or other work which contains
3361 a notice placed by the copyright holder saying it may be distributed
3362 under the terms of this General Public License. The ``Program'', below,
3363 refers to any such program or work, and a ``work based on the Program''
3364 means either the Program or any derivative work under copyright law:
3365 that is to say, a work containing the Program or a portion of it,
3366 either verbatim or with modifications and/or translated into another
3367 language. (Hereinafter, translation is included without limitation in
3368 the term ``modification''.) Each licensee is addressed as ``you''.
3370 Activities other than copying, distribution and modification are not
3371 covered by this License; they are outside its scope. The act of
3372 running the Program is not restricted, and the output from the Program
3373 is covered only if its contents constitute a work based on the
3374 Program (independent of having been made by running the Program).
3375 Whether that is true depends on what the Program does.
3378 You may copy and distribute verbatim copies of the Program's
3379 source code as you receive it, in any medium, provided that you
3380 conspicuously and appropriately publish on each copy an appropriate
3381 copyright notice and disclaimer of warranty; keep intact all the
3382 notices that refer to this License and to the absence of any warranty;
3383 and give any other recipients of the Program a copy of this License
3384 along with the Program.
3386 You may charge a fee for the physical act of transferring a copy, and
3387 you may at your option offer warranty protection in exchange for a fee.
3390 You may modify your copy or copies of the Program or any portion
3391 of it, thus forming a work based on the Program, and copy and
3392 distribute such modifications or work under the terms of Section 1
3393 above, provided that you also meet all of these conditions:
3397 You must cause the modified files to carry prominent notices
3398 stating that you changed the files and the date of any change.
3401 You must cause any work that you distribute or publish, that in
3402 whole or in part contains or is derived from the Program or any
3403 part thereof, to be licensed as a whole at no charge to all third
3404 parties under the terms of this License.
3407 If the modified program normally reads commands interactively
3408 when run, you must cause it, when started running for such
3409 interactive use in the most ordinary way, to print or display an
3410 announcement including an appropriate copyright notice and a
3411 notice that there is no warranty (or else, saying that you provide
3412 a warranty) and that users may redistribute the program under
3413 these conditions, and telling the user how to view a copy of this
3414 License. (Exception: if the Program itself is interactive but
3415 does not normally print such an announcement, your work based on
3416 the Program is not required to print an announcement.)
3419 These requirements apply to the modified work as a whole. If
3420 identifiable sections of that work are not derived from the Program,
3421 and can be reasonably considered independent and separate works in
3422 themselves, then this License, and its terms, do not apply to those
3423 sections when you distribute them as separate works. But when you
3424 distribute the same sections as part of a whole which is a work based
3425 on the Program, the distribution of the whole must be on the terms of
3426 this License, whose permissions for other licensees extend to the
3427 entire whole, and thus to each and every part regardless of who wrote it.
3429 Thus, it is not the intent of this section to claim rights or contest
3430 your rights to work written entirely by you; rather, the intent is to
3431 exercise the right to control the distribution of derivative or
3432 collective works based on the Program.
3434 In addition, mere aggregation of another work not based on the Program
3435 with the Program (or with a work based on the Program) on a volume of
3436 a storage or distribution medium does not bring the other work under
3437 the scope of this License.
3440 You may copy and distribute the Program (or a work based on it,
3441 under Section 2) in object code or executable form under the terms of
3442 Sections 1 and 2 above provided that you also do one of the following:
3446 Accompany it with the complete corresponding machine-readable
3447 source code, which must be distributed under the terms of Sections
3448 1 and 2 above on a medium customarily used for software interchange; or,
3451 Accompany it with a written offer, valid for at least three
3452 years, to give any third party, for a charge no more than your
3453 cost of physically performing source distribution, a complete
3454 machine-readable copy of the corresponding source code, to be
3455 distributed under the terms of Sections 1 and 2 above on a medium
3456 customarily used for software interchange; or,
3459 Accompany it with the information you received as to the offer
3460 to distribute corresponding source code. (This alternative is
3461 allowed only for noncommercial distribution and only if you
3462 received the program in object code or executable form with such
3463 an offer, in accord with Subsection b above.)
3466 The source code for a work means the preferred form of the work for
3467 making modifications to it. For an executable work, complete source
3468 code means all the source code for all modules it contains, plus any
3469 associated interface definition files, plus the scripts used to
3470 control compilation and installation of the executable. However, as a
3471 special exception, the source code distributed need not include
3472 anything that is normally distributed (in either source or binary
3473 form) with the major components (compiler, kernel, and so on) of the
3474 operating system on which the executable runs, unless that component
3475 itself accompanies the executable.
3477 If distribution of executable or object code is made by offering
3478 access to copy from a designated place, then offering equivalent
3479 access to copy the source code from the same place counts as
3480 distribution of the source code, even though third parties are not
3481 compelled to copy the source along with the object code.
3484 You may not copy, modify, sublicense, or distribute the Program
3485 except as expressly provided under this License. Any attempt
3486 otherwise to copy, modify, sublicense or distribute the Program is
3487 void, and will automatically terminate your rights under this License.
3488 However, parties who have received copies, or rights, from you under
3489 this License will not have their licenses terminated so long as such
3490 parties remain in full compliance.
3493 You are not required to accept this License, since you have not
3494 signed it. However, nothing else grants you permission to modify or
3495 distribute the Program or its derivative works. These actions are
3496 prohibited by law if you do not accept this License. Therefore, by
3497 modifying or distributing the Program (or any work based on the
3498 Program), you indicate your acceptance of this License to do so, and
3499 all its terms and conditions for copying, distributing or modifying
3500 the Program or works based on it.
3503 Each time you redistribute the Program (or any work based on the
3504 Program), the recipient automatically receives a license from the
3505 original licensor to copy, distribute or modify the Program subject to
3506 these terms and conditions. You may not impose any further
3507 restrictions on the recipients' exercise of the rights granted herein.
3508 You are not responsible for enforcing compliance by third parties to
3512 If, as a consequence of a court judgment or allegation of patent
3513 infringement or for any other reason (not limited to patent issues),
3514 conditions are imposed on you (whether by court order, agreement or
3515 otherwise) that contradict the conditions of this License, they do not
3516 excuse you from the conditions of this License. If you cannot
3517 distribute so as to satisfy simultaneously your obligations under this
3518 License and any other pertinent obligations, then as a consequence you
3519 may not distribute the Program at all. For example, if a patent
3520 license would not permit royalty-free redistribution of the Program by
3521 all those who receive copies directly or indirectly through you, then
3522 the only way you could satisfy both it and this License would be to
3523 refrain entirely from distribution of the Program.
3525 If any portion of this section is held invalid or unenforceable under
3526 any particular circumstance, the balance of the section is intended to
3527 apply and the section as a whole is intended to apply in other
3530 It is not the purpose of this section to induce you to infringe any
3531 patents or other property right claims or to contest validity of any
3532 such claims; this section has the sole purpose of protecting the
3533 integrity of the free software distribution system, which is
3534 implemented by public license practices. Many people have made
3535 generous contributions to the wide range of software distributed
3536 through that system in reliance on consistent application of that
3537 system; it is up to the author/donor to decide if he or she is willing
3538 to distribute software through any other system and a licensee cannot
3541 This section is intended to make thoroughly clear what is believed to
3542 be a consequence of the rest of this License.
3545 If the distribution and/or use of the Program is restricted in
3546 certain countries either by patents or by copyrighted interfaces, the
3547 original copyright holder who places the Program under this License
3548 may add an explicit geographical distribution limitation excluding
3549 those countries, so that distribution is permitted only in or among
3550 countries not thus excluded. In such case, this License incorporates
3551 the limitation as if written in the body of this License.
3554 The Free Software Foundation may publish revised and/or new versions
3555 of the General Public License from time to time. Such new versions will
3556 be similar in spirit to the present version, but may differ in detail to
3557 address new problems or concerns.
3559 Each version is given a distinguishing version number. If the Program
3560 specifies a version number of this License which applies to it and ``any
3561 later version'', you have the option of following the terms and conditions
3562 either of that version or of any later version published by the Free
3563 Software Foundation. If the Program does not specify a version number of
3564 this License, you may choose any version ever published by the Free Software
3568 If you wish to incorporate parts of the Program into other free
3569 programs whose distribution conditions are different, write to the author
3570 to ask for permission. For software which is copyrighted by the Free
3571 Software Foundation, write to the Free Software Foundation; we sometimes
3572 make exceptions for this. Our decision will be guided by the two goals
3573 of preserving the free status of all derivatives of our free software and
3574 of promoting the sharing and reuse of software generally.
3577 @heading NO WARRANTY
3585 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3586 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3587 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3588 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3589 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3590 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3591 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3592 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3593 REPAIR OR CORRECTION.
3596 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3597 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3598 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3599 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3600 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3601 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3602 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3603 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3604 POSSIBILITY OF SUCH DAMAGES.
3608 @heading END OF TERMS AND CONDITIONS
3611 @center END OF TERMS AND CONDITIONS
3615 @unnumberedsec How to Apply These Terms to Your New Programs
3617 If you develop a new program, and you want it to be of the greatest
3618 possible use to the public, the best way to achieve this is to make it
3619 free software which everyone can redistribute and change under these terms.
3621 To do so, attach the following notices to the program. It is safest
3622 to attach them to the start of each source file to most effectively
3623 convey the exclusion of warranty; and each file should have at least
3624 the ``copyright'' line and a pointer to where the full notice is found.
3627 @var{one line to give the program's name and an idea of what it does.}
3628 Copyright (C) 19@var{yy} @var{name of author}
3630 This program is free software; you can redistribute it and/or
3631 modify it under the terms of the GNU General Public License
3632 as published by the Free Software Foundation; either version 2
3633 of the License, or (at your option) any later version.
3635 This program is distributed in the hope that it will be useful,
3636 but WITHOUT ANY WARRANTY; without even the implied warranty of
3637 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3638 GNU General Public License for more details.
3640 You should have received a copy of the GNU General Public License
3641 along with this program; if not, write to the Free Software
3642 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3645 Also add information on how to contact you by electronic and paper mail.
3647 If the program is interactive, make it output a short notice like this
3648 when it starts in an interactive mode:
3651 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3652 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3653 type `show w'. This is free software, and you are welcome
3654 to redistribute it under certain conditions; type `show c'
3658 The hypothetical commands @samp{show w} and @samp{show c} should show
3659 the appropriate parts of the General Public License. Of course, the
3660 commands you use may be called something other than @samp{show w} and
3661 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3664 You should also get your employer (if you work as a programmer) or your
3665 school, if any, to sign a ``copyright disclaimer'' for the program, if
3666 necessary. Here is a sample; alter the names:
3670 Yoyodyne, Inc., hereby disclaims all copyright
3671 interest in the program `Gnomovision'
3672 (which makes passes at compilers) written
3675 @var{signature of Ty Coon}, 1 April 1989
3676 Ty Coon, President of Vice
3680 This General Public License does not permit incorporating your program into
3681 proprietary programs. If your program is a subroutine library, you may
3682 consider it more useful to permit linking proprietary applications with the
3683 library. If this is what you want to do, use the GNU Library General
3684 Public License instead of this License.
3686 @node GNU Free Documentation License, , GNU General Public License, Copying
3687 @section GNU Free Documentation License
3688 @center Version 1.1, March 2000
3691 Copyright (C) 2000 Free Software Foundation, Inc.
3692 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3694 Everyone is permitted to copy and distribute verbatim copies
3695 of this license document, but changing it is not allowed.
3702 The purpose of this License is to make a manual, textbook, or other
3703 written document ``free'' in the sense of freedom: to assure everyone
3704 the effective freedom to copy and redistribute it, with or without
3705 modifying it, either commercially or noncommercially. Secondarily,
3706 this License preserves for the author and publisher a way to get
3707 credit for their work, while not being considered responsible for
3708 modifications made by others.
3710 This License is a kind of ``copyleft'', which means that derivative
3711 works of the document must themselves be free in the same sense. It
3712 complements the GNU General Public License, which is a copyleft
3713 license designed for free software.
3715 We have designed this License in order to use it for manuals for free
3716 software, because free software needs free documentation: a free
3717 program should come with manuals providing the same freedoms that the
3718 software does. But this License is not limited to software manuals;
3719 it can be used for any textual work, regardless of subject matter or
3720 whether it is published as a printed book. We recommend this License
3721 principally for works whose purpose is instruction or reference.
3725 APPLICABILITY AND DEFINITIONS
3727 This License applies to any manual or other work that contains a
3728 notice placed by the copyright holder saying it can be distributed
3729 under the terms of this License. The ``Document'', below, refers to any
3730 such manual or work. Any member of the public is a licensee, and is
3731 addressed as ``you''.
3733 A ``Modified Version'' of the Document means any work containing the
3734 Document or a portion of it, either copied verbatim, or with
3735 modifications and/or translated into another language.
3737 A ``Secondary Section'' is a named appendix or a front-matter section of
3738 the Document that deals exclusively with the relationship of the
3739 publishers or authors of the Document to the Document's overall subject
3740 (or to related matters) and contains nothing that could fall directly
3741 within that overall subject. (For example, if the Document is in part a
3742 textbook of mathematics, a Secondary Section may not explain any
3743 mathematics.) The relationship could be a matter of historical
3744 connection with the subject or with related matters, or of legal,
3745 commercial, philosophical, ethical or political position regarding
3748 The ``Invariant Sections'' are certain Secondary Sections whose titles
3749 are designated, as being those of Invariant Sections, in the notice
3750 that says that the Document is released under this License.
3752 The ``Cover Texts'' are certain short passages of text that are listed,
3753 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3754 the Document is released under this License.
3756 A ``Transparent'' copy of the Document means a machine-readable copy,
3757 represented in a format whose specification is available to the
3758 general public, whose contents can be viewed and edited directly and
3759 straightforwardly with generic text editors or (for images composed of
3760 pixels) generic paint programs or (for drawings) some widely available
3761 drawing editor, and that is suitable for input to text formatters or
3762 for automatic translation to a variety of formats suitable for input
3763 to text formatters. A copy made in an otherwise Transparent file
3764 format whose markup has been designed to thwart or discourage
3765 subsequent modification by readers is not Transparent. A copy that is
3766 not ``Transparent'' is called ``Opaque''.
3768 Examples of suitable formats for Transparent copies include plain
3769 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3770 or XML using a publicly available DTD, and standard-conforming simple
3771 HTML designed for human modification. Opaque formats include
3772 PostScript, PDF, proprietary formats that can be read and edited only
3773 by proprietary word processors, SGML or XML for which the DTD and/or
3774 processing tools are not generally available, and the
3775 machine-generated HTML produced by some word processors for output
3778 The ``Title Page'' means, for a printed book, the title page itself,
3779 plus such following pages as are needed to hold, legibly, the material
3780 this License requires to appear in the title page. For works in
3781 formats which do not have any title page as such, ``Title Page'' means
3782 the text near the most prominent appearance of the work's title,
3783 preceding the beginning of the body of the text.
3788 You may copy and distribute the Document in any medium, either
3789 commercially or noncommercially, provided that this License, the
3790 copyright notices, and the license notice saying this License applies
3791 to the Document are reproduced in all copies, and that you add no other
3792 conditions whatsoever to those of this License. You may not use
3793 technical measures to obstruct or control the reading or further
3794 copying of the copies you make or distribute. However, you may accept
3795 compensation in exchange for copies. If you distribute a large enough
3796 number of copies you must also follow the conditions in section 3.
3798 You may also lend copies, under the same conditions stated above, and
3799 you may publicly display copies.
3804 If you publish printed copies of the Document numbering more than 100,
3805 and the Document's license notice requires Cover Texts, you must enclose
3806 the copies in covers that carry, clearly and legibly, all these Cover
3807 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3808 the back cover. Both covers must also clearly and legibly identify
3809 you as the publisher of these copies. The front cover must present
3810 the full title with all words of the title equally prominent and
3811 visible. You may add other material on the covers in addition.
3812 Copying with changes limited to the covers, as long as they preserve
3813 the title of the Document and satisfy these conditions, can be treated
3814 as verbatim copying in other respects.
3816 If the required texts for either cover are too voluminous to fit
3817 legibly, you should put the first ones listed (as many as fit
3818 reasonably) on the actual cover, and continue the rest onto adjacent
3821 If you publish or distribute Opaque copies of the Document numbering
3822 more than 100, you must either include a machine-readable Transparent
3823 copy along with each Opaque copy, or state in or with each Opaque copy
3824 a publicly-accessible computer-network location containing a complete
3825 Transparent copy of the Document, free of added material, which the
3826 general network-using public has access to download anonymously at no
3827 charge using public-standard network protocols. If you use the latter
3828 option, you must take reasonably prudent steps, when you begin
3829 distribution of Opaque copies in quantity, to ensure that this
3830 Transparent copy will remain thus accessible at the stated location
3831 until at least one year after the last time you distribute an Opaque
3832 copy (directly or through your agents or retailers) of that edition to
3835 It is requested, but not required, that you contact the authors of the
3836 Document well before redistributing any large number of copies, to give
3837 them a chance to provide you with an updated version of the Document.
3842 You may copy and distribute a Modified Version of the Document under
3843 the conditions of sections 2 and 3 above, provided that you release
3844 the Modified Version under precisely this License, with the Modified
3845 Version filling the role of the Document, thus licensing distribution
3846 and modification of the Modified Version to whoever possesses a copy
3847 of it. In addition, you must do these things in the Modified Version:
3849 A. Use in the Title Page (and on the covers, if any) a title distinct
3850 from that of the Document, and from those of previous versions
3851 (which should, if there were any, be listed in the History section
3852 of the Document). You may use the same title as a previous version
3853 if the original publisher of that version gives permission.@*
3854 B. List on the Title Page, as authors, one or more persons or entities
3855 responsible for authorship of the modifications in the Modified
3856 Version, together with at least five of the principal authors of the
3857 Document (all of its principal authors, if it has less than five).@*
3858 C. State on the Title page the name of the publisher of the
3859 Modified Version, as the publisher.@*
3860 D. Preserve all the copyright notices of the Document.@*
3861 E. Add an appropriate copyright notice for your modifications
3862 adjacent to the other copyright notices.@*
3863 F. Include, immediately after the copyright notices, a license notice
3864 giving the public permission to use the Modified Version under the
3865 terms of this License, in the form shown in the Addendum below.@*
3866 G. Preserve in that license notice the full lists of Invariant Sections
3867 and required Cover Texts given in the Document's license notice.@*
3868 H. Include an unaltered copy of this License.@*
3869 I. Preserve the section entitled ``History'', and its title, and add to
3870 it an item stating at least the title, year, new authors, and
3871 publisher of the Modified Version as given on the Title Page. If
3872 there is no section entitled ``History'' in the Document, create one
3873 stating the title, year, authors, and publisher of the Document as
3874 given on its Title Page, then add an item describing the Modified
3875 Version as stated in the previous sentence.@*
3876 J. Preserve the network location, if any, given in the Document for
3877 public access to a Transparent copy of the Document, and likewise
3878 the network locations given in the Document for previous versions
3879 it was based on. These may be placed in the ``History'' section.
3880 You may omit a network location for a work that was published at
3881 least four years before the Document itself, or if the original
3882 publisher of the version it refers to gives permission.@*
3883 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3884 preserve the section's title, and preserve in the section all the
3885 substance and tone of each of the contributor acknowledgements
3886 and/or dedications given therein.@*
3887 L. Preserve all the Invariant Sections of the Document,
3888 unaltered in their text and in their titles. Section numbers
3889 or the equivalent are not considered part of the section titles.@*
3890 M. Delete any section entitled ``Endorsements''. Such a section
3891 may not be included in the Modified Version.@*
3892 N. Do not retitle any existing section as ``Endorsements''
3893 or to conflict in title with any Invariant Section.@*
3895 If the Modified Version includes new front-matter sections or
3896 appendices that qualify as Secondary Sections and contain no material
3897 copied from the Document, you may at your option designate some or all
3898 of these sections as invariant. To do this, add their titles to the
3899 list of Invariant Sections in the Modified Version's license notice.
3900 These titles must be distinct from any other section titles.
3902 You may add a section entitled ``Endorsements'', provided it contains
3903 nothing but endorsements of your Modified Version by various
3904 parties--for example, statements of peer review or that the text has
3905 been approved by an organization as the authoritative definition of a
3908 You may add a passage of up to five words as a Front-Cover Text, and a
3909 passage of up to 25 words as a Back-Cover Text, to the end of the list
3910 of Cover Texts in the Modified Version. Only one passage of
3911 Front-Cover Text and one of Back-Cover Text may be added by (or
3912 through arrangements made by) any one entity. If the Document already
3913 includes a cover text for the same cover, previously added by you or
3914 by arrangement made by the same entity you are acting on behalf of,
3915 you may not add another; but you may replace the old one, on explicit
3916 permission from the previous publisher that added the old one.
3918 The author(s) and publisher(s) of the Document do not by this License
3919 give permission to use their names for publicity for or to assert or
3920 imply endorsement of any Modified Version.
3925 You may combine the Document with other documents released under this
3926 License, under the terms defined in section 4 above for modified
3927 versions, provided that you include in the combination all of the
3928 Invariant Sections of all of the original documents, unmodified, and
3929 list them all as Invariant Sections of your combined work in its
3932 The combined work need only contain one copy of this License, and
3933 multiple identical Invariant Sections may be replaced with a single
3934 copy. If there are multiple Invariant Sections with the same name but
3935 different contents, make the title of each such section unique by
3936 adding at the end of it, in parentheses, the name of the original
3937 author or publisher of that section if known, or else a unique number.
3938 Make the same adjustment to the section titles in the list of
3939 Invariant Sections in the license notice of the combined work.
3941 In the combination, you must combine any sections entitled ``History''
3942 in the various original documents, forming one section entitled
3943 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3944 and any sections entitled ``Dedications''. You must delete all sections
3945 entitled ``Endorsements.''
3948 COLLECTIONS OF DOCUMENTS
3950 You may make a collection consisting of the Document and other documents
3951 released under this License, and replace the individual copies of this
3952 License in the various documents with a single copy that is included in
3953 the collection, provided that you follow the rules of this License for
3954 verbatim copying of each of the documents in all other respects.
3956 You may extract a single document from such a collection, and distribute
3957 it individually under this License, provided you insert a copy of this
3958 License into the extracted document, and follow this License in all
3959 other respects regarding verbatim copying of that document.
3962 AGGREGATION WITH INDEPENDENT WORKS
3964 A compilation of the Document or its derivatives with other separate
3965 and independent documents or works, in or on a volume of a storage or
3966 distribution medium, does not as a whole count as a Modified Version
3967 of the Document, provided no compilation copyright is claimed for the
3968 compilation. Such a compilation is called an ``aggregate'', and this
3969 License does not apply to the other self-contained works thus compiled
3970 with the Document, on account of their being thus compiled, if they
3971 are not themselves derivative works of the Document.
3973 If the Cover Text requirement of section 3 is applicable to these
3974 copies of the Document, then if the Document is less than one quarter
3975 of the entire aggregate, the Document's Cover Texts may be placed on
3976 covers that surround only the Document within the aggregate.
3977 Otherwise they must appear on covers around the whole aggregate.
3982 Translation is considered a kind of modification, so you may
3983 distribute translations of the Document under the terms of section 4.
3984 Replacing Invariant Sections with translations requires special
3985 permission from their copyright holders, but you may include
3986 translations of some or all Invariant Sections in addition to the
3987 original versions of these Invariant Sections. You may include a
3988 translation of this License provided that you also include the
3989 original English version of this License. In case of a disagreement
3990 between the translation and the original English version of this
3991 License, the original English version will prevail.
3996 You may not copy, modify, sublicense, or distribute the Document except
3997 as expressly provided for under this License. Any other attempt to
3998 copy, modify, sublicense or distribute the Document is void, and will
3999 automatically terminate your rights under this License. However,
4000 parties who have received copies, or rights, from you under this
4001 License will not have their licenses terminated so long as such
4002 parties remain in full compliance.
4005 FUTURE REVISIONS OF THIS LICENSE
4007 The Free Software Foundation may publish new, revised versions
4008 of the GNU Free Documentation License from time to time. Such new
4009 versions will be similar in spirit to the present version, but may
4010 differ in detail to address new problems or concerns. See
4011 http://www.gnu.org/copyleft/.
4013 Each version of the License is given a distinguishing version number.
4014 If the Document specifies that a particular numbered version of this
4015 License ``or any later version'' applies to it, you have the option of
4016 following the terms and conditions either of that specified version or
4017 of any later version that has been published (not as a draft) by the
4018 Free Software Foundation. If the Document does not specify a version
4019 number of this License, you may choose any version ever published (not
4020 as a draft) by the Free Software Foundation.
4024 @unnumberedsec ADDENDUM: How to use this License for your documents
4026 To use this License in a document you have written, include a copy of
4027 the License in the document and put the following copyright and
4028 license notices just after the title page:
4033 Copyright (C) @var{year} @var{your name}.
4034 Permission is granted to copy, distribute and/or modify this document
4035 under the terms of the GNU Free Documentation License, Version 1.1
4036 or any later version published by the Free Software Foundation;
4037 with the Invariant Sections being @var{list their titles}, with the
4038 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
4039 A copy of the license is included in the section entitled ``GNU
4040 Free Documentation License''.
4043 If you have no Invariant Sections, write ``with no Invariant Sections''
4044 instead of saying which ones are invariant. If you have no
4045 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
4046 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
4048 If your document contains nontrivial examples of program code, we
4049 recommend releasing these examples in parallel under your choice of
4050 free software license, such as the GNU General Public License,
4051 to permit their use in free software.
4054 @node Concept Index, , Copying, Top
4055 @unnumbered Concept Index