1 \input texinfo @c -*-texinfo-*-
5 @settitle GNU Wget Manual
6 @c Disable the monstrous rectangles beside overfull hbox-es.
8 @c Use `odd' to print double-sided.
13 @c Remove this if you don't use A4 paper.
17 @c This should really be auto-generated!
19 @set UPDATED December 2001
21 @dircategory Net Utilities
22 @dircategory World Wide Web
24 * Wget: (wget). The non-interactive network downloader.
28 This file documents the the GNU Wget utility for downloading network
31 @c man begin COPYRIGHT
32 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
35 Permission is granted to make and distribute verbatim copies of
36 this manual provided the copyright notice and this permission notice
37 are preserved on all copies.
40 Permission is granted to process this file through TeX and print the
41 results, provided the printed document carries a copying permission
42 notice identical to this one except for the removal of this paragraph
43 (this paragraph not being relevant to the printed manual).
45 Permission is granted to copy, distribute and/or modify this document
46 under the terms of the GNU Free Documentation License, Version 1.1 or
47 any later version published by the Free Software Foundation; with the
48 Invariant Sections being ``GNU General Public License'' and ``GNU Free
49 Documentation License'', with no Front-Cover Texts, and with no
50 Back-Cover Texts. A copy of the license is included in the section
51 entitled ``GNU Free Documentation License''.
57 @subtitle The noninteractive downloading utility
58 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
59 @author by Hrvoje Nik@v{s}i@'{c} and the developers
63 Originally written by Hrvoje Niksic <hniksic@arsdigita.com>.
66 GNU Info entry for @file{wget}.
71 @vskip 0pt plus 1filll
72 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
75 Permission is granted to copy, distribute and/or modify this document
76 under the terms of the GNU Free Documentation License, Version 1.1 or
77 any later version published by the Free Software Foundation; with the
78 Invariant Sections being ``GNU General Public License'' and ``GNU Free
79 Documentation License'', with no Front-Cover Texts, and with no
80 Back-Cover Texts. A copy of the license is included in the section
81 entitled ``GNU Free Documentation License''.
85 @node Top, Overview, (dir), (dir)
86 @top Wget @value{VERSION}
88 This manual documents version @value{VERSION} of GNU Wget, the freely
89 available utility for network download.
91 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
95 * Overview:: Features of Wget.
96 * Invoking:: Wget command-line arguments.
97 * Recursive Retrieval:: Description of recursive retrieval.
98 * Following Links:: The available methods of chasing links.
99 * Time-Stamping:: Mirroring according to time-stamps.
100 * Startup File:: Wget's initialization file.
101 * Examples:: Examples of usage.
102 * Various:: The stuff that doesn't fit anywhere else.
103 * Appendices:: Some useful references.
104 * Copying:: You may give out copies of Wget and of this manual.
105 * Concept Index:: Topics covered by this manual.
109 @node Overview, Invoking, Top, Top
114 @c man begin DESCRIPTION
115 GNU Wget is a free utility for non-interactive download of files from
116 the Web. It supports @sc{http}, @sc{https}, and @sc{ftp} protocols, as
117 well as retrieval through @sc{http} proxies.
120 This chapter is a partial overview of Wget's features.
124 @c man begin DESCRIPTION
125 Wget is non-interactive, meaning that it can work in the background,
126 while the user is not logged on. This allows you to start a retrieval
127 and disconnect from the system, letting Wget finish the work. By
128 contrast, most of the Web browsers require constant user's presence,
129 which can be a great hindrance when transferring a lot of data.
135 @c man begin DESCRIPTION
139 @c man begin DESCRIPTION
140 Wget can follow links in @sc{html} pages and create local versions of
141 remote web sites, fully recreating the directory structure of the
142 original site. This is sometimes referred to as ``recursive
143 downloading.'' While doing that, Wget respects the Robot Exclusion
144 Standard (@file{/robots.txt}). Wget can be instructed to convert the
145 links in downloaded @sc{html} files to the local files for offline
151 File name wildcard matching and recursive mirroring of directories are
152 available when retrieving via @sc{ftp}. Wget can read the time-stamp
153 information given by both @sc{http} and @sc{ftp} servers, and store it
154 locally. Thus Wget can see if the remote file has changed since last
155 retrieval, and automatically retrieve the new version if it has. This
156 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
162 @c man begin DESCRIPTION
166 @c man begin DESCRIPTION
167 Wget has been designed for robustness over slow or unstable network
168 connections; if a download fails due to a network problem, it will
169 keep retrying until the whole file has been retrieved. If the server
170 supports regetting, it will instruct the server to continue the
171 download from where it left off.
176 Wget supports proxy servers, which can lighten the network load, speed
177 up retrieval and provide access behind firewalls. However, if you are
178 behind a firewall that requires that you use a socks style gateway, you
179 can get the socks library and build Wget with support for socks. Wget
180 also supports the passive @sc{ftp} downloading as an option.
184 Builtin features offer mechanisms to tune which links you wish to follow
185 (@pxref{Following Links}).
189 The retrieval is conveniently traced with printing dots, each dot
190 representing a fixed amount of data received (1KB by default). These
191 representations can be customized to your preferences.
195 Most of the features are fully configurable, either through command line
196 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
197 File}). Wget allows you to define @dfn{global} startup files
198 (@file{/usr/local/etc/wgetrc} by default) for site settings.
203 @item /usr/local/etc/wgetrc
204 Default location of the @dfn{global} startup file.
214 Finally, GNU Wget is free software. This means that everyone may use
215 it, redistribute it and/or modify it under the terms of the GNU General
216 Public License, as published by the Free Software Foundation
220 @node Invoking, Recursive Retrieval, Overview, Top
227 By default, Wget is very simple to invoke. The basic syntax is:
230 @c man begin SYNOPSIS
231 wget [@var{option}]@dots{} [@var{URL}]@dots{}
235 Wget will simply download all the @sc{url}s specified on the command
236 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
238 However, you may wish to change some of the default parameters of
239 Wget. You can do it two ways: permanently, adding the appropriate
240 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
246 * Basic Startup Options::
247 * Logging and Input File Options::
249 * Directory Options::
252 * Recursive Retrieval Options::
253 * Recursive Accept/Reject Options::
256 @node URL Format, Option Syntax, Invoking, Invoking
261 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
262 resource locator is a compact string representation for a resource
263 available via the Internet. Wget recognizes the @sc{url} syntax as per
264 @sc{rfc1738}. This is the most widely used form (square brackets denote
268 http://host[:port]/directory/file
269 ftp://host[:port]/directory/file
272 You can also encode your username and password within a @sc{url}:
275 ftp://user:password@@host/path
276 http://user:password@@host/path
279 Either @var{user} or @var{password}, or both, may be left out. If you
280 leave out either the @sc{http} username or password, no authentication
281 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
282 will be used. If you leave out the @sc{ftp} password, your email
283 address will be supplied as a default password.@footnote{If you have a
284 @file{.netrc} file in your home directory, password will also be
287 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
288 being the hexadecimal representation of the character's @sc{ascii}
289 value. Some common unsafe characters include @samp{%} (quoted as
290 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
291 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
294 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
295 default, @sc{ftp} documents are retrieved in the binary mode (type
296 @samp{i}), which means that they are downloaded unchanged. Another
297 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
298 delimiters between the different operating systems, and is thus useful
299 for text files. Here is an example:
302 ftp://host/directory/file;type=a
305 Two alternative variants of @sc{url} specification are also supported,
306 because of historical (hysterical?) reasons and their widespreaded use.
308 @sc{ftp}-only syntax (supported by @code{NcFTP}):
313 @sc{http}-only syntax (introduced by @code{Netscape}):
318 These two alternative forms are deprecated, and may cease being
319 supported in the future.
321 If you do not understand the difference between these notations, or do
322 not know which one to use, just use the plain ordinary format you use
323 with your favorite browser, like @code{Lynx} or @code{Netscape}.
325 @node Option Syntax, Basic Startup Options, URL Format, Invoking
326 @section Option Syntax
327 @cindex option syntax
328 @cindex syntax of options
330 Since Wget uses GNU getopts to process its arguments, every option has a
331 short form and a long form. Long options are more convenient to
332 remember, but take time to type. You may freely mix different option
333 styles, or specify options after the command-line arguments. Thus you
337 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
340 The space between the option accepting an argument and the argument may
341 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
343 You may put several options that do not require arguments together,
350 This is a complete equivalent of:
353 wget -d -r -c @var{URL}
356 Since the options can be specified after the arguments, you may
357 terminate them with @samp{--}. So the following will try to download
358 @sc{url} @samp{-x}, reporting failure to @file{log}:
364 The options that accept comma-separated lists all respect the convention
365 that specifying an empty list clears its value. This can be useful to
366 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
367 sets @code{exclude_directories} to @file{/cgi-bin}, the following
368 example will first reset it, and then set it to exclude @file{/~nobody}
369 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
370 (@pxref{Wgetrc Syntax}).
373 wget -X '' -X /~nobody,/~somebody
378 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
379 @section Basic Startup Options
384 Display the version of Wget.
388 Print a help message describing all of Wget's command-line options.
392 Go to background immediately after startup. If no output file is
393 specified via the @samp{-o}, output is redirected to @file{wget-log}.
395 @cindex execute wgetrc command
396 @item -e @var{command}
397 @itemx --execute @var{command}
398 Execute @var{command} as if it were a part of @file{.wgetrc}
399 (@pxref{Startup File}). A command thus invoked will be executed
400 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
404 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
405 @section Logging and Input File Options
410 @item -o @var{logfile}
411 @itemx --output-file=@var{logfile}
412 Log all messages to @var{logfile}. The messages are normally reported
415 @cindex append to log
416 @item -a @var{logfile}
417 @itemx --append-output=@var{logfile}
418 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
419 to @var{logfile} instead of overwriting the old log file. If
420 @var{logfile} does not exist, a new file is created.
425 Turn on debug output, meaning various information important to the
426 developers of Wget if it does not work properly. Your system
427 administrator may have chosen to compile Wget without debug support, in
428 which case @samp{-d} will not work. Please note that compiling with
429 debug support is always safe---Wget compiled with the debug support will
430 @emph{not} print any debug info unless requested with @samp{-d}.
431 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
437 Turn off Wget's output.
442 Turn on verbose output, with all the available data. The default output
447 Non-verbose output---turn off verbose without being completely quiet
448 (use @samp{-q} for that), which means that error messages and basic
449 information still get printed.
453 @itemx --input-file=@var{file}
454 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
455 the command line. If there are @sc{url}s both on the command line and
456 in an input file, those on the command lines will be the first ones to
457 be retrieved. The @var{file} need not be an @sc{html} document (but no
458 harm if it is)---it is enough if the @sc{url}s are just listed
461 However, if you specify @samp{--force-html}, the document will be
462 regarded as @samp{html}. In that case you may have problems with
463 relative links, which you can solve either by adding @code{<base
464 href="@var{url}">} to the documents or by specifying
465 @samp{--base=@var{url}} on the command line.
470 When input is read from a file, force it to be treated as an @sc{html}
471 file. This enables you to retrieve relative links from existing
472 @sc{html} files on your local disk, by adding @code{<base
473 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
476 @cindex base for relative links in input file
478 @itemx --base=@var{URL}
479 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
480 links in the file specified by @samp{-i}.
483 @node Download Options, Directory Options, Logging and Input File Options, Invoking
484 @section Download Options
487 @cindex bind() address
488 @cindex client IP address
489 @cindex IP address, client
490 @item --bind-address=@var{ADDRESS}
491 When making client TCP/IP connections, @code{bind()} to @var{ADDRESS} on
492 the local machine. @var{ADDRESS} may be specified as a hostname or IP
493 address. This option can be useful if your machine is bound to multiple
498 @cindex number of retries
499 @item -t @var{number}
500 @itemx --tries=@var{number}
501 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
505 @itemx --output-document=@var{file}
506 The documents will not be written to the appropriate files, but all will
507 be concatenated together and written to @var{file}. If @var{file}
508 already exists, it will be overwritten. If the @var{file} is @samp{-},
509 the documents will be written to standard output. Including this option
510 automatically sets the number of tries to 1.
512 @cindex clobbering, file
513 @cindex downloading multiple times
517 If a file is downloaded more than once in the same directory, Wget's
518 behavior depends on a few options, including @samp{-nc}. In certain
519 cases, the local file will be @dfn{clobbered}, or overwritten, upon
520 repeated download. In other cases it will be preserved.
522 When running Wget without @samp{-N}, @samp{-nc}, or @samp{-r},
523 downloading the same file in the same directory will result in the
524 original copy of @var{file} being preserved and the second copy being
525 named @samp{@var{file}.1}. If that file is downloaded yet again, the
526 third copy will be named @samp{@var{file}.2}, and so on. When
527 @samp{-nc} is specified, this behavior is suppressed, and Wget will
528 refuse to download newer copies of @samp{@var{file}}. Therefore,
529 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
530 clobbering that's prevented (as the numeric suffixes were already
531 preventing clobbering), but rather the multiple version saving that's
534 When running Wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
535 re-downloading a file will result in the new copy simply overwriting the
536 old. Adding @samp{-nc} will prevent this behavior, instead causing the
537 original version to be preserved and any newer copies on the server to
540 When running Wget with @samp{-N}, with or without @samp{-r}, the
541 decision as to whether or not to download a newer copy of a file depends
542 on the local and remote timestamp and size of the file
543 (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the same
546 Note that when @samp{-nc} is specified, files with the suffixes
547 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
548 and parsed as if they had been retrieved from the Web.
550 @cindex continue retrieval
551 @cindex incomplete downloads
552 @cindex resume download
555 Continue getting a partially-downloaded file. This is useful when you
556 want to finish up a download started by a previous instance of Wget, or
557 by another program. For instance:
560 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
563 If there is a file named @file{ls-lR.Z} in the current directory, Wget
564 will assume that it is the first portion of the remote file, and will
565 ask the server to continue the retrieval from an offset equal to the
566 length of the local file.
568 Note that you don't need to specify this option if you just want the
569 current invocation of Wget to retry downloading a file should the
570 connection be lost midway through. This is the default behavior.
571 @samp{-c} only affects resumption of downloads started @emph{prior} to
572 this invocation of Wget, and whose local files are still sitting around.
574 Without @samp{-c}, the previous example would just download the remote
575 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
578 Beginning with Wget 1.7, if you use @samp{-c} on a non-empty file, and
579 it turns out that the server does not support continued downloading,
580 Wget will refuse to start the download from scratch, which would
581 effectively ruin existing contents. If you really want the download to
582 start from scratch, remove the file.
584 Also beginning with Wget 1.7, if you use @samp{-c} on a file which is of
585 equal size as the one on the server, Wget will refuse to download the
586 file and print an explanatory message. The same happens when the file
587 is smaller on the server than locally (presumably because it was changed
588 on the server since your last download attempt)---because ``continuing''
589 is not meaningful, no download occurs.
591 On the other side of the coin, while using @samp{-c}, any file that's
592 bigger on the server than locally will be considered an incomplete
593 download and only @code{(length(remote) - length(local))} bytes will be
594 downloaded and tacked onto the end of the local file. This behavior can
595 be desirable in certain cases---for instance, you can use @samp{wget -c}
596 to download just the new portion that's been appended to a data
597 collection or log file.
599 However, if the file is bigger on the server because it's been
600 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
601 with a garbled file. Wget has no way of verifying that the local file
602 is really a valid prefix of the remote file. You need to be especially
603 careful of this when using @samp{-c} in conjunction with @samp{-r},
604 since every file will be considered as an "incomplete download" candidate.
606 Another instance where you'll get a garbled file if you try to use
607 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
608 ``transfer interrupted'' string into the local file. In the future a
609 ``rollback'' option may be added to deal with this case.
611 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
612 servers that support the @code{Range} header.
614 @cindex progress indicator
616 @item --progress=@var{type}
617 Select the type of the progress indicator you wish to use. Legal
618 indicators are ``dot'' and ``bar''.
620 The ``dot'' indicator is used by default. It traces the retrieval by
621 printing dots on the screen, each dot representing a fixed amount of
624 When using the dotted retrieval, you may also set the @dfn{style} by
625 specifying the type as @samp{dot:@var{style}}. Different styles assign
626 different meaning to one dot. With the @code{default} style each dot
627 represents 1K, there are ten dots in a cluster and 50 dots in a line.
628 The @code{binary} style has a more ``computer''-like orientation---8K
629 dots, 16-dots clusters and 48 dots per line (which makes for 384K
630 lines). The @code{mega} style is suitable for downloading very large
631 files---each dot represents 64K retrieved, there are eight dots in a
632 cluster, and 48 dots on each line (so each line contains 3M).
634 Specifying @samp{--progress=bar} will draw a nice ASCII progress bar
635 graphics (a.k.a ``thermometer'' display) to indicate retrieval. If the
636 output is not a TTY, this option will be ignored, and Wget will revert
637 to the dot indicator. If you want to force the bar indicator, use
638 @samp{--progress=bar:force}.
641 @itemx --timestamping
642 Turn on time-stamping. @xref{Time-Stamping}, for details.
644 @cindex server response, print
646 @itemx --server-response
647 Print the headers sent by @sc{http} servers and responses sent by
650 @cindex Wget as spider
653 When invoked with this option, Wget will behave as a Web @dfn{spider},
654 which means that it will not download the pages, just check that they
655 are there. You can use it to check your bookmarks, e.g. with:
658 wget --spider --force-html -i bookmarks.html
661 This feature needs much more work for Wget to get close to the
662 functionality of real @sc{www} spiders.
666 @itemx --timeout=@var{seconds}
667 Set the read timeout to @var{seconds} seconds. Whenever a network read
668 is issued, the file descriptor is checked for a timeout, which could
669 otherwise leave a pending connection (uninterrupted read). The default
670 timeout is 900 seconds (fifteen minutes). Setting timeout to 0 will
671 disable checking for timeouts.
673 Please do not lower the default timeout value with this option unless
674 you know what you are doing.
678 @item -w @var{seconds}
679 @itemx --wait=@var{seconds}
680 Wait the specified number of seconds between the retrievals. Use of
681 this option is recommended, as it lightens the server load by making the
682 requests less frequent. Instead of in seconds, the time can be
683 specified in minutes using the @code{m} suffix, in hours using @code{h}
684 suffix, or in days using @code{d} suffix.
686 Specifying a large value for this option is useful if the network or the
687 destination host is down, so that Wget can wait long enough to
688 reasonably expect the network error to be fixed before the retry.
690 @cindex retries, waiting between
691 @cindex waiting between retries
692 @item --waitretry=@var{seconds}
693 If you don't want Wget to wait between @emph{every} retrieval, but only
694 between retries of failed downloads, you can use this option. Wget will
695 use @dfn{linear backoff}, waiting 1 second after the first failure on a
696 given file, then waiting 2 seconds after the second failure on that
697 file, up to the maximum number of @var{seconds} you specify. Therefore,
698 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
701 Note that this option is turned on by default in the global
707 Some web sites may perform log analysis to identify retrieval programs
708 such as Wget by looking for statistically significant similarities in
709 the time between requests. This option causes the time between requests
710 to vary between 0 and 2 * @var{wait} seconds, where @var{wait} was
711 specified using the @samp{-w} or @samp{--wait} options, in order to mask
712 Wget's presence from such analysis.
714 A recent article in a publication devoted to development on a popular
715 consumer platform provided code to perform this analysis on the fly.
716 Its author suggested blocking at the class C address level to ensure
717 automated retrieval programs were blocked despite changing DHCP-supplied
720 The @samp{--random-wait} option was inspired by this ill-advised
721 recommendation to block many unrelated users from a web site due to the
726 @itemx --proxy=on/off
727 Turn proxy support on or off. The proxy is on by default if the
728 appropriate environmental variable is defined.
732 @itemx --quota=@var{quota}
733 Specify download quota for automatic retrievals. The value can be
734 specified in bytes (default), kilobytes (with @samp{k} suffix), or
735 megabytes (with @samp{m} suffix).
737 Note that quota will never affect downloading a single file. So if you
738 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
739 @file{ls-lR.gz} will be downloaded. The same goes even when several
740 @sc{url}s are specified on the command-line. However, quota is
741 respected when retrieving either recursively, or from an input file.
742 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
743 aborted when the quota is exceeded.
745 Setting quota to 0 or to @samp{inf} unlimits the download quota.
748 @node Directory Options, HTTP Options, Download Options, Invoking
749 @section Directory Options
753 @itemx --no-directories
754 Do not create a hierarchy of directories when retrieving recursively.
755 With this option turned on, all files will get saved to the current
756 directory, without clobbering (if a name shows up more than once, the
757 filenames will get extensions @samp{.n}).
760 @itemx --force-directories
761 The opposite of @samp{-nd}---create a hierarchy of directories, even if
762 one would not have been created otherwise. E.g. @samp{wget -x
763 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
764 @file{fly.srk.fer.hr/robots.txt}.
767 @itemx --no-host-directories
768 Disable generation of host-prefixed directories. By default, invoking
769 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
770 directories beginning with @file{fly.srk.fer.hr/}. This option disables
773 @cindex cut directories
774 @item --cut-dirs=@var{number}
775 Ignore @var{number} directory components. This is useful for getting a
776 fine-grained control over the directory where recursive retrieval will
779 Take, for example, the directory at
780 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
781 @samp{-r}, it will be saved locally under
782 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
783 remove the @file{ftp.xemacs.org/} part, you are still stuck with
784 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
785 makes Wget not ``see'' @var{number} remote directory components. Here
786 are several examples of how @samp{--cut-dirs} option works.
790 No options -> ftp.xemacs.org/pub/xemacs/
792 -nH --cut-dirs=1 -> xemacs/
793 -nH --cut-dirs=2 -> .
795 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
800 If you just want to get rid of the directory structure, this option is
801 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
802 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
803 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
804 be placed to @file{xemacs/beta}, as one would expect.
806 @cindex directory prefix
807 @item -P @var{prefix}
808 @itemx --directory-prefix=@var{prefix}
809 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
810 directory where all other files and subdirectories will be saved to,
811 i.e. the top of the retrieval tree. The default is @samp{.} (the
815 @node HTTP Options, FTP Options, Directory Options, Invoking
816 @section HTTP Options
819 @cindex .html extension
821 @itemx --html-extension
822 If a file of type @samp{text/html} is downloaded and the URL does not
823 end with the regexp @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause
824 the suffix @samp{.html} to be appended to the local filename. This is
825 useful, for instance, when you're mirroring a remote site that uses
826 @samp{.asp} pages, but you want the mirrored pages to be viewable on
827 your stock Apache server. Another good use for this is when you're
828 downloading the output of CGIs. A URL like
829 @samp{http://site.com/article.cgi?25} will be saved as
830 @file{article.cgi?25.html}.
832 Note that filenames changed in this way will be re-downloaded every time
833 you re-mirror a site, because Wget can't tell that the local
834 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
835 it doesn't yet know that the URL produces output of type
836 @samp{text/html}. To prevent this re-downloading, you must use
837 @samp{-k} and @samp{-K} so that the original version of the file will be
838 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
841 @cindex http password
842 @cindex authentication
843 @item --http-user=@var{user}
844 @itemx --http-passwd=@var{password}
845 Specify the username @var{user} and password @var{password} on an
846 @sc{http} server. According to the type of the challenge, Wget will
847 encode them using either the @code{basic} (insecure) or the
848 @code{digest} authentication scheme.
850 Another way to specify username and password is in the @sc{url} itself
851 (@pxref{URL Format}). For more information about security issues with
852 Wget, @xref{Security Considerations}.
857 @itemx --cache=on/off
858 When set to off, disable server-side cache. In this case, Wget will
859 send the remote server an appropriate directive (@samp{Pragma:
860 no-cache}) to get the file from the remote service, rather than
861 returning the cached version. This is especially useful for retrieving
862 and flushing out-of-date documents on proxy servers.
864 Caching is allowed by default.
867 @item --cookies=on/off
868 When set to off, disable the use of cookies. Cookies are a mechanism
869 for maintaining server-side state. The server sends the client a cookie
870 using the @code{Set-Cookie} header, and the client responds with the
871 same cookie upon further requests. Since cookies allow the server
872 owners to keep track of visitors and for sites to exchange this
873 information, some consider them a breach of privacy. The default is to
874 use cookies; however, @emph{storing} cookies is not on by default.
876 @cindex loading cookies
877 @cindex cookies, loading
878 @item --load-cookies @var{file}
879 Load cookies from @var{file} before the first HTTP retrieval. The
880 format of @var{file} is one used by Netscape and Mozilla, at least their
883 @cindex saving cookies
884 @cindex cookies, saving
885 @item --save-cookies @var{file}
886 Save cookies from @var{file} at the end of session. Cookies whose
887 expiry time is not specified, or those that have already expired, are
890 @cindex Content-Length, ignore
891 @cindex ignore length
892 @item --ignore-length
893 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
894 precise) send out bogus @code{Content-Length} headers, which makes Wget
895 go wild, as it thinks not all the document was retrieved. You can spot
896 this syndrome if Wget retries getting the same document again and again,
897 each time claiming that the (otherwise normal) connection has closed on
900 With this option, Wget will ignore the @code{Content-Length} header---as
904 @item --header=@var{additional-header}
905 Define an @var{additional-header} to be passed to the @sc{http} servers.
906 Headers must contain a @samp{:} preceded by one or more non-blank
907 characters, and must not contain newlines.
909 You may define more than one additional header by specifying
910 @samp{--header} more than once.
914 wget --header='Accept-Charset: iso-8859-2' \
915 --header='Accept-Language: hr' \
916 http://fly.srk.fer.hr/
920 Specification of an empty string as the header value will clear all
921 previous user-defined headers.
924 @cindex proxy password
925 @cindex proxy authentication
926 @item --proxy-user=@var{user}
927 @itemx --proxy-passwd=@var{password}
928 Specify the username @var{user} and password @var{password} for
929 authentication on a proxy server. Wget will encode them using the
930 @code{basic} authentication scheme.
933 @cindex referer, http
934 @item --referer=@var{url}
935 Include `Referer: @var{url}' header in HTTP request. Useful for
936 retrieving documents with server-side processing that assume they are
937 always being retrieved by interactive web browsers and only come out
938 properly when Referer is set to one of the pages that point to them.
940 @cindex server response, save
942 @itemx --save-headers
943 Save the headers sent by the @sc{http} server to the file, preceding the
944 actual contents, with an empty line as the separator.
947 @item -U @var{agent-string}
948 @itemx --user-agent=@var{agent-string}
949 Identify as @var{agent-string} to the @sc{http} server.
951 The @sc{http} protocol allows the clients to identify themselves using a
952 @code{User-Agent} header field. This enables distinguishing the
953 @sc{www} software, usually for statistical purposes or for tracing of
954 protocol violations. Wget normally identifies as
955 @samp{Wget/@var{version}}, @var{version} being the current version
958 However, some sites have been known to impose the policy of tailoring
959 the output according to the @code{User-Agent}-supplied information.
960 While conceptually this is not such a bad idea, it has been abused by
961 servers denying information to clients other than @code{Mozilla} or
962 Microsoft @code{Internet Explorer}. This option allows you to change
963 the @code{User-Agent} line issued by Wget. Use of this option is
964 discouraged, unless you really know what you are doing.
967 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
971 @cindex .listing files, removing
973 @itemx --dont-remove-listing
974 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
975 retrievals. Normally, these files contain the raw directory listings
976 received from @sc{ftp} servers. Not removing them can be useful for
977 debugging purposes, or when you want to be able to easily check on the
978 contents of remote server directories (e.g. to verify that a mirror
979 you're running is complete).
981 Note that even though Wget writes to a known filename for this file,
982 this is not a security hole in the scenario of a user making
983 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
984 asking @code{root} to run Wget in his or her directory. Depending on
985 the options used, either Wget will refuse to write to @file{.listing},
986 making the globbing/recursion/time-stamping operation fail, or the
987 symbolic link will be deleted and replaced with the actual
988 @file{.listing} file, or the listing will be written to a
989 @file{.listing.@var{number}} file.
991 Even though this situation isn't a problem, though, @code{root} should
992 never run Wget in a non-trusted user's directory. A user could do
993 something as simple as linking @file{index.html} to @file{/etc/passwd}
994 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
997 @cindex globbing, toggle
1000 Turn @sc{ftp} globbing on or off. Globbing means you may use the
1001 shell-like special characters (@dfn{wildcards}), like @samp{*},
1002 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
1003 same directory at once, like:
1006 wget ftp://gnjilux.srk.fer.hr/*.msg
1009 By default, globbing will be turned on if the @sc{url} contains a
1010 globbing character. This option may be used to turn globbing on or off
1013 You may have to quote the @sc{url} to protect it from being expanded by
1014 your shell. Globbing makes Wget look for a directory listing, which is
1015 system-specific. This is why it currently works only with Unix @sc{ftp}
1016 servers (and the ones emulating Unix @code{ls} output).
1020 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
1021 initiates the data connection. This is sometimes required for @sc{ftp}
1022 to work behind firewalls.
1024 @cindex symbolic links, retrieving
1025 @item --retr-symlinks
1026 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1027 link is encountered, the linked-to file is not downloaded. Instead, a
1028 matching symbolic link is created on the local filesystem. The
1029 pointed-to file will not be downloaded unless this recursive retrieval
1030 would have encountered it separately and downloaded it anyway.
1032 When @samp{--retr-symlinks} is specified, however, symbolic links are
1033 traversed and the pointed-to files are retrieved. At this time, this
1034 option does not cause Wget to traverse symlinks to directories and
1035 recurse through them, but in the future it should be enhanced to do
1038 Note that when retrieving a file (not a directory) because it was
1039 specified on the commandline, rather than because it was recursed to,
1040 this option has no effect. Symbolic links are always traversed in this
1044 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
1045 @section Recursive Retrieval Options
1050 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
1053 @item -l @var{depth}
1054 @itemx --level=@var{depth}
1055 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1056 Retrieval}). The default maximum depth is 5.
1058 @cindex proxy filling
1059 @cindex delete after retrieval
1060 @cindex filling proxy cache
1061 @item --delete-after
1062 This option tells Wget to delete every single file it downloads,
1063 @emph{after} having done so. It is useful for pre-fetching popular
1064 pages through a proxy, e.g.:
1067 wget -r -nd --delete-after http://whatever.com/~popular/page/
1070 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1073 Note that @samp{--delete-after} deletes files on the local machine. It
1074 does not issue the @samp{DELE} command to remote FTP sites, for
1075 instance. Also note that when @samp{--delete-after} is specified,
1076 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1077 created in the first place.
1079 @cindex conversion of links
1080 @cindex link conversion
1082 @itemx --convert-links
1083 After the download is complete, convert the links in the document to
1084 make them suitable for local viewing. This affects not only the visible
1085 hyperlinks, but any part of the document that links to external content,
1086 such as embedded images, links to style sheets, hyperlinks to non-HTML
1089 Each link will be changed in one of the two ways:
1093 The links to files that have been downloaded by Wget will be changed to
1094 refer to the file they point to as a relative link.
1096 Example: if the downloaded file @file{/foo/doc.html} links to
1097 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1098 will be modified to point to @samp{../bar/img.gif}. This kind of
1099 transformation works reliably for arbitrary combinations of directories.
1102 The links to files that have not been downloaded by Wget will be changed
1103 to include host name and absolute path of the location they point to.
1105 Example: if the downloaded file @file{/foo/doc.html} links to
1106 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1107 @file{doc.html} will be modified to point to
1108 @file{http://@var{hostname}/bar/img.gif}.
1111 Because of this, local browsing works reliably: if a linked file was
1112 downloaded, the link will refer to its local name; if it was not
1113 downloaded, the link will refer to its full Internet address rather than
1114 presenting a broken link. The fact that the former links are converted
1115 to relative links ensures that you can move the downloaded hierarchy to
1118 Note that only at the end of the download can Wget know which links have
1119 been downloaded. Because of that, the work done by @samp{-k} will be
1120 performed at the end of all the downloads.
1122 @cindex backing up converted files
1124 @itemx --backup-converted
1125 When converting a file, back up the original version with a @samp{.orig}
1126 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1131 Turn on options suitable for mirroring. This option turns on recursion
1132 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1133 directory listings. It is currently equivalent to
1134 @samp{-r -N -l inf -nr}.
1136 @cindex page requisites
1137 @cindex required images, downloading
1139 @itemx --page-requisites
1140 This option causes Wget to download all the files that are necessary to
1141 properly display a given HTML page. This includes such things as
1142 inlined images, sounds, and referenced stylesheets.
1144 Ordinarily, when downloading a single HTML page, any requisite documents
1145 that may be needed to display it properly are not downloaded. Using
1146 @samp{-r} together with @samp{-l} can help, but since Wget does not
1147 ordinarily distinguish between external and inlined documents, one is
1148 generally left with ``leaf documents'' that are missing their
1151 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1152 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1153 document @file{2.html}. Say that @file{2.html} is similar but that its
1154 image is @file{2.gif} and it links to @file{3.html}. Say this
1155 continues up to some arbitrarily high number.
1157 If one executes the command:
1160 wget -r -l 2 http://@var{site}/1.html
1163 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1164 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1165 without its requisite @file{3.gif} because Wget is simply counting the
1166 number of hops (up to 2) away from @file{1.html} in order to determine
1167 where to stop the recursion. However, with this command:
1170 wget -r -l 2 -p http://@var{site}/1.html
1173 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1174 will be downloaded. Similarly,
1177 wget -r -l 1 -p http://@var{site}/1.html
1180 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1181 to be downloaded. One might think that:
1184 wget -r -l 0 -p http://@var{site}/1.html
1187 would download just @file{1.html} and @file{1.gif}, but unfortunately
1188 this is not the case, because @samp{-l 0} is equivalent to
1189 @samp{-l inf}---that is, infinite recursion. To download a single HTML
1190 page (or a handful of them, all specified on the commandline or in a
1191 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1192 @samp{-r} and @samp{-l}:
1195 wget -p http://@var{site}/1.html
1198 Note that Wget will behave as if @samp{-r} had been specified, but only
1199 that single page and its requisites will be downloaded. Links from that
1200 page to external documents will not be followed. Actually, to download
1201 a single page and all its requisites (even if they exist on separate
1202 websites), and make sure the lot displays properly locally, this author
1203 likes to use a few options in addition to @samp{-p}:
1206 wget -E -H -k -K -p http://@var{site}/@var{document}
1209 To finish off this topic, it's worth knowing that Wget's idea of an
1210 external document link is any URL specified in an @code{<A>} tag, an
1211 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1215 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1216 @section Recursive Accept/Reject Options
1219 @item -A @var{acclist} --accept @var{acclist}
1220 @itemx -R @var{rejlist} --reject @var{rejlist}
1221 Specify comma-separated lists of file name suffixes or patterns to
1222 accept or reject (@pxref{Types of Files} for more details).
1224 @item -D @var{domain-list}
1225 @itemx --domains=@var{domain-list}
1226 Set domains to be followed. @var{domain-list} is a comma-separated list
1227 of domains. Note that it does @emph{not} turn on @samp{-H}.
1229 @item --exclude-domains @var{domain-list}
1230 Specify the domains that are @emph{not} to be followed.
1231 (@pxref{Spanning Hosts}).
1233 @cindex follow FTP links
1235 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1236 Wget will ignore all the @sc{ftp} links.
1238 @cindex tag-based recursive pruning
1239 @item --follow-tags=@var{list}
1240 Wget has an internal table of HTML tag / attribute pairs that it
1241 considers when looking for linked documents during a recursive
1242 retrieval. If a user wants only a subset of those tags to be
1243 considered, however, he or she should be specify such tags in a
1244 comma-separated @var{list} with this option.
1247 @itemx --ignore-tags=@var{list}
1248 This is the opposite of the @samp{--follow-tags} option. To skip
1249 certain HTML tags when recursively looking for documents to download,
1250 specify them in a comma-separated @var{list}.
1252 In the past, the @samp{-G} option was the best bet for downloading a
1253 single page and its requisites, using a commandline like:
1256 wget -Ga,area -H -k -K -r http://@var{site}/@var{document}
1259 However, the author of this option came across a page with tags like
1260 @code{<LINK REL="home" HREF="/">} and came to the realization that
1261 @samp{-G} was not enough. One can't just tell Wget to ignore
1262 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1263 best bet for downloading a single page and its requisites is the
1264 dedicated @samp{--page-requisites} option.
1268 Enable spanning across hosts when doing recursive retrieving
1269 (@pxref{Spanning Hosts}).
1273 Follow relative links only. Useful for retrieving a specific home page
1274 without any distractions, not even those from the same hosts
1275 (@pxref{Relative Links}).
1278 @itemx --include-directories=@var{list}
1279 Specify a comma-separated list of directories you wish to follow when
1280 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1281 of @var{list} may contain wildcards.
1284 @itemx --exclude-directories=@var{list}
1285 Specify a comma-separated list of directories you wish to exclude from
1286 download (@pxref{Directory-Based Limits} for more details.) Elements of
1287 @var{list} may contain wildcards.
1291 Do not ever ascend to the parent directory when retrieving recursively.
1292 This is a useful option, since it guarantees that only the files
1293 @emph{below} a certain hierarchy will be downloaded.
1294 @xref{Directory-Based Limits}, for more details.
1299 @node Recursive Retrieval, Following Links, Invoking, Top
1300 @chapter Recursive Retrieval
1303 @cindex recursive retrieval
1305 GNU Wget is capable of traversing parts of the Web (or a single
1306 @sc{http} or @sc{ftp} server), following links and directory structure.
1307 We refer to this as to @dfn{recursive retrieving}, or @dfn{recursion}.
1309 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1310 the given @sc{url}, documents, retrieving the files the @sc{html}
1311 document was referring to, through markups like @code{href}, or
1312 @code{src}. If the freshly downloaded file is also of type
1313 @code{text/html}, it will be parsed and followed further.
1315 Recursive retrieval of @sc{http} and @sc{html} content is
1316 @dfn{breadth-first}. This means that Wget first downloads the requested
1317 HTML document, then the documents linked from that document, then the
1318 documents linked by them, and so on. In other words, Wget first
1319 downloads the documents at depth 1, then those at depth 2, and so on
1320 until the specified maximum depth.
1322 The maximum @dfn{depth} to which the retrieval may descend is specified
1323 with the @samp{-l} option. The default maximum depth is five layers.
1325 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1326 the data from the given directory tree (including the subdirectories up
1327 to the specified depth) on the remote server, creating its mirror image
1328 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1329 parameter. Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1332 By default, Wget will create a local directory tree, corresponding to
1333 the one found on the remote server.
1335 Recursive retrieving can find a number of applications, the most
1336 important of which is mirroring. It is also useful for @sc{www}
1337 presentations, and any other opportunities where slow network
1338 connections should be bypassed by storing the files locally.
1340 You should be warned that recursive downloads can overload the remote
1341 servers. Because of that, many administrators frown upon them and may
1342 ban access from your site if they detect very fast downloads of big
1343 amounts of content. When downloading from Internet servers, consider
1344 using the @samp{-w} option to introduce a delay between accesses to the
1345 server. The download will take a while longer, but the server
1346 administrator will not be alarmed by your rudeness.
1348 Of course, recursive download may cause problems on your machine. If
1349 left to run unchecked, it can easily fill up the disk. If downloading
1350 from local network, it can also take bandwidth on the system, as well as
1351 consume memory and CPU.
1353 Try to specify the criteria that match the kind of download you are
1354 trying to achieve. If you want to download only one page, use
1355 @samp{--page-requisites} without any additional recursion. If you want
1356 to download things under one directory, use @samp{-np} to avoid
1357 downloading things from other directories. If you want to download all
1358 the files from one directory, use @samp{-l 1} to make sure the recursion
1359 depth never exceeds one. @xref{Following Links}, for more information
1362 Recursive retrieval should be used with care. Don't say you were not
1365 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1366 @chapter Following Links
1368 @cindex following links
1370 When retrieving recursively, one does not wish to retrieve loads of
1371 unnecessary data. Most of the time the users bear in mind exactly what
1372 they want to download, and want Wget to follow only specific links.
1374 For example, if you wish to download the music archive from
1375 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1376 that happen to be referenced by an obscure part of the archive.
1378 Wget possesses several mechanisms that allows you to fine-tune which
1379 links it will follow.
1382 * Spanning Hosts:: (Un)limiting retrieval based on host name.
1383 * Types of Files:: Getting only certain files.
1384 * Directory-Based Limits:: Getting only certain directories.
1385 * Relative Links:: Follow relative links only.
1386 * FTP Links:: Following FTP links.
1389 @node Spanning Hosts, Types of Files, Following Links, Following Links
1390 @section Spanning Hosts
1391 @cindex spanning hosts
1392 @cindex hosts, spanning
1394 Wget's recursive retrieval normally refuses to visit hosts different
1395 than the one you specified on the command line. This is a reasonable
1396 default; without it, every retrieval would have the potential to turn
1397 your Wget into a small version of google.
1399 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1400 a useful option. Maybe the images are served from a different server.
1401 Maybe you're mirroring a site that consists of pages interlinked between
1402 three servers. Maybe the server has two equivalent names, and the HTML
1403 pages refer to both interchangeably.
1406 @item Span to any host---@samp{-H}
1408 The @samp{-H} option turns on host spanning, thus allowing Wget's
1409 recursive run to visit any host referenced by a link. Unless sufficient
1410 recursion-limiting criteria are applied depth, these foreign hosts will
1411 typically link to yet more hosts, and so on until Wget ends up sucking
1412 up much more data than you have intended.
1414 @item Limit spanning to certain domains---@samp{-D}
1416 The @samp{-D} option allows you to specify the domains that will be
1417 followed, thus limiting the recursion only to the hosts that belong to
1418 these domains. Obviously, this makes sense only in conjunction with
1419 @samp{-H}. A typical example would be downloading the contents of
1420 @samp{www.server.com}, but allowing downloads from
1421 @samp{images.server.com}, etc.:
1424 wget -rH -Dserver.com http://www.server.com/
1427 You can specify more than one address by separating them with a comma,
1428 e.g. @samp{-Ddomain1.com,domain2.com}.
1430 @item Keep download off certain domains---@samp{--exclude-domains}
1432 If there are domains you want to exclude specifically, you can do it
1433 with @samp{--exclude-domains}, which accepts the same type of arguments
1434 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1435 example, if you want to download all the hosts from @samp{foo.edu}
1436 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1440 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
1446 @node Types of Files, Directory-Based Limits, Spanning Hosts, Following Links
1447 @section Types of Files
1448 @cindex types of files
1450 When downloading material from the web, you will often want to restrict
1451 the retrieval to only certain file types. For example, if you are
1452 interested in downloading @sc{gif}s, you will not be overjoyed to get
1453 loads of PostScript documents, and vice versa.
1455 Wget offers two options to deal with this problem. Each option
1456 description lists a short name, a long name, and the equivalent command
1459 @cindex accept wildcards
1460 @cindex accept suffixes
1461 @cindex wildcards, accept
1462 @cindex suffixes, accept
1464 @item -A @var{acclist}
1465 @itemx --accept @var{acclist}
1466 @itemx accept = @var{acclist}
1467 The argument to @samp{--accept} option is a list of file suffixes or
1468 patterns that Wget will download during recursive retrieval. A suffix
1469 is the ending part of a file, and consists of ``normal'' letters,
1470 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1471 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1473 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1474 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1475 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1476 download only files beginning with @samp{zelazny} and containing numbers
1477 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1478 a description of how pattern matching works.
1480 Of course, any number of suffixes and patterns can be combined into a
1481 comma-separated list, and given as an argument to @samp{-A}.
1483 @cindex reject wildcards
1484 @cindex reject suffixes
1485 @cindex wildcards, reject
1486 @cindex suffixes, reject
1487 @item -R @var{rejlist}
1488 @itemx --reject @var{rejlist}
1489 @itemx reject = @var{rejlist}
1490 The @samp{--reject} option works the same way as @samp{--accept}, only
1491 its logic is the reverse; Wget will download all files @emph{except} the
1492 ones matching the suffixes (or patterns) in the list.
1494 So, if you want to download a whole page except for the cumbersome
1495 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1496 Analogously, to download all files except the ones beginning with
1497 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1498 expansion by the shell.
1501 The @samp{-A} and @samp{-R} options may be combined to achieve even
1502 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1503 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1504 a part of their name, but @emph{not} the PostScript files.
1506 Note that these two options do not affect the downloading of @sc{html}
1507 files; Wget must load all the @sc{html}s to know where to go at
1508 all---recursive retrieval would make no sense otherwise.
1510 @node Directory-Based Limits, Relative Links, Types of Files, Following Links
1511 @section Directory-Based Limits
1513 @cindex directory limits
1515 Regardless of other link-following facilities, it is often useful to
1516 place the restriction of what files to retrieve based on the directories
1517 those files are placed in. There can be many reasons for this---the
1518 home pages may be organized in a reasonable directory structure; or some
1519 directories may contain useless information, e.g. @file{/cgi-bin} or
1520 @file{/dev} directories.
1522 Wget offers three different options to deal with this requirement. Each
1523 option description lists a short name, a long name, and the equivalent
1524 command in @file{.wgetrc}.
1526 @cindex directories, include
1527 @cindex include directories
1528 @cindex accept directories
1531 @itemx --include @var{list}
1532 @itemx include_directories = @var{list}
1533 @samp{-I} option accepts a comma-separated list of directories included
1534 in the retrieval. Any other directories will simply be ignored. The
1535 directories are absolute paths.
1537 So, if you wish to download from @samp{http://host/people/bozo/}
1538 following only links to bozo's colleagues in the @file{/people}
1539 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1542 wget -I /people,/cgi-bin http://host/people/bozo/
1545 @cindex directories, exclude
1546 @cindex exclude directories
1547 @cindex reject directories
1549 @itemx --exclude @var{list}
1550 @itemx exclude_directories = @var{list}
1551 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1552 directories @emph{excluded} from the download. E.g. if you do not want
1553 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1554 /cgi-bin} on the command line.
1556 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1557 to get a better fine-tuning of downloading subdirectories. E.g. if you
1558 want to load all the files from @file{/pub} hierarchy except for
1559 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1564 @itemx no_parent = on
1565 The simplest, and often very useful way of limiting directories is
1566 disallowing retrieval of the links that refer to the hierarchy
1567 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1568 parent directory/directories.
1570 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1571 Using it guarantees that you will never leave the existing hierarchy.
1572 Supposing you issue Wget with:
1575 wget -r --no-parent http://somehost/~luzer/my-archive/
1578 You may rest assured that none of the references to
1579 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1580 followed. Only the archive you are interested in will be downloaded.
1581 Essentially, @samp{--no-parent} is similar to
1582 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1583 intelligent fashion.
1586 @node Relative Links, FTP Links, Directory-Based Limits, Following Links
1587 @section Relative Links
1588 @cindex relative links
1590 When @samp{-L} is turned on, only the relative links are ever followed.
1591 Relative links are here defined those that do not refer to the web
1592 server root. For example, these links are relative:
1596 <a href="foo/bar.gif">
1597 <a href="../foo/bar.gif">
1600 These links are not relative:
1604 <a href="/foo/bar.gif">
1605 <a href="http://www.server.com/foo/bar.gif">
1608 Using this option guarantees that recursive retrieval will not span
1609 hosts, even without @samp{-H}. In simple cases it also allows downloads
1610 to ``just work'' without having to convert links.
1612 This option is probably not very useful and might be removed in a future
1615 @node FTP Links, , Relative Links, Following Links
1616 @section Following FTP Links
1617 @cindex following ftp links
1619 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1620 them to be. @sc{ftp} links in @sc{html} documents are often included
1621 for purposes of reference, and it is often inconvenient to download them
1624 To have @sc{ftp} links followed from @sc{html} documents, you need to
1625 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1626 links will span hosts regardless of @samp{-H} setting. This is logical,
1627 as @sc{ftp} links rarely point to the same host where the @sc{http}
1628 server resides. For similar reasons, the @samp{-L} options has no
1629 effect on such downloads. On the other hand, domain acceptance
1630 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1632 Also note that followed links to @sc{ftp} directories will not be
1633 retrieved recursively further.
1635 @node Time-Stamping, Startup File, Following Links, Top
1636 @chapter Time-Stamping
1637 @cindex time-stamping
1638 @cindex timestamping
1639 @cindex updating the archives
1640 @cindex incremental updating
1642 One of the most important aspects of mirroring information from the
1643 Internet is updating your archives.
1645 Downloading the whole archive again and again, just to replace a few
1646 changed files is expensive, both in terms of wasted bandwidth and money,
1647 and the time to do the update. This is why all the mirroring tools
1648 offer the option of incremental updating.
1650 Such an updating mechanism means that the remote server is scanned in
1651 search of @dfn{new} files. Only those new files will be downloaded in
1652 the place of the old ones.
1654 A file is considered new if one of these two conditions are met:
1658 A file of that name does not already exist locally.
1661 A file of that name does exist, but the remote file was modified more
1662 recently than the local file.
1665 To implement this, the program needs to be aware of the time of last
1666 modification of both local and remote files. We call this information the
1667 @dfn{time-stamp} of a file.
1669 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1670 (@samp{-N}) option, or through @code{timestamping = on} directive in
1671 @file{.wgetrc}. With this option, for each file it intends to download,
1672 Wget will check whether a local file of the same name exists. If it
1673 does, and the remote file is older, Wget will not download it.
1675 If the local file does not exist, or the sizes of the files do not
1676 match, Wget will download the remote file no matter what the time-stamps
1680 * Time-Stamping Usage::
1681 * HTTP Time-Stamping Internals::
1682 * FTP Time-Stamping Internals::
1685 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1686 @section Time-Stamping Usage
1687 @cindex time-stamping usage
1688 @cindex usage, time-stamping
1690 The usage of time-stamping is simple. Say you would like to download a
1691 file so that it keeps its date of modification.
1694 wget -S http://www.gnu.ai.mit.edu/
1697 A simple @code{ls -l} shows that the time stamp on the local file equals
1698 the state of the @code{Last-Modified} header, as returned by the server.
1699 As you can see, the time-stamping info is preserved locally, even
1700 without @samp{-N} (at least for @sc{http}).
1702 Several days later, you would like Wget to check if the remote file has
1703 changed, and download it if it has.
1706 wget -N http://www.gnu.ai.mit.edu/
1709 Wget will ask the server for the last-modified date. If the local file
1710 has the same timestamp as the server, or a newer one, the remote file
1711 will not be re-fetched. However, if the remote file is more recent,
1712 Wget will proceed to fetch it.
1714 The same goes for @sc{ftp}. For example:
1717 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
1720 (The quotes around that URL are to prevent the shell from trying to
1721 interpret the @samp{*}.)
1723 After download, a local directory listing will show that the timestamps
1724 match those on the remote server. Reissuing the command with @samp{-N}
1725 will make Wget re-fetch @emph{only} the files that have been modified
1726 since the last download.
1728 If you wished to mirror the GNU archive every week, you would use a
1729 command like the following, weekly:
1732 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
1735 Note that time-stamping will only work for files for which the server
1736 gives a timestamp. For @sc{http}, this depends on getting a
1737 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
1738 directory listing with dates in a format that Wget can parse
1739 (@pxref{FTP Time-Stamping Internals}).
1741 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1742 @section HTTP Time-Stamping Internals
1743 @cindex http time-stamping
1745 Time-stamping in @sc{http} is implemented by checking of the
1746 @code{Last-Modified} header. If you wish to retrieve the file
1747 @file{foo.html} through @sc{http}, Wget will check whether
1748 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1749 retrieved unconditionally.
1751 If the file does exist locally, Wget will first check its local
1752 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1753 @code{HEAD} request to the remote server, demanding the information on
1756 The @code{Last-Modified} header is examined to find which file was
1757 modified more recently (which makes it ``newer''). If the remote file
1758 is newer, it will be downloaded; if it is older, Wget will give
1759 up.@footnote{As an additional check, Wget will look at the
1760 @code{Content-Length} header, and compare the sizes; if they are not the
1761 same, the remote file will be downloaded no matter what the time-stamp
1764 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1765 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1766 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1767 @samp{@var{X}}, which will always differ if it's been converted by
1768 @samp{--convert-links} (@samp{-k}).
1770 Arguably, @sc{http} time-stamping should be implemented using the
1771 @code{If-Modified-Since} request.
1773 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1774 @section FTP Time-Stamping Internals
1775 @cindex ftp time-stamping
1777 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1778 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
1781 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
1782 @sc{ftp} @code{LIST} command to get a file listing for the directory
1783 containing the desired file(s). It will try to analyze the listing,
1784 treating it like Unix @code{ls -l} output, extracting the time-stamps.
1785 The rest is exactly the same as for @sc{http}. Note that when
1786 retrieving individual files from an @sc{ftp} server without using
1787 globbing or recursion, listing files will not be downloaded (and thus
1788 files will not be time-stamped) unless @samp{-N} is specified.
1790 Assumption that every directory listing is a Unix-style listing may
1791 sound extremely constraining, but in practice it is not, as many
1792 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1793 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
1794 defines no standard way to get a file list, let alone the time-stamps.
1795 We can only hope that a future standard will define this.
1797 Another non-standard solution includes the use of @code{MDTM} command
1798 that is supported by some @sc{ftp} servers (including the popular
1799 @code{wu-ftpd}), which returns the exact time of the specified file.
1800 Wget may support this command in the future.
1802 @node Startup File, Examples, Time-Stamping, Top
1803 @chapter Startup File
1804 @cindex startup file
1810 Once you know how to change default settings of Wget through command
1811 line arguments, you may wish to make some of those settings permanent.
1812 You can do that in a convenient way by creating the Wget startup
1813 file---@file{.wgetrc}.
1815 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1816 convenient to have a special facility for storing passwords. Thus Wget
1817 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1818 it. You can find @file{.netrc} format in your system manuals.
1820 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1824 * Wgetrc Location:: Location of various wgetrc files.
1825 * Wgetrc Syntax:: Syntax of wgetrc.
1826 * Wgetrc Commands:: List of available commands.
1827 * Sample Wgetrc:: A wgetrc example.
1830 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1831 @section Wgetrc Location
1832 @cindex wgetrc location
1833 @cindex location of wgetrc
1835 When initializing, Wget will look for a @dfn{global} startup file,
1836 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1837 @file{/usr/local}, if Wget was not installed there) and read commands
1838 from there, if it exists.
1840 Then it will look for the user's file. If the environmental variable
1841 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
1842 further attempts will be made.
1844 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1846 The fact that user's settings are loaded after the system-wide ones
1847 means that in case of collision user's wgetrc @emph{overrides} the
1848 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1849 Fascist admins, away!
1851 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1852 @section Wgetrc Syntax
1853 @cindex wgetrc syntax
1854 @cindex syntax of wgetrc
1856 The syntax of a wgetrc command is simple:
1862 The @dfn{variable} will also be called @dfn{command}. Valid
1863 @dfn{values} are different for different commands.
1865 The commands are case-insensitive and underscore-insensitive. Thus
1866 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
1867 beginning with @samp{#} and lines containing white-space only are
1870 Commands that expect a comma-separated list will clear the list on an
1871 empty command. So, if you wish to reset the rejection list specified in
1872 global @file{wgetrc}, you can do it with:
1878 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1879 @section Wgetrc Commands
1880 @cindex wgetrc commands
1882 The complete set of commands is listed below. Legal values are listed
1883 after the @samp{=}. Simple Boolean values can be set or unset using
1884 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
1885 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
1886 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
1887 option is set to @samp{always} or @samp{never}, that value will be
1888 locked in for the duration of the Wget invocation---commandline options
1891 Some commands take pseudo-arbitrary values. @var{address} values can be
1892 hostnames or dotted-quad IP addresses. @var{n} can be any positive
1893 integer, or @samp{inf} for infinity, where appropriate. @var{string}
1894 values can be any non-empty string.
1896 Most of these commands have commandline equivalents (@pxref{Invoking}),
1897 though some of the more obscure or rarely used ones do not.
1900 @item accept/reject = @var{string}
1901 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
1903 @item add_hostdir = on/off
1904 Enable/disable host-prefixed file names. @samp{-nH} disables it.
1906 @item continue = on/off
1907 If set to on, force continuation of preexistent partially retrieved
1908 files. See @samp{-c} before setting it.
1910 @item background = on/off
1911 Enable/disable going to background---the same as @samp{-b} (which
1914 @item backup_converted = on/off
1915 Enable/disable saving pre-converted files with the suffix
1916 @samp{.orig}---the same as @samp{-K} (which enables it).
1918 @c @item backups = @var{number}
1919 @c #### Document me!
1921 @item base = @var{string}
1922 Consider relative @sc{url}s in @sc{url} input files forced to be
1923 interpreted as @sc{html} as being relative to @var{string}---the same as
1926 @item bind_address = @var{address}
1927 Bind to @var{address}, like the @samp{--bind-address} option.
1929 @item cache = on/off
1930 When set to off, disallow server-caching. See the @samp{-C} option.
1932 @item convert links = on/off
1933 Convert non-relative links locally. The same as @samp{-k}.
1935 @item cookies = on/off
1936 When set to off, disallow cookies. See the @samp{--cookies} option.
1938 @item load_cookies = @var{file}
1939 Load cookies from @var{file}. See @samp{--load-cookies}.
1941 @item save_cookies = @var{file}
1942 Save cookies to @var{file}. See @samp{--save-cookies}.
1944 @item cut_dirs = @var{n}
1945 Ignore @var{n} remote directory components.
1947 @item debug = on/off
1948 Debug mode, same as @samp{-d}.
1950 @item delete_after = on/off
1951 Delete after download---the same as @samp{--delete-after}.
1953 @item dir_prefix = @var{string}
1954 Top of directory tree---the same as @samp{-P}.
1956 @item dirstruct = on/off
1957 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
1960 @item domains = @var{string}
1961 Same as @samp{-D} (@pxref{Spanning Hosts}).
1963 @item dot_bytes = @var{n}
1964 Specify the number of bytes ``contained'' in a dot, as seen throughout
1965 the retrieval (1024 by default). You can postfix the value with
1966 @samp{k} or @samp{m}, representing kilobytes and megabytes,
1967 respectively. With dot settings you can tailor the dot retrieval to
1968 suit your needs, or you can use the predefined @dfn{styles}
1969 (@pxref{Download Options}).
1971 @item dots_in_line = @var{n}
1972 Specify the number of dots that will be printed in each line throughout
1973 the retrieval (50 by default).
1975 @item dot_spacing = @var{n}
1976 Specify the number of dots in a single cluster (10 by default).
1978 @item exclude_directories = @var{string}
1979 Specify a comma-separated list of directories you wish to exclude from
1980 download---the same as @samp{-X} (@pxref{Directory-Based Limits}).
1982 @item exclude_domains = @var{string}
1983 Same as @samp{--exclude-domains} (@pxref{Spanning Hosts}).
1985 @item follow_ftp = on/off
1986 Follow @sc{ftp} links from @sc{html} documents---the same as
1987 @samp{--follow-ftp}.
1989 @item follow_tags = @var{string}
1990 Only follow certain HTML tags when doing a recursive retrieval, just like
1991 @samp{--follow-tags}.
1993 @item force_html = on/off
1994 If set to on, force the input filename to be regarded as an @sc{html}
1995 document---the same as @samp{-F}.
1997 @item ftp_proxy = @var{string}
1998 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2002 Turn globbing on/off---the same as @samp{-g}.
2004 @item header = @var{string}
2005 Define an additional header, like @samp{--header}.
2007 @item html_extension = on/off
2008 Add a @samp{.html} extension to @samp{text/html} files without it, like
2011 @item http_passwd = @var{string}
2012 Set @sc{http} password.
2014 @item http_proxy = @var{string}
2015 Use @var{string} as @sc{http} proxy, instead of the one specified in
2018 @item http_user = @var{string}
2019 Set @sc{http} user to @var{string}.
2021 @item ignore_length = on/off
2022 When set to on, ignore @code{Content-Length} header; the same as
2023 @samp{--ignore-length}.
2025 @item ignore_tags = @var{string}
2026 Ignore certain HTML tags when doing a recursive retrieval, just like
2027 @samp{-G} / @samp{--ignore-tags}.
2029 @item include_directories = @var{string}
2030 Specify a comma-separated list of directories you wish to follow when
2031 downloading---the same as @samp{-I}.
2033 @item input = @var{string}
2034 Read the @sc{url}s from @var{string}, like @samp{-i}.
2036 @item kill_longer = on/off
2037 Consider data longer than specified in content-length header as invalid
2038 (and retry getting it). The default behaviour is to save as much data
2039 as there is, provided there is more than or equal to the value in
2040 @code{Content-Length}.
2042 @item logfile = @var{string}
2043 Set logfile---the same as @samp{-o}.
2045 @item login = @var{string}
2046 Your user name on the remote machine, for @sc{ftp}. Defaults to
2049 @item mirror = on/off
2050 Turn mirroring on/off. The same as @samp{-m}.
2052 @item netrc = on/off
2053 Turn reading netrc on or off.
2055 @item noclobber = on/off
2058 @item no_parent = on/off
2059 Disallow retrieving outside the directory hierarchy, like
2060 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2062 @item no_proxy = @var{string}
2063 Use @var{string} as the comma-separated list of domains to avoid in
2064 proxy loading, instead of the one specified in environment.
2066 @item output_document = @var{string}
2067 Set the output filename---the same as @samp{-O}.
2069 @item page_requisites = on/off
2070 Download all ancillary documents necessary for a single HTML page to
2071 display properly---the same as @samp{-p}.
2073 @item passive_ftp = on/off/always/never
2074 Set passive @sc{ftp}---the same as @samp{--passive-ftp}. Some scripts
2075 and @samp{.pm} (Perl module) files download files using @samp{wget
2076 --passive-ftp}. If your firewall does not allow this, you can set
2077 @samp{passive_ftp = never} to override the commandline.
2079 @item passwd = @var{string}
2080 Set your @sc{ftp} password to @var{password}. Without this setting, the
2081 password defaults to @samp{username@@hostname.domainname}.
2083 @item progress = @var{string}
2084 Set the type of the progress indicator. Legal types are ``dot'' and
2087 @item proxy_user = @var{string}
2088 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
2090 @item proxy_passwd = @var{string}
2091 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
2093 @item referer = @var{string}
2094 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
2095 was the folks who wrote the @sc{http} spec who got the spelling of
2096 ``referrer'' wrong.)
2098 @item quiet = on/off
2099 Quiet mode---the same as @samp{-q}.
2101 @item quota = @var{quota}
2102 Specify the download quota, which is useful to put in the global
2103 @file{wgetrc}. When download quota is specified, Wget will stop
2104 retrieving after the download sum has become greater than quota. The
2105 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2106 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2107 to 5 mbytes. Note that the user's startup file overrides system
2110 @item reclevel = @var{n}
2111 Recursion level---the same as @samp{-l}.
2113 @item recursive = on/off
2114 Recursive on/off---the same as @samp{-r}.
2116 @item relative_only = on/off
2117 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2120 @item remove_listing = on/off
2121 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2122 to off is the same as @samp{-nr}.
2124 @item retr_symlinks = on/off
2125 When set to on, retrieve symbolic links as if they were plain files; the
2126 same as @samp{--retr-symlinks}.
2128 @item robots = on/off
2129 Use (or not) @file{/robots.txt} file (@pxref{Robots}). Be sure to know
2130 what you are doing before changing the default (which is @samp{on}).
2132 @item server_response = on/off
2133 Choose whether or not to print the @sc{http} and @sc{ftp} server
2134 responses---the same as @samp{-S}.
2136 @item simple_host_check = on/off
2137 Same as @samp{-nh} (@pxref{Spanning Hosts}).
2139 @item span_hosts = on/off
2142 @item timeout = @var{n}
2143 Set timeout value---the same as @samp{-T}.
2145 @item timestamping = on/off
2146 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2148 @item tries = @var{n}
2149 Set number of retries per @sc{url}---the same as @samp{-t}.
2151 @item use_proxy = on/off
2152 Turn proxy support on/off. The same as @samp{-Y}.
2154 @item verbose = on/off
2155 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2157 @item wait = @var{n}
2158 Wait @var{n} seconds between retrievals---the same as @samp{-w}.
2160 @item waitretry = @var{n}
2161 Wait up to @var{n} seconds between retries of failed retrievals
2162 only---the same as @samp{--waitretry}. Note that this is turned on by
2163 default in the global @file{wgetrc}.
2165 @item randomwait = on/off
2166 Turn random between-request wait times on or off. The same as
2167 @samp{--random-wait}.
2170 @node Sample Wgetrc, , Wgetrc Commands, Startup File
2171 @section Sample Wgetrc
2172 @cindex sample wgetrc
2174 This is the sample initialization file, as given in the distribution.
2175 It is divided in two section---one for global usage (suitable for global
2176 startup file), and one for local usage (suitable for
2177 @file{$HOME/.wgetrc}). Be careful about the things you change.
2179 Note that almost all the lines are commented out. For a command to have
2180 any effect, you must remove the @samp{#} character at the beginning of
2184 @include sample.wgetrc.munged_for_texi_inclusion
2187 @node Examples, Various, Startup File, Top
2191 @c man begin EXAMPLES
2192 The examples are divided into three sections loosely based on their
2196 * Simple Usage:: Simple, basic usage of the program.
2197 * Advanced Usage:: Advanced tips.
2198 * Very Advanced Usage:: The hairy stuff.
2201 @node Simple Usage, Advanced Usage, Examples, Examples
2202 @section Simple Usage
2206 Say you want to download a @sc{url}. Just type:
2209 wget http://fly.srk.fer.hr/
2213 But what will happen if the connection is slow, and the file is lengthy?
2214 The connection will probably fail before the whole file is retrieved,
2215 more than once. In this case, Wget will try getting the file until it
2216 either gets the whole of it, or exceeds the default number of retries
2217 (this being 20). It is easy to change the number of tries to 45, to
2218 insure that the whole file will arrive safely:
2221 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2225 Now let's leave Wget to work in the background, and write its progress
2226 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2227 shall use @samp{-t}.
2230 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2233 The ampersand at the end of the line makes sure that Wget works in the
2234 background. To unlimit the number of retries, use @samp{-t inf}.
2237 The usage of @sc{ftp} is as simple. Wget will take care of login and
2241 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2245 If you specify a directory, Wget will retrieve the directory listing,
2246 parse it and convert it to @sc{html}. Try:
2249 wget ftp://prep.ai.mit.edu/pub/gnu/
2254 @node Advanced Usage, Very Advanced Usage, Simple Usage, Examples
2255 @section Advanced Usage
2259 You have a file that contains the URLs you want to download? Use the
2266 If you specify @samp{-} as file name, the @sc{url}s will be read from
2270 Create a five levels deep mirror image of the GNU web site, with the
2271 same directory structure the original has, with only one try per
2272 document, saving the log of the activities to @file{gnulog}:
2275 wget -r http://www.gnu.org/ -o gnulog
2279 The same as the above, but convert the links in the @sc{html} files to
2280 point to local files, so you can view the documents off-line:
2283 wget --convert-links -r http://www.gnu.org/ -o gnulog
2287 Retrieve only one HTML page, but make sure that all the elements needed
2288 for the page to be displayed, such as inline images and external style
2289 sheets, are also downloaded. Also make sure the downloaded page
2290 references the downloaded links.
2293 wget -p --convert-links http://www.server.com/dir/page.html
2296 The HTML page will be saved to @file{www.server.com/dir/page.html}, and
2297 the images, stylesheets, etc., somewhere under @file{www.server.com/},
2298 depending on where they were on the remote server.
2301 The same as the above, but without the @file{www.server.com/} directory.
2302 In fact, I don't want to have all those random server directories
2303 anyway---just save @emph{all} those files under a @file{download/}
2304 subdirectory of the current directory.
2307 wget -p --convert-links -nH -nd -Pdownload \
2308 http://www.server.com/dir/page.html
2312 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2316 wget -S http://www.lycos.com/
2320 Save the server headers with the file, perhaps for post-processing.
2323 wget -s http://www.lycos.com/
2328 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2332 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
2336 You want to download all the @sc{gif}s from a directory on an @sc{http}
2337 server. @samp{wget http://www.server.com/dir/*.gif} doesn't work
2338 because @sc{http} retrieval does not support globbing. In that case,
2342 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
2345 More verbose, but the effect is the same. @samp{-r -l1} means to
2346 retrieve recursively (@pxref{Recursive Retrieval}), with maximum depth
2347 of 1. @samp{--no-parent} means that references to the parent directory
2348 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2349 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2353 Suppose you were in the middle of downloading, when Wget was
2354 interrupted. Now you do not want to clobber the files already present.
2358 wget -nc -r http://www.gnu.org/
2362 If you want to encode your own username and password to @sc{http} or
2363 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2366 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
2369 @cindex redirecting output
2371 You would like the output documents to go to standard output instead of
2375 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2378 You can also combine the two options and make pipelines to retrieve the
2379 documents from remote hotlists:
2382 wget -O - http://cool.list.com/ | wget --force-html -i -
2386 @node Very Advanced Usage, , Advanced Usage, Examples
2387 @section Very Advanced Usage
2392 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2393 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2394 for @samp{-r -l inf -N}. You can put Wget in the crontab file asking it
2395 to recheck a site each Sunday:
2399 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
2403 In addition to the above, you want the links to be converted for local
2404 viewing. But, after having read this manual, you know that link
2405 conversion doesn't play well with timestamping, so you also want Wget to
2406 back up the original HTML files before the conversion. Wget invocation
2407 would look like this:
2410 wget --mirror --convert-links --backup-converted \
2411 http://www.gnu.org/ -o /home/me/weeklog
2415 But you've also noticed that local viewing doesn't work all that well
2416 when HTML files are saved under extensions other than @samp{.html},
2417 perhaps because they were served as @file{index.cgi}. So you'd like
2418 Wget to rename all the files served with content-type @samp{text/html}
2419 to @file{@var{name}.html}.
2422 wget --mirror --convert-links --backup-converted \
2423 --html-extension -o /home/me/weeklog \
2427 Or, with less typing:
2430 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
2436 @node Various, Appendices, Examples, Top
2440 This chapter contains all the stuff that could not fit anywhere else.
2443 * Proxies:: Support for proxy servers
2444 * Distribution:: Getting the latest version.
2445 * Mailing List:: Wget mailing list for announcements and discussion.
2446 * Reporting Bugs:: How and where to report bugs.
2447 * Portability:: The systems Wget works on.
2448 * Signals:: Signal-handling performed by Wget.
2451 @node Proxies, Distribution, Various, Various
2455 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2456 data from remote servers to local clients. One typical use of proxies
2457 is lightening network load for users behind a slow connection. This is
2458 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2459 proxy which caches the transferred data. When a cached resource is
2460 requested again, proxy will return the data from cache. Another use for
2461 proxies is for companies that separate (for security reasons) their
2462 internal networks from the rest of Internet. In order to obtain
2463 information from the Web, their users connect and retrieve remote data
2464 using an authorized proxy.
2466 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2467 standard way to specify proxy location, which Wget recognizes, is using
2468 the following environment variables:
2472 This variable should contain the @sc{url} of the proxy for @sc{http}
2476 This variable should contain the @sc{url} of the proxy for @sc{ftp}
2477 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2478 are set to the same @sc{url}.
2481 This variable should contain a comma-separated list of domain extensions
2482 proxy should @emph{not} be used for. For instance, if the value of
2483 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2487 In addition to the environment variables, proxy location and settings
2488 may be specified from within Wget itself.
2492 @itemx --proxy=on/off
2493 @itemx proxy = on/off
2494 This option may be used to turn the proxy support on or off. Proxy
2495 support is on by default, provided that the appropriate environment
2498 @item http_proxy = @var{URL}
2499 @itemx ftp_proxy = @var{URL}
2500 @itemx no_proxy = @var{string}
2501 These startup file variables allow you to override the proxy settings
2502 specified by the environment.
2505 Some proxy servers require authorization to enable you to use them. The
2506 authorization consists of @dfn{username} and @dfn{password}, which must
2507 be sent by Wget. As with @sc{http} authorization, several
2508 authentication schemes exist. For proxy authorization only the
2509 @code{Basic} authentication scheme is currently implemented.
2511 You may specify your username and password either through the proxy
2512 @sc{url} or through the command-line options. Assuming that the
2513 company's proxy is located at @samp{proxy.company.com} at port 8001, a
2514 proxy @sc{url} location containing authorization data might look like
2518 http://hniksic:mypassword@@proxy.company.com:8001/
2521 Alternatively, you may use the @samp{proxy-user} and
2522 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2523 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2524 username and password.
2526 @node Distribution, Mailing List, Proxies, Various
2527 @section Distribution
2528 @cindex latest version
2530 Like all GNU utilities, the latest version of Wget can be found at the
2531 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2532 Wget @value{VERSION} can be found at
2533 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2535 @node Mailing List, Reporting Bugs, Distribution, Various
2536 @section Mailing List
2537 @cindex mailing list
2540 Wget has its own mailing list at @email{wget@@sunsite.dk}, thanks
2541 to Karsten Thygesen. The mailing list is for discussion of Wget
2542 features and web, reporting Wget bugs (those that you think may be of
2543 interest to the public) and mailing announcements. You are welcome to
2544 subscribe. The more people on the list, the better!
2546 To subscribe, send mail to @email{wget-subscribe@@sunsite.dk}.
2547 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2548 mailing to @email{wget-unsubscribe@@sunsite.dk}.
2550 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2551 Alternative archive is available at
2552 @url{http://www.mail-archive.com/wget%40sunsite.auc.dk/}.
2554 @node Reporting Bugs, Portability, Mailing List, Various
2555 @section Reporting Bugs
2557 @cindex reporting bugs
2561 You are welcome to send bug reports about GNU Wget to
2562 @email{bug-wget@@gnu.org}.
2564 Before actually submitting a bug report, please try to follow a few
2569 Please try to ascertain that the behaviour you see really is a bug. If
2570 Wget crashes, it's a bug. If Wget does not behave as documented,
2571 it's a bug. If things work strange, but you are not sure about the way
2572 they are supposed to work, it might well be a bug.
2575 Try to repeat the bug in as simple circumstances as possible. E.g. if
2576 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
2577 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
2578 repeatable, and if will occur with a simpler set of options. You might
2579 even try to start the download at the page where the crash occurred to
2580 see if that page somehow triggered the crash.
2582 Also, while I will probably be interested to know the contents of your
2583 @file{.wgetrc} file, just dumping it into the debug message is probably
2584 a bad idea. Instead, you should first try to see if the bug repeats
2585 with @file{.wgetrc} moved out of the way. Only if it turns out that
2586 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
2590 Please start Wget with @samp{-d} option and send the log (or the
2591 relevant parts of it). If Wget was compiled without debug support,
2592 recompile it. It is @emph{much} easier to trace bugs with debug support
2596 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2597 wget` core} and type @code{where} to get the backtrace.
2601 @node Portability, Signals, Reporting Bugs, Various
2602 @section Portability
2604 @cindex operating systems
2606 Since Wget uses GNU Autoconf for building and configuring, and avoids
2607 using ``special'' ultra--mega--cool features of any particular Unix, it
2608 should compile (and work) on all common Unix flavors.
2610 Various Wget versions have been compiled and tested under many kinds of
2611 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2612 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2613 distribution directory for a comprehensive list. If you compile it on
2614 an architecture not listed there, please let me know so I can update it.
2616 Wget should also compile on the other Unix systems, not listed in
2617 @file{MACHINES}. If it doesn't, please let me know.
2619 Thanks to kind contributors, this version of Wget compiles and works on
2620 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2621 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2622 with Winsock as networking software. Naturally, it is crippled of some
2623 features available on Unix, but it should work as a substitute for
2624 people stuck with Windows. Note that the Windows port is
2625 @strong{neither tested nor maintained} by me---all questions and
2626 problems should be reported to Wget mailing list at
2627 @email{wget@@sunsite.dk} where the maintainers will look at them.
2629 @node Signals, , Portability, Various
2631 @cindex signal handling
2634 Since the purpose of Wget is background work, it catches the hangup
2635 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2636 output, it will be redirected to a file named @file{wget-log}.
2637 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2638 to redirect the output of Wget after having started it.
2641 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2642 $ kill -HUP %% # Redirect the output to wget-log
2645 Other than that, Wget will not try to interfere with signals in any way.
2646 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
2648 @node Appendices, Copying, Various, Top
2651 This chapter contains some references I consider useful.
2654 * Robots:: Wget as a WWW robot.
2655 * Security Considerations:: Security with Wget.
2656 * Contributors:: People who helped.
2659 @node Robots, Security Considerations, Appendices, Appendices
2663 @cindex server maintenance
2665 It is extremely easy to make Wget wander aimlessly around a web site,
2666 sucking all the available data in progress. @samp{wget -r @var{site}},
2667 and you're set. Great? Not for the server admin.
2669 While Wget is retrieving static pages, there's not much of a problem.
2670 But for Wget, there is no real difference between a static page and the
2671 most demanding CGI. For instance, a site I know has a section handled
2672 by an, uh, @dfn{bitchin'} CGI script that converts all the Info files to
2673 HTML. The script can and does bring the machine to its knees without
2674 providing anything useful to the downloader.
2676 For such and similar cases various robot exclusion schemes have been
2677 devised as a means for the server administrators and document authors to
2678 protect chosen portions of their sites from the wandering of robots.
2680 The more popular mechanism is the @dfn{Robots Exclusion Standard}, or
2681 @sc{res}, written by Martijn Koster et al. in 1994. It specifies the
2682 format of a text file containing directives that instruct the robots
2683 which URL paths to avoid. To be found by the robots, the specifications
2684 must be placed in @file{/robots.txt} in the server root, which the
2685 robots are supposed to download and parse.
2687 Wget supports @sc{res} when downloading recursively. So, when you
2691 wget -r http://www.server.com/
2694 First the index of @samp{www.server.com} will be downloaded. If Wget
2695 finds that it wants to download more documents from that server, it will
2696 request @samp{http://www.server.com/robots.txt} and, if found, use it
2697 for further downloads. @file{robots.txt} is loaded only once per each
2700 Until version 1.8, Wget supported the first version of the standard,
2701 written by Martijn Koster in 1994 and available at
2702 @url{http://info.webcrawler.com/mak/projects/robots/norobots.html}. As
2703 of version 1.8, Wget has supported the additional directives specified
2704 in the internet draft @samp{<draft-koster-robots-00.txt>} titled ``A
2705 Method for Web Robots Control''. The draft, which has as far as I know
2706 never made to an @sc{rfc}, is available at
2707 @url{http://info.webcrawler.com/mak/projects/robots/norobots-rfc.html}.
2709 This manual no longer includes the text of the Robot Exclusion Standard.
2711 The second, less known mechanism, enables the author of an individual
2712 document to specify whether they want the links from the file to be
2713 followed by a robot. This is achieved using the @code{META} tag, like
2717 <meta name="robots" content="nofollow">
2720 This is explained in some detail at
2721 @url{http://info.webcrawler.com/mak/projects/robots/meta-user.html}.
2722 Wget supports this method of robot exclusion in addition to the usual
2723 @file{/robots.txt} exclusion.
2725 @node Security Considerations, Contributors, Robots, Appendices
2726 @section Security Considerations
2729 When using Wget, you must be aware that it sends unencrypted passwords
2730 through the network, which may present a security problem. Here are the
2731 main issues, and some solutions.
2735 The passwords on the command line are visible using @code{ps}. If this
2736 is a problem, avoid putting passwords from the command line---e.g. you
2737 can use @file{.netrc} for this.
2740 Using the insecure @dfn{basic} authentication scheme, unencrypted
2741 passwords are transmitted through the network routers and gateways.
2744 The @sc{ftp} passwords are also in no way encrypted. There is no good
2745 solution for this at the moment.
2748 Although the ``normal'' output of Wget tries to hide the passwords,
2749 debugging logs show them, in all forms. This problem is avoided by
2750 being careful when you send debug logs (yes, even when you send them to
2754 @node Contributors, , Security Considerations, Appendices
2755 @section Contributors
2756 @cindex contributors
2759 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
2762 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
2764 However, its development could never have gone as far as it has, were it
2765 not for the help of many people, either with bug reports, feature
2766 proposals, patches, or letters saying ``Thanks!''.
2768 Special thanks goes to the following people (no particular order):
2772 Karsten Thygesen---donated system resources such as the mailing list,
2773 web space, and @sc{ftp} space, along with a lot of time to make these
2777 Shawn McHorse---bug reports and patches.
2780 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
2784 Gordon Matzigkeit---@file{.netrc} support.
2788 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2789 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2792 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2793 and ``philosophical'' discussions.
2797 Darko Budor---initial port to Windows.
2800 Antonio Rosella---help and suggestions, plus the Italian translation.
2804 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2808 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2813 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2816 Francois Pinard---many thorough bug reports and discussions.
2820 Karl Eichwalder---lots of help with internationalization and other
2824 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2828 The people who provided donations for development, including Brian
2832 The following people have provided patches, bug/build reports, useful
2833 suggestions, beta testing services, fan mail and all the other things
2834 that make maintenance so much fun:
2853 Kristijan @v{C}onka@v{s},
2871 Aleksandar Erkalovi@'{c},
2874 Aleksandar Erkalovic,
2890 Erik Magnus Hulthen,
2908 Goran Kezunovi@'{c},
2919 $\Sigma\acute{\iota}\mu o\varsigma\;
2920 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
2921 (Simos KSenitellis),
2929 Nicol@'{a}s Lichtmeier,
2935 Alexander V. Lukyanov,
2960 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
2962 Juan Jos\'{e} Rodr\'{\i}gues,
2965 Juan Jose Rodrigues,
2977 Szakacsits Szabolcs,
2983 Douglas E. Wegscheid,
2993 Apologies to all who I accidentally left out, and many thanks to all the
2994 subscribers of the Wget mailing list.
2996 @node Copying, Concept Index, Appendices, Top
3001 @cindex free software
3003 GNU Wget is licensed under the GNU GPL, which makes it @dfn{free
3006 Please note that ``free'' in ``free software'' refers to liberty, not
3007 price. As some GNU project advocates like to point out, think of ``free
3008 speech'' rather than ``free beer''. The exact and legally binding
3009 distribution terms are spelled out below; in short, you have the right
3010 (freedom) to run and change Wget and distribute it to other people, and
3011 even---if you want---charge money for doing either. The important
3012 restriction is that you have to grant your recipients the same rights
3013 and impose the same restrictions.
3015 This method of licensing software is also known as @dfn{open source}
3016 because, among other things, it makes sure that all recipients will
3017 receive the source code along with the program, and be able to improve
3018 it. The GNU project prefers the term ``free software'' for reasons
3020 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3022 The exact license terms are defined by this paragraph and the GNU
3023 General Public License it refers to:
3026 GNU Wget is free software; you can redistribute it and/or modify it
3027 under the terms of the GNU General Public License as published by the
3028 Free Software Foundation; either version 2 of the License, or (at your
3029 option) any later version.
3031 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3032 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3033 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3036 A copy of the GNU General Public License is included as part of this
3037 manual; if you did not receive it, write to the Free Software
3038 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3041 In addition to this, this manual is free in the same sense:
3044 Permission is granted to copy, distribute and/or modify this document
3045 under the terms of the GNU Free Documentation License, Version 1.1 or
3046 any later version published by the Free Software Foundation; with the
3047 Invariant Sections being ``GNU General Public License'' and ``GNU Free
3048 Documentation License'', with no Front-Cover Texts, and with no
3049 Back-Cover Texts. A copy of the license is included in the section
3050 entitled ``GNU Free Documentation License''.
3053 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
3054 @c that the GFDL needs to be present in the manual, and to me it would
3055 @c suck to include the license for the manual and not the license for
3058 The full texts of the GNU General Public License and of the GNU Free
3059 Documentation License are available below.
3062 * GNU General Public License::
3063 * GNU Free Documentation License::
3066 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
3067 @section GNU General Public License
3068 @center Version 2, June 1991
3071 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3072 675 Mass Ave, Cambridge, MA 02139, USA
3074 Everyone is permitted to copy and distribute verbatim copies
3075 of this license document, but changing it is not allowed.
3078 @unnumberedsec Preamble
3080 The licenses for most software are designed to take away your
3081 freedom to share and change it. By contrast, the GNU General Public
3082 License is intended to guarantee your freedom to share and change free
3083 software---to make sure the software is free for all its users. This
3084 General Public License applies to most of the Free Software
3085 Foundation's software and to any other program whose authors commit to
3086 using it. (Some other Free Software Foundation software is covered by
3087 the GNU Library General Public License instead.) You can apply it to
3090 When we speak of free software, we are referring to freedom, not
3091 price. Our General Public Licenses are designed to make sure that you
3092 have the freedom to distribute copies of free software (and charge for
3093 this service if you wish), that you receive source code or can get it
3094 if you want it, that you can change the software or use pieces of it
3095 in new free programs; and that you know you can do these things.
3097 To protect your rights, we need to make restrictions that forbid
3098 anyone to deny you these rights or to ask you to surrender the rights.
3099 These restrictions translate to certain responsibilities for you if you
3100 distribute copies of the software, or if you modify it.
3102 For example, if you distribute copies of such a program, whether
3103 gratis or for a fee, you must give the recipients all the rights that
3104 you have. You must make sure that they, too, receive or can get the
3105 source code. And you must show them these terms so they know their
3108 We protect your rights with two steps: (1) copyright the software, and
3109 (2) offer you this license which gives you legal permission to copy,
3110 distribute and/or modify the software.
3112 Also, for each author's protection and ours, we want to make certain
3113 that everyone understands that there is no warranty for this free
3114 software. If the software is modified by someone else and passed on, we
3115 want its recipients to know that what they have is not the original, so
3116 that any problems introduced by others will not reflect on the original
3117 authors' reputations.
3119 Finally, any free program is threatened constantly by software
3120 patents. We wish to avoid the danger that redistributors of a free
3121 program will individually obtain patent licenses, in effect making the
3122 program proprietary. To prevent this, we have made it clear that any
3123 patent must be licensed for everyone's free use or not licensed at all.
3125 The precise terms and conditions for copying, distribution and
3126 modification follow.
3129 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3132 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3137 This License applies to any program or other work which contains
3138 a notice placed by the copyright holder saying it may be distributed
3139 under the terms of this General Public License. The ``Program'', below,
3140 refers to any such program or work, and a ``work based on the Program''
3141 means either the Program or any derivative work under copyright law:
3142 that is to say, a work containing the Program or a portion of it,
3143 either verbatim or with modifications and/or translated into another
3144 language. (Hereinafter, translation is included without limitation in
3145 the term ``modification''.) Each licensee is addressed as ``you''.
3147 Activities other than copying, distribution and modification are not
3148 covered by this License; they are outside its scope. The act of
3149 running the Program is not restricted, and the output from the Program
3150 is covered only if its contents constitute a work based on the
3151 Program (independent of having been made by running the Program).
3152 Whether that is true depends on what the Program does.
3155 You may copy and distribute verbatim copies of the Program's
3156 source code as you receive it, in any medium, provided that you
3157 conspicuously and appropriately publish on each copy an appropriate
3158 copyright notice and disclaimer of warranty; keep intact all the
3159 notices that refer to this License and to the absence of any warranty;
3160 and give any other recipients of the Program a copy of this License
3161 along with the Program.
3163 You may charge a fee for the physical act of transferring a copy, and
3164 you may at your option offer warranty protection in exchange for a fee.
3167 You may modify your copy or copies of the Program or any portion
3168 of it, thus forming a work based on the Program, and copy and
3169 distribute such modifications or work under the terms of Section 1
3170 above, provided that you also meet all of these conditions:
3174 You must cause the modified files to carry prominent notices
3175 stating that you changed the files and the date of any change.
3178 You must cause any work that you distribute or publish, that in
3179 whole or in part contains or is derived from the Program or any
3180 part thereof, to be licensed as a whole at no charge to all third
3181 parties under the terms of this License.
3184 If the modified program normally reads commands interactively
3185 when run, you must cause it, when started running for such
3186 interactive use in the most ordinary way, to print or display an
3187 announcement including an appropriate copyright notice and a
3188 notice that there is no warranty (or else, saying that you provide
3189 a warranty) and that users may redistribute the program under
3190 these conditions, and telling the user how to view a copy of this
3191 License. (Exception: if the Program itself is interactive but
3192 does not normally print such an announcement, your work based on
3193 the Program is not required to print an announcement.)
3196 These requirements apply to the modified work as a whole. If
3197 identifiable sections of that work are not derived from the Program,
3198 and can be reasonably considered independent and separate works in
3199 themselves, then this License, and its terms, do not apply to those
3200 sections when you distribute them as separate works. But when you
3201 distribute the same sections as part of a whole which is a work based
3202 on the Program, the distribution of the whole must be on the terms of
3203 this License, whose permissions for other licensees extend to the
3204 entire whole, and thus to each and every part regardless of who wrote it.
3206 Thus, it is not the intent of this section to claim rights or contest
3207 your rights to work written entirely by you; rather, the intent is to
3208 exercise the right to control the distribution of derivative or
3209 collective works based on the Program.
3211 In addition, mere aggregation of another work not based on the Program
3212 with the Program (or with a work based on the Program) on a volume of
3213 a storage or distribution medium does not bring the other work under
3214 the scope of this License.
3217 You may copy and distribute the Program (or a work based on it,
3218 under Section 2) in object code or executable form under the terms of
3219 Sections 1 and 2 above provided that you also do one of the following:
3223 Accompany it with the complete corresponding machine-readable
3224 source code, which must be distributed under the terms of Sections
3225 1 and 2 above on a medium customarily used for software interchange; or,
3228 Accompany it with a written offer, valid for at least three
3229 years, to give any third party, for a charge no more than your
3230 cost of physically performing source distribution, a complete
3231 machine-readable copy of the corresponding source code, to be
3232 distributed under the terms of Sections 1 and 2 above on a medium
3233 customarily used for software interchange; or,
3236 Accompany it with the information you received as to the offer
3237 to distribute corresponding source code. (This alternative is
3238 allowed only for noncommercial distribution and only if you
3239 received the program in object code or executable form with such
3240 an offer, in accord with Subsection b above.)
3243 The source code for a work means the preferred form of the work for
3244 making modifications to it. For an executable work, complete source
3245 code means all the source code for all modules it contains, plus any
3246 associated interface definition files, plus the scripts used to
3247 control compilation and installation of the executable. However, as a
3248 special exception, the source code distributed need not include
3249 anything that is normally distributed (in either source or binary
3250 form) with the major components (compiler, kernel, and so on) of the
3251 operating system on which the executable runs, unless that component
3252 itself accompanies the executable.
3254 If distribution of executable or object code is made by offering
3255 access to copy from a designated place, then offering equivalent
3256 access to copy the source code from the same place counts as
3257 distribution of the source code, even though third parties are not
3258 compelled to copy the source along with the object code.
3261 You may not copy, modify, sublicense, or distribute the Program
3262 except as expressly provided under this License. Any attempt
3263 otherwise to copy, modify, sublicense or distribute the Program is
3264 void, and will automatically terminate your rights under this License.
3265 However, parties who have received copies, or rights, from you under
3266 this License will not have their licenses terminated so long as such
3267 parties remain in full compliance.
3270 You are not required to accept this License, since you have not
3271 signed it. However, nothing else grants you permission to modify or
3272 distribute the Program or its derivative works. These actions are
3273 prohibited by law if you do not accept this License. Therefore, by
3274 modifying or distributing the Program (or any work based on the
3275 Program), you indicate your acceptance of this License to do so, and
3276 all its terms and conditions for copying, distributing or modifying
3277 the Program or works based on it.
3280 Each time you redistribute the Program (or any work based on the
3281 Program), the recipient automatically receives a license from the
3282 original licensor to copy, distribute or modify the Program subject to
3283 these terms and conditions. You may not impose any further
3284 restrictions on the recipients' exercise of the rights granted herein.
3285 You are not responsible for enforcing compliance by third parties to
3289 If, as a consequence of a court judgment or allegation of patent
3290 infringement or for any other reason (not limited to patent issues),
3291 conditions are imposed on you (whether by court order, agreement or
3292 otherwise) that contradict the conditions of this License, they do not
3293 excuse you from the conditions of this License. If you cannot
3294 distribute so as to satisfy simultaneously your obligations under this
3295 License and any other pertinent obligations, then as a consequence you
3296 may not distribute the Program at all. For example, if a patent
3297 license would not permit royalty-free redistribution of the Program by
3298 all those who receive copies directly or indirectly through you, then
3299 the only way you could satisfy both it and this License would be to
3300 refrain entirely from distribution of the Program.
3302 If any portion of this section is held invalid or unenforceable under
3303 any particular circumstance, the balance of the section is intended to
3304 apply and the section as a whole is intended to apply in other
3307 It is not the purpose of this section to induce you to infringe any
3308 patents or other property right claims or to contest validity of any
3309 such claims; this section has the sole purpose of protecting the
3310 integrity of the free software distribution system, which is
3311 implemented by public license practices. Many people have made
3312 generous contributions to the wide range of software distributed
3313 through that system in reliance on consistent application of that
3314 system; it is up to the author/donor to decide if he or she is willing
3315 to distribute software through any other system and a licensee cannot
3318 This section is intended to make thoroughly clear what is believed to
3319 be a consequence of the rest of this License.
3322 If the distribution and/or use of the Program is restricted in
3323 certain countries either by patents or by copyrighted interfaces, the
3324 original copyright holder who places the Program under this License
3325 may add an explicit geographical distribution limitation excluding
3326 those countries, so that distribution is permitted only in or among
3327 countries not thus excluded. In such case, this License incorporates
3328 the limitation as if written in the body of this License.
3331 The Free Software Foundation may publish revised and/or new versions
3332 of the General Public License from time to time. Such new versions will
3333 be similar in spirit to the present version, but may differ in detail to
3334 address new problems or concerns.
3336 Each version is given a distinguishing version number. If the Program
3337 specifies a version number of this License which applies to it and ``any
3338 later version'', you have the option of following the terms and conditions
3339 either of that version or of any later version published by the Free
3340 Software Foundation. If the Program does not specify a version number of
3341 this License, you may choose any version ever published by the Free Software
3345 If you wish to incorporate parts of the Program into other free
3346 programs whose distribution conditions are different, write to the author
3347 to ask for permission. For software which is copyrighted by the Free
3348 Software Foundation, write to the Free Software Foundation; we sometimes
3349 make exceptions for this. Our decision will be guided by the two goals
3350 of preserving the free status of all derivatives of our free software and
3351 of promoting the sharing and reuse of software generally.
3354 @heading NO WARRANTY
3362 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3363 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3364 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3365 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3366 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3367 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3368 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3369 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3370 REPAIR OR CORRECTION.
3373 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3374 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3375 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3376 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3377 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3378 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3379 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3380 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3381 POSSIBILITY OF SUCH DAMAGES.
3385 @heading END OF TERMS AND CONDITIONS
3388 @center END OF TERMS AND CONDITIONS
3392 @unnumberedsec How to Apply These Terms to Your New Programs
3394 If you develop a new program, and you want it to be of the greatest
3395 possible use to the public, the best way to achieve this is to make it
3396 free software which everyone can redistribute and change under these terms.
3398 To do so, attach the following notices to the program. It is safest
3399 to attach them to the start of each source file to most effectively
3400 convey the exclusion of warranty; and each file should have at least
3401 the ``copyright'' line and a pointer to where the full notice is found.
3404 @var{one line to give the program's name and an idea of what it does.}
3405 Copyright (C) 19@var{yy} @var{name of author}
3407 This program is free software; you can redistribute it and/or
3408 modify it under the terms of the GNU General Public License
3409 as published by the Free Software Foundation; either version 2
3410 of the License, or (at your option) any later version.
3412 This program is distributed in the hope that it will be useful,
3413 but WITHOUT ANY WARRANTY; without even the implied warranty of
3414 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3415 GNU General Public License for more details.
3417 You should have received a copy of the GNU General Public License
3418 along with this program; if not, write to the Free Software
3419 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3422 Also add information on how to contact you by electronic and paper mail.
3424 If the program is interactive, make it output a short notice like this
3425 when it starts in an interactive mode:
3428 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3429 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3430 type `show w'. This is free software, and you are welcome
3431 to redistribute it under certain conditions; type `show c'
3435 The hypothetical commands @samp{show w} and @samp{show c} should show
3436 the appropriate parts of the General Public License. Of course, the
3437 commands you use may be called something other than @samp{show w} and
3438 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3441 You should also get your employer (if you work as a programmer) or your
3442 school, if any, to sign a ``copyright disclaimer'' for the program, if
3443 necessary. Here is a sample; alter the names:
3447 Yoyodyne, Inc., hereby disclaims all copyright
3448 interest in the program `Gnomovision'
3449 (which makes passes at compilers) written
3452 @var{signature of Ty Coon}, 1 April 1989
3453 Ty Coon, President of Vice
3457 This General Public License does not permit incorporating your program into
3458 proprietary programs. If your program is a subroutine library, you may
3459 consider it more useful to permit linking proprietary applications with the
3460 library. If this is what you want to do, use the GNU Library General
3461 Public License instead of this License.
3463 @node GNU Free Documentation License, , GNU General Public License, Copying
3464 @section GNU Free Documentation License
3465 @center Version 1.1, March 2000
3468 Copyright (C) 2000 Free Software Foundation, Inc.
3469 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3471 Everyone is permitted to copy and distribute verbatim copies
3472 of this license document, but changing it is not allowed.
3479 The purpose of this License is to make a manual, textbook, or other
3480 written document ``free'' in the sense of freedom: to assure everyone
3481 the effective freedom to copy and redistribute it, with or without
3482 modifying it, either commercially or noncommercially. Secondarily,
3483 this License preserves for the author and publisher a way to get
3484 credit for their work, while not being considered responsible for
3485 modifications made by others.
3487 This License is a kind of ``copyleft'', which means that derivative
3488 works of the document must themselves be free in the same sense. It
3489 complements the GNU General Public License, which is a copyleft
3490 license designed for free software.
3492 We have designed this License in order to use it for manuals for free
3493 software, because free software needs free documentation: a free
3494 program should come with manuals providing the same freedoms that the
3495 software does. But this License is not limited to software manuals;
3496 it can be used for any textual work, regardless of subject matter or
3497 whether it is published as a printed book. We recommend this License
3498 principally for works whose purpose is instruction or reference.
3502 APPLICABILITY AND DEFINITIONS
3504 This License applies to any manual or other work that contains a
3505 notice placed by the copyright holder saying it can be distributed
3506 under the terms of this License. The ``Document'', below, refers to any
3507 such manual or work. Any member of the public is a licensee, and is
3508 addressed as ``you''.
3510 A ``Modified Version'' of the Document means any work containing the
3511 Document or a portion of it, either copied verbatim, or with
3512 modifications and/or translated into another language.
3514 A ``Secondary Section'' is a named appendix or a front-matter section of
3515 the Document that deals exclusively with the relationship of the
3516 publishers or authors of the Document to the Document's overall subject
3517 (or to related matters) and contains nothing that could fall directly
3518 within that overall subject. (For example, if the Document is in part a
3519 textbook of mathematics, a Secondary Section may not explain any
3520 mathematics.) The relationship could be a matter of historical
3521 connection with the subject or with related matters, or of legal,
3522 commercial, philosophical, ethical or political position regarding
3525 The ``Invariant Sections'' are certain Secondary Sections whose titles
3526 are designated, as being those of Invariant Sections, in the notice
3527 that says that the Document is released under this License.
3529 The ``Cover Texts'' are certain short passages of text that are listed,
3530 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3531 the Document is released under this License.
3533 A ``Transparent'' copy of the Document means a machine-readable copy,
3534 represented in a format whose specification is available to the
3535 general public, whose contents can be viewed and edited directly and
3536 straightforwardly with generic text editors or (for images composed of
3537 pixels) generic paint programs or (for drawings) some widely available
3538 drawing editor, and that is suitable for input to text formatters or
3539 for automatic translation to a variety of formats suitable for input
3540 to text formatters. A copy made in an otherwise Transparent file
3541 format whose markup has been designed to thwart or discourage
3542 subsequent modification by readers is not Transparent. A copy that is
3543 not ``Transparent'' is called ``Opaque''.
3545 Examples of suitable formats for Transparent copies include plain
3546 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3547 or XML using a publicly available DTD, and standard-conforming simple
3548 HTML designed for human modification. Opaque formats include
3549 PostScript, PDF, proprietary formats that can be read and edited only
3550 by proprietary word processors, SGML or XML for which the DTD and/or
3551 processing tools are not generally available, and the
3552 machine-generated HTML produced by some word processors for output
3555 The ``Title Page'' means, for a printed book, the title page itself,
3556 plus such following pages as are needed to hold, legibly, the material
3557 this License requires to appear in the title page. For works in
3558 formats which do not have any title page as such, ``Title Page'' means
3559 the text near the most prominent appearance of the work's title,
3560 preceding the beginning of the body of the text.
3565 You may copy and distribute the Document in any medium, either
3566 commercially or noncommercially, provided that this License, the
3567 copyright notices, and the license notice saying this License applies
3568 to the Document are reproduced in all copies, and that you add no other
3569 conditions whatsoever to those of this License. You may not use
3570 technical measures to obstruct or control the reading or further
3571 copying of the copies you make or distribute. However, you may accept
3572 compensation in exchange for copies. If you distribute a large enough
3573 number of copies you must also follow the conditions in section 3.
3575 You may also lend copies, under the same conditions stated above, and
3576 you may publicly display copies.
3581 If you publish printed copies of the Document numbering more than 100,
3582 and the Document's license notice requires Cover Texts, you must enclose
3583 the copies in covers that carry, clearly and legibly, all these Cover
3584 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3585 the back cover. Both covers must also clearly and legibly identify
3586 you as the publisher of these copies. The front cover must present
3587 the full title with all words of the title equally prominent and
3588 visible. You may add other material on the covers in addition.
3589 Copying with changes limited to the covers, as long as they preserve
3590 the title of the Document and satisfy these conditions, can be treated
3591 as verbatim copying in other respects.
3593 If the required texts for either cover are too voluminous to fit
3594 legibly, you should put the first ones listed (as many as fit
3595 reasonably) on the actual cover, and continue the rest onto adjacent
3598 If you publish or distribute Opaque copies of the Document numbering
3599 more than 100, you must either include a machine-readable Transparent
3600 copy along with each Opaque copy, or state in or with each Opaque copy
3601 a publicly-accessible computer-network location containing a complete
3602 Transparent copy of the Document, free of added material, which the
3603 general network-using public has access to download anonymously at no
3604 charge using public-standard network protocols. If you use the latter
3605 option, you must take reasonably prudent steps, when you begin
3606 distribution of Opaque copies in quantity, to ensure that this
3607 Transparent copy will remain thus accessible at the stated location
3608 until at least one year after the last time you distribute an Opaque
3609 copy (directly or through your agents or retailers) of that edition to
3612 It is requested, but not required, that you contact the authors of the
3613 Document well before redistributing any large number of copies, to give
3614 them a chance to provide you with an updated version of the Document.
3619 You may copy and distribute a Modified Version of the Document under
3620 the conditions of sections 2 and 3 above, provided that you release
3621 the Modified Version under precisely this License, with the Modified
3622 Version filling the role of the Document, thus licensing distribution
3623 and modification of the Modified Version to whoever possesses a copy
3624 of it. In addition, you must do these things in the Modified Version:
3626 A. Use in the Title Page (and on the covers, if any) a title distinct
3627 from that of the Document, and from those of previous versions
3628 (which should, if there were any, be listed in the History section
3629 of the Document). You may use the same title as a previous version
3630 if the original publisher of that version gives permission.@*
3631 B. List on the Title Page, as authors, one or more persons or entities
3632 responsible for authorship of the modifications in the Modified
3633 Version, together with at least five of the principal authors of the
3634 Document (all of its principal authors, if it has less than five).@*
3635 C. State on the Title page the name of the publisher of the
3636 Modified Version, as the publisher.@*
3637 D. Preserve all the copyright notices of the Document.@*
3638 E. Add an appropriate copyright notice for your modifications
3639 adjacent to the other copyright notices.@*
3640 F. Include, immediately after the copyright notices, a license notice
3641 giving the public permission to use the Modified Version under the
3642 terms of this License, in the form shown in the Addendum below.@*
3643 G. Preserve in that license notice the full lists of Invariant Sections
3644 and required Cover Texts given in the Document's license notice.@*
3645 H. Include an unaltered copy of this License.@*
3646 I. Preserve the section entitled ``History'', and its title, and add to
3647 it an item stating at least the title, year, new authors, and
3648 publisher of the Modified Version as given on the Title Page. If
3649 there is no section entitled ``History'' in the Document, create one
3650 stating the title, year, authors, and publisher of the Document as
3651 given on its Title Page, then add an item describing the Modified
3652 Version as stated in the previous sentence.@*
3653 J. Preserve the network location, if any, given in the Document for
3654 public access to a Transparent copy of the Document, and likewise
3655 the network locations given in the Document for previous versions
3656 it was based on. These may be placed in the ``History'' section.
3657 You may omit a network location for a work that was published at
3658 least four years before the Document itself, or if the original
3659 publisher of the version it refers to gives permission.@*
3660 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3661 preserve the section's title, and preserve in the section all the
3662 substance and tone of each of the contributor acknowledgements
3663 and/or dedications given therein.@*
3664 L. Preserve all the Invariant Sections of the Document,
3665 unaltered in their text and in their titles. Section numbers
3666 or the equivalent are not considered part of the section titles.@*
3667 M. Delete any section entitled ``Endorsements''. Such a section
3668 may not be included in the Modified Version.@*
3669 N. Do not retitle any existing section as ``Endorsements''
3670 or to conflict in title with any Invariant Section.@*
3672 If the Modified Version includes new front-matter sections or
3673 appendices that qualify as Secondary Sections and contain no material
3674 copied from the Document, you may at your option designate some or all
3675 of these sections as invariant. To do this, add their titles to the
3676 list of Invariant Sections in the Modified Version's license notice.
3677 These titles must be distinct from any other section titles.
3679 You may add a section entitled ``Endorsements'', provided it contains
3680 nothing but endorsements of your Modified Version by various
3681 parties--for example, statements of peer review or that the text has
3682 been approved by an organization as the authoritative definition of a
3685 You may add a passage of up to five words as a Front-Cover Text, and a
3686 passage of up to 25 words as a Back-Cover Text, to the end of the list
3687 of Cover Texts in the Modified Version. Only one passage of
3688 Front-Cover Text and one of Back-Cover Text may be added by (or
3689 through arrangements made by) any one entity. If the Document already
3690 includes a cover text for the same cover, previously added by you or
3691 by arrangement made by the same entity you are acting on behalf of,
3692 you may not add another; but you may replace the old one, on explicit
3693 permission from the previous publisher that added the old one.
3695 The author(s) and publisher(s) of the Document do not by this License
3696 give permission to use their names for publicity for or to assert or
3697 imply endorsement of any Modified Version.
3702 You may combine the Document with other documents released under this
3703 License, under the terms defined in section 4 above for modified
3704 versions, provided that you include in the combination all of the
3705 Invariant Sections of all of the original documents, unmodified, and
3706 list them all as Invariant Sections of your combined work in its
3709 The combined work need only contain one copy of this License, and
3710 multiple identical Invariant Sections may be replaced with a single
3711 copy. If there are multiple Invariant Sections with the same name but
3712 different contents, make the title of each such section unique by
3713 adding at the end of it, in parentheses, the name of the original
3714 author or publisher of that section if known, or else a unique number.
3715 Make the same adjustment to the section titles in the list of
3716 Invariant Sections in the license notice of the combined work.
3718 In the combination, you must combine any sections entitled ``History''
3719 in the various original documents, forming one section entitled
3720 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3721 and any sections entitled ``Dedications''. You must delete all sections
3722 entitled ``Endorsements.''
3725 COLLECTIONS OF DOCUMENTS
3727 You may make a collection consisting of the Document and other documents
3728 released under this License, and replace the individual copies of this
3729 License in the various documents with a single copy that is included in
3730 the collection, provided that you follow the rules of this License for
3731 verbatim copying of each of the documents in all other respects.
3733 You may extract a single document from such a collection, and distribute
3734 it individually under this License, provided you insert a copy of this
3735 License into the extracted document, and follow this License in all
3736 other respects regarding verbatim copying of that document.
3739 AGGREGATION WITH INDEPENDENT WORKS
3741 A compilation of the Document or its derivatives with other separate
3742 and independent documents or works, in or on a volume of a storage or
3743 distribution medium, does not as a whole count as a Modified Version
3744 of the Document, provided no compilation copyright is claimed for the
3745 compilation. Such a compilation is called an ``aggregate'', and this
3746 License does not apply to the other self-contained works thus compiled
3747 with the Document, on account of their being thus compiled, if they
3748 are not themselves derivative works of the Document.
3750 If the Cover Text requirement of section 3 is applicable to these
3751 copies of the Document, then if the Document is less than one quarter
3752 of the entire aggregate, the Document's Cover Texts may be placed on
3753 covers that surround only the Document within the aggregate.
3754 Otherwise they must appear on covers around the whole aggregate.
3759 Translation is considered a kind of modification, so you may
3760 distribute translations of the Document under the terms of section 4.
3761 Replacing Invariant Sections with translations requires special
3762 permission from their copyright holders, but you may include
3763 translations of some or all Invariant Sections in addition to the
3764 original versions of these Invariant Sections. You may include a
3765 translation of this License provided that you also include the
3766 original English version of this License. In case of a disagreement
3767 between the translation and the original English version of this
3768 License, the original English version will prevail.
3773 You may not copy, modify, sublicense, or distribute the Document except
3774 as expressly provided for under this License. Any other attempt to
3775 copy, modify, sublicense or distribute the Document is void, and will
3776 automatically terminate your rights under this License. However,
3777 parties who have received copies, or rights, from you under this
3778 License will not have their licenses terminated so long as such
3779 parties remain in full compliance.
3782 FUTURE REVISIONS OF THIS LICENSE
3784 The Free Software Foundation may publish new, revised versions
3785 of the GNU Free Documentation License from time to time. Such new
3786 versions will be similar in spirit to the present version, but may
3787 differ in detail to address new problems or concerns. See
3788 http://www.gnu.org/copyleft/.
3790 Each version of the License is given a distinguishing version number.
3791 If the Document specifies that a particular numbered version of this
3792 License ``or any later version'' applies to it, you have the option of
3793 following the terms and conditions either of that specified version or
3794 of any later version that has been published (not as a draft) by the
3795 Free Software Foundation. If the Document does not specify a version
3796 number of this License, you may choose any version ever published (not
3797 as a draft) by the Free Software Foundation.
3801 @unnumberedsec ADDENDUM: How to use this License for your documents
3803 To use this License in a document you have written, include a copy of
3804 the License in the document and put the following copyright and
3805 license notices just after the title page:
3810 Copyright (C) @var{year} @var{your name}.
3811 Permission is granted to copy, distribute and/or modify this document
3812 under the terms of the GNU Free Documentation License, Version 1.1
3813 or any later version published by the Free Software Foundation;
3814 with the Invariant Sections being @var{list their titles}, with the
3815 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
3816 A copy of the license is included in the section entitled ``GNU
3817 Free Documentation License''.
3820 If you have no Invariant Sections, write ``with no Invariant Sections''
3821 instead of saying which ones are invariant. If you have no
3822 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
3823 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
3825 If your document contains nontrivial examples of program code, we
3826 recommend releasing these examples in parallel under your choice of
3827 free software license, such as the GNU General Public License,
3828 to permit their use in free software.
3831 @node Concept Index, , Copying, Top
3832 @unnumbered Concept Index