Import en_AU from Rosetta Project

[thirdparty/squid.git] / tools / squidclient.1

.TH squidclient 1 "Squid Web Client Tool"
.SH NAME
squidclient -- a simple HTTP web client
.SH SYNOPSIS
.B squidclient
.if !'po4a'hide' .RB [ \-arsv ]
.if !'po4a'hide' .RB [ \-g
.IR count
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-h
.IR remote\-host
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-H
.IR 'string'
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-i
.IR IMS
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-I
.IR ping\-interval
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-j
.IR 'Host\-header'
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-l
.IR local\-host
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-m
.IR method
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-p
.IR port
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-P
.IR file
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-t
.IR count
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-T
.IR timeout
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-u
.IR proxy-user
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-U
.IR www-user
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-V
.IR version
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-w
.IR proxy-password
.if !'po4a'hide' ]
.if !'po4a'hide' .RB [ \-W
.IR www-password
.if !'po4a'hide' ]
.B url
.SH DESCRIPTION
.B squidclient
is a tool providing a command line interface for retrieving URLs.
Designed for testing any HTTP 0.9, 1.0, or 1.1 web server or proxy.
This tool can be combined with scripts to perform any basic HTTP operation.
Some additional features for access to the 
.B Squid
proxy object cache and management information are provided.
.SH OPTIONS
.if !'po4a'hide' .IP "\-a"
Do NOT include Accept: header.
.IP "\-g \fIcount\fP"
Ping mode, perform
.I count
iterations (0 to loop until interrupted).
.IP "\-h \fIhost\fP"
Retrieve URL from cache on hostname.  Default is localhost.
.IP "\-H \fI'string'\fP"
Extra headers to send. Use '\\n' for new lines.
.IP "\-i \fItime\fP"
If-Modified-Since time (in Epoch seconds).
.IP "-I \fIinterval\fP"
Ping interval in seconds (default 1 second).
.IP "\-j \fIhosthdr\fP"
Host header content
.IP "\-l \fIhost\fP"
Specify a local IP address to bind to.  Default is none.
.IP "\-m \fImethod\fP"
Request method, default is GET. Squid also supports a non-standard method
called \fBPURGE\fP. You can use that to purge a specific URL from the cache.
You need to have \fIpurge\fP access setup in squid.conf similar to
\fImanager\fP access. Here is an example:
.nf
.if !'po4a'hide'       acl purge method PURGE
.if !'po4a'hide'       http_access deny purge !localhost
.fi
.IP "\-p \fIport\fP"
Port number of cache.  Default is 3128.
.IP "\-P \fIfile"
PUT request. Using the named file.
.IP "\-r"
Force cache to reload URL.
.IP "\-s"
Silent.  Do not print data to stdout.
.IP "\-t \fIcount\fP"
Trace count cache-hops
.IP "\-T \fItimeout\fP"
Timeout value (seconds) for read/write operations.
.IP "\-u \fIuser\fP"
Proxy authentication username
.IP "\-U \fIuser\fP"
WWW authentication username
.IP "\-v"
Verbose. Print outgoing message to stderr.
.IP "\-w \fIpassword\fP"
Proxy authentication password
.IP "\-W \fIpassword\fP"
WWW authentication password
.IP "\-V \fIversion\fP"
HTTP Version. Use '-' for HTTP/0.9 omitted case
.SH SEE ALSO
.if !'po4a'hide' .BR cachemgr.cgi "(8), "
.if !'po4a'hide' .BR squid "(8)"
.SH AUTHOR
Derived from Harvest. Further developed by by numerous individuals from
the internet community. Development is led by Duane Wessels of the
National Laboratory for Applied Network Research and funded by
the National Science Foundation.