添加帮助文档到man搜索路径

man命令时Linux/Mac平台下一个强大的帮助文档查看命令。当我们学习一个新的框架或知识时,最好的资料可能就是帮助文档了。那么怎样使用man命令查看这些帮助文档呢? 其实很简单,仅仅三步操作就可实现。

安装文档生成工具

1
$ brew install yelp-tools yelp-xsl

生成文档

1
2
$ ./configure --enable-man-pages
$ make man

添加路径

打开/private/etc/man.conf文件(作者的OS为MAC, Linux的路径可能为/etc/man.conf), 定位到MANPATH的位置:

1
2
3
MANPATH	/usr/share/man
MANPATH /usr/local/share/man
MANPATH /usr/X11/man

添加你的文档路径:

1
2
3
4
MANPATH	/usr/share/man
MANPATH /usr/local/share/man
MANPATH /usr/X11/man
MANPATH 你的文档目录的绝对路径

添加路径后,保存退出,然后使用man命令就可以查看你的文档了。

注意

如果使用man命令找不到文档,进入你的man文档目录,查看函数的等级,如果为库函数,其后缀都为.3,具体视情况而定。然后将你的man目录重命名为man3(里面的文档后缀为几就改为man几),并将man3目录剪切到新建的man目录。再次使用man命令,发现可以查看文档了。

,