前言

《Sun Cluster Geographic Edition 系统参考手册》介绍有关在 Sun^TM Cluster Geographic Edition 软件中出现的命令、函数以及其他公共接口的参考信息。本书的目标读者为有经验且具有丰富的 Sun 软硬件知识的系统管理员。不要将本书用作规划指南或售前指南。本书假定读者具有 Solaris^TM 操作系统 (Solaris Operating System, Solaris OS) 方面的知识，并熟练掌握与 Sun Cluster 软件一起使用的卷管理器软件。

初学者和熟悉 Solaris OS 的人员均可使用联机手册页，以获得有关基于 SPARC® 的系统及其特性的信息。

手册页旨在简要回答“此命令是用来干什么的？”。参考手册通常由多个手册页构成，它们并不是专用教程。

本参考手册的结构

下面简要地介绍手册页的各个部分及其包含的信息。

• 第 1 部分按照字母顺序，介绍了操作系统中包含的命令。

• 第 1M 部分按照字母顺序，介绍了主要用于系统维护和管理目的的命令。

• 第 2 部分介绍了所有的系统调用。大多数调用会返回一个或多个错误。如果返回一个异常值，则表明有错误情况。

• 第 3 部分介绍了包含在各种库中的函数，它们不同于那些直接调用 UNIX® 系统元语的函数（在第 2 部分进行介绍）。

• 第 4 部分简要介绍了各种文件的格式，并在适当之处给出了文件格式的 C 结构声明。

• 第 5 部分包含了诸如字符集表等其他文档。

• 第 6 部分包含了可用的游戏和演示程序。

• 第 7 部分介绍了涉及特殊硬件外围设备和设备驱动程序的各种特殊文件。还介绍了 STREAMS 软件驱动程序、模块和 STREAMS 通用的系统调用集。

• 第 9 部分介绍了在内核环境中写入设备驱动程序所需的参考信息。本部分介绍了两种设备驱动程序接口规范：设备驱动程序接口 (DDI) 和驱动程序/内核接口 (DKI)。

• 第 9E 部分介绍了 DDI/DKI、仅 DDI 和仅 DKI 入口点例程，开发者可以将它们包含在设备驱动程序中。

• 第 9F 部分介绍了可由设备驱动程序使用的内核函数 。

• 第 9S 部分介绍了驱动程序用来在驱动程序和内核之间共享信息的数据结构。

以下是手册页的通用格式。每一手册部分的手册页的内容通常按以下顺序排列，但只包含需要的标题。 例如，如果没有可以报告的错误，则不包含“错误”部分。有关每部分的详细信息，请参阅 intro 页；有关手册页的通用信息，请参阅 man(1)。

名称

本部分介绍所收录的命令或函数的名称，并对其用途进行简要描述。

概览

本部分介绍命令或函数的语法。如果命令或文件没有位于标准路径下，则会显示其完整路径名称。如果没有要求使用不同的参数顺序，则选项和参数将按字母顺序排列，首先是单字母参数，接下来是带参数的选项。

在本部分中用到的特殊字符有：

[ ]

方括号。包含在这些方括号中的选项或参数为可选项。如果省略了方括号，则必须指定参数。

. . .

省略号。可以为该符号前面的参数提供多个值，或者可以多次指定该参数，例如 "filename . . ."。

|

分隔符。每次只能指定由这种分隔符隔开的参数中的一个。

{ }

大括号。包含在大括号中的选项和/或参数是相互依存的。必须将包含在大括号中的所有字符视为一个整体。

协议

本部分只出现在子部分 3R 中，用于指定协议描述文件。

说明

本部分定义服务的功能和行为。因此它简明地描述命令的用途。“说明”中不会讨论“选项”部分，也不会引用“示例”部分。交互式命令、子命令、请求、宏和函数在“使用”部分进行介绍。

IOCTL

本部分只出现在第 7 部分的页面中。只有为 ioctl(2) 系统调用提供适当参数的设备类才被称为 ioctl，并生成自己的标题。特定设备的 ioctl 调用按字母顺序排列（在该特定设备的手册页中）。ioctl 调用用于特殊类别的设备。所有这些调用都以 io 结尾，例如 mtio(7I)。

选项

本部分列出了命令选项，并简明概括了每个选项的用途。这些选项被完整列出，并按照它们出现在“概述”部分中的顺序排列。在每个选项下，介绍了该选项可能用到的参数，并在适当之处提供了默认值。

操作对象

本部分列出了命令操作对象并介绍了它们如何影响命令的操作。

输出

本部分介绍了命令生成的输出—标准输出、标准错误或输出文件。

返回值

如果手册页中包含了会返回值的函数，则本部分将列出这些值并介绍返回这些值的条件。如果一个函数只能返回常数值，如 0 或 –1，则这些值会在多个标记段落中列出来。否则，每个函数的返回值会通过一个段落进行描述。被声明为空的函数不返回值，因此在“返回值”部分不讨论这些函数。

错误

出现故障时，大多数函数会在全局变量 errno 中放入一个表明故障原因的错误代码。本部分按字母顺序列出了函数可能生成的所有错误代码，并描述了导致每个错误的条件。如果一个错误可能是由多个条件导致的，则将在错误代码下面，对每个条件用一个单独的段落进行描述。

用法

本部分列出了需要深入解释的特殊规则、特性和命令。下面列出的子部分用于解释内置的功能：

• 命令
• 修改符
• 变量
• 表达式
• 输入语法

示例

本部分介绍了用法或如何使用命令或函数的示例。如果可能，文中会给出包含命令行输入和计算机响应的完整示例。每个示例后面都会跟有解释、变量替代规则或返回的值。大多数示例描述了来自“概述”、“说明”、“选项”和“用法”部分的概念。

环境变量

本部分列出了命令或函数影响到的所有环境变量，并对这种影响进行了简短描述。

退出状态

本部分列出了命令返回给调用程序或 shell 的值，以及导致返回这些值的条件。 通常情况下，如果成功完成则会返回 0；对于各种错误条件，则会返回 0 以外的值。

文件

本部分列出了手册页、相关文件以及由命令创建或命令所需要的文件所涉及的所有文件的名称。每个文件名称之后都有相应的描述性概述或解释。

属性

本部分通过定义属性类型及其相应值，列出了命令、实用程序和设备驱动程序的特性。有关详细信息，请参阅 attributes(5)。

另请参见

本部分列出了对其他手册页、Sun 文档和第三方出版物等的参考信息。

故障诊断

本部分列出了诊断消息，并简要解释了导致错误出现的条件。

警告

本部分列出了有关会严重影响您工作环境的特殊条件的警告。“警告”部分并非诊断列表。

注意事项

本部分列出了不属于本手册页其他部分的附加信息。“注意事项”中包含了用户需要特别注意的事项。此处不包含重要信息。

错误

本部分介绍已知的错误和建议的解决方法（如果有的话）。