Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

[0d0e60]: doc / opcontrol.1.in Maximize Restore History

Download this file

opcontrol.1.in    140 lines (134 with data), 3.2 kB

.TH OPCONTROL 1 "@DATE@" "oprofile @VERSION@"
.UC 4
.SH NAME
opcontrol \- control OProfile profiling
.SH SYNOPSIS
.br
.B opcontrol
[
.I options
]
.SH DESCRIPTION
.B opcontrol
can be used to start profiling, end a profiling session,
dump profile data, and set up the profiling parameters.

.SH OPTIONS
.TP
.BI "--help"
Show help message.
.br
.TP
.BI "--version"
Show version.
.br
.TP
.BI "--list-events"
Shows the monitorable events.
.br
.TP
.BI "--init"
Load the OProfile module if required and make the OProfile driver
interface available.
.br
.TP
.BI "--setup"
Followed by list options for profiling setup. Store setup 
in ~root/.oprofile/daemonrc. Optional.
.br
.TP
.BI "--start-daemon"
Start the oprofile daemon without starting profiling. Not available
in 2.2/2.4 kernels.
.br
.TP
.BI "--start"
Start data collection with either arguments provided by --setup
of information saved in ~root/.oprofile/daemonrc.
.br
.TP
.BI "--dump"
Force a flush of the collected profiling data to the daemon.
.br
.TP
.BI "--stop"
Stop data collection. Not available in 2.2/2.4 kernels.
.br
.TP
.BI "--shutdown"
Stop data collection and kill the daemon.
.br
.TP
.BI "--reset"
Clear out data from current session, but leaves saved sessions.
.br
.TP
.BI "--save="sessionname
Save data from current session to sessionname.
.br
.TP
.BI "--deinit"
Shut down daemon. Unload the oprofile module and oprofilefs.
.br
.TP
.BI "--buffer-size="num
Set kernel buffer to num samples.
.br
.TP
.BI "--event="[event|"default"]
Add an event to measure for the hardware performance counters,
or "default" for the default event. The event is of the form
"CPU_CLK_UNHALTED:30000:0:1:1" where the numeric values are
count, unit mask, kernel-space counting, user-space counting,
respectively.
.br
.TP
.BI "--separate="[none,library,kernel,thread,cpu,all]
Separate samples based on the given separator. 'library' separates
dynamically linked library samples per application. 'kernel' separates
kernel and kernel module samples per application; 'kernel'
implies 'library'. 'thread' gives separation for each thread and
task.  'cpu' separates for each CPU. 'all' implies all of the above
options and 'none' turns off separation.
.br
.TP
.BI "--callgraph=#depth"
Enable callgraph sample collection with a maximum depth. Use 0 to disable
callgraph. This option is ignored with 2.2/2.4 or 2.6 kernel w/o the
callgraph support patch (x86 only).
.br
.TP
.BI "--image="[name,name...|"all"]
Only profile the given absolute paths to binaries, or "all" to profile
everything (the default).
.br
.TP
.BI "--vmlinux="file
vmlinux kernel image.
.br
.TP
.BI "--no-vmlinux"
Use this when you don't have a kernel vmlinux file, and you don't want to
profile the kernel.
.br
.TP
.BI "--verbose"
Be verbose in the daemon log. This has a high overhead.
.br
.TP
.BI "--kernel-range="start,end
Set kernel range vma address in hexadecimal.

.SH ENVIRONMENT
No special environment variables are recognised by opreport.

.SH FILES
.TP
.I /root/.oprofile/daemonrc
Configuration file for opcontrol
.TP
.I /var/lib/oprofile/samples/
The location of the generated sample files.

.SH VERSION
.TP
This man page is current for @PACKAGE@-@VERSION@.

.SH SEE ALSO
.BR @OP_DOCDIR@,
.BR oprofile(1)