对于在Unix/Linux系统下进行系统程序或者应用程序编程的程序猿来说,应该都很熟悉Vim和man。Vim作为强大的文本编辑器一直受到广大Unix/Linux系统程序猿的热爱;man作为Unix/Linux系统接口的在线帮助文档查看器,也是平时使用频率很高的工具。
不知道,你是否遇到过如下的烦恼:在使用一个系统接口时,对于该接口的一些特性不是很清楚,需要使用man来查看一下。你是否需要从当前程序编辑终端切换到另一个终端,然后使用man API来查看该API的手册呢?
本文通过vim-man插件配合vim的快捷键来实现API的快速查询,让我们开始实现吧!
vim-man
vim-man作为一款用于Vim使用man的插件,解决了我们在不能在Vim里使用man的问题。我们可以通过如下命令:Man/Vman + API 的方式查询API手册,而且vim-man还支持grep模式,可以更好、更快的实现API相关手册的查询功能。
vim-man的项目位于GitHub,基于Vim的Vundle安装vim-man十分的方便,只需要在~/.vimrc的Vundle配置中添加如下代码:
`Plugin 'vim-utils/vim-man'`
然后,重启Vim,执行如下命令:
:`VundleInstall`
vim-man就会自动进行安装配置了。关于Vundle的使用方式,可以参考这里。vim-man的使用也十分的方便,:Man + API就可以在vim的命令模式下查询相关API的手册,并横屏显示,Vman会将手册竖屏显示。
vim-man 快捷键
vim-man插件安装成功之后,我们可以在~/.vimrc中为其增加快捷键,这是我增加的快捷键:
nmap m :Man <C-R>=expand("<cword>")<CR><CR>
nmap vm :Vman <C-R>=expand("<cword>")<CR><CR>
在Vim的普通模式下,将光标定位到需要查询的API上,例如(pthread_create),按下m键横屏显示man手册,按vm键竖屏显示man手册,是不是很方便!关于Vim快捷键的使用方式可以参考。
Enjoy It!