← Back to branch summary

~arosales/test/oprofile

« back to all changes in this revision

Viewing changes to doc/opreport.1.in

  • Committer: Antonio Rosales
  • Date: 2013-03-28 08:40:26 UTC
  • Revision ID: antonio.rosales@canonical.com-20130328084026-gpqns1mkqd7cnr05
Move files up one directory.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/opreport.1.in
 
1
.TH OPREPORT 1 "@DATE@" "oprofile @VERSION@"
 
2
.UC 4
 
3
.SH NAME
 
4
opreport \- 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
 
15
outputs binary image summaries, or per-symbol data, from OProfile profiling
 
16
sessions. See oprofile(1) for how to write profile specifications.
 
17
 
 
18
.SH OPTIONS
 
19
.TP
 
20
.BI "--accumulated / -a"
 
21
Accumulate sample and percentage counts in the symbol list.
 
22
.br
 
23
.TP
 
24
.BI "--debug-info / -g"
 
25
Show source file and line for each symbol.
 
26
.br
 
27
.TP
 
28
.BI "--demangle / -D none|smart|normal"
 
29
none: no demangling. normal: use default demangler (default) smart: use
 
30
pattern-matching to make C++ symbol demangling more readable.
 
31
.br
 
32
.TP
 
33
.BI "--callgraph / -c"
 
34
Show call graph information if available.
 
35
.br
 
36
.TP
 
37
.BI "--details / -d"
 
38
Show per-instruction details for all selected symbols.
 
39
.br
 
40
.TP
 
41
.BI "--exclude-dependent / -x"
 
42
Do not include application-specific images for libraries, kernel modules
 
43
and the kernel. This option only makes sense if the profile session
 
44
used --separate.
 
45
.br
 
46
.TP
 
47
.BI "--exclude-symbols / -e [symbols]"
 
48
Exclude all the symbols in the given comma-separated list.
 
49
.br
 
50
.TP
 
51
.BI "--global-percent / -%"
 
52
Make all percentages relative to the whole profile.
 
53
.br
 
54
.TP
 
55
.BI "--help / -? / --usage"
 
56
Show help message.
 
57
.br
 
58
.TP
 
59
.BI "--image-path / -p [paths]"
 
60
Comma-separated list of additional paths to search for binaries.
 
61
This is needed to find modules in kernels 2.6 and upwards.
 
62
.br
 
63
.TP
 
64
.BI "--root / -R [path]"
 
65
A path to a filesystem to search for additional binaries.
 
66
.br
 
67
.TP
 
68
.BI "--include-symbols / -i [symbols]"
 
69
Only include symbols in the given comma-separated list.
 
70
.br
 
71
.TP
 
72
.BI "--long-filenames / -f"
 
73
Output full paths instead of basenames.
 
74
.br
 
75
.TP
 
76
.BI "--merge / -m [lib,cpu,tid,tgid,unitmask,all]"
 
77
Merge any profiles separated in a --separate session.
 
78
.br
 
79
.TP
 
80
.BI "--no-header"
 
81
Don't output a header detailing profiling parameters.
 
82
.br
 
83
.TP
 
84
.BI "--output-file / -o [file]"
 
85
Output to the given file instead of stdout.
 
86
.br
 
87
.TP
 
88
.BI "--reverse-sort / -r"
 
89
Reverse the sort from the default.
 
90
.br
 
91
.TP
 
92
.BI "--session-dir="dir_path
 
93
Use sample database from the specified directory
 
94
.I dir_path
 
95
instead of the default locations. If
 
96
.I --session-dir
 
97
is not specified, then
 
98
.B opreport
 
99
will search for samples in
 
100
.I <current_dir>/oprofile_data
 
101
first. If that directory does not exist, the standard session-dir of /var/lib/oprofile is used.
 
102
.br
 
103
.TP
 
104
.BI "--show-address / -w"
 
105
Show each symbol's VMA address.
 
106
.br
 
107
.TP
 
108
.BI "--sort / -s [vma,sample,symbol,debug,image]"
 
109
Sort the list of symbols by, respectively, symbol address,
 
110
number of samples, symbol name, debug filename and line number,
 
111
binary image filename.
 
112
.br
 
113
.TP
 
114
.BI "--symbols / -l"
 
115
List per-symbol information instead of a binary image summary.
 
116
.br
 
117
.TP
 
118
.BI "--threshold / -t [percentage]"
 
119
Only output data for symbols that have more than the given percentage
 
120
of total samples.
 
121
.br
 
122
.TP
 
123
.BI "--verbose / -V [options]"
 
124
Give verbose debugging output.
 
125
.br
 
126
.TP
 
127
.BI "--version / -v"
 
128
Show version.
 
129
.br
 
130
.TP
 
131
.BI "--xml / -X"
 
132
Generate XML output.
 
133
 
 
134
.SH ENVIRONMENT
 
135
No special environment variables are recognized by opreport.
 
136
 
 
137
.SH FILES
 
138
.I <current_dir>/oprofile_data/samples
 
139
.RS 7
 
140
Or
 
141
.RE
 
142
.I /var/lib/oprofile/samples/
 
143
.LP
 
144
.RS 7
 
145
The location of the generated sample files.
 
146
.RE
 
147
 
 
148
.SH VERSION
 
149
.TP
 
150
This man page is current for @PACKAGE@-@VERSION@.
 
151
 
 
152
.SH SEE ALSO
 
153
.BR @OP_DOCDIR@,
 
154
.BR oprofile(1)