xref: /linux/tools/perf/Documentation/perf.txt (revision a36e9f5cfe9eb3a1dce8769c7058251c42705357)
1perf(1)
2=======
3
4NAME
5----
6perf - Performance analysis tools for Linux
7
8SYNOPSIS
9--------
10[verse]
11'perf' [--version] [--help] [OPTIONS] COMMAND [ARGS]
12
13OPTIONS
14-------
15-h::
16--help::
17        Run perf help command.
18
19-v::
20--version::
21        Display perf version.
22
23-vv::
24        Print the compiled-in status of libraries.
25
26--exec-path::
27        Display or set exec path.
28
29--html-path::
30        Display html documentation path.
31
32-p::
33--paginate::
34        Set up pager.
35
36--no-pager::
37        Do not set pager.
38
39--buildid-dir::
40        Setup buildid cache directory. It has higher priority
41        than buildid.dir config file option.
42
43--list-cmds::
44        List the most commonly used perf commands.
45
46--list-opts::
47        List available perf options.
48
49--debugfs-dir::
50        Set debugfs directory or set environment variable PERF_DEBUGFS_DIR.
51
52--debug::
53        Setup debug variable (see list below) in value
54        range (0, 10). Use like:
55          --debug verbose   # sets verbose = 1
56          --debug verbose=2 # sets verbose = 2
57
58        List of debug variables allowed to set:
59          verbose          - general debug messages
60          ordered-events   - ordered events object debug messages
61          data-convert     - data convert command debug messages
62          stderr           - write debug output (option -v) to stderr
63                             in browser mode
64          perf-event-open  - Print perf_event_open() arguments and
65                             return value
66          kmaps            - Print kernel and module maps (perf script
67                             and perf report without browser)
68
69--debug-file::
70	Write debug output to a specified file.
71
72DESCRIPTION
73-----------
74Performance counters for Linux are a new kernel-based subsystem
75that provide a framework for all things performance analysis. It
76covers hardware level (CPU/PMU, Performance Monitoring Unit) features
77and software features (software counters, tracepoints) as well.
78
79SEE ALSO
80--------
81linkperf:perf-stat[1], linkperf:perf-top[1],
82linkperf:perf-record[1], linkperf:perf-report[1],
83linkperf:perf-list[1]
84
85linkperf:perf-amd-ibs[1], linkperf:perf-annotate[1],
86linkperf:perf-archive[1], linkperf:perf-arm-spe[1],
87linkperf:perf-bench[1], linkperf:perf-buildid-cache[1],
88linkperf:perf-buildid-list[1], linkperf:perf-c2c[1],
89linkperf:perf-config[1], linkperf:perf-data[1], linkperf:perf-diff[1],
90linkperf:perf-evlist[1], linkperf:perf-ftrace[1],
91linkperf:perf-help[1], linkperf:perf-inject[1],
92linkperf:perf-intel-pt[1], linkperf:perf-iostat[1], linkperf:perf-kallsyms[1],
93linkperf:perf-kmem[1], linkperf:perf-kvm[1], linkperf:perf-lock[1],
94linkperf:perf-mem[1], linkperf:perf-probe[1], linkperf:perf-sched[1],
95linkperf:perf-script[1], linkperf:perf-test[1],
96linkperf:perf-trace[1], linkperf:perf-version[1]
97