About This Manual

This manual describes the application programming interfaces (APIs) of the TruCluster^TM Production Server Software product.

Audience

This manual is for programmers writing distributed applications that need the synchronization services of the distributed lock manager (DLM) or the cluster information services.

Organization

This manual contains two chapters and an index. A brief description follows:

Related Documents

Consult the following TruCluster Software Products manuals for assistance in cluster configuration, installation, and administration tasks:

• TruCluster Software Products Release Notes--Documents known restrictions and other important information about the Production Server.

• TruCluster Software Products Hardware Configuration--Describes how to set up the processors that are to become cluster members, and how to configure cluster shared storage.

• TruCluster Software Products Software Installation--Describes how to install the Production Server on the systems that are to participate in the cluster.

• TruCluster Software Products Administration--Describes cluster-specific administration tasks, such as those required to set up an available server environment (ASE) within a cluster. It also shows how to configure, start, and manage distributed raw disk (DRD) services and other available services.

• TruCluster Production Server Software MEMORY CHANNEL Application Programming Interfaces--Describes the application programming interfaces that allow programming to the features of the MEMORY CHANNEL^TM hardware.

Reader's Comments

DIGITAL welcomes any comments and suggestions you have on this and other DIGITAL UNIX manuals.

You can send your comments in the following ways:

• Fax: 603-884-0120 Attn: UBPG Publications, ZKO3-3/Y32

• Internet electronic mail: readers_comment@zk3.dec.com

  A Reader's Comment form is located on your system in the following location:

  /usr/doc/readers_comment.txt
  

• Mail:

  Digital Equipment Corporation
  UBPG Publications Manager
  ZKO3-3/Y32
  110 Spit Brook Road
  Nashua, NH 03062-9987
  

  A Reader's Comment form is located in the back of each printed manual. The form is postage paid if you mail it in the United States.

Please include the following information along with your comments:

• The full title of the book and the order number. (The order number is printed on the title page of this book and on its back cover.)

• The section numbers and page numbers of the information on which you are commenting.

• The version of DIGITAL UNIX that you are using.

• If known, the type of processor that is running the DIGITAL UNIX software.

The DIGITAL UNIX Publications group cannot respond to system problems or technical support inquiries. Please address technical questions to your local system vendor or to the appropriate DIGITAL technical support office. Information provided with the software media explains how to send problem reports to DIGITAL.

Conventions

The following typographical conventions are used in this manual:

%
$

A percent sign represents the C shell system prompt. A dollar sign represents the system prompt for the Bourne, Korn, and POSIX shells.

#

A number sign represents the superuser prompt.

% cat

Boldface type in interactive examples indicates typed user input.

file

Italic (slanted) type indicates variable values, placeholders, and function argument names.

[ | ]
{ | }

In syntax definitions, brackets indicate items that are optional and braces indicate items that are required. Vertical bars separating items inside brackets or braces indicate that you choose one item from among those listed.

colored text

In syntax definitions, literal elements are colored green. Variable values, placeholders, and function argument names are colored red. No special colored text is used outside of syntax descriptions.

. . .

In syntax definitions, a horizontal ellipsis indicates that the preceding item can be repeated one or more times.

cat(1)

A cross-reference to a reference page includes the appropriate section number in parentheses. For example, cat(1) indicates that you can find information on the cat command in Section 1 of the reference pages.

[Return]

In an example, a key name enclosed in a box indicates that you press that key.

[Ctrl/x]

This symbol indicates that you hold down the first named key while pressing the key or mouse button that follows the slash. In examples, this key combination is enclosed in a box (for example, [Ctrl/C] ).