man 命令

在线编辑

用途

显示联机手册条目。

语法

man [[[ -c ] [ -t ] [ section ]] | [ -k | -f ]] [ -F ] [ -m ] [ -Mpath ] [ -r ] [ -a ] title ...

描述

man 命令提供有关主题的参考信息，例如命令、子例程和文件。 man 命令提供由名称指定的对命令的单行描述。 man 命令也提供所有命令的信息，这些命令的描述包含用户指定的关键字集合。

man 命令格式化指定的联机帮助页集合。 如果为 section 参数指定一个段，那么 man 命令在联机帮助页的该段中搜索 title 参数指定的标题。 section 参数的值可以是 1 到 8 的阿拉伯数字或某个字母。

段字母是：

项 描述
C 指定命令（包含系统管理命令）。
F 指定文件类型联机帮助页。
L 指定库函数。
n 指定为新的。
L 指定为局部的。
o 指定为原来的。
p 指定为公用的。
注: n， l， o和 p 节说明符对于读取超文本信息库无效。 其中包含操作系统文档。

段号是：

项 描述
第 1 年 表示用户命令和守护程序。
2 表示系统调用和内核服务。
3 表示子例程。
4 表示特殊文件、设备驱动程序和硬件。
5 代 表示配置文件。
6 表示游戏。
7 表示杂项命令。
8 周 表示管理命令和守护程序。
注: 超文本信息数据库中的操作系统文档仅分为三个部分: 命令手册页 (在 1 节中，相当于 C 节) ，子例程手册页 (在 3 节中，相当于 L 节) 和文件手册页 (在 4 节中，相当于 F 节)。 当搜索超文本信息时，指定段 1、6、7 或 8 缺省为命令联机帮助页，段 2 或 3 缺省为子例程联机帮助页，段 4 或 5 缺省为文件联机帮助页。

如果省略了 section 参数，那么 man 命令搜索手册的所有段。

man 命令使用的搜索路径是一个由 :（冒号）分隔的目录列表，可以在这些目录中找到手册子目录。

man 命令显示联机帮助页如下：

  1. man 命令搜索 nroff 目录 (man?) 在 /usr/share/man 目录下。
  2. man 命令搜索格式化版本目录 (cat?) 在 /usr/share/man 目录下。 如果格式化版本可用，并且它比 nroff 命令源修改得更晚，那么 man 命令显示格式化版本。 否则，联机帮助页以 nroff 命令格式化和显示。 如果用户有许可权，那么格式化的联机帮助页可存储在正确的地方，以便最后一次启用 man 命令不会再一次格式化页面。
    注: 提供的手动页面没有 nroff 源。 然而，可以将联机帮助页的 nroff 源放置到 man 目录中，然后 man 命令能够定位并处理 nroff 源。
  3. 如果 man 命令在 /usr/share/man/man 或 /usr/share/man/cat 目录中没有找到联机帮助页，那么 man 命令通过 -M 选项或 MANPATH 环境变量为 nroff 目录（man?） 和格式化版本目录 (cat?)。
  4. 如果 man 命令在 /usr/share/man/man 或 /usr/share/man/cat 或用户指定的 man/cat 目录中没有找到联机帮助页，那么 man 命令从超文本信息库中读取。 超文本信息库驻留在 /usr/share/man/info 目录结构中，且包含操作系统文档。 当从超文本数据库中读取时，man 命令并不将任何联机帮助页放进 /usr/share/man/cat 目录结构中。 man 命令将 HTML 文件转换成格式化文本文件以适应显示器，并使用 PAGER 环境变量中描述的命令显示联机帮助页。
  5. 如果 man 命令在位于 /usr/share/man/info 目录结构的超文本信息库中没有找到联机帮助页，那么，它查找用户指定的超文本信息库（通过 -M 或 MANPATH）。 用户定义的超文本信息库应该参照以下的目录结构：
    BasePath[/%{ L | l }]/DocLibraryname/Section/command_or_routine_or_filename.htm
    其中：
    • %L 表示使用 LC_MESSAGES 时指定的 ISO 语言符号，%l 表示使用 LC_MESSAGES 时指定的 ISO 语言符号的首 2 个字符。 例如，对于 LC_MESSAGES=en_US ，可以将文档放在 Path/en_US 或 Path/en中。
    • DocLibraryname 表示文档库的名称。
    • Section 表示段名称，必须是以下之一：
      • cmds－表示“命令段”
      • libs－表示“库段”
      • files－表示“文件段”
    注: 如果指定了 -m 选项，那么将仅按通过 -M 或 MANPATH 环境变量指定的路径顺序来搜索手动页面。

当访问 HTML 数据库时，man 在查找其他 LPP 库之前查找操作系统库。 在这些库中，它按以下顺序处理信息：

项 描述
cmds 命令参考
libs 子例程，系统调用
文件 文件引用

如果标准输出是 tty ，那么 人 命令使用带有 -s 和 - 标志的 更多 命令来传输其输出。 -s 标志消除多个空行并且在屏幕上每显示一页就停止。 -v 标志禁止在屏幕上显示非打印字符。 要继续滚动，按空格键。 在输出停止后要继续再滚动 11 行，按 Ctrl-D 键序列。

PAGER 环境变量可以设置到任何所需的页面调度程序上。 缺省值为 more 命令。 要更改缺省的页面调度程序，请输入：

PAGER=Somepager
export PAGER

例如，如果以相反或部分换行方式来定制联机帮助页，PAGER 环境变量可以设置到 /usr/bin/pg，以便换行不会像控制字符那样打印出来。 这个过程对联机帮助页并非是必要的。

当 man 命令使用超文本数据库时，它能够检索几个物件。 例如，man open显示几篇文章。 使用 SIGINT（Ctrl-C）完全退出 man 命令。 另一方面，man open close也会显示几篇文章，但使用 SIGINT (Ctrl-C) 会导致 man 显示 close 命令信息而不是退出。 再次使用 SIGINT（Ctrl-C）完全退出 man 命令。

当指定名称中包含 $（美元符号）的“网络计算系统”库例程之一时，应在 $ 前输入一个 \ (反斜杠)。

标志

项 描述
-a 显示所有匹配项。
-c 显示使用 cat 命令的手册信息。
-f 显示在关键字数据库中仅与作为最终参数给定的命令名相关的项。 可以输入多个命令名，中间用空格隔开。 使用该标志仅搜索命令物件。 要使用 -f 标志， root 用户必须先前已输入 catman -w 以创建 /usr/share/man/whatis 文件。
-f 只显示首个匹配项。
-k 显示关键字数据库中包含与作为最终参数给定的字符匹配的标题的字符串的每一行。 可以输入多个标题，中间用空格隔开。 要使用 -k 标志， root 用户必须先前已输入 catman -w 以创建 /usr/share/man/whatis 文件。
-M 只在 MANPATH 或 -M 中指定的路径中搜索。
-M路径 更改 man 命令搜索手册信息的标准位置。 路径是用冒号隔开的路径的列表，其中，可以使用以下特殊符号：
  • %D-
  • AIX®man 页面的默认路径。
  • %L-与当前语言环境的 LC_MESSAGES 类别对应的特定于语言环境的目录位置。
  • %L－与当前 LC_MESSAGES 类别的首 2 个字符相对应的特定于语言环境的目录位置。
-r 手册信息的远程搜索。 如果出于某个原因，远程搜索失败，那么 man 将执行本地搜索以获取请求的联机帮助页。 任何以下情况都可能导致远程搜索失败：
  • 远程机器不可到达。
  • 读取 URL 时发生问题。
  • 未安装 Java™ applet ，或者在 PATH 环境变量中指定的用户搜索路径中找不到该 applet。
注: DOCUMENT_SERVER_MACHINE_NAME 环境变量应设置为用户要使用的文档搜索服务器的名称。 如果主机所在地区不支持AIX基本文档，则man命令会搜索其他地区的文档。 如果搜索成功，那么文档页在转换到本地主机的语言环境后显示。 如果备用语言环境未在本地主机上安装，那么 man 命令显示文档页失败。
-t 使用 troff 命令格式化手册信息。 如果在超文本信息基中查找到联机帮助页，那么忽略该标志。

退出状态

本命令返回以下退出值：

项 描述
重大安全事件数量 成功完成。
> 0 发生错误。

示例

  1. 要显示有关 grep 命令的信息，请输入以下命令:
    man grep
  2. 要显示有关 rpc_$register 库例程的信息，请输入以下命令:
    man rpc_\$register
  3. 要显示 /usr/share/man/whatis 关键字数据库中包含 "mkdir" 字符串的所有条目，请输入以下命令:
    man -k mkdir
    此输出等同于 apropos 命令。 只有在 /usr/share/man/whatis 关键字数据库已存在时，才能从 -k 标志接收输出。
  4. 要显示关键字数据库中与 nroff 和 troff 命令相关的所有条目，请输入以下命令:
    man -f nroff troff
    此输出等同于 whatis 命令。 只有在 /usr/share/man/whatis 关键字数据库已存在时，才能从 -f 标志接收输出。
  5. 要在 /usr/share/man 或 /usr/share/man/local 路径中显示所有 ftp 命令相关文章，请输入以下命令:
    man -M/usr/share/man:/usr/share/man/local ftp
  6. 要显示所有匹配条目，请输入以下命令：
    man -a title
  7. 要仅显示首个匹配条目，请输入以下命令：
    man -F title
  8. 要仅在 MANPATH 或 -M中指定的路径中进行搜索，请输入以下命令:
    man -m -M PATH title
  9. 要在用户定义的路径中搜索，请输入以下命令：
    man -M PATH title

文件

项 描述
/usr/bin/man 包含 man 命令。
/usr/share/man 标准手册目录结构。
/usr/share/man/cat?/* 包含预格式化的页面的目录。
/usr/share/man/whatis 包含关键字数据库。
/usr/share/man/man?/* 包含 nroff 格式联机帮助页的目录。