]> sjero.net Git - wget/blob - doc/wget.texi
[svn] Removed invariant status to the GPL and GFDL sections in the documentation.
[wget] / doc / wget.texi
1 \input texinfo   @c -*-texinfo-*-
2
3 @c %**start of header
4 @setfilename wget.info
5 @include version.texi
6 @set UPDATED Jun 2006
7 @settitle GNU Wget @value{VERSION} Manual
8 @c Disable the monstrous rectangles beside overfull hbox-es.
9 @finalout
10 @c Use `odd' to print double-sided.
11 @setchapternewpage on
12 @c %**end of header
13
14 @iftex
15 @c Remove this if you don't use A4 paper.
16 @afourpaper
17 @end iftex
18
19 @c Title for man page.  The weird way texi2pod.pl is written requires
20 @c the preceding @set.
21 @set Wget Wget
22 @c man title Wget The non-interactive network downloader.
23
24 @dircategory Network Applications
25 @direntry
26 * Wget: (wget).         The non-interactive network downloader.
27 @end direntry
28
29 @ifnottex
30 This file documents the the GNU Wget utility for downloading network
31 data.
32
33 @c man begin COPYRIGHT
34 Copyright @copyright{} 1996--2006 Free Software Foundation, Inc.
35
36 Permission is granted to make and distribute verbatim copies of
37 this manual provided the copyright notice and this permission notice
38 are preserved on all copies.
39
40 @ignore
41 Permission is granted to process this file through TeX and print the
42 results, provided the printed document carries a copying permission
43 notice identical to this one except for the removal of this paragraph
44 (this paragraph not being relevant to the printed manual).
45 @end ignore
46 Permission is granted to copy, distribute and/or modify this document
47 under the terms of the GNU Free Documentation License, Version 1.2 or
48 any later version published by the Free Software Foundation; with no
49 Invariant Sections, with no Front-Cover Texts, and with no
50 Back-Cover Texts.  A copy of the license is included in the section
51 entitled ``GNU Free Documentation License''.
52 @c man end
53 @end ifnottex
54
55 @titlepage
56 @title GNU Wget @value{VERSION}
57 @subtitle The non-interactive download utility
58 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
59 @author by Hrvoje Nik@v{s}i@'{c} and others
60
61 @ignore
62 @c man begin AUTHOR
63 Originally written by Hrvoje Niksic <hniksic@xemacs.org>.
64 @c man end
65 @c man begin SEEALSO
66 GNU Info entry for @file{wget}.
67 @c man end
68 @end ignore
69
70 @page
71 @vskip 0pt plus 1filll
72 Copyright @copyright{} 1996--2006, Free Software Foundation, Inc.
73
74 Permission is granted to copy, distribute and/or modify this document
75 under the terms of the GNU Free Documentation License, Version 1.2 or
76 any later version published by the Free Software Foundation; with the
77 Invariant Sections being ``GNU General Public License'' and ``GNU Free
78 Documentation License'', with no Front-Cover Texts, and with no
79 Back-Cover Texts.  A copy of the license is included in the section
80 entitled ``GNU Free Documentation License''.
81 @end titlepage
82
83 @ifnottex
84 @node Top
85 @top Wget @value{VERSION}
86
87 This manual documents version @value{VERSION} of GNU Wget, the freely
88 available utility for network downloads.
89
90 Copyright @copyright{} 1996--2006 Free Software Foundation, Inc.
91
92 @menu
93 * Overview::            Features of Wget.
94 * Invoking::            Wget command-line arguments.
95 * Recursive Download::  Downloading interlinked pages.
96 * Following Links::     The available methods of chasing links.
97 * Time-Stamping::       Mirroring according to time-stamps.
98 * Startup File::        Wget's initialization file.
99 * Examples::            Examples of usage.
100 * Various::             The stuff that doesn't fit anywhere else.
101 * Appendices::          Some useful references.
102 * Copying::             You may give out copies of Wget and of this manual.
103 * Concept Index::       Topics covered by this manual.
104 @end menu
105 @end ifnottex
106
107 @node Overview
108 @chapter Overview
109 @cindex overview
110 @cindex features
111
112 @c man begin DESCRIPTION
113 GNU Wget is a free utility for non-interactive download of files from
114 the Web.  It supports @sc{http}, @sc{https}, and @sc{ftp} protocols, as
115 well as retrieval through @sc{http} proxies.
116
117 @c man end
118 This chapter is a partial overview of Wget's features.
119
120 @itemize @bullet
121 @item
122 @c man begin DESCRIPTION
123 Wget is non-interactive, meaning that it can work in the background,
124 while the user is not logged on.  This allows you to start a retrieval
125 and disconnect from the system, letting Wget finish the work.  By
126 contrast, most of the Web browsers require constant user's presence,
127 which can be a great hindrance when transferring a lot of data.
128 @c man end
129
130 @item
131 @ignore
132 @c man begin DESCRIPTION
133
134 @c man end
135 @end ignore
136 @c man begin DESCRIPTION
137 Wget can follow links in @sc{html} and @sc{xhtml} pages and create local 
138 versions of remote web sites, fully recreating the directory structure of 
139 the original site.  This is sometimes referred to as ``recursive
140 downloading.''  While doing that, Wget respects the Robot Exclusion
141 Standard (@file{/robots.txt}).  Wget can be instructed to convert the
142 links in downloaded @sc{html} files to the local files for offline
143 viewing.
144 @c man end
145
146 @item
147 File name wildcard matching and recursive mirroring of directories are
148 available when retrieving via @sc{ftp}.  Wget can read the time-stamp
149 information given by both @sc{http} and @sc{ftp} servers, and store it
150 locally.  Thus Wget can see if the remote file has changed since last
151 retrieval, and automatically retrieve the new version if it has.  This
152 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
153 pages.
154
155 @item
156 @ignore
157 @c man begin DESCRIPTION
158
159 @c man end
160 @end ignore
161 @c man begin DESCRIPTION
162 Wget has been designed for robustness over slow or unstable network
163 connections; if a download fails due to a network problem, it will
164 keep retrying until the whole file has been retrieved.  If the server
165 supports regetting, it will instruct the server to continue the
166 download from where it left off.
167 @c man end
168
169 @item
170 Wget supports proxy servers, which can lighten the network load, speed
171 up retrieval and provide access behind firewalls.  However, if you are
172 behind a firewall that requires that you use a socks style gateway,
173 you can get the socks library and build Wget with support for socks.
174 Wget uses the passive @sc{ftp} downloading by default, active @sc{ftp}
175 being an option.
176
177 @item
178 Wget supports IP version 6, the next generation of IP.  IPv6 is
179 autodetected at compile-time, and can be disabled at either build or
180 run time.  Binaries built with IPv6 support work well in both
181 IPv4-only and dual family environments.
182
183 @item
184 Built-in features offer mechanisms to tune which links you wish to follow
185 (@pxref{Following Links}).
186
187 @item
188 The progress of individual downloads is traced using a progress gauge.
189 Interactive downloads are tracked using a ``thermometer''-style gauge,
190 whereas non-interactive ones are traced with dots, each dot
191 representing a fixed amount of data received (1KB by default).  Either
192 gauge can be customized to your preferences.
193
194 @item
195 Most of the features are fully configurable, either through command line
196 options, or via the initialization file @file{.wgetrc} (@pxref{Startup
197 File}).  Wget allows you to define @dfn{global} startup files
198 (@file{/usr/local/etc/wgetrc} by default) for site settings.
199
200 @ignore
201 @c man begin FILES
202 @table @samp
203 @item /usr/local/etc/wgetrc
204 Default location of the @dfn{global} startup file.
205
206 @item .wgetrc
207 User startup file.
208 @end table
209 @c man end
210 @end ignore
211
212 @item
213 Finally, GNU Wget is free software.  This means that everyone may use
214 it, redistribute it and/or modify it under the terms of the GNU General
215 Public License, as published by the Free Software Foundation
216 (@pxref{Copying}).
217 @end itemize
218
219 @node Invoking
220 @chapter Invoking
221 @cindex invoking
222 @cindex command line
223 @cindex arguments
224 @cindex nohup
225
226 By default, Wget is very simple to invoke.  The basic syntax is:
227
228 @example
229 @c man begin SYNOPSIS
230 wget [@var{option}]@dots{} [@var{URL}]@dots{}
231 @c man end
232 @end example
233
234 Wget will simply download all the @sc{url}s specified on the command
235 line.  @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
236
237 However, you may wish to change some of the default parameters of
238 Wget.  You can do it two ways: permanently, adding the appropriate
239 command to @file{.wgetrc} (@pxref{Startup File}), or specifying it on
240 the command line.
241
242 @menu
243 * URL Format::
244 * Option Syntax::
245 * Basic Startup Options::
246 * Logging and Input File Options::
247 * Download Options::
248 * Directory Options::
249 * HTTP Options::
250 * HTTPS (SSL/TLS) Options::
251 * FTP Options::
252 * Recursive Retrieval Options::
253 * Recursive Accept/Reject Options::
254 @end menu
255
256 @node URL Format
257 @section URL Format
258 @cindex URL
259 @cindex URL syntax
260
261 @dfn{URL} is an acronym for Uniform Resource Locator.  A uniform
262 resource locator is a compact string representation for a resource
263 available via the Internet.  Wget recognizes the @sc{url} syntax as per
264 @sc{rfc1738}.  This is the most widely used form (square brackets denote
265 optional parts):
266
267 @example
268 http://host[:port]/directory/file
269 ftp://host[:port]/directory/file
270 @end example
271
272 You can also encode your username and password within a @sc{url}:
273
274 @example
275 ftp://user:password@@host/path
276 http://user:password@@host/path
277 @end example
278
279 Either @var{user} or @var{password}, or both, may be left out.  If you
280 leave out either the @sc{http} username or password, no authentication
281 will be sent.  If you leave out the @sc{ftp} username, @samp{anonymous}
282 will be used.  If you leave out the @sc{ftp} password, your email
283 address will be supplied as a default password.@footnote{If you have a
284 @file{.netrc} file in your home directory, password will also be
285 searched for there.}
286
287 @strong{Important Note}: if you specify a password-containing @sc{url}
288 on the command line, the username and password will be plainly visible
289 to all users on the system, by way of @code{ps}.  On multi-user systems,
290 this is a big security risk.  To work around it, use @code{wget -i -}
291 and feed the @sc{url}s to Wget's standard input, each on a separate
292 line, terminated by @kbd{C-d}.
293
294 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
295 being the hexadecimal representation of the character's @sc{ascii}
296 value.  Some common unsafe characters include @samp{%} (quoted as
297 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
298 @samp{%40}).  Refer to @sc{rfc1738} for a comprehensive list of unsafe
299 characters.
300
301 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s.  By
302 default, @sc{ftp} documents are retrieved in the binary mode (type
303 @samp{i}), which means that they are downloaded unchanged.  Another
304 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
305 delimiters between the different operating systems, and is thus useful
306 for text files.  Here is an example:
307
308 @example
309 ftp://host/directory/file;type=a
310 @end example
311
312 Two alternative variants of @sc{url} specification are also supported,
313 because of historical (hysterical?) reasons and their widespreaded use.
314
315 @sc{ftp}-only syntax (supported by @code{NcFTP}):
316 @example
317 host:/dir/file
318 @end example
319
320 @sc{http}-only syntax (introduced by @code{Netscape}):
321 @example
322 host[:port]/dir/file
323 @end example
324
325 These two alternative forms are deprecated, and may cease being
326 supported in the future.
327
328 If you do not understand the difference between these notations, or do
329 not know which one to use, just use the plain ordinary format you use
330 with your favorite browser, like @code{Lynx} or @code{Netscape}.
331
332 @c man begin OPTIONS
333
334 @node Option Syntax
335 @section Option Syntax
336 @cindex option syntax
337 @cindex syntax of options
338
339 Since Wget uses GNU getopt to process command-line arguments, every
340 option has a long form along with the short one.  Long options are
341 more convenient to remember, but take time to type.  You may freely
342 mix different option styles, or specify options after the command-line
343 arguments.  Thus you may write:
344
345 @example
346 wget -r --tries=10 http://fly.srk.fer.hr/ -o log
347 @end example
348
349 The space between the option accepting an argument and the argument may
350 be omitted.  Instead @samp{-o log} you can write @samp{-olog}.
351
352 You may put several options that do not require arguments together,
353 like:
354
355 @example
356 wget -drc @var{URL}
357 @end example
358
359 This is a complete equivalent of:
360
361 @example
362 wget -d -r -c @var{URL}
363 @end example
364
365 Since the options can be specified after the arguments, you may
366 terminate them with @samp{--}.  So the following will try to download
367 @sc{url} @samp{-x}, reporting failure to @file{log}:
368
369 @example
370 wget -o log -- -x
371 @end example
372
373 The options that accept comma-separated lists all respect the convention
374 that specifying an empty list clears its value.  This can be useful to
375 clear the @file{.wgetrc} settings.  For instance, if your @file{.wgetrc}
376 sets @code{exclude_directories} to @file{/cgi-bin}, the following
377 example will first reset it, and then set it to exclude @file{/~nobody}
378 and @file{/~somebody}.  You can also clear the lists in @file{.wgetrc}
379 (@pxref{Wgetrc Syntax}).
380
381 @example
382 wget -X '' -X /~nobody,/~somebody
383 @end example
384
385 Most options that do not accept arguments are @dfn{boolean} options,
386 so named because their state can be captured with a yes-or-no
387 (``boolean'') variable.  For example, @samp{--follow-ftp} tells Wget
388 to follow FTP links from HTML files and, on the other hand,
389 @samp{--no-glob} tells it not to perform file globbing on FTP URLs.  A
390 boolean option is either @dfn{affirmative} or @dfn{negative}
391 (beginning with @samp{--no}).  All such options share several
392 properties.
393
394 Unless stated otherwise, it is assumed that the default behavior is
395 the opposite of what the option accomplishes.  For example, the
396 documented existence of @samp{--follow-ftp} assumes that the default
397 is to @emph{not} follow FTP links from HTML pages.
398
399 Affirmative options can be negated by prepending the @samp{--no-} to
400 the option name; negative options can be negated by omitting the
401 @samp{--no-} prefix.  This might seem superfluous---if the default for
402 an affirmative option is to not do something, then why provide a way
403 to explicitly turn it off?  But the startup file may in fact change
404 the default.  For instance, using @code{follow_ftp = off} in
405 @file{.wgetrc} makes Wget @emph{not} follow FTP links by default, and
406 using @samp{--no-follow-ftp} is the only way to restore the factory
407 default from the command line.
408
409 @node Basic Startup Options
410 @section Basic Startup Options
411
412 @table @samp
413 @item -V
414 @itemx --version
415 Display the version of Wget.
416
417 @item -h
418 @itemx --help
419 Print a help message describing all of Wget's command-line options.
420
421 @item -b
422 @itemx --background
423 Go to background immediately after startup.  If no output file is
424 specified via the @samp{-o}, output is redirected to @file{wget-log}.
425
426 @cindex execute wgetrc command
427 @item -e @var{command}
428 @itemx --execute @var{command}
429 Execute @var{command} as if it were a part of @file{.wgetrc}
430 (@pxref{Startup File}).  A command thus invoked will be executed
431 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
432 them.  If you need to specify more than one wgetrc command, use multiple
433 instances of @samp{-e}.
434
435 @end table
436
437 @node Logging and Input File Options
438 @section Logging and Input File Options
439
440 @table @samp
441 @cindex output file
442 @cindex log file
443 @item -o @var{logfile}
444 @itemx --output-file=@var{logfile}
445 Log all messages to @var{logfile}.  The messages are normally reported
446 to standard error.
447
448 @cindex append to log
449 @item -a @var{logfile}
450 @itemx --append-output=@var{logfile}
451 Append to @var{logfile}.  This is the same as @samp{-o}, only it appends
452 to @var{logfile} instead of overwriting the old log file.  If
453 @var{logfile} does not exist, a new file is created.
454
455 @cindex debug
456 @item -d
457 @itemx --debug
458 Turn on debug output, meaning various information important to the
459 developers of Wget if it does not work properly.  Your system
460 administrator may have chosen to compile Wget without debug support, in
461 which case @samp{-d} will not work.  Please note that compiling with
462 debug support is always safe---Wget compiled with the debug support will
463 @emph{not} print any debug info unless requested with @samp{-d}.
464 @xref{Reporting Bugs}, for more information on how to use @samp{-d} for
465 sending bug reports.
466
467 @cindex quiet
468 @item -q
469 @itemx --quiet
470 Turn off Wget's output.
471
472 @cindex verbose
473 @item -v
474 @itemx --verbose
475 Turn on verbose output, with all the available data.  The default output
476 is verbose.
477
478 @item -nv
479 @itemx --no-verbose
480 Turn off verbose without being completely quiet (use @samp{-q} for
481 that), which means that error messages and basic information still get
482 printed.
483
484 @cindex input-file
485 @item -i @var{file}
486 @itemx --input-file=@var{file}
487 Read @sc{url}s from @var{file}.  If @samp{-} is specified as
488 @var{file}, @sc{url}s are read from the standard input.  (Use
489 @samp{./-} to read from a file literally named @samp{-}.)
490
491 If this function is used, no @sc{url}s need be present on the command
492 line.  If there are @sc{url}s both on the command line and in an input
493 file, those on the command lines will be the first ones to be
494 retrieved.  The @var{file} need not be an @sc{html} document (but no
495 harm if it is)---it is enough if the @sc{url}s are just listed
496 sequentially.
497
498 However, if you specify @samp{--force-html}, the document will be
499 regarded as @samp{html}.  In that case you may have problems with
500 relative links, which you can solve either by adding @code{<base
501 href="@var{url}">} to the documents or by specifying
502 @samp{--base=@var{url}} on the command line.
503
504 @cindex force html
505 @item -F
506 @itemx --force-html
507 When input is read from a file, force it to be treated as an @sc{html}
508 file.  This enables you to retrieve relative links from existing
509 @sc{html} files on your local disk, by adding @code{<base
510 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
511 option.
512
513 @cindex base for relative links in input file
514 @item -B @var{URL}
515 @itemx --base=@var{URL}
516 Prepends @var{URL} to relative links read from the file specified with
517 the @samp{-i} option.
518 @end table
519
520 @node Download Options
521 @section Download Options
522
523 @table @samp
524 @cindex bind address
525 @cindex client IP address
526 @cindex IP address, client
527 @item --bind-address=@var{ADDRESS}
528 When making client TCP/IP connections, bind to @var{ADDRESS} on
529 the local machine.  @var{ADDRESS} may be specified as a hostname or IP
530 address.  This option can be useful if your machine is bound to multiple
531 IPs.
532
533 @cindex retries
534 @cindex tries
535 @cindex number of retries
536 @item -t @var{number}
537 @itemx --tries=@var{number}
538 Set number of retries to @var{number}.  Specify 0 or @samp{inf} for
539 infinite retrying.  The default is to retry 20 times, with the exception
540 of fatal errors like ``connection refused'' or ``not found'' (404),
541 which are not retried.
542
543 @item -O @var{file}
544 @itemx --output-document=@var{file}
545 The documents will not be written to the appropriate files, but all
546 will be concatenated together and written to @var{file}.  If @samp{-}
547 is used as @var{file}, documents will be printed to standard output,
548 disabling link conversion.  (Use @samp{./-} to print to a file
549 literally named @samp{-}.)
550
551 Note that a combination with @samp{-k} is only well-defined for
552 downloading a single document.
553
554 @cindex clobbering, file
555 @cindex downloading multiple times
556 @cindex no-clobber
557 @item -nc
558 @itemx --no-clobber
559 If a file is downloaded more than once in the same directory, Wget's
560 behavior depends on a few options, including @samp{-nc}.  In certain
561 cases, the local file will be @dfn{clobbered}, or overwritten, upon
562 repeated download.  In other cases it will be preserved.
563
564 When running Wget without @samp{-N}, @samp{-nc}, or @samp{-r},
565 downloading the same file in the same directory will result in the
566 original copy of @var{file} being preserved and the second copy being
567 named @samp{@var{file}.1}.  If that file is downloaded yet again, the
568 third copy will be named @samp{@var{file}.2}, and so on.  When
569 @samp{-nc} is specified, this behavior is suppressed, and Wget will
570 refuse to download newer copies of @samp{@var{file}}.  Therefore,
571 ``@code{no-clobber}'' is actually a misnomer in this mode---it's not
572 clobbering that's prevented (as the numeric suffixes were already
573 preventing clobbering), but rather the multiple version saving that's
574 prevented.
575
576 When running Wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
577 re-downloading a file will result in the new copy simply overwriting the
578 old.  Adding @samp{-nc} will prevent this behavior, instead causing the
579 original version to be preserved and any newer copies on the server to
580 be ignored.
581
582 When running Wget with @samp{-N}, with or without @samp{-r}, the
583 decision as to whether or not to download a newer copy of a file depends
584 on the local and remote timestamp and size of the file
585 (@pxref{Time-Stamping}).  @samp{-nc} may not be specified at the same
586 time as @samp{-N}.
587
588 Note that when @samp{-nc} is specified, files with the suffixes
589 @samp{.html} or @samp{.htm} will be loaded from the local disk and
590 parsed as if they had been retrieved from the Web.
591
592 @cindex continue retrieval
593 @cindex incomplete downloads
594 @cindex resume download
595 @item -c
596 @itemx --continue
597 Continue getting a partially-downloaded file.  This is useful when you
598 want to finish up a download started by a previous instance of Wget, or
599 by another program.  For instance:
600
601 @example
602 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
603 @end example
604
605 If there is a file named @file{ls-lR.Z} in the current directory, Wget
606 will assume that it is the first portion of the remote file, and will
607 ask the server to continue the retrieval from an offset equal to the
608 length of the local file.
609
610 Note that you don't need to specify this option if you just want the
611 current invocation of Wget to retry downloading a file should the
612 connection be lost midway through.  This is the default behavior.
613 @samp{-c} only affects resumption of downloads started @emph{prior} to
614 this invocation of Wget, and whose local files are still sitting around.
615
616 Without @samp{-c}, the previous example would just download the remote
617 file to @file{ls-lR.Z.1}, leaving the truncated @file{ls-lR.Z} file
618 alone.
619
620 Beginning with Wget 1.7, if you use @samp{-c} on a non-empty file, and
621 it turns out that the server does not support continued downloading,
622 Wget will refuse to start the download from scratch, which would
623 effectively ruin existing contents.  If you really want the download to
624 start from scratch, remove the file.
625
626 Also beginning with Wget 1.7, if you use @samp{-c} on a file which is of
627 equal size as the one on the server, Wget will refuse to download the
628 file and print an explanatory message.  The same happens when the file
629 is smaller on the server than locally (presumably because it was changed
630 on the server since your last download attempt)---because ``continuing''
631 is not meaningful, no download occurs.
632
633 On the other side of the coin, while using @samp{-c}, any file that's
634 bigger on the server than locally will be considered an incomplete
635 download and only @code{(length(remote) - length(local))} bytes will be
636 downloaded and tacked onto the end of the local file.  This behavior can
637 be desirable in certain cases---for instance, you can use @samp{wget -c}
638 to download just the new portion that's been appended to a data
639 collection or log file.
640
641 However, if the file is bigger on the server because it's been
642 @emph{changed}, as opposed to just @emph{appended} to, you'll end up
643 with a garbled file.  Wget has no way of verifying that the local file
644 is really a valid prefix of the remote file.  You need to be especially
645 careful of this when using @samp{-c} in conjunction with @samp{-r},
646 since every file will be considered as an "incomplete download" candidate.
647
648 Another instance where you'll get a garbled file if you try to use
649 @samp{-c} is if you have a lame @sc{http} proxy that inserts a
650 ``transfer interrupted'' string into the local file.  In the future a
651 ``rollback'' option may be added to deal with this case.
652
653 Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http}
654 servers that support the @code{Range} header.
655
656 @cindex progress indicator
657 @cindex dot style
658 @item --progress=@var{type}
659 Select the type of the progress indicator you wish to use.  Legal
660 indicators are ``dot'' and ``bar''.
661
662 The ``bar'' indicator is used by default.  It draws an @sc{ascii} progress
663 bar graphics (a.k.a ``thermometer'' display) indicating the status of
664 retrieval.  If the output is not a TTY, the ``dot'' bar will be used by
665 default.
666
667 Use @samp{--progress=dot} to switch to the ``dot'' display.  It traces
668 the retrieval by printing dots on the screen, each dot representing a
669 fixed amount of downloaded data.
670
671 When using the dotted retrieval, you may also set the @dfn{style} by
672 specifying the type as @samp{dot:@var{style}}.  Different styles assign
673 different meaning to one dot.  With the @code{default} style each dot
674 represents 1K, there are ten dots in a cluster and 50 dots in a line.
675 The @code{binary} style has a more ``computer''-like orientation---8K
676 dots, 16-dots clusters and 48 dots per line (which makes for 384K
677 lines).  The @code{mega} style is suitable for downloading very large
678 files---each dot represents 64K retrieved, there are eight dots in a
679 cluster, and 48 dots on each line (so each line contains 3M).
680
681 Note that you can set the default style using the @code{progress}
682 command in @file{.wgetrc}.  That setting may be overridden from the
683 command line.  The exception is that, when the output is not a TTY, the
684 ``dot'' progress will be favored over ``bar''.  To force the bar output,
685 use @samp{--progress=bar:force}.
686
687 @item -N
688 @itemx --timestamping
689 Turn on time-stamping.  @xref{Time-Stamping}, for details.
690
691 @cindex server response, print
692 @item -S
693 @itemx --server-response
694 Print the headers sent by @sc{http} servers and responses sent by
695 @sc{ftp} servers.
696
697 @cindex Wget as spider
698 @cindex spider
699 @item --spider
700 When invoked with this option, Wget will behave as a Web @dfn{spider},
701 which means that it will not download the pages, just check that they
702 are there.  For example, you can use Wget to check your bookmarks:
703
704 @example
705 wget --spider --force-html -i bookmarks.html
706 @end example
707
708 This feature needs much more work for Wget to get close to the
709 functionality of real web spiders.
710
711 @cindex timeout
712 @item -T seconds
713 @itemx --timeout=@var{seconds}
714 Set the network timeout to @var{seconds} seconds.  This is equivalent
715 to specifying @samp{--dns-timeout}, @samp{--connect-timeout}, and
716 @samp{--read-timeout}, all at the same time.
717
718 When interacting with the network, Wget can check for timeout and
719 abort the operation if it takes too long.  This prevents anomalies
720 like hanging reads and infinite connects.  The only timeout enabled by
721 default is a 900-second read timeout.  Setting a timeout to 0 disables
722 it altogether.  Unless you know what you are doing, it is best not to
723 change the default timeout settings.
724
725 All timeout-related options accept decimal values, as well as
726 subsecond values.  For example, @samp{0.1} seconds is a legal (though
727 unwise) choice of timeout.  Subsecond timeouts are useful for checking
728 server response times or for testing network latency.
729
730 @cindex DNS timeout
731 @cindex timeout, DNS
732 @item --dns-timeout=@var{seconds}
733 Set the DNS lookup timeout to @var{seconds} seconds.  DNS lookups that
734 don't complete within the specified time will fail.  By default, there
735 is no timeout on DNS lookups, other than that implemented by system
736 libraries.
737
738 @cindex connect timeout
739 @cindex timeout, connect
740 @item --connect-timeout=@var{seconds}
741 Set the connect timeout to @var{seconds} seconds.  TCP connections that
742 take longer to establish will be aborted.  By default, there is no
743 connect timeout, other than that implemented by system libraries.
744
745 @cindex read timeout
746 @cindex timeout, read
747 @item --read-timeout=@var{seconds}
748 Set the read (and write) timeout to @var{seconds} seconds.  The
749 ``time'' of this timeout refers @dfn{idle time}: if, at any point in
750 the download, no data is received for more than the specified number
751 of seconds, reading fails and the download is restarted.  This option
752 does not directly affect the duration of the entire download.
753
754 Of course, the remote server may choose to terminate the connection
755 sooner than this option requires.  The default read timeout is 900
756 seconds.
757
758 @cindex bandwidth, limit
759 @cindex rate, limit
760 @cindex limit bandwidth
761 @item --limit-rate=@var{amount}
762 Limit the download speed to @var{amount} bytes per second.  Amount may
763 be expressed in bytes, kilobytes with the @samp{k} suffix, or megabytes
764 with the @samp{m} suffix.  For example, @samp{--limit-rate=20k} will
765 limit the retrieval rate to 20KB/s.  This is useful when, for whatever
766 reason, you don't want Wget to consume the entire available bandwidth.
767
768 This option allows the use of decimal numbers, usually in conjunction
769 with power suffixes; for example, @samp{--limit-rate=2.5k} is a legal
770 value.
771
772 Note that Wget implements the limiting by sleeping the appropriate
773 amount of time after a network read that took less time than specified
774 by the rate.  Eventually this strategy causes the TCP transfer to slow
775 down to approximately the specified rate.  However, it may take some
776 time for this balance to be achieved, so don't be surprised if limiting
777 the rate doesn't work well with very small files.
778
779 @cindex pause
780 @cindex wait
781 @item -w @var{seconds}
782 @itemx --wait=@var{seconds}
783 Wait the specified number of seconds between the retrievals.  Use of
784 this option is recommended, as it lightens the server load by making the
785 requests less frequent.  Instead of in seconds, the time can be
786 specified in minutes using the @code{m} suffix, in hours using @code{h}
787 suffix, or in days using @code{d} suffix.
788
789 Specifying a large value for this option is useful if the network or the
790 destination host is down, so that Wget can wait long enough to
791 reasonably expect the network error to be fixed before the retry.  The
792 waiting interval specified by this function is influenced by
793 @code{--random-wait}, which see.
794
795 @cindex retries, waiting between
796 @cindex waiting between retries
797 @item --waitretry=@var{seconds}
798 If you don't want Wget to wait between @emph{every} retrieval, but only
799 between retries of failed downloads, you can use this option.  Wget will
800 use @dfn{linear backoff}, waiting 1 second after the first failure on a
801 given file, then waiting 2 seconds after the second failure on that
802 file, up to the maximum number of @var{seconds} you specify.  Therefore,
803 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
804 seconds per file.
805
806 Note that this option is turned on by default in the global
807 @file{wgetrc} file.
808
809 @cindex wait, random
810 @cindex random wait
811 @item --random-wait
812 Some web sites may perform log analysis to identify retrieval programs
813 such as Wget by looking for statistically significant similarities in
814 the time between requests. This option causes the time between requests
815 to vary between 0.5 and 1.5 * @var{wait} seconds, where @var{wait} was
816 specified using the @samp{--wait} option, in order to mask Wget's
817 presence from such analysis.
818
819 A 2001 article in a publication devoted to development on a popular
820 consumer platform provided code to perform this analysis on the fly.
821 Its author suggested blocking at the class C address level to ensure
822 automated retrieval programs were blocked despite changing DHCP-supplied
823 addresses.
824
825 The @samp{--random-wait} option was inspired by this ill-advised
826 recommendation to block many unrelated users from a web site due to the
827 actions of one.
828
829 @cindex proxy
830 @itemx --no-proxy
831 Don't use proxies, even if the appropriate @code{*_proxy} environment
832 variable is defined.
833
834 For more information about the use of proxies with Wget, @xref{Proxies}.
835
836 @cindex quota
837 @item -Q @var{quota}
838 @itemx --quota=@var{quota}
839 Specify download quota for automatic retrievals.  The value can be
840 specified in bytes (default), kilobytes (with @samp{k} suffix), or
841 megabytes (with @samp{m} suffix).
842
843 Note that quota will never affect downloading a single file.  So if you
844 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
845 @file{ls-lR.gz} will be downloaded.  The same goes even when several
846 @sc{url}s are specified on the command-line.  However, quota is
847 respected when retrieving either recursively, or from an input file.
848 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
849 aborted when the quota is exceeded.
850
851 Setting quota to 0 or to @samp{inf} unlimits the download quota.
852
853 @cindex DNS cache
854 @cindex caching of DNS lookups
855 @item --no-dns-cache
856 Turn off caching of DNS lookups.  Normally, Wget remembers the IP
857 addresses it looked up from DNS so it doesn't have to repeatedly
858 contact the DNS server for the same (typically small) set of hosts it
859 retrieves from.  This cache exists in memory only; a new Wget run will
860 contact DNS again.
861
862 However, it has been reported that in some situations it is not
863 desirable to cache host names, even for the duration of a
864 short-running application like Wget.  With this option Wget issues a
865 new DNS lookup (more precisely, a new call to @code{gethostbyname} or
866 @code{getaddrinfo}) each time it makes a new connection.  Please note
867 that this option will @emph{not} affect caching that might be
868 performed by the resolving library or by an external caching layer,
869 such as NSCD.
870
871 If you don't understand exactly what this option does, you probably
872 won't need it.
873
874 @cindex file names, restrict
875 @cindex Windows file names
876 @item --restrict-file-names=@var{mode}
877 Change which characters found in remote URLs may show up in local file
878 names generated from those URLs.  Characters that are @dfn{restricted}
879 by this option are escaped, i.e. replaced with @samp{%HH}, where
880 @samp{HH} is the hexadecimal number that corresponds to the restricted
881 character.
882
883 By default, Wget escapes the characters that are not valid as part of
884 file names on your operating system, as well as control characters that
885 are typically unprintable.  This option is useful for changing these
886 defaults, either because you are downloading to a non-native partition,
887 or because you want to disable escaping of the control characters.
888
889 When mode is set to ``unix'', Wget escapes the character @samp{/} and
890 the control characters in the ranges 0--31 and 128--159.  This is the
891 default on Unix-like OS'es.
892
893 When mode is set to ``windows'', Wget escapes the characters @samp{\},
894 @samp{|}, @samp{/}, @samp{:}, @samp{?}, @samp{"}, @samp{*}, @samp{<},
895 @samp{>}, and the control characters in the ranges 0--31 and 128--159.
896 In addition to this, Wget in Windows mode uses @samp{+} instead of
897 @samp{:} to separate host and port in local file names, and uses
898 @samp{@@} instead of @samp{?} to separate the query portion of the file
899 name from the rest.  Therefore, a URL that would be saved as
900 @samp{www.xemacs.org:4300/search.pl?input=blah} in Unix mode would be
901 saved as @samp{www.xemacs.org+4300/search.pl@@input=blah} in Windows
902 mode.  This mode is the default on Windows.
903
904 If you append @samp{,nocontrol} to the mode, as in
905 @samp{unix,nocontrol}, escaping of the control characters is also
906 switched off.  You can use @samp{--restrict-file-names=nocontrol} to
907 turn off escaping of control characters without affecting the choice of
908 the OS to use as file name restriction mode.
909
910 @cindex IPv6
911 @itemx -4
912 @itemx --inet4-only
913 @itemx -6
914 @itemx --inet6-only
915 Force connecting to IPv4 or IPv6 addresses.  With @samp{--inet4-only}
916 or @samp{-4}, Wget will only connect to IPv4 hosts, ignoring AAAA
917 records in DNS, and refusing to connect to IPv6 addresses specified in
918 URLs.  Conversely, with @samp{--inet6-only} or @samp{-6}, Wget will
919 only connect to IPv6 hosts and ignore A records and IPv4 addresses.
920
921 Neither options should be needed normally.  By default, an IPv6-aware
922 Wget will use the address family specified by the host's DNS record.
923 If the DNS responds with both IPv4 and IPv6 addresses, Wget will try
924 them in sequence until it finds one it can connect to.  (Also see
925 @code{--prefer-family} option described below.)
926
927 These options can be used to deliberately force the use of IPv4 or
928 IPv6 address families on dual family systems, usually to aid debugging
929 or to deal with broken network configuration.  Only one of
930 @samp{--inet6-only} and @samp{--inet4-only} may be specified at the
931 same time.  Neither option is available in Wget compiled without IPv6
932 support.
933
934 @item --prefer-family=IPv4/IPv6/none
935 When given a choice of several addresses, connect to the addresses
936 with specified address family first.  IPv4 addresses are preferred by
937 default.
938
939 This avoids spurious errors and connect attempts when accessing hosts
940 that resolve to both IPv6 and IPv4 addresses from IPv4 networks.  For
941 example, @samp{www.kame.net} resolves to
942 @samp{2001:200:0:8002:203:47ff:fea5:3085} and to
943 @samp{203.178.141.194}.  When the preferred family is @code{IPv4}, the
944 IPv4 address is used first; when the preferred family is @code{IPv6},
945 the IPv6 address is used first; if the specified value is @code{none},
946 the address order returned by DNS is used without change.
947
948 Unlike @samp{-4} and @samp{-6}, this option doesn't inhibit access to
949 any address family, it only changes the @emph{order} in which the
950 addresses are accessed.  Also note that the reordering performed by
951 this option is @dfn{stable}---it doesn't affect order of addresses of
952 the same family.  That is, the relative order of all IPv4 addresses
953 and of all IPv6 addresses remains intact in all cases.
954
955 @item --retry-connrefused
956 Consider ``connection refused'' a transient error and try again.
957 Normally Wget gives up on a URL when it is unable to connect to the
958 site because failure to connect is taken as a sign that the server is
959 not running at all and that retries would not help.  This option is
960 for mirroring unreliable sites whose servers tend to disappear for
961 short periods of time.
962
963 @cindex user
964 @cindex password
965 @cindex authentication
966 @item --user=@var{user}
967 @itemx --password=@var{password}
968 Specify the username @var{user} and password @var{password} for both
969 @sc{ftp} and @sc{http} file retrieval.  These parameters can be overridden
970 using the @samp{--ftp-user} and @samp{--ftp-password} options for 
971 @sc{ftp} connections and the @samp{--http-user} and @samp{--http-password} 
972 options for @sc{http} connections.
973 @end table
974
975 @node Directory Options
976 @section Directory Options
977
978 @table @samp
979 @item -nd
980 @itemx --no-directories
981 Do not create a hierarchy of directories when retrieving recursively.
982 With this option turned on, all files will get saved to the current
983 directory, without clobbering (if a name shows up more than once, the
984 filenames will get extensions @samp{.n}).
985
986 @item -x
987 @itemx --force-directories
988 The opposite of @samp{-nd}---create a hierarchy of directories, even if
989 one would not have been created otherwise.  E.g. @samp{wget -x
990 http://fly.srk.fer.hr/robots.txt} will save the downloaded file to
991 @file{fly.srk.fer.hr/robots.txt}.
992
993 @item -nH
994 @itemx --no-host-directories
995 Disable generation of host-prefixed directories.  By default, invoking
996 Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
997 directories beginning with @file{fly.srk.fer.hr/}.  This option disables
998 such behavior.
999
1000 @item --protocol-directories
1001 Use the protocol name as a directory component of local file names.  For
1002 example, with this option, @samp{wget -r http://@var{host}} will save to
1003 @samp{http/@var{host}/...} rather than just to @samp{@var{host}/...}.
1004
1005 @cindex cut directories
1006 @item --cut-dirs=@var{number}
1007 Ignore @var{number} directory components.  This is useful for getting a
1008 fine-grained control over the directory where recursive retrieval will
1009 be saved.
1010
1011 Take, for example, the directory at
1012 @samp{ftp://ftp.xemacs.org/pub/xemacs/}.  If you retrieve it with
1013 @samp{-r}, it will be saved locally under
1014 @file{ftp.xemacs.org/pub/xemacs/}.  While the @samp{-nH} option can
1015 remove the @file{ftp.xemacs.org/} part, you are still stuck with
1016 @file{pub/xemacs}.  This is where @samp{--cut-dirs} comes in handy; it
1017 makes Wget not ``see'' @var{number} remote directory components.  Here
1018 are several examples of how @samp{--cut-dirs} option works.
1019
1020 @example
1021 @group
1022 No options        -> ftp.xemacs.org/pub/xemacs/
1023 -nH               -> pub/xemacs/
1024 -nH --cut-dirs=1  -> xemacs/
1025 -nH --cut-dirs=2  -> .
1026
1027 --cut-dirs=1      -> ftp.xemacs.org/xemacs/
1028 ...
1029 @end group
1030 @end example
1031
1032 If you just want to get rid of the directory structure, this option is
1033 similar to a combination of @samp{-nd} and @samp{-P}.  However, unlike
1034 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
1035 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
1036 be placed to @file{xemacs/beta}, as one would expect.
1037
1038 @cindex directory prefix
1039 @item -P @var{prefix}
1040 @itemx --directory-prefix=@var{prefix}
1041 Set directory prefix to @var{prefix}.  The @dfn{directory prefix} is the
1042 directory where all other files and subdirectories will be saved to,
1043 i.e. the top of the retrieval tree.  The default is @samp{.} (the
1044 current directory).
1045 @end table
1046
1047 @node HTTP Options
1048 @section HTTP Options
1049
1050 @table @samp
1051 @cindex .html extension
1052 @item -E
1053 @itemx --html-extension
1054 If a file of type @samp{application/xhtml+xml} or @samp{text/html} is 
1055 downloaded and the URL does not end with the regexp 
1056 @samp{\.[Hh][Tt][Mm][Ll]?}, this option will cause the suffix @samp{.html} 
1057 to be appended to the local filename.  This is useful, for instance, when 
1058 you're mirroring a remote site that uses @samp{.asp} pages, but you want 
1059 the mirrored pages to be viewable on your stock Apache server.  Another 
1060 good use for this is when you're downloading CGI-generated materials.  A URL 
1061 like @samp{http://site.com/article.cgi?25} will be saved as
1062 @file{article.cgi?25.html}.
1063
1064 Note that filenames changed in this way will be re-downloaded every time
1065 you re-mirror a site, because Wget can't tell that the local
1066 @file{@var{X}.html} file corresponds to remote URL @samp{@var{X}} (since
1067 it doesn't yet know that the URL produces output of type
1068 @samp{text/html} or @samp{application/xhtml+xml}.  To prevent this 
1069 re-downloading, you must use @samp{-k} and @samp{-K} so that the original 
1070 version of the file will be saved as @file{@var{X}.orig} (@pxref{Recursive 
1071 Retrieval Options}).
1072
1073 @cindex http user
1074 @cindex http password
1075 @cindex authentication
1076 @item --http-user=@var{user}
1077 @itemx --http-password=@var{password}
1078 Specify the username @var{user} and password @var{password} on an
1079 @sc{http} server.  According to the type of the challenge, Wget will
1080 encode them using either the @code{basic} (insecure) or the
1081 @code{digest} authentication scheme.
1082
1083 Another way to specify username and password is in the @sc{url} itself
1084 (@pxref{URL Format}).  Either method reveals your password to anyone who
1085 bothers to run @code{ps}.  To prevent the passwords from being seen,
1086 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
1087 those files from other users with @code{chmod}.  If the passwords are
1088 really important, do not leave them lying in those files either---edit
1089 the files and delete them after Wget has started the download.
1090
1091 @iftex
1092 For more information about security issues with Wget, @xref{Security
1093 Considerations}.
1094 @end iftex
1095
1096 @cindex proxy
1097 @cindex cache
1098 @item --no-cache
1099 Disable server-side cache.  In this case, Wget will send the remote
1100 server an appropriate directive (@samp{Pragma: no-cache}) to get the
1101 file from the remote service, rather than returning the cached version.
1102 This is especially useful for retrieving and flushing out-of-date
1103 documents on proxy servers.
1104
1105 Caching is allowed by default.
1106
1107 @cindex cookies
1108 @item --no-cookies
1109 Disable the use of cookies.  Cookies are a mechanism for maintaining
1110 server-side state.  The server sends the client a cookie using the
1111 @code{Set-Cookie} header, and the client responds with the same cookie
1112 upon further requests.  Since cookies allow the server owners to keep
1113 track of visitors and for sites to exchange this information, some
1114 consider them a breach of privacy.  The default is to use cookies;
1115 however, @emph{storing} cookies is not on by default.
1116
1117 @cindex loading cookies
1118 @cindex cookies, loading
1119 @item --load-cookies @var{file}
1120 Load cookies from @var{file} before the first HTTP retrieval.
1121 @var{file} is a textual file in the format originally used by Netscape's
1122 @file{cookies.txt} file.
1123
1124 You will typically use this option when mirroring sites that require
1125 that you be logged in to access some or all of their content.  The login
1126 process typically works by the web server issuing an @sc{http} cookie
1127 upon receiving and verifying your credentials.  The cookie is then
1128 resent by the browser when accessing that part of the site, and so
1129 proves your identity.
1130
1131 Mirroring such a site requires Wget to send the same cookies your
1132 browser sends when communicating with the site.  This is achieved by
1133 @samp{--load-cookies}---simply point Wget to the location of the
1134 @file{cookies.txt} file, and it will send the same cookies your browser
1135 would send in the same situation.  Different browsers keep textual
1136 cookie files in different locations:
1137
1138 @table @asis
1139 @item Netscape 4.x.
1140 The cookies are in @file{~/.netscape/cookies.txt}.
1141
1142 @item Mozilla and Netscape 6.x.
1143 Mozilla's cookie file is also named @file{cookies.txt}, located
1144 somewhere under @file{~/.mozilla}, in the directory of your profile.
1145 The full path usually ends up looking somewhat like
1146 @file{~/.mozilla/default/@var{some-weird-string}/cookies.txt}.
1147
1148 @item Internet Explorer.
1149 You can produce a cookie file Wget can use by using the File menu,
1150 Import and Export, Export Cookies.  This has been tested with Internet
1151 Explorer 5; it is not guaranteed to work with earlier versions.
1152
1153 @item Other browsers.
1154 If you are using a different browser to create your cookies,
1155 @samp{--load-cookies} will only work if you can locate or produce a
1156 cookie file in the Netscape format that Wget expects.
1157 @end table
1158
1159 If you cannot use @samp{--load-cookies}, there might still be an
1160 alternative.  If your browser supports a ``cookie manager'', you can use
1161 it to view the cookies used when accessing the site you're mirroring.
1162 Write down the name and value of the cookie, and manually instruct Wget
1163 to send those cookies, bypassing the ``official'' cookie support:
1164
1165 @example
1166 wget --no-cookies --header "Cookie: @var{name}=@var{value}"
1167 @end example
1168
1169 @cindex saving cookies
1170 @cindex cookies, saving
1171 @item --save-cookies @var{file}
1172 Save cookies to @var{file} before exiting.  This will not save cookies
1173 that have expired or that have no expiry time (so-called ``session
1174 cookies''), but also see @samp{--keep-session-cookies}.
1175
1176 @cindex cookies, session
1177 @cindex session cookies
1178 @item --keep-session-cookies
1179 When specified, causes @samp{--save-cookies} to also save session
1180 cookies.  Session cookies are normally not saved because they are
1181 meant to be kept in memory and forgotten when you exit the browser.
1182 Saving them is useful on sites that require you to log in or to visit
1183 the home page before you can access some pages.  With this option,
1184 multiple Wget runs are considered a single browser session as far as
1185 the site is concerned.
1186
1187 Since the cookie file format does not normally carry session cookies,
1188 Wget marks them with an expiry timestamp of 0.  Wget's
1189 @samp{--load-cookies} recognizes those as session cookies, but it might
1190 confuse other browsers.  Also note that cookies so loaded will be
1191 treated as other session cookies, which means that if you want
1192 @samp{--save-cookies} to preserve them again, you must use
1193 @samp{--keep-session-cookies} again.
1194
1195 @cindex Content-Length, ignore
1196 @cindex ignore length
1197 @item --ignore-length
1198 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
1199 precise) send out bogus @code{Content-Length} headers, which makes Wget
1200 go wild, as it thinks not all the document was retrieved.  You can spot
1201 this syndrome if Wget retries getting the same document again and again,
1202 each time claiming that the (otherwise normal) connection has closed on
1203 the very same byte.
1204
1205 With this option, Wget will ignore the @code{Content-Length} header---as
1206 if it never existed.
1207
1208 @cindex header, add
1209 @item --header=@var{header-line}
1210 Send @var{header-line} along with the rest of the headers in each
1211 @sc{http} request.  The supplied header is sent as-is, which means it
1212 must contain name and value separated by colon, and must not contain
1213 newlines.
1214
1215 You may define more than one additional header by specifying
1216 @samp{--header} more than once.
1217
1218 @example
1219 @group
1220 wget --header='Accept-Charset: iso-8859-2' \
1221      --header='Accept-Language: hr'        \
1222        http://fly.srk.fer.hr/
1223 @end group
1224 @end example
1225
1226 Specification of an empty string as the header value will clear all
1227 previous user-defined headers.
1228
1229 As of Wget 1.10, this option can be used to override headers otherwise
1230 generated automatically.  This example instructs Wget to connect to
1231 localhost, but to specify @samp{foo.bar} in the @code{Host} header:
1232
1233 @example
1234 wget --header="Host: foo.bar" http://localhost/
1235 @end example
1236
1237 In versions of Wget prior to 1.10 such use of @samp{--header} caused
1238 sending of duplicate headers.
1239
1240 @cindex proxy user
1241 @cindex proxy password
1242 @cindex proxy authentication
1243 @item --proxy-user=@var{user}
1244 @itemx --proxy-password=@var{password}
1245 Specify the username @var{user} and password @var{password} for
1246 authentication on a proxy server.  Wget will encode them using the
1247 @code{basic} authentication scheme.
1248
1249 Security considerations similar to those with @samp{--http-password}
1250 pertain here as well.
1251
1252 @cindex http referer
1253 @cindex referer, http
1254 @item --referer=@var{url}
1255 Include `Referer: @var{url}' header in HTTP request.  Useful for
1256 retrieving documents with server-side processing that assume they are
1257 always being retrieved by interactive web browsers and only come out
1258 properly when Referer is set to one of the pages that point to them.
1259
1260 @cindex server response, save
1261 @item --save-headers
1262 Save the headers sent by the @sc{http} server to the file, preceding the
1263 actual contents, with an empty line as the separator.
1264
1265 @cindex user-agent
1266 @item -U @var{agent-string}
1267 @itemx --user-agent=@var{agent-string}
1268 Identify as @var{agent-string} to the @sc{http} server.
1269
1270 The @sc{http} protocol allows the clients to identify themselves using a
1271 @code{User-Agent} header field.  This enables distinguishing the
1272 @sc{www} software, usually for statistical purposes or for tracing of
1273 protocol violations.  Wget normally identifies as
1274 @samp{Wget/@var{version}}, @var{version} being the current version
1275 number of Wget.
1276
1277 However, some sites have been known to impose the policy of tailoring
1278 the output according to the @code{User-Agent}-supplied information.
1279 While this is not such a bad idea in theory, it has been abused by
1280 servers denying information to clients other than (historically)
1281 Netscape or, more frequently, Microsoft Internet Explorer.  This
1282 option allows you to change the @code{User-Agent} line issued by Wget.
1283 Use of this option is discouraged, unless you really know what you are
1284 doing.
1285
1286 Specifying empty user agent with @samp{--user-agent=""} instructs Wget
1287 not to send the @code{User-Agent} header in @sc{http} requests.
1288
1289 @cindex POST
1290 @item --post-data=@var{string}
1291 @itemx --post-file=@var{file}
1292 Use POST as the method for all HTTP requests and send the specified data
1293 in the request body.  @code{--post-data} sends @var{string} as data,
1294 whereas @code{--post-file} sends the contents of @var{file}.  Other than
1295 that, they work in exactly the same way.
1296
1297 Please be aware that Wget needs to know the size of the POST data in
1298 advance.  Therefore the argument to @code{--post-file} must be a regular
1299 file; specifying a FIFO or something like @file{/dev/stdin} won't work.
1300 It's not quite clear how to work around this limitation inherent in
1301 HTTP/1.0.  Although HTTP/1.1 introduces @dfn{chunked} transfer that
1302 doesn't require knowing the request length in advance, a client can't
1303 use chunked unless it knows it's talking to an HTTP/1.1 server.  And it
1304 can't know that until it receives a response, which in turn requires the
1305 request to have been completed -- a chicken-and-egg problem.
1306
1307 Note: if Wget is redirected after the POST request is completed, it
1308 will not send the POST data to the redirected URL.  This is because
1309 URLs that process POST often respond with a redirection to a regular
1310 page, which does not desire or accept POST.  It is not completely
1311 clear that this behavior is optimal; if it doesn't work out, it might
1312 be changed in the future.
1313
1314 This example shows how to log to a server using POST and then proceed to
1315 download the desired pages, presumably only accessible to authorized
1316 users:
1317
1318 @example
1319 @group
1320 # @r{Log in to the server.  This can be done only once.}
1321 wget --save-cookies cookies.txt \
1322      --post-data 'user=foo&password=bar' \
1323      http://server.com/auth.php
1324
1325 # @r{Now grab the page or pages we care about.}
1326 wget --load-cookies cookies.txt \
1327      -p http://server.com/interesting/article.php
1328 @end group
1329 @end example
1330
1331 If the server is using session cookies to track user authentication,
1332 the above will not work because @samp{--save-cookies} will not save
1333 them (and neither will browsers) and the @file{cookies.txt} file will
1334 be empty.  In that case use @samp{--keep-session-cookies} along with
1335 @samp{--save-cookies} to force saving of session cookies.
1336 @end table
1337
1338 @node HTTPS (SSL/TLS) Options
1339 @section HTTPS (SSL/TLS) Options
1340
1341 @cindex SSL
1342 To support encrypted HTTP (HTTPS) downloads, Wget must be compiled
1343 with an external SSL library, currently OpenSSL.  If Wget is compiled
1344 without SSL support, none of these options are available.
1345
1346 @table @samp
1347 @cindex SSL protocol, choose
1348 @item --secure-protocol=@var{protocol}
1349 Choose the secure protocol to be used.  Legal values are @samp{auto},
1350 @samp{SSLv2}, @samp{SSLv3}, and @samp{TLSv1}.  If @samp{auto} is used,
1351 the SSL library is given the liberty of choosing the appropriate
1352 protocol automatically, which is achieved by sending an SSLv2 greeting
1353 and announcing support for SSLv3 and TLSv1.  This is the default.
1354
1355 Specifying @samp{SSLv2}, @samp{SSLv3}, or @samp{TLSv1} forces the use
1356 of the corresponding protocol.  This is useful when talking to old and
1357 buggy SSL server implementations that make it hard for OpenSSL to
1358 choose the correct protocol version.  Fortunately, such servers are
1359 quite rare.
1360
1361 @cindex SSL certificate, check
1362 @item --no-check-certificate
1363 Don't check the server certificate against the available certificate
1364 authorities.  Also don't require the URL host name to match the common
1365 name presented by the certificate.
1366
1367 As of Wget 1.10, the default is to verify the server's certificate
1368 against the recognized certificate authorities, breaking the SSL
1369 handshake and aborting the download if the verification fails.
1370 Although this provides more secure downloads, it does break
1371 interoperability with some sites that worked with previous Wget
1372 versions, particularly those using self-signed, expired, or otherwise
1373 invalid certificates.  This option forces an ``insecure'' mode of
1374 operation that turns the certificate verification errors into warnings
1375 and allows you to proceed.
1376
1377 If you encounter ``certificate verification'' errors or ones saying
1378 that ``common name doesn't match requested host name'', you can use
1379 this option to bypass the verification and proceed with the download.
1380 @emph{Only use this option if you are otherwise convinced of the
1381 site's authenticity, or if you really don't care about the validity of
1382 its certificate.}  It is almost always a bad idea not to check the
1383 certificates when transmitting confidential or important data.
1384
1385 @cindex SSL certificate
1386 @item --certificate=@var{file}
1387 Use the client certificate stored in @var{file}.  This is needed for
1388 servers that are configured to require certificates from the clients
1389 that connect to them.  Normally a certificate is not required and this
1390 switch is optional.
1391
1392 @cindex SSL certificate type, specify
1393 @item --certificate-type=@var{type}
1394 Specify the type of the client certificate.  Legal values are
1395 @samp{PEM} (assumed by default) and @samp{DER}, also known as
1396 @samp{ASN1}.
1397
1398 @item --private-key=@var{file}
1399 Read the private key from @var{file}.  This allows you to provide the
1400 private key in a file separate from the certificate.
1401
1402 @item --private-key-type=@var{type}
1403 Specify the type of the private key.  Accepted values are @samp{PEM}
1404 (the default) and @samp{DER}.
1405
1406 @item --ca-certificate=@var{file}
1407 Use @var{file} as the file with the bundle of certificate authorities
1408 (``CA'') to verify the peers.  The certificates must be in PEM format.
1409
1410 Without this option Wget looks for CA certificates at the
1411 system-specified locations, chosen at OpenSSL installation time.
1412
1413 @cindex SSL certificate authority
1414 @item --ca-directory=@var{directory}
1415 Specifies directory containing CA certificates in PEM format.  Each
1416 file contains one CA certificate, and the file name is based on a hash
1417 value derived from the certificate.  This is achieved by processing a
1418 certificate directory with the @code{c_rehash} utility supplied with
1419 OpenSSL.  Using @samp{--ca-directory} is more efficient than
1420 @samp{--ca-certificate} when many certificates are installed because
1421 it allows Wget to fetch certificates on demand.
1422
1423 Without this option Wget looks for CA certificates at the
1424 system-specified locations, chosen at OpenSSL installation time.
1425
1426 @cindex entropy, specifying source of
1427 @cindex randomness, specifying source of
1428 @item --random-file=@var{file}
1429 Use @var{file} as the source of random data for seeding the
1430 pseudo-random number generator on systems without @file{/dev/random}.
1431
1432 On such systems the SSL library needs an external source of randomness
1433 to initialize.  Randomness may be provided by EGD (see
1434 @samp{--egd-file} below) or read from an external source specified by
1435 the user.  If this option is not specified, Wget looks for random data
1436 in @code{$RANDFILE} or, if that is unset, in @file{$HOME/.rnd}.  If
1437 none of those are available, it is likely that SSL encryption will not
1438 be usable.
1439
1440 If you're getting the ``Could not seed OpenSSL PRNG; disabling SSL.'' 
1441 error, you should provide random data using some of the methods
1442 described above.
1443
1444 @cindex EGD
1445 @item --egd-file=@var{file}
1446 Use @var{file} as the EGD socket.  EGD stands for @dfn{Entropy
1447 Gathering Daemon}, a user-space program that collects data from
1448 various unpredictable system sources and makes it available to other
1449 programs that might need it.  Encryption software, such as the SSL
1450 library, needs sources of non-repeating randomness to seed the random
1451 number generator used to produce cryptographically strong keys.
1452
1453 OpenSSL allows the user to specify his own source of entropy using the
1454 @code{RAND_FILE} environment variable.  If this variable is unset, or
1455 if the specified file does not produce enough randomness, OpenSSL will
1456 read random data from EGD socket specified using this option.
1457
1458 If this option is not specified (and the equivalent startup command is
1459 not used), EGD is never contacted.  EGD is not needed on modern Unix
1460 systems that support @file{/dev/random}.
1461 @end table
1462
1463 @node FTP Options
1464 @section FTP Options
1465
1466 @table @samp
1467 @cindex ftp user
1468 @cindex ftp password
1469 @cindex ftp authentication
1470 @item --ftp-user=@var{user}
1471 @itemx --ftp-password=@var{password}
1472 Specify the username @var{user} and password @var{password} on an
1473 @sc{ftp} server.  Without this, or the corresponding startup option, 
1474 the password defaults to @samp{-wget@@}, normally used for anonymous 
1475 FTP.
1476
1477 Another way to specify username and password is in the @sc{url} itself
1478 (@pxref{URL Format}).  Either method reveals your password to anyone who
1479 bothers to run @code{ps}.  To prevent the passwords from being seen,
1480 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
1481 those files from other users with @code{chmod}.  If the passwords are
1482 really important, do not leave them lying in those files either---edit
1483 the files and delete them after Wget has started the download.
1484
1485 @iftex
1486 For more information about security issues with Wget, @xref{Security
1487 Considerations}.
1488 @end iftex
1489
1490 @cindex .listing files, removing
1491 @item --no-remove-listing
1492 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1493 retrievals.  Normally, these files contain the raw directory listings
1494 received from @sc{ftp} servers.  Not removing them can be useful for
1495 debugging purposes, or when you want to be able to easily check on the
1496 contents of remote server directories (e.g. to verify that a mirror
1497 you're running is complete).
1498
1499 Note that even though Wget writes to a known filename for this file,
1500 this is not a security hole in the scenario of a user making
1501 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1502 asking @code{root} to run Wget in his or her directory.  Depending on
1503 the options used, either Wget will refuse to write to @file{.listing},
1504 making the globbing/recursion/time-stamping operation fail, or the
1505 symbolic link will be deleted and replaced with the actual
1506 @file{.listing} file, or the listing will be written to a
1507 @file{.listing.@var{number}} file.
1508
1509 Even though this situation isn't a problem, though, @code{root} should
1510 never run Wget in a non-trusted user's directory.  A user could do
1511 something as simple as linking @file{index.html} to @file{/etc/passwd}
1512 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1513 will be overwritten.
1514
1515 @cindex globbing, toggle
1516 @item --no-glob
1517 Turn off @sc{ftp} globbing.  Globbing refers to the use of shell-like
1518 special characters (@dfn{wildcards}), like @samp{*}, @samp{?}, @samp{[}
1519 and @samp{]} to retrieve more than one file from the same directory at
1520 once, like:
1521
1522 @example
1523 wget ftp://gnjilux.srk.fer.hr/*.msg
1524 @end example
1525
1526 By default, globbing will be turned on if the @sc{url} contains a
1527 globbing character.  This option may be used to turn globbing on or off
1528 permanently.
1529
1530 You may have to quote the @sc{url} to protect it from being expanded by
1531 your shell.  Globbing makes Wget look for a directory listing, which is
1532 system-specific.  This is why it currently works only with Unix @sc{ftp}
1533 servers (and the ones emulating Unix @code{ls} output).
1534
1535 @cindex passive ftp
1536 @item --no-passive-ftp
1537 Disable the use of the @dfn{passive} FTP transfer mode.  Passive FTP
1538 mandates that the client connect to the server to establish the data
1539 connection rather than the other way around.
1540
1541 If the machine is connected to the Internet directly, both passive and
1542 active FTP should work equally well.  Behind most firewall and NAT
1543 configurations passive FTP has a better chance of working.  However,
1544 in some rare firewall configurations, active FTP actually works when
1545 passive FTP doesn't.  If you suspect this to be the case, use this
1546 option, or set @code{passive_ftp=off} in your init file.
1547
1548 @cindex symbolic links, retrieving
1549 @item --retr-symlinks
1550 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1551 link is encountered, the linked-to file is not downloaded.  Instead, a
1552 matching symbolic link is created on the local filesystem.  The
1553 pointed-to file will not be downloaded unless this recursive retrieval
1554 would have encountered it separately and downloaded it anyway.
1555
1556 When @samp{--retr-symlinks} is specified, however, symbolic links are
1557 traversed and the pointed-to files are retrieved.  At this time, this
1558 option does not cause Wget to traverse symlinks to directories and
1559 recurse through them, but in the future it should be enhanced to do
1560 this.
1561
1562 Note that when retrieving a file (not a directory) because it was
1563 specified on the command-line, rather than because it was recursed to,
1564 this option has no effect.  Symbolic links are always traversed in this
1565 case.
1566
1567 @cindex Keep-Alive, turning off
1568 @cindex Persistent Connections, disabling
1569 @item --no-http-keep-alive
1570 Turn off the ``keep-alive'' feature for HTTP downloads.  Normally, Wget
1571 asks the server to keep the connection open so that, when you download
1572 more than one document from the same server, they get transferred over
1573 the same TCP connection.  This saves time and at the same time reduces
1574 the load on the server.
1575
1576 This option is useful when, for some reason, persistent (keep-alive)
1577 connections don't work for you, for example due to a server bug or due
1578 to the inability of server-side scripts to cope with the connections.
1579 @end table
1580
1581 @node Recursive Retrieval Options
1582 @section Recursive Retrieval Options
1583
1584 @table @samp
1585 @item -r
1586 @itemx --recursive
1587 Turn on recursive retrieving.  @xref{Recursive Download}, for more
1588 details.
1589
1590 @item -l @var{depth}
1591 @itemx --level=@var{depth}
1592 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1593 Download}).  The default maximum depth is 5.
1594
1595 @cindex proxy filling
1596 @cindex delete after retrieval
1597 @cindex filling proxy cache
1598 @item --delete-after
1599 This option tells Wget to delete every single file it downloads,
1600 @emph{after} having done so.  It is useful for pre-fetching popular
1601 pages through a proxy, e.g.:
1602
1603 @example
1604 wget -r -nd --delete-after http://whatever.com/~popular/page/
1605 @end example
1606
1607 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1608 create directories.  
1609
1610 Note that @samp{--delete-after} deletes files on the local machine.  It
1611 does not issue the @samp{DELE} command to remote FTP sites, for
1612 instance.  Also note that when @samp{--delete-after} is specified,
1613 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1614 created in the first place.
1615
1616 @cindex conversion of links
1617 @cindex link conversion
1618 @item -k
1619 @itemx --convert-links
1620 After the download is complete, convert the links in the document to
1621 make them suitable for local viewing.  This affects not only the visible
1622 hyperlinks, but any part of the document that links to external content,
1623 such as embedded images, links to style sheets, hyperlinks to non-@sc{html}
1624 content, etc.
1625
1626 Each link will be changed in one of the two ways:
1627
1628 @itemize @bullet
1629 @item
1630 The links to files that have been downloaded by Wget will be changed to
1631 refer to the file they point to as a relative link.
1632
1633 Example: if the downloaded file @file{/foo/doc.html} links to
1634 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1635 will be modified to point to @samp{../bar/img.gif}.  This kind of
1636 transformation works reliably for arbitrary combinations of directories.
1637
1638 @item
1639 The links to files that have not been downloaded by Wget will be changed
1640 to include host name and absolute path of the location they point to.
1641
1642 Example: if the downloaded file @file{/foo/doc.html} links to
1643 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1644 @file{doc.html} will be modified to point to
1645 @file{http://@var{hostname}/bar/img.gif}.
1646 @end itemize
1647
1648 Because of this, local browsing works reliably: if a linked file was
1649 downloaded, the link will refer to its local name; if it was not
1650 downloaded, the link will refer to its full Internet address rather than
1651 presenting a broken link.  The fact that the former links are converted
1652 to relative links ensures that you can move the downloaded hierarchy to
1653 another directory.
1654
1655 Note that only at the end of the download can Wget know which links have
1656 been downloaded.  Because of that, the work done by @samp{-k} will be
1657 performed at the end of all the downloads.
1658
1659 @cindex backing up converted files
1660 @item -K
1661 @itemx --backup-converted
1662 When converting a file, back up the original version with a @samp{.orig}
1663 suffix.  Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1664 Internals}).
1665
1666 @item -m
1667 @itemx --mirror
1668 Turn on options suitable for mirroring.  This option turns on recursion
1669 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1670 directory listings.  It is currently equivalent to
1671 @samp{-r -N -l inf --no-remove-listing}.
1672
1673 @cindex page requisites
1674 @cindex required images, downloading
1675 @item -p
1676 @itemx --page-requisites
1677 This option causes Wget to download all the files that are necessary to
1678 properly display a given @sc{html} page.  This includes such things as
1679 inlined images, sounds, and referenced stylesheets.
1680
1681 Ordinarily, when downloading a single @sc{html} page, any requisite documents
1682 that may be needed to display it properly are not downloaded.  Using
1683 @samp{-r} together with @samp{-l} can help, but since Wget does not
1684 ordinarily distinguish between external and inlined documents, one is
1685 generally left with ``leaf documents'' that are missing their
1686 requisites.
1687
1688 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1689 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1690 document @file{2.html}.  Say that @file{2.html} is similar but that its
1691 image is @file{2.gif} and it links to @file{3.html}.  Say this
1692 continues up to some arbitrarily high number.
1693
1694 If one executes the command:
1695
1696 @example
1697 wget -r -l 2 http://@var{site}/1.html
1698 @end example
1699
1700 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1701 @file{3.html} will be downloaded.  As you can see, @file{3.html} is
1702 without its requisite @file{3.gif} because Wget is simply counting the
1703 number of hops (up to 2) away from @file{1.html} in order to determine
1704 where to stop the recursion.  However, with this command:
1705
1706 @example
1707 wget -r -l 2 -p http://@var{site}/1.html
1708 @end example
1709
1710 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1711 will be downloaded.  Similarly,
1712
1713 @example
1714 wget -r -l 1 -p http://@var{site}/1.html
1715 @end example
1716
1717 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1718 to be downloaded.  One might think that:
1719
1720 @example
1721 wget -r -l 0 -p http://@var{site}/1.html
1722 @end example
1723
1724 would download just @file{1.html} and @file{1.gif}, but unfortunately
1725 this is not the case, because @samp{-l 0} is equivalent to
1726 @samp{-l inf}---that is, infinite recursion.  To download a single @sc{html}
1727 page (or a handful of them, all specified on the command-line or in a
1728 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1729 @samp{-r} and @samp{-l}:
1730
1731 @example
1732 wget -p http://@var{site}/1.html
1733 @end example
1734
1735 Note that Wget will behave as if @samp{-r} had been specified, but only
1736 that single page and its requisites will be downloaded.  Links from that
1737 page to external documents will not be followed.  Actually, to download
1738 a single page and all its requisites (even if they exist on separate
1739 websites), and make sure the lot displays properly locally, this author
1740 likes to use a few options in addition to @samp{-p}:
1741
1742 @example
1743 wget -E -H -k -K -p http://@var{site}/@var{document}
1744 @end example
1745
1746 To finish off this topic, it's worth knowing that Wget's idea of an
1747 external document link is any URL specified in an @code{<A>} tag, an
1748 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1749 REL="stylesheet">}.
1750
1751 @cindex @sc{html} comments
1752 @cindex comments, @sc{html}
1753 @item --strict-comments
1754 Turn on strict parsing of @sc{html} comments.  The default is to terminate
1755 comments at the first occurrence of @samp{-->}.
1756
1757 According to specifications, @sc{html} comments are expressed as @sc{sgml}
1758 @dfn{declarations}.  Declaration is special markup that begins with
1759 @samp{<!} and ends with @samp{>}, such as @samp{<!DOCTYPE ...>}, that
1760 may contain comments between a pair of @samp{--} delimiters.  @sc{html}
1761 comments are ``empty declarations'', @sc{sgml} declarations without any
1762 non-comment text.  Therefore, @samp{<!--foo-->} is a valid comment, and
1763 so is @samp{<!--one-- --two-->}, but @samp{<!--1--2-->} is not.
1764
1765 On the other hand, most @sc{html} writers don't perceive comments as anything
1766 other than text delimited with @samp{<!--} and @samp{-->}, which is not
1767 quite the same.  For example, something like @samp{<!------------>}
1768 works as a valid comment as long as the number of dashes is a multiple
1769 of four (!).  If not, the comment technically lasts until the next
1770 @samp{--}, which may be at the other end of the document.  Because of
1771 this, many popular browsers completely ignore the specification and
1772 implement what users have come to expect: comments delimited with
1773 @samp{<!--} and @samp{-->}.
1774
1775 Until version 1.9, Wget interpreted comments strictly, which resulted in
1776 missing links in many web pages that displayed fine in browsers, but had
1777 the misfortune of containing non-compliant comments.  Beginning with
1778 version 1.9, Wget has joined the ranks of clients that implements
1779 ``naive'' comments, terminating each comment at the first occurrence of
1780 @samp{-->}.
1781
1782 If, for whatever reason, you want strict comment parsing, use this
1783 option to turn it on.
1784 @end table
1785
1786 @node Recursive Accept/Reject Options
1787 @section Recursive Accept/Reject Options
1788
1789 @table @samp
1790 @item -A @var{acclist} --accept @var{acclist}
1791 @itemx -R @var{rejlist} --reject @var{rejlist}
1792 Specify comma-separated lists of file name suffixes or patterns to
1793 accept or reject (@pxref{Types of Files} for more details).
1794
1795 @item -D @var{domain-list}
1796 @itemx --domains=@var{domain-list}
1797 Set domains to be followed.  @var{domain-list} is a comma-separated list
1798 of domains.  Note that it does @emph{not} turn on @samp{-H}.
1799
1800 @item --exclude-domains @var{domain-list}
1801 Specify the domains that are @emph{not} to be followed.
1802 (@pxref{Spanning Hosts}).
1803
1804 @cindex follow FTP links
1805 @item --follow-ftp
1806 Follow @sc{ftp} links from @sc{html} documents.  Without this option,
1807 Wget will ignore all the @sc{ftp} links.
1808
1809 @cindex tag-based recursive pruning
1810 @item --follow-tags=@var{list}
1811 Wget has an internal table of @sc{html} tag / attribute pairs that it
1812 considers when looking for linked documents during a recursive
1813 retrieval.  If a user wants only a subset of those tags to be
1814 considered, however, he or she should be specify such tags in a
1815 comma-separated @var{list} with this option.
1816
1817 @item --ignore-tags=@var{list}
1818 This is the opposite of the @samp{--follow-tags} option.  To skip
1819 certain @sc{html} tags when recursively looking for documents to download,
1820 specify them in a comma-separated @var{list}.  
1821
1822 In the past, this option was the best bet for downloading a single page
1823 and its requisites, using a command-line like:
1824
1825 @example
1826 wget --ignore-tags=a,area -H -k -K -r http://@var{site}/@var{document}
1827 @end example
1828
1829 However, the author of this option came across a page with tags like
1830 @code{<LINK REL="home" HREF="/">} and came to the realization that
1831 specifying tags to ignore was not enough.  One can't just tell Wget to
1832 ignore @code{<LINK>}, because then stylesheets will not be downloaded.
1833 Now the best bet for downloading a single page and its requisites is the
1834 dedicated @samp{--page-requisites} option.
1835
1836 @cindex case fold
1837 @cindex ignore case
1838 @item --ignore-case
1839 Ignore case when matching files and directories.  This influences the
1840 behavior of -R, -A, -I, and -X options, as well as globbing
1841 implemented when downloading from FTP sites.  For example, with this
1842 option, @samp{-A *.txt} will match @samp{file1.txt}, but also
1843 @samp{file2.TXT}, @samp{file3.TxT}, and so on.
1844
1845 @item -H
1846 @itemx --span-hosts
1847 Enable spanning across hosts when doing recursive retrieving
1848 (@pxref{Spanning Hosts}).
1849
1850 @item -L
1851 @itemx --relative
1852 Follow relative links only.  Useful for retrieving a specific home page
1853 without any distractions, not even those from the same hosts
1854 (@pxref{Relative Links}).
1855
1856 @item -I @var{list}
1857 @itemx --include-directories=@var{list}
1858 Specify a comma-separated list of directories you wish to follow when
1859 downloading (@pxref{Directory-Based Limits} for more details.)  Elements
1860 of @var{list} may contain wildcards.
1861
1862 @item -X @var{list}
1863 @itemx --exclude-directories=@var{list}
1864 Specify a comma-separated list of directories you wish to exclude from
1865 download (@pxref{Directory-Based Limits} for more details.)  Elements of
1866 @var{list} may contain wildcards.
1867
1868 @item -np
1869 @item --no-parent
1870 Do not ever ascend to the parent directory when retrieving recursively.
1871 This is a useful option, since it guarantees that only the files
1872 @emph{below} a certain hierarchy will be downloaded.
1873 @xref{Directory-Based Limits}, for more details.
1874 @end table
1875
1876 @c man end
1877
1878 @node Recursive Download
1879 @chapter Recursive Download
1880 @cindex recursion
1881 @cindex retrieving
1882 @cindex recursive download
1883
1884 GNU Wget is capable of traversing parts of the Web (or a single
1885 @sc{http} or @sc{ftp} server), following links and directory structure.
1886 We refer to this as to @dfn{recursive retrieval}, or @dfn{recursion}.
1887
1888 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1889 the given @sc{url}, documents, retrieving the files the @sc{html}
1890 document was referring to, through markup like @code{href}, or
1891 @code{src}.  If the freshly downloaded file is also of type
1892 @code{text/html} or @code{application/xhtml+xml}, it will be parsed and 
1893 followed further.
1894
1895 Recursive retrieval of @sc{http} and @sc{html} content is
1896 @dfn{breadth-first}.  This means that Wget first downloads the requested
1897 @sc{html} document, then the documents linked from that document, then the
1898 documents linked by them, and so on.  In other words, Wget first
1899 downloads the documents at depth 1, then those at depth 2, and so on
1900 until the specified maximum depth.
1901
1902 The maximum @dfn{depth} to which the retrieval may descend is specified
1903 with the @samp{-l} option.  The default maximum depth is five layers.
1904
1905 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1906 the data from the given directory tree (including the subdirectories up
1907 to the specified depth) on the remote server, creating its mirror image
1908 locally.  @sc{ftp} retrieval is also limited by the @code{depth}
1909 parameter.  Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1910 depth-first.
1911
1912 By default, Wget will create a local directory tree, corresponding to
1913 the one found on the remote server.
1914
1915 Recursive retrieving can find a number of applications, the most
1916 important of which is mirroring.  It is also useful for @sc{www}
1917 presentations, and any other opportunities where slow network
1918 connections should be bypassed by storing the files locally.
1919
1920 You should be warned that recursive downloads can overload the remote
1921 servers.  Because of that, many administrators frown upon them and may
1922 ban access from your site if they detect very fast downloads of big
1923 amounts of content.  When downloading from Internet servers, consider
1924 using the @samp{-w} option to introduce a delay between accesses to the
1925 server.  The download will take a while longer, but the server
1926 administrator will not be alarmed by your rudeness.
1927
1928 Of course, recursive download may cause problems on your machine.  If
1929 left to run unchecked, it can easily fill up the disk.  If downloading
1930 from local network, it can also take bandwidth on the system, as well as
1931 consume memory and CPU.
1932
1933 Try to specify the criteria that match the kind of download you are
1934 trying to achieve.  If you want to download only one page, use
1935 @samp{--page-requisites} without any additional recursion.  If you want
1936 to download things under one directory, use @samp{-np} to avoid
1937 downloading things from other directories.  If you want to download all
1938 the files from one directory, use @samp{-l 1} to make sure the recursion
1939 depth never exceeds one.  @xref{Following Links}, for more information
1940 about this.
1941
1942 Recursive retrieval should be used with care.  Don't say you were not
1943 warned.
1944
1945 @node Following Links
1946 @chapter Following Links
1947 @cindex links
1948 @cindex following links
1949
1950 When retrieving recursively, one does not wish to retrieve loads of
1951 unnecessary data.  Most of the time the users bear in mind exactly what
1952 they want to download, and want Wget to follow only specific links.
1953
1954 For example, if you wish to download the music archive from
1955 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1956 that happen to be referenced by an obscure part of the archive.
1957
1958 Wget possesses several mechanisms that allows you to fine-tune which
1959 links it will follow.
1960
1961 @menu
1962 * Spanning Hosts::         (Un)limiting retrieval based on host name.
1963 * Types of Files::         Getting only certain files.
1964 * Directory-Based Limits:: Getting only certain directories.
1965 * Relative Links::         Follow relative links only.
1966 * FTP Links::              Following FTP links.
1967 @end menu
1968
1969 @node Spanning Hosts
1970 @section Spanning Hosts
1971 @cindex spanning hosts
1972 @cindex hosts, spanning
1973
1974 Wget's recursive retrieval normally refuses to visit hosts different
1975 than the one you specified on the command line.  This is a reasonable
1976 default; without it, every retrieval would have the potential to turn
1977 your Wget into a small version of google.
1978
1979 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1980 a useful option.  Maybe the images are served from a different server.
1981 Maybe you're mirroring a site that consists of pages interlinked between
1982 three servers.  Maybe the server has two equivalent names, and the @sc{html}
1983 pages refer to both interchangeably.
1984
1985 @table @asis
1986 @item Span to any host---@samp{-H}
1987
1988 The @samp{-H} option turns on host spanning, thus allowing Wget's
1989 recursive run to visit any host referenced by a link.  Unless sufficient
1990 recursion-limiting criteria are applied depth, these foreign hosts will
1991 typically link to yet more hosts, and so on until Wget ends up sucking
1992 up much more data than you have intended.
1993
1994 @item Limit spanning to certain domains---@samp{-D}
1995
1996 The @samp{-D} option allows you to specify the domains that will be
1997 followed, thus limiting the recursion only to the hosts that belong to
1998 these domains.  Obviously, this makes sense only in conjunction with
1999 @samp{-H}.  A typical example would be downloading the contents of
2000 @samp{www.server.com}, but allowing downloads from
2001 @samp{images.server.com}, etc.:
2002
2003 @example
2004 wget -rH -Dserver.com http://www.server.com/
2005 @end example
2006
2007 You can specify more than one address by separating them with a comma,
2008 e.g. @samp{-Ddomain1.com,domain2.com}.
2009
2010 @item Keep download off certain domains---@samp{--exclude-domains}
2011
2012 If there are domains you want to exclude specifically, you can do it
2013 with @samp{--exclude-domains}, which accepts the same type of arguments
2014 of @samp{-D}, but will @emph{exclude} all the listed domains.  For
2015 example, if you want to download all the hosts from @samp{foo.edu}
2016 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
2017 this:
2018
2019 @example
2020 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
2021     http://www.foo.edu/
2022 @end example
2023
2024 @end table
2025
2026 @node Types of Files
2027 @section Types of Files
2028 @cindex types of files
2029
2030 When downloading material from the web, you will often want to restrict
2031 the retrieval to only certain file types.  For example, if you are
2032 interested in downloading @sc{gif}s, you will not be overjoyed to get
2033 loads of PostScript documents, and vice versa.
2034
2035 Wget offers two options to deal with this problem.  Each option
2036 description lists a short name, a long name, and the equivalent command
2037 in @file{.wgetrc}.
2038
2039 @cindex accept wildcards
2040 @cindex accept suffixes
2041 @cindex wildcards, accept
2042 @cindex suffixes, accept
2043 @table @samp
2044 @item -A @var{acclist}
2045 @itemx --accept @var{acclist}
2046 @itemx accept = @var{acclist}
2047 The argument to @samp{--accept} option is a list of file suffixes or
2048 patterns that Wget will download during recursive retrieval.  A suffix
2049 is the ending part of a file, and consists of ``normal'' letters,
2050 e.g. @samp{gif} or @samp{.jpg}.  A matching pattern contains shell-like
2051 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
2052
2053 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
2054 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
2055 @sc{jpeg}s.  On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
2056 download only files beginning with @samp{zelazny} and containing numbers
2057 from 1960 to 1969 anywhere within.  Look up the manual of your shell for
2058 a description of how pattern matching works.
2059
2060 Of course, any number of suffixes and patterns can be combined into a
2061 comma-separated list, and given as an argument to @samp{-A}.
2062
2063 @cindex reject wildcards
2064 @cindex reject suffixes
2065 @cindex wildcards, reject
2066 @cindex suffixes, reject
2067 @item -R @var{rejlist}
2068 @itemx --reject @var{rejlist}
2069 @itemx reject = @var{rejlist}
2070 The @samp{--reject} option works the same way as @samp{--accept}, only
2071 its logic is the reverse; Wget will download all files @emph{except} the
2072 ones matching the suffixes (or patterns) in the list.
2073
2074 So, if you want to download a whole page except for the cumbersome
2075 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
2076 Analogously, to download all files except the ones beginning with
2077 @samp{bjork}, use @samp{wget -R "bjork*"}.  The quotes are to prevent
2078 expansion by the shell.
2079 @end table
2080
2081 The @samp{-A} and @samp{-R} options may be combined to achieve even
2082 better fine-tuning of which files to retrieve.  E.g. @samp{wget -A
2083 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
2084 a part of their name, but @emph{not} the PostScript files.
2085
2086 Note that these two options do not affect the downloading of @sc{html}
2087 files; Wget must load all the @sc{html}s to know where to go at
2088 all---recursive retrieval would make no sense otherwise.
2089
2090 @node Directory-Based Limits
2091 @section Directory-Based Limits
2092 @cindex directories
2093 @cindex directory limits
2094
2095 Regardless of other link-following facilities, it is often useful to
2096 place the restriction of what files to retrieve based on the directories
2097 those files are placed in.  There can be many reasons for this---the
2098 home pages may be organized in a reasonable directory structure; or some
2099 directories may contain useless information, e.g. @file{/cgi-bin} or
2100 @file{/dev} directories.
2101
2102 Wget offers three different options to deal with this requirement.  Each
2103 option description lists a short name, a long name, and the equivalent
2104 command in @file{.wgetrc}.
2105
2106 @cindex directories, include
2107 @cindex include directories
2108 @cindex accept directories
2109 @table @samp
2110 @item -I @var{list}
2111 @itemx --include @var{list}
2112 @itemx include_directories = @var{list}
2113 @samp{-I} option accepts a comma-separated list of directories included
2114 in the retrieval.  Any other directories will simply be ignored.  The
2115 directories are absolute paths.
2116
2117 So, if you wish to download from @samp{http://host/people/bozo/}
2118 following only links to bozo's colleagues in the @file{/people}
2119 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
2120
2121 @example
2122 wget -I /people,/cgi-bin http://host/people/bozo/
2123 @end example
2124
2125 @cindex directories, exclude
2126 @cindex exclude directories
2127 @cindex reject directories
2128 @item -X @var{list}
2129 @itemx --exclude @var{list}
2130 @itemx exclude_directories = @var{list}
2131 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
2132 directories @emph{excluded} from the download.  E.g. if you do not want
2133 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
2134 /cgi-bin} on the command line.
2135
2136 The same as with @samp{-A}/@samp{-R}, these two options can be combined
2137 to get a better fine-tuning of downloading subdirectories.  E.g. if you
2138 want to load all the files from @file{/pub} hierarchy except for
2139 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
2140
2141 @cindex no parent
2142 @item -np
2143 @itemx --no-parent
2144 @itemx no_parent = on
2145 The simplest, and often very useful way of limiting directories is
2146 disallowing retrieval of the links that refer to the hierarchy
2147 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
2148 parent directory/directories.
2149
2150 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
2151 Using it guarantees that you will never leave the existing hierarchy.
2152 Supposing you issue Wget with:
2153
2154 @example
2155 wget -r --no-parent http://somehost/~luzer/my-archive/
2156 @end example
2157
2158 You may rest assured that none of the references to
2159 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
2160 followed.  Only the archive you are interested in will be downloaded.
2161 Essentially, @samp{--no-parent} is similar to
2162 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
2163 intelligent fashion.
2164 @end table
2165
2166 @node Relative Links
2167 @section Relative Links
2168 @cindex relative links
2169
2170 When @samp{-L} is turned on, only the relative links are ever followed.
2171 Relative links are here defined those that do not refer to the web
2172 server root.  For example, these links are relative:
2173
2174 @example
2175 <a href="foo.gif">
2176 <a href="foo/bar.gif">
2177 <a href="../foo/bar.gif">
2178 @end example
2179
2180 These links are not relative:
2181
2182 @example
2183 <a href="/foo.gif">
2184 <a href="/foo/bar.gif">
2185 <a href="http://www.server.com/foo/bar.gif">
2186 @end example
2187
2188 Using this option guarantees that recursive retrieval will not span
2189 hosts, even without @samp{-H}.  In simple cases it also allows downloads
2190 to ``just work'' without having to convert links.
2191
2192 This option is probably not very useful and might be removed in a future
2193 release.
2194
2195 @node FTP Links
2196 @section Following FTP Links
2197 @cindex following ftp links
2198
2199 The rules for @sc{ftp} are somewhat specific, as it is necessary for
2200 them to be.  @sc{ftp} links in @sc{html} documents are often included
2201 for purposes of reference, and it is often inconvenient to download them
2202 by default.
2203
2204 To have @sc{ftp} links followed from @sc{html} documents, you need to
2205 specify the @samp{--follow-ftp} option.  Having done that, @sc{ftp}
2206 links will span hosts regardless of @samp{-H} setting.  This is logical,
2207 as @sc{ftp} links rarely point to the same host where the @sc{http}
2208 server resides.  For similar reasons, the @samp{-L} options has no
2209 effect on such downloads.  On the other hand, domain acceptance
2210 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
2211
2212 Also note that followed links to @sc{ftp} directories will not be
2213 retrieved recursively further.
2214
2215 @node Time-Stamping
2216 @chapter Time-Stamping
2217 @cindex time-stamping
2218 @cindex timestamping
2219 @cindex updating the archives
2220 @cindex incremental updating
2221
2222 One of the most important aspects of mirroring information from the
2223 Internet is updating your archives.
2224
2225 Downloading the whole archive again and again, just to replace a few
2226 changed files is expensive, both in terms of wasted bandwidth and money,
2227 and the time to do the update.  This is why all the mirroring tools
2228 offer the option of incremental updating.
2229
2230 Such an updating mechanism means that the remote server is scanned in
2231 search of @dfn{new} files.  Only those new files will be downloaded in
2232 the place of the old ones.
2233
2234 A file is considered new if one of these two conditions are met:
2235
2236 @enumerate
2237 @item
2238 A file of that name does not already exist locally.
2239
2240 @item
2241 A file of that name does exist, but the remote file was modified more
2242 recently than the local file.
2243 @end enumerate
2244
2245 To implement this, the program needs to be aware of the time of last
2246 modification of both local and remote files.  We call this information the
2247 @dfn{time-stamp} of a file.
2248
2249 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
2250 (@samp{-N}) option, or through @code{timestamping = on} directive in
2251 @file{.wgetrc}.  With this option, for each file it intends to download,
2252 Wget will check whether a local file of the same name exists.  If it
2253 does, and the remote file is older, Wget will not download it.
2254
2255 If the local file does not exist, or the sizes of the files do not
2256 match, Wget will download the remote file no matter what the time-stamps
2257 say.
2258
2259 @menu
2260 * Time-Stamping Usage::
2261 * HTTP Time-Stamping Internals::
2262 * FTP Time-Stamping Internals::
2263 @end menu
2264
2265 @node Time-Stamping Usage
2266 @section Time-Stamping Usage
2267 @cindex time-stamping usage
2268 @cindex usage, time-stamping
2269
2270 The usage of time-stamping is simple.  Say you would like to download a
2271 file so that it keeps its date of modification.
2272
2273 @example
2274 wget -S http://www.gnu.ai.mit.edu/
2275 @end example
2276
2277 A simple @code{ls -l} shows that the time stamp on the local file equals
2278 the state of the @code{Last-Modified} header, as returned by the server.
2279 As you can see, the time-stamping info is preserved locally, even
2280 without @samp{-N} (at least for @sc{http}).
2281
2282 Several days later, you would like Wget to check if the remote file has
2283 changed, and download it if it has.
2284
2285 @example
2286 wget -N http://www.gnu.ai.mit.edu/
2287 @end example
2288
2289 Wget will ask the server for the last-modified date.  If the local file
2290 has the same timestamp as the server, or a newer one, the remote file
2291 will not be re-fetched.  However, if the remote file is more recent,
2292 Wget will proceed to fetch it.
2293
2294 The same goes for @sc{ftp}.  For example:
2295
2296 @example
2297 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
2298 @end example
2299
2300 (The quotes around that URL are to prevent the shell from trying to
2301 interpret the @samp{*}.)
2302
2303 After download, a local directory listing will show that the timestamps
2304 match those on the remote server.  Reissuing the command with @samp{-N}
2305 will make Wget re-fetch @emph{only} the files that have been modified
2306 since the last download.
2307
2308 If you wished to mirror the GNU archive every week, you would use a
2309 command like the following, weekly:
2310
2311 @example
2312 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
2313 @end example
2314
2315 Note that time-stamping will only work for files for which the server
2316 gives a timestamp.  For @sc{http}, this depends on getting a
2317 @code{Last-Modified} header.  For @sc{ftp}, this depends on getting a
2318 directory listing with dates in a format that Wget can parse
2319 (@pxref{FTP Time-Stamping Internals}).
2320
2321 @node HTTP Time-Stamping Internals
2322 @section HTTP Time-Stamping Internals
2323 @cindex http time-stamping
2324
2325 Time-stamping in @sc{http} is implemented by checking of the
2326 @code{Last-Modified} header.  If you wish to retrieve the file
2327 @file{foo.html} through @sc{http}, Wget will check whether
2328 @file{foo.html} exists locally.  If it doesn't, @file{foo.html} will be
2329 retrieved unconditionally.
2330
2331 If the file does exist locally, Wget will first check its local
2332 time-stamp (similar to the way @code{ls -l} checks it), and then send a
2333 @code{HEAD} request to the remote server, demanding the information on
2334 the remote file.
2335
2336 The @code{Last-Modified} header is examined to find which file was
2337 modified more recently (which makes it ``newer'').  If the remote file
2338 is newer, it will be downloaded; if it is older, Wget will give
2339 up.@footnote{As an additional check, Wget will look at the
2340 @code{Content-Length} header, and compare the sizes; if they are not the
2341 same, the remote file will be downloaded no matter what the time-stamp
2342 says.}
2343
2344 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
2345 with @samp{-N}, server file @samp{@var{X}} is compared to local file
2346 @samp{@var{X}.orig}, if extant, rather than being compared to local file
2347 @samp{@var{X}}, which will always differ if it's been converted by
2348 @samp{--convert-links} (@samp{-k}).
2349
2350 Arguably, @sc{http} time-stamping should be implemented using the
2351 @code{If-Modified-Since} request.
2352
2353 @node FTP Time-Stamping Internals
2354 @section FTP Time-Stamping Internals
2355 @cindex ftp time-stamping
2356
2357 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
2358 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
2359 listings.
2360
2361 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
2362 @sc{ftp} @code{LIST} command to get a file listing for the directory
2363 containing the desired file(s).  It will try to analyze the listing,
2364 treating it like Unix @code{ls -l} output, extracting the time-stamps.
2365 The rest is exactly the same as for @sc{http}.  Note that when
2366 retrieving individual files from an @sc{ftp} server without using
2367 globbing or recursion, listing files will not be downloaded (and thus
2368 files will not be time-stamped) unless @samp{-N} is specified.
2369
2370 Assumption that every directory listing is a Unix-style listing may
2371 sound extremely constraining, but in practice it is not, as many
2372 non-Unix @sc{ftp} servers use the Unixoid listing format because most
2373 (all?) of the clients understand it.  Bear in mind that @sc{rfc959}
2374 defines no standard way to get a file list, let alone the time-stamps.
2375 We can only hope that a future standard will define this.
2376
2377 Another non-standard solution includes the use of @code{MDTM} command
2378 that is supported by some @sc{ftp} servers (including the popular
2379 @code{wu-ftpd}), which returns the exact time of the specified file.
2380 Wget may support this command in the future.
2381
2382 @node Startup File
2383 @chapter Startup File
2384 @cindex startup file
2385 @cindex wgetrc
2386 @cindex .wgetrc
2387 @cindex startup
2388 @cindex .netrc
2389
2390 Once you know how to change default settings of Wget through command
2391 line arguments, you may wish to make some of those settings permanent.
2392 You can do that in a convenient way by creating the Wget startup
2393 file---@file{.wgetrc}.
2394
2395 Besides @file{.wgetrc} is the ``main'' initialization file, it is
2396 convenient to have a special facility for storing passwords.  Thus Wget
2397 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
2398 it.  You can find @file{.netrc} format in your system manuals.
2399
2400 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
2401 commands.
2402
2403 @menu
2404 * Wgetrc Location::   Location of various wgetrc files.
2405 * Wgetrc Syntax::     Syntax of wgetrc.
2406 * Wgetrc Commands::   List of available commands.
2407 * Sample Wgetrc::     A wgetrc example.
2408 @end menu
2409
2410 @node Wgetrc Location
2411 @section Wgetrc Location
2412 @cindex wgetrc location
2413 @cindex location of wgetrc
2414
2415 When initializing, Wget will look for a @dfn{global} startup file,
2416 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
2417 @file{/usr/local}, if Wget was not installed there) and read commands
2418 from there, if it exists.
2419
2420 Then it will look for the user's file.  If the environmental variable
2421 @code{WGETRC} is set, Wget will try to load that file.  Failing that, no
2422 further attempts will be made.
2423
2424 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
2425
2426 The fact that user's settings are loaded after the system-wide ones
2427 means that in case of collision user's wgetrc @emph{overrides} the
2428 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
2429 Fascist admins, away!
2430
2431 @node Wgetrc Syntax
2432 @section Wgetrc Syntax
2433 @cindex wgetrc syntax
2434 @cindex syntax of wgetrc
2435
2436 The syntax of a wgetrc command is simple:
2437
2438 @example
2439 variable = value
2440 @end example
2441
2442 The @dfn{variable} will also be called @dfn{command}.  Valid
2443 @dfn{values} are different for different commands.
2444
2445 The commands are case-insensitive and underscore-insensitive.  Thus
2446 @samp{DIr__PrefiX} is the same as @samp{dirprefix}.  Empty lines, lines
2447 beginning with @samp{#} and lines containing white-space only are
2448 discarded.
2449
2450 Commands that expect a comma-separated list will clear the list on an
2451 empty command.  So, if you wish to reset the rejection list specified in
2452 global @file{wgetrc}, you can do it with:
2453
2454 @example
2455 reject =
2456 @end example
2457
2458 @node Wgetrc Commands
2459 @section Wgetrc Commands
2460 @cindex wgetrc commands
2461
2462 The complete set of commands is listed below.  Legal values are listed
2463 after the @samp{=}.  Simple Boolean values can be set or unset using
2464 @samp{on} and @samp{off} or @samp{1} and @samp{0}.
2465
2466 Some commands take pseudo-arbitrary values.  @var{address} values can be
2467 hostnames or dotted-quad IP addresses.  @var{n} can be any positive
2468 integer, or @samp{inf} for infinity, where appropriate.  @var{string}
2469 values can be any non-empty string.
2470
2471 Most of these commands have direct command-line equivalents.  Also, any
2472 wgetrc command can be specified on the command line using the
2473 @samp{--execute} switch (@pxref{Basic Startup Options}.)
2474
2475 @table @asis
2476 @item accept/reject = @var{string}
2477 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
2478
2479 @item add_hostdir = on/off
2480 Enable/disable host-prefixed file names.  @samp{-nH} disables it.
2481
2482 @item continue = on/off
2483 If set to on, force continuation of preexistent partially retrieved
2484 files.  See @samp{-c} before setting it.
2485
2486 @item background = on/off
2487 Enable/disable going to background---the same as @samp{-b} (which
2488 enables it).
2489
2490 @item backup_converted = on/off
2491 Enable/disable saving pre-converted files with the suffix
2492 @samp{.orig}---the same as @samp{-K} (which enables it).
2493
2494 @c @item backups = @var{number}
2495 @c #### Document me!
2496 @c
2497 @item base = @var{string}
2498 Consider relative @sc{url}s in @sc{url} input files forced to be
2499 interpreted as @sc{html} as being relative to @var{string}---the same as
2500 @samp{--base=@var{string}}.
2501
2502 @item bind_address = @var{address}
2503 Bind to @var{address}, like the @samp{--bind-address=@var{address}}.
2504
2505 @item ca_certificate = @var{file}
2506 Set the certificate authority bundle file to @var{file}.  The same
2507 as @samp{--ca-certificate=@var{file}}.
2508
2509 @item ca_directory = @var{directory}
2510 Set the directory used for certificate authorities.  The same as
2511 @samp{--ca-directory=@var{directory}}.
2512
2513 @item cache = on/off
2514 When set to off, disallow server-caching.  See the @samp{--no-cache}
2515 option.
2516
2517 @item certificate = @var{file}
2518 Set the client certificate file name to @var{file}.  The same as
2519 @samp{--certificate=@var{file}}.
2520
2521 @item certificate_type = @var{string}
2522 Specify the type of the client certificate, legal values being
2523 @samp{PEM} (the default) and @samp{DER} (aka ASN1).  The same as
2524 @samp{--certificate-type=@var{string}}.
2525
2526 @item check_certificate = on/off
2527 If this is set to off, the server certificate is not checked against
2528 the specified client authorities.  The default is ``on''.  The same as
2529 @samp{--check-certificate}.
2530
2531 @item convert_links = on/off
2532 Convert non-relative links locally.  The same as @samp{-k}.
2533
2534 @item cookies = on/off
2535 When set to off, disallow cookies.  See the @samp{--cookies} option.
2536
2537 @item connect_timeout = @var{n}
2538 Set the connect timeout---the same as @samp{--connect-timeout}.
2539
2540 @item cut_dirs = @var{n}
2541 Ignore @var{n} remote directory components.  Equivalent to
2542 @samp{--cut-dirs=@var{n}}.
2543
2544 @item debug = on/off
2545 Debug mode, same as @samp{-d}.
2546
2547 @item delete_after = on/off
2548 Delete after download---the same as @samp{--delete-after}.
2549
2550 @item dir_prefix = @var{string}
2551 Top of directory tree---the same as @samp{-P @var{string}}.
2552
2553 @item dirstruct = on/off
2554 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2555 respectively.
2556
2557 @item dns_cache = on/off
2558 Turn DNS caching on/off.  Since DNS caching is on by default, this
2559 option is normally used to turn it off and is equivalent to
2560 @samp{--no-dns-cache}.
2561
2562 @item dns_timeout = @var{n}
2563 Set the DNS timeout---the same as @samp{--dns-timeout}.
2564
2565 @item domains = @var{string}
2566 Same as @samp{-D} (@pxref{Spanning Hosts}).
2567
2568 @item dot_bytes = @var{n}
2569 Specify the number of bytes ``contained'' in a dot, as seen throughout
2570 the retrieval (1024 by default).  You can postfix the value with
2571 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2572 respectively.  With dot settings you can tailor the dot retrieval to
2573 suit your needs, or you can use the predefined @dfn{styles}
2574 (@pxref{Download Options}).
2575
2576 @item dots_in_line = @var{n}
2577 Specify the number of dots that will be printed in each line throughout
2578 the retrieval (50 by default).
2579
2580 @item dot_spacing = @var{n}
2581 Specify the number of dots in a single cluster (10 by default).
2582
2583 @item egd_file = @var{file}
2584 Use @var{string} as the EGD socket file name.  The same as
2585 @samp{--egd-file=@var{file}}.
2586
2587 @item exclude_directories = @var{string}
2588 Specify a comma-separated list of directories you wish to exclude from
2589 download---the same as @samp{-X @var{string}} (@pxref{Directory-Based
2590 Limits}).
2591
2592 @item exclude_domains = @var{string}
2593 Same as @samp{--exclude-domains=@var{string}} (@pxref{Spanning
2594 Hosts}).
2595
2596 @item follow_ftp = on/off
2597 Follow @sc{ftp} links from @sc{html} documents---the same as
2598 @samp{--follow-ftp}.
2599
2600 @item follow_tags = @var{string}
2601 Only follow certain @sc{html} tags when doing a recursive retrieval,
2602 just like @samp{--follow-tags=@var{string}}.
2603
2604 @item force_html = on/off
2605 If set to on, force the input filename to be regarded as an @sc{html}
2606 document---the same as @samp{-F}.
2607
2608 @item ftp_password = @var{string}
2609 Set your @sc{ftp} password to @var{string}.  Without this setting, the
2610 password defaults to @samp{-wget@@}, which is a useful default for
2611 anonymous @sc{ftp} access.
2612
2613 This command used to be named @code{passwd} prior to Wget 1.10.
2614
2615 @item ftp_proxy = @var{string}
2616 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2617 environment.
2618
2619 @item ftp_user = @var{string}
2620 Set @sc{ftp} user to @var{string}.
2621
2622 This command used to be named @code{login} prior to Wget 1.10.
2623
2624 @item glob = on/off
2625 Turn globbing on/off---the same as @samp{--glob} and @samp{--no-glob}.
2626
2627 @item header = @var{string}
2628 Define a header for HTTP doewnloads, like using
2629 @samp{--header=@var{string}}.
2630
2631 @item html_extension = on/off
2632 Add a @samp{.html} extension to @samp{text/html} or
2633 @samp{application/xhtml+xml} files without it, like @samp{-E}.
2634
2635 @item http_keep_alive = on/off
2636 Turn the keep-alive feature on or off (defaults to on).  Turning it
2637 off is equivalent to @samp{--no-http-keep-alive}.
2638
2639 @item http_password = @var{string}
2640 Set @sc{http} password, equivalent to
2641 @samp{--http-password=@var{string}}.
2642
2643 @item http_proxy = @var{string}
2644 Use @var{string} as @sc{http} proxy, instead of the one specified in
2645 environment.
2646
2647 @item http_user = @var{string}
2648 Set @sc{http} user to @var{string}, equivalent to
2649 @samp{--http-user=@var{string}}.
2650
2651 @item https_proxy = @var{string}
2652 Use @var{string} as @sc{https} proxy, instead of the one specified in
2653 environment.
2654
2655 @item ignore_case = on/off
2656 When set to on, match files and directories case insensitively; the
2657 same as @samp{--ignore-case}.
2658
2659 @item ignore_length = on/off
2660 When set to on, ignore @code{Content-Length} header; the same as
2661 @samp{--ignore-length}.
2662
2663 @item ignore_tags = @var{string}
2664 Ignore certain @sc{html} tags when doing a recursive retrieval, like
2665 @samp{--ignore-tags=@var{string}}.
2666
2667 @item include_directories = @var{string}
2668 Specify a comma-separated list of directories you wish to follow when
2669 downloading---the same as @samp{-I @var{string}}.
2670
2671 @item inet4_only = on/off
2672 Force connecting to IPv4 addresses, off by default.  You can put this
2673 in the global init file to disable Wget's attempts to resolve and
2674 connect to IPv6 hosts.  Available only if Wget was compiled with IPv6
2675 support.  The same as @samp{--inet4-only} or @samp{-4}.
2676
2677 @item inet6_only = on/off
2678 Force connecting to IPv6 addresses, off by default.  Available only if
2679 Wget was compiled with IPv6 support.  The same as @samp{--inet6-only}
2680 or @samp{-6}.
2681
2682 @item input = @var{file}
2683 Read the @sc{url}s from @var{string}, like @samp{-i @var{file}}.
2684
2685 @item limit_rate = @var{rate}
2686 Limit the download speed to no more than @var{rate} bytes per second.
2687 The same as @samp{--limit-rate=@var{rate}}.
2688
2689 @item load_cookies = @var{file}
2690 Load cookies from @var{file}.  See @samp{--load-cookies @var{file}}.
2691
2692 @item logfile = @var{file}
2693 Set logfile to @var{file}, the same as @samp{-o @var{file}}.
2694
2695 @item mirror = on/off
2696 Turn mirroring on/off.  The same as @samp{-m}.
2697
2698 @item netrc = on/off
2699 Turn reading netrc on or off.
2700
2701 @item noclobber = on/off
2702 Same as @samp{-nc}.
2703
2704 @item no_parent = on/off
2705 Disallow retrieving outside the directory hierarchy, like
2706 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2707
2708 @item no_proxy = @var{string}
2709 Use @var{string} as the comma-separated list of domains to avoid in
2710 proxy loading, instead of the one specified in environment.
2711
2712 @item output_document = @var{file}
2713 Set the output filename---the same as @samp{-O @var{file}}.
2714
2715 @item page_requisites = on/off
2716 Download all ancillary documents necessary for a single @sc{html} page to
2717 display properly---the same as @samp{-p}.
2718
2719 @item passive_ftp = on/off
2720 Change setting of passive @sc{ftp}, equivalent to the
2721 @samp{--passive-ftp} option.
2722
2723 @itemx password = @var{string}
2724 Specify password @var{string} for both @sc{ftp} and @sc{http} file retrieval. 
2725 This command can be overridden using the @samp{ftp_password} and 
2726 @samp{http_password} command for @sc{ftp} and @sc{http} respectively.
2727
2728 @item post_data = @var{string}
2729 Use POST as the method for all HTTP requests and send @var{string} in
2730 the request body.  The same as @samp{--post-data=@var{string}}.
2731
2732 @item post_file = @var{file}
2733 Use POST as the method for all HTTP requests and send the contents of
2734 @var{file} in the request body.  The same as
2735 @samp{--post-file=@var{file}}.
2736
2737 @item prefer_family = IPv4/IPv6/none
2738 When given a choice of several addresses, connect to the addresses
2739 with specified address family first.  IPv4 addresses are preferred by
2740 default.  The same as @samp{--prefer-family}, which see for a detailed
2741 discussion of why this is useful.
2742
2743 @item private_key = @var{file}
2744 Set the private key file to @var{file}.  The same as
2745 @samp{--private-key=@var{file}}.
2746
2747 @item private_key_type = @var{string}
2748 Specify the type of the private key, legal values being @samp{PEM}
2749 (the default) and @samp{DER} (aka ASN1).  The same as
2750 @samp{--private-type=@var{string}}.
2751
2752 @item progress = @var{string}
2753 Set the type of the progress indicator.  Legal types are @samp{dot}
2754 and @samp{bar}.  Equivalent to @samp{--progress=@var{string}}.
2755
2756 @item protocol_directories = on/off
2757 When set, use the protocol name as a directory component of local file
2758 names.  The same as @samp{--protocol-directories}.
2759
2760 @item proxy_user = @var{string}
2761 Set proxy authentication user name to @var{string}, like
2762 @samp{--proxy-user=@var{string}}.
2763
2764 @item proxy_password = @var{string}
2765 Set proxy authentication password to @var{string}, like
2766 @samp{--proxy-password=@var{string}}.
2767
2768 @item quiet = on/off
2769 Quiet mode---the same as @samp{-q}.
2770
2771 @item quota = @var{quota}
2772 Specify the download quota, which is useful to put in the global
2773 @file{wgetrc}.  When download quota is specified, Wget will stop
2774 retrieving after the download sum has become greater than quota.  The
2775 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2776 mbytes (@samp{m} appended).  Thus @samp{quota = 5m} will set the quota
2777 to 5 megabytes.  Note that the user's startup file overrides system
2778 settings.
2779
2780 @item random_file = @var{file}
2781 Use @var{file} as a source of randomness on systems lacking
2782 @file{/dev/random}.
2783
2784 @item random_wait = on/off
2785 Turn random between-request wait times on or off. The same as 
2786 @samp{--random-wait}.
2787
2788 @item read_timeout = @var{n}
2789 Set the read (and write) timeout---the same as
2790 @samp{--read-timeout=@var{n}}.
2791
2792 @item reclevel = @var{n}
2793 Recursion level (depth)---the same as @samp{-l @var{n}}.
2794
2795 @item recursive = on/off
2796 Recursive on/off---the same as @samp{-r}.
2797
2798 @item referer = @var{string}
2799 Set HTTP @samp{Referer:} header just like
2800 @samp{--referer=@var{string}}.  (Note it was the folks who wrote the
2801 @sc{http} spec who got the spelling of ``referrer'' wrong.)
2802
2803 @item relative_only = on/off
2804 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2805 Links}).
2806
2807 @item remove_listing = on/off
2808 If set to on, remove @sc{ftp} listings downloaded by Wget.  Setting it
2809 to off is the same as @samp{--no-remove-listing}.
2810
2811 @item restrict_file_names = unix/windows
2812 Restrict the file names generated by Wget from URLs.  See
2813 @samp{--restrict-file-names} for a more detailed description.
2814
2815 @item retr_symlinks = on/off
2816 When set to on, retrieve symbolic links as if they were plain files; the
2817 same as @samp{--retr-symlinks}.
2818
2819 @item retry_connrefused = on/off
2820 When set to on, consider ``connection refused'' a transient
2821 error---the same as @samp{--retry-connrefused}.
2822
2823 @item robots = on/off
2824 Specify whether the norobots convention is respected by Wget, ``on'' by
2825 default.  This switch controls both the @file{/robots.txt} and the
2826 @samp{nofollow} aspect of the spec.  @xref{Robot Exclusion}, for more
2827 details about this.  Be sure you know what you are doing before turning
2828 this off.
2829
2830 @item save_cookies = @var{file}
2831 Save cookies to @var{file}.  The same as @samp{--save-cookies
2832 @var{file}}.
2833
2834 @item secure_protocol = @var{string}
2835 Choose the secure protocol to be used.  Legal values are @samp{auto}
2836 (the default), @samp{SSLv2}, @samp{SSLv3}, and @samp{TLSv1}.  The same
2837 as @samp{--secure-protocol=@var{string}}.
2838
2839 @item server_response = on/off
2840 Choose whether or not to print the @sc{http} and @sc{ftp} server
2841 responses---the same as @samp{-S}.
2842
2843 @item span_hosts = on/off
2844 Same as @samp{-H}.
2845
2846 @item strict_comments = on/off
2847 Same as @samp{--strict-comments}.
2848
2849 @item timeout = @var{n}
2850 Set all applicable timeout values to @var{n}, the same as @samp{-T
2851 @var{n}}.
2852
2853 @item timestamping = on/off
2854 Turn timestamping on/off.  The same as @samp{-N} (@pxref{Time-Stamping}).
2855
2856 @item tries = @var{n}
2857 Set number of retries per @sc{url}---the same as @samp{-t @var{n}}.
2858
2859 @item use_proxy = on/off
2860 When set to off, don't use proxy even when proxy-related environment
2861 variables are set.  In that case it is the same as using
2862 @samp{--no-proxy}.
2863
2864 @item user = @var{string}
2865 Specify username @var{string} for both @sc{ftp} and @sc{http} file retrieval. 
2866 This command can be overridden using the @samp{ftp_user} and 
2867 @samp{http_user} command for @sc{ftp} and @sc{http} respectively.
2868
2869 @item verbose = on/off
2870 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2871
2872 @item wait = @var{n}
2873 Wait @var{n} seconds between retrievals---the same as @samp{-w
2874 @var{n}}.
2875
2876 @item waitretry = @var{n}
2877 Wait up to @var{n} seconds between retries of failed retrievals
2878 only---the same as @samp{--waitretry=@var{n}}.  Note that this is
2879 turned on by default in the global @file{wgetrc}.
2880 @end table
2881
2882 @node Sample Wgetrc
2883 @section Sample Wgetrc
2884 @cindex sample wgetrc
2885
2886 This is the sample initialization file, as given in the distribution.
2887 It is divided in two section---one for global usage (suitable for global
2888 startup file), and one for local usage (suitable for
2889 @file{$HOME/.wgetrc}).  Be careful about the things you change.
2890
2891 Note that almost all the lines are commented out.  For a command to have
2892 any effect, you must remove the @samp{#} character at the beginning of
2893 its line.
2894
2895 @example
2896 @include sample.wgetrc.munged_for_texi_inclusion
2897 @end example
2898
2899 @node Examples
2900 @chapter Examples
2901 @cindex examples
2902
2903 @c man begin EXAMPLES
2904 The examples are divided into three sections loosely based on their
2905 complexity.
2906
2907 @menu
2908 * Simple Usage::         Simple, basic usage of the program.
2909 * Advanced Usage::       Advanced tips.
2910 * Very Advanced Usage::  The hairy stuff.
2911 @end menu
2912
2913 @node Simple Usage
2914 @section Simple Usage
2915
2916 @itemize @bullet
2917 @item
2918 Say you want to download a @sc{url}.  Just type:
2919
2920 @example
2921 wget http://fly.srk.fer.hr/
2922 @end example
2923
2924 @item
2925 But what will happen if the connection is slow, and the file is lengthy?
2926 The connection will probably fail before the whole file is retrieved,
2927 more than once.  In this case, Wget will try getting the file until it
2928 either gets the whole of it, or exceeds the default number of retries
2929 (this being 20).  It is easy to change the number of tries to 45, to
2930 insure that the whole file will arrive safely:
2931
2932 @example
2933 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2934 @end example
2935
2936 @item
2937 Now let's leave Wget to work in the background, and write its progress
2938 to log file @file{log}.  It is tiring to type @samp{--tries}, so we
2939 shall use @samp{-t}.
2940
2941 @example
2942 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2943 @end example
2944
2945 The ampersand at the end of the line makes sure that Wget works in the
2946 background.  To unlimit the number of retries, use @samp{-t inf}.
2947
2948 @item
2949 The usage of @sc{ftp} is as simple.  Wget will take care of login and
2950 password.
2951
2952 @example
2953 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2954 @end example
2955
2956 @item
2957 If you specify a directory, Wget will retrieve the directory listing,
2958 parse it and convert it to @sc{html}.  Try:
2959
2960 @example
2961 wget ftp://ftp.gnu.org/pub/gnu/
2962 links index.html
2963 @end example
2964 @end itemize
2965
2966 @node Advanced Usage
2967 @section Advanced Usage
2968
2969 @itemize @bullet
2970 @item
2971 You have a file that contains the URLs you want to download?  Use the
2972 @samp{-i} switch:
2973
2974 @example
2975 wget -i @var{file}
2976 @end example
2977
2978 If you specify @samp{-} as file name, the @sc{url}s will be read from
2979 standard input.
2980
2981 @item
2982 Create a five levels deep mirror image of the GNU web site, with the
2983 same directory structure the original has, with only one try per
2984 document, saving the log of the activities to @file{gnulog}:
2985
2986 @example
2987 wget -r http://www.gnu.org/ -o gnulog
2988 @end example
2989
2990 @item
2991 The same as the above, but convert the links in the @sc{html} files to
2992 point to local files, so you can view the documents off-line:
2993
2994 @example
2995 wget --convert-links -r http://www.gnu.org/ -o gnulog
2996 @end example
2997
2998 @item
2999 Retrieve only one @sc{html} page, but make sure that all the elements needed
3000 for the page to be displayed, such as inline images and external style
3001 sheets, are also downloaded.  Also make sure the downloaded page
3002 references the downloaded links.
3003
3004 @example
3005 wget -p --convert-links http://www.server.com/dir/page.html
3006 @end example
3007
3008 The @sc{html} page will be saved to @file{www.server.com/dir/page.html}, and
3009 the images, stylesheets, etc., somewhere under @file{www.server.com/},
3010 depending on where they were on the remote server.
3011
3012 @item
3013 The same as the above, but without the @file{www.server.com/} directory.
3014 In fact, I don't want to have all those random server directories
3015 anyway---just save @emph{all} those files under a @file{download/}
3016 subdirectory of the current directory.
3017
3018 @example
3019 wget -p --convert-links -nH -nd -Pdownload \
3020      http://www.server.com/dir/page.html
3021 @end example
3022
3023 @item
3024 Retrieve the index.html of @samp{www.lycos.com}, showing the original
3025 server headers:
3026
3027 @example
3028 wget -S http://www.lycos.com/
3029 @end example
3030
3031 @item
3032 Save the server headers with the file, perhaps for post-processing.
3033
3034 @example
3035 wget --save-headers http://www.lycos.com/
3036 more index.html
3037 @end example
3038
3039 @item
3040 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
3041 to @file{/tmp}.
3042
3043 @example
3044 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
3045 @end example
3046
3047 @item
3048 You want to download all the @sc{gif}s from a directory on an @sc{http}
3049 server.  You tried @samp{wget http://www.server.com/dir/*.gif}, but that
3050 didn't work because @sc{http} retrieval does not support globbing.  In
3051 that case, use:
3052
3053 @example
3054 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
3055 @end example
3056
3057 More verbose, but the effect is the same.  @samp{-r -l1} means to
3058 retrieve recursively (@pxref{Recursive Download}), with maximum depth
3059 of 1.  @samp{--no-parent} means that references to the parent directory
3060 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
3061 download only the @sc{gif} files.  @samp{-A "*.gif"} would have worked
3062 too.
3063
3064 @item
3065 Suppose you were in the middle of downloading, when Wget was
3066 interrupted.  Now you do not want to clobber the files already present.
3067 It would be:
3068
3069 @example
3070 wget -nc -r http://www.gnu.org/
3071 @end example
3072
3073 @item
3074 If you want to encode your own username and password to @sc{http} or
3075 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
3076
3077 @example
3078 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
3079 @end example
3080
3081 Note, however, that this usage is not advisable on multi-user systems
3082 because it reveals your password to anyone who looks at the output of
3083 @code{ps}.
3084
3085 @cindex redirecting output
3086 @item
3087 You would like the output documents to go to standard output instead of
3088 to files?
3089
3090 @example
3091 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
3092 @end example
3093
3094 You can also combine the two options and make pipelines to retrieve the
3095 documents from remote hotlists:
3096
3097 @example
3098 wget -O - http://cool.list.com/ | wget --force-html -i -
3099 @end example
3100 @end itemize
3101
3102 @node Very Advanced Usage
3103 @section Very Advanced Usage
3104
3105 @cindex mirroring
3106 @itemize @bullet
3107 @item
3108 If you wish Wget to keep a mirror of a page (or @sc{ftp}
3109 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
3110 for @samp{-r -l inf -N}.  You can put Wget in the crontab file asking it
3111 to recheck a site each Sunday:
3112
3113 @example
3114 crontab
3115 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
3116 @end example
3117
3118 @item
3119 In addition to the above, you want the links to be converted for local
3120 viewing.  But, after having read this manual, you know that link
3121 conversion doesn't play well with timestamping, so you also want Wget to
3122 back up the original @sc{html} files before the conversion.  Wget invocation
3123 would look like this:
3124
3125 @example
3126 wget --mirror --convert-links --backup-converted  \
3127      http://www.gnu.org/ -o /home/me/weeklog
3128 @end example
3129
3130 @item
3131 But you've also noticed that local viewing doesn't work all that well
3132 when @sc{html} files are saved under extensions other than @samp{.html},
3133 perhaps because they were served as @file{index.cgi}.  So you'd like
3134 Wget to rename all the files served with content-type @samp{text/html}
3135 or @samp{application/xhtml+xml} to @file{@var{name}.html}.
3136
3137 @example
3138 wget --mirror --convert-links --backup-converted \
3139      --html-extension -o /home/me/weeklog        \
3140      http://www.gnu.org/
3141 @end example
3142
3143 Or, with less typing:
3144
3145 @example
3146 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
3147 @end example
3148 @end itemize
3149 @c man end
3150
3151 @node Various
3152 @chapter Various
3153 @cindex various
3154
3155 This chapter contains all the stuff that could not fit anywhere else.
3156
3157 @menu
3158 * Proxies::             Support for proxy servers
3159 * Distribution::        Getting the latest version.
3160 * Mailing List::        Wget mailing list for announcements and discussion.
3161 * Reporting Bugs::      How and where to report bugs.
3162 * Portability::         The systems Wget works on.
3163 * Signals::             Signal-handling performed by Wget.
3164 @end menu
3165
3166 @node Proxies
3167 @section Proxies
3168 @cindex proxies
3169
3170 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
3171 data from remote servers to local clients.  One typical use of proxies
3172 is lightening network load for users behind a slow connection.  This is
3173 achieved by channeling all @sc{http} and @sc{ftp} requests through the
3174 proxy which caches the transferred data.  When a cached resource is
3175 requested again, proxy will return the data from cache.  Another use for
3176 proxies is for companies that separate (for security reasons) their
3177 internal networks from the rest of Internet.  In order to obtain
3178 information from the Web, their users connect and retrieve remote data
3179 using an authorized proxy.
3180
3181 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals.  The
3182 standard way to specify proxy location, which Wget recognizes, is using
3183 the following environment variables:
3184
3185 @table @code
3186 @item http_proxy
3187 @itemx https_proxy
3188 If set, the @code{http_proxy} and @code{https_proxy} variables should
3189 contain the @sc{url}s of the proxies for @sc{http} and @sc{https}
3190 connections respectively.
3191
3192 @item ftp_proxy
3193 This variable should contain the @sc{url} of the proxy for @sc{ftp}
3194 connections.  It is quite common that @code{http_proxy} and
3195 @code{ftp_proxy} are set to the same @sc{url}.
3196
3197 @item no_proxy
3198 This variable should contain a comma-separated list of domain extensions
3199 proxy should @emph{not} be used for.  For instance, if the value of
3200 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
3201 documents from MIT.
3202 @end table
3203
3204 In addition to the environment variables, proxy location and settings
3205 may be specified from within Wget itself.
3206
3207 @table @samp
3208 @itemx --no-proxy
3209 @itemx proxy = on/off
3210 This option and the corresponding command may be used to suppress the
3211 use of proxy, even if the appropriate environment variables are set.
3212
3213 @item http_proxy = @var{URL}
3214 @itemx https_proxy = @var{URL}
3215 @itemx ftp_proxy = @var{URL}
3216 @itemx no_proxy = @var{string}
3217 These startup file variables allow you to override the proxy settings
3218 specified by the environment.
3219 @end table
3220
3221 Some proxy servers require authorization to enable you to use them.  The
3222 authorization consists of @dfn{username} and @dfn{password}, which must
3223 be sent by Wget.  As with @sc{http} authorization, several
3224 authentication schemes exist.  For proxy authorization only the
3225 @code{Basic} authentication scheme is currently implemented.
3226
3227 You may specify your username and password either through the proxy
3228 @sc{url} or through the command-line options.  Assuming that the
3229 company's proxy is located at @samp{proxy.company.com} at port 8001, a
3230 proxy @sc{url} location containing authorization data might look like
3231 this:
3232
3233 @example
3234 http://hniksic:mypassword@@proxy.company.com:8001/
3235 @end example
3236
3237 Alternatively, you may use the @samp{proxy-user} and
3238 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
3239 settings @code{proxy_user} and @code{proxy_password} to set the proxy
3240 username and password.
3241
3242 @node Distribution
3243 @section Distribution
3244 @cindex latest version
3245
3246 Like all GNU utilities, the latest version of Wget can be found at the
3247 master GNU archive site ftp.gnu.org, and its mirrors.  For example,
3248 Wget @value{VERSION} can be found at
3249 @url{ftp://ftp.gnu.org/pub/gnu/wget/wget-@value{VERSION}.tar.gz}
3250
3251 @node Mailing List
3252 @section Mailing List
3253 @cindex mailing list
3254 @cindex list
3255
3256 There are several Wget-related mailing lists, all hosted by
3257 SunSITE.dk.  The general discussion list is at
3258 @email{wget@@sunsite.dk}.  It is the preferred place for bug reports
3259 and suggestions, as well as for discussion of development.  You are
3260 invited to subscribe.
3261
3262 To subscribe, simply send mail to @email{wget-subscribe@@sunsite.dk}
3263 and follow the instructions.  Unsubscribe by mailing to
3264 @email{wget-unsubscribe@@sunsite.dk}.  The mailing list is archived at
3265 @url{http://www.mail-archive.com/wget%40sunsite.dk/} and at
3266 @url{http://news.gmane.org/gmane.comp.web.wget.general}.
3267
3268 The second mailing list is at @email{wget-patches@@sunsite.dk}, and is
3269 used to submit patches for review by Wget developers.  A ``patch'' is
3270 a textual representation of change to source code, readable by both
3271 humans and programs.  The file @file{PATCHES} that comes with Wget
3272 covers the creation and submitting of patches in detail.  Please don't
3273 send general suggestions or bug reports to @samp{wget-patches}; use it
3274 only for patch submissions.
3275
3276 To subscribe, simply send mail to @email{wget-subscribe@@sunsite.dk}
3277 and follow the instructions.  Unsubscribe by mailing to
3278 @email{wget-unsubscribe@@sunsite.dk}.  The mailing list is archived at
3279 @url{http://news.gmane.org/gmane.comp.web.wget.patches}.
3280
3281 @node Reporting Bugs
3282 @section Reporting Bugs
3283 @cindex bugs
3284 @cindex reporting bugs
3285 @cindex bug reports
3286
3287 @c man begin BUGS
3288 You are welcome to send bug reports about GNU Wget to
3289 @email{bug-wget@@gnu.org}.
3290
3291 Before actually submitting a bug report, please try to follow a few
3292 simple guidelines.
3293
3294 @enumerate
3295 @item
3296 Please try to ascertain that the behavior you see really is a bug.  If
3297 Wget crashes, it's a bug.  If Wget does not behave as documented,
3298 it's a bug.  If things work strange, but you are not sure about the way
3299 they are supposed to work, it might well be a bug.
3300
3301 @item
3302 Try to repeat the bug in as simple circumstances as possible.  E.g. if
3303 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
3304 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
3305 repeatable, and if will occur with a simpler set of options.  You might
3306 even try to start the download at the page where the crash occurred to
3307 see if that page somehow triggered the crash.
3308
3309 Also, while I will probably be interested to know the contents of your
3310 @file{.wgetrc} file, just dumping it into the debug message is probably
3311 a bad idea.  Instead, you should first try to see if the bug repeats
3312 with @file{.wgetrc} moved out of the way.  Only if it turns out that
3313 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
3314 the file.
3315
3316 @item
3317 Please start Wget with @samp{-d} option and send us the resulting
3318 output (or relevant parts thereof).  If Wget was compiled without
3319 debug support, recompile it---it is @emph{much} easier to trace bugs
3320 with debug support on.
3321
3322 Note: please make sure to remove any potentially sensitive information
3323 from the debug log before sending it to the bug address.  The
3324 @code{-d} won't go out of its way to collect sensitive information,
3325 but the log @emph{will} contain a fairly complete transcript of Wget's
3326 communication with the server, which may include passwords and pieces
3327 of downloaded data.  Since the bug address is publically archived, you
3328 may assume that all bug reports are visible to the public.
3329
3330 @item
3331 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
3332 wget` core} and type @code{where} to get the backtrace.  This may not
3333 work if the system administrator has disabled core files, but it is
3334 safe to try.
3335 @end enumerate
3336 @c man end
3337
3338 @node Portability
3339 @section Portability
3340 @cindex portability
3341 @cindex operating systems
3342
3343 Like all GNU software, Wget works on the GNU system.  However, since it
3344 uses GNU Autoconf for building and configuring, and mostly avoids using
3345 ``special'' features of any particular Unix, it should compile (and
3346 work) on all common Unix flavors.
3347
3348 Various Wget versions have been compiled and tested under many kinds
3349 of Unix systems, including GNU/Linux, Solaris, SunOS 4.x, OSF (aka
3350 Digital Unix or Tru64), Ultrix, *BSD, IRIX, AIX, and others.  Some of
3351 those systems are no longer in widespread use and may not be able to
3352 support recent versions of Wget.  If Wget fails to compile on your
3353 system, we would like to know about it.
3354
3355 Thanks to kind contributors, this version of Wget compiles and works
3356 on 32-bit Microsoft Windows platforms.  It has been compiled
3357 successfully using MS Visual C++ 6.0, Watcom, Borland C, and GCC
3358 compilers.  Naturally, it is crippled of some features available on
3359 Unix, but it should work as a substitute for people stuck with
3360 Windows.  Note that Windows-specific portions of Wget are not
3361 guaranteed to be supported in the future, although this has been the
3362 case in practice for many years now.  All questions and problems in
3363 Windows usage should be reported to Wget mailing list at
3364 @email{wget@@sunsite.dk} where the volunteers who maintain the
3365 Windows-related features might look at them.
3366
3367 @node Signals
3368 @section Signals
3369 @cindex signal handling
3370 @cindex hangup
3371
3372 Since the purpose of Wget is background work, it catches the hangup
3373 signal (@code{SIGHUP}) and ignores it.  If the output was on standard
3374 output, it will be redirected to a file named @file{wget-log}.
3375 Otherwise, @code{SIGHUP} is ignored.  This is convenient when you wish
3376 to redirect the output of Wget after having started it.
3377
3378 @example
3379 $ wget http://www.gnus.org/dist/gnus.tar.gz &
3380 ...
3381 $ kill -HUP %%
3382 SIGHUP received, redirecting output to `wget-log'.
3383 @end example
3384
3385 Other than that, Wget will not try to interfere with signals in any way.
3386 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
3387
3388 @node Appendices
3389 @chapter Appendices
3390
3391 This chapter contains some references I consider useful.
3392
3393 @menu
3394 * Robot Exclusion::         Wget's support for RES.
3395 * Security Considerations:: Security with Wget.
3396 * Contributors::            People who helped.
3397 @end menu
3398
3399 @node Robot Exclusion
3400 @section Robot Exclusion
3401 @cindex robot exclusion
3402 @cindex robots.txt
3403 @cindex server maintenance
3404
3405 It is extremely easy to make Wget wander aimlessly around a web site,
3406 sucking all the available data in progress.  @samp{wget -r @var{site}},
3407 and you're set.  Great?  Not for the server admin.
3408
3409 As long as Wget is only retrieving static pages, and doing it at a
3410 reasonable rate (see the @samp{--wait} option), there's not much of a
3411 problem.  The trouble is that Wget can't tell the difference between the
3412 smallest static page and the most demanding CGI.  A site I know has a
3413 section handled by a CGI Perl script that converts Info files to @sc{html} on
3414 the fly.  The script is slow, but works well enough for human users
3415 viewing an occasional Info file.  However, when someone's recursive Wget
3416 download stumbles upon the index page that links to all the Info files
3417 through the script, the system is brought to its knees without providing
3418 anything useful to the user (This task of converting Info files could be
3419 done locally and access to Info documentation for all installed GNU
3420 software on a system is available from the @code{info} command).
3421
3422 To avoid this kind of accident, as well as to preserve privacy for
3423 documents that need to be protected from well-behaved robots, the
3424 concept of @dfn{robot exclusion} was invented.  The idea is that
3425 the server administrators and document authors can specify which
3426 portions of the site they wish to protect from robots and those
3427 they will permit access.
3428
3429 The most popular mechanism, and the @i{de facto} standard supported by
3430 all the major robots, is the ``Robots Exclusion Standard'' (RES) written
3431 by Martijn Koster et al. in 1994.  It specifies the format of a text
3432 file containing directives that instruct the robots which URL paths to
3433 avoid.  To be found by the robots, the specifications must be placed in
3434 @file{/robots.txt} in the server root, which the robots are expected to
3435 download and parse.
3436
3437 Although Wget is not a web robot in the strictest sense of the word, it
3438 can downloads large parts of the site without the user's intervention to
3439 download an individual page.  Because of that, Wget honors RES when
3440 downloading recursively.  For instance, when you issue:
3441
3442 @example
3443 wget -r http://www.server.com/
3444 @end example
3445
3446 First the index of @samp{www.server.com} will be downloaded.  If Wget
3447 finds that it wants to download more documents from that server, it will
3448 request @samp{http://www.server.com/robots.txt} and, if found, use it
3449 for further downloads.  @file{robots.txt} is loaded only once per each
3450 server.
3451
3452 Until version 1.8, Wget supported the first version of the standard,
3453 written by Martijn Koster in 1994 and available at
3454 @url{http://www.robotstxt.org/wc/norobots.html}.  As of version 1.8,
3455 Wget has supported the additional directives specified in the internet
3456 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
3457 Robots Control''.  The draft, which has as far as I know never made to
3458 an @sc{rfc}, is available at
3459 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
3460
3461 This manual no longer includes the text of the Robot Exclusion Standard.
3462
3463 The second, less known mechanism, enables the author of an individual
3464 document to specify whether they want the links from the file to be
3465 followed by a robot.  This is achieved using the @code{META} tag, like
3466 this:
3467
3468 @example
3469 <meta name="robots" content="nofollow">
3470 @end example
3471
3472 This is explained in some detail at
3473 @url{http://www.robotstxt.org/wc/meta-user.html}.  Wget supports this
3474 method of robot exclusion in addition to the usual @file{/robots.txt}
3475 exclusion.
3476
3477 If you know what you are doing and really really wish to turn off the
3478 robot exclusion, set the @code{robots} variable to @samp{off} in your
3479 @file{.wgetrc}.  You can achieve the same effect from the command line
3480 using the @code{-e} switch, e.g. @samp{wget -e robots=off @var{url}...}.
3481
3482 @node Security Considerations
3483 @section Security Considerations
3484 @cindex security
3485
3486 When using Wget, you must be aware that it sends unencrypted passwords
3487 through the network, which may present a security problem.  Here are the
3488 main issues, and some solutions.
3489
3490 @enumerate
3491 @item
3492 The passwords on the command line are visible using @code{ps}.  The best
3493 way around it is to use @code{wget -i -} and feed the @sc{url}s to
3494 Wget's standard input, each on a separate line, terminated by @kbd{C-d}.
3495 Another workaround is to use @file{.netrc} to store passwords; however,
3496 storing unencrypted passwords is also considered a security risk.
3497
3498 @item
3499 Using the insecure @dfn{basic} authentication scheme, unencrypted
3500 passwords are transmitted through the network routers and gateways.
3501
3502 @item
3503 The @sc{ftp} passwords are also in no way encrypted.  There is no good
3504 solution for this at the moment.
3505
3506 @item
3507 Although the ``normal'' output of Wget tries to hide the passwords,
3508 debugging logs show them, in all forms.  This problem is avoided by
3509 being careful when you send debug logs (yes, even when you send them to
3510 me).
3511 @end enumerate
3512
3513 @node Contributors
3514 @section Contributors
3515 @cindex contributors
3516
3517 @iftex
3518 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@xemacs.org}.
3519 @end iftex
3520 @ifnottex
3521 GNU Wget was written by Hrvoje Niksic @email{hniksic@@xemacs.org}.
3522 @end ifnottex
3523 However, its development could never have gone as far as it has, were it
3524 not for the help of many people, either with bug reports, feature
3525 proposals, patches, or letters saying ``Thanks!''.
3526
3527 Special thanks goes to the following people (no particular order):
3528
3529 @itemize @bullet
3530 @item Mauro Tortonesi---contributed high-quality IPv6 code and many
3531 other fixes.
3532
3533 @item Dan Harkless---contributed a lot of code and documentation of
3534 extremely high quality, as well as the @code{--page-requisites} and
3535 related options.  He was the principal maintainer for some time and
3536 released Wget 1.6.
3537
3538 @item Ian Abbott---contributed bug fixes, Windows-related fixes, and
3539 provided a prototype implementation of the breadth-first recursive
3540 download.  Co-maintained Wget during the 1.8 release cycle.
3541
3542 @item
3543 The dotsrc.org crew, in particular Karsten Thygesen---donated system
3544 resources such as the mailing list, web space, @sc{ftp} space, and
3545 version control repositories, along with a lot of time to make these
3546 actually work.  Christian Reiniger was of invaluable help with setting
3547 up Subversion.
3548
3549 @item
3550 Heiko Herold---provided high-quality Windows builds and contributed
3551 bug and build reports for many years.
3552
3553 @item
3554 Shawn McHorse---bug reports and patches.
3555
3556 @item
3557 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization.  Lots of
3558 portability fixes.
3559
3560 @item
3561 Gordon Matzigkeit---@file{.netrc} support.
3562
3563 @item
3564 @iftex
3565 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
3566 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
3567 @end iftex
3568 @ifnottex
3569 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
3570 and ``philosophical'' discussions.
3571 @end ifnottex
3572
3573 @item
3574 Darko Budor---initial port to Windows.
3575
3576 @item
3577 Antonio Rosella---help and suggestions, plus the initial Italian
3578 translation.
3579
3580 @item
3581 @iftex
3582 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
3583 suggestions.
3584 @end iftex
3585 @ifnottex
3586 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
3587 @end ifnottex
3588
3589 @item
3590 @iftex
3591 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
3592 @end iftex
3593 @ifnottex
3594 Francois Pinard---many thorough bug reports and discussions.
3595 @end ifnottex
3596
3597 @item
3598 Karl Eichwalder---lots of help with internationalization, Makefile
3599 layout and many other things.
3600
3601 @item
3602 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
3603 authentication.
3604
3605 @item
3606 People who provided donations for development---including Brian Gough.
3607 @end itemize
3608
3609 The following people have provided patches, bug/build reports, useful
3610 suggestions, beta testing services, fan mail and all the other things
3611 that make maintenance so much fun:
3612
3613 Tim Adam,
3614 Adrian Aichner,
3615 Martin Baehr,
3616 Dieter Baron,
3617 Roger Beeman,
3618 Dan Berger,
3619 T. Bharath,
3620 Christian Biere,
3621 Paul Bludov,
3622 Daniel Bodea,
3623 Mark Boyns,
3624 John Burden,
3625 Wanderlei Cavassin,
3626 Gilles Cedoc,
3627 Tim Charron,
3628 Noel Cragg,
3629 @iftex
3630 Kristijan @v{C}onka@v{s},
3631 @end iftex
3632 @ifnottex
3633 Kristijan Conkas,
3634 @end ifnottex
3635 John Daily,
3636 Andreas Damm,
3637 Ahmon Dancy,
3638 Andrew Davison,
3639 Bertrand Demiddelaer,
3640 Andrew Deryabin,
3641 Ulrich Drepper,
3642 Marc Duponcheel,
3643 @iftex
3644 Damir D@v{z}eko,
3645 @end iftex
3646 @ifnottex
3647 Damir Dzeko,
3648 @end ifnottex
3649 Alan Eldridge,
3650 Hans-Andreas Engel,
3651 @iftex
3652 Aleksandar Erkalovi@'{c},
3653 @end iftex
3654 @ifnottex
3655 Aleksandar Erkalovic,
3656 @end ifnottex
3657 Andy Eskilsson,
3658 Christian Fraenkel,
3659 David Fritz,
3660 Charles C. Fu,
3661 FUJISHIMA Satsuki,
3662 Masashi Fujita,
3663 Howard Gayle,
3664 Marcel Gerrits,
3665 Lemble Gregory,
3666 Hans Grobler,
3667 Mathieu Guillaume,
3668 Aaron Hawley,
3669 Jochen Hein,
3670 Karl Heuer,
3671 HIROSE Masaaki,
3672 Ulf Harnhammar,
3673 Gregor Hoffleit,
3674 Erik Magnus Hulthen,
3675 Richard Huveneers,
3676 Jonas Jensen,
3677 Larry Jones,
3678 Simon Josefsson,
3679 @iftex
3680 Mario Juri@'{c},
3681 @end iftex
3682 @ifnottex
3683 Mario Juric,
3684 @end ifnottex
3685 @iftex
3686 Hack Kampbj@o rn,
3687 @end iftex
3688 @ifnottex
3689 Hack Kampbjorn,
3690 @end ifnottex
3691 Const Kaplinsky,
3692 @iftex
3693 Goran Kezunovi@'{c},
3694 @end iftex
3695 @ifnottex
3696 Goran Kezunovic,
3697 @end ifnottex
3698 Igor Khristophorov,
3699 Robert Kleine,
3700 KOJIMA Haime,
3701 Fila Kolodny,
3702 Alexander Kourakos,
3703 Martin Kraemer,
3704 Sami Krank,
3705 @tex
3706 $\Sigma\acute{\iota}\mu o\varsigma\;
3707 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
3708 (Simos KSenitellis),
3709 @end tex
3710 @ifnottex
3711 Simos KSenitellis,
3712 @end ifnottex
3713 Christian Lackas,
3714 Hrvoje Lacko,
3715 Daniel S. Lewart,
3716 @iftex
3717 Nicol@'{a}s Lichtmeier,
3718 @end iftex
3719 @ifnottex
3720 Nicolas Lichtmeier,
3721 @end ifnottex
3722 Dave Love,
3723 Alexander V. Lukyanov,
3724 @iftex
3725 Thomas Lu@ss{}nig,
3726 @end iftex
3727 @ifnottex
3728 Thomas Lussnig,
3729 @end ifnottex
3730 Andre Majorel,
3731 Aurelien Marchand,
3732 Matthew J. Mellon,
3733 Jordan Mendelson,
3734 Lin Zhe Min,
3735 Jan Minar,
3736 Tim Mooney,
3737 Keith Moore,
3738 Adam D. Moss,
3739 Simon Munton,
3740 Charlie Negyesi,
3741 R. K. Owen,
3742 Leonid Petrov,
3743 Simone Piunno,
3744 Andrew Pollock,
3745 Steve Pothier,
3746 @iftex
3747 Jan P@v{r}ikryl,
3748 @end iftex
3749 @ifnottex
3750 Jan Prikryl,
3751 @end ifnottex
3752 Marin Purgar,
3753 @iftex
3754 Csaba R@'{a}duly,
3755 @end iftex
3756 @ifnottex
3757 Csaba Raduly,
3758 @end ifnottex
3759 Keith Refson,
3760 Bill Richardson,
3761 Tyler Riddle,
3762 Tobias Ringstrom,
3763 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3764 @tex
3765 Juan Jos\'{e} Rodr\'{\i}guez,
3766 @end tex
3767 @ifnottex
3768 Juan Jose Rodriguez,
3769 @end ifnottex
3770 Maciej W. Rozycki,
3771 Edward J. Sabol,
3772 Heinz Salzmann,
3773 Robert Schmidt,
3774 Nicolas Schodet,
3775 Andreas Schwab,
3776 Steven M. Schweda,
3777 Chris Seawood,
3778 Dennis Smit,
3779 Toomas Soome,
3780 Tage Stabell-Kulo,
3781 Philip Stadermann,
3782 Daniel Stenberg,
3783 Sven Sternberger,
3784 Markus Strasser,
3785 John Summerfield,
3786 Szakacsits Szabolcs,
3787 Mike Thomas,
3788 Philipp Thomas,
3789 Mauro Tortonesi,
3790 Dave Turner,
3791 Gisle Vanem,
3792 Russell Vincent,
3793 @iftex
3794 @v{Z}eljko Vrba,
3795 @end iftex
3796 @ifnottex
3797 Zeljko Vrba,
3798 @end ifnottex
3799 Charles G Waldman,
3800 Douglas E. Wegscheid,
3801 YAMAZAKI Makoto,
3802 Jasmin Zainul,
3803 @iftex
3804 Bojan @v{Z}drnja,
3805 @end iftex
3806 @ifnottex
3807 Bojan Zdrnja,
3808 @end ifnottex
3809 Kristijan Zimmer.
3810
3811 Apologies to all who I accidentally left out, and many thanks to all the
3812 subscribers of the Wget mailing list.
3813
3814 @node Copying
3815 @chapter Copying
3816 @cindex copying
3817 @cindex GPL
3818 @cindex GFDL
3819 @cindex free software
3820
3821 GNU Wget is licensed under the GNU General Public License (GNU GPL),
3822 which makes it @dfn{free software}.  Please note that ``free'' in ``free
3823 software'' refers to liberty, not price.  As some people like to point
3824 out, it's the ``free'' of ``free speech'', not the ``free'' of ``free
3825 beer''.
3826
3827 The exact and legally binding distribution terms are spelled out below.
3828 The GPL guarantees that you have the right (freedom) to run and change
3829 GNU Wget and distribute it to others, and even---if you want---charge
3830 money for doing any of those things.  With these rights comes the
3831 obligation to distribute the source code along with the software and to
3832 grant your recipients the same rights and impose the same restrictions.
3833
3834 This licensing model is also known as @dfn{open source} because it,
3835 among other things, makes sure that all recipients will receive the
3836 source code along with the program, and be able to improve it.  The GNU
3837 project prefers the term ``free software'' for reasons outlined at
3838 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3839
3840 The exact license terms are defined by this paragraph and the GNU
3841 General Public License it refers to:
3842
3843 @quotation
3844 GNU Wget is free software; you can redistribute it and/or modify it
3845 under the terms of the GNU General Public License as published by the
3846 Free Software Foundation; either version 2 of the License, or (at your
3847 option) any later version.
3848
3849 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3850 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3851 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
3852 for more details.
3853
3854 A copy of the GNU General Public License is included as part of this
3855 manual; if you did not receive it, write to the Free Software
3856 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3857 @end quotation
3858
3859 In addition to this, this manual is free in the same sense:
3860
3861 @quotation
3862 Permission is granted to copy, distribute and/or modify this document
3863 under the terms of the GNU Free Documentation License, Version 1.2 or
3864 any later version published by the Free Software Foundation; with no
3865 Invariant Sections, with no Front-Cover Texts, and with no
3866 Back-Cover Texts.  A copy of the license is included in the section
3867 entitled ``GNU Free Documentation License''.
3868 @end quotation
3869
3870 @c #### Maybe we should wrap these licenses in ifinfo?  Stallman says
3871 @c that the GFDL needs to be present in the manual, and to me it would
3872 @c suck to include the license for the manual and not the license for
3873 @c the program.
3874
3875 The full texts of the GNU General Public License and of the GNU Free
3876 Documentation License are available below.
3877
3878 @menu
3879 * GNU General Public License::
3880 * GNU Free Documentation License::
3881 @end menu
3882
3883 @include gpl.texi
3884
3885 @include fdl.texi
3886
3887 @node Concept Index
3888 @unnumbered Concept Index
3889 @printindex cp
3890
3891 @contents
3892
3893 @bye