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