Oracle® Solaris Cluster 法定服务器参考手册

退出打印视图

更新时间: 2014 年 7 月,E51745-01
 
 

前言

Oracle Solaris Cluster 法定服务器参考手册》提供了有关 Oracle Solaris Cluster 法定服务器软件中的命令、文件格式和其他公共接口的参考信息。本书面向具有丰富的 Oracle 软硬件知识的有经验的系统管理员。请不要将本书用作规划指南或售前指南。本书中的信息假定读者具备 Oracle Solaris 操作系统知识以及与 Oracle Solaris Cluster 软件一起使用的卷管理器软件的专业知识。

初学者和那些熟悉 Oracle Solaris 操作系统的用户均可以使用联机手册页获取有关基于SPARC的系统或基于 x86 的系统及其功能的信息。

手册页可用来简明地回答“该命令的功能是什么?”问题。通常,手册页包含参考手册。它们并不作为教程使用。


注 -  Oracle Solaris Cluster 软件在以下两种平台上运行:SPARC 和 x86。除非在特定章节、注释、列表项、图形、表格或示例中另有说明,否则本书中的信息对于两种平台均适用。

概述

以下内容包含对各手册页部分及其所引用的信息的简要说明:

  • 第 1CL 部分按字母顺序介绍了用于维护和管理 Oracle Solaris Cluster 法定服务器的各种命令。

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

  • 第 4 部分概述了各种文件的格式。还提供了文件格式的 C 结构声明(如果适用)。

以下是手册页的通用格式。每个手册的手册页部分通常遵循该顺序,但只包括需要的标题。例如,如果未报告任何已知问题,则不包括“已知问题”部分。有关更多信息以及每个部分的详细信息,请参见 intro 页面;有关手册页的一般信息,请参见 man(1)

名称

本部分提供了记录的命令或函数的名称,后跟它们功能的简要说明。

用法概要

本部分显示了命令或函数的语法。如果命令或文件不存在于标准路径中,则显示它的完整路径名称。除非要求使用不同的参数顺序,否则选项和参数均按字母顺序排列,首先是单个字母的参数,接下来是带有参数的选项。

本部分使用以下特定字符:

[ ]

方括号。以这些括号括起来的选项或参数是可选的。如果省略括号,则必须指定参数。

省略号。可以为前一个参数提供多个值,还可以多次指定前一个参数,例如 "filename…"。

|

分隔符。一次只能指定一个由该字符分隔的参数。

{ }

花括号。以花括号括起来的选项和/或参数是相互依赖的。花括号内的所有字符必须视为一个整体。

协议

本部分仅在第 3R 子部分出现,用于指示协议描述文件。

描述

本部分定义了服务的功能和行为。因此它简明地介绍了命令执行哪些操作。“描述”不讨论“选项”或引用“示例”。在“用法”下介绍了交互式命令、子命令、请求、宏和函数。

IOCTL

本部分仅在第 7 部分中的页面上显示。只有为 ioctl(2) 系统调用提供相应参数的设备类才称为 ioctl 并生成其自己的标题。特定设备的 ioctl 调用按字母顺序列出(位于该特定设备的手册页上)。ioctl 调用可用于特定设备类。所有这些调用均以 io 结尾,例如 mtio(7I)

选项

本部分列出了各个命令选项,并且包括每个选项所具有的功能的简明摘要。逐个列出各个选项,并以它们在“用法概要”部分显示的顺序排列。在选项下讨论各个选项可能的参数,还提供默认值(如果适用)。

操作数

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

输出

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

返回值

如果手册页记录返回值的函数,则本部分列出这些值并介绍返回这些值应满足的条件。如果函数只能返回常量值(例如 0 或 –1),则将在标记的段落中列出这些值。否则,会有单个段落介绍每个函数的返回值。声明为 void 的函数不返回值,因此不会在“返回值”中讨论这些函数。

错误

对于故障,大多数函数将指出它们出现故障的原因的错误代码置于全局变量 errno 中。本部分按字母顺序列出了函数可以生成的所有错误代码,并介绍了导致每个错误的条件。如果多个条件可以导致同一错误,则在错误代码下以单独的段落介绍每个条件。

用法

本部分列出了需要详细说明的特定规则、功能和命令。此处列出的子部分用于说明内置功能:

命令
修饰符
变量
表达式
输入语法
示例

本部分提供了用法的示例,或者如何使用命令或函数的示例。尽可能显示包括命令行条目和计算机响应的完整示例。每当给定一个示例,就会出现提示并显示为 example%,或者如果用户必须为超级用户,则显示为 example#。示例后面跟有说明、变量替换规则或返回值。大部分示例说明了“用法概要”、“描述”、“选项”和“用法”部分的概念。

环境变量

本部分列出了命令或函数影响的所有环境变量,其后附加了关于影响的简要说明。

退出状态

本部分列出了命令返回到调用程序或 shell 中的值以及导致返回这些值的条件。通常,成功完成会返回值零,而各种错误条件会返回除零之外的其他值。

文件

本部分列出了手册页引用的所有文件名称、相关文件以及命令创建或所需的文件。每个文件名称后面都具有描述性摘要或说明。

属性

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

另请参见

本部分列出了对其他手册页、内部文档和外部出版物的引用。

诊断

本部分列出了诊断消息,其中包含导致错误的条件的简要说明。

警告

本部分列出了有关特定条件的警告,这些条件可能会严重影响您的工作条件。“警告”不是诊断列表。

附注

本部分列出了不属于页面任何部分的其他信息。“附注”包括用户特别关注的要点。此处不包含关键信息。

已知问题

本部分介绍了已知问题,并尽可能给出解决方法。