翻译用法章节

This commit is contained in:
郭金章 2017-03-27 17:55:42 +08:00
parent 2a92dd80b4
commit 0a5d19c858

578
chapter/Usage.md Normal file
View File

@ -0,0 +1,578 @@
## 用法
### 获取离线帮助
Vim自带了一个非常棒的用特殊格式排版的单文本文件的文档。Vim采用基于标签的系统来访问这些帮助文件的特定部分。
首先,读一下这个章节: `:help :help`。执行这个命令以后会在新窗口打开 `$VIMRUNTIME/doc/helphelp.txt` 文件并跳转到这个文件中 `:help` 标签的位置。
一些简化的技巧:
* 用单引号把文本包起来表示选项,如 `:h 'textwidth'`
* 以小括号结尾表示VimL函数`:h reverse()`
* 以冒号开头表示命令,如: `:h :echo`
可以使用 `<c-d>` (这是<kbd>ctrl</kbd>+<kbd>d</kbd>) 来列出所有匹配你当前输入的内容的帮助标签。如:`:h tab<c-d>` 会显示所有与 `tab` 相关的标签,从 `softtabstop``setting-guitablabel`
你想查看所有的VimL方法吗很简单只要输入`:h ()<c-d>`。你想查看所有与窗口相关的VimL函数输入 `:h win*()<c-d>`
这很快就能成功你的第二天性,但是在刚开始的时候,你可能对于你要查找的标签一点线索都没有。这时你可以想象一些相关的关键字,再用 `:helpgrep` 来救场。
```
:helpgrep backwards
```
这个命令会在所有的文档文件中搜索“backwards”然后跳转到第一个匹配的位置。所有的匹配位置会被只在到快速修复列表当中。用 `:cn / :cp` 来转到下一个/上一个匹配位置。或者使用 `:copen` 来打开快速修复窗口,用光标定位到某条记录,再按 `<cr>` 来跳转到该匹配项。详细说明请参考 `:h quickfix`
### 获取离线帮助(另一种方式)
这个列表是由@chrisbra编辑的他是Vim开发人员中最活跃的一个最初发表在[vim_dev](https://groups.google.com/forum/#!forum/vim_dev)。
经过一些微小的改动后,重新发布到了这里。
---
如果你知道你想要找什么,通常使用帮助系统搜索更简单一些,因为搜索的主题都带有固定的格式。
并且帮助系统中的主题包含了你当前使用的Vim版本所特有的功能而那些已经过时的帖子或者是后来发布的帖子是不会包含这些的。
因此学习使用帮助系统以及它所用的语言是很有必要的。这里是一些例子(不一定全,我有可能忘了一些什么)。
(译者注:下面介绍的都是如何快速的定位你想要的不同类型的帮助文档)
1. 选项用单引号引起来。你可以使用 `:h 'list'` 来跳转到列表选项。只有当你明确的了解你要找这么一个选项的时候才可以这么做,当然你也可以用 `:h options.txt` 来打开所有选项的帮助页,再用表达式进行搜索,如:`/width`。某些选项有它们自己的命名空间,如: `:h cpo-a``:h cpo-A` `:h cpo-b`等等。
2. 普通模式的命令不必用冒号作为前缀。使用 `:h gt` 来转到“gt”命令的帮助页面。
3. 正则表达式以“/”开头,所以 `:h /\+` 会带你到正则表达式中量词“+”的帮助页面。
4. 组合键经常以一个字母开头表示它们可以在哪些模式中使用。如:`:h i_CTRL-X` 会带你到插入模式下的 CTRL-X 命令的用法帮助页面这是一个自动完成类的组合键。需要注意的是某些键是有固定写法的如Control键写成CTRL。还有查找普通模式下的组合键帮助时可以省略开头的字母“n”如: `:h CTRL-A`。而 `:h c_CTRL-A`(译者注:原文为`:h c_CRTL-R`感觉改为A更符合上下文语境会解释CTRL-A在命令模式下输入命令时的作用`:h v_CTRL-A`说的是在可见模式下把光标所在处的数字加1`:h g_CTRL-A`则说的是g命令你需要先按"g"的命令)。这里的"g"代表一个普通的命令,这个命令总是与其它的按键组合使用才生效,与"z"开始的命令相似。
5. 寄存器是以"quote"开头的。如: `:h quote:` (译者注:原文为`:h quote`,感觉作者想以":"来举例)来查看关于":"寄存器的说明。
6. Vim脚本VimL的帮助都在 `:h eval.txt` 里。而某些方面的语言可以使用 `:h expr-X` 获取帮助,其中的'X'是一个特定的字符,如: `:h expr-!` 会跳转到描述VimL中'!'(非)的章节。另外一个重要提示,可以使用 `:h function-list` 来查看所有函数的简要描述,列表中包括函数名和一句话描述。
7. 关于映射都可以在 `:h map.txt` 中找到。通过 `:h mapmode-i` 来查找 `:imap` 命令;通过 `:h map-topic`来查找关于映射的topic译者注topic为一个占位符正如上面的字符'X'一样,在实际使用中需要替换成相应的单词)(如:`:h :map-local` 查询本地buffer的映射`:h map-bar`查询如何在映射中处理'|')。
8. 命令定义用"command-"开头,如用 `:h command-bar` 来查看自定义命令中'!'的作用。
9. 窗口管理类的命令是以"CTRL-W"开头的,所以你可以用 `:h CTRL-W_*` 来查找相应的帮助(译者注:'*'同样为占位符)(如: `:h CTRL-W_p` 查看切换到之前访问的窗口命令的解释)。如果你想找窗口处理的命令,还可以通过访问 `:h windows.txt` 并逐行向下浏览,所有窗口管理的命令都在这里了。
10. 执行类的命令以":"开头,即:`:h :s`讲的是":s"命令。
11. 在输入某个话题时按 CTRL-D让Vim来帮你填写剩下的部分或者列出所有的匹配项辅助你输入。
12. 用 `:helpgrep` 在所有的帮助页面(通常还包括了已安装的插件的帮助页面)中进行搜索。参考 `:h :helpgrep` 来了解如何使用。当你搜索了一个话题之后,所有的匹配结果都被保存到了快速修复窗口(或位置窗口)当中,可以通过 `:copen``:lopen` 打开。在打开的窗口中可能通过 `/` 对匹配项进行进一步的过滤。
13. `:h helphelp` 里介绍了如何使用帮助系统。
14. 用户手册。它采用了一种对初学者更加友好的方式来展示帮助话题。用 `:h usr_toc.txt` 打开内容目录你可能已经猜到这个命令的用处了。浏览用户手册能帮助你找出某些你想了解的话题如你可以在第24章看到关于“复合字符”以及“输入特殊字符”的讲解`:h usr_24.txt`可以快速打开相关章节)。
15. 高亮分组的帮助以 `hl-` 开头。如: `:h hl-WarningMsg` 说的是警告信息分组的高亮。
16. 语法高亮以`:syc-`开头,如:`:h :syn-conceal` 讲的是 `:syn` 命令的对于隐藏字符是如何显示的。
17. 快速修复命令以 `:c` 开头,而位置列表命令以 `:l`开头。
18. `:h BufWinLeave` 讲的是 BufWinLeave 自动命令。还有, `:h autocommand-events` (译者注:原文是`:h autocommands-events`,但是该没有该帮助)讲的是所有可用的事件。
19. 启动参数都以"-"开头,如:`:h -f` 会告诉你 Vim "-f" 参数的作用。
20. 额外的特性都以"+"开头,如:`:h +conceal`讲的是关于隐藏字符的支持。
21. 错误代码可以在帮助系统中直接查到。`:h E297`会带你到关于这一错误的详细解释。但是有时并没有转到错误描述而是列出了经常导出这一错误的Vim命令`:h E128` (译者注:原文为`:h hE128`,但是并没有该帮助)会直接跳转到 `:function` 命令。
22. 关于包含的语法文件的文档的帮助格式是 `:h ft-*-syntax`。如:`:h ft-c-syntax`说的就是C语言语法文件以及它所提供的选项。有的语法文件还会带有自动完成`:h ft-php-omni`)或文件类型插件(`:h ft-tex-plugin`)相关的章节可以查看。
另外在每个帮助页的顶端通常会包含一个用户文档(更多的从从用户的角度出发,减少细节的描述一些命令)链接。如:`:h pattern.txt` 里包含了 `:h 03.9``:h usr_27`两个章节的链接。
### 获取在线帮助
如果你遇到了无法解决的问题,或者需要指引的话,可以参考[Vim使用](https://groups.google.com/forum/#!forum/vim_use)邮件列表。[IRC](https://de.wikipedia.org/wiki/Internet_Relay_Chat)也是一个很不错的资源。[Freenode](https://freenode.net/)上的 `#vim` 频道很庞大,并且里面都是乐于助人的人。
如果你想给Vim提交Bug的话可以使用[vim_dev](https://groups.google.com/forum/#!forum/vim_dev)邮件列表。
### 执行自动命令
你可以触发任何事件,如:`:doautocmd BufRead`
#### 用户自定义事件
对于插件而言,创建你自己的“用户”事件有时非常有用。
```vim
function! Chibby()
" A lot of stuff is happening here.
" And at last..
doautocmd User ChibbyExit
endfunction
```
现在你插件的用户可以在Chibby执行完成之后做任何他想做的事情
```vim
autocmd User ChibbyExit call ChibbyCleanup()
```
顺便提一句,如果在使用 `:autocmd``:doautocmd` 时没有捕捉异常,那么会输出 "No matching autocommands" 信息。这也是为什么许多插件用 `silent doautocmd ...` 的原因。但是这也会有不足,那就是你不能再在 :autocmd 中使用 `echo "foo"` 了,取而代之的是你要使用 `unsilent echo "foo"`来输出。
这就是为什么要在触发事件之前先判断事件是否存在的原因,
```vim
if exists('#User#ChibbyExit')
doautocmd User ChibbyExit
endif
```
帮助文档:`:h User`
#### 嵌套的自动命令
默认情况下,自动命令并不会嵌套!如果某个自动命令执行了一个命令,这个命令再依次触发其它的事件,这是不可能的。
例如你想在每次启动Vim的时候自动打开你的 vimrc 文件:
```vim
autocmd VimEnter * edit $MYVIMRC
```
当你启动Vim的时候它会帮你打开你的 vimrc 文件,但是你很快会注意到这个文件没有任何的高亮,尽管平时它是正常可以高亮的。
问题在于你的非嵌套自动命令 `:edit` 不会触发“BufRead”事件所以并不会把文件类型设置成“vim”进而 `$VIMRUNTIME/syntax/vim.vim` 永远不会被引入。详细信息请参考:`:au BufRead *.vim`。要想完成上面所说的需求,使用下面这个命令:
```vim
autocmd VimEnter * nested edit $MYVIMRC
```
帮助文档:`:h autocmd-nested`
### 剪贴板
如果你想在没有GUI支持的Unix系统中使用Vim的 `'clipboard`选项,则需要[特性](#what-kind-of-vim-am-i-running)支持: `+clipboard` 以及可选的 `+xterm_clipboard`
帮助文档:
```
:h 'clipboard'
:h gui-clipboard
:h gui-selections
```
另外请参考:[持续粘贴(为什么我每次都要设置'paste'模式](#bracketed-paste-or-why-do-i-have-to-set-paste-all-the-time)
#### 剪贴板的使用(Windows, OSX)
Windows 自带了[剪贴板](https://msdn.microsoft.com/en-us/library/windows/desktop/ms649012(v=vs.85).aspx)OSX带了一个[粘贴板](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/PasteboardGuide106/Introduction/Introduction.html#//apple_ref/doc/uid/TP40008100-SW1)
这两者都以大家期望的模式进行工作,用 `ctrl+c / cmd+c` 复制选择的文本,然后在另外一个应用中用 `ctrl+v / cmd+v` 进行粘贴。
需要注意的是复制的文本已经被发送到了剪贴板,所以你在把从某个应用中复制的文本粘贴到其它的程序之前关闭这个应用是没有任何问题的。
每次复制的时候,都会向剪贴板寄存器 `*` 中写入数据。 而在Vim中分别使用 `"*y``"*p` 来进行复制yank) 和 粘贴paste)。
如果你不想每次操作都要指定 `*` 寄存器可以在你的vimrc中添加如下配置
```vim
set clipboard=unnamed
```
通常情况下复制/删除/放入操作会往 `"` 寄存器中写入数据,而加上了上面的配置之后 `*` 寄存器也会被写入同样数据,因此简单的使用 `y``p` 就可以复制粘贴了。
我再说一遍:使用上面的选项意味着每一次的复制/粘贴即使在同一个Vim窗口里都会修改剪贴板的内容。你自己决定上面的选项是否适合。
如果你觉得输入 `y` 还是太麻烦的话,可以使用下面的设置把在可视模式下选择的内容发送到剪贴板:
```vim
set clipboard=unnamed,autoselect
set guioptions+=a
```
帮助文档:
```
:h clipboard-unnamed
:h autoselect
:h 'go_a'
```
#### 剪贴板的使用(Linux, BSD)
如果你的系统使用了[X图形界面](http://www.x.org/wiki)事情会变得有一点不同。X图形界面实现了[X窗口系统协议](http://www.x.org/releases/X11R7.7/doc/xproto/x11protocol.html), 这个协议在1987年发布的主版本11因此X也通常被称为 X11。
在X10版本中[剪贴缓冲区](http://www.x.org/releases/X11R7.7/doc/xorg-docs/icccm/icccm.html#Peer_to_Peer_Communication_by_Means_of_Cut_Buffers)被用来实现像 _clipboard_ 一样由X来复制文本并且可以被所有的程序访问。现在这个机制在X中还存在但是已经过时了很多程序已经不再使用这一机制。
近年来数据在程序之前传递是通过[选择](http://www.x.org/releases/X11R7.7/doc/xorg-docs/icccm/icccm.html#Peer_to_Peer_Communication_by_Means_of_Selections)进行的。一共定义了三种选择经常用到的有两种PRIMARY 和 CLIPBOARD。
选择的工作工模大致是这样的:
```
Program A: <ctrl+c>
Program A: 声称对 CLIPBOARD 的所有权
Program B<ctrl+v>
Program B: 发现CLIPBOARD的所有权被Program A持有
Program B从Program A请求数据
Program A响应这个请求并发送数据给Program B
Program B从Program A接收数据并插入到窗口中
```
| 选择 | 何时使用 | 如何粘贴 | 如何在Vim中访问 |
|--------|-------------------|-------------------|--------------------|
| PRIMARY | 选择文本 | 鼠标中键, shift+insert | `*` 寄存器 |
| CLIPBOARD | 选择文本并按 `ctrl+c` | `ctrl+v` | `+`寄存器 |
**注意**: X服务器并不会保存选择不仅仅是CLIPBOARD选择因此在关闭了相应的程序后你用 `ctrl+c` 复制的内容将丢失。
使用 `"*p` 来贴粘 PRIMARY 选择中的内容,或者使用 `"+y1G` 来将整个文件的内容复制到CLIPBOARD选择。
如果你需要经常访问这两个寄存器,可以考虑使用如下配置:
```vim
set clipboard^=unnamed " * 寄存器
" 或者
set clipboard^=unnamedplus " + 寄存器
```
`^=` 用来将设置的值加到默认值之前,详见: `:h :set^=`
这会使得所有复制/删除/放入操作使用 `*``+` 寄存器代替默认的未命令寄存器 `"`。之后你就可以直接使用`y``p`访问你的X选择了。
帮助文档:
```
:h clipboard-unnamed
:h clipboard-unnamedplus
```
### 打开文件时恢复光标位置
如果没有这个设置,每次打开文件时都光标都将定位在第一行。而加入了这个设置以后,你就可以恢复到上次关闭文件时光标所在的位置了。
将下面的配置添加到你的vimrc文件
```vim
autocmd BufReadPost *
\ if line("'\"") > 1 && line("'\"") <= line("$") |
\ exe "normal! g`\"" |
\ endif
```
这只是简单的判断位置是否存在(文件可能由于其它程序修改的原因而导致所记录的位置已经超过实际行数了),如果存在的话就执行 ``g`"`` (转到你离开时的光标位置但是不更改跳转列表)。
这需要使用 viminfo 文件: `:h viminfo-`
### 备份文件, 交换文件, 撤销文件以及viminfo文件的处理
根据选项的不同Vim最多会创建4种工作文件。
**备份文件**:
你可以让Vim在将修改写入到文件之前先备份原文件。默认情况下Vim会保存一个备份文件但是当修改写入成功后会立即删除这个备份`:set writebackup`)。如果你想让这个备份文件一直存在的话,可以使用 `:set backup`。而如果你想禁用备份,可以使用 `:set nobackup nowritebackup`
我们来看一下我上次在自己的vimrc中加了什么
```
$ diff ~/.vim/vimrc ~/.vim/files/backup/vimrc-vimbackup
390d389
< command! -bar -nargs=* -complete=help H helpgrep <args>
```
帮助文档: `:h backup`
**交换文件**:
假设你有一个非常棒的科幻小说的构思。在按照故事情节写了好几个小时几十万字的时候..忽然停电了!而那时你想起来你上次保存你的 `~/来自外太空的邪恶入侵者.txt`是.. 好吧,你从来没有保存过。
但是并非没有希望了在编辑某个文件的时候Vim会创建一个交换文件这个文件里保存的是所有未保存的修改。自己试一下打开任意的文件并使用 `:swapname` 获得当前的交换文件的保存路径。你也可以将 `:set noswapfile` 加入到vimrc中以禁用交换文件。
默认情况下,交换文件会自动保存在源文件所在的目录下,文件名以`.file.swp`后缀结尾每当你更新了200个字符或是在之前4秒内没有任何动作时更新在你不再编辑这个文件的时候删除。你可以自己修改这些数字详见`:h 'updatecount'``:h 'updatetime'`
而在断电时,交换文件并不会被删除。当你再次打开 `vim ~/来自外太空的邪恶入侵者.txt`Vim会提示你恢复这个文件。
帮助文档:`:h swap-file``:h usr_11`
**撤销文件**:
[撤销树](#undo-tree)是保存在内存中的并且会在Vim退出时清空。如果你想让它持久化到磁盘中可以设置 `:set undofile`。这会把文件 `~/foo.c` 的撤销文件保存在 `~/foo.c.un~`
帮助文档: `:h 'undofile'``:h undo-persistence`
**viminfo文件**:
备份文件、交换文件和撤销文件都是与文本状态相关的而viminfo文件是用来保存在Vim退出时可能会丢失的其它的信息的。包括历史命令、搜索、输入、寄存器、标注、缓冲区列表、全局变量等等。
默认情况下viminfo被保存在 `~/.viminfo` 文件当中。
帮助文档:`:h viminfo``:h 'viminfo'`
---
如果你跟我一样,也喜欢把这些文件放到一个位置(如:`~/.vim/files`)的话:
```vim
set backup
set backupdir =$HOME/.vim/files/backup/
set backupext =-vimbackup
set backupskip =
set directory =$HOME/.vim/files/swap//
set updatecount =100
set undofile
set undodir =$HOME/.vim/files/undo/
set viminfo ='100,n$HOME/.vim/files/info/viminfo
```
目录 `~/.vim/files` 需要先自行创建否则Vim会报错。如果你经常在新环境下工作的话可以尝试让它自动完成
```vim
if exists('*mkdir') && !isdirectory($HOME.'/.vim/files')
call mkdir($HOME.'/.vim/files')
endif
```
注意如果你在一个多用户系统中编辑某个文件时Vim提示你交换文件已经存在的话可能是因为有其他的用户此时正在编辑这个文件。而如果你将交换文件放到自己的home目录的话将不再享有这个功能。
### 编辑远程文件
Vim自带的netrw插件支持对远程文件的编辑。实际上它将远程的文件通过scp复制到本地的临时文件用那个文件打开一个缓冲区然后在保存时把文件再写回远程。
这在你本地的配置与SSH远程服务器上管理理想让你使用的配置有冲突时尤其有用
```
:e scp://bram@awesome.site.com/.vimrc
```
如果你已经设置了 `~/.ssh/config`, 这个自动就会生效:
```
Host awesome
HostName awesome.site.com
Port 1234
User bram
```
假设你的 `~/.ssh/config` 中有以上的内容,那么下面的命令就可以正常执行了:
```
:e scp://awesome/.vimrc
```
可以用同样的方法编辑 `~/.netrc`, 详见:`:h netrc-netrc`
确保你已经读过了 `:h netrw-ssh-hack``:h g:netrw_ssh_cmd`
---
另外一种编辑远程文件的方法是使用[sshfs](https://wiki.archlinux.org/index.php/Sshfs),它会用[FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace)来挂载远程的文件系统到你本地的系统当中。
### 插件管理
[Pathogen](https://github.com/tpope/vim-pathogen)是第一个比较流行的插件管理工具。实际上它只是修改了 _runtimepath_ (`:h 'rtp'`) 来引入所有放到该目录下的文件。你需要自己克隆插件的代码仓库到那个目录。
真正的插件管理工具会在Vim中提供帮助你安装或更新插件的命令。在下文中是一些常用的插件管理工具
* [dein](https://github.com/Shougo/dein.vim)
* [plug](https://github.com/junegunn/vim-plug)
* [vim-addon-manager](https://github.com/MarcWeber/vim-addon-manager)
* [vundle](https://github.com/VundleVim/Vundle.vim)
### 多行编辑
这是一种可以同时输入多行连续文本的技术。参考这个[示例](https://raw.githubusercontent.com/mhinz/vim-galore/master/contents/images/content-block_insert.gif)。
`<c-v>` 切换到可视块模式。然后向下选中几行,按 `I``A` 译者注大写字母即shift+i 或 shift+a然后开始输入你想要输入的文本。
在刚开始的时候可能会有些迷惑,因为文本只出现在了当前编辑的行,只有在当前的插入动作结束后,之前选中的其它行才会出现插入的文本。
举一个简单的例子: `<c-v>3jItext<esc>`
如果你要编辑的行长度不同,但是你想在他们后面追加相同的内容的话,可以试一下这个: `<c-v>3j$Atext<esc>`
有时你可能需要把光标放到当前行末尾之后,默认情况下你是不可能做到的,但是可能通过设置 `virtualedit` 选项达到目的:
```
set virtualedit=all
```
设置之后 `$10l``90|` 都会生效,即使超过了行尾的长度。
详见 `:h blockwise-examples`。在开始的时候可能会觉得有些复杂,但是它很快就会成为你的第二天性的。
如果你想探索更有趣的事情,可以看看[多光标](https://github.com/terryma/vim-multiple-cursors)
### 使用外部程序和过滤器
免责声明Vim是单线程的因此在Vim中以前端线程执行其它的程序时会阻止其它的一切。当然你可以使用Vim程序接口如Lua并且使用它的多线程支持但是在那期间Vim的处理还是被阻止了。Neovim添加了任务 API 解决了此问题。
(据说 Bram 正在考虑在Vim中也添加任务控制。如果你使用了较新版本的的Vim可以看一下 `:helpgrep startjob`。)
使用 `:!` 启动一个新任务。如果你想列出当前工作目录下的所有文件,可以使用 `:!ls`。 用 `|` 来将结果通过管道重定向,如: `:!ls -l | ssort | tail -n5`
没有使用范围时,`:!` 会显示在一个可滚动的窗口中。相反的,如果指定了范围,这些行会被[过滤](https://en.wikipedia.org/wiki/Filter_(software))。这意味着它们会通过管道被重定向到过滤程序的[stdin](https://en.wikipedia.org/wiki/Standard_streams#Standard_input_.28stdin.29),在处理后再通过过滤器的[stdout](https://en.wikipedia.org/wiki/Standard_streams#Standard_output_.28stdout.29)输出。例如为接下来的5行文本添加行号可以使用
```
:.,+4!nl -ba -w1 -s' '
```
由于手动添加范围很麻烦Vim提供了一些辅助方法以方便的添加范围。如果需要一直带着范围的话你可以在可见模式中先选择然后再按 `:`。还可以使用 `!` 来采取一个动作,如 `!ip !sort` 可以将当前段落的行进行排序。
使用过滤比较好的一个案例是[Go语言](https://golang.org/)。它的缩进非常个性,甚至还提供了一个名为 `gofmt` 的过滤器来对Go语言的源文件进行正确的缩进。所以Go语言的插件通常会提供一个名为 `:Fmt` 的函数,这个函数只是执行了 `:%!gofmt` 来对整个文件进行缩进。
人们常用 `:r !prog` 将程序的输出放到当前文件的底端, 这对于脚本来说是很不错的选择,但是在使用的过程中,我发现 `!!ls` 更加方便,它会把输入放到当前行。
帮助文档:
```
:h filter
:h :read!
```
### Cscope
[Cscope](http://cscope.sourceforge.net/)的功能比[ctags](http://ctags.sourceforge.net/)要完善但是只支持C通过设置cscope.files后同样支持C++以及Java
鉴于Tag文件只是知道某个符号是在哪里定义的cscope的数据库里的数据信息就多的多了
* 符号是在哪里定义的?
* 符号是在哪里被使用的?
* 这个全局符号定义了什么?
* 这个变量是在哪里被赋值的?
* 这个函数在源文件的哪个位置?
* 哪些函数调用了这个函数?
* 这个函数调用了哪些函数?
* "out of space"消息是从哪来的?
* 在目录结构中当前的源文件在哪个位置?
* 哪些文件引用了这个头文件?
#### 1. 构建数据库
在你项目的根目录执行下面的命令:
```sh
$ cscope -bqR
```
这条命令会在当前目录下创建三个文件:`cscope{,.in,.po}.out` 。把它们想象成你的数据库。
不幸的时 `cscope` 默认只分析 `*.[c|h|y|l]` 文件。如果你想在Java项目中使用 cscope ,需要这样做:
```sh
$ find . -name "*.java" > cscope.files
$ cscope -bq
```
#### 2. 添加数据库
打开你新创建的数据库连接:
```vim
:cs add cscope.out
```
检查连接已经创建成功:
```vim
:cs show
```
(当然你可以添加多个连接。)
#### 3. 查询数据库
```vim
:cs find <kind> <query>
```
如: `:cs find d foo` 会列出 `foo(...)` 调用的所有函数。
| Kind | 说明 |
|------|-------------|
| s | **s**ymbol: 查找使用该符号的引用 |
| g | **g**lobal: 查找该全局符号的定义 |
| c | **c**alls: 查找调用当前方法的位置 |
| t | **t**ext: 查找出现该文本的位置 |
| e | **e**grep: 使用egrep搜索当前单词 |
| f | **f**ile: 打开文件名 |
| i | **i**ncludes: 查询引入了当前文件的文件 |
| d | **d**epends: 查找当前方法调用的方法 |
推荐一些比较方便的映射,如:
```vim
nnoremap <buffer> <leader>cs :cscope find s <c-r>=expand('<cword>')<cr><cr>
nnoremap <buffer> <leader>cg :cscope find g <c-r>=expand('<cword>')<cr><cr>
nnoremap <buffer> <leader>cc :cscope find c <c-r>=expand('<cword>')<cr><cr>
nnoremap <buffer> <leader>ct :cscope find t <c-r>=expand('<cword>')<cr><cr>
nnoremap <buffer> <leader>ce :cscope find e <c-r>=expand('<cword>')<cr><cr>
nnoremap <buffer> <leader>cf :cscope find f <c-r>=expand('<cfile>')<cr><cr>
nnoremap <buffer> <leader>ci :cscope find i ^<c-r>=expand('<cfile>')<cr>$<cr>
nnoremap <buffer> <leader>cd :cscope find d <c-r>=expand('<cword>')<cr><cr>
```
所以 `:tag` (或 `<c-]>`)跳转到标签定义的文件,而 `:cstag` 可以达到同样的目的,同时还会打开 cscope 的数据库连接。`'cscopetag'` 选项使得 `:tag` 命令自动的像 `:cstag` 一样工作。这在你已经使用了基于标签的映射时会非常方便。
帮助文档: `:h cscope`
### MatchIt
由于Vim是用C语言编写的因此许多功能都假设使用类似C语言的语法。默认情况下如果你的光标在 `{``#endif` , 就可以使用 `%` 跳转到与之匹配的 `}``#ifdef`
Vim自带了一个名为 matchit.vim 的插件,但是默认没有启用。它可以使得 `%` 在HTML相匹配的标签或 VimL 的 if/else/endif 块之间进行跳转,它还带来了一些新的命令。
##### 在Vim 8 中安装
```vim
" vimrc
packadd! matchit
```
##### 在Vim 7 或者更早的版本中安装
```vim
"vimrc
runtime macros/matchit.vim
```
由于matchit的文档很全面我建议安装以后执行一次下面的命令
```vim
:!mkdir -p ~/.vim/doc
:!cp $VIMRUNTIME/macros/matchit.vim ~/.vim/doc
:helptags ~/.vim/doc
```
##### 简短的介绍
至此这个插件已经可以使用了。 参考 `:h matchit-intro` 来获得支持的命令以及 `:h matchit-languages` 来获得支持的语言。
也就是说,你可以很方便的定义自己的匹配对:
```vim
autocmd FileType python let b:match_words = '\<if\>:\<elif\>:\<else\>'
```
之后你就可以在任何的Python文件中使用 `%` (向前)或 `g%` (向后)在这三个片断之间跳转了。
帮助文档:
```
:h matchit-install
:h matchit
:h b:match_words
```