Man page - apropos(1)

Packages contains this manual

Available languages:

en fr pt_BR es it pl pt ko nl da tr sv ja uk id ru ro sr zh_CN de

Manual

APROPOS

名 称
概 述
描 述
选 项
退 出 状 态
环 境
文 件
亦 见
作 者
BUGS

名 称

apropos - 搜 索 手 册 页 名 称 和 描 述

概 述

apropos [ -dalv?V ] [ -e | -w | -r ] [ -s 列 表 ] [ -m 系 统 [,...]] [ -M path ] [ -L 区 域 ] [ -C 文 件 ] 关 键 词 ...

描 述

每 个 手 册 页 都 包 含 一 段 概 述 。 apropos 会 搜 索 包 括 关 键 词 的 描 述 。

关 键 词 通 常 为 正 则 表 达 式 ， 视 同 使 用 ( -r )选 项 ； 或 包 含 通 配 符 ( -w )； 或 完 全 匹 配 关 键 词 ( -e )。 使 用 这 些 选 项 时 可 能 要 给 关 键 词 加 引 号 ， 或 对 特 殊 字 符 转 义 (\)， 以 防 shell 解 释 它 们 。

标 准 匹 配 规 则 允 许 匹 配 手 册 页 名 称 和 手 册 页 描 述 中 的 单 词 边 界 。

通 过 apropos 搜 索 的 数 据 库 已 由 mandb 程 序 更 新 。 取 决 于 您 的 安 装 方 式 ， 这 可 能 是 通 过 定 期 的 cron 任 务 进 行 的 ， 或 者 需 要 在 安 装 新 手 册 页 后 手 动 进 行 。

选 项

-d , --debug

打 印 调 试 信 息 。

-v , --verbose

打 印 详 细 的 警 告 消 息 。

-r , --regex

将 每 个 关 键 词 解 释 为 正 则 表 达 式 。 这 是 默 认 行 为 。 每 个 关 键 词 将 与 手 册 页 名 称 和 描 述 分 别 匹 配 。 匹 配 不 限 于 单 词 边 界 。

-w , --wildcard

将 每 个 关 键 词 解 释 为 shell 风 格 的 通 配 符 。 每 个 关 键 词 将 与 手 册 页 名 称 和 描 述 分 别 匹 配 。 如 果 同 时 使 用 了 --exact 选 项 ， 只 有 展 开 的 关 键 词 与 整 个 描 述 或 手 册 页 名 称 完 全 匹 配 时 才 视 为 找 到 。 否 则 关 键 词 也 允 许 沿 描 述 中 的 单 词 边 界 匹 配 。

-e , --exact

每 个 关 键 词 将 严 格 与 手 册 页 名 称 和 描 述 匹 配 。

-a , --and

只 显 示 匹 配 提 供 的 全 部 关 键 词 的 项 目 。 默 认 是 显 示 匹 配 任 一 关 键 词 的 项 目 。

-l , --long

不 按 终 端 宽 度 截 断 输 出 。 通 常 会 将 输 出 截 短 为 终 端 宽 度 ， 以 免 显 示 写 得 不 好 的 时 显 示 混 乱 。

-s 列 表 , --sections 列 表 , --section 列 表

只 搜 索 指 定 的 手 册 章 节 。 列 表 是 由 冒 号 或 逗 号 分 隔 的 章 节 列 表 。 如 果 列 表 中 的 指 定 的 是 简 单 的 章 节 号 ， 如 “3”， 则 显 示 的 描 述 列 表 将 只 包 含 “3”、 “3perl”“3x”等 章 节 中 的 页 面 ； 如 果 列 表 中 的 章 节 号 带 扩 展 ， 如 “3perl”， 则 显 示 的 描 述 列 表 将 只 包 含 手 册 章 节 中 对 应 部 分 的 页 面 。

-m 系 统 [,...], --systems= 系 统 [,...]

如 果 此 系 统 可 以 访 问 其 他 操 作 系 统 的 手 册 页 描 述 ， 则 可 以 通 过 使 用 这 一 选 项 来 搜 索 它 们 。 如 要 搜 索 NewOS 的 手 册 页 描 述 ， 使 用 -m NewOS 选 项 。

指 定 的 系 统 选 项 可 以 是 逗 号 分 隔 的 操 作 系 统 名 称 组 合 。 要 在 搜 索 中 包 括 本 地 操 作 系 统 的 whatis 描 述 ， 可 以 在 参 数 字 符 串 中 包 含 系 统 名 man 。 此 选 项 会 覆 盖 $ SYSTEM 环 境 变 量 。

-M 路 径 , --manpath= 路 径

另 外 指 定 一 组 以 冒 号 分 隔 的 手 册 页 层 次 结 构 作 为 搜 索 路 径 。 默 认 情 况 下 apropos 会 使 用 $ MANPATH 环 境 变 量 作 为 搜 索 路 径 ； 如 果 该 环 境 变 量 为 空 或 未 设 置 ， 程 序 会 根 据 您 的 $ PATH 环 境 变 量 确 定 相 应 的 手 册 路 径 。 此 选 项 会 覆 盖 $ MANPATH 环 境 变 量 的 内 容 。

-L 区 域 , --locale= 区 域

apropos 通 常 会 通 过 调 用 C 语 言 函 数 setlocale (3) 来 确 定 您 的 当 前 区 域 设 置 。 该 函 数 会 查 询 多 个 环 境 变 量 ， 可 能 包 括 $ LC_MESSAGES 和 $ LANG 。 要 临 时 覆 盖 检 测 到 的 值 ， 请 使 用 该 选 项 直 接 向 apropos 提 供 一 个 区 域 字 符 串 。 注 意 ， 在 搜 索 页 面 实 际 开 始 前 它 不 会 生 效 。 帮 助 消 息 等 输 出 将 始 终 以 检 测 到 的 区 域 语 言 显 示 。

-C 文 件 , --config-file= 文 件

使 用 此 用 户 配 置 文 件 代 替 默 认 的 ~/.manpath 。

-? , --help

打 印 帮 助 消 息 并 退 出 。

--usage

打 印 简 短 的 帮 助 消 息 并 退 出 。

-V , --version

显 示 版 本 信 息 。

退 出 状 态

0

程 序 成 功 执 行 。

1

用 法 、 语 法 或 配 置 文 件 出 错 。

2

操 作 出 错 。

16

未 找 到 符 合 指 定 条 件 的 结 果 。

环 境

SYSTEM

如 果 设 置 了 $ SYSTEM 环 境 变 量 ， 其 效 果 将 与 -m 选 项 的 参 数 相 同 。

MANPATH

如 果 设 置 了 $ MANPATH 环 境 变 量 ， 它 的 值 将 被 解 释 为 要 使 用 的 ， 以 冒 号 分 隔 的 手 册 页 层 次 结 构 搜 索 路 径 。

请 参 考 manpath (5) 中 的 搜 索 路 径 一 节 以 了 解 默 认 行 为 以 及 处 理 该 环 境 变 量 的 细 节 。

MANWIDTH

如 果 设 置 了 $ MANWIDTH ， 它 的 值 将 用 作 终 端 宽 度 (参 阅 --long 选 项 )。 如 果 未 设 置 它 ， 终 端 宽 度 将 通 过 $ COLUMNS 环 境 变 量 或 调 用 ioctl (2)(如 果 有 的 话 )计 算 。 若 都 失 败 ， 将 退 回 到 80 个 字 符 。

POSIXLY_CORRECT

如 果 设 置 了 $ POSIXLY_CORRECT 环 境 变 量 (即 使 是 空 值 )， 默 认 的 apropos 搜 索 将 视 为 扩 展 的 正 则 表 达 式 ( -r )。 不 过 ， 现 在 这 已 经 是 默 认 行 为 了 。

文 件

/usr/share/man/index.(bt|db|dir|pag)

传 统 的 全 局 索 引 数 据 库 缓 存 。

/var/cache/man/index.(bt|db|dir|pag)

与 FHS 兼 容 的 全 局 索 引 数 据 库 缓 存 。

/usr/share/man/.../whatis

传 统 的 whatis 文 本 数 据 库 。

亦 见

man (1), whatis (1), mandb (8)

作 者

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

BUGS

https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db