squid(8)

NAME
squid - proxy caching server

SYNOPSIS
squid [ -dhisrvzCDFNRVYX ] [ -l facility ] [ -f config-file ] [ -[ au ] port ] [ -k signal ] [ -n service-name ] [ -O cmd-line ]

DESCRIPTION
squid is a high-performance proxy caching server for web clients, supporting FTP, gopher, and HTTP data objects. Unlike traditional caching software, squid handles all requests in a single, non-blocking, I/O-driven process.

squid keeps meta data and especially hot objects cached in RAM, caches DNS lookups, supports non-blocking DNS lookups, and implements negative caching of failed requests.

squid supports SSL, extensive access controls, and full request logging. By using the lightweight Internet Cache Protocol, squid caches can be arranged in a hierarchy or mesh for additional bandwidth savings.

squid consists of a main server program squid, a Domain Name System lookup program dnsserver, some optional programs for rewriting requests and performing authentication, and some management and client tools. When squid starts up, it spawns a configurable number of dnsserver processes, each of which can perform a single, blocking Domain Name System (DNS) lookup. This reduces the amount of time the cache waits for DNS lookups.

squid is derived from the ARPA-funded Harvest Project http://harvest.cs.colorado.edu/

This manual page only lists the command line arguments. For details on how to configure squid see the file /squid/etc/squid.conf, the Squid FAQ and the documentation at the squid home page http://www.squid-cache.org

OPTIONS

-a port
    Specify HTTP port number where Squid should listen for requests, in addition to any http_port specifications in squid.conf.

-d level
    Write debugging to stderr also.

-f file
    Use the given config-file instead of /squid/etc/squid.conf. If the file name starts with a ! or | then it is assumed to be an external command or command line. Can for example be used to pre-process the configuration before it is being read by Squid. To facilitate this Squid also understands the common #line notion to indicate the real source file.

-h  Print help message.

-i  Install as a Windows Service (see -n option).

-k reconfigure | rotate | shutdown | interrupt | kill | debug | check | parse
    Parse configuration file, then send signal to running copy (except -k parse) and exit.

-n name
    Specify Windows Service name to use for service operations, default is: Squid

-r  Remove a Windows Service (see -n option).

-s  Enable logging to syslog.

-l facility
    Use specified syslog facility. implies -s

-u port
    Specify ICP port number (default: 3130), disable with 0.

-v  Print version.

-z  Create swap directories

-C  Do not catch fatal signals.

-D  Disable initial DNS tests.

-F  Don't serve any requests until store is rebuilt.

-O options
    Set Windows Service Command line options in Registry.

-N  No daemon mode.

-R  Do not set REUSEADDR on port.

-X  Force full debugging.

-Y  Only return UDP_HIT or UDP_MISS_NOFETCH during fast reload.

FILES
/squid/etc/squid.conf
    The main configuration file. You must initially make changes to this file for squid to work. For example, the default configuration does not allow access from any browser.
/squid/etc/squid.conf.default
    Reference copy of the configuration file. Always kept up to date with the version of Squid you are using. Use this to look up configuration syntax after upgrading.
/squid/etc/mime.conf (mime_table)
    MIME type mappings for FTP gatewaying
/squid/share/errors/templates (error_directory)
    Error page templates

SEE ALSO
cachemgr.cgi(8), pam_auth(8), squid_ldap_auth(8), squid_ldap_group(8), squid_session(8), squid_unix_group(8),
The Squid FAQ