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.
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 ``dot'' indicator is used by default. It traces the retrieval by
629 printing dots on the screen, each dot representing a fixed amount of
632 When using the dotted retrieval, you may also set the @dfn{style} by
633 specifying the type as @samp{dot:@var{style}}. Different styles assign
634 different meaning to one dot. With the @code{default} style each dot
635 represents 1K, there are ten dots in a cluster and 50 dots in a line.
636 The @code{binary} style has a more ``computer''-like orientation---8K
637 dots, 16-dots clusters and 48 dots per line (which makes for 384K
638 lines). The @code{mega} style is suitable for downloading very large
639 files---each dot represents 64K retrieved, there are eight dots in a
640 cluster, and 48 dots on each line (so each line contains 3M).
642 Specifying @samp{--progress=bar} will draw a nice ASCII progress bar
643 graphics (a.k.a ``thermometer'' display) to indicate retrieval. If the
644 output is not a TTY, this option will be ignored, and Wget will revert
645 to the dot indicator. If you want to force the bar indicator, use
646 @samp{--progress=bar:force}.
649 @itemx --timestamping
650 Turn on time-stamping. @xref{Time-Stamping}, for details.
652 @cindex server response, print
654 @itemx --server-response
655 Print the headers sent by @sc{http} servers and responses sent by
658 @cindex Wget as spider
661 When invoked with this option, Wget will behave as a Web @dfn{spider},
662 which means that it will not download the pages, just check that they
663 are there. You can use it to check your bookmarks, e.g. with:
666 wget --spider --force-html -i bookmarks.html
669 This feature needs much more work for Wget to get close to the
670 functionality of real @sc{www} spiders.
674 @itemx --timeout=@var{seconds}
675 Set the read timeout to @var{seconds} seconds. Whenever a network read
676 is issued, the file descriptor is checked for a timeout, which could
677 otherwise leave a pending connection (uninterrupted read). The default
678 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
679 disable checking for timeouts.
681 Please do not lower the default timeout value with this option unless
682 you know what you are doing.
686 @item -w @var{seconds}
687 @itemx --wait=@var{seconds}
688 Wait the specified number of seconds between the retrievals. Use of
689 this option is recommended, as it lightens the server load by making the
690 requests less frequent. Instead of in seconds, the time can be
691 specified in minutes using the @code{m} suffix, in hours using @code{h}
692 suffix, or in days using @code{d} suffix.
694 Specifying a large value for this option is useful if the network or the
695 destination host is down, so that Wget can wait long enough to
696 reasonably expect the network error to be fixed before the retry.
698 @cindex retries, waiting between
699 @cindex waiting between retries
700 @item --waitretry=@var{seconds}
701 If you don't want Wget to wait between @emph{every} retrieval, but only
702 between retries of failed downloads, you can use this option. Wget will
703 use @dfn{linear backoff}, waiting 1 second after the first failure on a
704 given file, then waiting 2 seconds after the second failure on that
705 file, up to the maximum number of @var{seconds} you specify. Therefore,
706 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
709 Note that this option is turned on by default in the global
715 Some web sites may perform log analysis to identify retrieval programs
716 such as Wget by looking for statistically significant similarities in
717 the time between requests. This option causes the time between requests
718 to vary between 0 and 2 * @var{wait} seconds, where @var{wait} was
719 specified using the @samp{-w} or @samp{--wait} options, in order to mask
720 Wget's presence from such analysis.
722 A recent article in a publication devoted to development on a popular
723 consumer platform provided code to perform this analysis on the fly.
724 Its author suggested blocking at the class C address level to ensure
725 automated retrieval programs were blocked despite changing DHCP-supplied
728 The @samp{--random-wait} option was inspired by this ill-advised
729 recommendation to block many unrelated users from a web site due to the
734 @itemx --proxy=on/off
735 Turn proxy support on or off. The proxy is on by default if the
736 appropriate environmental variable is defined.
740 @itemx --quota=@var{quota}
741 Specify download quota for automatic retrievals. The value can be
742 specified in bytes (default), kilobytes (with @samp{k} suffix), or
743 megabytes (with @samp{m} suffix).
745 Note that quota will never affect downloading a single file. So if you
746 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
747 @file{ls-lR.gz} will be downloaded. The same goes even when several
748 @sc{url}s are specified on the command-line. However, quota is
749 respected when retrieving either recursively, or from an input file.
750 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
751 aborted when the quota is exceeded.
753 Setting quota to 0 or to @samp{inf} unlimits the download quota.
756 @node Directory Options, HTTP Options, Download Options, Invoking
757 @section Directory Options
761 @itemx --no-directories
762 Do not create a hierarchy of directories when retrieving recursively.
763 With this option turned on, all files will get saved to the current
764 directory, without clobbering (if a name shows up more than once, the
765 filenames will get extensions @samp{.n}).
768 @itemx --force-directories
769 The opposite of @samp{-nd}---create a hierarchy of directories, even if
770 one would not have been created otherwise. E.g. @samp{wget -x
771 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
772 @file{fly.srk.fer.hr/robots.txt}.
775 @itemx --no-host-directories
776 Disable generation of host-prefixed directories. By default, invoking
777 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
778 directories beginning with @file{fly.srk.fer.hr/}. This option disables
781 @cindex cut directories
782 @item --cut-dirs=@var{number}
783 Ignore @var{number} directory components. This is useful for getting a
784 fine-grained control over the directory where recursive retrieval will
787 Take, for example, the directory at
788 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
789 @samp{-r}, it will be saved locally under
790 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
791 remove the @file{ftp.xemacs.org/} part, you are still stuck with
792 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
793 makes Wget not ``see'' @var{number} remote directory components. Here
794 are several examples of how @samp{--cut-dirs} option works.
798 No options -> ftp.xemacs.org/pub/xemacs/
800 -nH --cut-dirs=1 -> xemacs/
801 -nH --cut-dirs=2 -> .
803 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
808 If you just want to get rid of the directory structure, this option is
809 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
810 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
811 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
812 be placed to @file{xemacs/beta}, as one would expect.
814 @cindex directory prefix
815 @item -P @var{prefix}
816 @itemx --directory-prefix=@var{prefix}
817 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
818 directory where all other files and subdirectories will be saved to,
819 i.e. the top of the retrieval tree. The default is @samp{.} (the
823 @node HTTP Options, FTP Options, Directory Options, Invoking
824 @section HTTP Options
827 @cindex .html extension
829 @itemx --html-extension
830 If a file of type @samp{text/html} is downloaded and the URL does not
831 end with the regexp @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause
832 the suffix @samp{.html} to be appended to the local filename. This is
833 useful, for instance, when you're mirroring a remote site that uses
834 @samp{.asp} pages, but you want the mirrored pages to be viewable on
835 your stock Apache server. Another good use for this is when you're
836 downloading the output of CGIs. A URL like
837 @samp{http://site.com/article.cgi?25} will be saved as
838 @file{article.cgi?25.html}.
840 Note that filenames changed in this way will be re-downloaded every time
841 you re-mirror a site, because Wget can't tell that the local
842 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
843 it doesn't yet know that the URL produces output of type
844 @samp{text/html}. To prevent this re-downloading, you must use
845 @samp{-k} and @samp{-K} so that the original version of the file will be
846 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
849 @cindex http password
850 @cindex authentication
851 @item --http-user=@var{user}
852 @itemx --http-passwd=@var{password}
853 Specify the username @var{user} and password @var{password} on an
854 @sc{http} server. According to the type of the challenge, Wget will
855 encode them using either the @code{basic} (insecure) or the
856 @code{digest} authentication scheme.
858 Another way to specify username and password is in the @sc{url} itself
859 (@pxref{URL Format}). Either method reveals your password to anyone who
860 bothers to run @code{ps}. To prevent the passwords from being seen,
861 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
862 those files from other users with @code{chmod}. If the passwords are
863 really important, do not leave them lying in those files either---edit
864 the files and delete them after Wget has started the download.
866 For more information about security issues with Wget, @xref{Security
872 @itemx --cache=on/off
873 When set to off, disable server-side cache. In this case, Wget will
874 send the remote server an appropriate directive (@samp{Pragma:
875 no-cache}) to get the file from the remote service, rather than
876 returning the cached version. This is especially useful for retrieving
877 and flushing out-of-date documents on proxy servers.
879 Caching is allowed by default.
882 @item --cookies=on/off
883 When set to off, disable the use of cookies. Cookies are a mechanism
884 for maintaining server-side state. The server sends the client a cookie
885 using the @code{Set-Cookie} header, and the client responds with the
886 same cookie upon further requests. Since cookies allow the server
887 owners to keep track of visitors and for sites to exchange this
888 information, some consider them a breach of privacy. The default is to
889 use cookies; however, @emph{storing} cookies is not on by default.
891 @cindex loading cookies
892 @cindex cookies, loading
893 @item --load-cookies @var{file}
894 Load cookies from @var{file} before the first HTTP retrieval.
895 @var{file} is a textual file in the format originally used by Netscape's
896 @file{cookies.txt} file.
898 You will typically use this option when mirroring sites that require
899 that you be logged in to access some or all of their content. The login
900 process typically works by the web server issuing an @sc{http} cookie
901 upon receiving and verifying your credentials. The cookie is then
902 resent by the browser when accessing that part of the site, and so
903 proves your identity.
905 Mirroring such a site requires Wget to send the same cookies your
906 browser sends when communicating with the site. This is achieved by
907 @samp{--load-cookies}---simply point Wget to the location of the
908 @file{cookies.txt} file, and it will send the same cookies your browser
909 would send in the same situation. Different browsers keep textual
910 cookie files in different locations:
914 The cookies are in @file{~/.netscape/cookies.txt}.
916 @item Mozilla and Netscape 6.x.
917 Mozilla's cookie file is also named @file{cookies.txt}, located
918 somewhere under @file{~/.mozilla}, in the directory of your profile.
919 The full path usually ends up looking somewhat like
920 @file{~/.mozilla/default/@var{some-weird-string}/cookies.txt}.
922 @item Internet Explorer.
923 You can produce a cookie file Wget can use by using the File menu,
924 Import and Export, Export Cookies. This has been tested with Internet
925 Explorer 5; it is not guaranteed to work with earlier versions.
927 @item Other browsers.
928 If you are using a different browser to create your cookies,
929 @samp{--load-cookies} will only work if you can locate or produce a
930 cookie file in the Netscape format that Wget expects.
933 If you cannot use @samp{--load-cookies}, there might still be an
934 alternative. If your browser supports a ``cookie manager'', you can use
935 it to view the cookies used when accessing the site you're mirroring.
936 Write down the name and value of the cookie, and manually instruct Wget
937 to send those cookies, bypassing the ``official'' cookie support:
940 wget --cookies=off --header "Cookie: @var{name}=@var{value}"
943 @cindex saving cookies
944 @cindex cookies, saving
945 @item --save-cookies @var{file}
946 Save cookies from @var{file} at the end of session. Cookies whose
947 expiry time is not specified, or those that have already expired, are
950 @cindex Content-Length, ignore
951 @cindex ignore length
952 @item --ignore-length
953 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
954 precise) send out bogus @code{Content-Length} headers, which makes Wget
955 go wild, as it thinks not all the document was retrieved. You can spot
956 this syndrome if Wget retries getting the same document again and again,
957 each time claiming that the (otherwise normal) connection has closed on
960 With this option, Wget will ignore the @code{Content-Length} header---as
964 @item --header=@var{additional-header}
965 Define an @var{additional-header} to be passed to the @sc{http} servers.
966 Headers must contain a @samp{:} preceded by one or more non-blank
967 characters, and must not contain newlines.
969 You may define more than one additional header by specifying
970 @samp{--header} more than once.
974 wget --header='Accept-Charset: iso-8859-2' \
975 --header='Accept-Language: hr' \
976 http://fly.srk.fer.hr/
980 Specification of an empty string as the header value will clear all
981 previous user-defined headers.
984 @cindex proxy password
985 @cindex proxy authentication
986 @item --proxy-user=@var{user}
987 @itemx --proxy-passwd=@var{password}
988 Specify the username @var{user} and password @var{password} for
989 authentication on a proxy server. Wget will encode them using the
990 @code{basic} authentication scheme.
992 Security considerations similar to those with @samp{--http-passwd}
993 pertain here as well.
996 @cindex referer, http
997 @item --referer=@var{url}
998 Include `Referer: @var{url}' header in HTTP request. Useful for
999 retrieving documents with server-side processing that assume they are
1000 always being retrieved by interactive web browsers and only come out
1001 properly when Referer is set to one of the pages that point to them.
1003 @cindex server response, save
1005 @itemx --save-headers
1006 Save the headers sent by the @sc{http} server to the file, preceding the
1007 actual contents, with an empty line as the separator.
1010 @item -U @var{agent-string}
1011 @itemx --user-agent=@var{agent-string}
1012 Identify as @var{agent-string} to the @sc{http} server.
1014 The @sc{http} protocol allows the clients to identify themselves using a
1015 @code{User-Agent} header field. This enables distinguishing the
1016 @sc{www} software, usually for statistical purposes or for tracing of
1017 protocol violations. Wget normally identifies as
1018 @samp{Wget/@var{version}}, @var{version} being the current version
1021 However, some sites have been known to impose the policy of tailoring
1022 the output according to the @code{User-Agent}-supplied information.
1023 While conceptually this is not such a bad idea, it has been abused by
1024 servers denying information to clients other than @code{Mozilla} or
1025 Microsoft @code{Internet Explorer}. This option allows you to change
1026 the @code{User-Agent} line issued by Wget. Use of this option is
1027 discouraged, unless you really know what you are doing.
1030 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
1031 @section FTP Options
1034 @cindex .listing files, removing
1036 @itemx --dont-remove-listing
1037 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1038 retrievals. Normally, these files contain the raw directory listings
1039 received from @sc{ftp} servers. Not removing them can be useful for
1040 debugging purposes, or when you want to be able to easily check on the
1041 contents of remote server directories (e.g. to verify that a mirror
1042 you're running is complete).
1044 Note that even though Wget writes to a known filename for this file,
1045 this is not a security hole in the scenario of a user making
1046 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1047 asking @code{root} to run Wget in his or her directory. Depending on
1048 the options used, either Wget will refuse to write to @file{.listing},
1049 making the globbing/recursion/time-stamping operation fail, or the
1050 symbolic link will be deleted and replaced with the actual
1051 @file{.listing} file, or the listing will be written to a
1052 @file{.listing.@var{number}} file.
1054 Even though this situation isn't a problem, though, @code{root} should
1055 never run Wget in a non-trusted user's directory. A user could do
1056 something as simple as linking @file{index.html} to @file{/etc/passwd}
1057 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1058 will be overwritten.
1060 @cindex globbing, toggle
1062 @itemx --glob=on/off
1063 Turn @sc{ftp} globbing on or off. Globbing means you may use the
1064 shell-like special characters (@dfn{wildcards}), like @samp{*},
1065 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
1066 same directory at once, like:
1069 wget ftp://gnjilux.srk.fer.hr/*.msg
1072 By default, globbing will be turned on if the @sc{url} contains a
1073 globbing character. This option may be used to turn globbing on or off
1076 You may have to quote the @sc{url} to protect it from being expanded by
1077 your shell. Globbing makes Wget look for a directory listing, which is
1078 system-specific. This is why it currently works only with Unix @sc{ftp}
1079 servers (and the ones emulating Unix @code{ls} output).
1083 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
1084 initiates the data connection. This is sometimes required for @sc{ftp}
1085 to work behind firewalls.
1087 @cindex symbolic links, retrieving
1088 @item --retr-symlinks
1089 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1090 link is encountered, the linked-to file is not downloaded. Instead, a
1091 matching symbolic link is created on the local filesystem. The
1092 pointed-to file will not be downloaded unless this recursive retrieval
1093 would have encountered it separately and downloaded it anyway.
1095 When @samp{--retr-symlinks} is specified, however, symbolic links are
1096 traversed and the pointed-to files are retrieved. At this time, this
1097 option does not cause Wget to traverse symlinks to directories and
1098 recurse through them, but in the future it should be enhanced to do
1101 Note that when retrieving a file (not a directory) because it was
1102 specified on the commandline, rather than because it was recursed to,
1103 this option has no effect. Symbolic links are always traversed in this
1107 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
1108 @section Recursive Retrieval Options
1113 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
1116 @item -l @var{depth}
1117 @itemx --level=@var{depth}
1118 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1119 Retrieval}). The default maximum depth is 5.
1121 @cindex proxy filling
1122 @cindex delete after retrieval
1123 @cindex filling proxy cache
1124 @item --delete-after
1125 This option tells Wget to delete every single file it downloads,
1126 @emph{after} having done so. It is useful for pre-fetching popular
1127 pages through a proxy, e.g.:
1130 wget -r -nd --delete-after http://whatever.com/~popular/page/
1133 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1136 Note that @samp{--delete-after} deletes files on the local machine. It
1137 does not issue the @samp{DELE} command to remote FTP sites, for
1138 instance. Also note that when @samp{--delete-after} is specified,
1139 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1140 created in the first place.
1142 @cindex conversion of links
1143 @cindex link conversion
1145 @itemx --convert-links
1146 After the download is complete, convert the links in the document to
1147 make them suitable for local viewing. This affects not only the visible
1148 hyperlinks, but any part of the document that links to external content,
1149 such as embedded images, links to style sheets, hyperlinks to non-HTML
1152 Each link will be changed in one of the two ways:
1156 The links to files that have been downloaded by Wget will be changed to
1157 refer to the file they point to as a relative link.
1159 Example: if the downloaded file @file{/foo/doc.html} links to
1160 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1161 will be modified to point to @samp{../bar/img.gif}. This kind of
1162 transformation works reliably for arbitrary combinations of directories.
1165 The links to files that have not been downloaded by Wget will be changed
1166 to include host name and absolute path of the location they point to.
1168 Example: if the downloaded file @file{/foo/doc.html} links to
1169 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1170 @file{doc.html} will be modified to point to
1171 @file{http://@var{hostname}/bar/img.gif}.
1174 Because of this, local browsing works reliably: if a linked file was
1175 downloaded, the link will refer to its local name; if it was not
1176 downloaded, the link will refer to its full Internet address rather than
1177 presenting a broken link. The fact that the former links are converted
1178 to relative links ensures that you can move the downloaded hierarchy to
1181 Note that only at the end of the download can Wget know which links have
1182 been downloaded. Because of that, the work done by @samp{-k} will be
1183 performed at the end of all the downloads.
1185 @cindex backing up converted files
1187 @itemx --backup-converted
1188 When converting a file, back up the original version with a @samp{.orig}
1189 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1194 Turn on options suitable for mirroring. This option turns on recursion
1195 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1196 directory listings. It is currently equivalent to
1197 @samp{-r -N -l inf -nr}.
1199 @cindex page requisites
1200 @cindex required images, downloading
1202 @itemx --page-requisites
1203 This option causes Wget to download all the files that are necessary to
1204 properly display a given HTML page. This includes such things as
1205 inlined images, sounds, and referenced stylesheets.
1207 Ordinarily, when downloading a single HTML page, any requisite documents
1208 that may be needed to display it properly are not downloaded. Using
1209 @samp{-r} together with @samp{-l} can help, but since Wget does not
1210 ordinarily distinguish between external and inlined documents, one is
1211 generally left with ``leaf documents'' that are missing their
1214 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1215 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1216 document @file{2.html}. Say that @file{2.html} is similar but that its
1217 image is @file{2.gif} and it links to @file{3.html}. Say this
1218 continues up to some arbitrarily high number.
1220 If one executes the command:
1223 wget -r -l 2 http://@var{site}/1.html
1226 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1227 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1228 without its requisite @file{3.gif} because Wget is simply counting the
1229 number of hops (up to 2) away from @file{1.html} in order to determine
1230 where to stop the recursion. However, with this command:
1233 wget -r -l 2 -p http://@var{site}/1.html
1236 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1237 will be downloaded. Similarly,
1240 wget -r -l 1 -p http://@var{site}/1.html
1243 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1244 to be downloaded. One might think that:
1247 wget -r -l 0 -p http://@var{site}/1.html
1250 would download just @file{1.html} and @file{1.gif}, but unfortunately
1251 this is not the case, because @samp{-l 0} is equivalent to
1252 @samp{-l inf}---that is, infinite recursion. To download a single HTML
1253 page (or a handful of them, all specified on the commandline or in a
1254 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1255 @samp{-r} and @samp{-l}:
1258 wget -p http://@var{site}/1.html
1261 Note that Wget will behave as if @samp{-r} had been specified, but only
1262 that single page and its requisites will be downloaded. Links from that
1263 page to external documents will not be followed. Actually, to download
1264 a single page and all its requisites (even if they exist on separate
1265 websites), and make sure the lot displays properly locally, this author
1266 likes to use a few options in addition to @samp{-p}:
1269 wget -E -H -k -K -p http://@var{site}/@var{document}
1272 To finish off this topic, it's worth knowing that Wget's idea of an
1273 external document link is any URL specified in an @code{<A>} tag, an
1274 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1278 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1279 @section Recursive Accept/Reject Options
1282 @item -A @var{acclist} --accept @var{acclist}
1283 @itemx -R @var{rejlist} --reject @var{rejlist}
1284 Specify comma-separated lists of file name suffixes or patterns to
1285 accept or reject (@pxref{Types of Files} for more details).
1287 @item -D @var{domain-list}
1288 @itemx --domains=@var{domain-list}
1289 Set domains to be followed. @var{domain-list} is a comma-separated list
1290 of domains. Note that it does @emph{not} turn on @samp{-H}.
1292 @item --exclude-domains @var{domain-list}
1293 Specify the domains that are @emph{not} to be followed.
1294 (@pxref{Spanning Hosts}).
1296 @cindex follow FTP links
1298 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1299 Wget will ignore all the @sc{ftp} links.
1301 @cindex tag-based recursive pruning
1302 @item --follow-tags=@var{list}
1303 Wget has an internal table of HTML tag / attribute pairs that it
1304 considers when looking for linked documents during a recursive
1305 retrieval. If a user wants only a subset of those tags to be
1306 considered, however, he or she should be specify such tags in a
1307 comma-separated @var{list} with this option.
1310 @itemx --ignore-tags=@var{list}
1311 This is the opposite of the @samp{--follow-tags} option. To skip
1312 certain HTML tags when recursively looking for documents to download,
1313 specify them in a comma-separated @var{list}.
1315 In the past, the @samp{-G} option was the best bet for downloading a
1316 single page and its requisites, using a commandline like:
1319 wget -Ga,area -H -k -K -r http://@var{site}/@var{document}
1322 However, the author of this option came across a page with tags like
1323 @code{<LINK REL="home" HREF="/">} and came to the realization that
1324 @samp{-G} was not enough. One can't just tell Wget to ignore
1325 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1326 best bet for downloading a single page and its requisites is the
1327 dedicated @samp{--page-requisites} option.
1331 Enable spanning across hosts when doing recursive retrieving
1332 (@pxref{Spanning Hosts}).
1336 Follow relative links only. Useful for retrieving a specific home page
1337 without any distractions, not even those from the same hosts
1338 (@pxref{Relative Links}).
1341 @itemx --include-directories=@var{list}
1342 Specify a comma-separated list of directories you wish to follow when
1343 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1344 of @var{list} may contain wildcards.
1347 @itemx --exclude-directories=@var{list}
1348 Specify a comma-separated list of directories you wish to exclude from
1349 download (@pxref{Directory-Based Limits} for more details.) Elements of
1350 @var{list} may contain wildcards.
1354 Do not ever ascend to the parent directory when retrieving recursively.
1355 This is a useful option, since it guarantees that only the files
1356 @emph{below} a certain hierarchy will be downloaded.
1357 @xref{Directory-Based Limits}, for more details.
1362 @node Recursive Retrieval, Following Links, Invoking, Top
1363 @chapter Recursive Retrieval
1366 @cindex recursive retrieval
1368 GNU Wget is capable of traversing parts of the Web (or a single
1369 @sc{http} or @sc{ftp} server), following links and directory structure.
1370 We refer to this as to @dfn{recursive retrieving}, or @dfn{recursion}.
1372 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1373 the given @sc{url}, documents, retrieving the files the @sc{html}
1374 document was referring to, through markups like @code{href}, or
1375 @code{src}. If the freshly downloaded file is also of type
1376 @code{text/html}, it will be parsed and followed further.
1378 Recursive retrieval of @sc{http} and @sc{html} content is
1379 @dfn{breadth-first}. This means that Wget first downloads the requested
1380 HTML document, then the documents linked from that document, then the
1381 documents linked by them, and so on. In other words, Wget first
1382 downloads the documents at depth 1, then those at depth 2, and so on
1383 until the specified maximum depth.
1385 The maximum @dfn{depth} to which the retrieval may descend is specified
1386 with the @samp{-l} option. The default maximum depth is five layers.
1388 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1389 the data from the given directory tree (including the subdirectories up
1390 to the specified depth) on the remote server, creating its mirror image
1391 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1392 parameter. Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1395 By default, Wget will create a local directory tree, corresponding to
1396 the one found on the remote server.
1398 Recursive retrieving can find a number of applications, the most
1399 important of which is mirroring. It is also useful for @sc{www}
1400 presentations, and any other opportunities where slow network
1401 connections should be bypassed by storing the files locally.
1403 You should be warned that recursive downloads can overload the remote
1404 servers. Because of that, many administrators frown upon them and may
1405 ban access from your site if they detect very fast downloads of big
1406 amounts of content. When downloading from Internet servers, consider
1407 using the @samp{-w} option to introduce a delay between accesses to the
1408 server. The download will take a while longer, but the server
1409 administrator will not be alarmed by your rudeness.
1411 Of course, recursive download may cause problems on your machine. If
1412 left to run unchecked, it can easily fill up the disk. If downloading
1413 from local network, it can also take bandwidth on the system, as well as
1414 consume memory and CPU.
1416 Try to specify the criteria that match the kind of download you are
1417 trying to achieve. If you want to download only one page, use
1418 @samp{--page-requisites} without any additional recursion. If you want
1419 to download things under one directory, use @samp{-np} to avoid
1420 downloading things from other directories. If you want to download all
1421 the files from one directory, use @samp{-l 1} to make sure the recursion
1422 depth never exceeds one. @xref{Following Links}, for more information
1425 Recursive retrieval should be used with care. Don't say you were not
1428 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1429 @chapter Following Links
1431 @cindex following links
1433 When retrieving recursively, one does not wish to retrieve loads of
1434 unnecessary data. Most of the time the users bear in mind exactly what
1435 they want to download, and want Wget to follow only specific links.
1437 For example, if you wish to download the music archive from
1438 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1439 that happen to be referenced by an obscure part of the archive.
1441 Wget possesses several mechanisms that allows you to fine-tune which
1442 links it will follow.
1445 * Spanning Hosts:: (Un)limiting retrieval based on host name.
1446 * Types of Files:: Getting only certain files.
1447 * Directory-Based Limits:: Getting only certain directories.
1448 * Relative Links:: Follow relative links only.
1449 * FTP Links:: Following FTP links.
1452 @node Spanning Hosts, Types of Files, Following Links, Following Links
1453 @section Spanning Hosts
1454 @cindex spanning hosts
1455 @cindex hosts, spanning
1457 Wget's recursive retrieval normally refuses to visit hosts different
1458 than the one you specified on the command line. This is a reasonable
1459 default; without it, every retrieval would have the potential to turn
1460 your Wget into a small version of google.
1462 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1463 a useful option. Maybe the images are served from a different server.
1464 Maybe you're mirroring a site that consists of pages interlinked between
1465 three servers. Maybe the server has two equivalent names, and the HTML
1466 pages refer to both interchangeably.
1469 @item Span to any host---@samp{-H}
1471 The @samp{-H} option turns on host spanning, thus allowing Wget's
1472 recursive run to visit any host referenced by a link. Unless sufficient
1473 recursion-limiting criteria are applied depth, these foreign hosts will
1474 typically link to yet more hosts, and so on until Wget ends up sucking
1475 up much more data than you have intended.
1477 @item Limit spanning to certain domains---@samp{-D}
1479 The @samp{-D} option allows you to specify the domains that will be
1480 followed, thus limiting the recursion only to the hosts that belong to
1481 these domains. Obviously, this makes sense only in conjunction with
1482 @samp{-H}. A typical example would be downloading the contents of
1483 @samp{www.server.com}, but allowing downloads from
1484 @samp{images.server.com}, etc.:
1487 wget -rH -Dserver.com http://www.server.com/
1490 You can specify more than one address by separating them with a comma,
1491 e.g. @samp{-Ddomain1.com,domain2.com}.
1493 @item Keep download off certain domains---@samp{--exclude-domains}
1495 If there are domains you want to exclude specifically, you can do it
1496 with @samp{--exclude-domains}, which accepts the same type of arguments
1497 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1498 example, if you want to download all the hosts from @samp{foo.edu}
1499 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1503 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
1509 @node Types of Files, Directory-Based Limits, Spanning Hosts, Following Links
1510 @section Types of Files
1511 @cindex types of files
1513 When downloading material from the web, you will often want to restrict
1514 the retrieval to only certain file types. For example, if you are
1515 interested in downloading @sc{gif}s, you will not be overjoyed to get
1516 loads of PostScript documents, and vice versa.
1518 Wget offers two options to deal with this problem. Each option
1519 description lists a short name, a long name, and the equivalent command
1522 @cindex accept wildcards
1523 @cindex accept suffixes
1524 @cindex wildcards, accept
1525 @cindex suffixes, accept
1527 @item -A @var{acclist}
1528 @itemx --accept @var{acclist}
1529 @itemx accept = @var{acclist}
1530 The argument to @samp{--accept} option is a list of file suffixes or
1531 patterns that Wget will download during recursive retrieval. A suffix
1532 is the ending part of a file, and consists of ``normal'' letters,
1533 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1534 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1536 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1537 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1538 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1539 download only files beginning with @samp{zelazny} and containing numbers
1540 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1541 a description of how pattern matching works.
1543 Of course, any number of suffixes and patterns can be combined into a
1544 comma-separated list, and given as an argument to @samp{-A}.
1546 @cindex reject wildcards
1547 @cindex reject suffixes
1548 @cindex wildcards, reject
1549 @cindex suffixes, reject
1550 @item -R @var{rejlist}
1551 @itemx --reject @var{rejlist}
1552 @itemx reject = @var{rejlist}
1553 The @samp{--reject} option works the same way as @samp{--accept}, only
1554 its logic is the reverse; Wget will download all files @emph{except} the
1555 ones matching the suffixes (or patterns) in the list.
1557 So, if you want to download a whole page except for the cumbersome
1558 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1559 Analogously, to download all files except the ones beginning with
1560 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1561 expansion by the shell.
1564 The @samp{-A} and @samp{-R} options may be combined to achieve even
1565 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1566 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1567 a part of their name, but @emph{not} the PostScript files.
1569 Note that these two options do not affect the downloading of @sc{html}
1570 files; Wget must load all the @sc{html}s to know where to go at
1571 all---recursive retrieval would make no sense otherwise.
1573 @node Directory-Based Limits, Relative Links, Types of Files, Following Links
1574 @section Directory-Based Limits
1576 @cindex directory limits
1578 Regardless of other link-following facilities, it is often useful to
1579 place the restriction of what files to retrieve based on the directories
1580 those files are placed in. There can be many reasons for this---the
1581 home pages may be organized in a reasonable directory structure; or some
1582 directories may contain useless information, e.g. @file{/cgi-bin} or
1583 @file{/dev} directories.
1585 Wget offers three different options to deal with this requirement. Each
1586 option description lists a short name, a long name, and the equivalent
1587 command in @file{.wgetrc}.
1589 @cindex directories, include
1590 @cindex include directories
1591 @cindex accept directories
1594 @itemx --include @var{list}
1595 @itemx include_directories = @var{list}
1596 @samp{-I} option accepts a comma-separated list of directories included
1597 in the retrieval. Any other directories will simply be ignored. The
1598 directories are absolute paths.
1600 So, if you wish to download from @samp{http://host/people/bozo/}
1601 following only links to bozo's colleagues in the @file{/people}
1602 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1605 wget -I /people,/cgi-bin http://host/people/bozo/
1608 @cindex directories, exclude
1609 @cindex exclude directories
1610 @cindex reject directories
1612 @itemx --exclude @var{list}
1613 @itemx exclude_directories = @var{list}
1614 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1615 directories @emph{excluded} from the download. E.g. if you do not want
1616 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1617 /cgi-bin} on the command line.
1619 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1620 to get a better fine-tuning of downloading subdirectories. E.g. if you
1621 want to load all the files from @file{/pub} hierarchy except for
1622 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1627 @itemx no_parent = on
1628 The simplest, and often very useful way of limiting directories is
1629 disallowing retrieval of the links that refer to the hierarchy
1630 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1631 parent directory/directories.
1633 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1634 Using it guarantees that you will never leave the existing hierarchy.
1635 Supposing you issue Wget with:
1638 wget -r --no-parent http://somehost/~luzer/my-archive/
1641 You may rest assured that none of the references to
1642 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1643 followed. Only the archive you are interested in will be downloaded.
1644 Essentially, @samp{--no-parent} is similar to
1645 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1646 intelligent fashion.
1649 @node Relative Links, FTP Links, Directory-Based Limits, Following Links
1650 @section Relative Links
1651 @cindex relative links
1653 When @samp{-L} is turned on, only the relative links are ever followed.
1654 Relative links are here defined those that do not refer to the web
1655 server root. For example, these links are relative:
1659 <a href="foo/bar.gif">
1660 <a href="../foo/bar.gif">
1663 These links are not relative:
1667 <a href="/foo/bar.gif">
1668 <a href="http://www.server.com/foo/bar.gif">
1671 Using this option guarantees that recursive retrieval will not span
1672 hosts, even without @samp{-H}. In simple cases it also allows downloads
1673 to ``just work'' without having to convert links.
1675 This option is probably not very useful and might be removed in a future
1678 @node FTP Links, , Relative Links, Following Links
1679 @section Following FTP Links
1680 @cindex following ftp links
1682 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1683 them to be. @sc{ftp} links in @sc{html} documents are often included
1684 for purposes of reference, and it is often inconvenient to download them
1687 To have @sc{ftp} links followed from @sc{html} documents, you need to
1688 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1689 links will span hosts regardless of @samp{-H} setting. This is logical,
1690 as @sc{ftp} links rarely point to the same host where the @sc{http}
1691 server resides. For similar reasons, the @samp{-L} options has no
1692 effect on such downloads. On the other hand, domain acceptance
1693 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1695 Also note that followed links to @sc{ftp} directories will not be
1696 retrieved recursively further.
1698 @node Time-Stamping, Startup File, Following Links, Top
1699 @chapter Time-Stamping
1700 @cindex time-stamping
1701 @cindex timestamping
1702 @cindex updating the archives
1703 @cindex incremental updating
1705 One of the most important aspects of mirroring information from the
1706 Internet is updating your archives.
1708 Downloading the whole archive again and again, just to replace a few
1709 changed files is expensive, both in terms of wasted bandwidth and money,
1710 and the time to do the update. This is why all the mirroring tools
1711 offer the option of incremental updating.
1713 Such an updating mechanism means that the remote server is scanned in
1714 search of @dfn{new} files. Only those new files will be downloaded in
1715 the place of the old ones.
1717 A file is considered new if one of these two conditions are met:
1721 A file of that name does not already exist locally.
1724 A file of that name does exist, but the remote file was modified more
1725 recently than the local file.
1728 To implement this, the program needs to be aware of the time of last
1729 modification of both local and remote files. We call this information the
1730 @dfn{time-stamp} of a file.
1732 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1733 (@samp{-N}) option, or through @code{timestamping = on} directive in
1734 @file{.wgetrc}. With this option, for each file it intends to download,
1735 Wget will check whether a local file of the same name exists. If it
1736 does, and the remote file is older, Wget will not download it.
1738 If the local file does not exist, or the sizes of the files do not
1739 match, Wget will download the remote file no matter what the time-stamps
1743 * Time-Stamping Usage::
1744 * HTTP Time-Stamping Internals::
1745 * FTP Time-Stamping Internals::
1748 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1749 @section Time-Stamping Usage
1750 @cindex time-stamping usage
1751 @cindex usage, time-stamping
1753 The usage of time-stamping is simple. Say you would like to download a
1754 file so that it keeps its date of modification.
1757 wget -S http://www.gnu.ai.mit.edu/
1760 A simple @code{ls -l} shows that the time stamp on the local file equals
1761 the state of the @code{Last-Modified} header, as returned by the server.
1762 As you can see, the time-stamping info is preserved locally, even
1763 without @samp{-N} (at least for @sc{http}).
1765 Several days later, you would like Wget to check if the remote file has
1766 changed, and download it if it has.
1769 wget -N http://www.gnu.ai.mit.edu/
1772 Wget will ask the server for the last-modified date. If the local file
1773 has the same timestamp as the server, or a newer one, the remote file
1774 will not be re-fetched. However, if the remote file is more recent,
1775 Wget will proceed to fetch it.
1777 The same goes for @sc{ftp}. For example:
1780 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
1783 (The quotes around that URL are to prevent the shell from trying to
1784 interpret the @samp{*}.)
1786 After download, a local directory listing will show that the timestamps
1787 match those on the remote server. Reissuing the command with @samp{-N}
1788 will make Wget re-fetch @emph{only} the files that have been modified
1789 since the last download.
1791 If you wished to mirror the GNU archive every week, you would use a
1792 command like the following, weekly:
1795 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
1798 Note that time-stamping will only work for files for which the server
1799 gives a timestamp. For @sc{http}, this depends on getting a
1800 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
1801 directory listing with dates in a format that Wget can parse
1802 (@pxref{FTP Time-Stamping Internals}).
1804 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1805 @section HTTP Time-Stamping Internals
1806 @cindex http time-stamping
1808 Time-stamping in @sc{http} is implemented by checking of the
1809 @code{Last-Modified} header. If you wish to retrieve the file
1810 @file{foo.html} through @sc{http}, Wget will check whether
1811 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1812 retrieved unconditionally.
1814 If the file does exist locally, Wget will first check its local
1815 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1816 @code{HEAD} request to the remote server, demanding the information on
1819 The @code{Last-Modified} header is examined to find which file was
1820 modified more recently (which makes it ``newer''). If the remote file
1821 is newer, it will be downloaded; if it is older, Wget will give
1822 up.@footnote{As an additional check, Wget will look at the
1823 @code{Content-Length} header, and compare the sizes; if they are not the
1824 same, the remote file will be downloaded no matter what the time-stamp
1827 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1828 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1829 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1830 @samp{@var{X}}, which will always differ if it's been converted by
1831 @samp{--convert-links} (@samp{-k}).
1833 Arguably, @sc{http} time-stamping should be implemented using the
1834 @code{If-Modified-Since} request.
1836 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1837 @section FTP Time-Stamping Internals
1838 @cindex ftp time-stamping
1840 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1841 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
1844 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
1845 @sc{ftp} @code{LIST} command to get a file listing for the directory
1846 containing the desired file(s). It will try to analyze the listing,
1847 treating it like Unix @code{ls -l} output, extracting the time-stamps.
1848 The rest is exactly the same as for @sc{http}. Note that when
1849 retrieving individual files from an @sc{ftp} server without using
1850 globbing or recursion, listing files will not be downloaded (and thus
1851 files will not be time-stamped) unless @samp{-N} is specified.
1853 Assumption that every directory listing is a Unix-style listing may
1854 sound extremely constraining, but in practice it is not, as many
1855 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1856 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1857 defines no standard way to get a file list, let alone the time-stamps.
1858 We can only hope that a future standard will define this.
1860 Another non-standard solution includes the use of @code{MDTM} command
1861 that is supported by some @sc{ftp} servers (including the popular
1862 @code{wu-ftpd}), which returns the exact time of the specified file.
1863 Wget may support this command in the future.
1865 @node Startup File, Examples, Time-Stamping, Top
1866 @chapter Startup File
1867 @cindex startup file
1873 Once you know how to change default settings of Wget through command
1874 line arguments, you may wish to make some of those settings permanent.
1875 You can do that in a convenient way by creating the Wget startup
1876 file---@file{.wgetrc}.
1878 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1879 convenient to have a special facility for storing passwords. Thus Wget
1880 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1881 it. You can find @file{.netrc} format in your system manuals.
1883 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1887 * Wgetrc Location:: Location of various wgetrc files.
1888 * Wgetrc Syntax:: Syntax of wgetrc.
1889 * Wgetrc Commands:: List of available commands.
1890 * Sample Wgetrc:: A wgetrc example.
1893 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1894 @section Wgetrc Location
1895 @cindex wgetrc location
1896 @cindex location of wgetrc
1898 When initializing, Wget will look for a @dfn{global} startup file,
1899 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1900 @file{/usr/local}, if Wget was not installed there) and read commands
1901 from there, if it exists.
1903 Then it will look for the user's file. If the environmental variable
1904 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1905 further attempts will be made.
1907 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1909 The fact that user's settings are loaded after the system-wide ones
1910 means that in case of collision user's wgetrc @emph{overrides} the
1911 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1912 Fascist admins, away!
1914 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1915 @section Wgetrc Syntax
1916 @cindex wgetrc syntax
1917 @cindex syntax of wgetrc
1919 The syntax of a wgetrc command is simple:
1925 The @dfn{variable} will also be called @dfn{command}. Valid
1926 @dfn{values} are different for different commands.
1928 The commands are case-insensitive and underscore-insensitive. Thus
1929 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1930 beginning with @samp{#} and lines containing white-space only are
1933 Commands that expect a comma-separated list will clear the list on an
1934 empty command. So, if you wish to reset the rejection list specified in
1935 global @file{wgetrc}, you can do it with:
1941 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1942 @section Wgetrc Commands
1943 @cindex wgetrc commands
1945 The complete set of commands is listed below. Legal values are listed
1946 after the @samp{=}. Simple Boolean values can be set or unset using
1947 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
1948 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
1949 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
1950 option is set to @samp{always} or @samp{never}, that value will be
1951 locked in for the duration of the Wget invocation---commandline options
1954 Some commands take pseudo-arbitrary values. @var{address} values can be
1955 hostnames or dotted-quad IP addresses. @var{n} can be any positive
1956 integer, or @samp{inf} for infinity, where appropriate. @var{string}
1957 values can be any non-empty string.
1959 Most of these commands have commandline equivalents (@pxref{Invoking}),
1960 though some of the more obscure or rarely used ones do not.
1963 @item accept/reject = @var{string}
1964 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
1966 @item add_hostdir = on/off
1967 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1969 @item continue = on/off
1970 If set to on, force continuation of preexistent partially retrieved
1971 files. See @samp{-c} before setting it.
1973 @item background = on/off
1974 Enable/disable going to background---the same as @samp{-b} (which
1977 @item backup_converted = on/off
1978 Enable/disable saving pre-converted files with the suffix
1979 @samp{.orig}---the same as @samp{-K} (which enables it).
1981 @c @item backups = @var{number}
1982 @c #### Document me!
1984 @item base = @var{string}
1985 Consider relative @sc{url}s in @sc{url} input files forced to be
1986 interpreted as @sc{html} as being relative to @var{string}---the same as
1989 @item bind_address = @var{address}
1990 Bind to @var{address}, like the @samp{--bind-address} option.
1992 @item cache = on/off
1993 When set to off, disallow server-caching. See the @samp{-C} option.
1995 @item convert links = on/off
1996 Convert non-relative links locally. The same as @samp{-k}.
1998 @item cookies = on/off
1999 When set to off, disallow cookies. See the @samp{--cookies} option.
2001 @item load_cookies = @var{file}
2002 Load cookies from @var{file}. See @samp{--load-cookies}.
2004 @item save_cookies = @var{file}
2005 Save cookies to @var{file}. See @samp{--save-cookies}.
2007 @item cut_dirs = @var{n}
2008 Ignore @var{n} remote directory components.
2010 @item debug = on/off
2011 Debug mode, same as @samp{-d}.
2013 @item delete_after = on/off
2014 Delete after download---the same as @samp{--delete-after}.
2016 @item dir_prefix = @var{string}
2017 Top of directory tree---the same as @samp{-P}.
2019 @item dirstruct = on/off
2020 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2023 @item domains = @var{string}
2024 Same as @samp{-D} (@pxref{Spanning Hosts}).
2026 @item dot_bytes = @var{n}
2027 Specify the number of bytes ``contained'' in a dot, as seen throughout
2028 the retrieval (1024 by default). You can postfix the value with
2029 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2030 respectively. With dot settings you can tailor the dot retrieval to
2031 suit your needs, or you can use the predefined @dfn{styles}
2032 (@pxref{Download Options}).
2034 @item dots_in_line = @var{n}
2035 Specify the number of dots that will be printed in each line throughout
2036 the retrieval (50 by default).
2038 @item dot_spacing = @var{n}
2039 Specify the number of dots in a single cluster (10 by default).
2041 @item exclude_directories = @var{string}
2042 Specify a comma-separated list of directories you wish to exclude from
2043 download---the same as @samp{-X} (@pxref{Directory-Based Limits}).
2045 @item exclude_domains = @var{string}
2046 Same as @samp{--exclude-domains} (@pxref{Spanning Hosts}).
2048 @item follow_ftp = on/off
2049 Follow @sc{ftp} links from @sc{html} documents---the same as
2050 @samp{--follow-ftp}.
2052 @item follow_tags = @var{string}
2053 Only follow certain HTML tags when doing a recursive retrieval, just like
2054 @samp{--follow-tags}.
2056 @item force_html = on/off
2057 If set to on, force the input filename to be regarded as an @sc{html}
2058 document---the same as @samp{-F}.
2060 @item ftp_proxy = @var{string}
2061 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2065 Turn globbing on/off---the same as @samp{-g}.
2067 @item header = @var{string}
2068 Define an additional header, like @samp{--header}.
2070 @item html_extension = on/off
2071 Add a @samp{.html} extension to @samp{text/html} files without it, like
2074 @item http_passwd = @var{string}
2075 Set @sc{http} password.
2077 @item http_proxy = @var{string}
2078 Use @var{string} as @sc{http} proxy, instead of the one specified in
2081 @item http_user = @var{string}
2082 Set @sc{http} user to @var{string}.
2084 @item ignore_length = on/off
2085 When set to on, ignore @code{Content-Length} header; the same as
2086 @samp{--ignore-length}.
2088 @item ignore_tags = @var{string}
2089 Ignore certain HTML tags when doing a recursive retrieval, just like
2090 @samp{-G} / @samp{--ignore-tags}.
2092 @item include_directories = @var{string}
2093 Specify a comma-separated list of directories you wish to follow when
2094 downloading---the same as @samp{-I}.
2096 @item input = @var{string}
2097 Read the @sc{url}s from @var{string}, like @samp{-i}.
2099 @item kill_longer = on/off
2100 Consider data longer than specified in content-length header as invalid
2101 (and retry getting it). The default behaviour is to save as much data
2102 as there is, provided there is more than or equal to the value in
2103 @code{Content-Length}.
2105 @item logfile = @var{string}
2106 Set logfile---the same as @samp{-o}.
2108 @item login = @var{string}
2109 Your user name on the remote machine, for @sc{ftp}. Defaults to
2112 @item mirror = on/off
2113 Turn mirroring on/off. The same as @samp{-m}.
2115 @item netrc = on/off
2116 Turn reading netrc on or off.
2118 @item noclobber = on/off
2121 @item no_parent = on/off
2122 Disallow retrieving outside the directory hierarchy, like
2123 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2125 @item no_proxy = @var{string}
2126 Use @var{string} as the comma-separated list of domains to avoid in
2127 proxy loading, instead of the one specified in environment.
2129 @item output_document = @var{string}
2130 Set the output filename---the same as @samp{-O}.
2132 @item page_requisites = on/off
2133 Download all ancillary documents necessary for a single HTML page to
2134 display properly---the same as @samp{-p}.
2136 @item passive_ftp = on/off/always/never
2137 Set passive @sc{ftp}---the same as @samp{--passive-ftp}. Some scripts
2138 and @samp{.pm} (Perl module) files download files using @samp{wget
2139 --passive-ftp}. If your firewall does not allow this, you can set
2140 @samp{passive_ftp = never} to override the commandline.
2142 @item passwd = @var{string}
2143 Set your @sc{ftp} password to @var{password}. Without this setting, the
2144 password defaults to @samp{username@@hostname.domainname}.
2146 @item progress = @var{string}
2147 Set the type of the progress indicator. Legal types are ``dot'' and
2150 @item proxy_user = @var{string}
2151 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
2153 @item proxy_passwd = @var{string}
2154 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
2156 @item referer = @var{string}
2157 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
2158 was the folks who wrote the @sc{http} spec who got the spelling of
2159 ``referrer'' wrong.)
2161 @item quiet = on/off
2162 Quiet mode---the same as @samp{-q}.
2164 @item quota = @var{quota}
2165 Specify the download quota, which is useful to put in the global
2166 @file{wgetrc}. When download quota is specified, Wget will stop
2167 retrieving after the download sum has become greater than quota. The
2168 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2169 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2170 to 5 mbytes. Note that the user's startup file overrides system
2173 @item reclevel = @var{n}
2174 Recursion level---the same as @samp{-l}.
2176 @item recursive = on/off
2177 Recursive on/off---the same as @samp{-r}.
2179 @item relative_only = on/off
2180 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2183 @item remove_listing = on/off
2184 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2185 to off is the same as @samp{-nr}.
2187 @item retr_symlinks = on/off
2188 When set to on, retrieve symbolic links as if they were plain files; the
2189 same as @samp{--retr-symlinks}.
2191 @item robots = on/off
2192 Use (or not) @file{/robots.txt} file (@pxref{Robots}). Be sure to know
2193 what you are doing before changing the default (which is @samp{on}).
2195 @item server_response = on/off
2196 Choose whether or not to print the @sc{http} and @sc{ftp} server
2197 responses---the same as @samp{-S}.
2199 @item span_hosts = on/off
2202 @item timeout = @var{n}
2203 Set timeout value---the same as @samp{-T}.
2205 @item timestamping = on/off
2206 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2208 @item tries = @var{n}
2209 Set number of retries per @sc{url}---the same as @samp{-t}.
2211 @item use_proxy = on/off
2212 Turn proxy support on/off. The same as @samp{-Y}.
2214 @item verbose = on/off
2215 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2217 @item wait = @var{n}
2218 Wait @var{n} seconds between retrievals---the same as @samp{-w}.
2220 @item waitretry = @var{n}
2221 Wait up to @var{n} seconds between retries of failed retrievals
2222 only---the same as @samp{--waitretry}. Note that this is turned on by
2223 default in the global @file{wgetrc}.
2225 @item randomwait = on/off
2226 Turn random between-request wait times on or off. The same as
2227 @samp{--random-wait}.
2230 @node Sample Wgetrc, , Wgetrc Commands, Startup File
2231 @section Sample Wgetrc
2232 @cindex sample wgetrc
2234 This is the sample initialization file, as given in the distribution.
2235 It is divided in two section---one for global usage (suitable for global
2236 startup file), and one for local usage (suitable for
2237 @file{$HOME/.wgetrc}). Be careful about the things you change.
2239 Note that almost all the lines are commented out. For a command to have
2240 any effect, you must remove the @samp{#} character at the beginning of
2244 @include sample.wgetrc.munged_for_texi_inclusion
2247 @node Examples, Various, Startup File, Top
2251 @c man begin EXAMPLES
2252 The examples are divided into three sections loosely based on their
2256 * Simple Usage:: Simple, basic usage of the program.
2257 * Advanced Usage:: Advanced tips.
2258 * Very Advanced Usage:: The hairy stuff.
2261 @node Simple Usage, Advanced Usage, Examples, Examples
2262 @section Simple Usage
2266 Say you want to download a @sc{url}. Just type:
2269 wget http://fly.srk.fer.hr/
2273 But what will happen if the connection is slow, and the file is lengthy?
2274 The connection will probably fail before the whole file is retrieved,
2275 more than once. In this case, Wget will try getting the file until it
2276 either gets the whole of it, or exceeds the default number of retries
2277 (this being 20). It is easy to change the number of tries to 45, to
2278 insure that the whole file will arrive safely:
2281 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2285 Now let's leave Wget to work in the background, and write its progress
2286 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2287 shall use @samp{-t}.
2290 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2293 The ampersand at the end of the line makes sure that Wget works in the
2294 background. To unlimit the number of retries, use @samp{-t inf}.
2297 The usage of @sc{ftp} is as simple. Wget will take care of login and
2301 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2305 If you specify a directory, Wget will retrieve the directory listing,
2306 parse it and convert it to @sc{html}. Try:
2309 wget ftp://prep.ai.mit.edu/pub/gnu/
2314 @node Advanced Usage, Very Advanced Usage, Simple Usage, Examples
2315 @section Advanced Usage
2319 You have a file that contains the URLs you want to download? Use the
2326 If you specify @samp{-} as file name, the @sc{url}s will be read from
2330 Create a five levels deep mirror image of the GNU web site, with the
2331 same directory structure the original has, with only one try per
2332 document, saving the log of the activities to @file{gnulog}:
2335 wget -r http://www.gnu.org/ -o gnulog
2339 The same as the above, but convert the links in the @sc{html} files to
2340 point to local files, so you can view the documents off-line:
2343 wget --convert-links -r http://www.gnu.org/ -o gnulog
2347 Retrieve only one HTML page, but make sure that all the elements needed
2348 for the page to be displayed, such as inline images and external style
2349 sheets, are also downloaded. Also make sure the downloaded page
2350 references the downloaded links.
2353 wget -p --convert-links http://www.server.com/dir/page.html
2356 The HTML page will be saved to @file{www.server.com/dir/page.html}, and
2357 the images, stylesheets, etc., somewhere under @file{www.server.com/},
2358 depending on where they were on the remote server.
2361 The same as the above, but without the @file{www.server.com/} directory.
2362 In fact, I don't want to have all those random server directories
2363 anyway---just save @emph{all} those files under a @file{download/}
2364 subdirectory of the current directory.
2367 wget -p --convert-links -nH -nd -Pdownload \
2368 http://www.server.com/dir/page.html
2372 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2376 wget -S http://www.lycos.com/
2380 Save the server headers with the file, perhaps for post-processing.
2383 wget -s http://www.lycos.com/
2388 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2392 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
2396 You want to download all the @sc{gif}s from a directory on an @sc{http}
2397 server. You tried @samp{wget http://www.server.com/dir/*.gif}, but that
2398 didn't work because @sc{http} retrieval does not support globbing. In
2402 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
2405 More verbose, but the effect is the same. @samp{-r -l1} means to
2406 retrieve recursively (@pxref{Recursive Retrieval}), with maximum depth
2407 of 1. @samp{--no-parent} means that references to the parent directory
2408 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2409 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2413 Suppose you were in the middle of downloading, when Wget was
2414 interrupted. Now you do not want to clobber the files already present.
2418 wget -nc -r http://www.gnu.org/
2422 If you want to encode your own username and password to @sc{http} or
2423 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2426 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
2429 Note, however, that this usage is not advisable on multi-user systems
2430 because it reveals your password to anyone who looks at the output of
2433 @cindex redirecting output
2435 You would like the output documents to go to standard output instead of
2439 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2442 You can also combine the two options and make pipelines to retrieve the
2443 documents from remote hotlists:
2446 wget -O - http://cool.list.com/ | wget --force-html -i -
2450 @node Very Advanced Usage, , Advanced Usage, Examples
2451 @section Very Advanced Usage
2456 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2457 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2458 for @samp{-r -l inf -N}. You can put Wget in the crontab file asking it
2459 to recheck a site each Sunday:
2463 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
2467 In addition to the above, you want the links to be converted for local
2468 viewing. But, after having read this manual, you know that link
2469 conversion doesn't play well with timestamping, so you also want Wget to
2470 back up the original HTML files before the conversion. Wget invocation
2471 would look like this:
2474 wget --mirror --convert-links --backup-converted \
2475 http://www.gnu.org/ -o /home/me/weeklog
2479 But you've also noticed that local viewing doesn't work all that well
2480 when HTML files are saved under extensions other than @samp{.html},
2481 perhaps because they were served as @file{index.cgi}. So you'd like
2482 Wget to rename all the files served with content-type @samp{text/html}
2483 to @file{@var{name}.html}.
2486 wget --mirror --convert-links --backup-converted \
2487 --html-extension -o /home/me/weeklog \
2491 Or, with less typing:
2494 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
2499 @node Various, Appendices, Examples, Top
2503 This chapter contains all the stuff that could not fit anywhere else.
2506 * Proxies:: Support for proxy servers
2507 * Distribution:: Getting the latest version.
2508 * Mailing List:: Wget mailing list for announcements and discussion.
2509 * Reporting Bugs:: How and where to report bugs.
2510 * Portability:: The systems Wget works on.
2511 * Signals:: Signal-handling performed by Wget.
2514 @node Proxies, Distribution, Various, Various
2518 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2519 data from remote servers to local clients. One typical use of proxies
2520 is lightening network load for users behind a slow connection. This is
2521 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2522 proxy which caches the transferred data. When a cached resource is
2523 requested again, proxy will return the data from cache. Another use for
2524 proxies is for companies that separate (for security reasons) their
2525 internal networks from the rest of Internet. In order to obtain
2526 information from the Web, their users connect and retrieve remote data
2527 using an authorized proxy.
2529 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2530 standard way to specify proxy location, which Wget recognizes, is using
2531 the following environment variables:
2535 This variable should contain the @sc{url} of the proxy for @sc{http}
2539 This variable should contain the @sc{url} of the proxy for @sc{ftp}
2540 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2541 are set to the same @sc{url}.
2544 This variable should contain a comma-separated list of domain extensions
2545 proxy should @emph{not} be used for. For instance, if the value of
2546 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2550 In addition to the environment variables, proxy location and settings
2551 may be specified from within Wget itself.
2555 @itemx --proxy=on/off
2556 @itemx proxy = on/off
2557 This option may be used to turn the proxy support on or off. Proxy
2558 support is on by default, provided that the appropriate environment
2561 @item http_proxy = @var{URL}
2562 @itemx ftp_proxy = @var{URL}
2563 @itemx no_proxy = @var{string}
2564 These startup file variables allow you to override the proxy settings
2565 specified by the environment.
2568 Some proxy servers require authorization to enable you to use them. The
2569 authorization consists of @dfn{username} and @dfn{password}, which must
2570 be sent by Wget. As with @sc{http} authorization, several
2571 authentication schemes exist. For proxy authorization only the
2572 @code{Basic} authentication scheme is currently implemented.
2574 You may specify your username and password either through the proxy
2575 @sc{url} or through the command-line options. Assuming that the
2576 company's proxy is located at @samp{proxy.company.com} at port 8001, a
2577 proxy @sc{url} location containing authorization data might look like
2581 http://hniksic:mypassword@@proxy.company.com:8001/
2584 Alternatively, you may use the @samp{proxy-user} and
2585 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2586 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2587 username and password.
2589 @node Distribution, Mailing List, Proxies, Various
2590 @section Distribution
2591 @cindex latest version
2593 Like all GNU utilities, the latest version of Wget can be found at the
2594 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2595 Wget @value{VERSION} can be found at
2596 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2598 @node Mailing List, Reporting Bugs, Distribution, Various
2599 @section Mailing List
2600 @cindex mailing list
2603 Wget has its own mailing list at @email{wget@@sunsite.dk}, thanks
2604 to Karsten Thygesen. The mailing list is for discussion of Wget
2605 features and web, reporting Wget bugs (those that you think may be of
2606 interest to the public) and mailing announcements. You are welcome to
2607 subscribe. The more people on the list, the better!
2609 To subscribe, send mail to @email{wget-subscribe@@sunsite.dk}.
2610 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2611 mailing to @email{wget-unsubscribe@@sunsite.dk}.
2613 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2614 Alternative archive is available at
2615 @url{http://www.mail-archive.com/wget%40sunsite.auc.dk/}.
2617 @node Reporting Bugs, Portability, Mailing List, Various
2618 @section Reporting Bugs
2620 @cindex reporting bugs
2624 You are welcome to send bug reports about GNU Wget to
2625 @email{bug-wget@@gnu.org}.
2627 Before actually submitting a bug report, please try to follow a few
2632 Please try to ascertain that the behaviour you see really is a bug. If
2633 Wget crashes, it's a bug. If Wget does not behave as documented,
2634 it's a bug. If things work strange, but you are not sure about the way
2635 they are supposed to work, it might well be a bug.
2638 Try to repeat the bug in as simple circumstances as possible. E.g. if
2639 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
2640 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
2641 repeatable, and if will occur with a simpler set of options. You might
2642 even try to start the download at the page where the crash occurred to
2643 see if that page somehow triggered the crash.
2645 Also, while I will probably be interested to know the contents of your
2646 @file{.wgetrc} file, just dumping it into the debug message is probably
2647 a bad idea. Instead, you should first try to see if the bug repeats
2648 with @file{.wgetrc} moved out of the way. Only if it turns out that
2649 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
2653 Please start Wget with @samp{-d} option and send the log (or the
2654 relevant parts of it). If Wget was compiled without debug support,
2655 recompile it. It is @emph{much} easier to trace bugs with debug support
2659 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2660 wget` core} and type @code{where} to get the backtrace.
2664 @node Portability, Signals, Reporting Bugs, Various
2665 @section Portability
2667 @cindex operating systems
2669 Since Wget uses GNU Autoconf for building and configuring, and avoids
2670 using ``special'' ultra--mega--cool features of any particular Unix, it
2671 should compile (and work) on all common Unix flavors.
2673 Various Wget versions have been compiled and tested under many kinds of
2674 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2675 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2676 distribution directory for a comprehensive list. If you compile it on
2677 an architecture not listed there, please let me know so I can update it.
2679 Wget should also compile on the other Unix systems, not listed in
2680 @file{MACHINES}. If it doesn't, please let me know.
2682 Thanks to kind contributors, this version of Wget compiles and works on
2683 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2684 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2685 with Winsock as networking software. Naturally, it is crippled of some
2686 features available on Unix, but it should work as a substitute for
2687 people stuck with Windows. Note that the Windows port is
2688 @strong{neither tested nor maintained} by me---all questions and
2689 problems should be reported to Wget mailing list at
2690 @email{wget@@sunsite.dk} where the maintainers will look at them.
2692 @node Signals, , Portability, Various
2694 @cindex signal handling
2697 Since the purpose of Wget is background work, it catches the hangup
2698 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2699 output, it will be redirected to a file named @file{wget-log}.
2700 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2701 to redirect the output of Wget after having started it.
2704 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2705 $ kill -HUP %% # Redirect the output to wget-log
2708 Other than that, Wget will not try to interfere with signals in any way.
2709 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
2711 @node Appendices, Copying, Various, Top
2714 This chapter contains some references I consider useful.
2717 * Robots:: Wget as a WWW robot.
2718 * Security Considerations:: Security with Wget.
2719 * Contributors:: People who helped.
2722 @node Robots, Security Considerations, Appendices, Appendices
2726 @cindex server maintenance
2728 It is extremely easy to make Wget wander aimlessly around a web site,
2729 sucking all the available data in progress. @samp{wget -r @var{site}},
2730 and you're set. Great? Not for the server admin.
2732 While Wget is retrieving static pages, there's not much of a problem.
2733 But for Wget, there is no real difference between a static page and the
2734 most demanding CGI. For instance, a site I know has a section handled
2735 by an, uh, @dfn{bitchin'} CGI script that converts all the Info files to
2736 HTML. The script can and does bring the machine to its knees without
2737 providing anything useful to the downloader.
2739 For such and similar cases various robot exclusion schemes have been
2740 devised as a means for the server administrators and document authors to
2741 protect chosen portions of their sites from the wandering of robots.
2743 The more popular mechanism is the @dfn{Robots Exclusion Standard}, or
2744 @sc{res}, written by Martijn Koster et al. in 1994. It specifies the
2745 format of a text file containing directives that instruct the robots
2746 which URL paths to avoid. To be found by the robots, the specifications
2747 must be placed in @file{/robots.txt} in the server root, which the
2748 robots are supposed to download and parse.
2750 Wget supports @sc{res} when downloading recursively. So, when you
2754 wget -r http://www.server.com/
2757 First the index of @samp{www.server.com} will be downloaded. If Wget
2758 finds that it wants to download more documents from that server, it will
2759 request @samp{http://www.server.com/robots.txt} and, if found, use it
2760 for further downloads. @file{robots.txt} is loaded only once per each
2763 Until version 1.8, Wget supported the first version of the standard,
2764 written by Martijn Koster in 1994 and available at
2765 @url{http://www.robotstxt.org/wc/norobots.html}. As of version 1.8,
2766 Wget has supported the additional directives specified in the internet
2767 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
2768 Robots Control''. The draft, which has as far as I know never made to
2769 an @sc{rfc}, is available at
2770 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
2772 This manual no longer includes the text of the Robot Exclusion Standard.
2774 The second, less known mechanism, enables the author of an individual
2775 document to specify whether they want the links from the file to be
2776 followed by a robot. This is achieved using the @code{META} tag, like
2780 <meta name="robots" content="nofollow">
2783 This is explained in some detail at
2784 @url{http://www.robotstxt.org/wc/meta-user.html}. Wget supports this
2785 method of robot exclusion in addition to the usual @file{/robots.txt}
2788 @node Security Considerations, Contributors, Robots, Appendices
2789 @section Security Considerations
2792 When using Wget, you must be aware that it sends unencrypted passwords
2793 through the network, which may present a security problem. Here are the
2794 main issues, and some solutions.
2797 @item The passwords on the command line are visible using @code{ps}.
2798 The best way around it is to use @code{wget -i -} and feed the @sc{url}s
2799 to Wget's standard input, each on a separate line, terminated by
2800 @kbd{C-d}. Another workaround is to use @file{.netrc} to store
2801 passwords; however, storing unencrypted passwords is also considered a
2805 Using the insecure @dfn{basic} authentication scheme, unencrypted
2806 passwords are transmitted through the network routers and gateways.
2809 The @sc{ftp} passwords are also in no way encrypted. There is no good
2810 solution for this at the moment.
2813 Although the ``normal'' output of Wget tries to hide the passwords,
2814 debugging logs show them, in all forms. This problem is avoided by
2815 being careful when you send debug logs (yes, even when you send them to
2819 @node Contributors, , Security Considerations, Appendices
2820 @section Contributors
2821 @cindex contributors
2824 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
2827 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
2829 However, its development could never have gone as far as it has, were it
2830 not for the help of many people, either with bug reports, feature
2831 proposals, patches, or letters saying ``Thanks!''.
2833 Special thanks goes to the following people (no particular order):
2837 Karsten Thygesen---donated system resources such as the mailing list,
2838 web space, and @sc{ftp} space, along with a lot of time to make these
2842 Shawn McHorse---bug reports and patches.
2845 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
2849 Gordon Matzigkeit---@file{.netrc} support.
2853 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2854 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2857 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2858 and ``philosophical'' discussions.
2862 Darko Budor---initial port to Windows.
2865 Antonio Rosella---help and suggestions, plus the Italian translation.
2869 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2873 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2878 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2881 Francois Pinard---many thorough bug reports and discussions.
2885 Karl Eichwalder---lots of help with internationalization and other
2889 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2893 The people who provided donations for development, including Brian
2897 The following people have provided patches, bug/build reports, useful
2898 suggestions, beta testing services, fan mail and all the other things
2899 that make maintenance so much fun:
2918 Kristijan @v{C}onka@v{s},
2936 Aleksandar Erkalovi@'{c},
2939 Aleksandar Erkalovic,
2955 Erik Magnus Hulthen,
2973 Goran Kezunovi@'{c},
2984 $\Sigma\acute{\iota}\mu o\varsigma\;
2985 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
2986 (Simos KSenitellis),
2994 Nicol@'{a}s Lichtmeier,
3000 Alexander V. Lukyanov,
3025 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3027 Juan Jos\'{e} Rodr\'{\i}gues,
3030 Juan Jose Rodrigues,
3042 Szakacsits Szabolcs,
3048 Douglas E. Wegscheid,
3058 Apologies to all who I accidentally left out, and many thanks to all the
3059 subscribers of the Wget mailing list.
3061 @node Copying, Concept Index, Appendices, Top
3066 @cindex free software
3068 GNU Wget is licensed under the GNU GPL, which makes it @dfn{free
3071 Please note that ``free'' in ``free software'' refers to liberty, not
3072 price. As some GNU project advocates like to point out, think of ``free
3073 speech'' rather than ``free beer''. The exact and legally binding
3074 distribution terms are spelled out below; in short, you have the right
3075 (freedom) to run and change Wget and distribute it to other people, and
3076 even---if you want---charge money for doing either. The important
3077 restriction is that you have to grant your recipients the same rights
3078 and impose the same restrictions.
3080 This method of licensing software is also known as @dfn{open source}
3081 because, among other things, it makes sure that all recipients will
3082 receive the source code along with the program, and be able to improve
3083 it. The GNU project prefers the term ``free software'' for reasons
3085 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3087 The exact license terms are defined by this paragraph and the GNU
3088 General Public License it refers to:
3091 GNU Wget is free software; you can redistribute it and/or modify it
3092 under the terms of the GNU General Public License as published by the
3093 Free Software Foundation; either version 2 of the License, or (at your
3094 option) any later version.
3096 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3097 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3098 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3101 A copy of the GNU General Public License is included as part of this
3102 manual; if you did not receive it, write to the Free Software
3103 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3106 In addition to this, this manual is free in the same sense:
3109 Permission is granted to copy, distribute and/or modify this document
3110 under the terms of the GNU Free Documentation License, Version 1.1 or
3111 any later version published by the Free Software Foundation; with the
3112 Invariant Sections being ``GNU General Public License'' and ``GNU Free
3113 Documentation License'', with no Front-Cover Texts, and with no
3114 Back-Cover Texts. A copy of the license is included in the section
3115 entitled ``GNU Free Documentation License''.
3118 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
3119 @c that the GFDL needs to be present in the manual, and to me it would
3120 @c suck to include the license for the manual and not the license for
3123 The full texts of the GNU General Public License and of the GNU Free
3124 Documentation License are available below.
3127 * GNU General Public License::
3128 * GNU Free Documentation License::
3131 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
3132 @section GNU General Public License
3133 @center Version 2, June 1991
3136 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3137 675 Mass Ave, Cambridge, MA 02139, USA
3139 Everyone is permitted to copy and distribute verbatim copies
3140 of this license document, but changing it is not allowed.
3143 @unnumberedsec Preamble
3145 The licenses for most software are designed to take away your
3146 freedom to share and change it. By contrast, the GNU General Public
3147 License is intended to guarantee your freedom to share and change free
3148 software---to make sure the software is free for all its users. This
3149 General Public License applies to most of the Free Software
3150 Foundation's software and to any other program whose authors commit to
3151 using it. (Some other Free Software Foundation software is covered by
3152 the GNU Library General Public License instead.) You can apply it to
3155 When we speak of free software, we are referring to freedom, not
3156 price. Our General Public Licenses are designed to make sure that you
3157 have the freedom to distribute copies of free software (and charge for
3158 this service if you wish), that you receive source code or can get it
3159 if you want it, that you can change the software or use pieces of it
3160 in new free programs; and that you know you can do these things.
3162 To protect your rights, we need to make restrictions that forbid
3163 anyone to deny you these rights or to ask you to surrender the rights.
3164 These restrictions translate to certain responsibilities for you if you
3165 distribute copies of the software, or if you modify it.
3167 For example, if you distribute copies of such a program, whether
3168 gratis or for a fee, you must give the recipients all the rights that
3169 you have. You must make sure that they, too, receive or can get the
3170 source code. And you must show them these terms so they know their
3173 We protect your rights with two steps: (1) copyright the software, and
3174 (2) offer you this license which gives you legal permission to copy,
3175 distribute and/or modify the software.
3177 Also, for each author's protection and ours, we want to make certain
3178 that everyone understands that there is no warranty for this free
3179 software. If the software is modified by someone else and passed on, we
3180 want its recipients to know that what they have is not the original, so
3181 that any problems introduced by others will not reflect on the original
3182 authors' reputations.
3184 Finally, any free program is threatened constantly by software
3185 patents. We wish to avoid the danger that redistributors of a free
3186 program will individually obtain patent licenses, in effect making the
3187 program proprietary. To prevent this, we have made it clear that any
3188 patent must be licensed for everyone's free use or not licensed at all.
3190 The precise terms and conditions for copying, distribution and
3191 modification follow.
3194 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3197 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3202 This License applies to any program or other work which contains
3203 a notice placed by the copyright holder saying it may be distributed
3204 under the terms of this General Public License. The ``Program'', below,
3205 refers to any such program or work, and a ``work based on the Program''
3206 means either the Program or any derivative work under copyright law:
3207 that is to say, a work containing the Program or a portion of it,
3208 either verbatim or with modifications and/or translated into another
3209 language. (Hereinafter, translation is included without limitation in
3210 the term ``modification''.) Each licensee is addressed as ``you''.
3212 Activities other than copying, distribution and modification are not
3213 covered by this License; they are outside its scope. The act of
3214 running the Program is not restricted, and the output from the Program
3215 is covered only if its contents constitute a work based on the
3216 Program (independent of having been made by running the Program).
3217 Whether that is true depends on what the Program does.
3220 You may copy and distribute verbatim copies of the Program's
3221 source code as you receive it, in any medium, provided that you
3222 conspicuously and appropriately publish on each copy an appropriate
3223 copyright notice and disclaimer of warranty; keep intact all the
3224 notices that refer to this License and to the absence of any warranty;
3225 and give any other recipients of the Program a copy of this License
3226 along with the Program.
3228 You may charge a fee for the physical act of transferring a copy, and
3229 you may at your option offer warranty protection in exchange for a fee.
3232 You may modify your copy or copies of the Program or any portion
3233 of it, thus forming a work based on the Program, and copy and
3234 distribute such modifications or work under the terms of Section 1
3235 above, provided that you also meet all of these conditions:
3239 You must cause the modified files to carry prominent notices
3240 stating that you changed the files and the date of any change.
3243 You must cause any work that you distribute or publish, that in
3244 whole or in part contains or is derived from the Program or any
3245 part thereof, to be licensed as a whole at no charge to all third
3246 parties under the terms of this License.
3249 If the modified program normally reads commands interactively
3250 when run, you must cause it, when started running for such
3251 interactive use in the most ordinary way, to print or display an
3252 announcement including an appropriate copyright notice and a
3253 notice that there is no warranty (or else, saying that you provide
3254 a warranty) and that users may redistribute the program under
3255 these conditions, and telling the user how to view a copy of this
3256 License. (Exception: if the Program itself is interactive but
3257 does not normally print such an announcement, your work based on
3258 the Program is not required to print an announcement.)
3261 These requirements apply to the modified work as a whole. If
3262 identifiable sections of that work are not derived from the Program,
3263 and can be reasonably considered independent and separate works in
3264 themselves, then this License, and its terms, do not apply to those
3265 sections when you distribute them as separate works. But when you
3266 distribute the same sections as part of a whole which is a work based
3267 on the Program, the distribution of the whole must be on the terms of
3268 this License, whose permissions for other licensees extend to the
3269 entire whole, and thus to each and every part regardless of who wrote it.
3271 Thus, it is not the intent of this section to claim rights or contest
3272 your rights to work written entirely by you; rather, the intent is to
3273 exercise the right to control the distribution of derivative or
3274 collective works based on the Program.
3276 In addition, mere aggregation of another work not based on the Program
3277 with the Program (or with a work based on the Program) on a volume of
3278 a storage or distribution medium does not bring the other work under
3279 the scope of this License.
3282 You may copy and distribute the Program (or a work based on it,
3283 under Section 2) in object code or executable form under the terms of
3284 Sections 1 and 2 above provided that you also do one of the following:
3288 Accompany it with the complete corresponding machine-readable
3289 source code, which must be distributed under the terms of Sections
3290 1 and 2 above on a medium customarily used for software interchange; or,
3293 Accompany it with a written offer, valid for at least three
3294 years, to give any third party, for a charge no more than your
3295 cost of physically performing source distribution, a complete
3296 machine-readable copy of the corresponding source code, to be
3297 distributed under the terms of Sections 1 and 2 above on a medium
3298 customarily used for software interchange; or,
3301 Accompany it with the information you received as to the offer
3302 to distribute corresponding source code. (This alternative is
3303 allowed only for noncommercial distribution and only if you
3304 received the program in object code or executable form with such
3305 an offer, in accord with Subsection b above.)
3308 The source code for a work means the preferred form of the work for
3309 making modifications to it. For an executable work, complete source
3310 code means all the source code for all modules it contains, plus any
3311 associated interface definition files, plus the scripts used to
3312 control compilation and installation of the executable. However, as a
3313 special exception, the source code distributed need not include
3314 anything that is normally distributed (in either source or binary
3315 form) with the major components (compiler, kernel, and so on) of the
3316 operating system on which the executable runs, unless that component
3317 itself accompanies the executable.
3319 If distribution of executable or object code is made by offering
3320 access to copy from a designated place, then offering equivalent
3321 access to copy the source code from the same place counts as
3322 distribution of the source code, even though third parties are not
3323 compelled to copy the source along with the object code.
3326 You may not copy, modify, sublicense, or distribute the Program
3327 except as expressly provided under this License. Any attempt
3328 otherwise to copy, modify, sublicense or distribute the Program is
3329 void, and will automatically terminate your rights under this License.
3330 However, parties who have received copies, or rights, from you under
3331 this License will not have their licenses terminated so long as such
3332 parties remain in full compliance.
3335 You are not required to accept this License, since you have not
3336 signed it. However, nothing else grants you permission to modify or
3337 distribute the Program or its derivative works. These actions are
3338 prohibited by law if you do not accept this License. Therefore, by
3339 modifying or distributing the Program (or any work based on the
3340 Program), you indicate your acceptance of this License to do so, and
3341 all its terms and conditions for copying, distributing or modifying
3342 the Program or works based on it.
3345 Each time you redistribute the Program (or any work based on the
3346 Program), the recipient automatically receives a license from the
3347 original licensor to copy, distribute or modify the Program subject to
3348 these terms and conditions. You may not impose any further
3349 restrictions on the recipients' exercise of the rights granted herein.
3350 You are not responsible for enforcing compliance by third parties to
3354 If, as a consequence of a court judgment or allegation of patent
3355 infringement or for any other reason (not limited to patent issues),
3356 conditions are imposed on you (whether by court order, agreement or
3357 otherwise) that contradict the conditions of this License, they do not
3358 excuse you from the conditions of this License. If you cannot
3359 distribute so as to satisfy simultaneously your obligations under this
3360 License and any other pertinent obligations, then as a consequence you
3361 may not distribute the Program at all. For example, if a patent
3362 license would not permit royalty-free redistribution of the Program by
3363 all those who receive copies directly or indirectly through you, then
3364 the only way you could satisfy both it and this License would be to
3365 refrain entirely from distribution of the Program.
3367 If any portion of this section is held invalid or unenforceable under
3368 any particular circumstance, the balance of the section is intended to
3369 apply and the section as a whole is intended to apply in other
3372 It is not the purpose of this section to induce you to infringe any
3373 patents or other property right claims or to contest validity of any
3374 such claims; this section has the sole purpose of protecting the
3375 integrity of the free software distribution system, which is
3376 implemented by public license practices. Many people have made
3377 generous contributions to the wide range of software distributed
3378 through that system in reliance on consistent application of that
3379 system; it is up to the author/donor to decide if he or she is willing
3380 to distribute software through any other system and a licensee cannot
3383 This section is intended to make thoroughly clear what is believed to
3384 be a consequence of the rest of this License.
3387 If the distribution and/or use of the Program is restricted in
3388 certain countries either by patents or by copyrighted interfaces, the
3389 original copyright holder who places the Program under this License
3390 may add an explicit geographical distribution limitation excluding
3391 those countries, so that distribution is permitted only in or among
3392 countries not thus excluded. In such case, this License incorporates
3393 the limitation as if written in the body of this License.
3396 The Free Software Foundation may publish revised and/or new versions
3397 of the General Public License from time to time. Such new versions will
3398 be similar in spirit to the present version, but may differ in detail to
3399 address new problems or concerns.
3401 Each version is given a distinguishing version number. If the Program
3402 specifies a version number of this License which applies to it and ``any
3403 later version'', you have the option of following the terms and conditions
3404 either of that version or of any later version published by the Free
3405 Software Foundation. If the Program does not specify a version number of
3406 this License, you may choose any version ever published by the Free Software
3410 If you wish to incorporate parts of the Program into other free
3411 programs whose distribution conditions are different, write to the author
3412 to ask for permission. For software which is copyrighted by the Free
3413 Software Foundation, write to the Free Software Foundation; we sometimes
3414 make exceptions for this. Our decision will be guided by the two goals
3415 of preserving the free status of all derivatives of our free software and
3416 of promoting the sharing and reuse of software generally.
3419 @heading NO WARRANTY
3427 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3428 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3429 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3430 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3431 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3432 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3433 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3434 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3435 REPAIR OR CORRECTION.
3438 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3439 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3440 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3441 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3442 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3443 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3444 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3445 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3446 POSSIBILITY OF SUCH DAMAGES.
3450 @heading END OF TERMS AND CONDITIONS
3453 @center END OF TERMS AND CONDITIONS
3457 @unnumberedsec How to Apply These Terms to Your New Programs
3459 If you develop a new program, and you want it to be of the greatest
3460 possible use to the public, the best way to achieve this is to make it
3461 free software which everyone can redistribute and change under these terms.
3463 To do so, attach the following notices to the program. It is safest
3464 to attach them to the start of each source file to most effectively
3465 convey the exclusion of warranty; and each file should have at least
3466 the ``copyright'' line and a pointer to where the full notice is found.
3469 @var{one line to give the program's name and an idea of what it does.}
3470 Copyright (C) 19@var{yy} @var{name of author}
3472 This program is free software; you can redistribute it and/or
3473 modify it under the terms of the GNU General Public License
3474 as published by the Free Software Foundation; either version 2
3475 of the License, or (at your option) any later version.
3477 This program is distributed in the hope that it will be useful,
3478 but WITHOUT ANY WARRANTY; without even the implied warranty of
3479 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3480 GNU General Public License for more details.
3482 You should have received a copy of the GNU General Public License
3483 along with this program; if not, write to the Free Software
3484 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3487 Also add information on how to contact you by electronic and paper mail.
3489 If the program is interactive, make it output a short notice like this
3490 when it starts in an interactive mode:
3493 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3494 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3495 type `show w'. This is free software, and you are welcome
3496 to redistribute it under certain conditions; type `show c'
3500 The hypothetical commands @samp{show w} and @samp{show c} should show
3501 the appropriate parts of the General Public License. Of course, the
3502 commands you use may be called something other than @samp{show w} and
3503 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3506 You should also get your employer (if you work as a programmer) or your
3507 school, if any, to sign a ``copyright disclaimer'' for the program, if
3508 necessary. Here is a sample; alter the names:
3512 Yoyodyne, Inc., hereby disclaims all copyright
3513 interest in the program `Gnomovision'
3514 (which makes passes at compilers) written
3517 @var{signature of Ty Coon}, 1 April 1989
3518 Ty Coon, President of Vice
3522 This General Public License does not permit incorporating your program into
3523 proprietary programs. If your program is a subroutine library, you may
3524 consider it more useful to permit linking proprietary applications with the
3525 library. If this is what you want to do, use the GNU Library General
3526 Public License instead of this License.
3528 @node GNU Free Documentation License, , GNU General Public License, Copying
3529 @section GNU Free Documentation License
3530 @center Version 1.1, March 2000
3533 Copyright (C) 2000 Free Software Foundation, Inc.
3534 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3536 Everyone is permitted to copy and distribute verbatim copies
3537 of this license document, but changing it is not allowed.
3544 The purpose of this License is to make a manual, textbook, or other
3545 written document ``free'' in the sense of freedom: to assure everyone
3546 the effective freedom to copy and redistribute it, with or without
3547 modifying it, either commercially or noncommercially. Secondarily,
3548 this License preserves for the author and publisher a way to get
3549 credit for their work, while not being considered responsible for
3550 modifications made by others.
3552 This License is a kind of ``copyleft'', which means that derivative
3553 works of the document must themselves be free in the same sense. It
3554 complements the GNU General Public License, which is a copyleft
3555 license designed for free software.
3557 We have designed this License in order to use it for manuals for free
3558 software, because free software needs free documentation: a free
3559 program should come with manuals providing the same freedoms that the
3560 software does. But this License is not limited to software manuals;
3561 it can be used for any textual work, regardless of subject matter or
3562 whether it is published as a printed book. We recommend this License
3563 principally for works whose purpose is instruction or reference.
3567 APPLICABILITY AND DEFINITIONS
3569 This License applies to any manual or other work that contains a
3570 notice placed by the copyright holder saying it can be distributed
3571 under the terms of this License. The ``Document'', below, refers to any
3572 such manual or work. Any member of the public is a licensee, and is
3573 addressed as ``you''.
3575 A ``Modified Version'' of the Document means any work containing the
3576 Document or a portion of it, either copied verbatim, or with
3577 modifications and/or translated into another language.
3579 A ``Secondary Section'' is a named appendix or a front-matter section of
3580 the Document that deals exclusively with the relationship of the
3581 publishers or authors of the Document to the Document's overall subject
3582 (or to related matters) and contains nothing that could fall directly
3583 within that overall subject. (For example, if the Document is in part a
3584 textbook of mathematics, a Secondary Section may not explain any
3585 mathematics.) The relationship could be a matter of historical
3586 connection with the subject or with related matters, or of legal,
3587 commercial, philosophical, ethical or political position regarding
3590 The ``Invariant Sections'' are certain Secondary Sections whose titles
3591 are designated, as being those of Invariant Sections, in the notice
3592 that says that the Document is released under this License.
3594 The ``Cover Texts'' are certain short passages of text that are listed,
3595 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3596 the Document is released under this License.
3598 A ``Transparent'' copy of the Document means a machine-readable copy,
3599 represented in a format whose specification is available to the
3600 general public, whose contents can be viewed and edited directly and
3601 straightforwardly with generic text editors or (for images composed of
3602 pixels) generic paint programs or (for drawings) some widely available
3603 drawing editor, and that is suitable for input to text formatters or
3604 for automatic translation to a variety of formats suitable for input
3605 to text formatters. A copy made in an otherwise Transparent file
3606 format whose markup has been designed to thwart or discourage
3607 subsequent modification by readers is not Transparent. A copy that is
3608 not ``Transparent'' is called ``Opaque''.
3610 Examples of suitable formats for Transparent copies include plain
3611 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3612 or XML using a publicly available DTD, and standard-conforming simple
3613 HTML designed for human modification. Opaque formats include
3614 PostScript, PDF, proprietary formats that can be read and edited only
3615 by proprietary word processors, SGML or XML for which the DTD and/or
3616 processing tools are not generally available, and the
3617 machine-generated HTML produced by some word processors for output
3620 The ``Title Page'' means, for a printed book, the title page itself,
3621 plus such following pages as are needed to hold, legibly, the material
3622 this License requires to appear in the title page. For works in
3623 formats which do not have any title page as such, ``Title Page'' means
3624 the text near the most prominent appearance of the work's title,
3625 preceding the beginning of the body of the text.
3630 You may copy and distribute the Document in any medium, either
3631 commercially or noncommercially, provided that this License, the
3632 copyright notices, and the license notice saying this License applies
3633 to the Document are reproduced in all copies, and that you add no other
3634 conditions whatsoever to those of this License. You may not use
3635 technical measures to obstruct or control the reading or further
3636 copying of the copies you make or distribute. However, you may accept
3637 compensation in exchange for copies. If you distribute a large enough
3638 number of copies you must also follow the conditions in section 3.
3640 You may also lend copies, under the same conditions stated above, and
3641 you may publicly display copies.
3646 If you publish printed copies of the Document numbering more than 100,
3647 and the Document's license notice requires Cover Texts, you must enclose
3648 the copies in covers that carry, clearly and legibly, all these Cover
3649 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3650 the back cover. Both covers must also clearly and legibly identify
3651 you as the publisher of these copies. The front cover must present
3652 the full title with all words of the title equally prominent and
3653 visible. You may add other material on the covers in addition.
3654 Copying with changes limited to the covers, as long as they preserve
3655 the title of the Document and satisfy these conditions, can be treated
3656 as verbatim copying in other respects.
3658 If the required texts for either cover are too voluminous to fit
3659 legibly, you should put the first ones listed (as many as fit
3660 reasonably) on the actual cover, and continue the rest onto adjacent
3663 If you publish or distribute Opaque copies of the Document numbering
3664 more than 100, you must either include a machine-readable Transparent
3665 copy along with each Opaque copy, or state in or with each Opaque copy
3666 a publicly-accessible computer-network location containing a complete
3667 Transparent copy of the Document, free of added material, which the
3668 general network-using public has access to download anonymously at no
3669 charge using public-standard network protocols. If you use the latter
3670 option, you must take reasonably prudent steps, when you begin
3671 distribution of Opaque copies in quantity, to ensure that this
3672 Transparent copy will remain thus accessible at the stated location
3673 until at least one year after the last time you distribute an Opaque
3674 copy (directly or through your agents or retailers) of that edition to
3677 It is requested, but not required, that you contact the authors of the
3678 Document well before redistributing any large number of copies, to give
3679 them a chance to provide you with an updated version of the Document.
3684 You may copy and distribute a Modified Version of the Document under
3685 the conditions of sections 2 and 3 above, provided that you release
3686 the Modified Version under precisely this License, with the Modified
3687 Version filling the role of the Document, thus licensing distribution
3688 and modification of the Modified Version to whoever possesses a copy
3689 of it. In addition, you must do these things in the Modified Version:
3691 A. Use in the Title Page (and on the covers, if any) a title distinct
3692 from that of the Document, and from those of previous versions
3693 (which should, if there were any, be listed in the History section
3694 of the Document). You may use the same title as a previous version
3695 if the original publisher of that version gives permission.@*
3696 B. List on the Title Page, as authors, one or more persons or entities
3697 responsible for authorship of the modifications in the Modified
3698 Version, together with at least five of the principal authors of the
3699 Document (all of its principal authors, if it has less than five).@*
3700 C. State on the Title page the name of the publisher of the
3701 Modified Version, as the publisher.@*
3702 D. Preserve all the copyright notices of the Document.@*
3703 E. Add an appropriate copyright notice for your modifications
3704 adjacent to the other copyright notices.@*
3705 F. Include, immediately after the copyright notices, a license notice
3706 giving the public permission to use the Modified Version under the
3707 terms of this License, in the form shown in the Addendum below.@*
3708 G. Preserve in that license notice the full lists of Invariant Sections
3709 and required Cover Texts given in the Document's license notice.@*
3710 H. Include an unaltered copy of this License.@*
3711 I. Preserve the section entitled ``History'', and its title, and add to
3712 it an item stating at least the title, year, new authors, and
3713 publisher of the Modified Version as given on the Title Page. If
3714 there is no section entitled ``History'' in the Document, create one
3715 stating the title, year, authors, and publisher of the Document as
3716 given on its Title Page, then add an item describing the Modified
3717 Version as stated in the previous sentence.@*
3718 J. Preserve the network location, if any, given in the Document for
3719 public access to a Transparent copy of the Document, and likewise
3720 the network locations given in the Document for previous versions
3721 it was based on. These may be placed in the ``History'' section.
3722 You may omit a network location for a work that was published at
3723 least four years before the Document itself, or if the original
3724 publisher of the version it refers to gives permission.@*
3725 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3726 preserve the section's title, and preserve in the section all the
3727 substance and tone of each of the contributor acknowledgements
3728 and/or dedications given therein.@*
3729 L. Preserve all the Invariant Sections of the Document,
3730 unaltered in their text and in their titles. Section numbers
3731 or the equivalent are not considered part of the section titles.@*
3732 M. Delete any section entitled ``Endorsements''. Such a section
3733 may not be included in the Modified Version.@*
3734 N. Do not retitle any existing section as ``Endorsements''
3735 or to conflict in title with any Invariant Section.@*
3737 If the Modified Version includes new front-matter sections or
3738 appendices that qualify as Secondary Sections and contain no material
3739 copied from the Document, you may at your option designate some or all
3740 of these sections as invariant. To do this, add their titles to the
3741 list of Invariant Sections in the Modified Version's license notice.
3742 These titles must be distinct from any other section titles.
3744 You may add a section entitled ``Endorsements'', provided it contains
3745 nothing but endorsements of your Modified Version by various
3746 parties--for example, statements of peer review or that the text has
3747 been approved by an organization as the authoritative definition of a
3750 You may add a passage of up to five words as a Front-Cover Text, and a
3751 passage of up to 25 words as a Back-Cover Text, to the end of the list
3752 of Cover Texts in the Modified Version. Only one passage of
3753 Front-Cover Text and one of Back-Cover Text may be added by (or
3754 through arrangements made by) any one entity. If the Document already
3755 includes a cover text for the same cover, previously added by you or
3756 by arrangement made by the same entity you are acting on behalf of,
3757 you may not add another; but you may replace the old one, on explicit
3758 permission from the previous publisher that added the old one.
3760 The author(s) and publisher(s) of the Document do not by this License
3761 give permission to use their names for publicity for or to assert or
3762 imply endorsement of any Modified Version.
3767 You may combine the Document with other documents released under this
3768 License, under the terms defined in section 4 above for modified
3769 versions, provided that you include in the combination all of the
3770 Invariant Sections of all of the original documents, unmodified, and
3771 list them all as Invariant Sections of your combined work in its
3774 The combined work need only contain one copy of this License, and
3775 multiple identical Invariant Sections may be replaced with a single
3776 copy. If there are multiple Invariant Sections with the same name but
3777 different contents, make the title of each such section unique by
3778 adding at the end of it, in parentheses, the name of the original
3779 author or publisher of that section if known, or else a unique number.
3780 Make the same adjustment to the section titles in the list of
3781 Invariant Sections in the license notice of the combined work.
3783 In the combination, you must combine any sections entitled ``History''
3784 in the various original documents, forming one section entitled
3785 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3786 and any sections entitled ``Dedications''. You must delete all sections
3787 entitled ``Endorsements.''
3790 COLLECTIONS OF DOCUMENTS
3792 You may make a collection consisting of the Document and other documents
3793 released under this License, and replace the individual copies of this
3794 License in the various documents with a single copy that is included in
3795 the collection, provided that you follow the rules of this License for
3796 verbatim copying of each of the documents in all other respects.
3798 You may extract a single document from such a collection, and distribute
3799 it individually under this License, provided you insert a copy of this
3800 License into the extracted document, and follow this License in all
3801 other respects regarding verbatim copying of that document.
3804 AGGREGATION WITH INDEPENDENT WORKS
3806 A compilation of the Document or its derivatives with other separate
3807 and independent documents or works, in or on a volume of a storage or
3808 distribution medium, does not as a whole count as a Modified Version
3809 of the Document, provided no compilation copyright is claimed for the
3810 compilation. Such a compilation is called an ``aggregate'', and this
3811 License does not apply to the other self-contained works thus compiled
3812 with the Document, on account of their being thus compiled, if they
3813 are not themselves derivative works of the Document.
3815 If the Cover Text requirement of section 3 is applicable to these
3816 copies of the Document, then if the Document is less than one quarter
3817 of the entire aggregate, the Document's Cover Texts may be placed on
3818 covers that surround only the Document within the aggregate.
3819 Otherwise they must appear on covers around the whole aggregate.
3824 Translation is considered a kind of modification, so you may
3825 distribute translations of the Document under the terms of section 4.
3826 Replacing Invariant Sections with translations requires special
3827 permission from their copyright holders, but you may include
3828 translations of some or all Invariant Sections in addition to the
3829 original versions of these Invariant Sections. You may include a
3830 translation of this License provided that you also include the
3831 original English version of this License. In case of a disagreement
3832 between the translation and the original English version of this
3833 License, the original English version will prevail.
3838 You may not copy, modify, sublicense, or distribute the Document except
3839 as expressly provided for under this License. Any other attempt to
3840 copy, modify, sublicense or distribute the Document is void, and will
3841 automatically terminate your rights under this License. However,
3842 parties who have received copies, or rights, from you under this
3843 License will not have their licenses terminated so long as such
3844 parties remain in full compliance.
3847 FUTURE REVISIONS OF THIS LICENSE
3849 The Free Software Foundation may publish new, revised versions
3850 of the GNU Free Documentation License from time to time. Such new
3851 versions will be similar in spirit to the present version, but may
3852 differ in detail to address new problems or concerns. See
3853 http://www.gnu.org/copyleft/.
3855 Each version of the License is given a distinguishing version number.
3856 If the Document specifies that a particular numbered version of this
3857 License ``or any later version'' applies to it, you have the option of
3858 following the terms and conditions either of that specified version or
3859 of any later version that has been published (not as a draft) by the
3860 Free Software Foundation. If the Document does not specify a version
3861 number of this License, you may choose any version ever published (not
3862 as a draft) by the Free Software Foundation.
3866 @unnumberedsec ADDENDUM: How to use this License for your documents
3868 To use this License in a document you have written, include a copy of
3869 the License in the document and put the following copyright and
3870 license notices just after the title page:
3875 Copyright (C) @var{year} @var{your name}.
3876 Permission is granted to copy, distribute and/or modify this document
3877 under the terms of the GNU Free Documentation License, Version 1.1
3878 or any later version published by the Free Software Foundation;
3879 with the Invariant Sections being @var{list their titles}, with the
3880 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
3881 A copy of the license is included in the section entitled ``GNU
3882 Free Documentation License''.
3885 If you have no Invariant Sections, write ``with no Invariant Sections''
3886 instead of saying which ones are invariant. If you have no
3887 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
3888 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
3890 If your document contains nontrivial examples of program code, we
3891 recommend releasing these examples in parallel under your choice of
3892 free software license, such as the GNU General Public License,
3893 to permit their use in free software.
3896 @node Concept Index, , Copying, Top
3897 @unnumbered Concept Index