User Guide

Intel® VTune™ Profiler User Guide

ID 766319
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

vtune Command Syntax

Use the following Intel® VTune™ Profiler vtune command syntax:

vtune <-action> [-action-option] [-global-option] [[--] <target> [target-options]]

vtune

The name of the VTune Profiler command line tool.

<-action>

The action to perform, such as collect or report.

[-action-option]

Action-options modify behavior specific to the action. You can have multiple action-options per action. Using an action-option that does not apply to the action results in a usage error.

NOTE:

Long names of the options can be abbreviated. If the option consists of several words you can abbreviate each word, keeping the dash between them. Make sure an abbreviated version unambiguously matches the long name. For example, the -option-name option can be abbreviated as -opt-name, -op-na, -opt-n, or -o-n.

[-global-option]

Global-options modify behavior in the same manner for all actions. You can have multiple global-options per action.

[--] <target>

The target application to analyze.

NOTE:

You may use vtune to analyze remote targets running on regular Linux* or Android* systems.

[target-options]

Options for the application.

NOTE:

See the VTune Profiler CLI Cheat Sheet quick reference on VTune Profiler command line interface.

Example

This example runs the Hotspots analysis for the sample target located at the /home/test/ directory on a Linux* system, saves the analysis result in the r001hs subdirectory of the current directory, and displays the default summary report.

vtune -collect hotspots -result-dir r001hs -quiet /home/test/sample

where:

  • -collect is an action

  • hotspots is an argument of the action

  • -result-dir is an action-option

  • r001hs is an argument of the action-option

  • -quiet is a global-option

  • sample is a target