cf.data.pre

-

	The default is 8 Megabytes.

cache_mem  8 MB
DOC_END


NAME: cache_swap_low
COMMENT: (percent, 0-100)
TYPE: int
DEFAULT: 90
LOC: Config.Swap.lowWaterMark
DOC_NONE

NAME: cache_swap_high
COMMENT: (percent, 0-100)
TYPE: int
DEFAULT: 95
LOC: Config.Swap.highWaterMark
DOC_START
	The low- and high-water marks for cache LRU replacement.  LRU
	replacement begins when the high-water mark is reached and ends
	when enough objects have been removed and the low-water mark is
	reached. Defaults are 90% and 95%. If you have a large cache, 5%
	could be hundreds of MB. If this is the case you may wish to
	set these numbers closer together.

cache_swap_low  90
cache_swap_high 95
DOC_END

NAME: maximum_object_size
COMMENT: (bytes)
TYPE: b_size_t
DEFAULT: 4096 KB
LOC: Config.Store.maxObjectSize
DOC_START
	Objects larger than this size will NOT be saved on disk.  The
	value is specified in kilobytes, and the default is 4MB.  If
	you wish to get a high BYTES hit ratio, you should probably
	increase this (one 32 MB object hit counts for 3200 10KB
	hits).  If you wish to increase speed more than your want to
	save bandwidth you should leave this low.

maximum_object_size 4096 KB
DOC_END


NAME: ipcache_size
COMMENT: (number of entries)
TYPE: int
DEFAULT: 1024
LOC: Config.ipcache.size
DOC_NONE

NAME: ipcache_low
COMMENT: (percent)
TYPE: int
DEFAULT: 90
LOC: Config.ipcache.low
DOC_NONE

NAME: ipcache_high
COMMENT: (percent)
TYPE: int
DEFAULT: 95
LOC: Config.ipcache.high
DOC_START
	The size, low-, and high-water marks for the IP cache.

ipcache_size 1024
ipcache_low  90
ipcache_high 95
DOC_END

NAME: fqdncache_size
COMMENT: (number of entries)
TYPE: int
DEFAULT: 1024
LOC: Config.fqdncache.size
DOC_START
	Maximum number of FQDN cache entries.
fqdncache_size 1024
DOC_END

COMMENT_START
 LOGFILE PATHNAMES AND CACHE DIRECTORIES
 -----------------------------------------------------------------------------
COMMENT_END

NAME: cache_dir
TYPE: cachedir
DEFAULT: none
DEFAULT_IF_NONE: @DEFAULT_SWAP_DIR@ 100 16 256
LOC: Config.cacheSwap
DOC_START
	Usage:
	
	cache_dir Directory-Name Mbytes Level-1 Level2

	You can specify multiple cache_dir lines to spread the
	cache among different disk partitions.

	'Directory' is a top-level directory where cache swap
	files will be stored.  If you want to use an entire disk
	for caching, then this can be the mount-point directory.
	The directory must exist and be writable by the Squid
	process.  Squid will NOT create this directory for you.

	If no 'cache_dir' lines are specified, the following
	default will be used: @DEFAULT_SWAP_DIR@.

	'Mbytes' is the amount of disk space (MB) to use under this
	directory.  The default is 100 MB.  Change this to suit your
	configuration.

	'Level-1' is the number of first-level subdirectories which
	will be created under the 'Directory'.  The default is 16.

	'Level-2' is the number of second-level subdirectories which
	will be created under each first-level directory.  The default
	is 256.

cache_dir @DEFAULT_SWAP_DIR@ 100 16 256
DOC_END


NAME: cache_access_log
TYPE: string
DEFAULT: @DEFAULT_ACCESS_LOG@
LOC: Config.Log.access
DOC_START
	Logs the client request activity.  Contains an entry for
	every HTTP and ICP request received.

cache_access_log @DEFAULT_ACCESS_LOG@
DOC_END


NAME: cache_log
TYPE: string
DEFAULT: @DEFAULT_CACHE_LOG@
LOC: Config.Log.log
DOC_START
	Cache logging file. This is where general information about
	your cache's behaviour goes. You can increase the amount of data
	logged to this file with the "debug_options" tag below.

cache_log @DEFAULT_CACHE_LOG@
DOC_END


NAME: cache_store_log
TYPE: string
DEFAULT: @DEFAULT_STORE_LOG@
LOC: Config.Log.store
DOC_START
	Logs the activities of the storage manager.  Shows which
	objects are ejected from the cache, and which objects are
	saved and for how long.  To disable, enter "none". There are
	not really utilities to analyse this data, so you can safely
	disable it.

cache_store_log @DEFAULT_STORE_LOG@
DOC_END


NAME: cache_swap_log
TYPE: string
LOC: Config.Log.swap
DEFAULT: none
DOC_START
	Location for the cache "swap.log."  This log file holds the
	metadata of objects saved on disk.  It is used to rebuild the
	cache during startup.  Normally this file resides in the first
	'cache_dir' directory, but you may specify an alternate
	pathname here.  Note you must give a full filename, not just
	a directory. Since this is the index for the whole object
	list you CANNOT periodically rotate it!

	If you have more than one 'cache_dir', these swap logs will
	have names such as:

		cache_swap_log.00
		cache_swap_log.01
		cache_swap_log.02

	The numbered extension (which is added automatically)
	corresponds to the order of the 'cache_dir' lines in this
	configuration file.  If you change the order of the 'cache_dir'
	lines in this file, then these log files will NOT correspond to
	the correct 'cache_dir' entry (unless you manually rename
	them).  We recommend that you do NOT use this option.  It is
	better to keep these log files in each 'cache_dir' directory.

cache_swap_log
DOC_END


NAME: emulate_httpd_log
COMMENT: on|off
TYPE: onoff
DEFAULT: off
LOC: Config.onoff.common_log
DOC_START
	The Cache can emulate the log file format which many 'httpd'
	programs use.  To disable/enable this emulation, set
	emulate_httpd_log to 'off' or 'on'.  The default
	is to use the native log format since it includes useful
	information that Squid-specific log analysers use.

emulate_httpd_log off
DOC_END


NAME: mime_table
TYPE: string
DEFAULT: @DEFAULT_MIME_TABLE@
LOC: Config.mimeTablePathname
DOC_START
	Pathname to Squid's MIME table. You shouldn't need to change
	this, but the default file contains examples and formatting
	information if you do.

mime_table @DEFAULT_MIME_TABLE@
DOC_END


NAME: log_mime_hdrs
COMMENT: on|off
TYPE: onoff
LOC: Config.onoff.log_mime_hdrs
DEFAULT: off
DOC_START
	The Cache can record both the request and the response MIME
	headers for each HTTP transaction.  The headers are encoded
	safely and will appear as two bracketed fields at the end of
	the access log (for either the native or httpd-emulated log
	formats).  To enable this logging set log_mime_hdrs to 'on'.

log_mime_hdrs off
DOC_END


NAME: useragent_log
TYPE: string
LOC: Config.Log.useragent
DEFAULT: none
DOC_START
	If configured with the "--enable-useragent_log" configure
	option, Squid will write the User-Agent field from HTTP
	requests to the filename specified here.  By default
	useragent_log is disabled.

useragent_log none
DOC_END


NAME: pid_filename
TYPE: string
DEFAULT: @DEFAULT_PID_FILE@
LOC: Config.pidFilename
DOC_START
	A filename to write the process-id to.  To disable, enter "none".

pid_filename @DEFAULT_PID_FILE@
DOC_END


NAME: debug_options
TYPE: eol
DEFAULT: ALL,1
LOC: Config.debugOptions
DOC_START
	Logging options are set as section,level where each source file
	is assigned a unique section.  Lower levels result in less
	output,  Full debugging (level 9) can result in a very large
	log file, so be careful.  The magic word "ALL" sets debugging
	levels for all sections.  We recommend normally running with
	"ALL,1".

debug_options ALL,1
DOC_END


NAME: log_fqdn
COMMENT: on|off
TYPE: onoff
DEFAULT: off
LOC: Config.onoff.log_fqdn
DOC_START
	Turn this on if you wish to log fully qualified domain names
	in the access.log. To do this Squid does a DNS lookup of all
	IP's connecting to it. This can (in some situations) increase
	latency, which makes your cache seem slower for interactive
	browsing. 

log_fqdn off
DOC_END


NAME: client_netmask
TYPE: address
LOC: Config.Addrs.client_netmask
DEFAULT: 255.255.255.255
DOC_START
	A netmask for client addresses in logfiles and cachemgr output.
	Change this to protect the privacy of your cache clients.
	A netmask of 255.255.255.0 will log all IP's in that range with
	the last digit set to '0'.

client_netmask 255.255.255.255
DOC_END


COMMENT_START
 OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
 -----------------------------------------------------------------------------
COMMENT_END

NAME: ftp_user
TYPE: string
DEFAULT: Squid@
LOC: Config.Ftp.anon_user
DOC_START
	If you want the anonymous login password to be more informative
	(and enable the use of picky ftp servers), set this to something
	resonable for your domain, like [e-mail]

	The reason why this is domainless by default is that the
	request can be made on the behalf of a user in any domain,
	depending on how the cache is used.
	Some ftp server also validate that the email address is valid
	(for example perl.com).

ftp_user Squid@
DOC_END

NAME: ftp_list_width
TYPE: size_t
DEFAULT: 32
LOC: Config.Ftp.list_width
DOC_START
	Sets the width of ftp listings. This should be set to fit in
	the width of a standard browser. Setting this too small
	can cut off long filenames when browsing ftp sites.

ftp_list_width 32
DOC_END

NAME: cache_dns_program
TYPE: string
DEFAULT: @DEFAULT_DNSSERVER@
LOC: Config.Program.dnsserver
DOC_START
	Specify the location of the executable for dnslookup process.

cache_dns_program @DEFAULT_DNSSERVER@
DOC_END

NAME: dns_children
TYPE: int
DEFAULT: 5
LOC: Config.dnsChildren
DOC_START
	The number of processes spawn to service DNS name lookups.
	For heavily loaded caches on large servers, you should
	probably increase this value to at least 10.  The maximum
	is 32.  The default is 5.

	To disable dnsservers, set this to 0.  NOTE, this is very
	strongly discouraged.  If you disable dnsservers your Squid
	process will BLOCK on DNS lookups!

dns_children 5
DOC_END


NAME: dns_defnames
COMMENT: on|off
TYPE: onoff
DEFAULT: off
LOC: Config.onoff.res_defnames
DOC_START
	Normally the 'dnsserver' disables the RES_DEFNAMES resolver
	option (see res_init(3)).  This prevents caches in a hierarchy
	from interpreting single-component hostnames locally.  To allow
	dnsserver to handle single-component names, enable this
	option.

dns_defnames off
DOC_END

NAME: dns_nameservers
TYPE: wordlist
DEFAULT: none
LOC: Config.dns_nameservers
DOC_START
	Use this if you want to specify a list of DNS name servers
	(IP addresses) to use instead of those given in your
	/etc/resolv.conf file.

	Example: dns_nameservers 10.0.0.1 192.172.0.4

dns_nameservers none
DOC_END


NAME: unlinkd_program
TYPE: string
DEFAULT: @DEFAULT_UNLINKD@
LOC: Config.Program.unlinkd
DOC_START
	Specify the location of the executable for file deletion process.
	This isn't needed if you are using async-io since it's handled by
	a thread.

unlinkd_program @DEFAULT_UNLINKD@
DOC_END


NAME: pinger_program
TYPE: string
DEFAULT: @DEFAULT_PINGER@
LOC: Config.Program.pinger
DOC_START
	Specify the location of the executable for the pinger process.
	This is only useful if you configured Squid (during compliation)
	with the '--enable-icmp' option.

pinger_program @DEFAULT_PINGER@
DOC_END


NAME: redirect_program
TYPE: string
LOC: Config.Program.redirect
DEFAULT: none
DOC_START
	Specify the location of the executable for the URL redirector.
	Since they can perform almost any function there isn't one included.
	See the Release-Notes for information on how to write one.
	By default, a redirector is not used.

redirect_program none
DOC_END


NAME: redirect_children
TYPE: int
DEFAULT: 5
LOC: Config.redirectChildren
DOC_START
	The number of redirector processes to spawn. If you start
	too few Squid will have to wait for them to process a backlog of
	URLs, slowing it down. If you start too many they will use RAM
	and other system resources.

redirect_children 5
DOC_END

NAME: redirect_rewrites_host_header
TYPE: onoff
DEFAULT: on
LOC: Config.onoff.redir_rewrites_host
DOC_START
	By default Squid rewrites any Host: header in redirected requests.
	If you are running a accelerator then this may not be a wanted effect
	of a redirector.
redirect_rewrites_host_header on
DOC_END


NAME: authenticate_program
TYPE: wordlist
LOC: Config.Program.authenticate
DEFAULT: none
DOC_START