1 \input texinfo @c -*-texinfo-*-
5 @settitle GNU Wget Manual
6 @c Disable the monstrous rectangles beside overfull hbox-es.
8 @c Use `odd' to print double-sided.
13 @c Remove this if you don't use A4 paper.
17 @c This should really be generated automatically, possibly by including
18 @c an auto-generated file.
20 @set UPDATED December 2001
22 @dircategory Net Utilities
23 @dircategory World Wide Web
25 * Wget: (wget). The non-interactive network downloader.
29 This file documents the the GNU Wget utility for downloading network
32 @c man begin COPYRIGHT
33 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
36 Permission is granted to make and distribute verbatim copies of
37 this manual provided the copyright notice and this permission notice
38 are preserved on all copies.
41 Permission is granted to process this file through TeX and print the
42 results, provided the printed document carries a copying permission
43 notice identical to this one except for the removal of this paragraph
44 (this paragraph not being relevant to the printed manual).
46 Permission is granted to copy, distribute and/or modify this document
47 under the terms of the GNU Free Documentation License, Version 1.1 or
48 any later version published by the Free Software Foundation; with the
49 Invariant Sections being ``GNU General Public License'' and ``GNU Free
50 Documentation License'', with no Front-Cover Texts, and with no
51 Back-Cover Texts. A copy of the license is included in the section
52 entitled ``GNU Free Documentation License''.
58 @subtitle The noninteractive downloading utility
59 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
60 @author by Hrvoje Nik@v{s}i@'{c} and the developers
64 Originally written by Hrvoje Niksic <hniksic@arsdigita.com>.
67 GNU Info entry for @file{wget}.
72 @vskip 0pt plus 1filll
73 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
76 Permission is granted to copy, distribute and/or modify this document
77 under the terms of the GNU Free Documentation License, Version 1.1 or
78 any later version published by the Free Software Foundation; with the
79 Invariant Sections being ``GNU General Public License'' and ``GNU Free
80 Documentation License'', with no Front-Cover Texts, and with no
81 Back-Cover Texts. A copy of the license is included in the section
82 entitled ``GNU Free Documentation License''.
86 @node Top, Overview, (dir), (dir)
87 @top Wget @value{VERSION}
89 This manual documents version @value{VERSION} of GNU Wget, the freely
90 available utility for network download.
92 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
96 * Overview:: Features of Wget.
97 * Invoking:: Wget command-line arguments.
98 * Recursive Retrieval:: Description of recursive retrieval.
99 * Following Links:: The available methods of chasing links.
100 * Time-Stamping:: Mirroring according to time-stamps.
101 * Startup File:: Wget's initialization file.
102 * Examples:: Examples of usage.
103 * Various:: The stuff that doesn't fit anywhere else.
104 * Appendices:: Some useful references.
105 * Copying:: You may give out copies of Wget and of this manual.
106 * Concept Index:: Topics covered by this manual.
110 @node Overview, Invoking, Top, Top
115 @c man begin DESCRIPTION
116 GNU Wget is a free utility for non-interactive download of files from
117 the Web. It supports @sc{http}, @sc{https}, and @sc{ftp} protocols, as
118 well as retrieval through @sc{http} proxies.
121 This chapter is a partial overview of Wget's features.
125 @c man begin DESCRIPTION
126 Wget is non-interactive, meaning that it can work in the background,
127 while the user is not logged on. This allows you to start a retrieval
128 and disconnect from the system, letting Wget finish the work. By
129 contrast, most of the Web browsers require constant user's presence,
130 which can be a great hindrance when transferring a lot of data.
136 @c man begin DESCRIPTION
140 @c man begin DESCRIPTION
141 Wget can follow links in @sc{html} pages and create local versions of
142 remote web sites, fully recreating the directory structure of the
143 original site. This is sometimes referred to as ``recursive
144 downloading.'' While doing that, Wget respects the Robot Exclusion
145 Standard (@file{/robots.txt}). Wget can be instructed to convert the
146 links in downloaded @sc{html} files to the local files for offline
152 File name wildcard matching and recursive mirroring of directories are
153 available when retrieving via @sc{ftp}. Wget can read the time-stamp
154 information given by both @sc{http} and @sc{ftp} servers, and store it
155 locally. Thus Wget can see if the remote file has changed since last
156 retrieval, and automatically retrieve the new version if it has. This
157 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
163 @c man begin DESCRIPTION
167 @c man begin DESCRIPTION
168 Wget has been designed for robustness over slow or unstable network
169 connections; if a download fails due to a network problem, it will
170 keep retrying until the whole file has been retrieved. If the server
171 supports regetting, it will instruct the server to continue the
172 download from where it left off.
177 Wget supports proxy servers, which can lighten the network load, speed
178 up retrieval and provide access behind firewalls. However, if you are
179 behind a firewall that requires that you use a socks style gateway, you
180 can get the socks library and build Wget with support for socks. Wget
181 also supports the passive @sc{ftp} downloading as an option.
185 Builtin features offer mechanisms to tune which links you wish to follow
186 (@pxref{Following Links}).
190 The retrieval is conveniently traced with printing dots, each dot
191 representing a fixed amount of data received (1KB by default). These
192 representations can be customized to your preferences.
196 Most of the features are fully configurable, either through command line
197 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
198 File}). Wget allows you to define @dfn{global} startup files
199 (@file{/usr/local/etc/wgetrc} by default) for site settings.
204 @item /usr/local/etc/wgetrc
205 Default location of the @dfn{global} startup file.
215 Finally, GNU Wget is free software. This means that everyone may use
216 it, redistribute it and/or modify it under the terms of the GNU General
217 Public License, as published by the Free Software Foundation
221 @node Invoking, Recursive Retrieval, Overview, Top
228 By default, Wget is very simple to invoke. The basic syntax is:
231 @c man begin SYNOPSIS
232 wget [@var{option}]@dots{} [@var{URL}]@dots{}
236 Wget will simply download all the @sc{url}s specified on the command
237 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
239 However, you may wish to change some of the default parameters of
240 Wget. You can do it two ways: permanently, adding the appropriate
241 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
247 * Basic Startup Options::
248 * Logging and Input File Options::
250 * Directory Options::
253 * Recursive Retrieval Options::
254 * Recursive Accept/Reject Options::
257 @node URL Format, Option Syntax, Invoking, Invoking
262 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
263 resource locator is a compact string representation for a resource
264 available via the Internet. Wget recognizes the @sc{url} syntax as per
265 @sc{rfc1738}. This is the most widely used form (square brackets denote
269 http://host[:port]/directory/file
270 ftp://host[:port]/directory/file
273 You can also encode your username and password within a @sc{url}:
276 ftp://user:password@@host/path
277 http://user:password@@host/path
280 Either @var{user} or @var{password}, or both, may be left out. If you
281 leave out either the @sc{http} username or password, no authentication
282 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
283 will be used. If you leave out the @sc{ftp} password, your email
284 address will be supplied as a default password.@footnote{If you have a
285 @file{.netrc} file in your home directory, password will also be
288 @strong{Important Note}: if you specify a password-containing @sc{url}
289 on the command line, the username and password will be plainly visible
290 to all users on the system, by way of @code{ps}. On multi-user systems,
291 this is a big security risk. To work around it, use @code{wget -i -}
292 and feed the @sc{url}s to Wget's standard input, each on a separate
293 line, terminated by @kbd{C-d}.
295 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
296 being the hexadecimal representation of the character's @sc{ascii}
297 value. Some common unsafe characters include @samp{%} (quoted as
298 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
299 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
302 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
303 default, @sc{ftp} documents are retrieved in the binary mode (type
304 @samp{i}), which means that they are downloaded unchanged. Another
305 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
306 delimiters between the different operating systems, and is thus useful
307 for text files. Here is an example:
310 ftp://host/directory/file;type=a
313 Two alternative variants of @sc{url} specification are also supported,
314 because of historical (hysterical?) reasons and their widespreaded use.
316 @sc{ftp}-only syntax (supported by @code{NcFTP}):
321 @sc{http}-only syntax (introduced by @code{Netscape}):
326 These two alternative forms are deprecated, and may cease being
327 supported in the future.
329 If you do not understand the difference between these notations, or do
330 not know which one to use, just use the plain ordinary format you use
331 with your favorite browser, like @code{Lynx} or @code{Netscape}.
333 @node Option Syntax, Basic Startup Options, URL Format, Invoking
334 @section Option Syntax
335 @cindex option syntax
336 @cindex syntax of options
338 Since Wget uses GNU getopts to process its arguments, every option has a
339 short form and a long form. Long options are more convenient to
340 remember, but take time to type. You may freely mix different option
341 styles, or specify options after the command-line arguments. Thus you
345 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
348 The space between the option accepting an argument and the argument may
349 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
351 You may put several options that do not require arguments together,
358 This is a complete equivalent of:
361 wget -d -r -c @var{URL}
364 Since the options can be specified after the arguments, you may
365 terminate them with @samp{--}. So the following will try to download
366 @sc{url} @samp{-x}, reporting failure to @file{log}:
372 The options that accept comma-separated lists all respect the convention
373 that specifying an empty list clears its value. This can be useful to
374 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
375 sets @code{exclude_directories} to @file{/cgi-bin}, the following
376 example will first reset it, and then set it to exclude @file{/~nobody}
377 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
378 (@pxref{Wgetrc Syntax}).
381 wget -X '' -X /~nobody,/~somebody
386 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
387 @section Basic Startup Options
392 Display the version of Wget.
396 Print a help message describing all of Wget's command-line options.
400 Go to background immediately after startup. If no output file is
401 specified via the @samp{-o}, output is redirected to @file{wget-log}.
403 @cindex execute wgetrc command
404 @item -e @var{command}
405 @itemx --execute @var{command}
406 Execute @var{command} as if it were a part of @file{.wgetrc}
407 (@pxref{Startup File}). A command thus invoked will be executed
408 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
412 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
413 @section Logging and Input File Options
418 @item -o @var{logfile}
419 @itemx --output-file=@var{logfile}
420 Log all messages to @var{logfile}. The messages are normally reported
423 @cindex append to log
424 @item -a @var{logfile}
425 @itemx --append-output=@var{logfile}
426 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
427 to @var{logfile} instead of overwriting the old log file. If
428 @var{logfile} does not exist, a new file is created.
433 Turn on debug output, meaning various information important to the
434 developers of Wget if it does not work properly. Your system
435 administrator may have chosen to compile Wget without debug support, in
436 which case @samp{-d} will not work. Please note that compiling with
437 debug support is always safe---Wget compiled with the debug support will
438 @emph{not} print any debug info unless requested with @samp{-d}.
439 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
445 Turn off Wget's output.
450 Turn on verbose output, with all the available data. The default output
455 Non-verbose output---turn off verbose without being completely quiet
456 (use @samp{-q} for that), which means that error messages and basic
457 information still get printed.
461 @itemx --input-file=@var{file}
462 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
463 the command line. If there are @sc{url}s both on the command line and
464 in an input file, those on the command lines will be the first ones to
465 be retrieved. The @var{file} need not be an @sc{html} document (but no
466 harm if it is)---it is enough if the @sc{url}s are just listed
469 However, if you specify @samp{--force-html}, the document will be
470 regarded as @samp{html}. In that case you may have problems with
471 relative links, which you can solve either by adding @code{<base
472 href="@var{url}">} to the documents or by specifying
473 @samp{--base=@var{url}} on the command line.
478 When input is read from a file, force it to be treated as an @sc{html}
479 file. This enables you to retrieve relative links from existing
480 @sc{html} files on your local disk, by adding @code{<base
481 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
484 @cindex base for relative links in input file
486 @itemx --base=@var{URL}
487 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
488 links in the file specified by @samp{-i}.
491 @node Download Options, Directory Options, Logging and Input File Options, Invoking
492 @section Download Options
495 @cindex bind() address
496 @cindex client IP address
497 @cindex IP address, client
498 @item --bind-address=@var{ADDRESS}
499 When making client TCP/IP connections, @code{bind()} to @var{ADDRESS} on
500 the local machine. @var{ADDRESS} may be specified as a hostname or IP
501 address. This option can be useful if your machine is bound to multiple
506 @cindex number of retries
507 @item -t @var{number}
508 @itemx --tries=@var{number}
509 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
513 @itemx --output-document=@var{file}
514 The documents will not be written to the appropriate files, but all will
515 be concatenated together and written to @var{file}. If @var{file}
516 already exists, it will be overwritten. If the @var{file} is @samp{-},
517 the documents will be written to standard output. Including this option
518 automatically sets the number of tries to 1.
520 @cindex clobbering, file
521 @cindex downloading multiple times
525 If a file is downloaded more than once in the same directory, Wget's
526 behavior depends on a few options, including @samp{-nc}. In certain
527 cases, the local file will be @dfn{clobbered}, or overwritten, upon
528 repeated download. In other cases it will be preserved.
530 When running Wget without @samp{-N}, @samp{-nc}, or @samp{-r},
531 downloading the same file in the same directory will result in the
532 original copy of @var{file} being preserved and the second copy being
533 named @samp{@var{file}.1}. If that file is downloaded yet again, the
534 third copy will be named @samp{@var{file}.2}, and so on. When
535 @samp{-nc} is specified, this behavior is suppressed, and Wget will
536 refuse to download newer copies of @samp{@var{file}}. Therefore,
537 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
538 clobbering that's prevented (as the numeric suffixes were already
539 preventing clobbering), but rather the multiple version saving that's
542 When running Wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
543 re-downloading a file will result in the new copy simply overwriting the
544 old. Adding @samp{-nc} will prevent this behavior, instead causing the
545 original version to be preserved and any newer copies on the server to
548 When running Wget with @samp{-N}, with or without @samp{-r}, the
549 decision as to whether or not to download a newer copy of a file depends
550 on the local and remote timestamp and size of the file
551 (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the same
554 Note that when @samp{-nc} is specified, files with the suffixes
555 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
556 and parsed as if they had been retrieved from the Web.
558 @cindex continue retrieval
559 @cindex incomplete downloads
560 @cindex resume download
563 Continue getting a partially-downloaded file. This is useful when you
564 want to finish up a download started by a previous instance of Wget, or
565 by another program. For instance:
568 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
571 If there is a file named @file{ls-lR.Z} in the current directory, Wget
572 will assume that it is the first portion of the remote file, and will
573 ask the server to continue the retrieval from an offset equal to the
574 length of the local file.
576 Note that you don't need to specify this option if you just want the
577 current invocation of Wget to retry downloading a file should the
578 connection be lost midway through. This is the default behavior.
579 @samp{-c} only affects resumption of downloads started @emph{prior} to
580 this invocation of Wget, and whose local files are still sitting around.
582 Without @samp{-c}, the previous example would just download the remote
583 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
586 Beginning with Wget 1.7, if you use @samp{-c} on a non-empty file, and
587 it turns out that the server does not support continued downloading,
588 Wget will refuse to start the download from scratch, which would
589 effectively ruin existing contents. If you really want the download to
590 start from scratch, remove the file.
592 Also beginning with Wget 1.7, if you use @samp{-c} on a file which is of
593 equal size as the one on the server, Wget will refuse to download the
594 file and print an explanatory message. The same happens when the file
595 is smaller on the server than locally (presumably because it was changed
596 on the server since your last download attempt)---because ``continuing''
597 is not meaningful, no download occurs.
599 On the other side of the coin, while using @samp{-c}, any file that's
600 bigger on the server than locally will be considered an incomplete
601 download and only @code{(length(remote) - length(local))} bytes will be
602 downloaded and tacked onto the end of the local file. This behavior can
603 be desirable in certain cases---for instance, you can use @samp{wget -c}
604 to download just the new portion that's been appended to a data
605 collection or log file.
607 However, if the file is bigger on the server because it's been
608 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
609 with a garbled file. Wget has no way of verifying that the local file
610 is really a valid prefix of the remote file. You need to be especially
611 careful of this when using @samp{-c} in conjunction with @samp{-r},
612 since every file will be considered as an "incomplete download" candidate.
614 Another instance where you'll get a garbled file if you try to use
615 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
616 ``transfer interrupted'' string into the local file. In the future a
617 ``rollback'' option may be added to deal with this case.
619 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
620 servers that support the @code{Range} header.
622 @cindex progress indicator
624 @item --progress=@var{type}
625 Select the type of the progress indicator you wish to use. Legal
626 indicators are ``dot'' and ``bar''.
628 The ``dot'' indicator is used by default. It traces the retrieval by
629 printing dots on the screen, each dot representing a fixed amount of
632 When using the dotted retrieval, you may also set the @dfn{style} by
633 specifying the type as @samp{dot:@var{style}}. Different styles assign
634 different meaning to one dot. With the @code{default} style each dot
635 represents 1K, there are ten dots in a cluster and 50 dots in a line.
636 The @code{binary} style has a more ``computer''-like orientation---8K
637 dots, 16-dots clusters and 48 dots per line (which makes for 384K
638 lines). The @code{mega} style is suitable for downloading very large
639 files---each dot represents 64K retrieved, there are eight dots in a
640 cluster, and 48 dots on each line (so each line contains 3M).
642 Specifying @samp{--progress=bar} will draw a nice ASCII progress bar
643 graphics (a.k.a ``thermometer'' display) to indicate retrieval. If the
644 output is not a TTY, this option will be ignored, and Wget will revert
645 to the dot indicator. If you want to force the bar indicator, use
646 @samp{--progress=bar:force}.
649 @itemx --timestamping
650 Turn on time-stamping. @xref{Time-Stamping}, for details.
652 @cindex server response, print
654 @itemx --server-response
655 Print the headers sent by @sc{http} servers and responses sent by
658 @cindex Wget as spider
661 When invoked with this option, Wget will behave as a Web @dfn{spider},
662 which means that it will not download the pages, just check that they
663 are there. You can use it to check your bookmarks, e.g. with:
666 wget --spider --force-html -i bookmarks.html
669 This feature needs much more work for Wget to get close to the
670 functionality of real @sc{www} spiders.
674 @itemx --timeout=@var{seconds}
675 Set the network timeout to @var{seconds} seconds. Whenever Wget
676 connects to or reads from a remote host, it checks for a timeout and
677 aborts the operation if the time expires. This prevents anomalous
678 occurrences such as hanging reads or infinite connects. The default
679 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
680 disable checking for timeouts.
682 Please do not lower the default timeout value with this option unless
683 you know what you are doing.
685 @cindex bandwidth, limit
687 @cindex limit bandwidth
688 @item --limit-rate=@var{amount}
689 Limit the download speed to @var{amount} bytes per second. Amount may
690 be expressed in bytes, kilobytes with the @samp{k} suffix, or megabytes
691 with the @samp{m} suffix. For example, @samp{--limit-rate=20k} will
692 limit the retrieval rate to 20KB/s. This kind of thing is useful when,
693 for whatever reason, you don't want Wget to consume the entire evailable
696 Note that Wget implementeds the limiting by sleeping the appropriate
697 amount of time after a network read that took less time than specified
698 by the rate. Eventually this strategy causes the TCP transfer to slow
699 down to approximately the specified rate. However, it takes some time
700 for this balance to be achieved, so don't be surprised if limiting the
701 rate doesn't work with very small files. Also, the "sleeping" strategy
702 will misfire when an extremely small bandwidth, say less than 1.5KB/s,
707 @item -w @var{seconds}
708 @itemx --wait=@var{seconds}
709 Wait the specified number of seconds between the retrievals. Use of
710 this option is recommended, as it lightens the server load by making the
711 requests less frequent. Instead of in seconds, the time can be
712 specified in minutes using the @code{m} suffix, in hours using @code{h}
713 suffix, or in days using @code{d} suffix.
715 Specifying a large value for this option is useful if the network or the
716 destination host is down, so that Wget can wait long enough to
717 reasonably expect the network error to be fixed before the retry.
719 @cindex retries, waiting between
720 @cindex waiting between retries
721 @item --waitretry=@var{seconds}
722 If you don't want Wget to wait between @emph{every} retrieval, but only
723 between retries of failed downloads, you can use this option. Wget will
724 use @dfn{linear backoff}, waiting 1 second after the first failure on a
725 given file, then waiting 2 seconds after the second failure on that
726 file, up to the maximum number of @var{seconds} you specify. Therefore,
727 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
730 Note that this option is turned on by default in the global
736 Some web sites may perform log analysis to identify retrieval programs
737 such as Wget by looking for statistically significant similarities in
738 the time between requests. This option causes the time between requests
739 to vary between 0 and 2 * @var{wait} seconds, where @var{wait} was
740 specified using the @samp{-w} or @samp{--wait} options, in order to mask
741 Wget's presence from such analysis.
743 A recent article in a publication devoted to development on a popular
744 consumer platform provided code to perform this analysis on the fly.
745 Its author suggested blocking at the class C address level to ensure
746 automated retrieval programs were blocked despite changing DHCP-supplied
749 The @samp{--random-wait} option was inspired by this ill-advised
750 recommendation to block many unrelated users from a web site due to the
755 @itemx --proxy=on/off
756 Turn proxy support on or off. The proxy is on by default if the
757 appropriate environmental variable is defined.
761 @itemx --quota=@var{quota}
762 Specify download quota for automatic retrievals. The value can be
763 specified in bytes (default), kilobytes (with @samp{k} suffix), or
764 megabytes (with @samp{m} suffix).
766 Note that quota will never affect downloading a single file. So if you
767 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
768 @file{ls-lR.gz} will be downloaded. The same goes even when several
769 @sc{url}s are specified on the command-line. However, quota is
770 respected when retrieving either recursively, or from an input file.
771 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
772 aborted when the quota is exceeded.
774 Setting quota to 0 or to @samp{inf} unlimits the download quota.
777 @node Directory Options, HTTP Options, Download Options, Invoking
778 @section Directory Options
782 @itemx --no-directories
783 Do not create a hierarchy of directories when retrieving recursively.
784 With this option turned on, all files will get saved to the current
785 directory, without clobbering (if a name shows up more than once, the
786 filenames will get extensions @samp{.n}).
789 @itemx --force-directories
790 The opposite of @samp{-nd}---create a hierarchy of directories, even if
791 one would not have been created otherwise. E.g. @samp{wget -x
792 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
793 @file{fly.srk.fer.hr/robots.txt}.
796 @itemx --no-host-directories
797 Disable generation of host-prefixed directories. By default, invoking
798 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
799 directories beginning with @file{fly.srk.fer.hr/}. This option disables
802 @cindex cut directories
803 @item --cut-dirs=@var{number}
804 Ignore @var{number} directory components. This is useful for getting a
805 fine-grained control over the directory where recursive retrieval will
808 Take, for example, the directory at
809 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
810 @samp{-r}, it will be saved locally under
811 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
812 remove the @file{ftp.xemacs.org/} part, you are still stuck with
813 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
814 makes Wget not ``see'' @var{number} remote directory components. Here
815 are several examples of how @samp{--cut-dirs} option works.
819 No options -> ftp.xemacs.org/pub/xemacs/
821 -nH --cut-dirs=1 -> xemacs/
822 -nH --cut-dirs=2 -> .
824 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
829 If you just want to get rid of the directory structure, this option is
830 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
831 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
832 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
833 be placed to @file{xemacs/beta}, as one would expect.
835 @cindex directory prefix
836 @item -P @var{prefix}
837 @itemx --directory-prefix=@var{prefix}
838 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
839 directory where all other files and subdirectories will be saved to,
840 i.e. the top of the retrieval tree. The default is @samp{.} (the
844 @node HTTP Options, FTP Options, Directory Options, Invoking
845 @section HTTP Options
848 @cindex .html extension
850 @itemx --html-extension
851 If a file of type @samp{text/html} is downloaded and the URL does not
852 end with the regexp @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause
853 the suffix @samp{.html} to be appended to the local filename. This is
854 useful, for instance, when you're mirroring a remote site that uses
855 @samp{.asp} pages, but you want the mirrored pages to be viewable on
856 your stock Apache server. Another good use for this is when you're
857 downloading the output of CGIs. A URL like
858 @samp{http://site.com/article.cgi?25} will be saved as
859 @file{article.cgi?25.html}.
861 Note that filenames changed in this way will be re-downloaded every time
862 you re-mirror a site, because Wget can't tell that the local
863 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
864 it doesn't yet know that the URL produces output of type
865 @samp{text/html}. To prevent this re-downloading, you must use
866 @samp{-k} and @samp{-K} so that the original version of the file will be
867 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
870 @cindex http password
871 @cindex authentication
872 @item --http-user=@var{user}
873 @itemx --http-passwd=@var{password}
874 Specify the username @var{user} and password @var{password} on an
875 @sc{http} server. According to the type of the challenge, Wget will
876 encode them using either the @code{basic} (insecure) or the
877 @code{digest} authentication scheme.
879 Another way to specify username and password is in the @sc{url} itself
880 (@pxref{URL Format}). Either method reveals your password to anyone who
881 bothers to run @code{ps}. To prevent the passwords from being seen,
882 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
883 those files from other users with @code{chmod}. If the passwords are
884 really important, do not leave them lying in those files either---edit
885 the files and delete them after Wget has started the download.
887 For more information about security issues with Wget, @xref{Security
893 @itemx --cache=on/off
894 When set to off, disable server-side cache. In this case, Wget will
895 send the remote server an appropriate directive (@samp{Pragma:
896 no-cache}) to get the file from the remote service, rather than
897 returning the cached version. This is especially useful for retrieving
898 and flushing out-of-date documents on proxy servers.
900 Caching is allowed by default.
903 @item --cookies=on/off
904 When set to off, disable the use of cookies. Cookies are a mechanism
905 for maintaining server-side state. The server sends the client a cookie
906 using the @code{Set-Cookie} header, and the client responds with the
907 same cookie upon further requests. Since cookies allow the server
908 owners to keep track of visitors and for sites to exchange this
909 information, some consider them a breach of privacy. The default is to
910 use cookies; however, @emph{storing} cookies is not on by default.
912 @cindex loading cookies
913 @cindex cookies, loading
914 @item --load-cookies @var{file}
915 Load cookies from @var{file} before the first HTTP retrieval.
916 @var{file} is a textual file in the format originally used by Netscape's
917 @file{cookies.txt} file.
919 You will typically use this option when mirroring sites that require
920 that you be logged in to access some or all of their content. The login
921 process typically works by the web server issuing an @sc{http} cookie
922 upon receiving and verifying your credentials. The cookie is then
923 resent by the browser when accessing that part of the site, and so
924 proves your identity.
926 Mirroring such a site requires Wget to send the same cookies your
927 browser sends when communicating with the site. This is achieved by
928 @samp{--load-cookies}---simply point Wget to the location of the
929 @file{cookies.txt} file, and it will send the same cookies your browser
930 would send in the same situation. Different browsers keep textual
931 cookie files in different locations:
935 The cookies are in @file{~/.netscape/cookies.txt}.
937 @item Mozilla and Netscape 6.x.
938 Mozilla's cookie file is also named @file{cookies.txt}, located
939 somewhere under @file{~/.mozilla}, in the directory of your profile.
940 The full path usually ends up looking somewhat like
941 @file{~/.mozilla/default/@var{some-weird-string}/cookies.txt}.
943 @item Internet Explorer.
944 You can produce a cookie file Wget can use by using the File menu,
945 Import and Export, Export Cookies. This has been tested with Internet
946 Explorer 5; it is not guaranteed to work with earlier versions.
948 @item Other browsers.
949 If you are using a different browser to create your cookies,
950 @samp{--load-cookies} will only work if you can locate or produce a
951 cookie file in the Netscape format that Wget expects.
954 If you cannot use @samp{--load-cookies}, there might still be an
955 alternative. If your browser supports a ``cookie manager'', you can use
956 it to view the cookies used when accessing the site you're mirroring.
957 Write down the name and value of the cookie, and manually instruct Wget
958 to send those cookies, bypassing the ``official'' cookie support:
961 wget --cookies=off --header "Cookie: @var{name}=@var{value}"
964 @cindex saving cookies
965 @cindex cookies, saving
966 @item --save-cookies @var{file}
967 Save cookies from @var{file} at the end of session. Cookies whose
968 expiry time is not specified, or those that have already expired, are
971 @cindex Content-Length, ignore
972 @cindex ignore length
973 @item --ignore-length
974 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
975 precise) send out bogus @code{Content-Length} headers, which makes Wget
976 go wild, as it thinks not all the document was retrieved. You can spot
977 this syndrome if Wget retries getting the same document again and again,
978 each time claiming that the (otherwise normal) connection has closed on
981 With this option, Wget will ignore the @code{Content-Length} header---as
985 @item --header=@var{additional-header}
986 Define an @var{additional-header} to be passed to the @sc{http} servers.
987 Headers must contain a @samp{:} preceded by one or more non-blank
988 characters, and must not contain newlines.
990 You may define more than one additional header by specifying
991 @samp{--header} more than once.
995 wget --header='Accept-Charset: iso-8859-2' \
996 --header='Accept-Language: hr' \
997 http://fly.srk.fer.hr/
1001 Specification of an empty string as the header value will clear all
1002 previous user-defined headers.
1005 @cindex proxy password
1006 @cindex proxy authentication
1007 @item --proxy-user=@var{user}
1008 @itemx --proxy-passwd=@var{password}
1009 Specify the username @var{user} and password @var{password} for
1010 authentication on a proxy server. Wget will encode them using the
1011 @code{basic} authentication scheme.
1013 Security considerations similar to those with @samp{--http-passwd}
1014 pertain here as well.
1016 @cindex http referer
1017 @cindex referer, http
1018 @item --referer=@var{url}
1019 Include `Referer: @var{url}' header in HTTP request. Useful for
1020 retrieving documents with server-side processing that assume they are
1021 always being retrieved by interactive web browsers and only come out
1022 properly when Referer is set to one of the pages that point to them.
1024 @cindex server response, save
1026 @itemx --save-headers
1027 Save the headers sent by the @sc{http} server to the file, preceding the
1028 actual contents, with an empty line as the separator.
1031 @item -U @var{agent-string}
1032 @itemx --user-agent=@var{agent-string}
1033 Identify as @var{agent-string} to the @sc{http} server.
1035 The @sc{http} protocol allows the clients to identify themselves using a
1036 @code{User-Agent} header field. This enables distinguishing the
1037 @sc{www} software, usually for statistical purposes or for tracing of
1038 protocol violations. Wget normally identifies as
1039 @samp{Wget/@var{version}}, @var{version} being the current version
1042 However, some sites have been known to impose the policy of tailoring
1043 the output according to the @code{User-Agent}-supplied information.
1044 While conceptually this is not such a bad idea, it has been abused by
1045 servers denying information to clients other than @code{Mozilla} or
1046 Microsoft @code{Internet Explorer}. This option allows you to change
1047 the @code{User-Agent} line issued by Wget. Use of this option is
1048 discouraged, unless you really know what you are doing.
1051 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
1052 @section FTP Options
1055 @cindex .listing files, removing
1057 @itemx --dont-remove-listing
1058 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1059 retrievals. Normally, these files contain the raw directory listings
1060 received from @sc{ftp} servers. Not removing them can be useful for
1061 debugging purposes, or when you want to be able to easily check on the
1062 contents of remote server directories (e.g. to verify that a mirror
1063 you're running is complete).
1065 Note that even though Wget writes to a known filename for this file,
1066 this is not a security hole in the scenario of a user making
1067 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1068 asking @code{root} to run Wget in his or her directory. Depending on
1069 the options used, either Wget will refuse to write to @file{.listing},
1070 making the globbing/recursion/time-stamping operation fail, or the
1071 symbolic link will be deleted and replaced with the actual
1072 @file{.listing} file, or the listing will be written to a
1073 @file{.listing.@var{number}} file.
1075 Even though this situation isn't a problem, though, @code{root} should
1076 never run Wget in a non-trusted user's directory. A user could do
1077 something as simple as linking @file{index.html} to @file{/etc/passwd}
1078 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1079 will be overwritten.
1081 @cindex globbing, toggle
1083 @itemx --glob=on/off
1084 Turn @sc{ftp} globbing on or off. Globbing means you may use the
1085 shell-like special characters (@dfn{wildcards}), like @samp{*},
1086 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
1087 same directory at once, like:
1090 wget ftp://gnjilux.srk.fer.hr/*.msg
1093 By default, globbing will be turned on if the @sc{url} contains a
1094 globbing character. This option may be used to turn globbing on or off
1097 You may have to quote the @sc{url} to protect it from being expanded by
1098 your shell. Globbing makes Wget look for a directory listing, which is
1099 system-specific. This is why it currently works only with Unix @sc{ftp}
1100 servers (and the ones emulating Unix @code{ls} output).
1104 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
1105 initiates the data connection. This is sometimes required for @sc{ftp}
1106 to work behind firewalls.
1108 @cindex symbolic links, retrieving
1109 @item --retr-symlinks
1110 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1111 link is encountered, the linked-to file is not downloaded. Instead, a
1112 matching symbolic link is created on the local filesystem. The
1113 pointed-to file will not be downloaded unless this recursive retrieval
1114 would have encountered it separately and downloaded it anyway.
1116 When @samp{--retr-symlinks} is specified, however, symbolic links are
1117 traversed and the pointed-to files are retrieved. At this time, this
1118 option does not cause Wget to traverse symlinks to directories and
1119 recurse through them, but in the future it should be enhanced to do
1122 Note that when retrieving a file (not a directory) because it was
1123 specified on the commandline, rather than because it was recursed to,
1124 this option has no effect. Symbolic links are always traversed in this
1128 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
1129 @section Recursive Retrieval Options
1134 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
1137 @item -l @var{depth}
1138 @itemx --level=@var{depth}
1139 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1140 Retrieval}). The default maximum depth is 5.
1142 @cindex proxy filling
1143 @cindex delete after retrieval
1144 @cindex filling proxy cache
1145 @item --delete-after
1146 This option tells Wget to delete every single file it downloads,
1147 @emph{after} having done so. It is useful for pre-fetching popular
1148 pages through a proxy, e.g.:
1151 wget -r -nd --delete-after http://whatever.com/~popular/page/
1154 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1157 Note that @samp{--delete-after} deletes files on the local machine. It
1158 does not issue the @samp{DELE} command to remote FTP sites, for
1159 instance. Also note that when @samp{--delete-after} is specified,
1160 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1161 created in the first place.
1163 @cindex conversion of links
1164 @cindex link conversion
1166 @itemx --convert-links
1167 After the download is complete, convert the links in the document to
1168 make them suitable for local viewing. This affects not only the visible
1169 hyperlinks, but any part of the document that links to external content,
1170 such as embedded images, links to style sheets, hyperlinks to non-HTML
1173 Each link will be changed in one of the two ways:
1177 The links to files that have been downloaded by Wget will be changed to
1178 refer to the file they point to as a relative link.
1180 Example: if the downloaded file @file{/foo/doc.html} links to
1181 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1182 will be modified to point to @samp{../bar/img.gif}. This kind of
1183 transformation works reliably for arbitrary combinations of directories.
1186 The links to files that have not been downloaded by Wget will be changed
1187 to include host name and absolute path of the location they point to.
1189 Example: if the downloaded file @file{/foo/doc.html} links to
1190 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1191 @file{doc.html} will be modified to point to
1192 @file{http://@var{hostname}/bar/img.gif}.
1195 Because of this, local browsing works reliably: if a linked file was
1196 downloaded, the link will refer to its local name; if it was not
1197 downloaded, the link will refer to its full Internet address rather than
1198 presenting a broken link. The fact that the former links are converted
1199 to relative links ensures that you can move the downloaded hierarchy to
1202 Note that only at the end of the download can Wget know which links have
1203 been downloaded. Because of that, the work done by @samp{-k} will be
1204 performed at the end of all the downloads.
1206 @cindex backing up converted files
1208 @itemx --backup-converted
1209 When converting a file, back up the original version with a @samp{.orig}
1210 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1215 Turn on options suitable for mirroring. This option turns on recursion
1216 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1217 directory listings. It is currently equivalent to
1218 @samp{-r -N -l inf -nr}.
1220 @cindex page requisites
1221 @cindex required images, downloading
1223 @itemx --page-requisites
1224 This option causes Wget to download all the files that are necessary to
1225 properly display a given HTML page. This includes such things as
1226 inlined images, sounds, and referenced stylesheets.
1228 Ordinarily, when downloading a single HTML page, any requisite documents
1229 that may be needed to display it properly are not downloaded. Using
1230 @samp{-r} together with @samp{-l} can help, but since Wget does not
1231 ordinarily distinguish between external and inlined documents, one is
1232 generally left with ``leaf documents'' that are missing their
1235 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1236 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1237 document @file{2.html}. Say that @file{2.html} is similar but that its
1238 image is @file{2.gif} and it links to @file{3.html}. Say this
1239 continues up to some arbitrarily high number.
1241 If one executes the command:
1244 wget -r -l 2 http://@var{site}/1.html
1247 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1248 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1249 without its requisite @file{3.gif} because Wget is simply counting the
1250 number of hops (up to 2) away from @file{1.html} in order to determine
1251 where to stop the recursion. However, with this command:
1254 wget -r -l 2 -p http://@var{site}/1.html
1257 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1258 will be downloaded. Similarly,
1261 wget -r -l 1 -p http://@var{site}/1.html
1264 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1265 to be downloaded. One might think that:
1268 wget -r -l 0 -p http://@var{site}/1.html
1271 would download just @file{1.html} and @file{1.gif}, but unfortunately
1272 this is not the case, because @samp{-l 0} is equivalent to
1273 @samp{-l inf}---that is, infinite recursion. To download a single HTML
1274 page (or a handful of them, all specified on the commandline or in a
1275 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1276 @samp{-r} and @samp{-l}:
1279 wget -p http://@var{site}/1.html
1282 Note that Wget will behave as if @samp{-r} had been specified, but only
1283 that single page and its requisites will be downloaded. Links from that
1284 page to external documents will not be followed. Actually, to download
1285 a single page and all its requisites (even if they exist on separate
1286 websites), and make sure the lot displays properly locally, this author
1287 likes to use a few options in addition to @samp{-p}:
1290 wget -E -H -k -K -p http://@var{site}/@var{document}
1293 To finish off this topic, it's worth knowing that Wget's idea of an
1294 external document link is any URL specified in an @code{<A>} tag, an
1295 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1299 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1300 @section Recursive Accept/Reject Options
1303 @item -A @var{acclist} --accept @var{acclist}
1304 @itemx -R @var{rejlist} --reject @var{rejlist}
1305 Specify comma-separated lists of file name suffixes or patterns to
1306 accept or reject (@pxref{Types of Files} for more details).
1308 @item -D @var{domain-list}
1309 @itemx --domains=@var{domain-list}
1310 Set domains to be followed. @var{domain-list} is a comma-separated list
1311 of domains. Note that it does @emph{not} turn on @samp{-H}.
1313 @item --exclude-domains @var{domain-list}
1314 Specify the domains that are @emph{not} to be followed.
1315 (@pxref{Spanning Hosts}).
1317 @cindex follow FTP links
1319 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1320 Wget will ignore all the @sc{ftp} links.
1322 @cindex tag-based recursive pruning
1323 @item --follow-tags=@var{list}
1324 Wget has an internal table of HTML tag / attribute pairs that it
1325 considers when looking for linked documents during a recursive
1326 retrieval. If a user wants only a subset of those tags to be
1327 considered, however, he or she should be specify such tags in a
1328 comma-separated @var{list} with this option.
1331 @itemx --ignore-tags=@var{list}
1332 This is the opposite of the @samp{--follow-tags} option. To skip
1333 certain HTML tags when recursively looking for documents to download,
1334 specify them in a comma-separated @var{list}.
1336 In the past, the @samp{-G} option was the best bet for downloading a
1337 single page and its requisites, using a commandline like:
1340 wget -Ga,area -H -k -K -r http://@var{site}/@var{document}
1343 However, the author of this option came across a page with tags like
1344 @code{<LINK REL="home" HREF="/">} and came to the realization that
1345 @samp{-G} was not enough. One can't just tell Wget to ignore
1346 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1347 best bet for downloading a single page and its requisites is the
1348 dedicated @samp{--page-requisites} option.
1352 Enable spanning across hosts when doing recursive retrieving
1353 (@pxref{Spanning Hosts}).
1357 Follow relative links only. Useful for retrieving a specific home page
1358 without any distractions, not even those from the same hosts
1359 (@pxref{Relative Links}).
1362 @itemx --include-directories=@var{list}
1363 Specify a comma-separated list of directories you wish to follow when
1364 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1365 of @var{list} may contain wildcards.
1368 @itemx --exclude-directories=@var{list}
1369 Specify a comma-separated list of directories you wish to exclude from
1370 download (@pxref{Directory-Based Limits} for more details.) Elements of
1371 @var{list} may contain wildcards.
1375 Do not ever ascend to the parent directory when retrieving recursively.
1376 This is a useful option, since it guarantees that only the files
1377 @emph{below} a certain hierarchy will be downloaded.
1378 @xref{Directory-Based Limits}, for more details.
1383 @node Recursive Retrieval, Following Links, Invoking, Top
1384 @chapter Recursive Retrieval
1387 @cindex recursive retrieval
1389 GNU Wget is capable of traversing parts of the Web (or a single
1390 @sc{http} or @sc{ftp} server), following links and directory structure.
1391 We refer to this as to @dfn{recursive retrieving}, or @dfn{recursion}.
1393 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1394 the given @sc{url}, documents, retrieving the files the @sc{html}
1395 document was referring to, through markups like @code{href}, or
1396 @code{src}. If the freshly downloaded file is also of type
1397 @code{text/html}, it will be parsed and followed further.
1399 Recursive retrieval of @sc{http} and @sc{html} content is
1400 @dfn{breadth-first}. This means that Wget first downloads the requested
1401 HTML document, then the documents linked from that document, then the
1402 documents linked by them, and so on. In other words, Wget first
1403 downloads the documents at depth 1, then those at depth 2, and so on
1404 until the specified maximum depth.
1406 The maximum @dfn{depth} to which the retrieval may descend is specified
1407 with the @samp{-l} option. The default maximum depth is five layers.
1409 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1410 the data from the given directory tree (including the subdirectories up
1411 to the specified depth) on the remote server, creating its mirror image
1412 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1413 parameter. Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1416 By default, Wget will create a local directory tree, corresponding to
1417 the one found on the remote server.
1419 Recursive retrieving can find a number of applications, the most
1420 important of which is mirroring. It is also useful for @sc{www}
1421 presentations, and any other opportunities where slow network
1422 connections should be bypassed by storing the files locally.
1424 You should be warned that recursive downloads can overload the remote
1425 servers. Because of that, many administrators frown upon them and may
1426 ban access from your site if they detect very fast downloads of big
1427 amounts of content. When downloading from Internet servers, consider
1428 using the @samp{-w} option to introduce a delay between accesses to the
1429 server. The download will take a while longer, but the server
1430 administrator will not be alarmed by your rudeness.
1432 Of course, recursive download may cause problems on your machine. If
1433 left to run unchecked, it can easily fill up the disk. If downloading
1434 from local network, it can also take bandwidth on the system, as well as
1435 consume memory and CPU.
1437 Try to specify the criteria that match the kind of download you are
1438 trying to achieve. If you want to download only one page, use
1439 @samp{--page-requisites} without any additional recursion. If you want
1440 to download things under one directory, use @samp{-np} to avoid
1441 downloading things from other directories. If you want to download all
1442 the files from one directory, use @samp{-l 1} to make sure the recursion
1443 depth never exceeds one. @xref{Following Links}, for more information
1446 Recursive retrieval should be used with care. Don't say you were not
1449 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1450 @chapter Following Links
1452 @cindex following links
1454 When retrieving recursively, one does not wish to retrieve loads of
1455 unnecessary data. Most of the time the users bear in mind exactly what
1456 they want to download, and want Wget to follow only specific links.
1458 For example, if you wish to download the music archive from
1459 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1460 that happen to be referenced by an obscure part of the archive.
1462 Wget possesses several mechanisms that allows you to fine-tune which
1463 links it will follow.
1466 * Spanning Hosts:: (Un)limiting retrieval based on host name.
1467 * Types of Files:: Getting only certain files.
1468 * Directory-Based Limits:: Getting only certain directories.
1469 * Relative Links:: Follow relative links only.
1470 * FTP Links:: Following FTP links.
1473 @node Spanning Hosts, Types of Files, Following Links, Following Links
1474 @section Spanning Hosts
1475 @cindex spanning hosts
1476 @cindex hosts, spanning
1478 Wget's recursive retrieval normally refuses to visit hosts different
1479 than the one you specified on the command line. This is a reasonable
1480 default; without it, every retrieval would have the potential to turn
1481 your Wget into a small version of google.
1483 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1484 a useful option. Maybe the images are served from a different server.
1485 Maybe you're mirroring a site that consists of pages interlinked between
1486 three servers. Maybe the server has two equivalent names, and the HTML
1487 pages refer to both interchangeably.
1490 @item Span to any host---@samp{-H}
1492 The @samp{-H} option turns on host spanning, thus allowing Wget's
1493 recursive run to visit any host referenced by a link. Unless sufficient
1494 recursion-limiting criteria are applied depth, these foreign hosts will
1495 typically link to yet more hosts, and so on until Wget ends up sucking
1496 up much more data than you have intended.
1498 @item Limit spanning to certain domains---@samp{-D}
1500 The @samp{-D} option allows you to specify the domains that will be
1501 followed, thus limiting the recursion only to the hosts that belong to
1502 these domains. Obviously, this makes sense only in conjunction with
1503 @samp{-H}. A typical example would be downloading the contents of
1504 @samp{www.server.com}, but allowing downloads from
1505 @samp{images.server.com}, etc.:
1508 wget -rH -Dserver.com http://www.server.com/
1511 You can specify more than one address by separating them with a comma,
1512 e.g. @samp{-Ddomain1.com,domain2.com}.
1514 @item Keep download off certain domains---@samp{--exclude-domains}
1516 If there are domains you want to exclude specifically, you can do it
1517 with @samp{--exclude-domains}, which accepts the same type of arguments
1518 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1519 example, if you want to download all the hosts from @samp{foo.edu}
1520 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1524 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
1530 @node Types of Files, Directory-Based Limits, Spanning Hosts, Following Links
1531 @section Types of Files
1532 @cindex types of files
1534 When downloading material from the web, you will often want to restrict
1535 the retrieval to only certain file types. For example, if you are
1536 interested in downloading @sc{gif}s, you will not be overjoyed to get
1537 loads of PostScript documents, and vice versa.
1539 Wget offers two options to deal with this problem. Each option
1540 description lists a short name, a long name, and the equivalent command
1543 @cindex accept wildcards
1544 @cindex accept suffixes
1545 @cindex wildcards, accept
1546 @cindex suffixes, accept
1548 @item -A @var{acclist}
1549 @itemx --accept @var{acclist}
1550 @itemx accept = @var{acclist}
1551 The argument to @samp{--accept} option is a list of file suffixes or
1552 patterns that Wget will download during recursive retrieval. A suffix
1553 is the ending part of a file, and consists of ``normal'' letters,
1554 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1555 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1557 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1558 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1559 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1560 download only files beginning with @samp{zelazny} and containing numbers
1561 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1562 a description of how pattern matching works.
1564 Of course, any number of suffixes and patterns can be combined into a
1565 comma-separated list, and given as an argument to @samp{-A}.
1567 @cindex reject wildcards
1568 @cindex reject suffixes
1569 @cindex wildcards, reject
1570 @cindex suffixes, reject
1571 @item -R @var{rejlist}
1572 @itemx --reject @var{rejlist}
1573 @itemx reject = @var{rejlist}
1574 The @samp{--reject} option works the same way as @samp{--accept}, only
1575 its logic is the reverse; Wget will download all files @emph{except} the
1576 ones matching the suffixes (or patterns) in the list.
1578 So, if you want to download a whole page except for the cumbersome
1579 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1580 Analogously, to download all files except the ones beginning with
1581 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1582 expansion by the shell.
1585 The @samp{-A} and @samp{-R} options may be combined to achieve even
1586 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1587 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1588 a part of their name, but @emph{not} the PostScript files.
1590 Note that these two options do not affect the downloading of @sc{html}
1591 files; Wget must load all the @sc{html}s to know where to go at
1592 all---recursive retrieval would make no sense otherwise.
1594 @node Directory-Based Limits, Relative Links, Types of Files, Following Links
1595 @section Directory-Based Limits
1597 @cindex directory limits
1599 Regardless of other link-following facilities, it is often useful to
1600 place the restriction of what files to retrieve based on the directories
1601 those files are placed in. There can be many reasons for this---the
1602 home pages may be organized in a reasonable directory structure; or some
1603 directories may contain useless information, e.g. @file{/cgi-bin} or
1604 @file{/dev} directories.
1606 Wget offers three different options to deal with this requirement. Each
1607 option description lists a short name, a long name, and the equivalent
1608 command in @file{.wgetrc}.
1610 @cindex directories, include
1611 @cindex include directories
1612 @cindex accept directories
1615 @itemx --include @var{list}
1616 @itemx include_directories = @var{list}
1617 @samp{-I} option accepts a comma-separated list of directories included
1618 in the retrieval. Any other directories will simply be ignored. The
1619 directories are absolute paths.
1621 So, if you wish to download from @samp{http://host/people/bozo/}
1622 following only links to bozo's colleagues in the @file{/people}
1623 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1626 wget -I /people,/cgi-bin http://host/people/bozo/
1629 @cindex directories, exclude
1630 @cindex exclude directories
1631 @cindex reject directories
1633 @itemx --exclude @var{list}
1634 @itemx exclude_directories = @var{list}
1635 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1636 directories @emph{excluded} from the download. E.g. if you do not want
1637 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1638 /cgi-bin} on the command line.
1640 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1641 to get a better fine-tuning of downloading subdirectories. E.g. if you
1642 want to load all the files from @file{/pub} hierarchy except for
1643 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1648 @itemx no_parent = on
1649 The simplest, and often very useful way of limiting directories is
1650 disallowing retrieval of the links that refer to the hierarchy
1651 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1652 parent directory/directories.
1654 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1655 Using it guarantees that you will never leave the existing hierarchy.
1656 Supposing you issue Wget with:
1659 wget -r --no-parent http://somehost/~luzer/my-archive/
1662 You may rest assured that none of the references to
1663 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1664 followed. Only the archive you are interested in will be downloaded.
1665 Essentially, @samp{--no-parent} is similar to
1666 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1667 intelligent fashion.
1670 @node Relative Links, FTP Links, Directory-Based Limits, Following Links
1671 @section Relative Links
1672 @cindex relative links
1674 When @samp{-L} is turned on, only the relative links are ever followed.
1675 Relative links are here defined those that do not refer to the web
1676 server root. For example, these links are relative:
1680 <a href="foo/bar.gif">
1681 <a href="../foo/bar.gif">
1684 These links are not relative:
1688 <a href="/foo/bar.gif">
1689 <a href="http://www.server.com/foo/bar.gif">
1692 Using this option guarantees that recursive retrieval will not span
1693 hosts, even without @samp{-H}. In simple cases it also allows downloads
1694 to ``just work'' without having to convert links.
1696 This option is probably not very useful and might be removed in a future
1699 @node FTP Links, , Relative Links, Following Links
1700 @section Following FTP Links
1701 @cindex following ftp links
1703 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1704 them to be. @sc{ftp} links in @sc{html} documents are often included
1705 for purposes of reference, and it is often inconvenient to download them
1708 To have @sc{ftp} links followed from @sc{html} documents, you need to
1709 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1710 links will span hosts regardless of @samp{-H} setting. This is logical,
1711 as @sc{ftp} links rarely point to the same host where the @sc{http}
1712 server resides. For similar reasons, the @samp{-L} options has no
1713 effect on such downloads. On the other hand, domain acceptance
1714 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1716 Also note that followed links to @sc{ftp} directories will not be
1717 retrieved recursively further.
1719 @node Time-Stamping, Startup File, Following Links, Top
1720 @chapter Time-Stamping
1721 @cindex time-stamping
1722 @cindex timestamping
1723 @cindex updating the archives
1724 @cindex incremental updating
1726 One of the most important aspects of mirroring information from the
1727 Internet is updating your archives.
1729 Downloading the whole archive again and again, just to replace a few
1730 changed files is expensive, both in terms of wasted bandwidth and money,
1731 and the time to do the update. This is why all the mirroring tools
1732 offer the option of incremental updating.
1734 Such an updating mechanism means that the remote server is scanned in
1735 search of @dfn{new} files. Only those new files will be downloaded in
1736 the place of the old ones.
1738 A file is considered new if one of these two conditions are met:
1742 A file of that name does not already exist locally.
1745 A file of that name does exist, but the remote file was modified more
1746 recently than the local file.
1749 To implement this, the program needs to be aware of the time of last
1750 modification of both local and remote files. We call this information the
1751 @dfn{time-stamp} of a file.
1753 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1754 (@samp{-N}) option, or through @code{timestamping = on} directive in
1755 @file{.wgetrc}. With this option, for each file it intends to download,
1756 Wget will check whether a local file of the same name exists. If it
1757 does, and the remote file is older, Wget will not download it.
1759 If the local file does not exist, or the sizes of the files do not
1760 match, Wget will download the remote file no matter what the time-stamps
1764 * Time-Stamping Usage::
1765 * HTTP Time-Stamping Internals::
1766 * FTP Time-Stamping Internals::
1769 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1770 @section Time-Stamping Usage
1771 @cindex time-stamping usage
1772 @cindex usage, time-stamping
1774 The usage of time-stamping is simple. Say you would like to download a
1775 file so that it keeps its date of modification.
1778 wget -S http://www.gnu.ai.mit.edu/
1781 A simple @code{ls -l} shows that the time stamp on the local file equals
1782 the state of the @code{Last-Modified} header, as returned by the server.
1783 As you can see, the time-stamping info is preserved locally, even
1784 without @samp{-N} (at least for @sc{http}).
1786 Several days later, you would like Wget to check if the remote file has
1787 changed, and download it if it has.
1790 wget -N http://www.gnu.ai.mit.edu/
1793 Wget will ask the server for the last-modified date. If the local file
1794 has the same timestamp as the server, or a newer one, the remote file
1795 will not be re-fetched. However, if the remote file is more recent,
1796 Wget will proceed to fetch it.
1798 The same goes for @sc{ftp}. For example:
1801 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
1804 (The quotes around that URL are to prevent the shell from trying to
1805 interpret the @samp{*}.)
1807 After download, a local directory listing will show that the timestamps
1808 match those on the remote server. Reissuing the command with @samp{-N}
1809 will make Wget re-fetch @emph{only} the files that have been modified
1810 since the last download.
1812 If you wished to mirror the GNU archive every week, you would use a
1813 command like the following, weekly:
1816 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
1819 Note that time-stamping will only work for files for which the server
1820 gives a timestamp. For @sc{http}, this depends on getting a
1821 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
1822 directory listing with dates in a format that Wget can parse
1823 (@pxref{FTP Time-Stamping Internals}).
1825 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1826 @section HTTP Time-Stamping Internals
1827 @cindex http time-stamping
1829 Time-stamping in @sc{http} is implemented by checking of the
1830 @code{Last-Modified} header. If you wish to retrieve the file
1831 @file{foo.html} through @sc{http}, Wget will check whether
1832 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1833 retrieved unconditionally.
1835 If the file does exist locally, Wget will first check its local
1836 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1837 @code{HEAD} request to the remote server, demanding the information on
1840 The @code{Last-Modified} header is examined to find which file was
1841 modified more recently (which makes it ``newer''). If the remote file
1842 is newer, it will be downloaded; if it is older, Wget will give
1843 up.@footnote{As an additional check, Wget will look at the
1844 @code{Content-Length} header, and compare the sizes; if they are not the
1845 same, the remote file will be downloaded no matter what the time-stamp
1848 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1849 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1850 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1851 @samp{@var{X}}, which will always differ if it's been converted by
1852 @samp{--convert-links} (@samp{-k}).
1854 Arguably, @sc{http} time-stamping should be implemented using the
1855 @code{If-Modified-Since} request.
1857 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1858 @section FTP Time-Stamping Internals
1859 @cindex ftp time-stamping
1861 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1862 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
1865 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
1866 @sc{ftp} @code{LIST} command to get a file listing for the directory
1867 containing the desired file(s). It will try to analyze the listing,
1868 treating it like Unix @code{ls -l} output, extracting the time-stamps.
1869 The rest is exactly the same as for @sc{http}. Note that when
1870 retrieving individual files from an @sc{ftp} server without using
1871 globbing or recursion, listing files will not be downloaded (and thus
1872 files will not be time-stamped) unless @samp{-N} is specified.
1874 Assumption that every directory listing is a Unix-style listing may
1875 sound extremely constraining, but in practice it is not, as many
1876 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1877 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1878 defines no standard way to get a file list, let alone the time-stamps.
1879 We can only hope that a future standard will define this.
1881 Another non-standard solution includes the use of @code{MDTM} command
1882 that is supported by some @sc{ftp} servers (including the popular
1883 @code{wu-ftpd}), which returns the exact time of the specified file.
1884 Wget may support this command in the future.
1886 @node Startup File, Examples, Time-Stamping, Top
1887 @chapter Startup File
1888 @cindex startup file
1894 Once you know how to change default settings of Wget through command
1895 line arguments, you may wish to make some of those settings permanent.
1896 You can do that in a convenient way by creating the Wget startup
1897 file---@file{.wgetrc}.
1899 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1900 convenient to have a special facility for storing passwords. Thus Wget
1901 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1902 it. You can find @file{.netrc} format in your system manuals.
1904 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1908 * Wgetrc Location:: Location of various wgetrc files.
1909 * Wgetrc Syntax:: Syntax of wgetrc.
1910 * Wgetrc Commands:: List of available commands.
1911 * Sample Wgetrc:: A wgetrc example.
1914 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1915 @section Wgetrc Location
1916 @cindex wgetrc location
1917 @cindex location of wgetrc
1919 When initializing, Wget will look for a @dfn{global} startup file,
1920 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1921 @file{/usr/local}, if Wget was not installed there) and read commands
1922 from there, if it exists.
1924 Then it will look for the user's file. If the environmental variable
1925 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1926 further attempts will be made.
1928 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1930 The fact that user's settings are loaded after the system-wide ones
1931 means that in case of collision user's wgetrc @emph{overrides} the
1932 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1933 Fascist admins, away!
1935 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1936 @section Wgetrc Syntax
1937 @cindex wgetrc syntax
1938 @cindex syntax of wgetrc
1940 The syntax of a wgetrc command is simple:
1946 The @dfn{variable} will also be called @dfn{command}. Valid
1947 @dfn{values} are different for different commands.
1949 The commands are case-insensitive and underscore-insensitive. Thus
1950 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1951 beginning with @samp{#} and lines containing white-space only are
1954 Commands that expect a comma-separated list will clear the list on an
1955 empty command. So, if you wish to reset the rejection list specified in
1956 global @file{wgetrc}, you can do it with:
1962 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1963 @section Wgetrc Commands
1964 @cindex wgetrc commands
1966 The complete set of commands is listed below. Legal values are listed
1967 after the @samp{=}. Simple Boolean values can be set or unset using
1968 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
1969 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
1970 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
1971 option is set to @samp{always} or @samp{never}, that value will be
1972 locked in for the duration of the Wget invocation---commandline options
1975 Some commands take pseudo-arbitrary values. @var{address} values can be
1976 hostnames or dotted-quad IP addresses. @var{n} can be any positive
1977 integer, or @samp{inf} for infinity, where appropriate. @var{string}
1978 values can be any non-empty string.
1980 Most of these commands have commandline equivalents (@pxref{Invoking}),
1981 though some of the more obscure or rarely used ones do not.
1984 @item accept/reject = @var{string}
1985 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
1987 @item add_hostdir = on/off
1988 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1990 @item continue = on/off
1991 If set to on, force continuation of preexistent partially retrieved
1992 files. See @samp{-c} before setting it.
1994 @item background = on/off
1995 Enable/disable going to background---the same as @samp{-b} (which
1998 @item backup_converted = on/off
1999 Enable/disable saving pre-converted files with the suffix
2000 @samp{.orig}---the same as @samp{-K} (which enables it).
2002 @c @item backups = @var{number}
2003 @c #### Document me!
2005 @item base = @var{string}
2006 Consider relative @sc{url}s in @sc{url} input files forced to be
2007 interpreted as @sc{html} as being relative to @var{string}---the same as
2010 @item bind_address = @var{address}
2011 Bind to @var{address}, like the @samp{--bind-address} option.
2013 @item cache = on/off
2014 When set to off, disallow server-caching. See the @samp{-C} option.
2016 @item convert links = on/off
2017 Convert non-relative links locally. The same as @samp{-k}.
2019 @item cookies = on/off
2020 When set to off, disallow cookies. See the @samp{--cookies} option.
2022 @item load_cookies = @var{file}
2023 Load cookies from @var{file}. See @samp{--load-cookies}.
2025 @item save_cookies = @var{file}
2026 Save cookies to @var{file}. See @samp{--save-cookies}.
2028 @item cut_dirs = @var{n}
2029 Ignore @var{n} remote directory components.
2031 @item debug = on/off
2032 Debug mode, same as @samp{-d}.
2034 @item delete_after = on/off
2035 Delete after download---the same as @samp{--delete-after}.
2037 @item dir_prefix = @var{string}
2038 Top of directory tree---the same as @samp{-P}.
2040 @item dirstruct = on/off
2041 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2044 @item domains = @var{string}
2045 Same as @samp{-D} (@pxref{Spanning Hosts}).
2047 @item dot_bytes = @var{n}
2048 Specify the number of bytes ``contained'' in a dot, as seen throughout
2049 the retrieval (1024 by default). You can postfix the value with
2050 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2051 respectively. With dot settings you can tailor the dot retrieval to
2052 suit your needs, or you can use the predefined @dfn{styles}
2053 (@pxref{Download Options}).
2055 @item dots_in_line = @var{n}
2056 Specify the number of dots that will be printed in each line throughout
2057 the retrieval (50 by default).
2059 @item dot_spacing = @var{n}
2060 Specify the number of dots in a single cluster (10 by default).
2062 @item exclude_directories = @var{string}
2063 Specify a comma-separated list of directories you wish to exclude from
2064 download---the same as @samp{-X} (@pxref{Directory-Based Limits}).
2066 @item exclude_domains = @var{string}
2067 Same as @samp{--exclude-domains} (@pxref{Spanning Hosts}).
2069 @item follow_ftp = on/off
2070 Follow @sc{ftp} links from @sc{html} documents---the same as
2071 @samp{--follow-ftp}.
2073 @item follow_tags = @var{string}
2074 Only follow certain HTML tags when doing a recursive retrieval, just like
2075 @samp{--follow-tags}.
2077 @item force_html = on/off
2078 If set to on, force the input filename to be regarded as an @sc{html}
2079 document---the same as @samp{-F}.
2081 @item ftp_proxy = @var{string}
2082 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2086 Turn globbing on/off---the same as @samp{-g}.
2088 @item header = @var{string}
2089 Define an additional header, like @samp{--header}.
2091 @item html_extension = on/off
2092 Add a @samp{.html} extension to @samp{text/html} files without it, like
2095 @item http_passwd = @var{string}
2096 Set @sc{http} password.
2098 @item http_proxy = @var{string}
2099 Use @var{string} as @sc{http} proxy, instead of the one specified in
2102 @item http_user = @var{string}
2103 Set @sc{http} user to @var{string}.
2105 @item ignore_length = on/off
2106 When set to on, ignore @code{Content-Length} header; the same as
2107 @samp{--ignore-length}.
2109 @item ignore_tags = @var{string}
2110 Ignore certain HTML tags when doing a recursive retrieval, just like
2111 @samp{-G} / @samp{--ignore-tags}.
2113 @item include_directories = @var{string}
2114 Specify a comma-separated list of directories you wish to follow when
2115 downloading---the same as @samp{-I}.
2117 @item input = @var{string}
2118 Read the @sc{url}s from @var{string}, like @samp{-i}.
2120 @item kill_longer = on/off
2121 Consider data longer than specified in content-length header as invalid
2122 (and retry getting it). The default behaviour is to save as much data
2123 as there is, provided there is more than or equal to the value in
2124 @code{Content-Length}.
2126 @item limit_rate = @var{rate}
2127 Limit the download speed to no more than @var{rate} bytes per second.
2128 The same as @samp{--limit-rate}.
2130 @item logfile = @var{string}
2131 Set logfile---the same as @samp{-o}.
2133 @item login = @var{string}
2134 Your user name on the remote machine, for @sc{ftp}. Defaults to
2137 @item mirror = on/off
2138 Turn mirroring on/off. The same as @samp{-m}.
2140 @item netrc = on/off
2141 Turn reading netrc on or off.
2143 @item noclobber = on/off
2146 @item no_parent = on/off
2147 Disallow retrieving outside the directory hierarchy, like
2148 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2150 @item no_proxy = @var{string}
2151 Use @var{string} as the comma-separated list of domains to avoid in
2152 proxy loading, instead of the one specified in environment.
2154 @item output_document = @var{string}
2155 Set the output filename---the same as @samp{-O}.
2157 @item page_requisites = on/off
2158 Download all ancillary documents necessary for a single HTML page to
2159 display properly---the same as @samp{-p}.
2161 @item passive_ftp = on/off/always/never
2162 Set passive @sc{ftp}---the same as @samp{--passive-ftp}. Some scripts
2163 and @samp{.pm} (Perl module) files download files using @samp{wget
2164 --passive-ftp}. If your firewall does not allow this, you can set
2165 @samp{passive_ftp = never} to override the commandline.
2167 @item passwd = @var{string}
2168 Set your @sc{ftp} password to @var{password}. Without this setting, the
2169 password defaults to @samp{username@@hostname.domainname}.
2171 @item progress = @var{string}
2172 Set the type of the progress indicator. Legal types are ``dot'' and
2175 @item proxy_user = @var{string}
2176 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
2178 @item proxy_passwd = @var{string}
2179 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
2181 @item referer = @var{string}
2182 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
2183 was the folks who wrote the @sc{http} spec who got the spelling of
2184 ``referrer'' wrong.)
2186 @item quiet = on/off
2187 Quiet mode---the same as @samp{-q}.
2189 @item quota = @var{quota}
2190 Specify the download quota, which is useful to put in the global
2191 @file{wgetrc}. When download quota is specified, Wget will stop
2192 retrieving after the download sum has become greater than quota. The
2193 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2194 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2195 to 5 mbytes. Note that the user's startup file overrides system
2198 @item reclevel = @var{n}
2199 Recursion level---the same as @samp{-l}.
2201 @item recursive = on/off
2202 Recursive on/off---the same as @samp{-r}.
2204 @item relative_only = on/off
2205 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2208 @item remove_listing = on/off
2209 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2210 to off is the same as @samp{-nr}.
2212 @item retr_symlinks = on/off
2213 When set to on, retrieve symbolic links as if they were plain files; the
2214 same as @samp{--retr-symlinks}.
2216 @item robots = on/off
2217 Use (or not) @file{/robots.txt} file (@pxref{Robots}). Be sure to know
2218 what you are doing before changing the default (which is @samp{on}).
2220 @item server_response = on/off
2221 Choose whether or not to print the @sc{http} and @sc{ftp} server
2222 responses---the same as @samp{-S}.
2224 @item span_hosts = on/off
2227 @item timeout = @var{n}
2228 Set timeout value---the same as @samp{-T}.
2230 @item timestamping = on/off
2231 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2233 @item tries = @var{n}
2234 Set number of retries per @sc{url}---the same as @samp{-t}.
2236 @item use_proxy = on/off
2237 Turn proxy support on/off. The same as @samp{-Y}.
2239 @item verbose = on/off
2240 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2242 @item wait = @var{n}
2243 Wait @var{n} seconds between retrievals---the same as @samp{-w}.
2245 @item waitretry = @var{n}
2246 Wait up to @var{n} seconds between retries of failed retrievals
2247 only---the same as @samp{--waitretry}. Note that this is turned on by
2248 default in the global @file{wgetrc}.
2250 @item randomwait = on/off
2251 Turn random between-request wait times on or off. The same as
2252 @samp{--random-wait}.
2255 @node Sample Wgetrc, , Wgetrc Commands, Startup File
2256 @section Sample Wgetrc
2257 @cindex sample wgetrc
2259 This is the sample initialization file, as given in the distribution.
2260 It is divided in two section---one for global usage (suitable for global
2261 startup file), and one for local usage (suitable for
2262 @file{$HOME/.wgetrc}). Be careful about the things you change.
2264 Note that almost all the lines are commented out. For a command to have
2265 any effect, you must remove the @samp{#} character at the beginning of
2269 @include sample.wgetrc.munged_for_texi_inclusion
2272 @node Examples, Various, Startup File, Top
2276 @c man begin EXAMPLES
2277 The examples are divided into three sections loosely based on their
2281 * Simple Usage:: Simple, basic usage of the program.
2282 * Advanced Usage:: Advanced tips.
2283 * Very Advanced Usage:: The hairy stuff.
2286 @node Simple Usage, Advanced Usage, Examples, Examples
2287 @section Simple Usage
2291 Say you want to download a @sc{url}. Just type:
2294 wget http://fly.srk.fer.hr/
2298 But what will happen if the connection is slow, and the file is lengthy?
2299 The connection will probably fail before the whole file is retrieved,
2300 more than once. In this case, Wget will try getting the file until it
2301 either gets the whole of it, or exceeds the default number of retries
2302 (this being 20). It is easy to change the number of tries to 45, to
2303 insure that the whole file will arrive safely:
2306 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2310 Now let's leave Wget to work in the background, and write its progress
2311 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2312 shall use @samp{-t}.
2315 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2318 The ampersand at the end of the line makes sure that Wget works in the
2319 background. To unlimit the number of retries, use @samp{-t inf}.
2322 The usage of @sc{ftp} is as simple. Wget will take care of login and
2326 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2330 If you specify a directory, Wget will retrieve the directory listing,
2331 parse it and convert it to @sc{html}. Try:
2334 wget ftp://prep.ai.mit.edu/pub/gnu/
2339 @node Advanced Usage, Very Advanced Usage, Simple Usage, Examples
2340 @section Advanced Usage
2344 You have a file that contains the URLs you want to download? Use the
2351 If you specify @samp{-} as file name, the @sc{url}s will be read from
2355 Create a five levels deep mirror image of the GNU web site, with the
2356 same directory structure the original has, with only one try per
2357 document, saving the log of the activities to @file{gnulog}:
2360 wget -r http://www.gnu.org/ -o gnulog
2364 The same as the above, but convert the links in the @sc{html} files to
2365 point to local files, so you can view the documents off-line:
2368 wget --convert-links -r http://www.gnu.org/ -o gnulog
2372 Retrieve only one HTML page, but make sure that all the elements needed
2373 for the page to be displayed, such as inline images and external style
2374 sheets, are also downloaded. Also make sure the downloaded page
2375 references the downloaded links.
2378 wget -p --convert-links http://www.server.com/dir/page.html
2381 The HTML page will be saved to @file{www.server.com/dir/page.html}, and
2382 the images, stylesheets, etc., somewhere under @file{www.server.com/},
2383 depending on where they were on the remote server.
2386 The same as the above, but without the @file{www.server.com/} directory.
2387 In fact, I don't want to have all those random server directories
2388 anyway---just save @emph{all} those files under a @file{download/}
2389 subdirectory of the current directory.
2392 wget -p --convert-links -nH -nd -Pdownload \
2393 http://www.server.com/dir/page.html
2397 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2401 wget -S http://www.lycos.com/
2405 Save the server headers with the file, perhaps for post-processing.
2408 wget -s http://www.lycos.com/
2413 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2417 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
2421 You want to download all the @sc{gif}s from a directory on an @sc{http}
2422 server. You tried @samp{wget http://www.server.com/dir/*.gif}, but that
2423 didn't work because @sc{http} retrieval does not support globbing. In
2427 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
2430 More verbose, but the effect is the same. @samp{-r -l1} means to
2431 retrieve recursively (@pxref{Recursive Retrieval}), with maximum depth
2432 of 1. @samp{--no-parent} means that references to the parent directory
2433 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2434 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2438 Suppose you were in the middle of downloading, when Wget was
2439 interrupted. Now you do not want to clobber the files already present.
2443 wget -nc -r http://www.gnu.org/
2447 If you want to encode your own username and password to @sc{http} or
2448 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2451 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
2454 Note, however, that this usage is not advisable on multi-user systems
2455 because it reveals your password to anyone who looks at the output of
2458 @cindex redirecting output
2460 You would like the output documents to go to standard output instead of
2464 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2467 You can also combine the two options and make pipelines to retrieve the
2468 documents from remote hotlists:
2471 wget -O - http://cool.list.com/ | wget --force-html -i -
2475 @node Very Advanced Usage, , Advanced Usage, Examples
2476 @section Very Advanced Usage
2481 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2482 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2483 for @samp{-r -l inf -N}. You can put Wget in the crontab file asking it
2484 to recheck a site each Sunday:
2488 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
2492 In addition to the above, you want the links to be converted for local
2493 viewing. But, after having read this manual, you know that link
2494 conversion doesn't play well with timestamping, so you also want Wget to
2495 back up the original HTML files before the conversion. Wget invocation
2496 would look like this:
2499 wget --mirror --convert-links --backup-converted \
2500 http://www.gnu.org/ -o /home/me/weeklog
2504 But you've also noticed that local viewing doesn't work all that well
2505 when HTML files are saved under extensions other than @samp{.html},
2506 perhaps because they were served as @file{index.cgi}. So you'd like
2507 Wget to rename all the files served with content-type @samp{text/html}
2508 to @file{@var{name}.html}.
2511 wget --mirror --convert-links --backup-converted \
2512 --html-extension -o /home/me/weeklog \
2516 Or, with less typing:
2519 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
2524 @node Various, Appendices, Examples, Top
2528 This chapter contains all the stuff that could not fit anywhere else.
2531 * Proxies:: Support for proxy servers
2532 * Distribution:: Getting the latest version.
2533 * Mailing List:: Wget mailing list for announcements and discussion.
2534 * Reporting Bugs:: How and where to report bugs.
2535 * Portability:: The systems Wget works on.
2536 * Signals:: Signal-handling performed by Wget.
2539 @node Proxies, Distribution, Various, Various
2543 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2544 data from remote servers to local clients. One typical use of proxies
2545 is lightening network load for users behind a slow connection. This is
2546 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2547 proxy which caches the transferred data. When a cached resource is
2548 requested again, proxy will return the data from cache. Another use for
2549 proxies is for companies that separate (for security reasons) their
2550 internal networks from the rest of Internet. In order to obtain
2551 information from the Web, their users connect and retrieve remote data
2552 using an authorized proxy.
2554 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2555 standard way to specify proxy location, which Wget recognizes, is using
2556 the following environment variables:
2560 This variable should contain the @sc{url} of the proxy for @sc{http}
2564 This variable should contain the @sc{url} of the proxy for @sc{ftp}
2565 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2566 are set to the same @sc{url}.
2569 This variable should contain a comma-separated list of domain extensions
2570 proxy should @emph{not} be used for. For instance, if the value of
2571 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2575 In addition to the environment variables, proxy location and settings
2576 may be specified from within Wget itself.
2580 @itemx --proxy=on/off
2581 @itemx proxy = on/off
2582 This option may be used to turn the proxy support on or off. Proxy
2583 support is on by default, provided that the appropriate environment
2586 @item http_proxy = @var{URL}
2587 @itemx ftp_proxy = @var{URL}
2588 @itemx no_proxy = @var{string}
2589 These startup file variables allow you to override the proxy settings
2590 specified by the environment.
2593 Some proxy servers require authorization to enable you to use them. The
2594 authorization consists of @dfn{username} and @dfn{password}, which must
2595 be sent by Wget. As with @sc{http} authorization, several
2596 authentication schemes exist. For proxy authorization only the
2597 @code{Basic} authentication scheme is currently implemented.
2599 You may specify your username and password either through the proxy
2600 @sc{url} or through the command-line options. Assuming that the
2601 company's proxy is located at @samp{proxy.company.com} at port 8001, a
2602 proxy @sc{url} location containing authorization data might look like
2606 http://hniksic:mypassword@@proxy.company.com:8001/
2609 Alternatively, you may use the @samp{proxy-user} and
2610 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2611 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2612 username and password.
2614 @node Distribution, Mailing List, Proxies, Various
2615 @section Distribution
2616 @cindex latest version
2618 Like all GNU utilities, the latest version of Wget can be found at the
2619 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2620 Wget @value{VERSION} can be found at
2621 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2623 @node Mailing List, Reporting Bugs, Distribution, Various
2624 @section Mailing List
2625 @cindex mailing list
2628 Wget has its own mailing list at @email{wget@@sunsite.dk}, thanks
2629 to Karsten Thygesen. The mailing list is for discussion of Wget
2630 features and web, reporting Wget bugs (those that you think may be of
2631 interest to the public) and mailing announcements. You are welcome to
2632 subscribe. The more people on the list, the better!
2634 To subscribe, send mail to @email{wget-subscribe@@sunsite.dk}.
2635 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2636 mailing to @email{wget-unsubscribe@@sunsite.dk}.
2638 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2639 Alternative archive is available at
2640 @url{http://www.mail-archive.com/wget%40sunsite.auc.dk/}.
2642 @node Reporting Bugs, Portability, Mailing List, Various
2643 @section Reporting Bugs
2645 @cindex reporting bugs
2649 You are welcome to send bug reports about GNU Wget to
2650 @email{bug-wget@@gnu.org}.
2652 Before actually submitting a bug report, please try to follow a few
2657 Please try to ascertain that the behaviour you see really is a bug. If
2658 Wget crashes, it's a bug. If Wget does not behave as documented,
2659 it's a bug. If things work strange, but you are not sure about the way
2660 they are supposed to work, it might well be a bug.
2663 Try to repeat the bug in as simple circumstances as possible. E.g. if
2664 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
2665 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
2666 repeatable, and if will occur with a simpler set of options. You might
2667 even try to start the download at the page where the crash occurred to
2668 see if that page somehow triggered the crash.
2670 Also, while I will probably be interested to know the contents of your
2671 @file{.wgetrc} file, just dumping it into the debug message is probably
2672 a bad idea. Instead, you should first try to see if the bug repeats
2673 with @file{.wgetrc} moved out of the way. Only if it turns out that
2674 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
2678 Please start Wget with @samp{-d} option and send the log (or the
2679 relevant parts of it). If Wget was compiled without debug support,
2680 recompile it. It is @emph{much} easier to trace bugs with debug support
2684 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2685 wget` core} and type @code{where} to get the backtrace.
2689 @node Portability, Signals, Reporting Bugs, Various
2690 @section Portability
2692 @cindex operating systems
2694 Since Wget uses GNU Autoconf for building and configuring, and avoids
2695 using ``special'' ultra--mega--cool features of any particular Unix, it
2696 should compile (and work) on all common Unix flavors.
2698 Various Wget versions have been compiled and tested under many kinds of
2699 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2700 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2701 distribution directory for a comprehensive list. If you compile it on
2702 an architecture not listed there, please let me know so I can update it.
2704 Wget should also compile on the other Unix systems, not listed in
2705 @file{MACHINES}. If it doesn't, please let me know.
2707 Thanks to kind contributors, this version of Wget compiles and works on
2708 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2709 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2710 with Winsock as networking software. Naturally, it is crippled of some
2711 features available on Unix, but it should work as a substitute for
2712 people stuck with Windows. Note that the Windows port is
2713 @strong{neither tested nor maintained} by me---all questions and
2714 problems should be reported to Wget mailing list at
2715 @email{wget@@sunsite.dk} where the maintainers will look at them.
2717 @node Signals, , Portability, Various
2719 @cindex signal handling
2722 Since the purpose of Wget is background work, it catches the hangup
2723 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2724 output, it will be redirected to a file named @file{wget-log}.
2725 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2726 to redirect the output of Wget after having started it.
2729 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2730 $ kill -HUP %% # Redirect the output to wget-log
2733 Other than that, Wget will not try to interfere with signals in any way.
2734 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
2736 @node Appendices, Copying, Various, Top
2739 This chapter contains some references I consider useful.
2742 * Robots:: Wget as a WWW robot.
2743 * Security Considerations:: Security with Wget.
2744 * Contributors:: People who helped.
2747 @node Robots, Security Considerations, Appendices, Appendices
2751 @cindex server maintenance
2753 It is extremely easy to make Wget wander aimlessly around a web site,
2754 sucking all the available data in progress. @samp{wget -r @var{site}},
2755 and you're set. Great? Not for the server admin.
2757 While Wget is retrieving static pages, there's not much of a problem.
2758 But for Wget, there is no real difference between a static page and the
2759 most demanding CGI. For instance, a site I know has a section handled
2760 by an, uh, @dfn{bitchin'} CGI script that converts all the Info files to
2761 HTML. The script can and does bring the machine to its knees without
2762 providing anything useful to the downloader.
2764 For such and similar cases various robot exclusion schemes have been
2765 devised as a means for the server administrators and document authors to
2766 protect chosen portions of their sites from the wandering of robots.
2768 The more popular mechanism is the @dfn{Robots Exclusion Standard}, or
2769 @sc{res}, written by Martijn Koster et al. in 1994. It specifies the
2770 format of a text file containing directives that instruct the robots
2771 which URL paths to avoid. To be found by the robots, the specifications
2772 must be placed in @file{/robots.txt} in the server root, which the
2773 robots are supposed to download and parse.
2775 Wget supports @sc{res} when downloading recursively. So, when you
2779 wget -r http://www.server.com/
2782 First the index of @samp{www.server.com} will be downloaded. If Wget
2783 finds that it wants to download more documents from that server, it will
2784 request @samp{http://www.server.com/robots.txt} and, if found, use it
2785 for further downloads. @file{robots.txt} is loaded only once per each
2788 Until version 1.8, Wget supported the first version of the standard,
2789 written by Martijn Koster in 1994 and available at
2790 @url{http://www.robotstxt.org/wc/norobots.html}. As of version 1.8,
2791 Wget has supported the additional directives specified in the internet
2792 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
2793 Robots Control''. The draft, which has as far as I know never made to
2794 an @sc{rfc}, is available at
2795 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
2797 This manual no longer includes the text of the Robot Exclusion Standard.
2799 The second, less known mechanism, enables the author of an individual
2800 document to specify whether they want the links from the file to be
2801 followed by a robot. This is achieved using the @code{META} tag, like
2805 <meta name="robots" content="nofollow">
2808 This is explained in some detail at
2809 @url{http://www.robotstxt.org/wc/meta-user.html}. Wget supports this
2810 method of robot exclusion in addition to the usual @file{/robots.txt}
2813 @node Security Considerations, Contributors, Robots, Appendices
2814 @section Security Considerations
2817 When using Wget, you must be aware that it sends unencrypted passwords
2818 through the network, which may present a security problem. Here are the
2819 main issues, and some solutions.
2822 @item The passwords on the command line are visible using @code{ps}.
2823 The best way around it is to use @code{wget -i -} and feed the @sc{url}s
2824 to Wget's standard input, each on a separate line, terminated by
2825 @kbd{C-d}. Another workaround is to use @file{.netrc} to store
2826 passwords; however, storing unencrypted passwords is also considered a
2830 Using the insecure @dfn{basic} authentication scheme, unencrypted
2831 passwords are transmitted through the network routers and gateways.
2834 The @sc{ftp} passwords are also in no way encrypted. There is no good
2835 solution for this at the moment.
2838 Although the ``normal'' output of Wget tries to hide the passwords,
2839 debugging logs show them, in all forms. This problem is avoided by
2840 being careful when you send debug logs (yes, even when you send them to
2844 @node Contributors, , Security Considerations, Appendices
2845 @section Contributors
2846 @cindex contributors
2849 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
2852 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
2854 However, its development could never have gone as far as it has, were it
2855 not for the help of many people, either with bug reports, feature
2856 proposals, patches, or letters saying ``Thanks!''.
2858 Special thanks goes to the following people (no particular order):
2862 Karsten Thygesen---donated system resources such as the mailing list,
2863 web space, and @sc{ftp} space, along with a lot of time to make these
2867 Shawn McHorse---bug reports and patches.
2870 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
2874 Gordon Matzigkeit---@file{.netrc} support.
2878 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2879 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2882 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2883 and ``philosophical'' discussions.
2887 Darko Budor---initial port to Windows.
2890 Antonio Rosella---help and suggestions, plus the Italian translation.
2894 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2898 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2903 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2906 Francois Pinard---many thorough bug reports and discussions.
2910 Karl Eichwalder---lots of help with internationalization and other
2914 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2918 The people who provided donations for development, including Brian
2922 The following people have provided patches, bug/build reports, useful
2923 suggestions, beta testing services, fan mail and all the other things
2924 that make maintenance so much fun:
2943 Kristijan @v{C}onka@v{s},
2961 Aleksandar Erkalovi@'{c},
2964 Aleksandar Erkalovic,
2980 Erik Magnus Hulthen,
2998 Goran Kezunovi@'{c},
3009 $\Sigma\acute{\iota}\mu o\varsigma\;
3010 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
3011 (Simos KSenitellis),
3019 Nicol@'{a}s Lichtmeier,
3025 Alexander V. Lukyanov,
3050 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3052 Juan Jos\'{e} Rodr\'{\i}gues,
3055 Juan Jose Rodrigues,
3067 Szakacsits Szabolcs,
3073 Douglas E. Wegscheid,
3083 Apologies to all who I accidentally left out, and many thanks to all the
3084 subscribers of the Wget mailing list.
3086 @node Copying, Concept Index, Appendices, Top
3091 @cindex free software
3093 GNU Wget is licensed under the GNU GPL, which makes it @dfn{free
3096 Please note that ``free'' in ``free software'' refers to liberty, not
3097 price. As some GNU project advocates like to point out, think of ``free
3098 speech'' rather than ``free beer''. The exact and legally binding
3099 distribution terms are spelled out below; in short, you have the right
3100 (freedom) to run and change Wget and distribute it to other people, and
3101 even---if you want---charge money for doing either. The important
3102 restriction is that you have to grant your recipients the same rights
3103 and impose the same restrictions.
3105 This method of licensing software is also known as @dfn{open source}
3106 because, among other things, it makes sure that all recipients will
3107 receive the source code along with the program, and be able to improve
3108 it. The GNU project prefers the term ``free software'' for reasons
3110 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3112 The exact license terms are defined by this paragraph and the GNU
3113 General Public License it refers to:
3116 GNU Wget is free software; you can redistribute it and/or modify it
3117 under the terms of the GNU General Public License as published by the
3118 Free Software Foundation; either version 2 of the License, or (at your
3119 option) any later version.
3121 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3122 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3123 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3126 A copy of the GNU General Public License is included as part of this
3127 manual; if you did not receive it, write to the Free Software
3128 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3131 In addition to this, this manual is free in the same sense:
3134 Permission is granted to copy, distribute and/or modify this document
3135 under the terms of the GNU Free Documentation License, Version 1.1 or
3136 any later version published by the Free Software Foundation; with the
3137 Invariant Sections being ``GNU General Public License'' and ``GNU Free
3138 Documentation License'', with no Front-Cover Texts, and with no
3139 Back-Cover Texts. A copy of the license is included in the section
3140 entitled ``GNU Free Documentation License''.
3143 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
3144 @c that the GFDL needs to be present in the manual, and to me it would
3145 @c suck to include the license for the manual and not the license for
3148 The full texts of the GNU General Public License and of the GNU Free
3149 Documentation License are available below.
3152 * GNU General Public License::
3153 * GNU Free Documentation License::
3156 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
3157 @section GNU General Public License
3158 @center Version 2, June 1991
3161 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3162 675 Mass Ave, Cambridge, MA 02139, USA
3164 Everyone is permitted to copy and distribute verbatim copies
3165 of this license document, but changing it is not allowed.
3168 @unnumberedsec Preamble
3170 The licenses for most software are designed to take away your
3171 freedom to share and change it. By contrast, the GNU General Public
3172 License is intended to guarantee your freedom to share and change free
3173 software---to make sure the software is free for all its users. This
3174 General Public License applies to most of the Free Software
3175 Foundation's software and to any other program whose authors commit to
3176 using it. (Some other Free Software Foundation software is covered by
3177 the GNU Library General Public License instead.) You can apply it to
3180 When we speak of free software, we are referring to freedom, not
3181 price. Our General Public Licenses are designed to make sure that you
3182 have the freedom to distribute copies of free software (and charge for
3183 this service if you wish), that you receive source code or can get it
3184 if you want it, that you can change the software or use pieces of it
3185 in new free programs; and that you know you can do these things.
3187 To protect your rights, we need to make restrictions that forbid
3188 anyone to deny you these rights or to ask you to surrender the rights.
3189 These restrictions translate to certain responsibilities for you if you
3190 distribute copies of the software, or if you modify it.
3192 For example, if you distribute copies of such a program, whether
3193 gratis or for a fee, you must give the recipients all the rights that
3194 you have. You must make sure that they, too, receive or can get the
3195 source code. And you must show them these terms so they know their
3198 We protect your rights with two steps: (1) copyright the software, and
3199 (2) offer you this license which gives you legal permission to copy,
3200 distribute and/or modify the software.
3202 Also, for each author's protection and ours, we want to make certain
3203 that everyone understands that there is no warranty for this free
3204 software. If the software is modified by someone else and passed on, we
3205 want its recipients to know that what they have is not the original, so
3206 that any problems introduced by others will not reflect on the original
3207 authors' reputations.
3209 Finally, any free program is threatened constantly by software
3210 patents. We wish to avoid the danger that redistributors of a free
3211 program will individually obtain patent licenses, in effect making the
3212 program proprietary. To prevent this, we have made it clear that any
3213 patent must be licensed for everyone's free use or not licensed at all.
3215 The precise terms and conditions for copying, distribution and
3216 modification follow.
3219 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3222 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3227 This License applies to any program or other work which contains
3228 a notice placed by the copyright holder saying it may be distributed
3229 under the terms of this General Public License. The ``Program'', below,
3230 refers to any such program or work, and a ``work based on the Program''
3231 means either the Program or any derivative work under copyright law:
3232 that is to say, a work containing the Program or a portion of it,
3233 either verbatim or with modifications and/or translated into another
3234 language. (Hereinafter, translation is included without limitation in
3235 the term ``modification''.) Each licensee is addressed as ``you''.
3237 Activities other than copying, distribution and modification are not
3238 covered by this License; they are outside its scope. The act of
3239 running the Program is not restricted, and the output from the Program
3240 is covered only if its contents constitute a work based on the
3241 Program (independent of having been made by running the Program).
3242 Whether that is true depends on what the Program does.
3245 You may copy and distribute verbatim copies of the Program's
3246 source code as you receive it, in any medium, provided that you
3247 conspicuously and appropriately publish on each copy an appropriate
3248 copyright notice and disclaimer of warranty; keep intact all the
3249 notices that refer to this License and to the absence of any warranty;
3250 and give any other recipients of the Program a copy of this License
3251 along with the Program.
3253 You may charge a fee for the physical act of transferring a copy, and
3254 you may at your option offer warranty protection in exchange for a fee.
3257 You may modify your copy or copies of the Program or any portion
3258 of it, thus forming a work based on the Program, and copy and
3259 distribute such modifications or work under the terms of Section 1
3260 above, provided that you also meet all of these conditions:
3264 You must cause the modified files to carry prominent notices
3265 stating that you changed the files and the date of any change.
3268 You must cause any work that you distribute or publish, that in
3269 whole or in part contains or is derived from the Program or any
3270 part thereof, to be licensed as a whole at no charge to all third
3271 parties under the terms of this License.
3274 If the modified program normally reads commands interactively
3275 when run, you must cause it, when started running for such
3276 interactive use in the most ordinary way, to print or display an
3277 announcement including an appropriate copyright notice and a
3278 notice that there is no warranty (or else, saying that you provide
3279 a warranty) and that users may redistribute the program under
3280 these conditions, and telling the user how to view a copy of this
3281 License. (Exception: if the Program itself is interactive but
3282 does not normally print such an announcement, your work based on
3283 the Program is not required to print an announcement.)
3286 These requirements apply to the modified work as a whole. If
3287 identifiable sections of that work are not derived from the Program,
3288 and can be reasonably considered independent and separate works in
3289 themselves, then this License, and its terms, do not apply to those
3290 sections when you distribute them as separate works. But when you
3291 distribute the same sections as part of a whole which is a work based
3292 on the Program, the distribution of the whole must be on the terms of
3293 this License, whose permissions for other licensees extend to the
3294 entire whole, and thus to each and every part regardless of who wrote it.
3296 Thus, it is not the intent of this section to claim rights or contest
3297 your rights to work written entirely by you; rather, the intent is to
3298 exercise the right to control the distribution of derivative or
3299 collective works based on the Program.
3301 In addition, mere aggregation of another work not based on the Program
3302 with the Program (or with a work based on the Program) on a volume of
3303 a storage or distribution medium does not bring the other work under
3304 the scope of this License.
3307 You may copy and distribute the Program (or a work based on it,
3308 under Section 2) in object code or executable form under the terms of
3309 Sections 1 and 2 above provided that you also do one of the following:
3313 Accompany it with the complete corresponding machine-readable
3314 source code, which must be distributed under the terms of Sections
3315 1 and 2 above on a medium customarily used for software interchange; or,
3318 Accompany it with a written offer, valid for at least three
3319 years, to give any third party, for a charge no more than your
3320 cost of physically performing source distribution, a complete
3321 machine-readable copy of the corresponding source code, to be
3322 distributed under the terms of Sections 1 and 2 above on a medium
3323 customarily used for software interchange; or,
3326 Accompany it with the information you received as to the offer
3327 to distribute corresponding source code. (This alternative is
3328 allowed only for noncommercial distribution and only if you
3329 received the program in object code or executable form with such
3330 an offer, in accord with Subsection b above.)
3333 The source code for a work means the preferred form of the work for
3334 making modifications to it. For an executable work, complete source
3335 code means all the source code for all modules it contains, plus any
3336 associated interface definition files, plus the scripts used to
3337 control compilation and installation of the executable. However, as a
3338 special exception, the source code distributed need not include
3339 anything that is normally distributed (in either source or binary
3340 form) with the major components (compiler, kernel, and so on) of the
3341 operating system on which the executable runs, unless that component
3342 itself accompanies the executable.
3344 If distribution of executable or object code is made by offering
3345 access to copy from a designated place, then offering equivalent
3346 access to copy the source code from the same place counts as
3347 distribution of the source code, even though third parties are not
3348 compelled to copy the source along with the object code.
3351 You may not copy, modify, sublicense, or distribute the Program
3352 except as expressly provided under this License. Any attempt
3353 otherwise to copy, modify, sublicense or distribute the Program is
3354 void, and will automatically terminate your rights under this License.
3355 However, parties who have received copies, or rights, from you under
3356 this License will not have their licenses terminated so long as such
3357 parties remain in full compliance.
3360 You are not required to accept this License, since you have not
3361 signed it. However, nothing else grants you permission to modify or
3362 distribute the Program or its derivative works. These actions are
3363 prohibited by law if you do not accept this License. Therefore, by
3364 modifying or distributing the Program (or any work based on the
3365 Program), you indicate your acceptance of this License to do so, and
3366 all its terms and conditions for copying, distributing or modifying
3367 the Program or works based on it.
3370 Each time you redistribute the Program (or any work based on the
3371 Program), the recipient automatically receives a license from the
3372 original licensor to copy, distribute or modify the Program subject to
3373 these terms and conditions. You may not impose any further
3374 restrictions on the recipients' exercise of the rights granted herein.
3375 You are not responsible for enforcing compliance by third parties to
3379 If, as a consequence of a court judgment or allegation of patent
3380 infringement or for any other reason (not limited to patent issues),
3381 conditions are imposed on you (whether by court order, agreement or
3382 otherwise) that contradict the conditions of this License, they do not
3383 excuse you from the conditions of this License. If you cannot
3384 distribute so as to satisfy simultaneously your obligations under this
3385 License and any other pertinent obligations, then as a consequence you
3386 may not distribute the Program at all. For example, if a patent
3387 license would not permit royalty-free redistribution of the Program by
3388 all those who receive copies directly or indirectly through you, then
3389 the only way you could satisfy both it and this License would be to
3390 refrain entirely from distribution of the Program.
3392 If any portion of this section is held invalid or unenforceable under
3393 any particular circumstance, the balance of the section is intended to
3394 apply and the section as a whole is intended to apply in other
3397 It is not the purpose of this section to induce you to infringe any
3398 patents or other property right claims or to contest validity of any
3399 such claims; this section has the sole purpose of protecting the
3400 integrity of the free software distribution system, which is
3401 implemented by public license practices. Many people have made
3402 generous contributions to the wide range of software distributed
3403 through that system in reliance on consistent application of that
3404 system; it is up to the author/donor to decide if he or she is willing
3405 to distribute software through any other system and a licensee cannot
3408 This section is intended to make thoroughly clear what is believed to
3409 be a consequence of the rest of this License.
3412 If the distribution and/or use of the Program is restricted in
3413 certain countries either by patents or by copyrighted interfaces, the
3414 original copyright holder who places the Program under this License
3415 may add an explicit geographical distribution limitation excluding
3416 those countries, so that distribution is permitted only in or among
3417 countries not thus excluded. In such case, this License incorporates
3418 the limitation as if written in the body of this License.
3421 The Free Software Foundation may publish revised and/or new versions
3422 of the General Public License from time to time. Such new versions will
3423 be similar in spirit to the present version, but may differ in detail to
3424 address new problems or concerns.
3426 Each version is given a distinguishing version number. If the Program
3427 specifies a version number of this License which applies to it and ``any
3428 later version'', you have the option of following the terms and conditions
3429 either of that version or of any later version published by the Free
3430 Software Foundation. If the Program does not specify a version number of
3431 this License, you may choose any version ever published by the Free Software
3435 If you wish to incorporate parts of the Program into other free
3436 programs whose distribution conditions are different, write to the author
3437 to ask for permission. For software which is copyrighted by the Free
3438 Software Foundation, write to the Free Software Foundation; we sometimes
3439 make exceptions for this. Our decision will be guided by the two goals
3440 of preserving the free status of all derivatives of our free software and
3441 of promoting the sharing and reuse of software generally.
3444 @heading NO WARRANTY
3452 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3453 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3454 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3455 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3456 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3457 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3458 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3459 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3460 REPAIR OR CORRECTION.
3463 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3464 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3465 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3466 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3467 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3468 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3469 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3470 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3471 POSSIBILITY OF SUCH DAMAGES.
3475 @heading END OF TERMS AND CONDITIONS
3478 @center END OF TERMS AND CONDITIONS
3482 @unnumberedsec How to Apply These Terms to Your New Programs
3484 If you develop a new program, and you want it to be of the greatest
3485 possible use to the public, the best way to achieve this is to make it
3486 free software which everyone can redistribute and change under these terms.
3488 To do so, attach the following notices to the program. It is safest
3489 to attach them to the start of each source file to most effectively
3490 convey the exclusion of warranty; and each file should have at least
3491 the ``copyright'' line and a pointer to where the full notice is found.
3494 @var{one line to give the program's name and an idea of what it does.}
3495 Copyright (C) 19@var{yy} @var{name of author}
3497 This program is free software; you can redistribute it and/or
3498 modify it under the terms of the GNU General Public License
3499 as published by the Free Software Foundation; either version 2
3500 of the License, or (at your option) any later version.
3502 This program is distributed in the hope that it will be useful,
3503 but WITHOUT ANY WARRANTY; without even the implied warranty of
3504 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3505 GNU General Public License for more details.
3507 You should have received a copy of the GNU General Public License
3508 along with this program; if not, write to the Free Software
3509 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3512 Also add information on how to contact you by electronic and paper mail.
3514 If the program is interactive, make it output a short notice like this
3515 when it starts in an interactive mode:
3518 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3519 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3520 type `show w'. This is free software, and you are welcome
3521 to redistribute it under certain conditions; type `show c'
3525 The hypothetical commands @samp{show w} and @samp{show c} should show
3526 the appropriate parts of the General Public License. Of course, the
3527 commands you use may be called something other than @samp{show w} and
3528 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3531 You should also get your employer (if you work as a programmer) or your
3532 school, if any, to sign a ``copyright disclaimer'' for the program, if
3533 necessary. Here is a sample; alter the names:
3537 Yoyodyne, Inc., hereby disclaims all copyright
3538 interest in the program `Gnomovision'
3539 (which makes passes at compilers) written
3542 @var{signature of Ty Coon}, 1 April 1989
3543 Ty Coon, President of Vice
3547 This General Public License does not permit incorporating your program into
3548 proprietary programs. If your program is a subroutine library, you may
3549 consider it more useful to permit linking proprietary applications with the
3550 library. If this is what you want to do, use the GNU Library General
3551 Public License instead of this License.
3553 @node GNU Free Documentation License, , GNU General Public License, Copying
3554 @section GNU Free Documentation License
3555 @center Version 1.1, March 2000
3558 Copyright (C) 2000 Free Software Foundation, Inc.
3559 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3561 Everyone is permitted to copy and distribute verbatim copies
3562 of this license document, but changing it is not allowed.
3569 The purpose of this License is to make a manual, textbook, or other
3570 written document ``free'' in the sense of freedom: to assure everyone
3571 the effective freedom to copy and redistribute it, with or without
3572 modifying it, either commercially or noncommercially. Secondarily,
3573 this License preserves for the author and publisher a way to get
3574 credit for their work, while not being considered responsible for
3575 modifications made by others.
3577 This License is a kind of ``copyleft'', which means that derivative
3578 works of the document must themselves be free in the same sense. It
3579 complements the GNU General Public License, which is a copyleft
3580 license designed for free software.
3582 We have designed this License in order to use it for manuals for free
3583 software, because free software needs free documentation: a free
3584 program should come with manuals providing the same freedoms that the
3585 software does. But this License is not limited to software manuals;
3586 it can be used for any textual work, regardless of subject matter or
3587 whether it is published as a printed book. We recommend this License
3588 principally for works whose purpose is instruction or reference.
3592 APPLICABILITY AND DEFINITIONS
3594 This License applies to any manual or other work that contains a
3595 notice placed by the copyright holder saying it can be distributed
3596 under the terms of this License. The ``Document'', below, refers to any
3597 such manual or work. Any member of the public is a licensee, and is
3598 addressed as ``you''.
3600 A ``Modified Version'' of the Document means any work containing the
3601 Document or a portion of it, either copied verbatim, or with
3602 modifications and/or translated into another language.
3604 A ``Secondary Section'' is a named appendix or a front-matter section of
3605 the Document that deals exclusively with the relationship of the
3606 publishers or authors of the Document to the Document's overall subject
3607 (or to related matters) and contains nothing that could fall directly
3608 within that overall subject. (For example, if the Document is in part a
3609 textbook of mathematics, a Secondary Section may not explain any
3610 mathematics.) The relationship could be a matter of historical
3611 connection with the subject or with related matters, or of legal,
3612 commercial, philosophical, ethical or political position regarding
3615 The ``Invariant Sections'' are certain Secondary Sections whose titles
3616 are designated, as being those of Invariant Sections, in the notice
3617 that says that the Document is released under this License.
3619 The ``Cover Texts'' are certain short passages of text that are listed,
3620 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3621 the Document is released under this License.
3623 A ``Transparent'' copy of the Document means a machine-readable copy,
3624 represented in a format whose specification is available to the
3625 general public, whose contents can be viewed and edited directly and
3626 straightforwardly with generic text editors or (for images composed of
3627 pixels) generic paint programs or (for drawings) some widely available
3628 drawing editor, and that is suitable for input to text formatters or
3629 for automatic translation to a variety of formats suitable for input
3630 to text formatters. A copy made in an otherwise Transparent file
3631 format whose markup has been designed to thwart or discourage
3632 subsequent modification by readers is not Transparent. A copy that is
3633 not ``Transparent'' is called ``Opaque''.
3635 Examples of suitable formats for Transparent copies include plain
3636 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3637 or XML using a publicly available DTD, and standard-conforming simple
3638 HTML designed for human modification. Opaque formats include
3639 PostScript, PDF, proprietary formats that can be read and edited only
3640 by proprietary word processors, SGML or XML for which the DTD and/or
3641 processing tools are not generally available, and the
3642 machine-generated HTML produced by some word processors for output
3645 The ``Title Page'' means, for a printed book, the title page itself,
3646 plus such following pages as are needed to hold, legibly, the material
3647 this License requires to appear in the title page. For works in
3648 formats which do not have any title page as such, ``Title Page'' means
3649 the text near the most prominent appearance of the work's title,
3650 preceding the beginning of the body of the text.
3655 You may copy and distribute the Document in any medium, either
3656 commercially or noncommercially, provided that this License, the
3657 copyright notices, and the license notice saying this License applies
3658 to the Document are reproduced in all copies, and that you add no other
3659 conditions whatsoever to those of this License. You may not use
3660 technical measures to obstruct or control the reading or further
3661 copying of the copies you make or distribute. However, you may accept
3662 compensation in exchange for copies. If you distribute a large enough
3663 number of copies you must also follow the conditions in section 3.
3665 You may also lend copies, under the same conditions stated above, and
3666 you may publicly display copies.
3671 If you publish printed copies of the Document numbering more than 100,
3672 and the Document's license notice requires Cover Texts, you must enclose
3673 the copies in covers that carry, clearly and legibly, all these Cover
3674 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3675 the back cover. Both covers must also clearly and legibly identify
3676 you as the publisher of these copies. The front cover must present
3677 the full title with all words of the title equally prominent and
3678 visible. You may add other material on the covers in addition.
3679 Copying with changes limited to the covers, as long as they preserve
3680 the title of the Document and satisfy these conditions, can be treated
3681 as verbatim copying in other respects.
3683 If the required texts for either cover are too voluminous to fit
3684 legibly, you should put the first ones listed (as many as fit
3685 reasonably) on the actual cover, and continue the rest onto adjacent
3688 If you publish or distribute Opaque copies of the Document numbering
3689 more than 100, you must either include a machine-readable Transparent
3690 copy along with each Opaque copy, or state in or with each Opaque copy
3691 a publicly-accessible computer-network location containing a complete
3692 Transparent copy of the Document, free of added material, which the
3693 general network-using public has access to download anonymously at no
3694 charge using public-standard network protocols. If you use the latter
3695 option, you must take reasonably prudent steps, when you begin
3696 distribution of Opaque copies in quantity, to ensure that this
3697 Transparent copy will remain thus accessible at the stated location
3698 until at least one year after the last time you distribute an Opaque
3699 copy (directly or through your agents or retailers) of that edition to
3702 It is requested, but not required, that you contact the authors of the
3703 Document well before redistributing any large number of copies, to give
3704 them a chance to provide you with an updated version of the Document.
3709 You may copy and distribute a Modified Version of the Document under
3710 the conditions of sections 2 and 3 above, provided that you release
3711 the Modified Version under precisely this License, with the Modified
3712 Version filling the role of the Document, thus licensing distribution
3713 and modification of the Modified Version to whoever possesses a copy
3714 of it. In addition, you must do these things in the Modified Version:
3716 A. Use in the Title Page (and on the covers, if any) a title distinct
3717 from that of the Document, and from those of previous versions
3718 (which should, if there were any, be listed in the History section
3719 of the Document). You may use the same title as a previous version
3720 if the original publisher of that version gives permission.@*
3721 B. List on the Title Page, as authors, one or more persons or entities
3722 responsible for authorship of the modifications in the Modified
3723 Version, together with at least five of the principal authors of the
3724 Document (all of its principal authors, if it has less than five).@*
3725 C. State on the Title page the name of the publisher of the
3726 Modified Version, as the publisher.@*
3727 D. Preserve all the copyright notices of the Document.@*
3728 E. Add an appropriate copyright notice for your modifications
3729 adjacent to the other copyright notices.@*
3730 F. Include, immediately after the copyright notices, a license notice
3731 giving the public permission to use the Modified Version under the
3732 terms of this License, in the form shown in the Addendum below.@*
3733 G. Preserve in that license notice the full lists of Invariant Sections
3734 and required Cover Texts given in the Document's license notice.@*
3735 H. Include an unaltered copy of this License.@*
3736 I. Preserve the section entitled ``History'', and its title, and add to
3737 it an item stating at least the title, year, new authors, and
3738 publisher of the Modified Version as given on the Title Page. If
3739 there is no section entitled ``History'' in the Document, create one
3740 stating the title, year, authors, and publisher of the Document as
3741 given on its Title Page, then add an item describing the Modified
3742 Version as stated in the previous sentence.@*
3743 J. Preserve the network location, if any, given in the Document for
3744 public access to a Transparent copy of the Document, and likewise
3745 the network locations given in the Document for previous versions
3746 it was based on. These may be placed in the ``History'' section.
3747 You may omit a network location for a work that was published at
3748 least four years before the Document itself, or if the original
3749 publisher of the version it refers to gives permission.@*
3750 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3751 preserve the section's title, and preserve in the section all the
3752 substance and tone of each of the contributor acknowledgements
3753 and/or dedications given therein.@*
3754 L. Preserve all the Invariant Sections of the Document,
3755 unaltered in their text and in their titles. Section numbers
3756 or the equivalent are not considered part of the section titles.@*
3757 M. Delete any section entitled ``Endorsements''. Such a section
3758 may not be included in the Modified Version.@*
3759 N. Do not retitle any existing section as ``Endorsements''
3760 or to conflict in title with any Invariant Section.@*
3762 If the Modified Version includes new front-matter sections or
3763 appendices that qualify as Secondary Sections and contain no material
3764 copied from the Document, you may at your option designate some or all
3765 of these sections as invariant. To do this, add their titles to the
3766 list of Invariant Sections in the Modified Version's license notice.
3767 These titles must be distinct from any other section titles.
3769 You may add a section entitled ``Endorsements'', provided it contains
3770 nothing but endorsements of your Modified Version by various
3771 parties--for example, statements of peer review or that the text has
3772 been approved by an organization as the authoritative definition of a
3775 You may add a passage of up to five words as a Front-Cover Text, and a
3776 passage of up to 25 words as a Back-Cover Text, to the end of the list
3777 of Cover Texts in the Modified Version. Only one passage of
3778 Front-Cover Text and one of Back-Cover Text may be added by (or
3779 through arrangements made by) any one entity. If the Document already
3780 includes a cover text for the same cover, previously added by you or
3781 by arrangement made by the same entity you are acting on behalf of,
3782 you may not add another; but you may replace the old one, on explicit
3783 permission from the previous publisher that added the old one.
3785 The author(s) and publisher(s) of the Document do not by this License
3786 give permission to use their names for publicity for or to assert or
3787 imply endorsement of any Modified Version.
3792 You may combine the Document with other documents released under this
3793 License, under the terms defined in section 4 above for modified
3794 versions, provided that you include in the combination all of the
3795 Invariant Sections of all of the original documents, unmodified, and
3796 list them all as Invariant Sections of your combined work in its
3799 The combined work need only contain one copy of this License, and
3800 multiple identical Invariant Sections may be replaced with a single
3801 copy. If there are multiple Invariant Sections with the same name but
3802 different contents, make the title of each such section unique by
3803 adding at the end of it, in parentheses, the name of the original
3804 author or publisher of that section if known, or else a unique number.
3805 Make the same adjustment to the section titles in the list of
3806 Invariant Sections in the license notice of the combined work.
3808 In the combination, you must combine any sections entitled ``History''
3809 in the various original documents, forming one section entitled
3810 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3811 and any sections entitled ``Dedications''. You must delete all sections
3812 entitled ``Endorsements.''
3815 COLLECTIONS OF DOCUMENTS
3817 You may make a collection consisting of the Document and other documents
3818 released under this License, and replace the individual copies of this
3819 License in the various documents with a single copy that is included in
3820 the collection, provided that you follow the rules of this License for
3821 verbatim copying of each of the documents in all other respects.
3823 You may extract a single document from such a collection, and distribute
3824 it individually under this License, provided you insert a copy of this
3825 License into the extracted document, and follow this License in all
3826 other respects regarding verbatim copying of that document.
3829 AGGREGATION WITH INDEPENDENT WORKS
3831 A compilation of the Document or its derivatives with other separate
3832 and independent documents or works, in or on a volume of a storage or
3833 distribution medium, does not as a whole count as a Modified Version
3834 of the Document, provided no compilation copyright is claimed for the
3835 compilation. Such a compilation is called an ``aggregate'', and this
3836 License does not apply to the other self-contained works thus compiled
3837 with the Document, on account of their being thus compiled, if they
3838 are not themselves derivative works of the Document.
3840 If the Cover Text requirement of section 3 is applicable to these
3841 copies of the Document, then if the Document is less than one quarter
3842 of the entire aggregate, the Document's Cover Texts may be placed on
3843 covers that surround only the Document within the aggregate.
3844 Otherwise they must appear on covers around the whole aggregate.
3849 Translation is considered a kind of modification, so you may
3850 distribute translations of the Document under the terms of section 4.
3851 Replacing Invariant Sections with translations requires special
3852 permission from their copyright holders, but you may include
3853 translations of some or all Invariant Sections in addition to the
3854 original versions of these Invariant Sections. You may include a
3855 translation of this License provided that you also include the
3856 original English version of this License. In case of a disagreement
3857 between the translation and the original English version of this
3858 License, the original English version will prevail.
3863 You may not copy, modify, sublicense, or distribute the Document except
3864 as expressly provided for under this License. Any other attempt to
3865 copy, modify, sublicense or distribute the Document is void, and will
3866 automatically terminate your rights under this License. However,
3867 parties who have received copies, or rights, from you under this
3868 License will not have their licenses terminated so long as such
3869 parties remain in full compliance.
3872 FUTURE REVISIONS OF THIS LICENSE
3874 The Free Software Foundation may publish new, revised versions
3875 of the GNU Free Documentation License from time to time. Such new
3876 versions will be similar in spirit to the present version, but may
3877 differ in detail to address new problems or concerns. See
3878 http://www.gnu.org/copyleft/.
3880 Each version of the License is given a distinguishing version number.
3881 If the Document specifies that a particular numbered version of this
3882 License ``or any later version'' applies to it, you have the option of
3883 following the terms and conditions either of that specified version or
3884 of any later version that has been published (not as a draft) by the
3885 Free Software Foundation. If the Document does not specify a version
3886 number of this License, you may choose any version ever published (not
3887 as a draft) by the Free Software Foundation.
3891 @unnumberedsec ADDENDUM: How to use this License for your documents
3893 To use this License in a document you have written, include a copy of
3894 the License in the document and put the following copyright and
3895 license notices just after the title page:
3900 Copyright (C) @var{year} @var{your name}.
3901 Permission is granted to copy, distribute and/or modify this document
3902 under the terms of the GNU Free Documentation License, Version 1.1
3903 or any later version published by the Free Software Foundation;
3904 with the Invariant Sections being @var{list their titles}, with the
3905 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
3906 A copy of the license is included in the section entitled ``GNU
3907 Free Documentation License''.
3910 If you have no Invariant Sections, write ``with no Invariant Sections''
3911 instead of saying which ones are invariant. If you have no
3912 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
3913 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
3915 If your document contains nontrivial examples of program code, we
3916 recommend releasing these examples in parallel under your choice of
3917 free software license, such as the GNU General Public License,
3918 to permit their use in free software.
3921 @node Concept Index, , Copying, Top
3922 @unnumbered Concept Index