GNU Linux-libre 4.9.309-gnu1
[releases.git] / tools / perf / Documentation / perf.txt
1 perf(1)
2 =======
3
4 NAME
5 ----
6 perf - Performance analysis tools for Linux
7
8 SYNOPSIS
9 --------
10 [verse]
11 'perf' [--version] [--help] [OPTIONS] COMMAND [ARGS]
12
13 OPTIONS
14 -------
15 --debug::
16         Setup debug variable (see list below) in value
17         range (0, 10). Use like:
18           --debug verbose   # sets verbose = 1
19           --debug verbose=2 # sets verbose = 2
20
21         List of debug variables allowed to set:
22           verbose          - general debug messages
23           ordered-events   - ordered events object debug messages
24           data-convert     - data convert command debug messages
25
26 --buildid-dir::
27         Setup buildid cache directory. It has higher priority than
28         buildid.dir config file option.
29
30 -v::
31 --version::
32   Display perf version.
33
34 -h::
35 --help::
36   Run perf help command.
37
38 DESCRIPTION
39 -----------
40 Performance counters for Linux are a new kernel-based subsystem
41 that provide a framework for all things performance analysis. It
42 covers hardware level (CPU/PMU, Performance Monitoring Unit) features
43 and software features (software counters, tracepoints) as well.
44
45 SEE ALSO
46 --------
47 linkperf:perf-stat[1], linkperf:perf-top[1],
48 linkperf:perf-record[1], linkperf:perf-report[1],
49 linkperf:perf-list[1]