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