]> sjero.net Git - wget/blob - doc/wget.texi
[svn] Wording change.
[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 encounter ``certificate verification'' errors or ones saying
1387 that ``common name doesn't match requested host name'', you can use
1388 this option to bypass the verification and proceed with the download.
1389 @emph{Only use this option if you are otherwise convinced of the
1390 site's authenticity, or if you really don't care about the validity of
1391 its certificate.}  It is almost always a bad idea not to check the
1392 certificates when transmitting confidential or important data.
1393
1394 @cindex SSL certificate
1395 @item --certificate=@var{file}
1396 Use the client certificate stored in @var{file}.  This is needed for
1397 servers that are configured to require certificates from the clients
1398 that connect to them.  Normally a certificate is not required and this
1399 switch is optional.
1400
1401 @cindex SSL certificate type, specify
1402 @item --certificate-type=@var{type}
1403 Specify the type of the client certificate.  Legal values are
1404 @samp{PEM} (assumed by default) and @samp{DER}, also known as
1405 @samp{ASN1}.
1406
1407 @item --private-key=@var{file}
1408 Read the private key from @var{file}.  This allows you to provide the
1409 private key in a file separate from the certificate.
1410
1411 @item --private-key-type=@var{type}
1412 Specify the type of the private key.  Accepted values are @samp{PEM}
1413 (the default) and @samp{DER}.
1414
1415 @item --ca-certificate=@var{file}
1416 Use @var{file} as the file with the bundle of certificate authorities
1417 (``CA'') to verify the peers.  The certificates must be in PEM format.
1418
1419 Without this option Wget looks for CA certificates at the
1420 system-specified locations, chosen at OpenSSL installation time.
1421
1422 @cindex SSL certificate authority
1423 @item --ca-directory=@var{directory}
1424 Specifies directory containing CA certificates in PEM format.  Each
1425 file contains one CA certificate, and the file name is based on a hash
1426 value derived from the certificate.  This is achieved by processing a
1427 certificate directory with the @code{c_rehash} utility supplied with
1428 OpenSSL.  Using @samp{--ca-directory} is more efficient than
1429 @samp{--ca-certificate} when many certificates are installed because
1430 it allows Wget to fetch certificates on demand.
1431
1432 Without this option Wget looks for CA certificates at the
1433 system-specified locations, chosen at OpenSSL installation time.
1434
1435 @cindex entropy, specifying source of
1436 @cindex randomness, specifying source of
1437 @item --random-file=@var{file}
1438 Use @var{file} as the source of random data for seeding the
1439 pseudo-random number generator on systems without @file{/dev/random}.
1440
1441 On such systems the SSL library needs an external source of randomness
1442 to initialize.  Randomness may be provided by EGD (see
1443 @samp{--egd-file} below) or read from an external source specified by
1444 the user.  If this option is not specified, Wget looks for random data
1445 in @code{$RANDFILE} or, if that is unset, in @file{$HOME/.rnd}.  If
1446 none of those are available, it is likely that SSL encryption will not
1447 be usable.
1448
1449 If you're getting the ``Could not seed OpenSSL PRNG; disabling SSL.'' 
1450 error, you should provide random data using some of the methods
1451 described above.
1452
1453 @cindex EGD
1454 @item --egd-file=@var{file}
1455 Use @var{file} as the EGD socket.  EGD stands for @dfn{Entropy
1456 Gathering Daemon}, a user-space program that collects data from
1457 various unpredictable system sources and makes it available to other
1458 programs that might need it.  Encryption software, such as the SSL
1459 library, needs sources of non-repeating randomness to seed the random
1460 number generator used to produce cryptographically strong keys.
1461
1462 OpenSSL allows the user to specify his own source of entropy using the
1463 @code{RAND_FILE} environment variable.  If this variable is unset, or
1464 if the specified file does not produce enough randomness, OpenSSL will
1465 read random data from EGD socket specified using this option.
1466
1467 If this option is not specified (and the equivalent startup command is
1468 not used), EGD is never contacted.  EGD is not needed on modern Unix
1469 systems that support @file{/dev/random}.
1470 @end table
1471
1472 @node FTP Options
1473 @section FTP Options
1474
1475 @table @samp
1476 @cindex ftp user
1477 @cindex ftp password
1478 @cindex ftp authentication
1479 @item --ftp-user=@var{user}
1480 @itemx --ftp-password=@var{password}
1481 Specify the username @var{user} and password @var{password} on an
1482 @sc{ftp} server.  Without this, or the corresponding startup option, 
1483 the password defaults to @samp{-wget@@}, normally used for anonymous 
1484 FTP.
1485
1486 Another way to specify username and password is in the @sc{url} itself
1487 (@pxref{URL Format}).  Either method reveals your password to anyone who
1488 bothers to run @code{ps}.  To prevent the passwords from being seen,
1489 store them in @file{.wgetrc} or @file{.netrc}, and make sure to protect
1490 those files from other users with @code{chmod}.  If the passwords are
1491 really important, do not leave them lying in those files either---edit
1492 the files and delete them after Wget has started the download.
1493
1494 @iftex
1495 For more information about security issues with Wget, @xref{Security
1496 Considerations}.
1497 @end iftex
1498
1499 @cindex .listing files, removing
1500 @item --no-remove-listing
1501 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
1502 retrievals.  Normally, these files contain the raw directory listings
1503 received from @sc{ftp} servers.  Not removing them can be useful for
1504 debugging purposes, or when you want to be able to easily check on the
1505 contents of remote server directories (e.g. to verify that a mirror
1506 you're running is complete).
1507
1508 Note that even though Wget writes to a known filename for this file,
1509 this is not a security hole in the scenario of a user making
1510 @file{.listing} a symbolic link to @file{/etc/passwd} or something and
1511 asking @code{root} to run Wget in his or her directory.  Depending on
1512 the options used, either Wget will refuse to write to @file{.listing},
1513 making the globbing/recursion/time-stamping operation fail, or the
1514 symbolic link will be deleted and replaced with the actual
1515 @file{.listing} file, or the listing will be written to a
1516 @file{.listing.@var{number}} file.
1517
1518 Even though this situation isn't a problem, though, @code{root} should
1519 never run Wget in a non-trusted user's directory.  A user could do
1520 something as simple as linking @file{index.html} to @file{/etc/passwd}
1521 and asking @code{root} to run Wget with @samp{-N} or @samp{-r} so the file
1522 will be overwritten.
1523
1524 @cindex globbing, toggle
1525 @item --no-glob
1526 Turn off @sc{ftp} globbing.  Globbing refers to the use of shell-like
1527 special characters (@dfn{wildcards}), like @samp{*}, @samp{?}, @samp{[}
1528 and @samp{]} to retrieve more than one file from the same directory at
1529 once, like:
1530
1531 @example
1532 wget ftp://gnjilux.srk.fer.hr/*.msg
1533 @end example
1534
1535 By default, globbing will be turned on if the @sc{url} contains a
1536 globbing character.  This option may be used to turn globbing on or off
1537 permanently.
1538
1539 You may have to quote the @sc{url} to protect it from being expanded by
1540 your shell.  Globbing makes Wget look for a directory listing, which is
1541 system-specific.  This is why it currently works only with Unix @sc{ftp}
1542 servers (and the ones emulating Unix @code{ls} output).
1543
1544 @cindex passive ftp
1545 @item --no-passive-ftp
1546 Disable the use of the @dfn{passive} FTP transfer mode.  Passive FTP
1547 mandates that the client connect to the server to establish the data
1548 connection rather than the other way around.
1549
1550 If the machine is connected to the Internet directly, both passive and
1551 active FTP should work equally well.  Behind most firewall and NAT
1552 configurations passive FTP has a better chance of working.  However,
1553 in some rare firewall configurations, active FTP actually works when
1554 passive FTP doesn't.  If you suspect this to be the case, use this
1555 option, or set @code{passive_ftp=off} in your init file.
1556
1557 @cindex symbolic links, retrieving
1558 @item --retr-symlinks
1559 Usually, when retrieving @sc{ftp} directories recursively and a symbolic
1560 link is encountered, the linked-to file is not downloaded.  Instead, a
1561 matching symbolic link is created on the local filesystem.  The
1562 pointed-to file will not be downloaded unless this recursive retrieval
1563 would have encountered it separately and downloaded it anyway.
1564
1565 When @samp{--retr-symlinks} is specified, however, symbolic links are
1566 traversed and the pointed-to files are retrieved.  At this time, this
1567 option does not cause Wget to traverse symlinks to directories and
1568 recurse through them, but in the future it should be enhanced to do
1569 this.
1570
1571 Note that when retrieving a file (not a directory) because it was
1572 specified on the command-line, rather than because it was recursed to,
1573 this option has no effect.  Symbolic links are always traversed in this
1574 case.
1575
1576 @cindex Keep-Alive, turning off
1577 @cindex Persistent Connections, disabling
1578 @item --no-http-keep-alive
1579 Turn off the ``keep-alive'' feature for HTTP downloads.  Normally, Wget
1580 asks the server to keep the connection open so that, when you download
1581 more than one document from the same server, they get transferred over
1582 the same TCP connection.  This saves time and at the same time reduces
1583 the load on the server.
1584
1585 This option is useful when, for some reason, persistent (keep-alive)
1586 connections don't work for you, for example due to a server bug or due
1587 to the inability of server-side scripts to cope with the connections.
1588 @end table
1589
1590 @node Recursive Retrieval Options
1591 @section Recursive Retrieval Options
1592
1593 @table @samp
1594 @item -r
1595 @itemx --recursive
1596 Turn on recursive retrieving.  @xref{Recursive Download}, for more
1597 details.
1598
1599 @item -l @var{depth}
1600 @itemx --level=@var{depth}
1601 Specify recursion maximum depth level @var{depth} (@pxref{Recursive
1602 Download}).  The default maximum depth is 5.
1603
1604 @cindex proxy filling
1605 @cindex delete after retrieval
1606 @cindex filling proxy cache
1607 @item --delete-after
1608 This option tells Wget to delete every single file it downloads,
1609 @emph{after} having done so.  It is useful for pre-fetching popular
1610 pages through a proxy, e.g.:
1611
1612 @example
1613 wget -r -nd --delete-after http://whatever.com/~popular/page/
1614 @end example
1615
1616 The @samp{-r} option is to retrieve recursively, and @samp{-nd} to not
1617 create directories.  
1618
1619 Note that @samp{--delete-after} deletes files on the local machine.  It
1620 does not issue the @samp{DELE} command to remote FTP sites, for
1621 instance.  Also note that when @samp{--delete-after} is specified,
1622 @samp{--convert-links} is ignored, so @samp{.orig} files are simply not
1623 created in the first place.
1624
1625 @cindex conversion of links
1626 @cindex link conversion
1627 @item -k
1628 @itemx --convert-links
1629 After the download is complete, convert the links in the document to
1630 make them suitable for local viewing.  This affects not only the visible
1631 hyperlinks, but any part of the document that links to external content,
1632 such as embedded images, links to style sheets, hyperlinks to non-@sc{html}
1633 content, etc.
1634
1635 Each link will be changed in one of the two ways:
1636
1637 @itemize @bullet
1638 @item
1639 The links to files that have been downloaded by Wget will be changed to
1640 refer to the file they point to as a relative link.
1641
1642 Example: if the downloaded file @file{/foo/doc.html} links to
1643 @file{/bar/img.gif}, also downloaded, then the link in @file{doc.html}
1644 will be modified to point to @samp{../bar/img.gif}.  This kind of
1645 transformation works reliably for arbitrary combinations of directories.
1646
1647 @item
1648 The links to files that have not been downloaded by Wget will be changed
1649 to include host name and absolute path of the location they point to.
1650
1651 Example: if the downloaded file @file{/foo/doc.html} links to
1652 @file{/bar/img.gif} (or to @file{../bar/img.gif}), then the link in
1653 @file{doc.html} will be modified to point to
1654 @file{http://@var{hostname}/bar/img.gif}.
1655 @end itemize
1656
1657 Because of this, local browsing works reliably: if a linked file was
1658 downloaded, the link will refer to its local name; if it was not
1659 downloaded, the link will refer to its full Internet address rather than
1660 presenting a broken link.  The fact that the former links are converted
1661 to relative links ensures that you can move the downloaded hierarchy to
1662 another directory.
1663
1664 Note that only at the end of the download can Wget know which links have
1665 been downloaded.  Because of that, the work done by @samp{-k} will be
1666 performed at the end of all the downloads.
1667
1668 @cindex backing up converted files
1669 @item -K
1670 @itemx --backup-converted
1671 When converting a file, back up the original version with a @samp{.orig}
1672 suffix.  Affects the behavior of @samp{-N} (@pxref{HTTP Time-Stamping
1673 Internals}).
1674
1675 @item -m
1676 @itemx --mirror
1677 Turn on options suitable for mirroring.  This option turns on recursion
1678 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
1679 directory listings.  It is currently equivalent to
1680 @samp{-r -N -l inf --no-remove-listing}.
1681
1682 @cindex page requisites
1683 @cindex required images, downloading
1684 @item -p
1685 @itemx --page-requisites
1686 This option causes Wget to download all the files that are necessary to
1687 properly display a given @sc{html} page.  This includes such things as
1688 inlined images, sounds, and referenced stylesheets.
1689
1690 Ordinarily, when downloading a single @sc{html} page, any requisite documents
1691 that may be needed to display it properly are not downloaded.  Using
1692 @samp{-r} together with @samp{-l} can help, but since Wget does not
1693 ordinarily distinguish between external and inlined documents, one is
1694 generally left with ``leaf documents'' that are missing their
1695 requisites.
1696
1697 For instance, say document @file{1.html} contains an @code{<IMG>} tag
1698 referencing @file{1.gif} and an @code{<A>} tag pointing to external
1699 document @file{2.html}.  Say that @file{2.html} is similar but that its
1700 image is @file{2.gif} and it links to @file{3.html}.  Say this
1701 continues up to some arbitrarily high number.
1702
1703 If one executes the command:
1704
1705 @example
1706 wget -r -l 2 http://@var{site}/1.html
1707 @end example
1708
1709 then @file{1.html}, @file{1.gif}, @file{2.html}, @file{2.gif}, and
1710 @file{3.html} will be downloaded.  As you can see, @file{3.html} is
1711 without its requisite @file{3.gif} because Wget is simply counting the
1712 number of hops (up to 2) away from @file{1.html} in order to determine
1713 where to stop the recursion.  However, with this command:
1714
1715 @example
1716 wget -r -l 2 -p http://@var{site}/1.html
1717 @end example
1718
1719 all the above files @emph{and} @file{3.html}'s requisite @file{3.gif}
1720 will be downloaded.  Similarly,
1721
1722 @example
1723 wget -r -l 1 -p http://@var{site}/1.html
1724 @end example
1725
1726 will cause @file{1.html}, @file{1.gif}, @file{2.html}, and @file{2.gif}
1727 to be downloaded.  One might think that:
1728
1729 @example
1730 wget -r -l 0 -p http://@var{site}/1.html
1731 @end example
1732
1733 would download just @file{1.html} and @file{1.gif}, but unfortunately
1734 this is not the case, because @samp{-l 0} is equivalent to
1735 @samp{-l inf}---that is, infinite recursion.  To download a single @sc{html}
1736 page (or a handful of them, all specified on the command-line or in a
1737 @samp{-i} @sc{url} input file) and its (or their) requisites, simply leave off
1738 @samp{-r} and @samp{-l}:
1739
1740 @example
1741 wget -p http://@var{site}/1.html
1742 @end example
1743
1744 Note that Wget will behave as if @samp{-r} had been specified, but only
1745 that single page and its requisites will be downloaded.  Links from that
1746 page to external documents will not be followed.  Actually, to download
1747 a single page and all its requisites (even if they exist on separate
1748 websites), and make sure the lot displays properly locally, this author
1749 likes to use a few options in addition to @samp{-p}:
1750
1751 @example
1752 wget -E -H -k -K -p http://@var{site}/@var{document}
1753 @end example
1754
1755 To finish off this topic, it's worth knowing that Wget's idea of an
1756 external document link is any URL specified in an @code{<A>} tag, an
1757 @code{<AREA>} tag, or a @code{<LINK>} tag other than @code{<LINK
1758 REL="stylesheet">}.
1759
1760 @cindex @sc{html} comments
1761 @cindex comments, @sc{html}
1762 @item --strict-comments
1763 Turn on strict parsing of @sc{html} comments.  The default is to terminate
1764 comments at the first occurrence of @samp{-->}.
1765
1766 According to specifications, @sc{html} comments are expressed as @sc{sgml}
1767 @dfn{declarations}.  Declaration is special markup that begins with
1768 @samp{<!} and ends with @samp{>}, such as @samp{<!DOCTYPE ...>}, that
1769 may contain comments between a pair of @samp{--} delimiters.  @sc{html}
1770 comments are ``empty declarations'', @sc{sgml} declarations without any
1771 non-comment text.  Therefore, @samp{<!--foo-->} is a valid comment, and
1772 so is @samp{<!--one-- --two-->}, but @samp{<!--1--2-->} is not.
1773
1774 On the other hand, most @sc{html} writers don't perceive comments as anything
1775 other than text delimited with @samp{<!--} and @samp{-->}, which is not
1776 quite the same.  For example, something like @samp{<!------------>}
1777 works as a valid comment as long as the number of dashes is a multiple
1778 of four (!).  If not, the comment technically lasts until the next
1779 @samp{--}, which may be at the other end of the document.  Because of
1780 this, many popular browsers completely ignore the specification and
1781 implement what users have come to expect: comments delimited with
1782 @samp{<!--} and @samp{-->}.
1783
1784 Until version 1.9, Wget interpreted comments strictly, which resulted in
1785 missing links in many web pages that displayed fine in browsers, but had
1786 the misfortune of containing non-compliant comments.  Beginning with
1787 version 1.9, Wget has joined the ranks of clients that implements
1788 ``naive'' comments, terminating each comment at the first occurrence of
1789 @samp{-->}.
1790
1791 If, for whatever reason, you want strict comment parsing, use this
1792 option to turn it on.
1793 @end table
1794
1795 @node Recursive Accept/Reject Options
1796 @section Recursive Accept/Reject Options
1797
1798 @table @samp
1799 @item -A @var{acclist} --accept @var{acclist}
1800 @itemx -R @var{rejlist} --reject @var{rejlist}
1801 Specify comma-separated lists of file name suffixes or patterns to
1802 accept or reject (@pxref{Types of Files} for more details).
1803
1804 @item -D @var{domain-list}
1805 @itemx --domains=@var{domain-list}
1806 Set domains to be followed.  @var{domain-list} is a comma-separated list
1807 of domains.  Note that it does @emph{not} turn on @samp{-H}.
1808
1809 @item --exclude-domains @var{domain-list}
1810 Specify the domains that are @emph{not} to be followed.
1811 (@pxref{Spanning Hosts}).
1812
1813 @cindex follow FTP links
1814 @item --follow-ftp
1815 Follow @sc{ftp} links from @sc{html} documents.  Without this option,
1816 Wget will ignore all the @sc{ftp} links.
1817
1818 @cindex tag-based recursive pruning
1819 @item --follow-tags=@var{list}
1820 Wget has an internal table of @sc{html} tag / attribute pairs that it
1821 considers when looking for linked documents during a recursive
1822 retrieval.  If a user wants only a subset of those tags to be
1823 considered, however, he or she should be specify such tags in a
1824 comma-separated @var{list} with this option.
1825
1826 @item --ignore-tags=@var{list}
1827 This is the opposite of the @samp{--follow-tags} option.  To skip
1828 certain @sc{html} tags when recursively looking for documents to download,
1829 specify them in a comma-separated @var{list}.  
1830
1831 In the past, this option was the best bet for downloading a single page
1832 and its requisites, using a command-line like:
1833
1834 @example
1835 wget --ignore-tags=a,area -H -k -K -r http://@var{site}/@var{document}
1836 @end example
1837
1838 However, the author of this option came across a page with tags like
1839 @code{<LINK REL="home" HREF="/">} and came to the realization that
1840 specifying tags to ignore was not enough.  One can't just tell Wget to
1841 ignore @code{<LINK>}, because then stylesheets will not be downloaded.
1842 Now the best bet for downloading a single page and its requisites is the
1843 dedicated @samp{--page-requisites} option.
1844
1845 @item -H
1846 @itemx --span-hosts
1847 Enable spanning across hosts when doing recursive retrieving
1848 (@pxref{Spanning Hosts}).
1849
1850 @item -L
1851 @itemx --relative
1852 Follow relative links only.  Useful for retrieving a specific home page
1853 without any distractions, not even those from the same hosts
1854 (@pxref{Relative Links}).
1855
1856 @item -I @var{list}
1857 @itemx --include-directories=@var{list}
1858 Specify a comma-separated list of directories you wish to follow when
1859 downloading (@pxref{Directory-Based Limits} for more details.)  Elements
1860 of @var{list} may contain wildcards.
1861
1862 @item -X @var{list}
1863 @itemx --exclude-directories=@var{list}
1864 Specify a comma-separated list of directories you wish to exclude from
1865 download (@pxref{Directory-Based Limits} for more details.)  Elements of
1866 @var{list} may contain wildcards.
1867
1868 @item -np
1869 @item --no-parent
1870 Do not ever ascend to the parent directory when retrieving recursively.
1871 This is a useful option, since it guarantees that only the files
1872 @emph{below} a certain hierarchy will be downloaded.
1873 @xref{Directory-Based Limits}, for more details.
1874 @end table
1875
1876 @c man end
1877
1878 @node Recursive Download
1879 @chapter Recursive Download
1880 @cindex recursion
1881 @cindex retrieving
1882 @cindex recursive download
1883
1884 GNU Wget is capable of traversing parts of the Web (or a single
1885 @sc{http} or @sc{ftp} server), following links and directory structure.
1886 We refer to this as to @dfn{recursive retrieval}, or @dfn{recursion}.
1887
1888 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1889 the given @sc{url}, documents, retrieving the files the @sc{html}
1890 document was referring to, through markup like @code{href}, or
1891 @code{src}.  If the freshly downloaded file is also of type
1892 @code{text/html} or @code{application/xhtml+xml}, it will be parsed and 
1893 followed further.
1894
1895 Recursive retrieval of @sc{http} and @sc{html} content is
1896 @dfn{breadth-first}.  This means that Wget first downloads the requested
1897 @sc{html} document, then the documents linked from that document, then the
1898 documents linked by them, and so on.  In other words, Wget first
1899 downloads the documents at depth 1, then those at depth 2, and so on
1900 until the specified maximum depth.
1901
1902 The maximum @dfn{depth} to which the retrieval may descend is specified
1903 with the @samp{-l} option.  The default maximum depth is five layers.
1904
1905 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1906 the data from the given directory tree (including the subdirectories up
1907 to the specified depth) on the remote server, creating its mirror image
1908 locally.  @sc{ftp} retrieval is also limited by the @code{depth}
1909 parameter.  Unlike @sc{http} recursion, @sc{ftp} recursion is performed
1910 depth-first.
1911
1912 By default, Wget will create a local directory tree, corresponding to
1913 the one found on the remote server.
1914
1915 Recursive retrieving can find a number of applications, the most
1916 important of which is mirroring.  It is also useful for @sc{www}
1917 presentations, and any other opportunities where slow network
1918 connections should be bypassed by storing the files locally.
1919
1920 You should be warned that recursive downloads can overload the remote
1921 servers.  Because of that, many administrators frown upon them and may
1922 ban access from your site if they detect very fast downloads of big
1923 amounts of content.  When downloading from Internet servers, consider
1924 using the @samp{-w} option to introduce a delay between accesses to the
1925 server.  The download will take a while longer, but the server
1926 administrator will not be alarmed by your rudeness.
1927
1928 Of course, recursive download may cause problems on your machine.  If
1929 left to run unchecked, it can easily fill up the disk.  If downloading
1930 from local network, it can also take bandwidth on the system, as well as
1931 consume memory and CPU.
1932
1933 Try to specify the criteria that match the kind of download you are
1934 trying to achieve.  If you want to download only one page, use
1935 @samp{--page-requisites} without any additional recursion.  If you want
1936 to download things under one directory, use @samp{-np} to avoid
1937 downloading things from other directories.  If you want to download all
1938 the files from one directory, use @samp{-l 1} to make sure the recursion
1939 depth never exceeds one.  @xref{Following Links}, for more information
1940 about this.
1941
1942 Recursive retrieval should be used with care.  Don't say you were not
1943 warned.
1944
1945 @node Following Links
1946 @chapter Following Links
1947 @cindex links
1948 @cindex following links
1949
1950 When retrieving recursively, one does not wish to retrieve loads of
1951 unnecessary data.  Most of the time the users bear in mind exactly what
1952 they want to download, and want Wget to follow only specific links.
1953
1954 For example, if you wish to download the music archive from
1955 @samp{fly.srk.fer.hr}, you will not want to download all the home pages
1956 that happen to be referenced by an obscure part of the archive.
1957
1958 Wget possesses several mechanisms that allows you to fine-tune which
1959 links it will follow.
1960
1961 @menu
1962 * Spanning Hosts::         (Un)limiting retrieval based on host name.
1963 * Types of Files::         Getting only certain files.
1964 * Directory-Based Limits:: Getting only certain directories.
1965 * Relative Links::         Follow relative links only.
1966 * FTP Links::              Following FTP links.
1967 @end menu
1968
1969 @node Spanning Hosts
1970 @section Spanning Hosts
1971 @cindex spanning hosts
1972 @cindex hosts, spanning
1973
1974 Wget's recursive retrieval normally refuses to visit hosts different
1975 than the one you specified on the command line.  This is a reasonable
1976 default; without it, every retrieval would have the potential to turn
1977 your Wget into a small version of google.
1978
1979 However, visiting different hosts, or @dfn{host spanning,} is sometimes
1980 a useful option.  Maybe the images are served from a different server.
1981 Maybe you're mirroring a site that consists of pages interlinked between
1982 three servers.  Maybe the server has two equivalent names, and the @sc{html}
1983 pages refer to both interchangeably.
1984
1985 @table @asis
1986 @item Span to any host---@samp{-H}
1987
1988 The @samp{-H} option turns on host spanning, thus allowing Wget's
1989 recursive run to visit any host referenced by a link.  Unless sufficient
1990 recursion-limiting criteria are applied depth, these foreign hosts will
1991 typically link to yet more hosts, and so on until Wget ends up sucking
1992 up much more data than you have intended.
1993
1994 @item Limit spanning to certain domains---@samp{-D}
1995
1996 The @samp{-D} option allows you to specify the domains that will be
1997 followed, thus limiting the recursion only to the hosts that belong to
1998 these domains.  Obviously, this makes sense only in conjunction with
1999 @samp{-H}.  A typical example would be downloading the contents of
2000 @samp{www.server.com}, but allowing downloads from
2001 @samp{images.server.com}, etc.:
2002
2003 @example
2004 wget -rH -Dserver.com http://www.server.com/
2005 @end example
2006
2007 You can specify more than one address by separating them with a comma,
2008 e.g. @samp{-Ddomain1.com,domain2.com}.
2009
2010 @item Keep download off certain domains---@samp{--exclude-domains}
2011
2012 If there are domains you want to exclude specifically, you can do it
2013 with @samp{--exclude-domains}, which accepts the same type of arguments
2014 of @samp{-D}, but will @emph{exclude} all the listed domains.  For
2015 example, if you want to download all the hosts from @samp{foo.edu}
2016 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
2017 this:
2018
2019 @example
2020 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu \
2021     http://www.foo.edu/
2022 @end example
2023
2024 @end table
2025
2026 @node Types of Files
2027 @section Types of Files
2028 @cindex types of files
2029
2030 When downloading material from the web, you will often want to restrict
2031 the retrieval to only certain file types.  For example, if you are
2032 interested in downloading @sc{gif}s, you will not be overjoyed to get
2033 loads of PostScript documents, and vice versa.
2034
2035 Wget offers two options to deal with this problem.  Each option
2036 description lists a short name, a long name, and the equivalent command
2037 in @file{.wgetrc}.
2038
2039 @cindex accept wildcards
2040 @cindex accept suffixes
2041 @cindex wildcards, accept
2042 @cindex suffixes, accept
2043 @table @samp
2044 @item -A @var{acclist}
2045 @itemx --accept @var{acclist}
2046 @itemx accept = @var{acclist}
2047 The argument to @samp{--accept} option is a list of file suffixes or
2048 patterns that Wget will download during recursive retrieval.  A suffix
2049 is the ending part of a file, and consists of ``normal'' letters,
2050 e.g. @samp{gif} or @samp{.jpg}.  A matching pattern contains shell-like
2051 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
2052
2053 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
2054 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
2055 @sc{jpeg}s.  On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
2056 download only files beginning with @samp{zelazny} and containing numbers
2057 from 1960 to 1969 anywhere within.  Look up the manual of your shell for
2058 a description of how pattern matching works.
2059
2060 Of course, any number of suffixes and patterns can be combined into a
2061 comma-separated list, and given as an argument to @samp{-A}.
2062
2063 @cindex reject wildcards
2064 @cindex reject suffixes
2065 @cindex wildcards, reject
2066 @cindex suffixes, reject
2067 @item -R @var{rejlist}
2068 @itemx --reject @var{rejlist}
2069 @itemx reject = @var{rejlist}
2070 The @samp{--reject} option works the same way as @samp{--accept}, only
2071 its logic is the reverse; Wget will download all files @emph{except} the
2072 ones matching the suffixes (or patterns) in the list.
2073
2074 So, if you want to download a whole page except for the cumbersome
2075 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
2076 Analogously, to download all files except the ones beginning with
2077 @samp{bjork}, use @samp{wget -R "bjork*"}.  The quotes are to prevent
2078 expansion by the shell.
2079 @end table
2080
2081 The @samp{-A} and @samp{-R} options may be combined to achieve even
2082 better fine-tuning of which files to retrieve.  E.g. @samp{wget -A
2083 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
2084 a part of their name, but @emph{not} the PostScript files.
2085
2086 Note that these two options do not affect the downloading of @sc{html}
2087 files; Wget must load all the @sc{html}s to know where to go at
2088 all---recursive retrieval would make no sense otherwise.
2089
2090 @node Directory-Based Limits
2091 @section Directory-Based Limits
2092 @cindex directories
2093 @cindex directory limits
2094
2095 Regardless of other link-following facilities, it is often useful to
2096 place the restriction of what files to retrieve based on the directories
2097 those files are placed in.  There can be many reasons for this---the
2098 home pages may be organized in a reasonable directory structure; or some
2099 directories may contain useless information, e.g. @file{/cgi-bin} or
2100 @file{/dev} directories.
2101
2102 Wget offers three different options to deal with this requirement.  Each
2103 option description lists a short name, a long name, and the equivalent
2104 command in @file{.wgetrc}.
2105
2106 @cindex directories, include
2107 @cindex include directories
2108 @cindex accept directories
2109 @table @samp
2110 @item -I @var{list}
2111 @itemx --include @var{list}
2112 @itemx include_directories = @var{list}
2113 @samp{-I} option accepts a comma-separated list of directories included
2114 in the retrieval.  Any other directories will simply be ignored.  The
2115 directories are absolute paths.
2116
2117 So, if you wish to download from @samp{http://host/people/bozo/}
2118 following only links to bozo's colleagues in the @file{/people}
2119 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
2120
2121 @example
2122 wget -I /people,/cgi-bin http://host/people/bozo/
2123 @end example
2124
2125 @cindex directories, exclude
2126 @cindex exclude directories
2127 @cindex reject directories
2128 @item -X @var{list}
2129 @itemx --exclude @var{list}
2130 @itemx exclude_directories = @var{list}
2131 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
2132 directories @emph{excluded} from the download.  E.g. if you do not want
2133 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
2134 /cgi-bin} on the command line.
2135
2136 The same as with @samp{-A}/@samp{-R}, these two options can be combined
2137 to get a better fine-tuning of downloading subdirectories.  E.g. if you
2138 want to load all the files from @file{/pub} hierarchy except for
2139 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
2140
2141 @cindex no parent
2142 @item -np
2143 @itemx --no-parent
2144 @itemx no_parent = on
2145 The simplest, and often very useful way of limiting directories is
2146 disallowing retrieval of the links that refer to the hierarchy
2147 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
2148 parent directory/directories.
2149
2150 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
2151 Using it guarantees that you will never leave the existing hierarchy.
2152 Supposing you issue Wget with:
2153
2154 @example
2155 wget -r --no-parent http://somehost/~luzer/my-archive/
2156 @end example
2157
2158 You may rest assured that none of the references to
2159 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
2160 followed.  Only the archive you are interested in will be downloaded.
2161 Essentially, @samp{--no-parent} is similar to
2162 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
2163 intelligent fashion.
2164 @end table
2165
2166 @node Relative Links
2167 @section Relative Links
2168 @cindex relative links
2169
2170 When @samp{-L} is turned on, only the relative links are ever followed.
2171 Relative links are here defined those that do not refer to the web
2172 server root.  For example, these links are relative:
2173
2174 @example
2175 <a href="foo.gif">
2176 <a href="foo/bar.gif">
2177 <a href="../foo/bar.gif">
2178 @end example
2179
2180 These links are not relative:
2181
2182 @example
2183 <a href="/foo.gif">
2184 <a href="/foo/bar.gif">
2185 <a href="http://www.server.com/foo/bar.gif">
2186 @end example
2187
2188 Using this option guarantees that recursive retrieval will not span
2189 hosts, even without @samp{-H}.  In simple cases it also allows downloads
2190 to ``just work'' without having to convert links.
2191
2192 This option is probably not very useful and might be removed in a future
2193 release.
2194
2195 @node FTP Links
2196 @section Following FTP Links
2197 @cindex following ftp links
2198
2199 The rules for @sc{ftp} are somewhat specific, as it is necessary for
2200 them to be.  @sc{ftp} links in @sc{html} documents are often included
2201 for purposes of reference, and it is often inconvenient to download them
2202 by default.
2203
2204 To have @sc{ftp} links followed from @sc{html} documents, you need to
2205 specify the @samp{--follow-ftp} option.  Having done that, @sc{ftp}
2206 links will span hosts regardless of @samp{-H} setting.  This is logical,
2207 as @sc{ftp} links rarely point to the same host where the @sc{http}
2208 server resides.  For similar reasons, the @samp{-L} options has no
2209 effect on such downloads.  On the other hand, domain acceptance
2210 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
2211
2212 Also note that followed links to @sc{ftp} directories will not be
2213 retrieved recursively further.
2214
2215 @node Time-Stamping
2216 @chapter Time-Stamping
2217 @cindex time-stamping
2218 @cindex timestamping
2219 @cindex updating the archives
2220 @cindex incremental updating
2221
2222 One of the most important aspects of mirroring information from the
2223 Internet is updating your archives.
2224
2225 Downloading the whole archive again and again, just to replace a few
2226 changed files is expensive, both in terms of wasted bandwidth and money,
2227 and the time to do the update.  This is why all the mirroring tools
2228 offer the option of incremental updating.
2229
2230 Such an updating mechanism means that the remote server is scanned in
2231 search of @dfn{new} files.  Only those new files will be downloaded in
2232 the place of the old ones.
2233
2234 A file is considered new if one of these two conditions are met:
2235
2236 @enumerate
2237 @item
2238 A file of that name does not already exist locally.
2239
2240 @item
2241 A file of that name does exist, but the remote file was modified more
2242 recently than the local file.
2243 @end enumerate
2244
2245 To implement this, the program needs to be aware of the time of last
2246 modification of both local and remote files.  We call this information the
2247 @dfn{time-stamp} of a file.
2248
2249 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
2250 (@samp{-N}) option, or through @code{timestamping = on} directive in
2251 @file{.wgetrc}.  With this option, for each file it intends to download,
2252 Wget will check whether a local file of the same name exists.  If it
2253 does, and the remote file is older, Wget will not download it.
2254
2255 If the local file does not exist, or the sizes of the files do not
2256 match, Wget will download the remote file no matter what the time-stamps
2257 say.
2258
2259 @menu
2260 * Time-Stamping Usage::
2261 * HTTP Time-Stamping Internals::
2262 * FTP Time-Stamping Internals::
2263 @end menu
2264
2265 @node Time-Stamping Usage
2266 @section Time-Stamping Usage
2267 @cindex time-stamping usage
2268 @cindex usage, time-stamping
2269
2270 The usage of time-stamping is simple.  Say you would like to download a
2271 file so that it keeps its date of modification.
2272
2273 @example
2274 wget -S http://www.gnu.ai.mit.edu/
2275 @end example
2276
2277 A simple @code{ls -l} shows that the time stamp on the local file equals
2278 the state of the @code{Last-Modified} header, as returned by the server.
2279 As you can see, the time-stamping info is preserved locally, even
2280 without @samp{-N} (at least for @sc{http}).
2281
2282 Several days later, you would like Wget to check if the remote file has
2283 changed, and download it if it has.
2284
2285 @example
2286 wget -N http://www.gnu.ai.mit.edu/
2287 @end example
2288
2289 Wget will ask the server for the last-modified date.  If the local file
2290 has the same timestamp as the server, or a newer one, the remote file
2291 will not be re-fetched.  However, if the remote file is more recent,
2292 Wget will proceed to fetch it.
2293
2294 The same goes for @sc{ftp}.  For example:
2295
2296 @example
2297 wget "ftp://ftp.ifi.uio.no/pub/emacs/gnus/*"
2298 @end example
2299
2300 (The quotes around that URL are to prevent the shell from trying to
2301 interpret the @samp{*}.)
2302
2303 After download, a local directory listing will show that the timestamps
2304 match those on the remote server.  Reissuing the command with @samp{-N}
2305 will make Wget re-fetch @emph{only} the files that have been modified
2306 since the last download.
2307
2308 If you wished to mirror the GNU archive every week, you would use a
2309 command like the following, weekly:
2310
2311 @example
2312 wget --timestamping -r ftp://ftp.gnu.org/pub/gnu/
2313 @end example
2314
2315 Note that time-stamping will only work for files for which the server
2316 gives a timestamp.  For @sc{http}, this depends on getting a
2317 @code{Last-Modified} header.  For @sc{ftp}, this depends on getting a
2318 directory listing with dates in a format that Wget can parse
2319 (@pxref{FTP Time-Stamping Internals}).
2320
2321 @node HTTP Time-Stamping Internals
2322 @section HTTP Time-Stamping Internals
2323 @cindex http time-stamping
2324
2325 Time-stamping in @sc{http} is implemented by checking of the
2326 @code{Last-Modified} header.  If you wish to retrieve the file
2327 @file{foo.html} through @sc{http}, Wget will check whether
2328 @file{foo.html} exists locally.  If it doesn't, @file{foo.html} will be
2329 retrieved unconditionally.
2330
2331 If the file does exist locally, Wget will first check its local
2332 time-stamp (similar to the way @code{ls -l} checks it), and then send a
2333 @code{HEAD} request to the remote server, demanding the information on
2334 the remote file.
2335
2336 The @code{Last-Modified} header is examined to find which file was
2337 modified more recently (which makes it ``newer'').  If the remote file
2338 is newer, it will be downloaded; if it is older, Wget will give
2339 up.@footnote{As an additional check, Wget will look at the
2340 @code{Content-Length} header, and compare the sizes; if they are not the
2341 same, the remote file will be downloaded no matter what the time-stamp
2342 says.}
2343
2344 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
2345 with @samp{-N}, server file @samp{@var{X}} is compared to local file
2346 @samp{@var{X}.orig}, if extant, rather than being compared to local file
2347 @samp{@var{X}}, which will always differ if it's been converted by
2348 @samp{--convert-links} (@samp{-k}).
2349
2350 Arguably, @sc{http} time-stamping should be implemented using the
2351 @code{If-Modified-Since} request.
2352
2353 @node FTP Time-Stamping Internals
2354 @section FTP Time-Stamping Internals
2355 @cindex ftp time-stamping
2356
2357 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
2358 @sc{ftp} has no headers---time-stamps must be ferreted out of directory
2359 listings.
2360
2361 If an @sc{ftp} download is recursive or uses globbing, Wget will use the
2362 @sc{ftp} @code{LIST} command to get a file listing for the directory
2363 containing the desired file(s).  It will try to analyze the listing,
2364 treating it like Unix @code{ls -l} output, extracting the time-stamps.
2365 The rest is exactly the same as for @sc{http}.  Note that when
2366 retrieving individual files from an @sc{ftp} server without using
2367 globbing or recursion, listing files will not be downloaded (and thus
2368 files will not be time-stamped) unless @samp{-N} is specified.
2369
2370 Assumption that every directory listing is a Unix-style listing may
2371 sound extremely constraining, but in practice it is not, as many
2372 non-Unix @sc{ftp} servers use the Unixoid listing format because most
2373 (all?) of the clients understand it.  Bear in mind that @sc{rfc959}
2374 defines no standard way to get a file list, let alone the time-stamps.
2375 We can only hope that a future standard will define this.
2376
2377 Another non-standard solution includes the use of @code{MDTM} command
2378 that is supported by some @sc{ftp} servers (including the popular
2379 @code{wu-ftpd}), which returns the exact time of the specified file.
2380 Wget may support this command in the future.
2381
2382 @node Startup File
2383 @chapter Startup File
2384 @cindex startup file
2385 @cindex wgetrc
2386 @cindex .wgetrc
2387 @cindex startup
2388 @cindex .netrc
2389
2390 Once you know how to change default settings of Wget through command
2391 line arguments, you may wish to make some of those settings permanent.
2392 You can do that in a convenient way by creating the Wget startup
2393 file---@file{.wgetrc}.
2394
2395 Besides @file{.wgetrc} is the ``main'' initialization file, it is
2396 convenient to have a special facility for storing passwords.  Thus Wget
2397 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
2398 it.  You can find @file{.netrc} format in your system manuals.
2399
2400 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
2401 commands.
2402
2403 @menu
2404 * Wgetrc Location::   Location of various wgetrc files.
2405 * Wgetrc Syntax::     Syntax of wgetrc.
2406 * Wgetrc Commands::   List of available commands.
2407 * Sample Wgetrc::     A wgetrc example.
2408 @end menu
2409
2410 @node Wgetrc Location
2411 @section Wgetrc Location
2412 @cindex wgetrc location
2413 @cindex location of wgetrc
2414
2415 When initializing, Wget will look for a @dfn{global} startup file,
2416 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
2417 @file{/usr/local}, if Wget was not installed there) and read commands
2418 from there, if it exists.
2419
2420 Then it will look for the user's file.  If the environmental variable
2421 @code{WGETRC} is set, Wget will try to load that file.  Failing that, no
2422 further attempts will be made.
2423
2424 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
2425
2426 The fact that user's settings are loaded after the system-wide ones
2427 means that in case of collision user's wgetrc @emph{overrides} the
2428 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
2429 Fascist admins, away!
2430
2431 @node Wgetrc Syntax
2432 @section Wgetrc Syntax
2433 @cindex wgetrc syntax
2434 @cindex syntax of wgetrc
2435
2436 The syntax of a wgetrc command is simple:
2437
2438 @example
2439 variable = value
2440 @end example
2441
2442 The @dfn{variable} will also be called @dfn{command}.  Valid
2443 @dfn{values} are different for different commands.
2444
2445 The commands are case-insensitive and underscore-insensitive.  Thus
2446 @samp{DIr__PrefiX} is the same as @samp{dirprefix}.  Empty lines, lines
2447 beginning with @samp{#} and lines containing white-space only are
2448 discarded.
2449
2450 Commands that expect a comma-separated list will clear the list on an
2451 empty command.  So, if you wish to reset the rejection list specified in
2452 global @file{wgetrc}, you can do it with:
2453
2454 @example
2455 reject =
2456 @end example
2457
2458 @node Wgetrc Commands
2459 @section Wgetrc Commands
2460 @cindex wgetrc commands
2461
2462 The complete set of commands is listed below.  Legal values are listed
2463 after the @samp{=}.  Simple Boolean values can be set or unset using
2464 @samp{on} and @samp{off} or @samp{1} and @samp{0}.  A fancier kind of
2465 Boolean allowed in some cases is the @dfn{lockable Boolean}, which may
2466 be set to @samp{on}, @samp{off}, @samp{always}, or @samp{never}.  If an
2467 option is set to @samp{always} or @samp{never}, that value will be
2468 locked in for the duration of the Wget invocation---command-line options
2469 will not override.
2470
2471 Some commands take pseudo-arbitrary values.  @var{address} values can be
2472 hostnames or dotted-quad IP addresses.  @var{n} can be any positive
2473 integer, or @samp{inf} for infinity, where appropriate.  @var{string}
2474 values can be any non-empty string.
2475
2476 Most of these commands have direct command-line equivalents.  Also, any
2477 wgetrc command can be specified on the command line using the
2478 @samp{--execute} switch (@pxref{Basic Startup Options}.)
2479
2480 @table @asis
2481 @item accept/reject = @var{string}
2482 Same as @samp{-A}/@samp{-R} (@pxref{Types of Files}).
2483
2484 @item add_hostdir = on/off
2485 Enable/disable host-prefixed file names.  @samp{-nH} disables it.
2486
2487 @item continue = on/off
2488 If set to on, force continuation of preexistent partially retrieved
2489 files.  See @samp{-c} before setting it.
2490
2491 @item background = on/off
2492 Enable/disable going to background---the same as @samp{-b} (which
2493 enables it).
2494
2495 @item backup_converted = on/off
2496 Enable/disable saving pre-converted files with the suffix
2497 @samp{.orig}---the same as @samp{-K} (which enables it).
2498
2499 @c @item backups = @var{number}
2500 @c #### Document me!
2501 @c
2502 @item base = @var{string}
2503 Consider relative @sc{url}s in @sc{url} input files forced to be
2504 interpreted as @sc{html} as being relative to @var{string}---the same as
2505 @samp{--base=@var{string}}.
2506
2507 @item bind_address = @var{address}
2508 Bind to @var{address}, like the @samp{--bind-address=@var{address}}.
2509
2510 @item ca_certificate = @var{file}
2511 Set the certificate authority bundle file to @var{file}.  The same
2512 as @samp{--ca-certificate=@var{file}}.
2513
2514 @item ca_directory = @var{directory}
2515 Set the directory used for certificate authorities.  The same as
2516 @samp{--ca-directory=@var{directory}}.
2517
2518 @item cache = on/off
2519 When set to off, disallow server-caching.  See the @samp{--no-cache}
2520 option.
2521
2522 @item certificate = @var{file}
2523 Set the client certificate file name to @var{file}.  The same as
2524 @samp{--certificate=@var{file}}.
2525
2526 @item certificate_type = @var{string}
2527 Specify the type of the client certificate, legal values being
2528 @samp{PEM} (the default) and @samp{DER} (aka ASN1).  The same as
2529 @samp{--certificate-type=@var{string}}.
2530
2531 @item check_certificate = on/off
2532 If this is set to off, the server certificate is not checked against
2533 the specified client authorities.  The default is ``on''.  The same as
2534 @samp{--check-certificate}.
2535
2536 @item convert_links = on/off
2537 Convert non-relative links locally.  The same as @samp{-k}.
2538
2539 @item cookies = on/off
2540 When set to off, disallow cookies.  See the @samp{--cookies} option.
2541
2542 @item connect_timeout = @var{n}
2543 Set the connect timeout---the same as @samp{--connect-timeout}.
2544
2545 @item cut_dirs = @var{n}
2546 Ignore @var{n} remote directory components.  Equivalent to
2547 @samp{--cut-dirs=@var{n}}.
2548
2549 @item debug = on/off
2550 Debug mode, same as @samp{-d}.
2551
2552 @item delete_after = on/off
2553 Delete after download---the same as @samp{--delete-after}.
2554
2555 @item dir_prefix = @var{string}
2556 Top of directory tree---the same as @samp{-P @var{string}}.
2557
2558 @item dirstruct = on/off
2559 Turning dirstruct on or off---the same as @samp{-x} or @samp{-nd},
2560 respectively.
2561
2562 @item dns_cache = on/off
2563 Turn DNS caching on/off.  Since DNS caching is on by default, this
2564 option is normally used to turn it off and is equivalent to
2565 @samp{--no-dns-cache}.
2566
2567 @item dns_timeout = @var{n}
2568 Set the DNS timeout---the same as @samp{--dns-timeout}.
2569
2570 @item domains = @var{string}
2571 Same as @samp{-D} (@pxref{Spanning Hosts}).
2572
2573 @item dot_bytes = @var{n}
2574 Specify the number of bytes ``contained'' in a dot, as seen throughout
2575 the retrieval (1024 by default).  You can postfix the value with
2576 @samp{k} or @samp{m}, representing kilobytes and megabytes,
2577 respectively.  With dot settings you can tailor the dot retrieval to
2578 suit your needs, or you can use the predefined @dfn{styles}
2579 (@pxref{Download Options}).
2580
2581 @item dots_in_line = @var{n}
2582 Specify the number of dots that will be printed in each line throughout
2583 the retrieval (50 by default).
2584
2585 @item dot_spacing = @var{n}
2586 Specify the number of dots in a single cluster (10 by default).
2587
2588 @item egd_file = @var{file}
2589 Use @var{string} as the EGD socket file name.  The same as
2590 @samp{--egd-file=@var{file}}.
2591
2592 @item exclude_directories = @var{string}
2593 Specify a comma-separated list of directories you wish to exclude from
2594 download---the same as @samp{-X @var{string}} (@pxref{Directory-Based
2595 Limits}).
2596
2597 @item exclude_domains = @var{string}
2598 Same as @samp{--exclude-domains=@var{string}} (@pxref{Spanning
2599 Hosts}).
2600
2601 @item follow_ftp = on/off
2602 Follow @sc{ftp} links from @sc{html} documents---the same as
2603 @samp{--follow-ftp}.
2604
2605 @item follow_tags = @var{string}
2606 Only follow certain @sc{html} tags when doing a recursive retrieval,
2607 just like @samp{--follow-tags=@var{string}}.
2608
2609 @item force_html = on/off
2610 If set to on, force the input filename to be regarded as an @sc{html}
2611 document---the same as @samp{-F}.
2612
2613 @item ftp_password = @var{string}
2614 Set your @sc{ftp} password to @var{string}.  Without this setting, the
2615 password defaults to @samp{-wget@@}, which is a useful default for
2616 anonymous @sc{ftp} access.
2617
2618 This command used to be named @code{passwd} prior to Wget 1.10.
2619
2620 @item ftp_proxy = @var{string}
2621 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
2622 environment.
2623
2624 @item ftp_user = @var{string}
2625 Set @sc{ftp} user to @var{string}.
2626
2627 This command used to be named @code{login} prior to Wget 1.10.
2628
2629 @item glob = on/off
2630 Turn globbing on/off---the same as @samp{--glob} and @samp{--no-glob}.
2631
2632 @item header = @var{string}
2633 Define a header for HTTP doewnloads, like using
2634 @samp{--header=@var{string}}.
2635
2636 @item html_extension = on/off
2637 Add a @samp{.html} extension to @samp{text/html} or
2638 @samp{application/xhtml+xml} files without it, like @samp{-E}.
2639
2640 @item http_keep_alive = on/off
2641 Turn the keep-alive feature on or off (defaults to on).  Turning it
2642 off is equivalent to @samp{--no-http-keep-alive}.
2643
2644 @item http_password = @var{string}
2645 Set @sc{http} password, equivalent to
2646 @samp{--http-password=@var{string}}.
2647
2648 @item http_proxy = @var{string}
2649 Use @var{string} as @sc{http} proxy, instead of the one specified in
2650 environment.
2651
2652 @item http_user = @var{string}
2653 Set @sc{http} user to @var{string}, equivalent to
2654 @samp{--http-user=@var{string}}.
2655
2656 @item ignore_length = on/off
2657 When set to on, ignore @code{Content-Length} header; the same as
2658 @samp{--ignore-length}.
2659
2660 @item ignore_tags = @var{string}
2661 Ignore certain @sc{html} tags when doing a recursive retrieval, like
2662 @samp{--ignore-tags=@var{string}}.
2663
2664 @item include_directories = @var{string}
2665 Specify a comma-separated list of directories you wish to follow when
2666 downloading---the same as @samp{-I @var{string}}.
2667
2668 @item inet4_only = on/off
2669 Force connecting to IPv4 addresses, off by default.  You can put this
2670 in the global init file to disable Wget's attempts to resolve and
2671 connect to IPv6 hosts.  Available only if Wget was compiled with IPv6
2672 support.  The same as @samp{--inet4-only} or @samp{-4}.
2673
2674 @item inet6_only = on/off
2675 Force connecting to IPv6 addresses, off by default.  Available only if
2676 Wget was compiled with IPv6 support.  The same as @samp{--inet6-only}
2677 or @samp{-6}.
2678
2679 @item input = @var{file}
2680 Read the @sc{url}s from @var{string}, like @samp{-i @var{file}}.
2681
2682 @item kill_longer = on/off
2683 Consider data longer than specified in content-length header as invalid
2684 (and retry getting it).  The default behavior is to save as much data
2685 as there is, provided there is more than or equal to the value in
2686 @code{Content-Length}.
2687
2688 @item limit_rate = @var{rate}
2689 Limit the download speed to no more than @var{rate} bytes per second.
2690 The same as @samp{--limit-rate=@var{rate}}.
2691
2692 @item load_cookies = @var{file}
2693 Load cookies from @var{file}.  See @samp{--load-cookies @var{file}}.
2694
2695 @item logfile = @var{file}
2696 Set logfile to @var{file}, the same as @samp{-o @var{file}}.
2697
2698 @item mirror = on/off
2699 Turn mirroring on/off.  The same as @samp{-m}.
2700
2701 @item netrc = on/off
2702 Turn reading netrc on or off.
2703
2704 @item noclobber = on/off
2705 Same as @samp{-nc}.
2706
2707 @item no_parent = on/off
2708 Disallow retrieving outside the directory hierarchy, like
2709 @samp{--no-parent} (@pxref{Directory-Based Limits}).
2710
2711 @item no_proxy = @var{string}
2712 Use @var{string} as the comma-separated list of domains to avoid in
2713 proxy loading, instead of the one specified in environment.
2714
2715 @item output_document = @var{file}
2716 Set the output filename---the same as @samp{-O @var{file}}.
2717
2718 @item page_requisites = on/off
2719 Download all ancillary documents necessary for a single @sc{html} page to
2720 display properly---the same as @samp{-p}.
2721
2722 @item passive_ftp = on/off/always/never
2723 Change setting of passive @sc{ftp}, equivalent to the
2724 @samp{--passive-ftp} option.  Some scripts and @samp{.pm} (Perl
2725 module) files download files using @samp{wget --passive-ftp}.  If your
2726 firewall does not allow this, you can set @samp{passive_ftp = never}
2727 to override the command-line.
2728
2729 @itemx password = @var{string}
2730 Specify password @var{string} for both @sc{ftp} and @sc{http} file retrieval. 
2731 This command can be overridden using the @samp{ftp_password} and 
2732 @samp{http_password} command for @sc{ftp} and @sc{http} respectively.
2733
2734 @item post_data = @var{string}
2735 Use POST as the method for all HTTP requests and send @var{string} in
2736 the request body.  The same as @samp{--post-data=@var{string}}.
2737
2738 @item post_file = @var{file}
2739 Use POST as the method for all HTTP requests and send the contents of
2740 @var{file} in the request body.  The same as
2741 @samp{--post-file=@var{file}}.
2742
2743 @item prefer_family = IPv4/IPv6/none
2744 When given a choice of several addresses, connect to the addresses
2745 with specified address family first.  IPv4 addresses are preferred by
2746 default.  The same as @samp{--prefer-family}, which see for a detailed
2747 discussion of why this is useful.
2748
2749 @item private_key = @var{file}
2750 Set the private key file to @var{file}.  The same as
2751 @samp{--private-key=@var{file}}.
2752
2753 @item private_key_type = @var{string}
2754 Specify the type of the private key, legal values being @samp{PEM}
2755 (the default) and @samp{DER} (aka ASN1).  The same as
2756 @samp{--private-type=@var{string}}.
2757
2758 @item progress = @var{string}
2759 Set the type of the progress indicator.  Legal types are @samp{dot}
2760 and @samp{bar}.  Equivalent to @samp{--progress=@var{string}}.
2761
2762 @item protocol_directories = on/off
2763 When set, use the protocol name as a directory component of local file
2764 names.  The same as @samp{--protocol-directories}.
2765
2766 @item proxy_user = @var{string}
2767 Set proxy authentication user name to @var{string}, like
2768 @samp{--proxy-user=@var{string}}.
2769
2770 @item proxy_password = @var{string}
2771 Set proxy authentication password to @var{string}, like
2772 @samp{--proxy-password=@var{string}}.
2773
2774 @item quiet = on/off
2775 Quiet mode---the same as @samp{-q}.
2776
2777 @item quota = @var{quota}
2778 Specify the download quota, which is useful to put in the global
2779 @file{wgetrc}.  When download quota is specified, Wget will stop
2780 retrieving after the download sum has become greater than quota.  The
2781 quota can be specified in bytes (default), kbytes @samp{k} appended) or
2782 mbytes (@samp{m} appended).  Thus @samp{quota = 5m} will set the quota
2783 to 5 megabytes.  Note that the user's startup file overrides system
2784 settings.
2785
2786 @item random_file = @var{file}
2787 Use @var{file} as a source of randomness on systems lacking
2788 @file{/dev/random}.
2789
2790 @item read_timeout = @var{n}
2791 Set the read (and write) timeout---the same as
2792 @samp{--read-timeout=@var{n}}.
2793
2794 @item reclevel = @var{n}
2795 Recursion level (depth)---the same as @samp{-l @var{n}}.
2796
2797 @item recursive = on/off
2798 Recursive on/off---the same as @samp{-r}.
2799
2800 @item referer = @var{string}
2801 Set HTTP @samp{Referer:} header just like
2802 @samp{--referer=@var{string}}.  (Note it was the folks who wrote the
2803 @sc{http} spec who got the spelling of ``referrer'' wrong.)
2804
2805 @item relative_only = on/off
2806 Follow only relative links---the same as @samp{-L} (@pxref{Relative
2807 Links}).
2808
2809 @item remove_listing = on/off
2810 If set to on, remove @sc{ftp} listings downloaded by Wget.  Setting it
2811 to off is the same as @samp{--no-remove-listing}.
2812
2813 @item restrict_file_names = unix/windows
2814 Restrict the file names generated by Wget from URLs.  See
2815 @samp{--restrict-file-names} for a more detailed description.
2816
2817 @item retr_symlinks = on/off
2818 When set to on, retrieve symbolic links as if they were plain files; the
2819 same as @samp{--retr-symlinks}.
2820
2821 @item retry_connrefused = on/off
2822 When set to on, consider ``connection refused'' a transient
2823 error---the same as @samp{--retry-connrefused}.
2824
2825 @item robots = on/off
2826 Specify whether the norobots convention is respected by Wget, ``on'' by
2827 default.  This switch controls both the @file{/robots.txt} and the
2828 @samp{nofollow} aspect of the spec.  @xref{Robot Exclusion}, for more
2829 details about this.  Be sure you know what you are doing before turning
2830 this off.
2831
2832 @item save_cookies = @var{file}
2833 Save cookies to @var{file}.  The same as @samp{--save-cookies
2834 @var{file}}.
2835
2836 @item secure_protocol = @var{string}
2837 Choose the secure protocol to be used.  Legal values are @samp{auto}
2838 (the default), @samp{SSLv2}, @samp{SSLv3}, and @samp{TLSv1}.  The same
2839 as @samp{--secure-protocol=@var{string}}.
2840
2841 @item server_response = on/off
2842 Choose whether or not to print the @sc{http} and @sc{ftp} server
2843 responses---the same as @samp{-S}.
2844
2845 @item span_hosts = on/off
2846 Same as @samp{-H}.
2847
2848 @item strict_comments = on/off
2849 Same as @samp{--strict-comments}.
2850
2851 @item timeout = @var{n}
2852 Set all applicable timeout values to @var{n}, the same as @samp{-T
2853 @var{n}}.
2854
2855 @item timestamping = on/off
2856 Turn timestamping on/off.  The same as @samp{-N} (@pxref{Time-Stamping}).
2857
2858 @item tries = @var{n}
2859 Set number of retries per @sc{url}---the same as @samp{-t @var{n}}.
2860
2861 @item use_proxy = on/off
2862 When set to off, don't use proxy even when proxy-related environment
2863 variables are set.  In that case it is the same as using
2864 @samp{--no-proxy}.
2865
2866 @item user = @var{string}
2867 Specify username @var{string} for both @sc{ftp} and @sc{http} file retrieval. 
2868 This command can be overridden using the @samp{ftp_user} and 
2869 @samp{http_user} command for @sc{ftp} and @sc{http} respectively.
2870
2871 @item verbose = on/off
2872 Turn verbose on/off---the same as @samp{-v}/@samp{-nv}.
2873
2874 @item wait = @var{n}
2875 Wait @var{n} seconds between retrievals---the same as @samp{-w
2876 @var{n}}.
2877
2878 @item waitretry = @var{n}
2879 Wait up to @var{n} seconds between retries of failed retrievals
2880 only---the same as @samp{--waitretry=@var{n}}.  Note that this is
2881 turned on by default in the global @file{wgetrc}.
2882
2883 @item randomwait = on/off
2884 Turn random between-request wait times on or off. The same as 
2885 @samp{--random-wait}.
2886 @end table
2887
2888 @node Sample Wgetrc
2889 @section Sample Wgetrc
2890 @cindex sample wgetrc
2891
2892 This is the sample initialization file, as given in the distribution.
2893 It is divided in two section---one for global usage (suitable for global
2894 startup file), and one for local usage (suitable for
2895 @file{$HOME/.wgetrc}).  Be careful about the things you change.
2896
2897 Note that almost all the lines are commented out.  For a command to have
2898 any effect, you must remove the @samp{#} character at the beginning of
2899 its line.
2900
2901 @example
2902 @include sample.wgetrc.munged_for_texi_inclusion
2903 @end example
2904
2905 @node Examples
2906 @chapter Examples
2907 @cindex examples
2908
2909 @c man begin EXAMPLES
2910 The examples are divided into three sections loosely based on their
2911 complexity.
2912
2913 @menu
2914 * Simple Usage::         Simple, basic usage of the program.
2915 * Advanced Usage::       Advanced tips.
2916 * Very Advanced Usage::  The hairy stuff.
2917 @end menu
2918
2919 @node Simple Usage
2920 @section Simple Usage
2921
2922 @itemize @bullet
2923 @item
2924 Say you want to download a @sc{url}.  Just type:
2925
2926 @example
2927 wget http://fly.srk.fer.hr/
2928 @end example
2929
2930 @item
2931 But what will happen if the connection is slow, and the file is lengthy?
2932 The connection will probably fail before the whole file is retrieved,
2933 more than once.  In this case, Wget will try getting the file until it
2934 either gets the whole of it, or exceeds the default number of retries
2935 (this being 20).  It is easy to change the number of tries to 45, to
2936 insure that the whole file will arrive safely:
2937
2938 @example
2939 wget --tries=45 http://fly.srk.fer.hr/jpg/flyweb.jpg
2940 @end example
2941
2942 @item
2943 Now let's leave Wget to work in the background, and write its progress
2944 to log file @file{log}.  It is tiring to type @samp{--tries}, so we
2945 shall use @samp{-t}.
2946
2947 @example
2948 wget -t 45 -o log http://fly.srk.fer.hr/jpg/flyweb.jpg &
2949 @end example
2950
2951 The ampersand at the end of the line makes sure that Wget works in the
2952 background.  To unlimit the number of retries, use @samp{-t inf}.
2953
2954 @item
2955 The usage of @sc{ftp} is as simple.  Wget will take care of login and
2956 password.
2957
2958 @example
2959 wget ftp://gnjilux.srk.fer.hr/welcome.msg
2960 @end example
2961
2962 @item
2963 If you specify a directory, Wget will retrieve the directory listing,
2964 parse it and convert it to @sc{html}.  Try:
2965
2966 @example
2967 wget ftp://ftp.gnu.org/pub/gnu/
2968 links index.html
2969 @end example
2970 @end itemize
2971
2972 @node Advanced Usage
2973 @section Advanced Usage
2974
2975 @itemize @bullet
2976 @item
2977 You have a file that contains the URLs you want to download?  Use the
2978 @samp{-i} switch:
2979
2980 @example
2981 wget -i @var{file}
2982 @end example
2983
2984 If you specify @samp{-} as file name, the @sc{url}s will be read from
2985 standard input.
2986
2987 @item
2988 Create a five levels deep mirror image of the GNU web site, with the
2989 same directory structure the original has, with only one try per
2990 document, saving the log of the activities to @file{gnulog}:
2991
2992 @example
2993 wget -r http://www.gnu.org/ -o gnulog
2994 @end example
2995
2996 @item
2997 The same as the above, but convert the links in the @sc{html} files to
2998 point to local files, so you can view the documents off-line:
2999
3000 @example
3001 wget --convert-links -r http://www.gnu.org/ -o gnulog
3002 @end example
3003
3004 @item
3005 Retrieve only one @sc{html} page, but make sure that all the elements needed
3006 for the page to be displayed, such as inline images and external style
3007 sheets, are also downloaded.  Also make sure the downloaded page
3008 references the downloaded links.
3009
3010 @example
3011 wget -p --convert-links http://www.server.com/dir/page.html
3012 @end example
3013
3014 The @sc{html} page will be saved to @file{www.server.com/dir/page.html}, and
3015 the images, stylesheets, etc., somewhere under @file{www.server.com/},
3016 depending on where they were on the remote server.
3017
3018 @item
3019 The same as the above, but without the @file{www.server.com/} directory.
3020 In fact, I don't want to have all those random server directories
3021 anyway---just save @emph{all} those files under a @file{download/}
3022 subdirectory of the current directory.
3023
3024 @example
3025 wget -p --convert-links -nH -nd -Pdownload \
3026      http://www.server.com/dir/page.html
3027 @end example
3028
3029 @item
3030 Retrieve the index.html of @samp{www.lycos.com}, showing the original
3031 server headers:
3032
3033 @example
3034 wget -S http://www.lycos.com/
3035 @end example
3036
3037 @item
3038 Save the server headers with the file, perhaps for post-processing.
3039
3040 @example
3041 wget --save-headers http://www.lycos.com/
3042 more index.html
3043 @end example
3044
3045 @item
3046 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
3047 to @file{/tmp}.
3048
3049 @example
3050 wget -r -l2 -P/tmp ftp://wuarchive.wustl.edu/
3051 @end example
3052
3053 @item
3054 You want to download all the @sc{gif}s from a directory on an @sc{http}
3055 server.  You tried @samp{wget http://www.server.com/dir/*.gif}, but that
3056 didn't work because @sc{http} retrieval does not support globbing.  In
3057 that case, use:
3058
3059 @example
3060 wget -r -l1 --no-parent -A.gif http://www.server.com/dir/
3061 @end example
3062
3063 More verbose, but the effect is the same.  @samp{-r -l1} means to
3064 retrieve recursively (@pxref{Recursive Download}), with maximum depth
3065 of 1.  @samp{--no-parent} means that references to the parent directory
3066 are ignored (@pxref{Directory-Based Limits}), and @samp{-A.gif} means to
3067 download only the @sc{gif} files.  @samp{-A "*.gif"} would have worked
3068 too.
3069
3070 @item
3071 Suppose you were in the middle of downloading, when Wget was
3072 interrupted.  Now you do not want to clobber the files already present.
3073 It would be:
3074
3075 @example
3076 wget -nc -r http://www.gnu.org/
3077 @end example
3078
3079 @item
3080 If you want to encode your own username and password to @sc{http} or
3081 @sc{ftp}, use the appropriate @sc{url} syntax (@pxref{URL Format}).
3082
3083 @example
3084 wget ftp://hniksic:mypassword@@unix.server.com/.emacs
3085 @end example
3086
3087 Note, however, that this usage is not advisable on multi-user systems
3088 because it reveals your password to anyone who looks at the output of
3089 @code{ps}.
3090
3091 @cindex redirecting output
3092 @item
3093 You would like the output documents to go to standard output instead of
3094 to files?
3095
3096 @example
3097 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
3098 @end example
3099
3100 You can also combine the two options and make pipelines to retrieve the
3101 documents from remote hotlists:
3102
3103 @example
3104 wget -O - http://cool.list.com/ | wget --force-html -i -
3105 @end example
3106 @end itemize
3107
3108 @node Very Advanced Usage
3109 @section Very Advanced Usage
3110
3111 @cindex mirroring
3112 @itemize @bullet
3113 @item
3114 If you wish Wget to keep a mirror of a page (or @sc{ftp}
3115 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
3116 for @samp{-r -l inf -N}.  You can put Wget in the crontab file asking it
3117 to recheck a site each Sunday:
3118
3119 @example
3120 crontab
3121 0 0 * * 0 wget --mirror http://www.gnu.org/ -o /home/me/weeklog
3122 @end example
3123
3124 @item
3125 In addition to the above, you want the links to be converted for local
3126 viewing.  But, after having read this manual, you know that link
3127 conversion doesn't play well with timestamping, so you also want Wget to
3128 back up the original @sc{html} files before the conversion.  Wget invocation
3129 would look like this:
3130
3131 @example
3132 wget --mirror --convert-links --backup-converted  \
3133      http://www.gnu.org/ -o /home/me/weeklog
3134 @end example
3135
3136 @item
3137 But you've also noticed that local viewing doesn't work all that well
3138 when @sc{html} files are saved under extensions other than @samp{.html},
3139 perhaps because they were served as @file{index.cgi}.  So you'd like
3140 Wget to rename all the files served with content-type @samp{text/html}
3141 or @samp{application/xhtml+xml} to @file{@var{name}.html}.
3142
3143 @example
3144 wget --mirror --convert-links --backup-converted \
3145      --html-extension -o /home/me/weeklog        \
3146      http://www.gnu.org/
3147 @end example
3148
3149 Or, with less typing:
3150
3151 @example
3152 wget -m -k -K -E http://www.gnu.org/ -o /home/me/weeklog
3153 @end example
3154 @end itemize
3155 @c man end
3156
3157 @node Various
3158 @chapter Various
3159 @cindex various
3160
3161 This chapter contains all the stuff that could not fit anywhere else.
3162
3163 @menu
3164 * Proxies::             Support for proxy servers
3165 * Distribution::        Getting the latest version.
3166 * Mailing List::        Wget mailing list for announcements and discussion.
3167 * Reporting Bugs::      How and where to report bugs.
3168 * Portability::         The systems Wget works on.
3169 * Signals::             Signal-handling performed by Wget.
3170 @end menu
3171
3172 @node Proxies
3173 @section Proxies
3174 @cindex proxies
3175
3176 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
3177 data from remote servers to local clients.  One typical use of proxies
3178 is lightening network load for users behind a slow connection.  This is
3179 achieved by channeling all @sc{http} and @sc{ftp} requests through the
3180 proxy which caches the transferred data.  When a cached resource is
3181 requested again, proxy will return the data from cache.  Another use for
3182 proxies is for companies that separate (for security reasons) their
3183 internal networks from the rest of Internet.  In order to obtain
3184 information from the Web, their users connect and retrieve remote data
3185 using an authorized proxy.
3186
3187 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals.  The
3188 standard way to specify proxy location, which Wget recognizes, is using
3189 the following environment variables:
3190
3191 @table @code
3192 @item http_proxy
3193 This variable should contain the @sc{url} of the proxy for @sc{http}
3194 connections.
3195
3196 @item ftp_proxy
3197 This variable should contain the @sc{url} of the proxy for @sc{ftp}
3198 connections.  It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
3199 are set to the same @sc{url}.
3200
3201 @item no_proxy
3202 This variable should contain a comma-separated list of domain extensions
3203 proxy should @emph{not} be used for.  For instance, if the value of
3204 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
3205 documents from MIT.
3206 @end table
3207
3208 In addition to the environment variables, proxy location and settings
3209 may be specified from within Wget itself.
3210
3211 @table @samp
3212 @item -Y on/off
3213 @itemx --proxy
3214 @itemx --no-proxy
3215 @itemx proxy = on/off
3216 This option may be used to turn the proxy support on or off.  Proxy
3217 support is on by default, provided that the appropriate environment
3218 variables are set.
3219
3220 @item http_proxy = @var{URL}
3221 @itemx ftp_proxy = @var{URL}
3222 @itemx no_proxy = @var{string}
3223 These startup file variables allow you to override the proxy settings
3224 specified by the environment.
3225 @end table
3226
3227 Some proxy servers require authorization to enable you to use them.  The
3228 authorization consists of @dfn{username} and @dfn{password}, which must
3229 be sent by Wget.  As with @sc{http} authorization, several
3230 authentication schemes exist.  For proxy authorization only the
3231 @code{Basic} authentication scheme is currently implemented.
3232
3233 You may specify your username and password either through the proxy
3234 @sc{url} or through the command-line options.  Assuming that the
3235 company's proxy is located at @samp{proxy.company.com} at port 8001, a
3236 proxy @sc{url} location containing authorization data might look like
3237 this:
3238
3239 @example
3240 http://hniksic:mypassword@@proxy.company.com:8001/
3241 @end example
3242
3243 Alternatively, you may use the @samp{proxy-user} and
3244 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
3245 settings @code{proxy_user} and @code{proxy_password} to set the proxy
3246 username and password.
3247
3248 @node Distribution
3249 @section Distribution
3250 @cindex latest version
3251
3252 Like all GNU utilities, the latest version of Wget can be found at the
3253 master GNU archive site ftp.gnu.org, and its mirrors.  For example,
3254 Wget @value{VERSION} can be found at
3255 @url{ftp://ftp.gnu.org/pub/gnu/wget/wget-@value{VERSION}.tar.gz}
3256
3257 @node Mailing List
3258 @section Mailing List
3259 @cindex mailing list
3260 @cindex list
3261
3262 There are several Wget-related mailing lists, all hosted by
3263 SunSITE.dk.  The general discussion list is at
3264 @email{wget@@sunsite.dk}.  It is the preferred place for bug reports
3265 and suggestions, as well as for discussion of development.  You are
3266 invited to subscribe.
3267
3268 To subscribe, simply send mail to @email{wget-subscribe@@sunsite.dk}
3269 and follow the instructions.  Unsubscribe by mailing to
3270 @email{wget-unsubscribe@@sunsite.dk}.  The mailing list is archived at
3271 @url{http://www.mail-archive.com/wget%40sunsite.dk/} and at
3272 @url{http://news.gmane.org/gmane.comp.web.wget.general}.
3273
3274 The second mailing list is at @email{wget-patches@@sunsite.dk}, and is
3275 used to submit patches for review by Wget developers.  A ``patch'' is
3276 a textual representation of change to source code, readable by both
3277 humans and programs.  The file @file{PATCHES} that comes with Wget
3278 covers the creation and submitting of patches in detail.  Please don't
3279 send general suggestions or bug reports to @samp{wget-patches}; use it
3280 only for patch submissions.
3281
3282 To subscribe, simply send mail to @email{wget-subscribe@@sunsite.dk}
3283 and follow the instructions.  Unsubscribe by mailing to
3284 @email{wget-unsubscribe@@sunsite.dk}.  The mailing list is archived at
3285 @url{http://news.gmane.org/gmane.comp.web.wget.patches}.
3286
3287 Finally, there is a read-only list at @email{wget-cvs@@sunsite.dk}
3288 that tracks commits to the Wget CVS repository.  To subscribe to that
3289 list, send mail to @email{wget-cvs-subscribe@@sunsite.dk}.  The list
3290 is not archived.
3291
3292 @node Reporting Bugs
3293 @section Reporting Bugs
3294 @cindex bugs
3295 @cindex reporting bugs
3296 @cindex bug reports
3297
3298 @c man begin BUGS
3299 You are welcome to send bug reports about GNU Wget to
3300 @email{bug-wget@@gnu.org}.
3301
3302 Before actually submitting a bug report, please try to follow a few
3303 simple guidelines.
3304
3305 @enumerate
3306 @item
3307 Please try to ascertain that the behavior you see really is a bug.  If
3308 Wget crashes, it's a bug.  If Wget does not behave as documented,
3309 it's a bug.  If things work strange, but you are not sure about the way
3310 they are supposed to work, it might well be a bug.
3311
3312 @item
3313 Try to repeat the bug in as simple circumstances as possible.  E.g. if
3314 Wget crashes while downloading @samp{wget -rl0 -kKE -t5 -Y0
3315 http://yoyodyne.com -o /tmp/log}, you should try to see if the crash is
3316 repeatable, and if will occur with a simpler set of options.  You might
3317 even try to start the download at the page where the crash occurred to
3318 see if that page somehow triggered the crash.
3319
3320 Also, while I will probably be interested to know the contents of your
3321 @file{.wgetrc} file, just dumping it into the debug message is probably
3322 a bad idea.  Instead, you should first try to see if the bug repeats
3323 with @file{.wgetrc} moved out of the way.  Only if it turns out that
3324 @file{.wgetrc} settings affect the bug, mail me the relevant parts of
3325 the file.
3326
3327 @item
3328 Please start Wget with @samp{-d} option and send us the resulting
3329 output (or relevant parts thereof).  If Wget was compiled without
3330 debug support, recompile it---it is @emph{much} easier to trace bugs
3331 with debug support on.
3332
3333 Note: please make sure to remove any potentially sensitive information
3334 from the debug log before sending it to the bug address.  The
3335 @code{-d} won't go out of its way to collect sensitive information,
3336 but the log @emph{will} contain a fairly complete transcript of Wget's
3337 communication with the server, which may include passwords and pieces
3338 of downloaded data.  Since the bug address is publically archived, you
3339 may assume that all bug reports are visible to the public.
3340
3341 @item
3342 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
3343 wget` core} and type @code{where} to get the backtrace.  This may not
3344 work if the system administrator has disabled core files, but it is
3345 safe to try.
3346 @end enumerate
3347 @c man end
3348
3349 @node Portability
3350 @section Portability
3351 @cindex portability
3352 @cindex operating systems
3353
3354 Like all GNU software, Wget works on the GNU system.  However, since it
3355 uses GNU Autoconf for building and configuring, and mostly avoids using
3356 ``special'' features of any particular Unix, it should compile (and
3357 work) on all common Unix flavors.
3358
3359 Various Wget versions have been compiled and tested under many kinds
3360 of Unix systems, including GNU/Linux, Solaris, SunOS 4.x, OSF (aka
3361 Digital Unix or Tru64), Ultrix, *BSD, IRIX, AIX, and others.  Some of
3362 those systems are no longer in widespread use and may not be able to
3363 support recent versions of Wget.  If Wget fails to compile on your
3364 system, we would like to know about it.
3365
3366 Thanks to kind contributors, this version of Wget compiles and works
3367 on 32-bit Microsoft Windows platforms.  It has been compiled
3368 successfully using MS Visual C++ 6.0, Watcom, Borland C, and GCC
3369 compilers.  Naturally, it is crippled of some features available on
3370 Unix, but it should work as a substitute for people stuck with
3371 Windows.  Note that Windows-specific portions of Wget are not
3372 guaranteed to be supported in the future, although this has been the
3373 case in practice for many years now.  All questions and problems in
3374 Windows usage should be reported to Wget mailing list at
3375 @email{wget@@sunsite.dk} where the volunteers who maintain the
3376 Windows-related features might look at them.
3377
3378 @node Signals
3379 @section Signals
3380 @cindex signal handling
3381 @cindex hangup
3382
3383 Since the purpose of Wget is background work, it catches the hangup
3384 signal (@code{SIGHUP}) and ignores it.  If the output was on standard
3385 output, it will be redirected to a file named @file{wget-log}.
3386 Otherwise, @code{SIGHUP} is ignored.  This is convenient when you wish
3387 to redirect the output of Wget after having started it.
3388
3389 @example
3390 $ wget http://www.gnus.org/dist/gnus.tar.gz &
3391 ...
3392 $ kill -HUP %%
3393 SIGHUP received, redirecting output to `wget-log'.
3394 @end example
3395
3396 Other than that, Wget will not try to interfere with signals in any way.
3397 @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it alike.
3398
3399 @node Appendices
3400 @chapter Appendices
3401
3402 This chapter contains some references I consider useful.
3403
3404 @menu
3405 * Robot Exclusion::         Wget's support for RES.
3406 * Security Considerations:: Security with Wget.
3407 * Contributors::            People who helped.
3408 @end menu
3409
3410 @node Robot Exclusion
3411 @section Robot Exclusion
3412 @cindex robot exclusion
3413 @cindex robots.txt
3414 @cindex server maintenance
3415
3416 It is extremely easy to make Wget wander aimlessly around a web site,
3417 sucking all the available data in progress.  @samp{wget -r @var{site}},
3418 and you're set.  Great?  Not for the server admin.
3419
3420 As long as Wget is only retrieving static pages, and doing it at a
3421 reasonable rate (see the @samp{--wait} option), there's not much of a
3422 problem.  The trouble is that Wget can't tell the difference between the
3423 smallest static page and the most demanding CGI.  A site I know has a
3424 section handled by a CGI Perl script that converts Info files to @sc{html} on
3425 the fly.  The script is slow, but works well enough for human users
3426 viewing an occasional Info file.  However, when someone's recursive Wget
3427 download stumbles upon the index page that links to all the Info files
3428 through the script, the system is brought to its knees without providing
3429 anything useful to the user (This task of converting Info files could be
3430 done locally and access to Info documentation for all installed GNU
3431 software on a system is available from the @code{info} command).
3432
3433 To avoid this kind of accident, as well as to preserve privacy for
3434 documents that need to be protected from well-behaved robots, the
3435 concept of @dfn{robot exclusion} was invented.  The idea is that
3436 the server administrators and document authors can specify which
3437 portions of the site they wish to protect from robots and those
3438 they will permit access.
3439
3440 The most popular mechanism, and the @i{de facto} standard supported by
3441 all the major robots, is the ``Robots Exclusion Standard'' (RES) written
3442 by Martijn Koster et al. in 1994.  It specifies the format of a text
3443 file containing directives that instruct the robots which URL paths to
3444 avoid.  To be found by the robots, the specifications must be placed in
3445 @file{/robots.txt} in the server root, which the robots are expected to
3446 download and parse.
3447
3448 Although Wget is not a web robot in the strictest sense of the word, it
3449 can downloads large parts of the site without the user's intervention to
3450 download an individual page.  Because of that, Wget honors RES when
3451 downloading recursively.  For instance, when you issue:
3452
3453 @example
3454 wget -r http://www.server.com/
3455 @end example
3456
3457 First the index of @samp{www.server.com} will be downloaded.  If Wget
3458 finds that it wants to download more documents from that server, it will
3459 request @samp{http://www.server.com/robots.txt} and, if found, use it
3460 for further downloads.  @file{robots.txt} is loaded only once per each
3461 server.
3462
3463 Until version 1.8, Wget supported the first version of the standard,
3464 written by Martijn Koster in 1994 and available at
3465 @url{http://www.robotstxt.org/wc/norobots.html}.  As of version 1.8,
3466 Wget has supported the additional directives specified in the internet
3467 draft @samp{<draft-koster-robots-00.txt>} titled ``A Method for Web
3468 Robots Control''.  The draft, which has as far as I know never made to
3469 an @sc{rfc}, is available at
3470 @url{http://www.robotstxt.org/wc/norobots-rfc.txt}.
3471
3472 This manual no longer includes the text of the Robot Exclusion Standard.
3473
3474 The second, less known mechanism, enables the author of an individual
3475 document to specify whether they want the links from the file to be
3476 followed by a robot.  This is achieved using the @code{META} tag, like
3477 this:
3478
3479 @example
3480 <meta name="robots" content="nofollow">
3481 @end example
3482
3483 This is explained in some detail at
3484 @url{http://www.robotstxt.org/wc/meta-user.html}.  Wget supports this
3485 method of robot exclusion in addition to the usual @file{/robots.txt}
3486 exclusion.
3487
3488 If you know what you are doing and really really wish to turn off the
3489 robot exclusion, set the @code{robots} variable to @samp{off} in your
3490 @file{.wgetrc}.  You can achieve the same effect from the command line
3491 using the @code{-e} switch, e.g. @samp{wget -e robots=off @var{url}...}.
3492
3493 @node Security Considerations
3494 @section Security Considerations
3495 @cindex security
3496
3497 When using Wget, you must be aware that it sends unencrypted passwords
3498 through the network, which may present a security problem.  Here are the
3499 main issues, and some solutions.
3500
3501 @enumerate
3502 @item
3503 The passwords on the command line are visible using @code{ps}.  The best
3504 way around it is to use @code{wget -i -} and feed the @sc{url}s to
3505 Wget's standard input, each on a separate line, terminated by @kbd{C-d}.
3506 Another workaround is to use @file{.netrc} to store passwords; however,
3507 storing unencrypted passwords is also considered a security risk.
3508
3509 @item
3510 Using the insecure @dfn{basic} authentication scheme, unencrypted
3511 passwords are transmitted through the network routers and gateways.
3512
3513 @item
3514 The @sc{ftp} passwords are also in no way encrypted.  There is no good
3515 solution for this at the moment.
3516
3517 @item
3518 Although the ``normal'' output of Wget tries to hide the passwords,
3519 debugging logs show them, in all forms.  This problem is avoided by
3520 being careful when you send debug logs (yes, even when you send them to
3521 me).
3522 @end enumerate
3523
3524 @node Contributors
3525 @section Contributors
3526 @cindex contributors
3527
3528 @iftex
3529 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@xemacs.org}.
3530 @end iftex
3531 @ifnottex
3532 GNU Wget was written by Hrvoje Niksic @email{hniksic@@xemacs.org}.
3533 @end ifnottex
3534 However, its development could never have gone as far as it has, were it
3535 not for the help of many people, either with bug reports, feature
3536 proposals, patches, or letters saying ``Thanks!''.
3537
3538 Special thanks goes to the following people (no particular order):
3539
3540 @itemize @bullet
3541 @item
3542 Karsten Thygesen---donated system resources such as the mailing list,
3543 web space, and @sc{ftp} space, along with a lot of time to make these
3544 actually work.
3545
3546 @item
3547 Shawn McHorse---bug reports and patches.
3548
3549 @item
3550 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization.  Lots of
3551 portability fixes.
3552
3553 @item
3554 Gordon Matzigkeit---@file{.netrc} support.
3555
3556 @item
3557 @iftex
3558 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
3559 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
3560 @end iftex
3561 @ifnottex
3562 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
3563 and ``philosophical'' discussions.
3564 @end ifnottex
3565
3566 @item
3567 Darko Budor---initial port to Windows.
3568
3569 @item
3570 Antonio Rosella---help and suggestions, plus the Italian translation.
3571
3572 @item
3573 @iftex
3574 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
3575 suggestions.
3576 @end iftex
3577 @ifnottex
3578 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
3579 @end ifnottex
3580
3581 @item
3582 @iftex
3583 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
3584 @end iftex
3585 @ifnottex
3586 Francois Pinard---many thorough bug reports and discussions.
3587 @end ifnottex
3588
3589 @item
3590 Karl Eichwalder---lots of help with internationalization and other
3591 things.
3592
3593 @item
3594 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
3595 authentication.
3596
3597 @item
3598 The people who provided donations for development, including Brian
3599 Gough.
3600 @end itemize
3601
3602 The following people have provided patches, bug/build reports, useful
3603 suggestions, beta testing services, fan mail and all the other things
3604 that make maintenance so much fun:
3605
3606 Ian Abbott
3607 Tim Adam,
3608 Adrian Aichner,
3609 Martin Baehr,
3610 Dieter Baron,
3611 Roger Beeman,
3612 Dan Berger,
3613 T. Bharath,
3614 Christian Biere,
3615 Paul Bludov,
3616 Daniel Bodea,
3617 Mark Boyns,
3618 John Burden,
3619 Wanderlei Cavassin,
3620 Gilles Cedoc,
3621 Tim Charron,
3622 Noel Cragg,
3623 @iftex
3624 Kristijan @v{C}onka@v{s},
3625 @end iftex
3626 @ifnottex
3627 Kristijan Conkas,
3628 @end ifnottex
3629 John Daily,
3630 Andreas Damm,
3631 Ahmon Dancy,
3632 Andrew Davison,
3633 Bertrand Demiddelaer,
3634 Andrew Deryabin,
3635 Ulrich Drepper,
3636 Marc Duponcheel,
3637 @iftex
3638 Damir D@v{z}eko,
3639 @end iftex
3640 @ifnottex
3641 Damir Dzeko,
3642 @end ifnottex
3643 Alan Eldridge,
3644 Hans-Andreas Engel,
3645 @iftex
3646 Aleksandar Erkalovi@'{c},
3647 @end iftex
3648 @ifnottex
3649 Aleksandar Erkalovic,
3650 @end ifnottex
3651 Andy Eskilsson,
3652 Christian Fraenkel,
3653 David Fritz,
3654 Charles C. Fu,
3655 FUJISHIMA Satsuki,
3656 Masashi Fujita,
3657 Howard Gayle,
3658 Marcel Gerrits,
3659 Lemble Gregory,
3660 Hans Grobler,
3661 Mathieu Guillaume,
3662 Dan Harkless,
3663 Aaron Hawley,
3664 Herold Heiko,
3665 Jochen Hein,
3666 Karl Heuer,
3667 HIROSE Masaaki,
3668 Ulf Harnhammar,
3669 Gregor Hoffleit,
3670 Erik Magnus Hulthen,
3671 Richard Huveneers,
3672 Jonas Jensen,
3673 Larry Jones,
3674 Simon Josefsson,
3675 @iftex
3676 Mario Juri@'{c},
3677 @end iftex
3678 @ifnottex
3679 Mario Juric,
3680 @end ifnottex
3681 @iftex
3682 Hack Kampbj@o rn,
3683 @end iftex
3684 @ifnottex
3685 Hack Kampbjorn,
3686 @end ifnottex
3687 Const Kaplinsky,
3688 @iftex
3689 Goran Kezunovi@'{c},
3690 @end iftex
3691 @ifnottex
3692 Goran Kezunovic,
3693 @end ifnottex
3694 Igor Khristophorov,
3695 Robert Kleine,
3696 KOJIMA Haime,
3697 Fila Kolodny,
3698 Alexander Kourakos,
3699 Martin Kraemer,
3700 Sami Krank,
3701 @tex
3702 $\Sigma\acute{\iota}\mu o\varsigma\;
3703 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
3704 (Simos KSenitellis),
3705 @end tex
3706 @ifnottex
3707 Simos KSenitellis,
3708 @end ifnottex
3709 Christian Lackas,
3710 Hrvoje Lacko,
3711 Daniel S. Lewart,
3712 @iftex
3713 Nicol@'{a}s Lichtmeier,
3714 @end iftex
3715 @ifnottex
3716 Nicolas Lichtmeier,
3717 @end ifnottex
3718 Dave Love,
3719 Alexander V. Lukyanov,
3720 Thomas Lussnig,
3721 Andre Majorel,
3722 Aurelien Marchand,
3723 Matthew J. Mellon,
3724 Jordan Mendelson,
3725 Lin Zhe Min,
3726 Jan Minar,
3727 Tim Mooney,
3728 Adam D. Moss,
3729 Simon Munton,
3730 Charlie Negyesi,
3731 R. K. Owen,
3732 Leonid Petrov,
3733 Simone Piunno,
3734 Andrew Pollock,
3735 Steve Pothier,
3736 @iftex
3737 Jan P@v{r}ikryl,
3738 @end iftex
3739 @ifnottex
3740 Jan Prikryl,
3741 @end ifnottex
3742 Marin Purgar,
3743 @iftex
3744 Csaba R@'{a}duly,
3745 @end iftex
3746 @ifnottex
3747 Csaba Raduly,
3748 @end ifnottex
3749 Keith Refson,
3750 Bill Richardson,
3751 Tyler Riddle,
3752 Tobias Ringstrom,
3753 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
3754 @tex
3755 Juan Jos\'{e} Rodr\'{\i}guez,
3756 @end tex
3757 @ifnottex
3758 Juan Jose Rodriguez,
3759 @end ifnottex
3760 Maciej W. Rozycki,
3761 Edward J. Sabol,
3762 Heinz Salzmann,
3763 Robert Schmidt,
3764 Nicolas Schodet,
3765 Andreas Schwab,
3766 Chris Seawood,
3767 Dennis Smit,
3768 Toomas Soome,
3769 Tage Stabell-Kulo,
3770 Philip Stadermann,
3771 Daniel Stenberg,
3772 Sven Sternberger,
3773 Markus Strasser,
3774 John Summerfield,
3775 Szakacsits Szabolcs,
3776 Mike Thomas,
3777 Philipp Thomas,
3778 Mauro Tortonesi,
3779 Dave Turner,
3780 Gisle Vanem,
3781 Russell Vincent,
3782 @iftex
3783 @v{Z}eljko Vrba,
3784 @end iftex
3785 @ifnottex
3786 Zeljko Vrba,
3787 @end ifnottex
3788 Charles G Waldman,
3789 Douglas E. Wegscheid,
3790 YAMAZAKI Makoto,
3791 Jasmin Zainul,
3792 @iftex
3793 Bojan @v{Z}drnja,
3794 @end iftex
3795 @ifnottex
3796 Bojan Zdrnja,
3797 @end ifnottex
3798 Kristijan Zimmer.
3799
3800 Apologies to all who I accidentally left out, and many thanks to all the
3801 subscribers of the Wget mailing list.
3802
3803 @node Copying
3804 @chapter Copying
3805 @cindex copying
3806 @cindex GPL
3807 @cindex GFDL
3808 @cindex free software
3809
3810 GNU Wget is licensed under the GNU General Public License (GNU GPL),
3811 which makes it @dfn{free software}.  Please note that ``free'' in ``free
3812 software'' refers to liberty, not price.  As some people like to point
3813 out, it's the ``free'' of ``free speech'', not the ``free'' of ``free
3814 beer''.
3815
3816 The exact and legally binding distribution terms are spelled out below.
3817 The GPL guarantees that you have the right (freedom) to run and change
3818 GNU Wget and distribute it to others, and even---if you want---charge
3819 money for doing any of those things.  With these rights comes the
3820 obligation to distribute the source code along with the software and to
3821 grant your recipients the same rights and impose the same restrictions.
3822
3823 This licensing model is also known as @dfn{open source} because it,
3824 among other things, makes sure that all recipients will receive the
3825 source code along with the program, and be able to improve it.  The GNU
3826 project prefers the term ``free software'' for reasons outlined at
3827 @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
3828
3829 The exact license terms are defined by this paragraph and the GNU
3830 General Public License it refers to:
3831
3832 @quotation
3833 GNU Wget is free software; you can redistribute it and/or modify it
3834 under the terms of the GNU General Public License as published by the
3835 Free Software Foundation; either version 2 of the License, or (at your
3836 option) any later version.
3837
3838 GNU Wget is distributed in the hope that it will be useful, but WITHOUT
3839 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3840 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
3841 for more details.
3842
3843 A copy of the GNU General Public License is included as part of this
3844 manual; if you did not receive it, write to the Free Software
3845 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3846 @end quotation
3847
3848 In addition to this, this manual is free in the same sense:
3849
3850 @quotation
3851 Permission is granted to copy, distribute and/or modify this document
3852 under the terms of the GNU Free Documentation License, Version 1.2 or
3853 any later version published by the Free Software Foundation; with the
3854 Invariant Sections being ``GNU General Public License'' and ``GNU Free
3855 Documentation License'', with no Front-Cover Texts, and with no
3856 Back-Cover Texts.  A copy of the license is included in the section
3857 entitled ``GNU Free Documentation License''.
3858 @end quotation
3859
3860 @c #### Maybe we should wrap these licenses in ifinfo?  Stallman says
3861 @c that the GFDL needs to be present in the manual, and to me it would
3862 @c suck to include the license for the manual and not the license for
3863 @c the program.
3864
3865 The full texts of the GNU General Public License and of the GNU Free
3866 Documentation License are available below.
3867
3868 @menu
3869 * GNU General Public License::
3870 * GNU Free Documentation License::
3871 @end menu
3872
3873 @node GNU General Public License
3874 @section GNU General Public License
3875 @center Version 2, June 1991
3876
3877 @display
3878 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
3879 675 Mass Ave, Cambridge, MA 02139, USA
3880
3881 Everyone is permitted to copy and distribute verbatim copies
3882 of this license document, but changing it is not allowed.
3883 @end display
3884
3885 @unnumberedsec Preamble
3886
3887   The licenses for most software are designed to take away your
3888 freedom to share and change it.  By contrast, the GNU General Public
3889 License is intended to guarantee your freedom to share and change free
3890 software---to make sure the software is free for all its users.  This
3891 General Public License applies to most of the Free Software
3892 Foundation's software and to any other program whose authors commit to
3893 using it.  (Some other Free Software Foundation software is covered by
3894 the GNU Library General Public License instead.)  You can apply it to
3895 your programs, too.
3896
3897   When we speak of free software, we are referring to freedom, not
3898 price.  Our General Public Licenses are designed to make sure that you
3899 have the freedom to distribute copies of free software (and charge for
3900 this service if you wish), that you receive source code or can get it
3901 if you want it, that you can change the software or use pieces of it
3902 in new free programs; and that you know you can do these things.
3903
3904   To protect your rights, we need to make restrictions that forbid
3905 anyone to deny you these rights or to ask you to surrender the rights.
3906 These restrictions translate to certain responsibilities for you if you
3907 distribute copies of the software, or if you modify it.
3908
3909   For example, if you distribute copies of such a program, whether
3910 gratis or for a fee, you must give the recipients all the rights that
3911 you have.  You must make sure that they, too, receive or can get the
3912 source code.  And you must show them these terms so they know their
3913 rights.
3914
3915   We protect your rights with two steps: (1) copyright the software, and
3916 (2) offer you this license which gives you legal permission to copy,
3917 distribute and/or modify the software.
3918
3919   Also, for each author's protection and ours, we want to make certain
3920 that everyone understands that there is no warranty for this free
3921 software.  If the software is modified by someone else and passed on, we
3922 want its recipients to know that what they have is not the original, so
3923 that any problems introduced by others will not reflect on the original
3924 authors' reputations.
3925
3926   Finally, any free program is threatened constantly by software
3927 patents.  We wish to avoid the danger that redistributors of a free
3928 program will individually obtain patent licenses, in effect making the
3929 program proprietary.  To prevent this, we have made it clear that any
3930 patent must be licensed for everyone's free use or not licensed at all.
3931
3932   The precise terms and conditions for copying, distribution and
3933 modification follow.
3934
3935 @iftex
3936 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3937 @end iftex
3938 @ifnottex
3939 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
3940 @end ifnottex
3941
3942 @enumerate
3943 @item
3944 This License applies to any program or other work which contains
3945 a notice placed by the copyright holder saying it may be distributed
3946 under the terms of this General Public License.  The ``Program'', below,
3947 refers to any such program or work, and a ``work based on the Program''
3948 means either the Program or any derivative work under copyright law:
3949 that is to say, a work containing the Program or a portion of it,
3950 either verbatim or with modifications and/or translated into another
3951 language.  (Hereinafter, translation is included without limitation in
3952 the term ``modification''.)  Each licensee is addressed as ``you''.
3953
3954 Activities other than copying, distribution and modification are not
3955 covered by this License; they are outside its scope.  The act of
3956 running the Program is not restricted, and the output from the Program
3957 is covered only if its contents constitute a work based on the
3958 Program (independent of having been made by running the Program).
3959 Whether that is true depends on what the Program does.
3960
3961 @item
3962 You may copy and distribute verbatim copies of the Program's
3963 source code as you receive it, in any medium, provided that you
3964 conspicuously and appropriately publish on each copy an appropriate
3965 copyright notice and disclaimer of warranty; keep intact all the
3966 notices that refer to this License and to the absence of any warranty;
3967 and give any other recipients of the Program a copy of this License
3968 along with the Program.
3969
3970 You may charge a fee for the physical act of transferring a copy, and
3971 you may at your option offer warranty protection in exchange for a fee.
3972
3973 @item
3974 You may modify your copy or copies of the Program or any portion
3975 of it, thus forming a work based on the Program, and copy and
3976 distribute such modifications or work under the terms of Section 1
3977 above, provided that you also meet all of these conditions:
3978
3979 @enumerate a
3980 @item
3981 You must cause the modified files to carry prominent notices
3982 stating that you changed the files and the date of any change.
3983
3984 @item
3985 You must cause any work that you distribute or publish, that in
3986 whole or in part contains or is derived from the Program or any
3987 part thereof, to be licensed as a whole at no charge to all third
3988 parties under the terms of this License.
3989
3990 @item
3991 If the modified program normally reads commands interactively
3992 when run, you must cause it, when started running for such
3993 interactive use in the most ordinary way, to print or display an
3994 announcement including an appropriate copyright notice and a
3995 notice that there is no warranty (or else, saying that you provide
3996 a warranty) and that users may redistribute the program under
3997 these conditions, and telling the user how to view a copy of this
3998 License.  (Exception: if the Program itself is interactive but
3999 does not normally print such an announcement, your work based on
4000 the Program is not required to print an announcement.)
4001 @end enumerate
4002
4003 These requirements apply to the modified work as a whole.  If
4004 identifiable sections of that work are not derived from the Program,
4005 and can be reasonably considered independent and separate works in
4006 themselves, then this License, and its terms, do not apply to those
4007 sections when you distribute them as separate works.  But when you
4008 distribute the same sections as part of a whole which is a work based
4009 on the Program, the distribution of the whole must be on the terms of
4010 this License, whose permissions for other licensees extend to the
4011 entire whole, and thus to each and every part regardless of who wrote it.
4012
4013 Thus, it is not the intent of this section to claim rights or contest
4014 your rights to work written entirely by you; rather, the intent is to
4015 exercise the right to control the distribution of derivative or
4016 collective works based on the Program.
4017
4018 In addition, mere aggregation of another work not based on the Program
4019 with the Program (or with a work based on the Program) on a volume of
4020 a storage or distribution medium does not bring the other work under
4021 the scope of this License.
4022
4023 @item
4024 You may copy and distribute the Program (or a work based on it,
4025 under Section 2) in object code or executable form under the terms of
4026 Sections 1 and 2 above provided that you also do one of the following:
4027
4028 @enumerate a
4029 @item
4030 Accompany it with the complete corresponding machine-readable
4031 source code, which must be distributed under the terms of Sections
4032 1 and 2 above on a medium customarily used for software interchange; or,
4033
4034 @item
4035 Accompany it with a written offer, valid for at least three
4036 years, to give any third party, for a charge no more than your
4037 cost of physically performing source distribution, a complete
4038 machine-readable copy of the corresponding source code, to be
4039 distributed under the terms of Sections 1 and 2 above on a medium
4040 customarily used for software interchange; or,
4041
4042 @item
4043 Accompany it with the information you received as to the offer
4044 to distribute corresponding source code.  (This alternative is
4045 allowed only for noncommercial distribution and only if you
4046 received the program in object code or executable form with such
4047 an offer, in accord with Subsection b above.)
4048 @end enumerate
4049
4050 The source code for a work means the preferred form of the work for
4051 making modifications to it.  For an executable work, complete source
4052 code means all the source code for all modules it contains, plus any
4053 associated interface definition files, plus the scripts used to
4054 control compilation and installation of the executable.  However, as a
4055 special exception, the source code distributed need not include
4056 anything that is normally distributed (in either source or binary
4057 form) with the major components (compiler, kernel, and so on) of the
4058 operating system on which the executable runs, unless that component
4059 itself accompanies the executable.
4060
4061 If distribution of executable or object code is made by offering
4062 access to copy from a designated place, then offering equivalent
4063 access to copy the source code from the same place counts as
4064 distribution of the source code, even though third parties are not
4065 compelled to copy the source along with the object code.
4066
4067 @item
4068 You may not copy, modify, sublicense, or distribute the Program
4069 except as expressly provided under this License.  Any attempt
4070 otherwise to copy, modify, sublicense or distribute the Program is
4071 void, and will automatically terminate your rights under this License.
4072 However, parties who have received copies, or rights, from you under
4073 this License will not have their licenses terminated so long as such
4074 parties remain in full compliance.
4075
4076 @item
4077 You are not required to accept this License, since you have not
4078 signed it.  However, nothing else grants you permission to modify or
4079 distribute the Program or its derivative works.  These actions are
4080 prohibited by law if you do not accept this License.  Therefore, by
4081 modifying or distributing the Program (or any work based on the
4082 Program), you indicate your acceptance of this License to do so, and
4083 all its terms and conditions for copying, distributing or modifying
4084 the Program or works based on it.
4085
4086 @item
4087 Each time you redistribute the Program (or any work based on the
4088 Program), the recipient automatically receives a license from the
4089 original licensor to copy, distribute or modify the Program subject to
4090 these terms and conditions.  You may not impose any further
4091 restrictions on the recipients' exercise of the rights granted herein.
4092 You are not responsible for enforcing compliance by third parties to
4093 this License.
4094
4095 @item
4096 If, as a consequence of a court judgment or allegation of patent
4097 infringement or for any other reason (not limited to patent issues),
4098 conditions are imposed on you (whether by court order, agreement or
4099 otherwise) that contradict the conditions of this License, they do not
4100 excuse you from the conditions of this License.  If you cannot
4101 distribute so as to satisfy simultaneously your obligations under this
4102 License and any other pertinent obligations, then as a consequence you
4103 may not distribute the Program at all.  For example, if a patent
4104 license would not permit royalty-free redistribution of the Program by
4105 all those who receive copies directly or indirectly through you, then
4106 the only way you could satisfy both it and this License would be to
4107 refrain entirely from distribution of the Program.
4108
4109 If any portion of this section is held invalid or unenforceable under
4110 any particular circumstance, the balance of the section is intended to
4111 apply and the section as a whole is intended to apply in other
4112 circumstances.
4113
4114 It is not the purpose of this section to induce you to infringe any
4115 patents or other property right claims or to contest validity of any
4116 such claims; this section has the sole purpose of protecting the
4117 integrity of the free software distribution system, which is
4118 implemented by public license practices.  Many people have made
4119 generous contributions to the wide range of software distributed
4120 through that system in reliance on consistent application of that
4121 system; it is up to the author/donor to decide if he or she is willing
4122 to distribute software through any other system and a licensee cannot
4123 impose that choice.
4124
4125 This section is intended to make thoroughly clear what is believed to
4126 be a consequence of the rest of this License.
4127
4128 @item
4129 If the distribution and/or use of the Program is restricted in
4130 certain countries either by patents or by copyrighted interfaces, the
4131 original copyright holder who places the Program under this License
4132 may add an explicit geographical distribution limitation excluding
4133 those countries, so that distribution is permitted only in or among
4134 countries not thus excluded.  In such case, this License incorporates
4135 the limitation as if written in the body of this License.
4136
4137 @item
4138 The Free Software Foundation may publish revised and/or new versions
4139 of the General Public License from time to time.  Such new versions will
4140 be similar in spirit to the present version, but may differ in detail to
4141 address new problems or concerns.
4142
4143 Each version is given a distinguishing version number.  If the Program
4144 specifies a version number of this License which applies to it and ``any
4145 later version'', you have the option of following the terms and conditions
4146 either of that version or of any later version published by the Free
4147 Software Foundation.  If the Program does not specify a version number of
4148 this License, you may choose any version ever published by the Free Software
4149 Foundation.
4150
4151 @item
4152 If you wish to incorporate parts of the Program into other free
4153 programs whose distribution conditions are different, write to the author
4154 to ask for permission.  For software which is copyrighted by the Free
4155 Software Foundation, write to the Free Software Foundation; we sometimes
4156 make exceptions for this.  Our decision will be guided by the two goals
4157 of preserving the free status of all derivatives of our free software and
4158 of promoting the sharing and reuse of software generally.
4159
4160 @iftex
4161 @heading NO WARRANTY
4162 @end iftex
4163 @ifnottex
4164 @center NO WARRANTY
4165 @end ifnottex
4166 @cindex no warranty
4167
4168 @item
4169 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
4170 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
4171 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
4172 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
4173 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
4174 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
4175 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
4176 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
4177 REPAIR OR CORRECTION.
4178
4179 @item
4180 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
4181 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
4182 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
4183 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
4184 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
4185 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
4186 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
4187 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
4188 POSSIBILITY OF SUCH DAMAGES.
4189 @end enumerate
4190
4191 @iftex
4192 @heading END OF TERMS AND CONDITIONS
4193 @end iftex
4194 @ifnottex
4195 @center END OF TERMS AND CONDITIONS
4196 @end ifnottex
4197
4198 @page
4199 @unnumberedsec How to Apply These Terms to Your New Programs
4200
4201   If you develop a new program, and you want it to be of the greatest
4202 possible use to the public, the best way to achieve this is to make it
4203 free software which everyone can redistribute and change under these terms.
4204
4205   To do so, attach the following notices to the program.  It is safest
4206 to attach them to the start of each source file to most effectively
4207 convey the exclusion of warranty; and each file should have at least
4208 the ``copyright'' line and a pointer to where the full notice is found.
4209
4210 @smallexample
4211 @var{one line to give the program's name and an idea of what it does.}
4212 Copyright (C) 20@var{yy}  @var{name of author}
4213
4214 This program is free software; you can redistribute it and/or
4215 modify it under the terms of the GNU General Public License
4216 as published by the Free Software Foundation; either version 2
4217 of the License, or (at your option) any later version.
4218
4219 This program is distributed in the hope that it will be useful,
4220 but WITHOUT ANY WARRANTY; without even the implied warranty of
4221 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4222 GNU General Public License for more details.
4223
4224 You should have received a copy of the GNU General Public License
4225 along with this program; if not, write to the Free Software
4226 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
4227 @end smallexample
4228
4229 Also add information on how to contact you by electronic and paper mail.
4230
4231 If the program is interactive, make it output a short notice like this
4232 when it starts in an interactive mode:
4233
4234 @smallexample
4235 Gnomovision version 69, Copyright (C) 20@var{yy} @var{name of author}
4236 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
4237 type `show w'.  This is free software, and you are welcome
4238 to redistribute it under certain conditions; type `show c'
4239 for details.
4240 @end smallexample
4241
4242 The hypothetical commands @samp{show w} and @samp{show c} should show
4243 the appropriate parts of the General Public License.  Of course, the
4244 commands you use may be called something other than @samp{show w} and
4245 @samp{show c}; they could even be mouse-clicks or menu items---whatever
4246 suits your program.
4247
4248 You should also get your employer (if you work as a programmer) or your
4249 school, if any, to sign a ``copyright disclaimer'' for the program, if
4250 necessary.  Here is a sample; alter the names:
4251
4252 @smallexample
4253 @group
4254 Yoyodyne, Inc., hereby disclaims all copyright
4255 interest in the program `Gnomovision'
4256 (which makes passes at compilers) written
4257 by James Hacker.
4258
4259 @var{signature of Ty Coon}, 1 April 1989
4260 Ty Coon, President of Vice
4261 @end group
4262 @end smallexample
4263
4264 This General Public License does not permit incorporating your program into
4265 proprietary programs.  If your program is a subroutine library, you may
4266 consider it more useful to permit linking proprietary applications with the
4267 library.  If this is what you want to do, use the GNU Library General
4268 Public License instead of this License.
4269
4270 @include fdl.texi
4271
4272 @node Concept Index
4273 @unnumbered Concept Index
4274 @printindex cp
4275
4276 @contents
4277
4278 @bye