Getting Help

Intel® VTune™ Amplifier provides multiple documentation formats and resources that help you better understand product functionality:

Note

This topic describes different options to get documentation support for the VTune Amplifier in any Intel Studio. Note that Visual Studio IDE integration is available only for the VTune Amplifier XE, part of Intel Parallel Studio XE and Intel Cluster Studio XE.

Accessing Documentation

To access product documentation, do any of the following:

  • For the VTune Amplifier XE integrated into the Visual Studio user interface: Select Intel VTune Amplifier version> documentation_format from the Help menu or click the Help button on the VTune Amplifier toolbar:

  • For the standalone user interface of the VTune Amplifier: Click the menu button and select Help > documentation_format or click the Help button on the product toolbar.

  • From the Start menu, select Program Files > Intel_Studio_version > Intel VTune Amplifier version > documentation_format > Intel VTune Amplifier documentation_format. For example: Program Files > Intel Parallel Studio XE 2013 > Intel VTune Amplifier XE 2013 > Documentation > Intel VTune Amplifier XE Documentation.

Getting Started Page

VTune Amplifier provides a Getting Started page that includes a brief product introduction and links to installed resources, like Tutorials using a variety of tuning scenarios for sample applications, and links to documentation resources available on the web. This page automatically opens after product installation. You can also access this page through the Help menu/toolbar button or Getting Stared link on the Welcome page of the standalone product version.

VTune Amplifier Help

VTune Amplifier Help system documents concepts, procedures, and reference information required to successfully work with the product. This help system is applicable to both VTune Amplifer XE and VTune Amplifier for Systems. VTune Amplifier Help is installed with the product as well as available from the Intel Software Documentation Library on the web. Installed help opens in the default HTML browser available on your system.

A short VTune Amplifier XE help module is also available from the Microsoft Visual Studio Help Viewer. To access it, select Help > View Help and navigate to the Intel® VTune™ Amplifier version module in the Help Viewer Home.

VTune Amplifier enables easy access to help topics on active GUI elements by providing context-sensitive help. The following context-sensitive help features are available on a product-specific basis:

  • F1 Help: Press F1 to get help for an active dialog box, property page, pane, or window.

  • What's This Column: In the grid, right-click a performance metric column and select the What's This Column entry from the context menu to open a help topic for this particular metric. You can also view a lightweight metric description in the pop-up window when hovering over the column name.

  • =

    ? Help: In Visual Studio, click the ? button, in the upper-right corner of the dialog box or pane to get help for the dialog box or pane.

Tutorials

VTune Amplifier provides 15-minute tutorials that show you how to use basic or advanced product features with a short sample. The tutorials provide an excellent foundation before you read the VTune Amplifier help. For details, see the Tutorials and Samples topic.

Video and Technical Articles

You can select the Video and Articles Help menu item to access the VTune Amplifier web page with How-to videos and technical articles.

Intel Processor Event Reference

VTune Amplifier documentation includes Reference for Intel processor events. To access the Reference for a particular Intel processor/microarchitecture, select Intel Processor Event Reference option from the Help menu and choose the required microarchitecture/processor. Intel Processor Event Reference is also available from Intel Software Documentation Library on the web.

You can also find it useful to explore Tuning Guides for Intel microarchitecture created by Intel architects and available on the web.

Release Notes and Installation Guide

VTune Amplifier Release Notes provide the most up-to-date information about the product, including a product description, technical support, and known limitations and issues. This document also contains installation instructions and system requirements for installing the product. Before installation, the Installation Guide and Release Notes document is located at the root level (same level as the installation script/executable) of the installation download package. After installation it is available in the product documentation folder.

See Also


For more complete information about compiler optimizations, see our Optimization Notice.