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