Manpages

名 称

man - 在 线 参 考 手 册 的 接 口

概 述

man [-C 文 件 ] [-d] [-D] [--warnings[=警 告 ]] [-R 编 码 ] [-L 区 域 ] [-m 系 统 [,...]] [-M 路 径 ] [-S 列 表 ] [-e 扩 展 ] [-i|-I] [--regex|--wildcard] [--names-only] [-a] [-u] [--no-subpages] [-P 分 页 程 序 ] [-r 提 示 ] [-7] [-E 编 码 ] [--no-hyphenation] [--no-justification] [-p 字 符 串 ] [-t] [-T[设 备 ]] [-H[浏 览 器 ]] [-X[dpi]] [-Z] [[章 节 ] [.章 节 ] ...] ...
man -k
[apropos 选 项 ] 正 则 表 达 式 ...
man -K
[-w|-W] [-S list] [-i|-I] [--regex] [章 节 ] 词 语  ...
man -f
[whatis 选 项 ] ...
man -l
[-C 文 件 ] [-d] [-D] [--warnings[=警 告 ]] [-R 编 码 ] [-L 区 域 ] [-P 分 页 程 序 ] [-r 提 示 ] [-7] [-E 编 码 ] [-p 字 符 串 ] [-t] [-T[设 备 ]] [-H[浏 览 器 ]] [-X[dpi]] [-Z] 文 件 ...
man -w
|-W [-C 文 件 ] [-d] [-D] ...
man -c
[-C 文 件 ] [-d] [-D] ...
man
[-?V]

描 述

man 是 系 统 的 手 册 分 页 程 序 。 指 定 给 man 选 项 通 常 是 程 序 、 工 具 或 函 数 名 。 程 序 将 显 示 每 一 个 找 到 的 相 关 手 册 页 。 如 果 指 定 了 章 节man 将 只 在 手 册 的 指 定 章 节 搜 索 。 默 认 将 按 预 定 的 顺 序 查 找 所 有 可 用 的 章 节 (默 认 是 “1 n l 8 3 2 3posix 3pm 3perl 3am 5 4 9 6 7”, 除 非 被 /etc/manpath.config 中 的 SECTION 指 令 覆 盖 ), 并 只 显 示 找 到 的 第 一 个 , 即 使 多 个 章 节 中 都 有 这 个 页 面 。 下 表 显 示 了 手 册 的 章 节 号 及 其 包 含 的 手 册 页 类 型 。

一 个 手 册 页 面 包 含 若 干 个 小 节 。 小 节 名 称 通 常 包 括 NAME, 概 述 (SYNOPSIS), 配 置 (CONFIGURATION), 描 述 (DESCRIPTION), 选 项 (OPTIONS), 退 出 状 态 (EXIT STATUS), 返 回 值 (RETURN VALUE), 错 误 (ERRORS), 环 境 (ENVIRONMENT), 文 件 (FILES), 版 本 (VERSIONS), 符 合 标 准 (CONFORMING TO), 注 (NOTES), 缺 陷 (BUGS), 示 例 (EXAMPLE), 作 者 (AUTHORS), 和 亦 见 (SEE ALSO). 以 下 规 范 适 用 于 概 述 (SYNOPSIS) 小 节 , 也 可 作 为 其 他 小 节 的 指 南 。

实 际 渲 染 的 效 果 可 能 因 输 出 设 备 而 异 。 例 如 , 在 终 端 中 man 程 序 通 常 无 法 渲 染 出 斜 体 , 这 时 一 般 会 以 下 划 线 或 彩 色 文 字 代 替 。 程 序 和 函 数 说 明 应 该 是 一 个 可 以 匹 配 所 有 可 能 用 法 的 模 式 (pattern)。 有 些 情 况 下 , 建 议 按 此 手 册 页 概 述 (SYNOPSIS) 小 节 所 显 示 的 分 别 陈 述 几 种 互 斥 的 用 法 。

示 例

man ls 显 示 项 目 (程 序 ) ls 对 应 的 手 册 页
man
man.7 显 示 章 节 7 中 宏 包 man 对 应 的 手 册 页 。
man -a 
intro 正 确 执 行 时 显 示 手 册 中 包 含 的 所 有 可 用 的 intro 手 册 页 。 可 以 在 连 续 显 示 过 程 中 退 出 或 跳 过 任 一 页 。
man -t
alias | lpr -Pps 将 别 名 “alias”所 引 用 的 手 册 页 (常 为 shell 手 册 页 )格 式 化 为 默 认 的 troffgroff 格 式 并 通 过 管 道 传 送 给 名 为 ps 的 打 印 机 。 groff 的 默 认 输 出 通 常 为 PostScript。 man --help 应 该 会 提 示 哪 个 处 理 器 程 序 与 -t 选 项 绑 定 。
man -l -T
dvi ./foo.1x.gz > ./foo.1x.dvi 此 命 令 会 将 nroff 源 手 册 页 ./foo.1x.gz 解 压 并 格 式 化 为 设 备 无 关 (dvi) 文 件 。 重 定 向 是 必 须 的 , 因 为 -T 标 志 会 导 致 输 出 不 经 分 页 程 序 直 接 传 送 到 stdout。 应 该 使 用 xdvi 这 样 的 程 序 查 看 输 出 结 果 , 或 使 用 dvips 这 样 的 程 序 进 一 步 处 理 为 PostScript。
man -k 
printf 将 关 键 词 printf 作 为 正 则 表 达 式 来 搜 索 对 应 的 手 册 页 概 述 和 手 册 页 名 称 , 并 打 印 所 有 匹 配 结 果 。 等 效 于 apropos printf.
man -f 
smail 查 找 smail 引 用 的 手 册 页 并 输 出 找 到 的 所 有 概 述 。 等 效 于 whatis smail.

概 述

man 有 许 多 选 项 供 用 户 灵 活 使 用 。 搜 索 路 径 、 章 节 顺 序 、 输 出 处 理 器 和 其 他 行 为 和 操 作 均 可 更 改 , 具 体 如 下 。 如 果 被 设 置 , 程 序 将 检 查 各 种 环 境 变 量 来 确 定 man 如 何 操 作 。 可 以 对 命 令 行 中 的 任 何 字 符 串 设 置 “catch all”变 量 $MANOPT, 除 非 是 选 项 参 数 中 需 要 转 义 的 空 格 。 man 将 会 先 解 析 $MANOPT, 再 解 析 它 自 己 的 命 令 行 。 这 些 需 要 参 数 的 选 项 将 会 被 命 令 行 中 其 他 的 相 同 选 项 所 覆 盖 。 若 要 重 置 $MANOPT 中 的 所 有 选 项 , 可 以 在 命 令 行 开 头 指 定 -D 选 项 。 这 会 让 man “忘 掉 ”$MANOPT 中 指 定 的 选 项 , 即 便 它 们 可 能 仍 然 是 有 效 的 。 手 册 分 页 程 序 工 具 封 装 在 man-db 程 序 包 里 , 它 们 充 分 利 用 索 引 数 据 库 缓 存 。 这 些 缓 存 包 含 了 诸 如 每 个 手 册 页 存 储 在 文 件 系 统 的 什 么 位 置 , 它 的 whatis (对 手 册 页 的 一 句 概 述 ) 包 含 什 么 , 而 且 能 让 man 运 行 更 快 些 , 因 为 不 用 每 次 搜 索 文 件 系 统 查 找 相 应 的 手 册 页 。 如 果 调 用 时 使 用 了 -u 选 项 , man 会 保 证 缓 存 的 一 致 性 ; 这 避 免 了 手 动 运 行 软 件 来 更 新 传 统 的 whatis 文 本 数 据 库 。 如 果 manmandb 初 始 化 的 索 引 数 据 库 中 找 不 到 某 个 手 册 页 层 次 结 构 , 它 仍 然 会 搜 索 请 求 的 手 册 页 , 尽 管 搜 索 该 层 次 结 构 时 需 要 展 开 文 件 。 如 果 whatisapropos 找 不 到 索 引 , 它 会 尝 试 从 传 统 的 whatis 数 据 库 中 提 取 信 息 。 这 些 工 具 默 认 支 持 以 .Z, .z.gz 为 扩 展 名 的 nroff 压 缩 源 文 件 。 可 以 支 持 其 他 压 缩 扩 展 名 , 但 相 应 信 息 需 要 在 编 译 时 提 供 。 同 样 , 任 何 cat 页 面 将 使 用 gzip 压 缩 。 每 个 “全 局 ”手 册 页 层 次 结 构 如 /usr/share/man/usr/X11R6/man 可 以 包 含 任 何 与 其 cat 页 层 次 结 构 相 同 的 目 录 。 传 统 上 cat 页 面 保 存 在 与 man 页 面 相 同 的 层 次 结 构 下 , 但 由 于 某 些 原 因 , 例 如 File Hierarchy Standard (文 件 系 统 层 次 结 构 标 准 , FHS) 所 指 出 的 , 可 能 将 它 们 保 存 在 其 他 位 置 更 好 。 有 关 如 何 操 作 的 详 细 信 息 , 请 参 阅 manpath(5)。 想 了 解 这 样 做 的 详 细 原 因 , 请 阅 读 标 准 文 档 。 此 包 提 供 了 国 际 化 支 持 。 本 地 语 言 的 手 册 页 (如 果 系 统 上 有 )可 以 通 过 使 用 locale 功 能 来 访 问 。 要 启 用 本 地 语 言 支 持 , 需 要 将 $LC_MESSAGES 或 $LANG 或 其 他 系 统 相 关 的 环 境 变 量 设 置 为 您 的 语 言 区 域 代 码 ; 该 代 码 通 常 以 基 于 POSIX 1003.1 的 格 式 指 定 :

<语 言 >[_<地 区 >[.<字 符 集 >[,<版 本 >]]] 如 果 所 需 的 页 面 有 您 的 区 域 对 应 的 版 本 , 它 会 替 代 标 准 的 (通 常 为 美 国 英 语 )手 册 页 显 示 。 国 际 化 的 消 息 分 类 功 能 也 包 含 在 此 包 中 , 可 以 用 同 样 的 方 式 启 用 (如 果 可 用 的 话 )。 如 果 您 发 现 此 包 提 供 的 手 册 页 和 消 息 分 类 对 您 的 本 地 语 言 不 可 用 并 且 想 提 供 支 持 , 请 联 系 协 调 这 类 活 动 的 (手 册 本 地 化 )维 护 者 。 有 关 此 手 册 分 页 程 序 其 他 可 用 功 能 和 扩 展 的 信 息 , 请 阅 读 此 包 提 供 的 文 档 。

默 认 值

man 将 在 索 引 数 据 库 缓 存 中 搜 索 需 要 的 手 册 页 。 如 果 指 定 了 -u 选 项 , 将 执 行 缓 存 一 致 性 检 查 来 保 证 数 据 库 与 文 件 系 统 精 确 对 应 。 如 果 总 是 指 定 该 选 项 , 则 不 必 在 缓 存 初 次 创 建 后 运 行 mandb, 除 非 缓 存 被 破 坏 。 不 过 , 缓 存 一 致 性 检 查 在 安 装 了 很 多 手 册 页 的 系 统 上 可 能 很 慢 , 因 此 默 认 不 检 查 ; 系 统 管 理 员 可 以 隔 段 时 间 (如 每 周 )运 行 一 次 mandb 来 保 证 数 据 库 缓 存 及 时 更 新 。 为 预 防 过 期 缓 存 导 致 的 问 题 , man 会 在 查 找 缓 存 失 败 后 退 回 到 文 件 展 开 查 找 , 就 像 没 有 缓 存 时 一 样 。 一 旦 定 位 到 手 册 页 , 程 序 将 检 查 是 否 已 存 在 一 个 相 关 的 “cat”文 件 并 且 比 nroff 文 件 新 。 如 果 是 , 这 个 预 格 式 化 的 文 件 (通 常 )会 使 用 分 页 程 序 解 压 和 显 示 。 分 页 程 序 可 以 通 过 几 种 方 式 指 定 , 或 者 退 回 到 使 用 一 个 默 认 的 (详 见 -P 选 项 )。 如 果 找 不 到 cat 文 件 或 它 比 nroff 文 件 旧 , nroff 将 通 过 各 种 程 序 过 滤 并 立 即 显 示 。 如 果 可 以 生 成 cat 文 件 (相 应 的 cat 目 录 存 在 并 有 正 确 的 权 限 ), man 会 在 后 台 压 缩 并 保 存 cat 文 件 。 可 以 通 过 几 种 方 式 指 定 过 滤 程 序 。 首 先 , 会 查 询 命 令 行 选 项 -p 或 环 境 变 量 $MANROFFSEQ。 如 果 没 有 指 定 -p, 环 境 变 量 也 未 设 置 , 将 解 析 nroff 的 第 一 行 来 查 找 预 处 理 器 字 符 串 。 要 包 含 有 效 的 预 处 理 器 字 符 串 , 第 一 行 必 须 这 样 写 :

’\" <字 符 串 > 其 中 字 符 串 可 以 是 下 面 -p 选 项 所 描 述 的 任 何 字 符 的 组 合 。 如 果 以 上 方 法 都 没 有 提 供 过 滤 程 序 信 息 , 将 使 用 默 认 程 序 集 。 过 滤 程 序 和 主 格 式 化 程 序 (nroff 或 [tg]roff -t) 将 组 成 格 式 化 流 水 线 并 执 行 。 或 者 , 如 果 man 树 根 节 点 有 可 执 行 的 mandb_nfmt (或 mandb_tfmt -t) 程 序 , 将 转 而 执 行 它 。 手 册 源 文 件 、 预 处 理 字 符 串 , 以 及 可 选 的 以 -T-E 指 定 的 设 备 将 作 为 参 数 传 递 给 它 。

选 项

非 参 数 的 选 项 如 果 在 命 令 行 和 /或 $MANOPT 重 复 指 定 , 不 会 产 生 问 题 。 对 于 需 要 参 数 的 选 项 , 每 次 重 复 将 覆 盖 上 个 参 数 值 。 常 规 选 项

-C 文 件--config-file=文 件 使 用 此 用 户 配 置 文 件 代 替 默 认 的 ~/.manpath
-d
, --debug 打 印 调 试 信 息 。
-D
, --default 此 选 项 通 常 作 为 第 一 个 选 项 , 它 将 man 的 行 为 恢 复 为 默 认 值 。 它 的 作 用 是 重 置 任 何 在 $MANOPT 中 设 置 的 选 项 。 -D 之 后 的 任 何 选 项 保 留 其 原 有 效 果 。
--warnings
[=警 告 ] 启 用 来 自 groff 的 警 告 。 这 可 以 用 于 检 查 手 册 页 源 文 件 完 整 性 。 警 告 是 以 英 文 逗 号 分 隔 的 警 告 名 列 表 ; 如 果 不 提 供 , 默 认 为 “mac”。 请 查 阅 info groff 中 的 “警 告 ” 节 点 了 解 可 用 的 警 告 名 列 表 。 主 要 操 作 方 式
-f
, --whatis 等 同 于 whatis。 显 示 来 自 手 册 页 的 加 简 短 说 明 (若 有 )。 详 见 whatis(1)
-k
, --apropos 等 同 于 apropos。 搜 索 关 键 词 对 应 的 手 册 概 述 并 显 示 所 有 匹 配 结 果 。 详 见 apropos
-K
, --global-apropos 在 所 有 手 册 中 搜 索 文 本 。 这 是 蛮 力 搜 索 , 需 要 花 费 一 定 时 间 ; 如 果 可 以 , 您 应 该 指 定 手 册 章 节 以 减 少 需 要 搜 索 的 手 册 页 数 量 。 搜 索 条 目 可 以 是 简 单 的 字 符 串 (默 认 ), 或 正 则 表 达 式 (若 使 用 了 --regex 选 项 )。 注 意 , 这 种 做 法 应 用 于 搜 索 手 册 页 的 资 源 , 而 非 渲 染 后 的 文 本 , 所 以 可 能 会 包 含 一 些 不 相 干 的 内 容 ( 如 源 文 件 中 的 注 释 ) 。 若 要 搜 索 渲 染 后 的 文 本 , 速 度 会 比 较 慢 。
-l
, --local-file 启 用 “本 地 ”方 式 。 格 式 化 并 显 示 本 地 手 册 文 件 , 而 非 搜 索 系 统 手 册 集 。 每 个 手 册 页 参 数 将 解 释 为 格 式 正 确 的 nroff 源 文 件 。 不 产 生 cat 文 件 。 如 果 参 数 中 有 “-”, 将 从 标 准 输 入 读 取 。 如 果 未 指 定 它 , 而 man 未 找 到 要 求 的 页 面 , 在 显 示 错 误 消 息 前 man 会 假 设 指 定 了 此 选 项 进 行 尝 试 , 使 用 名 称 作 为 文 件 名 并 查 找 精 确 匹 配 。
-w
, --where, --path, --location 不 显 示 手 册 页 , 但 打 印 将 被 格 式 化 的 nroff 文 件 的 位 置 。
-W
, --where-cat, --location-cat 不 实 际 显 示 手 册 页 , 但 打 印 将 显 示 的 cat 文 件 的 位 置 。 如 果 同 时 指 定 了 -w 和 -W, 则 同 时 打 印 二 者 , 以 空 格 隔 开 。
-c
, --catman 此 选 项 一 般 不 使 用 , 并 且 只 应 由 catman 程 序 使 用 。
-R 
编 码--recode=编 码 与 正 常 的 格 式 化 手 册 页 不 同 , 将 输 入 源 转 换 成 指 定 的 编 码 输 出 。 如 果 您 已 经 知 道 源 文 件 的 编 码 , 也 可 以 直 接 使 用 manconv(1)。 不 过 , 此 选 项 可 以 将 几 个 手 册 页 转 换 为 单 一 编 码 , 而 不 用 明 确 声 明 各 自 的 编 码 , 前 提 是 它 们 已 经 安 装 在 与 手 册 页 层 次 结 构 类 似 的 目 录 结 构 中 。 查 找 手 册 页
-L 
区 域--locale=区 域

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

-m 系 统 [,...], --systems=系 统 [,...] 如 果 此 系 统 可 以 访 问 其 他 操 作 系 统 的 手 册 页 , 可 以 使 用 此 选 项 访 问 它 们 。 如 要 在 NewOS 的 手 册 页 集 中 搜 索 某 个 手 册 页 , 使 用 -m NewOS 选 项 。 指 定 的 系 统 选 项 可 以 是 逗 号 分 隔 的 操 作 系 统 名 称 组 合 。 要 在 搜 索 中 包 括 本 地 操 作 系 统 的 手 册 页 , 可 以 在 参 数 字 符 串 中 包 含 系 统 名 man。 此 选 项 会 覆 盖 $SYSTEM 环 境 变 量 。
-M 
路 径--manpath=路 径 指 定 要 使 用 的 另 一 manpath 路 径 。 默 认 情 况 下 man 使 用 manpath 得 到 的 代 码 来 确 定 搜 索 路 径 。 此 选 项 会 覆 盖 $SYSTEM 环 境 变 量 。 指 定 为 manpath 的 路 径 必 须 是 划 分 为 若 干 章 节 的 手 册 页 层 次 结 构 的 根 目 录 。 章 节 描 述 见 man-db 手 册 (位 于 “手 册 页 系 统 ”)。 要 查 看 层 次 结 构 之 外 的 手 册 页 , 请 参 阅 -l 选 项 。
-S 
列 表-s 列 表--sections=列 表 要 搜 索 的 “指 定 顺 序 ”的 手 册 章 节 列 表 , 以 英 文 冒 号 或 逗 号 分 隔 。 此 选 项 会 覆 盖 $MANSECT 环 境 变 量 。 (使 用 -s 表 示 是 为 了 与 System V 兼 容 。 )
-e 
sub-extension--extension=sub-extension 某 些 系 统 包 含 大 量 的 手 册 页 包 , 例 如 某 些 系 统 将 Tcl (手 册 )包 并 入 主 手 册 页 层 次 目 录 。 为 避 免 两 个 手 册 页 重 名 , 如 exit(3)Tcl 手 册 页 通 常 都 归 于 l 章 节 。 为 解 决 这 一 不 便 , 现 在 可 以 将 页 面 放 在 正 确 的 节 , 分 配 给 它 们 一 个 特 定 的 “扩 展 (extension”即 可 ; 这 个 例 子 中 , 就 是 exit(3tcl)。 正 常 操 作 时 , man 会 优 先 显 示 exit(3) 而 不 是 exit(3tcl)。 为 协 调 这 一 状 况 并 避 免 要 记 住 所 需 手 册 页 属 于 哪 个 章 节 , 现 在 可 以 给 man 指 定 一 个 sub-extension字 符 串 , 指 示 该 手 册 页 必 须 属 于 哪 个 包 。 对 于 上 面 的 例 子 , 给 man 加 上 -e tcl 选 项 , 就 能 限 制 只 搜 索 带 有 *tcl 扩 展 的 页 面 。
-i
, --ignore-case 搜 索 手 册 页 时 忽 略 大 小 写 。 此 为 默 认 值 。
-I
, --match-case 搜 索 手 册 页 时 匹 配 大 小 写 。
--regex
显 示 名 字 或 描 述 的 任 何 部 分 与 所 提 供 的 正 则 表 达 式 参 数 匹 配 的 所 有 页 面 , 像 使 用 apropos(1) 一 样 。 由 于 搜 索 正 则 表 达 式 时 通 常 没 办 法 选 出 “ 最 佳 ”手 册 页 , 此 选 项 隐 含 了 -a 选 项 。
--wildcard
显 示 名 字 或 描 述 的 任 何 部 分 与 所 提 供 的 shell 格 式 通 配 符 参 数 匹 配 的 所 有 页 面 , 像 使 用 apropos(1) --wildcard 一 样 。 参 数 必 须 匹 配 整 个 名 字 或 描 述 , 或 匹 配 描 述 中 单 词 的 边 界 。 由 于 搜 索 通 配 符 时 通 常 没 办 法 选 出 “最 佳 ”手 册 页 , 此 选 项 隐 含 了 -a 选 项 。
--names-only
如 果 使 用 了 --regex--wildcard 选 项 , 则 只 匹 配 手 册 页 名 而 不 匹 配 描 述 , 就 像 使 用 whatis(1) 一 样 。 否 则 不 起 作 用 。
-a
, --all 默 认 情 况 下 , man 在 显 示 它 找 到 的 最 符 合 的 手 册 页 后 会 退 出 。 此 选 项 强 制 man 显 示 名 字 匹 配 搜 索 条 件 的 所 有 的 手 册 页 。
-u
, --update 此 选 项 使 man 对 数 据 库 缓 存 进 行 “inode 级 别 ”的 一 致 性 检 查 , 以 保 证 缓 存 与 文 件 系 统 精 确 对 应 。 只 有 安 装 的 man 程 序 设 置 了 setuid 权 限 位 时 它 才 有 效 。
--no-subpages
默 认 情 况 下 , man 会 试 图 将 命 令 行 上 提 供 的 一 对 手 册 页 名 视 同 包 含 连 字 符 或 下 划 线 的 单 个 手 册 页 名 来 解 释 。 这 会 支 持 那 些 实 现 了 多 个 子 命 令 的 程 序 的 常 见 模 式 , 允 许 程 序 为 每 个 子 命 令 提 供 手 册 页 , 并 用 和 调 用 各 子 命 令 的 语 法 类 似 的 方 式 访 问 它 们 。 例 如 :

$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz 要 禁 用 此 行 为 , 请 使 用 --no-subpages 选 项 。

$ man -aw --no-subpages git diff
/usr/share/man/man1/git.1.gz
/usr/share/man/man3/Git.3pm.gz
/usr/share/man/man1/diff.1.gz 控 制 格 式 化 输 出

-P 分 页 程 序--pager=分 页 程 序 指 定 使 用 哪 个 输 出 分 页 程 序 。 man 默 认 使 用 pager, 在 无 法 找 到 pager 或 它 不 是 可 执 行 文 件 时 则 会 回 退 到 使 用 cat。 此 选 项 会 覆 盖 $MANPAGER 环 境 变 量 , 进 一 步 覆 盖 $PAGER 环 境 变 量 。 它 不 和 -f-k 合 用 。 值 可 以 是 简 单 的 命 令 名 或 带 参 数 的 命 令 , 并 可 以 使 用 shell 引 用 (反 斜 杠 、 单 引 号 或 双 引 号 )。 不 能 使 用 管 道 连 接 多 个 命 令 ; 如 果 您 需 要 , 请 使 用 封 装 器 脚 本 , 它 能 够 以 参 数 形 式 或 从 标 准 输 入 获 得 要 显 示 的 文 件 。
-r 
提 示--prompt=提 示 如 果 使 用 较 新 的 less 作 为 分 页 程 序 , man 将 尝 试 设 置 它 的 提 示 消 息 和 一 些 敏 感 选 项 。 默 认 的 提 示 消 息 类 似 于  

Manual page name(sec) line x 其 中 name 表 示 手 册 页 名 , sec 表 示 找 到 的 手 册 页 所 属 的 章 节 , x 是 当 前 行 号 。 这 是 通 过 使 用 $LESS 环 境 变 量 实 现 的 。 提 供 一 个 带 字 符 串 的 -r 选 项 会 覆 盖 这 个 默 认 值 。 字 符 串 可 以 包 含 文 本 $MAN_PN, 它 会 展 开 为 用 “(”和 “)”括 起 来 的 当 前 手 册 页 的 章 节 名 。 显 示 默 认 提 示 的 字 符 串 可 以 表 示 为

\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(press h for help or q to quit)
为 了 方 便 阅 读 , 这 里 分 成 了 三 行 。 字 符 串 的 含 义 请 参 阅 less(1) 手 册 页 。 提 示 字 符 串 将 首 先 由 shell 解 释 。 提 示 中 的 所 有 的 双 引 号 、 反 斜 杠 都 必 须 在 前 面 加 一 个 反 斜 杠 转 义 。 提 示 字 符 串 可 以 转 义 的 $ 结 束 , 后 面 还 可 以 跟 其 他 的 less 选 项 。 man 默 认 设 置 -ix8 选 项 。 下 面 描 述 的 $MANLESS 环 境 变 量 可 以 用 来 在 命 令 行 未 指 定 时 设 置 默 认 的 提 示 字 符 串 。

-7, --ascii 当 在 7位 编 码 的 终 端 或 终 端 模 拟 器 中 查 看 纯 ascii(7) 手 册 页 时 , 若 使 用 GNU nroff latin1(7) 设 备 描 述 , 一 些 字 符 可 能 显 示 不 正 确 。 此 选 项 允 许 纯 ascii 手 册 页 使 用 latin11 设 备 以 ascii 显 示 。 它 不 会 转 换 任 何 latin1 文 本 。 以 下 表 格 显 示 了 进 行 的 转 换 : 其 中 一 部 分 可 能 只 有 在 使 用 GNU nrofflatin1(7) 设 备 时 才 正 确 显 示 。

如 果 latin1 列 显 示 正 确 , 您 的 终 端 可 能 作 了 latin1 字 符 设 置 , 此 选 项 将 不 需 要 。 如 果 latin1ascii 列 一 样 , 那 么 您 正 在 使 用 此 选 项 阅 读 本 手 册 页 , 或 man 未 使 用 latin1 设 备 描 述 来 格 式 化 此 页 。 如 果 latin1 列 缺 损 , 您 可 能 要 使 用 此 选 项 来 查 看 手 册 页 。 在 使 用 -t, -H, -T, 或 -Z 选 项 时 此 选 项 可 能 对 GNU 版 之 外 的 nroff 程 序 无 用 。

-E 编 码--encoding=编 码 生 成 对 应 字 符 编 码 的 输 出 , 而 非 默 认 编 码 。 为 向 后 兼 容 , 编 码 可 以 是 nroff 设 备 , 如 asciilatin1utf8, 也 可 以 是 实 际 的 字 符 编 码 如 UTF-8
--no-hyphenation
, --nh 通 常 , 如 果 需 要 将 单 词 排 在 一 行 而 不 添 加 过 多 的 空 格 , nroff 会 在 换 行 处 自 动 断 字 (给 文 本 添 加 连 字 符 , 即 使 单 词 本 来 不 包 含 )。 此 选 项 禁 止 自 动 断 字 , 即 单 词 包 含 连 字 符 时 才 会 被 断 开 。 如 果 您 编 写 手 册 页 时 只 是 不 希 望 nroff 在 某 个 位 置 不 恰 当 地 断 字 , 不 要 使 用 此 选 项 , 而 应 查 阅 nroff 文 档 中 的 相 关 方 法 ; 例 如 , 您 可 以 在 单 词 中 插 入 “\%”来 指 示 该 位 置 可 以 断 字 , 或 在 单 词 开 头 插 入 “\%”来 阻 止 对 它 断 字 。
--no-justification
, --nj 通 常 , nroff 会 自 动 两 端 对 齐 文 本 。 此 选 项 禁 止 两 端 对 齐 , 只 对 齐 左 边 , 形 成 所 谓 的 “ragged-right”(右 边 不 齐 )的 文 本 。 如 果 您 编 写 手 册 页 时 只 是 不 希 望 nroff 对 齐 某 些 段 落 , 不 要 使 用 此 选 项 , 而 应 查 阅 nroff 文 档 中 的 相 关 方 法 ; 例 如 , 您 可 以 使 用 “.na”、 “.nf”、 “.fi”和 “.ad”请 求 来 临 时 禁 止 对 齐 和 填 充 。
-p 
字 符 串--preprocessor=字 符 串 指 定 nrofftroff/groff 之 前 运 行 的 预 处 理 器 序 列 。 系 统 中 可 能 未 安 装 所 有 的 预 处 理 器 。 一 些 预 处 理 器 及 其 代 号 如 下 : eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r)。 此 选 项 覆 盖 $MANROFFSEQ 环 境 变 量 。 zsoelim 总 是 作 为 第 一 个 预 处 理 器 运 行 。
-t
, --troff 使 用 %troff 来 格 式 化 手 册 页 到 stdout。 此 选 项 不 要 求 和 -H-T-Z 一 起 使 用 。
-T
[设 备 ], --troff-device[=设 备 ] 此 选 项 用 于 更 改 groff (也 可 能 是 troff) 的 输 出 以 适 合 某 个 非 默 认 设 备 。 此 选 项 隐 含 了 -t。 (Groff-1.17 提 供 的 )例 子 包 括 dvilatin1psutf8X75X100
-H
[浏 览 器 ], --html[=浏 览 器 ] 此 选 项 使 groff 生 成 HTML 输 出 并 在 浏 览 器 中 显 示 输 出 结 果 。 浏 览 器 选 择 取 决 于 可 选 的 browser 参 数 (若 提 供 )、 $BROWSER 环 境 变 量 , 或 编 译 时 指 定 的 默 认 值 (或 环 境 变 量 未 设 置 , 默 认 值 通 常 为 lynx)。 此 选 项 隐 含 了 -t, 并 只 和 GNU troff 一 起 使 用 。
-X
[dpi], --gxditview[=dpi] 此 选 项 使 用 gxditview 程 序 在 一 个 图 形 窗 口 中 显 示 groff 的 输 出 结 果 。 dpi (点 /英 寸 )可 以 是 75、 75-12、 100 或 100-12, 默 认 为 75; -12 形 式 使 用 12 点 的 基 础 字 号 。 此 选 项 隐 含 了 带 相 应 X75、 X75-12、 X100 或 X100-12 参 数 的 -T 选 项 。
-Z
, --ditroff

groff 会 运 行 troff 然 后 使 用 合 适 的 后 处 理 器 产 生 适 合 所 选 设 备 的 输 出 。 如 果 %troffgroff, 此 选 项 会 传 递 给 groff 并 禁 止 使 用 后 处 理 器 。 此 选 项 隐 含 了 -t 选 项 。 获 取 帮 助

-?, --help 打 印 帮 助 消 息 并 退 出 。
--usage
打 印 简 短 的 帮 助 消 息 并 退 出 。
-V
, --version 显 示 版 本 信 息 。

退 出 状 态

0 程 序 成 功 执 行 。

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

2 操 作 出 错 。

3 子 进 程 返 回 了 非 零 的 退 出 状 态 码 。

16 至 少 有 一 个 页 面

/文 件 /关 键 词 不 存 在 或 不 匹 配 。

环 境

MANPATH 如 果 设 置 了 $MANPATH, 它 的 值 会 用 作 搜 索 手 册 页 的 路 径 。
MANROFFOPT

$MANROFFOPT 的 内 容 会 在 每 次 man 调 用 格 式 化 程 序 (nroff, troffgroff)时 添 加 到 命 令 行 。

MANROFFSEQ 如 果 设 置 了 $MANROFFSEQ, 它 的 值 会 用 于 确 定 每 个 手 册 页 经 过 的 预 处 理 程 序 的 集 合 。 默 认 的 预 处 理 器 列 表 因 系 统 而 异 。
MANSECT
如 果 设 置 了 $MANSECT, 它 的 值 (以 冒 号 分 隔 的 章 节 列 表 )会 用 于 确 定 搜 索 哪 些 章 节 及 搜 索 顺 序 。 默 认 值 为 “1 n l 8 3 2 3posix 3pm 3perl 3am 5 4 9 6 7”, 除 非 被 /etc/manpath.config 中 的 SECTION 指 令 覆 盖 。
MANPAGER
, PAGER 如 果 设 置 了 $MANPAGER 或 $PAGER (优 先 使 用 $MANPAGER), 它 的 值 会 用 作 显 示 手 册 页 的 程 序 的 名 称 。 默 认 使 用 pager, 如 果 无 法 找 到 pager 或 它 不 是 可 执 行 文 件 的 话 则 会 回 退 到 使 用 cat。 值 可 以 是 简 单 的 命 令 名 或 带 参 数 的 命 令 , 并 可 以 使 用 shell 引 用 (反 斜 杠 、 单 引 号 或 双 引 号 )。 不 能 使 用 管 道 连 接 多 个 命 令 ; 如 果 您 需 要 , 请 使 用 封 装 器 脚 本 , 它 能 够 以 参 数 形 式 或 从 标 准 输 入 获 得 要 显 示 的 文 件 。
MANLESS
如 果 设 置 了 $MANLESS, 它 的 值 将 用 作 less 分 页 程 序 的 默 认 提 示 字 符 串 , 如 同 作 为 -r 选 项 的 参 数 传 递 一 样 (因 此 出 现 的 任 何 $MAN_PN 会 以 同 样 的 方 式 展 开 )。 例 如 , 如 果 您 想 将 提 示 字 符 串 无 条 件 地 设 置 为 “my prompt string”, 请 将 $MANLESS 设 置 为 ’-Psmy prompt string’。 使 用 -r 选 项 会 覆 盖 此 环 境 变 量 。
BROWSER
如 果 设 置 了 $BROWSER, 它 的 值 (冒 号 分 隔 的 命 令 列 表 )中 的 每 一 个 会 轮 流 用 于 尝 试 为 man --html 启 动 一 个 网 络 浏 览 器 。 每 个 命 令 中 , %s 会 替 换 成 包 含 groff HTML 输 出 的 文 件 名 , %% 会 替 换 成 一 个 百 分 号 (%), %c 会 替 换 成 冒 号 (:)。

SYSTEM 如 果 设 置 了

$SYSTEM 环 境 变 量 , 其 效 果 将 与 -m 选 项 的 参 数 相 同 。

MANOPT 如 果 设 置 了

$MANOPT, 它 会 先 于 man 的 命 令 行 并 假 设 为 类 似 的 格 式 来 解

析 。 由 于 所 有 其 他 的 man 特 定 环 境 变 量 可 以 表 达 为 命 令 行 选 项 而 可 以 包 被 含 进 $MANOPT, 因 此 这 些 环 境 变 量 可 能 废 弃 。 注 意 , 所 有 应 当 解 释 为 命 令 行 选 项 参 数 一 部 分 的 空 格 必 须 被 转 义 。

MANWIDTH 如 果 设 置 了 $MANWIDTH, 它 的 值 将 用 作 手 册 页 格 式 化 时 的 每 行 长 度 。 如 果 未 设 置 , 手 册 页 将 使 用 适 合 当 前 终 端 的 行 长 度 格 式 化 (使 用 $COLUMNS 的 值 或 通 过 ioctl(2) 调 用 获 取 , 或 在 都 不 可 用 的 情 况 下 退 回 到 80 个 字 符 )。 Cat 页 面 只 有 在 默 认 格 式 化 可 用 时 才 会 保 存 , 即 终 端 行 长 度 介 于 66 到 80 个 字 符 时 。
MAN_KEEP_FORMATTING
通 常 , 当 输 出 不 定 向 到 终 端 时 (如 定 向 到 文 件 或 管 道 ), 格 式 化 字 符 会 被 忽 略 , 以 便 不 使 用 特 殊 工 具 就 能 阅 读 结 果 。 但 如 果 $MAN_KEEP_FORMATTING 设 置 成 了 任 何 非 空 的 值 , 这 些 格 式 化 字 符 将 保 存 。 这 对 于 可 以 解 释 格 式 化 字 符 的 man 封 装 程 序 有 用 。
MAN_KEEP_STDERR
通 常 , 当 输 出 定 向 到 终 端 时 (一 般 是 分 页 程 序 ), 产 生 手 册 格 式 化 版 本 的 命 令 造 成 的 任 何 错 误 输 出 都 会 被 忽 略 , 以 免 干 扰 分 页 程 序 显 示 。 groff 这 样 的 程 度 经 常 产 生 较 小 的 有 关 排 版 显 示 的 错 误 消 息 (如 未 对 齐 )。 这 些 消 息 很 难 看 , 并 且 一 般 与 手 册 页 一 起 显 示 时 会 产 生 干 扰 。 不 过 , 有 些 用 户 就 是 想 看 到 它 们 , 好 吧 , 如 果 $MAN_KEEP_STDERR 设 成 了 非 空 的 值 , 这 些 错 误 输 出 会 照 常 显 示 。
LANG
, LC_MESSAGES 取 决 于 系 统 和 实 现 , 程 序 会 查 询 $LANG 和 /或 $LC_MESSAGES 获 知 当 前 的 消 息 区 域 语 言 。 man 会 以 该 区 域 语 言 显 示 消 息 (若 可 用 )。 参 阅 setlocale(3) 了 解 准 确 的 详 情 。

文 件

/etc/manpath.config

man-db 配 置 文 件 。

/usr/share/man 全 局 手 册 页 层 次 结 构 。
/usr/share/man/index.(bt|db|dir|pag)
传 统 的 全 局 索 引 数 据 库 缓 存 。
/var/cache/man/index.(bt|db|dir|pag)
与 FHS 兼 容 的 全 局 索 引 数 据 库 缓 存 。

亦 见

apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), whatis(1), zsoelim(1), setlocale(3), manpath(5), ascii(7), latin1(7), man(7), catman(8), mandb(8), man-db 包 的 手 册 , FSSTND

历 史

1990, 1991 – 原 作 者 John W. Eaton (jwe [AT] che.edu)。

1992年 12月 23日 : Rik Faith (faith [AT] cs.edu) 应 用 了 Willem Kasdorp (wkasdo [AT] nikhefk.nl) 提 供 的 bug 补 丁 。

1994年 4月 30日 – 2000年 2月 23日 : Wilf. (G.Wilford [AT] ee.uk) 在 几 位 热 心 人 的 帮 助 下 开 发 和 维 护 这 个 包 。

1996年 10月 30日 – 2001年 3月 30日 : Fabrizio Polacco <fpolacco [AT] debian.org> 为 Debian 项 目 维 护 并 增 强 了 这 个 包 , 过 程 中 得 到 整 个 社 区 的 帮 助 。

2001年 3月 31日 – 今 天 : Colin Watson <cjwatson [AT] debian.org> 开 发 和 维 护 着 man-db。

COMMENTS