Intel® VTune™ Performance Analyzer for Linux* - Documentation and command-line help

The documentation for the Intel® VTune™ Performance Analyzer for Linux* is presented in these formats:

• Documentation Index
• Readme File
• Installation Guide
• Administrator's Guide
• Readme File for the VTune Analyzer Remote Agent
• Command-line Help
• Man Pages
• HTML Reference, User's Guide and Getting Started Tutorial for vtl
• Integrated Eclipse platform environment help

• Enter vtl -help to view command syntax and options for vtl.
• Enter vtl -help -c <collector_name> where <collector_name> is either callgraph or sampling, for detailed help on collecting data.
• Enter vtl -help -v <view_name> where <view_name> is either callgraph, sampling or source, for detailed help on viewing data.
• Enter ActivityController -help to view command syntax and options for the ActivityController.

To view manual entries for the VTune analyzer, enter the appropriate command:

• man vtl for the vtl command man page
• man vtlec for the vtlec command man page
• man ActivityController for the ActivityController man page
• man sampling for the sampling collector man page
• man callgraph for the callgraph collector man page
• man source or man 7 source or man code for the source view man page

Note: To view the man pages in the local language, set the system variables LESSCHARSET and LANG as follows: LESSCHARSET=utf-8
LANG=zh_CN.utf8

The HTML documentation for the VTune analyzer consists of these components:

• Documentation Index. Open this document in the browser to view the list of available documentation. This document is available at < install_dir>/doc/doc_index.htm.
• VTune(TM) Performance Environment User's Guide. To access the guide, launch the index.htm file from the <install_dir>/doc/users_guide subdirectory.
• Reference Guide. To access the reference, launch the index.htm file from the <install_dir>/doc/reference subdirectory.
• Getting Started Tutorial. To access the tutorial, launch the index.htm file from the <install_dir>/doc/training/gs_vtune subdirectory.
• Java* Managed Run Time Environment Frequently Aske d Questions. To access the document, launch java_faq.htm file from the <install_dir> directory.
• These Release Notes

Where: <install_dir> is the installation directory. The default installation directory is: /opt/intel/vtune.

The HTML documentation can be viewed with any web browser, although a browser that supports HTML 4.0 is recommended. Older versions of browsers (especially Netscape* and Konqueror*) may not display some of the HTML documents correctly.

The VTune analyzer documentation in the integrated Eclipse platform environment is available from the Eclipse user interface. Go to Help » Help Contents and click to expand the following books: VTune™ Performance Environment, VTune™ Performance Analyzer or VTune™ Performance Analyzer Reference.