About This Guide

This guide describes the Performance Co-Pilot (PCP) software package of advanced performance tools for the Silicon Graphics family of graphical workstations and servers. Performance Co-Pilot provides a systems-level suite of tools that cooperate to deliver integrated performance monitoring and performance management services spanning the hardware platforms, operating systems, service layers, database management systems, and user applications.

“About This Guide” includes short descriptions of the chapters in this book, directs you to additional sources of information, and explains typographical conventions.

What This Guide Contains

This guide contains the following chapters:

Audience for This Guide

This guide is written for the system administrator or performance analyst who is directly using and administering PCP applications. It is assumed that you have installed IRIS InSight for viewing online books, or have access to the IRIX Admin manual set and the Personal System Administration Guide as hardcopy documents.

Additional Resources

The Performance Co-Pilot Programmer's Guide is a companion document intended for application developers who wish to use the PCP framework and services for exporting additional collections of performance metrics, or for delivering new or customized applications to enhance performance management.

Reference Pages

The IRIX reference pages (also called “man” or manual pages) provide concise reference information on the use of IRIX commands, subroutines, and system resources. There is usually a reference page for each PCP command or subroutine. To see a list of all the PCP reference pages, enter the following command:

man -k performance 

To see a particular reference page, supply its name to the man command, for example:

man pcp 

The reference pages are divided into seven sections, as shown in Table i. When referring to reference pages, this guide follows a standard UNIX convention: the section number in parentheses follows the item. For example, PMDA(3) refers to the reference page in section 3 for the pmda command.

Table 1. Outline of Reference Page Organization

Type of Reference Page

Section Number

General commands

(1)

System calls and error numbers

(2)

Library subroutines

(3)

File formats

(4)

Miscellaneous

(5)

Demos and games

(6)

Special files

(7)


Release Notes

Release notes provide specific information about the current release, available online through the relnotes command. Exceptions to the printed and online documentation are found in the release notes. The grelnotes command provides a graphical interface to the release notes of all products installed on your system.

Silicon Graphics Web Sites

The following Web sites are accessible to everyone with general Internet access:

http://www.sgi.com  


The Silicon Graphics general Web site, with search capability.

http://www.sgi.com/Products  


Contains links to Performance Co-Pilot product information.

http://techpubs.sgi.com/library  


The Silicon Graphics Technical Publications Library.

Conventions Used in This Guide

These type conventions and symbols are used in this guide:

Bold 

Literal command-line arguments (options/flags), nonalphabetic data types, operators, and subroutines.

Italics 

Backus-Naur Form entries, command monitor commands, executable names, filenames, IRIX commands, manual/book titles, new terms, onscreen button names, program variables, tools, utilities, variable command-line arguments, variable coordinates, and variables to be supplied by the user in examples, code, and syntax statements

Fixed-width type 


Error messages, prompts, and onscreen text

Bold fixed-width type 


User input, including keyboard keys (printing and nonprinting); literals supplied by the user in examples, code, and syntax statements

ALL CAPS 

Environment variables, operator names, directives, defined constants, macros in C programs

“” 

(Double quotation marks) Onscreen menu items and references to document section titles within text

() 

(Parentheses) Following function names—surround function arguments or are empty if the function has no arguments; following IRIX commands—surround reference page (man page) section numbers.

[] 

(Brackets) Surrounding optional syntax statement arguments

# 

IRIX shell prompt for the superuser (root)

% 

IRIX shell prompt for users other than the superuser

>> 

Command Monitor prompt