| Mike Dodd | 8cfa702 | 2010-11-17 11:12:26 -0800 | [diff] [blame] | 1 | .TH OPHELP 1 "@DATE@" "oprofile @VERSION@" |
| 2 | .UC 4 |
| 3 | .SH NAME |
| 4 | ophelp \- list OProfile events |
| 5 | .SH SYNOPSIS |
| 6 | .br |
| 7 | .B ophelp |
| 8 | [ |
| 9 | .I options |
| 10 | ] |
| 11 | [event name] |
| 12 | .SH DESCRIPTION |
| 13 | |
| 14 | By default, |
| 15 | .B ophelp |
| 16 | lists the available performance counter options. If you |
| 17 | give it a symbolic event name, it will return the hardware |
| 18 | value (e.g. "ophelp DATA_MEM_REFS"). |
| 19 | |
| 20 | .SH OPTIONS |
| 21 | .TP |
| 22 | .BI "--cpu-type / -c" |
| 23 | Show the events for the given numerical CPU type. |
| 24 | .br |
| 25 | .TP |
| 26 | .BI "--get-cpu-type / -r" |
| 27 | Show the symbolic CPU name. |
| 28 | .br |
| 29 | .TP |
| 30 | .BI "--xml / -X" |
| 31 | List events in XML format. |
| 32 | .br |
| 33 | .TP |
| 34 | .BI "--help / -? / --usage" |
| 35 | Show help message. |
| 36 | .br |
| 37 | .TP |
| 38 | .BI "--version / -v" |
| 39 | Show version. |
| 40 | |
| 41 | .SH ENVIRONMENT |
| 42 | No special environment variables are recognised by ophelp. |
| 43 | |
| 44 | .SH FILES |
| 45 | .TP |
| 46 | .I $prefix/share/oprofile/ |
| 47 | Event description files used by OProfile. |
| 48 | .TP |
| 49 | .I /var/lib/oprofile/samples/ |
| 50 | The location of the generated sample files. |
| 51 | |
| 52 | .SH VERSION |
| 53 | .TP |
| 54 | This man page is current for @PACKAGE@-@VERSION@. |
| 55 | |
| 56 | .SH SEE ALSO |
| 57 | .BR @OP_DOCDIR@, |
| 58 | .BR oprofile(1) |