「catman(1)」-

  LINUX MANUAL PAGES

创建或更新预格式化的手册页

命令语法格式

catman [-d?V] [-M path] [-C file] [section] …

命令描述

catman用于创建最新的预格式化手册页集合(称为Cat页面)。Cat页面通常比原手册页显示得快,但是需要额外的存储空间。若本地管理员决定加入Cat页面支持,他们必须提供合适的目录来保存这些页面。

在我们的系统(Kali GNU/Linux Rolling)中,执行catman命令后会为每个手册页生成对应Cat页面,Cat页面保存在/var/cache/man/cat<n>,其中<n>为章节号(通常为1-9的数字)。每个手册的Cat页面都保存在对应的章节导的Cat<n>目录中,手册页面使用的gzip进行了压缩,解压查看手册的内容,你会发现它是普通文本格式,区别于/usr/share/man中对应的手册页面(使用gzip -d解压查看),/usr/share/man中的手册是nroff源文件。关于这一点可以参考man(1)的-W和-w选项。

catman的可用选项为要预格式化的手册页层次结构和章节。默认的层次结构是那些在man-db配置文件中指定的系统层次结构,默认章节是环境变量$MANSECT中以冒号分隔的内容或编译进man的标准集合(如果未定义$MANSECT)。给 catman 提供一组空格分隔的章节名会覆盖以上两个选项。

catman利用与每个层次结构关联的索引数据库缓存来确定需要格式化哪些文件。

命令支持的选项及含义

-d, –debug
打印调试信息。

-M path, –manpath=path
指定替代的手册页层次结构搜索路径,以冒号分隔。默认情况下,这是man-db配置文件中指定的所有系统层次结构。

-C file, –config-file=file
使用配置文件file代替默认的~/.manpath

-?, –help
打印帮助消息并退出。

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

-V, –version
显示版本信息。

环境变量

MANSECT
如果设置了$MANSECT,它的值(以冒号分隔的章节列表)会用于确定搜索哪些章节及搜索顺序。默认值为“1 n l 8 3 2 3posix 3pm 3perl 3am 5 4 9 6 7”,除非被/etc/manpath.config中的SECTION指令覆盖。

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

相关文件

/etc/manpath.config
man-db配置文件。

/usr/man/index.(bt|db|dir|pag)
传统的全局索引数据库缓存。

/var/catman/index.(bt|db|dir|pag)
替代的或FSSTND兼容的全局索引数据库缓存。

相关手册

man(1), manpath(5), mandb(8)

参考文献

  • man 8 catman, version 2.7.6.1

更新日志

  • 07/29/2017 创建文章