usr.bin/evtranalyze/evtranalyze.1

   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
  39 The
  40 .Nm
  41 utility is used to analyze an event trace stream.
  42 It takes a few global options, after which the user should
  43 specify a subcommand, followed by the subcommands options.
  44 .Ss Global options
  45 The global options are
  46 .Bl -tag -width indent
  47 .It Fl f Ar path
  48 Specifies the file containing the event stream.
  49 .El
  50 .Pp
  51 The subcommands are:
  52 .Bl -ohang
  53 .\" ==== show ====
  54 .It Cm show
  55 Lists the individual events, one per line.
  56 The flags it accepts are:
  57 .Bl -tag -width indent-two
  58 .It Fl f Ar fmt
  59 Limits the displayed events to those matching
  60 .Ar fmt .
  61 .El
  62 .\" ==== svg ====
  63 .It Cm svg
  64 Generates an svg file (by default "output.svg") in the current directory,
  65 displaying the stream events.
  66 The flags it accepts are:
  67 .Bl -tag -width indent-two
  68 .It Fl i Ar interval
  69 Limits the displayed events to those occurring within the
  70 specified time interval.
  71 The interval is specified in the form [c|m]<num>:<num>.
  72 If
  73 .Ar interval
  74 starts with 'c', <num> is absolute (i.e. not relative to the start of the
  75 event stream) clock cycles (integral).
  76 If
  77 .Ar interval
  78 starts with 'm', <num> is a floating point number specifying miliseconds
  79 since the first event in the stream.
  80 .It Fl o Ar path
  81 Specifies an alternate output file.
  82 .El
  83 .\" ==== svg ====
  84 .It Cm summary
  85 Displays summary information about the event stream.
  86 .El
  87 .Sh SEE ALSO
  88 .Xr ktrdump 8
  89 .Sh HISTORY
  90 The
  91 .Nm
  92 utility first appeared in
  93 .Dx 2.5 .
  94 .Sh AUTHORS
  95 .An -nosplit
  96 The
  97 .Nm
  98 utility was implemented by
  99 .An Aggelos Economopoulos Aq aggelos@dragonflybsd.org
 100 for
 101 .Dx .