1 \input texinfo @c -*-texinfo-*-
5 @settitle GNU Wget Manual
6 @c Disable the monstrous rectangles beside overfull hbox-es.
8 @c Use `odd' to print double-sided.
13 @c Remove this if you don't use A4 paper.
17 @c This should really be auto-generated!
19 @set UPDATED December 2001
21 @dircategory Net Utilities
22 @dircategory World Wide Web
24 * Wget: (wget). The non-interactive network downloader.
28 This file documents the the GNU Wget utility for downloading network
31 @c man begin COPYRIGHT
32 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
35 Permission is granted to make and distribute verbatim copies of
36 this manual provided the copyright notice and this permission notice
37 are preserved on all copies.
40 Permission is granted to process this file through TeX and print the
41 results, provided the printed document carries a copying permission
42 notice identical to this one except for the removal of this paragraph
43 (this paragraph not being relevant to the printed manual).
45 Permission is granted to copy, distribute and/or modify this document
46 under the terms of the GNU Free Documentation License, Version 1.1 or
47 any later version published by the Free Software Foundation; with the
48 Invariant Sections being ``GNU General Public License'' and ``GNU Free
49 Documentation License'', with no Front-Cover Texts, and with no
50 Back-Cover Texts. A copy of the license is included in the section
51 entitled ``GNU Free Documentation License''.
57 @subtitle The noninteractive downloading utility
58 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
59 @author by Hrvoje Nik@v{s}i@'{c} and the developers
63 Originally written by Hrvoje Niksic <hniksic@arsdigita.com>.
66 GNU Info entry for @file{wget}.
71 @vskip 0pt plus 1filll
72 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
75 Permission is granted to copy, distribute and/or modify this document
76 under the terms of the GNU Free Documentation License, Version 1.1 or
77 any later version published by the Free Software Foundation; with the
78 Invariant Sections being ``GNU General Public License'' and ``GNU Free
79 Documentation License'', with no Front-Cover Texts, and with no
80 Back-Cover Texts. A copy of the license is included in the section
81 entitled ``GNU Free Documentation License''.
85 @node Top, Overview, (dir), (dir)
86 @top Wget @value{VERSION}
88 This manual documents version @value{VERSION} of GNU Wget, the freely
89 available utility for network download.
91 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
95 * Overview:: Features of Wget.
96 * Invoking:: Wget command-line arguments.
97 * Recursive Retrieval:: Description of recursive retrieval.
98 * Following Links:: The available methods of chasing links.
99 * Time-Stamping:: Mirroring according to time-stamps.
100 * Startup File:: Wget's initialization file.
101 * Examples:: Examples of usage.
102 * Various:: The stuff that doesn't fit anywhere else.
103 * Appendices:: Some useful references.
104 * Copying:: You may give out copies of Wget and of this manual.
105 * Concept Index:: Topics covered by this manual.
109 @node Overview, Invoking, Top, Top
114 @c man begin DESCRIPTION
115 GNU Wget is a free utility for non-interactive download of files from
116 the Web. It supports @sc{http}, @sc{https}, and @sc{ftp} protocols, as
117 well as retrieval through @sc{http} proxies.
120 This chapter is a partial overview of Wget's features.
124 @c man begin DESCRIPTION
125 Wget is non-interactive, meaning that it can work in the background,
126 while the user is not logged on. This allows you to start a retrieval
127 and disconnect from the system, letting Wget finish the work. By
128 contrast, most of the Web browsers require constant user's presence,
129 which can be a great hindrance when transferring a lot of data.
135 @c man begin DESCRIPTION
139 @c man begin DESCRIPTION
140 Wget can follow links in @sc{html} pages and create local versions of
141 remote web sites, fully recreating the directory structure of the
142 original site. This is sometimes referred to as ``recursive
143 downloading.'' While doing that, Wget respects the Robot Exclusion
144 Standard (@file{/robots.txt}). Wget can be instructed to convert the
145 links in downloaded @sc{html} files to the local files for offline
151 File name wildcard matching and recursive mirroring of directories are
152 available when retrieving via @sc{ftp}. Wget can read the time-stamp
153 information given by both @sc{http} and @sc{ftp} servers, and store it
154 locally. Thus Wget can see if the remote file has changed since last
155 retrieval, and automatically retrieve the new version if it has. This
156 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
162 @c man begin DESCRIPTION
166 @c man begin DESCRIPTION
167 Wget has been designed for robustness over slow or unstable network
168 connections; if a download fails due to a network problem, it will
169 keep retrying until the whole file has been retrieved. If the server
170 supports regetting, it will instruct the server to continue the
171 download from where it left off.
176 Wget supports proxy servers, which can lighten the network load, speed
177 up retrieval and provide access behind firewalls. However, if you are
178 behind a firewall that requires that you use a socks style gateway, you
179 can get the socks library and build Wget with support for socks. Wget
180 also supports the passive @sc{ftp} downloading as an option.
184 Builtin features offer mechanisms to tune which links you wish to follow
185 (@pxref{Following Links}).
189 The retrieval is conveniently traced with printing dots, each dot
190 representing a fixed amount of data received (1KB by default). These
191 representations can be customized to your preferences.
195 Most of the features are fully configurable, either through command line
196 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
197 File}). Wget allows you to define @dfn{global} startup files
198 (@file{/usr/local/etc/wgetrc} by default) for site settings.
203 @item /usr/local/etc/wgetrc
204 Default location of the @dfn{global} startup file.
214 Finally, GNU Wget is free software. This means that everyone may use
215 it, redistribute it and/or modify it under the terms of the GNU General
216 Public License, as published by the Free Software Foundation
220 @node Invoking, Recursive Retrieval, Overview, Top
227 By default, Wget is very simple to invoke. The basic syntax is:
230 @c man begin SYNOPSIS
231 wget [@var{option}]@dots{} [@var{URL}]@dots{}
235 Wget will simply download all the @sc{url}s specified on the command
236 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
238 However, you may wish to change some of the default parameters of
239 Wget. You can do it two ways: permanently, adding the appropriate
240 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
246 * Basic Startup Options::
247 * Logging and Input File Options::
249 * Directory Options::
252 * Recursive Retrieval Options::
253 * Recursive Accept/Reject Options::
256 @node URL Format, Option Syntax, Invoking, Invoking
261 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
262 resource locator is a compact string representation for a resource
263 available via the Internet. Wget recognizes the @sc{url} syntax as per
264 @sc{rfc1738}. This is the most widely used form (square brackets denote
268 http://host[:port]/directory/file
269 ftp://host[:port]/directory/file
272 You can also encode your username and password within a @sc{url}:
275 ftp://user:password@@host/path
276 http://user:password@@host/path
279 Either @var{user} or @var{password}, or both, may be left out. If you
280 leave out either the @sc{http} username or password, no authentication
281 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
282 will be used. If you leave out the @sc{ftp} password, your email
283 address will be supplied as a default password.@footnote{If you have a
284 @file{.netrc} file in your home directory, password will also be
287 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
288 being the hexadecimal representation of the character's @sc{ascii}
289 value. Some common unsafe characters include @samp{%} (quoted as
290 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
291 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
294 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
295 default, @sc{ftp} documents are retrieved in the binary mode (type
296 @samp{i}), which means that they are downloaded unchanged. Another
297 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
298 delimiters between the different operating systems, and is thus useful
299 for text files. Here is an example:
302 ftp://host/directory/file;type=a
305 Two alternative variants of @sc{url} specification are also supported,
306 because of historical (hysterical?) reasons and their widespreaded use.
308 @sc{ftp}-only syntax (supported by @code{NcFTP}):
313 @sc{http}-only syntax (introduced by @code{Netscape}):
318 These two alternative forms are deprecated, and may cease being
319 supported in the future.
321 If you do not understand the difference between these notations, or do
322 not know which one to use, just use the plain ordinary format you use
323 with your favorite browser, like @code{Lynx} or @code{Netscape}.
325 @node Option Syntax, Basic Startup Options, URL Format, Invoking
326 @section Option Syntax
327 @cindex option syntax
328 @cindex syntax of options
330 Since Wget uses GNU getopts to process its arguments, every option has a
331 short form and a long form. Long options are more convenient to
332 remember, but take time to type. You may freely mix different option
333 styles, or specify options after the command-line arguments. Thus you
337 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
340 The space between the option accepting an argument and the argument may
341 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
343 You may put several options that do not require arguments together,
350 This is a complete equivalent of:
353 wget -d -r -c @var{URL}
356 Since the options can be specified after the arguments, you may
357 terminate them with @samp{--}. So the following will try to download
358 @sc{url} @samp{-x}, reporting failure to @file{log}:
364 The options that accept comma-separated lists all respect the convention
365 that specifying an empty list clears its value. This can be useful to
366 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
367 sets @code{exclude_directories} to @file{/cgi-bin}, the following
368 example will first reset it, and then set it to exclude @file{/~nobody}
369 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
370 (@pxref{Wgetrc Syntax}).
373 wget -X '' -X /~nobody,/~somebody
378 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
379 @section Basic Startup Options
384 Display the version of Wget.
388 Print a help message describing all of Wget's command-line options.
392 Go to background immediately after startup. If no output file is
393 specified via the @samp{-o}, output is redirected to @file{wget-log}.
395 @cindex execute wgetrc command
396 @item -e @var{command}
397 @itemx --execute @var{command}
398 Execute @var{command} as if it were a part of @file{.wgetrc}
399 (@pxref{Startup File}). A command thus invoked will be executed
400 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
404 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
405 @section Logging and Input File Options
410 @item -o @var{logfile}
411 @itemx --output-file=@var{logfile}
412 Log all messages to @var{logfile}. The messages are normally reported
415 @cindex append to log
416 @item -a @var{logfile}
417 @itemx --append-output=@var{logfile}
418 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
419 to @var{logfile} instead of overwriting the old log file. If
420 @var{logfile} does not exist, a new file is created.
425 Turn on debug output, meaning various information important to the
426 developers of Wget if it does not work properly. Your system
427 administrator may have chosen to compile Wget without debug support, in
428 which case @samp{-d} will not work. Please note that compiling with
429 debug support is always safe---Wget compiled with the debug support will
430 @emph{not} print any debug info unless requested with @samp{-d}.
431 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
437 Turn off Wget's output.
442 Turn on verbose output, with all the available data. The default output
447 Non-verbose output---turn off verbose without being completely quiet
448 (use @samp{-q} for that), which means that error messages and basic
449 information still get printed.
453 @itemx --input-file=@var{file}
454 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
455 the command line. If there are @sc{url}s both on the command line and
456 in an input file, those on the command lines will be the first ones to
457 be retrieved. The @var{file} need not be an @sc{html} document (but no
458 harm if it is)---it is enough if the @sc{url}s are just listed
461 However, if you specify @samp{--force-html}, the document will be
462 regarded as @samp{html}. In that case you may have problems with
463 relative links, which you can solve either by adding @code{<base
464 href="@var{url}">} to the documents or by specifying
465 @samp{--base=@var{url}} on the command line.
470 When input is read from a file, force it to be treated as an @sc{html}
471 file. This enables you to retrieve relative links from existing
472 @sc{html} files on your local disk, by adding @code{<base
473 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
476 @cindex base for relative links in input file
478 @itemx --base=@var{URL}
479 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
480 links in the file specified by @samp{-i}.
483 @node Download Options, Directory Options, Logging and Input File Options, Invoking
484 @section Download Options
487 @cindex bind() address
488 @cindex client IP address
489 @cindex IP address, client
490 @item --bind-address=@var{ADDRESS}
491 When making client TCP/IP connections, @code{bind()} to @var{ADDRESS} on
492 the local machine. @var{ADDRESS} may be specified as a hostname or IP
493 address. This option can be useful if your machine is bound to multiple
498 @cindex number of retries
499 @item -t @var{number}
500 @itemx --tries=@var{number}
501 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
505 @itemx --output-document=@var{file}
506 The documents will not be written to the appropriate files, but all will
507 be concatenated together and written to @var{file}. If @var{file}
508 already exists, it will be overwritten. If the @var{file} is @samp{-},
509 the documents will be written to standard output. Including this option
510 automatically sets the number of tries to 1.
512 @cindex clobbering, file
513 @cindex downloading multiple times
517 If a file is downloaded more than once in the same directory, Wget's
518 behavior depends on a few options, including @samp{-nc}. In certain
519 cases, the local file will be @dfn{clobbered}, or overwritten, upon
520 repeated download. In other cases it will be preserved.
522 When running Wget without @samp{-N}, @samp{-nc}, or @samp{-r},
523 downloading the same file in the same directory will result in the
524 original copy of @var{file} being preserved and the second copy being
525 named @samp{@var{file}.1}. If that file is downloaded yet again, the
526 third copy will be named @samp{@var{file}.2}, and so on. When
527 @samp{-nc} is specified, this behavior is suppressed, and Wget will
528 refuse to download newer copies of @samp{@var{file}}. Therefore,
529 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
530 clobbering that's prevented (as the numeric suffixes were already
531 preventing clobbering), but rather the multiple version saving that's
534 When running Wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
535 re-downloading a file will result in the new copy simply overwriting the
536 old. Adding @samp{-nc} will prevent this behavior, instead causing the
537 original version to be preserved and any newer copies on the server to
540 When running Wget with @samp{-N}, with or without @samp{-r}, the
541 decision as to whether or not to download a newer copy of a file depends
542 on the local and remote timestamp and size of the file
543 (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the same
546 Note that when @samp{-nc} is specified, files with the suffixes
547 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
548 and parsed as if they had been retrieved from the Web.
550 @cindex continue retrieval
551 @cindex incomplete downloads
552 @cindex resume download
555 Continue getting a partially-downloaded file. This is useful when you
556 want to finish up a download started by a previous instance of Wget, or
557 by another program. For instance:
560 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
563 If there is a file named @file{ls-lR.Z} in the current directory, Wget
564 will assume that it is the first portion of the remote file, and will
565 ask the server to continue the retrieval from an offset equal to the
566 length of the local file.
568 Note that you don't need to specify this option if you just want the
569 current invocation of Wget to retry downloading a file should the
570 connection be lost midway through. This is the default behavior.
571 @samp{-c} only affects resumption of downloads started @emph{prior} to
572 this invocation of Wget, and whose local files are still sitting around.
574 Without @samp{-c}, the previous example would just download the remote
575 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
578 Beginning with Wget 1.7, if you use @samp{-c} on a non-empty file, and
579 it turns out that the server does not support continued downloading,
580 Wget will refuse to start the download from scratch, which would
581 effectively ruin existing contents. If you really want the download to
582 start from scratch, remove the file.
584 Also beginning with Wget 1.7, if you use @samp{-c} on a file which is of
585 equal size as the one on the server, Wget will refuse to download the
586 file and print an explanatory message. The same happens when the file
587 is smaller on the server than locally (presumably because it was changed
588 on the server since your last download attempt)---because ``continuing''
589 is not meaningful, no download occurs.
591 On the other side of the coin, while using @samp{-c}, any file that's
592 bigger on the server than locally will be considered an incomplete
593 download and only @code{(length(remote) - length(local))} bytes will be
594 downloaded and tacked onto the end of the local file. This behavior can
595 be desirable in certain cases---for instance, you can use @samp{wget -c}
596 to download just the new portion that's been appended to a data
597 collection or log file.
599 However, if the file is bigger on the server because it's been
600 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
601 with a garbled file. Wget has no way of verifying that the local file
602 is really a valid prefix of the remote file. You need to be especially
603 careful of this when using @samp{-c} in conjunction with @samp{-r},
604 since every file will be considered as an "incomplete download" candidate.
606 Another instance where you'll get a garbled file if you try to use
607 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
608 ``transfer interrupted'' string into the local file. In the future a
609 ``rollback'' option may be added to deal with this case.
611 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
612 servers that support the @code{Range} header.
614 @cindex progress indicator
616 @item --progress=@var{type}
617 Select the type of the progress indicator you wish to use. Legal
618 indicators are ``dot'' and ``bar''.
620 The ``dot'' indicator is used by default. It traces the retrieval by
621 printing dots on the screen, each dot representing a fixed amount of
624 When using the dotted retrieval, you may also set the @dfn{style} by
625 specifying the type as @samp{dot:@var{style}}. Different styles assign
626 different meaning to one dot. With the @code{default} style each dot
627 represents 1K, there are ten dots in a cluster and 50 dots in a line.
628 The @code{binary} style has a more ``computer''-like orientation---8K
629 dots, 16-dots clusters and 48 dots per line (which makes for 384K
630 lines). The @code{mega} style is suitable for downloading very large
631 files---each dot represents 64K retrieved, there are eight dots in a
632 cluster, and 48 dots on each line (so each line contains 3M).
634 Specifying @samp{--progress=bar} will draw a nice ASCII progress bar
635 graphics (a.k.a ``thermometer'' display) to indicate retrieval. If the
636 output is not a TTY, this option will be ignored, and Wget will revert
637 to the dot indicator. If you want to force the bar indicator, use
638 @samp{--progress=bar:force}.
641 @itemx --timestamping
642 Turn on time-stamping. @xref{Time-Stamping}, for details.
644 @cindex server response, print
646 @itemx --server-response
647 Print the headers sent by @sc{http} servers and responses sent by
650 @cindex Wget as spider
653 When invoked with this option, Wget will behave as a Web @dfn{spider},
654 which means that it will not download the pages, just check that they
655 are there. You can use it to check your bookmarks, e.g. with:
658 wget --spider --force-html -i bookmarks.html
661 This feature needs much more work for Wget to get close to the
662 functionality of real @sc{www} spiders.
666 @itemx --timeout=@var{seconds}
667 Set the read timeout to @var{seconds} seconds. Whenever a network read
668 is issued, the file descriptor is checked for a timeout, which could
669 otherwise leave a pending connection (uninterrupted read). The default
670 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
671 disable checking for timeouts.
673 Please do not lower the default timeout value with this option unless
674 you know what you are doing.
678 @item -w @var{seconds}
679 @itemx --wait=@var{seconds}
680 Wait the specified number of seconds between the retrievals. Use of
681 this option is recommended, as it lightens the server load by making the
682 requests less frequent. Instead of in seconds, the time can be
683 specified in minutes using the @code{m} suffix, in hours using @code{h}
684 suffix, or in days using @code{d} suffix.
686 Specifying a large value for this option is useful if the network or the
687 destination host is down, so that Wget can wait long enough to
688 reasonably expect the network error to be fixed before the retry.
690 @cindex retries, waiting between
691 @cindex waiting between retries
692 @item --waitretry=@var{seconds}
693 If you don't want Wget to wait between @emph{every} retrieval, but only
694 between retries of failed downloads, you can use this option. Wget will
695 use @dfn{linear backoff}, waiting 1 second after the first failure on a
696 given file, then waiting 2 seconds after the second failure on that
697 file, up to the maximum number of @var{seconds} you specify. Therefore,
698 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
701 Note that this option is turned on by default in the global
707 Some web sites may perform log analysis to identify retrieval programs
708 such as Wget by looking for statistically significant similarities in
709 the time between requests. This option causes the time between requests
710 to vary between 0 and 2 * @var{wait} seconds, where @var{wait} was
711 specified using the @samp{-w} or @samp{--wait} options, in order to mask
712 Wget's presence from such analysis.
714 A recent article in a publication devoted to development on a popular
715 consumer platform provided code to perform this analysis on the fly.
716 Its author suggested blocking at the class C address level to ensure
717 automated retrieval programs were blocked despite changing DHCP-supplied
720 The @samp{--random-wait} option was inspired by this ill-advised
721 recommendation to block many unrelated users from a web site due to the
726 @itemx --proxy=on/off
727 Turn proxy support on or off. The proxy is on by default if the
728 appropriate environmental variable is defined.
732 @itemx --quota=@var{quota}
733 Specify download quota for automatic retrievals. The value can be
734 specified in bytes (default), kilobytes (with @samp{k} suffix), or
735 megabytes (with @samp{m} suffix).
737 Note that quota will never affect downloading a single file. So if you
738 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
739 @file{ls-lR.gz} will be downloaded. The same goes even when several
740 @sc{url}s are specified on the command-line. However, quota is
741 respected when retrieving either recursively, or from an input file.
742 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
743 aborted when the quota is exceeded.
745 Setting quota to 0 or to @samp{inf} unlimits the download quota.
748 @node Directory Options, HTTP Options, Download Options, Invoking
749 @section Directory Options
753 @itemx --no-directories
754 Do not create a hierarchy of directories when retrieving recursively.
755 With this option turned on, all files will get saved to the current
756 directory, without clobbering (if a name shows up more than once, the
757 filenames will get extensions @samp{.n}).
760 @itemx --force-directories
761 The opposite of @samp{-nd}---create a hierarchy of directories, even if
762 one would not have been created otherwise. E.g. @samp{wget -x
763 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
764 @file{fly.srk.fer.hr/robots.txt}.
767 @itemx --no-host-directories
768 Disable generation of host-prefixed directories. By default, invoking
769 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
770 directories beginning with @file{fly.srk.fer.hr/}. This option disables
773 @cindex cut directories
774 @item --cut-dirs=@var{number}
775 Ignore @var{number} directory components. This is useful for getting a
776 fine-grained control over the directory where recursive retrieval will
779 Take, for example, the directory at
780 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
781 @samp{-r}, it will be saved locally under
782 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
783 remove the @file{ftp.xemacs.org/} part, you are still stuck with
784 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
785 makes Wget not ``see'' @var{number} remote directory components. Here
786 are several examples of how @samp{--cut-dirs} option works.
790 No options -> ftp.xemacs.org/pub/xemacs/
792 -nH --cut-dirs=1 -> xemacs/
793 -nH --cut-dirs=2 -> .
795 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
800 If you just want to get rid of the directory structure, this option is
801 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
802 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
803 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
804 be placed to @file{xemacs/beta}, as one would expect.
806 @cindex directory prefix
807 @item -P @var{prefix}
808 @itemx --directory-prefix=@var{prefix}
809 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
810 directory where all other files and subdirectories will be saved to,
811 i.e. the top of the retrieval tree. The default is @samp{.} (the
815 @node HTTP Options, FTP Options, Directory Options, Invoking
816 @section HTTP Options
819 @cindex .html extension
821 @itemx --html-extension
822 If a file of type @samp{text/html} is downloaded and the URL does not
823 end with the regexp @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause
824 the suffix @samp{.html} to be appended to the local filename. This is
825 useful, for instance, when you're mirroring a remote site that uses
826 @samp{.asp} pages, but you want the mirrored pages to be viewable on
827 your stock Apache server. Another good use for this is when you're
828 downloading the output of CGIs. A URL like
829 @samp{http://site.com/article.cgi?25} will be saved as
830 @file{article.cgi?25.html}.
832 Note that filenames changed in this way will be re-downloaded every time
833 you re-mirror a site, because Wget can't tell that the local
834 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
835 it doesn't yet know that the URL produces output of type
836 @samp{text/html}. To prevent this re-downloading, you must use
837 @samp{-k} and @samp{-K} so that the original version of the file will be
838 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
841 @cindex http password
842 @cindex authentication
843 @item --http-user=@var{user}
844 @itemx --http-passwd=@var{password}
845 Specify the username @var{user} and password @var{password} on an
846 @sc{http} server. According to the type of the challenge, Wget will
847 encode them using either the @code{basic} (insecure) or the
848 @code{digest} authentication scheme.
850 Another way to specify username and password is in the @sc{url} itself
851 (@pxref{URL Format}). For more information about security issues with
852 Wget, @xref{Security Considerations}.
857 @itemx --cache=on/off
858 When set to off, disable server-side cache. In this case, Wget will
859 send the remote server an appropriate directive (@samp{Pragma:
860 no-cache}) to get the file from the remote service, rather than
861 returning the cached version. This is especially useful for retrieving
862 and flushing out-of-date documents on proxy servers.
864 Caching is allowed by default.
867 @item --cookies=on/off
868 When set to off, disable the use of cookies. Cookies are a mechanism
869 for maintaining server-side state. The server sends the client a cookie
870 using the @code{Set-Cookie} header, and the client responds with the
871 same cookie upon further requests. Since cookies allow the server
872 owners to keep track of visitors and for sites to exchange this
873 information, some consider them a breach of privacy. The default is to
874 use cookies; however, @emph{storing} cookies is not on by default.
876 @cindex loading cookies
877 @cindex cookies, loading
878 @item --load-cookies @var{file}
879 Load cookies from @var{file} before the first HTTP retrieval.
880 @var{file} is a textual file in the format originally used by Netscape's
881 @file{cookies.txt} file.
883 You will typically use this option when mirroring sites that require
884 that you be logged in to access some or all of their content. The login
885 process typically works by the web server issuing an @sc{http} cookie
886 upon receiving and verifying your credentials. The cookie is then
887 resent by the browser when accessing that part of the site, and so
888 proves your identity.
890 Mirroring such a site requires Wget to send the same cookies your
891 browser sends when communicating with the site. This is achieved by
892 @samp{--load-cookies}---simply point Wget to the location of the
893 @file{cookies.txt} file, and it will send the same cookies your browser
894 would send in the same situation. Different browsers keep textual
895 cookie files in different locations:
899 The cookies are in @file{~/.netscape/cookies.txt}.
901 @item Mozilla and Netscape 6.x.
902 Mozilla's cookie file is also named @file{cookies.txt}, located
903 somewhere under @file{~/.mozilla}, in the directory of your profile.
904 The full path usually ends up looking somewhat like
905 @file{~/.mozilla/default/@var{some-weird-string}/cookies.txt}.
907 @item Internet Explorer.
908 You can produce a cookie file Wget can use by using the File menu,
909 Import and Export, Export Cookies. This has been tested with Internet
910 Explorer 5; it is not guaranteed to work with earlier versions.
912 @item Other browsers.
913 If you are using a different browser to create your cookies,
914 @samp{--load-cookies} will only work if you can locate or produce a
915 cookie file in the Netscape format that Wget expects.
918 If you cannot use @samp{--load-cookies}, there might still be an
919 alternative. If your browser supports a ``cookie manager'', you can use
920 it to view the cookies used when accessing the site you're mirroring.
921 Write down the name and value of the cookie, and manually instruct Wget
922 to send those cookies, bypassing the ``official'' cookie support:
925 wget --cookies=off --header "Cookie: @var{name}=@var{value}"
928 @cindex saving cookies
929 @cindex cookies, saving
930 @item --save-cookies @var{file}
931 Save cookies from @var{file} at the end of session. Cookies whose
932 expiry time is not specified, or those that have already expired, are
935 @cindex Content-Length, ignore
936 @cindex ignore length
937 @item --ignore-length
938 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
939 precise) send out bogus @code{Content-Length} headers, which makes Wget
940 go wild, as it thinks not all the document was retrieved. You can spot
941 this syndrome if Wget retries getting the same document again and again,
942 each time claiming that the (otherwise normal) connection has closed on
945 With this option, Wget will ignore the @code{Content-Length} header---as
949 @item --header=@var{additional-header}
950 Define an @var{additional-header} to be passed to the @sc{http} servers.
951 Headers must contain a @samp{:} preceded by one or more non-blank
952 characters, and must not contain newlines.
954 You may define more than one additional header by specifying
955 @samp{--header} more than once.
959 wget --header='Accept-Charset: iso-8859-2' \
960 --header='Accept-Language: hr' \
961 http://fly.srk.fer.hr/
965 Specification of an empty string as the header value will clear all
966 previous user-defined headers.
969 @cindex proxy password
970 @cindex proxy authentication
971 @item --proxy-user=@var{user}
972 @itemx --proxy-passwd=@var{password}
973 Specify the username @var{user} and password @var{password} for
974 authentication on a proxy server. Wget will encode them using the
975 @code{basic} authentication scheme.
978 @cindex referer, http
979 @item --referer=@var{url}
980 Include `Referer: @var{url}' header in HTTP request. Useful for
981 retrieving documents with server-side processing that assume they are
982 always being retrieved by interactive web browsers and only come out
983 properly when Referer is set to one of the pages that point to them.
985 @cindex server response, save
987 @itemx --save-headers
988 Save the headers sent by the @sc{http} server to the file, preceding the
989 actual contents, with an empty line as the separator.
992 @item -U @var{agent-string}
993 @itemx --user-agent=@var{agent-string}
994 Identify as @var{agent-string} to the @sc{http} server.
996 The @sc{http} protocol allows the clients to identify themselves using a
997 @code{User-Agent} header field. This enables distinguishing the
998 @sc{www} software, usually for statistical purposes or for tracing of
999 protocol violations. Wget normally identifies as
1000 @samp{Wget/@var{version}}, @var{version} being the current version
1003 However, some sites have been known to impose the policy of tailoring
1004 the output according to the @code{User-Agent}-supplied information.
1005 While conceptually this is not such a bad idea, it has been abused by
1006 servers denying information to clients other than @code{Mozilla} or
1007 Microsoft @code{Internet Explorer}. This option allows you to change
1008 the @code{User-Agent} line issued by Wget. Use of this option is
1009 discouraged, unless you really know what you are doing.
1012 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
1013 @section FTP Options
1016 @cindex .listing files, removing
1018 @itemx --dont-remove-listing
1019 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1020 retrievals. Normally, these files contain the raw directory listings
1021 received from @sc{ftp} servers. Not removing them can be useful for
1022 debugging purposes, or when you want to be able to easily check on the
1023 contents of remote server directories (e.g. to verify that a mirror
1024 you're running is complete).
1026 Note that even though Wget writes to a known filename for this file,
1027 this is not a security hole in the scenario of a user making
1028 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1029 asking @code{root} to run Wget in his or her directory. Depending on
1030 the options used, either Wget will refuse to write to @file{.listing},
1031 making the globbing/recursion/time-stamping operation fail, or the
1032 symbolic link will be deleted and replaced with the actual
1033 @file{.listing} file, or the listing will be written to a
1034 @file{.listing.@var{number}} file.
1036 Even though this situation isn't a problem, though, @code{root} should
1037 never run Wget in a non-trusted user's directory. A user could do
1038 something as simple as linking @file{index.html} to @file{/etc/passwd}
1039 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1040 will be overwritten.
1042 @cindex globbing, toggle
1044 @itemx --glob=on/off
1045 Turn @sc{ftp} globbing on or off. Globbing means you may use the
1046 shell-like special characters (@dfn{wildcards}), like @samp{*},
1047 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
1048 same directory at once, like:
1051 wget ftp://gnjilux.srk.fer.hr/*.msg
1054 By default, globbing will be turned on if the @sc{url} contains a
1055 globbing character. This option may be used to turn globbing on or off
1058 You may have to quote the @sc{url} to protect it from being expanded by
1059 your shell. Globbing makes Wget look for a directory listing, which is
1060 system-specific. This is why it currently works only with Unix @sc{ftp}
1061 servers (and the ones emulating Unix @code{ls} output).
1065 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
1066 initiates the data connection. This is sometimes required for @sc{ftp}
1067 to work behind firewalls.
1069 @cindex symbolic links, retrieving
1070 @item --retr-symlinks
1071 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1072 link is encountered, the linked-to file is not downloaded. Instead, a
1073 matching symbolic link is created on the local filesystem. The
1074 pointed-to file will not be downloaded unless this recursive retrieval
1075 would have encountered it separately and downloaded it anyway.
1077 When @samp{--retr-symlinks} is specified, however, symbolic links are
1078 traversed and the pointed-to files are retrieved. At this time, this
1079 option does not cause Wget to traverse symlinks to directories and
1080 recurse through them, but in the future it should be enhanced to do
1083 Note that when retrieving a file (not a directory) because it was
1084 specified on the commandline, rather than because it was recursed to,
1085 this option has no effect. Symbolic links are always traversed in this
1089 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
1090 @section Recursive Retrieval Options
1095 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
1098 @item -l @var{depth}
1099 @itemx --level=@var{depth}
1100 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1101 Retrieval}). The default maximum depth is 5.
1103 @cindex proxy filling
1104 @cindex delete after retrieval
1105 @cindex filling proxy cache
1106 @item --delete-after
1107 This option tells Wget to delete every single file it downloads,
1108 @emph{after} having done so. It is useful for pre-fetching popular
1109 pages through a proxy, e.g.:
1112 wget -r -nd --delete-after http://whatever.com/~popular/page/
1115 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1118 Note that @samp{--delete-after} deletes files on the local machine. It
1119 does not issue the @samp{DELE} command to remote FTP sites, for
1120 instance. Also note that when @samp{--delete-after} is specified,
1121 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1122 created in the first place.
1124 @cindex conversion of links
1125 @cindex link conversion
1127 @itemx --convert-links
1128 After the download is complete, convert the links in the document to
1129 make them suitable for local viewing. This affects not only the visible
1130 hyperlinks, but any part of the document that links to external content,
1131 such as embedded images, links to style sheets, hyperlinks to non-HTML
1134 Each link will be changed in one of the two ways:
1138 The links to files that have been downloaded by Wget will be changed to
1139 refer to the file they point to as a relative link.
1141 Example: if the downloaded file @file{/foo/doc.html} links to
1142 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1143 will be modified to point to @samp{../bar/img.gif}. This kind of
1144 transformation works reliably for arbitrary combinations of directories.
1147 The links to files that have not been downloaded by Wget will be changed
1148 to include host name and absolute path of the location they point to.
1150 Example: if the downloaded file @file{/foo/doc.html} links to
1151 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1152 @file{doc.html} will be modified to point to
1153 @file{http://@var{hostname}/bar/img.gif}.
1156 Because of this, local browsing works reliably: if a linked file was
1157 downloaded, the link will refer to its local name; if it was not
1158 downloaded, the link will refer to its full Internet address rather than
1159 presenting a broken link. The fact that the former links are converted
1160 to relative links ensures that you can move the downloaded hierarchy to
1163 Note that only at the end of the download can Wget know which links have
1164 been downloaded. Because of that, the work done by @samp{-k} will be
1165 performed at the end of all the downloads.
1167 @cindex backing up converted files
1169 @itemx --backup-converted
1170 When converting a file, back up the original version with a @samp{.orig}
1171 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1176 Turn on options suitable for mirroring. This option turns on recursion
1177 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1178 directory listings. It is currently equivalent to
1179 @samp{-r -N -l inf -nr}.
1181 @cindex page requisites
1182 @cindex required images, downloading
1184 @itemx --page-requisites
1185 This option causes Wget to download all the files that are necessary to
1186 properly display a given HTML page. This includes such things as
1187 inlined images, sounds, and referenced stylesheets.
1189 Ordinarily, when downloading a single HTML page, any requisite documents
1190 that may be needed to display it properly are not downloaded. Using
1191 @samp{-r} together with @samp{-l} can help, but since Wget does not
1192 ordinarily distinguish between external and inlined documents, one is
1193 generally left with ``leaf documents'' that are missing their
1196 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1197 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1198 document @file{2.html}. Say that @file{2.html} is similar but that its
1199 image is @file{2.gif} and it links to @file{3.html}. Say this
1200 continues up to some arbitrarily high number.
1202 If one executes the command:
1205 wget -r -l 2 http://@var{site}/1.html
1208 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1209 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1210 without its requisite @file{3.gif} because Wget is simply counting the
1211 number of hops (up to 2) away from @file{1.html} in order to determine
1212 where to stop the recursion. However, with this command:
1215 wget -r -l 2 -p http://@var{site}/1.html
1218 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1219 will be downloaded. Similarly,
1222 wget -r -l 1 -p http://@var{site}/1.html
1225 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1226 to be downloaded. One might think that:
1229 wget -r -l 0 -p http://@var{site}/1.html
1232 would download just @file{1.html} and @file{1.gif}, but unfortunately
1233 this is not the case, because @samp{-l 0} is equivalent to
1234 @samp{-l inf}---that is, infinite recursion. To download a single HTML
1235 page (or a handful of them, all specified on the commandline or in a
1236 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1237 @samp{-r} and @samp{-l}:
1240 wget -p http://@var{site}/1.html
1243 Note that Wget will behave as if @samp{-r} had been specified, but only
1244 that single page and its requisites will be downloaded. Links from that
1245 page to external documents will not be followed. Actually, to download
1246 a single page and all its requisites (even if they exist on separate
1247 websites), and make sure the lot displays properly locally, this author
1248 likes to use a few options in addition to @samp{-p}:
1251 wget -E -H -k -K -p http://@var{site}/@var{document}
1254 To finish off this topic, it's worth knowing that Wget's idea of an
1255 external document link is any URL specified in an @code{<A>} tag, an
1256 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1260 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1261 @section Recursive Accept/Reject Options
1264 @item -A @var{acclist} --accept @var{acclist}
1265 @itemx -R @var{rejlist} --reject @var{rejlist}
1266 Specify comma-separated lists of file name suffixes or patterns to
1267 accept or reject (@pxref{Types of Files} for more details).
1269 @item -D @var{domain-list}
1270 @itemx --domains=@var{domain-list}
1271 Set domains to be followed. @var{domain-list} is a comma-separated list
1272 of domains. Note that it does @emph{not} turn on @samp{-H}.
1274 @item --exclude-domains @var{domain-list}
1275 Specify the domains that are @emph{not} to be followed.
1276 (@pxref{Spanning Hosts}).
1278 @cindex follow FTP links
1280 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1281 Wget will ignore all the @sc{ftp} links.
1283 @cindex tag-based recursive pruning
1284 @item --follow-tags=@var{list}
1285 Wget has an internal table of HTML tag / attribute pairs that it
1286 considers when looking for linked documents during a recursive
1287 retrieval. If a user wants only a subset of those tags to be
1288 considered, however, he or she should be specify such tags in a
1289 comma-separated @var{list} with this option.
1292 @itemx --ignore-tags=@var{list}
1293 This is the opposite of the @samp{--follow-tags} option. To skip
1294 certain HTML tags when recursively looking for documents to download,
1295 specify them in a comma-separated @var{list}.
1297 In the past, the @samp{-G} option was the best bet for downloading a
1298 single page and its requisites, using a commandline like:
1301 wget -Ga,area -H -k -K -r http://@var{site}/@var{document}
1304 However, the author of this option came across a page with tags like
1305 @code{<LINK REL="home" HREF="/">} and came to the realization that
1306 @samp{-G} was not enough. One can't just tell Wget to ignore
1307 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1308 best bet for downloading a single page and its requisites is the
1309 dedicated @samp{--page-requisites} option.
1313 Enable spanning across hosts when doing recursive retrieving
1314 (@pxref{Spanning Hosts}).
1318 Follow relative links only. Useful for retrieving a specific home page
1319 without any distractions, not even those from the same hosts
1320 (@pxref{Relative Links}).
1323 @itemx --include-directories=@var{list}
1324 Specify a comma-separated list of directories you wish to follow when
1325 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1326 of @var{list} may contain wildcards.
1329 @itemx --exclude-directories=@var{list}
1330 Specify a comma-separated list of directories you wish to exclude from
1331 download (@pxref{Directory-Based Limits} for more details.) Elements of
1332 @var{list} may contain wildcards.
1336 Do not ever ascend to the parent directory when retrieving recursively.
1337 This is a useful option, since it guarantees that only the files
1338 @emph{below} a certain hierarchy will be downloaded.
1339 @xref{Directory-Based Limits}, for more details.
1344 @node Recursive Retrieval, Following Links, Invoking, Top
1345 @chapter Recursive Retrieval
1348 @cindex recursive retrieval
1350 GNU Wget is capable of traversing parts of the Web (or a single
1351 @sc{http} or @sc{ftp} server), following links and directory structure.
1352 We refer to this as to @dfn{recursive retrieving}, or @dfn{recursion}.
1354 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1355 the given @sc{url}, documents, retrieving the files the @sc{html}
1356 document was referring to, through markups like @code{href}, or
1357 @code{src}. If the freshly downloaded file is also of type
1358 @code{text/html}, it will be parsed and followed further.
1360 Recursive retrieval of @sc{http} and @sc{html} content is
1361 @dfn{breadth-first}. This means that Wget first downloads the requested
1362 HTML document, then the documents linked from that document, then the
1363 documents linked by them, and so on. In other words, Wget first
1364 downloads the documents at depth 1, then those at depth 2, and so on
1365 until the specified maximum depth.
1367 The maximum @dfn{depth} to which the retrieval may descend is specified
1368 with the @samp{-l} option. The default maximum depth is five layers.
1370 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1371 the data from the given directory tree (including the subdirectories up
1372 to the specified depth) on the remote server, creating its mirror image
1373 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1374 parameter. Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1377 By default, Wget will create a local directory tree, corresponding to
1378 the one found on the remote server.
1380 Recursive retrieving can find a number of applications, the most
1381 important of which is mirroring. It is also useful for @sc{www}
1382 presentations, and any other opportunities where slow network
1383 connections should be bypassed by storing the files locally.
1385 You should be warned that recursive downloads can overload the remote
1386 servers. Because of that, many administrators frown upon them and may
1387 ban access from your site if they detect very fast downloads of big
1388 amounts of content. When downloading from Internet servers, consider
1389 using the @samp{-w} option to introduce a delay between accesses to the
1390 server. The download will take a while longer, but the server
1391 administrator will not be alarmed by your rudeness.
1393 Of course, recursive download may cause problems on your machine. If
1394 left to run unchecked, it can easily fill up the disk. If downloading
1395 from local network, it can also take bandwidth on the system, as well as
1396 consume memory and CPU.
1398 Try to specify the criteria that match the kind of download you are
1399 trying to achieve. If you want to download only one page, use
1400 @samp{--page-requisites} without any additional recursion. If you want
1401 to download things under one directory, use @samp{-np} to avoid
1402 downloading things from other directories. If you want to download all
1403 the files from one directory, use @samp{-l 1} to make sure the recursion
1404 depth never exceeds one. @xref{Following Links}, for more information
1407 Recursive retrieval should be used with care. Don't say you were not
1410 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1411 @chapter Following Links
1413 @cindex following links
1415 When retrieving recursively, one does not wish to retrieve loads of
1416 unnecessary data. Most of the time the users bear in mind exactly what
1417 they want to download, and want Wget to follow only specific links.
1419 For example, if you wish to download the music archive from
1420 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1421 that happen to be referenced by an obscure part of the archive.
1423 Wget possesses several mechanisms that allows you to fine-tune which
1424 links it will follow.
1427 * Spanning Hosts:: (Un)limiting retrieval based on host name.
1428 * Types of Files:: Getting only certain files.
1429 * Directory-Based Limits:: Getting only certain directories.
1430 * Relative Links:: Follow relative links only.
1431 * FTP Links:: Following FTP links.
1434 @node Spanning Hosts, Types of Files, Following Links, Following Links
1435 @section Spanning Hosts
1436 @cindex spanning hosts
1437 @cindex hosts, spanning
1439 Wget's recursive retrieval normally refuses to visit hosts different
1440 than the one you specified on the command line. This is a reasonable
1441 default; without it, every retrieval would have the potential to turn
1442 your Wget into a small version of google.
1444 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1445 a useful option. Maybe the images are served from a different server.
1446 Maybe you're mirroring a site that consists of pages interlinked between
1447 three servers. Maybe the server has two equivalent names, and the HTML
1448 pages refer to both interchangeably.
1451 @item Span to any host---@samp{-H}
1453 The @samp{-H} option turns on host spanning, thus allowing Wget's
1454 recursive run to visit any host referenced by a link. Unless sufficient
1455 recursion-limiting criteria are applied depth, these foreign hosts will
1456 typically link to yet more hosts, and so on until Wget ends up sucking
1457 up much more data than you have intended.
1459 @item Limit spanning to certain domains---@samp{-D}
1461 The @samp{-D} option allows you to specify the domains that will be
1462 followed, thus limiting the recursion only to the hosts that belong to
1463 these domains. Obviously, this makes sense only in conjunction with
1464 @samp{-H}. A typical example would be downloading the contents of
1465 @samp{www.server.com}, but allowing downloads from
1466 @samp{images.server.com}, etc.:
1469 wget -rH -Dserver.com http://www.server.com/
1472 You can specify more than one address by separating them with a comma,
1473 e.g. @samp{-Ddomain1.com,domain2.com}.
1475 @item Keep download off certain domains---@samp{--exclude-domains}
1477 If there are domains you want to exclude specifically, you can do it
1478 with @samp{--exclude-domains}, which accepts the same type of arguments
1479 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1480 example, if you want to download all the hosts from @samp{foo.edu}
1481 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1485 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
1491 @node Types of Files, Directory-Based Limits, Spanning Hosts, Following Links
1492 @section Types of Files
1493 @cindex types of files
1495 When downloading material from the web, you will often want to restrict
1496 the retrieval to only certain file types. For example, if you are
1497 interested in downloading @sc{gif}s, you will not be overjoyed to get
1498 loads of PostScript documents, and vice versa.
1500 Wget offers two options to deal with this problem. Each option
1501 description lists a short name, a long name, and the equivalent command
1504 @cindex accept wildcards
1505 @cindex accept suffixes
1506 @cindex wildcards, accept
1507 @cindex suffixes, accept
1509 @item -A @var{acclist}
1510 @itemx --accept @var{acclist}
1511 @itemx accept = @var{acclist}
1512 The argument to @samp{--accept} option is a list of file suffixes or
1513 patterns that Wget will download during recursive retrieval. A suffix
1514 is the ending part of a file, and consists of ``normal'' letters,
1515 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1516 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1518 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1519 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1520 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1521 download only files beginning with @samp{zelazny} and containing numbers
1522 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1523 a description of how pattern matching works.
1525 Of course, any number of suffixes and patterns can be combined into a
1526 comma-separated list, and given as an argument to @samp{-A}.
1528 @cindex reject wildcards
1529 @cindex reject suffixes
1530 @cindex wildcards, reject
1531 @cindex suffixes, reject
1532 @item -R @var{rejlist}
1533 @itemx --reject @var{rejlist}
1534 @itemx reject = @var{rejlist}
1535 The @samp{--reject} option works the same way as @samp{--accept}, only
1536 its logic is the reverse; Wget will download all files @emph{except} the
1537 ones matching the suffixes (or patterns) in the list.
1539 So, if you want to download a whole page except for the cumbersome
1540 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1541 Analogously, to download all files except the ones beginning with
1542 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1543 expansion by the shell.
1546 The @samp{-A} and @samp{-R} options may be combined to achieve even
1547 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1548 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1549 a part of their name, but @emph{not} the PostScript files.
1551 Note that these two options do not affect the downloading of @sc{html}
1552 files; Wget must load all the @sc{html}s to know where to go at
1553 all---recursive retrieval would make no sense otherwise.
1555 @node Directory-Based Limits, Relative Links, Types of Files, Following Links
1556 @section Directory-Based Limits
1558 @cindex directory limits
1560 Regardless of other link-following facilities, it is often useful to
1561 place the restriction of what files to retrieve based on the directories
1562 those files are placed in. There can be many reasons for this---the
1563 home pages may be organized in a reasonable directory structure; or some
1564 directories may contain useless information, e.g. @file{/cgi-bin} or
1565 @file{/dev} directories.
1567 Wget offers three different options to deal with this requirement. Each
1568 option description lists a short name, a long name, and the equivalent
1569 command in @file{.wgetrc}.
1571 @cindex directories, include
1572 @cindex include directories
1573 @cindex accept directories
1576 @itemx --include @var{list}
1577 @itemx include_directories = @var{list}
1578 @samp{-I} option accepts a comma-separated list of directories included
1579 in the retrieval. Any other directories will simply be ignored. The
1580 directories are absolute paths.
1582 So, if you wish to download from @samp{http://host/people/bozo/}
1583 following only links to bozo's colleagues in the @file{/people}
1584 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1587 wget -I /people,/cgi-bin http://host/people/bozo/
1590 @cindex directories, exclude
1591 @cindex exclude directories
1592 @cindex reject directories
1594 @itemx --exclude @var{list}
1595 @itemx exclude_directories = @var{list}
1596 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1597 directories @emph{excluded} from the download. E.g. if you do not want
1598 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1599 /cgi-bin} on the command line.
1601 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1602 to get a better fine-tuning of downloading subdirectories. E.g. if you
1603 want to load all the files from @file{/pub} hierarchy except for
1604 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1609 @itemx no_parent = on
1610 The simplest, and often very useful way of limiting directories is
1611 disallowing retrieval of the links that refer to the hierarchy
1612 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1613 parent directory/directories.
1615 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1616 Using it guarantees that you will never leave the existing hierarchy.
1617 Supposing you issue Wget with:
1620 wget -r --no-parent http://somehost/~luzer/my-archive/
1623 You may rest assured that none of the references to
1624 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1625 followed. Only the archive you are interested in will be downloaded.
1626 Essentially, @samp{--no-parent} is similar to
1627 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1628 intelligent fashion.
1631 @node Relative Links, FTP Links, Directory-Based Limits, Following Links
1632 @section Relative Links
1633 @cindex relative links
1635 When @samp{-L} is turned on, only the relative links are ever followed.
1636 Relative links are here defined those that do not refer to the web
1637 server root. For example, these links are relative:
1641 <a href="foo/bar.gif">
1642 <a href="../foo/bar.gif">
1645 These links are not relative:
1649 <a href="/foo/bar.gif">
1650 <a href="http://www.server.com/foo/bar.gif">
1653 Using this option guarantees that recursive retrieval will not span
1654 hosts, even without @samp{-H}. In simple cases it also allows downloads
1655 to ``just work'' without having to convert links.
1657 This option is probably not very useful and might be removed in a future
1660 @node FTP Links, , Relative Links, Following Links
1661 @section Following FTP Links
1662 @cindex following ftp links
1664 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1665 them to be. @sc{ftp} links in @sc{html} documents are often included
1666 for purposes of reference, and it is often inconvenient to download them
1669 To have @sc{ftp} links followed from @sc{html} documents, you need to
1670 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1671 links will span hosts regardless of @samp{-H} setting. This is logical,
1672 as @sc{ftp} links rarely point to the same host where the @sc{http}
1673 server resides. For similar reasons, the @samp{-L} options has no
1674 effect on such downloads. On the other hand, domain acceptance
1675 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1677 Also note that followed links to @sc{ftp} directories will not be
1678 retrieved recursively further.
1680 @node Time-Stamping, Startup File, Following Links, Top
1681 @chapter Time-Stamping
1682 @cindex time-stamping
1683 @cindex timestamping
1684 @cindex updating the archives
1685 @cindex incremental updating
1687 One of the most important aspects of mirroring information from the
1688 Internet is updating your archives.
1690 Downloading the whole archive again and again, just to replace a few
1691 changed files is expensive, both in terms of wasted bandwidth and money,
1692 and the time to do the update. This is why all the mirroring tools
1693 offer the option of incremental updating.
1695 Such an updating mechanism means that the remote server is scanned in
1696 search of @dfn{new} files. Only those new files will be downloaded in
1697 the place of the old ones.
1699 A file is considered new if one of these two conditions are met:
1703 A file of that name does not already exist locally.
1706 A file of that name does exist, but the remote file was modified more
1707 recently than the local file.
1710 To implement this, the program needs to be aware of the time of last
1711 modification of both local and remote files. We call this information the
1712 @dfn{time-stamp} of a file.
1714 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1715 (@samp{-N}) option, or through @code{timestamping = on} directive in
1716 @file{.wgetrc}. With this option, for each file it intends to download,
1717 Wget will check whether a local file of the same name exists. If it
1718 does, and the remote file is older, Wget will not download it.
1720 If the local file does not exist, or the sizes of the files do not
1721 match, Wget will download the remote file no matter what the time-stamps
1725 * Time-Stamping Usage::
1726 * HTTP Time-Stamping Internals::
1727 * FTP Time-Stamping Internals::
1730 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1731 @section Time-Stamping Usage
1732 @cindex time-stamping usage
1733 @cindex usage, time-stamping
1735 The usage of time-stamping is simple. Say you would like to download a
1736 file so that it keeps its date of modification.
1739 wget -S http://www.gnu.ai.mit.edu/
1742 A simple @code{ls -l} shows that the time stamp on the local file equals
1743 the state of the @code{Last-Modified} header, as returned by the server.
1744 As you can see, the time-stamping info is preserved locally, even
1745 without @samp{-N} (at least for @sc{http}).
1747 Several days later, you would like Wget to check if the remote file has
1748 changed, and download it if it has.
1751 wget -N http://www.gnu.ai.mit.edu/
1754 Wget will ask the server for the last-modified date. If the local file
1755 has the same timestamp as the server, or a newer one, the remote file
1756 will not be re-fetched. However, if the remote file is more recent,
1757 Wget will proceed to fetch it.
1759 The same goes for @sc{ftp}. For example:
1762 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
1765 (The quotes around that URL are to prevent the shell from trying to
1766 interpret the @samp{*}.)
1768 After download, a local directory listing will show that the timestamps
1769 match those on the remote server. Reissuing the command with @samp{-N}
1770 will make Wget re-fetch @emph{only} the files that have been modified
1771 since the last download.
1773 If you wished to mirror the GNU archive every week, you would use a
1774 command like the following, weekly:
1777 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
1780 Note that time-stamping will only work for files for which the server
1781 gives a timestamp. For @sc{http}, this depends on getting a
1782 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
1783 directory listing with dates in a format that Wget can parse
1784 (@pxref{FTP Time-Stamping Internals}).
1786 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1787 @section HTTP Time-Stamping Internals
1788 @cindex http time-stamping
1790 Time-stamping in @sc{http} is implemented by checking of the
1791 @code{Last-Modified} header. If you wish to retrieve the file
1792 @file{foo.html} through @sc{http}, Wget will check whether
1793 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1794 retrieved unconditionally.
1796 If the file does exist locally, Wget will first check its local
1797 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1798 @code{HEAD} request to the remote server, demanding the information on
1801 The @code{Last-Modified} header is examined to find which file was
1802 modified more recently (which makes it ``newer''). If the remote file
1803 is newer, it will be downloaded; if it is older, Wget will give
1804 up.@footnote{As an additional check, Wget will look at the
1805 @code{Content-Length} header, and compare the sizes; if they are not the
1806 same, the remote file will be downloaded no matter what the time-stamp
1809 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1810 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1811 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1812 @samp{@var{X}}, which will always differ if it's been converted by
1813 @samp{--convert-links} (@samp{-k}).
1815 Arguably, @sc{http} time-stamping should be implemented using the
1816 @code{If-Modified-Since} request.
1818 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1819 @section FTP Time-Stamping Internals
1820 @cindex ftp time-stamping
1822 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1823 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
1826 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
1827 @sc{ftp} @code{LIST} command to get a file listing for the directory
1828 containing the desired file(s). It will try to analyze the listing,
1829 treating it like Unix @code{ls -l} output, extracting the time-stamps.
1830 The rest is exactly the same as for @sc{http}. Note that when
1831 retrieving individual files from an @sc{ftp} server without using
1832 globbing or recursion, listing files will not be downloaded (and thus
1833 files will not be time-stamped) unless @samp{-N} is specified.
1835 Assumption that every directory listing is a Unix-style listing may
1836 sound extremely constraining, but in practice it is not, as many
1837 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1838 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1839 defines no standard way to get a file list, let alone the time-stamps.
1840 We can only hope that a future standard will define this.
1842 Another non-standard solution includes the use of @code{MDTM} command
1843 that is supported by some @sc{ftp} servers (including the popular
1844 @code{wu-ftpd}), which returns the exact time of the specified file.
1845 Wget may support this command in the future.
1847 @node Startup File, Examples, Time-Stamping, Top
1848 @chapter Startup File
1849 @cindex startup file
1855 Once you know how to change default settings of Wget through command
1856 line arguments, you may wish to make some of those settings permanent.
1857 You can do that in a convenient way by creating the Wget startup
1858 file---@file{.wgetrc}.
1860 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1861 convenient to have a special facility for storing passwords. Thus Wget
1862 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1863 it. You can find @file{.netrc} format in your system manuals.
1865 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1869 * Wgetrc Location:: Location of various wgetrc files.
1870 * Wgetrc Syntax:: Syntax of wgetrc.
1871 * Wgetrc Commands:: List of available commands.
1872 * Sample Wgetrc:: A wgetrc example.
1875 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1876 @section Wgetrc Location
1877 @cindex wgetrc location
1878 @cindex location of wgetrc
1880 When initializing, Wget will look for a @dfn{global} startup file,
1881 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1882 @file{/usr/local}, if Wget was not installed there) and read commands
1883 from there, if it exists.
1885 Then it will look for the user's file. If the environmental variable
1886 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1887 further attempts will be made.
1889 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1891 The fact that user's settings are loaded after the system-wide ones
1892 means that in case of collision user's wgetrc @emph{overrides} the
1893 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1894 Fascist admins, away!
1896 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1897 @section Wgetrc Syntax
1898 @cindex wgetrc syntax
1899 @cindex syntax of wgetrc
1901 The syntax of a wgetrc command is simple:
1907 The @dfn{variable} will also be called @dfn{command}. Valid
1908 @dfn{values} are different for different commands.
1910 The commands are case-insensitive and underscore-insensitive. Thus
1911 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1912 beginning with @samp{#} and lines containing white-space only are
1915 Commands that expect a comma-separated list will clear the list on an
1916 empty command. So, if you wish to reset the rejection list specified in
1917 global @file{wgetrc}, you can do it with:
1923 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1924 @section Wgetrc Commands
1925 @cindex wgetrc commands
1927 The complete set of commands is listed below. Legal values are listed
1928 after the @samp{=}. Simple Boolean values can be set or unset using
1929 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
1930 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
1931 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
1932 option is set to @samp{always} or @samp{never}, that value will be
1933 locked in for the duration of the Wget invocation---commandline options
1936 Some commands take pseudo-arbitrary values. @var{address} values can be
1937 hostnames or dotted-quad IP addresses. @var{n} can be any positive
1938 integer, or @samp{inf} for infinity, where appropriate. @var{string}
1939 values can be any non-empty string.
1941 Most of these commands have commandline equivalents (@pxref{Invoking}),
1942 though some of the more obscure or rarely used ones do not.
1945 @item accept/reject = @var{string}
1946 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
1948 @item add_hostdir = on/off
1949 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1951 @item continue = on/off
1952 If set to on, force continuation of preexistent partially retrieved
1953 files. See @samp{-c} before setting it.
1955 @item background = on/off
1956 Enable/disable going to background---the same as @samp{-b} (which
1959 @item backup_converted = on/off
1960 Enable/disable saving pre-converted files with the suffix
1961 @samp{.orig}---the same as @samp{-K} (which enables it).
1963 @c @item backups = @var{number}
1964 @c #### Document me!
1966 @item base = @var{string}
1967 Consider relative @sc{url}s in @sc{url} input files forced to be
1968 interpreted as @sc{html} as being relative to @var{string}---the same as
1971 @item bind_address = @var{address}
1972 Bind to @var{address}, like the @samp{--bind-address} option.
1974 @item cache = on/off
1975 When set to off, disallow server-caching. See the @samp{-C} option.
1977 @item convert links = on/off
1978 Convert non-relative links locally. The same as @samp{-k}.
1980 @item cookies = on/off
1981 When set to off, disallow cookies. See the @samp{--cookies} option.
1983 @item load_cookies = @var{file}
1984 Load cookies from @var{file}. See @samp{--load-cookies}.
1986 @item save_cookies = @var{file}
1987 Save cookies to @var{file}. See @samp{--save-cookies}.
1989 @item cut_dirs = @var{n}
1990 Ignore @var{n} remote directory components.
1992 @item debug = on/off
1993 Debug mode, same as @samp{-d}.
1995 @item delete_after = on/off
1996 Delete after download---the same as @samp{--delete-after}.
1998 @item dir_prefix = @var{string}
1999 Top of directory tree---the same as @samp{-P}.
2001 @item dirstruct = on/off
2002 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2005 @item domains = @var{string}
2006 Same as @samp{-D} (@pxref{Spanning Hosts}).
2008 @item dot_bytes = @var{n}
2009 Specify the number of bytes ``contained'' in a dot, as seen throughout
2010 the retrieval (1024 by default). You can postfix the value with
2011 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2012 respectively. With dot settings you can tailor the dot retrieval to
2013 suit your needs, or you can use the predefined @dfn{styles}
2014 (@pxref{Download Options}).
2016 @item dots_in_line = @var{n}
2017 Specify the number of dots that will be printed in each line throughout
2018 the retrieval (50 by default).
2020 @item dot_spacing = @var{n}
2021 Specify the number of dots in a single cluster (10 by default).
2023 @item exclude_directories = @var{string}
2024 Specify a comma-separated list of directories you wish to exclude from
2025 download---the same as @samp{-X} (@pxref{Directory-Based Limits}).
2027 @item exclude_domains = @var{string}
2028 Same as @samp{--exclude-domains} (@pxref{Spanning Hosts}).
2030 @item follow_ftp = on/off
2031 Follow @sc{ftp} links from @sc{html} documents---the same as
2032 @samp{--follow-ftp}.
2034 @item follow_tags = @var{string}
2035 Only follow certain HTML tags when doing a recursive retrieval, just like
2036 @samp{--follow-tags}.
2038 @item force_html = on/off
2039 If set to on, force the input filename to be regarded as an @sc{html}
2040 document---the same as @samp{-F}.
2042 @item ftp_proxy = @var{string}
2043 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2047 Turn globbing on/off---the same as @samp{-g}.
2049 @item header = @var{string}
2050 Define an additional header, like @samp{--header}.
2052 @item html_extension = on/off
2053 Add a @samp{.html} extension to @samp{text/html} files without it, like
2056 @item http_passwd = @var{string}
2057 Set @sc{http} password.
2059 @item http_proxy = @var{string}
2060 Use @var{string} as @sc{http} proxy, instead of the one specified in
2063 @item http_user = @var{string}
2064 Set @sc{http} user to @var{string}.
2066 @item ignore_length = on/off
2067 When set to on, ignore @code{Content-Length} header; the same as
2068 @samp{--ignore-length}.
2070 @item ignore_tags = @var{string}
2071 Ignore certain HTML tags when doing a recursive retrieval, just like
2072 @samp{-G} / @samp{--ignore-tags}.
2074 @item include_directories = @var{string}
2075 Specify a comma-separated list of directories you wish to follow when
2076 downloading---the same as @samp{-I}.
2078 @item input = @var{string}
2079 Read the @sc{url}s from @var{string}, like @samp{-i}.
2081 @item kill_longer = on/off
2082 Consider data longer than specified in content-length header as invalid
2083 (and retry getting it). The default behaviour is to save as much data
2084 as there is, provided there is more than or equal to the value in
2085 @code{Content-Length}.
2087 @item logfile = @var{string}
2088 Set logfile---the same as @samp{-o}.
2090 @item login = @var{string}
2091 Your user name on the remote machine, for @sc{ftp}. Defaults to
2094 @item mirror = on/off
2095 Turn mirroring on/off. The same as @samp{-m}.
2097 @item netrc = on/off
2098 Turn reading netrc on or off.
2100 @item noclobber = on/off
2103 @item no_parent = on/off
2104 Disallow retrieving outside the directory hierarchy, like
2105 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2107 @item no_proxy = @var{string}
2108 Use @var{string} as the comma-separated list of domains to avoid in
2109 proxy loading, instead of the one specified in environment.
2111 @item output_document = @var{string}
2112 Set the output filename---the same as @samp{-O}.
2114 @item page_requisites = on/off
2115 Download all ancillary documents necessary for a single HTML page to
2116 display properly---the same as @samp{-p}.
2118 @item passive_ftp = on/off/always/never
2119 Set passive @sc{ftp}---the same as @samp{--passive-ftp}. Some scripts
2120 and @samp{.pm} (Perl module) files download files using @samp{wget
2121 --passive-ftp}. If your firewall does not allow this, you can set
2122 @samp{passive_ftp = never} to override the commandline.
2124 @item passwd = @var{string}
2125 Set your @sc{ftp} password to @var{password}. Without this setting, the
2126 password defaults to @samp{username@@hostname.domainname}.
2128 @item progress = @var{string}
2129 Set the type of the progress indicator. Legal types are ``dot'' and
2132 @item proxy_user = @var{string}
2133 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
2135 @item proxy_passwd = @var{string}
2136 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
2138 @item referer = @var{string}
2139 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
2140 was the folks who wrote the @sc{http} spec who got the spelling of
2141 ``referrer'' wrong.)
2143 @item quiet = on/off
2144 Quiet mode---the same as @samp{-q}.
2146 @item quota = @var{quota}
2147 Specify the download quota, which is useful to put in the global
2148 @file{wgetrc}. When download quota is specified, Wget will stop
2149 retrieving after the download sum has become greater than quota. The
2150 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2151 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2152 to 5 mbytes. Note that the user's startup file overrides system
2155 @item reclevel = @var{n}
2156 Recursion level---the same as @samp{-l}.
2158 @item recursive = on/off
2159 Recursive on/off---the same as @samp{-r}.
2161 @item relative_only = on/off
2162 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2165 @item remove_listing = on/off
2166 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2167 to off is the same as @samp{-nr}.
2169 @item retr_symlinks = on/off
2170 When set to on, retrieve symbolic links as if they were plain files; the
2171 same as @samp{--retr-symlinks}.
2173 @item robots = on/off
2174 Use (or not) @file{/robots.txt} file (@pxref{Robots}). Be sure to know
2175 what you are doing before changing the default (which is @samp{on}).
2177 @item server_response = on/off
2178 Choose whether or not to print the @sc{http} and @sc{ftp} server
2179 responses---the same as @samp{-S}.
2181 @item simple_host_check = on/off
2182 Same as @samp{-nh} (@pxref{Spanning Hosts}).
2184 @item span_hosts = on/off
2187 @item timeout = @var{n}
2188 Set timeout value---the same as @samp{-T}.
2190 @item timestamping = on/off
2191 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2193 @item tries = @var{n}
2194 Set number of retries per @sc{url}---the same as @samp{-t}.
2196 @item use_proxy = on/off
2197 Turn proxy support on/off. The same as @samp{-Y}.
2199 @item verbose = on/off
2200 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2202 @item wait = @var{n}
2203 Wait @var{n} seconds between retrievals---the same as @samp{-w}.
2205 @item waitretry = @var{n}
2206 Wait up to @var{n} seconds between retries of failed retrievals
2207 only---the same as @samp{--waitretry}. Note that this is turned on by
2208 default in the global @file{wgetrc}.
2210 @item randomwait = on/off
2211 Turn random between-request wait times on or off. The same as
2212 @samp{--random-wait}.
2215 @node Sample Wgetrc, , Wgetrc Commands, Startup File
2216 @section Sample Wgetrc
2217 @cindex sample wgetrc
2219 This is the sample initialization file, as given in the distribution.
2220 It is divided in two section---one for global usage (suitable for global
2221 startup file), and one for local usage (suitable for
2222 @file{$HOME/.wgetrc}). Be careful about the things you change.
2224 Note that almost all the lines are commented out. For a command to have
2225 any effect, you must remove the @samp{#} character at the beginning of
2229 @include sample.wgetrc.munged_for_texi_inclusion
2232 @node Examples, Various, Startup File, Top
2236 @c man begin EXAMPLES
2237 The examples are divided into three sections loosely based on their
2241 * Simple Usage:: Simple, basic usage of the program.
2242 * Advanced Usage:: Advanced tips.
2243 * Very Advanced Usage:: The hairy stuff.
2246 @node Simple Usage, Advanced Usage, Examples, Examples
2247 @section Simple Usage
2251 Say you want to download a @sc{url}. Just type:
2254 wget http://fly.srk.fer.hr/
2258 But what will happen if the connection is slow, and the file is lengthy?
2259 The connection will probably fail before the whole file is retrieved,
2260 more than once. In this case, Wget will try getting the file until it
2261 either gets the whole of it, or exceeds the default number of retries
2262 (this being 20). It is easy to change the number of tries to 45, to
2263 insure that the whole file will arrive safely:
2266 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2270 Now let's leave Wget to work in the background, and write its progress
2271 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2272 shall use @samp{-t}.
2275 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2278 The ampersand at the end of the line makes sure that Wget works in the
2279 background. To unlimit the number of retries, use @samp{-t inf}.
2282 The usage of @sc{ftp} is as simple. Wget will take care of login and
2286 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2290 If you specify a directory, Wget will retrieve the directory listing,
2291 parse it and convert it to @sc{html}. Try:
2294 wget ftp://prep.ai.mit.edu/pub/gnu/
2299 @node Advanced Usage, Very Advanced Usage, Simple Usage, Examples
2300 @section Advanced Usage
2304 You have a file that contains the URLs you want to download? Use the
2311 If you specify @samp{-} as file name, the @sc{url}s will be read from
2315 Create a five levels deep mirror image of the GNU web site, with the
2316 same directory structure the original has, with only one try per
2317 document, saving the log of the activities to @file{gnulog}:
2320 wget -r http://www.gnu.org/ -o gnulog
2324 The same as the above, but convert the links in the @sc{html} files to
2325 point to local files, so you can view the documents off-line:
2328 wget --convert-links -r http://www.gnu.org/ -o gnulog
2332 Retrieve only one HTML page, but make sure that all the elements needed
2333 for the page to be displayed, such as inline images and external style
2334 sheets, are also downloaded. Also make sure the downloaded page
2335 references the downloaded links.
2338 wget -p --convert-links http://www.server.com/dir/page.html
2341 The HTML page will be saved to @file{www.server.com/dir/page.html}, and
2342 the images, stylesheets, etc., somewhere under @file{www.server.com/},
2343 depending on where they were on the remote server.
2346 The same as the above, but without the @file{www.server.com/} directory.
2347 In fact, I don't want to have all those random server directories
2348 anyway---just save @emph{all} those files under a @file{download/}
2349 subdirectory of the current directory.
2352 wget -p --convert-links -nH -nd -Pdownload \
2353 http://www.server.com/dir/page.html
2357 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2361 wget -S http://www.lycos.com/
2365 Save the server headers with the file, perhaps for post-processing.
2368 wget -s http://www.lycos.com/
2373 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2377 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
2381 You want to download all the @sc{gif}s from a directory on an @sc{http}
2382 server. You tried @samp{wget http://www.server.com/dir/*.gif}, but that
2383 didn't work because @sc{http} retrieval does not support globbing. In
2387 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
2390 More verbose, but the effect is the same. @samp{-r -l1} means to
2391 retrieve recursively (@pxref{Recursive Retrieval}), with maximum depth
2392 of 1. @samp{--no-parent} means that references to the parent directory
2393 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2394 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2398 Suppose you were in the middle of downloading, when Wget was
2399 interrupted. Now you do not want to clobber the files already present.
2403 wget -nc -r http://www.gnu.org/
2407 If you want to encode your own username and password to @sc{http} or
2408 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2411 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
2414 @cindex redirecting output
2416 You would like the output documents to go to standard output instead of
2420 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2423 You can also combine the two options and make pipelines to retrieve the
2424 documents from remote hotlists:
2427 wget -O - http://cool.list.com/ | wget --force-html -i -
2431 @node Very Advanced Usage, , Advanced Usage, Examples
2432 @section Very Advanced Usage
2437 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2438 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2439 for @samp{-r -l inf -N}. You can put Wget in the crontab file asking it
2440 to recheck a site each Sunday:
2444 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
2448 In addition to the above, you want the links to be converted for local
2449 viewing. But, after having read this manual, you know that link
2450 conversion doesn't play well with timestamping, so you also want Wget to
2451 back up the original HTML files before the conversion. Wget invocation
2452 would look like this:
2455 wget --mirror --convert-links --backup-converted \
2456 http://www.gnu.org/ -o /home/me/weeklog
2460 But you've also noticed that local viewing doesn't work all that well
2461 when HTML files are saved under extensions other than @samp{.html},
2462 perhaps because they were served as @file{index.cgi}. So you'd like
2463 Wget to rename all the files served with content-type @samp{text/html}
2464 to @file{@var{name}.html}.
2467 wget --mirror --convert-links --backup-converted \
2468 --html-extension -o /home/me/weeklog \
2472 Or, with less typing:
2475 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
2480 @node Various, Appendices, Examples, Top
2484 This chapter contains all the stuff that could not fit anywhere else.
2487 * Proxies:: Support for proxy servers
2488 * Distribution:: Getting the latest version.
2489 * Mailing List:: Wget mailing list for announcements and discussion.
2490 * Reporting Bugs:: How and where to report bugs.
2491 * Portability:: The systems Wget works on.
2492 * Signals:: Signal-handling performed by Wget.
2495 @node Proxies, Distribution, Various, Various
2499 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2500 data from remote servers to local clients. One typical use of proxies
2501 is lightening network load for users behind a slow connection. This is
2502 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2503 proxy which caches the transferred data. When a cached resource is
2504 requested again, proxy will return the data from cache. Another use for
2505 proxies is for companies that separate (for security reasons) their
2506 internal networks from the rest of Internet. In order to obtain
2507 information from the Web, their users connect and retrieve remote data
2508 using an authorized proxy.
2510 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2511 standard way to specify proxy location, which Wget recognizes, is using
2512 the following environment variables:
2516 This variable should contain the @sc{url} of the proxy for @sc{http}
2520 This variable should contain the @sc{url} of the proxy for @sc{ftp}
2521 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2522 are set to the same @sc{url}.
2525 This variable should contain a comma-separated list of domain extensions
2526 proxy should @emph{not} be used for. For instance, if the value of
2527 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2531 In addition to the environment variables, proxy location and settings
2532 may be specified from within Wget itself.
2536 @itemx --proxy=on/off
2537 @itemx proxy = on/off
2538 This option may be used to turn the proxy support on or off. Proxy
2539 support is on by default, provided that the appropriate environment
2542 @item http_proxy = @var{URL}
2543 @itemx ftp_proxy = @var{URL}
2544 @itemx no_proxy = @var{string}
2545 These startup file variables allow you to override the proxy settings
2546 specified by the environment.
2549 Some proxy servers require authorization to enable you to use them. The
2550 authorization consists of @dfn{username} and @dfn{password}, which must
2551 be sent by Wget. As with @sc{http} authorization, several
2552 authentication schemes exist. For proxy authorization only the
2553 @code{Basic} authentication scheme is currently implemented.
2555 You may specify your username and password either through the proxy
2556 @sc{url} or through the command-line options. Assuming that the
2557 company's proxy is located at @samp{proxy.company.com} at port 8001, a
2558 proxy @sc{url} location containing authorization data might look like
2562 http://hniksic:mypassword@@proxy.company.com:8001/
2565 Alternatively, you may use the @samp{proxy-user} and
2566 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2567 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2568 username and password.
2570 @node Distribution, Mailing List, Proxies, Various
2571 @section Distribution
2572 @cindex latest version
2574 Like all GNU utilities, the latest version of Wget can be found at the
2575 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2576 Wget @value{VERSION} can be found at
2577 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2579 @node Mailing List, Reporting Bugs, Distribution, Various
2580 @section Mailing List
2581 @cindex mailing list
2584 Wget has its own mailing list at @email{wget@@sunsite.dk}, thanks
2585 to Karsten Thygesen. The mailing list is for discussion of Wget
2586 features and web, reporting Wget bugs (those that you think may be of
2587 interest to the public) and mailing announcements. You are welcome to
2588 subscribe. The more people on the list, the better!
2590 To subscribe, send mail to @email{wget-subscribe@@sunsite.dk}.
2591 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2592 mailing to @email{wget-unsubscribe@@sunsite.dk}.
2594 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2595 Alternative archive is available at
2596 @url{http://www.mail-archive.com/wget%40sunsite.auc.dk/}.
2598 @node Reporting Bugs, Portability, Mailing List, Various
2599 @section Reporting Bugs
2601 @cindex reporting bugs
2605 You are welcome to send bug reports about GNU Wget to
2606 @email{bug-wget@@gnu.org}.
2608 Before actually submitting a bug report, please try to follow a few
2613 Please try to ascertain that the behaviour you see really is a bug. If
2614 Wget crashes, it's a bug. If Wget does not behave as documented,
2615 it's a bug. If things work strange, but you are not sure about the way
2616 they are supposed to work, it might well be a bug.
2619 Try to repeat the bug in as simple circumstances as possible. E.g. if
2620 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
2621 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
2622 repeatable, and if will occur with a simpler set of options. You might
2623 even try to start the download at the page where the crash occurred to
2624 see if that page somehow triggered the crash.
2626 Also, while I will probably be interested to know the contents of your
2627 @file{.wgetrc} file, just dumping it into the debug message is probably
2628 a bad idea. Instead, you should first try to see if the bug repeats
2629 with @file{.wgetrc} moved out of the way. Only if it turns out that
2630 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
2634 Please start Wget with @samp{-d} option and send the log (or the
2635 relevant parts of it). If Wget was compiled without debug support,
2636 recompile it. It is @emph{much} easier to trace bugs with debug support
2640 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2641 wget` core} and type @code{where} to get the backtrace.
2645 @node Portability, Signals, Reporting Bugs, Various
2646 @section Portability
2648 @cindex operating systems
2650 Since Wget uses GNU Autoconf for building and configuring, and avoids
2651 using ``special'' ultra--mega--cool features of any particular Unix, it
2652 should compile (and work) on all common Unix flavors.
2654 Various Wget versions have been compiled and tested under many kinds of
2655 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2656 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2657 distribution directory for a comprehensive list. If you compile it on
2658 an architecture not listed there, please let me know so I can update it.
2660 Wget should also compile on the other Unix systems, not listed in
2661 @file{MACHINES}. If it doesn't, please let me know.
2663 Thanks to kind contributors, this version of Wget compiles and works on
2664 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2665 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2666 with Winsock as networking software. Naturally, it is crippled of some
2667 features available on Unix, but it should work as a substitute for
2668 people stuck with Windows. Note that the Windows port is
2669 @strong{neither tested nor maintained} by me---all questions and
2670 problems should be reported to Wget mailing list at
2671 @email{wget@@sunsite.dk} where the maintainers will look at them.
2673 @node Signals, , Portability, Various
2675 @cindex signal handling
2678 Since the purpose of Wget is background work, it catches the hangup
2679 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2680 output, it will be redirected to a file named @file{wget-log}.
2681 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2682 to redirect the output of Wget after having started it.
2685 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2686 $ kill -HUP %% # Redirect the output to wget-log
2689 Other than that, Wget will not try to interfere with signals in any way.
2690 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
2692 @node Appendices, Copying, Various, Top
2695 This chapter contains some references I consider useful.
2698 * Robots:: Wget as a WWW robot.
2699 * Security Considerations:: Security with Wget.
2700 * Contributors:: People who helped.
2703 @node Robots, Security Considerations, Appendices, Appendices
2707 @cindex server maintenance
2709 It is extremely easy to make Wget wander aimlessly around a web site,
2710 sucking all the available data in progress. @samp{wget -r @var{site}},
2711 and you're set. Great? Not for the server admin.
2713 While Wget is retrieving static pages, there's not much of a problem.
2714 But for Wget, there is no real difference between a static page and the
2715 most demanding CGI. For instance, a site I know has a section handled
2716 by an, uh, @dfn{bitchin'} CGI script that converts all the Info files to
2717 HTML. The script can and does bring the machine to its knees without
2718 providing anything useful to the downloader.
2720 For such and similar cases various robot exclusion schemes have been
2721 devised as a means for the server administrators and document authors to
2722 protect chosen portions of their sites from the wandering of robots.
2724 The more popular mechanism is the @dfn{Robots Exclusion Standard}, or
2725 @sc{res}, written by Martijn Koster et al. in 1994. It specifies the
2726 format of a text file containing directives that instruct the robots
2727 which URL paths to avoid. To be found by the robots, the specifications
2728 must be placed in @file{/robots.txt} in the server root, which the
2729 robots are supposed to download and parse.
2731 Wget supports @sc{res} when downloading recursively. So, when you
2735 wget -r http://www.server.com/
2738 First the index of @samp{www.server.com} will be downloaded. If Wget
2739 finds that it wants to download more documents from that server, it will
2740 request @samp{http://www.server.com/robots.txt} and, if found, use it
2741 for further downloads. @file{robots.txt} is loaded only once per each
2744 Until version 1.8, Wget supported the first version of the standard,
2745 written by Martijn Koster in 1994 and available at
2746 @url{http://www.robotstxt.org/wc/norobots.html}. As of version 1.8,
2747 Wget has supported the additional directives specified in the internet
2748 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
2749 Robots Control''. The draft, which has as far as I know never made to
2750 an @sc{rfc}, is available at
2751 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
2753 This manual no longer includes the text of the Robot Exclusion Standard.
2755 The second, less known mechanism, enables the author of an individual
2756 document to specify whether they want the links from the file to be
2757 followed by a robot. This is achieved using the @code{META} tag, like
2761 <meta name="robots" content="nofollow">
2764 This is explained in some detail at
2765 @url{http://www.robotstxt.org/wc/meta-user.html}. Wget supports this
2766 method of robot exclusion in addition to the usual @file{/robots.txt}
2769 @node Security Considerations, Contributors, Robots, Appendices
2770 @section Security Considerations
2773 When using Wget, you must be aware that it sends unencrypted passwords
2774 through the network, which may present a security problem. Here are the
2775 main issues, and some solutions.
2779 The passwords on the command line are visible using @code{ps}. If this
2780 is a problem, avoid putting passwords from the command line---e.g. you
2781 can use @file{.netrc} for this.
2784 Using the insecure @dfn{basic} authentication scheme, unencrypted
2785 passwords are transmitted through the network routers and gateways.
2788 The @sc{ftp} passwords are also in no way encrypted. There is no good
2789 solution for this at the moment.
2792 Although the ``normal'' output of Wget tries to hide the passwords,
2793 debugging logs show them, in all forms. This problem is avoided by
2794 being careful when you send debug logs (yes, even when you send them to
2798 @node Contributors, , Security Considerations, Appendices
2799 @section Contributors
2800 @cindex contributors
2803 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
2806 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
2808 However, its development could never have gone as far as it has, were it
2809 not for the help of many people, either with bug reports, feature
2810 proposals, patches, or letters saying ``Thanks!''.
2812 Special thanks goes to the following people (no particular order):
2816 Karsten Thygesen---donated system resources such as the mailing list,
2817 web space, and @sc{ftp} space, along with a lot of time to make these
2821 Shawn McHorse---bug reports and patches.
2824 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
2828 Gordon Matzigkeit---@file{.netrc} support.
2832 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2833 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2836 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2837 and ``philosophical'' discussions.
2841 Darko Budor---initial port to Windows.
2844 Antonio Rosella---help and suggestions, plus the Italian translation.
2848 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2852 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2857 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2860 Francois Pinard---many thorough bug reports and discussions.
2864 Karl Eichwalder---lots of help with internationalization and other
2868 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2872 The people who provided donations for development, including Brian
2876 The following people have provided patches, bug/build reports, useful
2877 suggestions, beta testing services, fan mail and all the other things
2878 that make maintenance so much fun:
2897 Kristijan @v{C}onka@v{s},
2915 Aleksandar Erkalovi@'{c},
2918 Aleksandar Erkalovic,
2934 Erik Magnus Hulthen,
2952 Goran Kezunovi@'{c},
2963 $\Sigma\acute{\iota}\mu o\varsigma\;
2964 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
2965 (Simos KSenitellis),
2973 Nicol@'{a}s Lichtmeier,
2979 Alexander V. Lukyanov,
3004 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3006 Juan Jos\'{e} Rodr\'{\i}gues,
3009 Juan Jose Rodrigues,
3021 Szakacsits Szabolcs,
3027 Douglas E. Wegscheid,
3037 Apologies to all who I accidentally left out, and many thanks to all the
3038 subscribers of the Wget mailing list.
3040 @node Copying, Concept Index, Appendices, Top
3045 @cindex free software
3047 GNU Wget is licensed under the GNU GPL, which makes it @dfn{free
3050 Please note that ``free'' in ``free software'' refers to liberty, not
3051 price. As some GNU project advocates like to point out, think of ``free
3052 speech'' rather than ``free beer''. The exact and legally binding
3053 distribution terms are spelled out below; in short, you have the right
3054 (freedom) to run and change Wget and distribute it to other people, and
3055 even---if you want---charge money for doing either. The important
3056 restriction is that you have to grant your recipients the same rights
3057 and impose the same restrictions.
3059 This method of licensing software is also known as @dfn{open source}
3060 because, among other things, it makes sure that all recipients will
3061 receive the source code along with the program, and be able to improve
3062 it. The GNU project prefers the term ``free software'' for reasons
3064 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3066 The exact license terms are defined by this paragraph and the GNU
3067 General Public License it refers to:
3070 GNU Wget is free software; you can redistribute it and/or modify it
3071 under the terms of the GNU General Public License as published by the
3072 Free Software Foundation; either version 2 of the License, or (at your
3073 option) any later version.
3075 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3076 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3077 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3080 A copy of the GNU General Public License is included as part of this
3081 manual; if you did not receive it, write to the Free Software
3082 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3085 In addition to this, this manual is free in the same sense:
3088 Permission is granted to copy, distribute and/or modify this document
3089 under the terms of the GNU Free Documentation License, Version 1.1 or
3090 any later version published by the Free Software Foundation; with the
3091 Invariant Sections being ``GNU General Public License'' and ``GNU Free
3092 Documentation License'', with no Front-Cover Texts, and with no
3093 Back-Cover Texts. A copy of the license is included in the section
3094 entitled ``GNU Free Documentation License''.
3097 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
3098 @c that the GFDL needs to be present in the manual, and to me it would
3099 @c suck to include the license for the manual and not the license for
3102 The full texts of the GNU General Public License and of the GNU Free
3103 Documentation License are available below.
3106 * GNU General Public License::
3107 * GNU Free Documentation License::
3110 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
3111 @section GNU General Public License
3112 @center Version 2, June 1991
3115 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3116 675 Mass Ave, Cambridge, MA 02139, USA
3118 Everyone is permitted to copy and distribute verbatim copies
3119 of this license document, but changing it is not allowed.
3122 @unnumberedsec Preamble
3124 The licenses for most software are designed to take away your
3125 freedom to share and change it. By contrast, the GNU General Public
3126 License is intended to guarantee your freedom to share and change free
3127 software---to make sure the software is free for all its users. This
3128 General Public License applies to most of the Free Software
3129 Foundation's software and to any other program whose authors commit to
3130 using it. (Some other Free Software Foundation software is covered by
3131 the GNU Library General Public License instead.) You can apply it to
3134 When we speak of free software, we are referring to freedom, not
3135 price. Our General Public Licenses are designed to make sure that you
3136 have the freedom to distribute copies of free software (and charge for
3137 this service if you wish), that you receive source code or can get it
3138 if you want it, that you can change the software or use pieces of it
3139 in new free programs; and that you know you can do these things.
3141 To protect your rights, we need to make restrictions that forbid
3142 anyone to deny you these rights or to ask you to surrender the rights.
3143 These restrictions translate to certain responsibilities for you if you
3144 distribute copies of the software, or if you modify it.
3146 For example, if you distribute copies of such a program, whether
3147 gratis or for a fee, you must give the recipients all the rights that
3148 you have. You must make sure that they, too, receive or can get the
3149 source code. And you must show them these terms so they know their
3152 We protect your rights with two steps: (1) copyright the software, and
3153 (2) offer you this license which gives you legal permission to copy,
3154 distribute and/or modify the software.
3156 Also, for each author's protection and ours, we want to make certain
3157 that everyone understands that there is no warranty for this free
3158 software. If the software is modified by someone else and passed on, we
3159 want its recipients to know that what they have is not the original, so
3160 that any problems introduced by others will not reflect on the original
3161 authors' reputations.
3163 Finally, any free program is threatened constantly by software
3164 patents. We wish to avoid the danger that redistributors of a free
3165 program will individually obtain patent licenses, in effect making the
3166 program proprietary. To prevent this, we have made it clear that any
3167 patent must be licensed for everyone's free use or not licensed at all.
3169 The precise terms and conditions for copying, distribution and
3170 modification follow.
3173 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3176 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3181 This License applies to any program or other work which contains
3182 a notice placed by the copyright holder saying it may be distributed
3183 under the terms of this General Public License. The ``Program'', below,
3184 refers to any such program or work, and a ``work based on the Program''
3185 means either the Program or any derivative work under copyright law:
3186 that is to say, a work containing the Program or a portion of it,
3187 either verbatim or with modifications and/or translated into another
3188 language. (Hereinafter, translation is included without limitation in
3189 the term ``modification''.) Each licensee is addressed as ``you''.
3191 Activities other than copying, distribution and modification are not
3192 covered by this License; they are outside its scope. The act of
3193 running the Program is not restricted, and the output from the Program
3194 is covered only if its contents constitute a work based on the
3195 Program (independent of having been made by running the Program).
3196 Whether that is true depends on what the Program does.
3199 You may copy and distribute verbatim copies of the Program's
3200 source code as you receive it, in any medium, provided that you
3201 conspicuously and appropriately publish on each copy an appropriate
3202 copyright notice and disclaimer of warranty; keep intact all the
3203 notices that refer to this License and to the absence of any warranty;
3204 and give any other recipients of the Program a copy of this License
3205 along with the Program.
3207 You may charge a fee for the physical act of transferring a copy, and
3208 you may at your option offer warranty protection in exchange for a fee.
3211 You may modify your copy or copies of the Program or any portion
3212 of it, thus forming a work based on the Program, and copy and
3213 distribute such modifications or work under the terms of Section 1
3214 above, provided that you also meet all of these conditions:
3218 You must cause the modified files to carry prominent notices
3219 stating that you changed the files and the date of any change.
3222 You must cause any work that you distribute or publish, that in
3223 whole or in part contains or is derived from the Program or any
3224 part thereof, to be licensed as a whole at no charge to all third
3225 parties under the terms of this License.
3228 If the modified program normally reads commands interactively
3229 when run, you must cause it, when started running for such
3230 interactive use in the most ordinary way, to print or display an
3231 announcement including an appropriate copyright notice and a
3232 notice that there is no warranty (or else, saying that you provide
3233 a warranty) and that users may redistribute the program under
3234 these conditions, and telling the user how to view a copy of this
3235 License. (Exception: if the Program itself is interactive but
3236 does not normally print such an announcement, your work based on
3237 the Program is not required to print an announcement.)
3240 These requirements apply to the modified work as a whole. If
3241 identifiable sections of that work are not derived from the Program,
3242 and can be reasonably considered independent and separate works in
3243 themselves, then this License, and its terms, do not apply to those
3244 sections when you distribute them as separate works. But when you
3245 distribute the same sections as part of a whole which is a work based
3246 on the Program, the distribution of the whole must be on the terms of
3247 this License, whose permissions for other licensees extend to the
3248 entire whole, and thus to each and every part regardless of who wrote it.
3250 Thus, it is not the intent of this section to claim rights or contest
3251 your rights to work written entirely by you; rather, the intent is to
3252 exercise the right to control the distribution of derivative or
3253 collective works based on the Program.
3255 In addition, mere aggregation of another work not based on the Program
3256 with the Program (or with a work based on the Program) on a volume of
3257 a storage or distribution medium does not bring the other work under
3258 the scope of this License.
3261 You may copy and distribute the Program (or a work based on it,
3262 under Section 2) in object code or executable form under the terms of
3263 Sections 1 and 2 above provided that you also do one of the following:
3267 Accompany it with the complete corresponding machine-readable
3268 source code, which must be distributed under the terms of Sections
3269 1 and 2 above on a medium customarily used for software interchange; or,
3272 Accompany it with a written offer, valid for at least three
3273 years, to give any third party, for a charge no more than your
3274 cost of physically performing source distribution, a complete
3275 machine-readable copy of the corresponding source code, to be
3276 distributed under the terms of Sections 1 and 2 above on a medium
3277 customarily used for software interchange; or,
3280 Accompany it with the information you received as to the offer
3281 to distribute corresponding source code. (This alternative is
3282 allowed only for noncommercial distribution and only if you
3283 received the program in object code or executable form with such
3284 an offer, in accord with Subsection b above.)
3287 The source code for a work means the preferred form of the work for
3288 making modifications to it. For an executable work, complete source
3289 code means all the source code for all modules it contains, plus any
3290 associated interface definition files, plus the scripts used to
3291 control compilation and installation of the executable. However, as a
3292 special exception, the source code distributed need not include
3293 anything that is normally distributed (in either source or binary
3294 form) with the major components (compiler, kernel, and so on) of the
3295 operating system on which the executable runs, unless that component
3296 itself accompanies the executable.
3298 If distribution of executable or object code is made by offering
3299 access to copy from a designated place, then offering equivalent
3300 access to copy the source code from the same place counts as
3301 distribution of the source code, even though third parties are not
3302 compelled to copy the source along with the object code.
3305 You may not copy, modify, sublicense, or distribute the Program
3306 except as expressly provided under this License. Any attempt
3307 otherwise to copy, modify, sublicense or distribute the Program is
3308 void, and will automatically terminate your rights under this License.
3309 However, parties who have received copies, or rights, from you under
3310 this License will not have their licenses terminated so long as such
3311 parties remain in full compliance.
3314 You are not required to accept this License, since you have not
3315 signed it. However, nothing else grants you permission to modify or
3316 distribute the Program or its derivative works. These actions are
3317 prohibited by law if you do not accept this License. Therefore, by
3318 modifying or distributing the Program (or any work based on the
3319 Program), you indicate your acceptance of this License to do so, and
3320 all its terms and conditions for copying, distributing or modifying
3321 the Program or works based on it.
3324 Each time you redistribute the Program (or any work based on the
3325 Program), the recipient automatically receives a license from the
3326 original licensor to copy, distribute or modify the Program subject to
3327 these terms and conditions. You may not impose any further
3328 restrictions on the recipients' exercise of the rights granted herein.
3329 You are not responsible for enforcing compliance by third parties to
3333 If, as a consequence of a court judgment or allegation of patent
3334 infringement or for any other reason (not limited to patent issues),
3335 conditions are imposed on you (whether by court order, agreement or
3336 otherwise) that contradict the conditions of this License, they do not
3337 excuse you from the conditions of this License. If you cannot
3338 distribute so as to satisfy simultaneously your obligations under this
3339 License and any other pertinent obligations, then as a consequence you
3340 may not distribute the Program at all. For example, if a patent
3341 license would not permit royalty-free redistribution of the Program by
3342 all those who receive copies directly or indirectly through you, then
3343 the only way you could satisfy both it and this License would be to
3344 refrain entirely from distribution of the Program.
3346 If any portion of this section is held invalid or unenforceable under
3347 any particular circumstance, the balance of the section is intended to
3348 apply and the section as a whole is intended to apply in other
3351 It is not the purpose of this section to induce you to infringe any
3352 patents or other property right claims or to contest validity of any
3353 such claims; this section has the sole purpose of protecting the
3354 integrity of the free software distribution system, which is
3355 implemented by public license practices. Many people have made
3356 generous contributions to the wide range of software distributed
3357 through that system in reliance on consistent application of that
3358 system; it is up to the author/donor to decide if he or she is willing
3359 to distribute software through any other system and a licensee cannot
3362 This section is intended to make thoroughly clear what is believed to
3363 be a consequence of the rest of this License.
3366 If the distribution and/or use of the Program is restricted in
3367 certain countries either by patents or by copyrighted interfaces, the
3368 original copyright holder who places the Program under this License
3369 may add an explicit geographical distribution limitation excluding
3370 those countries, so that distribution is permitted only in or among
3371 countries not thus excluded. In such case, this License incorporates
3372 the limitation as if written in the body of this License.
3375 The Free Software Foundation may publish revised and/or new versions
3376 of the General Public License from time to time. Such new versions will
3377 be similar in spirit to the present version, but may differ in detail to
3378 address new problems or concerns.
3380 Each version is given a distinguishing version number. If the Program
3381 specifies a version number of this License which applies to it and ``any
3382 later version'', you have the option of following the terms and conditions
3383 either of that version or of any later version published by the Free
3384 Software Foundation. If the Program does not specify a version number of
3385 this License, you may choose any version ever published by the Free Software
3389 If you wish to incorporate parts of the Program into other free
3390 programs whose distribution conditions are different, write to the author
3391 to ask for permission. For software which is copyrighted by the Free
3392 Software Foundation, write to the Free Software Foundation; we sometimes
3393 make exceptions for this. Our decision will be guided by the two goals
3394 of preserving the free status of all derivatives of our free software and
3395 of promoting the sharing and reuse of software generally.
3398 @heading NO WARRANTY
3406 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3407 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3408 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3409 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3410 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3411 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3412 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3413 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3414 REPAIR OR CORRECTION.
3417 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3418 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3419 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3420 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3421 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3422 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3423 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3424 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3425 POSSIBILITY OF SUCH DAMAGES.
3429 @heading END OF TERMS AND CONDITIONS
3432 @center END OF TERMS AND CONDITIONS
3436 @unnumberedsec How to Apply These Terms to Your New Programs
3438 If you develop a new program, and you want it to be of the greatest
3439 possible use to the public, the best way to achieve this is to make it
3440 free software which everyone can redistribute and change under these terms.
3442 To do so, attach the following notices to the program. It is safest
3443 to attach them to the start of each source file to most effectively
3444 convey the exclusion of warranty; and each file should have at least
3445 the ``copyright'' line and a pointer to where the full notice is found.
3448 @var{one line to give the program's name and an idea of what it does.}
3449 Copyright (C) 19@var{yy} @var{name of author}
3451 This program is free software; you can redistribute it and/or
3452 modify it under the terms of the GNU General Public License
3453 as published by the Free Software Foundation; either version 2
3454 of the License, or (at your option) any later version.
3456 This program is distributed in the hope that it will be useful,
3457 but WITHOUT ANY WARRANTY; without even the implied warranty of
3458 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3459 GNU General Public License for more details.
3461 You should have received a copy of the GNU General Public License
3462 along with this program; if not, write to the Free Software
3463 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3466 Also add information on how to contact you by electronic and paper mail.
3468 If the program is interactive, make it output a short notice like this
3469 when it starts in an interactive mode:
3472 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3473 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3474 type `show w'. This is free software, and you are welcome
3475 to redistribute it under certain conditions; type `show c'
3479 The hypothetical commands @samp{show w} and @samp{show c} should show
3480 the appropriate parts of the General Public License. Of course, the
3481 commands you use may be called something other than @samp{show w} and
3482 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3485 You should also get your employer (if you work as a programmer) or your
3486 school, if any, to sign a ``copyright disclaimer'' for the program, if
3487 necessary. Here is a sample; alter the names:
3491 Yoyodyne, Inc., hereby disclaims all copyright
3492 interest in the program `Gnomovision'
3493 (which makes passes at compilers) written
3496 @var{signature of Ty Coon}, 1 April 1989
3497 Ty Coon, President of Vice
3501 This General Public License does not permit incorporating your program into
3502 proprietary programs. If your program is a subroutine library, you may
3503 consider it more useful to permit linking proprietary applications with the
3504 library. If this is what you want to do, use the GNU Library General
3505 Public License instead of this License.
3507 @node GNU Free Documentation License, , GNU General Public License, Copying
3508 @section GNU Free Documentation License
3509 @center Version 1.1, March 2000
3512 Copyright (C) 2000 Free Software Foundation, Inc.
3513 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3515 Everyone is permitted to copy and distribute verbatim copies
3516 of this license document, but changing it is not allowed.
3523 The purpose of this License is to make a manual, textbook, or other
3524 written document ``free'' in the sense of freedom: to assure everyone
3525 the effective freedom to copy and redistribute it, with or without
3526 modifying it, either commercially or noncommercially. Secondarily,
3527 this License preserves for the author and publisher a way to get
3528 credit for their work, while not being considered responsible for
3529 modifications made by others.
3531 This License is a kind of ``copyleft'', which means that derivative
3532 works of the document must themselves be free in the same sense. It
3533 complements the GNU General Public License, which is a copyleft
3534 license designed for free software.
3536 We have designed this License in order to use it for manuals for free
3537 software, because free software needs free documentation: a free
3538 program should come with manuals providing the same freedoms that the
3539 software does. But this License is not limited to software manuals;
3540 it can be used for any textual work, regardless of subject matter or
3541 whether it is published as a printed book. We recommend this License
3542 principally for works whose purpose is instruction or reference.
3546 APPLICABILITY AND DEFINITIONS
3548 This License applies to any manual or other work that contains a
3549 notice placed by the copyright holder saying it can be distributed
3550 under the terms of this License. The ``Document'', below, refers to any
3551 such manual or work. Any member of the public is a licensee, and is
3552 addressed as ``you''.
3554 A ``Modified Version'' of the Document means any work containing the
3555 Document or a portion of it, either copied verbatim, or with
3556 modifications and/or translated into another language.
3558 A ``Secondary Section'' is a named appendix or a front-matter section of
3559 the Document that deals exclusively with the relationship of the
3560 publishers or authors of the Document to the Document's overall subject
3561 (or to related matters) and contains nothing that could fall directly
3562 within that overall subject. (For example, if the Document is in part a
3563 textbook of mathematics, a Secondary Section may not explain any
3564 mathematics.) The relationship could be a matter of historical
3565 connection with the subject or with related matters, or of legal,
3566 commercial, philosophical, ethical or political position regarding
3569 The ``Invariant Sections'' are certain Secondary Sections whose titles
3570 are designated, as being those of Invariant Sections, in the notice
3571 that says that the Document is released under this License.
3573 The ``Cover Texts'' are certain short passages of text that are listed,
3574 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3575 the Document is released under this License.
3577 A ``Transparent'' copy of the Document means a machine-readable copy,
3578 represented in a format whose specification is available to the
3579 general public, whose contents can be viewed and edited directly and
3580 straightforwardly with generic text editors or (for images composed of
3581 pixels) generic paint programs or (for drawings) some widely available
3582 drawing editor, and that is suitable for input to text formatters or
3583 for automatic translation to a variety of formats suitable for input
3584 to text formatters. A copy made in an otherwise Transparent file
3585 format whose markup has been designed to thwart or discourage
3586 subsequent modification by readers is not Transparent. A copy that is
3587 not ``Transparent'' is called ``Opaque''.
3589 Examples of suitable formats for Transparent copies include plain
3590 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3591 or XML using a publicly available DTD, and standard-conforming simple
3592 HTML designed for human modification. Opaque formats include
3593 PostScript, PDF, proprietary formats that can be read and edited only
3594 by proprietary word processors, SGML or XML for which the DTD and/or
3595 processing tools are not generally available, and the
3596 machine-generated HTML produced by some word processors for output
3599 The ``Title Page'' means, for a printed book, the title page itself,
3600 plus such following pages as are needed to hold, legibly, the material
3601 this License requires to appear in the title page. For works in
3602 formats which do not have any title page as such, ``Title Page'' means
3603 the text near the most prominent appearance of the work's title,
3604 preceding the beginning of the body of the text.
3609 You may copy and distribute the Document in any medium, either
3610 commercially or noncommercially, provided that this License, the
3611 copyright notices, and the license notice saying this License applies
3612 to the Document are reproduced in all copies, and that you add no other
3613 conditions whatsoever to those of this License. You may not use
3614 technical measures to obstruct or control the reading or further
3615 copying of the copies you make or distribute. However, you may accept
3616 compensation in exchange for copies. If you distribute a large enough
3617 number of copies you must also follow the conditions in section 3.
3619 You may also lend copies, under the same conditions stated above, and
3620 you may publicly display copies.
3625 If you publish printed copies of the Document numbering more than 100,
3626 and the Document's license notice requires Cover Texts, you must enclose
3627 the copies in covers that carry, clearly and legibly, all these Cover
3628 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3629 the back cover. Both covers must also clearly and legibly identify
3630 you as the publisher of these copies. The front cover must present
3631 the full title with all words of the title equally prominent and
3632 visible. You may add other material on the covers in addition.
3633 Copying with changes limited to the covers, as long as they preserve
3634 the title of the Document and satisfy these conditions, can be treated
3635 as verbatim copying in other respects.
3637 If the required texts for either cover are too voluminous to fit
3638 legibly, you should put the first ones listed (as many as fit
3639 reasonably) on the actual cover, and continue the rest onto adjacent
3642 If you publish or distribute Opaque copies of the Document numbering
3643 more than 100, you must either include a machine-readable Transparent
3644 copy along with each Opaque copy, or state in or with each Opaque copy
3645 a publicly-accessible computer-network location containing a complete
3646 Transparent copy of the Document, free of added material, which the
3647 general network-using public has access to download anonymously at no
3648 charge using public-standard network protocols. If you use the latter
3649 option, you must take reasonably prudent steps, when you begin
3650 distribution of Opaque copies in quantity, to ensure that this
3651 Transparent copy will remain thus accessible at the stated location
3652 until at least one year after the last time you distribute an Opaque
3653 copy (directly or through your agents or retailers) of that edition to
3656 It is requested, but not required, that you contact the authors of the
3657 Document well before redistributing any large number of copies, to give
3658 them a chance to provide you with an updated version of the Document.
3663 You may copy and distribute a Modified Version of the Document under
3664 the conditions of sections 2 and 3 above, provided that you release
3665 the Modified Version under precisely this License, with the Modified
3666 Version filling the role of the Document, thus licensing distribution
3667 and modification of the Modified Version to whoever possesses a copy
3668 of it. In addition, you must do these things in the Modified Version:
3670 A. Use in the Title Page (and on the covers, if any) a title distinct
3671 from that of the Document, and from those of previous versions
3672 (which should, if there were any, be listed in the History section
3673 of the Document). You may use the same title as a previous version
3674 if the original publisher of that version gives permission.@*
3675 B. List on the Title Page, as authors, one or more persons or entities
3676 responsible for authorship of the modifications in the Modified
3677 Version, together with at least five of the principal authors of the
3678 Document (all of its principal authors, if it has less than five).@*
3679 C. State on the Title page the name of the publisher of the
3680 Modified Version, as the publisher.@*
3681 D. Preserve all the copyright notices of the Document.@*
3682 E. Add an appropriate copyright notice for your modifications
3683 adjacent to the other copyright notices.@*
3684 F. Include, immediately after the copyright notices, a license notice
3685 giving the public permission to use the Modified Version under the
3686 terms of this License, in the form shown in the Addendum below.@*
3687 G. Preserve in that license notice the full lists of Invariant Sections
3688 and required Cover Texts given in the Document's license notice.@*
3689 H. Include an unaltered copy of this License.@*
3690 I. Preserve the section entitled ``History'', and its title, and add to
3691 it an item stating at least the title, year, new authors, and
3692 publisher of the Modified Version as given on the Title Page. If
3693 there is no section entitled ``History'' in the Document, create one
3694 stating the title, year, authors, and publisher of the Document as
3695 given on its Title Page, then add an item describing the Modified
3696 Version as stated in the previous sentence.@*
3697 J. Preserve the network location, if any, given in the Document for
3698 public access to a Transparent copy of the Document, and likewise
3699 the network locations given in the Document for previous versions
3700 it was based on. These may be placed in the ``History'' section.
3701 You may omit a network location for a work that was published at
3702 least four years before the Document itself, or if the original
3703 publisher of the version it refers to gives permission.@*
3704 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3705 preserve the section's title, and preserve in the section all the
3706 substance and tone of each of the contributor acknowledgements
3707 and/or dedications given therein.@*
3708 L. Preserve all the Invariant Sections of the Document,
3709 unaltered in their text and in their titles. Section numbers
3710 or the equivalent are not considered part of the section titles.@*
3711 M. Delete any section entitled ``Endorsements''. Such a section
3712 may not be included in the Modified Version.@*
3713 N. Do not retitle any existing section as ``Endorsements''
3714 or to conflict in title with any Invariant Section.@*
3716 If the Modified Version includes new front-matter sections or
3717 appendices that qualify as Secondary Sections and contain no material
3718 copied from the Document, you may at your option designate some or all
3719 of these sections as invariant. To do this, add their titles to the
3720 list of Invariant Sections in the Modified Version's license notice.
3721 These titles must be distinct from any other section titles.
3723 You may add a section entitled ``Endorsements'', provided it contains
3724 nothing but endorsements of your Modified Version by various
3725 parties--for example, statements of peer review or that the text has
3726 been approved by an organization as the authoritative definition of a
3729 You may add a passage of up to five words as a Front-Cover Text, and a
3730 passage of up to 25 words as a Back-Cover Text, to the end of the list
3731 of Cover Texts in the Modified Version. Only one passage of
3732 Front-Cover Text and one of Back-Cover Text may be added by (or
3733 through arrangements made by) any one entity. If the Document already
3734 includes a cover text for the same cover, previously added by you or
3735 by arrangement made by the same entity you are acting on behalf of,
3736 you may not add another; but you may replace the old one, on explicit
3737 permission from the previous publisher that added the old one.
3739 The author(s) and publisher(s) of the Document do not by this License
3740 give permission to use their names for publicity for or to assert or
3741 imply endorsement of any Modified Version.
3746 You may combine the Document with other documents released under this
3747 License, under the terms defined in section 4 above for modified
3748 versions, provided that you include in the combination all of the
3749 Invariant Sections of all of the original documents, unmodified, and
3750 list them all as Invariant Sections of your combined work in its
3753 The combined work need only contain one copy of this License, and
3754 multiple identical Invariant Sections may be replaced with a single
3755 copy. If there are multiple Invariant Sections with the same name but
3756 different contents, make the title of each such section unique by
3757 adding at the end of it, in parentheses, the name of the original
3758 author or publisher of that section if known, or else a unique number.
3759 Make the same adjustment to the section titles in the list of
3760 Invariant Sections in the license notice of the combined work.
3762 In the combination, you must combine any sections entitled ``History''
3763 in the various original documents, forming one section entitled
3764 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3765 and any sections entitled ``Dedications''. You must delete all sections
3766 entitled ``Endorsements.''
3769 COLLECTIONS OF DOCUMENTS
3771 You may make a collection consisting of the Document and other documents
3772 released under this License, and replace the individual copies of this
3773 License in the various documents with a single copy that is included in
3774 the collection, provided that you follow the rules of this License for
3775 verbatim copying of each of the documents in all other respects.
3777 You may extract a single document from such a collection, and distribute
3778 it individually under this License, provided you insert a copy of this
3779 License into the extracted document, and follow this License in all
3780 other respects regarding verbatim copying of that document.
3783 AGGREGATION WITH INDEPENDENT WORKS
3785 A compilation of the Document or its derivatives with other separate
3786 and independent documents or works, in or on a volume of a storage or
3787 distribution medium, does not as a whole count as a Modified Version
3788 of the Document, provided no compilation copyright is claimed for the
3789 compilation. Such a compilation is called an ``aggregate'', and this
3790 License does not apply to the other self-contained works thus compiled
3791 with the Document, on account of their being thus compiled, if they
3792 are not themselves derivative works of the Document.
3794 If the Cover Text requirement of section 3 is applicable to these
3795 copies of the Document, then if the Document is less than one quarter
3796 of the entire aggregate, the Document's Cover Texts may be placed on
3797 covers that surround only the Document within the aggregate.
3798 Otherwise they must appear on covers around the whole aggregate.
3803 Translation is considered a kind of modification, so you may
3804 distribute translations of the Document under the terms of section 4.
3805 Replacing Invariant Sections with translations requires special
3806 permission from their copyright holders, but you may include
3807 translations of some or all Invariant Sections in addition to the
3808 original versions of these Invariant Sections. You may include a
3809 translation of this License provided that you also include the
3810 original English version of this License. In case of a disagreement
3811 between the translation and the original English version of this
3812 License, the original English version will prevail.
3817 You may not copy, modify, sublicense, or distribute the Document except
3818 as expressly provided for under this License. Any other attempt to
3819 copy, modify, sublicense or distribute the Document is void, and will
3820 automatically terminate your rights under this License. However,
3821 parties who have received copies, or rights, from you under this
3822 License will not have their licenses terminated so long as such
3823 parties remain in full compliance.
3826 FUTURE REVISIONS OF THIS LICENSE
3828 The Free Software Foundation may publish new, revised versions
3829 of the GNU Free Documentation License from time to time. Such new
3830 versions will be similar in spirit to the present version, but may
3831 differ in detail to address new problems or concerns. See
3832 http://www.gnu.org/copyleft/.
3834 Each version of the License is given a distinguishing version number.
3835 If the Document specifies that a particular numbered version of this
3836 License ``or any later version'' applies to it, you have the option of
3837 following the terms and conditions either of that specified version or
3838 of any later version that has been published (not as a draft) by the
3839 Free Software Foundation. If the Document does not specify a version
3840 number of this License, you may choose any version ever published (not
3841 as a draft) by the Free Software Foundation.
3845 @unnumberedsec ADDENDUM: How to use this License for your documents
3847 To use this License in a document you have written, include a copy of
3848 the License in the document and put the following copyright and
3849 license notices just after the title page:
3854 Copyright (C) @var{year} @var{your name}.
3855 Permission is granted to copy, distribute and/or modify this document
3856 under the terms of the GNU Free Documentation License, Version 1.1
3857 or any later version published by the Free Software Foundation;
3858 with the Invariant Sections being @var{list their titles}, with the
3859 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
3860 A copy of the license is included in the section entitled ``GNU
3861 Free Documentation License''.
3864 If you have no Invariant Sections, write ``with no Invariant Sections''
3865 instead of saying which ones are invariant. If you have no
3866 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
3867 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
3869 If your document contains nontrivial examples of program code, we
3870 recommend releasing these examples in parallel under your choice of
3871 free software license, such as the GNU General Public License,
3872 to permit their use in free software.
3875 @node Concept Index, , Copying, Top
3876 @unnumbered Concept Index