User Guide

Intel® VTune™ Profiler User Guide

ID 766319
Date 3/31/2023

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

Document Table of Contents
Give Feedback

Option Descriptions and General Rules

All option descriptions in the Intel® VTune™ ProfilerCommand Line Interface Reference follow the general rules and templates described below.

Option Description

Each option description provides the following information:

  • A short description of the option.

  • Products: This section lists the names of products supporting this option.

  • GUI Equivalent: This section shows the equivalent of the option in the integrated development environment (IDE)/standalone GUI client. If no equivalent is available, None is specified.

  • Syntax: This section describes the command line syntax of the option.

  • Arguments: This section lists the arguments related to the option. If it has no arguments, None is specified.

  • Default: This section shows the default setting for the option.

  • Modifiers: This section lists the modifiers for the described action. The section is only available for actions.

  • Actions Modified: This section lists the actions modified by the described option. The section is only available for modifiers.

  • Description: This section provides the full description for the option.

  • Alternate Options: These options can be used instead of the described option. If no alternate options are available, None is specified.

  • Example: This is a typical usage example of the option.

  • See Also: This section provides links to further information related to the option such as other options or corresponding GUI procedures.

General Rules

  • Options can be preceded by a single dash ("-") or a double dash ("--").

  • Option names and values can be separated with a space (" "), or an equal sign ("=").

  • Options defining the collection are specified before the analyzed target and can appear on the command line in any order. Options related to the target are specified after the target

  • You cannot combine options with a single dash. For example, -q and -c options cannot be specified as -qc option.

  • Options may have short and long names. Short names consist of one letter. Long names consist of one or more words separated by dashes. Both short and long names are case-sensitive. Long and short option names can be used interchangeably. For example, you may use -report or -R to generate a report.

  • 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.

  • If the abbreviation is ambiguous between two available options, a syntax error is reported.

  • You can disable Boolean default options by specifying -no-<optionname> from the command line. For example, to avoid displaying a summary report after analysis, run vtune with the -no-summary option. Conversely, if the default is -no-<option>, you can disable it by specifying -<optionname>.

  • You can specify multiple values for the option by using the option several times, or by using the option once and specifying comma-separated values (make sure there are no spaces around the commas). The examples below are equivalent and specify two filters for the r001tr result when generating a hotspots report.

    On Linux*:

    vtune -R hotspots -r r001tr -filter module=tachyon -filter module=vmlinux

    vtune -R hotspots -r r001tr -filter module=tachyon,vmlinux

    On Windows*:

    vtune -R hotspots -r r001tr -filter module=ntdll.dll -filter module=main.exe

    vtune -R hotspots -r r001tr -filter module=ntdll.dll,main.exe