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 Title for man page. The weird way texi2pod.pl is written requires
18 @c the preceding @set.
20 @c man title Wget The non-interactive network downloader.
22 @c This should really be generated automatically, possibly by including
23 @c an auto-generated file.
25 @set UPDATED September 2003
27 @dircategory Net Utilities
28 @dircategory World Wide Web
30 * Wget: (wget). The non-interactive network downloader.
34 This file documents the the GNU Wget utility for downloading network
37 @c man begin COPYRIGHT
38 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001, 2002, 2003 Free
39 Software Foundation, Inc.
41 Permission is granted to make and distribute verbatim copies of
42 this manual provided the copyright notice and this permission notice
43 are preserved on all copies.
46 Permission is granted to process this file through TeX and print the
47 results, provided the printed document carries a copying permission
48 notice identical to this one except for the removal of this paragraph
49 (this paragraph not being relevant to the printed manual).
51 Permission is granted to copy, distribute and/or modify this document
52 under the terms of the GNU Free Documentation License, Version 1.1 or
53 any later version published by the Free Software Foundation; with the
54 Invariant Sections being ``GNU General Public License'' and ``GNU Free
55 Documentation License'', with no Front-Cover Texts, and with no
56 Back-Cover Texts. A copy of the license is included in the section
57 entitled ``GNU Free Documentation License''.
63 @subtitle The noninteractive downloading utility
64 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
65 @author by Hrvoje Nik@v{s}i@'{c} and the developers
69 Originally written by Hrvoje Niksic <hniksic@arsdigita.com>.
72 GNU Info entry for @file{wget}.
77 @vskip 0pt plus 1filll
78 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
81 Permission is granted to copy, distribute and/or modify this document
82 under the terms of the GNU Free Documentation License, Version 1.1 or
83 any later version published by the Free Software Foundation; with the
84 Invariant Sections being ``GNU General Public License'' and ``GNU Free
85 Documentation License'', with no Front-Cover Texts, and with no
86 Back-Cover Texts. A copy of the license is included in the section
87 entitled ``GNU Free Documentation License''.
91 @node Top, Overview, (dir), (dir)
92 @top Wget @value{VERSION}
94 This manual documents version @value{VERSION} of GNU Wget, the freely
95 available utility for network download.
97 Copyright @copyright{} 1996, 1997, 1998, 2000, 2001 Free Software
101 * Overview:: Features of Wget.
102 * Invoking:: Wget command-line arguments.
103 * Recursive Retrieval:: Description of recursive retrieval.
104 * Following Links:: The available methods of chasing links.
105 * Time-Stamping:: Mirroring according to time-stamps.
106 * Startup File:: Wget's initialization file.
107 * Examples:: Examples of usage.
108 * Various:: The stuff that doesn't fit anywhere else.
109 * Appendices:: Some useful references.
110 * Copying:: You may give out copies of Wget and of this manual.
111 * Concept Index:: Topics covered by this manual.
115 @node Overview, Invoking, Top, Top
120 @c man begin DESCRIPTION
121 GNU Wget is a free utility for non-interactive download of files from
122 the Web. It supports @sc{http}, @sc{https}, and @sc{ftp} protocols, as
123 well as retrieval through @sc{http} proxies.
126 This chapter is a partial overview of Wget's features.
130 @c man begin DESCRIPTION
131 Wget is non-interactive, meaning that it can work in the background,
132 while the user is not logged on. This allows you to start a retrieval
133 and disconnect from the system, letting Wget finish the work. By
134 contrast, most of the Web browsers require constant user's presence,
135 which can be a great hindrance when transferring a lot of data.
141 @c man begin DESCRIPTION
145 @c man begin DESCRIPTION
146 Wget can follow links in @sc{html} pages and create local versions of
147 remote web sites, fully recreating the directory structure of the
148 original site. This is sometimes referred to as ``recursive
149 downloading.'' While doing that, Wget respects the Robot Exclusion
150 Standard (@file{/robots.txt}). Wget can be instructed to convert the
151 links in downloaded @sc{html} files to the local files for offline
157 File name wildcard matching and recursive mirroring of directories are
158 available when retrieving via @sc{ftp}. Wget can read the time-stamp
159 information given by both @sc{http} and @sc{ftp} servers, and store it
160 locally. Thus Wget can see if the remote file has changed since last
161 retrieval, and automatically retrieve the new version if it has. This
162 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
168 @c man begin DESCRIPTION
172 @c man begin DESCRIPTION
173 Wget has been designed for robustness over slow or unstable network
174 connections; if a download fails due to a network problem, it will
175 keep retrying until the whole file has been retrieved. If the server
176 supports regetting, it will instruct the server to continue the
177 download from where it left off.
182 Wget supports proxy servers, which can lighten the network load, speed
183 up retrieval and provide access behind firewalls. However, if you are
184 behind a firewall that requires that you use a socks style gateway, you
185 can get the socks library and build Wget with support for socks. Wget
186 also supports the passive @sc{ftp} downloading as an option.
190 Builtin features offer mechanisms to tune which links you wish to follow
191 (@pxref{Following Links}).
195 The retrieval is conveniently traced with printing dots, each dot
196 representing a fixed amount of data received (1KB by default). These
197 representations can be customized to your preferences.
201 Most of the features are fully configurable, either through command line
202 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
203 File}). Wget allows you to define @dfn{global} startup files
204 (@file{/usr/local/etc/wgetrc} by default) for site settings.
209 @item /usr/local/etc/wgetrc
210 Default location of the @dfn{global} startup file.
220 Finally, GNU Wget is free software. This means that everyone may use
221 it, redistribute it and/or modify it under the terms of the GNU General
222 Public License, as published by the Free Software Foundation
226 @node Invoking, Recursive Retrieval, Overview, Top
233 By default, Wget is very simple to invoke. The basic syntax is:
236 @c man begin SYNOPSIS
237 wget [@var{option}]@dots{} [@var{URL}]@dots{}
241 Wget will simply download all the @sc{url}s specified on the command
242 line. @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
244 However, you may wish to change some of the default parameters of
245 Wget. You can do it two ways: permanently, adding the appropriate
246 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
252 * Basic Startup Options::
253 * Logging and Input File Options::
255 * Directory Options::
258 * Recursive Retrieval Options::
259 * Recursive Accept/Reject Options::
262 @node URL Format, Option Syntax, Invoking, Invoking
267 @dfn{URL} is an acronym for Uniform Resource Locator. A uniform
268 resource locator is a compact string representation for a resource
269 available via the Internet. Wget recognizes the @sc{url} syntax as per
270 @sc{rfc1738}. This is the most widely used form (square brackets denote
274 http://host[:port]/directory/file
275 ftp://host[:port]/directory/file
278 You can also encode your username and password within a @sc{url}:
281 ftp://user:password@@host/path
282 http://user:password@@host/path
285 Either @var{user} or @var{password}, or both, may be left out. If you
286 leave out either the @sc{http} username or password, no authentication
287 will be sent. If you leave out the @sc{ftp} username, @samp{anonymous}
288 will be used. If you leave out the @sc{ftp} password, your email
289 address will be supplied as a default password.@footnote{If you have a
290 @file{.netrc} file in your home directory, password will also be
293 @strong{Important Note}: if you specify a password-containing @sc{url}
294 on the command line, the username and password will be plainly visible
295 to all users on the system, by way of @code{ps}. On multi-user systems,
296 this is a big security risk. To work around it, use @code{wget -i -}
297 and feed the @sc{url}s to Wget's standard input, each on a separate
298 line, terminated by @kbd{C-d}.
300 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
301 being the hexadecimal representation of the character's @sc{ascii}
302 value. Some common unsafe characters include @samp{%} (quoted as
303 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
304 @samp{%40}). Refer to @sc{rfc1738} for a comprehensive list of unsafe
307 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s. By
308 default, @sc{ftp} documents are retrieved in the binary mode (type
309 @samp{i}), which means that they are downloaded unchanged. Another
310 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
311 delimiters between the different operating systems, and is thus useful
312 for text files. Here is an example:
315 ftp://host/directory/file;type=a
318 Two alternative variants of @sc{url} specification are also supported,
319 because of historical (hysterical?) reasons and their widespreaded use.
321 @sc{ftp}-only syntax (supported by @code{NcFTP}):
326 @sc{http}-only syntax (introduced by @code{Netscape}):
331 These two alternative forms are deprecated, and may cease being
332 supported in the future.
334 If you do not understand the difference between these notations, or do
335 not know which one to use, just use the plain ordinary format you use
336 with your favorite browser, like @code{Lynx} or @code{Netscape}.
338 @node Option Syntax, Basic Startup Options, URL Format, Invoking
339 @section Option Syntax
340 @cindex option syntax
341 @cindex syntax of options
343 Since Wget uses GNU getopts to process its arguments, every option has a
344 short form and a long form. Long options are more convenient to
345 remember, but take time to type. You may freely mix different option
346 styles, or specify options after the command-line arguments. Thus you
350 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
353 The space between the option accepting an argument and the argument may
354 be omitted. Instead @samp{-o log} you can write @samp{-olog}.
356 You may put several options that do not require arguments together,
363 This is a complete equivalent of:
366 wget -d -r -c @var{URL}
369 Since the options can be specified after the arguments, you may
370 terminate them with @samp{--}. So the following will try to download
371 @sc{url} @samp{-x}, reporting failure to @file{log}:
377 The options that accept comma-separated lists all respect the convention
378 that specifying an empty list clears its value. This can be useful to
379 clear the @file{.wgetrc} settings. For instance, if your @file{.wgetrc}
380 sets @code{exclude_directories} to @file{/cgi-bin}, the following
381 example will first reset it, and then set it to exclude @file{/~nobody}
382 and @file{/~somebody}. You can also clear the lists in @file{.wgetrc}
383 (@pxref{Wgetrc Syntax}).
386 wget -X '' -X /~nobody,/~somebody
391 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
392 @section Basic Startup Options
397 Display the version of Wget.
401 Print a help message describing all of Wget's command-line options.
405 Go to background immediately after startup. If no output file is
406 specified via the @samp{-o}, output is redirected to @file{wget-log}.
408 @cindex execute wgetrc command
409 @item -e @var{command}
410 @itemx --execute @var{command}
411 Execute @var{command} as if it were a part of @file{.wgetrc}
412 (@pxref{Startup File}). A command thus invoked will be executed
413 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
417 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
418 @section Logging and Input File Options
423 @item -o @var{logfile}
424 @itemx --output-file=@var{logfile}
425 Log all messages to @var{logfile}. The messages are normally reported
428 @cindex append to log
429 @item -a @var{logfile}
430 @itemx --append-output=@var{logfile}
431 Append to @var{logfile}. This is the same as @samp{-o}, only it appends
432 to @var{logfile} instead of overwriting the old log file. If
433 @var{logfile} does not exist, a new file is created.
438 Turn on debug output, meaning various information important to the
439 developers of Wget if it does not work properly. Your system
440 administrator may have chosen to compile Wget without debug support, in
441 which case @samp{-d} will not work. Please note that compiling with
442 debug support is always safe---Wget compiled with the debug support will
443 @emph{not} print any debug info unless requested with @samp{-d}.
444 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
450 Turn off Wget's output.
455 Turn on verbose output, with all the available data. The default output
460 Non-verbose output---turn off verbose without being completely quiet
461 (use @samp{-q} for that), which means that error messages and basic
462 information still get printed.
466 @itemx --input-file=@var{file}
467 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
468 the command line. If there are @sc{url}s both on the command line and
469 in an input file, those on the command lines will be the first ones to
470 be retrieved. The @var{file} need not be an @sc{html} document (but no
471 harm if it is)---it is enough if the @sc{url}s are just listed
474 However, if you specify @samp{--force-html}, the document will be
475 regarded as @samp{html}. In that case you may have problems with
476 relative links, which you can solve either by adding @code{<base
477 href="@var{url}">} to the documents or by specifying
478 @samp{--base=@var{url}} on the command line.
483 When input is read from a file, force it to be treated as an @sc{html}
484 file. This enables you to retrieve relative links from existing
485 @sc{html} files on your local disk, by adding @code{<base
486 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
489 @cindex base for relative links in input file
491 @itemx --base=@var{URL}
492 When used in conjunction with @samp{-F}, prepends @var{URL} to relative
493 links in the file specified by @samp{-i}.
496 @node Download Options, Directory Options, Logging and Input File Options, Invoking
497 @section Download Options
500 @cindex bind() address
501 @cindex client IP address
502 @cindex IP address, client
503 @item --bind-address=@var{ADDRESS}
504 When making client TCP/IP connections, @code{bind()} to @var{ADDRESS} on
505 the local machine. @var{ADDRESS} may be specified as a hostname or IP
506 address. This option can be useful if your machine is bound to multiple
511 @cindex number of retries
512 @item -t @var{number}
513 @itemx --tries=@var{number}
514 Set number of retries to @var{number}. Specify 0 or @samp{inf} for
515 infinite retrying. The default is to retry 20 times, with the exception
516 of fatal errors like ``connection refused'' or ``not found'' (404),
517 which are not retried.
520 @itemx --output-document=@var{file}
521 The documents will not be written to the appropriate files, but all will
522 be concatenated together and written to @var{file}. If @var{file}
523 already exists, it will be overwritten. If the @var{file} is @samp{-},
524 the documents will be written to standard output. Including this option
525 automatically sets the number of tries to 1.
527 @cindex clobbering, file
528 @cindex downloading multiple times
532 If a file is downloaded more than once in the same directory, Wget's
533 behavior depends on a few options, including @samp{-nc}. In certain
534 cases, the local file will be @dfn{clobbered}, or overwritten, upon
535 repeated download. In other cases it will be preserved.
537 When running Wget without @samp{-N}, @samp{-nc}, or @samp{-r},
538 downloading the same file in the same directory will result in the
539 original copy of @var{file} being preserved and the second copy being
540 named @samp{@var{file}.1}. If that file is downloaded yet again, the
541 third copy will be named @samp{@var{file}.2}, and so on. When
542 @samp{-nc} is specified, this behavior is suppressed, and Wget will
543 refuse to download newer copies of @samp{@var{file}}. Therefore,
544 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
545 clobbering that's prevented (as the numeric suffixes were already
546 preventing clobbering), but rather the multiple version saving that's
549 When running Wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
550 re-downloading a file will result in the new copy simply overwriting the
551 old. Adding @samp{-nc} will prevent this behavior, instead causing the
552 original version to be preserved and any newer copies on the server to
555 When running Wget with @samp{-N}, with or without @samp{-r}, the
556 decision as to whether or not to download a newer copy of a file depends
557 on the local and remote timestamp and size of the file
558 (@pxref{Time-Stamping}). @samp{-nc} may not be specified at the same
561 Note that when @samp{-nc} is specified, files with the suffixes
562 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
563 and parsed as if they had been retrieved from the Web.
565 @cindex continue retrieval
566 @cindex incomplete downloads
567 @cindex resume download
570 Continue getting a partially-downloaded file. This is useful when you
571 want to finish up a download started by a previous instance of Wget, or
572 by another program. For instance:
575 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
578 If there is a file named @file{ls-lR.Z} in the current directory, Wget
579 will assume that it is the first portion of the remote file, and will
580 ask the server to continue the retrieval from an offset equal to the
581 length of the local file.
583 Note that you don't need to specify this option if you just want the
584 current invocation of Wget to retry downloading a file should the
585 connection be lost midway through. This is the default behavior.
586 @samp{-c} only affects resumption of downloads started @emph{prior} to
587 this invocation of Wget, and whose local files are still sitting around.
589 Without @samp{-c}, the previous example would just download the remote
590 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
593 Beginning with Wget 1.7, if you use @samp{-c} on a non-empty file, and
594 it turns out that the server does not support continued downloading,
595 Wget will refuse to start the download from scratch, which would
596 effectively ruin existing contents. If you really want the download to
597 start from scratch, remove the file.
599 Also beginning with Wget 1.7, if you use @samp{-c} on a file which is of
600 equal size as the one on the server, Wget will refuse to download the
601 file and print an explanatory message. The same happens when the file
602 is smaller on the server than locally (presumably because it was changed
603 on the server since your last download attempt)---because ``continuing''
604 is not meaningful, no download occurs.
606 On the other side of the coin, while using @samp{-c}, any file that's
607 bigger on the server than locally will be considered an incomplete
608 download and only @code{(length(remote) - length(local))} bytes will be
609 downloaded and tacked onto the end of the local file. This behavior can
610 be desirable in certain cases---for instance, you can use @samp{wget -c}
611 to download just the new portion that's been appended to a data
612 collection or log file.
614 However, if the file is bigger on the server because it's been
615 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
616 with a garbled file. Wget has no way of verifying that the local file
617 is really a valid prefix of the remote file. You need to be especially
618 careful of this when using @samp{-c} in conjunction with @samp{-r},
619 since every file will be considered as an "incomplete download" candidate.
621 Another instance where you'll get a garbled file if you try to use
622 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
623 ``transfer interrupted'' string into the local file. In the future a
624 ``rollback'' option may be added to deal with this case.
626 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
627 servers that support the @code{Range} header.
629 @cindex progress indicator
631 @item --progress=@var{type}
632 Select the type of the progress indicator you wish to use. Legal
633 indicators are ``dot'' and ``bar''.
635 The ``bar'' indicator is used by default. It draws an ASCII progress
636 bar graphics (a.k.a ``thermometer'' display) indicating the status of
637 retrieval. If the output is not a TTY, the ``dot'' bar will be used by
640 Use @samp{--progress=dot} to switch to the ``dot'' display. It traces
641 the retrieval by printing dots on the screen, each dot representing a
642 fixed amount of downloaded data.
644 When using the dotted retrieval, you may also set the @dfn{style} by
645 specifying the type as @samp{dot:@var{style}}. Different styles assign
646 different meaning to one dot. With the @code{default} style each dot
647 represents 1K, there are ten dots in a cluster and 50 dots in a line.
648 The @code{binary} style has a more ``computer''-like orientation---8K
649 dots, 16-dots clusters and 48 dots per line (which makes for 384K
650 lines). The @code{mega} style is suitable for downloading very large
651 files---each dot represents 64K retrieved, there are eight dots in a
652 cluster, and 48 dots on each line (so each line contains 3M).
654 Note that you can set the default style using the @code{progress}
655 command in @file{.wgetrc}. That setting may be overridden from the
656 command line. The exception is that, when the output is not a TTY, the
657 ``dot'' progress will be favored over ``bar''. To force the bar output,
658 use @samp{--progress=bar:force}.
661 @itemx --timestamping
662 Turn on time-stamping. @xref{Time-Stamping}, for details.
664 @cindex server response, print
666 @itemx --server-response
667 Print the headers sent by @sc{http} servers and responses sent by
670 @cindex Wget as spider
673 When invoked with this option, Wget will behave as a Web @dfn{spider},
674 which means that it will not download the pages, just check that they
675 are there. You can use it to check your bookmarks, e.g. with:
678 wget --spider --force-html -i bookmarks.html
681 This feature needs much more work for Wget to get close to the
682 functionality of real @sc{www} spiders.
686 @itemx --timeout=@var{seconds}
687 Set the network timeouts to @var{seconds} seconds. This is equivalent
688 to specifying @samp{--dns-timeout}, @samp{--connect-timeout}, and
689 @samp{--read-timeout}, all at the same time.
691 Whenever Wget connects to or reads from a remote host, it checks for a
692 timeout and aborts the operation if the time expires. This prevents
693 anomalous occurrences such as hanging reads or infinite connects. The
694 only timeout enabled by default is a 900-second timeout for reading.
695 Setting timeout to 0 disables checking for timeouts.
697 Unless you know what you are doing, it is best not to set any of the
698 timeout-related options.
702 @item --dns-timeout=@var{seconds}
703 Set the DNS lookup timeout to @var{seconds} seconds. DNS lookups that
704 don't complete within the specified time will fail. By default, there
705 is no timeout on DNS lookups, other than that implemented by system
708 @cindex connect timeout
709 @cindex timeout, connect
710 @item --connect-timeout=@var{seconds}
711 Set the connect timeout to @var{seconds} seconds. TCP connections that
712 take longer to establish will be aborted. By default, there is no
713 connect timeout, other than that implemented by system libraries.
716 @cindex timeout, read
717 @item --read-timeout=@var{seconds}
718 Set the read (and write) timeout to @var{seconds} seconds. Reads that
719 take longer will fail. The default value for read timeout is 900
722 @cindex bandwidth, limit
724 @cindex limit bandwidth
725 @item --limit-rate=@var{amount}
726 Limit the download speed to @var{amount} bytes per second. Amount may
727 be expressed in bytes, kilobytes with the @samp{k} suffix, or megabytes
728 with the @samp{m} suffix. For example, @samp{--limit-rate=20k} will
729 limit the retrieval rate to 20KB/s. This kind of thing is useful when,
730 for whatever reason, you don't want Wget to consume the entire available
733 Note that Wget implements the limiting by sleeping the appropriate
734 amount of time after a network read that took less time than specified
735 by the rate. Eventually this strategy causes the TCP transfer to slow
736 down to approximately the specified rate. However, it may take some
737 time for this balance to be achieved, so don't be surprised if limiting
738 the rate doesn't work well with very small files.
742 @item -w @var{seconds}
743 @itemx --wait=@var{seconds}
744 Wait the specified number of seconds between the retrievals. Use of
745 this option is recommended, as it lightens the server load by making the
746 requests less frequent. Instead of in seconds, the time can be
747 specified in minutes using the @code{m} suffix, in hours using @code{h}
748 suffix, or in days using @code{d} suffix.
750 Specifying a large value for this option is useful if the network or the
751 destination host is down, so that Wget can wait long enough to
752 reasonably expect the network error to be fixed before the retry.
754 @cindex retries, waiting between
755 @cindex waiting between retries
756 @item --waitretry=@var{seconds}
757 If you don't want Wget to wait between @emph{every} retrieval, but only
758 between retries of failed downloads, you can use this option. Wget will
759 use @dfn{linear backoff}, waiting 1 second after the first failure on a
760 given file, then waiting 2 seconds after the second failure on that
761 file, up to the maximum number of @var{seconds} you specify. Therefore,
762 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
765 Note that this option is turned on by default in the global
771 Some web sites may perform log analysis to identify retrieval programs
772 such as Wget by looking for statistically significant similarities in
773 the time between requests. This option causes the time between requests
774 to vary between 0 and 2 * @var{wait} seconds, where @var{wait} was
775 specified using the @samp{-w} or @samp{--wait} options, in order to mask
776 Wget's presence from such analysis.
778 A recent article in a publication devoted to development on a popular
779 consumer platform provided code to perform this analysis on the fly.
780 Its author suggested blocking at the class C address level to ensure
781 automated retrieval programs were blocked despite changing DHCP-supplied
784 The @samp{--random-wait} option was inspired by this ill-advised
785 recommendation to block many unrelated users from a web site due to the
790 @itemx --proxy=on/off
791 Turn proxy support on or off. The proxy is on by default if the
792 appropriate environment variable is defined.
794 For more information about the use of proxies with Wget, @xref{Proxies}.
798 @itemx --quota=@var{quota}
799 Specify download quota for automatic retrievals. The value can be
800 specified in bytes (default), kilobytes (with @samp{k} suffix), or
801 megabytes (with @samp{m} suffix).
803 Note that quota will never affect downloading a single file. So if you
804 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
805 @file{ls-lR.gz} will be downloaded. The same goes even when several
806 @sc{url}s are specified on the command-line. However, quota is
807 respected when retrieving either recursively, or from an input file.
808 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
809 aborted when the quota is exceeded.
811 Setting quota to 0 or to @samp{inf} unlimits the download quota.
814 @cindex caching of DNS lookups
815 @item --dns-cache=off
816 Turn off caching of DNS lookups. Normally, Wget remembers the addresses
817 it looked up from DNS so it doesn't have to repeatedly contact the DNS
818 server for the same (typically small) set of addresses it retrieves
819 from. This cache exists in memory only; a new Wget run will contact DNS
822 However, in some cases it is not desirable to cache host names, even for
823 the duration of a short-running application like Wget. For example,
824 some HTTP servers are hosted on machines with dynamically allocated IP
825 addresses that change from time to time. Their DNS entries are updated
826 along with each change. When Wget's download from such a host gets
827 interrupted by IP address change, Wget retries the download, but (due to
828 DNS caching) it contacts the old address. With the DNS cache turned
829 off, Wget will repeat the DNS lookup for every connect and will thus get
830 the correct dynamic address every time---at the cost of additional DNS
831 lookups where they're probably not needed.
833 If you don't understand the above description, you probably won't need
836 @cindex file names, restrict
837 @cindex Windows file names
838 @item --restrict-file-names=@var{mode}
839 Change which characters found in remote URLs may show up in local file
840 names generated from those URLs. Characters that are @dfn{restricted}
841 by this option are escaped, i.e. replaced with @samp{%HH}, where
842 @samp{HH} is the hexadecimal number that corresponds to the restricted
845 By default, Wget escapes the characters that are not valid as part of
846 file names on your operating system, as well as control characters that
847 are typically unprintable. This option is useful for changing these
848 defaults, either because you are downloading to a non-native partition,
849 or because you want to disable escaping of the control characters.
851 When mode is set to ``unix'', Wget escapes the character @samp{/} and
852 the control characters in the ranges 0--31 and 128--159. This is the
853 default on Unix-like OS'es.
855 When mode is seto to ``windows'', Wget escapes the characters @samp{\},
856 @samp{|}, @samp{/}, @samp{:}, @samp{?}, @samp{"}, @samp{*}, @samp{<},
857 @samp{>}, and the control characters in the ranges 0--31 and 128--159.
858 In addition to this, Wget in Windows mode uses @samp{+} instead of
859 @samp{:} to separate host and port in local file names, and uses
860 @samp{@@} instead of @samp{?} to separate the query portion of the file
861 name from the rest. Therefore, a URL that would be saved as
862 @samp{www.xemacs.org:4300/search.pl?input=blah} in Unix mode would be
863 saved as @samp{www.xemacs.org+4300/search.pl@@input=blah} in Windows
864 mode. This mode is the default on Windows.
866 If you append @samp{,nocontrol} to the mode, as in
867 @samp{unix,nocontrol}, escaping of the control characters is also
868 switched off. You can use @samp{--restrict-file-names=nocontrol} to
869 turn off escaping of control characters without affecting the choice of
870 the OS to use as file name restriction mode.
873 @node Directory Options, HTTP Options, Download Options, Invoking
874 @section Directory Options
878 @itemx --no-directories
879 Do not create a hierarchy of directories when retrieving recursively.
880 With this option turned on, all files will get saved to the current
881 directory, without clobbering (if a name shows up more than once, the
882 filenames will get extensions @samp{.n}).
885 @itemx --force-directories
886 The opposite of @samp{-nd}---create a hierarchy of directories, even if
887 one would not have been created otherwise. E.g. @samp{wget -x
888 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
889 @file{fly.srk.fer.hr/robots.txt}.
892 @itemx --no-host-directories
893 Disable generation of host-prefixed directories. By default, invoking
894 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
895 directories beginning with @file{fly.srk.fer.hr/}. This option disables
898 @cindex cut directories
899 @item --cut-dirs=@var{number}
900 Ignore @var{number} directory components. This is useful for getting a
901 fine-grained control over the directory where recursive retrieval will
904 Take, for example, the directory at
905 @samp{ftp://ftp.xemacs.org/pub/xemacs/}. If you retrieve it with
906 @samp{-r}, it will be saved locally under
907 @file{ftp.xemacs.org/pub/xemacs/}. While the @samp{-nH} option can
908 remove the @file{ftp.xemacs.org/} part, you are still stuck with
909 @file{pub/xemacs}. This is where @samp{--cut-dirs} comes in handy; it
910 makes Wget not ``see'' @var{number} remote directory components. Here
911 are several examples of how @samp{--cut-dirs} option works.
915 No options -> ftp.xemacs.org/pub/xemacs/
917 -nH --cut-dirs=1 -> xemacs/
918 -nH --cut-dirs=2 -> .
920 --cut-dirs=1 -> ftp.xemacs.org/xemacs/
925 If you just want to get rid of the directory structure, this option is
926 similar to a combination of @samp{-nd} and @samp{-P}. However, unlike
927 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
928 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
929 be placed to @file{xemacs/beta}, as one would expect.
931 @cindex directory prefix
932 @item -P @var{prefix}
933 @itemx --directory-prefix=@var{prefix}
934 Set directory prefix to @var{prefix}. The @dfn{directory prefix} is the
935 directory where all other files and subdirectories will be saved to,
936 i.e. the top of the retrieval tree. The default is @samp{.} (the
940 @node HTTP Options, FTP Options, Directory Options, Invoking
941 @section HTTP Options
944 @cindex .html extension
946 @itemx --html-extension
947 If a file of type @samp{text/html} is downloaded and the URL does not
948 end with the regexp @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause
949 the suffix @samp{.html} to be appended to the local filename. This is
950 useful, for instance, when you're mirroring a remote site that uses
951 @samp{.asp} pages, but you want the mirrored pages to be viewable on
952 your stock Apache server. Another good use for this is when you're
953 downloading the output of CGIs. A URL like
954 @samp{http://site.com/article.cgi?25} will be saved as
955 @file{article.cgi?25.html}.
957 Note that filenames changed in this way will be re-downloaded every time
958 you re-mirror a site, because Wget can't tell that the local
959 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
960 it doesn't yet know that the URL produces output of type
961 @samp{text/html}. To prevent this re-downloading, you must use
962 @samp{-k} and @samp{-K} so that the original version of the file will be
963 saved as @file{@var{X}.orig} (@pxref{Recursive Retrieval Options}).
966 @cindex http password
967 @cindex authentication
968 @item --http-user=@var{user}
969 @itemx --http-passwd=@var{password}
970 Specify the username @var{user} and password @var{password} on an
971 @sc{http} server. According to the type of the challenge, Wget will
972 encode them using either the @code{basic} (insecure) or the
973 @code{digest} authentication scheme.
975 Another way to specify username and password is in the @sc{url} itself
976 (@pxref{URL Format}). Either method reveals your password to anyone who
977 bothers to run @code{ps}. To prevent the passwords from being seen,
978 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
979 those files from other users with @code{chmod}. If the passwords are
980 really important, do not leave them lying in those files either---edit
981 the files and delete them after Wget has started the download.
983 For more information about security issues with Wget, @xref{Security
989 @itemx --cache=on/off
990 When set to off, disable server-side cache. In this case, Wget will
991 send the remote server an appropriate directive (@samp{Pragma:
992 no-cache}) to get the file from the remote service, rather than
993 returning the cached version. This is especially useful for retrieving
994 and flushing out-of-date documents on proxy servers.
996 Caching is allowed by default.
999 @item --cookies=on/off
1000 When set to off, disable the use of cookies. Cookies are a mechanism
1001 for maintaining server-side state. The server sends the client a cookie
1002 using the @code{Set-Cookie} header, and the client responds with the
1003 same cookie upon further requests. Since cookies allow the server
1004 owners to keep track of visitors and for sites to exchange this
1005 information, some consider them a breach of privacy. The default is to
1006 use cookies; however, @emph{storing} cookies is not on by default.
1008 @cindex loading cookies
1009 @cindex cookies, loading
1010 @item --load-cookies @var{file}
1011 Load cookies from @var{file} before the first HTTP retrieval.
1012 @var{file} is a textual file in the format originally used by Netscape's
1013 @file{cookies.txt} file.
1015 You will typically use this option when mirroring sites that require
1016 that you be logged in to access some or all of their content. The login
1017 process typically works by the web server issuing an @sc{http} cookie
1018 upon receiving and verifying your credentials. The cookie is then
1019 resent by the browser when accessing that part of the site, and so
1020 proves your identity.
1022 Mirroring such a site requires Wget to send the same cookies your
1023 browser sends when communicating with the site. This is achieved by
1024 @samp{--load-cookies}---simply point Wget to the location of the
1025 @file{cookies.txt} file, and it will send the same cookies your browser
1026 would send in the same situation. Different browsers keep textual
1027 cookie files in different locations:
1031 The cookies are in @file{~/.netscape/cookies.txt}.
1033 @item Mozilla and Netscape 6.x.
1034 Mozilla's cookie file is also named @file{cookies.txt}, located
1035 somewhere under @file{~/.mozilla}, in the directory of your profile.
1036 The full path usually ends up looking somewhat like
1037 @file{~/.mozilla/default/@var{some-weird-string}/cookies.txt}.
1039 @item Internet Explorer.
1040 You can produce a cookie file Wget can use by using the File menu,
1041 Import and Export, Export Cookies. This has been tested with Internet
1042 Explorer 5; it is not guaranteed to work with earlier versions.
1044 @item Other browsers.
1045 If you are using a different browser to create your cookies,
1046 @samp{--load-cookies} will only work if you can locate or produce a
1047 cookie file in the Netscape format that Wget expects.
1050 If you cannot use @samp{--load-cookies}, there might still be an
1051 alternative. If your browser supports a ``cookie manager'', you can use
1052 it to view the cookies used when accessing the site you're mirroring.
1053 Write down the name and value of the cookie, and manually instruct Wget
1054 to send those cookies, bypassing the ``official'' cookie support:
1057 wget --cookies=off --header "Cookie: @var{name}=@var{value}"
1060 @cindex saving cookies
1061 @cindex cookies, saving
1062 @item --save-cookies @var{file}
1063 Save cookies from @var{file} at the end of session. Cookies whose
1064 expiry time is not specified, or those that have already expired, are
1067 @cindex Content-Length, ignore
1068 @cindex ignore length
1069 @item --ignore-length
1070 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
1071 precise) send out bogus @code{Content-Length} headers, which makes Wget
1072 go wild, as it thinks not all the document was retrieved. You can spot
1073 this syndrome if Wget retries getting the same document again and again,
1074 each time claiming that the (otherwise normal) connection has closed on
1077 With this option, Wget will ignore the @code{Content-Length} header---as
1078 if it never existed.
1081 @item --header=@var{additional-header}
1082 Define an @var{additional-header} to be passed to the @sc{http} servers.
1083 Headers must contain a @samp{:} preceded by one or more non-blank
1084 characters, and must not contain newlines.
1086 You may define more than one additional header by specifying
1087 @samp{--header} more than once.
1091 wget --header='Accept-Charset: iso-8859-2' \
1092 --header='Accept-Language: hr' \
1093 http://fly.srk.fer.hr/
1097 Specification of an empty string as the header value will clear all
1098 previous user-defined headers.
1101 @cindex proxy password
1102 @cindex proxy authentication
1103 @item --proxy-user=@var{user}
1104 @itemx --proxy-passwd=@var{password}
1105 Specify the username @var{user} and password @var{password} for
1106 authentication on a proxy server. Wget will encode them using the
1107 @code{basic} authentication scheme.
1109 Security considerations similar to those with @samp{--http-passwd}
1110 pertain here as well.
1112 @cindex http referer
1113 @cindex referer, http
1114 @item --referer=@var{url}
1115 Include `Referer: @var{url}' header in HTTP request. Useful for
1116 retrieving documents with server-side processing that assume they are
1117 always being retrieved by interactive web browsers and only come out
1118 properly when Referer is set to one of the pages that point to them.
1120 @cindex server response, save
1122 @itemx --save-headers
1123 Save the headers sent by the @sc{http} server to the file, preceding the
1124 actual contents, with an empty line as the separator.
1127 @item -U @var{agent-string}
1128 @itemx --user-agent=@var{agent-string}
1129 Identify as @var{agent-string} to the @sc{http} server.
1131 The @sc{http} protocol allows the clients to identify themselves using a
1132 @code{User-Agent} header field. This enables distinguishing the
1133 @sc{www} software, usually for statistical purposes or for tracing of
1134 protocol violations. Wget normally identifies as
1135 @samp{Wget/@var{version}}, @var{version} being the current version
1138 However, some sites have been known to impose the policy of tailoring
1139 the output according to the @code{User-Agent}-supplied information.
1140 While conceptually this is not such a bad idea, it has been abused by
1141 servers denying information to clients other than @code{Mozilla} or
1142 Microsoft @code{Internet Explorer}. This option allows you to change
1143 the @code{User-Agent} line issued by Wget. Use of this option is
1144 discouraged, unless you really know what you are doing.
1147 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
1148 @section FTP Options
1151 @cindex .listing files, removing
1153 @itemx --dont-remove-listing
1154 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1155 retrievals. Normally, these files contain the raw directory listings
1156 received from @sc{ftp} servers. Not removing them can be useful for
1157 debugging purposes, or when you want to be able to easily check on the
1158 contents of remote server directories (e.g. to verify that a mirror
1159 you're running is complete).
1161 Note that even though Wget writes to a known filename for this file,
1162 this is not a security hole in the scenario of a user making
1163 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1164 asking @code{root} to run Wget in his or her directory. Depending on
1165 the options used, either Wget will refuse to write to @file{.listing},
1166 making the globbing/recursion/time-stamping operation fail, or the
1167 symbolic link will be deleted and replaced with the actual
1168 @file{.listing} file, or the listing will be written to a
1169 @file{.listing.@var{number}} file.
1171 Even though this situation isn't a problem, though, @code{root} should
1172 never run Wget in a non-trusted user's directory. A user could do
1173 something as simple as linking @file{index.html} to @file{/etc/passwd}
1174 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1175 will be overwritten.
1177 @cindex globbing, toggle
1179 @itemx --glob=on/off
1180 Turn @sc{ftp} globbing on or off. Globbing means you may use the
1181 shell-like special characters (@dfn{wildcards}), like @samp{*},
1182 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
1183 same directory at once, like:
1186 wget ftp://gnjilux.srk.fer.hr/*.msg
1189 By default, globbing will be turned on if the @sc{url} contains a
1190 globbing character. This option may be used to turn globbing on or off
1193 You may have to quote the @sc{url} to protect it from being expanded by
1194 your shell. Globbing makes Wget look for a directory listing, which is
1195 system-specific. This is why it currently works only with Unix @sc{ftp}
1196 servers (and the ones emulating Unix @code{ls} output).
1200 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
1201 initiates the data connection. This is sometimes required for @sc{ftp}
1202 to work behind firewalls.
1204 @cindex symbolic links, retrieving
1205 @item --retr-symlinks
1206 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1207 link is encountered, the linked-to file is not downloaded. Instead, a
1208 matching symbolic link is created on the local filesystem. The
1209 pointed-to file will not be downloaded unless this recursive retrieval
1210 would have encountered it separately and downloaded it anyway.
1212 When @samp{--retr-symlinks} is specified, however, symbolic links are
1213 traversed and the pointed-to files are retrieved. At this time, this
1214 option does not cause Wget to traverse symlinks to directories and
1215 recurse through them, but in the future it should be enhanced to do
1218 Note that when retrieving a file (not a directory) because it was
1219 specified on the commandline, rather than because it was recursed to,
1220 this option has no effect. Symbolic links are always traversed in this
1224 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
1225 @section Recursive Retrieval Options
1230 Turn on recursive retrieving. @xref{Recursive Retrieval}, for more
1233 @item -l @var{depth}
1234 @itemx --level=@var{depth}
1235 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1236 Retrieval}). The default maximum depth is 5.
1238 @cindex proxy filling
1239 @cindex delete after retrieval
1240 @cindex filling proxy cache
1241 @item --delete-after
1242 This option tells Wget to delete every single file it downloads,
1243 @emph{after} having done so. It is useful for pre-fetching popular
1244 pages through a proxy, e.g.:
1247 wget -r -nd --delete-after http://whatever.com/~popular/page/
1250 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1253 Note that @samp{--delete-after} deletes files on the local machine. It
1254 does not issue the @samp{DELE} command to remote FTP sites, for
1255 instance. Also note that when @samp{--delete-after} is specified,
1256 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1257 created in the first place.
1259 @cindex conversion of links
1260 @cindex link conversion
1262 @itemx --convert-links
1263 After the download is complete, convert the links in the document to
1264 make them suitable for local viewing. This affects not only the visible
1265 hyperlinks, but any part of the document that links to external content,
1266 such as embedded images, links to style sheets, hyperlinks to non-HTML
1269 Each link will be changed in one of the two ways:
1273 The links to files that have been downloaded by Wget will be changed to
1274 refer to the file they point to as a relative link.
1276 Example: if the downloaded file @file{/foo/doc.html} links to
1277 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1278 will be modified to point to @samp{../bar/img.gif}. This kind of
1279 transformation works reliably for arbitrary combinations of directories.
1282 The links to files that have not been downloaded by Wget will be changed
1283 to include host name and absolute path of the location they point to.
1285 Example: if the downloaded file @file{/foo/doc.html} links to
1286 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1287 @file{doc.html} will be modified to point to
1288 @file{http://@var{hostname}/bar/img.gif}.
1291 Because of this, local browsing works reliably: if a linked file was
1292 downloaded, the link will refer to its local name; if it was not
1293 downloaded, the link will refer to its full Internet address rather than
1294 presenting a broken link. The fact that the former links are converted
1295 to relative links ensures that you can move the downloaded hierarchy to
1298 Note that only at the end of the download can Wget know which links have
1299 been downloaded. Because of that, the work done by @samp{-k} will be
1300 performed at the end of all the downloads.
1302 @cindex backing up converted files
1304 @itemx --backup-converted
1305 When converting a file, back up the original version with a @samp{.orig}
1306 suffix. Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1311 Turn on options suitable for mirroring. This option turns on recursion
1312 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1313 directory listings. It is currently equivalent to
1314 @samp{-r -N -l inf -nr}.
1316 @cindex page requisites
1317 @cindex required images, downloading
1319 @itemx --page-requisites
1320 This option causes Wget to download all the files that are necessary to
1321 properly display a given HTML page. This includes such things as
1322 inlined images, sounds, and referenced stylesheets.
1324 Ordinarily, when downloading a single HTML page, any requisite documents
1325 that may be needed to display it properly are not downloaded. Using
1326 @samp{-r} together with @samp{-l} can help, but since Wget does not
1327 ordinarily distinguish between external and inlined documents, one is
1328 generally left with ``leaf documents'' that are missing their
1331 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1332 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1333 document @file{2.html}. Say that @file{2.html} is similar but that its
1334 image is @file{2.gif} and it links to @file{3.html}. Say this
1335 continues up to some arbitrarily high number.
1337 If one executes the command:
1340 wget -r -l 2 http://@var{site}/1.html
1343 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1344 @file{3.html} will be downloaded. As you can see, @file{3.html} is
1345 without its requisite @file{3.gif} because Wget is simply counting the
1346 number of hops (up to 2) away from @file{1.html} in order to determine
1347 where to stop the recursion. However, with this command:
1350 wget -r -l 2 -p http://@var{site}/1.html
1353 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1354 will be downloaded. Similarly,
1357 wget -r -l 1 -p http://@var{site}/1.html
1360 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1361 to be downloaded. One might think that:
1364 wget -r -l 0 -p http://@var{site}/1.html
1367 would download just @file{1.html} and @file{1.gif}, but unfortunately
1368 this is not the case, because @samp{-l 0} is equivalent to
1369 @samp{-l inf}---that is, infinite recursion. To download a single HTML
1370 page (or a handful of them, all specified on the commandline or in a
1371 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1372 @samp{-r} and @samp{-l}:
1375 wget -p http://@var{site}/1.html
1378 Note that Wget will behave as if @samp{-r} had been specified, but only
1379 that single page and its requisites will be downloaded. Links from that
1380 page to external documents will not be followed. Actually, to download
1381 a single page and all its requisites (even if they exist on separate
1382 websites), and make sure the lot displays properly locally, this author
1383 likes to use a few options in addition to @samp{-p}:
1386 wget -E -H -k -K -p http://@var{site}/@var{document}
1389 To finish off this topic, it's worth knowing that Wget's idea of an
1390 external document link is any URL specified in an @code{<A>} tag, an
1391 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1394 @cindex HTML comments
1395 @cindex comments, HTML
1396 @item --strict-comments
1397 Turn on strict parsing of HTML comments. The default is to terminate
1398 comments at the first occurrence of @samp{-->}.
1400 According to specifications, HTML comments are expressed as SGML
1401 @dfn{declarations}. Declaration is special markup that begins with
1402 @samp{<!} and ends with @samp{>}, such as @samp{<!DOCTYPE ...>}, that
1403 may contain comments between a pair of @samp{--} delimiters. HTML
1404 comments are ``empty declarations'', SGML declarations without any
1405 non-comment text. Therefore, @samp{<!--foo-->} is a valid comment, and
1406 so is @samp{<!--one-- --two-->}, but @samp{<!--1--2-->} is not.
1408 On the other hand, most HTML writers don't perceive comments as anything
1409 other than text delimited with @samp{<!--} and @samp{-->}, which is not
1410 quite the same. For example, something like @samp{<!------------>}
1411 works as a valid comment as long as the number of dashes is a multiple
1412 of four (!). If not, the comment technically lasts until the next
1413 @samp{--}, which may be at the other end of the document. Because of
1414 this, many popular browsers completely ignore the specification and
1415 implement what users have come to expect: comments delimited with
1416 @samp{<!--} and @samp{-->}.
1418 Until version 1.9, Wget interpreted comments strictly, which resulted in
1419 missing links in many web pages that displayed fine in browsers, but had
1420 the misfortune of containing non-compliant comments. Beginning with
1421 version 1.9, Wget has joined the ranks of clients that implements
1422 ``naive'' comments, terminating each comment at the first occurrence of
1425 If, for whatever reason, you want strict comment parsing, use this
1426 option to turn it on.
1429 @node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking
1430 @section Recursive Accept/Reject Options
1433 @item -A @var{acclist} --accept @var{acclist}
1434 @itemx -R @var{rejlist} --reject @var{rejlist}
1435 Specify comma-separated lists of file name suffixes or patterns to
1436 accept or reject (@pxref{Types of Files} for more details).
1438 @item -D @var{domain-list}
1439 @itemx --domains=@var{domain-list}
1440 Set domains to be followed. @var{domain-list} is a comma-separated list
1441 of domains. Note that it does @emph{not} turn on @samp{-H}.
1443 @item --exclude-domains @var{domain-list}
1444 Specify the domains that are @emph{not} to be followed.
1445 (@pxref{Spanning Hosts}).
1447 @cindex follow FTP links
1449 Follow @sc{ftp} links from @sc{html} documents. Without this option,
1450 Wget will ignore all the @sc{ftp} links.
1452 @cindex tag-based recursive pruning
1453 @item --follow-tags=@var{list}
1454 Wget has an internal table of HTML tag / attribute pairs that it
1455 considers when looking for linked documents during a recursive
1456 retrieval. If a user wants only a subset of those tags to be
1457 considered, however, he or she should be specify such tags in a
1458 comma-separated @var{list} with this option.
1461 @itemx --ignore-tags=@var{list}
1462 This is the opposite of the @samp{--follow-tags} option. To skip
1463 certain HTML tags when recursively looking for documents to download,
1464 specify them in a comma-separated @var{list}.
1466 In the past, the @samp{-G} option was the best bet for downloading a
1467 single page and its requisites, using a commandline like:
1470 wget -Ga,area -H -k -K -r http://@var{site}/@var{document}
1473 However, the author of this option came across a page with tags like
1474 @code{<LINK REL="home" HREF="/">} and came to the realization that
1475 @samp{-G} was not enough. One can't just tell Wget to ignore
1476 @code{<LINK>}, because then stylesheets will not be downloaded. Now the
1477 best bet for downloading a single page and its requisites is the
1478 dedicated @samp{--page-requisites} option.
1482 Enable spanning across hosts when doing recursive retrieving
1483 (@pxref{Spanning Hosts}).
1487 Follow relative links only. Useful for retrieving a specific home page
1488 without any distractions, not even those from the same hosts
1489 (@pxref{Relative Links}).
1492 @itemx --include-directories=@var{list}
1493 Specify a comma-separated list of directories you wish to follow when
1494 downloading (@pxref{Directory-Based Limits} for more details.) Elements
1495 of @var{list} may contain wildcards.
1498 @itemx --exclude-directories=@var{list}
1499 Specify a comma-separated list of directories you wish to exclude from
1500 download (@pxref{Directory-Based Limits} for more details.) Elements of
1501 @var{list} may contain wildcards.
1505 Do not ever ascend to the parent directory when retrieving recursively.
1506 This is a useful option, since it guarantees that only the files
1507 @emph{below} a certain hierarchy will be downloaded.
1508 @xref{Directory-Based Limits}, for more details.
1513 @node Recursive Retrieval, Following Links, Invoking, Top
1514 @chapter Recursive Retrieval
1517 @cindex recursive retrieval
1519 GNU Wget is capable of traversing parts of the Web (or a single
1520 @sc{http} or @sc{ftp} server), following links and directory structure.
1521 We refer to this as to @dfn{recursive retrieving}, or @dfn{recursion}.
1523 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1524 the given @sc{url}, documents, retrieving the files the @sc{html}
1525 document was referring to, through markups like @code{href}, or
1526 @code{src}. If the freshly downloaded file is also of type
1527 @code{text/html}, it will be parsed and followed further.
1529 Recursive retrieval of @sc{http} and @sc{html} content is
1530 @dfn{breadth-first}. This means that Wget first downloads the requested
1531 HTML document, then the documents linked from that document, then the
1532 documents linked by them, and so on. In other words, Wget first
1533 downloads the documents at depth 1, then those at depth 2, and so on
1534 until the specified maximum depth.
1536 The maximum @dfn{depth} to which the retrieval may descend is specified
1537 with the @samp{-l} option. The default maximum depth is five layers.
1539 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1540 the data from the given directory tree (including the subdirectories up
1541 to the specified depth) on the remote server, creating its mirror image
1542 locally. @sc{ftp} retrieval is also limited by the @code{depth}
1543 parameter. Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1546 By default, Wget will create a local directory tree, corresponding to
1547 the one found on the remote server.
1549 Recursive retrieving can find a number of applications, the most
1550 important of which is mirroring. It is also useful for @sc{www}
1551 presentations, and any other opportunities where slow network
1552 connections should be bypassed by storing the files locally.
1554 You should be warned that recursive downloads can overload the remote
1555 servers. Because of that, many administrators frown upon them and may
1556 ban access from your site if they detect very fast downloads of big
1557 amounts of content. When downloading from Internet servers, consider
1558 using the @samp{-w} option to introduce a delay between accesses to the
1559 server. The download will take a while longer, but the server
1560 administrator will not be alarmed by your rudeness.
1562 Of course, recursive download may cause problems on your machine. If
1563 left to run unchecked, it can easily fill up the disk. If downloading
1564 from local network, it can also take bandwidth on the system, as well as
1565 consume memory and CPU.
1567 Try to specify the criteria that match the kind of download you are
1568 trying to achieve. If you want to download only one page, use
1569 @samp{--page-requisites} without any additional recursion. If you want
1570 to download things under one directory, use @samp{-np} to avoid
1571 downloading things from other directories. If you want to download all
1572 the files from one directory, use @samp{-l 1} to make sure the recursion
1573 depth never exceeds one. @xref{Following Links}, for more information
1576 Recursive retrieval should be used with care. Don't say you were not
1579 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1580 @chapter Following Links
1582 @cindex following links
1584 When retrieving recursively, one does not wish to retrieve loads of
1585 unnecessary data. Most of the time the users bear in mind exactly what
1586 they want to download, and want Wget to follow only specific links.
1588 For example, if you wish to download the music archive from
1589 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1590 that happen to be referenced by an obscure part of the archive.
1592 Wget possesses several mechanisms that allows you to fine-tune which
1593 links it will follow.
1596 * Spanning Hosts:: (Un)limiting retrieval based on host name.
1597 * Types of Files:: Getting only certain files.
1598 * Directory-Based Limits:: Getting only certain directories.
1599 * Relative Links:: Follow relative links only.
1600 * FTP Links:: Following FTP links.
1603 @node Spanning Hosts, Types of Files, Following Links, Following Links
1604 @section Spanning Hosts
1605 @cindex spanning hosts
1606 @cindex hosts, spanning
1608 Wget's recursive retrieval normally refuses to visit hosts different
1609 than the one you specified on the command line. This is a reasonable
1610 default; without it, every retrieval would have the potential to turn
1611 your Wget into a small version of google.
1613 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1614 a useful option. Maybe the images are served from a different server.
1615 Maybe you're mirroring a site that consists of pages interlinked between
1616 three servers. Maybe the server has two equivalent names, and the HTML
1617 pages refer to both interchangeably.
1620 @item Span to any host---@samp{-H}
1622 The @samp{-H} option turns on host spanning, thus allowing Wget's
1623 recursive run to visit any host referenced by a link. Unless sufficient
1624 recursion-limiting criteria are applied depth, these foreign hosts will
1625 typically link to yet more hosts, and so on until Wget ends up sucking
1626 up much more data than you have intended.
1628 @item Limit spanning to certain domains---@samp{-D}
1630 The @samp{-D} option allows you to specify the domains that will be
1631 followed, thus limiting the recursion only to the hosts that belong to
1632 these domains. Obviously, this makes sense only in conjunction with
1633 @samp{-H}. A typical example would be downloading the contents of
1634 @samp{www.server.com}, but allowing downloads from
1635 @samp{images.server.com}, etc.:
1638 wget -rH -Dserver.com http://www.server.com/
1641 You can specify more than one address by separating them with a comma,
1642 e.g. @samp{-Ddomain1.com,domain2.com}.
1644 @item Keep download off certain domains---@samp{--exclude-domains}
1646 If there are domains you want to exclude specifically, you can do it
1647 with @samp{--exclude-domains}, which accepts the same type of arguments
1648 of @samp{-D}, but will @emph{exclude} all the listed domains. For
1649 example, if you want to download all the hosts from @samp{foo.edu}
1650 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1654 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
1660 @node Types of Files, Directory-Based Limits, Spanning Hosts, Following Links
1661 @section Types of Files
1662 @cindex types of files
1664 When downloading material from the web, you will often want to restrict
1665 the retrieval to only certain file types. For example, if you are
1666 interested in downloading @sc{gif}s, you will not be overjoyed to get
1667 loads of PostScript documents, and vice versa.
1669 Wget offers two options to deal with this problem. Each option
1670 description lists a short name, a long name, and the equivalent command
1673 @cindex accept wildcards
1674 @cindex accept suffixes
1675 @cindex wildcards, accept
1676 @cindex suffixes, accept
1678 @item -A @var{acclist}
1679 @itemx --accept @var{acclist}
1680 @itemx accept = @var{acclist}
1681 The argument to @samp{--accept} option is a list of file suffixes or
1682 patterns that Wget will download during recursive retrieval. A suffix
1683 is the ending part of a file, and consists of ``normal'' letters,
1684 e.g. @samp{gif} or @samp{.jpg}. A matching pattern contains shell-like
1685 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1687 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1688 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1689 @sc{jpeg}s. On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1690 download only files beginning with @samp{zelazny} and containing numbers
1691 from 1960 to 1969 anywhere within. Look up the manual of your shell for
1692 a description of how pattern matching works.
1694 Of course, any number of suffixes and patterns can be combined into a
1695 comma-separated list, and given as an argument to @samp{-A}.
1697 @cindex reject wildcards
1698 @cindex reject suffixes
1699 @cindex wildcards, reject
1700 @cindex suffixes, reject
1701 @item -R @var{rejlist}
1702 @itemx --reject @var{rejlist}
1703 @itemx reject = @var{rejlist}
1704 The @samp{--reject} option works the same way as @samp{--accept}, only
1705 its logic is the reverse; Wget will download all files @emph{except} the
1706 ones matching the suffixes (or patterns) in the list.
1708 So, if you want to download a whole page except for the cumbersome
1709 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1710 Analogously, to download all files except the ones beginning with
1711 @samp{bjork}, use @samp{wget -R "bjork*"}. The quotes are to prevent
1712 expansion by the shell.
1715 The @samp{-A} and @samp{-R} options may be combined to achieve even
1716 better fine-tuning of which files to retrieve. E.g. @samp{wget -A
1717 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1718 a part of their name, but @emph{not} the PostScript files.
1720 Note that these two options do not affect the downloading of @sc{html}
1721 files; Wget must load all the @sc{html}s to know where to go at
1722 all---recursive retrieval would make no sense otherwise.
1724 @node Directory-Based Limits, Relative Links, Types of Files, Following Links
1725 @section Directory-Based Limits
1727 @cindex directory limits
1729 Regardless of other link-following facilities, it is often useful to
1730 place the restriction of what files to retrieve based on the directories
1731 those files are placed in. There can be many reasons for this---the
1732 home pages may be organized in a reasonable directory structure; or some
1733 directories may contain useless information, e.g. @file{/cgi-bin} or
1734 @file{/dev} directories.
1736 Wget offers three different options to deal with this requirement. Each
1737 option description lists a short name, a long name, and the equivalent
1738 command in @file{.wgetrc}.
1740 @cindex directories, include
1741 @cindex include directories
1742 @cindex accept directories
1745 @itemx --include @var{list}
1746 @itemx include_directories = @var{list}
1747 @samp{-I} option accepts a comma-separated list of directories included
1748 in the retrieval. Any other directories will simply be ignored. The
1749 directories are absolute paths.
1751 So, if you wish to download from @samp{http://host/people/bozo/}
1752 following only links to bozo's colleagues in the @file{/people}
1753 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1756 wget -I /people,/cgi-bin http://host/people/bozo/
1759 @cindex directories, exclude
1760 @cindex exclude directories
1761 @cindex reject directories
1763 @itemx --exclude @var{list}
1764 @itemx exclude_directories = @var{list}
1765 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1766 directories @emph{excluded} from the download. E.g. if you do not want
1767 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1768 /cgi-bin} on the command line.
1770 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1771 to get a better fine-tuning of downloading subdirectories. E.g. if you
1772 want to load all the files from @file{/pub} hierarchy except for
1773 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1778 @itemx no_parent = on
1779 The simplest, and often very useful way of limiting directories is
1780 disallowing retrieval of the links that refer to the hierarchy
1781 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1782 parent directory/directories.
1784 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1785 Using it guarantees that you will never leave the existing hierarchy.
1786 Supposing you issue Wget with:
1789 wget -r --no-parent http://somehost/~luzer/my-archive/
1792 You may rest assured that none of the references to
1793 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1794 followed. Only the archive you are interested in will be downloaded.
1795 Essentially, @samp{--no-parent} is similar to
1796 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1797 intelligent fashion.
1800 @node Relative Links, FTP Links, Directory-Based Limits, Following Links
1801 @section Relative Links
1802 @cindex relative links
1804 When @samp{-L} is turned on, only the relative links are ever followed.
1805 Relative links are here defined those that do not refer to the web
1806 server root. For example, these links are relative:
1810 <a href="foo/bar.gif">
1811 <a href="../foo/bar.gif">
1814 These links are not relative:
1818 <a href="/foo/bar.gif">
1819 <a href="http://www.server.com/foo/bar.gif">
1822 Using this option guarantees that recursive retrieval will not span
1823 hosts, even without @samp{-H}. In simple cases it also allows downloads
1824 to ``just work'' without having to convert links.
1826 This option is probably not very useful and might be removed in a future
1829 @node FTP Links, , Relative Links, Following Links
1830 @section Following FTP Links
1831 @cindex following ftp links
1833 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1834 them to be. @sc{ftp} links in @sc{html} documents are often included
1835 for purposes of reference, and it is often inconvenient to download them
1838 To have @sc{ftp} links followed from @sc{html} documents, you need to
1839 specify the @samp{--follow-ftp} option. Having done that, @sc{ftp}
1840 links will span hosts regardless of @samp{-H} setting. This is logical,
1841 as @sc{ftp} links rarely point to the same host where the @sc{http}
1842 server resides. For similar reasons, the @samp{-L} options has no
1843 effect on such downloads. On the other hand, domain acceptance
1844 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1846 Also note that followed links to @sc{ftp} directories will not be
1847 retrieved recursively further.
1849 @node Time-Stamping, Startup File, Following Links, Top
1850 @chapter Time-Stamping
1851 @cindex time-stamping
1852 @cindex timestamping
1853 @cindex updating the archives
1854 @cindex incremental updating
1856 One of the most important aspects of mirroring information from the
1857 Internet is updating your archives.
1859 Downloading the whole archive again and again, just to replace a few
1860 changed files is expensive, both in terms of wasted bandwidth and money,
1861 and the time to do the update. This is why all the mirroring tools
1862 offer the option of incremental updating.
1864 Such an updating mechanism means that the remote server is scanned in
1865 search of @dfn{new} files. Only those new files will be downloaded in
1866 the place of the old ones.
1868 A file is considered new if one of these two conditions are met:
1872 A file of that name does not already exist locally.
1875 A file of that name does exist, but the remote file was modified more
1876 recently than the local file.
1879 To implement this, the program needs to be aware of the time of last
1880 modification of both local and remote files. We call this information the
1881 @dfn{time-stamp} of a file.
1883 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1884 (@samp{-N}) option, or through @code{timestamping = on} directive in
1885 @file{.wgetrc}. With this option, for each file it intends to download,
1886 Wget will check whether a local file of the same name exists. If it
1887 does, and the remote file is older, Wget will not download it.
1889 If the local file does not exist, or the sizes of the files do not
1890 match, Wget will download the remote file no matter what the time-stamps
1894 * Time-Stamping Usage::
1895 * HTTP Time-Stamping Internals::
1896 * FTP Time-Stamping Internals::
1899 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1900 @section Time-Stamping Usage
1901 @cindex time-stamping usage
1902 @cindex usage, time-stamping
1904 The usage of time-stamping is simple. Say you would like to download a
1905 file so that it keeps its date of modification.
1908 wget -S http://www.gnu.ai.mit.edu/
1911 A simple @code{ls -l} shows that the time stamp on the local file equals
1912 the state of the @code{Last-Modified} header, as returned by the server.
1913 As you can see, the time-stamping info is preserved locally, even
1914 without @samp{-N} (at least for @sc{http}).
1916 Several days later, you would like Wget to check if the remote file has
1917 changed, and download it if it has.
1920 wget -N http://www.gnu.ai.mit.edu/
1923 Wget will ask the server for the last-modified date. If the local file
1924 has the same timestamp as the server, or a newer one, the remote file
1925 will not be re-fetched. However, if the remote file is more recent,
1926 Wget will proceed to fetch it.
1928 The same goes for @sc{ftp}. For example:
1931 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
1934 (The quotes around that URL are to prevent the shell from trying to
1935 interpret the @samp{*}.)
1937 After download, a local directory listing will show that the timestamps
1938 match those on the remote server. Reissuing the command with @samp{-N}
1939 will make Wget re-fetch @emph{only} the files that have been modified
1940 since the last download.
1942 If you wished to mirror the GNU archive every week, you would use a
1943 command like the following, weekly:
1946 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
1949 Note that time-stamping will only work for files for which the server
1950 gives a timestamp. For @sc{http}, this depends on getting a
1951 @code{Last-Modified} header. For @sc{ftp}, this depends on getting a
1952 directory listing with dates in a format that Wget can parse
1953 (@pxref{FTP Time-Stamping Internals}).
1955 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1956 @section HTTP Time-Stamping Internals
1957 @cindex http time-stamping
1959 Time-stamping in @sc{http} is implemented by checking of the
1960 @code{Last-Modified} header. If you wish to retrieve the file
1961 @file{foo.html} through @sc{http}, Wget will check whether
1962 @file{foo.html} exists locally. If it doesn't, @file{foo.html} will be
1963 retrieved unconditionally.
1965 If the file does exist locally, Wget will first check its local
1966 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1967 @code{HEAD} request to the remote server, demanding the information on
1970 The @code{Last-Modified} header is examined to find which file was
1971 modified more recently (which makes it ``newer''). If the remote file
1972 is newer, it will be downloaded; if it is older, Wget will give
1973 up.@footnote{As an additional check, Wget will look at the
1974 @code{Content-Length} header, and compare the sizes; if they are not the
1975 same, the remote file will be downloaded no matter what the time-stamp
1978 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1979 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1980 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1981 @samp{@var{X}}, which will always differ if it's been converted by
1982 @samp{--convert-links} (@samp{-k}).
1984 Arguably, @sc{http} time-stamping should be implemented using the
1985 @code{If-Modified-Since} request.
1987 @node FTP Time-Stamping Internals, , HTTP Time-Stamping Internals, Time-Stamping
1988 @section FTP Time-Stamping Internals
1989 @cindex ftp time-stamping
1991 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1992 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
1995 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
1996 @sc{ftp} @code{LIST} command to get a file listing for the directory
1997 containing the desired file(s). It will try to analyze the listing,
1998 treating it like Unix @code{ls -l} output, extracting the time-stamps.
1999 The rest is exactly the same as for @sc{http}. Note that when
2000 retrieving individual files from an @sc{ftp} server without using
2001 globbing or recursion, listing files will not be downloaded (and thus
2002 files will not be time-stamped) unless @samp{-N} is specified.
2004 Assumption that every directory listing is a Unix-style listing may
2005 sound extremely constraining, but in practice it is not, as many
2006 non-Unix @sc{ftp} servers use the Unixoid listing format because most
2007 (all?) of the clients understand it. Bear in mind that @sc{rfc959}
2008 defines no standard way to get a file list, let alone the time-stamps.
2009 We can only hope that a future standard will define this.
2011 Another non-standard solution includes the use of @code{MDTM} command
2012 that is supported by some @sc{ftp} servers (including the popular
2013 @code{wu-ftpd}), which returns the exact time of the specified file.
2014 Wget may support this command in the future.
2016 @node Startup File, Examples, Time-Stamping, Top
2017 @chapter Startup File
2018 @cindex startup file
2024 Once you know how to change default settings of Wget through command
2025 line arguments, you may wish to make some of those settings permanent.
2026 You can do that in a convenient way by creating the Wget startup
2027 file---@file{.wgetrc}.
2029 Besides @file{.wgetrc} is the ``main'' initialization file, it is
2030 convenient to have a special facility for storing passwords. Thus Wget
2031 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
2032 it. You can find @file{.netrc} format in your system manuals.
2034 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
2038 * Wgetrc Location:: Location of various wgetrc files.
2039 * Wgetrc Syntax:: Syntax of wgetrc.
2040 * Wgetrc Commands:: List of available commands.
2041 * Sample Wgetrc:: A wgetrc example.
2044 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
2045 @section Wgetrc Location
2046 @cindex wgetrc location
2047 @cindex location of wgetrc
2049 When initializing, Wget will look for a @dfn{global} startup file,
2050 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
2051 @file{/usr/local}, if Wget was not installed there) and read commands
2052 from there, if it exists.
2054 Then it will look for the user's file. If the environmental variable
2055 @code{WGETRC} is set, Wget will try to load that file. Failing that, no
2056 further attempts will be made.
2058 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
2060 The fact that user's settings are loaded after the system-wide ones
2061 means that in case of collision user's wgetrc @emph{overrides} the
2062 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
2063 Fascist admins, away!
2065 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
2066 @section Wgetrc Syntax
2067 @cindex wgetrc syntax
2068 @cindex syntax of wgetrc
2070 The syntax of a wgetrc command is simple:
2076 The @dfn{variable} will also be called @dfn{command}. Valid
2077 @dfn{values} are different for different commands.
2079 The commands are case-insensitive and underscore-insensitive. Thus
2080 @samp{DIr__PrefiX} is the same as @samp{dirprefix}. Empty lines, lines
2081 beginning with @samp{#} and lines containing white-space only are
2084 Commands that expect a comma-separated list will clear the list on an
2085 empty command. So, if you wish to reset the rejection list specified in
2086 global @file{wgetrc}, you can do it with:
2092 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
2093 @section Wgetrc Commands
2094 @cindex wgetrc commands
2096 The complete set of commands is listed below. Legal values are listed
2097 after the @samp{=}. Simple Boolean values can be set or unset using
2098 @samp{on} and @samp{off} or @samp{1} and @samp{0}. A fancier kind of
2099 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
2100 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}. If an
2101 option is set to @samp{always} or @samp{never}, that value will be
2102 locked in for the duration of the Wget invocation---commandline options
2105 Some commands take pseudo-arbitrary values. @var{address} values can be
2106 hostnames or dotted-quad IP addresses. @var{n} can be any positive
2107 integer, or @samp{inf} for infinity, where appropriate. @var{string}
2108 values can be any non-empty string.
2110 Most of these commands have commandline equivalents (@pxref{Invoking}),
2111 though some of the more obscure or rarely used ones do not.
2114 @item accept/reject = @var{string}
2115 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
2117 @item add_hostdir = on/off
2118 Enable/disable host-prefixed file names. @samp{-nH} disables it.
2120 @item continue = on/off
2121 If set to on, force continuation of preexistent partially retrieved
2122 files. See @samp{-c} before setting it.
2124 @item background = on/off
2125 Enable/disable going to background---the same as @samp{-b} (which
2128 @item backup_converted = on/off
2129 Enable/disable saving pre-converted files with the suffix
2130 @samp{.orig}---the same as @samp{-K} (which enables it).
2132 @c @item backups = @var{number}
2133 @c #### Document me!
2135 @item base = @var{string}
2136 Consider relative @sc{url}s in @sc{url} input files forced to be
2137 interpreted as @sc{html} as being relative to @var{string}---the same as
2140 @item bind_address = @var{address}
2141 Bind to @var{address}, like the @samp{--bind-address} option.
2143 @item cache = on/off
2144 When set to off, disallow server-caching. See the @samp{-C} option.
2146 @item convert links = on/off
2147 Convert non-relative links locally. The same as @samp{-k}.
2149 @item cookies = on/off
2150 When set to off, disallow cookies. See the @samp{--cookies} option.
2152 @item load_cookies = @var{file}
2153 Load cookies from @var{file}. See @samp{--load-cookies}.
2155 @item save_cookies = @var{file}
2156 Save cookies to @var{file}. See @samp{--save-cookies}.
2158 @item connect_timeout = @var{n}
2159 Set the connect timeout---the same as @samp{--connect-timeout}.
2161 @item cut_dirs = @var{n}
2162 Ignore @var{n} remote directory components.
2164 @item debug = on/off
2165 Debug mode, same as @samp{-d}.
2167 @item delete_after = on/off
2168 Delete after download---the same as @samp{--delete-after}.
2170 @item dir_prefix = @var{string}
2171 Top of directory tree---the same as @samp{-P}.
2173 @item dirstruct = on/off
2174 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2177 @item dns_cache = on/off
2178 Turn DNS caching on/off. Since DNS caching is on by default, this
2179 option is normally used to turn it off. Same as @samp{--dns-cache}.
2181 @item dns_timeout = @var{n}
2182 Set the DNS timeout---the same as @samp{--dns-timeout}.
2184 @item domains = @var{string}
2185 Same as @samp{-D} (@pxref{Spanning Hosts}).
2187 @item dot_bytes = @var{n}
2188 Specify the number of bytes ``contained'' in a dot, as seen throughout
2189 the retrieval (1024 by default). You can postfix the value with
2190 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2191 respectively. With dot settings you can tailor the dot retrieval to
2192 suit your needs, or you can use the predefined @dfn{styles}
2193 (@pxref{Download Options}).
2195 @item dots_in_line = @var{n}
2196 Specify the number of dots that will be printed in each line throughout
2197 the retrieval (50 by default).
2199 @item dot_spacing = @var{n}
2200 Specify the number of dots in a single cluster (10 by default).
2202 @item exclude_directories = @var{string}
2203 Specify a comma-separated list of directories you wish to exclude from
2204 download---the same as @samp{-X} (@pxref{Directory-Based Limits}).
2206 @item exclude_domains = @var{string}
2207 Same as @samp{--exclude-domains} (@pxref{Spanning Hosts}).
2209 @item follow_ftp = on/off
2210 Follow @sc{ftp} links from @sc{html} documents---the same as
2211 @samp{--follow-ftp}.
2213 @item follow_tags = @var{string}
2214 Only follow certain HTML tags when doing a recursive retrieval, just like
2215 @samp{--follow-tags}.
2217 @item force_html = on/off
2218 If set to on, force the input filename to be regarded as an @sc{html}
2219 document---the same as @samp{-F}.
2221 @item ftp_proxy = @var{string}
2222 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2226 Turn globbing on/off---the same as @samp{-g}.
2228 @item header = @var{string}
2229 Define an additional header, like @samp{--header}.
2231 @item html_extension = on/off
2232 Add a @samp{.html} extension to @samp{text/html} files without it, like
2235 @item http_passwd = @var{string}
2236 Set @sc{http} password.
2238 @item http_proxy = @var{string}
2239 Use @var{string} as @sc{http} proxy, instead of the one specified in
2242 @item http_user = @var{string}
2243 Set @sc{http} user to @var{string}.
2245 @item ignore_length = on/off
2246 When set to on, ignore @code{Content-Length} header; the same as
2247 @samp{--ignore-length}.
2249 @item ignore_tags = @var{string}
2250 Ignore certain HTML tags when doing a recursive retrieval, just like
2251 @samp{-G} / @samp{--ignore-tags}.
2253 @item include_directories = @var{string}
2254 Specify a comma-separated list of directories you wish to follow when
2255 downloading---the same as @samp{-I}.
2257 @item input = @var{string}
2258 Read the @sc{url}s from @var{string}, like @samp{-i}.
2260 @item kill_longer = on/off
2261 Consider data longer than specified in content-length header as invalid
2262 (and retry getting it). The default behaviour is to save as much data
2263 as there is, provided there is more than or equal to the value in
2264 @code{Content-Length}.
2266 @item limit_rate = @var{rate}
2267 Limit the download speed to no more than @var{rate} bytes per second.
2268 The same as @samp{--limit-rate}.
2270 @item logfile = @var{string}
2271 Set logfile---the same as @samp{-o}.
2273 @item login = @var{string}
2274 Your user name on the remote machine, for @sc{ftp}. Defaults to
2277 @item mirror = on/off
2278 Turn mirroring on/off. The same as @samp{-m}.
2280 @item netrc = on/off
2281 Turn reading netrc on or off.
2283 @item noclobber = on/off
2286 @item no_parent = on/off
2287 Disallow retrieving outside the directory hierarchy, like
2288 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2290 @item no_proxy = @var{string}
2291 Use @var{string} as the comma-separated list of domains to avoid in
2292 proxy loading, instead of the one specified in environment.
2294 @item output_document = @var{string}
2295 Set the output filename---the same as @samp{-O}.
2297 @item page_requisites = on/off
2298 Download all ancillary documents necessary for a single HTML page to
2299 display properly---the same as @samp{-p}.
2301 @item passive_ftp = on/off/always/never
2302 Set passive @sc{ftp}---the same as @samp{--passive-ftp}. Some scripts
2303 and @samp{.pm} (Perl module) files download files using @samp{wget
2304 --passive-ftp}. If your firewall does not allow this, you can set
2305 @samp{passive_ftp = never} to override the commandline.
2307 @item passwd = @var{string}
2308 Set your @sc{ftp} password to @var{password}. Without this setting, the
2309 password defaults to @samp{username@@hostname.domainname}.
2311 @item progress = @var{string}
2312 Set the type of the progress indicator. Legal types are ``dot'' and
2315 @item proxy_user = @var{string}
2316 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
2318 @item proxy_passwd = @var{string}
2319 Set proxy authentication password to @var{string}, like @samp{--proxy-passwd}.
2321 @item referer = @var{string}
2322 Set HTTP @samp{Referer:} header just like @samp{--referer}. (Note it
2323 was the folks who wrote the @sc{http} spec who got the spelling of
2324 ``referrer'' wrong.)
2326 @item quiet = on/off
2327 Quiet mode---the same as @samp{-q}.
2329 @item quota = @var{quota}
2330 Specify the download quota, which is useful to put in the global
2331 @file{wgetrc}. When download quota is specified, Wget will stop
2332 retrieving after the download sum has become greater than quota. The
2333 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2334 mbytes (@samp{m} appended). Thus @samp{quota = 5m} will set the quota
2335 to 5 mbytes. Note that the user's startup file overrides system
2338 @item read_timeout = @var{n}
2339 Set the read (and write) timeout---the same as @samp{--read-timeout}.
2341 @item reclevel = @var{n}
2342 Recursion level---the same as @samp{-l}.
2344 @item recursive = on/off
2345 Recursive on/off---the same as @samp{-r}.
2347 @item relative_only = on/off
2348 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2351 @item remove_listing = on/off
2352 If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it
2353 to off is the same as @samp{-nr}.
2355 @item restrict_file_names = unix/windows
2356 Restrict the file names generated by Wget from URLs. See
2357 @samp{--restrict-file-names} for a more detailed description.
2359 @item retr_symlinks = on/off
2360 When set to on, retrieve symbolic links as if they were plain files; the
2361 same as @samp{--retr-symlinks}.
2363 @item robots = on/off
2364 Specify whether the norobots convention is respected by Wget, ``on'' by
2365 default. This switch controls both the @file{/robots.txt} and the
2366 @samp{nofollow} aspect of the spec. @xref{Robot Exclusion}, for more
2367 details about this. Be sure you know what you are doing before turning
2370 @item server_response = on/off
2371 Choose whether or not to print the @sc{http} and @sc{ftp} server
2372 responses---the same as @samp{-S}.
2374 @item span_hosts = on/off
2377 @item strict_comments = on/off
2378 Same as @samp{--strict-comments}.
2380 @item timeout = @var{n}
2381 Set timeout value---the same as @samp{-T}.
2383 @item timestamping = on/off
2384 Turn timestamping on/off. The same as @samp{-N} (@pxref{Time-Stamping}).
2386 @item tries = @var{n}
2387 Set number of retries per @sc{url}---the same as @samp{-t}.
2389 @item use_proxy = on/off
2390 Turn proxy support on/off. The same as @samp{-Y}.
2392 @item verbose = on/off
2393 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2395 @item wait = @var{n}
2396 Wait @var{n} seconds between retrievals---the same as @samp{-w}.
2398 @item waitretry = @var{n}
2399 Wait up to @var{n} seconds between retries of failed retrievals
2400 only---the same as @samp{--waitretry}. Note that this is turned on by
2401 default in the global @file{wgetrc}.
2403 @item randomwait = on/off
2404 Turn random between-request wait times on or off. The same as
2405 @samp{--random-wait}.
2408 @node Sample Wgetrc, , Wgetrc Commands, Startup File
2409 @section Sample Wgetrc
2410 @cindex sample wgetrc
2412 This is the sample initialization file, as given in the distribution.
2413 It is divided in two section---one for global usage (suitable for global
2414 startup file), and one for local usage (suitable for
2415 @file{$HOME/.wgetrc}). Be careful about the things you change.
2417 Note that almost all the lines are commented out. For a command to have
2418 any effect, you must remove the @samp{#} character at the beginning of
2422 @include sample.wgetrc.munged_for_texi_inclusion
2425 @node Examples, Various, Startup File, Top
2429 @c man begin EXAMPLES
2430 The examples are divided into three sections loosely based on their
2434 * Simple Usage:: Simple, basic usage of the program.
2435 * Advanced Usage:: Advanced tips.
2436 * Very Advanced Usage:: The hairy stuff.
2439 @node Simple Usage, Advanced Usage, Examples, Examples
2440 @section Simple Usage
2444 Say you want to download a @sc{url}. Just type:
2447 wget http://fly.srk.fer.hr/
2451 But what will happen if the connection is slow, and the file is lengthy?
2452 The connection will probably fail before the whole file is retrieved,
2453 more than once. In this case, Wget will try getting the file until it
2454 either gets the whole of it, or exceeds the default number of retries
2455 (this being 20). It is easy to change the number of tries to 45, to
2456 insure that the whole file will arrive safely:
2459 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2463 Now let's leave Wget to work in the background, and write its progress
2464 to log file @file{log}. It is tiring to type @samp{--tries}, so we
2465 shall use @samp{-t}.
2468 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2471 The ampersand at the end of the line makes sure that Wget works in the
2472 background. To unlimit the number of retries, use @samp{-t inf}.
2475 The usage of @sc{ftp} is as simple. Wget will take care of login and
2479 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2483 If you specify a directory, Wget will retrieve the directory listing,
2484 parse it and convert it to @sc{html}. Try:
2487 wget ftp://prep.ai.mit.edu/pub/gnu/
2492 @node Advanced Usage, Very Advanced Usage, Simple Usage, Examples
2493 @section Advanced Usage
2497 You have a file that contains the URLs you want to download? Use the
2504 If you specify @samp{-} as file name, the @sc{url}s will be read from
2508 Create a five levels deep mirror image of the GNU web site, with the
2509 same directory structure the original has, with only one try per
2510 document, saving the log of the activities to @file{gnulog}:
2513 wget -r http://www.gnu.org/ -o gnulog
2517 The same as the above, but convert the links in the @sc{html} files to
2518 point to local files, so you can view the documents off-line:
2521 wget --convert-links -r http://www.gnu.org/ -o gnulog
2525 Retrieve only one HTML page, but make sure that all the elements needed
2526 for the page to be displayed, such as inline images and external style
2527 sheets, are also downloaded. Also make sure the downloaded page
2528 references the downloaded links.
2531 wget -p --convert-links http://www.server.com/dir/page.html
2534 The HTML page will be saved to @file{www.server.com/dir/page.html}, and
2535 the images, stylesheets, etc., somewhere under @file{www.server.com/},
2536 depending on where they were on the remote server.
2539 The same as the above, but without the @file{www.server.com/} directory.
2540 In fact, I don't want to have all those random server directories
2541 anyway---just save @emph{all} those files under a @file{download/}
2542 subdirectory of the current directory.
2545 wget -p --convert-links -nH -nd -Pdownload \
2546 http://www.server.com/dir/page.html
2550 Retrieve the index.html of @samp{www.lycos.com}, showing the original
2554 wget -S http://www.lycos.com/
2558 Save the server headers with the file, perhaps for post-processing.
2561 wget -s http://www.lycos.com/
2566 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
2570 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
2574 You want to download all the @sc{gif}s from a directory on an @sc{http}
2575 server. You tried @samp{wget http://www.server.com/dir/*.gif}, but that
2576 didn't work because @sc{http} retrieval does not support globbing. In
2580 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
2583 More verbose, but the effect is the same. @samp{-r -l1} means to
2584 retrieve recursively (@pxref{Recursive Retrieval}), with maximum depth
2585 of 1. @samp{--no-parent} means that references to the parent directory
2586 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
2587 download only the @sc{gif} files. @samp{-A "*.gif"} would have worked
2591 Suppose you were in the middle of downloading, when Wget was
2592 interrupted. Now you do not want to clobber the files already present.
2596 wget -nc -r http://www.gnu.org/
2600 If you want to encode your own username and password to @sc{http} or
2601 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
2604 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
2607 Note, however, that this usage is not advisable on multi-user systems
2608 because it reveals your password to anyone who looks at the output of
2611 @cindex redirecting output
2613 You would like the output documents to go to standard output instead of
2617 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2620 You can also combine the two options and make pipelines to retrieve the
2621 documents from remote hotlists:
2624 wget -O - http://cool.list.com/ | wget --force-html -i -
2628 @node Very Advanced Usage, , Advanced Usage, Examples
2629 @section Very Advanced Usage
2634 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2635 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2636 for @samp{-r -l inf -N}. You can put Wget in the crontab file asking it
2637 to recheck a site each Sunday:
2641 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
2645 In addition to the above, you want the links to be converted for local
2646 viewing. But, after having read this manual, you know that link
2647 conversion doesn't play well with timestamping, so you also want Wget to
2648 back up the original HTML files before the conversion. Wget invocation
2649 would look like this:
2652 wget --mirror --convert-links --backup-converted \
2653 http://www.gnu.org/ -o /home/me/weeklog
2657 But you've also noticed that local viewing doesn't work all that well
2658 when HTML files are saved under extensions other than @samp{.html},
2659 perhaps because they were served as @file{index.cgi}. So you'd like
2660 Wget to rename all the files served with content-type @samp{text/html}
2661 to @file{@var{name}.html}.
2664 wget --mirror --convert-links --backup-converted \
2665 --html-extension -o /home/me/weeklog \
2669 Or, with less typing:
2672 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
2677 @node Various, Appendices, Examples, Top
2681 This chapter contains all the stuff that could not fit anywhere else.
2684 * Proxies:: Support for proxy servers
2685 * Distribution:: Getting the latest version.
2686 * Mailing List:: Wget mailing list for announcements and discussion.
2687 * Reporting Bugs:: How and where to report bugs.
2688 * Portability:: The systems Wget works on.
2689 * Signals:: Signal-handling performed by Wget.
2692 @node Proxies, Distribution, Various, Various
2696 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2697 data from remote servers to local clients. One typical use of proxies
2698 is lightening network load for users behind a slow connection. This is
2699 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2700 proxy which caches the transferred data. When a cached resource is
2701 requested again, proxy will return the data from cache. Another use for
2702 proxies is for companies that separate (for security reasons) their
2703 internal networks from the rest of Internet. In order to obtain
2704 information from the Web, their users connect and retrieve remote data
2705 using an authorized proxy.
2707 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals. The
2708 standard way to specify proxy location, which Wget recognizes, is using
2709 the following environment variables:
2713 This variable should contain the @sc{url} of the proxy for @sc{http}
2717 This variable should contain the @sc{url} of the proxy for @sc{ftp}
2718 connections. It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2719 are set to the same @sc{url}.
2722 This variable should contain a comma-separated list of domain extensions
2723 proxy should @emph{not} be used for. For instance, if the value of
2724 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2728 In addition to the environment variables, proxy location and settings
2729 may be specified from within Wget itself.
2733 @itemx --proxy=on/off
2734 @itemx proxy = on/off
2735 This option may be used to turn the proxy support on or off. Proxy
2736 support is on by default, provided that the appropriate environment
2739 @item http_proxy = @var{URL}
2740 @itemx ftp_proxy = @var{URL}
2741 @itemx no_proxy = @var{string}
2742 These startup file variables allow you to override the proxy settings
2743 specified by the environment.
2746 Some proxy servers require authorization to enable you to use them. The
2747 authorization consists of @dfn{username} and @dfn{password}, which must
2748 be sent by Wget. As with @sc{http} authorization, several
2749 authentication schemes exist. For proxy authorization only the
2750 @code{Basic} authentication scheme is currently implemented.
2752 You may specify your username and password either through the proxy
2753 @sc{url} or through the command-line options. Assuming that the
2754 company's proxy is located at @samp{proxy.company.com} at port 8001, a
2755 proxy @sc{url} location containing authorization data might look like
2759 http://hniksic:mypassword@@proxy.company.com:8001/
2762 Alternatively, you may use the @samp{proxy-user} and
2763 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2764 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2765 username and password.
2767 @node Distribution, Mailing List, Proxies, Various
2768 @section Distribution
2769 @cindex latest version
2771 Like all GNU utilities, the latest version of Wget can be found at the
2772 master GNU archive site prep.ai.mit.edu, and its mirrors. For example,
2773 Wget @value{VERSION} can be found at
2774 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2776 @node Mailing List, Reporting Bugs, Distribution, Various
2777 @section Mailing List
2778 @cindex mailing list
2781 Wget has its own mailing list at @email{wget@@sunsite.dk}, thanks
2782 to Karsten Thygesen. The mailing list is for discussion of Wget
2783 features and web, reporting Wget bugs (those that you think may be of
2784 interest to the public) and mailing announcements. You are welcome to
2785 subscribe. The more people on the list, the better!
2787 To subscribe, send mail to @email{wget-subscribe@@sunsite.dk}.
2788 the magic word @samp{subscribe} in the subject line. Unsubscribe by
2789 mailing to @email{wget-unsubscribe@@sunsite.dk}.
2791 The mailing list is archived at @url{http://fly.srk.fer.hr/archive/wget}.
2792 Alternative archive is available at
2793 @url{http://www.mail-archive.com/wget%40sunsite.auc.dk/}.
2795 @node Reporting Bugs, Portability, Mailing List, Various
2796 @section Reporting Bugs
2798 @cindex reporting bugs
2802 You are welcome to send bug reports about GNU Wget to
2803 @email{bug-wget@@gnu.org}.
2805 Before actually submitting a bug report, please try to follow a few
2810 Please try to ascertain that the behaviour you see really is a bug. If
2811 Wget crashes, it's a bug. If Wget does not behave as documented,
2812 it's a bug. If things work strange, but you are not sure about the way
2813 they are supposed to work, it might well be a bug.
2816 Try to repeat the bug in as simple circumstances as possible. E.g. if
2817 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
2818 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
2819 repeatable, and if will occur with a simpler set of options. You might
2820 even try to start the download at the page where the crash occurred to
2821 see if that page somehow triggered the crash.
2823 Also, while I will probably be interested to know the contents of your
2824 @file{.wgetrc} file, just dumping it into the debug message is probably
2825 a bad idea. Instead, you should first try to see if the bug repeats
2826 with @file{.wgetrc} moved out of the way. Only if it turns out that
2827 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
2831 Please start Wget with @samp{-d} option and send the log (or the
2832 relevant parts of it). If Wget was compiled without debug support,
2833 recompile it. It is @emph{much} easier to trace bugs with debug support
2837 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2838 wget` core} and type @code{where} to get the backtrace.
2842 @node Portability, Signals, Reporting Bugs, Various
2843 @section Portability
2845 @cindex operating systems
2847 Since Wget uses GNU Autoconf for building and configuring, and avoids
2848 using ``special'' ultra--mega--cool features of any particular Unix, it
2849 should compile (and work) on all common Unix flavors.
2851 Various Wget versions have been compiled and tested under many kinds of
2852 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2853 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2854 distribution directory for a comprehensive list. If you compile it on
2855 an architecture not listed there, please let me know so I can update it.
2857 Wget should also compile on the other Unix systems, not listed in
2858 @file{MACHINES}. If it doesn't, please let me know.
2860 Thanks to kind contributors, this version of Wget compiles and works on
2861 Microsoft Windows 95 and Windows NT platforms. It has been compiled
2862 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2863 with Winsock as networking software. Naturally, it is crippled of some
2864 features available on Unix, but it should work as a substitute for
2865 people stuck with Windows. Note that the Windows port is
2866 @strong{neither tested nor maintained} by me---all questions and
2867 problems should be reported to Wget mailing list at
2868 @email{wget@@sunsite.dk} where the maintainers will look at them.
2870 @node Signals, , Portability, Various
2872 @cindex signal handling
2875 Since the purpose of Wget is background work, it catches the hangup
2876 signal (@code{SIGHUP}) and ignores it. If the output was on standard
2877 output, it will be redirected to a file named @file{wget-log}.
2878 Otherwise, @code{SIGHUP} is ignored. This is convenient when you wish
2879 to redirect the output of Wget after having started it.
2882 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2883 $ kill -HUP %% # Redirect the output to wget-log
2886 Other than that, Wget will not try to interfere with signals in any way.
2887 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
2889 @node Appendices, Copying, Various, Top
2892 This chapter contains some references I consider useful.
2895 * Robot Exclusion:: Wget's support for RES.
2896 * Security Considerations:: Security with Wget.
2897 * Contributors:: People who helped.
2900 @node Robot Exclusion, Security Considerations, Appendices, Appendices
2901 @section Robot Exclusion
2902 @cindex robot exclusion
2904 @cindex server maintenance
2906 It is extremely easy to make Wget wander aimlessly around a web site,
2907 sucking all the available data in progress. @samp{wget -r @var{site}},
2908 and you're set. Great? Not for the server admin.
2910 As long as Wget is only retrieving static pages, and doing it at a
2911 reasonable rate (see the @samp{--wait} option), there's not much of a
2912 problem. The trouble is that Wget can't tell the difference between the
2913 smallest static page and the most demanding CGI. A site I know has a
2914 section handled by an, uh, @dfn{bitchin'} CGI Perl script that converts
2915 Info files to HTML on the fly. The script is slow, but works well
2916 enough for human users viewing an occasional Info file. However, when
2917 someone's recursive Wget download stumbles upon the index page that
2918 links to all the Info files through the script, the system is brought to
2919 its knees without providing anything useful to the downloader.
2921 To avoid this kind of accident, as well as to preserve privacy for
2922 documents that need to be protected from well-behaved robots, the
2923 concept of @dfn{robot exclusion} has been invented. The idea is that
2924 the server administrators and document authors can specify which
2925 portions of the site they wish to protect from the robots.
2927 The most popular mechanism, and the de facto standard supported by all
2928 the major robots, is the ``Robots Exclusion Standard'' (RES) written by
2929 Martijn Koster et al. in 1994. It specifies the format of a text file
2930 containing directives that instruct the robots which URL paths to avoid.
2931 To be found by the robots, the specifications must be placed in
2932 @file{/robots.txt} in the server root, which the robots are supposed to
2935 Although Wget is not a web robot in the strictest sense of the word, it
2936 can downloads large parts of the site without the user's intervention to
2937 download an individual page. Because of that, Wget honors RES when
2938 downloading recursively. For instance, when you issue:
2941 wget -r http://www.server.com/
2944 First the index of @samp{www.server.com} will be downloaded. If Wget
2945 finds that it wants to download more documents from that server, it will
2946 request @samp{http://www.server.com/robots.txt} and, if found, use it
2947 for further downloads. @file{robots.txt} is loaded only once per each
2950 Until version 1.8, Wget supported the first version of the standard,
2951 written by Martijn Koster in 1994 and available at
2952 @url{http://www.robotstxt.org/wc/norobots.html}. As of version 1.8,
2953 Wget has supported the additional directives specified in the internet
2954 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
2955 Robots Control''. The draft, which has as far as I know never made to
2956 an @sc{rfc}, is available at
2957 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
2959 This manual no longer includes the text of the Robot Exclusion Standard.
2961 The second, less known mechanism, enables the author of an individual
2962 document to specify whether they want the links from the file to be
2963 followed by a robot. This is achieved using the @code{META} tag, like
2967 <meta name="robots" content="nofollow">
2970 This is explained in some detail at
2971 @url{http://www.robotstxt.org/wc/meta-user.html}. Wget supports this
2972 method of robot exclusion in addition to the usual @file{/robots.txt}
2975 If you know what you are doing and really really wish to turn off the
2976 robot exclusion, set the @code{robots} variable to @samp{off} in your
2977 @file{.wgetrc}. You can achieve the same effect from the command line
2978 using the @code{-e} switch, e.g. @samp{wget -e robots=off @var{url}...}.
2980 @node Security Considerations, Contributors, Robot Exclusion, Appendices
2981 @section Security Considerations
2984 When using Wget, you must be aware that it sends unencrypted passwords
2985 through the network, which may present a security problem. Here are the
2986 main issues, and some solutions.
2989 @item The passwords on the command line are visible using @code{ps}.
2990 The best way around it is to use @code{wget -i -} and feed the @sc{url}s
2991 to Wget's standard input, each on a separate line, terminated by
2992 @kbd{C-d}. Another workaround is to use @file{.netrc} to store
2993 passwords; however, storing unencrypted passwords is also considered a
2997 Using the insecure @dfn{basic} authentication scheme, unencrypted
2998 passwords are transmitted through the network routers and gateways.
3001 The @sc{ftp} passwords are also in no way encrypted. There is no good
3002 solution for this at the moment.
3005 Although the ``normal'' output of Wget tries to hide the passwords,
3006 debugging logs show them, in all forms. This problem is avoided by
3007 being careful when you send debug logs (yes, even when you send them to
3011 @node Contributors, , Security Considerations, Appendices
3012 @section Contributors
3013 @cindex contributors
3016 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@arsdigita.com}.
3019 GNU Wget was written by Hrvoje Niksic @email{hniksic@@arsdigita.com}.
3021 However, its development could never have gone as far as it has, were it
3022 not for the help of many people, either with bug reports, feature
3023 proposals, patches, or letters saying ``Thanks!''.
3025 Special thanks goes to the following people (no particular order):
3029 Karsten Thygesen---donated system resources such as the mailing list,
3030 web space, and @sc{ftp} space, along with a lot of time to make these
3034 Shawn McHorse---bug reports and patches.
3037 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization. Lots of
3041 Gordon Matzigkeit---@file{.netrc} support.
3045 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
3046 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
3049 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
3050 and ``philosophical'' discussions.
3054 Darko Budor---initial port to Windows.
3057 Antonio Rosella---help and suggestions, plus the Italian translation.
3061 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
3065 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
3070 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
3073 Francois Pinard---many thorough bug reports and discussions.
3077 Karl Eichwalder---lots of help with internationalization and other
3081 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
3085 The people who provided donations for development, including Brian
3089 The following people have provided patches, bug/build reports, useful
3090 suggestions, beta testing services, fan mail and all the other things
3091 that make maintenance so much fun:
3110 Kristijan @v{C}onka@v{s},
3128 Aleksandar Erkalovi@'{c},
3131 Aleksandar Erkalovic,
3147 Erik Magnus Hulthen,
3165 Goran Kezunovi@'{c},
3176 $\Sigma\acute{\iota}\mu o\varsigma\;
3177 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
3178 (Simos KSenitellis),
3186 Nicol@'{a}s Lichtmeier,
3192 Alexander V. Lukyanov,
3217 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3219 Juan Jos\'{e} Rodr\'{\i}gues,
3222 Juan Jose Rodrigues,
3234 Szakacsits Szabolcs,
3240 Douglas E. Wegscheid,
3250 Apologies to all who I accidentally left out, and many thanks to all the
3251 subscribers of the Wget mailing list.
3253 @node Copying, Concept Index, Appendices, Top
3258 @cindex free software
3260 GNU Wget is licensed under the GNU GPL, which makes it @dfn{free
3263 Please note that ``free'' in ``free software'' refers to liberty, not
3264 price. As some GNU project advocates like to point out, think of ``free
3265 speech'' rather than ``free beer''. The exact and legally binding
3266 distribution terms are spelled out below; in short, you have the right
3267 (freedom) to run and change Wget and distribute it to other people, and
3268 even---if you want---charge money for doing either. The important
3269 restriction is that you have to grant your recipients the same rights
3270 and impose the same restrictions.
3272 This method of licensing software is also known as @dfn{open source}
3273 because, among other things, it makes sure that all recipients will
3274 receive the source code along with the program, and be able to improve
3275 it. The GNU project prefers the term ``free software'' for reasons
3277 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3279 The exact license terms are defined by this paragraph and the GNU
3280 General Public License it refers to:
3283 GNU Wget is free software; you can redistribute it and/or modify it
3284 under the terms of the GNU General Public License as published by the
3285 Free Software Foundation; either version 2 of the License, or (at your
3286 option) any later version.
3288 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3289 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3290 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3293 A copy of the GNU General Public License is included as part of this
3294 manual; if you did not receive it, write to the Free Software
3295 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3298 In addition to this, this manual is free in the same sense:
3301 Permission is granted to copy, distribute and/or modify this document
3302 under the terms of the GNU Free Documentation License, Version 1.1 or
3303 any later version published by the Free Software Foundation; with the
3304 Invariant Sections being ``GNU General Public License'' and ``GNU Free
3305 Documentation License'', with no Front-Cover Texts, and with no
3306 Back-Cover Texts. A copy of the license is included in the section
3307 entitled ``GNU Free Documentation License''.
3310 @c #### Maybe we should wrap these licenses in ifinfo? Stallman says
3311 @c that the GFDL needs to be present in the manual, and to me it would
3312 @c suck to include the license for the manual and not the license for
3315 The full texts of the GNU General Public License and of the GNU Free
3316 Documentation License are available below.
3319 * GNU General Public License::
3320 * GNU Free Documentation License::
3323 @node GNU General Public License, GNU Free Documentation License, Copying, Copying
3324 @section GNU General Public License
3325 @center Version 2, June 1991
3328 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3329 675 Mass Ave, Cambridge, MA 02139, USA
3331 Everyone is permitted to copy and distribute verbatim copies
3332 of this license document, but changing it is not allowed.
3335 @unnumberedsec Preamble
3337 The licenses for most software are designed to take away your
3338 freedom to share and change it. By contrast, the GNU General Public
3339 License is intended to guarantee your freedom to share and change free
3340 software---to make sure the software is free for all its users. This
3341 General Public License applies to most of the Free Software
3342 Foundation's software and to any other program whose authors commit to
3343 using it. (Some other Free Software Foundation software is covered by
3344 the GNU Library General Public License instead.) You can apply it to
3347 When we speak of free software, we are referring to freedom, not
3348 price. Our General Public Licenses are designed to make sure that you
3349 have the freedom to distribute copies of free software (and charge for
3350 this service if you wish), that you receive source code or can get it
3351 if you want it, that you can change the software or use pieces of it
3352 in new free programs; and that you know you can do these things.
3354 To protect your rights, we need to make restrictions that forbid
3355 anyone to deny you these rights or to ask you to surrender the rights.
3356 These restrictions translate to certain responsibilities for you if you
3357 distribute copies of the software, or if you modify it.
3359 For example, if you distribute copies of such a program, whether
3360 gratis or for a fee, you must give the recipients all the rights that
3361 you have. You must make sure that they, too, receive or can get the
3362 source code. And you must show them these terms so they know their
3365 We protect your rights with two steps: (1) copyright the software, and
3366 (2) offer you this license which gives you legal permission to copy,
3367 distribute and/or modify the software.
3369 Also, for each author's protection and ours, we want to make certain
3370 that everyone understands that there is no warranty for this free
3371 software. If the software is modified by someone else and passed on, we
3372 want its recipients to know that what they have is not the original, so
3373 that any problems introduced by others will not reflect on the original
3374 authors' reputations.
3376 Finally, any free program is threatened constantly by software
3377 patents. We wish to avoid the danger that redistributors of a free
3378 program will individually obtain patent licenses, in effect making the
3379 program proprietary. To prevent this, we have made it clear that any
3380 patent must be licensed for everyone's free use or not licensed at all.
3382 The precise terms and conditions for copying, distribution and
3383 modification follow.
3386 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3389 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3394 This License applies to any program or other work which contains
3395 a notice placed by the copyright holder saying it may be distributed
3396 under the terms of this General Public License. The ``Program'', below,
3397 refers to any such program or work, and a ``work based on the Program''
3398 means either the Program or any derivative work under copyright law:
3399 that is to say, a work containing the Program or a portion of it,
3400 either verbatim or with modifications and/or translated into another
3401 language. (Hereinafter, translation is included without limitation in
3402 the term ``modification''.) Each licensee is addressed as ``you''.
3404 Activities other than copying, distribution and modification are not
3405 covered by this License; they are outside its scope. The act of
3406 running the Program is not restricted, and the output from the Program
3407 is covered only if its contents constitute a work based on the
3408 Program (independent of having been made by running the Program).
3409 Whether that is true depends on what the Program does.
3412 You may copy and distribute verbatim copies of the Program's
3413 source code as you receive it, in any medium, provided that you
3414 conspicuously and appropriately publish on each copy an appropriate
3415 copyright notice and disclaimer of warranty; keep intact all the
3416 notices that refer to this License and to the absence of any warranty;
3417 and give any other recipients of the Program a copy of this License
3418 along with the Program.
3420 You may charge a fee for the physical act of transferring a copy, and
3421 you may at your option offer warranty protection in exchange for a fee.
3424 You may modify your copy or copies of the Program or any portion
3425 of it, thus forming a work based on the Program, and copy and
3426 distribute such modifications or work under the terms of Section 1
3427 above, provided that you also meet all of these conditions:
3431 You must cause the modified files to carry prominent notices
3432 stating that you changed the files and the date of any change.
3435 You must cause any work that you distribute or publish, that in
3436 whole or in part contains or is derived from the Program or any
3437 part thereof, to be licensed as a whole at no charge to all third
3438 parties under the terms of this License.
3441 If the modified program normally reads commands interactively
3442 when run, you must cause it, when started running for such
3443 interactive use in the most ordinary way, to print or display an
3444 announcement including an appropriate copyright notice and a
3445 notice that there is no warranty (or else, saying that you provide
3446 a warranty) and that users may redistribute the program under
3447 these conditions, and telling the user how to view a copy of this
3448 License. (Exception: if the Program itself is interactive but
3449 does not normally print such an announcement, your work based on
3450 the Program is not required to print an announcement.)
3453 These requirements apply to the modified work as a whole. If
3454 identifiable sections of that work are not derived from the Program,
3455 and can be reasonably considered independent and separate works in
3456 themselves, then this License, and its terms, do not apply to those
3457 sections when you distribute them as separate works. But when you
3458 distribute the same sections as part of a whole which is a work based
3459 on the Program, the distribution of the whole must be on the terms of
3460 this License, whose permissions for other licensees extend to the
3461 entire whole, and thus to each and every part regardless of who wrote it.
3463 Thus, it is not the intent of this section to claim rights or contest
3464 your rights to work written entirely by you; rather, the intent is to
3465 exercise the right to control the distribution of derivative or
3466 collective works based on the Program.
3468 In addition, mere aggregation of another work not based on the Program
3469 with the Program (or with a work based on the Program) on a volume of
3470 a storage or distribution medium does not bring the other work under
3471 the scope of this License.
3474 You may copy and distribute the Program (or a work based on it,
3475 under Section 2) in object code or executable form under the terms of
3476 Sections 1 and 2 above provided that you also do one of the following:
3480 Accompany it with the complete corresponding machine-readable
3481 source code, which must be distributed under the terms of Sections
3482 1 and 2 above on a medium customarily used for software interchange; or,
3485 Accompany it with a written offer, valid for at least three
3486 years, to give any third party, for a charge no more than your
3487 cost of physically performing source distribution, a complete
3488 machine-readable copy of the corresponding source code, to be
3489 distributed under the terms of Sections 1 and 2 above on a medium
3490 customarily used for software interchange; or,
3493 Accompany it with the information you received as to the offer
3494 to distribute corresponding source code. (This alternative is
3495 allowed only for noncommercial distribution and only if you
3496 received the program in object code or executable form with such
3497 an offer, in accord with Subsection b above.)
3500 The source code for a work means the preferred form of the work for
3501 making modifications to it. For an executable work, complete source
3502 code means all the source code for all modules it contains, plus any
3503 associated interface definition files, plus the scripts used to
3504 control compilation and installation of the executable. However, as a
3505 special exception, the source code distributed need not include
3506 anything that is normally distributed (in either source or binary
3507 form) with the major components (compiler, kernel, and so on) of the
3508 operating system on which the executable runs, unless that component
3509 itself accompanies the executable.
3511 If distribution of executable or object code is made by offering
3512 access to copy from a designated place, then offering equivalent
3513 access to copy the source code from the same place counts as
3514 distribution of the source code, even though third parties are not
3515 compelled to copy the source along with the object code.
3518 You may not copy, modify, sublicense, or distribute the Program
3519 except as expressly provided under this License. Any attempt
3520 otherwise to copy, modify, sublicense or distribute the Program is
3521 void, and will automatically terminate your rights under this License.
3522 However, parties who have received copies, or rights, from you under
3523 this License will not have their licenses terminated so long as such
3524 parties remain in full compliance.
3527 You are not required to accept this License, since you have not
3528 signed it. However, nothing else grants you permission to modify or
3529 distribute the Program or its derivative works. These actions are
3530 prohibited by law if you do not accept this License. Therefore, by
3531 modifying or distributing the Program (or any work based on the
3532 Program), you indicate your acceptance of this License to do so, and
3533 all its terms and conditions for copying, distributing or modifying
3534 the Program or works based on it.
3537 Each time you redistribute the Program (or any work based on the
3538 Program), the recipient automatically receives a license from the
3539 original licensor to copy, distribute or modify the Program subject to
3540 these terms and conditions. You may not impose any further
3541 restrictions on the recipients' exercise of the rights granted herein.
3542 You are not responsible for enforcing compliance by third parties to
3546 If, as a consequence of a court judgment or allegation of patent
3547 infringement or for any other reason (not limited to patent issues),
3548 conditions are imposed on you (whether by court order, agreement or
3549 otherwise) that contradict the conditions of this License, they do not
3550 excuse you from the conditions of this License. If you cannot
3551 distribute so as to satisfy simultaneously your obligations under this
3552 License and any other pertinent obligations, then as a consequence you
3553 may not distribute the Program at all. For example, if a patent
3554 license would not permit royalty-free redistribution of the Program by
3555 all those who receive copies directly or indirectly through you, then
3556 the only way you could satisfy both it and this License would be to
3557 refrain entirely from distribution of the Program.
3559 If any portion of this section is held invalid or unenforceable under
3560 any particular circumstance, the balance of the section is intended to
3561 apply and the section as a whole is intended to apply in other
3564 It is not the purpose of this section to induce you to infringe any
3565 patents or other property right claims or to contest validity of any
3566 such claims; this section has the sole purpose of protecting the
3567 integrity of the free software distribution system, which is
3568 implemented by public license practices. Many people have made
3569 generous contributions to the wide range of software distributed
3570 through that system in reliance on consistent application of that
3571 system; it is up to the author/donor to decide if he or she is willing
3572 to distribute software through any other system and a licensee cannot
3575 This section is intended to make thoroughly clear what is believed to
3576 be a consequence of the rest of this License.
3579 If the distribution and/or use of the Program is restricted in
3580 certain countries either by patents or by copyrighted interfaces, the
3581 original copyright holder who places the Program under this License
3582 may add an explicit geographical distribution limitation excluding
3583 those countries, so that distribution is permitted only in or among
3584 countries not thus excluded. In such case, this License incorporates
3585 the limitation as if written in the body of this License.
3588 The Free Software Foundation may publish revised and/or new versions
3589 of the General Public License from time to time. Such new versions will
3590 be similar in spirit to the present version, but may differ in detail to
3591 address new problems or concerns.
3593 Each version is given a distinguishing version number. If the Program
3594 specifies a version number of this License which applies to it and ``any
3595 later version'', you have the option of following the terms and conditions
3596 either of that version or of any later version published by the Free
3597 Software Foundation. If the Program does not specify a version number of
3598 this License, you may choose any version ever published by the Free Software
3602 If you wish to incorporate parts of the Program into other free
3603 programs whose distribution conditions are different, write to the author
3604 to ask for permission. For software which is copyrighted by the Free
3605 Software Foundation, write to the Free Software Foundation; we sometimes
3606 make exceptions for this. Our decision will be guided by the two goals
3607 of preserving the free status of all derivatives of our free software and
3608 of promoting the sharing and reuse of software generally.
3611 @heading NO WARRANTY
3619 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3620 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
3621 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3622 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3623 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3624 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
3625 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
3626 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3627 REPAIR OR CORRECTION.
3630 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3631 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3632 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3633 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3634 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3635 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3636 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3637 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3638 POSSIBILITY OF SUCH DAMAGES.
3642 @heading END OF TERMS AND CONDITIONS
3645 @center END OF TERMS AND CONDITIONS
3649 @unnumberedsec How to Apply These Terms to Your New Programs
3651 If you develop a new program, and you want it to be of the greatest
3652 possible use to the public, the best way to achieve this is to make it
3653 free software which everyone can redistribute and change under these terms.
3655 To do so, attach the following notices to the program. It is safest
3656 to attach them to the start of each source file to most effectively
3657 convey the exclusion of warranty; and each file should have at least
3658 the ``copyright'' line and a pointer to where the full notice is found.
3661 @var{one line to give the program's name and an idea of what it does.}
3662 Copyright (C) 19@var{yy} @var{name of author}
3664 This program is free software; you can redistribute it and/or
3665 modify it under the terms of the GNU General Public License
3666 as published by the Free Software Foundation; either version 2
3667 of the License, or (at your option) any later version.
3669 This program is distributed in the hope that it will be useful,
3670 but WITHOUT ANY WARRANTY; without even the implied warranty of
3671 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3672 GNU General Public License for more details.
3674 You should have received a copy of the GNU General Public License
3675 along with this program; if not, write to the Free Software
3676 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3679 Also add information on how to contact you by electronic and paper mail.
3681 If the program is interactive, make it output a short notice like this
3682 when it starts in an interactive mode:
3685 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3686 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3687 type `show w'. This is free software, and you are welcome
3688 to redistribute it under certain conditions; type `show c'
3692 The hypothetical commands @samp{show w} and @samp{show c} should show
3693 the appropriate parts of the General Public License. Of course, the
3694 commands you use may be called something other than @samp{show w} and
3695 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3698 You should also get your employer (if you work as a programmer) or your
3699 school, if any, to sign a ``copyright disclaimer'' for the program, if
3700 necessary. Here is a sample; alter the names:
3704 Yoyodyne, Inc., hereby disclaims all copyright
3705 interest in the program `Gnomovision'
3706 (which makes passes at compilers) written
3709 @var{signature of Ty Coon}, 1 April 1989
3710 Ty Coon, President of Vice
3714 This General Public License does not permit incorporating your program into
3715 proprietary programs. If your program is a subroutine library, you may
3716 consider it more useful to permit linking proprietary applications with the
3717 library. If this is what you want to do, use the GNU Library General
3718 Public License instead of this License.
3720 @node GNU Free Documentation License, , GNU General Public License, Copying
3721 @section GNU Free Documentation License
3722 @center Version 1.1, March 2000
3725 Copyright (C) 2000 Free Software Foundation, Inc.
3726 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3728 Everyone is permitted to copy and distribute verbatim copies
3729 of this license document, but changing it is not allowed.
3736 The purpose of this License is to make a manual, textbook, or other
3737 written document ``free'' in the sense of freedom: to assure everyone
3738 the effective freedom to copy and redistribute it, with or without
3739 modifying it, either commercially or noncommercially. Secondarily,
3740 this License preserves for the author and publisher a way to get
3741 credit for their work, while not being considered responsible for
3742 modifications made by others.
3744 This License is a kind of ``copyleft'', which means that derivative
3745 works of the document must themselves be free in the same sense. It
3746 complements the GNU General Public License, which is a copyleft
3747 license designed for free software.
3749 We have designed this License in order to use it for manuals for free
3750 software, because free software needs free documentation: a free
3751 program should come with manuals providing the same freedoms that the
3752 software does. But this License is not limited to software manuals;
3753 it can be used for any textual work, regardless of subject matter or
3754 whether it is published as a printed book. We recommend this License
3755 principally for works whose purpose is instruction or reference.
3759 APPLICABILITY AND DEFINITIONS
3761 This License applies to any manual or other work that contains a
3762 notice placed by the copyright holder saying it can be distributed
3763 under the terms of this License. The ``Document'', below, refers to any
3764 such manual or work. Any member of the public is a licensee, and is
3765 addressed as ``you''.
3767 A ``Modified Version'' of the Document means any work containing the
3768 Document or a portion of it, either copied verbatim, or with
3769 modifications and/or translated into another language.
3771 A ``Secondary Section'' is a named appendix or a front-matter section of
3772 the Document that deals exclusively with the relationship of the
3773 publishers or authors of the Document to the Document's overall subject
3774 (or to related matters) and contains nothing that could fall directly
3775 within that overall subject. (For example, if the Document is in part a
3776 textbook of mathematics, a Secondary Section may not explain any
3777 mathematics.) The relationship could be a matter of historical
3778 connection with the subject or with related matters, or of legal,
3779 commercial, philosophical, ethical or political position regarding
3782 The ``Invariant Sections'' are certain Secondary Sections whose titles
3783 are designated, as being those of Invariant Sections, in the notice
3784 that says that the Document is released under this License.
3786 The ``Cover Texts'' are certain short passages of text that are listed,
3787 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3788 the Document is released under this License.
3790 A ``Transparent'' copy of the Document means a machine-readable copy,
3791 represented in a format whose specification is available to the
3792 general public, whose contents can be viewed and edited directly and
3793 straightforwardly with generic text editors or (for images composed of
3794 pixels) generic paint programs or (for drawings) some widely available
3795 drawing editor, and that is suitable for input to text formatters or
3796 for automatic translation to a variety of formats suitable for input
3797 to text formatters. A copy made in an otherwise Transparent file
3798 format whose markup has been designed to thwart or discourage
3799 subsequent modification by readers is not Transparent. A copy that is
3800 not ``Transparent'' is called ``Opaque''.
3802 Examples of suitable formats for Transparent copies include plain
3803 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3804 or XML using a publicly available DTD, and standard-conforming simple
3805 HTML designed for human modification. Opaque formats include
3806 PostScript, PDF, proprietary formats that can be read and edited only
3807 by proprietary word processors, SGML or XML for which the DTD and/or
3808 processing tools are not generally available, and the
3809 machine-generated HTML produced by some word processors for output
3812 The ``Title Page'' means, for a printed book, the title page itself,
3813 plus such following pages as are needed to hold, legibly, the material
3814 this License requires to appear in the title page. For works in
3815 formats which do not have any title page as such, ``Title Page'' means
3816 the text near the most prominent appearance of the work's title,
3817 preceding the beginning of the body of the text.
3822 You may copy and distribute the Document in any medium, either
3823 commercially or noncommercially, provided that this License, the
3824 copyright notices, and the license notice saying this License applies
3825 to the Document are reproduced in all copies, and that you add no other
3826 conditions whatsoever to those of this License. You may not use
3827 technical measures to obstruct or control the reading or further
3828 copying of the copies you make or distribute. However, you may accept
3829 compensation in exchange for copies. If you distribute a large enough
3830 number of copies you must also follow the conditions in section 3.
3832 You may also lend copies, under the same conditions stated above, and
3833 you may publicly display copies.
3838 If you publish printed copies of the Document numbering more than 100,
3839 and the Document's license notice requires Cover Texts, you must enclose
3840 the copies in covers that carry, clearly and legibly, all these Cover
3841 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3842 the back cover. Both covers must also clearly and legibly identify
3843 you as the publisher of these copies. The front cover must present
3844 the full title with all words of the title equally prominent and
3845 visible. You may add other material on the covers in addition.
3846 Copying with changes limited to the covers, as long as they preserve
3847 the title of the Document and satisfy these conditions, can be treated
3848 as verbatim copying in other respects.
3850 If the required texts for either cover are too voluminous to fit
3851 legibly, you should put the first ones listed (as many as fit
3852 reasonably) on the actual cover, and continue the rest onto adjacent
3855 If you publish or distribute Opaque copies of the Document numbering
3856 more than 100, you must either include a machine-readable Transparent
3857 copy along with each Opaque copy, or state in or with each Opaque copy
3858 a publicly-accessible computer-network location containing a complete
3859 Transparent copy of the Document, free of added material, which the
3860 general network-using public has access to download anonymously at no
3861 charge using public-standard network protocols. If you use the latter
3862 option, you must take reasonably prudent steps, when you begin
3863 distribution of Opaque copies in quantity, to ensure that this
3864 Transparent copy will remain thus accessible at the stated location
3865 until at least one year after the last time you distribute an Opaque
3866 copy (directly or through your agents or retailers) of that edition to
3869 It is requested, but not required, that you contact the authors of the
3870 Document well before redistributing any large number of copies, to give
3871 them a chance to provide you with an updated version of the Document.
3876 You may copy and distribute a Modified Version of the Document under
3877 the conditions of sections 2 and 3 above, provided that you release
3878 the Modified Version under precisely this License, with the Modified
3879 Version filling the role of the Document, thus licensing distribution
3880 and modification of the Modified Version to whoever possesses a copy
3881 of it. In addition, you must do these things in the Modified Version:
3883 A. Use in the Title Page (and on the covers, if any) a title distinct
3884 from that of the Document, and from those of previous versions
3885 (which should, if there were any, be listed in the History section
3886 of the Document). You may use the same title as a previous version
3887 if the original publisher of that version gives permission.@*
3888 B. List on the Title Page, as authors, one or more persons or entities
3889 responsible for authorship of the modifications in the Modified
3890 Version, together with at least five of the principal authors of the
3891 Document (all of its principal authors, if it has less than five).@*
3892 C. State on the Title page the name of the publisher of the
3893 Modified Version, as the publisher.@*
3894 D. Preserve all the copyright notices of the Document.@*
3895 E. Add an appropriate copyright notice for your modifications
3896 adjacent to the other copyright notices.@*
3897 F. Include, immediately after the copyright notices, a license notice
3898 giving the public permission to use the Modified Version under the
3899 terms of this License, in the form shown in the Addendum below.@*
3900 G. Preserve in that license notice the full lists of Invariant Sections
3901 and required Cover Texts given in the Document's license notice.@*
3902 H. Include an unaltered copy of this License.@*
3903 I. Preserve the section entitled ``History'', and its title, and add to
3904 it an item stating at least the title, year, new authors, and
3905 publisher of the Modified Version as given on the Title Page. If
3906 there is no section entitled ``History'' in the Document, create one
3907 stating the title, year, authors, and publisher of the Document as
3908 given on its Title Page, then add an item describing the Modified
3909 Version as stated in the previous sentence.@*
3910 J. Preserve the network location, if any, given in the Document for
3911 public access to a Transparent copy of the Document, and likewise
3912 the network locations given in the Document for previous versions
3913 it was based on. These may be placed in the ``History'' section.
3914 You may omit a network location for a work that was published at
3915 least four years before the Document itself, or if the original
3916 publisher of the version it refers to gives permission.@*
3917 K. In any section entitled ``Acknowledgements'' or ``Dedications'',
3918 preserve the section's title, and preserve in the section all the
3919 substance and tone of each of the contributor acknowledgements
3920 and/or dedications given therein.@*
3921 L. Preserve all the Invariant Sections of the Document,
3922 unaltered in their text and in their titles. Section numbers
3923 or the equivalent are not considered part of the section titles.@*
3924 M. Delete any section entitled ``Endorsements''. Such a section
3925 may not be included in the Modified Version.@*
3926 N. Do not retitle any existing section as ``Endorsements''
3927 or to conflict in title with any Invariant Section.@*
3929 If the Modified Version includes new front-matter sections or
3930 appendices that qualify as Secondary Sections and contain no material
3931 copied from the Document, you may at your option designate some or all
3932 of these sections as invariant. To do this, add their titles to the
3933 list of Invariant Sections in the Modified Version's license notice.
3934 These titles must be distinct from any other section titles.
3936 You may add a section entitled ``Endorsements'', provided it contains
3937 nothing but endorsements of your Modified Version by various
3938 parties--for example, statements of peer review or that the text has
3939 been approved by an organization as the authoritative definition of a
3942 You may add a passage of up to five words as a Front-Cover Text, and a
3943 passage of up to 25 words as a Back-Cover Text, to the end of the list
3944 of Cover Texts in the Modified Version. Only one passage of
3945 Front-Cover Text and one of Back-Cover Text may be added by (or
3946 through arrangements made by) any one entity. If the Document already
3947 includes a cover text for the same cover, previously added by you or
3948 by arrangement made by the same entity you are acting on behalf of,
3949 you may not add another; but you may replace the old one, on explicit
3950 permission from the previous publisher that added the old one.
3952 The author(s) and publisher(s) of the Document do not by this License
3953 give permission to use their names for publicity for or to assert or
3954 imply endorsement of any Modified Version.
3959 You may combine the Document with other documents released under this
3960 License, under the terms defined in section 4 above for modified
3961 versions, provided that you include in the combination all of the
3962 Invariant Sections of all of the original documents, unmodified, and
3963 list them all as Invariant Sections of your combined work in its
3966 The combined work need only contain one copy of this License, and
3967 multiple identical Invariant Sections may be replaced with a single
3968 copy. If there are multiple Invariant Sections with the same name but
3969 different contents, make the title of each such section unique by
3970 adding at the end of it, in parentheses, the name of the original
3971 author or publisher of that section if known, or else a unique number.
3972 Make the same adjustment to the section titles in the list of
3973 Invariant Sections in the license notice of the combined work.
3975 In the combination, you must combine any sections entitled ``History''
3976 in the various original documents, forming one section entitled
3977 ``History''; likewise combine any sections entitled ``Acknowledgements'',
3978 and any sections entitled ``Dedications''. You must delete all sections
3979 entitled ``Endorsements.''
3982 COLLECTIONS OF DOCUMENTS
3984 You may make a collection consisting of the Document and other documents
3985 released under this License, and replace the individual copies of this
3986 License in the various documents with a single copy that is included in
3987 the collection, provided that you follow the rules of this License for
3988 verbatim copying of each of the documents in all other respects.
3990 You may extract a single document from such a collection, and distribute
3991 it individually under this License, provided you insert a copy of this
3992 License into the extracted document, and follow this License in all
3993 other respects regarding verbatim copying of that document.
3996 AGGREGATION WITH INDEPENDENT WORKS
3998 A compilation of the Document or its derivatives with other separate
3999 and independent documents or works, in or on a volume of a storage or
4000 distribution medium, does not as a whole count as a Modified Version
4001 of the Document, provided no compilation copyright is claimed for the
4002 compilation. Such a compilation is called an ``aggregate'', and this
4003 License does not apply to the other self-contained works thus compiled
4004 with the Document, on account of their being thus compiled, if they
4005 are not themselves derivative works of the Document.
4007 If the Cover Text requirement of section 3 is applicable to these
4008 copies of the Document, then if the Document is less than one quarter
4009 of the entire aggregate, the Document's Cover Texts may be placed on
4010 covers that surround only the Document within the aggregate.
4011 Otherwise they must appear on covers around the whole aggregate.
4016 Translation is considered a kind of modification, so you may
4017 distribute translations of the Document under the terms of section 4.
4018 Replacing Invariant Sections with translations requires special
4019 permission from their copyright holders, but you may include
4020 translations of some or all Invariant Sections in addition to the
4021 original versions of these Invariant Sections. You may include a
4022 translation of this License provided that you also include the
4023 original English version of this License. In case of a disagreement
4024 between the translation and the original English version of this
4025 License, the original English version will prevail.
4030 You may not copy, modify, sublicense, or distribute the Document except
4031 as expressly provided for under this License. Any other attempt to
4032 copy, modify, sublicense or distribute the Document is void, and will
4033 automatically terminate your rights under this License. However,
4034 parties who have received copies, or rights, from you under this
4035 License will not have their licenses terminated so long as such
4036 parties remain in full compliance.
4039 FUTURE REVISIONS OF THIS LICENSE
4041 The Free Software Foundation may publish new, revised versions
4042 of the GNU Free Documentation License from time to time. Such new
4043 versions will be similar in spirit to the present version, but may
4044 differ in detail to address new problems or concerns. See
4045 http://www.gnu.org/copyleft/.
4047 Each version of the License is given a distinguishing version number.
4048 If the Document specifies that a particular numbered version of this
4049 License ``or any later version'' applies to it, you have the option of
4050 following the terms and conditions either of that specified version or
4051 of any later version that has been published (not as a draft) by the
4052 Free Software Foundation. If the Document does not specify a version
4053 number of this License, you may choose any version ever published (not
4054 as a draft) by the Free Software Foundation.
4058 @unnumberedsec ADDENDUM: How to use this License for your documents
4060 To use this License in a document you have written, include a copy of
4061 the License in the document and put the following copyright and
4062 license notices just after the title page:
4067 Copyright (C) @var{year} @var{your name}.
4068 Permission is granted to copy, distribute and/or modify this document
4069 under the terms of the GNU Free Documentation License, Version 1.1
4070 or any later version published by the Free Software Foundation;
4071 with the Invariant Sections being @var{list their titles}, with the
4072 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
4073 A copy of the license is included in the section entitled ``GNU
4074 Free Documentation License''.
4077 If you have no Invariant Sections, write ``with no Invariant Sections''
4078 instead of saying which ones are invariant. If you have no
4079 Front-Cover Texts, write ``no Front-Cover Texts'' instead of
4080 ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
4082 If your document contains nontrivial examples of program code, we
4083 recommend releasing these examples in parallel under your choice of
4084 free software license, such as the GNU General Public License,
4085 to permit their use in free software.
4088 @node Concept Index, , Copying, Top
4089 @unnumbered Concept Index