Source Format Enforcement (#763)

[thirdparty/squid.git] / src / squid.8.in

.if !'po4a'hide' .TH squid 8
.
.SH NAME
squid \- HTTP web proxy caching server
.
.SH SYNOPSIS
.if !'po4a'hide' .B squid
.if !'po4a'hide' .B [\-dhisrvzCFNRSVYX]
.if !'po4a'hide' .B [\--foreground]
.if !'po4a'hide' .B [\-l
facility
.if !'po4a'hide' .B ] [\-f
config\-file
.if !'po4a'hide' .B ] [\-[au]
port
.if !'po4a'hide' .B ] [\-k
signal
.if !'po4a'hide' .B ] [\-n
service\-name
.if !'po4a'hide' .B ] [\-O
command\-line
.if !'po4a'hide' .B ]
.
.SH DESCRIPTION
.PP
.B squid
is a high\-performance proxy caching server for web clients,
supporting FTP, gopher, ICAP, ICP, HTCP and HTTP data objects.
Unlike traditional caching software, 
Squid handles all requests in a single, non-blocking process.
.PP
Squid keeps meta data and especially hot objects cached in RAM, 
caches DNS lookups, supports non\-blocking DNS lookups, and implements
negative caching of failed requests.
.PP
Squid supports SSL, extensive access controls, and full request logging. 
By using the lightweight Internet Cache Protocols ICP, HTCP or CARP, 
Squid caches can be arranged in a hierarchy or mesh for additional 
bandwidth savings.
.PP
Squid consists of a main server program
.B squid
, some optional programs for 
custom processing and authentication, and some management and client
tools.  When squid starts up, it spawns a configurable number of
helper processes, each of which can perform parallel lookups.
This reduces the amount of time the cache waits for results.
.PP
Squid is derived from the ARPA\-funded Harvest Project.
.PP
This manual page only lists the command line arguments.
For details on how to configure Squid see the file 
.BI @SYSCONFDIR@/squid.conf.documented,
the Squid wiki FAQ and examples at http://wiki.squid-cache.org/ ,
or the configuration manual on the Squid home page
.if !'po4a'hide' http://www.squid-cache.org/Doc/config/
.
.SH OPTIONS
.if !'po4a'hide' .TP 12
.if !'po4a'hide' .B "\-a port"
Specify HTTP port number where Squid should listen for requests, in addition to any
.B http_port
specifications in 
.B squid.conf
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-C
Do not catch fatal signals.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-d level"
Write debugging to stderr also.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-f file"
Use the given config-file instead of
.B @SYSCONFDIR@/squid.conf .
If the file name starts with a 
.B !
or
.B |
then it is assumed to be an external command or command line.
Can for example be used to pre\-process the configuration before it is being read by Squid.
To facilitate this Squid also understands the common #line notion to indicate the real source file.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-F
Don't serve any requests until store is rebuilt.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-h
Print help message.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-i
Install as a Windows Service (see
.B \-n
option).
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-k reconfigure | rotate | shutdown | interrupt | kill | debug | check | parse"
Parse configuration file, then send signal to running copy 
(except
.B "\-k parse"
) and exit.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-l facility"
Use specified syslog facility. Implies
.B \-s
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-n name"
Specify Windows Service name to use for service operations, default is: 
.B Squid
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-N
No daemon mode.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \--foreground
Parent process does not exit until its children have finished. It has no effect with
.B \-N
which does not fork/exit at startup.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\--kid roleID"
Play a given SMP kid process role, with a given ID. Do not use
this option. It is meant for the master process use only.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-O options"
Set Windows Service Command line options in Registry.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-r
Remove a Windows Service (see
.B \-n
option).
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-R
Do not set
.B REUSEADDR
on port.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-s
Enable logging to syslog. Also configurable in
.BI @SYSCONFDIR@/squid.conf
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-S
Double-check swap during rebuild.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B "\-u port"
Specify ICP port number (default: 3130), disable with 0.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-v
Print version and build details.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-X
Force full debugging.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-Y
Only return
.B UDP_HIT
or
.B UDP_MISS_NOFETCH
during fast reload.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-z
Create missing swap directories and other missing cache_dir structures,
then exit. All cache_dir types create the configured top-level directory if 
it is missing. Other actions are type-specific. For example, ufs-based
storage systems create missing L1 and L2 directories while Rock creates
the missing database file.
.IP
This option does not enable validation of any present swap structures. Its
focus is on creation of missing pieces. If nothing is missing, squid -z 
just exits. If you suspect cache_dir corruption, you must delete the top-level
cache_dir directory before running squid -z.
.IP
By default, squid -z runs in daemon mode (so that configuration macros and
other SMP features work as expected), returning control to the caller 
before cache_dirs are fully initialized. If run from init scripts or
daemon managers, the caller often needs to wait for the initialization to
complete before proceeding further.
Use
.B \--foreground
option to prevent premature exits. To disable daemon mode, use
.B \-N
option.
.
.SH FILES
Squid configuration files located in @SYSCONFDIR@/:
.
.if !'po4a'hide' .IP "squid.conf"
The main configuration file. You must initially make changes to this file for 
.B squid
to work. For example, the default configuration only allows access from RFC private LAN networks.
Some packaging distributions block even that.
.
.if !'po4a'hide' .IP "squid.conf.default"
Reference copy of the configuration file. Always kept up to date with
the version of Squid you are using.
.IP
Use this to look up the default configuration settings and syntax after upgrading.
.
.if !'po4a'hide' .IP "squid.conf.documented"
Reference copy of the configuration file. Always kept up to date with
the version of Squid you are using.
.IP
Use this to read the documentation for configuration options available in
your build of Squid. The online configuration manual is also available for
a full reference of options.
.BR see http://www.squid-cache.org/Doc/config/
.
.if !'po4a'hide' .IP "cachemgr.conf"
The main configuration file for the web
.B cachemgr.cgi
tools.
.
.if !'po4a'hide' .IP "msntauth.conf"
The main configuration file for the Sample MSNT authenticator.
.
.if !'po4a'hide' .IP "errorpage.css"
CSS Stylesheet to control the display of generated error pages.
Use this to set any company branding you need, it will apply to every
language Squid provides error pages for.
.PP
.br
Some files also located elsewhere:
.
.if !'po4a'hide' .IP "@DEFAULT_MIME_TABLE@ (mime_table)"
MIME type mappings for FTP gatewaying
.
.if !'po4a'hide' .IP "@DEFAULT_ERROR_DIR@"
Location of Squid error pages and templates.
.
.SH AUTHOR
Squid was written over many years by a changing team of developers and maintained in turn by
.if !'po4a'hide' .I Duane Wessels <duane@squid-cache.org>
.if !'po4a'hide' .I Henrik Nordstrom <hno@squid-cache.org>
.if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
.PP
With contributions from many others in the Squid community.
see CONTRIBUTORS for a full list of individuals who contributed code.
see CREDITS for a list of major code contributing copyright holders.
.
.SH COPYRIGHT
.PP
 * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
.
.SH QUESTIONS
Questions on the usage of this program can be sent to the
.I Squid Users mailing list
.if !'po4a'hide' <squid-users@lists.squid-cache.org>
.
.SH REPORTING BUGS
Bug reports need to be made in English.
See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
.PP
Report bugs or bug fixes using http://bugs.squid-cache.org/
.PP
Report serious security bugs to
.I Squid Bugs <squid-bugs@lists.squid-cache.org>
.PP
Report ideas for new improvements to the
.I Squid Developers mailing list
.if !'po4a'hide' <squid-dev@lists.squid-cache.org>
.
.SH SEE ALSO
.if !'po4a'hide' .B cachemgr.cgi "(8), "
.if !'po4a'hide' .B squidclient "(1), "
.if !'po4a'hide' .B basic_pam_auth "(8), "
.if !'po4a'hide' .B basic_ldap_auth "(8), "
.if !'po4a'hide' .B ext_ldap_group_acl "(8), "
.if !'po4a'hide' .B ext_session_acl "(8), "
.if !'po4a'hide' .B ext_unix_group_acl "(8), "
.br
The Squid FAQ wiki
.if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
.br
The Squid Configuration Manual
.if !'po4a'hide' http://www.squid-cache.org/Doc/config/