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