xref: /freebsd/libexec/phttpget/phttpget.8 (revision 90aac0d83bc9645f51ef0c2aeae6f9c0540bb031)
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.Dd January 3, 2015
26.Dt PHTTPGET 8
27.Os
28.Sh NAME
29.Nm phttpget
30.Nd retrieve multiple files via pipelined HTTP
31.Sh SYNOPSIS
32.Nm
33.Ar server
34.Ar file ...
35.Sh DESCRIPTION
36The
37.Nm
38utility is a minimalist pipelined HTTP client,
39which is used to retrieve multiple
40.Ar file Ns s
41from one
42.Ar server ,
43and saves the downloaded files in the current working directory,
44using the last portion of their download path as file names.
45.Pp
46By making several "in flight" HTTP requests,
47it can dramatically increase performance when a large number of
48small files need to be downloaded.
49.Pp
50The
51.Xr freebsd-update 8
52and
53.Xr portsnap 8
54tools use
55.Nm
56to download binary patch files.
57.Sh ENVIRONMENT
58.Bl -tag -width HTTP_PROXY_AUTH
59.It Ev HTTP_PROXY
60URL of the proxy to use for HTTP requests.
61.It Ev HTTP_PROXY_AUTH
62Authorization parameters for the HTTP proxy.
63.It Ev HTTP_USER_AGENT
64The User-Agent string to use for HTTP requests.
65The default is
66.Dq phttpget/0.1 .
67.It Ev HTTP_TIMEOUT
68Timeout for HTTP request in seconds.
69.El
70.Sh SEE ALSO
71.Xr fetch 1 ,
72.Xr freebsd-update 8 ,
73.Xr portsnap 8
74.Sh AUTHORS
75.An -nosplit
76The
77.Nm
78utility was written by
79.An Colin Percival Aq Mt cperciva@FreeBSD.org
80for use with
81.Xr portsnap 8
82and later with
83.Xr freebsd-update 8 .
84This manual page was written by
85.An Xin LI Aq Mt delphij@FreeBSD.org .
86