blob: 035d26cc2ec91bec59922b5df628f3226e17420c [file] [log] [blame]
Upstreamcc2ee171970-01-12 13:46:40 +00001.TH OPREPORT 1 "@DATE@" "oprofile @VERSION@"
2.UC 4
3.SH NAME
4opreport \- produce symbol or binary image summaries
5.SH SYNOPSIS
6.br
7.B opreport
8[
9.I options
10]
11[profile specification]
12.SH DESCRIPTION
13
14.B opreport
15outputs binary image summaries, or per-symbol data, from OProfile profiling
16sessions.
17
18.SH OPTIONS
19.TP
20.BI "--accumulated / -a"
21Accumulate sample and percentage counts in the symbol list.
22.br
23.TP
24.BI "--debug-info / -g"
25Show source file and line for each symbol.
26.br
27.TP
28.BI "--demangle / -D none|smart|normal"
29none: no demangling. normal: use default demangler (default) smart: use
30pattern-matching to make C++ symbol demangling more readable.
31.br
32.TP
33.BI "--callgraph / -c"
34Show call graph information if available.
35.br
36.TP
37.BI "--details / -d"
38Show per-instruction details for all selected symbols.
39.br
40.TP
41.BI "--exclude-dependent / -x"
42Do not include application-specific images for libraries, kernel modules
43and the kernel. This option only makes sense if the profile session
44used --separate.
45.br
46.TP
47.BI "--exclude-symbols / -e [symbols]"
48Exclude all the symbols in the given comma-separated list.
49.br
50.TP
51.BI "--global-percent / -%"
52Make all percentages relative to the whole profile.
53.br
54.TP
55.BI "--help / -? / --usage"
56Show help message.
57.br
58.TP
59.BI "--image-path / -p [paths]"
60Comma-separated list of additional paths to search for binaries.
61This is needed to find modules in kernels 2.6 and upwards.
62.br
63.TP
64.BI "--include-symbols / -i [symbols]"
65Only include symbols in the given comma-separated list.
66.br
67.TP
68.BI "--long-filenames / -l"
69Output full paths instead of basenames.
70.br
71.TP
72.BI "--merge / -m [lib,cpu,tid,tgid,unitmask,all]"
73Merge any profiles separated in a --separate session.
74.br
75.TP
76.BI "--no-header"
77Don't output a header detailing profiling parameters.
78.br
79.TP
80.BI "--output-file / -o [file]"
81Output to the given file instead of stdout.
82.br
83.TP
84.BI "--reverse-sort / -r"
85Reverse the sort from the default.
86.br
87.TP
88.BI "--show-address / -w"
89Show each symbol's VMA address.
90.br
91.TP
92.BI "--sort / -s [vma,sample,symbol,debug,image]"
93Sort the list of symbols by, respectively, symbol address,
94number of samples, symbol name, debug filename and line number,
95binary image filename.
96.br
97.TP
98.BI "--symbols / -l"
99List per-symbol information instead of a binary image summary.
100.br
101.TP
102.BI "--threshold / -t [percentage]"
103Only output data for symbols that have more than the given percentage
104of total samples.
105.br
106.TP
107.BI "--verbose / -V [options]"
108Give verbose debugging output.
109.br
110.TP
111.BI "--version / -v"
112Show version.
113
114.SH ENVIRONMENT
115No special environment variables are recognised by opreport.
116
117.SH FILES
118.TP
119.I /var/lib/oprofile/samples/
120The location of the generated sample files.
121
122.SH VERSION
123.TP
124This man page is current for @PACKAGE@-@VERSION@.
125
126.SH SEE ALSO
127.BR @OP_DOCDIR@,
128.BR oprofile(1)