[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
.RB [ \-arsv ]
.RB [ \-g
.IR count ]
.RB [ \-h
.IR remote\-host ]
.RB [ \-H
.IR 'string' ]
.RB [ \-i
.IR IMS ]
.RB [ \-I
.IR ping\-interval ]
.RB [ \-j
.IR 'Host\-header' ]
.RB [ \-l
.IR local\-host ]
.RB [ \-m
.IR method ]
.RB [ \-p
.IR port ]
.RB [ \-P
.IR file ]
.RB [ \-t
.IR count ]
.RB [ \-T
.IR timeout ]
.RB [ \-u
.IR proxy-user ]
.RB [ \-U
.IR www-user ]
.RB [ \-V
.IR version ]
.RB [ \-w
.IR proxy-password ]
.RB [ \-W
.IR www-password ]
.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 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
.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
      acl purge method PURGE
      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
.BR cachemgr.cgi "(8), "
.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.
Commit	Line	Data
4f16e7af	1	.TH squidclient 1 "Squid Web Client Tool"
06952d61	2	.SH NAME
4f16e7af	3	squidclient -- a simple HTTP web client
06952d61 AJ	4	.SH SYNOPSIS
06952d61 AJ	5	.B squidclient
4f16e7af AJ	6	.RB [ \-arsv ]
	7	.RB [ \-g
	8	.IR count ]
	9	.RB [ \-h
	10	.IR remote\-host ]
	11	.RB [ \-H
	12	.IR 'string' ]
06952d61 AJ	13	.RB [ \-i
06952d61 AJ	14	.IR IMS ]
4f16e7af AJ	15	.RB [ \-I
	16	.IR ping\-interval ]
	17	.RB [ \-j
	18	.IR 'Host\-header' ]
	19	.RB [ \-l
	20	.IR local\-host ]
06952d61 AJ	21	.RB [ \-m
06952d61 AJ	22	.IR method ]
4f16e7af AJ	23	.RB [ \-p
	24	.IR port ]
	25	.RB [ \-P
	26	.IR file ]
	27	.RB [ \-t
	28	.IR count ]
	29	.RB [ \-T
	30	.IR timeout ]
	31	.RB [ \-u
	32	.IR proxy-user ]
	33	.RB [ \-U
	34	.IR www-user ]
	35	.RB [ \-V
	36	.IR version ]
	37	.RB [ \-w
	38	.IR proxy-password ]
	39	.RB [ \-W
	40	.IR www-password ]
06952d61 AJ	41	.B url
06952d61 AJ	42	.SH DESCRIPTION
4f16e7af AJ	43	.B squidclient
	44	is a tool providing a command line interface for retrieving URLs.
	45	Designed for testing any HTTP 0.9, 1.0, or 1.1 web server or proxy.
	46	This tool can be combined scripts to perform any basic HTTP operation.
	47	Some additional features for access to the
	48	.B Squid
	49	proxy object cache and management information are provided.
06952d61	50	.SH OPTIONS
4f16e7af AJ	51	.IP "\-a"
	52	Do NOT include Accept: header.
	53	.IP "\-g \fIcount\fP"
	54	Ping mode, perform
	55	.I count
	56	iterations (0 to loop until interrupted).
06952d61 AJ	57	.IP "\-h \fIhost\fP"
06952d61 AJ	58	Retrieve URL from cache on hostname. Default is localhost.
4f16e7af AJ	59	.IP "\-H \fI'string'\fP"
	60	Extra headers to send. Use '\\n' for new lines.
	61	.IP "\-i \fItime\fP"
	62	If-Modified-Since time (in Epoch seconds).
	63	.IP "-I \fIinterval\fP"
	64	Ping interval in seconds (default 1 second).
	65	.IP "\-j \fIhosthdr\fP"
	66	Host header content
	67	.IP "\-l \fIhost\fP"
	68	Specify a local IP address to bind to. Default is none.
06952d61 AJ	69	.IP "\-m \fImethod\fP"
	70	Request method, default is GET. Squid also supports a non-standard method
	71	called \fBPURGE\fP. You can use that to purge a specific URL from the cache.
	72	You need to have \fIpurge\fP access setup in squid.conf similar to
	73	\fImanager\fP access. Here is an example:
	74	.nf
06952d61	75	acl purge method PURGE
4f16e7af	76	http_access deny purge !localhost
06952d61	77	.fi
4f16e7af AJ	78	.IP "\-p \fIport\fP"
	79	Port number of cache. Default is 3128.
	80	.IP "\-P \fIfile"
	81	PUT request. Using the named file.
	82	.IP "\-r"
	83	Force cache to reload URL.
	84	.IP "\-s"
	85	Silent. Do not print data to stdout.
	86	.IP "\-t \fIcount\fP"
	87	Trace count cache-hops
	88	.IP "\-T \fItimeout\fP"
	89	Timeout value (seconds) for read/write operations.
	90	.IP "\-u \fIuser\fP"
	91	Proxy authentication username
	92	.IP "\-U \fIuser\fP"
	93	WWW authentication username
	94	.IP "\-v"
	95	Verbose. Print outgoing message to stderr.
	96	.IP "\-w \fIpassword\fP"
	97	Proxy authentication password
	98	.IP "\-W \fIpassword\fP"
	99	WWW authentication password
	100	.IP "\-V \fIversion\fP"
	101	HTTP Version. Use '-' for HTTP/0.9 omitted case
06952d61	102	.SH SEE ALSO
4f16e7af AJ	103	.BR cachemgr.cgi "(8), "
4f16e7af AJ	104	.BR squid "(8)"
06952d61 AJ	105	.SH AUTHOR
	106	Derived from Harvest. Further developed by by numerous individuals from
	107	the internet community. Development is led by Duane Wessels of the
	108	National Laboratory for Applied Network Research and funded by
	109	the National Science Foundation.