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 -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
  67 DESCRIPTION
  68 -----------
  69 Performance counters for Linux are a new kernel-based subsystem
  70 that provide a framework for all things performance analysis. It
  71 covers hardware level (CPU/PMU, Performance Monitoring Unit) features
  72 and software features (software counters, tracepoints) as well.
  73
  74 SEE ALSO
  75 --------
  76 linkperf:perf-stat[1], linkperf:perf-top[1],
  77 linkperf:perf-record[1], linkperf:perf-report[1],
  78 linkperf:perf-list[1]
  79
  80 linkperf:perf-annotate[1],linkperf:perf-archive[1],
  81 linkperf:perf-bench[1], linkperf:perf-buildid-cache[1],
  82 linkperf:perf-buildid-list[1], linkperf:perf-c2c[1],
  83 linkperf:perf-config[1], linkperf:perf-data[1], linkperf:perf-diff[1],
  84 linkperf:perf-evlist[1], linkperf:perf-ftrace[1],
  85 linkperf:perf-help[1], linkperf:perf-inject[1],
  86 linkperf:perf-intel-pt[1], linkperf:perf-iostat[1], linkperf:perf-kallsyms[1],
  87 linkperf:perf-kmem[1], linkperf:perf-kvm[1], linkperf:perf-lock[1],
  88 linkperf:perf-mem[1], linkperf:perf-probe[1], linkperf:perf-sched[1],
  89 linkperf:perf-script[1], linkperf:perf-test[1],
  90 linkperf:perf-trace[1], linkperf:perf-version[1]