2 .\" Copyright (c) 2000-2004 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.
37 .Nd retrieve a file by Uniform Resource Locator
40 .Op Fl 146AFMPRUadlmnpqrsv
54 utility provides a command-line interface to the
57 Its purpose is to retrieve the file(s) pointed to by the URL(s) on the
60 The following options are available:
63 Stop and return exit code 0 at the first successfully retrieved file.
67 to use IPv4 addresses only.
71 to use IPv6 addresses only.
73 Do not automatically follow ``temporary'' (302) redirects.
74 Some broken Web sites will return a redirect instead of a not-found
75 error when the requested object does not exist.
77 Automatically retry the transfer upon soft failures.
79 Specify the read buffer size in bytes.
80 The default is 4096 bytes.
81 Attempts to set a buffer size lower than this will be silently
83 The number of reads actually performed is reported at verbosity level
84 two or higher (see the
88 The file to retrieve is in directory
91 This option is deprecated and is provided for backward compatibility
94 Use a direct connection even if a proxy is configured.
96 In combination with the
98 flag, forces a restart even if the local and remote files have
99 different modification times.
103 The file to retrieve is named
106 This option is deprecated and is provided for backward compatibility
109 The file to retrieve is located on the host
111 This option is deprecated and is provided for backward compatibility
114 If the target is a file-scheme URL, make a symbolic link to the target
115 rather than trying to copy it.
118 Mirror mode: if the file already exists locally and has the same size
119 and modification time as the remote file, it will not be fetched.
124 flags are mutually exclusive.
130 to look up login names and passwords for FTP sites.
133 for a description of the file format.
134 This feature is experimental.
136 Don't preserve the modification time of the transferred file.
138 Set the output file name to
140 By default, a ``pathname'' is extracted from the specified URI, and
141 its basename is used as the name of the output file.
146 indicates that results are to be directed to the standard output.
149 argument is a directory, fetched file(s) will be placed within the
150 directory, with name(s) selected as in the default behaviour.
154 This is useful if you are behind a firewall which blocks incoming
158 seems to hang when retrieving FTP URLs.
162 The output files are precious, and should not be deleted under any
163 circumstances, even if the transfer failed or was incomplete.
165 Restart a previously interrupted transfer.
170 flags are mutually exclusive.
172 Require the file size reported by the server to match the specified
174 If it does not, a message is printed and the file is not fetched.
175 If the server does not support reporting file sizes, this option is
176 ignored and the file is fetched unconditionally.
178 Print the size in bytes of each requested file, without fetching it.
182 Overrides the environment variables
186 for HTTP transfers if set.
188 When using passive FTP, allocate the port for the data connection from
189 the low (default) port range.
192 for details on how to specify which port range this corresponds to.
194 Increase verbosity level.
198 flag is specified, wait this many seconds between successive retries.
209 the current transfer rate statistics will be written to the
210 standard error output, in the same format as the standard completion
215 command returns zero on success, or one on failure.
216 If multiple URLs are listed on the command line,
218 will attempt to retrieve them each of them in turn, and return zero
219 only if they were all successfully retrieved.
221 .Bl -tag -width HTTP_TIMEOUT
223 maximum time, in seconds, to wait before aborting an FTP connection.
225 maximum time, in seconds, to wait before aborting an HTTP connection.
228 All environment variables mentioned in the documentation for the
230 library are supported.
231 A number of these are quite important to the proper operation of
233 you are strongly encouraged to read
243 This implementation first appeared in
247 The original implementation of
250 .An Jean-Marc Zucconi Aq jmz@FreeBSD.org .
251 It was extensively re-worked for
254 .An Garrett Wollman Aq wollman@FreeBSD.org ,
255 and later completely rewritten to use the
258 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .
264 options are no longer supported and will generate warnings.
265 They were workarounds for bugs in other OSes which this implementation
268 One cannot both use the
273 options and specify URLs on the command line.