名称

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

概述

catman [-d?V] [-M 路径] [-C 文件] [ 章节] ...

描述

catman 用于创建最新的预格式化手册页集合(称为 cat 页面)。Cat 页面通常比原手册页显示得快。若本地管理员决定加入 cat 页面支持,他们必须提供合适的目录来保存这些页面。
 
catman 的可用选项为要预格式化的手册页层次结构和章节。默认的层次结构是那些在 man-db 配置文件中指定的系统层次结构,默认章节是环境变量 $ MANSECT 中以冒号分隔的内容或编译进 man 的标准集合(如果未定义 $ MANSECT)。给 catman 提供一组空格分隔的章节名会覆盖以上两个选项。
 
catman 利用与每个层次结构关联的 索引 数据库缓存来确定需要格式化哪些文件。

选项

-d, --debug
打印调试信息。
-M 路径--manpath=路径
指定替代的手册页层次结构搜索路径,以冒号分隔。默认情况下,这是 man-db 配置文件中指定的所有系统层次结构。
-C 文件--config-file=文件
使用此用户配置文件代替默认的 ~/.manpath
-?, --help
打印帮助消息并退出。
--usage
打印简短的帮助消息并退出。
-V, --version
显示版本信息。

环境

MANSECT
如果设置了 $MANSECT,它的值(以冒号分隔的章节列表)会用于确定搜索哪些章节及搜索顺序。默认值为“1 n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7”,除非被 /etc/manpath.config 中的 SECTION 指令覆盖。
MANPATH
如果设置了 $MANPATH 环境变量,它的值将被解释为要使用的,以冒号分隔的手册页层次结构搜索路径。 请参考 manpath(5) 中的搜索路径一节以了解默认行为以及处理该环境变量的细节。

文件

/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)

作者

Wilf. ([email protected]).
Fabrizio Polacco ([email protected]).
Colin Watson ([email protected]).

BUGS

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

Recommended readings

Pages related to catman you should read also: