[master] 67450d8 First attempt at params

Per Buer perbu at varnish-cache.org
Tue Feb 19 16:47:18 CET 2013

commit 67450d830e0563a043032c3f335c19976727f277
Author: Per Buer <perbu at varnish-software.com>
Date:   Tue Feb 19 16:48:08 2013 +0100

    First attempt at params

diff --git a/doc/sphinx/users-guide/params.rst b/doc/sphinx/users-guide/params.rst
index a0123ec..635fdcf 100644
--- a/doc/sphinx/users-guide/params.rst
+++ b/doc/sphinx/users-guide/params.rst
@@ -1,4 +1,27 @@
\ No newline at end of file
+Varnish Cache has a set of parameter that affect its behaviour and
+performance. Most of these parameters can be set on the Varnish
+command line (through varnishadm) useing the param.set keyword.
+Some parameters can, for security purposes be read only using the "-r"
+command line switch to varnishd.
+I don't recommend tweaking the parameters unless you're sure of what
+you're doing. We've worked hard to make the defaults sane and Varnish
+should be able to handle most workloads with the default settings.
+For a complete listing of all the parameters and a short descriptions
+type ``param.show`` in the CLI. To inspect a certain parameter and get a somewhat longer description on what it does and what the default is type ``param.show *param*``, like this::
+  varnish> param.show shortlived
+  200        
+  shortlived                  10.000000 [s]
+                              Default is 10.0
+                              Objects created with TTL shorter than this are
+                              always put in transient storage.

More information about the varnish-commit mailing list