aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/perf_counter/Documentation/perf-top.txt
diff options
context:
space:
mode:
authorIngo Molnar <mingo@elte.hu>2009-04-20 09:52:29 -0400
committerIngo Molnar <mingo@elte.hu>2009-04-20 11:36:49 -0400
commit1d8c8b209e9351a7de1307d7b9b6df4222b8d742 (patch)
tree43acf25217e2760bac99ced7575ad809d641f75f /Documentation/perf_counter/Documentation/perf-top.txt
parentddcacfa0febff6454dba6cea1931f3020a9f6c24 (diff)
perf_counter tools: add help texts
Add Documentation/perf-stat.txt and Documentation/perf-top.txt. The template that was used for it: Documentation/git-add.txt from Git. Fix up small bugs to make these help texts show up both in the 'perf' common-command summary output screen, and on the individual help screens. Signed-off-by: Ingo Molnar <mingo@elte.hu>
Diffstat (limited to 'Documentation/perf_counter/Documentation/perf-top.txt')
-rw-r--r--Documentation/perf_counter/Documentation/perf-top.txt61
1 files changed, 61 insertions, 0 deletions
diff --git a/Documentation/perf_counter/Documentation/perf-top.txt b/Documentation/perf_counter/Documentation/perf-top.txt
new file mode 100644
index 000000000000..057333b72534
--- /dev/null
+++ b/Documentation/perf_counter/Documentation/perf-top.txt
@@ -0,0 +1,61 @@
1perf-top(1)
2==========
3
4NAME
5----
6perf-top - Run a command and profile it
7
8SYNOPSIS
9--------
10[verse]
11'perf top' [-e <EVENT> | --event=EVENT] [-l] [-a] <command>
12
13DESCRIPTION
14-----------
15This command runs a command and gathers a performance counter profile
16from it.
17
18
19OPTIONS
20-------
21<command>...::
22 Any command you can specify in a shell.
23
24-e::
25--event=::
26 0:0: cpu-cycles
27 0:0: cycles
28 0:1: instructions
29 0:2: cache-references
30 0:3: cache-misses
31 0:4: branch-instructions
32 0:4: branches
33 0:5: branch-misses
34 0:6: bus-cycles
35 1:0: cpu-clock
36 1:1: task-clock
37 1:2: page-faults
38 1:2: faults
39 1:5: minor-faults
40 1:6: major-faults
41 1:3: context-switches
42 1:3: cs
43 1:4: cpu-migrations
44 1:4: migrations
45 rNNN: raw PMU events (eventsel+umask)
46
47-a::
48 system-wide collection
49
50-l::
51 scale counter values
52
53Configuration
54-------------
55
56EXAMPLES
57--------
58
59SEE ALSO
60--------
61linkperf:git-stat[1]