catman 命令

用途

创建用于手册的 cat 文件。

语法

卡特曼 [ -n | -p | -w ] [ -M 路径 ] [ 部分 ... ]

描述

catman 命令从 nroff 命令输入文件创建联机手册的预格式化版本。 catman 命令检查手册每一页并重新创建那些其预格式化版本丢失或过期的页面。 如果作了任何更改,catman 命令会重新创建命令 whatis 数据库。

标志

描述
-M 路径 更新位于由 Path 变量指定的目录集(缺省情况下为 /usr/share/man 目录)中的手册页面。Path 变量具有以冒号(:)来分隔目录名列表的形式。 例如:
'/usr/local/man:/usr/share/man'

如果设置了环境变量 MANPATH,它的值用于缺省路径。 如果 nroff 命令源文件包含如下的行:

' .so manx/yyy.x'

catx 目录中将产生连接至相应预格式化手册页面的符号链接。 这样就可使用 rdist 命令来使得预格式化手册页面非常容易地分布在相关的机器组中。

nroff 命令源无需被分布至所有机器,这样就能节省相关的磁盘空间。

例如,拥有五台机器(称作 mach1 到 mach5)的本地网络中的 mach3 具有手册页 nroff 命令源。 每天夜间,mach3 通过使用 cron 守护程序来运行 catman 命令并稍后使用同以下内容相似的 distfile 文件来运行 rdist 命令:

MANSLAVES = (mach1 mach2 mach4 mach5)
MANUALS = (/usr/share/man/cat[1-8no] /usr/share/man/whatis)
${MANUALS}    ->    ${MANSLAVES}
install -R;
notify root;
-n 防止 whatis 命令数据库的创建。
-p 打印需要重新创建或更新的手册页面名称,但又不对它们进行重新创建或更新操作。
-w 读取 /usr/share/man/cat?/*.* 中的 Berkeley Software Distribution (BSD) 样式手动页面 和 /usr/share/man/man?/*.* 文件,然后读取超文本信息库并创建 /usr/share/man/whatis 数据库。

技巧:如果在系统上安装了库 EN_US 文档文件集,那么将 ilocale 设置为 en_US 以构建完整的 whatis 数据库。

示例

要只对手册的 1、2 和 3 节进行更新,请输入:

catman 123

文件

描述
/usr/lbin/getNAME 包含创建 whatis 数据库的命令。
/usr/share/man 指定缺省的手册目录位置。
/usr/share/man/man?/*.* 包含原始的( nroff 命令输入)手册章节。
/usr/share/man/cat?/*.* 包含预格式化手册页面。
/usr/share/man/whatis 包含 whatis 命令数据库。
/usr/lbin/mkwhatis 包含用于构建 whatis 命令数据库的命令脚本。