Ingo Molnar | 6142fdd | 2009-04-20 16:05:55 +0200 | [diff] [blame] | 1 | perf-help(1) |
Ingo Molnar | 6e6b754 | 2008-04-15 22:39:31 +0200 | [diff] [blame] | 2 | ============ |
Ingo Molnar | 6142fdd | 2009-04-20 16:05:55 +0200 | [diff] [blame] | 3 | |
| 4 | NAME |
| 5 | ---- |
| 6 | perf-help - display help information about perf |
| 7 | |
| 8 | SYNOPSIS |
| 9 | -------- |
| 10 | 'perf help' [-a|--all] [COMMAND] |
| 11 | |
| 12 | DESCRIPTION |
| 13 | ----------- |
| 14 | |
| 15 | With no options and no COMMAND given, the synopsis of the 'perf' |
| 16 | command and a list of the most commonly used perf commands are printed |
| 17 | on the standard output. |
| 18 | |
| 19 | If the option '--all' or '-a' is given, then all available commands are |
| 20 | printed on the standard output. |
| 21 | |
| 22 | If a perf command is named, a manual page for that command is brought |
| 23 | up. The 'man' program is used by default for this purpose, but this |
| 24 | can be overridden by other options or configuration variables. |
| 25 | |
| 26 | Note that `perf --help ...` is identical to `perf help ...` because the |
| 27 | former is internally converted into the latter. |
| 28 | |
| 29 | OPTIONS |
| 30 | ------- |
| 31 | -a:: |
| 32 | --all:: |
| 33 | Prints all the available commands on the standard output. This |
| 34 | option supersedes any other option. |
| 35 | |
| 36 | PERF |
| 37 | ---- |
| 38 | Part of the linkperf:perf[1] suite |