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!
21 @dircategory Net Utilities
22 @dircategory World Wide Web
24 * Wget: (wget). The non-interactive network downloader.
28 This file documents the the GNU Wget utility for downloading network
31 @c man begin COPYRIGHT
32 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
35 Permission is granted to make and distribute verbatim copies of
36 this manual provided the copyright notice and this permission notice
37 are preserved on all copies.
40 Permission is granted to process this file through TeX and print the
41 results, provided the printed document carries a copying permission
42 notice identical to this one except for the removal of this paragraph
43 (this paragraph not being relevant to the printed manual).
45 Permission is granted to copy, distribute and/or modify this document
46 under the terms of the GNU Free Documentation License, Version 1.1 or
47 any later version published by the Free Software Foundation; with the
48 Invariant Sections being ``GNU General Public License'' and ``GNU Free
49 Documentation License'', with no Front-Cover Texts, and with no
50 Back-Cover Texts. A copy of the license is included in the section
51 entitled ``GNU Free Documentation License''.
57 @subtitle The noninteractive downloading utility
58 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
59 @author by Hrvoje Nik@v{s}i@'{c} and the developers
63 Originally written by Hrvoje Niksic <hniksic@arsdigita.com>.
66 GNU Info entry for @file{wget}.
71 @vskip 0pt plus 1filll
72 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
75 Permission is granted to copy, distribute and/or modify this document
76 under the terms of the GNU Free Documentation License, Version 1.1 or
77 any later version published by the Free Software Foundation; with the
78 Invariant Sections being ``GNU General Public License'' and ``GNU Free
79 Documentation License'', with no Front-Cover Texts, and with no
80 Back-Cover Texts. A copy of the license is included in the section
81 entitled ``GNU Free Documentation License''.
85 @node Top, Overview, (dir), (dir)
86 @top Wget @value{VERSION}
88 This manual documents version @value{VERSION} of GNU Wget, the freely
89 available utility for network download.
91 Copyright @copyright{} 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
94 * Overview:: Features of Wget.
95 * Invoking:: Wget command-line arguments.
96 * Recursive Retrieval:: Description of recursive retrieval.
97 * Following Links:: The available methods of chasing links.
98 * Time-Stamping:: Mirroring according to time-stamps.
99 * Startup File:: Wget's initialization file.
100 * Examples:: Examples of usage.
101 * Various:: The stuff that doesn't fit anywhere else.
102 * Appendices:: Some useful references.
103 * Copying:: You may give out copies of Wget and of this manual.
104 * Concept Index:: Topics covered by this manual.
108 @node Overview, Invoking, Top, Top
113 @c man begin DESCRIPTION
114 GNU Wget is a freely available network utility to retrieve files from
115 the World Wide Web, using @sc{http} (Hyper Text Transfer Protocol) and
116 @sc{ftp} (File Transfer Protocol), the two most widely used Internet
117 protocols. It has many useful features to make downloading easier, some
122 Wget is non-interactive, meaning that it can work in the background,
123 while the user is not logged on. This allows you to start a retrieval
124 and disconnect from the system, letting Wget finish the work. By
125 contrast, most of the Web browsers require constant user's presence,
126 which can be a great hindrance when transferring a lot of data.
130 @c man begin DESCRIPTION
132 Wget is capable of descending recursively through the structure of
133 @sc{html} documents and @sc{ftp} directory trees, making a local copy of
134 the directory hierarchy similar to the one on the remote server. This
135 feature can be used to mirror archives and home pages, or traverse the
136 web in search of data, like a @sc{www} robot (@pxref{Robots}). In that
137 spirit, Wget understands the @code{norobots} convention.
141 @c man begin DESCRIPTION
143 File name wildcard matching and recursive mirroring of directories are
144 available when retrieving via @sc{ftp}. Wget can read the time-stamp
145 information given by both @sc{http} and @sc{ftp} servers, and store it
146 locally. Thus Wget can see if the remote file has changed since last
147 retrieval, and automatically retrieve the new version if it has. This
148 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
153 @c man begin DESCRIPTION
155 Wget works exceedingly well on slow or unstable connections,
156 retrying the document until it is fully retrieved, or until a
157 user-specified retry count is surpassed. It will try to resume the
158 download from the point of interruption, using @code{REST} with @sc{ftp}
159 and @code{Range} with @sc{http} servers that support them.
163 @c man begin DESCRIPTION
165 By default, Wget supports proxy servers, which can lighten the network
166 load, speed up retrieval and provide access behind firewalls. However,
167 if you are behind a firewall that requires that you use a socks style
168 gateway, you can get the socks library and build Wget with support for
169 socks. Wget also supports the passive @sc{ftp} downloading as an
174 @c man begin DESCRIPTION
176 Builtin features offer mechanisms to tune which links you wish to follow
177 (@pxref{Following Links}).
181 @c man begin DESCRIPTION
183 The retrieval is conveniently traced with printing dots, each dot
184 representing a fixed amount of data received (1KB by default). These
185 representations can be customized to your preferences.
189 @c man begin DESCRIPTION
191 Most of the features are fully configurable, either through command line
192 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
193 File}). Wget allows you to define @dfn{global} startup files
194 (@file{/usr/local/etc/wgetrc} by default) for site settings.
200 @item /usr/local/etc/wgetrc
201 Default location of the @dfn{global} startup file.
210 @c man begin DESCRIPTION
212 Finally, GNU Wget is free software. This means that everyone may use
213 it, redistribute it and/or modify it under the terms of the GNU General
214 Public License, as published by the Free Software Foundation
219 @node Invoking, Recursive Retrieval, Overview, Top
226 By default, Wget is very simple to invoke. The basic syntax is:
229 @c man begin SYNOPSIS
230 wget [@var{option}]@dots{} [@var{URL}]@dots{}
234 Wget will simply download all the @sc{url}s specified on the command
235 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
237 However, you may wish to change some of the default parameters of
238 Wget. You can do it two ways: permanently, adding the appropriate
239 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
245 * Basic Startup Options::
246 * Logging and Input File Options::
248 * Directory Options::
251 * Recursive Retrieval Options::
252 * Recursive Accept/Reject Options::
255 @node URL Format, Option Syntax, Invoking, Invoking
260 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
261 resource locator is a compact string representation for a resource
262 available via the Internet. Wget recognizes the @sc{url} syntax as per
263 @sc{rfc1738}. This is the most widely used form (square brackets denote
267 http://host[:port]/directory/file
268 ftp://host[:port]/directory/file
271 You can also encode your username and password within a @sc{url}:
274 ftp://user:password@@host/path
275 http://user:password@@host/path
278 Either @var{user} or @var{password}, or both, may be left out. If you
279 leave out either the @sc{http} username or password, no authentication
280 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
281 will be used. If you leave out the @sc{ftp} password, your email
282 address will be supplied as a default password.@footnote{If you have a
283 @file{.netrc} file in your home directory, password will also be
286 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
287 being the hexadecimal representation of the character's @sc{ascii}
288 value. Some common unsafe characters include @samp{%} (quoted as
289 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
290 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
293 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
294 default, @sc{ftp} documents are retrieved in the binary mode (type
295 @samp{i}), which means that they are downloaded unchanged. Another
296 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
297 delimiters between the different operating systems, and is thus useful
298 for text files. Here is an example:
301 ftp://host/directory/file;type=a
304 Two alternative variants of @sc{url} specification are also supported,
305 because of historical (hysterical?) reasons and their widespreaded use.
307 @sc{ftp}-only syntax (supported by @code{NcFTP}):
312 @sc{http}-only syntax (introduced by @code{Netscape}):
317 These two alternative forms are deprecated, and may cease being
318 supported in the future.
320 If you do not understand the difference between these notations, or do
321 not know which one to use, just use the plain ordinary format you use
322 with your favorite browser, like @code{Lynx} or @code{Netscape}.
324 @node Option Syntax, Basic Startup Options, URL Format, Invoking
325 @section Option Syntax
326 @cindex option syntax
327 @cindex syntax of options
329 Since Wget uses GNU getopts to process its arguments, every option has a
330 short form and a long form. Long options are more convenient to
331 remember, but take time to type. You may freely mix different option
332 styles, or specify options after the command-line arguments. Thus you
336 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
339 The space between the option accepting an argument and the argument may
340 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
342 You may put several options that do not require arguments together,
349 This is a complete equivalent of:
352 wget -d -r -c @var{URL}
355 Since the options can be specified after the arguments, you may
356 terminate them with @samp{--}. So the following will try to download
357 @sc{url} @samp{-x}, reporting failure to @file{log}:
363 The options that accept comma-separated lists all respect the convention
364 that specifying an empty list clears its value. This can be useful to
365 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
366 sets @code{exclude_directories} to @file{/cgi-bin}, the following
367 example will first reset it, and then set it to exclude @file{/~nobody}
368 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
369 (@pxref{Wgetrc Syntax}).
372 wget -X '' -X /~nobody,/~somebody
377 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
378 @section Basic Startup Options
383 Display the version of Wget.
387 Print a help message describing all of Wget's command-line options.
391 Go to background immediately after startup. If no output file is
392 specified via the @samp{-o}, output is redirected to @file{wget-log}.
394 @cindex execute wgetrc command
395 @item -e @var{command}
396 @itemx --execute @var{command}
397 Execute @var{command} as if it were a part of @file{.wgetrc}
398 (@pxref{Startup File}). A command thus invoked will be executed
399 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
403 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
404 @section Logging and Input File Options
409 @item -o @var{logfile}
410 @itemx --output-file=@var{logfile}
411 Log all messages to @var{logfile}. The messages are normally reported
414 @cindex append to log
415 @item -a @var{logfile}
416 @itemx --append-output=@var{logfile}
417 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
418 to @var{logfile} instead of overwriting the old log file. If
419 @var{logfile} does not exist, a new file is created.
424 Turn on debug output, meaning various information important to the
425 developers of Wget if it does not work properly. Your system
426 administrator may have chosen to compile Wget without debug support, in
427 which case @samp{-d} will not work. Please note that compiling with
428 debug support is always safe---Wget compiled with the debug support will
429 @emph{not} print any debug info unless requested with @samp{-d}.
430 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
436 Turn off Wget's output.
441 Turn on verbose output, with all the available data. The default output
446 Non-verbose output---turn off verbose without being completely quiet
447 (use @samp{-q} for that), which means that error messages and basic
448 information still get printed.
452 @itemx --input-file=@var{file}
453 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
454 the command line. If there are @sc{url}s both on the command line and
455 in an input file, those on the command lines will be the first ones to
456 be retrieved. The @var{file} need not be an @sc{html} document (but no
457 harm if it is)---it is enough if the @sc{url}s are just listed
460 However, if you specify @samp{--force-html}, the document will be
461 regarded as @samp{html}. In that case you may have problems with
462 relative links, which you can solve either by adding @code{<base
463 href="@var{url}">} to the documents or by specifying
464 @samp{--base=@var{url}} on the command line.
469 When input is read from a file, force it to be treated as an @sc{html}
470 file. This enables you to retrieve relative links from existing
471 @sc{html} files on your local disk, by adding @code{<base
472 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
475 @cindex base for relative links in input file
477 @itemx --base=@var{URL}
478 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
479 links in the file specified by @samp{-i}.
482 @node Download Options, Directory Options, Logging and Input File Options, Invoking
483 @section Download Options
486 @cindex bind() address
487 @cindex client IP address
488 @cindex IP address, client
489 @item --bind-address=@var{ADDRESS}
490 When making client TCP/IP connections, @code{bind()} to @var{ADDRESS} on
491 the local machine. @var{ADDRESS} may be specified as a hostname or IP
492 address. This option can be useful if your machine is bound to multiple
497 @cindex number of retries
498 @item -t @var{number}
499 @itemx --tries=@var{number}
500 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
504 @itemx --output-document=@var{file}
505 The documents will not be written to the appropriate files, but all will
506 be concatenated together and written to @var{file}. If @var{file}
507 already exists, it will be overwritten. If the @var{file} is @samp{-},
508 the documents will be written to standard output. Including this option
509 automatically sets the number of tries to 1.
511 @cindex clobbering, file
512 @cindex downloading multiple times
516 If a file is downloaded more than once in the same directory, Wget's
517 behavior depends on a few options, including @samp{-nc}. In certain
518 cases, the local file will be @dfn{clobbered}, or overwritten, upon
519 repeated download. In other cases it will be preserved.
521 When running Wget without @samp{-N}, @samp{-nc}, or @samp{-r},
522 downloading the same file in the same directory will result in the
523 original copy of @var{file} being preserved and the second copy being
524 named @samp{@var{file}.1}. If that file is downloaded yet again, the
525 third copy will be named @samp{@var{file}.2}, and so on. When
526 @samp{-nc} is specified, this behavior is suppressed, and Wget will
527 refuse to download newer copies of @samp{@var{file}}. Therefore,
528 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
529 clobbering that's prevented (as the numeric suffixes were already
530 preventing clobbering), but rather the multiple version saving that's
533 When running Wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
534 re-downloading a file will result in the new copy simply overwriting the
535 old. Adding @samp{-nc} will prevent this behavior, instead causing the
536 original version to be preserved and any newer copies on the server to
539 When running Wget with @samp{-N}, with or without @samp{-r}, the
540 decision as to whether or not to download a newer copy of a file depends
541 on the local and remote timestamp and size of the file
542 (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the same
545 Note that when @samp{-nc} is specified, files with the suffixes
546 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
547 and parsed as if they had been retrieved from the Web.
549 @cindex continue retrieval
550 @cindex incomplete downloads
551 @cindex resume download
554 Continue getting a partially-downloaded file. This is useful when you
555 want to finish up a download started by a previous instance of Wget, or
556 by another program. For instance:
559 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
562 If there is a file named @file{ls-lR.Z} in the current directory, Wget
563 will assume that it is the first portion of the remote file, and will
564 ask the server to continue the retrieval from an offset equal to the
565 length of the local file.
567 Note that you don't need to specify this option if you just want the
568 current invocation of Wget to retry downloading a file should the
569 connection be lost midway through. This is the default behavior.
570 @samp{-c} only affects resumption of downloads started @emph{prior} to
571 this invocation of Wget, and whose local files are still sitting around.
573 Without @samp{-c}, the previous example would just download the remote
574 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
577 If you use @samp{-c} on a file which is now smaller on the server than
578 locally (presumably because it was changed on the server since your last
579 download attempt), the file will be re-downloaded from scratch.
580 Unfortunately this also happens if the local file is the same length as
581 the server file---this will be fixed in a future version of Wget, but in
582 the meantime you can use @samp{--timestamping} to prevent this on files
583 for which the server gives timestamps (e.g. static files but not CGI
584 output or @sc{http} directory listings).
586 On the other side of the coin, while using @samp{-c}, any file that's
587 bigger on the server than locally will be considered an incomplete
588 download and only @code{(length(server) - length(local))} bytes will
589 be downloaded and tacked onto the end of the local file. This behavior
590 can be desirable in certain cases---for instance, you can use @samp{wget
591 -c} to download just the new portion that's been appended to a data
592 collection or log file.
594 However, if the file is bigger on the server because it's been
595 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
596 with a garbled file. Wget has no way of verifying that the local file
597 is really a valid prefix of the remote file. You need to be especially
598 careful of this when using @samp{-c} in conjunction with @samp{-r},
599 since every file will be considered as an "incomplete download" candidate.
601 Another instance where you'll get a garbled file if you try to use
602 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
603 ``transfer interrupted'' string into the local file. In the future a
604 ``rollback'' option may be added to deal with this case.
606 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
607 servers that support the @code{Range} header.
610 @cindex retrieval tracing style
611 @item --dot-style=@var{style}
612 Set the retrieval style to @var{style}. Wget traces the retrieval of
613 each document by printing dots on the screen, each dot representing a
614 fixed amount of retrieved data. Any number of dots may be separated in
615 a @dfn{cluster}, to make counting easier. This option allows you to
616 choose one of the pre-defined styles, determining the number of bytes
617 represented by a dot, the number of dots in a cluster, and the number of
620 With the @code{default} style each dot represents 1K, there are ten dots
621 in a cluster and 50 dots in a line. The @code{binary} style has a more
622 ``computer''-like orientation---8K dots, 16-dots clusters and 48 dots
623 per line (which makes for 384K lines). The @code{mega} style is
624 suitable for downloading very large files---each dot represents 64K
625 retrieved, there are eight dots in a cluster, and 48 dots on each line
626 (so each line contains 3M). The @code{micro} style is exactly the
627 reverse; it is suitable for downloading small files, with 128-byte dots,
628 8 dots per cluster, and 48 dots (6K) per line.
631 @itemx --timestamping
632 Turn on time-stamping. @xref{Time-Stamping}, for details.
634 @cindex server response, print
636 @itemx --server-response
637 Print the headers sent by @sc{http} servers and responses sent by
640 @cindex Wget as spider
643 When invoked with this option, Wget will behave as a Web @dfn{spider},
644 which means that it will not download the pages, just check that they
645 are there. You can use it to check your bookmarks, e.g. with:
648 wget --spider --force-html -i bookmarks.html
651 This feature needs much more work for Wget to get close to the
652 functionality of real @sc{www} spiders.
656 @itemx --timeout=@var{seconds}
657 Set the read timeout to @var{seconds} seconds. Whenever a network read
658 is issued, the file descriptor is checked for a timeout, which could
659 otherwise leave a pending connection (uninterrupted read). The default
660 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
661 disable checking for timeouts.
663 Please do not lower the default timeout value with this option unless
664 you know what you are doing.
668 @item -w @var{seconds}
669 @itemx --wait=@var{seconds}
670 Wait the specified number of seconds between the retrievals. Use of
671 this option is recommended, as it lightens the server load by making the
672 requests less frequent. Instead of in seconds, the time can be
673 specified in minutes using the @code{m} suffix, in hours using @code{h}
674 suffix, or in days using @code{d} suffix.
676 Specifying a large value for this option is useful if the network or the
677 destination host is down, so that Wget can wait long enough to
678 reasonably expect the network error to be fixed before the retry.
680 @cindex retries, waiting between
681 @cindex waiting between retries
682 @item --waitretry=@var{seconds}
683 If you don't want Wget to wait between @emph{every} retrieval, but only
684 between retries of failed downloads, you can use this option. Wget will
685 use @dfn{linear backoff}, waiting 1 second after the first failure on a
686 given file, then waiting 2 seconds after the second failure on that
687 file, up to the maximum number of @var{seconds} you specify. Therefore,
688 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
691 Note that this option is turned on by default in the global
696 @itemx --proxy=on/off
697 Turn proxy support on or off. The proxy is on by default if the
698 appropriate environmental variable is defined.
702 @itemx --quota=@var{quota}
703 Specify download quota for automatic retrievals. The value can be
704 specified in bytes (default), kilobytes (with @samp{k} suffix), or
705 megabytes (with @samp{m} suffix).
707 Note that quota will never affect downloading a single file. So if you
708 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
709 @file{ls-lR.gz} will be downloaded. The same goes even when several
710 @sc{url}s are specified on the command-line. However, quota is
711 respected when retrieving either recursively, or from an input file.
712 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
713 aborted when the quota is exceeded.
715 Setting quota to 0 or to @samp{inf} unlimits the download quota.
718 @node Directory Options, HTTP Options, Download Options, Invoking
719 @section Directory Options
723 @itemx --no-directories
724 Do not create a hierarchy of directories when retrieving recursively.
725 With this option turned on, all files will get saved to the current
726 directory, without clobbering (if a name shows up more than once, the
727 filenames will get extensions @samp{.n}).
730 @itemx --force-directories
731 The opposite of @samp{-nd}---create a hierarchy of directories, even if
732 one would not have been created otherwise. E.g. @samp{wget -x
733 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
734 @file{fly.srk.fer.hr/robots.txt}.
737 @itemx --no-host-directories
738 Disable generation of host-prefixed directories. By default, invoking
739 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
740 directories beginning with @file{fly.srk.fer.hr/}. This option disables
743 @cindex cut directories
744 @item --cut-dirs=@var{number}
745 Ignore @var{number} directory components. This is useful for getting a
746 fine-grained control over the directory where recursive retrieval will
749 Take, for example, the directory at
750 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
751 @samp{-r}, it will be saved locally under
752 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
753 remove the @file{ftp.xemacs.org/} part, you are still stuck with
754 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
755 makes Wget not ``see'' @var{number} remote directory components. Here
756 are several examples of how @samp{--cut-dirs} option works.
760 No options -> ftp.xemacs.org/pub/xemacs/
762 -nH --cut-dirs=1 -> xemacs/
763 -nH --cut-dirs=2 -> .
765 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
770 If you just want to get rid of the directory structure, this option is
771 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
772 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
773 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
774 be placed to @file{xemacs/beta}, as one would expect.
776 @cindex directory prefix
777 @item -P @var{prefix}
778 @itemx --directory-prefix=@var{prefix}
779 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
780 directory where all other files and subdirectories will be saved to,
781 i.e. the top of the retrieval tree. The default is @samp{.} (the
785 @node HTTP Options, FTP Options, Directory Options, Invoking
786 @section HTTP Options
789 @cindex .html extension
791 @itemx --html-extension
792 If a file of type @samp{text/html} is downloaded and the URL does not
793 end with the regexp @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause
794 the suffix @samp{.html} to be appended to the local filename. This is
795 useful, for instance, when you're mirroring a remote site that uses
796 @samp{.asp} pages, but you want the mirrored pages to be viewable on
797 your stock Apache server. Another good use for this is when you're
798 downloading the output of CGIs. A URL like
799 @samp{http://site.com/article.cgi?25} will be saved as
800 @file{article.cgi?25.html}.
802 Note that filenames changed in this way will be re-downloaded every time
803 you re-mirror a site, because Wget can't tell that the local
804 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
805 it doesn't yet know that the URL produces output of type
806 @samp{text/html}. To prevent this re-downloading, you must use
807 @samp{-k} and @samp{-K} so that the original version of the file will be
808 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
811 @cindex http password
812 @cindex authentication
813 @item --http-user=@var{user}
814 @itemx --http-passwd=@var{password}
815 Specify the username @var{user} and password @var{password} on an
816 @sc{http} server. According to the type of the challenge, Wget will
817 encode them using either the @code{basic} (insecure) or the
818 @code{digest} authentication scheme.
820 Another way to specify username and password is in the @sc{url} itself
821 (@pxref{URL Format}). For more information about security issues with
822 Wget, @xref{Security Considerations}.
827 @itemx --cache=on/off
828 When set to off, disable server-side cache. In this case, Wget will
829 send the remote server an appropriate directive (@samp{Pragma:
830 no-cache}) to get the file from the remote service, rather than
831 returning the cached version. This is especially useful for retrieving
832 and flushing out-of-date documents on proxy servers.
834 Caching is allowed by default.
836 @cindex Content-Length, ignore
837 @cindex ignore length
838 @item --ignore-length
839 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
840 precise) send out bogus @code{Content-Length} headers, which makes Wget
841 go wild, as it thinks not all the document was retrieved. You can spot
842 this syndrome if Wget retries getting the same document again and again,
843 each time claiming that the (otherwise normal) connection has closed on
846 With this option, Wget will ignore the @code{Content-Length} header---as
850 @item --header=@var{additional-header}
851 Define an @var{additional-header} to be passed to the @sc{http} servers.
852 Headers must contain a @samp{:} preceded by one or more non-blank
853 characters, and must not contain newlines.
855 You may define more than one additional header by specifying
856 @samp{--header} more than once.
860 wget --header='Accept-Charset: iso-8859-2' \
861 --header='Accept-Language: hr' \
862 http://fly.srk.fer.hr/
866 Specification of an empty string as the header value will clear all
867 previous user-defined headers.
870 @cindex proxy password
871 @cindex proxy authentication
872 @item --proxy-user=@var{user}
873 @itemx --proxy-passwd=@var{password}
874 Specify the username @var{user} and password @var{password} for
875 authentication on a proxy server. Wget will encode them using the
876 @code{basic} authentication scheme.
879 @cindex referer, http
880 @item --referer=@var{url}
881 Include `Referer: @var{url}' header in HTTP request. Useful for
882 retrieving documents with server-side processing that assume they are
883 always being retrieved by interactive web browsers and only come out
884 properly when Referer is set to one of the pages that point to them.
886 @cindex server response, save
888 @itemx --save-headers
889 Save the headers sent by the @sc{http} server to the file, preceding the
890 actual contents, with an empty line as the separator.
893 @item -U @var{agent-string}
894 @itemx --user-agent=@var{agent-string}
895 Identify as @var{agent-string} to the @sc{http} server.
897 The @sc{http} protocol allows the clients to identify themselves using a
898 @code{User-Agent} header field. This enables distinguishing the
899 @sc{www} software, usually for statistical purposes or for tracing of
900 protocol violations. Wget normally identifies as
901 @samp{Wget/@var{version}}, @var{version} being the current version
904 However, some sites have been known to impose the policy of tailoring
905 the output according to the @code{User-Agent}-supplied information.
906 While conceptually this is not such a bad idea, it has been abused by
907 servers denying information to clients other than @code{Mozilla} or
908 Microsoft @code{Internet Explorer}. This option allows you to change
909 the @code{User-Agent} line issued by Wget. Use of this option is
910 discouraged, unless you really know what you are doing.
913 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
917 @cindex .listing files, removing
919 @itemx --dont-remove-listing
920 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
921 retrievals. Normally, these files contain the raw directory listings
922 received from @sc{ftp} servers. Not removing them can be useful for
923 debugging purposes, or when you want to be able to easily check on the
924 contents of remote server directories (e.g. to verify that a mirror
925 you're running is complete).
927 Note that even though Wget writes to a known filename for this file,
928 this is not a security hole in the scenario of a user making
929 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
930 asking @code{root} to run Wget in his or her directory. Depending on
931 the options used, either Wget will refuse to write to @file{.listing},
932 making the globbing/recursion/time-stamping operation fail, or the
933 symbolic link will be deleted and replaced with the actual
934 @file{.listing} file, or the listing will be written to a
935 @file{.listing.@var{number}} file.
937 Even though this situation isn't a problem, though, @code{root} should
938 never run Wget in a non-trusted user's directory. A user could do
939 something as simple as linking @file{index.html} to @file{/etc/passwd}
940 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
943 @cindex globbing, toggle
946 Turn @sc{ftp} globbing on or off. Globbing means you may use the
947 shell-like special characters (@dfn{wildcards}), like @samp{*},
948 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
949 same directory at once, like:
952 wget ftp://gnjilux.srk.fer.hr/*.msg
955 By default, globbing will be turned on if the @sc{url} contains a
956 globbing character. This option may be used to turn globbing on or off
959 You may have to quote the @sc{url} to protect it from being expanded by
960 your shell. Globbing makes Wget look for a directory listing, which is
961 system-specific. This is why it currently works only with Unix @sc{ftp}
962 servers (and the ones emulating Unix @code{ls} output).
966 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
967 initiates the data connection. This is sometimes required for @sc{ftp}
968 to work behind firewalls.
970 @cindex symbolic links, retrieving
971 @item --retr-symlinks
972 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
973 link is encountered, the linked-to file is not downloaded. Instead, a
974 matching symbolic link is created on the local filesystem. The
975 pointed-to file will not be downloaded unless this recursive retrieval
976 would have encountered it separately and downloaded it anyway.
978 When @samp{--retr-symlinks} is specified, however, symbolic links are
979 traversed and the pointed-to files are retrieved. At this time, this
980 option does not cause Wget to traverse symlinks to directories and
981 recurse through them, but in the future it should be enhanced to do
984 Note that when retrieving a file (not a directory) because it was
985 specified on the commandline, rather than because it was recursed to,
986 this option has no effect. Symbolic links are always traversed in this
990 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
991 @section Recursive Retrieval Options
996 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
1000 @itemx --level=@var{depth}
1001 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1002 Retrieval}). The default maximum depth is 5.
1004 @cindex proxy filling
1005 @cindex delete after retrieval
1006 @cindex filling proxy cache
1007 @item --delete-after
1008 This option tells Wget to delete every single file it downloads,
1009 @emph{after} having done so. It is useful for pre-fetching popular
1010 pages through a proxy, e.g.:
1013 wget -r -nd --delete-after http://whatever.com/~popular/page/
1016 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1019 Note that @samp{--delete-after} deletes files on the local machine. It
1020 does not issue the @samp{DELE} command to remote FTP sites, for
1021 instance. Also note that when @samp{--delete-after} is specified,
1022 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1023 created in the first place.
1025 @cindex conversion of links
1026 @cindex link conversion
1028 @itemx --convert-links
1029 Convert the non-relative links to relative ones locally. Only the
1030 references to the documents actually downloaded will be converted; the
1031 rest will be left unchanged.
1033 Note that only at the end of the download can Wget know which links have
1034 been downloaded. Because of that, much of the work done by @samp{-k}
1035 will be performed at the end of the downloads.
1037 @cindex backing up converted files
1039 @itemx --backup-converted
1040 When converting a file, back up the original version with a @samp{.orig}
1041 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1046 Turn on options suitable for mirroring. This option turns on recursion
1047 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1048 directory listings. It is currently equivalent to
1049 @samp{-r -N -l inf -nr}.
1051 @cindex page requisites
1052 @cindex required images, downloading
1054 @itemx --page-requisites
1055 This option causes Wget to download all the files that are necessary to
1056 properly display a given HTML page. This includes such things as
1057 inlined images, sounds, and referenced stylesheets.
1059 Ordinarily, when downloading a single HTML page, any requisite documents
1060 that may be needed to display it properly are not downloaded. Using
1061 @samp{-r} together with @samp{-l} can help, but since Wget does not
1062 ordinarily distinguish between external and inlined documents, one is
1063 generally left with ``leaf documents'' that are missing their
1066 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1067 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1068 document @file{2.html}. Say that @file{2.html} is similar but that its
1069 image is @file{2.gif} and it links to @file{3.html}. Say this
1070 continues up to some arbitrarily high number.
1072 If one executes the command:
1075 wget -r -l 2 http://@var{site}/1.html
1078 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1079 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1080 without its requisite @file{3.gif} because Wget is simply counting the
1081 number of hops (up to 2) away from @file{1.html} in order to determine
1082 where to stop the recursion. However, with this command:
1085 wget -r -l 2 -p http://@var{site}/1.html
1088 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1089 will be downloaded. Similarly,
1092 wget -r -l 1 -p http://@var{site}/1.html
1095 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1096 to be downloaded. One might think that:
1099 wget -r -l 0 -p http://@var{site}/1.html
1102 would download just @file{1.html} and @file{1.gif}, but unfortunately
1103 this is not the case, because @samp{-l 0} is equivalent to
1104 @samp{-l inf}---that is, infinite recursion. To download a single HTML
1105 page (or a handful of them, all specified on the commandline or in a
1106 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1107 @samp{-r} and @samp{-l}:
1110 wget -p http://@var{site}/1.html
1113 Note that Wget will behave as if @samp{-r} had been specified, but only
1114 that single page and its requisites will be downloaded. Links from that
1115 page to external documents will not be followed. Actually, to download
1116 a single page and all its requisites (even if they exist on separate
1117 websites), and make sure the lot displays properly locally, this author
1118 likes to use a few options in addition to @samp{-p}:
1121 wget -E -H -k -K -nh -p http://@var{site}/@var{document}
1124 In one case you'll need to add a couple more options. If @var{document}
1125 is a @code{<FRAMESET>} page, the "one more hop" that @samp{-p} gives you
1126 won't be enough---you'll get the @code{<FRAME>} pages that are
1127 referenced, but you won't get @emph{their} requisites. Therefore, in
1128 this case you'll need to add @samp{-r -l1} to the commandline. The
1129 @samp{-r -l1} will recurse from the @code{<FRAMESET>} page to to the
1130 @code{<FRAME>} pages, and the @samp{-p} will get their requisites. If
1131 you're already using a recursion level of 1 or more, you'll need to up
1132 it by one. In the future, @samp{-p} may be made smarter so that it'll
1133 do "two more hops" in the case of a @code{<FRAMESET>} page.
1135 To finish off this topic, it's worth knowing that Wget's idea of an
1136 external document link is any URL specified in an @code{<A>} tag, an
1137 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1141 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1142 @section Recursive Accept/Reject Options
1145 @item -A @var{acclist} --accept @var{acclist}
1146 @itemx -R @var{rejlist} --reject @var{rejlist}
1147 Specify comma-separated lists of file name suffixes or patterns to
1148 accept or reject (@pxref{Types of Files} for more details).
1150 @item -D @var{domain-list}
1151 @itemx --domains=@var{domain-list}
1152 Set domains to be accepted and @sc{dns} looked-up, where
1153 @var{domain-list} is a comma-separated list. Note that it does
1154 @emph{not} turn on @samp{-H}. This option speeds things up, even if
1155 only one host is spanned (@pxref{Domain Acceptance}).
1157 @item --exclude-domains @var{domain-list}
1158 Exclude the domains given in a comma-separated @var{domain-list} from
1159 @sc{dns}-lookup (@pxref{Domain Acceptance}).
1161 @cindex follow FTP links
1163 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1164 Wget will ignore all the @sc{ftp} links.
1166 @cindex tag-based recursive pruning
1167 @item --follow-tags=@var{list}
1168 Wget has an internal table of HTML tag / attribute pairs that it
1169 considers when looking for linked documents during a recursive
1170 retrieval. If a user wants only a subset of those tags to be
1171 considered, however, he or she should be specify such tags in a
1172 comma-separated @var{list} with this option.
1175 @itemx --ignore-tags=@var{list}
1176 This is the opposite of the @samp{--follow-tags} option. To skip
1177 certain HTML tags when recursively looking for documents to download,
1178 specify them in a comma-separated @var{list}.
1180 In the past, the @samp{-G} option was the best bet for downloading a
1181 single page and its requisites, using a commandline like:
1184 wget -Ga,area -H -k -K -nh -r http://@var{site}/@var{document}
1187 However, the author of this option came across a page with tags like
1188 @code{<LINK REL="home" HREF="/">} and came to the realization that
1189 @samp{-G} was not enough. One can't just tell Wget to ignore
1190 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1191 best bet for downloading a single page and its requisites is the
1192 dedicated @samp{--page-requisites} option.
1196 Enable spanning across hosts when doing recursive retrieving (@pxref{All
1201 Follow relative links only. Useful for retrieving a specific home page
1202 without any distractions, not even those from the same hosts
1203 (@pxref{Relative Links}).
1206 @itemx --include-directories=@var{list}
1207 Specify a comma-separated list of directories you wish to follow when
1208 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1209 of @var{list} may contain wildcards.
1212 @itemx --exclude-directories=@var{list}
1213 Specify a comma-separated list of directories you wish to exclude from
1214 download (@pxref{Directory-Based Limits} for more details.) Elements of
1215 @var{list} may contain wildcards.
1218 @itemx --no-host-lookup
1219 Disable the time-consuming @sc{dns} lookup of almost all hosts
1220 (@pxref{Host Checking}).
1224 Do not ever ascend to the parent directory when retrieving recursively.
1225 This is a useful option, since it guarantees that only the files
1226 @emph{below} a certain hierarchy will be downloaded.
1227 @xref{Directory-Based Limits}, for more details.
1232 @node Recursive Retrieval, Following Links, Invoking, Top
1233 @chapter Recursive Retrieval
1236 @cindex recursive retrieval
1238 GNU Wget is capable of traversing parts of the Web (or a single
1239 @sc{http} or @sc{ftp} server), depth-first following links and directory
1240 structure. This is called @dfn{recursive} retrieving, or
1243 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1244 the given @sc{url}, documents, retrieving the files the @sc{html}
1245 document was referring to, through markups like @code{href}, or
1246 @code{src}. If the freshly downloaded file is also of type
1247 @code{text/html}, it will be parsed and followed further.
1249 The maximum @dfn{depth} to which the retrieval may descend is specified
1250 with the @samp{-l} option (the default maximum depth is five layers).
1251 @xref{Recursive Retrieval}.
1253 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1254 the data from the given directory tree (including the subdirectories up
1255 to the specified depth) on the remote server, creating its mirror image
1256 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1259 By default, Wget will create a local directory tree, corresponding to
1260 the one found on the remote server.
1262 Recursive retrieving can find a number of applications, the most
1263 important of which is mirroring. It is also useful for @sc{www}
1264 presentations, and any other opportunities where slow network
1265 connections should be bypassed by storing the files locally.
1267 You should be warned that invoking recursion may cause grave overloading
1268 on your system, because of the fast exchange of data through the
1269 network; all of this may hamper other users' work. The same stands for
1270 the foreign server you are mirroring---the more requests it gets in a
1271 rows, the greater is its load.
1273 Careless retrieving can also fill your file system uncontrollably, which
1274 can grind the machine to a halt.
1276 The load can be minimized by lowering the maximum recursion level
1277 (@samp{-l}) and/or by lowering the number of retries (@samp{-t}). You
1278 may also consider using the @samp{-w} option to slow down your requests
1279 to the remote servers, as well as the numerous options to narrow the
1280 number of followed links (@pxref{Following Links}).
1282 Recursive retrieval is a good thing when used properly. Please take all
1283 precautions not to wreak havoc through carelessness.
1285 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1286 @chapter Following Links
1288 @cindex following links
1290 When retrieving recursively, one does not wish to retrieve loads of
1291 unnecessary data. Most of the time the users bear in mind exactly what
1292 they want to download, and want Wget to follow only specific links.
1294 For example, if you wish to download the music archive from
1295 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1296 that happen to be referenced by an obscure part of the archive.
1298 Wget possesses several mechanisms that allows you to fine-tune which
1299 links it will follow.
1302 * Relative Links:: Follow relative links only.
1303 * Host Checking:: Follow links on the same host.
1304 * Domain Acceptance:: Check on a list of domains.
1305 * All Hosts:: No host restrictions.
1306 * Types of Files:: Getting only certain files.
1307 * Directory-Based Limits:: Getting only certain directories.
1308 * FTP Links:: Following FTP links.
1311 @node Relative Links, Host Checking, Following Links, Following Links
1312 @section Relative Links
1313 @cindex relative links
1315 When only relative links are followed (option @samp{-L}), recursive
1316 retrieving will never span hosts. No time-expensive @sc{dns}-lookups
1317 will be performed, and the process will be very fast, with the minimum
1318 strain of the network. This will suit your needs often, especially when
1319 mirroring the output of various @code{x2html} converters, since they
1320 generally output relative links.
1322 @node Host Checking, Domain Acceptance, Relative Links, Following Links
1323 @section Host Checking
1326 @cindex host checking
1328 The drawback of following the relative links solely is that humans often
1329 tend to mix them with absolute links to the very same host, and the very
1330 same page. In this mode (which is the default mode for following links)
1331 all @sc{url}s that refer to the same host will be retrieved.
1333 The problem with this option are the aliases of the hosts and domains.
1334 Thus there is no way for Wget to know that @samp{regoc.srce.hr} and
1335 @samp{www.srce.hr} are the same host, or that @samp{fly.srk.fer.hr} is
1336 the same as @samp{fly.cc.fer.hr}. Whenever an absolute link is
1337 encountered, the host is @sc{dns}-looked-up with @code{gethostbyname} to
1338 check whether we are maybe dealing with the same hosts. Although the
1339 results of @code{gethostbyname} are cached, it is still a great
1340 slowdown, e.g. when dealing with large indices of home pages on different
1341 hosts (because each of the hosts must be @sc{dns}-resolved to see
1342 whether it just @emph{might} be an alias of the starting host).
1344 To avoid the overhead you may use @samp{-nh}, which will turn off
1345 @sc{dns}-resolving and make Wget compare hosts literally. This will
1346 make things run much faster, but also much less reliable
1347 (e.g. @samp{www.srce.hr} and @samp{regoc.srce.hr} will be flagged as
1350 Note that modern @sc{http} servers allow one IP address to host several
1351 @dfn{virtual servers}, each having its own directory hierarchy. Such
1352 ``servers'' are distinguished by their hostnames (all of which point to
1353 the same IP address); for this to work, a client must send a @code{Host}
1354 header, which is what Wget does. However, in that case Wget @emph{must
1355 not} try to divine a host's ``real'' address, nor try to use the same
1356 hostname for each access, i.e. @samp{-nh} must be turned on.
1358 In other words, the @samp{-nh} option must be used to enable the
1359 retrieval from virtual servers distinguished by their hostnames. As the
1360 number of such server setups grow, the behavior of @samp{-nh} may become
1361 the default in the future.
1363 @node Domain Acceptance, All Hosts, Host Checking, Following Links
1364 @section Domain Acceptance
1366 With the @samp{-D} option you may specify the domains that will be
1367 followed. The hosts the domain of which is not in this list will not be
1368 @sc{dns}-resolved. Thus you can specify @samp{-Dmit.edu} just to make
1369 sure that @strong{nothing outside of @sc{mit} gets looked up}. This is
1370 very important and useful. It also means that @samp{-D} does @emph{not}
1371 imply @samp{-H} (span all hosts), which must be specified explicitly.
1372 Feel free to use this options since it will speed things up, with almost
1373 all the reliability of checking for all hosts. Thus you could invoke
1376 wget -r -D.hr http://fly.srk.fer.hr/
1379 to make sure that only the hosts in @samp{.hr} domain get
1380 @sc{dns}-looked-up for being equal to @samp{fly.srk.fer.hr}. So
1381 @samp{fly.cc.fer.hr} will be checked (only once!) and found equal, but
1382 @samp{www.gnu.ai.mit.edu} will not even be checked.
1384 Of course, domain acceptance can be used to limit the retrieval to
1385 particular domains with spanning of hosts in them, but then you must
1386 specify @samp{-H} explicitly. E.g.:
1389 wget -r -H -Dmit.edu,stanford.edu http://www.mit.edu/
1392 will start with @samp{http://www.mit.edu/}, following links across
1393 @sc{mit} and Stanford.
1395 If there are domains you want to exclude specifically, you can do it
1396 with @samp{--exclude-domains}, which accepts the same type of arguments
1397 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1398 example, if you want to download all the hosts from @samp{foo.edu}
1399 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1403 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu http://www.foo.edu/
1406 @node All Hosts, Types of Files, Domain Acceptance, Following Links
1411 When @samp{-H} is specified without @samp{-D}, all hosts are freely
1412 spanned. There are no restrictions whatsoever as to what part of the
1413 net Wget will go to fetch documents, other than maximum retrieval depth.
1414 If a page references @samp{www.yahoo.com}, so be it. Such an option is
1415 rarely useful for itself.
1417 @node Types of Files, Directory-Based Limits, All Hosts, Following Links
1418 @section Types of Files
1419 @cindex types of files
1421 When downloading material from the web, you will often want to restrict
1422 the retrieval to only certain file types. For example, if you are
1423 interested in downloading @sc{gif}s, you will not be overjoyed to get
1424 loads of PostScript documents, and vice versa.
1426 Wget offers two options to deal with this problem. Each option
1427 description lists a short name, a long name, and the equivalent command
1430 @cindex accept wildcards
1431 @cindex accept suffixes
1432 @cindex wildcards, accept
1433 @cindex suffixes, accept
1435 @item -A @var{acclist}
1436 @itemx --accept @var{acclist}
1437 @itemx accept = @var{acclist}
1438 The argument to @samp{--accept} option is a list of file suffixes or
1439 patterns that Wget will download during recursive retrieval. A suffix
1440 is the ending part of a file, and consists of ``normal'' letters,
1441 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1442 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1444 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1445 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1446 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1447 download only files beginning with @samp{zelazny} and containing numbers
1448 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1449 a description of how pattern matching works.
1451 Of course, any number of suffixes and patterns can be combined into a
1452 comma-separated list, and given as an argument to @samp{-A}.
1454 @cindex reject wildcards
1455 @cindex reject suffixes
1456 @cindex wildcards, reject
1457 @cindex suffixes, reject
1458 @item -R @var{rejlist}
1459 @itemx --reject @var{rejlist}
1460 @itemx reject = @var{rejlist}
1461 The @samp{--reject} option works the same way as @samp{--accept}, only
1462 its logic is the reverse; Wget will download all files @emph{except} the
1463 ones matching the suffixes (or patterns) in the list.
1465 So, if you want to download a whole page except for the cumbersome
1466 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1467 Analogously, to download all files except the ones beginning with
1468 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1469 expansion by the shell.
1472 The @samp{-A} and @samp{-R} options may be combined to achieve even
1473 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1474 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1475 a part of their name, but @emph{not} the PostScript files.
1477 Note that these two options do not affect the downloading of @sc{html}
1478 files; Wget must load all the @sc{html}s to know where to go at
1479 all---recursive retrieval would make no sense otherwise.
1481 @node Directory-Based Limits, FTP Links, Types of Files, Following Links
1482 @section Directory-Based Limits
1484 @cindex directory limits
1486 Regardless of other link-following facilities, it is often useful to
1487 place the restriction of what files to retrieve based on the directories
1488 those files are placed in. There can be many reasons for this---the
1489 home pages may be organized in a reasonable directory structure; or some
1490 directories may contain useless information, e.g. @file{/cgi-bin} or
1491 @file{/dev} directories.
1493 Wget offers three different options to deal with this requirement. Each
1494 option description lists a short name, a long name, and the equivalent
1495 command in @file{.wgetrc}.
1497 @cindex directories, include
1498 @cindex include directories
1499 @cindex accept directories
1502 @itemx --include @var{list}
1503 @itemx include_directories = @var{list}
1504 @samp{-I} option accepts a comma-separated list of directories included
1505 in the retrieval. Any other directories will simply be ignored. The
1506 directories are absolute paths.
1508 So, if you wish to download from @samp{http://host/people/bozo/}
1509 following only links to bozo's colleagues in the @file{/people}
1510 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1513 wget -I /people,/cgi-bin http://host/people/bozo/
1516 @cindex directories, exclude
1517 @cindex exclude directories
1518 @cindex reject directories
1520 @itemx --exclude @var{list}
1521 @itemx exclude_directories = @var{list}
1522 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1523 directories @emph{excluded} from the download. E.g. if you do not want
1524 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1525 /cgi-bin} on the command line.
1527 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1528 to get a better fine-tuning of downloading subdirectories. E.g. if you
1529 want to load all the files from @file{/pub} hierarchy except for
1530 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1535 @itemx no_parent = on
1536 The simplest, and often very useful way of limiting directories is
1537 disallowing retrieval of the links that refer to the hierarchy
1538 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1539 parent directory/directories.
1541 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1542 Using it guarantees that you will never leave the existing hierarchy.
1543 Supposing you issue Wget with:
1546 wget -r --no-parent http://somehost/~luzer/my-archive/
1549 You may rest assured that none of the references to
1550 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1551 followed. Only the archive you are interested in will be downloaded.
1552 Essentially, @samp{--no-parent} is similar to
1553 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1554 intelligent fashion.
1557 @node FTP Links, , Directory-Based Limits, Following Links
1558 @section Following FTP Links
1559 @cindex following ftp links
1561 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1562 them to be. @sc{ftp} links in @sc{html} documents are often included
1563 for purposes of reference, and it is often inconvenient to download them
1566 To have @sc{ftp} links followed from @sc{html} documents, you need to
1567 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1568 links will span hosts regardless of @samp{-H} setting. This is logical,
1569 as @sc{ftp} links rarely point to the same host where the @sc{http}
1570 server resides. For similar reasons, the @samp{-L} options has no
1571 effect on such downloads. On the other hand, domain acceptance
1572 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1574 Also note that followed links to @sc{ftp} directories will not be
1575 retrieved recursively further.
1577 @node Time-Stamping, Startup File, Following Links, Top
1578 @chapter Time-Stamping
1579 @cindex time-stamping
1580 @cindex timestamping
1581 @cindex updating the archives
1582 @cindex incremental updating
1584 One of the most important aspects of mirroring information from the
1585 Internet is updating your archives.
1587 Downloading the whole archive again and again, just to replace a few
1588 changed files is expensive, both in terms of wasted bandwidth and money,
1589 and the time to do the update. This is why all the mirroring tools
1590 offer the option of incremental updating.
1592 Such an updating mechanism means that the remote server is scanned in
1593 search of @dfn{new} files. Only those new files will be downloaded in
1594 the place of the old ones.
1596 A file is considered new if one of these two conditions are met:
1600 A file of that name does not already exist locally.
1603 A file of that name does exist, but the remote file was modified more
1604 recently than the local file.
1607 To implement this, the program needs to be aware of the time of last
1608 modification of both local and remote files. We call this information the
1609 @dfn{time-stamp} of a file.
1611 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1612 (@samp{-N}) option, or through @code{timestamping = on} directive in
1613 @file{.wgetrc}. With this option, for each file it intends to download,
1614 Wget will check whether a local file of the same name exists. If it
1615 does, and the remote file is older, Wget will not download it.
1617 If the local file does not exist, or the sizes of the files do not
1618 match, Wget will download the remote file no matter what the time-stamps
1622 * Time-Stamping Usage::
1623 * HTTP Time-Stamping Internals::
1624 * FTP Time-Stamping Internals::
1627 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1628 @section Time-Stamping Usage
1629 @cindex time-stamping usage
1630 @cindex usage, time-stamping
1632 The usage of time-stamping is simple. Say you would like to download a
1633 file so that it keeps its date of modification.
1636 wget -S http://www.gnu.ai.mit.edu/
1639 A simple @code{ls -l} shows that the time stamp on the local file equals
1640 the state of the @code{Last-Modified} header, as returned by the server.
1641 As you can see, the time-stamping info is preserved locally, even
1642 without @samp{-N} (at least for @sc{http}).
1644 Several days later, you would like Wget to check if the remote file has
1645 changed, and download it if it has.
1648 wget -N http://www.gnu.ai.mit.edu/
1651 Wget will ask the server for the last-modified date. If the local file
1652 has the same timestamp as the server, or a newer one, the remote file
1653 will not be re-fetched. However, if the remote file is more recent,
1654 Wget will proceed to fetch it.
1656 The same goes for @sc{ftp}. For example:
1659 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
1662 (The quotes around that URL are to prevent the shell from trying to
1663 interpret the @samp{*}.)
1665 After download, a local directory listing will show that the timestamps
1666 match those on the remote server. Reissuing the command with @samp{-N}
1667 will make Wget re-fetch @emph{only} the files that have been modified
1668 since the last download.
1670 If you wished to mirror the GNU archive every week, you would use a
1671 command like the following, weekly:
1674 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
1677 Note that time-stamping will only work for files for which the server
1678 gives a timestamp. For @sc{http}, this depends on getting a
1679 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
1680 directory listing with dates in a format that Wget can parse
1681 (@pxref{FTP Time-Stamping Internals}).
1683 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1684 @section HTTP Time-Stamping Internals
1685 @cindex http time-stamping
1687 Time-stamping in @sc{http} is implemented by checking of the
1688 @code{Last-Modified} header. If you wish to retrieve the file
1689 @file{foo.html} through @sc{http}, Wget will check whether
1690 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1691 retrieved unconditionally.
1693 If the file does exist locally, Wget will first check its local
1694 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1695 @code{HEAD} request to the remote server, demanding the information on
1698 The @code{Last-Modified} header is examined to find which file was
1699 modified more recently (which makes it ``newer''). If the remote file
1700 is newer, it will be downloaded; if it is older, Wget will give
1701 up.@footnote{As an additional check, Wget will look at the
1702 @code{Content-Length} header, and compare the sizes; if they are not the
1703 same, the remote file will be downloaded no matter what the time-stamp
1706 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1707 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1708 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1709 @samp{@var{X}}, which will always differ if it's been converted by
1710 @samp{--convert-links} (@samp{-k}).
1712 Arguably, @sc{http} time-stamping should be implemented using the
1713 @code{If-Modified-Since} request.
1715 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1716 @section FTP Time-Stamping Internals
1717 @cindex ftp time-stamping
1719 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1720 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
1723 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
1724 @sc{ftp} @code{LIST} command to get a file listing for the directory
1725 containing the desired file(s). It will try to analyze the listing,
1726 treating it like Unix @code{ls -l} output, extracting the time-stamps.
1727 The rest is exactly the same as for @sc{http}. Note that when
1728 retrieving individual files from an @sc{ftp} server without using
1729 globbing or recursion, listing files will not be downloaded (and thus
1730 files will not be time-stamped) unless @samp{-N} is specified.
1732 Assumption that every directory listing is a Unix-style listing may
1733 sound extremely constraining, but in practice it is not, as many
1734 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1735 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1736 defines no standard way to get a file list, let alone the time-stamps.
1737 We can only hope that a future standard will define this.
1739 Another non-standard solution includes the use of @code{MDTM} command
1740 that is supported by some @sc{ftp} servers (including the popular
1741 @code{wu-ftpd}), which returns the exact time of the specified file.
1742 Wget may support this command in the future.
1744 @node Startup File, Examples, Time-Stamping, Top
1745 @chapter Startup File
1746 @cindex startup file
1752 Once you know how to change default settings of Wget through command
1753 line arguments, you may wish to make some of those settings permanent.
1754 You can do that in a convenient way by creating the Wget startup
1755 file---@file{.wgetrc}.
1757 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1758 convenient to have a special facility for storing passwords. Thus Wget
1759 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1760 it. You can find @file{.netrc} format in your system manuals.
1762 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1766 * Wgetrc Location:: Location of various wgetrc files.
1767 * Wgetrc Syntax:: Syntax of wgetrc.
1768 * Wgetrc Commands:: List of available commands.
1769 * Sample Wgetrc:: A wgetrc example.
1772 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1773 @section Wgetrc Location
1774 @cindex wgetrc location
1775 @cindex location of wgetrc
1777 When initializing, Wget will look for a @dfn{global} startup file,
1778 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1779 @file{/usr/local}, if Wget was not installed there) and read commands
1780 from there, if it exists.
1782 Then it will look for the user's file. If the environmental variable
1783 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1784 further attempts will be made.
1786 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1788 The fact that user's settings are loaded after the system-wide ones
1789 means that in case of collision user's wgetrc @emph{overrides} the
1790 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1791 Fascist admins, away!
1793 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1794 @section Wgetrc Syntax
1795 @cindex wgetrc syntax
1796 @cindex syntax of wgetrc
1798 The syntax of a wgetrc command is simple:
1804 The @dfn{variable} will also be called @dfn{command}. Valid
1805 @dfn{values} are different for different commands.
1807 The commands are case-insensitive and underscore-insensitive. Thus
1808 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1809 beginning with @samp{#} and lines containing white-space only are
1812 Commands that expect a comma-separated list will clear the list on an
1813 empty command. So, if you wish to reset the rejection list specified in
1814 global @file{wgetrc}, you can do it with:
1820 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1821 @section Wgetrc Commands
1822 @cindex wgetrc commands
1824 The complete set of commands is listed below. Legal values are listed
1825 after the @samp{=}. Simple Boolean values can be set or unset using
1826 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
1827 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
1828 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
1829 option is set to @samp{always} or @samp{never}, that value will be
1830 locked in for the duration of the Wget invocation---commandline options
1833 Some commands take pseudo-arbitrary values. @var{address} values can be
1834 hostnames or dotted-quad IP addresses. @var{n} can be any positive
1835 integer, or @samp{inf} for infinity, where appropriate. @var{string}
1836 values can be any non-empty string.
1838 Most of these commands have commandline equivalents (@pxref{Invoking}),
1839 though some of the more obscure or rarely used ones do not.
1842 @item accept/reject = @var{string}
1843 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
1845 @item add_hostdir = on/off
1846 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1848 @item continue = on/off
1849 Enable/disable continuation of the retrieval---the same as @samp{-c}
1852 @item background = on/off
1853 Enable/disable going to background---the same as @samp{-b} (which
1856 @item backup_converted = on/off
1857 Enable/disable saving pre-converted files with the suffix
1858 @samp{.orig}---the same as @samp{-K} (which enables it).
1860 @c @item backups = @var{number}
1861 @c #### Document me!
1863 @item base = @var{string}
1864 Consider relative @sc{url}s in @sc{url} input files forced to be
1865 interpreted as @sc{html} as being relative to @var{string}---the same as
1868 @item bind_address = @var{address}
1869 Bind to @var{address}, like the @samp{--bind-address} option.
1871 @item cache = on/off
1872 When set to off, disallow server-caching. See the @samp{-C} option.
1874 @item convert links = on/off
1875 Convert non-relative links locally. The same as @samp{-k}.
1877 @item cut_dirs = @var{n}
1878 Ignore @var{n} remote directory components.
1880 @item debug = on/off
1881 Debug mode, same as @samp{-d}.
1883 @item delete_after = on/off
1884 Delete after download---the same as @samp{--delete-after}.
1886 @item dir_prefix = @var{string}
1887 Top of directory tree---the same as @samp{-P}.
1889 @item dirstruct = on/off
1890 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
1893 @item domains = @var{string}
1894 Same as @samp{-D} (@pxref{Domain Acceptance}).
1896 @item dot_bytes = @var{n}
1897 Specify the number of bytes ``contained'' in a dot, as seen throughout
1898 the retrieval (1024 by default). You can postfix the value with
1899 @samp{k} or @samp{m}, representing kilobytes and megabytes,
1900 respectively. With dot settings you can tailor the dot retrieval to
1901 suit your needs, or you can use the predefined @dfn{styles}
1902 (@pxref{Download Options}).
1904 @item dots_in_line = @var{n}
1905 Specify the number of dots that will be printed in each line throughout
1906 the retrieval (50 by default).
1908 @item dot_spacing = @var{n}
1909 Specify the number of dots in a single cluster (10 by default).
1911 @item dot_style = @var{string}
1912 Specify the dot retrieval @dfn{style}, as with @samp{--dot-style}.
1914 @item exclude_directories = @var{string}
1915 Specify a comma-separated list of directories you wish to exclude from
1916 download---the same as @samp{-X} (@pxref{Directory-Based Limits}).
1918 @item exclude_domains = @var{string}
1919 Same as @samp{--exclude-domains} (@pxref{Domain Acceptance}).
1921 @item follow_ftp = on/off
1922 Follow @sc{ftp} links from @sc{html} documents---the same as @samp{-f}.
1924 @item follow_tags = @var{string}
1925 Only follow certain HTML tags when doing a recursive retrieval, just like
1926 @samp{--follow-tags}.
1928 @item force_html = on/off
1929 If set to on, force the input filename to be regarded as an @sc{html}
1930 document---the same as @samp{-F}.
1932 @item ftp_proxy = @var{string}
1933 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
1937 Turn globbing on/off---the same as @samp{-g}.
1939 @item header = @var{string}
1940 Define an additional header, like @samp{--header}.
1942 @item html_extension = on/off
1943 Add a @samp{.html} extension to @samp{text/html} files without it, like
1946 @item http_passwd = @var{string}
1947 Set @sc{http} password.
1949 @item http_proxy = @var{string}
1950 Use @var{string} as @sc{http} proxy, instead of the one specified in
1953 @item http_user = @var{string}
1954 Set @sc{http} user to @var{string}.
1956 @item ignore_length = on/off
1957 When set to on, ignore @code{Content-Length} header; the same as
1958 @samp{--ignore-length}.
1960 @item ignore_tags = @var{string}
1961 Ignore certain HTML tags when doing a recursive retrieval, just like
1962 @samp{-G} / @samp{--ignore-tags}.
1964 @item include_directories = @var{string}
1965 Specify a comma-separated list of directories you wish to follow when
1966 downloading---the same as @samp{-I}.
1968 @item input = @var{string}
1969 Read the @sc{url}s from @var{string}, like @samp{-i}.
1971 @item kill_longer = on/off
1972 Consider data longer than specified in content-length header as invalid
1973 (and retry getting it). The default behaviour is to save as much data
1974 as there is, provided there is more than or equal to the value in
1975 @code{Content-Length}.
1977 @item logfile = @var{string}
1978 Set logfile---the same as @samp{-o}.
1980 @item login = @var{string}
1981 Your user name on the remote machine, for @sc{ftp}. Defaults to
1984 @item mirror = on/off
1985 Turn mirroring on/off. The same as @samp{-m}.
1987 @item netrc = on/off
1988 Turn reading netrc on or off.
1990 @item noclobber = on/off
1993 @item no_parent = on/off
1994 Disallow retrieving outside the directory hierarchy, like
1995 @samp{--no-parent} (@pxref{Directory-Based Limits}).
1997 @item no_proxy = @var{string}
1998 Use @var{string} as the comma-separated list of domains to avoid in
1999 proxy loading, instead of the one specified in environment.
2001 @item output_document = @var{string}
2002 Set the output filename---the same as @samp{-O}.
2004 @item page_requisites = on/off
2005 Download all ancillary documents necessary for a single HTML page to
2006 display properly---the same as @samp{-p}.
2008 @item passive_ftp = on/off/always/never
2009 Set passive @sc{ftp}---the same as @samp{--passive-ftp}. Some scripts
2010 and @samp{.pm} (Perl module) files download files using @samp{wget
2011 --passive-ftp}. If your firewall does not allow this, you can set
2012 @samp{passive_ftp = never} to override the commandline.
2014 @item passwd = @var{string}
2015 Set your @sc{ftp} password to @var{password}. Without this setting, the
2016 password defaults to @samp{username@@hostname.domainname}.
2018 @item proxy_user = @var{string}
2019 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
2021 @item proxy_passwd = @var{string}
2022 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
2024 @item referer = @var{string}
2025 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
2026 was the folks who wrote the @sc{http} spec who got the spelling of
2027 ``referrer'' wrong.)
2029 @item quiet = on/off
2030 Quiet mode---the same as @samp{-q}.
2032 @item quota = @var{quota}
2033 Specify the download quota, which is useful to put in the global
2034 @file{wgetrc}. When download quota is specified, Wget will stop
2035 retrieving after the download sum has become greater than quota. The
2036 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2037 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2038 to 5 mbytes. Note that the user's startup file overrides system
2041 @item reclevel = @var{n}
2042 Recursion level---the same as @samp{-l}.
2044 @item recursive = on/off
2045 Recursive on/off---the same as @samp{-r}.
2047 @item relative_only = on/off
2048 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2051 @item remove_listing = on/off
2052 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2053 to off is the same as @samp{-nr}.
2055 @item retr_symlinks = on/off
2056 When set to on, retrieve symbolic links as if they were plain files; the
2057 same as @samp{--retr-symlinks}.
2059 @item robots = on/off
2060 Use (or not) @file{/robots.txt} file (@pxref{Robots}). Be sure to know
2061 what you are doing before changing the default (which is @samp{on}).
2063 @item server_response = on/off
2064 Choose whether or not to print the @sc{http} and @sc{ftp} server
2065 responses---the same as @samp{-S}.
2067 @item simple_host_check = on/off
2068 Same as @samp{-nh} (@pxref{Host Checking}).
2070 @item span_hosts = on/off
2073 @item timeout = @var{n}
2074 Set timeout value---the same as @samp{-T}.
2076 @item timestamping = on/off
2077 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2079 @item tries = @var{n}
2080 Set number of retries per @sc{url}---the same as @samp{-t}.
2082 @item use_proxy = on/off
2083 Turn proxy support on/off. The same as @samp{-Y}.
2085 @item verbose = on/off
2086 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2088 @item wait = @var{n}
2089 Wait @var{n} seconds between retrievals---the same as @samp{-w}.
2091 @item waitretry = @var{n}
2092 Wait up to @var{n} seconds between retries of failed retrievals
2093 only---the same as @samp{--waitretry}. Note that this is turned on by
2094 default in the global @file{wgetrc}.
2097 @node Sample Wgetrc, , Wgetrc Commands, Startup File
2098 @section Sample Wgetrc
2099 @cindex sample wgetrc
2101 This is the sample initialization file, as given in the distribution.
2102 It is divided in two section---one for global usage (suitable for global
2103 startup file), and one for local usage (suitable for
2104 @file{$HOME/.wgetrc}). Be careful about the things you change.
2106 Note that almost all the lines are commented out. For a command to have
2107 any effect, you must remove the @samp{#} character at the beginning of
2111 @include sample.wgetrc.munged_for_texi_inclusion
2114 @node Examples, Various, Startup File, Top
2118 The examples are classified into three sections, because of clarity.
2119 The first section is a tutorial for beginners. The second section
2120 explains some of the more complex program features. The third section
2121 contains advice for mirror administrators, as well as even more complex
2122 features (that some would call perverted).
2125 * Simple Usage:: Simple, basic usage of the program.
2126 * Advanced Usage:: Advanced techniques of usage.
2127 * Guru Usage:: Mirroring and the hairy stuff.
2130 @node Simple Usage, Advanced Usage, Examples, Examples
2131 @section Simple Usage
2135 Say you want to download a @sc{url}. Just type:
2138 wget http://fly.srk.fer.hr/
2141 The response will be something like:
2145 --13:30:45-- http://fly.srk.fer.hr:80/en/
2147 Connecting to fly.srk.fer.hr:80... connected!
2148 HTTP request sent, awaiting response... 200 OK
2149 Length: 4,694 [text/html]
2153 13:30:46 (23.75 KB/s) - `index.html' saved [4694/4694]
2158 But what will happen if the connection is slow, and the file is lengthy?
2159 The connection will probably fail before the whole file is retrieved,
2160 more than once. In this case, Wget will try getting the file until it
2161 either gets the whole of it, or exceeds the default number of retries
2162 (this being 20). It is easy to change the number of tries to 45, to
2163 insure that the whole file will arrive safely:
2166 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2170 Now let's leave Wget to work in the background, and write its progress
2171 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2172 shall use @samp{-t}.
2175 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2178 The ampersand at the end of the line makes sure that Wget works in the
2179 background. To unlimit the number of retries, use @samp{-t inf}.
2182 The usage of @sc{ftp} is as simple. Wget will take care of login and
2187 $ wget ftp://gnjilux.srk.fer.hr/welcome.msg
2188 --10:08:47-- ftp://gnjilux.srk.fer.hr:21/welcome.msg
2190 Connecting to gnjilux.srk.fer.hr:21... connected!
2191 Logging in as anonymous ... Logged in!
2192 ==> TYPE I ... done. ==> CWD not needed.
2193 ==> PORT ... done. ==> RETR welcome.msg ... done.
2194 Length: 1,340 (unauthoritative)
2198 10:08:48 (1.28 MB/s) - `welcome.msg' saved [1340]
2203 If you specify a directory, Wget will retrieve the directory listing,
2204 parse it and convert it to @sc{html}. Try:
2207 wget ftp://prep.ai.mit.edu/pub/gnu/
2212 @node Advanced Usage, Guru Usage, Simple Usage, Examples
2213 @section Advanced Usage
2217 You would like to read the list of @sc{url}s from a file? Not a problem
2224 If you specify @samp{-} as file name, the @sc{url}s will be read from
2228 Create a mirror image of GNU @sc{www} site (with the same directory structure
2229 the original has) with only one try per document, saving the log of the
2230 activities to @file{gnulog}:
2233 wget -r -t1 http://www.gnu.ai.mit.edu/ -o gnulog
2237 Retrieve the first layer of yahoo links:
2240 wget -r -l1 http://www.yahoo.com/
2244 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2248 wget -S http://www.lycos.com/
2252 Save the server headers with the file:
2254 wget -s http://www.lycos.com/
2259 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2263 wget -P/tmp -l2 ftp://wuarchive.wustl.edu/
2267 You want to download all the @sc{gif}s from an @sc{http} directory.
2268 @samp{wget http://host/dir/*.gif} doesn't work, since @sc{http}
2269 retrieval does not support globbing. In that case, use:
2272 wget -r -l1 --no-parent -A.gif http://host/dir/
2275 It is a bit of a kludge, but it works. @samp{-r -l1} means to retrieve
2276 recursively (@pxref{Recursive Retrieval}), with maximum depth of 1.
2277 @samp{--no-parent} means that references to the parent directory are
2278 ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2279 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2283 Suppose you were in the middle of downloading, when Wget was
2284 interrupted. Now you do not want to clobber the files already present.
2288 wget -nc -r http://www.gnu.ai.mit.edu/
2292 If you want to encode your own username and password to @sc{http} or
2293 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2296 wget ftp://hniksic:mypassword@@jagor.srce.hr/.emacs
2300 If you do not like the default retrieval visualization (1K dots with 10
2301 dots per cluster and 50 dots per line), you can customize it through dot
2302 settings (@pxref{Wgetrc Commands}). For example, many people like the
2303 ``binary'' style of retrieval, with 8K dots and 512K lines:
2306 wget --dot-style=binary ftp://prep.ai.mit.edu/pub/gnu/README
2309 You can experiment with other styles, like:
2312 wget --dot-style=mega ftp://ftp.xemacs.org/pub/xemacs/xemacs-20.4/xemacs-20.4.tar.gz
2313 wget --dot-style=micro http://fly.srk.fer.hr/
2316 To make these settings permanent, put them in your @file{.wgetrc}, as
2317 described before (@pxref{Sample Wgetrc}).
2320 @node Guru Usage, , Advanced Usage, Examples
2326 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2327 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2328 for @samp{-r -N}. You can put Wget in the crontab file asking it to
2329 recheck a site each Sunday:
2333 0 0 * * 0 wget --mirror ftp://ftp.xemacs.org/pub/xemacs/ -o /home/me/weeklog
2337 You may wish to do the same with someone's home page. But you do not
2338 want to download all those images---you're only interested in @sc{html}.
2341 wget --mirror -A.html http://www.w3.org/
2345 But what about mirroring the hosts networkologically close to you? It
2346 seems so awfully slow because of all that @sc{dns} resolving. Just use
2347 @samp{-D} (@pxref{Domain Acceptance}).
2350 wget -rN -Dsrce.hr http://www.srce.hr/
2353 Now Wget will correctly find out that @samp{regoc.srce.hr} is the same
2354 as @samp{www.srce.hr}, but will not even take into consideration the
2355 link to @samp{www.mit.edu}.
2358 You have a presentation and would like the dumb absolute links to be
2359 converted to relative? Use @samp{-k}:
2362 wget -k -r @var{URL}
2365 @cindex redirecting output
2367 You would like the output documents to go to standard output instead of
2368 to files? OK, but Wget will automatically shut up (turn on
2369 @samp{--quiet}) to prevent mixing of Wget output and the retrieved
2373 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2376 You can also combine the two options and make weird pipelines to
2377 retrieve the documents from remote hotlists:
2380 wget -O - http://cool.list.com/ | wget --force-html -i -
2384 @node Various, Appendices, Examples, Top
2388 This chapter contains all the stuff that could not fit anywhere else.
2391 * Proxies:: Support for proxy servers
2392 * Distribution:: Getting the latest version.
2393 * Mailing List:: Wget mailing list for announcements and discussion.
2394 * Reporting Bugs:: How and where to report bugs.
2395 * Portability:: The systems Wget works on.
2396 * Signals:: Signal-handling performed by Wget.
2399 @node Proxies, Distribution, Various, Various
2403 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2404 data from remote servers to local clients. One typical use of proxies
2405 is lightening network load for users behind a slow connection. This is
2406 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2407 proxy which caches the transferred data. When a cached resource is
2408 requested again, proxy will return the data from cache. Another use for
2409 proxies is for companies that separate (for security reasons) their
2410 internal networks from the rest of Internet. In order to obtain
2411 information from the Web, their users connect and retrieve remote data
2412 using an authorized proxy.
2414 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2415 standard way to specify proxy location, which Wget recognizes, is using
2416 the following environment variables:
2420 This variable should contain the @sc{url} of the proxy for @sc{http}
2424 This variable should contain the @sc{url} of the proxy for @sc{http}
2425 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2426 are set to the same @sc{url}.
2429 This variable should contain a comma-separated list of domain extensions
2430 proxy should @emph{not} be used for. For instance, if the value of
2431 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2435 In addition to the environment variables, proxy location and settings
2436 may be specified from within Wget itself.
2440 @itemx --proxy=on/off
2441 @itemx proxy = on/off
2442 This option may be used to turn the proxy support on or off. Proxy
2443 support is on by default, provided that the appropriate environment
2446 @item http_proxy = @var{URL}
2447 @itemx ftp_proxy = @var{URL}
2448 @itemx no_proxy = @var{string}
2449 These startup file variables allow you to override the proxy settings
2450 specified by the environment.
2453 Some proxy servers require authorization to enable you to use them. The
2454 authorization consists of @dfn{username} and @dfn{password}, which must
2455 be sent by Wget. As with @sc{http} authorization, several
2456 authentication schemes exist. For proxy authorization only the
2457 @code{Basic} authentication scheme is currently implemented.
2459 You may specify your username and password either through the proxy
2460 @sc{url} or through the command-line options. Assuming that the
2461 company's proxy is located at @samp{proxy.srce.hr} at port 8001, a proxy
2462 @sc{url} location containing authorization data might look like this:
2465 http://hniksic:mypassword@@proxy.company.com:8001/
2468 Alternatively, you may use the @samp{proxy-user} and
2469 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2470 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2471 username and password.
2473 @node Distribution, Mailing List, Proxies, Various
2474 @section Distribution
2475 @cindex latest version
2477 Like all GNU utilities, the latest version of Wget can be found at the
2478 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2479 Wget @value{VERSION} can be found at
2480 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2482 @node Mailing List, Reporting Bugs, Distribution, Various
2483 @section Mailing List
2484 @cindex mailing list
2487 Wget has its own mailing list at @email{wget@@sunsite.auc.dk}, thanks
2488 to Karsten Thygesen. The mailing list is for discussion of Wget
2489 features and web, reporting Wget bugs (those that you think may be of
2490 interest to the public) and mailing announcements. You are welcome to
2491 subscribe. The more people on the list, the better!
2493 To subscribe, send mail to @email{wget-subscribe@@sunsite.auc.dk}.
2494 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2495 mailing to @email{wget-unsubscribe@@sunsite.auc.dk}.
2497 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2498 Alternative archive is available at
2499 @url{http://www.mail-archive.com/wget%40sunsite.auc.dk/}.
2501 @node Reporting Bugs, Portability, Mailing List, Various
2502 @section Reporting Bugs
2504 @cindex reporting bugs
2508 You are welcome to send bug reports about GNU Wget to
2509 @email{bug-wget@@gnu.org}.
2511 Before actually submitting a bug report, please try to follow a few
2516 Please try to ascertain that the behaviour you see really is a bug. If
2517 Wget crashes, it's a bug. If Wget does not behave as documented,
2518 it's a bug. If things work strange, but you are not sure about the way
2519 they are supposed to work, it might well be a bug.
2522 Try to repeat the bug in as simple circumstances as possible. E.g. if
2523 Wget crashes on @samp{wget -rLl0 -t5 -Y0 http://yoyodyne.com -o
2524 /tmp/log}, you should try to see if it will crash with a simpler set of
2527 Also, while I will probably be interested to know the contents of your
2528 @file{.wgetrc} file, just dumping it into the debug message is probably
2529 a bad idea. Instead, you should first try to see if the bug repeats
2530 with @file{.wgetrc} moved out of the way. Only if it turns out that
2531 @file{.wgetrc} settings affect the bug, should you mail me the relevant
2535 Please start Wget with @samp{-d} option and send the log (or the
2536 relevant parts of it). If Wget was compiled without debug support,
2537 recompile it. It is @emph{much} easier to trace bugs with debug support
2541 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2542 wget` core} and type @code{where} to get the backtrace.
2545 Find where the bug is, fix it and send me the patches. :-)
2549 @node Portability, Signals, Reporting Bugs, Various
2550 @section Portability
2552 @cindex operating systems
2554 Since Wget uses GNU Autoconf for building and configuring, and avoids
2555 using ``special'' ultra--mega--cool features of any particular Unix, it
2556 should compile (and work) on all common Unix flavors.
2558 Various Wget versions have been compiled and tested under many kinds of
2559 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2560 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2561 distribution directory for a comprehensive list. If you compile it on
2562 an architecture not listed there, please let me know so I can update it.
2564 Wget should also compile on the other Unix systems, not listed in
2565 @file{MACHINES}. If it doesn't, please let me know.
2567 Thanks to kind contributors, this version of Wget compiles and works on
2568 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2569 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2570 with Winsock as networking software. Naturally, it is crippled of some
2571 features available on Unix, but it should work as a substitute for
2572 people stuck with Windows. Note that the Windows port is
2573 @strong{neither tested nor maintained} by me---all questions and
2574 problems should be reported to Wget mailing list at
2575 @email{wget@@sunsite.auc.dk} where the maintainers will look at them.
2577 @node Signals, , Portability, Various
2579 @cindex signal handling
2582 Since the purpose of Wget is background work, it catches the hangup
2583 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2584 output, it will be redirected to a file named @file{wget-log}.
2585 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2586 to redirect the output of Wget after having started it.
2589 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2590 $ kill -HUP %% # Redirect the output to wget-log
2593 Other than that, Wget will not try to interfere with signals in any way.
2594 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
2596 @node Appendices, Copying, Various, Top
2599 This chapter contains some references I consider useful.
2602 * Robots:: Wget as a WWW robot.
2603 * Security Considerations:: Security with Wget.
2604 * Contributors:: People who helped.
2607 @node Robots, Security Considerations, Appendices, Appendices
2611 @cindex server maintenance
2613 It is extremely easy to make Wget wander aimlessly around a web site,
2614 sucking all the available data in progress. @samp{wget -r @var{site}},
2615 and you're set. Great? Not for the server admin.
2617 While Wget is retrieving static pages, there's not much of a problem.
2618 But for Wget, there is no real difference between the smallest static
2619 page and the hardest, most demanding CGI or dynamic page. For instance,
2620 a site I know has a section handled by an, uh, bitchin' CGI script that
2621 converts all the Info files to HTML. The script can and does bring the
2622 machine to its knees without providing anything useful to the
2625 For such and similar cases various robot exclusion schemes have been
2626 devised as a means for the server administrators and document authors to
2627 protect chosen portions of their sites from the wandering of robots.
2629 The more popular mechanism is the @dfn{Robots Exclusion Standard}
2630 written by Martijn Koster et al. in 1994. It is specified by placing a
2631 file named @file{/robots.txt} in the server root, which the robots are
2632 supposed to download and parse. Wget supports this specification.
2634 Norobots support is turned on only when retrieving recursively, and
2635 @emph{never} for the first page. Thus, you may issue:
2638 wget -r http://fly.srk.fer.hr/
2641 First the index of fly.srk.fer.hr will be downloaded. If Wget finds
2642 anything worth downloading on the same host, only @emph{then} will it
2643 load the robots, and decide whether or not to load the links after all.
2644 @file{/robots.txt} is loaded only once per host.
2646 Note that the exlusion standard discussed here has undergone some
2647 revisions. However, but Wget supports only the first version of
2648 @sc{res}, the one written by Martijn Koster in 1994, available at
2649 @url{http://info.webcrawler.com/mak/projects/robots/norobots.html}. A
2650 later version exists in the form of an internet draft
2651 <draft-koster-robots-00.txt> titled ``A Method for Web Robots Control'',
2652 which expired on June 4, 1997. I am not aware if it ever made to an
2653 @sc{rfc}. The text of the draft is available at
2654 @url{http://info.webcrawler.com/mak/projects/robots/norobots-rfc.html}.
2655 Wget does not yet support the new directives specified by this draft,
2656 but we plan to add them.
2658 This manual no longer includes the text of the old standard.
2660 The second, less known mechanism, enables the author of an individual
2661 document to specify whether they want the links from the file to be
2662 followed by a robot. This is achieved using the @code{META} tag, like
2666 <meta name="robots" content="nofollow">
2669 This is explained in some detail at
2670 @url{http://info.webcrawler.com/mak/projects/robots/meta-user.html}.
2671 Wget supports this method of robot exclusion in addition to the usual
2672 @file{/robots.txt} exclusion.
2674 @node Security Considerations, Contributors, Robots, Appendices
2675 @section Security Considerations
2678 When using Wget, you must be aware that it sends unencrypted passwords
2679 through the network, which may present a security problem. Here are the
2680 main issues, and some solutions.
2684 The passwords on the command line are visible using @code{ps}. If this
2685 is a problem, avoid putting passwords from the command line---e.g. you
2686 can use @file{.netrc} for this.
2689 Using the insecure @dfn{basic} authentication scheme, unencrypted
2690 passwords are transmitted through the network routers and gateways.
2693 The @sc{ftp} passwords are also in no way encrypted. There is no good
2694 solution for this at the moment.
2697 Although the ``normal'' output of Wget tries to hide the passwords,
2698 debugging logs show them, in all forms. This problem is avoided by
2699 being careful when you send debug logs (yes, even when you send them to
2703 @node Contributors, , Security Considerations, Appendices
2704 @section Contributors
2705 @cindex contributors
2708 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
2711 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
2713 However, its development could never have gone as far as it has, were it
2714 not for the help of many people, either with bug reports, feature
2715 proposals, patches, or letters saying ``Thanks!''.
2717 Special thanks goes to the following people (no particular order):
2721 Karsten Thygesen---donated system resources such as the mailing list,
2722 web space, and @sc{ftp} space, along with a lot of time to make these
2726 Shawn McHorse---bug reports and patches.
2729 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
2733 Gordon Matzigkeit---@file{.netrc} support.
2737 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2738 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2741 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2742 and ``philosophical'' discussions.
2746 Darko Budor---initial port to Windows.
2749 Antonio Rosella---help and suggestions, plus the Italian translation.
2753 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2757 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2762 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2765 Francois Pinard---many thorough bug reports and discussions.
2769 Karl Eichwalder---lots of help with internationalization and other
2773 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2777 Brian Gough---a generous donation.
2780 The following people have provided patches, bug/build reports, useful
2781 suggestions, beta testing services, fan mail and all the other things
2782 that make maintenance so much fun:
2788 Roger Beeman and the Gurus at Cisco,
2797 Kristijan @v{C}onka@v{s},
2814 Aleksandar Erkalovi@'{c},
2817 Aleksandar Erkalovic,
2830 Erik Magnus Hulthen,
2841 Goran Kezunovi@'{c},
2851 $\Sigma\acute{\iota}\mu o\varsigma\;
2852 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
2853 (Simos KSenitellis),
2861 Alexander V. Lukyanov,
2879 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
2881 Juan Jos\'{e} Rodr\'{\i}gues,
2884 Juan Jose Rodrigues,
2894 Szakacsits Szabolcs,
2898 Douglas E. Wegscheid,
2908 Apologies to all who I accidentally left out, and many thanks to all the
2909 subscribers of the Wget mailing list.
2911 @node Copying, Concept Index, Appendices, Top
2917 Wget is @dfn{free software}, where ``free'' refers to liberty, not
2918 price. As the GNU people like to say, think of ``free speech'' rather
2919 than ``free beer''. The exact legal distribution terms follow below,
2920 but in short, you have the right (freedom) to run and change Wget and
2921 distribute it to other people, and even---if you want---charge money for
2922 any of these things. The sole restriction is that you have to grant
2923 your recipients the same rights.
2925 This method of licensing software is also known as @dfn{open-source},
2926 because it requires that the recipients always receive a program's
2927 source code along with the program.
2932 This program is free software; you can redistribute it and/or modify it
2933 under the terms of the GNU General Public License as published by the
2934 Free Software Foundation; either version 2 of the License, or (at your
2935 option) any later version.
2937 This program is distributed in the hope that it will be useful, but
2938 WITHOUT ANY WARRANTY; without even the implied warranty of
2939 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2940 General Public License for more details.
2942 You should have received a copy of the GNU General Public License
2943 along with this program; if not, write to the Free Software
2944 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
2947 In addition to this, this manual is free in the same sense:
2950 Permission is granted to copy, distribute and/or modify this document
2951 under the terms of the GNU Free Documentation License, Version 1.1 or
2952 any later version published by the Free Software Foundation; with the
2953 Invariant Sections being ``GNU General Public License'' and ``GNU Free
2954 Documentation License'', with no Front-Cover Texts, and with no
2955 Back-Cover Texts. A copy of the license is included in the section
2956 entitled ``GNU Free Documentation License''.
2959 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
2960 @c that the GFDL needs to be present in the manual, and to me it would
2961 @c suck to include the license for the manual and not the license for
2964 The full texts of the GNU General Public License and of the GNU Free
2965 Documentation License are available below.
2968 * GNU General Public License::
2969 * GNU Free Documentation License::
2972 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
2973 @section GNU General Public License
2974 @center Version 2, June 1991
2977 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
2978 675 Mass Ave, Cambridge, MA 02139, USA
2980 Everyone is permitted to copy and distribute verbatim copies
2981 of this license document, but changing it is not allowed.
2984 @unnumberedsec Preamble
2986 The licenses for most software are designed to take away your
2987 freedom to share and change it. By contrast, the GNU General Public
2988 License is intended to guarantee your freedom to share and change free
2989 software---to make sure the software is free for all its users. This
2990 General Public License applies to most of the Free Software
2991 Foundation's software and to any other program whose authors commit to
2992 using it. (Some other Free Software Foundation software is covered by
2993 the GNU Library General Public License instead.) You can apply it to
2996 When we speak of free software, we are referring to freedom, not
2997 price. Our General Public Licenses are designed to make sure that you
2998 have the freedom to distribute copies of free software (and charge for
2999 this service if you wish), that you receive source code or can get it
3000 if you want it, that you can change the software or use pieces of it
3001 in new free programs; and that you know you can do these things.
3003 To protect your rights, we need to make restrictions that forbid
3004 anyone to deny you these rights or to ask you to surrender the rights.
3005 These restrictions translate to certain responsibilities for you if you
3006 distribute copies of the software, or if you modify it.
3008 For example, if you distribute copies of such a program, whether
3009 gratis or for a fee, you must give the recipients all the rights that
3010 you have. You must make sure that they, too, receive or can get the
3011 source code. And you must show them these terms so they know their
3014 We protect your rights with two steps: (1) copyright the software, and
3015 (2) offer you this license which gives you legal permission to copy,
3016 distribute and/or modify the software.
3018 Also, for each author's protection and ours, we want to make certain
3019 that everyone understands that there is no warranty for this free
3020 software. If the software is modified by someone else and passed on, we
3021 want its recipients to know that what they have is not the original, so
3022 that any problems introduced by others will not reflect on the original
3023 authors' reputations.
3025 Finally, any free program is threatened constantly by software
3026 patents. We wish to avoid the danger that redistributors of a free
3027 program will individually obtain patent licenses, in effect making the
3028 program proprietary. To prevent this, we have made it clear that any
3029 patent must be licensed for everyone's free use or not licensed at all.
3031 The precise terms and conditions for copying, distribution and
3032 modification follow.
3035 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3038 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3043 This License applies to any program or other work which contains
3044 a notice placed by the copyright holder saying it may be distributed
3045 under the terms of this General Public License. The ``Program'', below,
3046 refers to any such program or work, and a ``work based on the Program''
3047 means either the Program or any derivative work under copyright law:
3048 that is to say, a work containing the Program or a portion of it,
3049 either verbatim or with modifications and/or translated into another
3050 language. (Hereinafter, translation is included without limitation in
3051 the term ``modification''.) Each licensee is addressed as ``you''.
3053 Activities other than copying, distribution and modification are not
3054 covered by this License; they are outside its scope. The act of
3055 running the Program is not restricted, and the output from the Program
3056 is covered only if its contents constitute a work based on the
3057 Program (independent of having been made by running the Program).
3058 Whether that is true depends on what the Program does.
3061 You may copy and distribute verbatim copies of the Program's
3062 source code as you receive it, in any medium, provided that you
3063 conspicuously and appropriately publish on each copy an appropriate
3064 copyright notice and disclaimer of warranty; keep intact all the
3065 notices that refer to this License and to the absence of any warranty;
3066 and give any other recipients of the Program a copy of this License
3067 along with the Program.
3069 You may charge a fee for the physical act of transferring a copy, and
3070 you may at your option offer warranty protection in exchange for a fee.
3073 You may modify your copy or copies of the Program or any portion
3074 of it, thus forming a work based on the Program, and copy and
3075 distribute such modifications or work under the terms of Section 1
3076 above, provided that you also meet all of these conditions:
3080 You must cause the modified files to carry prominent notices
3081 stating that you changed the files and the date of any change.
3084 You must cause any work that you distribute or publish, that in
3085 whole or in part contains or is derived from the Program or any
3086 part thereof, to be licensed as a whole at no charge to all third
3087 parties under the terms of this License.
3090 If the modified program normally reads commands interactively
3091 when run, you must cause it, when started running for such
3092 interactive use in the most ordinary way, to print or display an
3093 announcement including an appropriate copyright notice and a
3094 notice that there is no warranty (or else, saying that you provide
3095 a warranty) and that users may redistribute the program under
3096 these conditions, and telling the user how to view a copy of this
3097 License. (Exception: if the Program itself is interactive but
3098 does not normally print such an announcement, your work based on
3099 the Program is not required to print an announcement.)
3102 These requirements apply to the modified work as a whole. If
3103 identifiable sections of that work are not derived from the Program,
3104 and can be reasonably considered independent and separate works in
3105 themselves, then this License, and its terms, do not apply to those
3106 sections when you distribute them as separate works. But when you
3107 distribute the same sections as part of a whole which is a work based
3108 on the Program, the distribution of the whole must be on the terms of
3109 this License, whose permissions for other licensees extend to the
3110 entire whole, and thus to each and every part regardless of who wrote it.
3112 Thus, it is not the intent of this section to claim rights or contest
3113 your rights to work written entirely by you; rather, the intent is to
3114 exercise the right to control the distribution of derivative or
3115 collective works based on the Program.
3117 In addition, mere aggregation of another work not based on the Program
3118 with the Program (or with a work based on the Program) on a volume of
3119 a storage or distribution medium does not bring the other work under
3120 the scope of this License.
3123 You may copy and distribute the Program (or a work based on it,
3124 under Section 2) in object code or executable form under the terms of
3125 Sections 1 and 2 above provided that you also do one of the following:
3129 Accompany it with the complete corresponding machine-readable
3130 source code, which must be distributed under the terms of Sections
3131 1 and 2 above on a medium customarily used for software interchange; or,
3134 Accompany it with a written offer, valid for at least three
3135 years, to give any third party, for a charge no more than your
3136 cost of physically performing source distribution, a complete
3137 machine-readable copy of the corresponding source code, to be
3138 distributed under the terms of Sections 1 and 2 above on a medium
3139 customarily used for software interchange; or,
3142 Accompany it with the information you received as to the offer
3143 to distribute corresponding source code. (This alternative is
3144 allowed only for noncommercial distribution and only if you
3145 received the program in object code or executable form with such
3146 an offer, in accord with Subsection b above.)
3149 The source code for a work means the preferred form of the work for
3150 making modifications to it. For an executable work, complete source
3151 code means all the source code for all modules it contains, plus any
3152 associated interface definition files, plus the scripts used to
3153 control compilation and installation of the executable. However, as a
3154 special exception, the source code distributed need not include
3155 anything that is normally distributed (in either source or binary
3156 form) with the major components (compiler, kernel, and so on) of the
3157 operating system on which the executable runs, unless that component
3158 itself accompanies the executable.
3160 If distribution of executable or object code is made by offering
3161 access to copy from a designated place, then offering equivalent
3162 access to copy the source code from the same place counts as
3163 distribution of the source code, even though third parties are not
3164 compelled to copy the source along with the object code.
3167 You may not copy, modify, sublicense, or distribute the Program
3168 except as expressly provided under this License. Any attempt
3169 otherwise to copy, modify, sublicense or distribute the Program is
3170 void, and will automatically terminate your rights under this License.
3171 However, parties who have received copies, or rights, from you under
3172 this License will not have their licenses terminated so long as such
3173 parties remain in full compliance.
3176 You are not required to accept this License, since you have not
3177 signed it. However, nothing else grants you permission to modify or
3178 distribute the Program or its derivative works. These actions are
3179 prohibited by law if you do not accept this License. Therefore, by
3180 modifying or distributing the Program (or any work based on the
3181 Program), you indicate your acceptance of this License to do so, and
3182 all its terms and conditions for copying, distributing or modifying
3183 the Program or works based on it.
3186 Each time you redistribute the Program (or any work based on the
3187 Program), the recipient automatically receives a license from the
3188 original licensor to copy, distribute or modify the Program subject to
3189 these terms and conditions. You may not impose any further
3190 restrictions on the recipients' exercise of the rights granted herein.
3191 You are not responsible for enforcing compliance by third parties to
3195 If, as a consequence of a court judgment or allegation of patent
3196 infringement or for any other reason (not limited to patent issues),
3197 conditions are imposed on you (whether by court order, agreement or
3198 otherwise) that contradict the conditions of this License, they do not
3199 excuse you from the conditions of this License. If you cannot
3200 distribute so as to satisfy simultaneously your obligations under this
3201 License and any other pertinent obligations, then as a consequence you
3202 may not distribute the Program at all. For example, if a patent
3203 license would not permit royalty-free redistribution of the Program by
3204 all those who receive copies directly or indirectly through you, then
3205 the only way you could satisfy both it and this License would be to
3206 refrain entirely from distribution of the Program.
3208 If any portion of this section is held invalid or unenforceable under
3209 any particular circumstance, the balance of the section is intended to
3210 apply and the section as a whole is intended to apply in other
3213 It is not the purpose of this section to induce you to infringe any
3214 patents or other property right claims or to contest validity of any
3215 such claims; this section has the sole purpose of protecting the
3216 integrity of the free software distribution system, which is
3217 implemented by public license practices. Many people have made
3218 generous contributions to the wide range of software distributed
3219 through that system in reliance on consistent application of that
3220 system; it is up to the author/donor to decide if he or she is willing
3221 to distribute software through any other system and a licensee cannot
3224 This section is intended to make thoroughly clear what is believed to
3225 be a consequence of the rest of this License.
3228 If the distribution and/or use of the Program is restricted in
3229 certain countries either by patents or by copyrighted interfaces, the
3230 original copyright holder who places the Program under this License
3231 may add an explicit geographical distribution limitation excluding
3232 those countries, so that distribution is permitted only in or among
3233 countries not thus excluded. In such case, this License incorporates
3234 the limitation as if written in the body of this License.
3237 The Free Software Foundation may publish revised and/or new versions
3238 of the General Public License from time to time. Such new versions will
3239 be similar in spirit to the present version, but may differ in detail to
3240 address new problems or concerns.
3242 Each version is given a distinguishing version number. If the Program
3243 specifies a version number of this License which applies to it and ``any
3244 later version'', you have the option of following the terms and conditions
3245 either of that version or of any later version published by the Free
3246 Software Foundation. If the Program does not specify a version number of
3247 this License, you may choose any version ever published by the Free Software
3251 If you wish to incorporate parts of the Program into other free
3252 programs whose distribution conditions are different, write to the author
3253 to ask for permission. For software which is copyrighted by the Free
3254 Software Foundation, write to the Free Software Foundation; we sometimes
3255 make exceptions for this. Our decision will be guided by the two goals
3256 of preserving the free status of all derivatives of our free software and
3257 of promoting the sharing and reuse of software generally.
3260 @heading NO WARRANTY
3268 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3269 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3270 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3271 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3272 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3273 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3274 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3275 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3276 REPAIR OR CORRECTION.
3279 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3280 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3281 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3282 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3283 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3284 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3285 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3286 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3287 POSSIBILITY OF SUCH DAMAGES.
3291 @heading END OF TERMS AND CONDITIONS
3294 @center END OF TERMS AND CONDITIONS
3298 @unnumberedsec How to Apply These Terms to Your New Programs
3300 If you develop a new program, and you want it to be of the greatest
3301 possible use to the public, the best way to achieve this is to make it
3302 free software which everyone can redistribute and change under these terms.
3304 To do so, attach the following notices to the program. It is safest
3305 to attach them to the start of each source file to most effectively
3306 convey the exclusion of warranty; and each file should have at least
3307 the ``copyright'' line and a pointer to where the full notice is found.
3310 @var{one line to give the program's name and an idea of what it does.}
3311 Copyright (C) 19@var{yy} @var{name of author}
3313 This program is free software; you can redistribute it and/or
3314 modify it under the terms of the GNU General Public License
3315 as published by the Free Software Foundation; either version 2
3316 of the License, or (at your option) any later version.
3318 This program is distributed in the hope that it will be useful,
3319 but WITHOUT ANY WARRANTY; without even the implied warranty of
3320 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3321 GNU General Public License for more details.
3323 You should have received a copy of the GNU General Public License
3324 along with this program; if not, write to the Free Software
3325 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3328 Also add information on how to contact you by electronic and paper mail.
3330 If the program is interactive, make it output a short notice like this
3331 when it starts in an interactive mode:
3334 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3335 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3336 type `show w'. This is free software, and you are welcome
3337 to redistribute it under certain conditions; type `show c'
3341 The hypothetical commands @samp{show w} and @samp{show c} should show
3342 the appropriate parts of the General Public License. Of course, the
3343 commands you use may be called something other than @samp{show w} and
3344 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3347 You should also get your employer (if you work as a programmer) or your
3348 school, if any, to sign a ``copyright disclaimer'' for the program, if
3349 necessary. Here is a sample; alter the names:
3353 Yoyodyne, Inc., hereby disclaims all copyright
3354 interest in the program `Gnomovision'
3355 (which makes passes at compilers) written
3358 @var{signature of Ty Coon}, 1 April 1989
3359 Ty Coon, President of Vice
3363 This General Public License does not permit incorporating your program into
3364 proprietary programs. If your program is a subroutine library, you may
3365 consider it more useful to permit linking proprietary applications with the
3366 library. If this is what you want to do, use the GNU Library General
3367 Public License instead of this License.
3369 @node GNU Free Documentation License, , GNU General Public License, Copying
3370 @section GNU Free Documentation License
3371 @center Version 1.1, March 2000
3374 Copyright (C) 2000 Free Software Foundation, Inc.
3375 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3377 Everyone is permitted to copy and distribute verbatim copies
3378 of this license document, but changing it is not allowed.
3385 The purpose of this License is to make a manual, textbook, or other
3386 written document ``free'' in the sense of freedom: to assure everyone
3387 the effective freedom to copy and redistribute it, with or without
3388 modifying it, either commercially or noncommercially. Secondarily,
3389 this License preserves for the author and publisher a way to get
3390 credit for their work, while not being considered responsible for
3391 modifications made by others.
3393 This License is a kind of ``copyleft'', which means that derivative
3394 works of the document must themselves be free in the same sense. It
3395 complements the GNU General Public License, which is a copyleft
3396 license designed for free software.
3398 We have designed this License in order to use it for manuals for free
3399 software, because free software needs free documentation: a free
3400 program should come with manuals providing the same freedoms that the
3401 software does. But this License is not limited to software manuals;
3402 it can be used for any textual work, regardless of subject matter or
3403 whether it is published as a printed book. We recommend this License
3404 principally for works whose purpose is instruction or reference.
3408 APPLICABILITY AND DEFINITIONS
3410 This License applies to any manual or other work that contains a
3411 notice placed by the copyright holder saying it can be distributed
3412 under the terms of this License. The ``Document'', below, refers to any
3413 such manual or work. Any member of the public is a licensee, and is
3414 addressed as ``you''.
3416 A ``Modified Version'' of the Document means any work containing the
3417 Document or a portion of it, either copied verbatim, or with
3418 modifications and/or translated into another language.
3420 A ``Secondary Section'' is a named appendix or a front-matter section of
3421 the Document that deals exclusively with the relationship of the
3422 publishers or authors of the Document to the Document's overall subject
3423 (or to related matters) and contains nothing that could fall directly
3424 within that overall subject. (For example, if the Document is in part a
3425 textbook of mathematics, a Secondary Section may not explain any
3426 mathematics.) The relationship could be a matter of historical
3427 connection with the subject or with related matters, or of legal,
3428 commercial, philosophical, ethical or political position regarding
3431 The ``Invariant Sections'' are certain Secondary Sections whose titles
3432 are designated, as being those of Invariant Sections, in the notice
3433 that says that the Document is released under this License.
3435 The ``Cover Texts'' are certain short passages of text that are listed,
3436 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3437 the Document is released under this License.
3439 A ``Transparent'' copy of the Document means a machine-readable copy,
3440 represented in a format whose specification is available to the
3441 general public, whose contents can be viewed and edited directly and
3442 straightforwardly with generic text editors or (for images composed of
3443 pixels) generic paint programs or (for drawings) some widely available
3444 drawing editor, and that is suitable for input to text formatters or
3445 for automatic translation to a variety of formats suitable for input
3446 to text formatters. A copy made in an otherwise Transparent file
3447 format whose markup has been designed to thwart or discourage
3448 subsequent modification by readers is not Transparent. A copy that is
3449 not ``Transparent'' is called ``Opaque''.
3451 Examples of suitable formats for Transparent copies include plain
3452 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3453 or XML using a publicly available DTD, and standard-conforming simple
3454 HTML designed for human modification. Opaque formats include
3455 PostScript, PDF, proprietary formats that can be read and edited only
3456 by proprietary word processors, SGML or XML for which the DTD and/or
3457 processing tools are not generally available, and the
3458 machine-generated HTML produced by some word processors for output
3461 The ``Title Page'' means, for a printed book, the title page itself,
3462 plus such following pages as are needed to hold, legibly, the material
3463 this License requires to appear in the title page. For works in
3464 formats which do not have any title page as such, ``Title Page'' means
3465 the text near the most prominent appearance of the work's title,
3466 preceding the beginning of the body of the text.
3471 You may copy and distribute the Document in any medium, either
3472 commercially or noncommercially, provided that this License, the
3473 copyright notices, and the license notice saying this License applies
3474 to the Document are reproduced in all copies, and that you add no other
3475 conditions whatsoever to those of this License. You may not use
3476 technical measures to obstruct or control the reading or further
3477 copying of the copies you make or distribute. However, you may accept
3478 compensation in exchange for copies. If you distribute a large enough
3479 number of copies you must also follow the conditions in section 3.
3481 You may also lend copies, under the same conditions stated above, and
3482 you may publicly display copies.
3487 If you publish printed copies of the Document numbering more than 100,
3488 and the Document's license notice requires Cover Texts, you must enclose
3489 the copies in covers that carry, clearly and legibly, all these Cover
3490 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3491 the back cover. Both covers must also clearly and legibly identify
3492 you as the publisher of these copies. The front cover must present
3493 the full title with all words of the title equally prominent and
3494 visible. You may add other material on the covers in addition.
3495 Copying with changes limited to the covers, as long as they preserve
3496 the title of the Document and satisfy these conditions, can be treated
3497 as verbatim copying in other respects.
3499 If the required texts for either cover are too voluminous to fit
3500 legibly, you should put the first ones listed (as many as fit
3501 reasonably) on the actual cover, and continue the rest onto adjacent
3504 If you publish or distribute Opaque copies of the Document numbering
3505 more than 100, you must either include a machine-readable Transparent
3506 copy along with each Opaque copy, or state in or with each Opaque copy
3507 a publicly-accessible computer-network location containing a complete
3508 Transparent copy of the Document, free of added material, which the
3509 general network-using public has access to download anonymously at no
3510 charge using public-standard network protocols. If you use the latter
3511 option, you must take reasonably prudent steps, when you begin
3512 distribution of Opaque copies in quantity, to ensure that this
3513 Transparent copy will remain thus accessible at the stated location
3514 until at least one year after the last time you distribute an Opaque
3515 copy (directly or through your agents or retailers) of that edition to
3518 It is requested, but not required, that you contact the authors of the
3519 Document well before redistributing any large number of copies, to give
3520 them a chance to provide you with an updated version of the Document.
3525 You may copy and distribute a Modified Version of the Document under
3526 the conditions of sections 2 and 3 above, provided that you release
3527 the Modified Version under precisely this License, with the Modified
3528 Version filling the role of the Document, thus licensing distribution
3529 and modification of the Modified Version to whoever possesses a copy
3530 of it. In addition, you must do these things in the Modified Version:
3532 A. Use in the Title Page (and on the covers, if any) a title distinct
3533 from that of the Document, and from those of previous versions
3534 (which should, if there were any, be listed in the History section
3535 of the Document). You may use the same title as a previous version
3536 if the original publisher of that version gives permission.@*
3537 B. List on the Title Page, as authors, one or more persons or entities
3538 responsible for authorship of the modifications in the Modified
3539 Version, together with at least five of the principal authors of the
3540 Document (all of its principal authors, if it has less than five).@*
3541 C. State on the Title page the name of the publisher of the
3542 Modified Version, as the publisher.@*
3543 D. Preserve all the copyright notices of the Document.@*
3544 E. Add an appropriate copyright notice for your modifications
3545 adjacent to the other copyright notices.@*
3546 F. Include, immediately after the copyright notices, a license notice
3547 giving the public permission to use the Modified Version under the
3548 terms of this License, in the form shown in the Addendum below.@*
3549 G. Preserve in that license notice the full lists of Invariant Sections
3550 and required Cover Texts given in the Document's license notice.@*
3551 H. Include an unaltered copy of this License.@*
3552 I. Preserve the section entitled ``History'', and its title, and add to
3553 it an item stating at least the title, year, new authors, and
3554 publisher of the Modified Version as given on the Title Page. If
3555 there is no section entitled ``History'' in the Document, create one
3556 stating the title, year, authors, and publisher of the Document as
3557 given on its Title Page, then add an item describing the Modified
3558 Version as stated in the previous sentence.@*
3559 J. Preserve the network location, if any, given in the Document for
3560 public access to a Transparent copy of the Document, and likewise
3561 the network locations given in the Document for previous versions
3562 it was based on. These may be placed in the ``History'' section.
3563 You may omit a network location for a work that was published at
3564 least four years before the Document itself, or if the original
3565 publisher of the version it refers to gives permission.@*
3566 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3567 preserve the section's title, and preserve in the section all the
3568 substance and tone of each of the contributor acknowledgements
3569 and/or dedications given therein.@*
3570 L. Preserve all the Invariant Sections of the Document,
3571 unaltered in their text and in their titles. Section numbers
3572 or the equivalent are not considered part of the section titles.@*
3573 M. Delete any section entitled ``Endorsements''. Such a section
3574 may not be included in the Modified Version.@*
3575 N. Do not retitle any existing section as ``Endorsements''
3576 or to conflict in title with any Invariant Section.@*
3578 If the Modified Version includes new front-matter sections or
3579 appendices that qualify as Secondary Sections and contain no material
3580 copied from the Document, you may at your option designate some or all
3581 of these sections as invariant. To do this, add their titles to the
3582 list of Invariant Sections in the Modified Version's license notice.
3583 These titles must be distinct from any other section titles.
3585 You may add a section entitled ``Endorsements'', provided it contains
3586 nothing but endorsements of your Modified Version by various
3587 parties--for example, statements of peer review or that the text has
3588 been approved by an organization as the authoritative definition of a
3591 You may add a passage of up to five words as a Front-Cover Text, and a
3592 passage of up to 25 words as a Back-Cover Text, to the end of the list
3593 of Cover Texts in the Modified Version. Only one passage of
3594 Front-Cover Text and one of Back-Cover Text may be added by (or
3595 through arrangements made by) any one entity. If the Document already
3596 includes a cover text for the same cover, previously added by you or
3597 by arrangement made by the same entity you are acting on behalf of,
3598 you may not add another; but you may replace the old one, on explicit
3599 permission from the previous publisher that added the old one.
3601 The author(s) and publisher(s) of the Document do not by this License
3602 give permission to use their names for publicity for or to assert or
3603 imply endorsement of any Modified Version.
3608 You may combine the Document with other documents released under this
3609 License, under the terms defined in section 4 above for modified
3610 versions, provided that you include in the combination all of the
3611 Invariant Sections of all of the original documents, unmodified, and
3612 list them all as Invariant Sections of your combined work in its
3615 The combined work need only contain one copy of this License, and
3616 multiple identical Invariant Sections may be replaced with a single
3617 copy. If there are multiple Invariant Sections with the same name but
3618 different contents, make the title of each such section unique by
3619 adding at the end of it, in parentheses, the name of the original
3620 author or publisher of that section if known, or else a unique number.
3621 Make the same adjustment to the section titles in the list of
3622 Invariant Sections in the license notice of the combined work.
3624 In the combination, you must combine any sections entitled ``History''
3625 in the various original documents, forming one section entitled
3626 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3627 and any sections entitled ``Dedications''. You must delete all sections
3628 entitled ``Endorsements.''
3631 COLLECTIONS OF DOCUMENTS
3633 You may make a collection consisting of the Document and other documents
3634 released under this License, and replace the individual copies of this
3635 License in the various documents with a single copy that is included in
3636 the collection, provided that you follow the rules of this License for
3637 verbatim copying of each of the documents in all other respects.
3639 You may extract a single document from such a collection, and distribute
3640 it individually under this License, provided you insert a copy of this
3641 License into the extracted document, and follow this License in all
3642 other respects regarding verbatim copying of that document.
3645 AGGREGATION WITH INDEPENDENT WORKS
3647 A compilation of the Document or its derivatives with other separate
3648 and independent documents or works, in or on a volume of a storage or
3649 distribution medium, does not as a whole count as a Modified Version
3650 of the Document, provided no compilation copyright is claimed for the
3651 compilation. Such a compilation is called an ``aggregate'', and this
3652 License does not apply to the other self-contained works thus compiled
3653 with the Document, on account of their being thus compiled, if they
3654 are not themselves derivative works of the Document.
3656 If the Cover Text requirement of section 3 is applicable to these
3657 copies of the Document, then if the Document is less than one quarter
3658 of the entire aggregate, the Document's Cover Texts may be placed on
3659 covers that surround only the Document within the aggregate.
3660 Otherwise they must appear on covers around the whole aggregate.
3665 Translation is considered a kind of modification, so you may
3666 distribute translations of the Document under the terms of section 4.
3667 Replacing Invariant Sections with translations requires special
3668 permission from their copyright holders, but you may include
3669 translations of some or all Invariant Sections in addition to the
3670 original versions of these Invariant Sections. You may include a
3671 translation of this License provided that you also include the
3672 original English version of this License. In case of a disagreement
3673 between the translation and the original English version of this
3674 License, the original English version will prevail.
3679 You may not copy, modify, sublicense, or distribute the Document except
3680 as expressly provided for under this License. Any other attempt to
3681 copy, modify, sublicense or distribute the Document is void, and will
3682 automatically terminate your rights under this License. However,
3683 parties who have received copies, or rights, from you under this
3684 License will not have their licenses terminated so long as such
3685 parties remain in full compliance.
3688 FUTURE REVISIONS OF THIS LICENSE
3690 The Free Software Foundation may publish new, revised versions
3691 of the GNU Free Documentation License from time to time. Such new
3692 versions will be similar in spirit to the present version, but may
3693 differ in detail to address new problems or concerns. See
3694 http://www.gnu.org/copyleft/.
3696 Each version of the License is given a distinguishing version number.
3697 If the Document specifies that a particular numbered version of this
3698 License ``or any later version'' applies to it, you have the option of
3699 following the terms and conditions either of that specified version or
3700 of any later version that has been published (not as a draft) by the
3701 Free Software Foundation. If the Document does not specify a version
3702 number of this License, you may choose any version ever published (not
3703 as a draft) by the Free Software Foundation.
3707 @unnumberedsec ADDENDUM: How to use this License for your documents
3709 To use this License in a document you have written, include a copy of
3710 the License in the document and put the following copyright and
3711 license notices just after the title page:
3716 Copyright (C) @var{year} @var{your name}.
3717 Permission is granted to copy, distribute and/or modify this document
3718 under the terms of the GNU Free Documentation License, Version 1.1
3719 or any later version published by the Free Software Foundation;
3720 with the Invariant Sections being @var{list their titles}, with the
3721 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
3722 A copy of the license is included in the section entitled ``GNU
3723 Free Documentation License''.
3726 If you have no Invariant Sections, write ``with no Invariant Sections''
3727 instead of saying which ones are invariant. If you have no
3728 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
3729 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
3731 If your document contains nontrivial examples of program code, we
3732 recommend releasing these examples in parallel under your choice of
3733 free software license, such as the GNU General Public License,
3734 to permit their use in free software.
3737 @node Concept Index, , Copying, Top
3738 @unnumbered Concept Index