如何使用 Vim 的 help

女爷i 2022-06-15 10:13 153阅读 0赞

实际上，无论是 Vim 的基础知识还是进阶知识，大都可以从 help 中找到指引。但是我想很多人并没有意识到这一点，或者并没有重视这一点。[RTFM][] (read the fucking manual) 是学习的一个很好的途径，至少对于 Vim 而言，help 是一个绝佳的资源。

#### Vim 的 help 在哪里 ####

Vim 在 GitHub 托管的仓库下 [vim/runtime/doc][vim_runtime_doc]

![GitHub Vim doc][]

在本地 Vim 目录下，比如 mac 下使用 brew 安装的位置如下：

![local Vim doc][]

这里所有的 txt 文件就构成了 Vim 自带的 help , 每个 txt 文件都可在 Vim 中使用 `:help` 直接打开 (`:h txt文件名`, 比如 `:h autocmd.txt`)。最好是在使用 Vim 打开，因为会有语法高亮，使用其他途径查看 txt 文件很可能没有任何样式而过于单调。

#### 如何使用 help ####

`:h help<Enter>` 或者 `:h<Enter>` (等同于 `:h` 是 `:help` 的缩写, 再按下回车键) 打开 help.txt:

![help][]

`:h` 实际打开的文件是 [help.txt][]。 能够写在开头想必是非常重要的 “知识点”， 来仔细看一下 help.txt 有些什么:

> Move around:  
> Close this window:  
> Get out of Vim:

果然，第一点就是 hjkl, 上下左右移动，即使那些没有用过 Vim 的人， 我想要也有很多知道 hjkl 在 Vim 中就是 “方向键”。其次就是如何退出 Vim, 这也相当重要，毕竟 [stackoverflow 已经帮助一百万开发者退出 Vim 了][stackoverflow _ Vim] . `:q<Enter>` 等同于 `:quit<Enter>`, `:` 是指按下键盘上 L 键旁边的 : 键 (注意输入法要处于英文输入状态)进入命令模式 (command mode), 然后输入 q, 再按下回车就退出 Vim 了。

> Get specific help

通过给 `:help` 传递参数来获取指定的帮助内容，比如 `:help x` 就显示 Normal mode command 的相关内容。这里就是重点了, 我怎么知道要给 help 指定哪些参数？先别着急， 虽然 Vim 的 help 内容繁多，幸而 Vim 已经做了一些整理:

`:h doc-file-list`，大概分为 3 部分：

![doc-file-list][]

*  `BASIC`  
    tutor 就在这个部分, `:h tutor` 也是很多人推荐的入门方式。上图中红色圈中的部分，都是 help 的一个索引，可以作为 help 的参数跳转到指定的 help 内容.
 *  `USER MANUAL`
    
     *  `Getting Started`
     *  `Editing Effectively`
     *  `Tuning Vim`
     *  `Making Vim Run`  
        涉及基本的移动，编辑，设置等等，内容很多就不展开了，每个索引后面都有一个简短的介绍。
 *  `REFERENCE MANUAL`
    
    这部分适合有一定基础的用户，涉及了 Vim 的很多特性。

至此，先对 Vim 的 help 有个粗略的认识，如果要想了解一些 “有用” 的内容，还需在使用中时常查阅 help 才能真正有所收获。当然了，无聊时也可以当做是 “休闲读物”。接下来我会结合 Vim 的 help 介绍一下 [space-vim][] 的一些配置，欢迎关注。  
2

[RTFM]: https://en.wikipedia.org/wiki/RTFM
[vim_runtime_doc]: https://github.com/vim/vim/tree/master/runtime/doc
[GitHub Vim doc]: /images/20220615/fe4482eea5ab40778470392fdfec2390.png
[local Vim doc]: /images/20220615/c7c0b3c270864ba1a4fb79dbc001ea5f.png
[help]: /images/20220615/3be392aad2bb4e8c81e118fdb48439df.png
[help.txt]: https://github.com/vim/vim/blob/master/runtime/doc/help.txt
[stackoverflow _ Vim]: https://stackoverflow.blog/2017/05/23/stack-overflow-helping-one-million-developers-exit-vim/
[doc-file-list]: /images/20220615/17931a5eb8f1496da31597d585cb0475.png
[space-vim]: https://github.com/liuchengxu/space-vim