「manpath(1)」-

  LINUX MANUAL PAGES

确定手册页的搜索路径

命令语法格式

manpath [-qgdc?V] [-m system[,…]] [-C file]

命令描述

如果设置了$MANPATH,manpath只会显示$MANPATH内容并显示一条警告。如果未设置,manpath会确定一个合适的手册页层次结构搜索路径并显示这个结果。

manpath会使用man-db的配置文件(/etc/manpath.config)和用户环境变量所得到的信息来确定最终输出的搜索路径(一个以冒号分隔的路径)。

命令行选项及含义

-q, –quiet
不显示警告。

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

-c, –catpath
生成针对manpath的catpath。一旦确定了manpath,它会将每个路径元素将转换为它的相对catpath。

-g, –global
在man-db配置文件中生成一个名为“global”的且包含所有路径的manpath。

-m system[,…], –systems=system[,…]
如果此系统可以访问其他操作系统的手册页层次结构,可以使用此选项将它们包含在manpath的输出中。要包含NewOS的手册页层次结构,使用-m NewOS选项。

指定的system选项可以是逗号分隔的操作系统名称组合。要包括本地操作系统的手册页层次结构,可以在参数字符串中包含系统名man。此选项会覆盖$SYSTEM环境变量

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

其他选项

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

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

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

相关的环境变量

MANPATH
如果设置了$MANPATH,manpath显示它的值,而不是在运行时确定它。如果$MANPATH前缀是冒号,则变量的值会追加到从配置文件内容确定的值的之后。如果冒号在变量值的结尾,则确定的列表会追加到变量内容之后。如果变量的值包含双冒号(::),则确定的列表会插入值的中间(两个冒号间)。

SYSTEM
如果设置了$SYSTEM,等价于将值指定为-m选项的参数,二者具有相同的效果。

相关配置文件

/etc/manpath.config
man-db的配置文件。man 5 manpath中描述了配置文件的格式。

参考文献

  • man 1 manpath
  • man 5 manpath

更新日志

  • 06/14/2017 创建文章
  • 05/27/2018 更新文章内容