Documentation ConventionsDocumentation ConventionsThis topic discusses the notation and interface conventions used in this documentation for the VTune(TM) Performance Environment command line interface (vtl).
This document uses typefaces and symbols described in the table below to indicate special text:
Item |
Description |
|---|---|
|
This type style |
An element of syntax, a reserved word, a keyword, or a file name. The text appears in lowercase unless uppercase is required. |
|
This type style |
A code example. |
|
This type style |
Indicates what you type as a command. |
|
This type style |
Indicates new terms being defined, for book titles, and occasionally for emphasis, or an option's argument. |
|
<arguments> |
Indicates an option's argument. |
|
{options} |
Indicates that the items enclosed in brackets are required. Do not type the brackets. |
|
[options] |
Indicates that the items enclosed in square brackets are optional. Do not type the brackets. |
|
value | value |
A value separated by a vertical bar (|) indicates a version of an option. |
|
... |
Ellipses in the code examples indicate that part of the code is not shown. |
VTune environment supports graphical and command-line interfaces. Help topics with the command line specifics are divided into the following categories:
Category |
Description |
|---|---|
|
Command-line only topics |
Topics contain command-line only information and show up in the table of contents with (vtl) appended. |
|
Shared topics |
Topics contain both command-line and graphical user interface information. Command-line specific information shows up in the topic under special headings. |
NoteDon't use space(s) when providing multiple comma-separated values, or provide within quotes, for example:
vtl view -modules -pid <pid1>,<pid2>
OR
vtl view -modules -pid "<pid1>, <pid2>"