Skip to content

V
varnish-cache
Commit 32b6b10f authored by Lasse Karstensen's avatar Lasse Karstensen
Browse files
Options

Rewrite odd UTF8 that makes pdflatex sad. 

Mostly non-breaking space and angle brackets. Stick with what has worked
for 51 years now, proper 7bit US-ASCII! ;-)
parent ee55121a
Hide whitespace changes
Inline Side-by-side
Showing with 50 additions and 51 deletions
doc/sphinx/reference/varnish-cli.rst
View file @ 32b6b10f
......@@ -127,7 +127,7 @@ help [command]
param.set param value
Set the parameter specified by param to the specified value.
See Run-Time Parameters for a list of parame‐ ters.
See Run-Time Parameters for a list of parameters.
param.show [-l] [param]
Display a list if run-time parameters and their values.
......@@ -179,7 +179,7 @@ vcl.show configname
vcl.use configname
Start using the configuration specified by configname for all
new requests. Existing requests will con‐ tinue using whichever
new requests. Existing requests will continue using whichever
configuration was in use when they arrived.
......
doc/sphinx/reference/varnishd.rst
View file @ 32b6b10f
......@@ -19,11 +19,11 @@ HTTP accelerator daemon
SYNOPSIS
========
varnishd [-a address[:port]] [-b host[:port]] [-d] [-F] [-f config]
varnishd [-a address[:port]] [-b host[:port]] [-d] [-F] [-f config]
[-g group] [-h type[,options]] [-i identity]
[-l shmlogsize] [-n name] [-P file] [-p param=value]
[-l shmlogsize] [-n name] [-P file] [-p param=value]
[-s type[,options]] [-T address[:port]] [-t ttl]
[-r param[,param...]] [-u user] [-V]
[-r param[,param...]] [-u user] [-V]
DESCRIPTION
===========
......@@ -41,14 +41,14 @@ OPTIONS
name (“localhost”), an IPv4 dotted-quad (“127.0.0.1”), or an IPv6 address enclosed in
square brackets (“[::1]”). If address is not specified, varnishd will listen on all
available IPv4 and IPv6 interfaces. If port is not specified, the default HTTP port as
listed in /etc/services is used. Multiple listening addresses and ports can be speci‐
fied as a whitespace- or comma-separated list.
listed in /etc/services is used. Multiple listening addresses and ports can be
specified as a whitespace or comma -separated list.
-b host[:port]
Use the specified host as backend server. If port is not specified,
Use the specified host as backend server. If port is not specified,
the default is 8080.
-C Print VCL code compiled to C language and exit. Specify the VCL file
-C Print VCL code compiled to C language and exit. Specify the VCL file
to compile with the -f option.
-d Enables debugging mode: The parent process runs in the foreground with a CLI connection
......@@ -85,8 +85,8 @@ OPTIONS
-P file Write the process's PID to the specified file.
-p param=value
Set the parameter specified by param to the specified value. See Run-Time
Parameters for a list of parameters. This option can be used multiple
Set the parameter specified by param to the specified value. See Run-Time
Parameters for a list of parameters. This option can be used multiple
times to specify multiple parameters.
-S file Path to a file containing a secret used for authorizing access to the management port.
......@@ -108,11 +108,11 @@ OPTIONS
-M address:port
Connect to this port and offer the command line
interface. Think of it as a reverse shell. When running with
interface. Think of it as a reverse shell. When running with
-M and there is no backend defined the child process (the cache)
will not start initially.
-t ttl
-t ttl
Specifies a hard minimum time to live for cached
documents. This is a shortcut for specifying the
default_ttl run-time parameter.
......@@ -129,7 +129,7 @@ OPTIONS
process should switch before it starts accepting
connections. This is a shortcut for specifying the user
run- time parameter.
If specifying both a user and a group, the user should be
specified first.
......@@ -250,7 +250,7 @@ The varnishd daemon was developed by Poul-Henning Kamp in cooperation
with Verdens Gang AS, Varnish Software AS and Varnish Software.
This manual page was written by Dag-Erling Smørgrav with updates by
Stig Sandbeck Mathisen ⟨ssm@debian.org⟩
Stig Sandbeck Mathisen <ssm@debian.org>
COPYRIGHT
......@@ -259,4 +259,4 @@ COPYRIGHT
This document is licensed under the same licence as Varnish
itself. See LICENCE for details.
* Copyright (c) 2007-2011 Varnish Software AS
* Copyright (c) 2007-2014 Varnish Software AS
doc/sphinx/reference/varnishhist.rst
View file @ 32b6b10f
......@@ -15,54 +15,54 @@ Varnish request histogram
SYNOPSIS
========
varnishhist [-b] [-C] [-c] [-d] [-I regex] [-i tag] [-m tag:regex ...]
varnishhist [-b] [-C] [-c] [-d] [-I regex] [-i tag] [-m tag:regex ...]
[-n varnish_name] [-r file] [-V] [-w delay] [-X regex] [-x tag]
DESCRIPTION
===========
The varnishhist utility reads varnishd(1) shared memory logs and
presents a continuously updated histogram show‐ ing the distribution
presents a continuously updated histogram showing the distribution
of the last N requests by their processing. The value of N and the
vertical scale are dis‐ played in the top left corner. The horizontal
vertical scale are displayed in the top left corner. The horizontal
scale is logarithmic. Hits are marked with a pipe character ("|"),
and misses are marked with a hash character ("#").
The following options are available:
-b Include log entries which result from communication with
-b Include log entries which result from communication with
a backend server. If neither -b nor -c is
specified, varnishhist acts as if they both were.
-C Ignore case when matching regular expressions.
-c Include log entries which result from communication with
a client. If neither -b nor -c is specified,
-c Include log entries which result from communication with
a client. If neither -b nor -c is specified,
varnishhist acts as if they both were.
-d Process old log entries on startup. Normally, varnishhist
will only process entries which are written to the
-d Process old log entries on startup. Normally, varnishhist
will only process entries which are written to the
log after it starts.
-I regex Include log entries which match the specified
regular expression. If neither -I nor -i is specified,
-I regex Include log entries which match the specified
regular expression. If neither -I nor -i is specified,
all log entries are included.
-i tag Include log entries with the specified tag. If neither
-i tag Include log entries with the specified tag. If neither
-I nor -i is specified, all log entries are included.
-m tag:regex only count transactions where tag matches regex. Multiple
-m options are AND-ed together.
-n Specifies the name of the varnishd instance to get logs
-n Specifies the name of the varnishd instance to get logs
from. If -n is not specified, the host name is used.
-r file Read log entries from file instead of shared memory.
-V Display the version number and exit.
-w delay Wait at least delay seconds between each update. The
default is 1. file instead of displaying them. The file
-w delay Wait at least delay seconds between each update. The
default is 1. file instead of displaying them. The file
will be overwritten unless the -a option was specified.
-X regex Exclude log entries which match the specified regular expression.
......@@ -75,7 +75,7 @@ SEE ALSO
* varnishd(1)
* varnishlog(1)
* varnishncsa(1)
* varnishstat(1)
* varnishstat(1)
* varnishtop(1)
HISTORY
......
doc/sphinx/reference/varnishlog.rst
View file @ 32b6b10f
......@@ -68,9 +68,9 @@ HISTORY
=======
The varnishlog utility was developed by Poul-Henning Kamp
⟨phk@phk.freebsd.dk⟩ in cooperation with Verdens Gang AS, Varnish
Software AS and Varnish Software. This manual page was initially
written by Dag-Erling Smørgrav.
<phk@phk.freebsd.dk> in cooperation with Verdens Gang AS and
Varnish Software AS. This manual page was initially written by Dag-Erling
Smørgrav.
COPYRIGHT
......
doc/sphinx/reference/varnishncsa.rst
View file @ 32b6b10f
......@@ -115,7 +115,7 @@ Supported formatters are:
Varnish:handling
How the request was handled, whether it was a cache hit, miss,
pass, pipe or error.
VCL_Log:key
Output value set by std.log("key:value") in VCL.
......@@ -140,7 +140,7 @@ HISTORY
The varnishncsa utility was developed by Poul-Henning Kamp in
cooperation with Verdens Gang AS and Varnish Software AS. This manual page was
written by Dag-Erling Smørgrav ⟨des@des.no⟩.
written by Dag-Erling Smørgrav <des@des.no>.
COPYRIGHT
=========
......
doc/sphinx/reference/varnishstat.rst
View file @ 32b6b10f
......@@ -70,26 +70,26 @@ When using the -1 option, the columns in the output are, from left to right:
When using the -x option, the output is::
<stat>
<name>FIELD NAME</name>
<value>FIELD VALUE</value>
<description>FIELD DESCRIPTION</description>
</stat>
<stat>
<name>FIELD NAME</name>
<value>FIELD VALUE</value>
<description>FIELD DESCRIPTION</description>
</stat>
With -j the output format is::
{
"timestamp": "YYYY-MM-DDTHH:mm:SS",
"client_conn": {
"value": 0, "flag": "a",
"value": 0, "flag": "a",
"description": "Client connections accepted"
},
"client_drop": {
"value": 0, "flag": "a",
"value": 0, "flag": "a",
"description": "Connection dropped, no sess/wrk"
},
"LCK.backend.creat": {
"type": "LCK", "ident": "backend", "value": 1,
"type": "LCK", "ident": "backend", "value": 1,
"flag": "a", "description": "Created locks"
},
[..]
......@@ -114,9 +114,8 @@ HISTORY
=======
The varnishstat utility was originally developed by Poul-Henning Kamp
⟨phk@phk.freebsd.dk⟩ in cooperation with Verdens Gang AS, Varnish Software AS
and Varnish Software. Manual page written by Dag-Erling Smørgrav,
and Per Buer.
<phk@phk.freebsd.dk> in cooperation with Verdens Gang AS and Varnish
Software AS. Manual page written by Dag-Erling Smørgrav and Per Buer.
COPYRIGHT
=========
......
doc/sphinx/reference/varnishtest.rst
View file @ 32b6b10f
......@@ -128,10 +128,10 @@ HISTORY
=======
The varnishtest program was developed by Poul-Henning Kamp
⟨phk@phk.freebsd.dk⟩ in cooperation with Varnish Software AS.
<phk@phk.freebsd.dk> in cooperation with Varnish Software AS.
This manual page was originally written by Stig Sandbeck Mathisen
⟨ssm@linpro.no⟩ and updated by Kristian Lyngstøl
(kristian@varnish-cache.org).
<ssm@linpro.no> and updated by Kristian Lyngstøl
<kristian@varnish-cache.org>.
COPYRIGHT
=========
......@@ -139,4 +139,4 @@ COPYRIGHT
This document is licensed under the same licence as Varnish
itself. See LICENCE for details.
* Copyright (c) 2007-2011 Varnish Software AS
* Copyright (c) 2007-2014 Varnish Software AS
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