Commit 3a9dcddb authored by Tollef Fog Heen's avatar Tollef Fog Heen

Merge r4105: Update documentation for the varnishd management interface



git-svn-id: http://www.varnish-cache.org/svn/branches/2.0@4288 d4fa192b-c00b-0410-8231-f00ffab90ce4
parent 63c56b79
...@@ -326,8 +326,12 @@ will offer a command-line management interface on the specified ...@@ -326,8 +326,12 @@ will offer a command-line management interface on the specified
address and port. address and port.
The following commands are available: The following commands are available:
.Bl -tag -width 4n .Bl -tag -width 4n
.It Cm help .It Cm help Op Ar command
Display a list of available commands. Display a list of available commands.
.Pp
If the
.Ar command
is specified, display help for this command.
.It Cm param.set Ar param Ar value .It Cm param.set Ar param Ar value
Set the parameter specified by Set the parameter specified by
.Ar param .Ar param
...@@ -336,20 +340,24 @@ to the specified ...@@ -336,20 +340,24 @@ to the specified
See See
.Sx Run-Time Parameters .Sx Run-Time Parameters
for a list of parameters. for a list of parameters.
.It Cm param.show Ar param .It Xo
Display the value of the parameter specified by .Cm param.show
.Ar param . .Op Fl l
See .Op Ar param
.Sx Run-Time Parameters .Xc
for a list of parameters. Display a list if run-time parameters and their values.
.It Cm param.show Op Fl l .Pp
Display a list of run-time parameters and their values.
If the If the
.Fl l .Fl l
option is specified, the list includes a brief explanation of each option is specified, the list includes a brief explanation of each
parameter. parameter.
.Pp
If a
.Ar param
is specified, display only the value and explanation for this
parameter.
.It Cm ping Op Ns Ar timestamp .It Cm ping Op Ns Ar timestamp
Ping the child process. Ping the Varnish cache process, keeping the connection alive.
.It Cm purge Ar field Ar operator Ar argument Op && Ar field Ar operator Ar argument Op ... .It Cm purge Ar field Ar operator Ar argument Op && Ar field Ar operator Ar argument Op ...
Immediately invalidate all documents matching the purge expression. Immediately invalidate all documents matching the purge expression.
See See
...@@ -382,20 +390,25 @@ is removed from the list. ...@@ -382,20 +390,25 @@ is removed from the list.
.It Cm purge.url Ar regexp .It Cm purge.url Ar regexp
Immediately invalidate all documents whose URL matches the specified Immediately invalidate all documents whose URL matches the specified
regular expression. regular expression.
.It Cm quit
Close the connection to the varnish admin port.
.It Cm start .It Cm start
Start the child process if it is not already running. Start the Varnish cache process if it is not already running.
.It Cm stats .It Cm stats
Display server statistics. Show summary statistics.
.Pp
All the numbers presented are totals since server startup; for a All the numbers presented are totals since server startup; for a
better idea of the current situation, use the better idea of the current situation, use the
.Xr varnishstat 1 .Xr varnishstat 1
utility. utility.
.It Cm status .It Cm status
Check the status of the child process. Check the status of the Varnish cache process.
.It Cm stop .It Cm stop
Stop the child process. Stop the Varnish cache process.
.It Cm url.purge Ar regexp .It Cm url.purge Ar regexp
Deprecated, see purge.url instead Deprecated, see
.Cm purge.url
instead.
.It Cm vcl.discard Ar configname .It Cm vcl.discard Ar configname
Discard the configuration specified by Discard the configuration specified by
.Ar configname . .Ar configname .
......
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