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