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 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
289 being the hexadecimal representation of the character's @sc{ascii}
290 value. Some common unsafe characters include @samp{%} (quoted as
291 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
292 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
295 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
296 default, @sc{ftp} documents are retrieved in the binary mode (type
297 @samp{i}), which means that they are downloaded unchanged. Another
298 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
299 delimiters between the different operating systems, and is thus useful
300 for text files. Here is an example:
303 ftp://host/directory/file;type=a
306 Two alternative variants of @sc{url} specification are also supported,
307 because of historical (hysterical?) reasons and their widespreaded use.
309 @sc{ftp}-only syntax (supported by @code{NcFTP}):
314 @sc{http}-only syntax (introduced by @code{Netscape}):
319 These two alternative forms are deprecated, and may cease being
320 supported in the future.
322 If you do not understand the difference between these notations, or do
323 not know which one to use, just use the plain ordinary format you use
324 with your favorite browser, like @code{Lynx} or @code{Netscape}.
326 @node Option Syntax, Basic Startup Options, URL Format, Invoking
327 @section Option Syntax
328 @cindex option syntax
329 @cindex syntax of options
331 Since Wget uses GNU getopts to process its arguments, every option has a
332 short form and a long form. Long options are more convenient to
333 remember, but take time to type. You may freely mix different option
334 styles, or specify options after the command-line arguments. Thus you
338 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
341 The space between the option accepting an argument and the argument may
342 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
344 You may put several options that do not require arguments together,
351 This is a complete equivalent of:
354 wget -d -r -c @var{URL}
357 Since the options can be specified after the arguments, you may
358 terminate them with @samp{--}. So the following will try to download
359 @sc{url} @samp{-x}, reporting failure to @file{log}:
365 The options that accept comma-separated lists all respect the convention
366 that specifying an empty list clears its value. This can be useful to
367 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
368 sets @code{exclude_directories} to @file{/cgi-bin}, the following
369 example will first reset it, and then set it to exclude @file{/~nobody}
370 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
371 (@pxref{Wgetrc Syntax}).
374 wget -X '' -X /~nobody,/~somebody
379 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
380 @section Basic Startup Options
385 Display the version of Wget.
389 Print a help message describing all of Wget's command-line options.
393 Go to background immediately after startup. If no output file is
394 specified via the @samp{-o}, output is redirected to @file{wget-log}.
396 @cindex execute wgetrc command
397 @item -e @var{command}
398 @itemx --execute @var{command}
399 Execute @var{command} as if it were a part of @file{.wgetrc}
400 (@pxref{Startup File}). A command thus invoked will be executed
401 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
405 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
406 @section Logging and Input File Options
411 @item -o @var{logfile}
412 @itemx --output-file=@var{logfile}
413 Log all messages to @var{logfile}. The messages are normally reported
416 @cindex append to log
417 @item -a @var{logfile}
418 @itemx --append-output=@var{logfile}
419 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
420 to @var{logfile} instead of overwriting the old log file. If
421 @var{logfile} does not exist, a new file is created.
426 Turn on debug output, meaning various information important to the
427 developers of Wget if it does not work properly. Your system
428 administrator may have chosen to compile Wget without debug support, in
429 which case @samp{-d} will not work. Please note that compiling with
430 debug support is always safe---Wget compiled with the debug support will
431 @emph{not} print any debug info unless requested with @samp{-d}.
432 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
438 Turn off Wget's output.
443 Turn on verbose output, with all the available data. The default output
448 Non-verbose output---turn off verbose without being completely quiet
449 (use @samp{-q} for that), which means that error messages and basic
450 information still get printed.
454 @itemx --input-file=@var{file}
455 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
456 the command line. If there are @sc{url}s both on the command line and
457 in an input file, those on the command lines will be the first ones to
458 be retrieved. The @var{file} need not be an @sc{html} document (but no
459 harm if it is)---it is enough if the @sc{url}s are just listed
462 However, if you specify @samp{--force-html}, the document will be
463 regarded as @samp{html}. In that case you may have problems with
464 relative links, which you can solve either by adding @code{<base
465 href="@var{url}">} to the documents or by specifying
466 @samp{--base=@var{url}} on the command line.
471 When input is read from a file, force it to be treated as an @sc{html}
472 file. This enables you to retrieve relative links from existing
473 @sc{html} files on your local disk, by adding @code{<base
474 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
477 @cindex base for relative links in input file
479 @itemx --base=@var{URL}
480 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
481 links in the file specified by @samp{-i}.
484 @node Download Options, Directory Options, Logging and Input File Options, Invoking
485 @section Download Options
488 @cindex bind() address
489 @cindex client IP address
490 @cindex IP address, client
491 @item --bind-address=@var{ADDRESS}
492 When making client TCP/IP connections, @code{bind()} to @var{ADDRESS} on
493 the local machine. @var{ADDRESS} may be specified as a hostname or IP
494 address. This option can be useful if your machine is bound to multiple
499 @cindex number of retries
500 @item -t @var{number}
501 @itemx --tries=@var{number}
502 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
506 @itemx --output-document=@var{file}
507 The documents will not be written to the appropriate files, but all will
508 be concatenated together and written to @var{file}. If @var{file}
509 already exists, it will be overwritten. If the @var{file} is @samp{-},
510 the documents will be written to standard output. Including this option
511 automatically sets the number of tries to 1.
513 @cindex clobbering, file
514 @cindex downloading multiple times
518 If a file is downloaded more than once in the same directory, Wget's
519 behavior depends on a few options, including @samp{-nc}. In certain
520 cases, the local file will be @dfn{clobbered}, or overwritten, upon
521 repeated download. In other cases it will be preserved.
523 When running Wget without @samp{-N}, @samp{-nc}, or @samp{-r},
524 downloading the same file in the same directory will result in the
525 original copy of @var{file} being preserved and the second copy being
526 named @samp{@var{file}.1}. If that file is downloaded yet again, the
527 third copy will be named @samp{@var{file}.2}, and so on. When
528 @samp{-nc} is specified, this behavior is suppressed, and Wget will
529 refuse to download newer copies of @samp{@var{file}}. Therefore,
530 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
531 clobbering that's prevented (as the numeric suffixes were already
532 preventing clobbering), but rather the multiple version saving that's
535 When running Wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
536 re-downloading a file will result in the new copy simply overwriting the
537 old. Adding @samp{-nc} will prevent this behavior, instead causing the
538 original version to be preserved and any newer copies on the server to
541 When running Wget with @samp{-N}, with or without @samp{-r}, the
542 decision as to whether or not to download a newer copy of a file depends
543 on the local and remote timestamp and size of the file
544 (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the same
547 Note that when @samp{-nc} is specified, files with the suffixes
548 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
549 and parsed as if they had been retrieved from the Web.
551 @cindex continue retrieval
552 @cindex incomplete downloads
553 @cindex resume download
556 Continue getting a partially-downloaded file. This is useful when you
557 want to finish up a download started by a previous instance of Wget, or
558 by another program. For instance:
561 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
564 If there is a file named @file{ls-lR.Z} in the current directory, Wget
565 will assume that it is the first portion of the remote file, and will
566 ask the server to continue the retrieval from an offset equal to the
567 length of the local file.
569 Note that you don't need to specify this option if you just want the
570 current invocation of Wget to retry downloading a file should the
571 connection be lost midway through. This is the default behavior.
572 @samp{-c} only affects resumption of downloads started @emph{prior} to
573 this invocation of Wget, and whose local files are still sitting around.
575 Without @samp{-c}, the previous example would just download the remote
576 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
579 Beginning with Wget 1.7, if you use @samp{-c} on a non-empty file, and
580 it turns out that the server does not support continued downloading,
581 Wget will refuse to start the download from scratch, which would
582 effectively ruin existing contents. If you really want the download to
583 start from scratch, remove the file.
585 Also beginning with Wget 1.7, if you use @samp{-c} on a file which is of
586 equal size as the one on the server, Wget will refuse to download the
587 file and print an explanatory message. The same happens when the file
588 is smaller on the server than locally (presumably because it was changed
589 on the server since your last download attempt)---because ``continuing''
590 is not meaningful, no download occurs.
592 On the other side of the coin, while using @samp{-c}, any file that's
593 bigger on the server than locally will be considered an incomplete
594 download and only @code{(length(remote) - length(local))} bytes will be
595 downloaded and tacked onto the end of the local file. This behavior can
596 be desirable in certain cases---for instance, you can use @samp{wget -c}
597 to download just the new portion that's been appended to a data
598 collection or log file.
600 However, if the file is bigger on the server because it's been
601 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
602 with a garbled file. Wget has no way of verifying that the local file
603 is really a valid prefix of the remote file. You need to be especially
604 careful of this when using @samp{-c} in conjunction with @samp{-r},
605 since every file will be considered as an "incomplete download" candidate.
607 Another instance where you'll get a garbled file if you try to use
608 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
609 ``transfer interrupted'' string into the local file. In the future a
610 ``rollback'' option may be added to deal with this case.
612 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
613 servers that support the @code{Range} header.
615 @cindex progress indicator
617 @item --progress=@var{type}
618 Select the type of the progress indicator you wish to use. Legal
619 indicators are ``dot'' and ``bar''.
621 The ``dot'' indicator is used by default. It traces the retrieval by
622 printing dots on the screen, each dot representing a fixed amount of
625 When using the dotted retrieval, you may also set the @dfn{style} by
626 specifying the type as @samp{dot:@var{style}}. Different styles assign
627 different meaning to one dot. With the @code{default} style each dot
628 represents 1K, there are ten dots in a cluster and 50 dots in a line.
629 The @code{binary} style has a more ``computer''-like orientation---8K
630 dots, 16-dots clusters and 48 dots per line (which makes for 384K
631 lines). The @code{mega} style is suitable for downloading very large
632 files---each dot represents 64K retrieved, there are eight dots in a
633 cluster, and 48 dots on each line (so each line contains 3M).
635 Specifying @samp{--progress=bar} will draw a nice ASCII progress bar
636 graphics (a.k.a ``thermometer'' display) to indicate retrieval. If the
637 output is not a TTY, this option will be ignored, and Wget will revert
638 to the dot indicator. If you want to force the bar indicator, use
639 @samp{--progress=bar:force}.
642 @itemx --timestamping
643 Turn on time-stamping. @xref{Time-Stamping}, for details.
645 @cindex server response, print
647 @itemx --server-response
648 Print the headers sent by @sc{http} servers and responses sent by
651 @cindex Wget as spider
654 When invoked with this option, Wget will behave as a Web @dfn{spider},
655 which means that it will not download the pages, just check that they
656 are there. You can use it to check your bookmarks, e.g. with:
659 wget --spider --force-html -i bookmarks.html
662 This feature needs much more work for Wget to get close to the
663 functionality of real @sc{www} spiders.
667 @itemx --timeout=@var{seconds}
668 Set the read timeout to @var{seconds} seconds. Whenever a network read
669 is issued, the file descriptor is checked for a timeout, which could
670 otherwise leave a pending connection (uninterrupted read). The default
671 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
672 disable checking for timeouts.
674 Please do not lower the default timeout value with this option unless
675 you know what you are doing.
679 @item -w @var{seconds}
680 @itemx --wait=@var{seconds}
681 Wait the specified number of seconds between the retrievals. Use of
682 this option is recommended, as it lightens the server load by making the
683 requests less frequent. Instead of in seconds, the time can be
684 specified in minutes using the @code{m} suffix, in hours using @code{h}
685 suffix, or in days using @code{d} suffix.
687 Specifying a large value for this option is useful if the network or the
688 destination host is down, so that Wget can wait long enough to
689 reasonably expect the network error to be fixed before the retry.
691 @cindex retries, waiting between
692 @cindex waiting between retries
693 @item --waitretry=@var{seconds}
694 If you don't want Wget to wait between @emph{every} retrieval, but only
695 between retries of failed downloads, you can use this option. Wget will
696 use @dfn{linear backoff}, waiting 1 second after the first failure on a
697 given file, then waiting 2 seconds after the second failure on that
698 file, up to the maximum number of @var{seconds} you specify. Therefore,
699 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
702 Note that this option is turned on by default in the global
708 Some web sites may perform log analysis to identify retrieval programs
709 such as Wget by looking for statistically significant similarities in
710 the time between requests. This option causes the time between requests
711 to vary between 0 and 2 * @var{wait} seconds, where @var{wait} was
712 specified using the @samp{-w} or @samp{--wait} options, in order to mask
713 Wget's presence from such analysis.
715 A recent article in a publication devoted to development on a popular
716 consumer platform provided code to perform this analysis on the fly.
717 Its author suggested blocking at the class C address level to ensure
718 automated retrieval programs were blocked despite changing DHCP-supplied
721 The @samp{--random-wait} option was inspired by this ill-advised
722 recommendation to block many unrelated users from a web site due to the
727 @itemx --proxy=on/off
728 Turn proxy support on or off. The proxy is on by default if the
729 appropriate environmental variable is defined.
733 @itemx --quota=@var{quota}
734 Specify download quota for automatic retrievals. The value can be
735 specified in bytes (default), kilobytes (with @samp{k} suffix), or
736 megabytes (with @samp{m} suffix).
738 Note that quota will never affect downloading a single file. So if you
739 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
740 @file{ls-lR.gz} will be downloaded. The same goes even when several
741 @sc{url}s are specified on the command-line. However, quota is
742 respected when retrieving either recursively, or from an input file.
743 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
744 aborted when the quota is exceeded.
746 Setting quota to 0 or to @samp{inf} unlimits the download quota.
749 @node Directory Options, HTTP Options, Download Options, Invoking
750 @section Directory Options
754 @itemx --no-directories
755 Do not create a hierarchy of directories when retrieving recursively.
756 With this option turned on, all files will get saved to the current
757 directory, without clobbering (if a name shows up more than once, the
758 filenames will get extensions @samp{.n}).
761 @itemx --force-directories
762 The opposite of @samp{-nd}---create a hierarchy of directories, even if
763 one would not have been created otherwise. E.g. @samp{wget -x
764 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
765 @file{fly.srk.fer.hr/robots.txt}.
768 @itemx --no-host-directories
769 Disable generation of host-prefixed directories. By default, invoking
770 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
771 directories beginning with @file{fly.srk.fer.hr/}. This option disables
774 @cindex cut directories
775 @item --cut-dirs=@var{number}
776 Ignore @var{number} directory components. This is useful for getting a
777 fine-grained control over the directory where recursive retrieval will
780 Take, for example, the directory at
781 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
782 @samp{-r}, it will be saved locally under
783 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
784 remove the @file{ftp.xemacs.org/} part, you are still stuck with
785 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
786 makes Wget not ``see'' @var{number} remote directory components. Here
787 are several examples of how @samp{--cut-dirs} option works.
791 No options -> ftp.xemacs.org/pub/xemacs/
793 -nH --cut-dirs=1 -> xemacs/
794 -nH --cut-dirs=2 -> .
796 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
801 If you just want to get rid of the directory structure, this option is
802 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
803 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
804 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
805 be placed to @file{xemacs/beta}, as one would expect.
807 @cindex directory prefix
808 @item -P @var{prefix}
809 @itemx --directory-prefix=@var{prefix}
810 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
811 directory where all other files and subdirectories will be saved to,
812 i.e. the top of the retrieval tree. The default is @samp{.} (the
816 @node HTTP Options, FTP Options, Directory Options, Invoking
817 @section HTTP Options
820 @cindex .html extension
822 @itemx --html-extension
823 If a file of type @samp{text/html} is downloaded and the URL does not
824 end with the regexp @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause
825 the suffix @samp{.html} to be appended to the local filename. This is
826 useful, for instance, when you're mirroring a remote site that uses
827 @samp{.asp} pages, but you want the mirrored pages to be viewable on
828 your stock Apache server. Another good use for this is when you're
829 downloading the output of CGIs. A URL like
830 @samp{http://site.com/article.cgi?25} will be saved as
831 @file{article.cgi?25.html}.
833 Note that filenames changed in this way will be re-downloaded every time
834 you re-mirror a site, because Wget can't tell that the local
835 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
836 it doesn't yet know that the URL produces output of type
837 @samp{text/html}. To prevent this re-downloading, you must use
838 @samp{-k} and @samp{-K} so that the original version of the file will be
839 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
842 @cindex http password
843 @cindex authentication
844 @item --http-user=@var{user}
845 @itemx --http-passwd=@var{password}
846 Specify the username @var{user} and password @var{password} on an
847 @sc{http} server. According to the type of the challenge, Wget will
848 encode them using either the @code{basic} (insecure) or the
849 @code{digest} authentication scheme.
851 Another way to specify username and password is in the @sc{url} itself
852 (@pxref{URL Format}). For more information about security issues with
853 Wget, @xref{Security Considerations}.
858 @itemx --cache=on/off
859 When set to off, disable server-side cache. In this case, Wget will
860 send the remote server an appropriate directive (@samp{Pragma:
861 no-cache}) to get the file from the remote service, rather than
862 returning the cached version. This is especially useful for retrieving
863 and flushing out-of-date documents on proxy servers.
865 Caching is allowed by default.
868 @item --cookies=on/off
869 When set to off, disable the use of cookies. Cookies are a mechanism
870 for maintaining server-side state. The server sends the client a cookie
871 using the @code{Set-Cookie} header, and the client responds with the
872 same cookie upon further requests. Since cookies allow the server
873 owners to keep track of visitors and for sites to exchange this
874 information, some consider them a breach of privacy. The default is to
875 use cookies; however, @emph{storing} cookies is not on by default.
877 @cindex loading cookies
878 @cindex cookies, loading
879 @item --load-cookies @var{file}
880 Load cookies from @var{file} before the first HTTP retrieval.
881 @var{file} is a textual file in the format originally used by Netscape's
882 @file{cookies.txt} file.
884 You will typically use this option when mirroring sites that require
885 that you be logged in to access some or all of their content. The login
886 process typically works by the web server issuing an @sc{http} cookie
887 upon receiving and verifying your credentials. The cookie is then
888 resent by the browser when accessing that part of the site, and so
889 proves your identity.
891 Mirroring such a site requires Wget to send the same cookies your
892 browser sends when communicating with the site. This is achieved by
893 @samp{--load-cookies}---simply point Wget to the location of the
894 @file{cookies.txt} file, and it will send the same cookies your browser
895 would send in the same situation. Different browsers keep textual
896 cookie files in different locations:
900 The cookies are in @file{~/.netscape/cookies.txt}.
902 @item Mozilla and Netscape 6.x.
903 Mozilla's cookie file is also named @file{cookies.txt}, located
904 somewhere under @file{~/.mozilla}, in the directory of your profile.
905 The full path usually ends up looking somewhat like
906 @file{~/.mozilla/default/@var{some-weird-string}/cookies.txt}.
908 @item Internet Explorer.
909 You can produce a cookie file Wget can use by using the File menu,
910 Import and Export, Export Cookies. This has been tested with Internet
911 Explorer 5; it is not guaranteed to work with earlier versions.
913 @item Other browsers.
914 If you are using a different browser to create your cookies,
915 @samp{--load-cookies} will only work if you can locate or produce a
916 cookie file in the Netscape format that Wget expects.
919 If you cannot use @samp{--load-cookies}, there might still be an
920 alternative. If your browser supports a ``cookie manager'', you can use
921 it to view the cookies used when accessing the site you're mirroring.
922 Write down the name and value of the cookie, and manually instruct Wget
923 to send those cookies, bypassing the ``official'' cookie support:
926 wget --cookies=off --header "Cookie: @var{name}=@var{value}"
929 @cindex saving cookies
930 @cindex cookies, saving
931 @item --save-cookies @var{file}
932 Save cookies from @var{file} at the end of session. Cookies whose
933 expiry time is not specified, or those that have already expired, are
936 @cindex Content-Length, ignore
937 @cindex ignore length
938 @item --ignore-length
939 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
940 precise) send out bogus @code{Content-Length} headers, which makes Wget
941 go wild, as it thinks not all the document was retrieved. You can spot
942 this syndrome if Wget retries getting the same document again and again,
943 each time claiming that the (otherwise normal) connection has closed on
946 With this option, Wget will ignore the @code{Content-Length} header---as
950 @item --header=@var{additional-header}
951 Define an @var{additional-header} to be passed to the @sc{http} servers.
952 Headers must contain a @samp{:} preceded by one or more non-blank
953 characters, and must not contain newlines.
955 You may define more than one additional header by specifying
956 @samp{--header} more than once.
960 wget --header='Accept-Charset: iso-8859-2' \
961 --header='Accept-Language: hr' \
962 http://fly.srk.fer.hr/
966 Specification of an empty string as the header value will clear all
967 previous user-defined headers.
970 @cindex proxy password
971 @cindex proxy authentication
972 @item --proxy-user=@var{user}
973 @itemx --proxy-passwd=@var{password}
974 Specify the username @var{user} and password @var{password} for
975 authentication on a proxy server. Wget will encode them using the
976 @code{basic} authentication scheme.
979 @cindex referer, http
980 @item --referer=@var{url}
981 Include `Referer: @var{url}' header in HTTP request. Useful for
982 retrieving documents with server-side processing that assume they are
983 always being retrieved by interactive web browsers and only come out
984 properly when Referer is set to one of the pages that point to them.
986 @cindex server response, save
988 @itemx --save-headers
989 Save the headers sent by the @sc{http} server to the file, preceding the
990 actual contents, with an empty line as the separator.
993 @item -U @var{agent-string}
994 @itemx --user-agent=@var{agent-string}
995 Identify as @var{agent-string} to the @sc{http} server.
997 The @sc{http} protocol allows the clients to identify themselves using a
998 @code{User-Agent} header field. This enables distinguishing the
999 @sc{www} software, usually for statistical purposes or for tracing of
1000 protocol violations. Wget normally identifies as
1001 @samp{Wget/@var{version}}, @var{version} being the current version
1004 However, some sites have been known to impose the policy of tailoring
1005 the output according to the @code{User-Agent}-supplied information.
1006 While conceptually this is not such a bad idea, it has been abused by
1007 servers denying information to clients other than @code{Mozilla} or
1008 Microsoft @code{Internet Explorer}. This option allows you to change
1009 the @code{User-Agent} line issued by Wget. Use of this option is
1010 discouraged, unless you really know what you are doing.
1013 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
1014 @section FTP Options
1017 @cindex .listing files, removing
1019 @itemx --dont-remove-listing
1020 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1021 retrievals. Normally, these files contain the raw directory listings
1022 received from @sc{ftp} servers. Not removing them can be useful for
1023 debugging purposes, or when you want to be able to easily check on the
1024 contents of remote server directories (e.g. to verify that a mirror
1025 you're running is complete).
1027 Note that even though Wget writes to a known filename for this file,
1028 this is not a security hole in the scenario of a user making
1029 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1030 asking @code{root} to run Wget in his or her directory. Depending on
1031 the options used, either Wget will refuse to write to @file{.listing},
1032 making the globbing/recursion/time-stamping operation fail, or the
1033 symbolic link will be deleted and replaced with the actual
1034 @file{.listing} file, or the listing will be written to a
1035 @file{.listing.@var{number}} file.
1037 Even though this situation isn't a problem, though, @code{root} should
1038 never run Wget in a non-trusted user's directory. A user could do
1039 something as simple as linking @file{index.html} to @file{/etc/passwd}
1040 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1041 will be overwritten.
1043 @cindex globbing, toggle
1045 @itemx --glob=on/off
1046 Turn @sc{ftp} globbing on or off. Globbing means you may use the
1047 shell-like special characters (@dfn{wildcards}), like @samp{*},
1048 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
1049 same directory at once, like:
1052 wget ftp://gnjilux.srk.fer.hr/*.msg
1055 By default, globbing will be turned on if the @sc{url} contains a
1056 globbing character. This option may be used to turn globbing on or off
1059 You may have to quote the @sc{url} to protect it from being expanded by
1060 your shell. Globbing makes Wget look for a directory listing, which is
1061 system-specific. This is why it currently works only with Unix @sc{ftp}
1062 servers (and the ones emulating Unix @code{ls} output).
1066 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
1067 initiates the data connection. This is sometimes required for @sc{ftp}
1068 to work behind firewalls.
1070 @cindex symbolic links, retrieving
1071 @item --retr-symlinks
1072 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1073 link is encountered, the linked-to file is not downloaded. Instead, a
1074 matching symbolic link is created on the local filesystem. The
1075 pointed-to file will not be downloaded unless this recursive retrieval
1076 would have encountered it separately and downloaded it anyway.
1078 When @samp{--retr-symlinks} is specified, however, symbolic links are
1079 traversed and the pointed-to files are retrieved. At this time, this
1080 option does not cause Wget to traverse symlinks to directories and
1081 recurse through them, but in the future it should be enhanced to do
1084 Note that when retrieving a file (not a directory) because it was
1085 specified on the commandline, rather than because it was recursed to,
1086 this option has no effect. Symbolic links are always traversed in this
1090 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
1091 @section Recursive Retrieval Options
1096 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
1099 @item -l @var{depth}
1100 @itemx --level=@var{depth}
1101 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1102 Retrieval}). The default maximum depth is 5.
1104 @cindex proxy filling
1105 @cindex delete after retrieval
1106 @cindex filling proxy cache
1107 @item --delete-after
1108 This option tells Wget to delete every single file it downloads,
1109 @emph{after} having done so. It is useful for pre-fetching popular
1110 pages through a proxy, e.g.:
1113 wget -r -nd --delete-after http://whatever.com/~popular/page/
1116 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1119 Note that @samp{--delete-after} deletes files on the local machine. It
1120 does not issue the @samp{DELE} command to remote FTP sites, for
1121 instance. Also note that when @samp{--delete-after} is specified,
1122 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1123 created in the first place.
1125 @cindex conversion of links
1126 @cindex link conversion
1128 @itemx --convert-links
1129 After the download is complete, convert the links in the document to
1130 make them suitable for local viewing. This affects not only the visible
1131 hyperlinks, but any part of the document that links to external content,
1132 such as embedded images, links to style sheets, hyperlinks to non-HTML
1135 Each link will be changed in one of the two ways:
1139 The links to files that have been downloaded by Wget will be changed to
1140 refer to the file they point to as a relative link.
1142 Example: if the downloaded file @file{/foo/doc.html} links to
1143 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1144 will be modified to point to @samp{../bar/img.gif}. This kind of
1145 transformation works reliably for arbitrary combinations of directories.
1148 The links to files that have not been downloaded by Wget will be changed
1149 to include host name and absolute path of the location they point to.
1151 Example: if the downloaded file @file{/foo/doc.html} links to
1152 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1153 @file{doc.html} will be modified to point to
1154 @file{http://@var{hostname}/bar/img.gif}.
1157 Because of this, local browsing works reliably: if a linked file was
1158 downloaded, the link will refer to its local name; if it was not
1159 downloaded, the link will refer to its full Internet address rather than
1160 presenting a broken link. The fact that the former links are converted
1161 to relative links ensures that you can move the downloaded hierarchy to
1164 Note that only at the end of the download can Wget know which links have
1165 been downloaded. Because of that, the work done by @samp{-k} will be
1166 performed at the end of all the downloads.
1168 @cindex backing up converted files
1170 @itemx --backup-converted
1171 When converting a file, back up the original version with a @samp{.orig}
1172 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1177 Turn on options suitable for mirroring. This option turns on recursion
1178 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1179 directory listings. It is currently equivalent to
1180 @samp{-r -N -l inf -nr}.
1182 @cindex page requisites
1183 @cindex required images, downloading
1185 @itemx --page-requisites
1186 This option causes Wget to download all the files that are necessary to
1187 properly display a given HTML page. This includes such things as
1188 inlined images, sounds, and referenced stylesheets.
1190 Ordinarily, when downloading a single HTML page, any requisite documents
1191 that may be needed to display it properly are not downloaded. Using
1192 @samp{-r} together with @samp{-l} can help, but since Wget does not
1193 ordinarily distinguish between external and inlined documents, one is
1194 generally left with ``leaf documents'' that are missing their
1197 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1198 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1199 document @file{2.html}. Say that @file{2.html} is similar but that its
1200 image is @file{2.gif} and it links to @file{3.html}. Say this
1201 continues up to some arbitrarily high number.
1203 If one executes the command:
1206 wget -r -l 2 http://@var{site}/1.html
1209 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1210 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1211 without its requisite @file{3.gif} because Wget is simply counting the
1212 number of hops (up to 2) away from @file{1.html} in order to determine
1213 where to stop the recursion. However, with this command:
1216 wget -r -l 2 -p http://@var{site}/1.html
1219 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1220 will be downloaded. Similarly,
1223 wget -r -l 1 -p http://@var{site}/1.html
1226 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1227 to be downloaded. One might think that:
1230 wget -r -l 0 -p http://@var{site}/1.html
1233 would download just @file{1.html} and @file{1.gif}, but unfortunately
1234 this is not the case, because @samp{-l 0} is equivalent to
1235 @samp{-l inf}---that is, infinite recursion. To download a single HTML
1236 page (or a handful of them, all specified on the commandline or in a
1237 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1238 @samp{-r} and @samp{-l}:
1241 wget -p http://@var{site}/1.html
1244 Note that Wget will behave as if @samp{-r} had been specified, but only
1245 that single page and its requisites will be downloaded. Links from that
1246 page to external documents will not be followed. Actually, to download
1247 a single page and all its requisites (even if they exist on separate
1248 websites), and make sure the lot displays properly locally, this author
1249 likes to use a few options in addition to @samp{-p}:
1252 wget -E -H -k -K -p http://@var{site}/@var{document}
1255 To finish off this topic, it's worth knowing that Wget's idea of an
1256 external document link is any URL specified in an @code{<A>} tag, an
1257 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1261 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1262 @section Recursive Accept/Reject Options
1265 @item -A @var{acclist} --accept @var{acclist}
1266 @itemx -R @var{rejlist} --reject @var{rejlist}
1267 Specify comma-separated lists of file name suffixes or patterns to
1268 accept or reject (@pxref{Types of Files} for more details).
1270 @item -D @var{domain-list}
1271 @itemx --domains=@var{domain-list}
1272 Set domains to be followed. @var{domain-list} is a comma-separated list
1273 of domains. Note that it does @emph{not} turn on @samp{-H}.
1275 @item --exclude-domains @var{domain-list}
1276 Specify the domains that are @emph{not} to be followed.
1277 (@pxref{Spanning Hosts}).
1279 @cindex follow FTP links
1281 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1282 Wget will ignore all the @sc{ftp} links.
1284 @cindex tag-based recursive pruning
1285 @item --follow-tags=@var{list}
1286 Wget has an internal table of HTML tag / attribute pairs that it
1287 considers when looking for linked documents during a recursive
1288 retrieval. If a user wants only a subset of those tags to be
1289 considered, however, he or she should be specify such tags in a
1290 comma-separated @var{list} with this option.
1293 @itemx --ignore-tags=@var{list}
1294 This is the opposite of the @samp{--follow-tags} option. To skip
1295 certain HTML tags when recursively looking for documents to download,
1296 specify them in a comma-separated @var{list}.
1298 In the past, the @samp{-G} option was the best bet for downloading a
1299 single page and its requisites, using a commandline like:
1302 wget -Ga,area -H -k -K -r http://@var{site}/@var{document}
1305 However, the author of this option came across a page with tags like
1306 @code{<LINK REL="home" HREF="/">} and came to the realization that
1307 @samp{-G} was not enough. One can't just tell Wget to ignore
1308 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1309 best bet for downloading a single page and its requisites is the
1310 dedicated @samp{--page-requisites} option.
1314 Enable spanning across hosts when doing recursive retrieving
1315 (@pxref{Spanning Hosts}).
1319 Follow relative links only. Useful for retrieving a specific home page
1320 without any distractions, not even those from the same hosts
1321 (@pxref{Relative Links}).
1324 @itemx --include-directories=@var{list}
1325 Specify a comma-separated list of directories you wish to follow when
1326 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1327 of @var{list} may contain wildcards.
1330 @itemx --exclude-directories=@var{list}
1331 Specify a comma-separated list of directories you wish to exclude from
1332 download (@pxref{Directory-Based Limits} for more details.) Elements of
1333 @var{list} may contain wildcards.
1337 Do not ever ascend to the parent directory when retrieving recursively.
1338 This is a useful option, since it guarantees that only the files
1339 @emph{below} a certain hierarchy will be downloaded.
1340 @xref{Directory-Based Limits}, for more details.
1345 @node Recursive Retrieval, Following Links, Invoking, Top
1346 @chapter Recursive Retrieval
1349 @cindex recursive retrieval
1351 GNU Wget is capable of traversing parts of the Web (or a single
1352 @sc{http} or @sc{ftp} server), following links and directory structure.
1353 We refer to this as to @dfn{recursive retrieving}, or @dfn{recursion}.
1355 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1356 the given @sc{url}, documents, retrieving the files the @sc{html}
1357 document was referring to, through markups like @code{href}, or
1358 @code{src}. If the freshly downloaded file is also of type
1359 @code{text/html}, it will be parsed and followed further.
1361 Recursive retrieval of @sc{http} and @sc{html} content is
1362 @dfn{breadth-first}. This means that Wget first downloads the requested
1363 HTML document, then the documents linked from that document, then the
1364 documents linked by them, and so on. In other words, Wget first
1365 downloads the documents at depth 1, then those at depth 2, and so on
1366 until the specified maximum depth.
1368 The maximum @dfn{depth} to which the retrieval may descend is specified
1369 with the @samp{-l} option. The default maximum depth is five layers.
1371 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1372 the data from the given directory tree (including the subdirectories up
1373 to the specified depth) on the remote server, creating its mirror image
1374 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1375 parameter. Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1378 By default, Wget will create a local directory tree, corresponding to
1379 the one found on the remote server.
1381 Recursive retrieving can find a number of applications, the most
1382 important of which is mirroring. It is also useful for @sc{www}
1383 presentations, and any other opportunities where slow network
1384 connections should be bypassed by storing the files locally.
1386 You should be warned that recursive downloads can overload the remote
1387 servers. Because of that, many administrators frown upon them and may
1388 ban access from your site if they detect very fast downloads of big
1389 amounts of content. When downloading from Internet servers, consider
1390 using the @samp{-w} option to introduce a delay between accesses to the
1391 server. The download will take a while longer, but the server
1392 administrator will not be alarmed by your rudeness.
1394 Of course, recursive download may cause problems on your machine. If
1395 left to run unchecked, it can easily fill up the disk. If downloading
1396 from local network, it can also take bandwidth on the system, as well as
1397 consume memory and CPU.
1399 Try to specify the criteria that match the kind of download you are
1400 trying to achieve. If you want to download only one page, use
1401 @samp{--page-requisites} without any additional recursion. If you want
1402 to download things under one directory, use @samp{-np} to avoid
1403 downloading things from other directories. If you want to download all
1404 the files from one directory, use @samp{-l 1} to make sure the recursion
1405 depth never exceeds one. @xref{Following Links}, for more information
1408 Recursive retrieval should be used with care. Don't say you were not
1411 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1412 @chapter Following Links
1414 @cindex following links
1416 When retrieving recursively, one does not wish to retrieve loads of
1417 unnecessary data. Most of the time the users bear in mind exactly what
1418 they want to download, and want Wget to follow only specific links.
1420 For example, if you wish to download the music archive from
1421 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1422 that happen to be referenced by an obscure part of the archive.
1424 Wget possesses several mechanisms that allows you to fine-tune which
1425 links it will follow.
1428 * Spanning Hosts:: (Un)limiting retrieval based on host name.
1429 * Types of Files:: Getting only certain files.
1430 * Directory-Based Limits:: Getting only certain directories.
1431 * Relative Links:: Follow relative links only.
1432 * FTP Links:: Following FTP links.
1435 @node Spanning Hosts, Types of Files, Following Links, Following Links
1436 @section Spanning Hosts
1437 @cindex spanning hosts
1438 @cindex hosts, spanning
1440 Wget's recursive retrieval normally refuses to visit hosts different
1441 than the one you specified on the command line. This is a reasonable
1442 default; without it, every retrieval would have the potential to turn
1443 your Wget into a small version of google.
1445 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1446 a useful option. Maybe the images are served from a different server.
1447 Maybe you're mirroring a site that consists of pages interlinked between
1448 three servers. Maybe the server has two equivalent names, and the HTML
1449 pages refer to both interchangeably.
1452 @item Span to any host---@samp{-H}
1454 The @samp{-H} option turns on host spanning, thus allowing Wget's
1455 recursive run to visit any host referenced by a link. Unless sufficient
1456 recursion-limiting criteria are applied depth, these foreign hosts will
1457 typically link to yet more hosts, and so on until Wget ends up sucking
1458 up much more data than you have intended.
1460 @item Limit spanning to certain domains---@samp{-D}
1462 The @samp{-D} option allows you to specify the domains that will be
1463 followed, thus limiting the recursion only to the hosts that belong to
1464 these domains. Obviously, this makes sense only in conjunction with
1465 @samp{-H}. A typical example would be downloading the contents of
1466 @samp{www.server.com}, but allowing downloads from
1467 @samp{images.server.com}, etc.:
1470 wget -rH -Dserver.com http://www.server.com/
1473 You can specify more than one address by separating them with a comma,
1474 e.g. @samp{-Ddomain1.com,domain2.com}.
1476 @item Keep download off certain domains---@samp{--exclude-domains}
1478 If there are domains you want to exclude specifically, you can do it
1479 with @samp{--exclude-domains}, which accepts the same type of arguments
1480 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1481 example, if you want to download all the hosts from @samp{foo.edu}
1482 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1486 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
1492 @node Types of Files, Directory-Based Limits, Spanning Hosts, Following Links
1493 @section Types of Files
1494 @cindex types of files
1496 When downloading material from the web, you will often want to restrict
1497 the retrieval to only certain file types. For example, if you are
1498 interested in downloading @sc{gif}s, you will not be overjoyed to get
1499 loads of PostScript documents, and vice versa.
1501 Wget offers two options to deal with this problem. Each option
1502 description lists a short name, a long name, and the equivalent command
1505 @cindex accept wildcards
1506 @cindex accept suffixes
1507 @cindex wildcards, accept
1508 @cindex suffixes, accept
1510 @item -A @var{acclist}
1511 @itemx --accept @var{acclist}
1512 @itemx accept = @var{acclist}
1513 The argument to @samp{--accept} option is a list of file suffixes or
1514 patterns that Wget will download during recursive retrieval. A suffix
1515 is the ending part of a file, and consists of ``normal'' letters,
1516 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1517 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1519 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1520 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1521 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1522 download only files beginning with @samp{zelazny} and containing numbers
1523 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1524 a description of how pattern matching works.
1526 Of course, any number of suffixes and patterns can be combined into a
1527 comma-separated list, and given as an argument to @samp{-A}.
1529 @cindex reject wildcards
1530 @cindex reject suffixes
1531 @cindex wildcards, reject
1532 @cindex suffixes, reject
1533 @item -R @var{rejlist}
1534 @itemx --reject @var{rejlist}
1535 @itemx reject = @var{rejlist}
1536 The @samp{--reject} option works the same way as @samp{--accept}, only
1537 its logic is the reverse; Wget will download all files @emph{except} the
1538 ones matching the suffixes (or patterns) in the list.
1540 So, if you want to download a whole page except for the cumbersome
1541 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1542 Analogously, to download all files except the ones beginning with
1543 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1544 expansion by the shell.
1547 The @samp{-A} and @samp{-R} options may be combined to achieve even
1548 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1549 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1550 a part of their name, but @emph{not} the PostScript files.
1552 Note that these two options do not affect the downloading of @sc{html}
1553 files; Wget must load all the @sc{html}s to know where to go at
1554 all---recursive retrieval would make no sense otherwise.
1556 @node Directory-Based Limits, Relative Links, Types of Files, Following Links
1557 @section Directory-Based Limits
1559 @cindex directory limits
1561 Regardless of other link-following facilities, it is often useful to
1562 place the restriction of what files to retrieve based on the directories
1563 those files are placed in. There can be many reasons for this---the
1564 home pages may be organized in a reasonable directory structure; or some
1565 directories may contain useless information, e.g. @file{/cgi-bin} or
1566 @file{/dev} directories.
1568 Wget offers three different options to deal with this requirement. Each
1569 option description lists a short name, a long name, and the equivalent
1570 command in @file{.wgetrc}.
1572 @cindex directories, include
1573 @cindex include directories
1574 @cindex accept directories
1577 @itemx --include @var{list}
1578 @itemx include_directories = @var{list}
1579 @samp{-I} option accepts a comma-separated list of directories included
1580 in the retrieval. Any other directories will simply be ignored. The
1581 directories are absolute paths.
1583 So, if you wish to download from @samp{http://host/people/bozo/}
1584 following only links to bozo's colleagues in the @file{/people}
1585 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1588 wget -I /people,/cgi-bin http://host/people/bozo/
1591 @cindex directories, exclude
1592 @cindex exclude directories
1593 @cindex reject directories
1595 @itemx --exclude @var{list}
1596 @itemx exclude_directories = @var{list}
1597 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1598 directories @emph{excluded} from the download. E.g. if you do not want
1599 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1600 /cgi-bin} on the command line.
1602 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1603 to get a better fine-tuning of downloading subdirectories. E.g. if you
1604 want to load all the files from @file{/pub} hierarchy except for
1605 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1610 @itemx no_parent = on
1611 The simplest, and often very useful way of limiting directories is
1612 disallowing retrieval of the links that refer to the hierarchy
1613 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1614 parent directory/directories.
1616 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1617 Using it guarantees that you will never leave the existing hierarchy.
1618 Supposing you issue Wget with:
1621 wget -r --no-parent http://somehost/~luzer/my-archive/
1624 You may rest assured that none of the references to
1625 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1626 followed. Only the archive you are interested in will be downloaded.
1627 Essentially, @samp{--no-parent} is similar to
1628 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1629 intelligent fashion.
1632 @node Relative Links, FTP Links, Directory-Based Limits, Following Links
1633 @section Relative Links
1634 @cindex relative links
1636 When @samp{-L} is turned on, only the relative links are ever followed.
1637 Relative links are here defined those that do not refer to the web
1638 server root. For example, these links are relative:
1642 <a href="foo/bar.gif">
1643 <a href="../foo/bar.gif">
1646 These links are not relative:
1650 <a href="/foo/bar.gif">
1651 <a href="http://www.server.com/foo/bar.gif">
1654 Using this option guarantees that recursive retrieval will not span
1655 hosts, even without @samp{-H}. In simple cases it also allows downloads
1656 to ``just work'' without having to convert links.
1658 This option is probably not very useful and might be removed in a future
1661 @node FTP Links, , Relative Links, Following Links
1662 @section Following FTP Links
1663 @cindex following ftp links
1665 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1666 them to be. @sc{ftp} links in @sc{html} documents are often included
1667 for purposes of reference, and it is often inconvenient to download them
1670 To have @sc{ftp} links followed from @sc{html} documents, you need to
1671 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1672 links will span hosts regardless of @samp{-H} setting. This is logical,
1673 as @sc{ftp} links rarely point to the same host where the @sc{http}
1674 server resides. For similar reasons, the @samp{-L} options has no
1675 effect on such downloads. On the other hand, domain acceptance
1676 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1678 Also note that followed links to @sc{ftp} directories will not be
1679 retrieved recursively further.
1681 @node Time-Stamping, Startup File, Following Links, Top
1682 @chapter Time-Stamping
1683 @cindex time-stamping
1684 @cindex timestamping
1685 @cindex updating the archives
1686 @cindex incremental updating
1688 One of the most important aspects of mirroring information from the
1689 Internet is updating your archives.
1691 Downloading the whole archive again and again, just to replace a few
1692 changed files is expensive, both in terms of wasted bandwidth and money,
1693 and the time to do the update. This is why all the mirroring tools
1694 offer the option of incremental updating.
1696 Such an updating mechanism means that the remote server is scanned in
1697 search of @dfn{new} files. Only those new files will be downloaded in
1698 the place of the old ones.
1700 A file is considered new if one of these two conditions are met:
1704 A file of that name does not already exist locally.
1707 A file of that name does exist, but the remote file was modified more
1708 recently than the local file.
1711 To implement this, the program needs to be aware of the time of last
1712 modification of both local and remote files. We call this information the
1713 @dfn{time-stamp} of a file.
1715 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1716 (@samp{-N}) option, or through @code{timestamping = on} directive in
1717 @file{.wgetrc}. With this option, for each file it intends to download,
1718 Wget will check whether a local file of the same name exists. If it
1719 does, and the remote file is older, Wget will not download it.
1721 If the local file does not exist, or the sizes of the files do not
1722 match, Wget will download the remote file no matter what the time-stamps
1726 * Time-Stamping Usage::
1727 * HTTP Time-Stamping Internals::
1728 * FTP Time-Stamping Internals::
1731 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1732 @section Time-Stamping Usage
1733 @cindex time-stamping usage
1734 @cindex usage, time-stamping
1736 The usage of time-stamping is simple. Say you would like to download a
1737 file so that it keeps its date of modification.
1740 wget -S http://www.gnu.ai.mit.edu/
1743 A simple @code{ls -l} shows that the time stamp on the local file equals
1744 the state of the @code{Last-Modified} header, as returned by the server.
1745 As you can see, the time-stamping info is preserved locally, even
1746 without @samp{-N} (at least for @sc{http}).
1748 Several days later, you would like Wget to check if the remote file has
1749 changed, and download it if it has.
1752 wget -N http://www.gnu.ai.mit.edu/
1755 Wget will ask the server for the last-modified date. If the local file
1756 has the same timestamp as the server, or a newer one, the remote file
1757 will not be re-fetched. However, if the remote file is more recent,
1758 Wget will proceed to fetch it.
1760 The same goes for @sc{ftp}. For example:
1763 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
1766 (The quotes around that URL are to prevent the shell from trying to
1767 interpret the @samp{*}.)
1769 After download, a local directory listing will show that the timestamps
1770 match those on the remote server. Reissuing the command with @samp{-N}
1771 will make Wget re-fetch @emph{only} the files that have been modified
1772 since the last download.
1774 If you wished to mirror the GNU archive every week, you would use a
1775 command like the following, weekly:
1778 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
1781 Note that time-stamping will only work for files for which the server
1782 gives a timestamp. For @sc{http}, this depends on getting a
1783 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
1784 directory listing with dates in a format that Wget can parse
1785 (@pxref{FTP Time-Stamping Internals}).
1787 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1788 @section HTTP Time-Stamping Internals
1789 @cindex http time-stamping
1791 Time-stamping in @sc{http} is implemented by checking of the
1792 @code{Last-Modified} header. If you wish to retrieve the file
1793 @file{foo.html} through @sc{http}, Wget will check whether
1794 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1795 retrieved unconditionally.
1797 If the file does exist locally, Wget will first check its local
1798 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1799 @code{HEAD} request to the remote server, demanding the information on
1802 The @code{Last-Modified} header is examined to find which file was
1803 modified more recently (which makes it ``newer''). If the remote file
1804 is newer, it will be downloaded; if it is older, Wget will give
1805 up.@footnote{As an additional check, Wget will look at the
1806 @code{Content-Length} header, and compare the sizes; if they are not the
1807 same, the remote file will be downloaded no matter what the time-stamp
1810 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1811 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1812 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1813 @samp{@var{X}}, which will always differ if it's been converted by
1814 @samp{--convert-links} (@samp{-k}).
1816 Arguably, @sc{http} time-stamping should be implemented using the
1817 @code{If-Modified-Since} request.
1819 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1820 @section FTP Time-Stamping Internals
1821 @cindex ftp time-stamping
1823 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1824 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
1827 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
1828 @sc{ftp} @code{LIST} command to get a file listing for the directory
1829 containing the desired file(s). It will try to analyze the listing,
1830 treating it like Unix @code{ls -l} output, extracting the time-stamps.
1831 The rest is exactly the same as for @sc{http}. Note that when
1832 retrieving individual files from an @sc{ftp} server without using
1833 globbing or recursion, listing files will not be downloaded (and thus
1834 files will not be time-stamped) unless @samp{-N} is specified.
1836 Assumption that every directory listing is a Unix-style listing may
1837 sound extremely constraining, but in practice it is not, as many
1838 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1839 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1840 defines no standard way to get a file list, let alone the time-stamps.
1841 We can only hope that a future standard will define this.
1843 Another non-standard solution includes the use of @code{MDTM} command
1844 that is supported by some @sc{ftp} servers (including the popular
1845 @code{wu-ftpd}), which returns the exact time of the specified file.
1846 Wget may support this command in the future.
1848 @node Startup File, Examples, Time-Stamping, Top
1849 @chapter Startup File
1850 @cindex startup file
1856 Once you know how to change default settings of Wget through command
1857 line arguments, you may wish to make some of those settings permanent.
1858 You can do that in a convenient way by creating the Wget startup
1859 file---@file{.wgetrc}.
1861 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1862 convenient to have a special facility for storing passwords. Thus Wget
1863 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1864 it. You can find @file{.netrc} format in your system manuals.
1866 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1870 * Wgetrc Location:: Location of various wgetrc files.
1871 * Wgetrc Syntax:: Syntax of wgetrc.
1872 * Wgetrc Commands:: List of available commands.
1873 * Sample Wgetrc:: A wgetrc example.
1876 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1877 @section Wgetrc Location
1878 @cindex wgetrc location
1879 @cindex location of wgetrc
1881 When initializing, Wget will look for a @dfn{global} startup file,
1882 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1883 @file{/usr/local}, if Wget was not installed there) and read commands
1884 from there, if it exists.
1886 Then it will look for the user's file. If the environmental variable
1887 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1888 further attempts will be made.
1890 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1892 The fact that user's settings are loaded after the system-wide ones
1893 means that in case of collision user's wgetrc @emph{overrides} the
1894 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1895 Fascist admins, away!
1897 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1898 @section Wgetrc Syntax
1899 @cindex wgetrc syntax
1900 @cindex syntax of wgetrc
1902 The syntax of a wgetrc command is simple:
1908 The @dfn{variable} will also be called @dfn{command}. Valid
1909 @dfn{values} are different for different commands.
1911 The commands are case-insensitive and underscore-insensitive. Thus
1912 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1913 beginning with @samp{#} and lines containing white-space only are
1916 Commands that expect a comma-separated list will clear the list on an
1917 empty command. So, if you wish to reset the rejection list specified in
1918 global @file{wgetrc}, you can do it with:
1924 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1925 @section Wgetrc Commands
1926 @cindex wgetrc commands
1928 The complete set of commands is listed below. Legal values are listed
1929 after the @samp{=}. Simple Boolean values can be set or unset using
1930 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
1931 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
1932 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
1933 option is set to @samp{always} or @samp{never}, that value will be
1934 locked in for the duration of the Wget invocation---commandline options
1937 Some commands take pseudo-arbitrary values. @var{address} values can be
1938 hostnames or dotted-quad IP addresses. @var{n} can be any positive
1939 integer, or @samp{inf} for infinity, where appropriate. @var{string}
1940 values can be any non-empty string.
1942 Most of these commands have commandline equivalents (@pxref{Invoking}),
1943 though some of the more obscure or rarely used ones do not.
1946 @item accept/reject = @var{string}
1947 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
1949 @item add_hostdir = on/off
1950 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1952 @item continue = on/off
1953 If set to on, force continuation of preexistent partially retrieved
1954 files. See @samp{-c} before setting it.
1956 @item background = on/off
1957 Enable/disable going to background---the same as @samp{-b} (which
1960 @item backup_converted = on/off
1961 Enable/disable saving pre-converted files with the suffix
1962 @samp{.orig}---the same as @samp{-K} (which enables it).
1964 @c @item backups = @var{number}
1965 @c #### Document me!
1967 @item base = @var{string}
1968 Consider relative @sc{url}s in @sc{url} input files forced to be
1969 interpreted as @sc{html} as being relative to @var{string}---the same as
1972 @item bind_address = @var{address}
1973 Bind to @var{address}, like the @samp{--bind-address} option.
1975 @item cache = on/off
1976 When set to off, disallow server-caching. See the @samp{-C} option.
1978 @item convert links = on/off
1979 Convert non-relative links locally. The same as @samp{-k}.
1981 @item cookies = on/off
1982 When set to off, disallow cookies. See the @samp{--cookies} option.
1984 @item load_cookies = @var{file}
1985 Load cookies from @var{file}. See @samp{--load-cookies}.
1987 @item save_cookies = @var{file}
1988 Save cookies to @var{file}. See @samp{--save-cookies}.
1990 @item cut_dirs = @var{n}
1991 Ignore @var{n} remote directory components.
1993 @item debug = on/off
1994 Debug mode, same as @samp{-d}.
1996 @item delete_after = on/off
1997 Delete after download---the same as @samp{--delete-after}.
1999 @item dir_prefix = @var{string}
2000 Top of directory tree---the same as @samp{-P}.
2002 @item dirstruct = on/off
2003 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2006 @item domains = @var{string}
2007 Same as @samp{-D} (@pxref{Spanning Hosts}).
2009 @item dot_bytes = @var{n}
2010 Specify the number of bytes ``contained'' in a dot, as seen throughout
2011 the retrieval (1024 by default). You can postfix the value with
2012 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2013 respectively. With dot settings you can tailor the dot retrieval to
2014 suit your needs, or you can use the predefined @dfn{styles}
2015 (@pxref{Download Options}).
2017 @item dots_in_line = @var{n}
2018 Specify the number of dots that will be printed in each line throughout
2019 the retrieval (50 by default).
2021 @item dot_spacing = @var{n}
2022 Specify the number of dots in a single cluster (10 by default).
2024 @item exclude_directories = @var{string}
2025 Specify a comma-separated list of directories you wish to exclude from
2026 download---the same as @samp{-X} (@pxref{Directory-Based Limits}).
2028 @item exclude_domains = @var{string}
2029 Same as @samp{--exclude-domains} (@pxref{Spanning Hosts}).
2031 @item follow_ftp = on/off
2032 Follow @sc{ftp} links from @sc{html} documents---the same as
2033 @samp{--follow-ftp}.
2035 @item follow_tags = @var{string}
2036 Only follow certain HTML tags when doing a recursive retrieval, just like
2037 @samp{--follow-tags}.
2039 @item force_html = on/off
2040 If set to on, force the input filename to be regarded as an @sc{html}
2041 document---the same as @samp{-F}.
2043 @item ftp_proxy = @var{string}
2044 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2048 Turn globbing on/off---the same as @samp{-g}.
2050 @item header = @var{string}
2051 Define an additional header, like @samp{--header}.
2053 @item html_extension = on/off
2054 Add a @samp{.html} extension to @samp{text/html} files without it, like
2057 @item http_passwd = @var{string}
2058 Set @sc{http} password.
2060 @item http_proxy = @var{string}
2061 Use @var{string} as @sc{http} proxy, instead of the one specified in
2064 @item http_user = @var{string}
2065 Set @sc{http} user to @var{string}.
2067 @item ignore_length = on/off
2068 When set to on, ignore @code{Content-Length} header; the same as
2069 @samp{--ignore-length}.
2071 @item ignore_tags = @var{string}
2072 Ignore certain HTML tags when doing a recursive retrieval, just like
2073 @samp{-G} / @samp{--ignore-tags}.
2075 @item include_directories = @var{string}
2076 Specify a comma-separated list of directories you wish to follow when
2077 downloading---the same as @samp{-I}.
2079 @item input = @var{string}
2080 Read the @sc{url}s from @var{string}, like @samp{-i}.
2082 @item kill_longer = on/off
2083 Consider data longer than specified in content-length header as invalid
2084 (and retry getting it). The default behaviour is to save as much data
2085 as there is, provided there is more than or equal to the value in
2086 @code{Content-Length}.
2088 @item logfile = @var{string}
2089 Set logfile---the same as @samp{-o}.
2091 @item login = @var{string}
2092 Your user name on the remote machine, for @sc{ftp}. Defaults to
2095 @item mirror = on/off
2096 Turn mirroring on/off. The same as @samp{-m}.
2098 @item netrc = on/off
2099 Turn reading netrc on or off.
2101 @item noclobber = on/off
2104 @item no_parent = on/off
2105 Disallow retrieving outside the directory hierarchy, like
2106 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2108 @item no_proxy = @var{string}
2109 Use @var{string} as the comma-separated list of domains to avoid in
2110 proxy loading, instead of the one specified in environment.
2112 @item output_document = @var{string}
2113 Set the output filename---the same as @samp{-O}.
2115 @item page_requisites = on/off
2116 Download all ancillary documents necessary for a single HTML page to
2117 display properly---the same as @samp{-p}.
2119 @item passive_ftp = on/off/always/never
2120 Set passive @sc{ftp}---the same as @samp{--passive-ftp}. Some scripts
2121 and @samp{.pm} (Perl module) files download files using @samp{wget
2122 --passive-ftp}. If your firewall does not allow this, you can set
2123 @samp{passive_ftp = never} to override the commandline.
2125 @item passwd = @var{string}
2126 Set your @sc{ftp} password to @var{password}. Without this setting, the
2127 password defaults to @samp{username@@hostname.domainname}.
2129 @item progress = @var{string}
2130 Set the type of the progress indicator. Legal types are ``dot'' and
2133 @item proxy_user = @var{string}
2134 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
2136 @item proxy_passwd = @var{string}
2137 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
2139 @item referer = @var{string}
2140 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
2141 was the folks who wrote the @sc{http} spec who got the spelling of
2142 ``referrer'' wrong.)
2144 @item quiet = on/off
2145 Quiet mode---the same as @samp{-q}.
2147 @item quota = @var{quota}
2148 Specify the download quota, which is useful to put in the global
2149 @file{wgetrc}. When download quota is specified, Wget will stop
2150 retrieving after the download sum has become greater than quota. The
2151 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2152 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2153 to 5 mbytes. Note that the user's startup file overrides system
2156 @item reclevel = @var{n}
2157 Recursion level---the same as @samp{-l}.
2159 @item recursive = on/off
2160 Recursive on/off---the same as @samp{-r}.
2162 @item relative_only = on/off
2163 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2166 @item remove_listing = on/off
2167 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2168 to off is the same as @samp{-nr}.
2170 @item retr_symlinks = on/off
2171 When set to on, retrieve symbolic links as if they were plain files; the
2172 same as @samp{--retr-symlinks}.
2174 @item robots = on/off
2175 Use (or not) @file{/robots.txt} file (@pxref{Robots}). Be sure to know
2176 what you are doing before changing the default (which is @samp{on}).
2178 @item server_response = on/off
2179 Choose whether or not to print the @sc{http} and @sc{ftp} server
2180 responses---the same as @samp{-S}.
2182 @item simple_host_check = on/off
2183 Same as @samp{-nh} (@pxref{Spanning Hosts}).
2185 @item span_hosts = on/off
2188 @item timeout = @var{n}
2189 Set timeout value---the same as @samp{-T}.
2191 @item timestamping = on/off
2192 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2194 @item tries = @var{n}
2195 Set number of retries per @sc{url}---the same as @samp{-t}.
2197 @item use_proxy = on/off
2198 Turn proxy support on/off. The same as @samp{-Y}.
2200 @item verbose = on/off
2201 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2203 @item wait = @var{n}
2204 Wait @var{n} seconds between retrievals---the same as @samp{-w}.
2206 @item waitretry = @var{n}
2207 Wait up to @var{n} seconds between retries of failed retrievals
2208 only---the same as @samp{--waitretry}. Note that this is turned on by
2209 default in the global @file{wgetrc}.
2211 @item randomwait = on/off
2212 Turn random between-request wait times on or off. The same as
2213 @samp{--random-wait}.
2216 @node Sample Wgetrc, , Wgetrc Commands, Startup File
2217 @section Sample Wgetrc
2218 @cindex sample wgetrc
2220 This is the sample initialization file, as given in the distribution.
2221 It is divided in two section---one for global usage (suitable for global
2222 startup file), and one for local usage (suitable for
2223 @file{$HOME/.wgetrc}). Be careful about the things you change.
2225 Note that almost all the lines are commented out. For a command to have
2226 any effect, you must remove the @samp{#} character at the beginning of
2230 @include sample.wgetrc.munged_for_texi_inclusion
2233 @node Examples, Various, Startup File, Top
2237 @c man begin EXAMPLES
2238 The examples are divided into three sections loosely based on their
2242 * Simple Usage:: Simple, basic usage of the program.
2243 * Advanced Usage:: Advanced tips.
2244 * Very Advanced Usage:: The hairy stuff.
2247 @node Simple Usage, Advanced Usage, Examples, Examples
2248 @section Simple Usage
2252 Say you want to download a @sc{url}. Just type:
2255 wget http://fly.srk.fer.hr/
2259 But what will happen if the connection is slow, and the file is lengthy?
2260 The connection will probably fail before the whole file is retrieved,
2261 more than once. In this case, Wget will try getting the file until it
2262 either gets the whole of it, or exceeds the default number of retries
2263 (this being 20). It is easy to change the number of tries to 45, to
2264 insure that the whole file will arrive safely:
2267 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2271 Now let's leave Wget to work in the background, and write its progress
2272 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2273 shall use @samp{-t}.
2276 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2279 The ampersand at the end of the line makes sure that Wget works in the
2280 background. To unlimit the number of retries, use @samp{-t inf}.
2283 The usage of @sc{ftp} is as simple. Wget will take care of login and
2287 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2291 If you specify a directory, Wget will retrieve the directory listing,
2292 parse it and convert it to @sc{html}. Try:
2295 wget ftp://prep.ai.mit.edu/pub/gnu/
2300 @node Advanced Usage, Very Advanced Usage, Simple Usage, Examples
2301 @section Advanced Usage
2305 You have a file that contains the URLs you want to download? Use the
2312 If you specify @samp{-} as file name, the @sc{url}s will be read from
2316 Create a five levels deep mirror image of the GNU web site, with the
2317 same directory structure the original has, with only one try per
2318 document, saving the log of the activities to @file{gnulog}:
2321 wget -r http://www.gnu.org/ -o gnulog
2325 The same as the above, but convert the links in the @sc{html} files to
2326 point to local files, so you can view the documents off-line:
2329 wget --convert-links -r http://www.gnu.org/ -o gnulog
2333 Retrieve only one HTML page, but make sure that all the elements needed
2334 for the page to be displayed, such as inline images and external style
2335 sheets, are also downloaded. Also make sure the downloaded page
2336 references the downloaded links.
2339 wget -p --convert-links http://www.server.com/dir/page.html
2342 The HTML page will be saved to @file{www.server.com/dir/page.html}, and
2343 the images, stylesheets, etc., somewhere under @file{www.server.com/},
2344 depending on where they were on the remote server.
2347 The same as the above, but without the @file{www.server.com/} directory.
2348 In fact, I don't want to have all those random server directories
2349 anyway---just save @emph{all} those files under a @file{download/}
2350 subdirectory of the current directory.
2353 wget -p --convert-links -nH -nd -Pdownload \
2354 http://www.server.com/dir/page.html
2358 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2362 wget -S http://www.lycos.com/
2366 Save the server headers with the file, perhaps for post-processing.
2369 wget -s http://www.lycos.com/
2374 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2378 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
2382 You want to download all the @sc{gif}s from a directory on an @sc{http}
2383 server. You tried @samp{wget http://www.server.com/dir/*.gif}, but that
2384 didn't work because @sc{http} retrieval does not support globbing. In
2388 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
2391 More verbose, but the effect is the same. @samp{-r -l1} means to
2392 retrieve recursively (@pxref{Recursive Retrieval}), with maximum depth
2393 of 1. @samp{--no-parent} means that references to the parent directory
2394 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2395 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2399 Suppose you were in the middle of downloading, when Wget was
2400 interrupted. Now you do not want to clobber the files already present.
2404 wget -nc -r http://www.gnu.org/
2408 If you want to encode your own username and password to @sc{http} or
2409 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2412 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
2415 @cindex redirecting output
2417 You would like the output documents to go to standard output instead of
2421 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2424 You can also combine the two options and make pipelines to retrieve the
2425 documents from remote hotlists:
2428 wget -O - http://cool.list.com/ | wget --force-html -i -
2432 @node Very Advanced Usage, , Advanced Usage, Examples
2433 @section Very Advanced Usage
2438 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2439 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2440 for @samp{-r -l inf -N}. You can put Wget in the crontab file asking it
2441 to recheck a site each Sunday:
2445 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
2449 In addition to the above, you want the links to be converted for local
2450 viewing. But, after having read this manual, you know that link
2451 conversion doesn't play well with timestamping, so you also want Wget to
2452 back up the original HTML files before the conversion. Wget invocation
2453 would look like this:
2456 wget --mirror --convert-links --backup-converted \
2457 http://www.gnu.org/ -o /home/me/weeklog
2461 But you've also noticed that local viewing doesn't work all that well
2462 when HTML files are saved under extensions other than @samp{.html},
2463 perhaps because they were served as @file{index.cgi}. So you'd like
2464 Wget to rename all the files served with content-type @samp{text/html}
2465 to @file{@var{name}.html}.
2468 wget --mirror --convert-links --backup-converted \
2469 --html-extension -o /home/me/weeklog \
2473 Or, with less typing:
2476 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
2481 @node Various, Appendices, Examples, Top
2485 This chapter contains all the stuff that could not fit anywhere else.
2488 * Proxies:: Support for proxy servers
2489 * Distribution:: Getting the latest version.
2490 * Mailing List:: Wget mailing list for announcements and discussion.
2491 * Reporting Bugs:: How and where to report bugs.
2492 * Portability:: The systems Wget works on.
2493 * Signals:: Signal-handling performed by Wget.
2496 @node Proxies, Distribution, Various, Various
2500 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2501 data from remote servers to local clients. One typical use of proxies
2502 is lightening network load for users behind a slow connection. This is
2503 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2504 proxy which caches the transferred data. When a cached resource is
2505 requested again, proxy will return the data from cache. Another use for
2506 proxies is for companies that separate (for security reasons) their
2507 internal networks from the rest of Internet. In order to obtain
2508 information from the Web, their users connect and retrieve remote data
2509 using an authorized proxy.
2511 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2512 standard way to specify proxy location, which Wget recognizes, is using
2513 the following environment variables:
2517 This variable should contain the @sc{url} of the proxy for @sc{http}
2521 This variable should contain the @sc{url} of the proxy for @sc{ftp}
2522 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2523 are set to the same @sc{url}.
2526 This variable should contain a comma-separated list of domain extensions
2527 proxy should @emph{not} be used for. For instance, if the value of
2528 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2532 In addition to the environment variables, proxy location and settings
2533 may be specified from within Wget itself.
2537 @itemx --proxy=on/off
2538 @itemx proxy = on/off
2539 This option may be used to turn the proxy support on or off. Proxy
2540 support is on by default, provided that the appropriate environment
2543 @item http_proxy = @var{URL}
2544 @itemx ftp_proxy = @var{URL}
2545 @itemx no_proxy = @var{string}
2546 These startup file variables allow you to override the proxy settings
2547 specified by the environment.
2550 Some proxy servers require authorization to enable you to use them. The
2551 authorization consists of @dfn{username} and @dfn{password}, which must
2552 be sent by Wget. As with @sc{http} authorization, several
2553 authentication schemes exist. For proxy authorization only the
2554 @code{Basic} authentication scheme is currently implemented.
2556 You may specify your username and password either through the proxy
2557 @sc{url} or through the command-line options. Assuming that the
2558 company's proxy is located at @samp{proxy.company.com} at port 8001, a
2559 proxy @sc{url} location containing authorization data might look like
2563 http://hniksic:mypassword@@proxy.company.com:8001/
2566 Alternatively, you may use the @samp{proxy-user} and
2567 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2568 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2569 username and password.
2571 @node Distribution, Mailing List, Proxies, Various
2572 @section Distribution
2573 @cindex latest version
2575 Like all GNU utilities, the latest version of Wget can be found at the
2576 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2577 Wget @value{VERSION} can be found at
2578 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2580 @node Mailing List, Reporting Bugs, Distribution, Various
2581 @section Mailing List
2582 @cindex mailing list
2585 Wget has its own mailing list at @email{wget@@sunsite.dk}, thanks
2586 to Karsten Thygesen. The mailing list is for discussion of Wget
2587 features and web, reporting Wget bugs (those that you think may be of
2588 interest to the public) and mailing announcements. You are welcome to
2589 subscribe. The more people on the list, the better!
2591 To subscribe, send mail to @email{wget-subscribe@@sunsite.dk}.
2592 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2593 mailing to @email{wget-unsubscribe@@sunsite.dk}.
2595 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2596 Alternative archive is available at
2597 @url{http://www.mail-archive.com/wget%40sunsite.auc.dk/}.
2599 @node Reporting Bugs, Portability, Mailing List, Various
2600 @section Reporting Bugs
2602 @cindex reporting bugs
2606 You are welcome to send bug reports about GNU Wget to
2607 @email{bug-wget@@gnu.org}.
2609 Before actually submitting a bug report, please try to follow a few
2614 Please try to ascertain that the behaviour you see really is a bug. If
2615 Wget crashes, it's a bug. If Wget does not behave as documented,
2616 it's a bug. If things work strange, but you are not sure about the way
2617 they are supposed to work, it might well be a bug.
2620 Try to repeat the bug in as simple circumstances as possible. E.g. if
2621 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
2622 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
2623 repeatable, and if will occur with a simpler set of options. You might
2624 even try to start the download at the page where the crash occurred to
2625 see if that page somehow triggered the crash.
2627 Also, while I will probably be interested to know the contents of your
2628 @file{.wgetrc} file, just dumping it into the debug message is probably
2629 a bad idea. Instead, you should first try to see if the bug repeats
2630 with @file{.wgetrc} moved out of the way. Only if it turns out that
2631 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
2635 Please start Wget with @samp{-d} option and send the log (or the
2636 relevant parts of it). If Wget was compiled without debug support,
2637 recompile it. It is @emph{much} easier to trace bugs with debug support
2641 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2642 wget` core} and type @code{where} to get the backtrace.
2646 @node Portability, Signals, Reporting Bugs, Various
2647 @section Portability
2649 @cindex operating systems
2651 Since Wget uses GNU Autoconf for building and configuring, and avoids
2652 using ``special'' ultra--mega--cool features of any particular Unix, it
2653 should compile (and work) on all common Unix flavors.
2655 Various Wget versions have been compiled and tested under many kinds of
2656 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2657 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2658 distribution directory for a comprehensive list. If you compile it on
2659 an architecture not listed there, please let me know so I can update it.
2661 Wget should also compile on the other Unix systems, not listed in
2662 @file{MACHINES}. If it doesn't, please let me know.
2664 Thanks to kind contributors, this version of Wget compiles and works on
2665 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2666 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2667 with Winsock as networking software. Naturally, it is crippled of some
2668 features available on Unix, but it should work as a substitute for
2669 people stuck with Windows. Note that the Windows port is
2670 @strong{neither tested nor maintained} by me---all questions and
2671 problems should be reported to Wget mailing list at
2672 @email{wget@@sunsite.dk} where the maintainers will look at them.
2674 @node Signals, , Portability, Various
2676 @cindex signal handling
2679 Since the purpose of Wget is background work, it catches the hangup
2680 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2681 output, it will be redirected to a file named @file{wget-log}.
2682 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2683 to redirect the output of Wget after having started it.
2686 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2687 $ kill -HUP %% # Redirect the output to wget-log
2690 Other than that, Wget will not try to interfere with signals in any way.
2691 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
2693 @node Appendices, Copying, Various, Top
2696 This chapter contains some references I consider useful.
2699 * Robots:: Wget as a WWW robot.
2700 * Security Considerations:: Security with Wget.
2701 * Contributors:: People who helped.
2704 @node Robots, Security Considerations, Appendices, Appendices
2708 @cindex server maintenance
2710 It is extremely easy to make Wget wander aimlessly around a web site,
2711 sucking all the available data in progress. @samp{wget -r @var{site}},
2712 and you're set. Great? Not for the server admin.
2714 While Wget is retrieving static pages, there's not much of a problem.
2715 But for Wget, there is no real difference between a static page and the
2716 most demanding CGI. For instance, a site I know has a section handled
2717 by an, uh, @dfn{bitchin'} CGI script that converts all the Info files to
2718 HTML. The script can and does bring the machine to its knees without
2719 providing anything useful to the downloader.
2721 For such and similar cases various robot exclusion schemes have been
2722 devised as a means for the server administrators and document authors to
2723 protect chosen portions of their sites from the wandering of robots.
2725 The more popular mechanism is the @dfn{Robots Exclusion Standard}, or
2726 @sc{res}, written by Martijn Koster et al. in 1994. It specifies the
2727 format of a text file containing directives that instruct the robots
2728 which URL paths to avoid. To be found by the robots, the specifications
2729 must be placed in @file{/robots.txt} in the server root, which the
2730 robots are supposed to download and parse.
2732 Wget supports @sc{res} when downloading recursively. So, when you
2736 wget -r http://www.server.com/
2739 First the index of @samp{www.server.com} will be downloaded. If Wget
2740 finds that it wants to download more documents from that server, it will
2741 request @samp{http://www.server.com/robots.txt} and, if found, use it
2742 for further downloads. @file{robots.txt} is loaded only once per each
2745 Until version 1.8, Wget supported the first version of the standard,
2746 written by Martijn Koster in 1994 and available at
2747 @url{http://www.robotstxt.org/wc/norobots.html}. As of version 1.8,
2748 Wget has supported the additional directives specified in the internet
2749 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
2750 Robots Control''. The draft, which has as far as I know never made to
2751 an @sc{rfc}, is available at
2752 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
2754 This manual no longer includes the text of the Robot Exclusion Standard.
2756 The second, less known mechanism, enables the author of an individual
2757 document to specify whether they want the links from the file to be
2758 followed by a robot. This is achieved using the @code{META} tag, like
2762 <meta name="robots" content="nofollow">
2765 This is explained in some detail at
2766 @url{http://www.robotstxt.org/wc/meta-user.html}. Wget supports this
2767 method of robot exclusion in addition to the usual @file{/robots.txt}
2770 @node Security Considerations, Contributors, Robots, Appendices
2771 @section Security Considerations
2774 When using Wget, you must be aware that it sends unencrypted passwords
2775 through the network, which may present a security problem. Here are the
2776 main issues, and some solutions.
2780 The passwords on the command line are visible using @code{ps}. If this
2781 is a problem, avoid putting passwords from the command line---e.g. you
2782 can use @file{.netrc} for this.
2785 Using the insecure @dfn{basic} authentication scheme, unencrypted
2786 passwords are transmitted through the network routers and gateways.
2789 The @sc{ftp} passwords are also in no way encrypted. There is no good
2790 solution for this at the moment.
2793 Although the ``normal'' output of Wget tries to hide the passwords,
2794 debugging logs show them, in all forms. This problem is avoided by
2795 being careful when you send debug logs (yes, even when you send them to
2799 @node Contributors, , Security Considerations, Appendices
2800 @section Contributors
2801 @cindex contributors
2804 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
2807 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
2809 However, its development could never have gone as far as it has, were it
2810 not for the help of many people, either with bug reports, feature
2811 proposals, patches, or letters saying ``Thanks!''.
2813 Special thanks goes to the following people (no particular order):
2817 Karsten Thygesen---donated system resources such as the mailing list,
2818 web space, and @sc{ftp} space, along with a lot of time to make these
2822 Shawn McHorse---bug reports and patches.
2825 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
2829 Gordon Matzigkeit---@file{.netrc} support.
2833 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2834 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2837 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2838 and ``philosophical'' discussions.
2842 Darko Budor---initial port to Windows.
2845 Antonio Rosella---help and suggestions, plus the Italian translation.
2849 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2853 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2858 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2861 Francois Pinard---many thorough bug reports and discussions.
2865 Karl Eichwalder---lots of help with internationalization and other
2869 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2873 The people who provided donations for development, including Brian
2877 The following people have provided patches, bug/build reports, useful
2878 suggestions, beta testing services, fan mail and all the other things
2879 that make maintenance so much fun:
2898 Kristijan @v{C}onka@v{s},
2916 Aleksandar Erkalovi@'{c},
2919 Aleksandar Erkalovic,
2935 Erik Magnus Hulthen,
2953 Goran Kezunovi@'{c},
2964 $\Sigma\acute{\iota}\mu o\varsigma\;
2965 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
2966 (Simos KSenitellis),
2974 Nicol@'{a}s Lichtmeier,
2980 Alexander V. Lukyanov,
3005 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3007 Juan Jos\'{e} Rodr\'{\i}gues,
3010 Juan Jose Rodrigues,
3022 Szakacsits Szabolcs,
3028 Douglas E. Wegscheid,
3038 Apologies to all who I accidentally left out, and many thanks to all the
3039 subscribers of the Wget mailing list.
3041 @node Copying, Concept Index, Appendices, Top
3046 @cindex free software
3048 GNU Wget is licensed under the GNU GPL, which makes it @dfn{free
3051 Please note that ``free'' in ``free software'' refers to liberty, not
3052 price. As some GNU project advocates like to point out, think of ``free
3053 speech'' rather than ``free beer''. The exact and legally binding
3054 distribution terms are spelled out below; in short, you have the right
3055 (freedom) to run and change Wget and distribute it to other people, and
3056 even---if you want---charge money for doing either. The important
3057 restriction is that you have to grant your recipients the same rights
3058 and impose the same restrictions.
3060 This method of licensing software is also known as @dfn{open source}
3061 because, among other things, it makes sure that all recipients will
3062 receive the source code along with the program, and be able to improve
3063 it. The GNU project prefers the term ``free software'' for reasons
3065 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3067 The exact license terms are defined by this paragraph and the GNU
3068 General Public License it refers to:
3071 GNU Wget is free software; you can redistribute it and/or modify it
3072 under the terms of the GNU General Public License as published by the
3073 Free Software Foundation; either version 2 of the License, or (at your
3074 option) any later version.
3076 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3077 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3078 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3081 A copy of the GNU General Public License is included as part of this
3082 manual; if you did not receive it, write to the Free Software
3083 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3086 In addition to this, this manual is free in the same sense:
3089 Permission is granted to copy, distribute and/or modify this document
3090 under the terms of the GNU Free Documentation License, Version 1.1 or
3091 any later version published by the Free Software Foundation; with the
3092 Invariant Sections being ``GNU General Public License'' and ``GNU Free
3093 Documentation License'', with no Front-Cover Texts, and with no
3094 Back-Cover Texts. A copy of the license is included in the section
3095 entitled ``GNU Free Documentation License''.
3098 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
3099 @c that the GFDL needs to be present in the manual, and to me it would
3100 @c suck to include the license for the manual and not the license for
3103 The full texts of the GNU General Public License and of the GNU Free
3104 Documentation License are available below.
3107 * GNU General Public License::
3108 * GNU Free Documentation License::
3111 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
3112 @section GNU General Public License
3113 @center Version 2, June 1991
3116 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3117 675 Mass Ave, Cambridge, MA 02139, USA
3119 Everyone is permitted to copy and distribute verbatim copies
3120 of this license document, but changing it is not allowed.
3123 @unnumberedsec Preamble
3125 The licenses for most software are designed to take away your
3126 freedom to share and change it. By contrast, the GNU General Public
3127 License is intended to guarantee your freedom to share and change free
3128 software---to make sure the software is free for all its users. This
3129 General Public License applies to most of the Free Software
3130 Foundation's software and to any other program whose authors commit to
3131 using it. (Some other Free Software Foundation software is covered by
3132 the GNU Library General Public License instead.) You can apply it to
3135 When we speak of free software, we are referring to freedom, not
3136 price. Our General Public Licenses are designed to make sure that you
3137 have the freedom to distribute copies of free software (and charge for
3138 this service if you wish), that you receive source code or can get it
3139 if you want it, that you can change the software or use pieces of it
3140 in new free programs; and that you know you can do these things.
3142 To protect your rights, we need to make restrictions that forbid
3143 anyone to deny you these rights or to ask you to surrender the rights.
3144 These restrictions translate to certain responsibilities for you if you
3145 distribute copies of the software, or if you modify it.
3147 For example, if you distribute copies of such a program, whether
3148 gratis or for a fee, you must give the recipients all the rights that
3149 you have. You must make sure that they, too, receive or can get the
3150 source code. And you must show them these terms so they know their
3153 We protect your rights with two steps: (1) copyright the software, and
3154 (2) offer you this license which gives you legal permission to copy,
3155 distribute and/or modify the software.
3157 Also, for each author's protection and ours, we want to make certain
3158 that everyone understands that there is no warranty for this free
3159 software. If the software is modified by someone else and passed on, we
3160 want its recipients to know that what they have is not the original, so
3161 that any problems introduced by others will not reflect on the original
3162 authors' reputations.
3164 Finally, any free program is threatened constantly by software
3165 patents. We wish to avoid the danger that redistributors of a free
3166 program will individually obtain patent licenses, in effect making the
3167 program proprietary. To prevent this, we have made it clear that any
3168 patent must be licensed for everyone's free use or not licensed at all.
3170 The precise terms and conditions for copying, distribution and
3171 modification follow.
3174 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3177 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3182 This License applies to any program or other work which contains
3183 a notice placed by the copyright holder saying it may be distributed
3184 under the terms of this General Public License. The ``Program'', below,
3185 refers to any such program or work, and a ``work based on the Program''
3186 means either the Program or any derivative work under copyright law:
3187 that is to say, a work containing the Program or a portion of it,
3188 either verbatim or with modifications and/or translated into another
3189 language. (Hereinafter, translation is included without limitation in
3190 the term ``modification''.) Each licensee is addressed as ``you''.
3192 Activities other than copying, distribution and modification are not
3193 covered by this License; they are outside its scope. The act of
3194 running the Program is not restricted, and the output from the Program
3195 is covered only if its contents constitute a work based on the
3196 Program (independent of having been made by running the Program).
3197 Whether that is true depends on what the Program does.
3200 You may copy and distribute verbatim copies of the Program's
3201 source code as you receive it, in any medium, provided that you
3202 conspicuously and appropriately publish on each copy an appropriate
3203 copyright notice and disclaimer of warranty; keep intact all the
3204 notices that refer to this License and to the absence of any warranty;
3205 and give any other recipients of the Program a copy of this License
3206 along with the Program.
3208 You may charge a fee for the physical act of transferring a copy, and
3209 you may at your option offer warranty protection in exchange for a fee.
3212 You may modify your copy or copies of the Program or any portion
3213 of it, thus forming a work based on the Program, and copy and
3214 distribute such modifications or work under the terms of Section 1
3215 above, provided that you also meet all of these conditions:
3219 You must cause the modified files to carry prominent notices
3220 stating that you changed the files and the date of any change.
3223 You must cause any work that you distribute or publish, that in
3224 whole or in part contains or is derived from the Program or any
3225 part thereof, to be licensed as a whole at no charge to all third
3226 parties under the terms of this License.
3229 If the modified program normally reads commands interactively
3230 when run, you must cause it, when started running for such
3231 interactive use in the most ordinary way, to print or display an
3232 announcement including an appropriate copyright notice and a
3233 notice that there is no warranty (or else, saying that you provide
3234 a warranty) and that users may redistribute the program under
3235 these conditions, and telling the user how to view a copy of this
3236 License. (Exception: if the Program itself is interactive but
3237 does not normally print such an announcement, your work based on
3238 the Program is not required to print an announcement.)
3241 These requirements apply to the modified work as a whole. If
3242 identifiable sections of that work are not derived from the Program,
3243 and can be reasonably considered independent and separate works in
3244 themselves, then this License, and its terms, do not apply to those
3245 sections when you distribute them as separate works. But when you
3246 distribute the same sections as part of a whole which is a work based
3247 on the Program, the distribution of the whole must be on the terms of
3248 this License, whose permissions for other licensees extend to the
3249 entire whole, and thus to each and every part regardless of who wrote it.
3251 Thus, it is not the intent of this section to claim rights or contest
3252 your rights to work written entirely by you; rather, the intent is to
3253 exercise the right to control the distribution of derivative or
3254 collective works based on the Program.
3256 In addition, mere aggregation of another work not based on the Program
3257 with the Program (or with a work based on the Program) on a volume of
3258 a storage or distribution medium does not bring the other work under
3259 the scope of this License.
3262 You may copy and distribute the Program (or a work based on it,
3263 under Section 2) in object code or executable form under the terms of
3264 Sections 1 and 2 above provided that you also do one of the following:
3268 Accompany it with the complete corresponding machine-readable
3269 source code, which must be distributed under the terms of Sections
3270 1 and 2 above on a medium customarily used for software interchange; or,
3273 Accompany it with a written offer, valid for at least three
3274 years, to give any third party, for a charge no more than your
3275 cost of physically performing source distribution, a complete
3276 machine-readable copy of the corresponding source code, to be
3277 distributed under the terms of Sections 1 and 2 above on a medium
3278 customarily used for software interchange; or,
3281 Accompany it with the information you received as to the offer
3282 to distribute corresponding source code. (This alternative is
3283 allowed only for noncommercial distribution and only if you
3284 received the program in object code or executable form with such
3285 an offer, in accord with Subsection b above.)
3288 The source code for a work means the preferred form of the work for
3289 making modifications to it. For an executable work, complete source
3290 code means all the source code for all modules it contains, plus any
3291 associated interface definition files, plus the scripts used to
3292 control compilation and installation of the executable. However, as a
3293 special exception, the source code distributed need not include
3294 anything that is normally distributed (in either source or binary
3295 form) with the major components (compiler, kernel, and so on) of the
3296 operating system on which the executable runs, unless that component
3297 itself accompanies the executable.
3299 If distribution of executable or object code is made by offering
3300 access to copy from a designated place, then offering equivalent
3301 access to copy the source code from the same place counts as
3302 distribution of the source code, even though third parties are not
3303 compelled to copy the source along with the object code.
3306 You may not copy, modify, sublicense, or distribute the Program
3307 except as expressly provided under this License. Any attempt
3308 otherwise to copy, modify, sublicense or distribute the Program is
3309 void, and will automatically terminate your rights under this License.
3310 However, parties who have received copies, or rights, from you under
3311 this License will not have their licenses terminated so long as such
3312 parties remain in full compliance.
3315 You are not required to accept this License, since you have not
3316 signed it. However, nothing else grants you permission to modify or
3317 distribute the Program or its derivative works. These actions are
3318 prohibited by law if you do not accept this License. Therefore, by
3319 modifying or distributing the Program (or any work based on the
3320 Program), you indicate your acceptance of this License to do so, and
3321 all its terms and conditions for copying, distributing or modifying
3322 the Program or works based on it.
3325 Each time you redistribute the Program (or any work based on the
3326 Program), the recipient automatically receives a license from the
3327 original licensor to copy, distribute or modify the Program subject to
3328 these terms and conditions. You may not impose any further
3329 restrictions on the recipients' exercise of the rights granted herein.
3330 You are not responsible for enforcing compliance by third parties to
3334 If, as a consequence of a court judgment or allegation of patent
3335 infringement or for any other reason (not limited to patent issues),
3336 conditions are imposed on you (whether by court order, agreement or
3337 otherwise) that contradict the conditions of this License, they do not
3338 excuse you from the conditions of this License. If you cannot
3339 distribute so as to satisfy simultaneously your obligations under this
3340 License and any other pertinent obligations, then as a consequence you
3341 may not distribute the Program at all. For example, if a patent
3342 license would not permit royalty-free redistribution of the Program by
3343 all those who receive copies directly or indirectly through you, then
3344 the only way you could satisfy both it and this License would be to
3345 refrain entirely from distribution of the Program.
3347 If any portion of this section is held invalid or unenforceable under
3348 any particular circumstance, the balance of the section is intended to
3349 apply and the section as a whole is intended to apply in other
3352 It is not the purpose of this section to induce you to infringe any
3353 patents or other property right claims or to contest validity of any
3354 such claims; this section has the sole purpose of protecting the
3355 integrity of the free software distribution system, which is
3356 implemented by public license practices. Many people have made
3357 generous contributions to the wide range of software distributed
3358 through that system in reliance on consistent application of that
3359 system; it is up to the author/donor to decide if he or she is willing
3360 to distribute software through any other system and a licensee cannot
3363 This section is intended to make thoroughly clear what is believed to
3364 be a consequence of the rest of this License.
3367 If the distribution and/or use of the Program is restricted in
3368 certain countries either by patents or by copyrighted interfaces, the
3369 original copyright holder who places the Program under this License
3370 may add an explicit geographical distribution limitation excluding
3371 those countries, so that distribution is permitted only in or among
3372 countries not thus excluded. In such case, this License incorporates
3373 the limitation as if written in the body of this License.
3376 The Free Software Foundation may publish revised and/or new versions
3377 of the General Public License from time to time. Such new versions will
3378 be similar in spirit to the present version, but may differ in detail to
3379 address new problems or concerns.
3381 Each version is given a distinguishing version number. If the Program
3382 specifies a version number of this License which applies to it and ``any
3383 later version'', you have the option of following the terms and conditions
3384 either of that version or of any later version published by the Free
3385 Software Foundation. If the Program does not specify a version number of
3386 this License, you may choose any version ever published by the Free Software
3390 If you wish to incorporate parts of the Program into other free
3391 programs whose distribution conditions are different, write to the author
3392 to ask for permission. For software which is copyrighted by the Free
3393 Software Foundation, write to the Free Software Foundation; we sometimes
3394 make exceptions for this. Our decision will be guided by the two goals
3395 of preserving the free status of all derivatives of our free software and
3396 of promoting the sharing and reuse of software generally.
3399 @heading NO WARRANTY
3407 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3408 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3409 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3410 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3411 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3412 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3413 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3414 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3415 REPAIR OR CORRECTION.
3418 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3419 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3420 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3421 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3422 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3423 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3424 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3425 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3426 POSSIBILITY OF SUCH DAMAGES.
3430 @heading END OF TERMS AND CONDITIONS
3433 @center END OF TERMS AND CONDITIONS
3437 @unnumberedsec How to Apply These Terms to Your New Programs
3439 If you develop a new program, and you want it to be of the greatest
3440 possible use to the public, the best way to achieve this is to make it
3441 free software which everyone can redistribute and change under these terms.
3443 To do so, attach the following notices to the program. It is safest
3444 to attach them to the start of each source file to most effectively
3445 convey the exclusion of warranty; and each file should have at least
3446 the ``copyright'' line and a pointer to where the full notice is found.
3449 @var{one line to give the program's name and an idea of what it does.}
3450 Copyright (C) 19@var{yy} @var{name of author}
3452 This program is free software; you can redistribute it and/or
3453 modify it under the terms of the GNU General Public License
3454 as published by the Free Software Foundation; either version 2
3455 of the License, or (at your option) any later version.
3457 This program is distributed in the hope that it will be useful,
3458 but WITHOUT ANY WARRANTY; without even the implied warranty of
3459 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3460 GNU General Public License for more details.
3462 You should have received a copy of the GNU General Public License
3463 along with this program; if not, write to the Free Software
3464 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3467 Also add information on how to contact you by electronic and paper mail.
3469 If the program is interactive, make it output a short notice like this
3470 when it starts in an interactive mode:
3473 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3474 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3475 type `show w'. This is free software, and you are welcome
3476 to redistribute it under certain conditions; type `show c'
3480 The hypothetical commands @samp{show w} and @samp{show c} should show
3481 the appropriate parts of the General Public License. Of course, the
3482 commands you use may be called something other than @samp{show w} and
3483 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3486 You should also get your employer (if you work as a programmer) or your
3487 school, if any, to sign a ``copyright disclaimer'' for the program, if
3488 necessary. Here is a sample; alter the names:
3492 Yoyodyne, Inc., hereby disclaims all copyright
3493 interest in the program `Gnomovision'
3494 (which makes passes at compilers) written
3497 @var{signature of Ty Coon}, 1 April 1989
3498 Ty Coon, President of Vice
3502 This General Public License does not permit incorporating your program into
3503 proprietary programs. If your program is a subroutine library, you may
3504 consider it more useful to permit linking proprietary applications with the
3505 library. If this is what you want to do, use the GNU Library General
3506 Public License instead of this License.
3508 @node GNU Free Documentation License, , GNU General Public License, Copying
3509 @section GNU Free Documentation License
3510 @center Version 1.1, March 2000
3513 Copyright (C) 2000 Free Software Foundation, Inc.
3514 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3516 Everyone is permitted to copy and distribute verbatim copies
3517 of this license document, but changing it is not allowed.
3524 The purpose of this License is to make a manual, textbook, or other
3525 written document ``free'' in the sense of freedom: to assure everyone
3526 the effective freedom to copy and redistribute it, with or without
3527 modifying it, either commercially or noncommercially. Secondarily,
3528 this License preserves for the author and publisher a way to get
3529 credit for their work, while not being considered responsible for
3530 modifications made by others.
3532 This License is a kind of ``copyleft'', which means that derivative
3533 works of the document must themselves be free in the same sense. It
3534 complements the GNU General Public License, which is a copyleft
3535 license designed for free software.
3537 We have designed this License in order to use it for manuals for free
3538 software, because free software needs free documentation: a free
3539 program should come with manuals providing the same freedoms that the
3540 software does. But this License is not limited to software manuals;
3541 it can be used for any textual work, regardless of subject matter or
3542 whether it is published as a printed book. We recommend this License
3543 principally for works whose purpose is instruction or reference.
3547 APPLICABILITY AND DEFINITIONS
3549 This License applies to any manual or other work that contains a
3550 notice placed by the copyright holder saying it can be distributed
3551 under the terms of this License. The ``Document'', below, refers to any
3552 such manual or work. Any member of the public is a licensee, and is
3553 addressed as ``you''.
3555 A ``Modified Version'' of the Document means any work containing the
3556 Document or a portion of it, either copied verbatim, or with
3557 modifications and/or translated into another language.
3559 A ``Secondary Section'' is a named appendix or a front-matter section of
3560 the Document that deals exclusively with the relationship of the
3561 publishers or authors of the Document to the Document's overall subject
3562 (or to related matters) and contains nothing that could fall directly
3563 within that overall subject. (For example, if the Document is in part a
3564 textbook of mathematics, a Secondary Section may not explain any
3565 mathematics.) The relationship could be a matter of historical
3566 connection with the subject or with related matters, or of legal,
3567 commercial, philosophical, ethical or political position regarding
3570 The ``Invariant Sections'' are certain Secondary Sections whose titles
3571 are designated, as being those of Invariant Sections, in the notice
3572 that says that the Document is released under this License.
3574 The ``Cover Texts'' are certain short passages of text that are listed,
3575 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3576 the Document is released under this License.
3578 A ``Transparent'' copy of the Document means a machine-readable copy,
3579 represented in a format whose specification is available to the
3580 general public, whose contents can be viewed and edited directly and
3581 straightforwardly with generic text editors or (for images composed of
3582 pixels) generic paint programs or (for drawings) some widely available
3583 drawing editor, and that is suitable for input to text formatters or
3584 for automatic translation to a variety of formats suitable for input
3585 to text formatters. A copy made in an otherwise Transparent file
3586 format whose markup has been designed to thwart or discourage
3587 subsequent modification by readers is not Transparent. A copy that is
3588 not ``Transparent'' is called ``Opaque''.
3590 Examples of suitable formats for Transparent copies include plain
3591 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3592 or XML using a publicly available DTD, and standard-conforming simple
3593 HTML designed for human modification. Opaque formats include
3594 PostScript, PDF, proprietary formats that can be read and edited only
3595 by proprietary word processors, SGML or XML for which the DTD and/or
3596 processing tools are not generally available, and the
3597 machine-generated HTML produced by some word processors for output
3600 The ``Title Page'' means, for a printed book, the title page itself,
3601 plus such following pages as are needed to hold, legibly, the material
3602 this License requires to appear in the title page. For works in
3603 formats which do not have any title page as such, ``Title Page'' means
3604 the text near the most prominent appearance of the work's title,
3605 preceding the beginning of the body of the text.
3610 You may copy and distribute the Document in any medium, either
3611 commercially or noncommercially, provided that this License, the
3612 copyright notices, and the license notice saying this License applies
3613 to the Document are reproduced in all copies, and that you add no other
3614 conditions whatsoever to those of this License. You may not use
3615 technical measures to obstruct or control the reading or further
3616 copying of the copies you make or distribute. However, you may accept
3617 compensation in exchange for copies. If you distribute a large enough
3618 number of copies you must also follow the conditions in section 3.
3620 You may also lend copies, under the same conditions stated above, and
3621 you may publicly display copies.
3626 If you publish printed copies of the Document numbering more than 100,
3627 and the Document's license notice requires Cover Texts, you must enclose
3628 the copies in covers that carry, clearly and legibly, all these Cover
3629 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3630 the back cover. Both covers must also clearly and legibly identify
3631 you as the publisher of these copies. The front cover must present
3632 the full title with all words of the title equally prominent and
3633 visible. You may add other material on the covers in addition.
3634 Copying with changes limited to the covers, as long as they preserve
3635 the title of the Document and satisfy these conditions, can be treated
3636 as verbatim copying in other respects.
3638 If the required texts for either cover are too voluminous to fit
3639 legibly, you should put the first ones listed (as many as fit
3640 reasonably) on the actual cover, and continue the rest onto adjacent
3643 If you publish or distribute Opaque copies of the Document numbering
3644 more than 100, you must either include a machine-readable Transparent
3645 copy along with each Opaque copy, or state in or with each Opaque copy
3646 a publicly-accessible computer-network location containing a complete
3647 Transparent copy of the Document, free of added material, which the
3648 general network-using public has access to download anonymously at no
3649 charge using public-standard network protocols. If you use the latter
3650 option, you must take reasonably prudent steps, when you begin
3651 distribution of Opaque copies in quantity, to ensure that this
3652 Transparent copy will remain thus accessible at the stated location
3653 until at least one year after the last time you distribute an Opaque
3654 copy (directly or through your agents or retailers) of that edition to
3657 It is requested, but not required, that you contact the authors of the
3658 Document well before redistributing any large number of copies, to give
3659 them a chance to provide you with an updated version of the Document.
3664 You may copy and distribute a Modified Version of the Document under
3665 the conditions of sections 2 and 3 above, provided that you release
3666 the Modified Version under precisely this License, with the Modified
3667 Version filling the role of the Document, thus licensing distribution
3668 and modification of the Modified Version to whoever possesses a copy
3669 of it. In addition, you must do these things in the Modified Version:
3671 A. Use in the Title Page (and on the covers, if any) a title distinct
3672 from that of the Document, and from those of previous versions
3673 (which should, if there were any, be listed in the History section
3674 of the Document). You may use the same title as a previous version
3675 if the original publisher of that version gives permission.@*
3676 B. List on the Title Page, as authors, one or more persons or entities
3677 responsible for authorship of the modifications in the Modified
3678 Version, together with at least five of the principal authors of the
3679 Document (all of its principal authors, if it has less than five).@*
3680 C. State on the Title page the name of the publisher of the
3681 Modified Version, as the publisher.@*
3682 D. Preserve all the copyright notices of the Document.@*
3683 E. Add an appropriate copyright notice for your modifications
3684 adjacent to the other copyright notices.@*
3685 F. Include, immediately after the copyright notices, a license notice
3686 giving the public permission to use the Modified Version under the
3687 terms of this License, in the form shown in the Addendum below.@*
3688 G. Preserve in that license notice the full lists of Invariant Sections
3689 and required Cover Texts given in the Document's license notice.@*
3690 H. Include an unaltered copy of this License.@*
3691 I. Preserve the section entitled ``History'', and its title, and add to
3692 it an item stating at least the title, year, new authors, and
3693 publisher of the Modified Version as given on the Title Page. If
3694 there is no section entitled ``History'' in the Document, create one
3695 stating the title, year, authors, and publisher of the Document as
3696 given on its Title Page, then add an item describing the Modified
3697 Version as stated in the previous sentence.@*
3698 J. Preserve the network location, if any, given in the Document for
3699 public access to a Transparent copy of the Document, and likewise
3700 the network locations given in the Document for previous versions
3701 it was based on. These may be placed in the ``History'' section.
3702 You may omit a network location for a work that was published at
3703 least four years before the Document itself, or if the original
3704 publisher of the version it refers to gives permission.@*
3705 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3706 preserve the section's title, and preserve in the section all the
3707 substance and tone of each of the contributor acknowledgements
3708 and/or dedications given therein.@*
3709 L. Preserve all the Invariant Sections of the Document,
3710 unaltered in their text and in their titles. Section numbers
3711 or the equivalent are not considered part of the section titles.@*
3712 M. Delete any section entitled ``Endorsements''. Such a section
3713 may not be included in the Modified Version.@*
3714 N. Do not retitle any existing section as ``Endorsements''
3715 or to conflict in title with any Invariant Section.@*
3717 If the Modified Version includes new front-matter sections or
3718 appendices that qualify as Secondary Sections and contain no material
3719 copied from the Document, you may at your option designate some or all
3720 of these sections as invariant. To do this, add their titles to the
3721 list of Invariant Sections in the Modified Version's license notice.
3722 These titles must be distinct from any other section titles.
3724 You may add a section entitled ``Endorsements'', provided it contains
3725 nothing but endorsements of your Modified Version by various
3726 parties--for example, statements of peer review or that the text has
3727 been approved by an organization as the authoritative definition of a
3730 You may add a passage of up to five words as a Front-Cover Text, and a
3731 passage of up to 25 words as a Back-Cover Text, to the end of the list
3732 of Cover Texts in the Modified Version. Only one passage of
3733 Front-Cover Text and one of Back-Cover Text may be added by (or
3734 through arrangements made by) any one entity. If the Document already
3735 includes a cover text for the same cover, previously added by you or
3736 by arrangement made by the same entity you are acting on behalf of,
3737 you may not add another; but you may replace the old one, on explicit
3738 permission from the previous publisher that added the old one.
3740 The author(s) and publisher(s) of the Document do not by this License
3741 give permission to use their names for publicity for or to assert or
3742 imply endorsement of any Modified Version.
3747 You may combine the Document with other documents released under this
3748 License, under the terms defined in section 4 above for modified
3749 versions, provided that you include in the combination all of the
3750 Invariant Sections of all of the original documents, unmodified, and
3751 list them all as Invariant Sections of your combined work in its
3754 The combined work need only contain one copy of this License, and
3755 multiple identical Invariant Sections may be replaced with a single
3756 copy. If there are multiple Invariant Sections with the same name but
3757 different contents, make the title of each such section unique by
3758 adding at the end of it, in parentheses, the name of the original
3759 author or publisher of that section if known, or else a unique number.
3760 Make the same adjustment to the section titles in the list of
3761 Invariant Sections in the license notice of the combined work.
3763 In the combination, you must combine any sections entitled ``History''
3764 in the various original documents, forming one section entitled
3765 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3766 and any sections entitled ``Dedications''. You must delete all sections
3767 entitled ``Endorsements.''
3770 COLLECTIONS OF DOCUMENTS
3772 You may make a collection consisting of the Document and other documents
3773 released under this License, and replace the individual copies of this
3774 License in the various documents with a single copy that is included in
3775 the collection, provided that you follow the rules of this License for
3776 verbatim copying of each of the documents in all other respects.
3778 You may extract a single document from such a collection, and distribute
3779 it individually under this License, provided you insert a copy of this
3780 License into the extracted document, and follow this License in all
3781 other respects regarding verbatim copying of that document.
3784 AGGREGATION WITH INDEPENDENT WORKS
3786 A compilation of the Document or its derivatives with other separate
3787 and independent documents or works, in or on a volume of a storage or
3788 distribution medium, does not as a whole count as a Modified Version
3789 of the Document, provided no compilation copyright is claimed for the
3790 compilation. Such a compilation is called an ``aggregate'', and this
3791 License does not apply to the other self-contained works thus compiled
3792 with the Document, on account of their being thus compiled, if they
3793 are not themselves derivative works of the Document.
3795 If the Cover Text requirement of section 3 is applicable to these
3796 copies of the Document, then if the Document is less than one quarter
3797 of the entire aggregate, the Document's Cover Texts may be placed on
3798 covers that surround only the Document within the aggregate.
3799 Otherwise they must appear on covers around the whole aggregate.
3804 Translation is considered a kind of modification, so you may
3805 distribute translations of the Document under the terms of section 4.
3806 Replacing Invariant Sections with translations requires special
3807 permission from their copyright holders, but you may include
3808 translations of some or all Invariant Sections in addition to the
3809 original versions of these Invariant Sections. You may include a
3810 translation of this License provided that you also include the
3811 original English version of this License. In case of a disagreement
3812 between the translation and the original English version of this
3813 License, the original English version will prevail.
3818 You may not copy, modify, sublicense, or distribute the Document except
3819 as expressly provided for under this License. Any other attempt to
3820 copy, modify, sublicense or distribute the Document is void, and will
3821 automatically terminate your rights under this License. However,
3822 parties who have received copies, or rights, from you under this
3823 License will not have their licenses terminated so long as such
3824 parties remain in full compliance.
3827 FUTURE REVISIONS OF THIS LICENSE
3829 The Free Software Foundation may publish new, revised versions
3830 of the GNU Free Documentation License from time to time. Such new
3831 versions will be similar in spirit to the present version, but may
3832 differ in detail to address new problems or concerns. See
3833 http://www.gnu.org/copyleft/.
3835 Each version of the License is given a distinguishing version number.
3836 If the Document specifies that a particular numbered version of this
3837 License ``or any later version'' applies to it, you have the option of
3838 following the terms and conditions either of that specified version or
3839 of any later version that has been published (not as a draft) by the
3840 Free Software Foundation. If the Document does not specify a version
3841 number of this License, you may choose any version ever published (not
3842 as a draft) by the Free Software Foundation.
3846 @unnumberedsec ADDENDUM: How to use this License for your documents
3848 To use this License in a document you have written, include a copy of
3849 the License in the document and put the following copyright and
3850 license notices just after the title page:
3855 Copyright (C) @var{year} @var{your name}.
3856 Permission is granted to copy, distribute and/or modify this document
3857 under the terms of the GNU Free Documentation License, Version 1.1
3858 or any later version published by the Free Software Foundation;
3859 with the Invariant Sections being @var{list their titles}, with the
3860 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
3861 A copy of the license is included in the section entitled ``GNU
3862 Free Documentation License''.
3865 If you have no Invariant Sections, write ``with no Invariant Sections''
3866 instead of saying which ones are invariant. If you have no
3867 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
3868 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
3870 If your document contains nontrivial examples of program code, we
3871 recommend releasing these examples in parallel under your choice of
3872 free software license, such as the GNU General Public License,
3873 to permit their use in free software.
3876 @node Concept Index, , Copying, Top
3877 @unnumbered Concept Index