perf trace/scripting: Update 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   'perf trace record <script>' to record the events required for 'perf
23   trace report'.  <script> is the name displayed in the output of
24   'perf trace --list' i.e. the actual script name minus any language
25   extension.
26
27   'perf trace report <script>' to run and display the results of
28   <script>.  <script> is the name displayed in the output of 'perf
29   trace --list' i.e. the actual script name minus any language
30   extension.  The perf.data output from a previous run of 'perf trace
31   record <script>' is used and should be present for this command to
32   succeed.
33
34 OPTIONS
35 -------
36 -D::
37 --dump-raw-trace=::
38         Display verbose dump of the trace data.
39
40 -L::
41 --Latency=::
42         Show latency attributes (irqs/preemption disabled, etc).
43
44 -l::
45 --list=::
46         Display a list of available trace scripts.
47
48 -s::
49 --script=::
50         Process trace data with the given script ([lang]:script[.ext]).
51
52 -g::
53 --gen-script=::
54         Generate perf-trace.[ext] starter script for given language,
55         using current perf.data.
56
57 SEE ALSO
58 --------
59 linkperf:perf-record[1], linkperf:perf-trace-perl[1]