squid(8)

1squid(8)                    System Manager's Manual                   squid(8)
2
3
4

NAME

6       squid - proxy caching server
7

SYNOPSIS

9       squid [ -dhisrvzCFNRSVYX ] [ -l facility ] [ -f config-file ] [ -[ au ]
10       port ] [ -k  signal ] [ -n service-name ] [ -O cmd-line ]
11

DESCRIPTION

13       squid is a high-performance proxy caching server for web clients,  sup‐
14       porting  FTP,  gopher,  ICAP,  ICP, HTCP and HTTP data objects.  Unlike
15       traditional caching software, squid handles all requests in  a  single,
16       non-blocking process.
17
18       squid  keeps meta data and especially hot objects cached in RAM, caches
19       DNS lookups, supports non-blocking DNS lookups, and implements negative
20       caching of failed requests.
21
22       squid  supports  SSL,  extensive access controls, and full request log‐
23       ging.  By using the lightweight Internet Cache Protocols ICP,  HTCP  or
24       CARP,  squid  caches  can  be arranged in a hierarchy or mesh for addi‐
25       tional bandwidth savings.
26
27       squid consists of a main server program squid, some  optional  programs
28       for  custom  processing  and  authentication,  and  some management and
29       client tools.  When squid starts up, it spawns a configurable number of
30       helper  processes,  each  of  which can perform parallel lookups.  This
31       reduces the amount of time the cache waits for results.
32
33       squid is derived  from  the  ARPA-funded  Harvest  Project  http://har‐
34       vest.cs.colorado.edu/
35
36       This manual page only lists the command line arguments.  For details on
37       how to configure squid see the  file  /etc/squid/squid.conf.documented,
38       the  Squid  wiki  FAQ and examples at http://wiki.squid-cache.org/ , or
39       the configuration manual  on  the  squid  home  page  http://www.squid-
40       cache.org/Doc/config/
41

OPTIONS

43       -a port
44              Specify HTTP port number where Squid should listen for requests,
45              in addition to any http_port specifications in squid.conf.
46
47       -d level
48              Write debugging to stderr also.
49
50       -f file
51              Use the given config-file instead of /etc/squid/squid.conf.   If
52              the  file  name starts with a ! or | then it is assumed to be an
53              external command or command line. Can for  example  be  used  to
54              pre-process  the configuration before it is being read by Squid.
55              To facilitate this  Squid  also  understands  the  common  #line
56              notion to indicate the real source file.
57
58       -h     Print help message.
59
60       -i     Install as a Windows Service (see -n option).
61
62       -k reconfigure | rotate | shutdown | interrupt | kill | debug | check |
63       parse
64              Parse configuration file,  then  send  signal  to  running  copy
65              (except -k parse) and exit.
66
67       -n name
68              Specify  Windows  Service  name  to  use for service operations,
69              default is: Squid
70
71       -r     Remove a Windows Service (see -n option).
72
73       -s     Enable    logging    to    syslog.    Also    configurable    in
74              /etc/squid/squid.conf
75
76       -l facility
77              Use specified syslog facility. implies -s
78
79       -u port
80              Specify ICP port number (default: 3130), disable with 0.
81
82       -v     Print version and build details.
83
84       -z     Create swap directories
85
86       -C     Do not catch fatal signals.
87
88       -F     Don't serve any requests until store is rebuilt.
89
90       -N     No daemon mode.
91
92       -O options
93              Set Windows Service Command line options in Registry.
94
95       -R     Do not set REUSEADDR on port.
96
97       -S     Double-check swap during rebuild.
98
99       -X     Force full debugging.
100
101       -Y     Only return UDP_HIT or UDP_MISS_NOFETCH during fast reload.
102
103

FILES

105       /etc/squid/squid.conf
106              The main configuration file.  You must initially make changes to
107              this file for squid to work.  For example, the default  configu‐
108              ration does not allow access from any browser.
109
110       *.default files
111              Reference copy of the configuration file. Always kept up to date
112              with the version of Squid you are using. Use this to look up the
113              default configuration settings and syntax after upgrading.
114
115       /etc/squid/squid.conf.documented
116              Reference copy of the configuration file. Always kept up to date
117              with the version of Squid you are using. Use this  to  read  the
118              documentation  for configuration options available in your build
119              of Squid. The online configuration manual is also available  for
120              a    full    reference    of    options.    seehttp://www.squid-
121              cache.org/Doc/config/
122
123       cachemgr.conf
124              The main configuration file for the web cachemgr.cgi tools.
125
126       msntauth.conf
127              The main configuration file for the Sample MSNT authenticator.
128
129       errorpage.css
130              CSS Stylesheet to control the display of generated error  pages.
131              Use  this to set any company branding you need, it will apply to
132              every Language Squid provides error pages for.
133
134       /etc/squid/mime.conf (mime_table)
135              MIME type mappings for FTP gatewaying
136
137       /usr/share/squid/errors
138              Location of squid error pages and templates.
139
140

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

FILES

SEE ALSO