]> sjero.net Git - wget/blob - doc/wget.texi
[svn] * wget.texi (Download Options): Using -c on a file that's already fully
[wget] / doc / wget.texi
1 \input texinfo   @c -*-texinfo-*-
2
3 @c %**start of header
4 @setfilename wget.info
5 @settitle GNU Wget Manual
6 @c Disable the monstrous rectangles beside overfull hbox-es.
7 @finalout
8 @c Use `odd' to print double-sided.
9 @setchapternewpage on
10 @c %**end of header
11
12 @iftex
13 @c Remove this if you don't use A4 paper.
14 @afourpaper
15 @end iftex
16
17 @c This should really be auto-generated!
18 @set VERSION 1.5.3+dev
19 @set UPDATED Feb 2000
20
21 @dircategory Net Utilities
22 @dircategory World Wide Web
23 @direntry
24 * Wget: (wget).         The non-interactive network downloader.
25 @end direntry
26
27 @ifinfo
28 This file documents the the GNU Wget utility for downloading network
29 data.
30
31 Copyright (C) 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
32
33 Permission is granted to make and distribute verbatim copies of
34 this manual provided the copyright notice and this permission notice
35 are preserved on all copies.
36
37 @ignore
38 Permission is granted to process this file through TeX and print the
39 results, provided the printed document carries a copying permission
40 notice identical to this one except for the removal of this paragraph
41 (this paragraph not being relevant to the printed manual).
42 @end ignore
43 Permission is granted to copy and distribute modified versions of this
44 manual under the conditions for verbatim copying, provided also that the
45 sections entitled ``Copying'' and ``GNU General Public License'' are
46 included exactly as in the original, and provided that the entire
47 resulting derived work is distributed under the terms of a permission
48 notice identical to this one.
49 @end ifinfo
50
51 @titlepage
52 @title GNU Wget
53 @subtitle The noninteractive downloading utility
54 @subtitle Updated for Wget @value{VERSION}, @value{UPDATED}
55 @author by Hrvoje Nik@v{s}i@'{c} and the developers
56
57 @page
58 @vskip 0pt plus 1filll
59 Copyright @copyright{} 1996, 1997, 1998 Free Software Foundation, Inc.
60
61 Permission is granted to make and distribute verbatim copies of this
62 manual provided the copyright notice and this permission notice are
63 preserved on all copies.
64
65 Permission is granted to copy and distribute modified versions of this
66 manual under the conditions for verbatim copying, provided also that the
67 sections entitled ``Copying'' and ``GNU General Public License'' are
68 included exactly as in the original, and provided that the entire
69 resulting derived work is distributed under the terms of a permission
70 notice identical to this one.
71
72 Permission is granted to copy and distribute translations of this manual
73 into another language, under the above conditions for modified versions,
74 except that this permission notice may be stated in a translation
75 approved by the Free Software Foundation.
76 @end titlepage
77
78 @ifinfo
79 @node Top, Overview, (dir), (dir)
80 @top Wget @value{VERSION}
81
82 This manual documents version @value{VERSION} of GNU Wget, the freely
83 available utility for network download.
84
85 Copyright @copyright{} 1996, 1997, 1998 Free Software Foundation, Inc.
86
87 @menu
88 * Overview::            Features of Wget.
89 * Invoking::            Wget command-line arguments.
90 * Recursive Retrieval:: Description of recursive retrieval.
91 * Following Links::     The available methods of chasing links.
92 * Time-Stamping::       Mirroring according to time-stamps.
93 * Startup File::        Wget's initialization file.
94 * Examples::            Examples of usage.
95 * Various::             The stuff that doesn't fit anywhere else.
96 * Appendices::          Some useful references.
97 * Copying::             You may give out copies of Wget.
98 * Concept Index::       Topics covered by this manual.
99 @end menu
100 @end ifinfo
101
102 @node Overview, Invoking, Top, Top
103 @chapter Overview
104 @cindex overview
105 @cindex features
106
107 GNU Wget is a freely available network utility to retrieve files from
108 the World Wide Web, using @sc{http} (Hyper Text Transfer Protocol) and
109 @sc{ftp} (File Transfer Protocol), the two most widely used Internet
110 protocols.  It has many useful features to make downloading easier, some
111 of them being:
112
113 @itemize @bullet
114 @item
115 Wget is non-interactive, meaning that it can work in the background,
116 while the user is not logged on.  This allows you to start a retrieval
117 and disconnect from the system, letting Wget finish the work.  By
118 contrast, most of the Web browsers require constant user's presence,
119 which can be a great hindrance when transferring a lot of data.
120
121 @sp 1
122 @item
123 Wget is capable of descending recursively through the structure of
124 @sc{html} documents and @sc{ftp} directory trees, making a local copy of
125 the directory hierarchy similar to the one on the remote server.  This
126 feature can be used to mirror archives and home pages, or traverse the
127 web in search of data, like a @sc{www} robot (@xref{Robots}).  In that
128 spirit, Wget understands the @code{norobots} convention.
129
130 @sp 1
131 @item
132 File name wildcard matching and recursive mirroring of directories are
133 available when retrieving via @sc{ftp}.  Wget can read the time-stamp
134 information given by both @sc{http} and @sc{ftp} servers, and store it
135 locally.  Thus Wget can see if the remote file has changed since last
136 retrieval, and automatically retrieve the new version if it has.  This
137 makes Wget suitable for mirroring of @sc{ftp} sites, as well as home
138 pages.
139
140 @sp 1
141 @item
142 Wget works exceedingly well on slow or unstable connections,
143 retrying the document until it is fully retrieved, or until a
144 user-specified retry count is surpassed.  It will try to resume the
145 download from the point of interruption, using @code{REST} with @sc{ftp}
146 and @code{Range} with @sc{http} servers that support them.
147
148 @sp 1
149 @item
150 By default, Wget supports proxy servers, which can lighten the network
151 load, speed up retrieval and provide access behind firewalls.  However,
152 if you are behind a firewall that requires that you use a socks style
153 gateway, you can get the socks library and build wget with support for
154 socks.  Wget also supports the passive @sc{ftp} downloading as an
155 option.
156
157 @sp 1
158 @item
159 Builtin features offer mechanisms to tune which links you wish to follow
160 (@xref{Following Links}).
161
162 @sp 1
163 @item
164 The retrieval is conveniently traced with printing dots, each dot
165 representing a fixed amount of data received (1KB by default).  These
166 representations can be customized to your preferences.
167
168 @sp 1
169 @item
170 Most of the features are fully configurable, either through command line
171 options, or via the initialization file @file{.wgetrc} (@xref{Startup
172 File}).  Wget allows you to define @dfn{global} startup files
173 (@file{/usr/local/etc/wgetrc} by default) for site settings.
174
175 @sp 1
176 @item
177 Finally, GNU Wget is free software.  This means that everyone may use
178 it, redistribute it and/or modify it under the terms of the GNU General
179 Public License, as published by the Free Software Foundation
180 (@xref{Copying}).
181 @end itemize
182
183 @node Invoking, Recursive Retrieval, Overview, Top
184 @chapter Invoking
185 @cindex invoking
186 @cindex command line
187 @cindex arguments
188 @cindex nohup
189
190 By default, Wget is very simple to invoke.  The basic syntax is:
191
192 @example
193 wget [@var{option}]@dots{} [@var{URL}]@dots{}
194 @end example
195
196 Wget will simply download all the @sc{url}s specified on the command
197 line.  @var{URL} is a @dfn{Uniform Resource Locator}, as defined below.
198
199 However, you may wish to change some of the default parameters of
200 Wget.  You can do it two ways: permanently, adding the appropriate
201 command to @file{.wgetrc} (@xref{Startup File}), or specifying it on
202 the command line.
203
204 @menu
205 * URL Format::
206 * Option Syntax::
207 * Basic Startup Options::
208 * Logging and Input File Options::
209 * Download Options::
210 * Directory Options::
211 * HTTP Options::
212 * FTP Options::
213 * Recursive Retrieval Options::
214 * Recursive Accept/Reject Options::
215 @end menu
216
217 @node URL Format, Option Syntax, Invoking, Invoking
218 @section URL Format
219 @cindex URL
220 @cindex URL syntax
221
222 @dfn{URL} is an acronym for Uniform Resource Locator.  A uniform
223 resource locator is a compact string representation for a resource
224 available via the Internet.  Wget recognizes the @sc{url} syntax as per
225 @sc{rfc1738}.  This is the most widely used form (square brackets denote
226 optional parts):
227
228 @example
229 http://host[:port]/directory/file
230 ftp://host[:port]/directory/file
231 @end example
232
233 You can also encode your username and password within a @sc{url}:
234
235 @example
236 ftp://user:password@@host/path
237 http://user:password@@host/path
238 @end example
239
240 Either @var{user} or @var{password}, or both, may be left out.  If you
241 leave out either the @sc{http} username or password, no authentication
242 will be sent.  If you leave out the @sc{ftp} username, @samp{anonymous}
243 will be used.  If you leave out the @sc{ftp} password, your email
244 address will be supplied as a default password.@footnote{If you have a
245 @file{.netrc} file in your home directory, password will also be
246 searched for there.}
247
248 You can encode unsafe characters in a @sc{url} as @samp{%xy}, @code{xy}
249 being the hexadecimal representation of the character's @sc{ascii}
250 value.  Some common unsafe characters include @samp{%} (quoted as
251 @samp{%25}), @samp{:} (quoted as @samp{%3A}), and @samp{@@} (quoted as
252 @samp{%40}).  Refer to @sc{rfc1738} for a comprehensive list of unsafe
253 characters.
254
255 Wget also supports the @code{type} feature for @sc{ftp} @sc{url}s.  By
256 default, @sc{ftp} documents are retrieved in the binary mode (type
257 @samp{i}), which means that they are downloaded unchanged.  Another
258 useful mode is the @samp{a} (@dfn{ASCII}) mode, which converts the line
259 delimiters between the different operating systems, and is thus useful
260 for text files.  Here is an example:
261
262 @example
263 ftp://host/directory/file;type=a
264 @end example
265
266 Two alternative variants of @sc{url} specification are also supported,
267 because of historical (hysterical?) reasons and their widespreaded use.
268
269 @sc{ftp}-only syntax (supported by @code{NcFTP}):
270 @example
271 host:/dir/file
272 @end example
273
274 @sc{http}-only syntax (introduced by @code{Netscape}):
275 @example
276 host[:port]/dir/file
277 @end example
278
279 These two alternative forms are deprecated, and may cease being
280 supported in the future.
281
282 If you do not understand the difference between these notations, or do
283 not know which one to use, just use the plain ordinary format you use
284 with your favorite browser, like @code{Lynx} or @code{Netscape}.
285
286 @node Option Syntax, Basic Startup Options, URL Format, Invoking
287 @section Option Syntax
288 @cindex option syntax
289 @cindex syntax of options
290
291 Since Wget uses GNU getopts to process its arguments, every option has a
292 short form and a long form.  Long options are more convenient to
293 remember, but take time to type.  You may freely mix different option
294 styles, or specify options after the command-line arguments. Thus you
295 may write:
296
297 @example
298 wget -r --tries=10 http://fly.cc.fer.hr/ -o log
299 @end example
300
301 The space between the option accepting an argument and the argument may
302 be omitted.  Instead @samp{-o log} you can write @samp{-olog}.
303
304 You may put several options that do not require arguments together,
305 like:
306
307 @example
308 wget -drc @var{URL}
309 @end example
310
311 This is a complete equivalent of:
312
313 @example
314 wget -d -r -c @var{URL}
315 @end example
316
317 Since the options can be specified after the arguments, you may
318 terminate them with @samp{--}.  So the following will try to download
319 @sc{url} @samp{-x}, reporting failure to @file{log}:
320
321 @example
322 wget -o log -- -x
323 @end example
324
325 The options that accept comma-separated lists all respect the convention
326 that specifying an empty list clears its value.  This can be useful to
327 clear the @file{.wgetrc} settings.  For instance, if your @file{.wgetrc}
328 sets @code{exclude_directories} to @file{/cgi-bin}, the following
329 example will first reset it, and then set it to exclude @file{/~nobody}
330 and @file{/~somebody}.  You can also clear the lists in @file{.wgetrc}
331 (@xref{Wgetrc Syntax}).
332
333 @example
334 wget -X '' -X /~nobody,/~somebody
335 @end example
336
337 @node Basic Startup Options, Logging and Input File Options, Option Syntax, Invoking
338 @section Basic Startup Options
339
340 @table @samp
341 @item -V
342 @itemx --version
343 Display the version of Wget.
344
345 @item -h
346 @itemx --help
347 Print a help message describing all of Wget's command-line options.
348
349 @item -b
350 @itemx --background
351 Go to background immediately after startup.  If no output file is
352 specified via the @samp{-o}, output is redirected to @file{wget-log}.
353
354 @cindex execute wgetrc command
355 @item -e @var{command}
356 @itemx --execute @var{command}
357 Execute @var{command} as if it were a part of @file{.wgetrc}
358 (@xref{Startup File}).  A command thus invoked will be executed
359 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
360 them.
361 @end table
362
363 @node Logging and Input File Options, Download Options, Basic Startup Options, Invoking
364 @section Logging and Input File Options
365
366 @table @samp
367 @cindex output file
368 @cindex log file
369 @item -o @var{logfile}
370 @itemx --output-file=@var{logfile}
371 Log all messages to @var{logfile}.  The messages are normally reported
372 to standard error.
373
374 @cindex append to log
375 @item -a @var{logfile}
376 @itemx --append-output=@var{logfile}
377 Append to @var{logfile}.  This is the same as @samp{-o}, only it appends
378 to @var{logfile} instead of overwriting the old log file.  If
379 @var{logfile} does not exist, a new file is created.
380
381 @cindex debug
382 @item -d
383 @itemx --debug
384 Turn on debug output, meaning various information important to the
385 developers of Wget if it does not work properly.  Your system
386 administrator may have chosen to compile Wget without debug support, in
387 which case @samp{-d} will not work.  Please note that compiling with
388 debug support is always safe---Wget compiled with the debug support will
389 @emph{not} print any debug info unless requested with @samp{-d}.
390 @xref{Reporting Bugs} for more information on how to use @samp{-d} for
391 sending bug reports.
392
393 @cindex quiet
394 @item -q
395 @itemx --quiet
396 Turn off Wget's output.
397
398 @cindex verbose
399 @item -v
400 @itemx --verbose
401 Turn on verbose output, with all the available data.  The default output
402 is verbose.
403
404 @item -nv
405 @itemx --non-verbose
406 Non-verbose output---turn off verbose without being completely quiet
407 (use @samp{-q} for that), which means that error messages and basic
408 information still get printed.
409
410 @cindex input-file
411 @item -i @var{file}
412 @itemx --input-file=@var{file}
413 Read @sc{url}s from @var{file}, in which case no @sc{url}s need to be on
414 the command line.  If there are @sc{url}s both on the command line and
415 in an input file, those on the command lines will be the first ones to
416 be retrieved.  The @var{file} need not be an @sc{html} document (but no
417 harm if it is)---it is enough if the @sc{url}s are just listed
418 sequentially.
419
420 However, if you specify @samp{--force-html}, the document will be
421 regarded as @samp{html}.  In that case you may have problems with
422 relative links, which you can solve either by adding @code{<base
423 href="@var{url}">} to the documents or by specifying
424 @samp{--base=@var{url}} on the command line.
425
426 @cindex force html
427 @item -F
428 @itemx --force-html
429 When input is read from a file, force it to be treated as an @sc{html}
430 file.  This enables you to retrieve relative links from existing
431 @sc{html} files on your local disk, by adding @code{<base
432 href="@var{url}">} to @sc{html}, or using the @samp{--base} command-line
433 option.
434 @end table
435
436 @node Download Options, Directory Options, Logging and Input File Options, Invoking
437 @section Download Options
438
439 @table @samp
440 @cindex retries
441 @cindex tries
442 @cindex number of retries
443 @item -t @var{number}
444 @itemx --tries=@var{number}
445 Set number of retries to @var{number}.  Specify 0 or @samp{inf} for
446 infinite retrying.
447
448 @item -O @var{file}
449 @itemx --output-document=@var{file}
450 The documents will not be written to the appropriate files, but all will
451 be concatenated together and written to @var{file}.  If @var{file}
452 already exists, it will be overwritten.  If the @var{file} is @samp{-},
453 the documents will be written to standard output.  Including this option
454 automatically sets the number of tries to 1.
455
456 @cindex clobbering, file
457 @cindex downloading multiple times
458 @cindex no-clobber
459 @item -nc
460 @itemx --no-clobber
461 If a file is downloaded more than once in the same directory, wget's
462 behavior depends on a few options, including @samp{-nc}.  In certain
463 cases, the local file will be "clobbered", or overwritten, upon repeated
464 download.  In other cases it will be preserved.
465
466 When running wget without @samp{-N}, @samp{-nc}, or @samp{-r},
467 downloading the same file in the same directory will result in the
468 original copy of @samp{@var{file}} being preserved and the second copy
469 being named @samp{@var{file}.1}.  If that file is downloaded yet again,
470 the third copy will be named @samp{@var{file}.2}, and so on.  When
471 @samp{-nc} is specified, this behavior is suppressed, and wget will
472 refuse to download newer copies of @samp{@var{file}}.  Therefore,
473 "no-clobber" is actually a misnomer in this mode -- it's not clobbering
474 that's prevented (as the numeric suffixes were already preventing
475 clobbering), but rather the multiple version saving that's prevented.
476
477 When running wget with @samp{-r}, but without @samp{-N} or @samp{-nc},
478 re-downloading a file will result in the new copy simply overwriting the
479 old.  Adding @samp{-nc} will prevent this behavior, instead causing the
480 original version to be preserved and any newer copies on the server to
481 be ignored.
482
483 When running wget with @samp{-N}, with or without @samp{-r}, the
484 decision as to whether or not to download a newer copy of a file depends
485 on the local and remote timestamp and size of the file
486 (@xref{Time-Stamping}).  @samp{-nc} may not be specified at the same
487 time as @samp{-N}.
488
489 Note that when @samp{-nc} is specified, files with the suffixes
490 @samp{.html} or (yuck) @samp{.htm} will be loaded from the local disk
491 and parsed as if they had been retrieved from the Web.
492
493 @cindex continue retrieval
494 @item -c
495 @itemx --continue
496 Continue getting an existing file.  This is useful when you want to
497 finish up the download started by another program, or a previous
498 instance of Wget.  Thus you can write:
499
500 @example
501 wget -c ftp://sunsite.doc.ic.ac.uk/ls-lR.Z
502 @end example
503
504 If there is a file name @file{ls-lR.Z} in the current directory, Wget
505 will assume that it is the first portion of the remote file, and will
506 require the server to continue the retrieval from an offset equal to the
507 length of the local file.
508
509 Note that you need not specify this option if all you want is Wget to
510 continue retrieving where it left off when the connection is lost---Wget
511 does this by default.  You need this option only when you want to
512 continue retrieval of a file already halfway retrieved, saved by another
513 @sc{ftp} client, or left by Wget being killed.
514
515 Without @samp{-c}, the previous example would just begin to download the
516 remote file to @file{ls-lR.Z.1}.  The @samp{-c} option is also
517 applicable for @sc{http} servers that support the @code{Range} header.
518
519 Note that if you use @samp{-c} on a file that's already downloaded
520 completely, @samp{@var{file}} will not be changed, nor will a second
521 @samp{@var{file}.1} copy be created.
522
523 @cindex dot style
524 @cindex retrieval tracing style
525 @item --dot-style=@var{style}
526 Set the retrieval style to @var{style}.  Wget traces the retrieval of
527 each document by printing dots on the screen, each dot representing a
528 fixed amount of retrieved data.  Any number of dots may be separated in
529 a @dfn{cluster}, to make counting easier.  This option allows you to
530 choose one of the pre-defined styles, determining the number of bytes
531 represented by a dot, the number of dots in a cluster, and the number of
532 dots on the line.
533
534 With the @code{default} style each dot represents 1K, there are ten dots
535 in a cluster and 50 dots in a line.  The @code{binary} style has a more
536 ``computer''-like orientation---8K dots, 16-dots clusters and 48 dots
537 per line (which makes for 384K lines).  The @code{mega} style is
538 suitable for downloading very large files---each dot represents 64K
539 retrieved, there are eight dots in a cluster, and 48 dots on each line
540 (so each line contains 3M).  The @code{micro} style is exactly the
541 reverse; it is suitable for downloading small files, with 128-byte dots,
542 8 dots per cluster, and 48 dots (6K) per line.
543
544 @item -N
545 @itemx --timestamping
546 Turn on time-stamping.  @xref{Time-Stamping} for details.
547
548 @cindex server response, print
549 @item -S
550 @itemx --server-response
551 Print the headers sent by @sc{http} servers and responses sent by
552 @sc{ftp} servers.
553
554 @cindex Wget as spider
555 @cindex spider
556 @item --spider
557 When invoked with this option, Wget will behave as a Web @dfn{spider},
558 which means that it will not download the pages, just check that they
559 are there.  You can use it to check your bookmarks, e.g. with:
560
561 @example
562 wget --spider --force-html -i bookmarks.html
563 @end example
564
565 This feature needs much more work for Wget to get close to the
566 functionality of real @sc{www} spiders.
567
568 @cindex timeout
569 @item -T seconds
570 @itemx --timeout=@var{seconds}
571 Set the read timeout to @var{seconds} seconds.  Whenever a network read
572 is issued, the file descriptor is checked for a timeout, which could
573 otherwise leave a pending connection (uninterrupted read).  The default
574 timeout is 900 seconds (fifteen minutes).  Setting timeout to 0 will
575 disable checking for timeouts.
576
577 Please do not lower the default timeout value with this option unless
578 you know what you are doing.
579
580 @cindex pause
581 @cindex wait
582 @item -w @var{seconds}
583 @itemx --wait=@var{seconds}
584 Wait the specified number of seconds between the retrievals.  Use of
585 this option is recommended, as it lightens the server load by making the
586 requests less frequent.  Instead of in seconds, the time can be
587 specified in minutes using the @code{m} suffix, in hours using @code{h}
588 suffix, or in days using @code{d} suffix.
589
590 Specifying a large value for this option is useful if the network or the
591 destination host is down, so that Wget can wait long enough to
592 reasonably expect the network error to be fixed before the retry.
593
594 @cindex retries, waiting between
595 @cindex waiting between retries
596 @item --waitretry=@var{seconds}
597 If you don't want Wget to wait between @emph{every} retrieval, but only
598 between retries of failed downloads, you can use this option.  Wget will
599 use "linear backoff", waiting 1 second after the first failure on a
600 given file, then waiting 2 seconds after the second failure on that
601 file, up to the maximum number of @var{seconds} you specify.  Therefore,
602 a value of 10 will actually make Wget wait up to (1 + 2 + ... + 10) = 55
603 seconds per file.
604
605 Note that this option is turned on by default in the global
606 @file{wgetrc} file.
607
608 @cindex proxy
609 @item -Y on/off
610 @itemx --proxy=on/off
611 Turn proxy support on or off. The proxy is on by default if the
612 appropriate environmental variable is defined.
613
614 @cindex quota
615 @item -Q @var{quota}
616 @itemx --quota=@var{quota}
617 Specify download quota for automatic retrievals.  The value can be
618 specified in bytes (default), kilobytes (with @samp{k} suffix), or
619 megabytes (with @samp{m} suffix).
620
621 Note that quota will never affect downloading a single file.  So if you
622 specify @samp{wget -Q10k ftp://wuarchive.wustl.edu/ls-lR.gz}, all of the
623 @file{ls-lR.gz} will be downloaded.  The same goes even when several
624 @sc{url}s are specified on the command-line.  However, quota is
625 respected when retrieving either recursively, or from an input file.
626 Thus you may safely type @samp{wget -Q2m -i sites}---download will be
627 aborted when the quota is exceeded.
628
629 Setting quota to 0 or to @samp{inf} unlimits the download quota.
630 @end table
631
632 @node Directory Options, HTTP Options, Download Options, Invoking
633 @section Directory Options
634
635 @table @samp
636 @item -nd
637 @itemx --no-directories
638 Do not create a hierarchy of directories when retrieving
639 recursively. With this option turned on, all files will get saved to the
640 current directory, without clobbering (if a name shows up more than
641 once, the filenames will get extensions @samp{.n}).
642
643 @item -x
644 @itemx --force-directories
645 The opposite of @samp{-nd}---create a hierarchy of directories, even if
646 one would not have been created otherwise.  E.g. @samp{wget -x
647 http://fly.cc.fer.hr/robots.txt} will save the downloaded file to
648 @file{fly.cc.fer.hr/robots.txt}.
649
650 @item -nH
651 @itemx --no-host-directories
652 Disable generation of host-prefixed directories.  By default, invoking
653 Wget with @samp{-r http://fly.cc.fer.hr/} will create a structure of
654 directories beginning with @file{fly.cc.fer.hr/}.  This option disables
655 such behavior.
656
657 @cindex cut directories
658 @item --cut-dirs=@var{number}
659 Ignore @var{number} directory components.  This is useful for getting a
660 fine-grained control over the directory where recursive retrieval will
661 be saved.
662
663 Take, for example, the directory at
664 @samp{ftp://ftp.xemacs.org/pub/xemacs/}.  If you retrieve it with
665 @samp{-r}, it will be saved locally under
666 @file{ftp.xemacs.org/pub/xemacs/}.  While the @samp{-nH} option can
667 remove the @file{ftp.xemacs.org/} part, you are still stuck with
668 @file{pub/xemacs}.  This is where @samp{--cut-dirs} comes in handy; it
669 makes Wget not ``see'' @var{number} remote directory components.  Here
670 are several examples of how @samp{--cut-dirs} option works.
671
672 @example
673 @group
674 No options        -> ftp.xemacs.org/pub/xemacs/
675 -nH               -> pub/xemacs/
676 -nH --cut-dirs=1  -> xemacs/
677 -nH --cut-dirs=2  -> .
678
679 --cut-dirs=1      -> ftp.xemacs.org/xemacs/
680 ...
681 @end group
682 @end example
683
684 If you just want to get rid of the directory structure, this option is
685 similar to a combination of @samp{-nd} and @samp{-P}.  However, unlike
686 @samp{-nd}, @samp{--cut-dirs} does not lose with subdirectories---for
687 instance, with @samp{-nH --cut-dirs=1}, a @file{beta/} subdirectory will
688 be placed to @file{xemacs/beta}, as one would expect.
689
690 @cindex directory prefix
691 @item -P @var{prefix}
692 @itemx --directory-prefix=@var{prefix}
693 Set directory prefix to @var{prefix}.  The @dfn{directory prefix} is the
694 directory where all other files and subdirectories will be saved to,
695 i.e. the top of the retrieval tree.  The default is @samp{.} (the
696 current directory).
697 @end table
698
699 @node HTTP Options, FTP Options, Directory Options, Invoking
700 @section HTTP Options
701
702 @table @samp
703 @cindex http user
704 @cindex http password
705 @cindex authentication
706 @item --http-user=@var{user}
707 @itemx --http-passwd=@var{password}
708 Specify the username @var{user} and password @var{password} on an
709 @sc{http} server.  According to the type of the challenge, Wget will
710 encode them using either the @code{basic} (insecure) or the
711 @code{digest} authentication scheme.
712
713 Another way to specify username and password is in the @sc{url} itself
714 (@xref{URL Format}).  For more information about security issues with
715 Wget, @xref{Security Considerations}.
716
717 @cindex proxy
718 @cindex cache
719 @item -C on/off
720 @itemx --cache=on/off
721 When set to off, disable server-side cache.  In this case, Wget will
722 send the remote server an appropriate directive (@samp{Pragma:
723 no-cache}) to get the file from the remote service, rather than
724 returning the cached version.  This is especially useful for retrieving
725 and flushing out-of-date documents on proxy servers.
726
727 Caching is allowed by default.
728
729 @cindex Content-Length, ignore
730 @cindex ignore length
731 @item --ignore-length
732 Unfortunately, some @sc{http} servers (@sc{cgi} programs, to be more
733 precise) send out bogus @code{Content-Length} headers, which makes Wget
734 go wild, as it thinks not all the document was retrieved.  You can spot
735 this syndrome if Wget retries getting the same document again and again,
736 each time claiming that the (otherwise normal) connection has closed on
737 the very same byte.
738
739 With this option, Wget will ignore the @code{Content-Length} header---as
740 if it never existed.
741
742 @cindex header, add
743 @item --header=@var{additional-header}
744 Define an @var{additional-header} to be passed to the @sc{http} servers.
745 Headers must contain a @samp{:} preceded by one or more non-blank
746 characters, and must not contain newlines.
747
748 You may define more than one additional header by specifying
749 @samp{--header} more than once.
750
751 @example
752 @group
753 wget --header='Accept-Charset: iso-8859-2' \
754      --header='Accept-Language: hr'        \
755        http://fly.cc.fer.hr/
756 @end group
757 @end example
758
759 Specification of an empty string as the header value will clear all
760 previous user-defined headers.
761
762 @cindex proxy user
763 @cindex proxy password
764 @cindex proxy authentication
765 @item --proxy-user=@var{user}
766 @itemx --proxy-passwd=@var{password}
767 Specify the username @var{user} and password @var{password} for
768 authentication on a proxy server.  Wget will encode them using the
769 @code{basic} authentication scheme.
770
771 @cindex http referer
772 @cindex referer, http
773 @item --referer=@var{url}
774 Include `Referer: @var{url}' header in HTTP request.  Useful for
775 retrieving documents with server-side processing that assume they are
776 always being retrieved by interactive web browsers and only come out
777 properly when Referer is set to one of the pages that point to them.
778
779 @cindex server response, save
780 @item -s
781 @itemx --save-headers
782 Save the headers sent by the @sc{http} server to the file, preceding the
783 actual contents, with an empty line as the separator.
784
785 @cindex user-agent
786 @item -U @var{agent-string}
787 @itemx --user-agent=@var{agent-string}
788 Identify as @var{agent-string} to the @sc{http} server.
789
790 The @sc{http} protocol allows the clients to identify themselves using a
791 @code{User-Agent} header field.  This enables distinguishing the
792 @sc{www} software, usually for statistical purposes or for tracing of
793 protocol violations.  Wget normally identifies as
794 @samp{Wget/@var{version}}, @var{version} being the current version
795 number of Wget.
796
797 However, some sites have been known to impose the policy of tailoring
798 the output according to the @code{User-Agent}-supplied information.
799 While conceptually this is not such a bad idea, it has been abused by
800 servers denying information to clients other than @code{Mozilla} or
801 Microsoft @code{Internet Explorer}.  This option allows you to change
802 the @code{User-Agent} line issued by Wget.  Use of this option is
803 discouraged, unless you really know what you are doing.
804
805 @strong{NOTE} that Netscape Communications Corp. has claimed that false
806 transmissions of @samp{Mozilla} as the @code{User-Agent} are a copyright
807 infringement, which will be prosecuted.  @strong{DO NOT} misrepresent
808 Wget as Mozilla.
809 @end table
810
811 @node FTP Options, Recursive Retrieval Options, HTTP Options, Invoking
812 @section FTP Options
813
814 @table @samp
815 @cindex retrieve symbolic links
816 @item --retr-symlinks
817 Retrieve symbolic links on @sc{ftp} sites as if they were plain files,
818 i.e. don't just create links locally.
819
820 @cindex globbing, toggle
821 @item -g on/off
822 @itemx --glob=on/off
823 Turn @sc{ftp} globbing on or off.  Globbing means you may use the
824 shell-like special characters (@dfn{wildcards}), like @samp{*},
825 @samp{?}, @samp{[} and @samp{]} to retrieve more than one file from the
826 same directory at once, like:
827
828 @example
829 wget ftp://gnjilux.cc.fer.hr/*.msg
830 @end example
831
832 By default, globbing will be turned on if the @sc{url} contains a
833 globbing character.  This option may be used to turn globbing on or off
834 permanently.
835
836 You may have to quote the @sc{url} to protect it from being expanded by
837 your shell.  Globbing makes Wget look for a directory listing, which is
838 system-specific.  This is why it currently works only with Unix @sc{ftp}
839 servers (and the ones emulating Unix @code{ls} output).
840
841 @cindex passive ftp
842 @item --passive-ftp
843 Use the @dfn{passive} @sc{ftp} retrieval scheme, in which the client
844 initiates the data connection.  This is sometimes required for @sc{ftp}
845 to work behind firewalls.
846 @end table
847
848 @node Recursive Retrieval Options, Recursive Accept/Reject Options, FTP Options, Invoking
849 @section Recursive Retrieval Options
850
851 @table @samp
852 @item -r
853 @itemx --recursive
854 Turn on recursive retrieving.  @xref{Recursive Retrieval} for more
855 details.
856
857 @item -l @var{depth}
858 @itemx --level=@var{depth}
859 Specify recursion maximum depth level @var{depth} (@xref{Recursive
860 Retrieval}).  The default maximum depth is 5.
861
862 @cindex proxy filling
863 @cindex delete after retrieval
864 @cindex filling proxy cache
865 @item --delete-after
866 This option tells Wget to delete every single file it downloads,
867 @emph{after} having done so.  It is useful for pre-fetching popular
868 pages through proxy, e.g.:
869
870 @example
871 wget -r -nd --delete-after http://whatever.com/~popular/page/
872 @end example
873
874 The @samp{-r} option is to retrieve recursively, and @samp{-nd} not to
875 create directories.
876
877 @cindex conversion of links
878 @cindex link conversion
879 @item -k
880 @itemx --convert-links
881 Convert the non-relative links to relative ones locally.  Only the
882 references to the documents actually downloaded will be converted; the
883 rest will be left unchanged.
884
885 Note that only at the end of the download can Wget know which links have
886 been downloaded.  Because of that, much of the work done by @samp{-k}
887 will be performed at the end of the downloads.
888
889 @cindex backing up converted files
890 @item -K
891 @itemx --backup-converted
892 When converting a file, back up the original version with a @samp{.orig}
893 suffix.  Affects the behavior of @samp{-N} (@xref{HTTP Time-Stamping
894 Internals}).
895
896 @item -m
897 @itemx --mirror
898 Turn on options suitable for mirroring.  This option turns on recursion
899 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
900 directory listings.  It is currently equivalent to
901 @samp{-r -N -l inf -nr}.
902
903 @item -nr
904 @itemx --dont-remove-listing
905 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
906 retrievals.  Normally, these files contain the raw directory listings
907 received from @sc{ftp} servers.  Not removing them can be useful to
908 access the full remote file list when running a mirror, or for debugging
909 purposes.
910 @end table
911
912 @node Recursive Accept/Reject Options,  , Recursive Retrieval Options, Invoking
913 @section Recursive Accept/Reject Options
914
915 @table @samp
916 @item -A @var{acclist} --accept @var{acclist}
917 @itemx -R @var{rejlist} --reject @var{rejlist}
918 Specify comma-separated lists of file name suffixes or patterns to
919 accept or reject (@xref{Types of Files} for more details).
920
921 @item -D @var{domain-list}
922 @itemx --domains=@var{domain-list}
923 Set domains to be accepted and @sc{dns} looked-up, where
924 @var{domain-list} is a comma-separated list.  Note that it does
925 @emph{not} turn on @samp{-H}.  This option speeds things up, even if
926 only one host is spanned (@xref{Domain Acceptance}).
927
928 @item --exclude-domains @var{domain-list}
929 Exclude the domains given in a comma-separated @var{domain-list} from
930 @sc{dns}-lookup (@xref{Domain Acceptance}).
931
932 @cindex follow FTP links
933 @item --follow-ftp
934 Follow @sc{ftp} links from @sc{html} documents.  Without this option,
935 Wget will ignore all the @sc{ftp} links.
936
937 @cindex tag-based recursive pruning
938 @item --follow-tags=@var{list}
939 Wget has an internal table of HTML tag / attribute pairs that it
940 considers when looking for linked documents during a recursive
941 retrieval.  If a user wants only a subset of those tags to be
942 considered, however, he or she should be specify such tags in a
943 comma-separated @var{list} with this option.
944
945 @item -G @var{list}
946 @itemx --ignore-tags=@var{list}
947 This is the opposite of the @samp{--follow-tags} option.  To skip
948 certain HTML tags when recursively looking for documents to download,
949 specify them in a comma-separated @var{list}.  The author of this option
950 likes to use the following command to download a single HTML page and
951 all files (e.g. images, sounds, and stylesheets) necessary to display it
952 properly:
953
954 @example
955 wget -Ga,area -H -k -K -nh -r http://@var{site}/@var{document}
956 @end example
957
958 @item -H
959 @itemx --span-hosts
960 Enable spanning across hosts when doing recursive retrieving (@xref{All
961 Hosts}).
962
963 @item -L
964 @itemx --relative
965 Follow relative links only.  Useful for retrieving a specific home page
966 without any distractions, not even those from the same hosts
967 (@xref{Relative Links}).
968
969 @item -I @var{list}
970 @itemx --include-directories=@var{list}
971 Specify a comma-separated list of directories you wish to follow when
972 downloading (@xref{Directory-Based Limits} for more details.)  Elements
973 of @var{list} may contain wildcards.
974
975 @item -X @var{list}
976 @itemx --exclude-directories=@var{list}
977 Specify a comma-separated list of directories you wish to exclude from
978 download (@xref{Directory-Based Limits} for more details.)  Elements of
979 @var{list} may contain wildcards.
980
981 @item -nh
982 @itemx --no-host-lookup
983 Disable the time-consuming @sc{dns} lookup of almost all hosts
984 (@xref{Host Checking}).
985
986 @item -np
987 @item --no-parent
988 Do not ever ascend to the parent directory when retrieving recursively.
989 This is a useful option, since it guarantees that only the files
990 @emph{below} a certain hierarchy will be downloaded.
991 @xref{Directory-Based Limits} for more details.
992 @end table
993
994 @node Recursive Retrieval, Following Links, Invoking, Top
995 @chapter Recursive Retrieval
996 @cindex recursion
997 @cindex retrieving
998 @cindex recursive retrieval
999
1000 GNU Wget is capable of traversing parts of the Web (or a single
1001 @sc{http} or @sc{ftp} server), depth-first following links and directory
1002 structure.  This is called @dfn{recursive} retrieving, or
1003 @dfn{recursion}.
1004
1005 With @sc{http} @sc{url}s, Wget retrieves and parses the @sc{html} from
1006 the given @sc{url}, documents, retrieving the files the @sc{html}
1007 document was referring to, through markups like @code{href}, or
1008 @code{src}.  If the freshly downloaded file is also of type
1009 @code{text/html}, it will be parsed and followed further.
1010
1011 The maximum @dfn{depth} to which the retrieval may descend is specified
1012 with the @samp{-l} option (the default maximum depth is five layers).
1013 @xref{Recursive Retrieval}.
1014
1015 When retrieving an @sc{ftp} @sc{url} recursively, Wget will retrieve all
1016 the data from the given directory tree (including the subdirectories up
1017 to the specified depth) on the remote server, creating its mirror image
1018 locally.  @sc{ftp} retrieval is also limited by the @code{depth}
1019 parameter.
1020
1021 By default, Wget will create a local directory tree, corresponding to
1022 the one found on the remote server.
1023
1024 Recursive retrieving can find a number of applications, the most
1025 important of which is mirroring.  It is also useful for @sc{www}
1026 presentations, and any other opportunities where slow network
1027 connections should be bypassed by storing the files locally.
1028
1029 You should be warned that invoking recursion may cause grave overloading
1030 on your system, because of the fast exchange of data through the
1031 network; all of this may hamper other users' work.  The same stands for
1032 the foreign server you are mirroring---the more requests it gets in a
1033 rows, the greater is its load.
1034
1035 Careless retrieving can also fill your file system uncontrollably, which
1036 can grind the machine to a halt.
1037
1038 The load can be minimized by lowering the maximum recursion level
1039 (@samp{-l}) and/or by lowering the number of retries (@samp{-t}).  You
1040 may also consider using the @samp{-w} option to slow down your requests
1041 to the remote servers, as well as the numerous options to narrow the
1042 number of followed links (@xref{Following Links}).
1043
1044 Recursive retrieval is a good thing when used properly.  Please take all
1045 precautions not to wreak havoc through carelessness.
1046
1047 @node Following Links, Time-Stamping, Recursive Retrieval, Top
1048 @chapter Following Links
1049 @cindex links
1050 @cindex following links
1051
1052 When retrieving recursively, one does not wish to retrieve loads of
1053 unnecessary data.  Most of the time the users bear in mind exactly what
1054 they want to download, and want Wget to follow only specific links.
1055
1056 For example, if you wish to download the music archive from
1057 @samp{fly.cc.fer.hr}, you will not want to download all the home pages
1058 that happen to be referenced by an obscure part of the archive.
1059
1060 Wget possesses several mechanisms that allows you to fine-tune which
1061 links it will follow.
1062
1063 @menu
1064 * Relative Links::         Follow relative links only.
1065 * Host Checking::          Follow links on the same host.
1066 * Domain Acceptance::      Check on a list of domains.
1067 * All Hosts::              No host restrictions.
1068 * Types of Files::         Getting only certain files.
1069 * Directory-Based Limits:: Getting only certain directories.
1070 * FTP Links::              Following FTP links.
1071 @end menu
1072
1073 @node Relative Links, Host Checking, Following Links, Following Links
1074 @section Relative Links
1075 @cindex relative links
1076
1077 When only relative links are followed (option @samp{-L}), recursive
1078 retrieving will never span hosts.  No time-expensive @sc{dns}-lookups
1079 will be performed, and the process will be very fast, with the minimum
1080 strain of the network.  This will suit your needs often, especially when
1081 mirroring the output of various @code{x2html} converters, since they
1082 generally output relative links.
1083
1084 @node Host Checking, Domain Acceptance, Relative Links, Following Links
1085 @section Host Checking
1086 @cindex DNS lookup
1087 @cindex host lookup
1088 @cindex host checking
1089
1090 The drawback of following the relative links solely is that humans often
1091 tend to mix them with absolute links to the very same host, and the very
1092 same page.  In this mode (which is the default mode for following links)
1093 all @sc{url}s that refer to the same host will be retrieved.
1094
1095 The problem with this option are the aliases of the hosts and domains.
1096 Thus there is no way for Wget to know that @samp{regoc.srce.hr} and
1097 @samp{www.srce.hr} are the same host, or that @samp{fly.cc.fer.hr} is
1098 the same as @samp{fly.cc.etf.hr}.  Whenever an absolute link is
1099 encountered, the host is @sc{dns}-looked-up with @code{gethostbyname} to
1100 check whether we are maybe dealing with the same hosts.  Although the
1101 results of @code{gethostbyname} are cached, it is still a great
1102 slowdown, e.g. when dealing with large indices of home pages on different
1103 hosts (because each of the hosts must be @sc{dns}-resolved to see
1104 whether it just @emph{might} be an alias of the starting host).
1105
1106 To avoid the overhead you may use @samp{-nh}, which will turn off
1107 @sc{dns}-resolving and make Wget compare hosts literally.  This will
1108 make things run much faster, but also much less reliable
1109 (e.g. @samp{www.srce.hr} and @samp{regoc.srce.hr} will be flagged as
1110 different hosts).
1111
1112 Note that modern @sc{http} servers allow one IP address to host several
1113 @dfn{virtual servers}, each having its own directory hierarchy.  Such
1114 ``servers'' are distinguished by their hostnames (all of which point to
1115 the same IP address); for this to work, a client must send a @code{Host}
1116 header, which is what Wget does.  However, in that case Wget @emph{must
1117 not} try to divine a host's ``real'' address, nor try to use the same
1118 hostname for each access, i.e. @samp{-nh} must be turned on.
1119
1120 In other words, the @samp{-nh} option must be used to enable the
1121 retrieval from virtual servers distinguished by their hostnames.  As the
1122 number of such server setups grow, the behavior of @samp{-nh} may become
1123 the default in the future.
1124
1125 @node Domain Acceptance, All Hosts, Host Checking, Following Links
1126 @section Domain Acceptance
1127
1128 With the @samp{-D} option you may specify the domains that will be
1129 followed.  The hosts the domain of which is not in this list will not be
1130 @sc{dns}-resolved.  Thus you can specify @samp{-Dmit.edu} just to make
1131 sure that @strong{nothing outside of @sc{mit} gets looked up}.  This is
1132 very important and useful.  It also means that @samp{-D} does @emph{not}
1133 imply @samp{-H} (span all hosts), which must be specified explicitly.
1134 Feel free to use this options since it will speed things up, with almost
1135 all the reliability of checking for all hosts.  Thus you could invoke
1136
1137 @example
1138 wget -r -D.hr http://fly.cc.fer.hr/
1139 @end example
1140
1141 to make sure that only the hosts in @samp{.hr} domain get
1142 @sc{dns}-looked-up for being equal to @samp{fly.cc.fer.hr}.  So
1143 @samp{fly.cc.etf.hr} will be checked (only once!) and found equal, but
1144 @samp{www.gnu.ai.mit.edu} will not even be checked.
1145
1146 Of course, domain acceptance can be used to limit the retrieval to
1147 particular domains with spanning of hosts in them, but then you must
1148 specify @samp{-H} explicitly.  E.g.:
1149
1150 @example
1151 wget -r -H -Dmit.edu,stanford.edu http://www.mit.edu/
1152 @end example
1153
1154 will start with @samp{http://www.mit.edu/}, following links across
1155 @sc{mit} and Stanford.
1156
1157 If there are domains you want to exclude specifically, you can do it
1158 with @samp{--exclude-domains}, which accepts the same type of arguments
1159 of @samp{-D}, but will @emph{exclude} all the listed domains.  For
1160 example, if you want to download all the hosts from @samp{foo.edu}
1161 domain, with the exception of @samp{sunsite.foo.edu}, you can do it like
1162 this:
1163
1164 @example
1165 wget -rH -Dfoo.edu --exclude-domains sunsite.foo.edu http://www.foo.edu/
1166 @end example
1167
1168 @node All Hosts, Types of Files, Domain Acceptance, Following Links
1169 @section All Hosts
1170 @cindex all hosts
1171 @cindex span hosts
1172
1173 When @samp{-H} is specified without @samp{-D}, all hosts are freely
1174 spanned.  There are no restrictions whatsoever as to what part of the
1175 net Wget will go to fetch documents, other than maximum retrieval depth.
1176 If a page references @samp{www.yahoo.com}, so be it.  Such an option is
1177 rarely useful for itself.
1178
1179 @node Types of Files, Directory-Based Limits, All Hosts, Following Links
1180 @section Types of Files
1181 @cindex types of files
1182
1183 When downloading material from the web, you will often want to restrict
1184 the retrieval to only certain file types.  For example, if you are
1185 interested in downloading @sc{gif}s, you will not be overjoyed to get
1186 loads of PostScript documents, and vice versa.
1187
1188 Wget offers two options to deal with this problem.  Each option
1189 description lists a short name, a long name, and the equivalent command
1190 in @file{.wgetrc}.
1191
1192 @cindex accept wildcards
1193 @cindex accept suffixes
1194 @cindex wildcards, accept
1195 @cindex suffixes, accept
1196 @table @samp
1197 @item -A @var{acclist}
1198 @itemx --accept @var{acclist}
1199 @itemx accept = @var{acclist}
1200 The argument to @samp{--accept} option is a list of file suffixes or
1201 patterns that Wget will download during recursive retrieval.  A suffix
1202 is the ending part of a file, and consists of ``normal'' letters,
1203 e.g. @samp{gif} or @samp{.jpg}.  A matching pattern contains shell-like
1204 wildcards, e.g. @samp{books*} or @samp{zelazny*196[0-9]*}.
1205
1206 So, specifying @samp{wget -A gif,jpg} will make Wget download only the
1207 files ending with @samp{gif} or @samp{jpg}, i.e. @sc{gif}s and
1208 @sc{jpeg}s.  On the other hand, @samp{wget -A "zelazny*196[0-9]*"} will
1209 download only files beginning with @samp{zelazny} and containing numbers
1210 from 1960 to 1969 anywhere within.  Look up the manual of your shell for
1211 a description of how pattern matching works.
1212
1213 Of course, any number of suffixes and patterns can be combined into a
1214 comma-separated list, and given as an argument to @samp{-A}.
1215
1216 @cindex reject wildcards
1217 @cindex reject suffixes
1218 @cindex wildcards, reject
1219 @cindex suffixes, reject
1220 @item -R @var{rejlist}
1221 @itemx --reject @var{rejlist}
1222 @itemx reject = @var{rejlist}
1223 The @samp{--reject} option works the same way as @samp{--accept}, only
1224 its logic is the reverse; Wget will download all files @emph{except} the
1225 ones matching the suffixes (or patterns) in the list.
1226
1227 So, if you want to download a whole page except for the cumbersome
1228 @sc{mpeg}s and @sc{.au} files, you can use @samp{wget -R mpg,mpeg,au}.
1229 Analogously, to download all files except the ones beginning with
1230 @samp{bjork}, use @samp{wget -R "bjork*"}.  The quotes are to prevent
1231 expansion by the shell.
1232 @end table
1233
1234 The @samp{-A} and @samp{-R} options may be combined to achieve even
1235 better fine-tuning of which files to retrieve.  E.g. @samp{wget -A
1236 "*zelazny*" -R .ps} will download all the files having @samp{zelazny} as
1237 a part of their name, but @emph{not} the PostScript files.
1238
1239 Note that these two options do not affect the downloading of @sc{html}
1240 files; Wget must load all the @sc{html}s to know where to go at
1241 all---recursive retrieval would make no sense otherwise.
1242
1243 @node Directory-Based Limits, FTP Links, Types of Files, Following Links
1244 @section Directory-Based Limits
1245 @cindex directories
1246 @cindex directory limits
1247
1248 Regardless of other link-following facilities, it is often useful to
1249 place the restriction of what files to retrieve based on the directories
1250 those files are placed in.  There can be many reasons for this---the
1251 home pages may be organized in a reasonable directory structure; or some
1252 directories may contain useless information, e.g. @file{/cgi-bin} or
1253 @file{/dev} directories.
1254
1255 Wget offers three different options to deal with this requirement.  Each
1256 option description lists a short name, a long name, and the equivalent
1257 command in @file{.wgetrc}.
1258
1259 @cindex directories, include
1260 @cindex include directories
1261 @cindex accept directories
1262 @table @samp
1263 @item -I @var{list}
1264 @itemx --include @var{list}
1265 @itemx include_directories = @var{list}
1266 @samp{-I} option accepts a comma-separated list of directories included
1267 in the retrieval.  Any other directories will simply be ignored.  The
1268 directories are absolute paths.
1269
1270 So, if you wish to download from @samp{http://host/people/bozo/}
1271 following only links to bozo's colleagues in the @file{/people}
1272 directory and the bogus scripts in @file{/cgi-bin}, you can specify:
1273
1274 @example
1275 wget -I /people,/cgi-bin http://host/people/bozo/
1276 @end example
1277
1278 @cindex directories, exclude
1279 @cindex exclude directories
1280 @cindex reject directories
1281 @item -X @var{list}
1282 @itemx --exclude @var{list}
1283 @itemx exclude_directories = @var{list}
1284 @samp{-X} option is exactly the reverse of @samp{-I}---this is a list of
1285 directories @emph{excluded} from the download.  E.g. if you do not want
1286 Wget to download things from @file{/cgi-bin} directory, specify @samp{-X
1287 /cgi-bin} on the command line.
1288
1289 The same as with @samp{-A}/@samp{-R}, these two options can be combined
1290 to get a better fine-tuning of downloading subdirectories.  E.g. if you
1291 want to load all the files from @file{/pub} hierarchy except for
1292 @file{/pub/worthless}, specify @samp{-I/pub -X/pub/worthless}.
1293
1294 @cindex no parent
1295 @item -np
1296 @itemx --no-parent
1297 @itemx no_parent = on
1298 The simplest, and often very useful way of limiting directories is
1299 disallowing retrieval of the links that refer to the hierarchy
1300 @dfn{above} than the beginning directory, i.e. disallowing ascent to the
1301 parent directory/directories.
1302
1303 The @samp{--no-parent} option (short @samp{-np}) is useful in this case.
1304 Using it guarantees that you will never leave the existing hierarchy.
1305 Supposing you issue Wget with:
1306
1307 @example
1308 wget -r --no-parent http://somehost/~luzer/my-archive/
1309 @end example
1310
1311 You may rest assured that none of the references to
1312 @file{/~his-girls-homepage/} or @file{/~luzer/all-my-mpegs/} will be
1313 followed.  Only the archive you are interested in will be downloaded.
1314 Essentially, @samp{--no-parent} is similar to
1315 @samp{-I/~luzer/my-archive}, only it handles redirections in a more
1316 intelligent fashion.
1317 @end table
1318
1319 @node FTP Links,  , Directory-Based Limits, Following Links
1320 @section Following FTP Links
1321 @cindex following ftp links
1322
1323 The rules for @sc{ftp} are somewhat specific, as it is necessary for
1324 them to be.  @sc{ftp} links in @sc{html} documents are often included
1325 for purposes of reference, and it is often inconvenient to download them
1326 by default.
1327
1328 To have @sc{ftp} links followed from @sc{html} documents, you need to
1329 specify the @samp{--follow-ftp} option.  Having done that, @sc{ftp}
1330 links will span hosts regardless of @samp{-H} setting.  This is logical,
1331 as @sc{ftp} links rarely point to the same host where the @sc{http}
1332 server resides.  For similar reasons, the @samp{-L} options has no
1333 effect on such downloads.  On the other hand, domain acceptance
1334 (@samp{-D}) and suffix rules (@samp{-A} and @samp{-R}) apply normally.
1335
1336 Also note that followed links to @sc{ftp} directories will not be
1337 retrieved recursively further.
1338
1339 @node Time-Stamping, Startup File, Following Links, Top
1340 @chapter Time-Stamping
1341 @cindex time-stamping
1342 @cindex timestamping
1343 @cindex updating the archives
1344 @cindex incremental updating
1345
1346 One of the most important aspects of mirroring information from the
1347 Internet is updating your archives.
1348
1349 Downloading the whole archive again and again, just to replace a few
1350 changed files is expensive, both in terms of wasted bandwidth and money,
1351 and the time to do the update.  This is why all the mirroring tools
1352 offer the option of incremental updating.
1353
1354 Such an updating mechanism means that the remote server is scanned in
1355 search of @dfn{new} files.  Only those new files will be downloaded in
1356 the place of the old ones.
1357
1358 A file is considered new if one of these two conditions are met:
1359
1360 @enumerate
1361 @item
1362 A file of that name does not already exist locally.
1363
1364 @item
1365 A file of that name does exist, but the remote file was modified more
1366 recently than the local file.
1367 @end enumerate
1368
1369 To implement this, the program needs to be aware of the time of last
1370 modification of both remote and local files.  Such information are
1371 called the @dfn{time-stamps}.
1372
1373 The time-stamping in GNU Wget is turned on using @samp{--timestamping}
1374 (@samp{-N}) option, or through @code{timestamping = on} directive in
1375 @file{.wgetrc}.  With this option, for each file it intends to download,
1376 Wget will check whether a local file of the same name exists.  If it
1377 does, and the remote file is older, Wget will not download it.
1378
1379 If the local file does not exist, or the sizes of the files do not
1380 match, Wget will download the remote file no matter what the time-stamps
1381 say.
1382
1383 @menu
1384 * Time-Stamping Usage::
1385 * HTTP Time-Stamping Internals::
1386 * FTP Time-Stamping Internals::
1387 @end menu
1388
1389 @node Time-Stamping Usage, HTTP Time-Stamping Internals, Time-Stamping, Time-Stamping
1390 @section Time-Stamping Usage
1391 @cindex time-stamping usage
1392 @cindex usage, time-stamping
1393
1394 The usage of time-stamping is simple.  Say you would like to download a
1395 file so that it keeps its date of modification.
1396
1397 @example
1398 wget -S http://www.gnu.ai.mit.edu/
1399 @end example
1400
1401 A simple @code{ls -l} shows that the time stamp on the local file equals
1402 the state of the @code{Last-Modified} header, as returned by the server.
1403 As you can see, the time-stamping info is preserved locally, even
1404 without @samp{-N}.
1405
1406 Several days later, you would like Wget to check if the remote file has
1407 changed, and download it if it has.
1408
1409 @example
1410 wget -N http://www.gnu.ai.mit.edu/
1411 @end example
1412
1413 Wget will ask the server for the last-modified date.  If the local file
1414 is newer, the remote file will not be re-fetched.  However, if the remote
1415 file is more recent, Wget will proceed fetching it normally.
1416
1417 The same goes for @sc{ftp}.  For example:
1418
1419 @example
1420 wget ftp://ftp.ifi.uio.no/pub/emacs/gnus/*
1421 @end example
1422
1423 @code{ls} will show that the timestamps are set according to the state
1424 on the remote server.  Reissuing the command with @samp{-N} will make
1425 Wget re-fetch @emph{only} the files that have been modified.
1426
1427 In both @sc{http} and @sc{ftp} retrieval Wget will time-stamp the local
1428 file correctly (with or without @samp{-N}) if it gets the stamps,
1429 i.e. gets the directory listing for @sc{ftp} or the @code{Last-Modified}
1430 header for @sc{http}.
1431
1432 If you wished to mirror the GNU archive every week, you would use the
1433 following command every week:
1434
1435 @example
1436 wget --timestamping -r ftp://prep.ai.mit.edu/pub/gnu/
1437 @end example
1438
1439 @node HTTP Time-Stamping Internals, FTP Time-Stamping Internals, Time-Stamping Usage, Time-Stamping
1440 @section HTTP Time-Stamping Internals
1441 @cindex http time-stamping
1442
1443 Time-stamping in @sc{http} is implemented by checking of the
1444 @code{Last-Modified} header.  If you wish to retrieve the file
1445 @file{foo.html} through @sc{http}, Wget will check whether
1446 @file{foo.html} exists locally.  If it doesn't, @file{foo.html} will be
1447 retrieved unconditionally.
1448
1449 If the file does exist locally, Wget will first check its local
1450 time-stamp (similar to the way @code{ls -l} checks it), and then send a
1451 @code{HEAD} request to the remote server, demanding the information on
1452 the remote file.
1453
1454 The @code{Last-Modified} header is examined to find which file was
1455 modified more recently (which makes it ``newer'').  If the remote file
1456 is newer, it will be downloaded; if it is older, Wget will give
1457 up.@footnote{As an additional check, Wget will look at the
1458 @code{Content-Length} header, and compare the sizes; if they are not the
1459 same, the remote file will be downloaded no matter what the time-stamp
1460 says.}
1461
1462 When @samp{--backup-converted} (@samp{-K}) is specified in conjunction
1463 with @samp{-N}, server file @samp{@var{X}} is compared to local file
1464 @samp{@var{X}.orig}, if extant, rather than being compared to local file
1465 @samp{@var{X}}, which will always differ if it's been converted by
1466 @samp{--convert-links} (@samp{-k}).
1467
1468 Arguably, @sc{http} time-stamping should be implemented using the
1469 @code{If-Modified-Since} request.
1470
1471 @node FTP Time-Stamping Internals,  , HTTP Time-Stamping Internals, Time-Stamping
1472 @section FTP Time-Stamping Internals
1473 @cindex ftp time-stamping
1474
1475 In theory, @sc{ftp} time-stamping works much the same as @sc{http}, only
1476 @sc{ftp} has no headers---time-stamps must be received from the
1477 directory listings.
1478
1479 For each directory files must be retrieved from, Wget will use the
1480 @code{LIST} command to get the listing.  It will try to analyze the
1481 listing, assuming that it is a Unix @code{ls -l} listing, and extract
1482 the time-stamps.  The rest is exactly the same as for @sc{http}.
1483
1484 Assumption that every directory listing is a Unix-style listing may
1485 sound extremely constraining, but in practice it is not, as many
1486 non-Unix @sc{ftp} servers use the Unixoid listing format because most
1487 (all?) of the clients understand it.  Bear in mind that @sc{rfc959}
1488 defines no standard way to get a file list, let alone the time-stamps.
1489 We can only hope that a future standard will define this.
1490
1491 Another non-standard solution includes the use of @code{MDTM} command
1492 that is supported by some @sc{ftp} servers (including the popular
1493 @code{wu-ftpd}), which returns the exact time of the specified file.
1494 Wget may support this command in the future.
1495
1496 @node Startup File, Examples, Time-Stamping, Top
1497 @chapter Startup File
1498 @cindex startup file
1499 @cindex wgetrc
1500 @cindex .wgetrc
1501 @cindex startup
1502 @cindex .netrc
1503
1504 Once you know how to change default settings of Wget through command
1505 line arguments, you may wish to make some of those settings permanent.
1506 You can do that in a convenient way by creating the Wget startup
1507 file---@file{.wgetrc}.
1508
1509 Besides @file{.wgetrc} is the ``main'' initialization file, it is
1510 convenient to have a special facility for storing passwords.  Thus Wget
1511 reads and interprets the contents of @file{$HOME/.netrc}, if it finds
1512 it.  You can find @file{.netrc} format in your system manuals.
1513
1514 Wget reads @file{.wgetrc} upon startup, recognizing a limited set of
1515 commands.
1516
1517 @menu
1518 * Wgetrc Location::   Location of various wgetrc files.
1519 * Wgetrc Syntax::     Syntax of wgetrc.
1520 * Wgetrc Commands::   List of available commands.
1521 * Sample Wgetrc::     A wgetrc example.
1522 @end menu
1523
1524 @node Wgetrc Location, Wgetrc Syntax, Startup File, Startup File
1525 @section Wgetrc Location
1526 @cindex wgetrc location
1527 @cindex location of wgetrc
1528
1529 When initializing, Wget will look for a @dfn{global} startup file,
1530 @file{/usr/local/etc/wgetrc} by default (or some prefix other than
1531 @file{/usr/local}, if Wget was not installed there) and read commands
1532 from there, if it exists.
1533
1534 Then it will look for the user's file.  If the environmental variable
1535 @code{WGETRC} is set, Wget will try to load that file.  Failing that, no
1536 further attempts will be made.
1537
1538 If @code{WGETRC} is not set, Wget will try to load @file{$HOME/.wgetrc}.
1539
1540 The fact that user's settings are loaded after the system-wide ones
1541 means that in case of collision user's wgetrc @emph{overrides} the
1542 system-wide wgetrc (in @file{/usr/local/etc/wgetrc} by default).
1543 Fascist admins, away!
1544
1545 @node Wgetrc Syntax, Wgetrc Commands, Wgetrc Location, Startup File
1546 @section Wgetrc Syntax
1547 @cindex wgetrc syntax
1548 @cindex syntax of wgetrc
1549
1550 The syntax of a wgetrc command is simple:
1551
1552 @example
1553 variable = value
1554 @end example
1555
1556 The @dfn{variable} will also be called @dfn{command}.  Valid
1557 @dfn{values} are different for different commands.
1558
1559 The commands are case-insensitive and underscore-insensitive.  Thus
1560 @samp{DIr__PrefiX} is the same as @samp{dirprefix}.  Empty lines, lines
1561 beginning with @samp{#} and lines containing white-space only are
1562 discarded.
1563
1564 Commands that expect a comma-separated list will clear the list on an
1565 empty command.  So, if you wish to reset the rejection list specified in
1566 global @file{wgetrc}, you can do it with:
1567
1568 @example
1569 reject =
1570 @end example
1571
1572 @node Wgetrc Commands, Sample Wgetrc, Wgetrc Syntax, Startup File
1573 @section Wgetrc Commands
1574 @cindex wgetrc commands
1575
1576 The complete set of commands is listed below, the letter after @samp{=}
1577 denoting the value the command takes. It is @samp{on/off} for @samp{on}
1578 or @samp{off} (which can also be @samp{1} or @samp{0}), @var{string} for
1579 any non-empty string or @var{n} for a positive integer.  For example,
1580 you may specify @samp{use_proxy = off} to disable use of proxy servers
1581 by default. You may use @samp{inf} for infinite values, where
1582 appropriate.
1583
1584 Most of the commands have their equivalent command-line option
1585 (@xref{Invoking}), except some more obscure or rarely used ones.
1586
1587 @table @asis
1588 @item accept/reject = @var{string}
1589 Same as @samp{-A}/@samp{-R} (@xref{Types of Files}).
1590
1591 @item add_hostdir = on/off
1592 Enable/disable host-prefixed file names.  @samp{-nH} disables it.
1593
1594 @item continue = on/off
1595 Enable/disable continuation of the retrieval, the same as @samp{-c}
1596 (which enables it).
1597
1598 @item background = on/off
1599 Enable/disable going to background, the same as @samp{-b} (which enables
1600 it).
1601
1602 @item backup_converted = on/off
1603 Enable/disable saving pre-converted files with the suffix @samp{.orig}
1604 -- the same as @samp{-K} (which enables it).
1605
1606 @c @item backups = @var{number}
1607 @c #### Document me!
1608 @item base = @var{string}
1609 Set base for relative @sc{url}s, the same as @samp{-B}.
1610
1611 @item cache = on/off
1612 When set to off, disallow server-caching.  See the @samp{-C} option.
1613
1614 @item convert links = on/off
1615 Convert non-relative links locally.  The same as @samp{-k}.
1616
1617 @item cut_dirs = @var{n}
1618 Ignore @var{n} remote directory components.
1619
1620 @item debug = on/off
1621 Debug mode, same as @samp{-d}.
1622
1623 @item delete_after = on/off
1624 Delete after download, the same as @samp{--delete-after}.
1625
1626 @item dir_prefix = @var{string}
1627 Top of directory tree, the same as @samp{-P}.
1628
1629 @item dirstruct = on/off
1630 Turning dirstruct on or off, the same as @samp{-x} or @samp{-nd},
1631 respectively.
1632
1633 @item domains = @var{string}
1634 Same as @samp{-D} (@xref{Domain Acceptance}).
1635
1636 @item dot_bytes = @var{n}
1637 Specify the number of bytes ``contained'' in a dot, as seen throughout
1638 the retrieval (1024 by default).  You can postfix the value with
1639 @samp{k} or @samp{m}, representing kilobytes and megabytes,
1640 respectively.  With dot settings you can tailor the dot retrieval to
1641 suit your needs, or you can use the predefined @dfn{styles}
1642 (@xref{Download Options}).
1643
1644 @item dots_in_line = @var{n}
1645 Specify the number of dots that will be printed in each line throughout
1646 the retrieval (50 by default).
1647
1648 @item dot_spacing = @var{n}
1649 Specify the number of dots in a single cluster (10 by default).
1650
1651 @item dot_style = @var{string}
1652 Specify the dot retrieval @dfn{style}, as with @samp{--dot-style}.
1653
1654 @item exclude_directories = @var{string}
1655 Specify a comma-separated list of directories you wish to exclude from
1656 download, the same as @samp{-X} (@xref{Directory-Based Limits}).
1657
1658 @item exclude_domains = @var{string}
1659 Same as @samp{--exclude-domains} (@xref{Domain Acceptance}).
1660
1661 @item follow_ftp = on/off
1662 Follow @sc{ftp} links from @sc{html} documents, the same as @samp{-f}.
1663
1664 @item follow_tags = @var{string}
1665 Only follow certain HTML tags when doing a recursive retrieval, just like
1666 @samp{--follow-tags}. 
1667
1668 @item force_html = on/off
1669 If set to on, force the input filename to be regarded as an @sc{html}
1670 document, the same as @samp{-F}.
1671
1672 @item ftp_proxy = @var{string}
1673 Use @var{string} as @sc{ftp} proxy, instead of the one specified in
1674 environment.
1675
1676 @item glob = on/off
1677 Turn globbing on/off, the same as @samp{-g}.
1678
1679 @item header = @var{string}
1680 Define an additional header, like @samp{--header}.
1681
1682 @item http_passwd = @var{string}
1683 Set @sc{http} password.
1684
1685 @item http_proxy = @var{string}
1686 Use @var{string} as @sc{http} proxy, instead of the one specified in
1687 environment.
1688
1689 @item http_user = @var{string}
1690 Set @sc{http} user to @var{string}.
1691
1692 @item ignore_length = on/off
1693 When set to on, ignore @code{Content-Length} header; the same as
1694 @samp{--ignore-length}.
1695
1696 @item ignore_tags = @var{string}
1697 Ignore certain HTML tags when doing a recursive retrieval, just like
1698 @samp{-G} / @samp{--ignore-tags}. 
1699
1700 @item include_directories = @var{string}
1701 Specify a comma-separated list of directories you wish to follow when
1702 downloading, the same as @samp{-I}.
1703
1704 @item input = @var{string}
1705 Read the @sc{url}s from @var{string}, like @samp{-i}.
1706
1707 @item kill_longer = on/off
1708 Consider data longer than specified in content-length header
1709 as invalid (and retry getting it). The default behaviour is to save
1710 as much data as there is, provided there is more than or equal
1711 to the value in @code{Content-Length}.
1712
1713 @item logfile = @var{string}
1714 Set logfile, the same as @samp{-o}.
1715
1716 @item login = @var{string}
1717 Your user name on the remote machine, for @sc{ftp}.  Defaults to
1718 @samp{anonymous}.
1719
1720 @item mirror = on/off
1721 Turn mirroring on/off.  The same as @samp{-m}.
1722
1723 @item netrc = on/off
1724 Turn reading netrc on or off.
1725
1726 @item noclobber = on/off
1727 Same as @samp{-nc}.
1728
1729 @item no_parent = on/off
1730 Disallow retrieving outside the directory hierarchy, like
1731 @samp{--no-parent} (@xref{Directory-Based Limits}).
1732
1733 @item no_proxy = @var{string}
1734 Use @var{string} as the comma-separated list of domains to avoid in
1735 proxy loading, instead of the one specified in environment.
1736
1737 @item output_document = @var{string}
1738 Set the output filename, the same as @samp{-O}.
1739
1740 @item passive_ftp = on/off
1741 Set passive @sc{ftp}, the same as @samp{--passive-ftp}.
1742
1743 @item passwd = @var{string}
1744 Set your @sc{ftp} password to @var{password}.  Without this setting, the
1745 password defaults to @samp{username@@hostname.domainname}.
1746
1747 @item proxy_user = @var{string}
1748 Set proxy authentication user name to @var{string}, like
1749 @samp{--proxy-user}.
1750
1751 @item proxy_passwd = @var{string}
1752 Set proxy authentication password to @var{string}, like
1753 @samp{--proxy-passwd}.
1754
1755 @item quiet = on/off
1756 Quiet mode, the same as @samp{-q}.
1757
1758 @item quota = @var{quota}
1759 Specify the download quota, which is useful to put in the global
1760 @file{wgetrc}. When download quota is specified, Wget will stop retrieving
1761 after the download sum has become greater than quota.  The quota can be
1762 specified in bytes (default), kbytes @samp{k} appended) or mbytes
1763 (@samp{m} appended).  Thus @samp{quota = 5m} will set the quota to 5
1764 mbytes. Note that the user's startup file overrides system settings.
1765
1766 @item reclevel = @var{n}
1767 Recursion level, the same as @samp{-l}.
1768
1769 @item recursive = on/off
1770 Recursive on/off, the same as @samp{-r}.
1771
1772 @item relative_only = on/off
1773 Follow only relative links, the same as @samp{-L} (@xref{Relative
1774 Links}).
1775
1776 @item remove_listing = on/off
1777 If set to on, remove @sc{ftp} listings downloaded by Wget.  Setting it
1778 to off is the same as @samp{-nr}.
1779
1780 @item retr_symlinks = on/off
1781 When set to on, retrieve symbolic links as if they were plain files; the
1782 same as @samp{--retr-symlinks}.
1783
1784 @item robots = on/off
1785 Use (or not) @file{/robots.txt} file (@xref{Robots}).  Be sure to know
1786 what you are doing before changing the default (which is @samp{on}).
1787
1788 @item server_response = on/off
1789 Choose whether or not to print the @sc{http} and @sc{ftp} server
1790 responses, the same as @samp{-S}.
1791
1792 @item simple_host_check = on/off
1793 Same as @samp{-nh} (@xref{Host Checking}).
1794
1795 @item span_hosts = on/off
1796 Same as @samp{-H}.
1797
1798 @item timeout = @var{n}
1799 Set timeout value, the same as @samp{-T}.
1800
1801 @item timestamping = on/off
1802 Turn timestamping on/off. The same as @samp{-N} (@xref{Time-Stamping}).
1803
1804 @item tries = @var{n}
1805 Set number of retries per @sc{url}, the same as @samp{-t}.
1806
1807 @item use_proxy = on/off
1808 Turn proxy support on/off. The same as @samp{-Y}.
1809
1810 @item verbose = on/off
1811 Turn verbose on/off, the same as @samp{-v}/@samp{-nv}.
1812
1813 @item wait = @var{n}
1814 Wait @var{n} seconds between retrievals, the same as @samp{-w}.
1815
1816 @item waitretry = @var{n}
1817 Wait up to @var{n} seconds between retries of failed retrievals only --
1818 the same as @samp{--waitretry}.  Note that this is turned on by default
1819 in the global @file{wgetrc}.
1820 @end table
1821
1822 @node Sample Wgetrc,  , Wgetrc Commands, Startup File
1823 @section Sample Wgetrc
1824 @cindex sample wgetrc
1825
1826 This is the sample initialization file, as given in the distribution.
1827 It is divided in two section---one for global usage (suitable for global
1828 startup file), and one for local usage (suitable for
1829 @file{$HOME/.wgetrc}).  Be careful about the things you change.
1830
1831 Note that almost all the lines are commented out.  For a command to have
1832 any effect, you must remove the @samp{#} character at the beginning of
1833 its line.
1834
1835 @example
1836 @include sample.wgetrc.munged_for_texi_inclusion
1837 @end example
1838
1839 @node Examples, Various, Startup File, Top
1840 @chapter Examples
1841 @cindex examples
1842
1843 The examples are classified into three sections, because of clarity.
1844 The first section is a tutorial for beginners.  The second section
1845 explains some of the more complex program features.  The third section
1846 contains advice for mirror administrators, as well as even more complex
1847 features (that some would call perverted).
1848
1849 @menu
1850 * Simple Usage::        Simple, basic usage of the program.
1851 * Advanced Usage::      Advanced techniques of usage.
1852 * Guru Usage::          Mirroring and the hairy stuff.
1853 @end menu
1854
1855 @node Simple Usage, Advanced Usage, Examples, Examples
1856 @section Simple Usage
1857
1858 @itemize @bullet
1859 @item
1860 Say you want to download a @sc{url}.  Just type:
1861
1862 @example
1863 wget http://fly.cc.fer.hr/
1864 @end example
1865
1866 The response will be something like:
1867
1868 @example
1869 @group
1870 --13:30:45--  http://fly.cc.fer.hr:80/en/
1871            => `index.html'
1872 Connecting to fly.cc.fer.hr:80... connected!
1873 HTTP request sent, awaiting response... 200 OK
1874 Length: 4,694 [text/html]
1875
1876     0K -> ....                                                   [100%]
1877
1878 13:30:46 (23.75 KB/s) - `index.html' saved [4694/4694]
1879 @end group
1880 @end example
1881
1882 @item
1883 But what will happen if the connection is slow, and the file is lengthy?
1884 The connection will probably fail before the whole file is retrieved,
1885 more than once.  In this case, Wget will try getting the file until it
1886 either gets the whole of it, or exceeds the default number of retries
1887 (this being 20).  It is easy to change the number of tries to 45, to
1888 insure that the whole file will arrive safely:
1889
1890 @example
1891 wget --tries=45 http://fly.cc.fer.hr/jpg/flyweb.jpg
1892 @end example
1893
1894 @item
1895 Now let's leave Wget to work in the background, and write its progress
1896 to log file @file{log}.  It is tiring to type @samp{--tries}, so we
1897 shall use @samp{-t}.
1898
1899 @example
1900 wget -t 45 -o log http://fly.cc.fer.hr/jpg/flyweb.jpg &
1901 @end example
1902
1903 The ampersand at the end of the line makes sure that Wget works in the
1904 background.  To unlimit the number of retries, use @samp{-t inf}.
1905
1906 @item
1907 The usage of @sc{ftp} is as simple.  Wget will take care of login and
1908 password.
1909
1910 @example
1911 @group
1912 $ wget ftp://gnjilux.cc.fer.hr/welcome.msg
1913 --10:08:47--  ftp://gnjilux.cc.fer.hr:21/welcome.msg
1914            => `welcome.msg'
1915 Connecting to gnjilux.cc.fer.hr:21... connected!
1916 Logging in as anonymous ... Logged in!
1917 ==> TYPE I ... done.  ==> CWD not needed.
1918 ==> PORT ... done.    ==> RETR welcome.msg ... done.
1919 Length: 1,340 (unauthoritative)
1920
1921     0K -> .                                                      [100%]
1922
1923 10:08:48 (1.28 MB/s) - `welcome.msg' saved [1340]
1924 @end group
1925 @end example
1926
1927 @item
1928 If you specify a directory, Wget will retrieve the directory listing,
1929 parse it and convert it to @sc{html}.  Try:
1930
1931 @example
1932 wget ftp://prep.ai.mit.edu/pub/gnu/
1933 lynx index.html
1934 @end example
1935 @end itemize
1936
1937 @node Advanced Usage, Guru Usage, Simple Usage, Examples
1938 @section Advanced Usage
1939
1940 @itemize @bullet
1941 @item
1942 You would like to read the list of @sc{url}s from a file?  Not a problem
1943 with that:
1944
1945 @example
1946 wget -i file
1947 @end example
1948
1949 If you specify @samp{-} as file name, the @sc{url}s will be read from
1950 standard input.
1951
1952 @item
1953 Create a mirror image of GNU @sc{www} site (with the same directory structure
1954 the original has) with only one try per document, saving the log of the
1955 activities to @file{gnulog}:
1956
1957 @example
1958 wget -r -t1 http://www.gnu.ai.mit.edu/ -o gnulog
1959 @end example
1960
1961 @item
1962 Retrieve the first layer of yahoo links:
1963
1964 @example
1965 wget -r -l1 http://www.yahoo.com/
1966 @end example
1967
1968 @item
1969 Retrieve the index.html of @samp{www.lycos.com}, showing the original
1970 server headers:
1971
1972 @example
1973 wget -S http://www.lycos.com/
1974 @end example
1975
1976 @item
1977 Save the server headers with the file:
1978 @example
1979 wget -s http://www.lycos.com/
1980 more index.html
1981 @end example
1982
1983 @item
1984 Retrieve the first two levels of @samp{wuarchive.wustl.edu}, saving them
1985 to /tmp.
1986
1987 @example
1988 wget -P/tmp -l2 ftp://wuarchive.wustl.edu/
1989 @end example
1990
1991 @item
1992 You want to download all the @sc{gif}s from an @sc{http} directory.
1993 @samp{wget http://host/dir/*.gif} doesn't work, since @sc{http}
1994 retrieval does not support globbing.  In that case, use:
1995
1996 @example
1997 wget -r -l1 --no-parent -A.gif http://host/dir/
1998 @end example
1999
2000 It is a bit of a kludge, but it works.  @samp{-r -l1} means to retrieve
2001 recursively (@xref{Recursive Retrieval}), with maximum depth of 1.
2002 @samp{--no-parent} means that references to the parent directory are
2003 ignored (@xref{Directory-Based Limits}), and @samp{-A.gif} means to
2004 download only the @sc{gif} files.  @samp{-A "*.gif"} would have worked
2005 too.
2006
2007 @item
2008 Suppose you were in the middle of downloading, when Wget was
2009 interrupted.  Now you do not want to clobber the files already present.
2010 It would be:
2011
2012 @example
2013 wget -nc -r http://www.gnu.ai.mit.edu/
2014 @end example
2015
2016 @item
2017 If you want to encode your own username and password to @sc{http} or
2018 @sc{ftp}, use the appropriate @sc{url} syntax (@xref{URL Format}).
2019
2020 @example
2021 wget ftp://hniksic:mypassword@@jagor.srce.hr/.emacs
2022 @end example
2023
2024 @item
2025 If you do not like the default retrieval visualization (1K dots with 10
2026 dots per cluster and 50 dots per line), you can customize it through dot
2027 settings (@xref{Wgetrc Commands}).  For example, many people like the
2028 ``binary'' style of retrieval, with 8K dots and 512K lines:
2029
2030 @example
2031 wget --dot-style=binary ftp://prep.ai.mit.edu/pub/gnu/README
2032 @end example
2033
2034 You can experiment with other styles, like:
2035
2036 @example
2037 wget --dot-style=mega ftp://ftp.xemacs.org/pub/xemacs/xemacs-20.4/xemacs-20.4.tar.gz
2038 wget --dot-style=micro http://fly.cc.fer.hr/
2039 @end example
2040
2041 To make these settings permanent, put them in your @file{.wgetrc}, as
2042 described before (@xref{Sample Wgetrc}).
2043 @end itemize
2044
2045 @node Guru Usage,  , Advanced Usage, Examples
2046 @section Guru Usage
2047
2048 @cindex mirroring
2049 @itemize @bullet
2050 @item
2051 If you wish Wget to keep a mirror of a page (or @sc{ftp}
2052 subdirectories), use @samp{--mirror} (@samp{-m}), which is the shorthand
2053 for @samp{-r -N}.  You can put Wget in the crontab file asking it to
2054 recheck a site each Sunday:
2055
2056 @example
2057 crontab
2058 0 0 * * 0 wget --mirror ftp://ftp.xemacs.org/pub/xemacs/ -o /home/me/weeklog
2059 @end example
2060
2061 @item
2062 You may wish to do the same with someone's home page.  But you do not
2063 want to download all those images---you're only interested in @sc{html}.
2064
2065 @example
2066 wget --mirror -A.html http://www.w3.org/
2067 @end example
2068
2069 @item
2070 But what about mirroring the hosts networkologically close to you?  It
2071 seems so awfully slow because of all that @sc{dns} resolving.  Just use
2072 @samp{-D} (@xref{Domain Acceptance}).
2073
2074 @example
2075 wget -rN -Dsrce.hr http://www.srce.hr/
2076 @end example
2077
2078 Now Wget will correctly find out that @samp{regoc.srce.hr} is the same
2079 as @samp{www.srce.hr}, but will not even take into consideration the
2080 link to @samp{www.mit.edu}.
2081
2082 @item
2083 You have a presentation and would like the dumb absolute links to be
2084 converted to relative?  Use @samp{-k}:
2085
2086 @example
2087 wget -k -r @var{URL}
2088 @end example
2089
2090 @cindex redirecting output
2091 @item
2092 You would like the output documents to go to standard output instead of
2093 to files?  OK, but Wget will automatically shut up (turn on
2094 @samp{--quiet}) to prevent mixing of Wget output and the retrieved
2095 documents.
2096
2097 @example
2098 wget -O - http://jagor.srce.hr/ http://www.srce.hr/
2099 @end example
2100
2101 You can also combine the two options and make weird pipelines to
2102 retrieve the documents from remote hotlists:
2103
2104 @example
2105 wget -O - http://cool.list.com/ | wget --force-html -i -
2106 @end example
2107 @end itemize
2108
2109 @node Various, Appendices, Examples, Top
2110 @chapter Various
2111 @cindex various
2112
2113 This chapter contains all the stuff that could not fit anywhere else.
2114
2115 @menu
2116 * Proxies::             Support for proxy servers
2117 * Distribution::        Getting the latest version.
2118 * Mailing List::        Wget mailing list for announcements and discussion.
2119 * Reporting Bugs::      How and where to report bugs.
2120 * Portability::         The systems Wget works on.
2121 * Signals::             Signal-handling performed by Wget.
2122 @end menu
2123
2124 @node Proxies, Distribution, Various, Various
2125 @section Proxies
2126 @cindex proxies
2127
2128 @dfn{Proxies} are special-purpose @sc{http} servers designed to transfer
2129 data from remote servers to local clients.  One typical use of proxies
2130 is lightening network load for users behind a slow connection.  This is
2131 achieved by channeling all @sc{http} and @sc{ftp} requests through the
2132 proxy which caches the transferred data.  When a cached resource is
2133 requested again, proxy will return the data from cache.  Another use for
2134 proxies is for companies that separate (for security reasons) their
2135 internal networks from the rest of Internet.  In order to obtain
2136 information from the Web, their users connect and retrieve remote data
2137 using an authorized proxy.
2138
2139 Wget supports proxies for both @sc{http} and @sc{ftp} retrievals.  The
2140 standard way to specify proxy location, which Wget recognizes, is using
2141 the following environment variables:
2142
2143 @table @code
2144 @item http_proxy
2145 This variable should contain the @sc{url} of the proxy for @sc{http}
2146 connections.
2147
2148 @item ftp_proxy
2149 This variable should contain the @sc{url} of the proxy for @sc{http}
2150 connections.  It is quite common that @sc{http_proxy} and @sc{ftp_proxy}
2151 are set to the same @sc{url}.
2152
2153 @item no_proxy
2154 This variable should contain a comma-separated list of domain extensions
2155 proxy should @emph{not} be used for.  For instance, if the value of
2156 @code{no_proxy} is @samp{.mit.edu}, proxy will not be used to retrieve
2157 documents from MIT.
2158 @end table
2159
2160 In addition to the environment variables, proxy location and settings
2161 may be specified from within Wget itself.
2162
2163 @table @samp
2164 @item -Y on/off
2165 @itemx --proxy=on/off
2166 @itemx proxy = on/off
2167 This option may be used to turn the proxy support on or off.  Proxy
2168 support is on by default, provided that the appropriate environment
2169 variables are set.
2170
2171 @item http_proxy = @var{URL}
2172 @itemx ftp_proxy = @var{URL}
2173 @itemx no_proxy = @var{string}
2174 These startup file variables allow you to override the proxy settings
2175 specified by the environment.
2176 @end table
2177
2178 Some proxy servers require authorization to enable you to use them.  The
2179 authorization consists of @dfn{username} and @dfn{password}, which must
2180 be sent by Wget.  As with @sc{http} authorization, several
2181 authentication schemes exist.  For proxy authorization only the
2182 @code{Basic} authentication scheme is currently implemented.
2183
2184 You may specify your username and password either through the proxy
2185 @sc{url} or through the command-line options.  Assuming that the
2186 company's proxy is located at @samp{proxy.srce.hr} at port 8001, a proxy
2187 @sc{url} location containing authorization data might look like this:
2188
2189 @example
2190 http://hniksic:mypassword@@proxy.company.com:8001/
2191 @end example
2192
2193 Alternatively, you may use the @samp{proxy-user} and
2194 @samp{proxy-password} options, and the equivalent @file{.wgetrc}
2195 settings @code{proxy_user} and @code{proxy_passwd} to set the proxy
2196 username and password.
2197
2198 @node Distribution, Mailing List, Proxies, Various
2199 @section Distribution
2200 @cindex latest version
2201
2202 Like all GNU utilities, the latest version of Wget can be found at the
2203 master GNU archive site prep.ai.mit.edu, and its mirrors.  For example,
2204 Wget @value{VERSION} can be found at
2205 @url{ftp://prep.ai.mit.edu/gnu/wget/wget-@value{VERSION}.tar.gz}
2206
2207 @node Mailing List, Reporting Bugs, Distribution, Various
2208 @section Mailing List
2209 @cindex mailing list
2210 @cindex list
2211
2212 Wget has its own mailing list at @email{wget@@sunsite.auc.dk}, thanks
2213 to Karsten Thygesen.  The mailing list is for discussion of Wget
2214 features and web, reporting Wget bugs (those that you think may be of
2215 interest to the public) and mailing announcements.  You are welcome to
2216 subscribe.  The more people on the list, the better!
2217
2218 To subscribe, send mail to @email{wget-subscribe@@sunsite.auc.dk}.
2219 the magic word @samp{subscribe} in the subject line.  Unsubscribe by
2220 mailing to @email{wget-unsubscribe@@sunsite.auc.dk}.
2221
2222 The mailing list is archived at @url{http://fly.cc.fer.hr/archive/wget}.
2223
2224 @node Reporting Bugs, Portability, Mailing List, Various
2225 @section Reporting Bugs
2226 @cindex bugs
2227 @cindex reporting bugs
2228 @cindex bug reports
2229
2230 You are welcome to send bug reports about GNU Wget to
2231 @email{bug-wget@@gnu.org}.  The bugs that you think are of the
2232 interest to the public (i.e. more people should be informed about them)
2233 can be Cc-ed to the mailing list at @email{wget@@sunsite.auc.dk}.
2234
2235 Before actually submitting a bug report, please try to follow a few
2236 simple guidelines.
2237
2238 @enumerate
2239 @item
2240 Please try to ascertain that the behaviour you see really is a bug.  If
2241 Wget crashes, it's a bug.  If Wget does not behave as documented,
2242 it's a bug.  If things work strange, but you are not sure about the way
2243 they are supposed to work, it might well be a bug.
2244
2245 @item
2246 Try to repeat the bug in as simple circumstances as possible.  E.g. if
2247 Wget crashes on @samp{wget -rLl0 -t5 -Y0 http://yoyodyne.com -o
2248 /tmp/log}, you should try to see if it will crash with a simpler set of
2249 options.
2250
2251 Also, while I will probably be interested to know the contents of your
2252 @file{.wgetrc} file, just dumping it into the debug message is probably
2253 a bad idea.  Instead, you should first try to see if the bug repeats
2254 with @file{.wgetrc} moved out of the way.  Only if it turns out that
2255 @file{.wgetrc} settings affect the bug, should you mail me the relevant
2256 parts of the file.
2257
2258 @item
2259 Please start Wget with @samp{-d} option and send the log (or the
2260 relevant parts of it).  If Wget was compiled without debug support,
2261 recompile it.  It is @emph{much} easier to trace bugs with debug support
2262 on.
2263
2264 @item
2265 If Wget has crashed, try to run it in a debugger, e.g. @code{gdb `which
2266 wget` core} and type @code{where} to get the backtrace.
2267
2268 @item
2269 Find where the bug is, fix it and send me the patches. :-)
2270 @end enumerate
2271
2272 @node Portability, Signals, Reporting Bugs, Various
2273 @section Portability
2274 @cindex portability
2275 @cindex operating systems
2276
2277 Since Wget uses GNU Autoconf for building and configuring, and avoids
2278 using ``special'' ultra--mega--cool features of any particular Unix, it
2279 should compile (and work) on all common Unix flavors.
2280
2281 Various Wget versions have been compiled and tested under many kinds of
2282 Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
2283 Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
2284 distribution directory for a comprehensive list.  If you compile it on
2285 an architecture not listed there, please let me know so I can update it.
2286
2287 Wget should also compile on the other Unix systems, not listed in
2288 @file{MACHINES}.  If it doesn't, please let me know.
2289
2290 Thanks to kind contributors, this version of Wget compiles and works on
2291 Microsoft Windows 95 and Windows NT platforms.  It has been compiled
2292 successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
2293 with Winsock as networking software.  Naturally, it is crippled of some
2294 features available on Unix, but it should work as a substitute for
2295 people stuck with Windows.  Note that the Windows port is
2296 @strong{neither tested nor maintained} by me---all questions and
2297 problems should be reported to Wget mailing list at
2298 @email{wget@@sunsite.auc.dk} where the maintainers will look at them.
2299
2300 @node Signals,  , Portability, Various
2301 @section Signals
2302 @cindex signal handling
2303 @cindex hangup
2304
2305 Since the purpose of Wget is background work, it catches the hangup
2306 signal (@code{SIGHUP}) and ignores it.  If the output was on standard
2307 output, it will be redirected to a file named @file{wget-log}.
2308 Otherwise, @code{SIGHUP} is ignored.  This is convenient when you wish
2309 to redirect the output of Wget after having started it.
2310
2311 @example
2312 $ wget http://www.ifi.uio.no/~larsi/gnus.tar.gz &
2313 $ kill -HUP %%     # Redirect the output to wget-log
2314 @end example
2315
2316 Other than that, Wget will not try to interfere with signals in any
2317 way. @kbd{C-c}, @code{kill -TERM} and @code{kill -KILL} should kill it
2318 alike.
2319
2320 @node Appendices, Copying, Various, Top
2321 @chapter Appendices
2322
2323 This chapter contains some references I consider useful, like the Robots
2324 Exclusion Standard specification, as well as a list of contributors to
2325 GNU Wget.
2326
2327 @menu
2328 * Robots::                  Wget as a WWW robot.
2329 * Security Considerations:: Security with Wget.
2330 * Contributors::            People who helped.
2331 @end menu
2332
2333 @node Robots, Security Considerations, Appendices, Appendices
2334 @section Robots
2335 @cindex robots
2336 @cindex robots.txt
2337 @cindex server maintenance
2338
2339 Since Wget is able to traverse the web, it counts as one of the Web
2340 @dfn{robots}.  Thus Wget understands @dfn{Robots Exclusion Standard}
2341 (@sc{res})---contents of @file{/robots.txt}, used by server
2342 administrators to shield parts of their systems from wanderings of Wget.
2343
2344 Norobots support is turned on only when retrieving recursively, and
2345 @emph{never} for the first page.  Thus, you may issue:
2346
2347 @example
2348 wget -r http://fly.cc.fer.hr/
2349 @end example
2350
2351 First the index of fly.cc.fer.hr will be downloaded.  If Wget finds
2352 anything worth downloading on the same host, only @emph{then} will it
2353 load the robots, and decide whether or not to load the links after all.
2354 @file{/robots.txt} is loaded only once per host.  Wget does not support
2355 the robots @code{META} tag.
2356
2357 The description of the norobots standard was written, and is maintained
2358 by Martijn Koster @email{m.koster@@webcrawler.com}.  With his
2359 permission, I contribute a (slightly modified) TeXified version of the
2360 @sc{res}.
2361
2362 @menu
2363 * Introduction to RES::
2364 * RES Format::
2365 * User-Agent Field::
2366 * Disallow Field::
2367 * Norobots Examples::
2368 @end menu
2369
2370 @node Introduction to RES, RES Format, Robots, Robots
2371 @subsection Introduction to RES
2372 @cindex norobots introduction
2373
2374 @dfn{WWW Robots} (also called @dfn{wanderers} or @dfn{spiders}) are
2375 programs that traverse many pages in the World Wide Web by recursively
2376 retrieving linked pages. For more information see the robots page.
2377
2378 In 1993 and 1994 there have been occasions where robots have visited
2379 @sc{www} servers where they weren't welcome for various
2380 reasons. Sometimes these reasons were robot specific, e.g. certain
2381 robots swamped servers with rapid-fire requests, or retrieved the same
2382 files repeatedly. In other situations robots traversed parts of @sc{www}
2383 servers that weren't suitable, e.g. very deep virtual trees, duplicated
2384 information, temporary information, or cgi-scripts with side-effects
2385 (such as voting).
2386
2387 These incidents indicated the need for established mechanisms for
2388 @sc{www} servers to indicate to robots which parts of their server
2389 should not be accessed. This standard addresses this need with an
2390 operational solution.
2391
2392 This document represents a consensus on 30 June 1994 on the robots
2393 mailing list (@code{robots@@webcrawler.com}), between the majority of
2394 robot authors and other people with an interest in robots. It has also
2395 been open for discussion on the Technical World Wide Web mailing list
2396 (@code{www-talk@@info.cern.ch}). This document is based on a previous
2397 working draft under the same title.
2398
2399 It is not an official standard backed by a standards body, or owned by
2400 any commercial organization. It is not enforced by anybody, and there
2401 no guarantee that all current and future robots will use it. Consider
2402 it a common facility the majority of robot authors offer the @sc{www}
2403 community to protect @sc{www} server against unwanted accesses by their
2404 robots.
2405
2406 The latest version of this document can be found at
2407 @url{http://info.webcrawler.com/mak/projects/robots/norobots.html}.
2408
2409 @node RES Format, User-Agent Field, Introduction to RES, Robots
2410 @subsection RES Format
2411 @cindex norobots format
2412
2413 The format and semantics of the @file{/robots.txt} file are as follows:
2414
2415 The file consists of one or more records separated by one or more blank
2416 lines (terminated by @code{CR}, @code{CR/NL}, or @code{NL}).  Each
2417 record contains lines of the form:
2418
2419 @example
2420 <field>:<optionalspace><value><optionalspace>
2421 @end example
2422
2423 The field name is case insensitive.
2424
2425 Comments can be included in file using UNIX Bourne shell conventions:
2426 the @samp{#} character is used to indicate that preceding space (if any)
2427 and the remainder of the line up to the line termination is discarded.
2428 Lines containing only a comment are discarded completely, and therefore
2429 do not indicate a record boundary.
2430
2431 The record starts with one or more User-agent lines, followed by one or
2432 more Disallow lines, as detailed below. Unrecognized headers are
2433 ignored.
2434
2435 The presence of an empty @file{/robots.txt} file has no explicit
2436 associated semantics, it will be treated as if it was not present,
2437 i.e. all robots will consider themselves welcome.
2438
2439 @node User-Agent Field, Disallow Field, RES Format, Robots
2440 @subsection User-Agent Field
2441 @cindex norobots user-agent
2442
2443 The value of this field is the name of the robot the record is
2444 describing access policy for.
2445
2446 If more than one User-agent field is present the record describes an
2447 identical access policy for more than one robot.  At least one field
2448 needs to be present per record.
2449
2450 The robot should be liberal in interpreting this field. A case
2451 insensitive substring match of the name without version information is
2452 recommended.
2453
2454 If the value is @samp{*}, the record describes the default access policy
2455 for any robot that has not matched any of the other records. It is not
2456 allowed to have multiple such records in the @file{/robots.txt} file.
2457
2458 @node Disallow Field, Norobots Examples, User-Agent Field, Robots
2459 @subsection Disallow Field
2460 @cindex norobots disallow
2461
2462 The value of this field specifies a partial @sc{url} that is not to be
2463 visited. This can be a full path, or a partial path; any @sc{url} that
2464 starts with this value will not be retrieved. For example,
2465 @w{@samp{Disallow: /help}} disallows both @samp{/help.html} and
2466 @samp{/help/index.html}, whereas @w{@samp{Disallow: /help/}} would
2467 disallow @samp{/help/index.html} but allow @samp{/help.html}.
2468
2469 Any empty value, indicates that all @sc{url}s can be retrieved. At least
2470 one Disallow field needs to be present in a record.
2471
2472 @node Norobots Examples,  , Disallow Field, Robots
2473 @subsection Norobots Examples
2474 @cindex norobots examples
2475
2476 The following example @samp{/robots.txt} file specifies that no robots
2477 should visit any @sc{url} starting with @samp{/cyberworld/map/} or
2478 @samp{/tmp/}:
2479
2480 @example
2481 # robots.txt for http://www.site.com/
2482
2483 User-agent: *
2484 Disallow: /cyberworld/map/ # This is an infinite virtual URL space
2485 Disallow: /tmp/ # these will soon disappear
2486 @end example
2487
2488 This example @samp{/robots.txt} file specifies that no robots should
2489 visit any @sc{url} starting with @samp{/cyberworld/map/}, except the
2490 robot called @samp{cybermapper}:
2491
2492 @example
2493 # robots.txt for http://www.site.com/
2494
2495 User-agent: *
2496 Disallow: /cyberworld/map/ # This is an infinite virtual URL space
2497
2498 # Cybermapper knows where to go.
2499 User-agent: cybermapper
2500 Disallow:
2501 @end example
2502
2503 This example indicates that no robots should visit this site further:
2504
2505 @example
2506 # go away
2507 User-agent: *
2508 Disallow: /
2509 @end example
2510
2511 @node Security Considerations, Contributors, Robots, Appendices
2512 @section Security Considerations
2513 @cindex security
2514
2515 When using Wget, you must be aware that it sends unencrypted passwords
2516 through the network, which may present a security problem.  Here are the
2517 main issues, and some solutions.
2518
2519 @enumerate
2520 @item
2521 The passwords on the command line are visible using @code{ps}.  If this
2522 is a problem, avoid putting passwords from the command line---e.g. you
2523 can use @file{.netrc} for this.
2524
2525 @item
2526 Using the insecure @dfn{basic} authentication scheme, unencrypted
2527 passwords are transmitted through the network routers and gateways.
2528
2529 @item
2530 The @sc{ftp} passwords are also in no way encrypted.  There is no good
2531 solution for this at the moment.
2532
2533 @item
2534 Although the ``normal'' output of Wget tries to hide the passwords,
2535 debugging logs show them, in all forms.  This problem is avoided by
2536 being careful when you send debug logs (yes, even when you send them to
2537 me).
2538 @end enumerate
2539
2540 @node Contributors,  , Security Considerations, Appendices
2541 @section Contributors
2542 @cindex contributors
2543
2544 @iftex
2545 GNU Wget was written by Hrvoje Nik@v{s}i@'{c} @email{hniksic@@iskon.hr}.
2546 @end iftex
2547 @ifinfo
2548 GNU Wget was written by Hrvoje Niksic @email{hniksic@@iskon.hr}.
2549 @end ifinfo
2550 However, its development could never have gone as far as it has, were it
2551 not for the help of many people, either with bug reports, feature
2552 proposals, patches, or letters saying ``Thanks!''.
2553
2554 Special thanks goes to the following people (no particular order):
2555
2556 @itemize @bullet
2557 @item
2558 Karsten Thygesen---donated the mailing list and the initial @sc{ftp}
2559 space.
2560
2561 @item
2562 Shawn McHorse---bug reports and patches.
2563
2564 @item
2565 Kaveh R. Ghazi---on-the-fly @code{ansi2knr}-ization.
2566
2567 @item
2568 Gordon Matzigkeit---@file{.netrc} support.
2569
2570 @item
2571 @iftex
2572 Zlatko @v{C}alu@v{s}i@'{c}, Tomislav Vujec and Dra@v{z}en
2573 Ka@v{c}ar---feature suggestions and ``philosophical'' discussions.
2574 @end iftex
2575 @ifinfo
2576 Zlatko Calusic, Tomislav Vujec and Drazen Kacar---feature suggestions
2577 and ``philosophical'' discussions.
2578 @end ifinfo
2579
2580 @item
2581 Darko Budor---initial port to Windows.
2582
2583 @item
2584 Antonio Rosella---help and suggestions, plus the Italian translation.
2585
2586 @item
2587 @iftex
2588 Tomislav Petrovi@'{c}, Mario Miko@v{c}evi@'{c}---many bug reports and
2589 suggestions.
2590 @end iftex
2591 @ifinfo
2592 Tomislav Petrovic, Mario Mikocevic---many bug reports and suggestions.
2593 @end ifinfo
2594
2595 @item
2596 @iftex
2597 Fran@,{c}ois Pinard---many thorough bug reports and discussions.
2598 @end iftex
2599 @ifinfo
2600 Francois Pinard---many thorough bug reports and discussions.
2601 @end ifinfo
2602
2603 @item
2604 Karl Eichwalder---lots of help with internationalization and other
2605 things.
2606
2607 @item
2608 Junio Hamano---donated support for Opie and @sc{http} @code{Digest}
2609 authentication.
2610
2611 @item
2612 Brian Gough---a generous donation.
2613 @end itemize
2614
2615 The following people have provided patches, bug/build reports, useful
2616 suggestions, beta testing services, fan mail and all the other things
2617 that make maintenance so much fun:
2618
2619 Tim Adam,
2620 Martin Baehr,
2621 Dieter Baron,
2622 Roger Beeman and the Gurus at Cisco,
2623 Dan Berger,
2624 Mark Boyns,
2625 John Burden,
2626 Wanderlei Cavassin,
2627 Gilles Cedoc,
2628 Tim Charron,
2629 Noel Cragg,
2630 @iftex
2631 Kristijan @v{C}onka@v{s},
2632 @end iftex
2633 @ifinfo
2634 Kristijan Conkas,
2635 @end ifinfo
2636 Andrew Deryabin,
2637 @iftex
2638 Damir D@v{z}eko,
2639 @end iftex
2640 @ifinfo
2641 Damir Dzeko,
2642 @end ifinfo
2643 Andrew Davison,
2644 Ulrich Drepper,
2645 Marc Duponcheel,
2646 @iftex
2647 Aleksandar Erkalovi@'{c},
2648 @end iftex
2649 @ifinfo
2650 Aleksandar Erkalovic,
2651 @end ifinfo
2652 Andy Eskilsson,
2653 Masashi Fujita,
2654 Howard Gayle,
2655 Marcel Gerrits,
2656 Hans Grobler,
2657 Mathieu Guillaume,
2658 Dan Harkless,
2659 Heiko Herold,
2660 Karl Heuer,
2661 HIROSE Masaaki,
2662 Gregor Hoffleit,
2663 Erik Magnus Hulthen,
2664 Richard Huveneers,
2665 Simon Josefsson,
2666 @iftex
2667 Mario Juri@'{c},
2668 @end iftex
2669 @ifinfo
2670 Mario Juric,
2671 @end ifinfo
2672 @iftex
2673 Goran Kezunovi@'{c},
2674 @end iftex
2675 @ifinfo
2676 Goran Kezunovic,
2677 @end ifinfo
2678 Robert Kleine,
2679 Fila Kolodny,
2680 Alexander Kourakos,
2681 Martin Kraemer,
2682 @tex
2683 $\Sigma\acute{\iota}\mu o\varsigma\;
2684 \Xi\varepsilon\nu\iota\tau\acute{\epsilon}\lambda\lambda\eta\varsigma$
2685 (Simos KSenitellis),
2686 @end tex
2687 @ifinfo
2688 Simos KSenitellis,
2689 @end ifinfo
2690 Hrvoje Lacko,
2691 Daniel S. Lewart,
2692 Dave Love,
2693 Jordan Mendelson,
2694 Lin Zhe Min,
2695 Charlie Negyesi,
2696 Andrew Pollock,
2697 Steve Pothier,
2698 Jan Prikryl,
2699 Marin Purgar,
2700 Keith Refson,
2701 Tobias Ringstrom,
2702 @c Texinfo doesn't grok @'{@i}, so we have to use TeX itself.
2703 @tex
2704 Juan Jos\'{e} Rodr\'{\i}gues,
2705 @end tex
2706 @ifinfo
2707 Juan Jose Rodrigues,
2708 @end ifinfo
2709 Edward J. Sabol,
2710 Heinz Salzmann,
2711 Robert Schmidt,
2712 Toomas Soome,
2713 Tage Stabell-Kulo,
2714 Sven Sternberger,
2715 Markus Strasser,
2716 Szakacsits Szabolcs,
2717 Mike Thomas,
2718 Russell Vincent,
2719 Charles G Waldman,
2720 Douglas E. Wegscheid,
2721 Jasmin Zainul,
2722 @iftex
2723 Bojan @v{Z}drnja,
2724 @end iftex
2725 @ifinfo
2726 Bojan Zdrnja,
2727 @end ifinfo
2728 Kristijan Zimmer.
2729
2730 Apologies to all who I accidentally left out, and many thanks to all the
2731 subscribers of the Wget mailing list.
2732
2733 @node Copying, Concept Index, Appendices, Top
2734 @unnumbered GNU GENERAL PUBLIC LICENSE
2735 @cindex copying
2736 @cindex GPL
2737 @center Version 2, June 1991
2738
2739 @display
2740 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
2741 675 Mass Ave, Cambridge, MA 02139, USA
2742
2743 Everyone is permitted to copy and distribute verbatim copies
2744 of this license document, but changing it is not allowed.
2745 @end display
2746
2747 @unnumberedsec Preamble
2748
2749   The licenses for most software are designed to take away your
2750 freedom to share and change it.  By contrast, the GNU General Public
2751 License is intended to guarantee your freedom to share and change free
2752 software---to make sure the software is free for all its users.  This
2753 General Public License applies to most of the Free Software
2754 Foundation's software and to any other program whose authors commit to
2755 using it.  (Some other Free Software Foundation software is covered by
2756 the GNU Library General Public License instead.)  You can apply it to
2757 your programs, too.
2758
2759   When we speak of free software, we are referring to freedom, not
2760 price.  Our General Public Licenses are designed to make sure that you
2761 have the freedom to distribute copies of free software (and charge for
2762 this service if you wish), that you receive source code or can get it
2763 if you want it, that you can change the software or use pieces of it
2764 in new free programs; and that you know you can do these things.
2765
2766   To protect your rights, we need to make restrictions that forbid
2767 anyone to deny you these rights or to ask you to surrender the rights.
2768 These restrictions translate to certain responsibilities for you if you
2769 distribute copies of the software, or if you modify it.
2770
2771   For example, if you distribute copies of such a program, whether
2772 gratis or for a fee, you must give the recipients all the rights that
2773 you have.  You must make sure that they, too, receive or can get the
2774 source code.  And you must show them these terms so they know their
2775 rights.
2776
2777   We protect your rights with two steps: (1) copyright the software, and
2778 (2) offer you this license which gives you legal permission to copy,
2779 distribute and/or modify the software.
2780
2781   Also, for each author's protection and ours, we want to make certain
2782 that everyone understands that there is no warranty for this free
2783 software.  If the software is modified by someone else and passed on, we
2784 want its recipients to know that what they have is not the original, so
2785 that any problems introduced by others will not reflect on the original
2786 authors' reputations.
2787
2788   Finally, any free program is threatened constantly by software
2789 patents.  We wish to avoid the danger that redistributors of a free
2790 program will individually obtain patent licenses, in effect making the
2791 program proprietary.  To prevent this, we have made it clear that any
2792 patent must be licensed for everyone's free use or not licensed at all.
2793
2794   The precise terms and conditions for copying, distribution and
2795 modification follow.
2796
2797 @iftex
2798 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2799 @end iftex
2800 @ifinfo
2801 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2802 @end ifinfo
2803
2804 @enumerate
2805 @item
2806 This License applies to any program or other work which contains
2807 a notice placed by the copyright holder saying it may be distributed
2808 under the terms of this General Public License.  The ``Program'', below,
2809 refers to any such program or work, and a ``work based on the Program''
2810 means either the Program or any derivative work under copyright law:
2811 that is to say, a work containing the Program or a portion of it,
2812 either verbatim or with modifications and/or translated into another
2813 language.  (Hereinafter, translation is included without limitation in
2814 the term ``modification''.)  Each licensee is addressed as ``you''.
2815
2816 Activities other than copying, distribution and modification are not
2817 covered by this License; they are outside its scope.  The act of
2818 running the Program is not restricted, and the output from the Program
2819 is covered only if its contents constitute a work based on the
2820 Program (independent of having been made by running the Program).
2821 Whether that is true depends on what the Program does.
2822
2823 @item
2824 You may copy and distribute verbatim copies of the Program's
2825 source code as you receive it, in any medium, provided that you
2826 conspicuously and appropriately publish on each copy an appropriate
2827 copyright notice and disclaimer of warranty; keep intact all the
2828 notices that refer to this License and to the absence of any warranty;
2829 and give any other recipients of the Program a copy of this License
2830 along with the Program.
2831
2832 You may charge a fee for the physical act of transferring a copy, and
2833 you may at your option offer warranty protection in exchange for a fee.
2834
2835 @item
2836 You may modify your copy or copies of the Program or any portion
2837 of it, thus forming a work based on the Program, and copy and
2838 distribute such modifications or work under the terms of Section 1
2839 above, provided that you also meet all of these conditions:
2840
2841 @enumerate a
2842 @item
2843 You must cause the modified files to carry prominent notices
2844 stating that you changed the files and the date of any change.
2845
2846 @item
2847 You must cause any work that you distribute or publish, that in
2848 whole or in part contains or is derived from the Program or any
2849 part thereof, to be licensed as a whole at no charge to all third
2850 parties under the terms of this License.
2851
2852 @item
2853 If the modified program normally reads commands interactively
2854 when run, you must cause it, when started running for such
2855 interactive use in the most ordinary way, to print or display an
2856 announcement including an appropriate copyright notice and a
2857 notice that there is no warranty (or else, saying that you provide
2858 a warranty) and that users may redistribute the program under
2859 these conditions, and telling the user how to view a copy of this
2860 License.  (Exception: if the Program itself is interactive but
2861 does not normally print such an announcement, your work based on
2862 the Program is not required to print an announcement.)
2863 @end enumerate
2864
2865 These requirements apply to the modified work as a whole.  If
2866 identifiable sections of that work are not derived from the Program,
2867 and can be reasonably considered independent and separate works in
2868 themselves, then this License, and its terms, do not apply to those
2869 sections when you distribute them as separate works.  But when you
2870 distribute the same sections as part of a whole which is a work based
2871 on the Program, the distribution of the whole must be on the terms of
2872 this License, whose permissions for other licensees extend to the
2873 entire whole, and thus to each and every part regardless of who wrote it.
2874
2875 Thus, it is not the intent of this section to claim rights or contest
2876 your rights to work written entirely by you; rather, the intent is to
2877 exercise the right to control the distribution of derivative or
2878 collective works based on the Program.
2879
2880 In addition, mere aggregation of another work not based on the Program
2881 with the Program (or with a work based on the Program) on a volume of
2882 a storage or distribution medium does not bring the other work under
2883 the scope of this License.
2884
2885 @item
2886 You may copy and distribute the Program (or a work based on it,
2887 under Section 2) in object code or executable form under the terms of
2888 Sections 1 and 2 above provided that you also do one of the following:
2889
2890 @enumerate a
2891 @item
2892 Accompany it with the complete corresponding machine-readable
2893 source code, which must be distributed under the terms of Sections
2894 1 and 2 above on a medium customarily used for software interchange; or,
2895
2896 @item
2897 Accompany it with a written offer, valid for at least three
2898 years, to give any third party, for a charge no more than your
2899 cost of physically performing source distribution, a complete
2900 machine-readable copy of the corresponding source code, to be
2901 distributed under the terms of Sections 1 and 2 above on a medium
2902 customarily used for software interchange; or,
2903
2904 @item
2905 Accompany it with the information you received as to the offer
2906 to distribute corresponding source code.  (This alternative is
2907 allowed only for noncommercial distribution and only if you
2908 received the program in object code or executable form with such
2909 an offer, in accord with Subsection b above.)
2910 @end enumerate
2911
2912 The source code for a work means the preferred form of the work for
2913 making modifications to it.  For an executable work, complete source
2914 code means all the source code for all modules it contains, plus any
2915 associated interface definition files, plus the scripts used to
2916 control compilation and installation of the executable.  However, as a
2917 special exception, the source code distributed need not include
2918 anything that is normally distributed (in either source or binary
2919 form) with the major components (compiler, kernel, and so on) of the
2920 operating system on which the executable runs, unless that component
2921 itself accompanies the executable.
2922
2923 If distribution of executable or object code is made by offering
2924 access to copy from a designated place, then offering equivalent
2925 access to copy the source code from the same place counts as
2926 distribution of the source code, even though third parties are not
2927 compelled to copy the source along with the object code.
2928
2929 @item
2930 You may not copy, modify, sublicense, or distribute the Program
2931 except as expressly provided under this License.  Any attempt
2932 otherwise to copy, modify, sublicense or distribute the Program is
2933 void, and will automatically terminate your rights under this License.
2934 However, parties who have received copies, or rights, from you under
2935 this License will not have their licenses terminated so long as such
2936 parties remain in full compliance.
2937
2938 @item
2939 You are not required to accept this License, since you have not
2940 signed it.  However, nothing else grants you permission to modify or
2941 distribute the Program or its derivative works.  These actions are
2942 prohibited by law if you do not accept this License.  Therefore, by
2943 modifying or distributing the Program (or any work based on the
2944 Program), you indicate your acceptance of this License to do so, and
2945 all its terms and conditions for copying, distributing or modifying
2946 the Program or works based on it.
2947
2948 @item
2949 Each time you redistribute the Program (or any work based on the
2950 Program), the recipient automatically receives a license from the
2951 original licensor to copy, distribute or modify the Program subject to
2952 these terms and conditions.  You may not impose any further
2953 restrictions on the recipients' exercise of the rights granted herein.
2954 You are not responsible for enforcing compliance by third parties to
2955 this License.
2956
2957 @item
2958 If, as a consequence of a court judgment or allegation of patent
2959 infringement or for any other reason (not limited to patent issues),
2960 conditions are imposed on you (whether by court order, agreement or
2961 otherwise) that contradict the conditions of this License, they do not
2962 excuse you from the conditions of this License.  If you cannot
2963 distribute so as to satisfy simultaneously your obligations under this
2964 License and any other pertinent obligations, then as a consequence you
2965 may not distribute the Program at all.  For example, if a patent
2966 license would not permit royalty-free redistribution of the Program by
2967 all those who receive copies directly or indirectly through you, then
2968 the only way you could satisfy both it and this License would be to
2969 refrain entirely from distribution of the Program.
2970
2971 If any portion of this section is held invalid or unenforceable under
2972 any particular circumstance, the balance of the section is intended to
2973 apply and the section as a whole is intended to apply in other
2974 circumstances.
2975
2976 It is not the purpose of this section to induce you to infringe any
2977 patents or other property right claims or to contest validity of any
2978 such claims; this section has the sole purpose of protecting the
2979 integrity of the free software distribution system, which is
2980 implemented by public license practices.  Many people have made
2981 generous contributions to the wide range of software distributed
2982 through that system in reliance on consistent application of that
2983 system; it is up to the author/donor to decide if he or she is willing
2984 to distribute software through any other system and a licensee cannot
2985 impose that choice.
2986
2987 This section is intended to make thoroughly clear what is believed to
2988 be a consequence of the rest of this License.
2989
2990 @item
2991 If the distribution and/or use of the Program is restricted in
2992 certain countries either by patents or by copyrighted interfaces, the
2993 original copyright holder who places the Program under this License
2994 may add an explicit geographical distribution limitation excluding
2995 those countries, so that distribution is permitted only in or among
2996 countries not thus excluded.  In such case, this License incorporates
2997 the limitation as if written in the body of this License.
2998
2999 @item
3000 The Free Software Foundation may publish revised and/or new versions
3001 of the General Public License from time to time.  Such new versions will
3002 be similar in spirit to the present version, but may differ in detail to
3003 address new problems or concerns.
3004
3005 Each version is given a distinguishing version number.  If the Program
3006 specifies a version number of this License which applies to it and ``any
3007 later version'', you have the option of following the terms and conditions
3008 either of that version or of any later version published by the Free
3009 Software Foundation.  If the Program does not specify a version number of
3010 this License, you may choose any version ever published by the Free Software
3011 Foundation.
3012
3013 @item
3014 If you wish to incorporate parts of the Program into other free
3015 programs whose distribution conditions are different, write to the author
3016 to ask for permission.  For software which is copyrighted by the Free
3017 Software Foundation, write to the Free Software Foundation; we sometimes
3018 make exceptions for this.  Our decision will be guided by the two goals
3019 of preserving the free status of all derivatives of our free software and
3020 of promoting the sharing and reuse of software generally.
3021
3022 @iftex
3023 @heading NO WARRANTY
3024 @end iftex
3025 @ifinfo
3026 @center NO WARRANTY
3027 @end ifinfo
3028 @cindex no warranty
3029
3030 @item
3031 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
3032 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
3033 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
3034 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
3035 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3036 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
3037 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
3038 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
3039 REPAIR OR CORRECTION.
3040
3041 @item
3042 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3043 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
3044 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3045 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
3046 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
3047 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
3048 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3049 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
3050 POSSIBILITY OF SUCH DAMAGES.
3051 @end enumerate
3052
3053 @iftex
3054 @heading END OF TERMS AND CONDITIONS
3055 @end iftex
3056 @ifinfo
3057 @center END OF TERMS AND CONDITIONS
3058 @end ifinfo
3059
3060 @page
3061 @unnumberedsec How to Apply These Terms to Your New Programs
3062
3063   If you develop a new program, and you want it to be of the greatest
3064 possible use to the public, the best way to achieve this is to make it
3065 free software which everyone can redistribute and change under these terms.
3066
3067   To do so, attach the following notices to the program.  It is safest
3068 to attach them to the start of each source file to most effectively
3069 convey the exclusion of warranty; and each file should have at least
3070 the ``copyright'' line and a pointer to where the full notice is found.
3071
3072 @smallexample
3073 @var{one line to give the program's name and an idea of what it does.}
3074 Copyright (C) 19@var{yy}  @var{name of author}
3075
3076 This program is free software; you can redistribute it and/or
3077 modify it under the terms of the GNU General Public License
3078 as published by the Free Software Foundation; either version 2
3079 of the License, or (at your option) any later version.
3080
3081 This program is distributed in the hope that it will be useful,
3082 but WITHOUT ANY WARRANTY; without even the implied warranty of
3083 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3084 GNU General Public License for more details.
3085
3086 You should have received a copy of the GNU General Public License
3087 along with this program; if not, write to the Free Software
3088 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
3089 @end smallexample
3090
3091 Also add information on how to contact you by electronic and paper mail.
3092
3093 If the program is interactive, make it output a short notice like this
3094 when it starts in an interactive mode:
3095
3096 @smallexample
3097 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3098 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
3099 type `show w'.  This is free software, and you are welcome
3100 to redistribute it under certain conditions; type `show c'
3101 for details.
3102 @end smallexample
3103
3104 The hypothetical commands @samp{show w} and @samp{show c} should show
3105 the appropriate parts of the General Public License.  Of course, the
3106 commands you use may be called something other than @samp{show w} and
3107 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3108 suits your program.
3109
3110 You should also get your employer (if you work as a programmer) or your
3111 school, if any, to sign a ``copyright disclaimer'' for the program, if
3112 necessary.  Here is a sample; alter the names:
3113
3114 @smallexample
3115 @group
3116 Yoyodyne, Inc., hereby disclaims all copyright
3117 interest in the program `Gnomovision'
3118 (which makes passes at compilers) written
3119 by James Hacker.
3120
3121 @var{signature of Ty Coon}, 1 April 1989
3122 Ty Coon, President of Vice
3123 @end group
3124 @end smallexample
3125
3126 This General Public License does not permit incorporating your program into
3127 proprietary programs.  If your program is a subroutine library, you may
3128 consider it more useful to permit linking proprietary applications with the
3129 library.  If this is what you want to do, use the GNU Library General
3130 Public License instead of this License.
3131
3132 @node Concept Index,  , Copying, Top
3133 @unnumbered Concept Index
3134 @printindex cp
3135
3136 @contents
3137
3138 @bye