src/squid.8.in

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