-
Copyright (c) 2000 Dag-Erling Co�dan Sm�rgrav
All rights reserved.
Portions Copyright (c) 1999 Massachusetts Institute of Technology; used
by permission.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer
in this position and unchanged.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

$FreeBSD: head/usr.bin/fetch/fetch.1 68718 2000-11-14 13:19:26Z ru $

.Dd June 28, 2000 .Dt FETCH 1 .Os .Sh NAME .Nm fetch .Nd retrieve a file by Uniform Resource Locator .Sh SYNOPSIS .Nm .Op Fl 146AFHMPRadlmnpqrsv .Op Fl B Ar bytes .Op Fl S Ar bytes .Op Fl T Ar seconds .Op Fl o Ar file .Op Fl w Ar seconds .Op Fl h Ar host .Op Fl c Ar dir .Op Fl f Ar file .Op Ar URL ... .Sh DESCRIPTION .Nm Fetch provides a command-line interface to the .Xr fetch 3 library. Its purpose is to retrieve the file(s) pointed to by the URL(s) on the command line.

p The following options are available: l -tag -width Fl t Fl 1 Stop and return exit code 0 at the first successfully retrieved file. t Fl 4 Forces .Nm to use IPv4 addresses only. t Fl 6 Forces .Nm to use IPv6 addresses only. t Fl A Do not automatically follow ``temporary'' (302) redirects. Some broken Web sites will return a redirect instead of a not-found error when the requested object does not exist. t Fl a Automatically retry the transfer upon soft failures. t Fl B Ar bytes Specify the read buffer size in bytes. The default is 4096 bytes. Attempts to set a buffer size lower than this will be silently ignored. The number of reads actually performed is reported at verbosity level two or higher (see the .Fl v flag). t Fl c Ar dir The file to retrieve is in directory .Ar dir on the remote host. This option is deprecated and is provided for backward compatibility only. t Fl d Use a direct connection even if a proxy is configured. t Fl F In combination with the .Fl r flag, forces a restart even if the local and remote files have different modification times. t Fl f Ar file The file to retrieve is named .Ar file on the remote host. This option is deprecated and is provided for backward compatibility only. t Fl H When using passive FTP, allocate a high port for the data connection. See .Xr ip 4 for details on how to specify which port range this corresponds to. t Fl h Ar host The file to retrieve is located on the host .Ar host . This option is deprecated and is provided for backward compatibility only. t Fl l If the target is a file-scheme URL, make a symbolic link to the target rather than trying to copy it. t Fl M t Fl m Mirror mode: if the file already exists locally and has the same size and modification time as the remote file, it will not be fetched. Note that the .Fl m and .Fl r flags are mutually exclusive. t Fl n Don't preserve the modification time of the transferred file. t Fl o Ar file Set the output file name to .Ar file . By default, a ``pathname'' is extracted from the specified URI, and its basename is used as the name of the output file. A .Ar file argument of .Sq Li - indicates that results are to be directed to the standard output. t Fl P t Fl p Use passive FTP. This is useful if you are behind a firewall which blocks incoming connections. Try this flag if .Nm seems to hang when retrieving FTP URLs. t Fl q Quiet mode. t Fl R The output files are precious, and should not be deleted under any circumstances, even if the transfer failed or was incomplete. t Fl r Restart a previously interrupted transfer. Note that the .Fl m and .Fl r flags are mutually exclusive. t Fl S Ar bytes Require the file size reported by the server to match the specified value. If it does not, a message is printed and the file is not fetched. If the server does not support reporting file sizes, this option is ignored and the file is fetched unconditionally. t Fl s Print the size in bytes of each requested file, without fetching it. t Fl T Ar seconds Set timeout value to .Ar seconds. Overrides the environment variables .Ev FTP_TIMEOUT for FTP transfers or .Ev HTTP_TIMEOUT for HTTP transfers if set. t Fl v Increase verbosity level. t Fl w Ar seconds When the .Fl a flag is specified, wait this many seconds between successive retries. .El .Sh DIAGNOSTICS The .Nm command returns zero on success, or one on failure. If multiple URLs are listed on the command line, .Nm will attempt to retrieve them each of them in turn, and return zero only if they were all successfully retrieved. .Sh ENVIRONMENT l -tag -width FTP_PASSIVE_MODE -offset indent t Ev FTP_TIMEOUT maximum time, in seconds, to wait before aborting an .Tn FTP connection. t Ev HTTP_TIMEOUT maximum time, in seconds, to wait before aborting an .Tn HTTP connection. .El

p All environment variables mentioned in the documentation for the .Xr fetch 3 library are supported. .Sh SEE ALSO .Xr fetch 3 .Sh HISTORY The .Nm command appeared in .Fx 2.1.5 . This implementation first appeared in .Fx 4.1 . .Sh AUTHORS The original implementation of .Nm was done by .An Jean-Marc Zucconi . It was extensively re-worked for .Fx 2.2 by .An Garrett Wollman , and later completely rewritten to use the .Xr fetch 3 library by .An Dag-Erling Sm\(/orgrav . .Sh NOTES The .Fl b and .Fl t options are no longer supported and will generate warnings. They were workarounds for bugs in other OSes which this implementation does not trigger.

p One cannot both use the .Fl h , .Fl c and .Fl f options and specify URLs on the command line.