1 \input texinfo @c -*-texinfo-*-
5 @settitle GNU Wget Manual
6 @c Disable the monstrous rectangles beside overfull hbox-es.
8 @c Use `odd' to print double-sided.
13 @c Remove this if you don't use A4 paper.
17 @c This should really be generated automatically, possibly by including
18 @c an auto-generated file.
19 @set VERSION 1.8.1+cvs
20 @set UPDATED December 2001
22 @dircategory Net Utilities
23 @dircategory World Wide Web
25 * Wget: (wget). The non-interactive network downloader.
29 This file documents the the GNU Wget utility for downloading network
32 @c man begin COPYRIGHT
33 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
36 Permission is granted to make and distribute verbatim copies of
37 this manual provided the copyright notice and this permission notice
38 are preserved on all copies.
41 Permission is granted to process this file through TeX and print the
42 results, provided the printed document carries a copying permission
43 notice identical to this one except for the removal of this paragraph
44 (this paragraph not being relevant to the printed manual).
46 Permission is granted to copy, distribute and/or modify this document
47 under the terms of the GNU Free Documentation License, Version 1.1 or
48 any later version published by the Free Software Foundation; with the
49 Invariant Sections being ``GNU General Public License'' and ``GNU Free
50 Documentation License'', with no Front-Cover Texts, and with no
51 Back-Cover Texts. A copy of the license is included in the section
52 entitled ``GNU Free Documentation License''.
58 @subtitle The noninteractive downloading utility
59 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
60 @author by Hrvoje Nik@v{s}i@'{c} and the developers
64 Originally written by Hrvoje Niksic <hniksic@arsdigita.com>.
67 GNU Info entry for @file{wget}.
72 @vskip 0pt plus 1filll
73 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
76 Permission is granted to copy, distribute and/or modify this document
77 under the terms of the GNU Free Documentation License, Version 1.1 or
78 any later version published by the Free Software Foundation; with the
79 Invariant Sections being ``GNU General Public License'' and ``GNU Free
80 Documentation License'', with no Front-Cover Texts, and with no
81 Back-Cover Texts. A copy of the license is included in the section
82 entitled ``GNU Free Documentation License''.
86 @node Top, Overview, (dir), (dir)
87 @top Wget @value{VERSION}
89 This manual documents version @value{VERSION} of GNU Wget, the freely
90 available utility for network download.
92 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
96 * Overview:: Features of Wget.
97 * Invoking:: Wget command-line arguments.
98 * Recursive Retrieval:: Description of recursive retrieval.
99 * Following Links:: The available methods of chasing links.
100 * Time-Stamping:: Mirroring according to time-stamps.
101 * Startup File:: Wget's initialization file.
102 * Examples:: Examples of usage.
103 * Various:: The stuff that doesn't fit anywhere else.
104 * Appendices:: Some useful references.
105 * Copying:: You may give out copies of Wget and of this manual.
106 * Concept Index:: Topics covered by this manual.
110 @node Overview, Invoking, Top, Top
115 @c man begin DESCRIPTION
116 GNU Wget is a free utility for non-interactive download of files from
117 the Web. It supports @sc{http}, @sc{https}, and @sc{ftp} protocols, as
118 well as retrieval through @sc{http} proxies.
121 This chapter is a partial overview of Wget's features.
125 @c man begin DESCRIPTION
126 Wget is non-interactive, meaning that it can work in the background,
127 while the user is not logged on. This allows you to start a retrieval
128 and disconnect from the system, letting Wget finish the work. By
129 contrast, most of the Web browsers require constant user's presence,
130 which can be a great hindrance when transferring a lot of data.
136 @c man begin DESCRIPTION
140 @c man begin DESCRIPTION
141 Wget can follow links in @sc{html} pages and create local versions of
142 remote web sites, fully recreating the directory structure of the
143 original site. This is sometimes referred to as ``recursive
144 downloading.'' While doing that, Wget respects the Robot Exclusion
145 Standard (@file{/robots.txt}). Wget can be instructed to convert the
146 links in downloaded @sc{html} files to the local files for offline
152 File name wildcard matching and recursive mirroring of directories are
153 available when retrieving via @sc{ftp}. Wget can read the time-stamp
154 information given by both @sc{http} and @sc{ftp} servers, and store it
155 locally. Thus Wget can see if the remote file has changed since last
156 retrieval, and automatically retrieve the new version if it has. This
157 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
163 @c man begin DESCRIPTION
167 @c man begin DESCRIPTION
168 Wget has been designed for robustness over slow or unstable network
169 connections; if a download fails due to a network problem, it will
170 keep retrying until the whole file has been retrieved. If the server
171 supports regetting, it will instruct the server to continue the
172 download from where it left off.
177 Wget supports proxy servers, which can lighten the network load, speed
178 up retrieval and provide access behind firewalls. However, if you are
179 behind a firewall that requires that you use a socks style gateway, you
180 can get the socks library and build Wget with support for socks. Wget
181 also supports the passive @sc{ftp} downloading as an option.
185 Builtin features offer mechanisms to tune which links you wish to follow
186 (@pxref{Following Links}).
190 The retrieval is conveniently traced with printing dots, each dot
191 representing a fixed amount of data received (1KB by default). These
192 representations can be customized to your preferences.
196 Most of the features are fully configurable, either through command line
197 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
198 File}). Wget allows you to define @dfn{global} startup files
199 (@file{/usr/local/etc/wgetrc} by default) for site settings.
204 @item /usr/local/etc/wgetrc
205 Default location of the @dfn{global} startup file.
215 Finally, GNU Wget is free software. This means that everyone may use
216 it, redistribute it and/or modify it under the terms of the GNU General
217 Public License, as published by the Free Software Foundation
221 @node Invoking, Recursive Retrieval, Overview, Top
228 By default, Wget is very simple to invoke. The basic syntax is:
231 @c man begin SYNOPSIS
232 wget [@var{option}]@dots{} [@var{URL}]@dots{}
236 Wget will simply download all the @sc{url}s specified on the command
237 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
239 However, you may wish to change some of the default parameters of
240 Wget. You can do it two ways: permanently, adding the appropriate
241 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
247 * Basic Startup Options::
248 * Logging and Input File Options::
250 * Directory Options::
253 * Recursive Retrieval Options::
254 * Recursive Accept/Reject Options::
257 @node URL Format, Option Syntax, Invoking, Invoking
262 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
263 resource locator is a compact string representation for a resource
264 available via the Internet. Wget recognizes the @sc{url} syntax as per
265 @sc{rfc1738}. This is the most widely used form (square brackets denote
269 http://host[:port]/directory/file
270 ftp://host[:port]/directory/file
273 You can also encode your username and password within a @sc{url}:
276 ftp://user:password@@host/path
277 http://user:password@@host/path
280 Either @var{user} or @var{password}, or both, may be left out. If you
281 leave out either the @sc{http} username or password, no authentication
282 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
283 will be used. If you leave out the @sc{ftp} password, your email
284 address will be supplied as a default password.@footnote{If you have a
285 @file{.netrc} file in your home directory, password will also be
288 @strong{Important Note}: if you specify a password-containing @sc{url}
289 on the command line, the username and password will be plainly visible
290 to all users on the system, by way of @code{ps}. On multi-user systems,
291 this is a big security risk. To work around it, use @code{wget -i -}
292 and feed the @sc{url}s to Wget's standard input, each on a separate
293 line, terminated by @kbd{C-d}.
295 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
296 being the hexadecimal representation of the character's @sc{ascii}
297 value. Some common unsafe characters include @samp{%} (quoted as
298 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
299 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
302 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
303 default, @sc{ftp} documents are retrieved in the binary mode (type
304 @samp{i}), which means that they are downloaded unchanged. Another
305 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
306 delimiters between the different operating systems, and is thus useful
307 for text files. Here is an example:
310 ftp://host/directory/file;type=a
313 Two alternative variants of @sc{url} specification are also supported,
314 because of historical (hysterical?) reasons and their widespreaded use.
316 @sc{ftp}-only syntax (supported by @code{NcFTP}):
321 @sc{http}-only syntax (introduced by @code{Netscape}):
326 These two alternative forms are deprecated, and may cease being
327 supported in the future.
329 If you do not understand the difference between these notations, or do
330 not know which one to use, just use the plain ordinary format you use
331 with your favorite browser, like @code{Lynx} or @code{Netscape}.
333 @node Option Syntax, Basic Startup Options, URL Format, Invoking
334 @section Option Syntax
335 @cindex option syntax
336 @cindex syntax of options
338 Since Wget uses GNU getopts to process its arguments, every option has a
339 short form and a long form. Long options are more convenient to
340 remember, but take time to type. You may freely mix different option
341 styles, or specify options after the command-line arguments. Thus you
345 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
348 The space between the option accepting an argument and the argument may
349 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
351 You may put several options that do not require arguments together,
358 This is a complete equivalent of:
361 wget -d -r -c @var{URL}
364 Since the options can be specified after the arguments, you may
365 terminate them with @samp{--}. So the following will try to download
366 @sc{url} @samp{-x}, reporting failure to @file{log}:
372 The options that accept comma-separated lists all respect the convention
373 that specifying an empty list clears its value. This can be useful to
374 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
375 sets @code{exclude_directories} to @file{/cgi-bin}, the following
376 example will first reset it, and then set it to exclude @file{/~nobody}
377 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
378 (@pxref{Wgetrc Syntax}).
381 wget -X '' -X /~nobody,/~somebody
386 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
387 @section Basic Startup Options
392 Display the version of Wget.
396 Print a help message describing all of Wget's command-line options.
400 Go to background immediately after startup. If no output file is
401 specified via the @samp{-o}, output is redirected to @file{wget-log}.
403 @cindex execute wgetrc command
404 @item -e @var{command}
405 @itemx --execute @var{command}
406 Execute @var{command} as if it were a part of @file{.wgetrc}
407 (@pxref{Startup File}). A command thus invoked will be executed
408 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
412 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
413 @section Logging and Input File Options
418 @item -o @var{logfile}
419 @itemx --output-file=@var{logfile}
420 Log all messages to @var{logfile}. The messages are normally reported
423 @cindex append to log
424 @item -a @var{logfile}
425 @itemx --append-output=@var{logfile}
426 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
427 to @var{logfile} instead of overwriting the old log file. If
428 @var{logfile} does not exist, a new file is created.
433 Turn on debug output, meaning various information important to the
434 developers of Wget if it does not work properly. Your system
435 administrator may have chosen to compile Wget without debug support, in
436 which case @samp{-d} will not work. Please note that compiling with
437 debug support is always safe---Wget compiled with the debug support will
438 @emph{not} print any debug info unless requested with @samp{-d}.
439 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
445 Turn off Wget's output.
450 Turn on verbose output, with all the available data. The default output
455 Non-verbose output---turn off verbose without being completely quiet
456 (use @samp{-q} for that), which means that error messages and basic
457 information still get printed.
461 @itemx --input-file=@var{file}
462 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
463 the command line. If there are @sc{url}s both on the command line and
464 in an input file, those on the command lines will be the first ones to
465 be retrieved. The @var{file} need not be an @sc{html} document (but no
466 harm if it is)---it is enough if the @sc{url}s are just listed
469 However, if you specify @samp{--force-html}, the document will be
470 regarded as @samp{html}. In that case you may have problems with
471 relative links, which you can solve either by adding @code{<base
472 href="@var{url}">} to the documents or by specifying
473 @samp{--base=@var{url}} on the command line.
478 When input is read from a file, force it to be treated as an @sc{html}
479 file. This enables you to retrieve relative links from existing
480 @sc{html} files on your local disk, by adding @code{<base
481 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
484 @cindex base for relative links in input file
486 @itemx --base=@var{URL}
487 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
488 links in the file specified by @samp{-i}.
491 @node Download Options, Directory Options, Logging and Input File Options, Invoking
492 @section Download Options
495 @cindex bind() address
496 @cindex client IP address
497 @cindex IP address, client
498 @item --bind-address=@var{ADDRESS}
499 When making client TCP/IP connections, @code{bind()} to @var{ADDRESS} on
500 the local machine. @var{ADDRESS} may be specified as a hostname or IP
501 address. This option can be useful if your machine is bound to multiple
506 @cindex number of retries
507 @item -t @var{number}
508 @itemx --tries=@var{number}
509 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
513 @itemx --output-document=@var{file}
514 The documents will not be written to the appropriate files, but all will
515 be concatenated together and written to @var{file}. If @var{file}
516 already exists, it will be overwritten. If the @var{file} is @samp{-},
517 the documents will be written to standard output. Including this option
518 automatically sets the number of tries to 1.
520 @cindex clobbering, file
521 @cindex downloading multiple times
525 If a file is downloaded more than once in the same directory, Wget's
526 behavior depends on a few options, including @samp{-nc}. In certain
527 cases, the local file will be @dfn{clobbered}, or overwritten, upon
528 repeated download. In other cases it will be preserved.
530 When running Wget without @samp{-N}, @samp{-nc}, or @samp{-r},
531 downloading the same file in the same directory will result in the
532 original copy of @var{file} being preserved and the second copy being
533 named @samp{@var{file}.1}. If that file is downloaded yet again, the
534 third copy will be named @samp{@var{file}.2}, and so on. When
535 @samp{-nc} is specified, this behavior is suppressed, and Wget will
536 refuse to download newer copies of @samp{@var{file}}. Therefore,
537 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
538 clobbering that's prevented (as the numeric suffixes were already
539 preventing clobbering), but rather the multiple version saving that's
542 When running Wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
543 re-downloading a file will result in the new copy simply overwriting the
544 old. Adding @samp{-nc} will prevent this behavior, instead causing the
545 original version to be preserved and any newer copies on the server to
548 When running Wget with @samp{-N}, with or without @samp{-r}, the
549 decision as to whether or not to download a newer copy of a file depends
550 on the local and remote timestamp and size of the file
551 (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the same
554 Note that when @samp{-nc} is specified, files with the suffixes
555 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
556 and parsed as if they had been retrieved from the Web.
558 @cindex continue retrieval
559 @cindex incomplete downloads
560 @cindex resume download
563 Continue getting a partially-downloaded file. This is useful when you
564 want to finish up a download started by a previous instance of Wget, or
565 by another program. For instance:
568 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
571 If there is a file named @file{ls-lR.Z} in the current directory, Wget
572 will assume that it is the first portion of the remote file, and will
573 ask the server to continue the retrieval from an offset equal to the
574 length of the local file.
576 Note that you don't need to specify this option if you just want the
577 current invocation of Wget to retry downloading a file should the
578 connection be lost midway through. This is the default behavior.
579 @samp{-c} only affects resumption of downloads started @emph{prior} to
580 this invocation of Wget, and whose local files are still sitting around.
582 Without @samp{-c}, the previous example would just download the remote
583 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
586 Beginning with Wget 1.7, if you use @samp{-c} on a non-empty file, and
587 it turns out that the server does not support continued downloading,
588 Wget will refuse to start the download from scratch, which would
589 effectively ruin existing contents. If you really want the download to
590 start from scratch, remove the file.
592 Also beginning with Wget 1.7, if you use @samp{-c} on a file which is of
593 equal size as the one on the server, Wget will refuse to download the
594 file and print an explanatory message. The same happens when the file
595 is smaller on the server than locally (presumably because it was changed
596 on the server since your last download attempt)---because ``continuing''
597 is not meaningful, no download occurs.
599 On the other side of the coin, while using @samp{-c}, any file that's
600 bigger on the server than locally will be considered an incomplete
601 download and only @code{(length(remote) - length(local))} bytes will be
602 downloaded and tacked onto the end of the local file. This behavior can
603 be desirable in certain cases---for instance, you can use @samp{wget -c}
604 to download just the new portion that's been appended to a data
605 collection or log file.
607 However, if the file is bigger on the server because it's been
608 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
609 with a garbled file. Wget has no way of verifying that the local file
610 is really a valid prefix of the remote file. You need to be especially
611 careful of this when using @samp{-c} in conjunction with @samp{-r},
612 since every file will be considered as an "incomplete download" candidate.
614 Another instance where you'll get a garbled file if you try to use
615 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
616 ``transfer interrupted'' string into the local file. In the future a
617 ``rollback'' option may be added to deal with this case.
619 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
620 servers that support the @code{Range} header.
622 @cindex progress indicator
624 @item --progress=@var{type}
625 Select the type of the progress indicator you wish to use. Legal
626 indicators are ``dot'' and ``bar''.
628 The ``bar'' indicator is used by default. It draws an ASCII progress
629 bar graphics (a.k.a ``thermometer'' display) indicating the status of
630 retrieval. If the output is not a TTY, the ``dot'' bar will be used by
633 Use @samp{--progress=dot} to switch to the ``dot'' display. It traces
634 the retrieval by printing dots on the screen, each dot representing a
635 fixed amount of downloaded data.
637 When using the dotted retrieval, you may also set the @dfn{style} by
638 specifying the type as @samp{dot:@var{style}}. Different styles assign
639 different meaning to one dot. With the @code{default} style each dot
640 represents 1K, there are ten dots in a cluster and 50 dots in a line.
641 The @code{binary} style has a more ``computer''-like orientation---8K
642 dots, 16-dots clusters and 48 dots per line (which makes for 384K
643 lines). The @code{mega} style is suitable for downloading very large
644 files---each dot represents 64K retrieved, there are eight dots in a
645 cluster, and 48 dots on each line (so each line contains 3M).
647 Note that you can set the default style using the @code{progress}
648 command in @file{.wgetrc}. That setting may be overridden from the
649 command line. The exception is that, when the output is not a TTY, the
650 ``dot'' progress will be favored over ``bar''. To force the bar output,
651 use @samp{--progress=bar:force}.
654 @itemx --timestamping
655 Turn on time-stamping. @xref{Time-Stamping}, for details.
657 @cindex server response, print
659 @itemx --server-response
660 Print the headers sent by @sc{http} servers and responses sent by
663 @cindex Wget as spider
666 When invoked with this option, Wget will behave as a Web @dfn{spider},
667 which means that it will not download the pages, just check that they
668 are there. You can use it to check your bookmarks, e.g. with:
671 wget --spider --force-html -i bookmarks.html
674 This feature needs much more work for Wget to get close to the
675 functionality of real @sc{www} spiders.
679 @itemx --timeout=@var{seconds}
680 Set the network timeout to @var{seconds} seconds. Whenever Wget
681 connects to or reads from a remote host, it checks for a timeout and
682 aborts the operation if the time expires. This prevents anomalous
683 occurrences such as hanging reads or infinite connects. The default
684 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
685 disable checking for timeouts.
687 Please do not lower the default timeout value with this option unless
688 you know what you are doing.
690 @cindex bandwidth, limit
692 @cindex limit bandwidth
693 @item --limit-rate=@var{amount}
694 Limit the download speed to @var{amount} bytes per second. Amount may
695 be expressed in bytes, kilobytes with the @samp{k} suffix, or megabytes
696 with the @samp{m} suffix. For example, @samp{--limit-rate=20k} will
697 limit the retrieval rate to 20KB/s. This kind of thing is useful when,
698 for whatever reason, you don't want Wget to consume the entire evailable
701 Note that Wget implementeds the limiting by sleeping the appropriate
702 amount of time after a network read that took less time than specified
703 by the rate. Eventually this strategy causes the TCP transfer to slow
704 down to approximately the specified rate. However, it takes some time
705 for this balance to be achieved, so don't be surprised if limiting the
706 rate doesn't work with very small files. Also, the "sleeping" strategy
707 will misfire when an extremely small bandwidth, say less than 1.5KB/s,
712 @item -w @var{seconds}
713 @itemx --wait=@var{seconds}
714 Wait the specified number of seconds between the retrievals. Use of
715 this option is recommended, as it lightens the server load by making the
716 requests less frequent. Instead of in seconds, the time can be
717 specified in minutes using the @code{m} suffix, in hours using @code{h}
718 suffix, or in days using @code{d} suffix.
720 Specifying a large value for this option is useful if the network or the
721 destination host is down, so that Wget can wait long enough to
722 reasonably expect the network error to be fixed before the retry.
724 @cindex retries, waiting between
725 @cindex waiting between retries
726 @item --waitretry=@var{seconds}
727 If you don't want Wget to wait between @emph{every} retrieval, but only
728 between retries of failed downloads, you can use this option. Wget will
729 use @dfn{linear backoff}, waiting 1 second after the first failure on a
730 given file, then waiting 2 seconds after the second failure on that
731 file, up to the maximum number of @var{seconds} you specify. Therefore,
732 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
735 Note that this option is turned on by default in the global
741 Some web sites may perform log analysis to identify retrieval programs
742 such as Wget by looking for statistically significant similarities in
743 the time between requests. This option causes the time between requests
744 to vary between 0 and 2 * @var{wait} seconds, where @var{wait} was
745 specified using the @samp{-w} or @samp{--wait} options, in order to mask
746 Wget's presence from such analysis.
748 A recent article in a publication devoted to development on a popular
749 consumer platform provided code to perform this analysis on the fly.
750 Its author suggested blocking at the class C address level to ensure
751 automated retrieval programs were blocked despite changing DHCP-supplied
754 The @samp{--random-wait} option was inspired by this ill-advised
755 recommendation to block many unrelated users from a web site due to the
760 @itemx --proxy=on/off
761 Turn proxy support on or off. The proxy is on by default if the
762 appropriate environmental variable is defined.
766 @itemx --quota=@var{quota}
767 Specify download quota for automatic retrievals. The value can be
768 specified in bytes (default), kilobytes (with @samp{k} suffix), or
769 megabytes (with @samp{m} suffix).
771 Note that quota will never affect downloading a single file. So if you
772 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
773 @file{ls-lR.gz} will be downloaded. The same goes even when several
774 @sc{url}s are specified on the command-line. However, quota is
775 respected when retrieving either recursively, or from an input file.
776 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
777 aborted when the quota is exceeded.
779 Setting quota to 0 or to @samp{inf} unlimits the download quota.
782 @node Directory Options, HTTP Options, Download Options, Invoking
783 @section Directory Options
787 @itemx --no-directories
788 Do not create a hierarchy of directories when retrieving recursively.
789 With this option turned on, all files will get saved to the current
790 directory, without clobbering (if a name shows up more than once, the
791 filenames will get extensions @samp{.n}).
794 @itemx --force-directories
795 The opposite of @samp{-nd}---create a hierarchy of directories, even if
796 one would not have been created otherwise. E.g. @samp{wget -x
797 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
798 @file{fly.srk.fer.hr/robots.txt}.
801 @itemx --no-host-directories
802 Disable generation of host-prefixed directories. By default, invoking
803 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
804 directories beginning with @file{fly.srk.fer.hr/}. This option disables
807 @cindex cut directories
808 @item --cut-dirs=@var{number}
809 Ignore @var{number} directory components. This is useful for getting a
810 fine-grained control over the directory where recursive retrieval will
813 Take, for example, the directory at
814 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
815 @samp{-r}, it will be saved locally under
816 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
817 remove the @file{ftp.xemacs.org/} part, you are still stuck with
818 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
819 makes Wget not ``see'' @var{number} remote directory components. Here
820 are several examples of how @samp{--cut-dirs} option works.
824 No options -> ftp.xemacs.org/pub/xemacs/
826 -nH --cut-dirs=1 -> xemacs/
827 -nH --cut-dirs=2 -> .
829 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
834 If you just want to get rid of the directory structure, this option is
835 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
836 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
837 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
838 be placed to @file{xemacs/beta}, as one would expect.
840 @cindex directory prefix
841 @item -P @var{prefix}
842 @itemx --directory-prefix=@var{prefix}
843 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
844 directory where all other files and subdirectories will be saved to,
845 i.e. the top of the retrieval tree. The default is @samp{.} (the
849 @node HTTP Options, FTP Options, Directory Options, Invoking
850 @section HTTP Options
853 @cindex .html extension
855 @itemx --html-extension
856 If a file of type @samp{text/html} is downloaded and the URL does not
857 end with the regexp @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause
858 the suffix @samp{.html} to be appended to the local filename. This is
859 useful, for instance, when you're mirroring a remote site that uses
860 @samp{.asp} pages, but you want the mirrored pages to be viewable on
861 your stock Apache server. Another good use for this is when you're
862 downloading the output of CGIs. A URL like
863 @samp{http://site.com/article.cgi?25} will be saved as
864 @file{article.cgi?25.html}.
866 Note that filenames changed in this way will be re-downloaded every time
867 you re-mirror a site, because Wget can't tell that the local
868 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
869 it doesn't yet know that the URL produces output of type
870 @samp{text/html}. To prevent this re-downloading, you must use
871 @samp{-k} and @samp{-K} so that the original version of the file will be
872 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
875 @cindex http password
876 @cindex authentication
877 @item --http-user=@var{user}
878 @itemx --http-passwd=@var{password}
879 Specify the username @var{user} and password @var{password} on an
880 @sc{http} server. According to the type of the challenge, Wget will
881 encode them using either the @code{basic} (insecure) or the
882 @code{digest} authentication scheme.
884 Another way to specify username and password is in the @sc{url} itself
885 (@pxref{URL Format}). Either method reveals your password to anyone who
886 bothers to run @code{ps}. To prevent the passwords from being seen,
887 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
888 those files from other users with @code{chmod}. If the passwords are
889 really important, do not leave them lying in those files either---edit
890 the files and delete them after Wget has started the download.
892 For more information about security issues with Wget, @xref{Security
898 @itemx --cache=on/off
899 When set to off, disable server-side cache. In this case, Wget will
900 send the remote server an appropriate directive (@samp{Pragma:
901 no-cache}) to get the file from the remote service, rather than
902 returning the cached version. This is especially useful for retrieving
903 and flushing out-of-date documents on proxy servers.
905 Caching is allowed by default.
908 @item --cookies=on/off
909 When set to off, disable the use of cookies. Cookies are a mechanism
910 for maintaining server-side state. The server sends the client a cookie
911 using the @code{Set-Cookie} header, and the client responds with the
912 same cookie upon further requests. Since cookies allow the server
913 owners to keep track of visitors and for sites to exchange this
914 information, some consider them a breach of privacy. The default is to
915 use cookies; however, @emph{storing} cookies is not on by default.
917 @cindex loading cookies
918 @cindex cookies, loading
919 @item --load-cookies @var{file}
920 Load cookies from @var{file} before the first HTTP retrieval.
921 @var{file} is a textual file in the format originally used by Netscape's
922 @file{cookies.txt} file.
924 You will typically use this option when mirroring sites that require
925 that you be logged in to access some or all of their content. The login
926 process typically works by the web server issuing an @sc{http} cookie
927 upon receiving and verifying your credentials. The cookie is then
928 resent by the browser when accessing that part of the site, and so
929 proves your identity.
931 Mirroring such a site requires Wget to send the same cookies your
932 browser sends when communicating with the site. This is achieved by
933 @samp{--load-cookies}---simply point Wget to the location of the
934 @file{cookies.txt} file, and it will send the same cookies your browser
935 would send in the same situation. Different browsers keep textual
936 cookie files in different locations:
940 The cookies are in @file{~/.netscape/cookies.txt}.
942 @item Mozilla and Netscape 6.x.
943 Mozilla's cookie file is also named @file{cookies.txt}, located
944 somewhere under @file{~/.mozilla}, in the directory of your profile.
945 The full path usually ends up looking somewhat like
946 @file{~/.mozilla/default/@var{some-weird-string}/cookies.txt}.
948 @item Internet Explorer.
949 You can produce a cookie file Wget can use by using the File menu,
950 Import and Export, Export Cookies. This has been tested with Internet
951 Explorer 5; it is not guaranteed to work with earlier versions.
953 @item Other browsers.
954 If you are using a different browser to create your cookies,
955 @samp{--load-cookies} will only work if you can locate or produce a
956 cookie file in the Netscape format that Wget expects.
959 If you cannot use @samp{--load-cookies}, there might still be an
960 alternative. If your browser supports a ``cookie manager'', you can use
961 it to view the cookies used when accessing the site you're mirroring.
962 Write down the name and value of the cookie, and manually instruct Wget
963 to send those cookies, bypassing the ``official'' cookie support:
966 wget --cookies=off --header "Cookie: @var{name}=@var{value}"
969 @cindex saving cookies
970 @cindex cookies, saving
971 @item --save-cookies @var{file}
972 Save cookies from @var{file} at the end of session. Cookies whose
973 expiry time is not specified, or those that have already expired, are
976 @cindex Content-Length, ignore
977 @cindex ignore length
978 @item --ignore-length
979 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
980 precise) send out bogus @code{Content-Length} headers, which makes Wget
981 go wild, as it thinks not all the document was retrieved. You can spot
982 this syndrome if Wget retries getting the same document again and again,
983 each time claiming that the (otherwise normal) connection has closed on
986 With this option, Wget will ignore the @code{Content-Length} header---as
990 @item --header=@var{additional-header}
991 Define an @var{additional-header} to be passed to the @sc{http} servers.
992 Headers must contain a @samp{:} preceded by one or more non-blank
993 characters, and must not contain newlines.
995 You may define more than one additional header by specifying
996 @samp{--header} more than once.
1000 wget --header='Accept-Charset: iso-8859-2' \
1001 --header='Accept-Language: hr' \
1002 http://fly.srk.fer.hr/
1006 Specification of an empty string as the header value will clear all
1007 previous user-defined headers.
1010 @cindex proxy password
1011 @cindex proxy authentication
1012 @item --proxy-user=@var{user}
1013 @itemx --proxy-passwd=@var{password}
1014 Specify the username @var{user} and password @var{password} for
1015 authentication on a proxy server. Wget will encode them using the
1016 @code{basic} authentication scheme.
1018 Security considerations similar to those with @samp{--http-passwd}
1019 pertain here as well.
1021 @cindex http referer
1022 @cindex referer, http
1023 @item --referer=@var{url}
1024 Include `Referer: @var{url}' header in HTTP request. Useful for
1025 retrieving documents with server-side processing that assume they are
1026 always being retrieved by interactive web browsers and only come out
1027 properly when Referer is set to one of the pages that point to them.
1029 @cindex server response, save
1031 @itemx --save-headers
1032 Save the headers sent by the @sc{http} server to the file, preceding the
1033 actual contents, with an empty line as the separator.
1036 @item -U @var{agent-string}
1037 @itemx --user-agent=@var{agent-string}
1038 Identify as @var{agent-string} to the @sc{http} server.
1040 The @sc{http} protocol allows the clients to identify themselves using a
1041 @code{User-Agent} header field. This enables distinguishing the
1042 @sc{www} software, usually for statistical purposes or for tracing of
1043 protocol violations. Wget normally identifies as
1044 @samp{Wget/@var{version}}, @var{version} being the current version
1047 However, some sites have been known to impose the policy of tailoring
1048 the output according to the @code{User-Agent}-supplied information.
1049 While conceptually this is not such a bad idea, it has been abused by
1050 servers denying information to clients other than @code{Mozilla} or
1051 Microsoft @code{Internet Explorer}. This option allows you to change
1052 the @code{User-Agent} line issued by Wget. Use of this option is
1053 discouraged, unless you really know what you are doing.
1056 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
1057 @section FTP Options
1060 @cindex .listing files, removing
1062 @itemx --dont-remove-listing
1063 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1064 retrievals. Normally, these files contain the raw directory listings
1065 received from @sc{ftp} servers. Not removing them can be useful for
1066 debugging purposes, or when you want to be able to easily check on the
1067 contents of remote server directories (e.g. to verify that a mirror
1068 you're running is complete).
1070 Note that even though Wget writes to a known filename for this file,
1071 this is not a security hole in the scenario of a user making
1072 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1073 asking @code{root} to run Wget in his or her directory. Depending on
1074 the options used, either Wget will refuse to write to @file{.listing},
1075 making the globbing/recursion/time-stamping operation fail, or the
1076 symbolic link will be deleted and replaced with the actual
1077 @file{.listing} file, or the listing will be written to a
1078 @file{.listing.@var{number}} file.
1080 Even though this situation isn't a problem, though, @code{root} should
1081 never run Wget in a non-trusted user's directory. A user could do
1082 something as simple as linking @file{index.html} to @file{/etc/passwd}
1083 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1084 will be overwritten.
1086 @cindex globbing, toggle
1088 @itemx --glob=on/off
1089 Turn @sc{ftp} globbing on or off. Globbing means you may use the
1090 shell-like special characters (@dfn{wildcards}), like @samp{*},
1091 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
1092 same directory at once, like:
1095 wget ftp://gnjilux.srk.fer.hr/*.msg
1098 By default, globbing will be turned on if the @sc{url} contains a
1099 globbing character. This option may be used to turn globbing on or off
1102 You may have to quote the @sc{url} to protect it from being expanded by
1103 your shell. Globbing makes Wget look for a directory listing, which is
1104 system-specific. This is why it currently works only with Unix @sc{ftp}
1105 servers (and the ones emulating Unix @code{ls} output).
1109 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
1110 initiates the data connection. This is sometimes required for @sc{ftp}
1111 to work behind firewalls.
1113 @cindex symbolic links, retrieving
1114 @item --retr-symlinks
1115 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1116 link is encountered, the linked-to file is not downloaded. Instead, a
1117 matching symbolic link is created on the local filesystem. The
1118 pointed-to file will not be downloaded unless this recursive retrieval
1119 would have encountered it separately and downloaded it anyway.
1121 When @samp{--retr-symlinks} is specified, however, symbolic links are
1122 traversed and the pointed-to files are retrieved. At this time, this
1123 option does not cause Wget to traverse symlinks to directories and
1124 recurse through them, but in the future it should be enhanced to do
1127 Note that when retrieving a file (not a directory) because it was
1128 specified on the commandline, rather than because it was recursed to,
1129 this option has no effect. Symbolic links are always traversed in this
1133 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
1134 @section Recursive Retrieval Options
1139 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
1142 @item -l @var{depth}
1143 @itemx --level=@var{depth}
1144 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1145 Retrieval}). The default maximum depth is 5.
1147 @cindex proxy filling
1148 @cindex delete after retrieval
1149 @cindex filling proxy cache
1150 @item --delete-after
1151 This option tells Wget to delete every single file it downloads,
1152 @emph{after} having done so. It is useful for pre-fetching popular
1153 pages through a proxy, e.g.:
1156 wget -r -nd --delete-after http://whatever.com/~popular/page/
1159 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1162 Note that @samp{--delete-after} deletes files on the local machine. It
1163 does not issue the @samp{DELE} command to remote FTP sites, for
1164 instance. Also note that when @samp{--delete-after} is specified,
1165 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1166 created in the first place.
1168 @cindex conversion of links
1169 @cindex link conversion
1171 @itemx --convert-links
1172 After the download is complete, convert the links in the document to
1173 make them suitable for local viewing. This affects not only the visible
1174 hyperlinks, but any part of the document that links to external content,
1175 such as embedded images, links to style sheets, hyperlinks to non-HTML
1178 Each link will be changed in one of the two ways:
1182 The links to files that have been downloaded by Wget will be changed to
1183 refer to the file they point to as a relative link.
1185 Example: if the downloaded file @file{/foo/doc.html} links to
1186 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1187 will be modified to point to @samp{../bar/img.gif}. This kind of
1188 transformation works reliably for arbitrary combinations of directories.
1191 The links to files that have not been downloaded by Wget will be changed
1192 to include host name and absolute path of the location they point to.
1194 Example: if the downloaded file @file{/foo/doc.html} links to
1195 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1196 @file{doc.html} will be modified to point to
1197 @file{http://@var{hostname}/bar/img.gif}.
1200 Because of this, local browsing works reliably: if a linked file was
1201 downloaded, the link will refer to its local name; if it was not
1202 downloaded, the link will refer to its full Internet address rather than
1203 presenting a broken link. The fact that the former links are converted
1204 to relative links ensures that you can move the downloaded hierarchy to
1207 Note that only at the end of the download can Wget know which links have
1208 been downloaded. Because of that, the work done by @samp{-k} will be
1209 performed at the end of all the downloads.
1211 @cindex backing up converted files
1213 @itemx --backup-converted
1214 When converting a file, back up the original version with a @samp{.orig}
1215 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1220 Turn on options suitable for mirroring. This option turns on recursion
1221 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1222 directory listings. It is currently equivalent to
1223 @samp{-r -N -l inf -nr}.
1225 @cindex page requisites
1226 @cindex required images, downloading
1228 @itemx --page-requisites
1229 This option causes Wget to download all the files that are necessary to
1230 properly display a given HTML page. This includes such things as
1231 inlined images, sounds, and referenced stylesheets.
1233 Ordinarily, when downloading a single HTML page, any requisite documents
1234 that may be needed to display it properly are not downloaded. Using
1235 @samp{-r} together with @samp{-l} can help, but since Wget does not
1236 ordinarily distinguish between external and inlined documents, one is
1237 generally left with ``leaf documents'' that are missing their
1240 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1241 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1242 document @file{2.html}. Say that @file{2.html} is similar but that its
1243 image is @file{2.gif} and it links to @file{3.html}. Say this
1244 continues up to some arbitrarily high number.
1246 If one executes the command:
1249 wget -r -l 2 http://@var{site}/1.html
1252 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1253 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1254 without its requisite @file{3.gif} because Wget is simply counting the
1255 number of hops (up to 2) away from @file{1.html} in order to determine
1256 where to stop the recursion. However, with this command:
1259 wget -r -l 2 -p http://@var{site}/1.html
1262 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1263 will be downloaded. Similarly,
1266 wget -r -l 1 -p http://@var{site}/1.html
1269 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1270 to be downloaded. One might think that:
1273 wget -r -l 0 -p http://@var{site}/1.html
1276 would download just @file{1.html} and @file{1.gif}, but unfortunately
1277 this is not the case, because @samp{-l 0} is equivalent to
1278 @samp{-l inf}---that is, infinite recursion. To download a single HTML
1279 page (or a handful of them, all specified on the commandline or in a
1280 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1281 @samp{-r} and @samp{-l}:
1284 wget -p http://@var{site}/1.html
1287 Note that Wget will behave as if @samp{-r} had been specified, but only
1288 that single page and its requisites will be downloaded. Links from that
1289 page to external documents will not be followed. Actually, to download
1290 a single page and all its requisites (even if they exist on separate
1291 websites), and make sure the lot displays properly locally, this author
1292 likes to use a few options in addition to @samp{-p}:
1295 wget -E -H -k -K -p http://@var{site}/@var{document}
1298 To finish off this topic, it's worth knowing that Wget's idea of an
1299 external document link is any URL specified in an @code{<A>} tag, an
1300 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1304 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1305 @section Recursive Accept/Reject Options
1308 @item -A @var{acclist} --accept @var{acclist}
1309 @itemx -R @var{rejlist} --reject @var{rejlist}
1310 Specify comma-separated lists of file name suffixes or patterns to
1311 accept or reject (@pxref{Types of Files} for more details).
1313 @item -D @var{domain-list}
1314 @itemx --domains=@var{domain-list}
1315 Set domains to be followed. @var{domain-list} is a comma-separated list
1316 of domains. Note that it does @emph{not} turn on @samp{-H}.
1318 @item --exclude-domains @var{domain-list}
1319 Specify the domains that are @emph{not} to be followed.
1320 (@pxref{Spanning Hosts}).
1322 @cindex follow FTP links
1324 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1325 Wget will ignore all the @sc{ftp} links.
1327 @cindex tag-based recursive pruning
1328 @item --follow-tags=@var{list}
1329 Wget has an internal table of HTML tag / attribute pairs that it
1330 considers when looking for linked documents during a recursive
1331 retrieval. If a user wants only a subset of those tags to be
1332 considered, however, he or she should be specify such tags in a
1333 comma-separated @var{list} with this option.
1336 @itemx --ignore-tags=@var{list}
1337 This is the opposite of the @samp{--follow-tags} option. To skip
1338 certain HTML tags when recursively looking for documents to download,
1339 specify them in a comma-separated @var{list}.
1341 In the past, the @samp{-G} option was the best bet for downloading a
1342 single page and its requisites, using a commandline like:
1345 wget -Ga,area -H -k -K -r http://@var{site}/@var{document}
1348 However, the author of this option came across a page with tags like
1349 @code{<LINK REL="home" HREF="/">} and came to the realization that
1350 @samp{-G} was not enough. One can't just tell Wget to ignore
1351 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1352 best bet for downloading a single page and its requisites is the
1353 dedicated @samp{--page-requisites} option.
1357 Enable spanning across hosts when doing recursive retrieving
1358 (@pxref{Spanning Hosts}).
1362 Follow relative links only. Useful for retrieving a specific home page
1363 without any distractions, not even those from the same hosts
1364 (@pxref{Relative Links}).
1367 @itemx --include-directories=@var{list}
1368 Specify a comma-separated list of directories you wish to follow when
1369 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1370 of @var{list} may contain wildcards.
1373 @itemx --exclude-directories=@var{list}
1374 Specify a comma-separated list of directories you wish to exclude from
1375 download (@pxref{Directory-Based Limits} for more details.) Elements of
1376 @var{list} may contain wildcards.
1380 Do not ever ascend to the parent directory when retrieving recursively.
1381 This is a useful option, since it guarantees that only the files
1382 @emph{below} a certain hierarchy will be downloaded.
1383 @xref{Directory-Based Limits}, for more details.
1388 @node Recursive Retrieval, Following Links, Invoking, Top
1389 @chapter Recursive Retrieval
1392 @cindex recursive retrieval
1394 GNU Wget is capable of traversing parts of the Web (or a single
1395 @sc{http} or @sc{ftp} server), following links and directory structure.
1396 We refer to this as to @dfn{recursive retrieving}, or @dfn{recursion}.
1398 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1399 the given @sc{url}, documents, retrieving the files the @sc{html}
1400 document was referring to, through markups like @code{href}, or
1401 @code{src}. If the freshly downloaded file is also of type
1402 @code{text/html}, it will be parsed and followed further.
1404 Recursive retrieval of @sc{http} and @sc{html} content is
1405 @dfn{breadth-first}. This means that Wget first downloads the requested
1406 HTML document, then the documents linked from that document, then the
1407 documents linked by them, and so on. In other words, Wget first
1408 downloads the documents at depth 1, then those at depth 2, and so on
1409 until the specified maximum depth.
1411 The maximum @dfn{depth} to which the retrieval may descend is specified
1412 with the @samp{-l} option. The default maximum depth is five layers.
1414 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1415 the data from the given directory tree (including the subdirectories up
1416 to the specified depth) on the remote server, creating its mirror image
1417 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1418 parameter. Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1421 By default, Wget will create a local directory tree, corresponding to
1422 the one found on the remote server.
1424 Recursive retrieving can find a number of applications, the most
1425 important of which is mirroring. It is also useful for @sc{www}
1426 presentations, and any other opportunities where slow network
1427 connections should be bypassed by storing the files locally.
1429 You should be warned that recursive downloads can overload the remote
1430 servers. Because of that, many administrators frown upon them and may
1431 ban access from your site if they detect very fast downloads of big
1432 amounts of content. When downloading from Internet servers, consider
1433 using the @samp{-w} option to introduce a delay between accesses to the
1434 server. The download will take a while longer, but the server
1435 administrator will not be alarmed by your rudeness.
1437 Of course, recursive download may cause problems on your machine. If
1438 left to run unchecked, it can easily fill up the disk. If downloading
1439 from local network, it can also take bandwidth on the system, as well as
1440 consume memory and CPU.
1442 Try to specify the criteria that match the kind of download you are
1443 trying to achieve. If you want to download only one page, use
1444 @samp{--page-requisites} without any additional recursion. If you want
1445 to download things under one directory, use @samp{-np} to avoid
1446 downloading things from other directories. If you want to download all
1447 the files from one directory, use @samp{-l 1} to make sure the recursion
1448 depth never exceeds one. @xref{Following Links}, for more information
1451 Recursive retrieval should be used with care. Don't say you were not
1454 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1455 @chapter Following Links
1457 @cindex following links
1459 When retrieving recursively, one does not wish to retrieve loads of
1460 unnecessary data. Most of the time the users bear in mind exactly what
1461 they want to download, and want Wget to follow only specific links.
1463 For example, if you wish to download the music archive from
1464 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1465 that happen to be referenced by an obscure part of the archive.
1467 Wget possesses several mechanisms that allows you to fine-tune which
1468 links it will follow.
1471 * Spanning Hosts:: (Un)limiting retrieval based on host name.
1472 * Types of Files:: Getting only certain files.
1473 * Directory-Based Limits:: Getting only certain directories.
1474 * Relative Links:: Follow relative links only.
1475 * FTP Links:: Following FTP links.
1478 @node Spanning Hosts, Types of Files, Following Links, Following Links
1479 @section Spanning Hosts
1480 @cindex spanning hosts
1481 @cindex hosts, spanning
1483 Wget's recursive retrieval normally refuses to visit hosts different
1484 than the one you specified on the command line. This is a reasonable
1485 default; without it, every retrieval would have the potential to turn
1486 your Wget into a small version of google.
1488 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1489 a useful option. Maybe the images are served from a different server.
1490 Maybe you're mirroring a site that consists of pages interlinked between
1491 three servers. Maybe the server has two equivalent names, and the HTML
1492 pages refer to both interchangeably.
1495 @item Span to any host---@samp{-H}
1497 The @samp{-H} option turns on host spanning, thus allowing Wget's
1498 recursive run to visit any host referenced by a link. Unless sufficient
1499 recursion-limiting criteria are applied depth, these foreign hosts will
1500 typically link to yet more hosts, and so on until Wget ends up sucking
1501 up much more data than you have intended.
1503 @item Limit spanning to certain domains---@samp{-D}
1505 The @samp{-D} option allows you to specify the domains that will be
1506 followed, thus limiting the recursion only to the hosts that belong to
1507 these domains. Obviously, this makes sense only in conjunction with
1508 @samp{-H}. A typical example would be downloading the contents of
1509 @samp{www.server.com}, but allowing downloads from
1510 @samp{images.server.com}, etc.:
1513 wget -rH -Dserver.com http://www.server.com/
1516 You can specify more than one address by separating them with a comma,
1517 e.g. @samp{-Ddomain1.com,domain2.com}.
1519 @item Keep download off certain domains---@samp{--exclude-domains}
1521 If there are domains you want to exclude specifically, you can do it
1522 with @samp{--exclude-domains}, which accepts the same type of arguments
1523 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1524 example, if you want to download all the hosts from @samp{foo.edu}
1525 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1529 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
1535 @node Types of Files, Directory-Based Limits, Spanning Hosts, Following Links
1536 @section Types of Files
1537 @cindex types of files
1539 When downloading material from the web, you will often want to restrict
1540 the retrieval to only certain file types. For example, if you are
1541 interested in downloading @sc{gif}s, you will not be overjoyed to get
1542 loads of PostScript documents, and vice versa.
1544 Wget offers two options to deal with this problem. Each option
1545 description lists a short name, a long name, and the equivalent command
1548 @cindex accept wildcards
1549 @cindex accept suffixes
1550 @cindex wildcards, accept
1551 @cindex suffixes, accept
1553 @item -A @var{acclist}
1554 @itemx --accept @var{acclist}
1555 @itemx accept = @var{acclist}
1556 The argument to @samp{--accept} option is a list of file suffixes or
1557 patterns that Wget will download during recursive retrieval. A suffix
1558 is the ending part of a file, and consists of ``normal'' letters,
1559 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1560 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1562 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1563 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1564 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1565 download only files beginning with @samp{zelazny} and containing numbers
1566 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1567 a description of how pattern matching works.
1569 Of course, any number of suffixes and patterns can be combined into a
1570 comma-separated list, and given as an argument to @samp{-A}.
1572 @cindex reject wildcards
1573 @cindex reject suffixes
1574 @cindex wildcards, reject
1575 @cindex suffixes, reject
1576 @item -R @var{rejlist}
1577 @itemx --reject @var{rejlist}
1578 @itemx reject = @var{rejlist}
1579 The @samp{--reject} option works the same way as @samp{--accept}, only
1580 its logic is the reverse; Wget will download all files @emph{except} the
1581 ones matching the suffixes (or patterns) in the list.
1583 So, if you want to download a whole page except for the cumbersome
1584 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1585 Analogously, to download all files except the ones beginning with
1586 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1587 expansion by the shell.
1590 The @samp{-A} and @samp{-R} options may be combined to achieve even
1591 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1592 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1593 a part of their name, but @emph{not} the PostScript files.
1595 Note that these two options do not affect the downloading of @sc{html}
1596 files; Wget must load all the @sc{html}s to know where to go at
1597 all---recursive retrieval would make no sense otherwise.
1599 @node Directory-Based Limits, Relative Links, Types of Files, Following Links
1600 @section Directory-Based Limits
1602 @cindex directory limits
1604 Regardless of other link-following facilities, it is often useful to
1605 place the restriction of what files to retrieve based on the directories
1606 those files are placed in. There can be many reasons for this---the
1607 home pages may be organized in a reasonable directory structure; or some
1608 directories may contain useless information, e.g. @file{/cgi-bin} or
1609 @file{/dev} directories.
1611 Wget offers three different options to deal with this requirement. Each
1612 option description lists a short name, a long name, and the equivalent
1613 command in @file{.wgetrc}.
1615 @cindex directories, include
1616 @cindex include directories
1617 @cindex accept directories
1620 @itemx --include @var{list}
1621 @itemx include_directories = @var{list}
1622 @samp{-I} option accepts a comma-separated list of directories included
1623 in the retrieval. Any other directories will simply be ignored. The
1624 directories are absolute paths.
1626 So, if you wish to download from @samp{http://host/people/bozo/}
1627 following only links to bozo's colleagues in the @file{/people}
1628 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1631 wget -I /people,/cgi-bin http://host/people/bozo/
1634 @cindex directories, exclude
1635 @cindex exclude directories
1636 @cindex reject directories
1638 @itemx --exclude @var{list}
1639 @itemx exclude_directories = @var{list}
1640 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1641 directories @emph{excluded} from the download. E.g. if you do not want
1642 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1643 /cgi-bin} on the command line.
1645 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1646 to get a better fine-tuning of downloading subdirectories. E.g. if you
1647 want to load all the files from @file{/pub} hierarchy except for
1648 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1653 @itemx no_parent = on
1654 The simplest, and often very useful way of limiting directories is
1655 disallowing retrieval of the links that refer to the hierarchy
1656 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1657 parent directory/directories.
1659 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1660 Using it guarantees that you will never leave the existing hierarchy.
1661 Supposing you issue Wget with:
1664 wget -r --no-parent http://somehost/~luzer/my-archive/
1667 You may rest assured that none of the references to
1668 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1669 followed. Only the archive you are interested in will be downloaded.
1670 Essentially, @samp{--no-parent} is similar to
1671 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1672 intelligent fashion.
1675 @node Relative Links, FTP Links, Directory-Based Limits, Following Links
1676 @section Relative Links
1677 @cindex relative links
1679 When @samp{-L} is turned on, only the relative links are ever followed.
1680 Relative links are here defined those that do not refer to the web
1681 server root. For example, these links are relative:
1685 <a href="foo/bar.gif">
1686 <a href="../foo/bar.gif">
1689 These links are not relative:
1693 <a href="/foo/bar.gif">
1694 <a href="http://www.server.com/foo/bar.gif">
1697 Using this option guarantees that recursive retrieval will not span
1698 hosts, even without @samp{-H}. In simple cases it also allows downloads
1699 to ``just work'' without having to convert links.
1701 This option is probably not very useful and might be removed in a future
1704 @node FTP Links, , Relative Links, Following Links
1705 @section Following FTP Links
1706 @cindex following ftp links
1708 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1709 them to be. @sc{ftp} links in @sc{html} documents are often included
1710 for purposes of reference, and it is often inconvenient to download them
1713 To have @sc{ftp} links followed from @sc{html} documents, you need to
1714 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1715 links will span hosts regardless of @samp{-H} setting. This is logical,
1716 as @sc{ftp} links rarely point to the same host where the @sc{http}
1717 server resides. For similar reasons, the @samp{-L} options has no
1718 effect on such downloads. On the other hand, domain acceptance
1719 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1721 Also note that followed links to @sc{ftp} directories will not be
1722 retrieved recursively further.
1724 @node Time-Stamping, Startup File, Following Links, Top
1725 @chapter Time-Stamping
1726 @cindex time-stamping
1727 @cindex timestamping
1728 @cindex updating the archives
1729 @cindex incremental updating
1731 One of the most important aspects of mirroring information from the
1732 Internet is updating your archives.
1734 Downloading the whole archive again and again, just to replace a few
1735 changed files is expensive, both in terms of wasted bandwidth and money,
1736 and the time to do the update. This is why all the mirroring tools
1737 offer the option of incremental updating.
1739 Such an updating mechanism means that the remote server is scanned in
1740 search of @dfn{new} files. Only those new files will be downloaded in
1741 the place of the old ones.
1743 A file is considered new if one of these two conditions are met:
1747 A file of that name does not already exist locally.
1750 A file of that name does exist, but the remote file was modified more
1751 recently than the local file.
1754 To implement this, the program needs to be aware of the time of last
1755 modification of both local and remote files. We call this information the
1756 @dfn{time-stamp} of a file.
1758 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1759 (@samp{-N}) option, or through @code{timestamping = on} directive in
1760 @file{.wgetrc}. With this option, for each file it intends to download,
1761 Wget will check whether a local file of the same name exists. If it
1762 does, and the remote file is older, Wget will not download it.
1764 If the local file does not exist, or the sizes of the files do not
1765 match, Wget will download the remote file no matter what the time-stamps
1769 * Time-Stamping Usage::
1770 * HTTP Time-Stamping Internals::
1771 * FTP Time-Stamping Internals::
1774 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1775 @section Time-Stamping Usage
1776 @cindex time-stamping usage
1777 @cindex usage, time-stamping
1779 The usage of time-stamping is simple. Say you would like to download a
1780 file so that it keeps its date of modification.
1783 wget -S http://www.gnu.ai.mit.edu/
1786 A simple @code{ls -l} shows that the time stamp on the local file equals
1787 the state of the @code{Last-Modified} header, as returned by the server.
1788 As you can see, the time-stamping info is preserved locally, even
1789 without @samp{-N} (at least for @sc{http}).
1791 Several days later, you would like Wget to check if the remote file has
1792 changed, and download it if it has.
1795 wget -N http://www.gnu.ai.mit.edu/
1798 Wget will ask the server for the last-modified date. If the local file
1799 has the same timestamp as the server, or a newer one, the remote file
1800 will not be re-fetched. However, if the remote file is more recent,
1801 Wget will proceed to fetch it.
1803 The same goes for @sc{ftp}. For example:
1806 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
1809 (The quotes around that URL are to prevent the shell from trying to
1810 interpret the @samp{*}.)
1812 After download, a local directory listing will show that the timestamps
1813 match those on the remote server. Reissuing the command with @samp{-N}
1814 will make Wget re-fetch @emph{only} the files that have been modified
1815 since the last download.
1817 If you wished to mirror the GNU archive every week, you would use a
1818 command like the following, weekly:
1821 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
1824 Note that time-stamping will only work for files for which the server
1825 gives a timestamp. For @sc{http}, this depends on getting a
1826 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
1827 directory listing with dates in a format that Wget can parse
1828 (@pxref{FTP Time-Stamping Internals}).
1830 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1831 @section HTTP Time-Stamping Internals
1832 @cindex http time-stamping
1834 Time-stamping in @sc{http} is implemented by checking of the
1835 @code{Last-Modified} header. If you wish to retrieve the file
1836 @file{foo.html} through @sc{http}, Wget will check whether
1837 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1838 retrieved unconditionally.
1840 If the file does exist locally, Wget will first check its local
1841 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1842 @code{HEAD} request to the remote server, demanding the information on
1845 The @code{Last-Modified} header is examined to find which file was
1846 modified more recently (which makes it ``newer''). If the remote file
1847 is newer, it will be downloaded; if it is older, Wget will give
1848 up.@footnote{As an additional check, Wget will look at the
1849 @code{Content-Length} header, and compare the sizes; if they are not the
1850 same, the remote file will be downloaded no matter what the time-stamp
1853 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1854 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1855 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1856 @samp{@var{X}}, which will always differ if it's been converted by
1857 @samp{--convert-links} (@samp{-k}).
1859 Arguably, @sc{http} time-stamping should be implemented using the
1860 @code{If-Modified-Since} request.
1862 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1863 @section FTP Time-Stamping Internals
1864 @cindex ftp time-stamping
1866 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1867 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
1870 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
1871 @sc{ftp} @code{LIST} command to get a file listing for the directory
1872 containing the desired file(s). It will try to analyze the listing,
1873 treating it like Unix @code{ls -l} output, extracting the time-stamps.
1874 The rest is exactly the same as for @sc{http}. Note that when
1875 retrieving individual files from an @sc{ftp} server without using
1876 globbing or recursion, listing files will not be downloaded (and thus
1877 files will not be time-stamped) unless @samp{-N} is specified.
1879 Assumption that every directory listing is a Unix-style listing may
1880 sound extremely constraining, but in practice it is not, as many
1881 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1882 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1883 defines no standard way to get a file list, let alone the time-stamps.
1884 We can only hope that a future standard will define this.
1886 Another non-standard solution includes the use of @code{MDTM} command
1887 that is supported by some @sc{ftp} servers (including the popular
1888 @code{wu-ftpd}), which returns the exact time of the specified file.
1889 Wget may support this command in the future.
1891 @node Startup File, Examples, Time-Stamping, Top
1892 @chapter Startup File
1893 @cindex startup file
1899 Once you know how to change default settings of Wget through command
1900 line arguments, you may wish to make some of those settings permanent.
1901 You can do that in a convenient way by creating the Wget startup
1902 file---@file{.wgetrc}.
1904 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1905 convenient to have a special facility for storing passwords. Thus Wget
1906 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1907 it. You can find @file{.netrc} format in your system manuals.
1909 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1913 * Wgetrc Location:: Location of various wgetrc files.
1914 * Wgetrc Syntax:: Syntax of wgetrc.
1915 * Wgetrc Commands:: List of available commands.
1916 * Sample Wgetrc:: A wgetrc example.
1919 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1920 @section Wgetrc Location
1921 @cindex wgetrc location
1922 @cindex location of wgetrc
1924 When initializing, Wget will look for a @dfn{global} startup file,
1925 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1926 @file{/usr/local}, if Wget was not installed there) and read commands
1927 from there, if it exists.
1929 Then it will look for the user's file. If the environmental variable
1930 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1931 further attempts will be made.
1933 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1935 The fact that user's settings are loaded after the system-wide ones
1936 means that in case of collision user's wgetrc @emph{overrides} the
1937 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1938 Fascist admins, away!
1940 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1941 @section Wgetrc Syntax
1942 @cindex wgetrc syntax
1943 @cindex syntax of wgetrc
1945 The syntax of a wgetrc command is simple:
1951 The @dfn{variable} will also be called @dfn{command}. Valid
1952 @dfn{values} are different for different commands.
1954 The commands are case-insensitive and underscore-insensitive. Thus
1955 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1956 beginning with @samp{#} and lines containing white-space only are
1959 Commands that expect a comma-separated list will clear the list on an
1960 empty command. So, if you wish to reset the rejection list specified in
1961 global @file{wgetrc}, you can do it with:
1967 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1968 @section Wgetrc Commands
1969 @cindex wgetrc commands
1971 The complete set of commands is listed below. Legal values are listed
1972 after the @samp{=}. Simple Boolean values can be set or unset using
1973 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
1974 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
1975 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
1976 option is set to @samp{always} or @samp{never}, that value will be
1977 locked in for the duration of the Wget invocation---commandline options
1980 Some commands take pseudo-arbitrary values. @var{address} values can be
1981 hostnames or dotted-quad IP addresses. @var{n} can be any positive
1982 integer, or @samp{inf} for infinity, where appropriate. @var{string}
1983 values can be any non-empty string.
1985 Most of these commands have commandline equivalents (@pxref{Invoking}),
1986 though some of the more obscure or rarely used ones do not.
1989 @item accept/reject = @var{string}
1990 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
1992 @item add_hostdir = on/off
1993 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1995 @item continue = on/off
1996 If set to on, force continuation of preexistent partially retrieved
1997 files. See @samp{-c} before setting it.
1999 @item background = on/off
2000 Enable/disable going to background---the same as @samp{-b} (which
2003 @item backup_converted = on/off
2004 Enable/disable saving pre-converted files with the suffix
2005 @samp{.orig}---the same as @samp{-K} (which enables it).
2007 @c @item backups = @var{number}
2008 @c #### Document me!
2010 @item base = @var{string}
2011 Consider relative @sc{url}s in @sc{url} input files forced to be
2012 interpreted as @sc{html} as being relative to @var{string}---the same as
2015 @item bind_address = @var{address}
2016 Bind to @var{address}, like the @samp{--bind-address} option.
2018 @item cache = on/off
2019 When set to off, disallow server-caching. See the @samp{-C} option.
2021 @item convert links = on/off
2022 Convert non-relative links locally. The same as @samp{-k}.
2024 @item cookies = on/off
2025 When set to off, disallow cookies. See the @samp{--cookies} option.
2027 @item load_cookies = @var{file}
2028 Load cookies from @var{file}. See @samp{--load-cookies}.
2030 @item save_cookies = @var{file}
2031 Save cookies to @var{file}. See @samp{--save-cookies}.
2033 @item cut_dirs = @var{n}
2034 Ignore @var{n} remote directory components.
2036 @item debug = on/off
2037 Debug mode, same as @samp{-d}.
2039 @item delete_after = on/off
2040 Delete after download---the same as @samp{--delete-after}.
2042 @item dir_prefix = @var{string}
2043 Top of directory tree---the same as @samp{-P}.
2045 @item dirstruct = on/off
2046 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2049 @item domains = @var{string}
2050 Same as @samp{-D} (@pxref{Spanning Hosts}).
2052 @item dot_bytes = @var{n}
2053 Specify the number of bytes ``contained'' in a dot, as seen throughout
2054 the retrieval (1024 by default). You can postfix the value with
2055 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2056 respectively. With dot settings you can tailor the dot retrieval to
2057 suit your needs, or you can use the predefined @dfn{styles}
2058 (@pxref{Download Options}).
2060 @item dots_in_line = @var{n}
2061 Specify the number of dots that will be printed in each line throughout
2062 the retrieval (50 by default).
2064 @item dot_spacing = @var{n}
2065 Specify the number of dots in a single cluster (10 by default).
2067 @item exclude_directories = @var{string}
2068 Specify a comma-separated list of directories you wish to exclude from
2069 download---the same as @samp{-X} (@pxref{Directory-Based Limits}).
2071 @item exclude_domains = @var{string}
2072 Same as @samp{--exclude-domains} (@pxref{Spanning Hosts}).
2074 @item follow_ftp = on/off
2075 Follow @sc{ftp} links from @sc{html} documents---the same as
2076 @samp{--follow-ftp}.
2078 @item follow_tags = @var{string}
2079 Only follow certain HTML tags when doing a recursive retrieval, just like
2080 @samp{--follow-tags}.
2082 @item force_html = on/off
2083 If set to on, force the input filename to be regarded as an @sc{html}
2084 document---the same as @samp{-F}.
2086 @item ftp_proxy = @var{string}
2087 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2091 Turn globbing on/off---the same as @samp{-g}.
2093 @item header = @var{string}
2094 Define an additional header, like @samp{--header}.
2096 @item html_extension = on/off
2097 Add a @samp{.html} extension to @samp{text/html} files without it, like
2100 @item http_passwd = @var{string}
2101 Set @sc{http} password.
2103 @item http_proxy = @var{string}
2104 Use @var{string} as @sc{http} proxy, instead of the one specified in
2107 @item http_user = @var{string}
2108 Set @sc{http} user to @var{string}.
2110 @item ignore_length = on/off
2111 When set to on, ignore @code{Content-Length} header; the same as
2112 @samp{--ignore-length}.
2114 @item ignore_tags = @var{string}
2115 Ignore certain HTML tags when doing a recursive retrieval, just like
2116 @samp{-G} / @samp{--ignore-tags}.
2118 @item include_directories = @var{string}
2119 Specify a comma-separated list of directories you wish to follow when
2120 downloading---the same as @samp{-I}.
2122 @item input = @var{string}
2123 Read the @sc{url}s from @var{string}, like @samp{-i}.
2125 @item kill_longer = on/off
2126 Consider data longer than specified in content-length header as invalid
2127 (and retry getting it). The default behaviour is to save as much data
2128 as there is, provided there is more than or equal to the value in
2129 @code{Content-Length}.
2131 @item limit_rate = @var{rate}
2132 Limit the download speed to no more than @var{rate} bytes per second.
2133 The same as @samp{--limit-rate}.
2135 @item logfile = @var{string}
2136 Set logfile---the same as @samp{-o}.
2138 @item login = @var{string}
2139 Your user name on the remote machine, for @sc{ftp}. Defaults to
2142 @item mirror = on/off
2143 Turn mirroring on/off. The same as @samp{-m}.
2145 @item netrc = on/off
2146 Turn reading netrc on or off.
2148 @item noclobber = on/off
2151 @item no_parent = on/off
2152 Disallow retrieving outside the directory hierarchy, like
2153 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2155 @item no_proxy = @var{string}
2156 Use @var{string} as the comma-separated list of domains to avoid in
2157 proxy loading, instead of the one specified in environment.
2159 @item output_document = @var{string}
2160 Set the output filename---the same as @samp{-O}.
2162 @item page_requisites = on/off
2163 Download all ancillary documents necessary for a single HTML page to
2164 display properly---the same as @samp{-p}.
2166 @item passive_ftp = on/off/always/never
2167 Set passive @sc{ftp}---the same as @samp{--passive-ftp}. Some scripts
2168 and @samp{.pm} (Perl module) files download files using @samp{wget
2169 --passive-ftp}. If your firewall does not allow this, you can set
2170 @samp{passive_ftp = never} to override the commandline.
2172 @item passwd = @var{string}
2173 Set your @sc{ftp} password to @var{password}. Without this setting, the
2174 password defaults to @samp{username@@hostname.domainname}.
2176 @item progress = @var{string}
2177 Set the type of the progress indicator. Legal types are ``dot'' and
2180 @item proxy_user = @var{string}
2181 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
2183 @item proxy_passwd = @var{string}
2184 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
2186 @item referer = @var{string}
2187 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
2188 was the folks who wrote the @sc{http} spec who got the spelling of
2189 ``referrer'' wrong.)
2191 @item quiet = on/off
2192 Quiet mode---the same as @samp{-q}.
2194 @item quota = @var{quota}
2195 Specify the download quota, which is useful to put in the global
2196 @file{wgetrc}. When download quota is specified, Wget will stop
2197 retrieving after the download sum has become greater than quota. The
2198 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2199 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2200 to 5 mbytes. Note that the user's startup file overrides system
2203 @item reclevel = @var{n}
2204 Recursion level---the same as @samp{-l}.
2206 @item recursive = on/off
2207 Recursive on/off---the same as @samp{-r}.
2209 @item relative_only = on/off
2210 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2213 @item remove_listing = on/off
2214 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2215 to off is the same as @samp{-nr}.
2217 @item retr_symlinks = on/off
2218 When set to on, retrieve symbolic links as if they were plain files; the
2219 same as @samp{--retr-symlinks}.
2221 @item robots = on/off
2222 Specify whether the norobots convention is respected by Wget, ``on'' by
2223 default. This switch controls both the @file{/robots.txt} and the
2224 @samp{nofollow} aspect of the spec. @xref{Robot Exclusion}, for more
2225 details about this. Be sure you know what you are doing before turning
2228 @item server_response = on/off
2229 Choose whether or not to print the @sc{http} and @sc{ftp} server
2230 responses---the same as @samp{-S}.
2232 @item span_hosts = on/off
2235 @item timeout = @var{n}
2236 Set timeout value---the same as @samp{-T}.
2238 @item timestamping = on/off
2239 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2241 @item tries = @var{n}
2242 Set number of retries per @sc{url}---the same as @samp{-t}.
2244 @item use_proxy = on/off
2245 Turn proxy support on/off. The same as @samp{-Y}.
2247 @item verbose = on/off
2248 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2250 @item wait = @var{n}
2251 Wait @var{n} seconds between retrievals---the same as @samp{-w}.
2253 @item waitretry = @var{n}
2254 Wait up to @var{n} seconds between retries of failed retrievals
2255 only---the same as @samp{--waitretry}. Note that this is turned on by
2256 default in the global @file{wgetrc}.
2258 @item randomwait = on/off
2259 Turn random between-request wait times on or off. The same as
2260 @samp{--random-wait}.
2263 @node Sample Wgetrc, , Wgetrc Commands, Startup File
2264 @section Sample Wgetrc
2265 @cindex sample wgetrc
2267 This is the sample initialization file, as given in the distribution.
2268 It is divided in two section---one for global usage (suitable for global
2269 startup file), and one for local usage (suitable for
2270 @file{$HOME/.wgetrc}). Be careful about the things you change.
2272 Note that almost all the lines are commented out. For a command to have
2273 any effect, you must remove the @samp{#} character at the beginning of
2277 @include sample.wgetrc.munged_for_texi_inclusion
2280 @node Examples, Various, Startup File, Top
2284 @c man begin EXAMPLES
2285 The examples are divided into three sections loosely based on their
2289 * Simple Usage:: Simple, basic usage of the program.
2290 * Advanced Usage:: Advanced tips.
2291 * Very Advanced Usage:: The hairy stuff.
2294 @node Simple Usage, Advanced Usage, Examples, Examples
2295 @section Simple Usage
2299 Say you want to download a @sc{url}. Just type:
2302 wget http://fly.srk.fer.hr/
2306 But what will happen if the connection is slow, and the file is lengthy?
2307 The connection will probably fail before the whole file is retrieved,
2308 more than once. In this case, Wget will try getting the file until it
2309 either gets the whole of it, or exceeds the default number of retries
2310 (this being 20). It is easy to change the number of tries to 45, to
2311 insure that the whole file will arrive safely:
2314 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2318 Now let's leave Wget to work in the background, and write its progress
2319 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2320 shall use @samp{-t}.
2323 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2326 The ampersand at the end of the line makes sure that Wget works in the
2327 background. To unlimit the number of retries, use @samp{-t inf}.
2330 The usage of @sc{ftp} is as simple. Wget will take care of login and
2334 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2338 If you specify a directory, Wget will retrieve the directory listing,
2339 parse it and convert it to @sc{html}. Try:
2342 wget ftp://prep.ai.mit.edu/pub/gnu/
2347 @node Advanced Usage, Very Advanced Usage, Simple Usage, Examples
2348 @section Advanced Usage
2352 You have a file that contains the URLs you want to download? Use the
2359 If you specify @samp{-} as file name, the @sc{url}s will be read from
2363 Create a five levels deep mirror image of the GNU web site, with the
2364 same directory structure the original has, with only one try per
2365 document, saving the log of the activities to @file{gnulog}:
2368 wget -r http://www.gnu.org/ -o gnulog
2372 The same as the above, but convert the links in the @sc{html} files to
2373 point to local files, so you can view the documents off-line:
2376 wget --convert-links -r http://www.gnu.org/ -o gnulog
2380 Retrieve only one HTML page, but make sure that all the elements needed
2381 for the page to be displayed, such as inline images and external style
2382 sheets, are also downloaded. Also make sure the downloaded page
2383 references the downloaded links.
2386 wget -p --convert-links http://www.server.com/dir/page.html
2389 The HTML page will be saved to @file{www.server.com/dir/page.html}, and
2390 the images, stylesheets, etc., somewhere under @file{www.server.com/},
2391 depending on where they were on the remote server.
2394 The same as the above, but without the @file{www.server.com/} directory.
2395 In fact, I don't want to have all those random server directories
2396 anyway---just save @emph{all} those files under a @file{download/}
2397 subdirectory of the current directory.
2400 wget -p --convert-links -nH -nd -Pdownload \
2401 http://www.server.com/dir/page.html
2405 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2409 wget -S http://www.lycos.com/
2413 Save the server headers with the file, perhaps for post-processing.
2416 wget -s http://www.lycos.com/
2421 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2425 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
2429 You want to download all the @sc{gif}s from a directory on an @sc{http}
2430 server. You tried @samp{wget http://www.server.com/dir/*.gif}, but that
2431 didn't work because @sc{http} retrieval does not support globbing. In
2435 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
2438 More verbose, but the effect is the same. @samp{-r -l1} means to
2439 retrieve recursively (@pxref{Recursive Retrieval}), with maximum depth
2440 of 1. @samp{--no-parent} means that references to the parent directory
2441 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2442 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2446 Suppose you were in the middle of downloading, when Wget was
2447 interrupted. Now you do not want to clobber the files already present.
2451 wget -nc -r http://www.gnu.org/
2455 If you want to encode your own username and password to @sc{http} or
2456 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2459 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
2462 Note, however, that this usage is not advisable on multi-user systems
2463 because it reveals your password to anyone who looks at the output of
2466 @cindex redirecting output
2468 You would like the output documents to go to standard output instead of
2472 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2475 You can also combine the two options and make pipelines to retrieve the
2476 documents from remote hotlists:
2479 wget -O - http://cool.list.com/ | wget --force-html -i -
2483 @node Very Advanced Usage, , Advanced Usage, Examples
2484 @section Very Advanced Usage
2489 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2490 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2491 for @samp{-r -l inf -N}. You can put Wget in the crontab file asking it
2492 to recheck a site each Sunday:
2496 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
2500 In addition to the above, you want the links to be converted for local
2501 viewing. But, after having read this manual, you know that link
2502 conversion doesn't play well with timestamping, so you also want Wget to
2503 back up the original HTML files before the conversion. Wget invocation
2504 would look like this:
2507 wget --mirror --convert-links --backup-converted \
2508 http://www.gnu.org/ -o /home/me/weeklog
2512 But you've also noticed that local viewing doesn't work all that well
2513 when HTML files are saved under extensions other than @samp{.html},
2514 perhaps because they were served as @file{index.cgi}. So you'd like
2515 Wget to rename all the files served with content-type @samp{text/html}
2516 to @file{@var{name}.html}.
2519 wget --mirror --convert-links --backup-converted \
2520 --html-extension -o /home/me/weeklog \
2524 Or, with less typing:
2527 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
2532 @node Various, Appendices, Examples, Top
2536 This chapter contains all the stuff that could not fit anywhere else.
2539 * Proxies:: Support for proxy servers
2540 * Distribution:: Getting the latest version.
2541 * Mailing List:: Wget mailing list for announcements and discussion.
2542 * Reporting Bugs:: How and where to report bugs.
2543 * Portability:: The systems Wget works on.
2544 * Signals:: Signal-handling performed by Wget.
2547 @node Proxies, Distribution, Various, Various
2551 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2552 data from remote servers to local clients. One typical use of proxies
2553 is lightening network load for users behind a slow connection. This is
2554 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2555 proxy which caches the transferred data. When a cached resource is
2556 requested again, proxy will return the data from cache. Another use for
2557 proxies is for companies that separate (for security reasons) their
2558 internal networks from the rest of Internet. In order to obtain
2559 information from the Web, their users connect and retrieve remote data
2560 using an authorized proxy.
2562 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2563 standard way to specify proxy location, which Wget recognizes, is using
2564 the following environment variables:
2568 This variable should contain the @sc{url} of the proxy for @sc{http}
2572 This variable should contain the @sc{url} of the proxy for @sc{ftp}
2573 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2574 are set to the same @sc{url}.
2577 This variable should contain a comma-separated list of domain extensions
2578 proxy should @emph{not} be used for. For instance, if the value of
2579 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2583 In addition to the environment variables, proxy location and settings
2584 may be specified from within Wget itself.
2588 @itemx --proxy=on/off
2589 @itemx proxy = on/off
2590 This option may be used to turn the proxy support on or off. Proxy
2591 support is on by default, provided that the appropriate environment
2594 @item http_proxy = @var{URL}
2595 @itemx ftp_proxy = @var{URL}
2596 @itemx no_proxy = @var{string}
2597 These startup file variables allow you to override the proxy settings
2598 specified by the environment.
2601 Some proxy servers require authorization to enable you to use them. The
2602 authorization consists of @dfn{username} and @dfn{password}, which must
2603 be sent by Wget. As with @sc{http} authorization, several
2604 authentication schemes exist. For proxy authorization only the
2605 @code{Basic} authentication scheme is currently implemented.
2607 You may specify your username and password either through the proxy
2608 @sc{url} or through the command-line options. Assuming that the
2609 company's proxy is located at @samp{proxy.company.com} at port 8001, a
2610 proxy @sc{url} location containing authorization data might look like
2614 http://hniksic:mypassword@@proxy.company.com:8001/
2617 Alternatively, you may use the @samp{proxy-user} and
2618 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2619 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2620 username and password.
2622 @node Distribution, Mailing List, Proxies, Various
2623 @section Distribution
2624 @cindex latest version
2626 Like all GNU utilities, the latest version of Wget can be found at the
2627 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2628 Wget @value{VERSION} can be found at
2629 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2631 @node Mailing List, Reporting Bugs, Distribution, Various
2632 @section Mailing List
2633 @cindex mailing list
2636 Wget has its own mailing list at @email{wget@@sunsite.dk}, thanks
2637 to Karsten Thygesen. The mailing list is for discussion of Wget
2638 features and web, reporting Wget bugs (those that you think may be of
2639 interest to the public) and mailing announcements. You are welcome to
2640 subscribe. The more people on the list, the better!
2642 To subscribe, send mail to @email{wget-subscribe@@sunsite.dk}.
2643 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2644 mailing to @email{wget-unsubscribe@@sunsite.dk}.
2646 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2647 Alternative archive is available at
2648 @url{http://www.mail-archive.com/wget%40sunsite.auc.dk/}.
2650 @node Reporting Bugs, Portability, Mailing List, Various
2651 @section Reporting Bugs
2653 @cindex reporting bugs
2657 You are welcome to send bug reports about GNU Wget to
2658 @email{bug-wget@@gnu.org}.
2660 Before actually submitting a bug report, please try to follow a few
2665 Please try to ascertain that the behaviour you see really is a bug. If
2666 Wget crashes, it's a bug. If Wget does not behave as documented,
2667 it's a bug. If things work strange, but you are not sure about the way
2668 they are supposed to work, it might well be a bug.
2671 Try to repeat the bug in as simple circumstances as possible. E.g. if
2672 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
2673 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
2674 repeatable, and if will occur with a simpler set of options. You might
2675 even try to start the download at the page where the crash occurred to
2676 see if that page somehow triggered the crash.
2678 Also, while I will probably be interested to know the contents of your
2679 @file{.wgetrc} file, just dumping it into the debug message is probably
2680 a bad idea. Instead, you should first try to see if the bug repeats
2681 with @file{.wgetrc} moved out of the way. Only if it turns out that
2682 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
2686 Please start Wget with @samp{-d} option and send the log (or the
2687 relevant parts of it). If Wget was compiled without debug support,
2688 recompile it. It is @emph{much} easier to trace bugs with debug support
2692 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2693 wget` core} and type @code{where} to get the backtrace.
2697 @node Portability, Signals, Reporting Bugs, Various
2698 @section Portability
2700 @cindex operating systems
2702 Since Wget uses GNU Autoconf for building and configuring, and avoids
2703 using ``special'' ultra--mega--cool features of any particular Unix, it
2704 should compile (and work) on all common Unix flavors.
2706 Various Wget versions have been compiled and tested under many kinds of
2707 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2708 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2709 distribution directory for a comprehensive list. If you compile it on
2710 an architecture not listed there, please let me know so I can update it.
2712 Wget should also compile on the other Unix systems, not listed in
2713 @file{MACHINES}. If it doesn't, please let me know.
2715 Thanks to kind contributors, this version of Wget compiles and works on
2716 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2717 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2718 with Winsock as networking software. Naturally, it is crippled of some
2719 features available on Unix, but it should work as a substitute for
2720 people stuck with Windows. Note that the Windows port is
2721 @strong{neither tested nor maintained} by me---all questions and
2722 problems should be reported to Wget mailing list at
2723 @email{wget@@sunsite.dk} where the maintainers will look at them.
2725 @node Signals, , Portability, Various
2727 @cindex signal handling
2730 Since the purpose of Wget is background work, it catches the hangup
2731 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2732 output, it will be redirected to a file named @file{wget-log}.
2733 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2734 to redirect the output of Wget after having started it.
2737 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2738 $ kill -HUP %% # Redirect the output to wget-log
2741 Other than that, Wget will not try to interfere with signals in any way.
2742 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
2744 @node Appendices, Copying, Various, Top
2747 This chapter contains some references I consider useful.
2750 * Robot Exclusion:: Wget's support for RES.
2751 * Security Considerations:: Security with Wget.
2752 * Contributors:: People who helped.
2755 @node Robot Exclusion, Security Considerations, Appendices, Appendices
2756 @section Robot Exclusion
2757 @cindex robot exclusion
2759 @cindex server maintenance
2761 It is extremely easy to make Wget wander aimlessly around a web site,
2762 sucking all the available data in progress. @samp{wget -r @var{site}},
2763 and you're set. Great? Not for the server admin.
2765 As long as Wget is only retrieving static pages, and doing it at a
2766 reasonable rate (see the @samp{--wait} option), there's not much of a
2767 problem. The trouble is that Wget can't tell the difference between the
2768 smallest static page and the most demanding CGI. A site I know has a
2769 section handled by an, uh, @dfn{bitchin'} CGI Perl script that converts
2770 Info files to HTML on the fly. The script is slow, but works well
2771 enough for human users viewing an occasional Info file. However, when
2772 someone's recursive Wget download stumbles upon the index page that
2773 links to all the Info files through the script, the system is brought to
2774 its knees without providing anything useful to the downloader.
2776 To avoid this kind of accident, as well as to preserve privacy for
2777 documents that need to be protected from well-behaved robots, the
2778 concept of @dfn{robot exclusion} has been invented. The idea is that
2779 the server administrators and document authors can specify which
2780 portions of the site they wish to protect from the robots.
2782 The most popular mechanism, and the de facto standard supported by all
2783 the major robots, is the ``Robots Exclusion Standard'' (RES) written by
2784 Martijn Koster et al. in 1994. It specifies the format of a text file
2785 containing directives that instruct the robots which URL paths to avoid.
2786 To be found by the robots, the specifications must be placed in
2787 @file{/robots.txt} in the server root, which the robots are supposed to
2790 Although Wget is not a web robot in the strictest sense of the word, it
2791 can downloads large parts of the site without the user's intervention to
2792 download an individual page. Because of that, Wget honors RES when
2793 downloading recursively. For instance, when you issue:
2796 wget -r http://www.server.com/
2799 First the index of @samp{www.server.com} will be downloaded. If Wget
2800 finds that it wants to download more documents from that server, it will
2801 request @samp{http://www.server.com/robots.txt} and, if found, use it
2802 for further downloads. @file{robots.txt} is loaded only once per each
2805 Until version 1.8, Wget supported the first version of the standard,
2806 written by Martijn Koster in 1994 and available at
2807 @url{http://www.robotstxt.org/wc/norobots.html}. As of version 1.8,
2808 Wget has supported the additional directives specified in the internet
2809 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
2810 Robots Control''. The draft, which has as far as I know never made to
2811 an @sc{rfc}, is available at
2812 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
2814 This manual no longer includes the text of the Robot Exclusion Standard.
2816 The second, less known mechanism, enables the author of an individual
2817 document to specify whether they want the links from the file to be
2818 followed by a robot. This is achieved using the @code{META} tag, like
2822 <meta name="robots" content="nofollow">
2825 This is explained in some detail at
2826 @url{http://www.robotstxt.org/wc/meta-user.html}. Wget supports this
2827 method of robot exclusion in addition to the usual @file{/robots.txt}
2830 If you know what you are doing and really really wish to turn off the
2831 robot exclusion, set the @code{robots} variable to @samp{off} in your
2832 @file{.wgetrc}. You can achieve the same effect from the command line
2833 using the @code{-e} switch, e.g. @samp{wget -e robots=off @var{url}...}.
2835 @node Security Considerations, Contributors, Robot Exclusion, Appendices
2836 @section Security Considerations
2839 When using Wget, you must be aware that it sends unencrypted passwords
2840 through the network, which may present a security problem. Here are the
2841 main issues, and some solutions.
2844 @item The passwords on the command line are visible using @code{ps}.
2845 The best way around it is to use @code{wget -i -} and feed the @sc{url}s
2846 to Wget's standard input, each on a separate line, terminated by
2847 @kbd{C-d}. Another workaround is to use @file{.netrc} to store
2848 passwords; however, storing unencrypted passwords is also considered a
2852 Using the insecure @dfn{basic} authentication scheme, unencrypted
2853 passwords are transmitted through the network routers and gateways.
2856 The @sc{ftp} passwords are also in no way encrypted. There is no good
2857 solution for this at the moment.
2860 Although the ``normal'' output of Wget tries to hide the passwords,
2861 debugging logs show them, in all forms. This problem is avoided by
2862 being careful when you send debug logs (yes, even when you send them to
2866 @node Contributors, , Security Considerations, Appendices
2867 @section Contributors
2868 @cindex contributors
2871 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
2874 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
2876 However, its development could never have gone as far as it has, were it
2877 not for the help of many people, either with bug reports, feature
2878 proposals, patches, or letters saying ``Thanks!''.
2880 Special thanks goes to the following people (no particular order):
2884 Karsten Thygesen---donated system resources such as the mailing list,
2885 web space, and @sc{ftp} space, along with a lot of time to make these
2889 Shawn McHorse---bug reports and patches.
2892 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
2896 Gordon Matzigkeit---@file{.netrc} support.
2900 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2901 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2904 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2905 and ``philosophical'' discussions.
2909 Darko Budor---initial port to Windows.
2912 Antonio Rosella---help and suggestions, plus the Italian translation.
2916 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2920 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2925 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2928 Francois Pinard---many thorough bug reports and discussions.
2932 Karl Eichwalder---lots of help with internationalization and other
2936 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2940 The people who provided donations for development, including Brian
2944 The following people have provided patches, bug/build reports, useful
2945 suggestions, beta testing services, fan mail and all the other things
2946 that make maintenance so much fun:
2965 Kristijan @v{C}onka@v{s},
2983 Aleksandar Erkalovi@'{c},
2986 Aleksandar Erkalovic,
3002 Erik Magnus Hulthen,
3020 Goran Kezunovi@'{c},
3031 $\Sigma\acute{\iota}\mu o\varsigma\;
3032 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
3033 (Simos KSenitellis),
3041 Nicol@'{a}s Lichtmeier,
3047 Alexander V. Lukyanov,
3072 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3074 Juan Jos\'{e} Rodr\'{\i}gues,
3077 Juan Jose Rodrigues,
3089 Szakacsits Szabolcs,
3095 Douglas E. Wegscheid,
3105 Apologies to all who I accidentally left out, and many thanks to all the
3106 subscribers of the Wget mailing list.
3108 @node Copying, Concept Index, Appendices, Top
3113 @cindex free software
3115 GNU Wget is licensed under the GNU GPL, which makes it @dfn{free
3118 Please note that ``free'' in ``free software'' refers to liberty, not
3119 price. As some GNU project advocates like to point out, think of ``free
3120 speech'' rather than ``free beer''. The exact and legally binding
3121 distribution terms are spelled out below; in short, you have the right
3122 (freedom) to run and change Wget and distribute it to other people, and
3123 even---if you want---charge money for doing either. The important
3124 restriction is that you have to grant your recipients the same rights
3125 and impose the same restrictions.
3127 This method of licensing software is also known as @dfn{open source}
3128 because, among other things, it makes sure that all recipients will
3129 receive the source code along with the program, and be able to improve
3130 it. The GNU project prefers the term ``free software'' for reasons
3132 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3134 The exact license terms are defined by this paragraph and the GNU
3135 General Public License it refers to:
3138 GNU Wget is free software; you can redistribute it and/or modify it
3139 under the terms of the GNU General Public License as published by the
3140 Free Software Foundation; either version 2 of the License, or (at your
3141 option) any later version.
3143 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3144 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3145 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3148 A copy of the GNU General Public License is included as part of this
3149 manual; if you did not receive it, write to the Free Software
3150 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3153 In addition to this, this manual is free in the same sense:
3156 Permission is granted to copy, distribute and/or modify this document
3157 under the terms of the GNU Free Documentation License, Version 1.1 or
3158 any later version published by the Free Software Foundation; with the
3159 Invariant Sections being ``GNU General Public License'' and ``GNU Free
3160 Documentation License'', with no Front-Cover Texts, and with no
3161 Back-Cover Texts. A copy of the license is included in the section
3162 entitled ``GNU Free Documentation License''.
3165 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
3166 @c that the GFDL needs to be present in the manual, and to me it would
3167 @c suck to include the license for the manual and not the license for
3170 The full texts of the GNU General Public License and of the GNU Free
3171 Documentation License are available below.
3174 * GNU General Public License::
3175 * GNU Free Documentation License::
3178 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
3179 @section GNU General Public License
3180 @center Version 2, June 1991
3183 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3184 675 Mass Ave, Cambridge, MA 02139, USA
3186 Everyone is permitted to copy and distribute verbatim copies
3187 of this license document, but changing it is not allowed.
3190 @unnumberedsec Preamble
3192 The licenses for most software are designed to take away your
3193 freedom to share and change it. By contrast, the GNU General Public
3194 License is intended to guarantee your freedom to share and change free
3195 software---to make sure the software is free for all its users. This
3196 General Public License applies to most of the Free Software
3197 Foundation's software and to any other program whose authors commit to
3198 using it. (Some other Free Software Foundation software is covered by
3199 the GNU Library General Public License instead.) You can apply it to
3202 When we speak of free software, we are referring to freedom, not
3203 price. Our General Public Licenses are designed to make sure that you
3204 have the freedom to distribute copies of free software (and charge for
3205 this service if you wish), that you receive source code or can get it
3206 if you want it, that you can change the software or use pieces of it
3207 in new free programs; and that you know you can do these things.
3209 To protect your rights, we need to make restrictions that forbid
3210 anyone to deny you these rights or to ask you to surrender the rights.
3211 These restrictions translate to certain responsibilities for you if you
3212 distribute copies of the software, or if you modify it.
3214 For example, if you distribute copies of such a program, whether
3215 gratis or for a fee, you must give the recipients all the rights that
3216 you have. You must make sure that they, too, receive or can get the
3217 source code. And you must show them these terms so they know their
3220 We protect your rights with two steps: (1) copyright the software, and
3221 (2) offer you this license which gives you legal permission to copy,
3222 distribute and/or modify the software.
3224 Also, for each author's protection and ours, we want to make certain
3225 that everyone understands that there is no warranty for this free
3226 software. If the software is modified by someone else and passed on, we
3227 want its recipients to know that what they have is not the original, so
3228 that any problems introduced by others will not reflect on the original
3229 authors' reputations.
3231 Finally, any free program is threatened constantly by software
3232 patents. We wish to avoid the danger that redistributors of a free
3233 program will individually obtain patent licenses, in effect making the
3234 program proprietary. To prevent this, we have made it clear that any
3235 patent must be licensed for everyone's free use or not licensed at all.
3237 The precise terms and conditions for copying, distribution and
3238 modification follow.
3241 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3244 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3249 This License applies to any program or other work which contains
3250 a notice placed by the copyright holder saying it may be distributed
3251 under the terms of this General Public License. The ``Program'', below,
3252 refers to any such program or work, and a ``work based on the Program''
3253 means either the Program or any derivative work under copyright law:
3254 that is to say, a work containing the Program or a portion of it,
3255 either verbatim or with modifications and/or translated into another
3256 language. (Hereinafter, translation is included without limitation in
3257 the term ``modification''.) Each licensee is addressed as ``you''.
3259 Activities other than copying, distribution and modification are not
3260 covered by this License; they are outside its scope. The act of
3261 running the Program is not restricted, and the output from the Program
3262 is covered only if its contents constitute a work based on the
3263 Program (independent of having been made by running the Program).
3264 Whether that is true depends on what the Program does.
3267 You may copy and distribute verbatim copies of the Program's
3268 source code as you receive it, in any medium, provided that you
3269 conspicuously and appropriately publish on each copy an appropriate
3270 copyright notice and disclaimer of warranty; keep intact all the
3271 notices that refer to this License and to the absence of any warranty;
3272 and give any other recipients of the Program a copy of this License
3273 along with the Program.
3275 You may charge a fee for the physical act of transferring a copy, and
3276 you may at your option offer warranty protection in exchange for a fee.
3279 You may modify your copy or copies of the Program or any portion
3280 of it, thus forming a work based on the Program, and copy and
3281 distribute such modifications or work under the terms of Section 1
3282 above, provided that you also meet all of these conditions:
3286 You must cause the modified files to carry prominent notices
3287 stating that you changed the files and the date of any change.
3290 You must cause any work that you distribute or publish, that in
3291 whole or in part contains or is derived from the Program or any
3292 part thereof, to be licensed as a whole at no charge to all third
3293 parties under the terms of this License.
3296 If the modified program normally reads commands interactively
3297 when run, you must cause it, when started running for such
3298 interactive use in the most ordinary way, to print or display an
3299 announcement including an appropriate copyright notice and a
3300 notice that there is no warranty (or else, saying that you provide
3301 a warranty) and that users may redistribute the program under
3302 these conditions, and telling the user how to view a copy of this
3303 License. (Exception: if the Program itself is interactive but
3304 does not normally print such an announcement, your work based on
3305 the Program is not required to print an announcement.)
3308 These requirements apply to the modified work as a whole. If
3309 identifiable sections of that work are not derived from the Program,
3310 and can be reasonably considered independent and separate works in
3311 themselves, then this License, and its terms, do not apply to those
3312 sections when you distribute them as separate works. But when you
3313 distribute the same sections as part of a whole which is a work based
3314 on the Program, the distribution of the whole must be on the terms of
3315 this License, whose permissions for other licensees extend to the
3316 entire whole, and thus to each and every part regardless of who wrote it.
3318 Thus, it is not the intent of this section to claim rights or contest
3319 your rights to work written entirely by you; rather, the intent is to
3320 exercise the right to control the distribution of derivative or
3321 collective works based on the Program.
3323 In addition, mere aggregation of another work not based on the Program
3324 with the Program (or with a work based on the Program) on a volume of
3325 a storage or distribution medium does not bring the other work under
3326 the scope of this License.
3329 You may copy and distribute the Program (or a work based on it,
3330 under Section 2) in object code or executable form under the terms of
3331 Sections 1 and 2 above provided that you also do one of the following:
3335 Accompany it with the complete corresponding machine-readable
3336 source code, which must be distributed under the terms of Sections
3337 1 and 2 above on a medium customarily used for software interchange; or,
3340 Accompany it with a written offer, valid for at least three
3341 years, to give any third party, for a charge no more than your
3342 cost of physically performing source distribution, a complete
3343 machine-readable copy of the corresponding source code, to be
3344 distributed under the terms of Sections 1 and 2 above on a medium
3345 customarily used for software interchange; or,
3348 Accompany it with the information you received as to the offer
3349 to distribute corresponding source code. (This alternative is
3350 allowed only for noncommercial distribution and only if you
3351 received the program in object code or executable form with such
3352 an offer, in accord with Subsection b above.)
3355 The source code for a work means the preferred form of the work for
3356 making modifications to it. For an executable work, complete source
3357 code means all the source code for all modules it contains, plus any
3358 associated interface definition files, plus the scripts used to
3359 control compilation and installation of the executable. However, as a
3360 special exception, the source code distributed need not include
3361 anything that is normally distributed (in either source or binary
3362 form) with the major components (compiler, kernel, and so on) of the
3363 operating system on which the executable runs, unless that component
3364 itself accompanies the executable.
3366 If distribution of executable or object code is made by offering
3367 access to copy from a designated place, then offering equivalent
3368 access to copy the source code from the same place counts as
3369 distribution of the source code, even though third parties are not
3370 compelled to copy the source along with the object code.
3373 You may not copy, modify, sublicense, or distribute the Program
3374 except as expressly provided under this License. Any attempt
3375 otherwise to copy, modify, sublicense or distribute the Program is
3376 void, and will automatically terminate your rights under this License.
3377 However, parties who have received copies, or rights, from you under
3378 this License will not have their licenses terminated so long as such
3379 parties remain in full compliance.
3382 You are not required to accept this License, since you have not
3383 signed it. However, nothing else grants you permission to modify or
3384 distribute the Program or its derivative works. These actions are
3385 prohibited by law if you do not accept this License. Therefore, by
3386 modifying or distributing the Program (or any work based on the
3387 Program), you indicate your acceptance of this License to do so, and
3388 all its terms and conditions for copying, distributing or modifying
3389 the Program or works based on it.
3392 Each time you redistribute the Program (or any work based on the
3393 Program), the recipient automatically receives a license from the
3394 original licensor to copy, distribute or modify the Program subject to
3395 these terms and conditions. You may not impose any further
3396 restrictions on the recipients' exercise of the rights granted herein.
3397 You are not responsible for enforcing compliance by third parties to
3401 If, as a consequence of a court judgment or allegation of patent
3402 infringement or for any other reason (not limited to patent issues),
3403 conditions are imposed on you (whether by court order, agreement or
3404 otherwise) that contradict the conditions of this License, they do not
3405 excuse you from the conditions of this License. If you cannot
3406 distribute so as to satisfy simultaneously your obligations under this
3407 License and any other pertinent obligations, then as a consequence you
3408 may not distribute the Program at all. For example, if a patent
3409 license would not permit royalty-free redistribution of the Program by
3410 all those who receive copies directly or indirectly through you, then
3411 the only way you could satisfy both it and this License would be to
3412 refrain entirely from distribution of the Program.
3414 If any portion of this section is held invalid or unenforceable under
3415 any particular circumstance, the balance of the section is intended to
3416 apply and the section as a whole is intended to apply in other
3419 It is not the purpose of this section to induce you to infringe any
3420 patents or other property right claims or to contest validity of any
3421 such claims; this section has the sole purpose of protecting the
3422 integrity of the free software distribution system, which is
3423 implemented by public license practices. Many people have made
3424 generous contributions to the wide range of software distributed
3425 through that system in reliance on consistent application of that
3426 system; it is up to the author/donor to decide if he or she is willing
3427 to distribute software through any other system and a licensee cannot
3430 This section is intended to make thoroughly clear what is believed to
3431 be a consequence of the rest of this License.
3434 If the distribution and/or use of the Program is restricted in
3435 certain countries either by patents or by copyrighted interfaces, the
3436 original copyright holder who places the Program under this License
3437 may add an explicit geographical distribution limitation excluding
3438 those countries, so that distribution is permitted only in or among
3439 countries not thus excluded. In such case, this License incorporates
3440 the limitation as if written in the body of this License.
3443 The Free Software Foundation may publish revised and/or new versions
3444 of the General Public License from time to time. Such new versions will
3445 be similar in spirit to the present version, but may differ in detail to
3446 address new problems or concerns.
3448 Each version is given a distinguishing version number. If the Program
3449 specifies a version number of this License which applies to it and ``any
3450 later version'', you have the option of following the terms and conditions
3451 either of that version or of any later version published by the Free
3452 Software Foundation. If the Program does not specify a version number of
3453 this License, you may choose any version ever published by the Free Software
3457 If you wish to incorporate parts of the Program into other free
3458 programs whose distribution conditions are different, write to the author
3459 to ask for permission. For software which is copyrighted by the Free
3460 Software Foundation, write to the Free Software Foundation; we sometimes
3461 make exceptions for this. Our decision will be guided by the two goals
3462 of preserving the free status of all derivatives of our free software and
3463 of promoting the sharing and reuse of software generally.
3466 @heading NO WARRANTY
3474 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3475 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3476 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3477 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3478 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3479 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3480 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3481 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3482 REPAIR OR CORRECTION.
3485 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3486 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3487 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3488 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3489 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3490 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3491 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3492 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3493 POSSIBILITY OF SUCH DAMAGES.
3497 @heading END OF TERMS AND CONDITIONS
3500 @center END OF TERMS AND CONDITIONS
3504 @unnumberedsec How to Apply These Terms to Your New Programs
3506 If you develop a new program, and you want it to be of the greatest
3507 possible use to the public, the best way to achieve this is to make it
3508 free software which everyone can redistribute and change under these terms.
3510 To do so, attach the following notices to the program. It is safest
3511 to attach them to the start of each source file to most effectively
3512 convey the exclusion of warranty; and each file should have at least
3513 the ``copyright'' line and a pointer to where the full notice is found.
3516 @var{one line to give the program's name and an idea of what it does.}
3517 Copyright (C) 19@var{yy} @var{name of author}
3519 This program is free software; you can redistribute it and/or
3520 modify it under the terms of the GNU General Public License
3521 as published by the Free Software Foundation; either version 2
3522 of the License, or (at your option) any later version.
3524 This program is distributed in the hope that it will be useful,
3525 but WITHOUT ANY WARRANTY; without even the implied warranty of
3526 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3527 GNU General Public License for more details.
3529 You should have received a copy of the GNU General Public License
3530 along with this program; if not, write to the Free Software
3531 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3534 Also add information on how to contact you by electronic and paper mail.
3536 If the program is interactive, make it output a short notice like this
3537 when it starts in an interactive mode:
3540 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3541 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3542 type `show w'. This is free software, and you are welcome
3543 to redistribute it under certain conditions; type `show c'
3547 The hypothetical commands @samp{show w} and @samp{show c} should show
3548 the appropriate parts of the General Public License. Of course, the
3549 commands you use may be called something other than @samp{show w} and
3550 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3553 You should also get your employer (if you work as a programmer) or your
3554 school, if any, to sign a ``copyright disclaimer'' for the program, if
3555 necessary. Here is a sample; alter the names:
3559 Yoyodyne, Inc., hereby disclaims all copyright
3560 interest in the program `Gnomovision'
3561 (which makes passes at compilers) written
3564 @var{signature of Ty Coon}, 1 April 1989
3565 Ty Coon, President of Vice
3569 This General Public License does not permit incorporating your program into
3570 proprietary programs. If your program is a subroutine library, you may
3571 consider it more useful to permit linking proprietary applications with the
3572 library. If this is what you want to do, use the GNU Library General
3573 Public License instead of this License.
3575 @node GNU Free Documentation License, , GNU General Public License, Copying
3576 @section GNU Free Documentation License
3577 @center Version 1.1, March 2000
3580 Copyright (C) 2000 Free Software Foundation, Inc.
3581 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3583 Everyone is permitted to copy and distribute verbatim copies
3584 of this license document, but changing it is not allowed.
3591 The purpose of this License is to make a manual, textbook, or other
3592 written document ``free'' in the sense of freedom: to assure everyone
3593 the effective freedom to copy and redistribute it, with or without
3594 modifying it, either commercially or noncommercially. Secondarily,
3595 this License preserves for the author and publisher a way to get
3596 credit for their work, while not being considered responsible for
3597 modifications made by others.
3599 This License is a kind of ``copyleft'', which means that derivative
3600 works of the document must themselves be free in the same sense. It
3601 complements the GNU General Public License, which is a copyleft
3602 license designed for free software.
3604 We have designed this License in order to use it for manuals for free
3605 software, because free software needs free documentation: a free
3606 program should come with manuals providing the same freedoms that the
3607 software does. But this License is not limited to software manuals;
3608 it can be used for any textual work, regardless of subject matter or
3609 whether it is published as a printed book. We recommend this License
3610 principally for works whose purpose is instruction or reference.
3614 APPLICABILITY AND DEFINITIONS
3616 This License applies to any manual or other work that contains a
3617 notice placed by the copyright holder saying it can be distributed
3618 under the terms of this License. The ``Document'', below, refers to any
3619 such manual or work. Any member of the public is a licensee, and is
3620 addressed as ``you''.
3622 A ``Modified Version'' of the Document means any work containing the
3623 Document or a portion of it, either copied verbatim, or with
3624 modifications and/or translated into another language.
3626 A ``Secondary Section'' is a named appendix or a front-matter section of
3627 the Document that deals exclusively with the relationship of the
3628 publishers or authors of the Document to the Document's overall subject
3629 (or to related matters) and contains nothing that could fall directly
3630 within that overall subject. (For example, if the Document is in part a
3631 textbook of mathematics, a Secondary Section may not explain any
3632 mathematics.) The relationship could be a matter of historical
3633 connection with the subject or with related matters, or of legal,
3634 commercial, philosophical, ethical or political position regarding
3637 The ``Invariant Sections'' are certain Secondary Sections whose titles
3638 are designated, as being those of Invariant Sections, in the notice
3639 that says that the Document is released under this License.
3641 The ``Cover Texts'' are certain short passages of text that are listed,
3642 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3643 the Document is released under this License.
3645 A ``Transparent'' copy of the Document means a machine-readable copy,
3646 represented in a format whose specification is available to the
3647 general public, whose contents can be viewed and edited directly and
3648 straightforwardly with generic text editors or (for images composed of
3649 pixels) generic paint programs or (for drawings) some widely available
3650 drawing editor, and that is suitable for input to text formatters or
3651 for automatic translation to a variety of formats suitable for input
3652 to text formatters. A copy made in an otherwise Transparent file
3653 format whose markup has been designed to thwart or discourage
3654 subsequent modification by readers is not Transparent. A copy that is
3655 not ``Transparent'' is called ``Opaque''.
3657 Examples of suitable formats for Transparent copies include plain
3658 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3659 or XML using a publicly available DTD, and standard-conforming simple
3660 HTML designed for human modification. Opaque formats include
3661 PostScript, PDF, proprietary formats that can be read and edited only
3662 by proprietary word processors, SGML or XML for which the DTD and/or
3663 processing tools are not generally available, and the
3664 machine-generated HTML produced by some word processors for output
3667 The ``Title Page'' means, for a printed book, the title page itself,
3668 plus such following pages as are needed to hold, legibly, the material
3669 this License requires to appear in the title page. For works in
3670 formats which do not have any title page as such, ``Title Page'' means
3671 the text near the most prominent appearance of the work's title,
3672 preceding the beginning of the body of the text.
3677 You may copy and distribute the Document in any medium, either
3678 commercially or noncommercially, provided that this License, the
3679 copyright notices, and the license notice saying this License applies
3680 to the Document are reproduced in all copies, and that you add no other
3681 conditions whatsoever to those of this License. You may not use
3682 technical measures to obstruct or control the reading or further
3683 copying of the copies you make or distribute. However, you may accept
3684 compensation in exchange for copies. If you distribute a large enough
3685 number of copies you must also follow the conditions in section 3.
3687 You may also lend copies, under the same conditions stated above, and
3688 you may publicly display copies.
3693 If you publish printed copies of the Document numbering more than 100,
3694 and the Document's license notice requires Cover Texts, you must enclose
3695 the copies in covers that carry, clearly and legibly, all these Cover
3696 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3697 the back cover. Both covers must also clearly and legibly identify
3698 you as the publisher of these copies. The front cover must present
3699 the full title with all words of the title equally prominent and
3700 visible. You may add other material on the covers in addition.
3701 Copying with changes limited to the covers, as long as they preserve
3702 the title of the Document and satisfy these conditions, can be treated
3703 as verbatim copying in other respects.
3705 If the required texts for either cover are too voluminous to fit
3706 legibly, you should put the first ones listed (as many as fit
3707 reasonably) on the actual cover, and continue the rest onto adjacent
3710 If you publish or distribute Opaque copies of the Document numbering
3711 more than 100, you must either include a machine-readable Transparent
3712 copy along with each Opaque copy, or state in or with each Opaque copy
3713 a publicly-accessible computer-network location containing a complete
3714 Transparent copy of the Document, free of added material, which the
3715 general network-using public has access to download anonymously at no
3716 charge using public-standard network protocols. If you use the latter
3717 option, you must take reasonably prudent steps, when you begin
3718 distribution of Opaque copies in quantity, to ensure that this
3719 Transparent copy will remain thus accessible at the stated location
3720 until at least one year after the last time you distribute an Opaque
3721 copy (directly or through your agents or retailers) of that edition to
3724 It is requested, but not required, that you contact the authors of the
3725 Document well before redistributing any large number of copies, to give
3726 them a chance to provide you with an updated version of the Document.
3731 You may copy and distribute a Modified Version of the Document under
3732 the conditions of sections 2 and 3 above, provided that you release
3733 the Modified Version under precisely this License, with the Modified
3734 Version filling the role of the Document, thus licensing distribution
3735 and modification of the Modified Version to whoever possesses a copy
3736 of it. In addition, you must do these things in the Modified Version:
3738 A. Use in the Title Page (and on the covers, if any) a title distinct
3739 from that of the Document, and from those of previous versions
3740 (which should, if there were any, be listed in the History section
3741 of the Document). You may use the same title as a previous version
3742 if the original publisher of that version gives permission.@*
3743 B. List on the Title Page, as authors, one or more persons or entities
3744 responsible for authorship of the modifications in the Modified
3745 Version, together with at least five of the principal authors of the
3746 Document (all of its principal authors, if it has less than five).@*
3747 C. State on the Title page the name of the publisher of the
3748 Modified Version, as the publisher.@*
3749 D. Preserve all the copyright notices of the Document.@*
3750 E. Add an appropriate copyright notice for your modifications
3751 adjacent to the other copyright notices.@*
3752 F. Include, immediately after the copyright notices, a license notice
3753 giving the public permission to use the Modified Version under the
3754 terms of this License, in the form shown in the Addendum below.@*
3755 G. Preserve in that license notice the full lists of Invariant Sections
3756 and required Cover Texts given in the Document's license notice.@*
3757 H. Include an unaltered copy of this License.@*
3758 I. Preserve the section entitled ``History'', and its title, and add to
3759 it an item stating at least the title, year, new authors, and
3760 publisher of the Modified Version as given on the Title Page. If
3761 there is no section entitled ``History'' in the Document, create one
3762 stating the title, year, authors, and publisher of the Document as
3763 given on its Title Page, then add an item describing the Modified
3764 Version as stated in the previous sentence.@*
3765 J. Preserve the network location, if any, given in the Document for
3766 public access to a Transparent copy of the Document, and likewise
3767 the network locations given in the Document for previous versions
3768 it was based on. These may be placed in the ``History'' section.
3769 You may omit a network location for a work that was published at
3770 least four years before the Document itself, or if the original
3771 publisher of the version it refers to gives permission.@*
3772 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3773 preserve the section's title, and preserve in the section all the
3774 substance and tone of each of the contributor acknowledgements
3775 and/or dedications given therein.@*
3776 L. Preserve all the Invariant Sections of the Document,
3777 unaltered in their text and in their titles. Section numbers
3778 or the equivalent are not considered part of the section titles.@*
3779 M. Delete any section entitled ``Endorsements''. Such a section
3780 may not be included in the Modified Version.@*
3781 N. Do not retitle any existing section as ``Endorsements''
3782 or to conflict in title with any Invariant Section.@*
3784 If the Modified Version includes new front-matter sections or
3785 appendices that qualify as Secondary Sections and contain no material
3786 copied from the Document, you may at your option designate some or all
3787 of these sections as invariant. To do this, add their titles to the
3788 list of Invariant Sections in the Modified Version's license notice.
3789 These titles must be distinct from any other section titles.
3791 You may add a section entitled ``Endorsements'', provided it contains
3792 nothing but endorsements of your Modified Version by various
3793 parties--for example, statements of peer review or that the text has
3794 been approved by an organization as the authoritative definition of a
3797 You may add a passage of up to five words as a Front-Cover Text, and a
3798 passage of up to 25 words as a Back-Cover Text, to the end of the list
3799 of Cover Texts in the Modified Version. Only one passage of
3800 Front-Cover Text and one of Back-Cover Text may be added by (or
3801 through arrangements made by) any one entity. If the Document already
3802 includes a cover text for the same cover, previously added by you or
3803 by arrangement made by the same entity you are acting on behalf of,
3804 you may not add another; but you may replace the old one, on explicit
3805 permission from the previous publisher that added the old one.
3807 The author(s) and publisher(s) of the Document do not by this License
3808 give permission to use their names for publicity for or to assert or
3809 imply endorsement of any Modified Version.
3814 You may combine the Document with other documents released under this
3815 License, under the terms defined in section 4 above for modified
3816 versions, provided that you include in the combination all of the
3817 Invariant Sections of all of the original documents, unmodified, and
3818 list them all as Invariant Sections of your combined work in its
3821 The combined work need only contain one copy of this License, and
3822 multiple identical Invariant Sections may be replaced with a single
3823 copy. If there are multiple Invariant Sections with the same name but
3824 different contents, make the title of each such section unique by
3825 adding at the end of it, in parentheses, the name of the original
3826 author or publisher of that section if known, or else a unique number.
3827 Make the same adjustment to the section titles in the list of
3828 Invariant Sections in the license notice of the combined work.
3830 In the combination, you must combine any sections entitled ``History''
3831 in the various original documents, forming one section entitled
3832 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3833 and any sections entitled ``Dedications''. You must delete all sections
3834 entitled ``Endorsements.''
3837 COLLECTIONS OF DOCUMENTS
3839 You may make a collection consisting of the Document and other documents
3840 released under this License, and replace the individual copies of this
3841 License in the various documents with a single copy that is included in
3842 the collection, provided that you follow the rules of this License for
3843 verbatim copying of each of the documents in all other respects.
3845 You may extract a single document from such a collection, and distribute
3846 it individually under this License, provided you insert a copy of this
3847 License into the extracted document, and follow this License in all
3848 other respects regarding verbatim copying of that document.
3851 AGGREGATION WITH INDEPENDENT WORKS
3853 A compilation of the Document or its derivatives with other separate
3854 and independent documents or works, in or on a volume of a storage or
3855 distribution medium, does not as a whole count as a Modified Version
3856 of the Document, provided no compilation copyright is claimed for the
3857 compilation. Such a compilation is called an ``aggregate'', and this
3858 License does not apply to the other self-contained works thus compiled
3859 with the Document, on account of their being thus compiled, if they
3860 are not themselves derivative works of the Document.
3862 If the Cover Text requirement of section 3 is applicable to these
3863 copies of the Document, then if the Document is less than one quarter
3864 of the entire aggregate, the Document's Cover Texts may be placed on
3865 covers that surround only the Document within the aggregate.
3866 Otherwise they must appear on covers around the whole aggregate.
3871 Translation is considered a kind of modification, so you may
3872 distribute translations of the Document under the terms of section 4.
3873 Replacing Invariant Sections with translations requires special
3874 permission from their copyright holders, but you may include
3875 translations of some or all Invariant Sections in addition to the
3876 original versions of these Invariant Sections. You may include a
3877 translation of this License provided that you also include the
3878 original English version of this License. In case of a disagreement
3879 between the translation and the original English version of this
3880 License, the original English version will prevail.
3885 You may not copy, modify, sublicense, or distribute the Document except
3886 as expressly provided for under this License. Any other attempt to
3887 copy, modify, sublicense or distribute the Document is void, and will
3888 automatically terminate your rights under this License. However,
3889 parties who have received copies, or rights, from you under this
3890 License will not have their licenses terminated so long as such
3891 parties remain in full compliance.
3894 FUTURE REVISIONS OF THIS LICENSE
3896 The Free Software Foundation may publish new, revised versions
3897 of the GNU Free Documentation License from time to time. Such new
3898 versions will be similar in spirit to the present version, but may
3899 differ in detail to address new problems or concerns. See
3900 http://www.gnu.org/copyleft/.
3902 Each version of the License is given a distinguishing version number.
3903 If the Document specifies that a particular numbered version of this
3904 License ``or any later version'' applies to it, you have the option of
3905 following the terms and conditions either of that specified version or
3906 of any later version that has been published (not as a draft) by the
3907 Free Software Foundation. If the Document does not specify a version
3908 number of this License, you may choose any version ever published (not
3909 as a draft) by the Free Software Foundation.
3913 @unnumberedsec ADDENDUM: How to use this License for your documents
3915 To use this License in a document you have written, include a copy of
3916 the License in the document and put the following copyright and
3917 license notices just after the title page:
3922 Copyright (C) @var{year} @var{your name}.
3923 Permission is granted to copy, distribute and/or modify this document
3924 under the terms of the GNU Free Documentation License, Version 1.1
3925 or any later version published by the Free Software Foundation;
3926 with the Invariant Sections being @var{list their titles}, with the
3927 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
3928 A copy of the license is included in the section entitled ``GNU
3929 Free Documentation License''.
3932 If you have no Invariant Sections, write ``with no Invariant Sections''
3933 instead of saying which ones are invariant. If you have no
3934 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
3935 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
3937 If your document contains nontrivial examples of program code, we
3938 recommend releasing these examples in parallel under your choice of
3939 free software license, such as the GNU General Public License,
3940 to permit their use in free software.
3943 @node Concept Index, , Copying, Top
3944 @unnumbered Concept Index