xref: /OK3568_Linux_fs/kernel/tools/perf/Documentation/perf-help.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyunperf-help(1)
2*4882a593Smuzhiyun============
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunNAME
5*4882a593Smuzhiyun----
6*4882a593Smuzhiyunperf-help - display help information about perf
7*4882a593Smuzhiyun
8*4882a593SmuzhiyunSYNOPSIS
9*4882a593Smuzhiyun--------
10*4882a593Smuzhiyun'perf help' [-a|--all] [COMMAND]
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunDESCRIPTION
13*4882a593Smuzhiyun-----------
14*4882a593Smuzhiyun
15*4882a593SmuzhiyunWith no options and no COMMAND given, the synopsis of the 'perf'
16*4882a593Smuzhiyuncommand and a list of the most commonly used perf commands are printed
17*4882a593Smuzhiyunon the standard output.
18*4882a593Smuzhiyun
19*4882a593SmuzhiyunIf the option '--all' or '-a' is given, then all available commands are
20*4882a593Smuzhiyunprinted on the standard output.
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunIf a perf command is named, a manual page for that command is brought
23*4882a593Smuzhiyunup. The 'man' program is used by default for this purpose, but this
24*4882a593Smuzhiyuncan be overridden by other options or configuration variables.
25*4882a593Smuzhiyun
26*4882a593SmuzhiyunNote that `perf --help ...` is identical to `perf help ...` because the
27*4882a593Smuzhiyunformer is internally converted into the latter.
28*4882a593Smuzhiyun
29*4882a593SmuzhiyunOPTIONS
30*4882a593Smuzhiyun-------
31*4882a593Smuzhiyun-a::
32*4882a593Smuzhiyun--all::
33*4882a593Smuzhiyun	Prints all the available commands on the standard output. This
34*4882a593Smuzhiyun	option supersedes any other option.
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunPERF
37*4882a593Smuzhiyun----
38*4882a593SmuzhiyunPart of the linkperf:perf[1] suite
39