前言

无论是初次使用 SunOS 操作系统的用户还是熟悉该操作系统的用户，均可通过联机手册页获取与系统及其功能有关的信息。手册页用于简要回答关于用途/用法的问题。手册页通常是参考手册的组成部分，并不用作教程。

概述

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

• 第 1 部分按照字母顺序介绍了操作系统中提供的各种命令。

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

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

• 第 3 部分介绍了各种库中包含的函数，这些函数不属于第 2 部分介绍的那些直接调用 UNIX 系统原语 (primitive) 的函数。

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

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

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

• 第 9E 部分介绍了 DDI（Device Driver Interface，设备驱动程序接口）/DKI（Driver/Kernel Interface，驱动程序/内核接口）、仅 DDI 和仅 DKI 入口点例程，开发者可以将这些例程包含在设备驱动程序中。

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

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

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

名称

本部分提供了记录的命令或函数的名称，后跟其用途的简要说明。

用法概要

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

本部分使用以下特殊字符：

[ ]

方括号。括在方括号中的选项或参数是可选的。如果没有方括号，则必须指定参数。

. . .

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

|

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

{ }

大括号。括在大括号内的选项和/或参数是相互依赖的，因此必须将大括号中的所有内容视为一个单元。

协议

本部分仅出现在第 3R 子部分，用于指示协议说明文件。

描述

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

IOCtl

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

选项

本部分列出了各命令选项及每个选项用途的简明摘要。逐个列出各个选项，并以它们在“用法概要”部分显示的顺序排列。在选项下讨论各个选项可能的参数，还提供缺省值（如果适用）。

操作数

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

输出

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

返回值

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

错误

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

用法

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

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

示例

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

环境变量

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

退出状态

本部分列出了命令返回到调用程序或 shell 中的值以及导致返回这些值的条件。通常，返回零表示成功完成，返回非零值表示各种错误条件。

文件

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

属性

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

另请参见

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

诊断

本部分列出了诊断消息以及导致错误的条件的简要说明。

警告

本部分列出了有关特殊条件的警告，这些条件可能会严重影响您的工作状况。此部分不是诊断列表。

附注

本部分列出了不属于页面任何部分的其他信息。它采用对用户旁白提示的形式，包含用户特别关注的要点。此处不包含关键信息。

已知问题

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