You copied the Doc URL to your clipboard.

Streamline command-line options

The streamline command has different modes that enable you to use most features of Streamline outside of the DS-5 for Eclipse user interface.

Streamline command-line modes

Use the streamline command in a Streamline-enabled shell with the following syntax:

streamline <mode> [options] <file...>

Use either of the following options directly after streamline on the command line:

Mode

Description

-capture

This mode initiates a capture session. You must specify a valid session.xml file with this option. The session.xml file defines your target hardware and the parameters of the capture session. For example:

streamline -capture session.xml

To create a session.xml file, enter your settings and then use the Export... option in the Capture & Analysis Options dialog box in the Streamline Data view in DS-5.

-report

This mode reads data from a capture and outputs it to your console or to a file. You can use additional options to filter and format the data. You must enter a valid .apc file after the declaration of report mode. For example:

streamline -report threads_001.apc

Figure 14-1 A functions report generated using report mode

A functions report generated using report mode

Options common to both modes

The following options are available in both modes:

Option

Description

-h, -?, -help

Outputs help information to the console, listing each mode and option as well as the required syntax.

-v, -version

Displays the program version information.

-o, -output <filename>

In capture mode, defines the name of the capture file to create.

In report mode, defines the name of the file to which to send the output. If you do not specify this option, output is sent to the console.

Capture mode options

The following options are available only in capture mode:

Option

Description

-duration <seconds>

Sets the number of seconds that you want the capture to last. The capture automatically terminates when it reaches that duration. For example, the following command triggers a 60 second capture session:

streamline -capture -duration 60 session.xml

-config <configuration.xml>

Defines the location of the configuration file to send to the target.

-retrieve-image <regex>

Specifies a regex that is used to match the processes to retrieve from the target.

-username <string>

Specifies the username to use when retrieving images from the target.

-password <string>

Specifies the password to use when retrieving images from the target.

-include-libs

Fetches the relevant libraries when retrieving images from the target.

Report mode options

The following options are unique to report mode:

Option

Description

-all

Outputs the contents of the Timeline, Call Paths, Functions, and Log views, including bookmarks and custom activity map tables. This is the default option.

-callpath

Outputs the contents of the table data of the Call Paths view. Subordinate functions are indented.

-function

Outputs the contents of the Functions view.

-log

Outputs the contents of the Log view.

-timeline

Outputs the contents of the Timeline view.

-cam

Outputs the contents of custom activity map tables.

Note

To export custom activity map data, the report must contain custom activity map annotations.
-opencl

Outputs the contents of the OpenCL table.

Note

To export OpenCL data, the report must contain OpenCL annotations.
-bookmarks

Outputs all bookmarks stored in a capture, listing the time index location of the bookmark and its text.

-template

Use this option with the location of a valid chart configuration file to list your customized charts on the command line. Use the Export snippet configuration to a file button in the Snippet menu of the Timeline view to create a valid configuration, then use that file with the -template option.

-per_cluster

When used with the -timeline option, this option forces Streamline to output per-cluster data. By default, it outputs aggregated data.

-per_core

Outputs per-core data when used with the -timeline option.

-start <seconds>

Filters output data to start at the specified time within the timeline. For example if you enter 0.005 with this option, all data before the 5 millisecond mark is not included in the output.

-stop <seconds>

Filters output data to stop at the specified time within the timeline.

-bstart <name>

Filter the data to start at the first bookmark with the provided name. For example, if you enter -bstart redflag, all data before the first instance of the bookmark title redflag is filtered from the output.

-bstop <name>

Filter the data to end at the first bookmark with the provided name.

-format <space|tab|csv>

Specifies the format of the output. Format the tables using spaces, tabs or comma-separated values. This can be useful if you want to easily convert output text files to your favorite spreadsheet program. The default format is spaces, making the tables easy to read when printed on the command line.

You can define multiple report types using these options. For example, enter streamline -report -callpath -function thread_001.apc to output only the Call Paths and Functions data from the thread_001.apc capture.

Related concepts

Was this page helpful? Yes No