Linux/Unix:从本地目录读取手册页

时间:2020-01-09 10:40:36  来源:igfitidea点击:

如何读取$HOME/foo.1手册页文件?
如何使用man命令读取名为~/foo.1的文件作为联机帮助页?

troff是AT&T为Unix操作系统开发的文档处理系统。

troff排版系统包括称为宏的命令集,这些命令在开始处理文档之前运行。

这些宏包括设置页面页眉和页脚,定义新命令以及通常影响输出格式的方式。
在Linux下,应使用groff an.tmac软件包标记所有新的手册页。

groff(GNU troff)软件是一个排版程序包,可读取混合了格式命令的纯文本并生成格式化的输出。

选项#1:使用man命令

语法为:

man ./file-name
man $HOME/foo.1
man ~/foo.1
man /path/to/foo.1
man /path/to/your-man-page-here

选项2:使用nroff命令

nroff脚本使用groff模拟nroff命令,语法为:

nroff -man  foo.1
nroff -man  $HOME/foo.1
nroff -man  /path/to/foo.1
nroff -man  /path/to/your-man-page-here

选项#3:设置MANPATH Shell变量

man命令搜索环境变量MANPATH。
它是冒号分隔的目录列表,例如手册页的PATH变量。
要查看当前的手册页路径,请运行:

$ manpath

输出示例:

/usr/local/share/man:/usr/share/man/overrides:/usr/share/man/en:/usr/share/man

man命令基于调用选项和环境变量,/etc/man.config配置文件以及一些内置的约定和启发式方法,使用一种复杂的方法来查找手册页文件。
如果设置了MANPATH,man将使用它作为搜索手册页文件的路径。
它覆盖配置文件和自动搜索路径,但被-M调用选项覆盖。

例子

输入以下命令

$ export MANPATH="$(manpath):/path/to/your/man1/"
$ man 1 foo