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