| Mike Dodd | 8cfa702 | 2010-11-17 11:12:26 -0800 | [diff] [blame] | 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 out of directory dir_path instead of the default location (/var/lib/oprofile). |
| 94 | .br |
| 95 | .TP |
| 96 | .BI "--show-address / -w" |
| 97 | Show each symbol's VMA address. |
| 98 | .br |
| 99 | .TP |
| 100 | .BI "--sort / -s [vma,sample,symbol,debug,image]" |
| 101 | Sort the list of symbols by, respectively, symbol address, |
| 102 | number of samples, symbol name, debug filename and line number, |
| 103 | binary image filename. |
| 104 | .br |
| 105 | .TP |
| 106 | .BI "--symbols / -l" |
| 107 | List per-symbol information instead of a binary image summary. |
| 108 | .br |
| 109 | .TP |
| 110 | .BI "--threshold / -t [percentage]" |
| 111 | Only output data for symbols that have more than the given percentage |
| 112 | of total samples. |
| 113 | .br |
| 114 | .TP |
| 115 | .BI "--verbose / -V [options]" |
| 116 | Give verbose debugging output. |
| 117 | .br |
| 118 | .TP |
| 119 | .BI "--version / -v" |
| 120 | Show version. |
| 121 | .br |
| 122 | .TP |
| 123 | .BI "--xml / -X" |
| 124 | Generate XML output. |
| 125 | |
| 126 | .SH ENVIRONMENT |
| 127 | No special environment variables are recognised by opreport. |
| 128 | |
| 129 | .SH FILES |
| 130 | .TP |
| 131 | .I /var/lib/oprofile/samples/ |
| 132 | The location of the generated sample files. |
| 133 | |
| 134 | .SH VERSION |
| 135 | .TP |
| 136 | This man page is current for @PACKAGE@-@VERSION@. |
| 137 | |
| 138 | .SH SEE ALSO |
| 139 | .BR @OP_DOCDIR@, |
| 140 | .BR oprofile(1) |