~ubuntu-branches/debian/sid/varnish/sid

« back to all changes in this revision

Viewing changes to bin/varnishstat/varnishstat.1

  • Committer: Bazaar Package Importer
  • Author(s): Stig Sandbeck Mathisen
  • Date: 2011-03-21 10:16:07 UTC
  • mfrom: (24.1.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20110321101607-528fzl583fqanas5
Tags: 2.1.5-2
Release for unstable

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\"-
2
 
.\" Copyright (c) 2006 Verdens Gang AS
3
 
.\" Copyright (c) 2006-2009 Linpro AS
4
 
.\" All rights reserved.
5
 
.\"
6
 
.\" Author: Dag-Erling Smørgrav <des@des.no>
7
 
.\"
8
 
.\" Redistribution and use in source and binary forms, with or without
9
 
.\" modification, are permitted provided that the following conditions
10
 
.\" are met:
11
 
.\" 1. Redistributions of source code must retain the above copyright
12
 
.\"    notice, this list of conditions and the following disclaimer.
13
 
.\" 2. Redistributions in binary form must reproduce the above copyright
14
 
.\"    notice, this list of conditions and the following disclaimer in the
15
 
.\"    documentation and/or other materials provided with the distribution.
16
 
.\"
17
 
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18
 
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
 
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
 
.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21
 
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22
 
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23
 
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24
 
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
 
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26
 
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27
 
.\" SUCH DAMAGE.
28
 
.\"
29
 
.\" $Id: varnishstat.1 4025 2009-04-03 21:52:44Z des $
30
 
.\"
31
 
.Dd June 28, 2007
32
 
.Dt VARNISHSTAT 1
33
 
.Os
34
 
.Sh NAME
35
 
.Nm varnishstat
36
 
.Nd HTTP accelerator statistics
37
 
.Sh SYNOPSIS
38
 
.Nm
39
 
.Op Fl 1
40
 
.Op Fl f Ar field_list
41
 
.Op Fl l
42
 
.Op Fl n Ar varnish_name
43
 
.Op Fl V
44
 
.Op Fl w Ar delay
45
 
.Sh DESCRIPTION
46
 
The
47
 
.Nm
48
 
utility displays statistics from a running
49
 
.Xr varnishd 1
50
 
instance.
51
 
.Pp
52
 
The following options are available:
53
 
.Bl -tag -width Fl
54
 
.It Fl 1
55
 
Instead of presenting of a continuously updated display, print the
56
 
statistics once and exit.
57
 
.It Fl f
58
 
A comma separated list of the fields to display.
59
 
If it starts with '^' it is used as an exclusion list.
60
 
.It Fl l
61
 
Lists the available fields to use with the
62
 
.Fl f
63
 
option.
64
 
.It Fl n
65
 
Specifies the name of the
66
 
.Nm varnishd
67
 
instance to get logs from.
68
 
If
69
 
.Fl n
70
 
is not specified, the host name is used.
71
 
.It Fl V
72
 
Display the version number and exit.
73
 
.It Fl w Ar delay
74
 
Wait
75
 
.Ar delay
76
 
seconds between updates.
77
 
The default is 1.
78
 
.El
79
 
.Pp
80
 
The columns in the main display are, from left to right:
81
 
.Bl -enum
82
 
.It
83
 
Value
84
 
.It
85
 
Per-second average in the period since last update, or a period if the
86
 
value can not be averaged
87
 
.It
88
 
Per-second average over process lifetime, or a period if the value can
89
 
not be averaged
90
 
.It
91
 
Descriptive text
92
 
.El
93
 
.Pp
94
 
When using the
95
 
.Fl 1
96
 
option, the columns in the output are, from left to right:
97
 
.Bl -enum
98
 
.It
99
 
Symbolic entry name
100
 
.It
101
 
Value
102
 
.It
103
 
Per-second average over process lifetime, or a period if the value can
104
 
not be averaged
105
 
.It
106
 
Descriptive text
107
 
.El
108
 
.Sh SEE ALSO
109
 
.Xr varnishd 1 ,
110
 
.Xr varnishhist 1 ,
111
 
.Xr varnishlog 1 ,
112
 
.Xr varnishncsa 1 ,
113
 
.Xr varnishtop 1 ,
114
 
.Xr curses 3
115
 
.Sh HISTORY
116
 
The
117
 
.Nm
118
 
utility was originally developed by
119
 
.An Poul-Henning Kamp Aq phk@phk.freebsd.dk
120
 
in cooperation with Verdens Gang AS and Linpro AS, and later
121
 
substantially rewritten by
122
 
.An Dag-Erling Sm\(/orgrav Aq des@des.no .
123
 
This manual page was written by
124
 
.An Dag-Erling Sm\(/orgrav Aq des@des.no .