Commit 65a15b75 authored by Dag Erling Smørgrav's avatar Dag Erling Smørgrav

Improve the descriptions of some of the options and parameters.


git-svn-id: http://www.varnish-cache.org/svn/trunk/varnish-cache@1439 d4fa192b-c00b-0410-8231-f00ffab90ce4
parent 5f0a5e21
...@@ -64,13 +64,17 @@ and ...@@ -64,13 +64,17 @@ and
.Ar port . .Ar port .
The The
.Ar address .Ar address
can be a host name, an IPv4 dotted-quad, or an IPv6 address enclosed can be a host name
in square brackets. .Pq Dq localhost ,
an IPv4 dotted-quad
.Pq Dq 127.0.0.1 ,
or an IPv6 address enclosed in square brackets
.Pq Dq [::1] .
If If
.Ar address .Ar address
is not specified, is not specified,
.Nm .Nm
will listen on all available interfaces. will listen on all available IPv4 and IPv6 interfaces.
If If
.Ar port .Ar port
is not specified, the default HTTP port as listed in is not specified, the default HTTP port as listed in
...@@ -107,6 +111,9 @@ terminating the parent process will also terminate the child. ...@@ -107,6 +111,9 @@ terminating the parent process will also terminate the child.
.It Fl f Ar config .It Fl f Ar config
Use the specified VCL configuration file instead of the builtin Use the specified VCL configuration file instead of the builtin
default. default.
See
.Xr vcl 7
for details on VCL syntax.
.It Fl h Ar type Ns Op , Ns Ar options .It Fl h Ar type Ns Op , Ns Ar options
Specifies the hash algorithm. Specifies the hash algorithm.
See See
...@@ -138,6 +145,9 @@ See ...@@ -138,6 +145,9 @@ See
for a list of management commands. for a list of management commands.
.It Fl t Ar ttl .It Fl t Ar ttl
Specifies a hard minimum time to live for cached documents. Specifies a hard minimum time to live for cached documents.
This is a shortcut for specifying the
.Va default_ttl
run-time parameter.
.It Fl V .It Fl V
Display the version number and exit. Display the version number and exit.
.It Fl w Ar min Ns Op , Ns Ar max Ns Op , Ns Ar timeout .It Fl w Ar min Ns Op , Ns Ar max Ns Op , Ns Ar timeout
...@@ -146,31 +156,20 @@ Start at least ...@@ -146,31 +156,20 @@ Start at least
but no more than but no more than
.Ar max .Ar max
worker threads with the specified idle timeout. worker threads with the specified idle timeout.
This is a shortcut for specifying the
.Va thread_pool_min ,
.Va thread_pool_max
and
.Va thread_pool_timeout
run-time parameters.
.Pp .Pp
If only If only one number is specified,
.Ar min .Va thread_pool_min
is specified,
.Nm
will start
.Ar min
threads and will not kill idle threads.
.Pp
If both
.Ar min
and and
.Ar max .Va thread_pool_max
are specified, the number of threads is allowed to vary within the are both set to this number, and
specified range according to system load. .Va thread_pool_timeout
Idle threads are killed after has no effect.
.Ar timeout
seconds.
.Pp
The default values are 1 for
.Ar min ,
1000 for
.Ar max ,
and 10 for
.Ar timeout .
.El .El
.Ss Hash Algorithms .Ss Hash Algorithms
The following hash algorithms are available: The following hash algorithms are available:
...@@ -439,7 +438,9 @@ restart. ...@@ -439,7 +438,9 @@ restart.
.Pp .Pp
The default is 1. The default is 1.
.It Va thread_pool_timeout .It Va thread_pool_timeout
The time to wait before killing an idle worker thread. The amount of time a worker thread can be idle before it is killed,
when the number of worker threads exceeds
.Va thread_pool_min .
.Pp .Pp
The default is 120 seconds. The default is 120 seconds.
.It Va vcl_trace .It Va vcl_trace
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment