]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Update squidclient manual and usage documentation.
authorAmos Jeffries <squid3@treenet.co.nz>
Sun, 12 Jul 2009 11:24:29 +0000 (23:24 +1200)
committerAmos Jeffries <squid3@treenet.co.nz>
Sun, 12 Jul 2009 11:24:29 +0000 (23:24 +1200)
Also add tools/ manual files to manuals bundling.

mksnapshot.sh
tools/squidclient.1
tools/squidclient.cc

index 3c7fd1de487514f5d450d5a6d15224ba3e5efa12..1ce4a5185c4020bf5492de6db584da3972d486b9 100755 (executable)
@@ -102,6 +102,8 @@ fi
 if (groff --help >/dev/null); then
        make -C ${tmpdir}/doc all
        cp ${tmpdir}/doc/*.8 ${tmpdir}/doc/manuals/
+       cp ${tmpdir}/tools/*.8 ${tmpdir}/doc/manuals/
+       cp ${tmpdir}/tools/*.1 ${tmpdir}/doc/manuals/
         for f in `ls -1 ${tmpdir}/helpers/*/*/*.8` ; do
                cp $f ${tmpdir}/doc/manuals/
        done
index d8810fad8ced21a15b66aca7896aa3e2940b6ad1..f5204df34a33f1d5f72867adbea441b88d8f2c6e 100644 (file)
-.TH SQUIDCLIENT 1 "Mar 1998" "Squid Web Client Tool"
+.TH squidclient 1 "Squid Web Client Tool"
 .SH NAME
-squidclient -- client interface to the squid cache
+squidclient -- a simple HTTP web client
 .SH SYNOPSIS
 .B squidclient
-.RB [ \-r ]
-.RB [ \-s ]
+.RB [ \-arsv ]
+.RB [ \-g
+.IR count ]
+.RB [ \-h
+.IR remote\-host ]
+.RB [ \-H
+.IR 'string' ]
 .RB [ \-i
 .IR IMS ]
-.RB [ \-h
-.IR host ]
-.RB [ \-p
-.IR port ]
+.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 command line interface to retrieve URLs through the squid object cache.
+.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 -r
-Force cache to reload URL.
-.IP -s
-Silent.  Do not print data to stdout.
-.IP "\-i \fItime\fP"
-If-Modified-Since time (in Epoch seconds).
+.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 "\-p \fIport\fP"
-Port number of cache.  Default is 3128.
+.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
+      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
-squid(8).
+.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
index 3549c1c9530442ea6346baba3fcccd03012fd69d..dd6e470a1a321d073235933ad727fca86e6c9db1 100644 (file)
@@ -132,29 +132,32 @@ usage(const char *progname)
 {
     fprintf(stderr,
             "Version: %s\n"
-            "Usage: %s [-arsv] [-i IMS] [-h remote host] [-l local host] [-p port] [-m method] [-t count] [-I ping-interval] [-H 'strings'] [-T timeout] [-j 'hostheader'] [-V version] url\n"
+            "Usage: %s [-arsv] [-g count] [-h remote host] [-H 'string'] [-i IMS] [-I ping-interval] [-j 'Host-header']"
+            "[-l local-host] [-m method] [-p port] [-P file] [-t count] [-T timeout] [-u proxy-user] [-U www-user] "
+            "[-V version] [-w proxy-password] [-W www-password] url\n"
+            "\n"
             "Options:\n"
-            "    -P file      PUT request.\n"
             "    -a           Do NOT include Accept: header.\n"
-            "    -r           Force cache to reload URL.\n"
-            "    -s           Silent.  Do not print data to stdout.\n"
-            "    -v           Verbose. Print outgoing message to stderr.\n"
-            "    -i IMS       If-Modified-Since time (in Epoch seconds).\n"
+            "    -g count     Ping mode, perform \"count\" iterations (0 to loop until interrupted).\n"
             "    -h host      Retrieve URL from cache on hostname.  Default is localhost.\n"
-            "    -l host      Specify a local IP address to bind to.  Default is none.\n"
+            "    -H 'string'  Extra headers to send. Use '\\n' for new lines.\n"
+            "    -i IMS       If-Modified-Since time (in Epoch seconds).\n"
+            "    -I interval  Ping interval in seconds (default 1 second).\n"
             "    -j hosthdr   Host header content\n"
-            "    -p port      Port number of cache.  Default is %d.\n"
+            "    -l host      Specify a local IP address to bind to.  Default is none.\n"
             "    -m method    Request method, default is GET.\n"
+            "    -p port      Port number of cache.  Default is %d.\n"
+            "    -P file      PUT request. Using the named file\n"
+            "    -r           Force cache to reload URL.\n"
+            "    -s           Silent.  Do not print data to stdout.\n"
             "    -t count     Trace count cache-hops\n"
-            "    -g count     Ping mode, \"count\" iterations (0 to loop until interrupted).\n"
-            "    -I interval  Ping interval in seconds (default 1 second).\n"
-            "    -H 'string'  Extra headers to send. Use '\\n' for new lines.\n"
             "    -T timeout   Timeout value (seconds) for read/write operations.\n"
             "    -u user      Proxy authentication username\n"
-            "    -w password  Proxy authentication password\n"
             "    -U user      WWW authentication username\n"
-            "    -W password  WWW authentication password\n"
+            "    -v           Verbose. Print outgoing message to stderr.\n"
             "    -V version   HTTP Version. Use '-' for HTTP/0.9 omitted case\n",
+            "    -w password  Proxy authentication password\n"
+            "    -W password  WWW authentication password\n"
             VERSION, progname, CACHE_HTTP_PORT);
     exit(1);
 }