/usr/bin/catman [-c] [-n
] [-p] [-t] [-w] [
-M directory]
[-T macro-package] [
sections]
/usr/bin/catman [-M directory] -w
catman 实用程序基于 nroff(1) 或 sgml(5) 输入文件创建在线手册的预格式化版本。通过此功能，可以轻松地在一组关联的计算机之间分发预格式化手册页，因为此功能使预格式化手册页的目录成为自包含目录，独立于未格式化的条目。
通过 –w 选项，catman 还可在 MANPATH 或 –M 选项指定的目录中创建索引文件。如果未指定 MANPATH 或 – M 选项，且未指定 –n，catman 缺省情况下会在 /usr/share/man/ 和 /usr/gnu/share/man/ 目录中创建索引文件。如果任何指定或缺省目录为只读目录，则 catman 会失败，并在标准错误中显示一条错误消息，指出不允许写入该目录。
系统会检查每个手册页，并对预格式化版本缺失或过期的手册页进行重新创建。如果进行了任何更改，则 catman 将重新创建索引文件。
如果手册页为 shadow 页，即该手册页将另一手册页作为其内容源，则会在 catx 或 fmt x 目录中创建指向相应预格式化手册页的符号链接。
未格式化 nroff 源文件中的阴影文件由第一行标识，其形式如下：.so manx /yyy.x。
SGML 源中的阴影文件由字符串 SHADOW_PAGE 标识。在阴影文件中声明的文件实体标识要作为源的文件。
支持以下选项：
基于 SGML 源在相应 man 子目录中创建未格式化的 nroff 源文件。此选项将覆盖 man 目录中与 SGML 文件具有相同名称的任何现有文件。
不创建（或重新创建）索引文件。如果指定了 –n 选项，则不会创建索引文件，并且 apropos(1) 和 whatis(1) 命令可能比其他情况下运行速度慢。
模拟运行选项。即显示将执行的操作，而不实际执行。
在相应 fmt 子目录中创建经过 troff 处理的条目，而不是通过 nroff 置入 cat 子目录。
在 MANPATH 环境变量或 –M 选项指定的目录中，创建供 apropos(1)、whatis(1) 以及 man(1) –f、–k 和 –K 选项使用的索引文件。如果未指定 MANPATH 或 –M 选项，则缺省情况下会在 /usr/share/man/ 和 /usr/gnu/share/man/ 目录中创建索引文件。不会执行手册重新格式化。
更新位于指定 directory （缺省情况下为 /usr/share/man）中的手册页。如果指定了 –M 选项，则目录参数不能包含 `,'（逗号），因为逗号用于分隔节编号。请参见 man(1)。
使用 macro-package 来替代标准手册页宏（缺省情况下为 man(5)）。
支持下列操作数：
如果有一个不以 `−' 开头的参数，则将其作为要由 catman 处理的手册节的空格分隔列表。如果指定了此操作数，则仅处理列表中的手册节。例如，
catman 1 2 3
仅更新手册节 1、2 和 3。如果未列出特定节，则处理由环境变量 MANPATH 指定的 man 目录中的所有节。
指定 –t 标志时要使用的格式化程序的名称。如果未设置，将使用 troff(1)。
供 catman 和 man(1) 处理的目录的冒号分隔列表。每个目录后面可以跟有节的逗号分隔列表。如果设置，则其值将覆盖作为缺省目录搜索路径的 /usr/share/man，以及作为缺省节搜索路径的 man.cf 文件。–M 和 –s 标志反过来会覆盖这些值。
以下命令在 /usr/local/share/man 目录中创建索引文件。
# catman -M /usr/local/share/man -w
缺省手册目录位置
原始 nroff 输入文件
预格式化的 nroff 手册页
预格式化的 troff 手册页
缺省宏软件包
–K 查询的索引文件
有关下列属性的说明，请参见 attributes(5)：
|
apropos(1)、man(1)、nroff(1)、rm(1)、troff(1)、whatis(1)、attributes(5)、man(5)、sgml(5)
括号外的文件缺失，括号内的文件引用了缺失的文件。
catman 只允许使用 .so man?/xxx.? 模式引用相对于目录 /path/to/man 的文件名，或者使用更简短的 .so in xxx.? 模式引用位于同一子目录中的文件名。
一条无害的警告消息，指出 catman 通常查找的目录之一缺失。
一条无害的警告消息，指出 catman 遇到一个空目录。
如果先前运行 catman 安装 cat* 目录的用户升级操作系统，则应该在运行 catman 之前删除整个 cat* 目录结构。请参见 rm(1)。
不要重新运行 catman 以重建索引文件，除非存在完整的 man* 目录集。catman 基于 man* 目录构建索引文件。
windex 数据库已由索引文件取代。与 windex 不同，索引文件生成对可以编制索引的内容没有任何特定限制或先决条件。