Overview of Open|SpeedShop CLI Commands.

Version 2.1
August 9, 2014


Table of Contents


Experiment Building Block Commands

 
   

expAttach

Attach a new collector, executable or running rank, process, or thread to an experiment.

expClose

Close/release the experiment by removing all knowledge of it.

expCreate

Start the definition of an experiment and return an identifier.

expDetach

Remove data collection for a process, rank or thread.

expDisable

Turn off data collection for an experiment.

expEnable

Restart data collection for an experiment.

expFocus

Focus the current input window on a specified experiment.

expGo

Start execution or continue running the experiment.

expPause

Temporarily interrupt the specified experiments' application and data gathering.

expRestore

Restore an experiment's definition and the previously saved performance data from a file for further analysis.

expSave

Save the experiment data to a file for later analysis.

expSetParam

Alter a value that is used as a parameter to a data collector.

   
   

Experiment Information Commands

 
   

expStatus

View the current state of a user defined experiment.

expView

View the experiment’s output in text form.

   
   

Low Level Information Commands

 
   

listBreaks

List the breakpoints that have been set by the user.

listExp

List the experiments that are currently defined for this session.

listHosts

List the machine hosts that are known.

listObj

List the object files that are known.

listPids

List the process Id's that are known.

listMetrics

List the measurements that an experiment is capable of making.

listParams

List the parameters of an experiment that can be set by the user.

listRanks

List the mpi ranks that are known.

listSrc

Display a source file.

listStatus

List the current status of an experiment.

listThreads

List the threads that are known.

listTypes

List the performance measurement utilities that are available to instrument an application.

listViews

List the reports that can be produced by an experiment.

   
   

Session Commands

 
   

clearBreak

Remove a breakpoint.

exit

Terminate the session.

help

Provide help to the user on specific topics based on user input.

history

Echo the commands that have been previously executed in the CLI interface.

log

Trace the internal evaluation of commands.

openGui


Open the Graphical User Interface.

playBack

Read and execute commands stored in a file.

record

Save to a user-specified filename the commands entered by the user.

setBreak

Define a breakpoint at which to halt the application’s running rank, process, or thread.