Skip Navigation Links
Exit Print View
| Oracle Solaris Cluster Data Services Reference Manual Oracle Solaris Cluster 4.1

Search Scope:

- This Document
- Entire Library

## Preface

The Oracle Solaris Cluster Data Services Reference Manual provides reference information about resources types for data services that are supplied with Oracle Solaris Cluster software. This book is intended for experienced system administrators with extensive knowledge of Oracle software and hardware. This book is not to be used as a planning or presales guide. The information in this book assumes knowledge of the Solaris Operating System and expertise with the volume manager software that is used with Oracle Solaris Cluster software.

Both novice users and those familiar with the Solaris Operating System can use online man pages to obtain information about their SPARC based system or x86 based system and its features.

A man page is intended to answer concisely the question “What does this command do?“ The man pages in general comprise a reference manual. They are not intended to be a tutorial.

Note - Oracle Solaris Cluster software runs on two platforms, SPARC and x86. The information in this book pertains to both platforms unless otherwise specified in a special chapter, section, note, bulleted item, figure, table, or example.

## Overview

The following contains a brief description of each man page section and the information it references:

- Section 4 outlines the formats of various files. The C structure declarations for the file formats are given where applicable.

- Section 5 contains miscellaneous Oracle Solaris Cluster documentation such as descriptions of resource types.

The following is a generic format for man pages. The man pages of each manual section generally follow this order, but include only needed headings. For example, if no bugs can be reported, no BUGS section is included. See the `intro` pages for more information and detail about each section, and `man`(1) for general information about man pages.

NAME
  This section gives the names of the commands or functions that are documented, followed by a brief description of what they do.
SYNOPSIS

  This section shows the syntax of commands or functions. If a command or file does not exist in the standard path, its full path name is shown. Options and arguments are alphabetized, with single-letter arguments first, and options with arguments next, unless a different argument order is required.

  The following special characters are used in this section:

  [ ]

    Brackets. The option or argument that is enclosed in these brackets is optional. If the brackets are omitted, the argument must be specified.

  . . .

    Ellipses. Several values can be provided for the previous argument, or the previous argument can be specified multiple times, for example, “`filename` . . .“ .

  |

    Separator. Only one of the arguments separated by this character can be specified at a time.

  { }

    Braces. The options and/or arguments enclosed within braces are interdependent. All characters within braces must be treated as a unit.

PROTOCOL

  This section occurs only in subsection 3R and indicates the protocol description file.

DESCRIPTION

  This section defines the functionality and behavior of the service. Thus it describes concisely what the command does. DESCRIPTION does not discuss OPTIONS or cite EXAMPLES. Interactive commands, subcommands, requests, macros, and functions are described under USAGE.

IOCTL

  This section appears on pages in Section 7 only. Only the device class that supplies appropriate parameters to the `ioctl`(2) system call is called `ioctl` and generates its own heading. `ioctl` calls for a specific device are listed alphabetically (on the man page for that specific device). `ioctl` calls are used for a particular class of devices. All these calls have an `io` ending, such as `mtio`(7I).

OPTIONS

  This section lists the command options with a concise summary of what each option does. The options are listed literally and in the order they appear in the SYNOPSIS section. Possible arguments to options are discussed under the option, and where appropriate, default values are supplied.

OPERANDS

  This section lists the command operands and describes how they affect the actions of the command.

OUTPUT

  This section describes the output – standard output, standard error, or output files – generated by the command.

RETURN VALUES

  If the man page documents functions that return values, this section lists these values and describes the conditions under which they are returned. If a function can return only constant values, such as 0 or –1, these values are listed in tagged paragraphs. Otherwise, a single paragraph describes the return values of each function. Functions that are declared void do not return values, so they are not discussed in RETURN VALUES.

ERRORS

  On failure, most functions place an error code in the global variable `errno` that indicates why they failed. This section lists alphabetically all error codes a function can generate and describes the conditions that cause each error. When more than one condition can cause the same error, each condition is described in a separate paragraph under the error code.

USAGE

  This section lists special rules, features, and commands that require in-depth explanations. The subsections that are listed here are used to explain built-in functionality:

  Commands
  Modifiers
  Variables
  Expressions
  Input Grammar

EXAMPLES

  This section provides examples of usage or of how to use a command or function. Wherever possible, a complete example, which includes command-line entry and machine response, is shown. Whenever an example is given, the prompt is shown as `example%`, or if the user must be superuser, `example#`. Examples are followed by explanations, variable substitution rules, or returned values. Most examples illustrate concepts from the SYNOPSIS, DESCRIPTION, OPTIONS, and USAGE sections.

ENVIRONMENT VARIABLES

  This section lists any environment variables that the command or function affects, followed by a brief description of the effect.

EXIT STATUS

  This section lists the values the command returns to the calling program or shell and the conditions that cause these values to be returned. Usually, zero is returned for successful completion, and values other than zero are returned for various error conditions.

FILES

  This section lists all file names that are referred to by the man page, files of interest, and files created or required by commands. Each file name is followed by a descriptive summary or explanation.

ATTRIBUTES

  This section lists characteristics of commands, utilities, and device drivers by defining the attribute type and its corresponding value. See `attributes`(5) for more information.

SEE ALSO

  This section lists references to other man pages, in-house documentation, and outside publications.

DIAGNOSTICS

  This section lists diagnostic messages with a brief explanation of the condition that caused the error.

WARNINGS

  This section lists warnings about special conditions that could seriously affect your working conditions. WARNINGS is not a list of diagnostics.

NOTES

  This section lists additional information that does not belong anywhere else on the page. NOTES covers points of special interest to the user. Critical information is never covered here.

BUGS

  This section describes known bugs and, wherever possible, suggests workarounds.

Copyright © 2000, 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |