Command and Technical Reference, Volume 2

About this book

This book provides detailed syntax and parameter information for all commands you can use to install, customize, and maintain the IBM RS/6000 SP system.

For a list of related books and information about accessing online information, see the bibliography in the back of the book.

This book applies to PSSP |version 3 release 4. To find out what version of PSSP is running on your control workstation (node 0), enter the following:

splst_versions -t -n0

In response, the system displays something similar to:

|0 PSSP-3.4

|If the response indicates PSSP-3.4, this book |applies to the version of PSSP that is running on your system.

To find out what version of PSSP is running on the nodes of your system, enter the following from your control workstation:

splst_versions -t -G

In response, the system displays something similar to:

|1 PSSP-3.4
|2 PSSP-3.2
|7 PSSP-3.1.1
|8 PSSP-2.4

|If the response for a particular node indicates |PSSP-3.4, this book applies to the version of PSSP that is |running on that node.

If you are running mixed levels of PSSP, be sure to maintain and refer to the appropriate documentation for whatever versions of PSSP you are running.

Who should use this book

This book is intended for anyone not familiar with the syntax and use of the RS/6000 SP commands.

How this book is organized

This book consists of two volumes. Volume 1 contains RS/6000 SP commands A - R. Volume 2 contains RS/6000 SP commands S - W, RS/6000 SP Files and Other Technical Information, and RS/6000 SP Subroutines. Both volumes share a common frontmatter, appendix, glossary, and bibliography. The indexes are customized for each volume.

Command format

The commands in this book are in the following format:

Purpose

Provides the name of the command and a brief description of its purpose.

Syntax

Includes a diagram that summarizes the use of the command.

Flags

Lists and describes the options that control the behavior of the command.

Operands

Lists and describes the objects on which the command operates.

Description

Includes a complete description of the command.

Environment Variables

Lists any environment variables that affect the operation of the command. Lists any environment variables that are affected by the operation of the command.

Files

Lists any RS/6000 SP system files that are read, employed, referred to, or written to by the command, or that are otherwise relevant to its use.

Standard Input

Describes what this command reads from standard input.

Standard Output

Describes what this command writes to standard output.

Standard Error

Describes what and when this command writes to standard error.

Exit Values

Describes the values returned and the conditions that caused the values to be returned.

Security

Describes who can run this command and provides other security-related information.

Restrictions

Lists restrictions beyond the security restrictions described previously.

Implementation Specifics

Identifies the package of each individual command.

Prerequisite Information

Provides a pointer to other documents that would enhance the user's understanding of this command.

Location

Specifies the location of the command.

Related Information

Lists RS/6000 SP commands, functions, file formats, and special files that are employed by the command, that have a purpose which is related to that of the command, or that are otherwise of interest within the context of the command. Also listed are related RS/6000 SP documents, other related documents, and miscellaneous information related to the command.

Examples

Provides examples of how the command is typically used.

Typographic conventions

This book uses the following typographic conventions:

Typographic	Usage
Bold	Bold words or characters represent system elements that you must use literally, such as commands, flags, and path names. Bold words also indicate the first use of a term included in the glossary.
Italic	Italic words or characters represent variable values that you must supply. Italics are also used for book titles and for general emphasis in text.
Constant width	Examples and information that the system displays appear in constant width typeface.
[ ]	Brackets enclose optional items in format and syntax descriptions.
{ }	Braces enclose a list from which you must choose an item in format and syntax descriptions.
|	A vertical bar separates items in a list of choices. (In other words, it means "or.")
< >	Angle brackets (less-than and greater-than) enclose the name of a key on the keyboard. For example, <Enter> refers to the key on your terminal or workstation that is labeled with the word Enter.
...	An ellipsis indicates that you can repeat the preceding item one or more times.
<Ctrl-x>	The notation <Ctrl-x> indicates a control character sequence. For example, <Ctrl-c> means that you hold down the control key while pressing <c>.
\	The continuation character is used in coding examples in this book for formatting purposes.