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

« back to all changes in this revision

Viewing changes to bin/varnishsizes/varnishsizes.1

  • Committer: Package Import Robot
  • Author(s): Stig Sandbeck Mathisen
  • Date: 2011-10-29 15:23:24 UTC
  • mfrom: (0.1.15)
  • Revision ID: package-import@ubuntu.com-20111029152324-tdtlsurrv22ysknj
Tags: 3.0.2-1
* New upstream release
* Build from upstream tarball instead of git tag
* debian/watch: more specific regular expression

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Man page generated from reStructeredText.
 
2
.
 
3
.TH VARNISHSIZES 1 "2010-05-31" "1.0" ""
 
4
.SH NAME
 
5
varnishsizes \- Varnish object size request histogram
 
6
.
 
7
.nr rst2man-indent-level 0
 
8
.
 
9
.de1 rstReportMargin
 
10
\\$1 \\n[an-margin]
 
11
level \\n[rst2man-indent-level]
 
12
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
13
-
 
14
\\n[rst2man-indent0]
 
15
\\n[rst2man-indent1]
 
16
\\n[rst2man-indent2]
 
17
..
 
18
.de1 INDENT
 
19
.\" .rstReportMargin pre:
 
20
. RS \\$1
 
21
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
 
22
. nr rst2man-indent-level +1
 
23
.\" .rstReportMargin post:
 
24
..
 
25
.de UNINDENT
 
26
. RE
 
27
.\" indent \\n[an-margin]
 
28
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
29
.nr rst2man-indent-level -1
 
30
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
31
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 
32
..
 
33
.SH SYNOPSIS
 
34
.INDENT 0.0
 
35
.TP
 
36
.B varnishsizes [\-b] [\-C] [\-c] [\-d] [\-I regex] [\-i tag] [\-m \fI\%tag:regex\fP ...]
 
37
.sp
 
38
[\-n varnish_name] [\-r file] [\-V] [\-w delay] [\-X regex] [\-x tag]
 
39
.UNINDENT
 
40
.SH DESCRIPTION
 
41
.sp
 
42
The varnishsizes utility reads varnishd(1) shared memory logs and presents
 
43
a continuously updated histogram showing the distribution of the last N
 
44
requests by their processing.  The value of N and the vertical scale are
 
45
displayed in the top left corner.  The horizontal scale is a logarithmic
 
46
representation of bytes.  Hits are marked with a pipe character
 
47
("|"), and misses are marked with a hash character ("#").
 
48
.sp
 
49
The following options are available:
 
50
.INDENT 0.0
 
51
.TP
 
52
.B \-b
 
53
.
 
54
Include log entries which result from communication with a backend server.
 
55
If neither \-b nor \-c is specified, varnishsizes acts as if they both were.
 
56
.TP
 
57
.B \-C
 
58
.
 
59
Ignore case when matching regular expressions.
 
60
.TP
 
61
.B \-c
 
62
.
 
63
Include log entries which result from communication with a client.
 
64
If neither \-b nor \-c is specified, varnishsizes acts as if they both were.
 
65
.TP
 
66
.B \-d
 
67
.
 
68
Process old log entries on startup.  Normally, varnishsizes will only
 
69
process entries which are written to the log after it starts.
 
70
.TP
 
71
.BI \-I \ regex
 
72
.
 
73
Include log entries which match the specified regular expression.
 
74
If neither \-I nor \-i is specified, all log entries are included.
 
75
.TP
 
76
.BI \-i \ tag
 
77
.
 
78
Include log entries with the specified tag.  If neither \-I nor \-i
 
79
is specified, all log entries are included.
 
80
.UNINDENT
 
81
.INDENT 0.0
 
82
.TP
 
83
.B \-m \fI\%tag:regex\fP only list record where tag matches regex. Multiple \-m
 
84
.sp
 
85
options are AND\-ed together.
 
86
.UNINDENT
 
87
.INDENT 0.0
 
88
.TP
 
89
.B \-n
 
90
.
 
91
Specifies the name of the varnishd instance to get logs from.
 
92
If \-n is not specified, the host name is used.
 
93
.TP
 
94
.BI \-r \ file
 
95
.
 
96
Read log entries from file instead of shared memory.
 
97
.TP
 
98
.B \-V
 
99
.
 
100
Display the version number and exit.
 
101
.TP
 
102
.BI \-w \ delay
 
103
.
 
104
Wait at least delay seconds between each update.  The default is 1.
 
105
file instead of displaying them.  The file will be overwritten
 
106
unless the \-a option was specified.
 
107
.TP
 
108
.BI \-X \ regex
 
109
.
 
110
Exclude log entries which match the specified regular expression.
 
111
.TP
 
112
.BI \-x \ tag
 
113
.
 
114
Exclude log entries with the specified tag.
 
115
.UNINDENT
 
116
.SH SEE ALSO
 
117
.INDENT 0.0
 
118
.IP \(bu 2
 
119
.
 
120
varnishd(1)
 
121
.IP \(bu 2
 
122
.
 
123
varnishlog(1)
 
124
.IP \(bu 2
 
125
.
 
126
varnishncsa(1)
 
127
.IP \(bu 2
 
128
.
 
129
varnishstat(1)
 
130
.IP \(bu 2
 
131
.
 
132
varnishtop(1)
 
133
.UNINDENT
 
134
.SH HISTORY
 
135
.sp
 
136
The varnishsizes utility was developed by Kristian Lyngstøl based on
 
137
varnishhist.  This manual page was written by Kristian Lyngstøl,
 
138
Dag\-Erling Smørgrav and Per Buer.
 
139
.SH COPYRIGHT
 
140
.sp
 
141
This document is licensed under the same licence as Varnish
 
142
itself. See LICENCE for details.
 
143
.INDENT 0.0
 
144
.IP \(bu 2
 
145
.
 
146
Copyright (c) 2010 Varnish Software AS
 
147
.UNINDENT
 
148
.SH AUTHOR
 
149
Dag Erling Smørgrav, Kristian Lyngstøl, Per Buer
 
150
.\" Generated by docutils manpage writer.
 
151
.\" 
 
152
.