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

.if !'po4a'hide' .TH squidclient 1
.
.SH NAME
squidclient \- A simple HTTP web client tool
.
.SH SYNOPSIS
.if !'po4a'hide' .B squidclient
.if !'po4a'hide' .B "[ \-aknNrsv ] "
.if !'po4a'hide' .B "[ \-\-ping [ping\-options] ] "
.if !'po4a'hide' .B "[ \-\-https] [tls\-options] [ \-A"
string
.if !'po4a'hide' .B "] [ \-h | \-\-host"
remote host
.if !'po4a'hide' .B "] [ \-H '"
string
.if !'po4a'hide' .B "' ] [ \-i"
IMS
.if !'po4a'hide' .B "] [ \-j '"
Host header
.if !'po4a'hide' .B "' ] [ \-l | \-\-local"
host
.if !'po4a'hide' .B "] [ \-m"
method
.if !'po4a'hide' .B "] [ \-p | \-\-port"
port
.if !'po4a'hide' .B "] [ \-P"
file
.if !'po4a'hide' .B "] [ \-t"
count
.if !'po4a'hide' .B "] [ \-T"
timeout
.if !'po4a'hide' .B "] [ \-u"
user
.if !'po4a'hide' .B "] [ \-U"
user
.if !'po4a'hide' .B "] [ \-V"
version
.if !'po4a'hide' .B "] [ \-w"
password
.if !'po4a'hide' .B "] [ \-W"
password
.if !'po4a'hide' .B "] "
url
.
.PP
.if !'po4a'hide' .B "Ping options: [ \-g"
count
.if !'po4a'hide' .B "] [ \-I"
interval
.if !'po4a'hide' .B "] "
.
.PP
.if !'po4a'hide' .B "TLS options: [ \-\-anonymous\-tls ] [ \-\-trusted\-ca"
CA certificates file
.if !'po4a'hide' .B "...] [ \-\-cert"
client X.509 certificate file
.if !'po4a'hide' .B "] [ \-\-params"
TLS session parameters
.if !'po4a'hide' .B "] "
.
.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' .TP 12
.if !'po4a'hide' .B "\-a"
Do NOT include Accept: header.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-A 'string'"
Send 
.B string
as User-Agent: header. To omit the header completely set string to empty ('').
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-h | \-\-host host"
Retrieve URL from server host.  Default is
.B localhost
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-H 'string'"
Extra headers to send. Use
.B '\en'
for new lines.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-i time"
If\-Modified\-Since time (in Epoch seconds).
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-j hosthdr"
Host header content
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-k"
Keep the connection active. Default is to do only one request then close.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-l | \-\-local host"
Specify a local IP address to bind to.  Default is none.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-m method"
Request method, default is
.I GET.
Squid also supports a non-standard method called
.I PURGE.
You can use that to purge a specific URL from the cache.
You need to have
.I purge
access setup in
.B squid.conf
similar to
.I manager
access. Here is an example:
.if !'po4a'hide' .nf
.if !'po4a'hide'       acl purge method PURGE
.if !'po4a'hide'       http_access deny purge !localhost
.if !'po4a'hide' .fi
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-n"
Proxy Negotiate(Kerberos) authentication.
.if !'po4a'hide' .nf
Use kinit username@DOMAIN first to get initial TGS.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-N"
WWW Negotiate(Kerberos) authentication.
.if !'po4a'hide' .nf
Use kinit username@DOMAIN first to get initial TGS.
.if !'po4a'hide' .fi
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-p port"
Port number of cache.  Default is 3128.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-P file"
Request body. Using the named file as data.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-r"
Force cache to reload URL.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-s"
Silent.  Do not print data to stdout.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-t count"
Trace
.I count
HTTP relay or proxy hops
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-T timeout"
Timeout value (seconds) for read/write operations.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-u user"
Proxy authentication username
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-U user"
WWW authentication username
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-v"
Verbose. Print outgoing message to stderr.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-V version"
HTTP Version. Use '\-' for HTTP/0.9 omitted case
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-w password"
Proxy authentication password
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-W password"
WWW authentication password
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-\-https"
Use Transport Layer Security on the HTTP connection.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-\-anonymous\-tls"
Use TLS with unauthenticated (anonymous) certificate.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-\-cert file"
File containing client X.509 certificate in PEM format.
May be repeated to load several client certificates.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-\-trusted\-ca file"
File containing trusted Certificate Authority (CA) certificates in PEM format.
May be repeated to load any number of files.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-\-params values"
TLS library specific parameters for the communication session.
See the library documentation for details on valid parameters.
.if !'po4a'hide' .I "GnuTLS: http://gnutls.org/manual/html_node/Priority\-Strings.html"
If repeated only the last value will have effect.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-\-ping [options]"
Enable ping mode. Optional \-g and \-I parameters must follow immediately if used.
Repeated use resets to default ping settings.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-g count"
Ping mode, perform
.I count
iterations (default is to loop until interrupted).
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-I interval"
Ping interval in seconds (default 1 second).
.
.SH AUTHOR
This program and manual was written by
.if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
.PP
Based on original code derived from Harvest and further developed by
numerous individuals from the internet community.
.
.SH COPYRIGHT
.PP
 * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
.
.SH QUESTIONS
Questions on the usage of this program can be sent to the
.I Squid Users mailing list
.if !'po4a'hide' <squid-users@lists.squid-cache.org>
.
.SH REPORTING BUGS
See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
.PP
Report bugs or bug fixes using http://bugs.squid-cache.org/
.PP
Report serious security bugs to
.I Squid Bugs <squid-bugs@lists.squid-cache.org>
.PP
Report ideas for new improvements to the
.I Squid Developers mailing list
.if !'po4a'hide' <squid-dev@lists.squid-cache.org>
.
.SH SEE ALSO
.if !'po4a'hide' .BR squid "(8), "
.if !'po4a'hide' .BR cachemgr.cgi "(8)"
Commit	Line	Data
	1	.if !'po4a'hide' .TH squidclient 1
	2	.
	3	.SH NAME
	4	squidclient \- A simple HTTP web client tool
	5	.
	6	.SH SYNOPSIS
	7	.if !'po4a'hide' .B squidclient
	8	.if !'po4a'hide' .B "[ \-aknNrsv ] "
	9	.if !'po4a'hide' .B "[ \-\-ping [ping\-options] ] "
	10	.if !'po4a'hide' .B "[ \-\-https] [tls\-options] [ \-A"
	11	string
	12	.if !'po4a'hide' .B "] [ \-h \| \-\-host"
	13	remote host
	14	.if !'po4a'hide' .B "] [ \-H '"
	15	string
	16	.if !'po4a'hide' .B "' ] [ \-i"
	17	IMS
	18	.if !'po4a'hide' .B "] [ \-j '"
	19	Host header
	20	.if !'po4a'hide' .B "' ] [ \-l \| \-\-local"
	21	host
	22	.if !'po4a'hide' .B "] [ \-m"
	23	method
	24	.if !'po4a'hide' .B "] [ \-p \| \-\-port"
	25	port
	26	.if !'po4a'hide' .B "] [ \-P"
	27	file
	28	.if !'po4a'hide' .B "] [ \-t"
	29	count
	30	.if !'po4a'hide' .B "] [ \-T"
	31	timeout
	32	.if !'po4a'hide' .B "] [ \-u"
	33	user
	34	.if !'po4a'hide' .B "] [ \-U"
	35	user
	36	.if !'po4a'hide' .B "] [ \-V"
	37	version
	38	.if !'po4a'hide' .B "] [ \-w"
	39	password
	40	.if !'po4a'hide' .B "] [ \-W"
	41	password
	42	.if !'po4a'hide' .B "] "
	43	url
	44	.
	45	.PP
	46	.if !'po4a'hide' .B "Ping options: [ \-g"
	47	count
	48	.if !'po4a'hide' .B "] [ \-I"
	49	interval
	50	.if !'po4a'hide' .B "] "
	51	.
	52	.PP
	53	.if !'po4a'hide' .B "TLS options: [ \-\-anonymous\-tls ] [ \-\-trusted\-ca"
	54	CA certificates file
	55	.if !'po4a'hide' .B "...] [ \-\-cert"
	56	client X.509 certificate file
	57	.if !'po4a'hide' .B "] [ \-\-params"
	58	TLS session parameters
	59	.if !'po4a'hide' .B "] "
	60	.
	61	.SH DESCRIPTION
	62	.B squidclient
	63	is a tool providing a command line interface for retrieving URLs.
	64	Designed for testing any HTTP 0.9, 1.0, or 1.1 web server or proxy.
	65	This tool can be combined with scripts to perform any basic HTTP operation.
	66	Some additional features for access to the
	67	.B squid
	68	proxy object cache and management information are provided.
	69	.
	70	.SH OPTIONS
	71	.if !'po4a'hide' .TP 12
	72	.if !'po4a'hide' .B "\-a"
	73	Do NOT include Accept: header.
	74	.
	75	.if !'po4a'hide' .TP
	76	.if !'po4a'hide' .B "\-A 'string'"
	77	Send
	78	.B string
	79	as User-Agent: header. To omit the header completely set string to empty ('').
	80	.
	81	.if !'po4a'hide' .TP
	82	.if !'po4a'hide' .B "\-h \| \-\-host host"
	83	Retrieve URL from server host. Default is
	84	.B localhost
	85	.
	86	.if !'po4a'hide' .TP
	87	.if !'po4a'hide' .B "\-H 'string'"
	88	Extra headers to send. Use
	89	.B '\en'
	90	for new lines.
	91	.
	92	.if !'po4a'hide' .TP
	93	.if !'po4a'hide' .B "\-i time"
	94	If\-Modified\-Since time (in Epoch seconds).
	95	.
	96	.if !'po4a'hide' .TP
	97	.if !'po4a'hide' .B "\-j hosthdr"
	98	Host header content
	99	.
	100	.if !'po4a'hide' .TP
	101	.if !'po4a'hide' .B "\-k"
	102	Keep the connection active. Default is to do only one request then close.
	103	.
	104	.if !'po4a'hide' .TP
	105	.if !'po4a'hide' .B "\-l \| \-\-local host"
	106	Specify a local IP address to bind to. Default is none.
	107	.
	108	.if !'po4a'hide' .TP
	109	.if !'po4a'hide' .B "\-m method"
	110	Request method, default is
	111	.I GET.
	112	Squid also supports a non-standard method called
	113	.I PURGE.
	114	You can use that to purge a specific URL from the cache.
	115	You need to have
	116	.I purge
	117	access setup in
	118	.B squid.conf
	119	similar to
	120	.I manager
	121	access. Here is an example:
	122	.if !'po4a'hide' .nf
	123	.if !'po4a'hide' acl purge method PURGE
	124	.if !'po4a'hide' http_access deny purge !localhost
	125	.if !'po4a'hide' .fi
	126	.
	127	.if !'po4a'hide' .TP
	128	.if !'po4a'hide' .B "\-n"
	129	Proxy Negotiate(Kerberos) authentication.
	130	.if !'po4a'hide' .nf
	131	Use kinit username@DOMAIN first to get initial TGS.
	132	.
	133	.if !'po4a'hide' .TP
	134	.if !'po4a'hide' .B "\-N"
	135	WWW Negotiate(Kerberos) authentication.
	136	.if !'po4a'hide' .nf
	137	Use kinit username@DOMAIN first to get initial TGS.
	138	.if !'po4a'hide' .fi
	139	.
	140	.if !'po4a'hide' .TP
	141	.if !'po4a'hide' .B "\-p port"
	142	Port number of cache. Default is 3128.
	143	.
	144	.if !'po4a'hide' .TP
	145	.if !'po4a'hide' .B "\-P file"
	146	Request body. Using the named file as data.
	147	.
	148	.if !'po4a'hide' .TP
	149	.if !'po4a'hide' .B "\-r"
	150	Force cache to reload URL.
	151	.
	152	.if !'po4a'hide' .TP
	153	.if !'po4a'hide' .B "\-s"
	154	Silent. Do not print data to stdout.
	155	.
	156	.if !'po4a'hide' .TP
	157	.if !'po4a'hide' .B "\-t count"
	158	Trace
	159	.I count
	160	HTTP relay or proxy hops
	161	.
	162	.if !'po4a'hide' .TP
	163	.if !'po4a'hide' .B "\-T timeout"
	164	Timeout value (seconds) for read/write operations.
	165	.
	166	.if !'po4a'hide' .TP
	167	.if !'po4a'hide' .B "\-u user"
	168	Proxy authentication username
	169	.
	170	.if !'po4a'hide' .TP
	171	.if !'po4a'hide' .B "\-U user"
	172	WWW authentication username
	173	.
	174	.if !'po4a'hide' .TP
	175	.if !'po4a'hide' .B "\-v"
	176	Verbose. Print outgoing message to stderr.
	177	.
	178	.if !'po4a'hide' .TP
	179	.if !'po4a'hide' .B "\-V version"
	180	HTTP Version. Use '\-' for HTTP/0.9 omitted case
	181	.
	182	.if !'po4a'hide' .TP
	183	.if !'po4a'hide' .B "\-w password"
	184	Proxy authentication password
	185	.
	186	.if !'po4a'hide' .TP
	187	.if !'po4a'hide' .B "\-W password"
	188	WWW authentication password
	189	.
	190	.if !'po4a'hide' .TP
	191	.if !'po4a'hide' .B "\-\-https"
	192	Use Transport Layer Security on the HTTP connection.
	193	.
	194	.if !'po4a'hide' .TP
	195	.if !'po4a'hide' .B "\-\-anonymous\-tls"
	196	Use TLS with unauthenticated (anonymous) certificate.
	197	.
	198	.if !'po4a'hide' .TP
	199	.if !'po4a'hide' .B "\-\-cert file"
	200	File containing client X.509 certificate in PEM format.
	201	May be repeated to load several client certificates.
	202	.
	203	.if !'po4a'hide' .TP
	204	.if !'po4a'hide' .B "\-\-trusted\-ca file"
	205	File containing trusted Certificate Authority (CA) certificates in PEM format.
	206	May be repeated to load any number of files.
	207	.
	208	.if !'po4a'hide' .TP
	209	.if !'po4a'hide' .B "\-\-params values"
	210	TLS library specific parameters for the communication session.
	211	See the library documentation for details on valid parameters.
	212	.if !'po4a'hide' .I "GnuTLS: http://gnutls.org/manual/html_node/Priority\-Strings.html"
	213	If repeated only the last value will have effect.
	214	.
	215	.if !'po4a'hide' .TP
	216	.if !'po4a'hide' .B "\-\-ping [options]"
	217	Enable ping mode. Optional \-g and \-I parameters must follow immediately if used.
	218	Repeated use resets to default ping settings.
	219	.
	220	.if !'po4a'hide' .TP
	221	.if !'po4a'hide' .B "\-g count"
	222	Ping mode, perform
	223	.I count
	224	iterations (default is to loop until interrupted).
	225	.
	226	.if !'po4a'hide' .TP
	227	.if !'po4a'hide' .B "\-I interval"
	228	Ping interval in seconds (default 1 second).
	229	.
	230	.SH AUTHOR
	231	This program and manual was written by
	232	.if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
	233	.PP
	234	Based on original code derived from Harvest and further developed by
	235	numerous individuals from the internet community.
	236	.
	237	.SH COPYRIGHT
	238	.PP
	239	* Copyright (C) 1996-2021 The Squid Software Foundation and contributors
	240	*
	241	* Squid software is distributed under GPLv2+ license and includes
	242	* contributions from numerous individuals and organizations.
	243	* Please see the COPYING and CONTRIBUTORS files for details.
	244	.
	245	.SH QUESTIONS
	246	Questions on the usage of this program can be sent to the
	247	.I Squid Users mailing list
	248	.if !'po4a'hide' <squid-users@lists.squid-cache.org>
	249	.
	250	.SH REPORTING BUGS
	251	See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
	252	.PP
	253	Report bugs or bug fixes using http://bugs.squid-cache.org/
	254	.PP
	255	Report serious security bugs to
	256	.I Squid Bugs <squid-bugs@lists.squid-cache.org>
	257	.PP
	258	Report ideas for new improvements to the
	259	.I Squid Developers mailing list
	260	.if !'po4a'hide' <squid-dev@lists.squid-cache.org>
	261	.
	262	.SH SEE ALSO
	263	.if !'po4a'hide' .BR squid "(8), "
	264	.if !'po4a'hide' .BR cachemgr.cgi "(8)"