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