evtranalyze: add summary command and refactor interval code
[dragonfly.git] / usr.bin / evtranalyze / evtranalyze.1
CommitLineData
e7c0dbba
AE
1.\"-
2.\" Copyright (c) 2009 Aggelos Economopoulos
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\" notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\" notice, this list of conditions and the following disclaimer in the
12.\" documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\"
27.Dd February 8, 2009
28.Dt EVTRANALYZE 1
29.Os
30.Sh NAME
31.Nm evtranalyze
32.Nd analyze a trace stream
33.Sh SYNOPSIS
34.Nm
35.Op Fl f Ar infile
36.Ar command
37.Op Ar argument ...
38.Sh DESCRIPTION
39The
40.Nm
41utility is used to analyze an event trace stream.
42It takes a few global options, after which the user should
43specify a subcommand, followed by the subcommands options.
44.Ss Global options
45The global options are
46.Bl -tag -width indent
47.It Fl f Ar path
48Specifies the file containing the event stream.
49.El
50The subcommands are:
51.Bl -ohang -width indent
52.\" ==== show ====
53.It Cm show
54Lists the individual events, one per line.
55The flags it accepts are:
56.Bl -tag -width indent-two
57.It Fl f Ar fmt
58Limits the displayed events to those matching
59.Ar fmt .
60.El
70af04e9 61.\" ==== svg ====
e7c0dbba 62.It Cm svg
70af04e9 63Generates an svg file (by default "output.svg") in the current directory,
e7c0dbba
AE
64displaying the stream events.
65The flags it accepts are:
66.Bl -tag -width indent-two
67.It Fl i Ar interval
68Limits the displayed events to those occuring within the
69specified time interval.
70af04e9
AE
70The interval is specified in the form [c|m]<num>:<num>.
71If
72.Ar interval
73starts with 'c', <num> is absolute (i.e. not relative to the start of the
74event stream) clock cycles (integral).
75If
76.Ar interval
77starts with 'm', <num> is a floating point number specifying miliseconds
78since the first event in the stream.
79.It Fl o Ar path
80Specifies an alternate output file.
e7c0dbba 81.El
70af04e9
AE
82.\" ==== svg ====
83.It Cm summary
84Displays summary information about the event stream.
e7c0dbba
AE
85.El
86.Sh SEE ALSO
87.Xr ktrdump 8
88.Sh HISTORY
89The
90.Nm
91utility first appeared in
92.Dx 2.5 .
93.Sh AUTHORS
94.An -nosplit
95The
96.Nm
97utility was implemented by
98.An Aggelos Economopoulos Aq aggelos@dragonflybsd.org
99for
100.Dx .