1 \input texinfo @c -*-texinfo-*-
5 @settitle GNU Wget Manual
6 @c Disable the monstrous rectangles beside overfull hbox-es.
8 @c Use `odd' to print double-sided.
13 @c Remove this if you don't use A4 paper.
17 @c This should really be auto-generated!
18 @set VERSION 1.5.3+dev
21 @dircategory Net Utilities
22 @dircategory World Wide Web
24 * Wget: (wget). The non-interactive network downloader.
28 This file documents the the GNU Wget utility for downloading network
31 Copyright (C) 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
33 Permission is granted to make and distribute verbatim copies of
34 this manual provided the copyright notice and this permission notice
35 are preserved on all copies.
38 Permission is granted to process this file through TeX and print the
39 results, provided the printed document carries a copying permission
40 notice identical to this one except for the removal of this paragraph
41 (this paragraph not being relevant to the printed manual).
43 Permission is granted to copy, distribute and/or modify this document
44 under the terms of the GNU Free Documentation License, Version 1.1 or
45 any later version published by the Free Software Foundation; with the
46 Invariant Sections being ``GNU General Public License'' and ``GNU Free
47 Documentation License'', with no Front-Cover Texts, and with no
48 Back-Cover Texts. A copy of the license is included in the section
49 entitled ``GNU Free Documentation License''.
54 @subtitle The noninteractive downloading utility
55 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
56 @author by Hrvoje Nik@v{s}i@'{c} and the developers
59 @vskip 0pt plus 1filll
60 Copyright @copyright{} 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
62 Permission is granted to copy, distribute and/or modify this document
63 under the terms of the GNU Free Documentation License, Version 1.1 or
64 any later version published by the Free Software Foundation; with the
65 Invariant Sections being ``GNU General Public License'' and ``GNU Free
66 Documentation License'', with no Front-Cover Texts, and with no
67 Back-Cover Texts. A copy of the license is included in the section
68 entitled ``GNU Free Documentation License''.
72 @node Top, Overview, (dir), (dir)
73 @top Wget @value{VERSION}
75 This manual documents version @value{VERSION} of GNU Wget, the freely
76 available utility for network download.
78 Copyright @copyright{} 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
81 * Overview:: Features of Wget.
82 * Invoking:: Wget command-line arguments.
83 * Recursive Retrieval:: Description of recursive retrieval.
84 * Following Links:: The available methods of chasing links.
85 * Time-Stamping:: Mirroring according to time-stamps.
86 * Startup File:: Wget's initialization file.
87 * Examples:: Examples of usage.
88 * Various:: The stuff that doesn't fit anywhere else.
89 * Appendices:: Some useful references.
90 * Copying:: You may give out copies of Wget and of this manual.
91 * Concept Index:: Topics covered by this manual.
95 @node Overview, Invoking, Top, Top
100 GNU Wget is a freely available network utility to retrieve files from
101 the World Wide Web, using @sc{http} (Hyper Text Transfer Protocol) and
102 @sc{ftp} (File Transfer Protocol), the two most widely used Internet
103 protocols. It has many useful features to make downloading easier, some
108 Wget is non-interactive, meaning that it can work in the background,
109 while the user is not logged on. This allows you to start a retrieval
110 and disconnect from the system, letting Wget finish the work. By
111 contrast, most of the Web browsers require constant user's presence,
112 which can be a great hindrance when transferring a lot of data.
116 Wget is capable of descending recursively through the structure of
117 @sc{html} documents and @sc{ftp} directory trees, making a local copy of
118 the directory hierarchy similar to the one on the remote server. This
119 feature can be used to mirror archives and home pages, or traverse the
120 web in search of data, like a @sc{www} robot (@pxref{Robots}). In that
121 spirit, Wget understands the @code{norobots} convention.
125 File name wildcard matching and recursive mirroring of directories are
126 available when retrieving via @sc{ftp}. Wget can read the time-stamp
127 information given by both @sc{http} and @sc{ftp} servers, and store it
128 locally. Thus Wget can see if the remote file has changed since last
129 retrieval, and automatically retrieve the new version if it has. This
130 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
135 Wget works exceedingly well on slow or unstable connections,
136 retrying the document until it is fully retrieved, or until a
137 user-specified retry count is surpassed. It will try to resume the
138 download from the point of interruption, using @code{REST} with @sc{ftp}
139 and @code{Range} with @sc{http} servers that support them.
143 By default, Wget supports proxy servers, which can lighten the network
144 load, speed up retrieval and provide access behind firewalls. However,
145 if you are behind a firewall that requires that you use a socks style
146 gateway, you can get the socks library and build wget with support for
147 socks. Wget also supports the passive @sc{ftp} downloading as an
152 Builtin features offer mechanisms to tune which links you wish to follow
153 (@pxref{Following Links}).
157 The retrieval is conveniently traced with printing dots, each dot
158 representing a fixed amount of data received (1KB by default). These
159 representations can be customized to your preferences.
163 Most of the features are fully configurable, either through command line
164 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
165 File}). Wget allows you to define @dfn{global} startup files
166 (@file{/usr/local/etc/wgetrc} by default) for site settings.
170 Finally, GNU Wget is free software. This means that everyone may use
171 it, redistribute it and/or modify it under the terms of the GNU General
172 Public License, as published by the Free Software Foundation
176 @node Invoking, Recursive Retrieval, Overview, Top
183 By default, Wget is very simple to invoke. The basic syntax is:
186 wget [@var{option}]@dots{} [@var{URL}]@dots{}
189 Wget will simply download all the @sc{url}s specified on the command
190 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
192 However, you may wish to change some of the default parameters of
193 Wget. You can do it two ways: permanently, adding the appropriate
194 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
200 * Basic Startup Options::
201 * Logging and Input File Options::
203 * Directory Options::
206 * Recursive Retrieval Options::
207 * Recursive Accept/Reject Options::
210 @node URL Format, Option Syntax, Invoking, Invoking
215 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
216 resource locator is a compact string representation for a resource
217 available via the Internet. Wget recognizes the @sc{url} syntax as per
218 @sc{rfc1738}. This is the most widely used form (square brackets denote
222 http://host[:port]/directory/file
223 ftp://host[:port]/directory/file
226 You can also encode your username and password within a @sc{url}:
229 ftp://user:password@@host/path
230 http://user:password@@host/path
233 Either @var{user} or @var{password}, or both, may be left out. If you
234 leave out either the @sc{http} username or password, no authentication
235 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
236 will be used. If you leave out the @sc{ftp} password, your email
237 address will be supplied as a default password.@footnote{If you have a
238 @file{.netrc} file in your home directory, password will also be
241 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
242 being the hexadecimal representation of the character's @sc{ascii}
243 value. Some common unsafe characters include @samp{%} (quoted as
244 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
245 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
248 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
249 default, @sc{ftp} documents are retrieved in the binary mode (type
250 @samp{i}), which means that they are downloaded unchanged. Another
251 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
252 delimiters between the different operating systems, and is thus useful
253 for text files. Here is an example:
256 ftp://host/directory/file;type=a
259 Two alternative variants of @sc{url} specification are also supported,
260 because of historical (hysterical?) reasons and their widespreaded use.
262 @sc{ftp}-only syntax (supported by @code{NcFTP}):
267 @sc{http}-only syntax (introduced by @code{Netscape}):
272 These two alternative forms are deprecated, and may cease being
273 supported in the future.
275 If you do not understand the difference between these notations, or do
276 not know which one to use, just use the plain ordinary format you use
277 with your favorite browser, like @code{Lynx} or @code{Netscape}.
279 @node Option Syntax, Basic Startup Options, URL Format, Invoking
280 @section Option Syntax
281 @cindex option syntax
282 @cindex syntax of options
284 Since Wget uses GNU getopts to process its arguments, every option has a
285 short form and a long form. Long options are more convenient to
286 remember, but take time to type. You may freely mix different option
287 styles, or specify options after the command-line arguments. Thus you
291 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
294 The space between the option accepting an argument and the argument may
295 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
297 You may put several options that do not require arguments together,
304 This is a complete equivalent of:
307 wget -d -r -c @var{URL}
310 Since the options can be specified after the arguments, you may
311 terminate them with @samp{--}. So the following will try to download
312 @sc{url} @samp{-x}, reporting failure to @file{log}:
318 The options that accept comma-separated lists all respect the convention
319 that specifying an empty list clears its value. This can be useful to
320 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
321 sets @code{exclude_directories} to @file{/cgi-bin}, the following
322 example will first reset it, and then set it to exclude @file{/~nobody}
323 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
324 (@pxref{Wgetrc Syntax}).
327 wget -X '' -X /~nobody,/~somebody
330 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
331 @section Basic Startup Options
336 Display the version of Wget.
340 Print a help message describing all of Wget's command-line options.
344 Go to background immediately after startup. If no output file is
345 specified via the @samp{-o}, output is redirected to @file{wget-log}.
347 @cindex execute wgetrc command
348 @item -e @var{command}
349 @itemx --execute @var{command}
350 Execute @var{command} as if it were a part of @file{.wgetrc}
351 (@pxref{Startup File}). A command thus invoked will be executed
352 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
356 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
357 @section Logging and Input File Options
362 @item -o @var{logfile}
363 @itemx --output-file=@var{logfile}
364 Log all messages to @var{logfile}. The messages are normally reported
367 @cindex append to log
368 @item -a @var{logfile}
369 @itemx --append-output=@var{logfile}
370 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
371 to @var{logfile} instead of overwriting the old log file. If
372 @var{logfile} does not exist, a new file is created.
377 Turn on debug output, meaning various information important to the
378 developers of Wget if it does not work properly. Your system
379 administrator may have chosen to compile Wget without debug support, in
380 which case @samp{-d} will not work. Please note that compiling with
381 debug support is always safe---Wget compiled with the debug support will
382 @emph{not} print any debug info unless requested with @samp{-d}.
383 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
389 Turn off Wget's output.
394 Turn on verbose output, with all the available data. The default output
399 Non-verbose output---turn off verbose without being completely quiet
400 (use @samp{-q} for that), which means that error messages and basic
401 information still get printed.
405 @itemx --input-file=@var{file}
406 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
407 the command line. If there are @sc{url}s both on the command line and
408 in an input file, those on the command lines will be the first ones to
409 be retrieved. The @var{file} need not be an @sc{html} document (but no
410 harm if it is)---it is enough if the @sc{url}s are just listed
413 However, if you specify @samp{--force-html}, the document will be
414 regarded as @samp{html}. In that case you may have problems with
415 relative links, which you can solve either by adding @code{<base
416 href="@var{url}">} to the documents or by specifying
417 @samp{--base=@var{url}} on the command line.
422 When input is read from a file, force it to be treated as an @sc{html}
423 file. This enables you to retrieve relative links from existing
424 @sc{html} files on your local disk, by adding @code{<base
425 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
428 @cindex base for relative links in input file
430 @itemx --base=@var{URL}
431 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
432 links in the file specified by @samp{-i}.
435 @node Download Options, Directory Options, Logging and Input File Options, Invoking
436 @section Download Options
439 @cindex bind() address
440 @cindex client IP address
441 @cindex IP address, client
442 @item --bind-address=@var{ADDRESS}
443 When making client TCP/IP connections, @code{bind()} to @var{ADDRESS} on
444 the local machine. @var{ADDRESS} may be specified as a hostname or IP
445 address. This option can be useful if your machine is bound to multiple
450 @cindex number of retries
451 @item -t @var{number}
452 @itemx --tries=@var{number}
453 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
457 @itemx --output-document=@var{file}
458 The documents will not be written to the appropriate files, but all will
459 be concatenated together and written to @var{file}. If @var{file}
460 already exists, it will be overwritten. If the @var{file} is @samp{-},
461 the documents will be written to standard output. Including this option
462 automatically sets the number of tries to 1.
464 @cindex clobbering, file
465 @cindex downloading multiple times
469 If a file is downloaded more than once in the same directory, wget's
470 behavior depends on a few options, including @samp{-nc}. In certain
471 cases, the local file will be "clobbered", or overwritten, upon repeated
472 download. In other cases it will be preserved.
474 When running wget without @samp{-N}, @samp{-nc}, or @samp{-r},
475 downloading the same file in the same directory will result in the
476 original copy of @samp{@var{file}} being preserved and the second copy
477 being named @samp{@var{file}.1}. If that file is downloaded yet again,
478 the third copy will be named @samp{@var{file}.2}, and so on. When
479 @samp{-nc} is specified, this behavior is suppressed, and wget will
480 refuse to download newer copies of @samp{@var{file}}. Therefore,
481 "no-clobber" is actually a misnomer in this mode -- it's not clobbering
482 that's prevented (as the numeric suffixes were already preventing
483 clobbering), but rather the multiple version saving that's prevented.
485 When running wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
486 re-downloading a file will result in the new copy simply overwriting the
487 old. Adding @samp{-nc} will prevent this behavior, instead causing the
488 original version to be preserved and any newer copies on the server to
491 When running wget with @samp{-N}, with or without @samp{-r}, the
492 decision as to whether or not to download a newer copy of a file depends
493 on the local and remote timestamp and size of the file
494 (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the same
497 Note that when @samp{-nc} is specified, files with the suffixes
498 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
499 and parsed as if they had been retrieved from the Web.
501 @cindex continue retrieval
504 Continue getting an existing file. This is useful when you want to
505 finish up the download started by another program, or a previous
506 instance of Wget. Thus you can write:
509 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
512 If there is a file name @file{ls-lR.Z} in the current directory, Wget
513 will assume that it is the first portion of the remote file, and will
514 require the server to continue the retrieval from an offset equal to the
515 length of the local file.
517 Note that you need not specify this option if all you want is Wget to
518 continue retrieving where it left off when the connection is lost---Wget
519 does this by default. You need this option only when you want to
520 continue retrieval of a file already halfway retrieved, saved by another
521 @sc{ftp} client, or left by Wget being killed.
523 Without @samp{-c}, the previous example would just begin to download the
524 remote file to @file{ls-lR.Z.1}. The @samp{-c} option is also
525 applicable for @sc{http} servers that support the @code{Range} header.
527 Note that if you use @samp{-c} on a file that's already downloaded
528 completely, @samp{@var{file}} will not be changed, nor will a second
529 @samp{@var{file}.1} copy be created.
532 @cindex retrieval tracing style
533 @item --dot-style=@var{style}
534 Set the retrieval style to @var{style}. Wget traces the retrieval of
535 each document by printing dots on the screen, each dot representing a
536 fixed amount of retrieved data. Any number of dots may be separated in
537 a @dfn{cluster}, to make counting easier. This option allows you to
538 choose one of the pre-defined styles, determining the number of bytes
539 represented by a dot, the number of dots in a cluster, and the number of
542 With the @code{default} style each dot represents 1K, there are ten dots
543 in a cluster and 50 dots in a line. The @code{binary} style has a more
544 ``computer''-like orientation---8K dots, 16-dots clusters and 48 dots
545 per line (which makes for 384K lines). The @code{mega} style is
546 suitable for downloading very large files---each dot represents 64K
547 retrieved, there are eight dots in a cluster, and 48 dots on each line
548 (so each line contains 3M). The @code{micro} style is exactly the
549 reverse; it is suitable for downloading small files, with 128-byte dots,
550 8 dots per cluster, and 48 dots (6K) per line.
553 @itemx --timestamping
554 Turn on time-stamping. @xref{Time-Stamping}, for details.
556 @cindex server response, print
558 @itemx --server-response
559 Print the headers sent by @sc{http} servers and responses sent by
562 @cindex Wget as spider
565 When invoked with this option, Wget will behave as a Web @dfn{spider},
566 which means that it will not download the pages, just check that they
567 are there. You can use it to check your bookmarks, e.g. with:
570 wget --spider --force-html -i bookmarks.html
573 This feature needs much more work for Wget to get close to the
574 functionality of real @sc{www} spiders.
578 @itemx --timeout=@var{seconds}
579 Set the read timeout to @var{seconds} seconds. Whenever a network read
580 is issued, the file descriptor is checked for a timeout, which could
581 otherwise leave a pending connection (uninterrupted read). The default
582 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
583 disable checking for timeouts.
585 Please do not lower the default timeout value with this option unless
586 you know what you are doing.
590 @item -w @var{seconds}
591 @itemx --wait=@var{seconds}
592 Wait the specified number of seconds between the retrievals. Use of
593 this option is recommended, as it lightens the server load by making the
594 requests less frequent. Instead of in seconds, the time can be
595 specified in minutes using the @code{m} suffix, in hours using @code{h}
596 suffix, or in days using @code{d} suffix.
598 Specifying a large value for this option is useful if the network or the
599 destination host is down, so that Wget can wait long enough to
600 reasonably expect the network error to be fixed before the retry.
602 @cindex retries, waiting between
603 @cindex waiting between retries
604 @item --waitretry=@var{seconds}
605 If you don't want Wget to wait between @emph{every} retrieval, but only
606 between retries of failed downloads, you can use this option. Wget will
607 use "linear backoff", waiting 1 second after the first failure on a
608 given file, then waiting 2 seconds after the second failure on that
609 file, up to the maximum number of @var{seconds} you specify. Therefore,
610 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
613 Note that this option is turned on by default in the global
618 @itemx --proxy=on/off
619 Turn proxy support on or off. The proxy is on by default if the
620 appropriate environmental variable is defined.
624 @itemx --quota=@var{quota}
625 Specify download quota for automatic retrievals. The value can be
626 specified in bytes (default), kilobytes (with @samp{k} suffix), or
627 megabytes (with @samp{m} suffix).
629 Note that quota will never affect downloading a single file. So if you
630 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
631 @file{ls-lR.gz} will be downloaded. The same goes even when several
632 @sc{url}s are specified on the command-line. However, quota is
633 respected when retrieving either recursively, or from an input file.
634 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
635 aborted when the quota is exceeded.
637 Setting quota to 0 or to @samp{inf} unlimits the download quota.
640 @node Directory Options, HTTP Options, Download Options, Invoking
641 @section Directory Options
645 @itemx --no-directories
646 Do not create a hierarchy of directories when retrieving
647 recursively. With this option turned on, all files will get saved to the
648 current directory, without clobbering (if a name shows up more than
649 once, the filenames will get extensions @samp{.n}).
652 @itemx --force-directories
653 The opposite of @samp{-nd}---create a hierarchy of directories, even if
654 one would not have been created otherwise. E.g. @samp{wget -x
655 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
656 @file{fly.srk.fer.hr/robots.txt}.
659 @itemx --no-host-directories
660 Disable generation of host-prefixed directories. By default, invoking
661 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
662 directories beginning with @file{fly.srk.fer.hr/}. This option disables
665 @cindex cut directories
666 @item --cut-dirs=@var{number}
667 Ignore @var{number} directory components. This is useful for getting a
668 fine-grained control over the directory where recursive retrieval will
671 Take, for example, the directory at
672 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
673 @samp{-r}, it will be saved locally under
674 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
675 remove the @file{ftp.xemacs.org/} part, you are still stuck with
676 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
677 makes Wget not ``see'' @var{number} remote directory components. Here
678 are several examples of how @samp{--cut-dirs} option works.
682 No options -> ftp.xemacs.org/pub/xemacs/
684 -nH --cut-dirs=1 -> xemacs/
685 -nH --cut-dirs=2 -> .
687 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
692 If you just want to get rid of the directory structure, this option is
693 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
694 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
695 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
696 be placed to @file{xemacs/beta}, as one would expect.
698 @cindex directory prefix
699 @item -P @var{prefix}
700 @itemx --directory-prefix=@var{prefix}
701 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
702 directory where all other files and subdirectories will be saved to,
703 i.e. the top of the retrieval tree. The default is @samp{.} (the
707 @node HTTP Options, FTP Options, Directory Options, Invoking
708 @section HTTP Options
711 @cindex .html extension
713 @itemx --html-extension
714 If a file of type @samp{text/html} is downloaded and the URL does not
715 end with the regexp "\.[Hh][Tt][Mm][Ll]?", this option will cause the
716 suffix @samp{.html} to be appended to the local filename. This is
717 useful, for instance, when you're mirroring a remote site that uses
718 @samp{.asp} pages, but you want the mirrored pages to be viewable on
719 your stock Apache server. Another good use for this is when you're
720 downloading the output of CGIs. A URL like
721 @samp{http://site.com/article.cgi?25} will be saved as
722 @file{article.cgi?25.html}.
724 Note that filenames changed in this way will be re-downloaded every time
725 you re-mirror a site, because wget can't tell that the local
726 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
727 it doesn't yet know that the URL produces output of type
728 @samp{text/html}. To prevent this re-downloading, you must use
729 @samp{-k} and @samp{-K} so that the original version of the file will be
730 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
733 @cindex http password
734 @cindex authentication
735 @item --http-user=@var{user}
736 @itemx --http-passwd=@var{password}
737 Specify the username @var{user} and password @var{password} on an
738 @sc{http} server. According to the type of the challenge, Wget will
739 encode them using either the @code{basic} (insecure) or the
740 @code{digest} authentication scheme.
742 Another way to specify username and password is in the @sc{url} itself
743 (@pxref{URL Format}). For more information about security issues with
744 Wget, @xref{Security Considerations}.
749 @itemx --cache=on/off
750 When set to off, disable server-side cache. In this case, Wget will
751 send the remote server an appropriate directive (@samp{Pragma:
752 no-cache}) to get the file from the remote service, rather than
753 returning the cached version. This is especially useful for retrieving
754 and flushing out-of-date documents on proxy servers.
756 Caching is allowed by default.
758 @cindex Content-Length, ignore
759 @cindex ignore length
760 @item --ignore-length
761 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
762 precise) send out bogus @code{Content-Length} headers, which makes Wget
763 go wild, as it thinks not all the document was retrieved. You can spot
764 this syndrome if Wget retries getting the same document again and again,
765 each time claiming that the (otherwise normal) connection has closed on
768 With this option, Wget will ignore the @code{Content-Length} header---as
772 @item --header=@var{additional-header}
773 Define an @var{additional-header} to be passed to the @sc{http} servers.
774 Headers must contain a @samp{:} preceded by one or more non-blank
775 characters, and must not contain newlines.
777 You may define more than one additional header by specifying
778 @samp{--header} more than once.
782 wget --header='Accept-Charset: iso-8859-2' \
783 --header='Accept-Language: hr' \
784 http://fly.srk.fer.hr/
788 Specification of an empty string as the header value will clear all
789 previous user-defined headers.
792 @cindex proxy password
793 @cindex proxy authentication
794 @item --proxy-user=@var{user}
795 @itemx --proxy-passwd=@var{password}
796 Specify the username @var{user} and password @var{password} for
797 authentication on a proxy server. Wget will encode them using the
798 @code{basic} authentication scheme.
801 @cindex referer, http
802 @item --referer=@var{url}
803 Include `Referer: @var{url}' header in HTTP request. Useful for
804 retrieving documents with server-side processing that assume they are
805 always being retrieved by interactive web browsers and only come out
806 properly when Referer is set to one of the pages that point to them.
808 @cindex server response, save
810 @itemx --save-headers
811 Save the headers sent by the @sc{http} server to the file, preceding the
812 actual contents, with an empty line as the separator.
815 @item -U @var{agent-string}
816 @itemx --user-agent=@var{agent-string}
817 Identify as @var{agent-string} to the @sc{http} server.
819 The @sc{http} protocol allows the clients to identify themselves using a
820 @code{User-Agent} header field. This enables distinguishing the
821 @sc{www} software, usually for statistical purposes or for tracing of
822 protocol violations. Wget normally identifies as
823 @samp{Wget/@var{version}}, @var{version} being the current version
826 However, some sites have been known to impose the policy of tailoring
827 the output according to the @code{User-Agent}-supplied information.
828 While conceptually this is not such a bad idea, it has been abused by
829 servers denying information to clients other than @code{Mozilla} or
830 Microsoft @code{Internet Explorer}. This option allows you to change
831 the @code{User-Agent} line issued by Wget. Use of this option is
832 discouraged, unless you really know what you are doing.
835 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
839 @cindex symbolic links, retrieving
840 @item --retr-symlinks
841 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
842 link is encountered, the linked-to file is not downloaded. Instead, a
843 matching symbolic link is created on the local filesystem. The
844 pointed-to file will not be downloaded unless this recursive retrieval
845 would have encountered it separately and downloaded it anyway.
847 When @samp{--retr-symlinks} is specified, however, symbolic links are
848 traversed and the pointed-to files are retrieved. At this time, this
849 option does not cause wget to traverse symlinks to directories and
850 recurse through them, but in the future it should be enhanced to do
853 Note that when retrieving a file (not a directory) because it was
854 specified on the commandline, rather than because it was recursed to,
855 this option has no effect. Symbolic links are always traversed in this
858 @cindex globbing, toggle
861 Turn @sc{ftp} globbing on or off. Globbing means you may use the
862 shell-like special characters (@dfn{wildcards}), like @samp{*},
863 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
864 same directory at once, like:
867 wget ftp://gnjilux.srk.fer.hr/*.msg
870 By default, globbing will be turned on if the @sc{url} contains a
871 globbing character. This option may be used to turn globbing on or off
874 You may have to quote the @sc{url} to protect it from being expanded by
875 your shell. Globbing makes Wget look for a directory listing, which is
876 system-specific. This is why it currently works only with Unix @sc{ftp}
877 servers (and the ones emulating Unix @code{ls} output).
881 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
882 initiates the data connection. This is sometimes required for @sc{ftp}
883 to work behind firewalls.
886 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
887 @section Recursive Retrieval Options
892 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
896 @itemx --level=@var{depth}
897 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
898 Retrieval}). The default maximum depth is 5.
900 @cindex proxy filling
901 @cindex delete after retrieval
902 @cindex filling proxy cache
904 This option tells Wget to delete every single file it downloads,
905 @emph{after} having done so. It is useful for pre-fetching popular
906 pages through a proxy, e.g.:
909 wget -r -nd --delete-after http://whatever.com/~popular/page/
912 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
915 Note that @samp{--delete-after} deletes files on the local machine. It
916 does not issue the @samp{DELE} command to remote FTP sites, for
917 instance. Also note that when @samp{--delete-after} is specified,
918 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
919 created in the first place.
921 @cindex conversion of links
922 @cindex link conversion
924 @itemx --convert-links
925 Convert the non-relative links to relative ones locally. Only the
926 references to the documents actually downloaded will be converted; the
927 rest will be left unchanged.
929 Note that only at the end of the download can Wget know which links have
930 been downloaded. Because of that, much of the work done by @samp{-k}
931 will be performed at the end of the downloads.
933 @cindex backing up converted files
935 @itemx --backup-converted
936 When converting a file, back up the original version with a @samp{.orig}
937 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
942 Turn on options suitable for mirroring. This option turns on recursion
943 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
944 directory listings. It is currently equivalent to
945 @samp{-r -N -l inf -nr}.
948 @itemx --dont-remove-listing
949 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
950 retrievals. Normally, these files contain the raw directory listings
951 received from @sc{ftp} servers. Not removing them can be useful to
952 access the full remote file list when running a mirror, or for debugging
955 @cindex page requisites
956 @cindex required images, downloading
958 @itemx --page-requisites
959 This option causes wget to download all the files that are necessary to
960 properly display a given HTML page. This includes such things as
961 inlined images, sounds, and referenced stylesheets.
963 Ordinarily, when downloading a single HTML page, any requisite documents
964 that may be needed to display it properly are not downloaded. Using
965 @samp{-r} together with @samp{-l} can help, but since wget does not
966 ordinarily distinguish between external and inlined documents, one is
967 generally left with "leaf documents" that are missing their requisites.
969 For instance, say document @file{1.html} contains an @code{<IMG>} tag
970 referencing @file{1.gif} and an @code{<A>} tag pointing to external
971 document @file{2.html}. Say that @file{2.html} is the same but that its
972 image is @file{2.gif} and it links to @file{3.html}. Say this
973 continues up to some arbitrarily high number.
975 If one executes the command:
978 wget -r -l 2 http://@var{site}/1.html
981 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
982 @file{3.html} will be downloaded. As you can see, @file{3.html} is
983 without its requisite @file{3.gif} because wget is simply counting the
984 number of hops (up to 2) away from @file{1.html} in order to determine
985 where to stop the recursion. However, with this command:
988 wget -r -l 2 -p http://@var{site}/1.html
991 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
992 will be downloaded. Similarly,
995 wget -r -l 1 -p http://@var{site}/1.html
998 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
999 to be downloaded. One might think that:
1002 wget -r -l 0 -p http://@var{site}/1.html
1005 would download just @file{1.html} and @file{1.gif}, but unfortunately
1006 this is not the case, because @samp{-l 0} is equivalent to @samp{-l inf}
1007 -- that is, infinite recursion. To download a single HTML page (or a
1008 handful of them, all specified on the commandline or in a @samp{-i} @sc{url}
1009 input file) and its requisites, simply leave off @samp{-p} and @samp{-l}:
1012 wget -p http://@var{site}/1.html
1015 Note that wget will behave as if @samp{-r} had been specified, but only
1016 that single page and its requisites will be downloaded. Links from that
1017 page to external documents will not be followed. Actually, to download
1018 a single page and all its requisites (even if they exist on separate
1019 websites), and make sure the lot displays properly locally, this author
1020 likes to use a few options in addition to @samp{-p}:
1023 wget -E -H -k -K -nh -p http://@var{site}/@var{document}
1026 To finish off this topic, it's worth knowing that wget's idea of an
1027 external document link is any URL specified in an @code{<A>} tag, an
1028 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1032 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1033 @section Recursive Accept/Reject Options
1036 @item -A @var{acclist} --accept @var{acclist}
1037 @itemx -R @var{rejlist} --reject @var{rejlist}
1038 Specify comma-separated lists of file name suffixes or patterns to
1039 accept or reject (@pxref{Types of Files} for more details).
1041 @item -D @var{domain-list}
1042 @itemx --domains=@var{domain-list}
1043 Set domains to be accepted and @sc{dns} looked-up, where
1044 @var{domain-list} is a comma-separated list. Note that it does
1045 @emph{not} turn on @samp{-H}. This option speeds things up, even if
1046 only one host is spanned (@pxref{Domain Acceptance}).
1048 @item --exclude-domains @var{domain-list}
1049 Exclude the domains given in a comma-separated @var{domain-list} from
1050 @sc{dns}-lookup (@pxref{Domain Acceptance}).
1052 @cindex follow FTP links
1054 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1055 Wget will ignore all the @sc{ftp} links.
1057 @cindex tag-based recursive pruning
1058 @item --follow-tags=@var{list}
1059 Wget has an internal table of HTML tag / attribute pairs that it
1060 considers when looking for linked documents during a recursive
1061 retrieval. If a user wants only a subset of those tags to be
1062 considered, however, he or she should be specify such tags in a
1063 comma-separated @var{list} with this option.
1066 @itemx --ignore-tags=@var{list}
1067 This is the opposite of the @samp{--follow-tags} option. To skip
1068 certain HTML tags when recursively looking for documents to download,
1069 specify them in a comma-separated @var{list}.
1071 In the past, the @samp{-G} option was the best bet for downloading a
1072 single page and its requisites, using a commandline like:
1075 wget -Ga,area -H -k -K -nh -r http://@var{site}/@var{document}
1078 However, the author of this option came across a page with tags like
1079 @code{<LINK REL="home" HREF="/">} and came to the realization that
1080 @samp{-G} was not enough. One can't just tell wget to ignore
1081 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1082 best bet for downloading a single page and its requisites is the
1083 dedicated @samp{--page-requisites} option.
1087 Enable spanning across hosts when doing recursive retrieving (@pxref{All
1092 Follow relative links only. Useful for retrieving a specific home page
1093 without any distractions, not even those from the same hosts
1094 (@pxref{Relative Links}).
1097 @itemx --include-directories=@var{list}
1098 Specify a comma-separated list of directories you wish to follow when
1099 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1100 of @var{list} may contain wildcards.
1103 @itemx --exclude-directories=@var{list}
1104 Specify a comma-separated list of directories you wish to exclude from
1105 download (@pxref{Directory-Based Limits} for more details.) Elements of
1106 @var{list} may contain wildcards.
1109 @itemx --no-host-lookup
1110 Disable the time-consuming @sc{dns} lookup of almost all hosts
1111 (@pxref{Host Checking}).
1115 Do not ever ascend to the parent directory when retrieving recursively.
1116 This is a useful option, since it guarantees that only the files
1117 @emph{below} a certain hierarchy will be downloaded.
1118 @xref{Directory-Based Limits}, for more details.
1121 @node Recursive Retrieval, Following Links, Invoking, Top
1122 @chapter Recursive Retrieval
1125 @cindex recursive retrieval
1127 GNU Wget is capable of traversing parts of the Web (or a single
1128 @sc{http} or @sc{ftp} server), depth-first following links and directory
1129 structure. This is called @dfn{recursive} retrieving, or
1132 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1133 the given @sc{url}, documents, retrieving the files the @sc{html}
1134 document was referring to, through markups like @code{href}, or
1135 @code{src}. If the freshly downloaded file is also of type
1136 @code{text/html}, it will be parsed and followed further.
1138 The maximum @dfn{depth} to which the retrieval may descend is specified
1139 with the @samp{-l} option (the default maximum depth is five layers).
1140 @xref{Recursive Retrieval}.
1142 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1143 the data from the given directory tree (including the subdirectories up
1144 to the specified depth) on the remote server, creating its mirror image
1145 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1148 By default, Wget will create a local directory tree, corresponding to
1149 the one found on the remote server.
1151 Recursive retrieving can find a number of applications, the most
1152 important of which is mirroring. It is also useful for @sc{www}
1153 presentations, and any other opportunities where slow network
1154 connections should be bypassed by storing the files locally.
1156 You should be warned that invoking recursion may cause grave overloading
1157 on your system, because of the fast exchange of data through the
1158 network; all of this may hamper other users' work. The same stands for
1159 the foreign server you are mirroring---the more requests it gets in a
1160 rows, the greater is its load.
1162 Careless retrieving can also fill your file system uncontrollably, which
1163 can grind the machine to a halt.
1165 The load can be minimized by lowering the maximum recursion level
1166 (@samp{-l}) and/or by lowering the number of retries (@samp{-t}). You
1167 may also consider using the @samp{-w} option to slow down your requests
1168 to the remote servers, as well as the numerous options to narrow the
1169 number of followed links (@pxref{Following Links}).
1171 Recursive retrieval is a good thing when used properly. Please take all
1172 precautions not to wreak havoc through carelessness.
1174 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1175 @chapter Following Links
1177 @cindex following links
1179 When retrieving recursively, one does not wish to retrieve loads of
1180 unnecessary data. Most of the time the users bear in mind exactly what
1181 they want to download, and want Wget to follow only specific links.
1183 For example, if you wish to download the music archive from
1184 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1185 that happen to be referenced by an obscure part of the archive.
1187 Wget possesses several mechanisms that allows you to fine-tune which
1188 links it will follow.
1191 * Relative Links:: Follow relative links only.
1192 * Host Checking:: Follow links on the same host.
1193 * Domain Acceptance:: Check on a list of domains.
1194 * All Hosts:: No host restrictions.
1195 * Types of Files:: Getting only certain files.
1196 * Directory-Based Limits:: Getting only certain directories.
1197 * FTP Links:: Following FTP links.
1200 @node Relative Links, Host Checking, Following Links, Following Links
1201 @section Relative Links
1202 @cindex relative links
1204 When only relative links are followed (option @samp{-L}), recursive
1205 retrieving will never span hosts. No time-expensive @sc{dns}-lookups
1206 will be performed, and the process will be very fast, with the minimum
1207 strain of the network. This will suit your needs often, especially when
1208 mirroring the output of various @code{x2html} converters, since they
1209 generally output relative links.
1211 @node Host Checking, Domain Acceptance, Relative Links, Following Links
1212 @section Host Checking
1215 @cindex host checking
1217 The drawback of following the relative links solely is that humans often
1218 tend to mix them with absolute links to the very same host, and the very
1219 same page. In this mode (which is the default mode for following links)
1220 all @sc{url}s that refer to the same host will be retrieved.
1222 The problem with this option are the aliases of the hosts and domains.
1223 Thus there is no way for Wget to know that @samp{regoc.srce.hr} and
1224 @samp{www.srce.hr} are the same host, or that @samp{fly.srk.fer.hr} is
1225 the same as @samp{fly.cc.fer.hr}. Whenever an absolute link is
1226 encountered, the host is @sc{dns}-looked-up with @code{gethostbyname} to
1227 check whether we are maybe dealing with the same hosts. Although the
1228 results of @code{gethostbyname} are cached, it is still a great
1229 slowdown, e.g. when dealing with large indices of home pages on different
1230 hosts (because each of the hosts must be @sc{dns}-resolved to see
1231 whether it just @emph{might} be an alias of the starting host).
1233 To avoid the overhead you may use @samp{-nh}, which will turn off
1234 @sc{dns}-resolving and make Wget compare hosts literally. This will
1235 make things run much faster, but also much less reliable
1236 (e.g. @samp{www.srce.hr} and @samp{regoc.srce.hr} will be flagged as
1239 Note that modern @sc{http} servers allow one IP address to host several
1240 @dfn{virtual servers}, each having its own directory hierarchy. Such
1241 ``servers'' are distinguished by their hostnames (all of which point to
1242 the same IP address); for this to work, a client must send a @code{Host}
1243 header, which is what Wget does. However, in that case Wget @emph{must
1244 not} try to divine a host's ``real'' address, nor try to use the same
1245 hostname for each access, i.e. @samp{-nh} must be turned on.
1247 In other words, the @samp{-nh} option must be used to enable the
1248 retrieval from virtual servers distinguished by their hostnames. As the
1249 number of such server setups grow, the behavior of @samp{-nh} may become
1250 the default in the future.
1252 @node Domain Acceptance, All Hosts, Host Checking, Following Links
1253 @section Domain Acceptance
1255 With the @samp{-D} option you may specify the domains that will be
1256 followed. The hosts the domain of which is not in this list will not be
1257 @sc{dns}-resolved. Thus you can specify @samp{-Dmit.edu} just to make
1258 sure that @strong{nothing outside of @sc{mit} gets looked up}. This is
1259 very important and useful. It also means that @samp{-D} does @emph{not}
1260 imply @samp{-H} (span all hosts), which must be specified explicitly.
1261 Feel free to use this options since it will speed things up, with almost
1262 all the reliability of checking for all hosts. Thus you could invoke
1265 wget -r -D.hr http://fly.srk.fer.hr/
1268 to make sure that only the hosts in @samp{.hr} domain get
1269 @sc{dns}-looked-up for being equal to @samp{fly.srk.fer.hr}. So
1270 @samp{fly.cc.fer.hr} will be checked (only once!) and found equal, but
1271 @samp{www.gnu.ai.mit.edu} will not even be checked.
1273 Of course, domain acceptance can be used to limit the retrieval to
1274 particular domains with spanning of hosts in them, but then you must
1275 specify @samp{-H} explicitly. E.g.:
1278 wget -r -H -Dmit.edu,stanford.edu http://www.mit.edu/
1281 will start with @samp{http://www.mit.edu/}, following links across
1282 @sc{mit} and Stanford.
1284 If there are domains you want to exclude specifically, you can do it
1285 with @samp{--exclude-domains}, which accepts the same type of arguments
1286 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1287 example, if you want to download all the hosts from @samp{foo.edu}
1288 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1292 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu http://www.foo.edu/
1295 @node All Hosts, Types of Files, Domain Acceptance, Following Links
1300 When @samp{-H} is specified without @samp{-D}, all hosts are freely
1301 spanned. There are no restrictions whatsoever as to what part of the
1302 net Wget will go to fetch documents, other than maximum retrieval depth.
1303 If a page references @samp{www.yahoo.com}, so be it. Such an option is
1304 rarely useful for itself.
1306 @node Types of Files, Directory-Based Limits, All Hosts, Following Links
1307 @section Types of Files
1308 @cindex types of files
1310 When downloading material from the web, you will often want to restrict
1311 the retrieval to only certain file types. For example, if you are
1312 interested in downloading @sc{gif}s, you will not be overjoyed to get
1313 loads of PostScript documents, and vice versa.
1315 Wget offers two options to deal with this problem. Each option
1316 description lists a short name, a long name, and the equivalent command
1319 @cindex accept wildcards
1320 @cindex accept suffixes
1321 @cindex wildcards, accept
1322 @cindex suffixes, accept
1324 @item -A @var{acclist}
1325 @itemx --accept @var{acclist}
1326 @itemx accept = @var{acclist}
1327 The argument to @samp{--accept} option is a list of file suffixes or
1328 patterns that Wget will download during recursive retrieval. A suffix
1329 is the ending part of a file, and consists of ``normal'' letters,
1330 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1331 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1333 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1334 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1335 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1336 download only files beginning with @samp{zelazny} and containing numbers
1337 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1338 a description of how pattern matching works.
1340 Of course, any number of suffixes and patterns can be combined into a
1341 comma-separated list, and given as an argument to @samp{-A}.
1343 @cindex reject wildcards
1344 @cindex reject suffixes
1345 @cindex wildcards, reject
1346 @cindex suffixes, reject
1347 @item -R @var{rejlist}
1348 @itemx --reject @var{rejlist}
1349 @itemx reject = @var{rejlist}
1350 The @samp{--reject} option works the same way as @samp{--accept}, only
1351 its logic is the reverse; Wget will download all files @emph{except} the
1352 ones matching the suffixes (or patterns) in the list.
1354 So, if you want to download a whole page except for the cumbersome
1355 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1356 Analogously, to download all files except the ones beginning with
1357 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1358 expansion by the shell.
1361 The @samp{-A} and @samp{-R} options may be combined to achieve even
1362 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1363 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1364 a part of their name, but @emph{not} the PostScript files.
1366 Note that these two options do not affect the downloading of @sc{html}
1367 files; Wget must load all the @sc{html}s to know where to go at
1368 all---recursive retrieval would make no sense otherwise.
1370 @node Directory-Based Limits, FTP Links, Types of Files, Following Links
1371 @section Directory-Based Limits
1373 @cindex directory limits
1375 Regardless of other link-following facilities, it is often useful to
1376 place the restriction of what files to retrieve based on the directories
1377 those files are placed in. There can be many reasons for this---the
1378 home pages may be organized in a reasonable directory structure; or some
1379 directories may contain useless information, e.g. @file{/cgi-bin} or
1380 @file{/dev} directories.
1382 Wget offers three different options to deal with this requirement. Each
1383 option description lists a short name, a long name, and the equivalent
1384 command in @file{.wgetrc}.
1386 @cindex directories, include
1387 @cindex include directories
1388 @cindex accept directories
1391 @itemx --include @var{list}
1392 @itemx include_directories = @var{list}
1393 @samp{-I} option accepts a comma-separated list of directories included
1394 in the retrieval. Any other directories will simply be ignored. The
1395 directories are absolute paths.
1397 So, if you wish to download from @samp{http://host/people/bozo/}
1398 following only links to bozo's colleagues in the @file{/people}
1399 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1402 wget -I /people,/cgi-bin http://host/people/bozo/
1405 @cindex directories, exclude
1406 @cindex exclude directories
1407 @cindex reject directories
1409 @itemx --exclude @var{list}
1410 @itemx exclude_directories = @var{list}
1411 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1412 directories @emph{excluded} from the download. E.g. if you do not want
1413 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1414 /cgi-bin} on the command line.
1416 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1417 to get a better fine-tuning of downloading subdirectories. E.g. if you
1418 want to load all the files from @file{/pub} hierarchy except for
1419 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1424 @itemx no_parent = on
1425 The simplest, and often very useful way of limiting directories is
1426 disallowing retrieval of the links that refer to the hierarchy
1427 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1428 parent directory/directories.
1430 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1431 Using it guarantees that you will never leave the existing hierarchy.
1432 Supposing you issue Wget with:
1435 wget -r --no-parent http://somehost/~luzer/my-archive/
1438 You may rest assured that none of the references to
1439 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1440 followed. Only the archive you are interested in will be downloaded.
1441 Essentially, @samp{--no-parent} is similar to
1442 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1443 intelligent fashion.
1446 @node FTP Links, , Directory-Based Limits, Following Links
1447 @section Following FTP Links
1448 @cindex following ftp links
1450 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1451 them to be. @sc{ftp} links in @sc{html} documents are often included
1452 for purposes of reference, and it is often inconvenient to download them
1455 To have @sc{ftp} links followed from @sc{html} documents, you need to
1456 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1457 links will span hosts regardless of @samp{-H} setting. This is logical,
1458 as @sc{ftp} links rarely point to the same host where the @sc{http}
1459 server resides. For similar reasons, the @samp{-L} options has no
1460 effect on such downloads. On the other hand, domain acceptance
1461 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1463 Also note that followed links to @sc{ftp} directories will not be
1464 retrieved recursively further.
1466 @node Time-Stamping, Startup File, Following Links, Top
1467 @chapter Time-Stamping
1468 @cindex time-stamping
1469 @cindex timestamping
1470 @cindex updating the archives
1471 @cindex incremental updating
1473 One of the most important aspects of mirroring information from the
1474 Internet is updating your archives.
1476 Downloading the whole archive again and again, just to replace a few
1477 changed files is expensive, both in terms of wasted bandwidth and money,
1478 and the time to do the update. This is why all the mirroring tools
1479 offer the option of incremental updating.
1481 Such an updating mechanism means that the remote server is scanned in
1482 search of @dfn{new} files. Only those new files will be downloaded in
1483 the place of the old ones.
1485 A file is considered new if one of these two conditions are met:
1489 A file of that name does not already exist locally.
1492 A file of that name does exist, but the remote file was modified more
1493 recently than the local file.
1496 To implement this, the program needs to be aware of the time of last
1497 modification of both remote and local files. Such information are
1498 called the @dfn{time-stamps}.
1500 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1501 (@samp{-N}) option, or through @code{timestamping = on} directive in
1502 @file{.wgetrc}. With this option, for each file it intends to download,
1503 Wget will check whether a local file of the same name exists. If it
1504 does, and the remote file is older, Wget will not download it.
1506 If the local file does not exist, or the sizes of the files do not
1507 match, Wget will download the remote file no matter what the time-stamps
1511 * Time-Stamping Usage::
1512 * HTTP Time-Stamping Internals::
1513 * FTP Time-Stamping Internals::
1516 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1517 @section Time-Stamping Usage
1518 @cindex time-stamping usage
1519 @cindex usage, time-stamping
1521 The usage of time-stamping is simple. Say you would like to download a
1522 file so that it keeps its date of modification.
1525 wget -S http://www.gnu.ai.mit.edu/
1528 A simple @code{ls -l} shows that the time stamp on the local file equals
1529 the state of the @code{Last-Modified} header, as returned by the server.
1530 As you can see, the time-stamping info is preserved locally, even
1533 Several days later, you would like Wget to check if the remote file has
1534 changed, and download it if it has.
1537 wget -N http://www.gnu.ai.mit.edu/
1540 Wget will ask the server for the last-modified date. If the local file
1541 is newer, the remote file will not be re-fetched. However, if the remote
1542 file is more recent, Wget will proceed fetching it normally.
1544 The same goes for @sc{ftp}. For example:
1547 wget ftp://ftp.ifi.uio.no/pub/emacs/gnus/*
1550 @code{ls} will show that the timestamps are set according to the state
1551 on the remote server. Reissuing the command with @samp{-N} will make
1552 Wget re-fetch @emph{only} the files that have been modified.
1554 In both @sc{http} and @sc{ftp} retrieval Wget will time-stamp the local
1555 file correctly (with or without @samp{-N}) if it gets the stamps,
1556 i.e. gets the directory listing for @sc{ftp} or the @code{Last-Modified}
1557 header for @sc{http}.
1559 If you wished to mirror the GNU archive every week, you would use the
1560 following command every week:
1563 wget --timestamping -r ftp://prep.ai.mit.edu/pub/gnu/
1566 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1567 @section HTTP Time-Stamping Internals
1568 @cindex http time-stamping
1570 Time-stamping in @sc{http} is implemented by checking of the
1571 @code{Last-Modified} header. If you wish to retrieve the file
1572 @file{foo.html} through @sc{http}, Wget will check whether
1573 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1574 retrieved unconditionally.
1576 If the file does exist locally, Wget will first check its local
1577 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1578 @code{HEAD} request to the remote server, demanding the information on
1581 The @code{Last-Modified} header is examined to find which file was
1582 modified more recently (which makes it ``newer''). If the remote file
1583 is newer, it will be downloaded; if it is older, Wget will give
1584 up.@footnote{As an additional check, Wget will look at the
1585 @code{Content-Length} header, and compare the sizes; if they are not the
1586 same, the remote file will be downloaded no matter what the time-stamp
1589 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1590 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1591 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1592 @samp{@var{X}}, which will always differ if it's been converted by
1593 @samp{--convert-links} (@samp{-k}).
1595 Arguably, @sc{http} time-stamping should be implemented using the
1596 @code{If-Modified-Since} request.
1598 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1599 @section FTP Time-Stamping Internals
1600 @cindex ftp time-stamping
1602 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1603 @sc{ftp} has no headers---time-stamps must be received from the
1606 For each directory files must be retrieved from, Wget will use the
1607 @code{LIST} command to get the listing. It will try to analyze the
1608 listing, assuming that it is a Unix @code{ls -l} listing, and extract
1609 the time-stamps. The rest is exactly the same as for @sc{http}.
1611 Assumption that every directory listing is a Unix-style listing may
1612 sound extremely constraining, but in practice it is not, as many
1613 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1614 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1615 defines no standard way to get a file list, let alone the time-stamps.
1616 We can only hope that a future standard will define this.
1618 Another non-standard solution includes the use of @code{MDTM} command
1619 that is supported by some @sc{ftp} servers (including the popular
1620 @code{wu-ftpd}), which returns the exact time of the specified file.
1621 Wget may support this command in the future.
1623 @node Startup File, Examples, Time-Stamping, Top
1624 @chapter Startup File
1625 @cindex startup file
1631 Once you know how to change default settings of Wget through command
1632 line arguments, you may wish to make some of those settings permanent.
1633 You can do that in a convenient way by creating the Wget startup
1634 file---@file{.wgetrc}.
1636 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1637 convenient to have a special facility for storing passwords. Thus Wget
1638 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1639 it. You can find @file{.netrc} format in your system manuals.
1641 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1645 * Wgetrc Location:: Location of various wgetrc files.
1646 * Wgetrc Syntax:: Syntax of wgetrc.
1647 * Wgetrc Commands:: List of available commands.
1648 * Sample Wgetrc:: A wgetrc example.
1651 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1652 @section Wgetrc Location
1653 @cindex wgetrc location
1654 @cindex location of wgetrc
1656 When initializing, Wget will look for a @dfn{global} startup file,
1657 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1658 @file{/usr/local}, if Wget was not installed there) and read commands
1659 from there, if it exists.
1661 Then it will look for the user's file. If the environmental variable
1662 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1663 further attempts will be made.
1665 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1667 The fact that user's settings are loaded after the system-wide ones
1668 means that in case of collision user's wgetrc @emph{overrides} the
1669 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1670 Fascist admins, away!
1672 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1673 @section Wgetrc Syntax
1674 @cindex wgetrc syntax
1675 @cindex syntax of wgetrc
1677 The syntax of a wgetrc command is simple:
1683 The @dfn{variable} will also be called @dfn{command}. Valid
1684 @dfn{values} are different for different commands.
1686 The commands are case-insensitive and underscore-insensitive. Thus
1687 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1688 beginning with @samp{#} and lines containing white-space only are
1691 Commands that expect a comma-separated list will clear the list on an
1692 empty command. So, if you wish to reset the rejection list specified in
1693 global @file{wgetrc}, you can do it with:
1699 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1700 @section Wgetrc Commands
1701 @cindex wgetrc commands
1703 The complete set of commands is listed below. Legal values are listed
1704 after the @samp{=}. Simple Boolean values can be set or unset using
1705 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
1706 Boolean allowed in some cases is the "lockable" Boolean, which may be
1707 set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
1708 option is set to @samp{always} or @samp{never}, that value will be
1709 locked in for the duration of the wget invocation -- commandline options
1712 Some commands take pseudo-arbitrary values. @var{address} values can be
1713 hostnames or dotted-quad IP addresses. @var{n} can be any positive
1714 integer, or @samp{inf} for infinity, where appropriate. @var{string}
1715 values can be any non-empty string.
1717 Most of these commands have commandline equivalents (@pxref{Invoking}),
1718 though some of the more obscure or rarely used ones do not.
1721 @item accept/reject = @var{string}
1722 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
1724 @item add_hostdir = on/off
1725 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1727 @item continue = on/off
1728 Enable/disable continuation of the retrieval -- the same as @samp{-c}
1731 @item background = on/off
1732 Enable/disable going to background -- the same as @samp{-b} (which enables
1735 @item backup_converted = on/off
1736 Enable/disable saving pre-converted files with the suffix @samp{.orig}
1737 -- the same as @samp{-K} (which enables it).
1739 @c @item backups = @var{number}
1740 @c #### Document me!
1742 @item base = @var{string}
1743 Consider relative @sc{url}s in @sc{url} input files forced to be
1744 interpreted as @sc{html} as being relative to @var{string} -- the same
1747 @item bind_address = @var{address}
1748 Bind to @var{address}, like the @samp{--bind-address} option.
1750 @item cache = on/off
1751 When set to off, disallow server-caching. See the @samp{-C} option.
1753 @item convert links = on/off
1754 Convert non-relative links locally. The same as @samp{-k}.
1756 @item cut_dirs = @var{n}
1757 Ignore @var{n} remote directory components.
1759 @item debug = on/off
1760 Debug mode, same as @samp{-d}.
1762 @item delete_after = on/off
1763 Delete after download -- the same as @samp{--delete-after}.
1765 @item dir_prefix = @var{string}
1766 Top of directory tree -- the same as @samp{-P}.
1768 @item dirstruct = on/off
1769 Turning dirstruct on or off -- the same as @samp{-x} or @samp{-nd},
1772 @item domains = @var{string}
1773 Same as @samp{-D} (@pxref{Domain Acceptance}).
1775 @item dot_bytes = @var{n}
1776 Specify the number of bytes ``contained'' in a dot, as seen throughout
1777 the retrieval (1024 by default). You can postfix the value with
1778 @samp{k} or @samp{m}, representing kilobytes and megabytes,
1779 respectively. With dot settings you can tailor the dot retrieval to
1780 suit your needs, or you can use the predefined @dfn{styles}
1781 (@pxref{Download Options}).
1783 @item dots_in_line = @var{n}
1784 Specify the number of dots that will be printed in each line throughout
1785 the retrieval (50 by default).
1787 @item dot_spacing = @var{n}
1788 Specify the number of dots in a single cluster (10 by default).
1790 @item dot_style = @var{string}
1791 Specify the dot retrieval @dfn{style}, as with @samp{--dot-style}.
1793 @item exclude_directories = @var{string}
1794 Specify a comma-separated list of directories you wish to exclude from
1795 download -- the same as @samp{-X} (@pxref{Directory-Based Limits}).
1797 @item exclude_domains = @var{string}
1798 Same as @samp{--exclude-domains} (@pxref{Domain Acceptance}).
1800 @item follow_ftp = on/off
1801 Follow @sc{ftp} links from @sc{html} documents -- the same as @samp{-f}.
1803 @item follow_tags = @var{string}
1804 Only follow certain HTML tags when doing a recursive retrieval, just like
1805 @samp{--follow-tags}.
1807 @item force_html = on/off
1808 If set to on, force the input filename to be regarded as an @sc{html}
1809 document -- the same as @samp{-F}.
1811 @item ftp_proxy = @var{string}
1812 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
1816 Turn globbing on/off -- the same as @samp{-g}.
1818 @item header = @var{string}
1819 Define an additional header, like @samp{--header}.
1821 @item html_extension = on/off
1822 Add a @samp{.html} extension to @samp{text/html} files without it, like
1825 @item http_passwd = @var{string}
1826 Set @sc{http} password.
1828 @item http_proxy = @var{string}
1829 Use @var{string} as @sc{http} proxy, instead of the one specified in
1832 @item http_user = @var{string}
1833 Set @sc{http} user to @var{string}.
1835 @item ignore_length = on/off
1836 When set to on, ignore @code{Content-Length} header; the same as
1837 @samp{--ignore-length}.
1839 @item ignore_tags = @var{string}
1840 Ignore certain HTML tags when doing a recursive retrieval, just like
1841 @samp{-G} / @samp{--ignore-tags}.
1843 @item include_directories = @var{string}
1844 Specify a comma-separated list of directories you wish to follow when
1845 downloading -- the same as @samp{-I}.
1847 @item input = @var{string}
1848 Read the @sc{url}s from @var{string}, like @samp{-i}.
1850 @item kill_longer = on/off
1851 Consider data longer than specified in content-length header
1852 as invalid (and retry getting it). The default behaviour is to save
1853 as much data as there is, provided there is more than or equal
1854 to the value in @code{Content-Length}.
1856 @item logfile = @var{string}
1857 Set logfile -- the same as @samp{-o}.
1859 @item login = @var{string}
1860 Your user name on the remote machine, for @sc{ftp}. Defaults to
1863 @item mirror = on/off
1864 Turn mirroring on/off. The same as @samp{-m}.
1866 @item netrc = on/off
1867 Turn reading netrc on or off.
1869 @item noclobber = on/off
1872 @item no_parent = on/off
1873 Disallow retrieving outside the directory hierarchy, like
1874 @samp{--no-parent} (@pxref{Directory-Based Limits}).
1876 @item no_proxy = @var{string}
1877 Use @var{string} as the comma-separated list of domains to avoid in
1878 proxy loading, instead of the one specified in environment.
1880 @item output_document = @var{string}
1881 Set the output filename -- the same as @samp{-O}.
1883 @item page_requisites = on/off
1884 Download all ancillary documents necessary for a single HTML page to
1885 display properly -- the same as @samp{-p}.
1887 @item passive_ftp = on/off/always/never
1888 Set passive @sc{ftp} -- the same as @samp{--passive-ftp}. Some scripts
1889 and @samp{.pm} (Perl module) files download files using @samp{wget
1890 --passive-ftp}. If your firewall does not allow this, you can set
1891 @samp{passive_ftp = never} to override the commandline.
1893 @item passwd = @var{string}
1894 Set your @sc{ftp} password to @var{password}. Without this setting, the
1895 password defaults to @samp{username@@hostname.domainname}.
1897 @item proxy_user = @var{string}
1898 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
1900 @item proxy_passwd = @var{string}
1901 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
1903 @item referer = @var{string}
1904 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
1905 was the folks who wrote the @sc{http} spec who got the spelling of
1908 @item quiet = on/off
1909 Quiet mode -- the same as @samp{-q}.
1911 @item quota = @var{quota}
1912 Specify the download quota, which is useful to put in the global
1913 @file{wgetrc}. When download quota is specified, Wget will stop retrieving
1914 after the download sum has become greater than quota. The quota can be
1915 specified in bytes (default), kbytes @samp{k} appended) or mbytes
1916 (@samp{m} appended). Thus @samp{quota = 5m} will set the quota to 5
1917 mbytes. Note that the user's startup file overrides system settings.
1919 @item reclevel = @var{n}
1920 Recursion level -- the same as @samp{-l}.
1922 @item recursive = on/off
1923 Recursive on/off -- the same as @samp{-r}.
1925 @item relative_only = on/off
1926 Follow only relative links -- the same as @samp{-L} (@pxref{Relative
1929 @item remove_listing = on/off
1930 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
1931 to off is the same as @samp{-nr}.
1933 @item retr_symlinks = on/off
1934 When set to on, retrieve symbolic links as if they were plain files; the
1935 same as @samp{--retr-symlinks}.
1937 @item robots = on/off
1938 Use (or not) @file{/robots.txt} file (@pxref{Robots}). Be sure to know
1939 what you are doing before changing the default (which is @samp{on}).
1941 @item server_response = on/off
1942 Choose whether or not to print the @sc{http} and @sc{ftp} server
1943 responses -- the same as @samp{-S}.
1945 @item simple_host_check = on/off
1946 Same as @samp{-nh} (@pxref{Host Checking}).
1948 @item span_hosts = on/off
1951 @item timeout = @var{n}
1952 Set timeout value -- the same as @samp{-T}.
1954 @item timestamping = on/off
1955 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
1957 @item tries = @var{n}
1958 Set number of retries per @sc{url} -- the same as @samp{-t}.
1960 @item use_proxy = on/off
1961 Turn proxy support on/off. The same as @samp{-Y}.
1963 @item verbose = on/off
1964 Turn verbose on/off -- the same as @samp{-v}/@samp{-nv}.
1966 @item wait = @var{n}
1967 Wait @var{n} seconds between retrievals -- the same as @samp{-w}.
1969 @item waitretry = @var{n}
1970 Wait up to @var{n} seconds between retries of failed retrievals only --
1971 the same as @samp{--waitretry}. Note that this is turned on by default
1972 in the global @file{wgetrc}.
1975 @node Sample Wgetrc, , Wgetrc Commands, Startup File
1976 @section Sample Wgetrc
1977 @cindex sample wgetrc
1979 This is the sample initialization file, as given in the distribution.
1980 It is divided in two section---one for global usage (suitable for global
1981 startup file), and one for local usage (suitable for
1982 @file{$HOME/.wgetrc}). Be careful about the things you change.
1984 Note that almost all the lines are commented out. For a command to have
1985 any effect, you must remove the @samp{#} character at the beginning of
1989 @include sample.wgetrc.munged_for_texi_inclusion
1992 @node Examples, Various, Startup File, Top
1996 The examples are classified into three sections, because of clarity.
1997 The first section is a tutorial for beginners. The second section
1998 explains some of the more complex program features. The third section
1999 contains advice for mirror administrators, as well as even more complex
2000 features (that some would call perverted).
2003 * Simple Usage:: Simple, basic usage of the program.
2004 * Advanced Usage:: Advanced techniques of usage.
2005 * Guru Usage:: Mirroring and the hairy stuff.
2008 @node Simple Usage, Advanced Usage, Examples, Examples
2009 @section Simple Usage
2013 Say you want to download a @sc{url}. Just type:
2016 wget http://fly.srk.fer.hr/
2019 The response will be something like:
2023 --13:30:45-- http://fly.srk.fer.hr:80/en/
2025 Connecting to fly.srk.fer.hr:80... connected!
2026 HTTP request sent, awaiting response... 200 OK
2027 Length: 4,694 [text/html]
2031 13:30:46 (23.75 KB/s) - `index.html' saved [4694/4694]
2036 But what will happen if the connection is slow, and the file is lengthy?
2037 The connection will probably fail before the whole file is retrieved,
2038 more than once. In this case, Wget will try getting the file until it
2039 either gets the whole of it, or exceeds the default number of retries
2040 (this being 20). It is easy to change the number of tries to 45, to
2041 insure that the whole file will arrive safely:
2044 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2048 Now let's leave Wget to work in the background, and write its progress
2049 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2050 shall use @samp{-t}.
2053 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2056 The ampersand at the end of the line makes sure that Wget works in the
2057 background. To unlimit the number of retries, use @samp{-t inf}.
2060 The usage of @sc{ftp} is as simple. Wget will take care of login and
2065 $ wget ftp://gnjilux.srk.fer.hr/welcome.msg
2066 --10:08:47-- ftp://gnjilux.srk.fer.hr:21/welcome.msg
2068 Connecting to gnjilux.srk.fer.hr:21... connected!
2069 Logging in as anonymous ... Logged in!
2070 ==> TYPE I ... done. ==> CWD not needed.
2071 ==> PORT ... done. ==> RETR welcome.msg ... done.
2072 Length: 1,340 (unauthoritative)
2076 10:08:48 (1.28 MB/s) - `welcome.msg' saved [1340]
2081 If you specify a directory, Wget will retrieve the directory listing,
2082 parse it and convert it to @sc{html}. Try:
2085 wget ftp://prep.ai.mit.edu/pub/gnu/
2090 @node Advanced Usage, Guru Usage, Simple Usage, Examples
2091 @section Advanced Usage
2095 You would like to read the list of @sc{url}s from a file? Not a problem
2102 If you specify @samp{-} as file name, the @sc{url}s will be read from
2106 Create a mirror image of GNU @sc{www} site (with the same directory structure
2107 the original has) with only one try per document, saving the log of the
2108 activities to @file{gnulog}:
2111 wget -r -t1 http://www.gnu.ai.mit.edu/ -o gnulog
2115 Retrieve the first layer of yahoo links:
2118 wget -r -l1 http://www.yahoo.com/
2122 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2126 wget -S http://www.lycos.com/
2130 Save the server headers with the file:
2132 wget -s http://www.lycos.com/
2137 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2141 wget -P/tmp -l2 ftp://wuarchive.wustl.edu/
2145 You want to download all the @sc{gif}s from an @sc{http} directory.
2146 @samp{wget http://host/dir/*.gif} doesn't work, since @sc{http}
2147 retrieval does not support globbing. In that case, use:
2150 wget -r -l1 --no-parent -A.gif http://host/dir/
2153 It is a bit of a kludge, but it works. @samp{-r -l1} means to retrieve
2154 recursively (@pxref{Recursive Retrieval}), with maximum depth of 1.
2155 @samp{--no-parent} means that references to the parent directory are
2156 ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2157 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2161 Suppose you were in the middle of downloading, when Wget was
2162 interrupted. Now you do not want to clobber the files already present.
2166 wget -nc -r http://www.gnu.ai.mit.edu/
2170 If you want to encode your own username and password to @sc{http} or
2171 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2174 wget ftp://hniksic:mypassword@@jagor.srce.hr/.emacs
2178 If you do not like the default retrieval visualization (1K dots with 10
2179 dots per cluster and 50 dots per line), you can customize it through dot
2180 settings (@pxref{Wgetrc Commands}). For example, many people like the
2181 ``binary'' style of retrieval, with 8K dots and 512K lines:
2184 wget --dot-style=binary ftp://prep.ai.mit.edu/pub/gnu/README
2187 You can experiment with other styles, like:
2190 wget --dot-style=mega ftp://ftp.xemacs.org/pub/xemacs/xemacs-20.4/xemacs-20.4.tar.gz
2191 wget --dot-style=micro http://fly.srk.fer.hr/
2194 To make these settings permanent, put them in your @file{.wgetrc}, as
2195 described before (@pxref{Sample Wgetrc}).
2198 @node Guru Usage, , Advanced Usage, Examples
2204 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2205 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2206 for @samp{-r -N}. You can put Wget in the crontab file asking it to
2207 recheck a site each Sunday:
2211 0 0 * * 0 wget --mirror ftp://ftp.xemacs.org/pub/xemacs/ -o /home/me/weeklog
2215 You may wish to do the same with someone's home page. But you do not
2216 want to download all those images---you're only interested in @sc{html}.
2219 wget --mirror -A.html http://www.w3.org/
2223 But what about mirroring the hosts networkologically close to you? It
2224 seems so awfully slow because of all that @sc{dns} resolving. Just use
2225 @samp{-D} (@pxref{Domain Acceptance}).
2228 wget -rN -Dsrce.hr http://www.srce.hr/
2231 Now Wget will correctly find out that @samp{regoc.srce.hr} is the same
2232 as @samp{www.srce.hr}, but will not even take into consideration the
2233 link to @samp{www.mit.edu}.
2236 You have a presentation and would like the dumb absolute links to be
2237 converted to relative? Use @samp{-k}:
2240 wget -k -r @var{URL}
2243 @cindex redirecting output
2245 You would like the output documents to go to standard output instead of
2246 to files? OK, but Wget will automatically shut up (turn on
2247 @samp{--quiet}) to prevent mixing of Wget output and the retrieved
2251 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2254 You can also combine the two options and make weird pipelines to
2255 retrieve the documents from remote hotlists:
2258 wget -O - http://cool.list.com/ | wget --force-html -i -
2262 @node Various, Appendices, Examples, Top
2266 This chapter contains all the stuff that could not fit anywhere else.
2269 * Proxies:: Support for proxy servers
2270 * Distribution:: Getting the latest version.
2271 * Mailing List:: Wget mailing list for announcements and discussion.
2272 * Reporting Bugs:: How and where to report bugs.
2273 * Portability:: The systems Wget works on.
2274 * Signals:: Signal-handling performed by Wget.
2277 @node Proxies, Distribution, Various, Various
2281 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2282 data from remote servers to local clients. One typical use of proxies
2283 is lightening network load for users behind a slow connection. This is
2284 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2285 proxy which caches the transferred data. When a cached resource is
2286 requested again, proxy will return the data from cache. Another use for
2287 proxies is for companies that separate (for security reasons) their
2288 internal networks from the rest of Internet. In order to obtain
2289 information from the Web, their users connect and retrieve remote data
2290 using an authorized proxy.
2292 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2293 standard way to specify proxy location, which Wget recognizes, is using
2294 the following environment variables:
2298 This variable should contain the @sc{url} of the proxy for @sc{http}
2302 This variable should contain the @sc{url} of the proxy for @sc{http}
2303 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2304 are set to the same @sc{url}.
2307 This variable should contain a comma-separated list of domain extensions
2308 proxy should @emph{not} be used for. For instance, if the value of
2309 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2313 In addition to the environment variables, proxy location and settings
2314 may be specified from within Wget itself.
2318 @itemx --proxy=on/off
2319 @itemx proxy = on/off
2320 This option may be used to turn the proxy support on or off. Proxy
2321 support is on by default, provided that the appropriate environment
2324 @item http_proxy = @var{URL}
2325 @itemx ftp_proxy = @var{URL}
2326 @itemx no_proxy = @var{string}
2327 These startup file variables allow you to override the proxy settings
2328 specified by the environment.
2331 Some proxy servers require authorization to enable you to use them. The
2332 authorization consists of @dfn{username} and @dfn{password}, which must
2333 be sent by Wget. As with @sc{http} authorization, several
2334 authentication schemes exist. For proxy authorization only the
2335 @code{Basic} authentication scheme is currently implemented.
2337 You may specify your username and password either through the proxy
2338 @sc{url} or through the command-line options. Assuming that the
2339 company's proxy is located at @samp{proxy.srce.hr} at port 8001, a proxy
2340 @sc{url} location containing authorization data might look like this:
2343 http://hniksic:mypassword@@proxy.company.com:8001/
2346 Alternatively, you may use the @samp{proxy-user} and
2347 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2348 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2349 username and password.
2351 @node Distribution, Mailing List, Proxies, Various
2352 @section Distribution
2353 @cindex latest version
2355 Like all GNU utilities, the latest version of Wget can be found at the
2356 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2357 Wget @value{VERSION} can be found at
2358 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2360 @node Mailing List, Reporting Bugs, Distribution, Various
2361 @section Mailing List
2362 @cindex mailing list
2365 Wget has its own mailing list at @email{wget@@sunsite.auc.dk}, thanks
2366 to Karsten Thygesen. The mailing list is for discussion of Wget
2367 features and web, reporting Wget bugs (those that you think may be of
2368 interest to the public) and mailing announcements. You are welcome to
2369 subscribe. The more people on the list, the better!
2371 To subscribe, send mail to @email{wget-subscribe@@sunsite.auc.dk}.
2372 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2373 mailing to @email{wget-unsubscribe@@sunsite.auc.dk}.
2375 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2377 @node Reporting Bugs, Portability, Mailing List, Various
2378 @section Reporting Bugs
2380 @cindex reporting bugs
2383 You are welcome to send bug reports about GNU Wget to
2384 @email{bug-wget@@gnu.org}. The bugs that you think are of the
2385 interest to the public (i.e. more people should be informed about them)
2386 can be Cc-ed to the mailing list at @email{wget@@sunsite.auc.dk}.
2388 Before actually submitting a bug report, please try to follow a few
2393 Please try to ascertain that the behaviour you see really is a bug. If
2394 Wget crashes, it's a bug. If Wget does not behave as documented,
2395 it's a bug. If things work strange, but you are not sure about the way
2396 they are supposed to work, it might well be a bug.
2399 Try to repeat the bug in as simple circumstances as possible. E.g. if
2400 Wget crashes on @samp{wget -rLl0 -t5 -Y0 http://yoyodyne.com -o
2401 /tmp/log}, you should try to see if it will crash with a simpler set of
2404 Also, while I will probably be interested to know the contents of your
2405 @file{.wgetrc} file, just dumping it into the debug message is probably
2406 a bad idea. Instead, you should first try to see if the bug repeats
2407 with @file{.wgetrc} moved out of the way. Only if it turns out that
2408 @file{.wgetrc} settings affect the bug, should you mail me the relevant
2412 Please start Wget with @samp{-d} option and send the log (or the
2413 relevant parts of it). If Wget was compiled without debug support,
2414 recompile it. It is @emph{much} easier to trace bugs with debug support
2418 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2419 wget` core} and type @code{where} to get the backtrace.
2422 Find where the bug is, fix it and send me the patches. :-)
2425 @node Portability, Signals, Reporting Bugs, Various
2426 @section Portability
2428 @cindex operating systems
2430 Since Wget uses GNU Autoconf for building and configuring, and avoids
2431 using ``special'' ultra--mega--cool features of any particular Unix, it
2432 should compile (and work) on all common Unix flavors.
2434 Various Wget versions have been compiled and tested under many kinds of
2435 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2436 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2437 distribution directory for a comprehensive list. If you compile it on
2438 an architecture not listed there, please let me know so I can update it.
2440 Wget should also compile on the other Unix systems, not listed in
2441 @file{MACHINES}. If it doesn't, please let me know.
2443 Thanks to kind contributors, this version of Wget compiles and works on
2444 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2445 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2446 with Winsock as networking software. Naturally, it is crippled of some
2447 features available on Unix, but it should work as a substitute for
2448 people stuck with Windows. Note that the Windows port is
2449 @strong{neither tested nor maintained} by me---all questions and
2450 problems should be reported to Wget mailing list at
2451 @email{wget@@sunsite.auc.dk} where the maintainers will look at them.
2453 @node Signals, , Portability, Various
2455 @cindex signal handling
2458 Since the purpose of Wget is background work, it catches the hangup
2459 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2460 output, it will be redirected to a file named @file{wget-log}.
2461 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2462 to redirect the output of Wget after having started it.
2465 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2466 $ kill -HUP %% # Redirect the output to wget-log
2469 Other than that, Wget will not try to interfere with signals in any
2470 way. @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it
2473 @node Appendices, Copying, Various, Top
2476 This chapter contains some references I consider useful.
2479 * Robots:: Wget as a WWW robot.
2480 * Security Considerations:: Security with Wget.
2481 * Contributors:: People who helped.
2484 @node Robots, Security Considerations, Appendices, Appendices
2488 @cindex server maintenance
2490 It is extremely easy to make Wget wander aimlessly around a web site,
2491 sucking all the available data in progress. @samp{wget -r @var{site}},
2492 and you're set. Great? Not for the server admin.
2494 While Wget is retrieving static pages, there's not much of a problem.
2495 But for Wget, there is no real difference between the smallest static
2496 page and the hardest, most demanding CGI or dynamic page. For instance,
2497 a site I know has a section handled by an, uh, bitchin' CGI script that
2498 converts all the Info files to HTML. The script can and does bring the
2499 machine to its knees without providing anything useful to the
2502 For such and similar cases various robot exclusion schemes have been
2503 devised as a means for the server administrators and document authors to
2504 protect chosen portions of their sites from the wandering of robots.
2506 The more popular mechanism is the @dfn{Robots Exclusion Standard}
2507 written by Martijn Koster et al. in 1994. It is specified by placing a
2508 file named @file{/robots.txt} in the server root, which the robots are
2509 supposed to download and parse. Wget supports this specification.
2511 Norobots support is turned on only when retrieving recursively, and
2512 @emph{never} for the first page. Thus, you may issue:
2515 wget -r http://fly.srk.fer.hr/
2518 First the index of fly.srk.fer.hr will be downloaded. If Wget finds
2519 anything worth downloading on the same host, only @emph{then} will it
2520 load the robots, and decide whether or not to load the links after all.
2521 @file{/robots.txt} is loaded only once per host.
2523 Note that the exlusion standard discussed here has undergone some
2524 revisions. However, but Wget supports only the first version of
2525 @sc{res}, the one written by Martijn Koster in 1994, available at
2526 @url{http://info.webcrawler.com/mak/projects/robots/norobots.html}. A
2527 later version exists in the form of an internet draft
2528 <draft-koster-robots-00.txt> titled ``A Method for Web Robots Control'',
2529 which expired on June 4, 1997. I am not aware if it ever made to an
2530 @sc{rfc}. The text of the draft is available at
2531 @url{http://info.webcrawler.com/mak/projects/robots/norobots-rfc.html}.
2532 Wget does not yet support the new directives specified by this draft,
2533 but we plan to add them.
2535 This manual no longer includes the text of the old standard.
2537 The second, less known mechanism, enables the author of an individual
2538 document to specify whether they want the links from the file to be
2539 followed by a robot. This is achieved using the @code{META} tag, like
2543 <meta name="robots" content="nofollow">
2546 This is explained in some detail at
2547 @url{http://info.webcrawler.com/mak/projects/robots/meta-user.html}.
2548 Unfortunately, Wget does not support this method of robot exclusion yet,
2549 but it will be implemented in the next release.
2551 @node Security Considerations, Contributors, Robots, Appendices
2552 @section Security Considerations
2555 When using Wget, you must be aware that it sends unencrypted passwords
2556 through the network, which may present a security problem. Here are the
2557 main issues, and some solutions.
2561 The passwords on the command line are visible using @code{ps}. If this
2562 is a problem, avoid putting passwords from the command line---e.g. you
2563 can use @file{.netrc} for this.
2566 Using the insecure @dfn{basic} authentication scheme, unencrypted
2567 passwords are transmitted through the network routers and gateways.
2570 The @sc{ftp} passwords are also in no way encrypted. There is no good
2571 solution for this at the moment.
2574 Although the ``normal'' output of Wget tries to hide the passwords,
2575 debugging logs show them, in all forms. This problem is avoided by
2576 being careful when you send debug logs (yes, even when you send them to
2580 @node Contributors, , Security Considerations, Appendices
2581 @section Contributors
2582 @cindex contributors
2585 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
2588 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
2590 However, its development could never have gone as far as it has, were it
2591 not for the help of many people, either with bug reports, feature
2592 proposals, patches, or letters saying ``Thanks!''.
2594 Special thanks goes to the following people (no particular order):
2598 Karsten Thygesen---donated system resources such as the mailing list,
2599 web space, and @sc{ftp} space, along with a lot of time to make these
2603 Shawn McHorse---bug reports and patches.
2606 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
2610 Gordon Matzigkeit---@file{.netrc} support.
2614 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2615 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2618 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2619 and ``philosophical'' discussions.
2623 Darko Budor---initial port to Windows.
2626 Antonio Rosella---help and suggestions, plus the Italian translation.
2630 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2634 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2639 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2642 Francois Pinard---many thorough bug reports and discussions.
2646 Karl Eichwalder---lots of help with internationalization and other
2650 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2654 Brian Gough---a generous donation.
2657 The following people have provided patches, bug/build reports, useful
2658 suggestions, beta testing services, fan mail and all the other things
2659 that make maintenance so much fun:
2665 Roger Beeman and the Gurus at Cisco,
2674 Kristijan @v{C}onka@v{s},
2691 Aleksandar Erkalovi@'{c},
2694 Aleksandar Erkalovic,
2707 Erik Magnus Hulthen,
2718 Goran Kezunovi@'{c},
2728 $\Sigma\acute{\iota}\mu o\varsigma\;
2729 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
2730 (Simos KSenitellis),
2738 Alexander V. Lukyanov,
2751 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
2753 Juan Jos\'{e} Rodr\'{\i}gues,
2756 Juan Jose Rodrigues,
2766 Szakacsits Szabolcs,
2770 Douglas E. Wegscheid,
2780 Apologies to all who I accidentally left out, and many thanks to all the
2781 subscribers of the Wget mailing list.
2783 @node Copying, Concept Index, Appendices, Top
2789 Wget is @dfn{free software}, where ``free'' refers to liberty, not
2790 price. The exact legal distribution terms follow below, but in short,
2791 it means that you have the right (freedom) to run and change and copy
2792 Wget, and even---if you want---charge money for any of those things.
2793 The sole restriction is that you have to grant your recipients the same
2796 This method of licensing software is also known as @dfn{open-source},
2797 because it requires that the recipients always receive a program's
2798 source code along with the program.
2803 This program is free software; you can redistribute it and/or modify it
2804 under the terms of the GNU General Public License as published by the
2805 Free Software Foundation; either version 2 of the License, or (at your
2806 option) any later version.
2808 This program is distributed in the hope that it will be useful, but
2809 WITHOUT ANY WARRANTY; without even the implied warranty of
2810 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2811 General Public License for more details.
2813 You should have received a copy of the GNU General Public License
2814 along with this program; if not, write to the Free Software
2815 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
2818 In addition to this, this manual is free in the same sense:
2821 Permission is granted to copy, distribute and/or modify this document
2822 under the terms of the GNU Free Documentation License, Version 1.1 or
2823 any later version published by the Free Software Foundation; with the
2824 Invariant Sections being ``GNU General Public License'' and ``GNU Free
2825 Documentation License'', with no Front-Cover Texts, and with no
2826 Back-Cover Texts. A copy of the license is included in the section
2827 entitled ``GNU Free Documentation License''.
2830 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
2831 @c that the GFDL needs to be present in the manual, and to me it would
2832 @c suck to include the license for the manual and not the license for
2835 The full texts of the GNU General Public License and of the GNU Free
2836 Documentation License are available below.
2839 * GNU General Public License::
2840 * GNU Free Documentation License::
2843 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
2844 @section GNU General Public License
2845 @center Version 2, June 1991
2848 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
2849 675 Mass Ave, Cambridge, MA 02139, USA
2851 Everyone is permitted to copy and distribute verbatim copies
2852 of this license document, but changing it is not allowed.
2855 @unnumberedsec Preamble
2857 The licenses for most software are designed to take away your
2858 freedom to share and change it. By contrast, the GNU General Public
2859 License is intended to guarantee your freedom to share and change free
2860 software---to make sure the software is free for all its users. This
2861 General Public License applies to most of the Free Software
2862 Foundation's software and to any other program whose authors commit to
2863 using it. (Some other Free Software Foundation software is covered by
2864 the GNU Library General Public License instead.) You can apply it to
2867 When we speak of free software, we are referring to freedom, not
2868 price. Our General Public Licenses are designed to make sure that you
2869 have the freedom to distribute copies of free software (and charge for
2870 this service if you wish), that you receive source code or can get it
2871 if you want it, that you can change the software or use pieces of it
2872 in new free programs; and that you know you can do these things.
2874 To protect your rights, we need to make restrictions that forbid
2875 anyone to deny you these rights or to ask you to surrender the rights.
2876 These restrictions translate to certain responsibilities for you if you
2877 distribute copies of the software, or if you modify it.
2879 For example, if you distribute copies of such a program, whether
2880 gratis or for a fee, you must give the recipients all the rights that
2881 you have. You must make sure that they, too, receive or can get the
2882 source code. And you must show them these terms so they know their
2885 We protect your rights with two steps: (1) copyright the software, and
2886 (2) offer you this license which gives you legal permission to copy,
2887 distribute and/or modify the software.
2889 Also, for each author's protection and ours, we want to make certain
2890 that everyone understands that there is no warranty for this free
2891 software. If the software is modified by someone else and passed on, we
2892 want its recipients to know that what they have is not the original, so
2893 that any problems introduced by others will not reflect on the original
2894 authors' reputations.
2896 Finally, any free program is threatened constantly by software
2897 patents. We wish to avoid the danger that redistributors of a free
2898 program will individually obtain patent licenses, in effect making the
2899 program proprietary. To prevent this, we have made it clear that any
2900 patent must be licensed for everyone's free use or not licensed at all.
2902 The precise terms and conditions for copying, distribution and
2903 modification follow.
2906 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2909 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2914 This License applies to any program or other work which contains
2915 a notice placed by the copyright holder saying it may be distributed
2916 under the terms of this General Public License. The ``Program'', below,
2917 refers to any such program or work, and a ``work based on the Program''
2918 means either the Program or any derivative work under copyright law:
2919 that is to say, a work containing the Program or a portion of it,
2920 either verbatim or with modifications and/or translated into another
2921 language. (Hereinafter, translation is included without limitation in
2922 the term ``modification''.) Each licensee is addressed as ``you''.
2924 Activities other than copying, distribution and modification are not
2925 covered by this License; they are outside its scope. The act of
2926 running the Program is not restricted, and the output from the Program
2927 is covered only if its contents constitute a work based on the
2928 Program (independent of having been made by running the Program).
2929 Whether that is true depends on what the Program does.
2932 You may copy and distribute verbatim copies of the Program's
2933 source code as you receive it, in any medium, provided that you
2934 conspicuously and appropriately publish on each copy an appropriate
2935 copyright notice and disclaimer of warranty; keep intact all the
2936 notices that refer to this License and to the absence of any warranty;
2937 and give any other recipients of the Program a copy of this License
2938 along with the Program.
2940 You may charge a fee for the physical act of transferring a copy, and
2941 you may at your option offer warranty protection in exchange for a fee.
2944 You may modify your copy or copies of the Program or any portion
2945 of it, thus forming a work based on the Program, and copy and
2946 distribute such modifications or work under the terms of Section 1
2947 above, provided that you also meet all of these conditions:
2951 You must cause the modified files to carry prominent notices
2952 stating that you changed the files and the date of any change.
2955 You must cause any work that you distribute or publish, that in
2956 whole or in part contains or is derived from the Program or any
2957 part thereof, to be licensed as a whole at no charge to all third
2958 parties under the terms of this License.
2961 If the modified program normally reads commands interactively
2962 when run, you must cause it, when started running for such
2963 interactive use in the most ordinary way, to print or display an
2964 announcement including an appropriate copyright notice and a
2965 notice that there is no warranty (or else, saying that you provide
2966 a warranty) and that users may redistribute the program under
2967 these conditions, and telling the user how to view a copy of this
2968 License. (Exception: if the Program itself is interactive but
2969 does not normally print such an announcement, your work based on
2970 the Program is not required to print an announcement.)
2973 These requirements apply to the modified work as a whole. If
2974 identifiable sections of that work are not derived from the Program,
2975 and can be reasonably considered independent and separate works in
2976 themselves, then this License, and its terms, do not apply to those
2977 sections when you distribute them as separate works. But when you
2978 distribute the same sections as part of a whole which is a work based
2979 on the Program, the distribution of the whole must be on the terms of
2980 this License, whose permissions for other licensees extend to the
2981 entire whole, and thus to each and every part regardless of who wrote it.
2983 Thus, it is not the intent of this section to claim rights or contest
2984 your rights to work written entirely by you; rather, the intent is to
2985 exercise the right to control the distribution of derivative or
2986 collective works based on the Program.
2988 In addition, mere aggregation of another work not based on the Program
2989 with the Program (or with a work based on the Program) on a volume of
2990 a storage or distribution medium does not bring the other work under
2991 the scope of this License.
2994 You may copy and distribute the Program (or a work based on it,
2995 under Section 2) in object code or executable form under the terms of
2996 Sections 1 and 2 above provided that you also do one of the following:
3000 Accompany it with the complete corresponding machine-readable
3001 source code, which must be distributed under the terms of Sections
3002 1 and 2 above on a medium customarily used for software interchange; or,
3005 Accompany it with a written offer, valid for at least three
3006 years, to give any third party, for a charge no more than your
3007 cost of physically performing source distribution, a complete
3008 machine-readable copy of the corresponding source code, to be
3009 distributed under the terms of Sections 1 and 2 above on a medium
3010 customarily used for software interchange; or,
3013 Accompany it with the information you received as to the offer
3014 to distribute corresponding source code. (This alternative is
3015 allowed only for noncommercial distribution and only if you
3016 received the program in object code or executable form with such
3017 an offer, in accord with Subsection b above.)
3020 The source code for a work means the preferred form of the work for
3021 making modifications to it. For an executable work, complete source
3022 code means all the source code for all modules it contains, plus any
3023 associated interface definition files, plus the scripts used to
3024 control compilation and installation of the executable. However, as a
3025 special exception, the source code distributed need not include
3026 anything that is normally distributed (in either source or binary
3027 form) with the major components (compiler, kernel, and so on) of the
3028 operating system on which the executable runs, unless that component
3029 itself accompanies the executable.
3031 If distribution of executable or object code is made by offering
3032 access to copy from a designated place, then offering equivalent
3033 access to copy the source code from the same place counts as
3034 distribution of the source code, even though third parties are not
3035 compelled to copy the source along with the object code.
3038 You may not copy, modify, sublicense, or distribute the Program
3039 except as expressly provided under this License. Any attempt
3040 otherwise to copy, modify, sublicense or distribute the Program is
3041 void, and will automatically terminate your rights under this License.
3042 However, parties who have received copies, or rights, from you under
3043 this License will not have their licenses terminated so long as such
3044 parties remain in full compliance.
3047 You are not required to accept this License, since you have not
3048 signed it. However, nothing else grants you permission to modify or
3049 distribute the Program or its derivative works. These actions are
3050 prohibited by law if you do not accept this License. Therefore, by
3051 modifying or distributing the Program (or any work based on the
3052 Program), you indicate your acceptance of this License to do so, and
3053 all its terms and conditions for copying, distributing or modifying
3054 the Program or works based on it.
3057 Each time you redistribute the Program (or any work based on the
3058 Program), the recipient automatically receives a license from the
3059 original licensor to copy, distribute or modify the Program subject to
3060 these terms and conditions. You may not impose any further
3061 restrictions on the recipients' exercise of the rights granted herein.
3062 You are not responsible for enforcing compliance by third parties to
3066 If, as a consequence of a court judgment or allegation of patent
3067 infringement or for any other reason (not limited to patent issues),
3068 conditions are imposed on you (whether by court order, agreement or
3069 otherwise) that contradict the conditions of this License, they do not
3070 excuse you from the conditions of this License. If you cannot
3071 distribute so as to satisfy simultaneously your obligations under this
3072 License and any other pertinent obligations, then as a consequence you
3073 may not distribute the Program at all. For example, if a patent
3074 license would not permit royalty-free redistribution of the Program by
3075 all those who receive copies directly or indirectly through you, then
3076 the only way you could satisfy both it and this License would be to
3077 refrain entirely from distribution of the Program.
3079 If any portion of this section is held invalid or unenforceable under
3080 any particular circumstance, the balance of the section is intended to
3081 apply and the section as a whole is intended to apply in other
3084 It is not the purpose of this section to induce you to infringe any
3085 patents or other property right claims or to contest validity of any
3086 such claims; this section has the sole purpose of protecting the
3087 integrity of the free software distribution system, which is
3088 implemented by public license practices. Many people have made
3089 generous contributions to the wide range of software distributed
3090 through that system in reliance on consistent application of that
3091 system; it is up to the author/donor to decide if he or she is willing
3092 to distribute software through any other system and a licensee cannot
3095 This section is intended to make thoroughly clear what is believed to
3096 be a consequence of the rest of this License.
3099 If the distribution and/or use of the Program is restricted in
3100 certain countries either by patents or by copyrighted interfaces, the
3101 original copyright holder who places the Program under this License
3102 may add an explicit geographical distribution limitation excluding
3103 those countries, so that distribution is permitted only in or among
3104 countries not thus excluded. In such case, this License incorporates
3105 the limitation as if written in the body of this License.
3108 The Free Software Foundation may publish revised and/or new versions
3109 of the General Public License from time to time. Such new versions will
3110 be similar in spirit to the present version, but may differ in detail to
3111 address new problems or concerns.
3113 Each version is given a distinguishing version number. If the Program
3114 specifies a version number of this License which applies to it and ``any
3115 later version'', you have the option of following the terms and conditions
3116 either of that version or of any later version published by the Free
3117 Software Foundation. If the Program does not specify a version number of
3118 this License, you may choose any version ever published by the Free Software
3122 If you wish to incorporate parts of the Program into other free
3123 programs whose distribution conditions are different, write to the author
3124 to ask for permission. For software which is copyrighted by the Free
3125 Software Foundation, write to the Free Software Foundation; we sometimes
3126 make exceptions for this. Our decision will be guided by the two goals
3127 of preserving the free status of all derivatives of our free software and
3128 of promoting the sharing and reuse of software generally.
3131 @heading NO WARRANTY
3139 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3140 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3141 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3142 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3143 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3144 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3145 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3146 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3147 REPAIR OR CORRECTION.
3150 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3151 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3152 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3153 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3154 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3155 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3156 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3157 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3158 POSSIBILITY OF SUCH DAMAGES.
3162 @heading END OF TERMS AND CONDITIONS
3165 @center END OF TERMS AND CONDITIONS
3169 @unnumberedsec How to Apply These Terms to Your New Programs
3171 If you develop a new program, and you want it to be of the greatest
3172 possible use to the public, the best way to achieve this is to make it
3173 free software which everyone can redistribute and change under these terms.
3175 To do so, attach the following notices to the program. It is safest
3176 to attach them to the start of each source file to most effectively
3177 convey the exclusion of warranty; and each file should have at least
3178 the ``copyright'' line and a pointer to where the full notice is found.
3181 @var{one line to give the program's name and an idea of what it does.}
3182 Copyright (C) 19@var{yy} @var{name of author}
3184 This program is free software; you can redistribute it and/or
3185 modify it under the terms of the GNU General Public License
3186 as published by the Free Software Foundation; either version 2
3187 of the License, or (at your option) any later version.
3189 This program is distributed in the hope that it will be useful,
3190 but WITHOUT ANY WARRANTY; without even the implied warranty of
3191 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3192 GNU General Public License for more details.
3194 You should have received a copy of the GNU General Public License
3195 along with this program; if not, write to the Free Software
3196 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3199 Also add information on how to contact you by electronic and paper mail.
3201 If the program is interactive, make it output a short notice like this
3202 when it starts in an interactive mode:
3205 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3206 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3207 type `show w'. This is free software, and you are welcome
3208 to redistribute it under certain conditions; type `show c'
3212 The hypothetical commands @samp{show w} and @samp{show c} should show
3213 the appropriate parts of the General Public License. Of course, the
3214 commands you use may be called something other than @samp{show w} and
3215 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3218 You should also get your employer (if you work as a programmer) or your
3219 school, if any, to sign a ``copyright disclaimer'' for the program, if
3220 necessary. Here is a sample; alter the names:
3224 Yoyodyne, Inc., hereby disclaims all copyright
3225 interest in the program `Gnomovision'
3226 (which makes passes at compilers) written
3229 @var{signature of Ty Coon}, 1 April 1989
3230 Ty Coon, President of Vice
3234 This General Public License does not permit incorporating your program into
3235 proprietary programs. If your program is a subroutine library, you may
3236 consider it more useful to permit linking proprietary applications with the
3237 library. If this is what you want to do, use the GNU Library General
3238 Public License instead of this License.
3240 @node GNU Free Documentation License, , GNU General Public License, Copying
3241 @section GNU Free Documentation License
3242 @center Version 1.1, March 2000
3245 Copyright (C) 2000 Free Software Foundation, Inc.
3246 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3248 Everyone is permitted to copy and distribute verbatim copies
3249 of this license document, but changing it is not allowed.
3256 The purpose of this License is to make a manual, textbook, or other
3257 written document ``free'' in the sense of freedom: to assure everyone
3258 the effective freedom to copy and redistribute it, with or without
3259 modifying it, either commercially or noncommercially. Secondarily,
3260 this License preserves for the author and publisher a way to get
3261 credit for their work, while not being considered responsible for
3262 modifications made by others.
3264 This License is a kind of ``copyleft'', which means that derivative
3265 works of the document must themselves be free in the same sense. It
3266 complements the GNU General Public License, which is a copyleft
3267 license designed for free software.
3269 We have designed this License in order to use it for manuals for free
3270 software, because free software needs free documentation: a free
3271 program should come with manuals providing the same freedoms that the
3272 software does. But this License is not limited to software manuals;
3273 it can be used for any textual work, regardless of subject matter or
3274 whether it is published as a printed book. We recommend this License
3275 principally for works whose purpose is instruction or reference.
3279 APPLICABILITY AND DEFINITIONS
3281 This License applies to any manual or other work that contains a
3282 notice placed by the copyright holder saying it can be distributed
3283 under the terms of this License. The ``Document'', below, refers to any
3284 such manual or work. Any member of the public is a licensee, and is
3285 addressed as ``you''.
3287 A ``Modified Version'' of the Document means any work containing the
3288 Document or a portion of it, either copied verbatim, or with
3289 modifications and/or translated into another language.
3291 A ``Secondary Section'' is a named appendix or a front-matter section of
3292 the Document that deals exclusively with the relationship of the
3293 publishers or authors of the Document to the Document's overall subject
3294 (or to related matters) and contains nothing that could fall directly
3295 within that overall subject. (For example, if the Document is in part a
3296 textbook of mathematics, a Secondary Section may not explain any
3297 mathematics.) The relationship could be a matter of historical
3298 connection with the subject or with related matters, or of legal,
3299 commercial, philosophical, ethical or political position regarding
3302 The ``Invariant Sections'' are certain Secondary Sections whose titles
3303 are designated, as being those of Invariant Sections, in the notice
3304 that says that the Document is released under this License.
3306 The ``Cover Texts'' are certain short passages of text that are listed,
3307 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3308 the Document is released under this License.
3310 A ``Transparent'' copy of the Document means a machine-readable copy,
3311 represented in a format whose specification is available to the
3312 general public, whose contents can be viewed and edited directly and
3313 straightforwardly with generic text editors or (for images composed of
3314 pixels) generic paint programs or (for drawings) some widely available
3315 drawing editor, and that is suitable for input to text formatters or
3316 for automatic translation to a variety of formats suitable for input
3317 to text formatters. A copy made in an otherwise Transparent file
3318 format whose markup has been designed to thwart or discourage
3319 subsequent modification by readers is not Transparent. A copy that is
3320 not ``Transparent'' is called ``Opaque''.
3322 Examples of suitable formats for Transparent copies include plain
3323 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3324 or XML using a publicly available DTD, and standard-conforming simple
3325 HTML designed for human modification. Opaque formats include
3326 PostScript, PDF, proprietary formats that can be read and edited only
3327 by proprietary word processors, SGML or XML for which the DTD and/or
3328 processing tools are not generally available, and the
3329 machine-generated HTML produced by some word processors for output
3332 The ``Title Page'' means, for a printed book, the title page itself,
3333 plus such following pages as are needed to hold, legibly, the material
3334 this License requires to appear in the title page. For works in
3335 formats which do not have any title page as such, ``Title Page'' means
3336 the text near the most prominent appearance of the work's title,
3337 preceding the beginning of the body of the text.
3342 You may copy and distribute the Document in any medium, either
3343 commercially or noncommercially, provided that this License, the
3344 copyright notices, and the license notice saying this License applies
3345 to the Document are reproduced in all copies, and that you add no other
3346 conditions whatsoever to those of this License. You may not use
3347 technical measures to obstruct or control the reading or further
3348 copying of the copies you make or distribute. However, you may accept
3349 compensation in exchange for copies. If you distribute a large enough
3350 number of copies you must also follow the conditions in section 3.
3352 You may also lend copies, under the same conditions stated above, and
3353 you may publicly display copies.
3358 If you publish printed copies of the Document numbering more than 100,
3359 and the Document's license notice requires Cover Texts, you must enclose
3360 the copies in covers that carry, clearly and legibly, all these Cover
3361 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3362 the back cover. Both covers must also clearly and legibly identify
3363 you as the publisher of these copies. The front cover must present
3364 the full title with all words of the title equally prominent and
3365 visible. You may add other material on the covers in addition.
3366 Copying with changes limited to the covers, as long as they preserve
3367 the title of the Document and satisfy these conditions, can be treated
3368 as verbatim copying in other respects.
3370 If the required texts for either cover are too voluminous to fit
3371 legibly, you should put the first ones listed (as many as fit
3372 reasonably) on the actual cover, and continue the rest onto adjacent
3375 If you publish or distribute Opaque copies of the Document numbering
3376 more than 100, you must either include a machine-readable Transparent
3377 copy along with each Opaque copy, or state in or with each Opaque copy
3378 a publicly-accessible computer-network location containing a complete
3379 Transparent copy of the Document, free of added material, which the
3380 general network-using public has access to download anonymously at no
3381 charge using public-standard network protocols. If you use the latter
3382 option, you must take reasonably prudent steps, when you begin
3383 distribution of Opaque copies in quantity, to ensure that this
3384 Transparent copy will remain thus accessible at the stated location
3385 until at least one year after the last time you distribute an Opaque
3386 copy (directly or through your agents or retailers) of that edition to
3389 It is requested, but not required, that you contact the authors of the
3390 Document well before redistributing any large number of copies, to give
3391 them a chance to provide you with an updated version of the Document.
3396 You may copy and distribute a Modified Version of the Document under
3397 the conditions of sections 2 and 3 above, provided that you release
3398 the Modified Version under precisely this License, with the Modified
3399 Version filling the role of the Document, thus licensing distribution
3400 and modification of the Modified Version to whoever possesses a copy
3401 of it. In addition, you must do these things in the Modified Version:
3403 A. Use in the Title Page (and on the covers, if any) a title distinct
3404 from that of the Document, and from those of previous versions
3405 (which should, if there were any, be listed in the History section
3406 of the Document). You may use the same title as a previous version
3407 if the original publisher of that version gives permission.@*
3408 B. List on the Title Page, as authors, one or more persons or entities
3409 responsible for authorship of the modifications in the Modified
3410 Version, together with at least five of the principal authors of the
3411 Document (all of its principal authors, if it has less than five).@*
3412 C. State on the Title page the name of the publisher of the
3413 Modified Version, as the publisher.@*
3414 D. Preserve all the copyright notices of the Document.@*
3415 E. Add an appropriate copyright notice for your modifications
3416 adjacent to the other copyright notices.@*
3417 F. Include, immediately after the copyright notices, a license notice
3418 giving the public permission to use the Modified Version under the
3419 terms of this License, in the form shown in the Addendum below.@*
3420 G. Preserve in that license notice the full lists of Invariant Sections
3421 and required Cover Texts given in the Document's license notice.@*
3422 H. Include an unaltered copy of this License.@*
3423 I. Preserve the section entitled ``History'', and its title, and add to
3424 it an item stating at least the title, year, new authors, and
3425 publisher of the Modified Version as given on the Title Page. If
3426 there is no section entitled ``History'' in the Document, create one
3427 stating the title, year, authors, and publisher of the Document as
3428 given on its Title Page, then add an item describing the Modified
3429 Version as stated in the previous sentence.@*
3430 J. Preserve the network location, if any, given in the Document for
3431 public access to a Transparent copy of the Document, and likewise
3432 the network locations given in the Document for previous versions
3433 it was based on. These may be placed in the ``History'' section.
3434 You may omit a network location for a work that was published at
3435 least four years before the Document itself, or if the original
3436 publisher of the version it refers to gives permission.@*
3437 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3438 preserve the section's title, and preserve in the section all the
3439 substance and tone of each of the contributor acknowledgements
3440 and/or dedications given therein.@*
3441 L. Preserve all the Invariant Sections of the Document,
3442 unaltered in their text and in their titles. Section numbers
3443 or the equivalent are not considered part of the section titles.@*
3444 M. Delete any section entitled ``Endorsements''. Such a section
3445 may not be included in the Modified Version.@*
3446 N. Do not retitle any existing section as ``Endorsements''
3447 or to conflict in title with any Invariant Section.@*
3449 If the Modified Version includes new front-matter sections or
3450 appendices that qualify as Secondary Sections and contain no material
3451 copied from the Document, you may at your option designate some or all
3452 of these sections as invariant. To do this, add their titles to the
3453 list of Invariant Sections in the Modified Version's license notice.
3454 These titles must be distinct from any other section titles.
3456 You may add a section entitled ``Endorsements'', provided it contains
3457 nothing but endorsements of your Modified Version by various
3458 parties--for example, statements of peer review or that the text has
3459 been approved by an organization as the authoritative definition of a
3462 You may add a passage of up to five words as a Front-Cover Text, and a
3463 passage of up to 25 words as a Back-Cover Text, to the end of the list
3464 of Cover Texts in the Modified Version. Only one passage of
3465 Front-Cover Text and one of Back-Cover Text may be added by (or
3466 through arrangements made by) any one entity. If the Document already
3467 includes a cover text for the same cover, previously added by you or
3468 by arrangement made by the same entity you are acting on behalf of,
3469 you may not add another; but you may replace the old one, on explicit
3470 permission from the previous publisher that added the old one.
3472 The author(s) and publisher(s) of the Document do not by this License
3473 give permission to use their names for publicity for or to assert or
3474 imply endorsement of any Modified Version.
3479 You may combine the Document with other documents released under this
3480 License, under the terms defined in section 4 above for modified
3481 versions, provided that you include in the combination all of the
3482 Invariant Sections of all of the original documents, unmodified, and
3483 list them all as Invariant Sections of your combined work in its
3486 The combined work need only contain one copy of this License, and
3487 multiple identical Invariant Sections may be replaced with a single
3488 copy. If there are multiple Invariant Sections with the same name but
3489 different contents, make the title of each such section unique by
3490 adding at the end of it, in parentheses, the name of the original
3491 author or publisher of that section if known, or else a unique number.
3492 Make the same adjustment to the section titles in the list of
3493 Invariant Sections in the license notice of the combined work.
3495 In the combination, you must combine any sections entitled ``History''
3496 in the various original documents, forming one section entitled
3497 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3498 and any sections entitled ``Dedications''. You must delete all sections
3499 entitled ``Endorsements.''
3502 COLLECTIONS OF DOCUMENTS
3504 You may make a collection consisting of the Document and other documents
3505 released under this License, and replace the individual copies of this
3506 License in the various documents with a single copy that is included in
3507 the collection, provided that you follow the rules of this License for
3508 verbatim copying of each of the documents in all other respects.
3510 You may extract a single document from such a collection, and distribute
3511 it individually under this License, provided you insert a copy of this
3512 License into the extracted document, and follow this License in all
3513 other respects regarding verbatim copying of that document.
3516 AGGREGATION WITH INDEPENDENT WORKS
3518 A compilation of the Document or its derivatives with other separate
3519 and independent documents or works, in or on a volume of a storage or
3520 distribution medium, does not as a whole count as a Modified Version
3521 of the Document, provided no compilation copyright is claimed for the
3522 compilation. Such a compilation is called an ``aggregate'', and this
3523 License does not apply to the other self-contained works thus compiled
3524 with the Document, on account of their being thus compiled, if they
3525 are not themselves derivative works of the Document.
3527 If the Cover Text requirement of section 3 is applicable to these
3528 copies of the Document, then if the Document is less than one quarter
3529 of the entire aggregate, the Document's Cover Texts may be placed on
3530 covers that surround only the Document within the aggregate.
3531 Otherwise they must appear on covers around the whole aggregate.
3536 Translation is considered a kind of modification, so you may
3537 distribute translations of the Document under the terms of section 4.
3538 Replacing Invariant Sections with translations requires special
3539 permission from their copyright holders, but you may include
3540 translations of some or all Invariant Sections in addition to the
3541 original versions of these Invariant Sections. You may include a
3542 translation of this License provided that you also include the
3543 original English version of this License. In case of a disagreement
3544 between the translation and the original English version of this
3545 License, the original English version will prevail.
3550 You may not copy, modify, sublicense, or distribute the Document except
3551 as expressly provided for under this License. Any other attempt to
3552 copy, modify, sublicense or distribute the Document is void, and will
3553 automatically terminate your rights under this License. However,
3554 parties who have received copies, or rights, from you under this
3555 License will not have their licenses terminated so long as such
3556 parties remain in full compliance.
3559 FUTURE REVISIONS OF THIS LICENSE
3561 The Free Software Foundation may publish new, revised versions
3562 of the GNU Free Documentation License from time to time. Such new
3563 versions will be similar in spirit to the present version, but may
3564 differ in detail to address new problems or concerns. See
3565 http://www.gnu.org/copyleft/.
3567 Each version of the License is given a distinguishing version number.
3568 If the Document specifies that a particular numbered version of this
3569 License ``or any later version'' applies to it, you have the option of
3570 following the terms and conditions either of that specified version or
3571 of any later version that has been published (not as a draft) by the
3572 Free Software Foundation. If the Document does not specify a version
3573 number of this License, you may choose any version ever published (not
3574 as a draft) by the Free Software Foundation.
3578 @unnumberedsec ADDENDUM: How to use this License for your documents
3580 To use this License in a document you have written, include a copy of
3581 the License in the document and put the following copyright and
3582 license notices just after the title page:
3587 Copyright (C) @var{year} @var{your name}.
3588 Permission is granted to copy, distribute and/or modify this document
3589 under the terms of the GNU Free Documentation License, Version 1.1
3590 or any later version published by the Free Software Foundation;
3591 with the Invariant Sections being @var{list their titles}, with the
3592 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
3593 A copy of the license is included in the section entitled ``GNU
3594 Free Documentation License''.
3597 If you have no Invariant Sections, write ``with no Invariant Sections''
3598 instead of saying which ones are invariant. If you have no
3599 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
3600 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
3602 If your document contains nontrivial examples of program code, we
3603 recommend releasing these examples in parallel under your choice of
3604 free software license, such as the GNU General Public License,
3605 to permit their use in free software.
3608 @node Concept Index, , Copying, Top
3609 @unnumbered Concept Index