在手册页中查找信息

您可以使用 man 命令在手册页中搜索有关 Oracle Solaris 命令的信息。使用新的 -K（大写）关键字 选项，您可以在所有手册页的所有节中搜索指定的关键字。-k 选项（小写）仅搜索所有手册页节中的 NAME（名称）子节。

创建索引文件以支持在手册页中搜索特定的关键字

要通过指定关键字来搜索手册页中的信息，首先要创建可供 man 命令进行查询的索引文件。您可以使用 catman 实用程序创建联机参考手册的各种预设格式版本。在未指定任何选项的情况下，catman 实用程序将为 /usr/share/man 和 usr/gnu/share/man 目录中的手册页生成索引文件。请注意，只有 root 用户才可以使用 catman 实用程序。

catman 实用程序还包含 -w 选项。使用此选项，您可以为通过 MANPATH 变量或使用 -M 选项指定的目录中的手册页创建索引文件。可以使用 catman 实用程序的 -M 选项指定一个备用目录来为第三方手册页创建索引文件。缺省情况下，未指定任何选项时 catman 实用程序将为 /usr/share/man 和 /usr/gnu/share/man 目录中的手册页创建索引文件。

要指定备用目录，请键入以下命令：

# catman -M directory -w

例如，要为 /usr/local/share/man 目录中的手册页创建索引文件，可键入以下命令：

# catman -M /usr/local/share/man -w

-M directory

更新位于指定目录（缺省情况下为 /usr/share/man）的手册页。如果指定 -M 选项，则目录参数不能包含逗号 (,)，因为手册页中使用逗号描述节编号。

-w

在通过 MANPATH 变量或使用 -M 选项指定的目录中创建索引文件。如果未指定 MANPATH 变量或 -M 选项，则将为 /usr/share/man/ 和 /usr/gnu/share/man 目录中的手册页创建索引文件。

有关 catman 实用程序（包括您可以指定的所有命令行选项）的完整说明，请参见 catman(1M) 手册页。

通过指定关键字在手册页中搜索信息

要通过指定关键字在手册页中搜索信息，请使用 catman 实用程序创建一个或多个索引文件。有关说明，请参见创建索引文件以支持在手册页中搜索特定的关键字。

要通过指定关键字在所有手册页节中执行全文搜索来查找信息，请键入带新的 -K keywords 选项的 man 命令，如下所示：

$ man -K keywords

-K

在所有手册页节中对指定的 keywords 执行全文搜索。

keywords

所指定的用户定义的字符串。要在一次搜索中指定多个关键字，请使用双引号。例如：

$ man -K "create zfs pool"

要仅在所有手册页的 NAME（名称）子节中搜索信息，请键入带 -k keywords 选项的 man 命令，如下所示：

$ man -k keywords

要在所有手册页的特定子节中搜索信息，请在 man -K keywords 命令语法中包括 SECTNAME，如下所示：

$ man -K SECTNAME:keywords

其中，SECTNAME 可以是所有手册页节中的以下子节：

• ATTRIBUTES（属性）

• DESCRIPTION（描述）

• ENVIRONMENT VARIABLES（环境变量）

• EXAMPLES（示例）

• EXIT STATUS（退出状态）

• FILES（文件）

• LIST OF COMMANDS（命令列表）

• NAME（名称）

• NOTES（附注）

• NULL（空）

• OPTIONS（选项）

• OPERANDS（操作数）

• OUTPUT（输出）

• SECURITY（安全）

• SEE ALSO（另请参见）

• SYNOPSIS（用法概要）

• USAGE（用法）

要搜索特定手册页节，请在 man 命令中将 -s 选项与 -k 或 -K 选项结合使用。

$ man -s manpage-section -K "keywords"

例如，要在 1M 手册页节中搜索关键字 "cpu usage"，可键入以下命令：

$ man -s 1m -K "cpu usage"

请注意下列有关 man 命令的其他重要信息。

• 使用带 -k 或 -K 选项的 man 命令搜索手册页的命令语法不区分大小写。

• man 命令在执行搜索之前会对关键字进行标准化，这意味着对指定关键字生成的查询结果中还包含那些含有关键字一部分的词。例如，如果查询单词 "searching"，则 "search"、"searches" 和 "searched" 这些词也会包含在搜索结果中。

示例 1-1 通过指定关键字在所有手册页的 NAME（名称）子节中搜索命令

在以下示例中，man -k 命令用于仅在所有手册页的 NAME（名称）子节中搜索 init 命令的实例：

$ man -k init
Searching in: /usr/man
Searching in: /usr/dt/man
Searching in: /usr/openwin/share/man
Searching in: /usr/sfw/man

1. init(1m)     "NAME"  /usr/share/man/man1m/init.1m
init, telinit - process control initialization


2. inittab(4)   "NAME"  /usr/share/man/man4/inittab.4
inittab - script for init


3. init.d(4)    "NAME"  /usr/share/man/man4/init.d.4
init.d - initialization and termination scripts for changing init states

在此示例中，man -k 命令的输出显示仅在所有手册页节的 NAME（名称）子节中搜索 init 命令的结果。请注意，名称中包含 init 的所有手册页也包含在搜索结果中。

示例 1-2 通过指定关键字在所有手册页节中搜索命令

在以下示例中，man -K keywords 命令用于在手册页的所有节中搜索 dumpadm 命令的实例。

$ man -K dumpadm
Searching in: /usr/man
Searching in: /usr/dt/man
Searching in: /usr/openwin/share/man
Searching in: /usr/sfw/man

1. dumpadm(1m)  NAME    /usr/share/man/man1m/dumpadm.1m
dumpadm - configure operating system crash dump


2. savecore(1m) DESCRIPTION     /usr/share/man/man1m/savecore.1m
The savecore utility saves a crash dump of the kernel (assuming that one
was made) and writes a reboot message in the shutdown log. It is invoked
by the dumpadm service each time the system boots.


3. svccfg(1m)   EXAMPLES        /usr/sh

在此示例中，搜索在手册页中找到了 dumpadm 命令的三个实例：

• 第一个实例位于 dumpadm(1M) 手册页的 NAME（名称）子节。

• 第二个实例位于 savecore(1M) 手册页的 DESCRIPTION（描述）子节。

• 第三个实例位于 svccfg(1M) 手册页的 EXAMPLES（示例）子节。

根据此查询的结果，用户可以知道在所有手册页中，有关 dumpadm 命令的其他信息位于何处。

示例 1-3 通过指定关键字在特定手册页子节中搜索命令

在以下示例中，man -K 命令和 SECTNAME:keywords 参数结合使用，在所有手册页节的 DESCRIPTION（描述）子节中搜索 bootadm 命令的实例。

$ man -K description:bootadm
Searching in: /usr/man
Searching in: /usr/dt/man
Searching in: /usr/openwin/share/man
Searching in: /usr/sfw/man

1. bootadm(1m)  DESCRIPTION     /usr/share/man/man1m/bootadm.1m
The bootadm command manages the boot archive and, with x86 boot environments,
the GRUB (GRand Unified Bootloader) menu. The update-archive option
provides a way for user to update the boot archive as a preventative
measure or as part of a


2. boot(1m)     DESCRIPTION     /usr/share/man/man1m/boot.1m
# bootadm update-archive

在此示例中，搜索在以下手册页节的 DESCRIPTION（描述）子节中找到了 bootadm 命令的两个实例：

• 第一个实例位于 bootadm(1M) 手册页。

• 第二个实例位于 boot(1M) 手册页。

有关使用 man 命令的更多信息，请参见 man(1) 手册页。