xref: /freebsd/libexec/phttpget/phttpget.8 (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1.\"-
2.\" Copyright (c) 2015 Xin LI <delphij@FreeBSD.org>
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd January 3, 2015
28.Dt PHTTPGET 8
29.Os
30.Sh NAME
31.Nm phttpget
32.Nd retrieve multiple files via pipelined HTTP
33.Sh SYNOPSIS
34.Nm
35.Ar server
36.Ar file ...
37.Sh DESCRIPTION
38The
39.Nm
40utility is a minimalist pipelined HTTP client,
41which is used to retrieve multiple
42.Ar file Ns s
43from one
44.Ar server ,
45and saves the downloaded files in the current working directory,
46using the last portion of their download path as file names.
47.Pp
48By making several "in flight" HTTP requests,
49it can dramatically increase performance when a large number of
50small files need to be downloaded.
51.Pp
52The
53.Xr freebsd-update 8
54and
55.Xr portsnap 8
56tools use
57.Nm
58to download binary patch files.
59.Sh ENVIRONMENT
60.Bl -tag -width HTTP_PROXY_AUTH
61.It Ev HTTP_PROXY
62URL of the proxy to use for HTTP requests.
63.It Ev HTTP_PROXY_AUTH
64Authorization parameters for the HTTP proxy.
65.It Ev HTTP_USER_AGENT
66The User-Agent string to use for HTTP requests.
67The default is
68.Dq phttpget/0.1 .
69.It Ev HTTP_TIMEOUT
70Timeout for HTTP request in seconds.
71.El
72.Sh SEE ALSO
73.Xr fetch 1 ,
74.Xr freebsd-update 8 ,
75.Xr portsnap 8
76.Sh AUTHORS
77.An -nosplit
78The
79.Nm
80utility was written by
81.An Colin Percival Aq Mt cperciva@FreeBSD.org
82for use with
83.Xr portsnap 8
84and later with
85.Xr freebsd-update 8 .
86This manual page was written by
87.An Xin LI Aq Mt delphij@FreeBSD.org .
88