perf/scripts: Add perf-trace-python Documentation
[linux-2.6.git] / tools / perf / Documentation / perf-trace.txt
1 perf-trace(1)
2 ==============
3
4 NAME
5 ----
6 perf-trace - Read perf.data (created by perf record) and display trace output
7
8 SYNOPSIS
9 --------
10 [verse]
11 'perf trace' {record <script> | report <script> [args] }
12
13 DESCRIPTION
14 -----------
15 This command reads the input file and displays the trace recorded.
16
17 There are several variants of perf trace:
18
19   'perf trace' to see a detailed trace of the workload that was
20   recorded.
21
22   You can also run a set of pre-canned scripts that aggregate and
23   summarize the raw trace data in various ways (the list of scripts is
24   available via 'perf trace -l').  The following variants allow you to
25   record and run those scripts:
26
27   'perf trace record <script>' to record the events required for 'perf
28   trace report'.  <script> is the name displayed in the output of
29   'perf trace --list' i.e. the actual script name minus any language
30   extension.
31
32   'perf trace report <script>' to run and display the results of
33   <script>.  <script> is the name displayed in the output of 'perf
34   trace --list' i.e. the actual script name minus any language
35   extension.  The perf.data output from a previous run of 'perf trace
36   record <script>' is used and should be present for this command to
37   succeed.
38
39   See the 'SEE ALSO' section for links to language-specific
40   information on how to write and run your own trace scripts.
41
42 OPTIONS
43 -------
44 -D::
45 --dump-raw-trace=::
46         Display verbose dump of the trace data.
47
48 -L::
49 --Latency=::
50         Show latency attributes (irqs/preemption disabled, etc).
51
52 -l::
53 --list=::
54         Display a list of available trace scripts.
55
56 -s ['lang']::
57 --script=::
58         Process trace data with the given script ([lang]:script[.ext]).
59         If the string 'lang' is specified in place of a script name, a
60         list of supported languages will be displayed instead.
61
62 -g::
63 --gen-script=::
64         Generate perf-trace.[ext] starter script for given language,
65         using current perf.data.
66
67 SEE ALSO
68 --------
69 linkperf:perf-record[1], linkperf:perf-trace-perl[1],
70 linkperf:perf-trace-python[1]