source: squid-ssl/trunk/fuentes/src/squid.8 @ 5495

Last change on this file since 5495 was 5495, checked in by Juanma, 21 months ago

Initial release

File size: 8.3 KB
Line 
1.if !'po4a'hide' .TH squid 8
2.
3.SH NAME
4squid \- HTTP web proxy caching server
5.
6.SH SYNOPSIS
7.if !'po4a'hide' .B squid
8.if !'po4a'hide' .B [\-dhisrvzCFNRSVYX]
9.if !'po4a'hide' .B [\-l
10facility
11.if !'po4a'hide' .B ] [\-f
12config\-file
13.if !'po4a'hide' .B ] [\-[au]
14port
15.if !'po4a'hide' .B ] [\-k
16signal
17.if !'po4a'hide' .B ] [\-n
18service\-name
19.if !'po4a'hide' .B ] [\-O
20command\-line
21.if !'po4a'hide' .B ]
22.
23.SH DESCRIPTION
24.PP
25.B squid
26is a high\-performance proxy caching server for web clients,
27supporting FTP, gopher, ICAP, ICP, HTCP and HTTP data objects.
28Unlike traditional caching software,
29Squid handles all requests in a single, non-blocking process.
30.PP
31Squid keeps meta data and especially hot objects cached in RAM,
32caches DNS lookups, supports non\-blocking DNS lookups, and implements
33negative caching of failed requests.
34.PP
35Squid supports SSL, extensive access controls, and full request logging.
36By using the lightweight Internet Cache Protocols ICP, HTCP or CARP,
37Squid caches can be arranged in a hierarchy or mesh for additional
38bandwidth savings.
39.PP
40Squid consists of a main server program
41.B squid
42, some optional programs for
43custom processing and authentication, and some management and client
44tools.  When squid starts up, it spawns a configurable number of
45helper processes, each of which can perform parallel lookups.
46This reduces the amount of time the cache waits for results.
47.PP
48Squid is derived from the ARPA\-funded Harvest Project.
49.PP
50This manual page only lists the command line arguments.
51For details on how to configure Squid see the file
52.BI /etc/squid-ssl/squid.conf.documented,
53the Squid wiki FAQ and examples at http://wiki.squid-cache.org/ ,
54or the configuration manual on the Squid home page
55.if !'po4a'hide' http://www.squid-cache.org/Doc/config/
56.
57.SH OPTIONS
58.if !'po4a'hide' .TP 12
59.if !'po4a'hide' .B "\-a port"
60Specify HTTP port number where Squid should listen for requests, in addition to any
61.B http_port
62specifications in
63.B squid.conf
64.
65.if !'po4a'hide' .TP
66.if !'po4a'hide' .B \-C
67Do not catch fatal signals.
68.
69.if !'po4a'hide' .TP
70.if !'po4a'hide' .B "\-d level"
71Write debugging to stderr also.
72.
73.if !'po4a'hide' .TP
74.if !'po4a'hide' .B "\-f file"
75Use the given config-file instead of
76.B /etc/squid-ssl/squid.conf .
77If the file name starts with a
78.B !
79or
80.B |
81then it is assumed to be an external command or command line.
82Can for example be used to pre\-process the configuration before it is being read by Squid.
83To facilitate this Squid also understands the common #line notion to indicate the real source file.
84.
85.if !'po4a'hide' .TP
86.if !'po4a'hide' .B \-F
87Don't serve any requests until store is rebuilt.
88.
89.if !'po4a'hide' .TP
90.if !'po4a'hide' .B \-h
91Print help message.
92.
93.if !'po4a'hide' .TP
94.if !'po4a'hide' .B \-i
95Install as a Windows Service (see
96.B \-n
97option).
98.
99.if !'po4a'hide' .TP
100.if !'po4a'hide' .B "\-k reconfigure | rotate | shutdown | interrupt | kill | debug | check | parse"
101Parse configuration file, then send signal to running copy
102(except
103.B "\-k parse"
104) and exit.
105.
106.if !'po4a'hide' .TP
107.if !'po4a'hide' .B "\-l facility"
108Use specified syslog facility. Implies
109.B \-s
110.
111.if !'po4a'hide' .TP
112.if !'po4a'hide' .B "\-n name"
113Specify Windows Service name to use for service operations, default is:
114.B Squid
115.
116.if !'po4a'hide' .TP
117.if !'po4a'hide' .B \-N
118No daemon mode.
119.
120.if !'po4a'hide' .TP
121.if !'po4a'hide' .B "\-O options"
122Set Windows Service Command line options in Registry.
123.
124.if !'po4a'hide' .TP
125.if !'po4a'hide' .B \-r
126Remove a Windows Service (see
127.B \-n
128option).
129.
130.if !'po4a'hide' .TP
131.if !'po4a'hide' .B \-R
132Do not set
133.B REUSEADDR
134on port.
135.
136.if !'po4a'hide' .TP
137.if !'po4a'hide' .B \-s
138Enable logging to syslog. Also configurable in
139.BI /etc/squid-ssl/squid.conf
140.
141.if !'po4a'hide' .TP
142.if !'po4a'hide' .B \-S
143Double-check swap during rebuild.
144.
145.if !'po4a'hide' .TP
146.if !'po4a'hide' .B "\-u port"
147Specify ICP port number (default: 3130), disable with 0.
148.
149.if !'po4a'hide' .TP
150.if !'po4a'hide' .B \-v
151Print version and build details.
152.
153.if !'po4a'hide' .TP
154.if !'po4a'hide' .B \-X
155Force full debugging.
156.
157.if !'po4a'hide' .TP
158.if !'po4a'hide' .B \-Y
159Only return
160.B UDP_HIT
161or
162.B UDP_MISS_NOFETCH
163during fast reload.
164.
165.if !'po4a'hide' .TP
166.if !'po4a'hide' .B \-z
167Create missing swap directories and other missing cache_dir structures,
168then exit. All cache_dir types create the configured top-level directory if
169it is missing. Other actions are type-specific. For example, ufs-based
170storage systems create missing L1 and L2 directories while Rock creates
171the missing database file.
172.IP
173This option does not enable validation of any present swap structures. Its
174focus is on creation of missing pieces. If nothing is missing, squid -z
175just exits. If you suspect cache_dir corruption, you must delete the top-level
176cache_dir directory before running squid -z.
177.IP
178By default, squid -z runs in daemon mode (so that configuration macros and
179other SMP features work as expected). Use
180.B \-N
181option to overwrite this.
182.
183.SH FILES
184Squid configuration files located in /etc/squid-ssl/:
185.
186.if !'po4a'hide' .IP "squid.conf"
187The main configuration file. You must initially make changes to this file for
188.B squid
189to work. For example, the default configuration only allows access from RFC private LAN networks.
190Some packaging distributions block even that.
191.
192.if !'po4a'hide' .IP "squid.conf.default"
193Reference copy of the configuration file. Always kept up to date with
194the version of Squid you are using.
195.IP
196Use this to look up the default configuration settings and syntax after upgrading.
197.
198.if !'po4a'hide' .IP "squid.conf.documented"
199Reference copy of the configuration file. Always kept up to date with
200the version of Squid you are using.
201.IP
202Use this to read the documentation for configuration options available in
203your build of Squid. The online configuration manual is also available for
204a full reference of options.
205.BR see http://www.squid-cache.org/Doc/config/
206.
207.if !'po4a'hide' .IP "cachemgr.conf"
208The main configuration file for the web
209.B cachemgr.cgi
210tools.
211.
212.if !'po4a'hide' .IP "msntauth.conf"
213The main configuration file for the Sample MSNT authenticator.
214.
215.if !'po4a'hide' .IP "errorpage.css"
216CSS Stylesheet to control the display of generated error pages.
217Use this to set any company branding you need, it will apply to every
218language Squid provides error pages for.
219.PP
220.br
221Some files also located elsewhere:
222.
223.if !'po4a'hide' .IP "/usr/share/squid-ssl/mime.conf (mime_table)"
224MIME type mappings for FTP gatewaying
225.
226.if !'po4a'hide' .IP "/usr/share/squid-ssl/errors"
227Location of Squid error pages and templates.
228.
229.SH AUTHOR
230Squid was written over many years by a changing team of developers and maintained in turn by
231.if !'po4a'hide' .I Duane Wessels <duane@squid-cache.org>
232.if !'po4a'hide' .I Henrik Nordstrom <hno@squid-cache.org>
233.if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
234.PP
235With contributions from many others in the Squid community.
236see CONTRIBUTORS for a full list of individuals who contributed code.
237see CREDITS for a list of major code contributing copyright holders.
238.
239.SH COPYRIGHT
240.PP
241 * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
242 *
243 * Squid software is distributed under GPLv2+ license and includes
244 * contributions from numerous individuals and organizations.
245 * Please see the COPYING and CONTRIBUTORS files for details.
246.
247.SH QUESTIONS
248Questions on the usage of this program can be sent to the
249.I Squid Users mailing list
250.if !'po4a'hide' <squid-users@squid-cache.org>
251.
252.SH REPORTING BUGS
253Bug reports need to be made in English.
254See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
255.PP
256Report bugs or bug fixes using http://bugs.squid-cache.org/
257.PP
258Report serious security bugs to
259.I Squid Bugs <squid-bugs@squid-cache.org>
260.PP
261Report ideas for new improvements to the
262.I Squid Developers mailing list
263.if !'po4a'hide' <squid-dev@squid-cache.org>
264.
265.SH SEE ALSO
266.if !'po4a'hide' .B cachemgr.cgi "(8), "
267.if !'po4a'hide' .B squidclient "(1), "
268.if !'po4a'hide' .B pam_auth "(8), "
269.if !'po4a'hide' .B squid_ldap_auth "(8), "
270.if !'po4a'hide' .B squid_ldap_group "(8), "
271.if !'po4a'hide' .B ext_session_acl "(8), "
272.if !'po4a'hide' .B squid_unix_group "(8), "
273.br
274The Squid FAQ wiki
275.if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
276.br
277The Squid Configuration Manual
278.if !'po4a'hide' http://www.squid-cache.org/Doc/config/
Note: See TracBrowser for help on using the repository browser.