2 .\" Copyright (c) 2000 Dag-Erling Coïdan Smørgrav
3 .\" All rights reserved.
4 .\" Portions Copyright (c) 1999 Massachusetts Institute of Technology; used
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer
12 .\" in this position and unchanged.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. The name of the author may not be used to endorse or promote products
17 .\" derived from this software without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 .\" $FreeBSD: src/usr.bin/fetch/fetch.1,v 1.33.2.12 2003/06/06 06:48:42 des Exp $
31 .\" $DragonFly: src/usr.bin/fetch/fetch.1,v 1.2 2003/06/17 04:29:26 dillon Exp $
38 .Nd retrieve a file by Uniform Resource Locator
41 .Op Fl 146AFMPRUadlmnpqrsv
55 utility provides a command-line interface to the
58 Its purpose is to retrieve the file(s) pointed to by the URL(s) on the
61 The following options are available:
64 Stop and return exit code 0 at the first successfully retrieved file.
68 to use IPv4 addresses only.
72 to use IPv6 addresses only.
74 Do not automatically follow ``temporary'' (302) redirects.
75 Some broken Web sites will return a redirect instead of a not-found
76 error when the requested object does not exist.
78 Automatically retry the transfer upon soft failures.
80 Specify the read buffer size in bytes.
81 The default is 4096 bytes.
82 Attempts to set a buffer size lower than this will be silently
84 The number of reads actually performed is reported at verbosity level
85 two or higher (see the
89 The file to retrieve is in directory
92 This option is deprecated and is provided for backward compatibility
95 Use a direct connection even if a proxy is configured.
97 In combination with the
99 flag, forces a restart even if the local and remote files have
100 different modification times.
104 The file to retrieve is named
107 This option is deprecated and is provided for backward compatibility
110 The file to retrieve is located on the host
112 This option is deprecated and is provided for backward compatibility
115 If the target is a file-scheme URL, make a symbolic link to the target
116 rather than trying to copy it.
119 Mirror mode: if the file already exists locally and has the same size
120 and modification time as the remote file, it will not be fetched.
125 flags are mutually exclusive.
131 to look up login names and passwords for FTP sites.
134 for a description of the file format.
135 This feature is experimental.
137 Don't preserve the modification time of the transferred file.
139 Set the output file name to
141 By default, a ``pathname'' is extracted from the specified URI, and
142 its basename is used as the name of the output file.
147 indicates that results are to be directed to the standard output.
151 This is useful if you are behind a firewall which blocks incoming
155 seems to hang when retrieving FTP URLs.
159 The output files are precious, and should not be deleted under any
160 circumstances, even if the transfer failed or was incomplete.
162 Restart a previously interrupted transfer.
167 flags are mutually exclusive.
169 Require the file size reported by the server to match the specified
171 If it does not, a message is printed and the file is not fetched.
172 If the server does not support reporting file sizes, this option is
173 ignored and the file is fetched unconditionally.
175 Print the size in bytes of each requested file, without fetching it.
179 Overrides the environment variables
183 for HTTP transfers if set.
185 When using passive FTP, allocate the port for the data connection from
186 the low (default) port range.
189 for details on how to specify which port range this corresponds to.
191 Increase verbosity level.
195 flag is specified, wait this many seconds between successive retries.
206 the current transfer rate statistics will be written to the
207 standard error output, in the same format as the standard completion
212 command returns zero on success, or one on failure.
213 If multiple URLs are listed on the command line,
215 will attempt to retrieve them each of them in turn, and return zero
216 only if they were all successfully retrieved.
218 .Bl -tag -width HTTP_TIMEOUT
220 maximum time, in seconds, to wait before aborting an
224 maximum time, in seconds, to wait before aborting an
229 All environment variables mentioned in the documentation for the
231 library are supported.
240 This implementation first appeared in
244 The original implementation of
247 .An Jean-Marc Zucconi .
248 It was extensively re-worked for
251 .An Garrett Wollman ,
252 and later completely rewritten to use the
255 .An Dag-Erling Sm\(/orgrav .
261 options are no longer supported and will generate warnings.
262 They were workarounds for bugs in other OSes which this implementation
265 One cannot both use the
270 options and specify URLs on the command line.