1 .if !'po4a'hide' .TH squid 8
4 .if !'po4a'hide' .B squid
6 HTTP web proxy caching server
9 .if !'po4a'hide' .B squid
10 .if !'po4a'hide' .B [\-dhisrvzCFNRSVYX]
11 .if !'po4a'hide' .B [\-l
13 .if !'po4a'hide' .B ] [\-f
15 .if !'po4a'hide' .B ] [\-[au]
17 .if !'po4a'hide' .B ] [\-k
19 .if !'po4a'hide' .B ] [\-n
21 .if !'po4a'hide' .B ] [\-O
28 is a high\-performance proxy caching server for web clients,
29 supporting FTP, gopher, ICAP, ICP, HTCP and HTTP data objects.
30 Unlike traditional caching software,
31 Squid handles all requests in a single, non-blocking process.
33 Squid keeps meta data and especially hot objects cached in RAM,
34 caches DNS lookups, supports non\-blocking DNS lookups, and implements
35 negative caching of failed requests.
37 Squid supports SSL, extensive access controls, and full request logging.
38 By using the lightweight Internet Cache Protocols ICP, HTCP or CARP,
39 Squid caches can be arranged in a hierarchy or mesh for additional
42 Squid consists of a main server program
44 , some optional programs for
45 custom processing and authentication, and some management and client
46 tools. When squid starts up, it spawns a configurable number of
47 helper processes, each of which can perform parallel lookups.
48 This reduces the amount of time the cache waits for results.
50 Squid is derived from the ARPA\-funded Harvest Project.
52 This manual page only lists the command line arguments.
53 For details on how to configure Squid see the file
54 .BI @SYSCONFDIR@/squid.conf.documented,
55 the Squid wiki FAQ and examples at http://wiki.squid-cache.org/ ,
56 or the configuration manual on the Squid home page
57 .if !'po4a'hide' http://www.squid-cache.org/Doc/config/
60 .if !'po4a'hide' .TP 12
61 .if !'po4a'hide' .B "\-a port"
62 Specify HTTP port number where Squid should listen for requests, in addition to any
68 .if !'po4a'hide' .B \-C
69 Do not catch fatal signals.
72 .if !'po4a'hide' .B "\-d level"
73 Write debugging to stderr also.
76 .if !'po4a'hide' .B "\-f file"
77 Use the given config-file instead of
78 .B @SYSCONFDIR@/squid.conf .
79 If the file name starts with a
83 then it is assumed to be an external command or command line.
84 Can for example be used to pre\-process the configuration before it is being read by Squid.
85 To facilitate this Squid also understands the common #line notion to indicate the real source file.
88 .if !'po4a'hide' .B \-F
89 Don't serve any requests until store is rebuilt.
92 .if !'po4a'hide' .B \-h
96 .if !'po4a'hide' .B \-i
97 Install as a Windows Service (see
102 .if !'po4a'hide' .B "\-k reconfigure | rotate | shutdown | interrupt | kill | debug | check | parse"
103 Parse configuration file, then send signal to running copy
109 .if !'po4a'hide' .B "\-l facility"
110 Use specified syslog facility. Implies
114 .if !'po4a'hide' .B "\-n name"
115 Specify Windows Service name to use for service operations, default is:
119 .if !'po4a'hide' .B \-N
123 .if !'po4a'hide' .B "\-O options"
124 Set Windows Service Command line options in Registry.
127 .if !'po4a'hide' .B \-r
128 Remove a Windows Service (see
133 .if !'po4a'hide' .B \-R
139 .if !'po4a'hide' .B \-s
140 Enable logging to syslog. Also configurable in
141 .BI @SYSCONFDIR@/squid.conf
144 .if !'po4a'hide' .B \-S
145 Double-check swap during rebuild.
148 .if !'po4a'hide' .B "\-u port"
149 Specify ICP port number (default: 3130), disable with 0.
152 .if !'po4a'hide' .B \-v
153 Print version and build details.
156 .if !'po4a'hide' .B \-X
157 Force full debugging.
160 .if !'po4a'hide' .B \-Y
168 .if !'po4a'hide' .B \-z
169 Create missing swap directories and other missing cache_dir structures,
170 then exit. All cache_dir types create the configured top-level directory if
171 it is missing. Other actions are type-specific. For example, ufs-based
172 storage systems create missing L1 and L2 directories while Rock creates
173 the missing database file.
175 This option does not enable validation of any present swap structures. Its
176 focus is on creation of missing pieces. If nothing is missing, squid -z
177 just exits. If you suspect cache_dir corruption, you must delete the top-level
178 cache_dir directory before running squid -z.
180 By default, squid -z runs in daemon mode (so that configuration macros and
181 other SMP features work as expected). Use
183 option to overwrite this.
186 Squid configuration files located in @SYSCONFDIR@/:
188 .if !'po4a'hide' .IP "squid.conf"
189 The main configuration file. You must initially make changes to this file for
191 to work. For example, the default configuration only allows access from RFC private LAN networks.
192 Some packaging distributions block even that.
194 .if !'po4a'hide' .IP "squid.conf.default"
195 Reference copy of the configuration file. Always kept up to date with
196 the version of Squid you are using.
198 Use this to look up the default configuration settings and syntax after upgrading.
200 .if !'po4a'hide' .IP "squid.conf.documented"
201 Reference copy of the configuration file. Always kept up to date with
202 the version of Squid you are using.
204 Use this to read the documentation for configuration options available in
205 your build of Squid. The online configuration manual is also available for
206 a full reference of options.
207 .BR see http://www.squid-cache.org/Doc/config/
209 .if !'po4a'hide' .IP "cachemgr.conf"
210 The main configuration file for the web
214 .if !'po4a'hide' .IP "msntauth.conf"
215 The main configuration file for the Sample MSNT authenticator.
217 .if !'po4a'hide' .IP "errorpage.css"
218 CSS Stylesheet to control the display of generated error pages.
219 Use this to set any company branding you need, it will apply to every
220 language Squid provides error pages for.
223 Some files also located elsewhere:
225 .if !'po4a'hide' .IP "@DEFAULT_MIME_TABLE@ (mime_table)"
226 MIME type mappings for FTP gatewaying
228 .if !'po4a'hide' .IP "@DEFAULT_ERROR_DIR@"
229 Location of Squid error pages and templates.
232 Squid was written over many years by a changing team of developers and maintained in turn by
233 .if !'po4a'hide' .I Duane Wessels <duane@squid-cache.org>
234 .if !'po4a'hide' .I Henrik Nordstrom <hno@squid-cache.org>
235 .if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
237 With contributions from many others in the Squid community.
238 see CONTRIBUTORS for a full list of individuals who contributed code.
239 see CREDITS for a list of major code contributing copyright holders.
243 * Copyright (C) 1996-2014 The Squid Software Foundation and contributors
245 * Squid software is distributed under GPLv2+ license and includes
246 * contributions from numerous individuals and organizations.
247 * Please see the COPYING and CONTRIBUTORS files for details.
250 Questions on the usage of this program can be sent to the
251 .I Squid Users mailing list
252 .if !'po4a'hide' <squid-users@squid-cache.org>
255 Bug reports need to be made in English.
256 See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
258 Report bugs or bug fixes using http://bugs.squid-cache.org/
260 Report serious security bugs to
261 .I Squid Bugs <squid-bugs@squid-cache.org>
263 Report ideas for new improvements to the
264 .I Squid Developers mailing list
265 .if !'po4a'hide' <squid-dev@squid-cache.org>
268 .if !'po4a'hide' .B cachemgr.cgi "(8), "
269 .if !'po4a'hide' .B squidclient "(1), "
270 .if !'po4a'hide' .B pam_auth "(8), "
271 .if !'po4a'hide' .B squid_ldap_auth "(8), "
272 .if !'po4a'hide' .B squid_ldap_group "(8), "
273 .if !'po4a'hide' .B ext_session_acl "(8), "
274 .if !'po4a'hide' .B squid_unix_group "(8), "
277 .if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
279 The Squid Configuration Manual
280 .if !'po4a'hide' http://www.squid-cache.org/Doc/config/