手册页节的格式

以下参考信息描述了每个手册页节的内容、每个节提供的信息，以及用于所有 Oracle Solaris 手册页的标准布局。

手册页节说明

下表描述了每个手册页节以及每个手册页引用的信息。

表 1-1 手册页节说明

手册页格式

手册页使用标准格式，该格式涵盖下面的部分或所有子节。此处子节的列出顺序与各手册页节中信息的显示顺序相同。

NAME（名称）

提供命令、库函数、文件或设备驱动程序的名称，同时简要说明该结构的用途。

SYNOPSIS（用法概要）

显示命令、库函数、文件或设备驱动程序的语法。

DESCRIPTION（描述）

定义服务的功能和行为。

IOCTL

用于特定一类设备，所有这类设备的名称都以 io 结尾，如 mtio(7I)。此节仅出现在手册页的第 7 节。

OPTIONS（选项）

列出命令选项，同时概要说明每个选项的用途。

OPERANDS（操作数）

列出命令操作数，并描述操作数对命令操作的影响。

OUTPUT（输出）

描述输出、标准输出、标准错误或由命令、库函数、文件或设备驱动程序生成的输出文件。

RETURN VALUES（返回值）

列出返回值并描述返回这些值的条件（仅适用于说明返回值的函数的手册页）。

ERRORS（错误）

按字母顺序列出函数库会生成的所有错误代码并描述导致每个错误的条件。

USAGE（用法）

列出需要详细说明的特殊规则、功能和命令。

EXAMPLES（示例）

提供用法示例或如何使用命令、库函数、文件或设备驱动程序的示例。

ENVIRONMENT VARIABLES（环境变量）

列出命令、库函数、文件或设备驱动程序影响的环境变量，并在环境变量后对这些影响做了简要说明。

EXIT STATUS（退出状态）

列出命令返回到调用程序或 shell 中的值以及导致返回这些值的条件。

FILES（文件）

列出该手册页引用的所有文件名称，包括相关文件以及命令创建或需要的文件。

ATTRIBUTES（属性）

通过定义属性类型及其相应的值列出命令、实用程序和设备驱动程序的特征。请参见 attributes(5) 手册页。

SEE ALSO（另请参见）

包含任何相关命令或库函数。

DIAGNOSTICS（诊断）

列出诊断消息并简要说明导致该错误的条件。

WARNINGS（警告）

列出可能严重影响工作状态的那些特殊条件的相关警告。此部分不是诊断列表。

NOTES（附注）

列出不属于页面任何部分的其他信息。

BUGS（已知问题）

描述已知问题并尽可能给出解决方法建议。