src/squid.8.in

   1 .if !'po4a'hide' .TH squid 8
   2 .
   3 .SH NAME
   4 .if !'po4a'hide' .B squid
   5 .if !'po4a'hide' \-
   6 HTTP web proxy caching server
   7 .
   8 .SH SYNOPSIS
   9 .if !'po4a'hide' .B squid
  10 .if !'po4a'hide' .B [\-dhisrvzCFNRSVYX]
  11 .if !'po4a'hide' .B [\-l
  12 facility
  13 .if !'po4a'hide' .B ] [\-f
  14 config\-file
  15 .if !'po4a'hide' .B ] [\-[au]
  16 port
  17 .if !'po4a'hide' .B ] [\-k
  18 signal
  19 .if !'po4a'hide' .B ] [\-n
  20 service\-name
  21 .if !'po4a'hide' .B ] [\-O
  22 command\-line
  23 .if !'po4a'hide' .B ]
  24 .
  25 .SH DESCRIPTION
  26 .PP
  27 .B squid
  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.
  32 .PP
  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.
  36 .PP
  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
  40 bandwidth savings.
  41 .PP
  42 Squid consists of a main server program
  43 .B squid
  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.
  49 .PP
  50 Squid is derived from the ARPA\-funded Harvest Project.
  51 .PP
  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/
  58 .
  59 .SH OPTIONS
  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
  63 .B http_port
  64 specifications in
  65 .B squid.conf
  66 .
  67 .if !'po4a'hide' .TP
  68 .if !'po4a'hide' .B \-C
  69 Do not catch fatal signals.
  70 .
  71 .if !'po4a'hide' .TP
  72 .if !'po4a'hide' .B "\-d level"
  73 Write debugging to stderr also.
  74 .
  75 .if !'po4a'hide' .TP
  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
  80 .B !
  81 or
  82 .B |
  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.
  86 .
  87 .if !'po4a'hide' .TP
  88 .if !'po4a'hide' .B \-F
  89 Don't serve any requests until store is rebuilt.
  90 .
  91 .if !'po4a'hide' .TP
  92 .if !'po4a'hide' .B \-h
  93 Print help message.
  94 .
  95 .if !'po4a'hide' .TP
  96 .if !'po4a'hide' .B \-i
  97 Install as a Windows Service (see
  98 .B \-n
  99 option).
 100 .
 101 .if !'po4a'hide' .TP
 102 .if !'po4a'hide' .B "\-k reconfigure | rotate | shutdown | interrupt | kill | debug | check | parse"
 103 Parse configuration file, then send signal to running copy
 104 (except
 105 .B "\-k parse"
 106 ) and exit.
 107 .
 108 .if !'po4a'hide' .TP
 109 .if !'po4a'hide' .B "\-l facility"
 110 Use specified syslog facility. Implies
 111 .B \-s
 112 .
 113 .if !'po4a'hide' .TP
 114 .if !'po4a'hide' .B "\-n name"
 115 Specify Windows Service name to use for service operations, default is:
 116 .B Squid
 117 .
 118 .if !'po4a'hide' .TP
 119 .if !'po4a'hide' .B \-N
 120 No daemon mode.
 121 .
 122 .if !'po4a'hide' .TP
 123 .if !'po4a'hide' .B "\-O options"
 124 Set Windows Service Command line options in Registry.
 125 .
 126 .if !'po4a'hide' .TP
 127 .if !'po4a'hide' .B \-r
 128 Remove a Windows Service (see
 129 .B \-n
 130 option).
 131 .
 132 .if !'po4a'hide' .TP
 133 .if !'po4a'hide' .B \-R
 134 Do not set
 135 .B REUSEADDR
 136 on port.
 137 .
 138 .if !'po4a'hide' .TP
 139 .if !'po4a'hide' .B \-s
 140 Enable logging to syslog. Also configurable in
 141 .BI @SYSCONFDIR@/squid.conf
 142 .
 143 .if !'po4a'hide' .TP
 144 .if !'po4a'hide' .B \-S
 145 Double-check swap during rebuild.
 146 .
 147 .if !'po4a'hide' .TP
 148 .if !'po4a'hide' .B "\-u port"
 149 Specify ICP port number (default: 3130), disable with 0.
 150 .
 151 .if !'po4a'hide' .TP
 152 .if !'po4a'hide' .B \-v
 153 Print version and build details.
 154 .
 155 .if !'po4a'hide' .TP
 156 .if !'po4a'hide' .B \-X
 157 Force full debugging.
 158 .
 159 .if !'po4a'hide' .TP
 160 .if !'po4a'hide' .B \-Y
 161 Only return
 162 .B UDP_HIT
 163 or
 164 .B UDP_MISS_NOFETCH
 165 during fast reload.
 166 .
 167 .if !'po4a'hide' .TP
 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.
 174 .IP
 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.
 179 .IP
 180 By default, squid -z runs in daemon mode (so that configuration macros and
 181 other SMP features work as expected). Use
 182 .B \-N
 183 option to overwrite this.
 184 .
 185 .SH FILES
 186 Squid configuration files located in @SYSCONFDIR@/:
 187 .
 188 .if !'po4a'hide' .IP "squid.conf"
 189 The main configuration file. You must initially make changes to this file for
 190 .B squid
 191 to work. For example, the default configuration only allows access from RFC private LAN networks.
 192 Some packaging distributions block even that.
 193 .
 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.
 197 .IP
 198 Use this to look up the default configuration settings and syntax after upgrading.
 199 .
 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.
 203 .IP
 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/
 208 .
 209 .if !'po4a'hide' .IP "cachemgr.conf"
 210 The main configuration file for the web
 211 .B cachemgr.cgi
 212 tools.
 213 .
 214 .if !'po4a'hide' .IP "msntauth.conf"
 215 The main configuration file for the Sample MSNT authenticator.
 216 .
 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.
 221 .PP
 222 .br
 223 Some files also located elsewhere:
 224 .
 225 .if !'po4a'hide' .IP "@DEFAULT_MIME_TABLE@ (mime_table)"
 226 MIME type mappings for FTP gatewaying
 227 .
 228 .if !'po4a'hide' .IP "@DEFAULT_ERROR_DIR@"
 229 Location of Squid error pages and templates.
 230 .
 231 .SH AUTHOR
 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>
 236 .PP
 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.
 240 .
 241 .SH COPYRIGHT
 242 .PP
 243 This software product, SQUID, is developed by a team of individuals,
 244 and copyrighted (C) 2001 by the Regents of the University of
 245 California, with all rights reserved.  UCSD administered the NLANR
 246 Cache grants, NCR 9616602 and NCR 9521745 under which most of this
 247 code was developed.
 248 .PP
 249 This program is free software; you can redistribute it and/or modify it
 250 under the terms of the GNU General Public License (version 2) as
 251 published by the Free Software Foundation.  It is distributed in the
 252 hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
 253 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 254 PURPOSE.  See the GNU General Public License for more details.
 255 .PP
 256 see the CREDITS file for further copyright licensing of third-party code contributions.
 257 .
 258 .SH QUESTIONS
 259 Questions on the usage of this program can be sent to the
 260 .I Squid Users mailing list
 261 .if !'po4a'hide' <squid-users@squid-cache.org>
 262 .
 263 .SH REPORTING BUGS
 264 Bug reports need to be made in English.
 265 See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
 266 .PP
 267 Report bugs or bug fixes using http://bugs.squid-cache.org/
 268 .PP
 269 Report serious security bugs to
 270 .I Squid Bugs <squid-bugs@squid-cache.org>
 271 .PP
 272 Report ideas for new improvements to the
 273 .I Squid Developers mailing list
 274 .if !'po4a'hide' <squid-dev@squid-cache.org>
 275 .
 276 .SH SEE ALSO
 277 .if !'po4a'hide' .B cachemgr.cgi "(8), "
 278 .if !'po4a'hide' .B squidclient "(1), "
 279 .if !'po4a'hide' .B pam_auth "(8), "
 280 .if !'po4a'hide' .B squid_ldap_auth "(8), "
 281 .if !'po4a'hide' .B squid_ldap_group "(8), "
 282 .if !'po4a'hide' .B ext_session_acl "(8), "
 283 .if !'po4a'hide' .B squid_unix_group "(8), "
 284 .br
 285 The Squid FAQ wiki
 286 .if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
 287 .br
 288 The Squid Configuration Manual
 289 .if !'po4a'hide' http://www.squid-cache.org/Doc/config/