About This Manual

This manual describes the TruCluster^TM MEMORY CHANNEL^TM Application Programming Interface (API) and how to use it to develop programs for TruCluster systems based on the MEMORY CHANNEL interconnect technology.

Audience

This manual is for developers who want to directly access the features provided by the MEMORY CHANNEL API, and for system managers who want to install the product. The manual assumes that the reader is experienced with the following:

UNIX^® operating environment

C programming language

Shared memory and message-passing programming models

Organization

This manual has three chapters, an appendix, and an index. The manual is structured as follows:

Chapter 1	Describes the MEMORY CHANNEL software installation procedure, initialization, and configuration.
Chapter 2	Contains information to help you develop applications based on the MEMORY CHANNEL API library.
Chapter 3	Provides reference information about each MEMORY CHANNEL API command and function.
Appendix A	Contains answers to questions asked by programmers who use the MEMORY CHANNEL API library.

Location of Code Examples

This manual includes code examples that show how to use the MEMORY CHANNEL API library functions in programs. You will find these code files in the /usr/examples/cluster/ directory. Each file contains compilation instructions.

Location of Online Documentation

Each book in the TruCluster Software documentation set is shipped as a set of Hypertext Markup Language (HTML) and graphics files in the /TCR/doc/html directory on the Associated Products Volume 2 CD-ROM. You can use the Netscape Navigator^® World Wide Web browsing program to display these books.

To access the TruCluster Software documentation from the viewer, click on the Open icon in the Netscape main window and enter the following file location in the Open Location: text entry field: file:/mountpoint/TCR/doc/html/BOOKSHELF.HTM.

Reader's Comments

DIGITAL welcomes any comments and suggestions you have on this and other DIGITAL UNIX manuals. A Reader's Comment form is located on your system in the following location:

/usr/doc/readers_comment.txt

You can send your comments in the following ways:

Internet electronic mail: comments@ilo.dec.com

Fax: +353 91 754784 Attn: DIGITAL Information Design

Mail:
Digital Equipment Corporation
DIGITAL Information Design
Ballybrit Industrial Park
Galway
Ireland

A Reader's Comment form is located in the back of each printed manual.

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 and Korn 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.
...: 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(1) 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).