| Mike Dodd | 8cfa702 | 2010-11-17 11:12:26 -0800 | [diff] [blame] | 1 | .TH OPANNOTATE 1 "@DATE@" "oprofile @VERSION@" |
| 2 | .UC 4 |
| 3 | .SH NAME |
| 4 | opannotate \- produce source or assembly annotated with profile data |
| 5 | .SH SYNOPSIS |
| 6 | .br |
| 7 | .B opannotate |
| 8 | [ |
| 9 | .I options |
| 10 | ] |
| 11 | [profile specification] |
| 12 | .SH DESCRIPTION |
| 13 | |
| 14 | .B opannotate |
| 15 | outputs annotated source and/or assembly from profile data of an OProfile |
| 16 | session. See oprofile(1) for how to write profile specifications. |
| 17 | |
| 18 | .SH OPTIONS |
| 19 | .TP |
| 20 | .BI "--assembly / -a" |
| 21 | Output annotated assembly. If this is combined with --source, then mixed |
| 22 | source / assembly annotations are output. |
| 23 | .br |
| 24 | .TP |
| 25 | .BI "--demangle / -D none|smart|normal" |
| 26 | none: no demangling. normal: use default demangler (default) smart: use |
| 27 | pattern-matching to make C++ symbol demangling more readable. |
| 28 | .br |
| 29 | .TP |
| 30 | .BI "--exclude-dependent / -x" |
| 31 | Do not include application-specific images for libraries, kernel modules |
| 32 | and the kernel. This option only makes sense if the profile session |
| 33 | used --separate. |
| 34 | .br |
| 35 | .TP |
| 36 | .BI "--exclude-file [files]" |
| 37 | Exclude all files in the given comma-separated list of glob patterns. |
| 38 | .br |
| 39 | .TP |
| 40 | .BI "--exclude-symbols / -e [symbols]" |
| 41 | Exclude all the symbols in the given comma-separated list. |
| 42 | .br |
| 43 | .TP |
| 44 | .BI "--help / -? / --usage" |
| 45 | Show help message. |
| 46 | .br |
| 47 | .TP |
| 48 | .BI "--image-path / -p [paths]" |
| 49 | Comma-separated list of additional paths to search for binaries. |
| 50 | This is needed to find modules in kernels 2.6 and upwards. |
| 51 | .br |
| 52 | .TP |
| 53 | .BI "--root / -R [path]" |
| 54 | A path to a filesystem to search for additional binaries. |
| 55 | .br |
| 56 | .TP |
| 57 | .BI "--include-file [files]" |
| 58 | Only include files in the given comma-separated list of glob patterns. |
| 59 | .br |
| 60 | .TP |
| 61 | .BI "--include-symbols / -i [symbols]" |
| 62 | Only include symbols in the given comma-separated list. |
| 63 | .br |
| 64 | .TP |
| 65 | .BI "--objdump-params [params]" |
| 66 | Pass the given parameters as extra values when calling objdump. |
| 67 | .br |
| 68 | .TP |
| 69 | .BI "--output-dir / -o [dir]" |
| 70 | Output directory. This makes opannotate output one annotated file for each |
| 71 | source file. This option can't be used in conjunction with --assembly. |
| 72 | .br |
| 73 | .TP |
| 74 | .BI "--search-dirs / -d [paths]" |
| 75 | Comma-separated list of paths to search for source files. You may need to use |
| 76 | this option when the debug information for an image contains relative paths. |
| 77 | .br |
| 78 | .TP |
| 79 | .BI "--base-dirs / -b [paths]" |
| 80 | Comma-separated list of paths to strip from debug source files, prior to |
| 81 | looking for them in --search-dirs. |
| 82 | .br |
| 83 | .TP |
| 84 | .BI "--session-dir="dir_path |
| 85 | Use sample database out of directory dir_path instead of the default location (/var/lib/oprofile). |
| 86 | .br |
| 87 | .TP |
| 88 | .BI "--source / -s" |
| 89 | Output annotated source. This requires debugging information to be available |
| 90 | for the binaries. |
| 91 | .br |
| 92 | .TP |
| 93 | .BI "--threshold / -t [percentage]" |
| 94 | Only output data for symbols that have more than the given percentage |
| 95 | of total samples. |
| 96 | .br |
| 97 | .TP |
| 98 | .BI "--verbose / -V [options]" |
| 99 | Give verbose debugging output. |
| 100 | .br |
| 101 | .TP |
| 102 | .BI "--version / -v" |
| 103 | Show version. |
| 104 | |
| 105 | .SH ENVIRONMENT |
| 106 | No special environment variables are recognised by opannotate. |
| 107 | |
| 108 | .SH FILES |
| 109 | .TP |
| 110 | .I /var/lib/oprofile/samples/ |
| 111 | The location of the generated sample files. |
| 112 | |
| 113 | .SH VERSION |
| 114 | .TP |
| 115 | This man page is current for @PACKAGE@-@VERSION@. |
| 116 | |
| 117 | .SH SEE ALSO |
| 118 | .BR @OP_DOCDIR@, |
| 119 | .BR oprofile(1) |