]> sjero.net Git - wget/blobdiff - doc/wget.texi
[svn] Added string.c module. Updated copyright information and added names of new...
[wget] / doc / wget.texi
index ab62760bb05cf44c86b7f64a9644e307ff912c9d..abe821c5eb24303bcf608c83816573af73897a17 100644 (file)
@@ -3,7 +3,7 @@
 @c %**start of header
 @setfilename wget.info
 @include version.texi
-@set UPDATED May 2003
+@set UPDATED Jan 2005
 @settitle GNU Wget @value{VERSION} Manual
 @c Disable the monstrous rectangles beside overfull hbox-es.
 @finalout
@@ -31,8 +31,8 @@ This file documents the the GNU Wget utility for downloading network
 data.
 
 @c man begin COPYRIGHT
-Copyright @copyright{} 1996, 1997, 1998, 2000, 2001, 2002, 2003 Free
-Software Foundation, Inc.
+Copyright @copyright{} 1996, 1997, 1998, 2000, 2001, 2002, 2003, 2004, 2005
+Free Software Foundation, Inc.
 
 Permission is granted to make and distribute verbatim copies of
 this manual provided the copyright notice and this permission notice
@@ -71,8 +71,8 @@ GNU Info entry for @file{wget}.
 
 @page
 @vskip 0pt plus 1filll
-Copyright @copyright{} 1996, 1997, 1998, 2000, 2001, 2003 Free Software
-Foundation, Inc.
+Copyright @copyright{} 1996, 1997, 1998, 2000, 2001, 2003, 2004, 2005,
+Free Software Foundation, Inc.
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.2 or
@@ -90,8 +90,8 @@ entitled ``GNU Free Documentation License''.
 This manual documents version @value{VERSION} of GNU Wget, the freely
 available utility for network downloads.
 
-Copyright @copyright{} 1996, 1997, 1998, 2000, 2001, 2003 Free Software
-Foundation, Inc.
+Copyright @copyright{} 1996, 1997, 1998, 2000, 2001, 2003, 2004, 2005
+Free Software Foundation, Inc.
 
 @menu
 * Overview::            Features of Wget.
@@ -407,7 +407,9 @@ specified via the @samp{-o}, output is redirected to @file{wget-log}.
 Execute @var{command} as if it were a part of @file{.wgetrc}
 (@pxref{Startup File}).  A command thus invoked will be executed
 @emph{after} the commands in @file{.wgetrc}, thus taking precedence over
-them.
+them.  If you need to specify more than one wgetrc command, use multiple
+instances of @samp{-e}.
+
 @end table
 
 @node Logging and Input File Options
@@ -516,9 +518,11 @@ which are not retried.
 @itemx --output-document=@var{file}
 The documents will not be written to the appropriate files, but all will
 be concatenated together and written to @var{file}.  If @var{file}
-already exists, it will be overwritten.  If the @var{file} is @samp{-},
-the documents will be written to standard output.  Including this option
-automatically sets the number of tries to 1.
+already exists, it will be overwritten.  If the @var{file} is @samp{-}, 
+the documents will be written to standard output (disabling @samp{-k}).
+Note that a combination with @samp{-k} is only well-defined for downloading
+a single document.
 
 @cindex clobbering, file
 @cindex downloading multiple times
@@ -891,6 +895,16 @@ Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
 directories beginning with @file{fly.srk.fer.hr/}.  This option disables
 such behavior.
 
+@item --protocol-directories
+Use the protocol name as a directory component of local file names.  For
+example, with this option, @samp{wget -r http://@var{host}} will save to
+@samp{http/@var{host}/...} rather than just to @samp{@var{host}/...}.
+
+Disable generation of host-prefixed directories.  By default, invoking
+Wget with @samp{-r http://fly.srk.fer.hr/} will create a structure of
+directories beginning with @file{fly.srk.fer.hr/}.  This option disables
+such behavior.
+
 @cindex cut directories
 @item --cut-dirs=@var{number}
 Ignore @var{number} directory components.  This is useful for getting a
@@ -1205,8 +1219,7 @@ wget --load-cookies cookies.txt \
 
 @table @samp
 @cindex .listing files, removing
-@item -nr
-@itemx --dont-remove-listing
+@item --no-remove-listing
 Don't remove the temporary @file{.listing} files generated by @sc{ftp}
 retrievals.  Normally, these files contain the raw directory listings
 received from @sc{ftp} servers.  Not removing them can be useful for
@@ -1274,6 +1287,19 @@ Note that when retrieving a file (not a directory) because it was
 specified on the command-line, rather than because it was recursed to,
 this option has no effect.  Symbolic links are always traversed in this
 case.
+
+@cindex Keep-Alive, turning off
+@cindex Persistent Connections, disabling
+@item --no-http-keep-alive
+Turn off the ``keep-alive'' feature for HTTP downloads.  Normally, Wget
+asks the server to keep the connection open so that, when you download
+more than one document from the same server, they get transferred over
+the same TCP connection.  This saves time and at the same time reduces
+the load on the server.
+
+This option is useful when, for some reason, persistent (keep-alive)
+connections don't work for you, for example due to a server bug or due
+to the inability of server-side scripts to cope with the connections.
 @end table
 
 @node Recursive Retrieval Options
@@ -1366,7 +1392,7 @@ Internals}).
 Turn on options suitable for mirroring.  This option turns on recursion
 and time-stamping, sets infinite recursion depth and keeps @sc{ftp}
 directory listings.  It is currently equivalent to
-@samp{-r -N -l inf -nr}.
+@samp{-r -N -l inf --no-remove-listing}.
 
 @cindex page requisites
 @cindex required images, downloading
@@ -2162,8 +2188,9 @@ hostnames or dotted-quad IP addresses.  @var{n} can be any positive
 integer, or @samp{inf} for infinity, where appropriate.  @var{string}
 values can be any non-empty string.
 
-Most of these commands have command-line equivalents (@pxref{Invoking}),
-though some of the more obscure or rarely used ones do not.
+Most of these commands have direct command-line equivalents.  Also, any
+wgetrc command can be specified on the command line using the
+@samp{--execute} switch (@pxref{Basic Startup Options}.)
 
 @table @asis
 @item accept/reject = @var{string}
@@ -2289,6 +2316,10 @@ Add a @samp{.html} extension to @samp{text/html} or
 @samp{application/xhtml+xml} files without it, like
 @samp{-E}.
 
+@item http_keep_alive = on/off
+Turn the keep-alive feature on or off (defaults to on).  The same as
+`--http-keep-alive'.
+
 @item http_passwd = @var{string}
 Set @sc{http} password.
 
@@ -2377,6 +2408,10 @@ Use POST as the method for all HTTP requests and send the contents of
 Set the type of the progress indicator.  Legal types are ``dot'' and
 ``bar''.
 
+@item protocol_directories = on/off
+When set, use the protocol name as a directory component of local file
+names.  The same as @samp{--protocol-directories}.
+
 @item proxy_user = @var{string}
 Set proxy authentication user name to @var{string}, like @samp{--proxy-user}.
 
@@ -2415,7 +2450,7 @@ Links}).
 
 @item remove_listing = on/off
 If set to on, remove @sc{ftp} listings downloaded by Wget.  Setting it
-to off is the same as @samp{-nr}.
+to off is the same as @samp{--no-remove-listing}.
 
 @item restrict_file_names = unix/windows
 Restrict the file names generated by Wget from URLs.  See
@@ -2908,28 +2943,31 @@ wget` core} and type @code{where} to get the backtrace.
 @cindex portability
 @cindex operating systems
 
-Since Wget uses GNU Autoconf for building and configuring, and avoids
-using ``special'' ultra--mega--cool features of any particular Unix, it
-should compile (and work) on all common Unix flavors.
+Like all GNU software, Wget works on the GNU system.  However, since it
+uses GNU Autoconf for building and configuring, and mostly avoids using
+``special'' features of any particular Unix, it should compile (and
+work) on all common Unix flavors.
 
 Various Wget versions have been compiled and tested under many kinds of
-Unix systems, including Solaris, Linux, SunOS, OSF (aka Digital Unix),
-Ultrix, *BSD, IRIX, and others; refer to the file @file{MACHINES} in the
-distribution directory for a comprehensive list.  If you compile it on
-an architecture not listed there, please let me know so I can update it.
+Unix systems, including Solaris, GNU/Linux, SunOS, OSF (aka Digital Unix
+or Tru64), Ultrix, *BSD, IRIX, AIX, and others; refer to the file
+@file{MACHINES} in the distribution directory for a comprehensive list.
+If you compile it on an architecture not listed there, please let me
+know so I can update it.
 
 Wget should also compile on the other Unix systems, not listed in
 @file{MACHINES}.  If it doesn't, please let me know.
 
 Thanks to kind contributors, this version of Wget compiles and works on
 Microsoft Windows 95 and Windows NT platforms.  It has been compiled
-successfully using MS Visual C++ 4.0, Watcom, and Borland C compilers,
+successfully using MS Visual C++ 6.0, Watcom, and Borland C compilers,
 with Winsock as networking software.  Naturally, it is crippled of some
 features available on Unix, but it should work as a substitute for
 people stuck with Windows.  Note that the Windows port is
 @strong{neither tested nor maintained} by me---all questions and
-problems should be reported to Wget mailing list at
-@email{wget@@sunsite.dk} where the maintainers will look at them.
+problems in Windows usage should be reported to Wget mailing list at
+@email{wget@@sunsite.dk} where the volunteers who maintain the
+Windows-related features might look at them.
 
 @node Signals
 @section Signals
@@ -3053,12 +3091,12 @@ through the network, which may present a security problem.  Here are the
 main issues, and some solutions.
 
 @enumerate
-@item The passwords on the command line are visible using @code{ps}.
-The best way around it is to use @code{wget -i -} and feed the @sc{url}s
-to Wget's standard input, each on a separate line, terminated by
-@kbd{C-d}.  Another workaround is to use @file{.netrc} to store
-passwords; however, storing unencrypted passwords is also considered a
-security risk.
+@item
+The passwords on the command line are visible using @code{ps}.  The best
+way around it is to use @code{wget -i -} and feed the @sc{url}s to
+Wget's standard input, each on a separate line, terminated by @kbd{C-d}.
+Another workaround is to use @file{.netrc} to store passwords; however,
+storing unencrypted passwords is also considered a security risk.
 
 @item
 Using the insecure @dfn{basic} authentication scheme, unencrypted
@@ -3165,6 +3203,7 @@ Dieter Baron,
 Roger Beeman,
 Dan Berger,
 T. Bharath,
+Christian Biere,
 Paul Bludov,
 Daniel Bodea,
 Mark Boyns,
@@ -3200,6 +3239,7 @@ Aleksandar Erkalovic,
 @end ifnottex
 Andy Eskilsson,
 Christian Fraenkel,
+David Fritz,
 Masashi Fujita,
 Howard Gayle,
 Marcel Gerrits,
@@ -3297,6 +3337,7 @@ Maciej W. Rozycki,
 Edward J. Sabol,
 Heinz Salzmann,
 Robert Schmidt,
+Nicolas Schodet,
 Andreas Schwab,
 Chris Seawood,
 Toomas Soome,
@@ -3320,7 +3361,12 @@ Bojan @v{Z}drnja,
 @ifnottex
 Bojan Zdrnja,
 @end ifnottex
-Kristijan Zimmer.
+Kristijan Zimmer,
+YAMAZAKI Makoto,
+Leonid Petrov,
+Hans-Andreas Engel,
+Ulf Harnhammar,
+Jan Minar.
 
 Apologies to all who I accidentally left out, and many thanks to all the
 subscribers of the Wget mailing list.
@@ -3734,7 +3780,7 @@ the ``copyright'' line and a pointer to where the full notice is found.
 
 @smallexample
 @var{one line to give the program's name and an idea of what it does.}
-Copyright (C) 19@var{yy}  @var{name of author}
+Copyright (C) 20@var{yy}  @var{name of author}
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
@@ -3757,7 +3803,7 @@ If the program is interactive, make it output a short notice like this
 when it starts in an interactive mode:
 
 @smallexample
-Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
+Gnomovision version 69, Copyright (C) 20@var{yy} @var{name of author}
 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
 type `show w'.  This is free software, and you are welcome
 to redistribute it under certain conditions; type `show c'