aboutsummaryrefslogtreecommitdiffstats
path: root/doc/ripgrep.txt
blob: f2e87db2ae97f396528aae4d3b9e75a672aff14b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
*ripgrep.txt*                                     Invoke rg(1) from within vim.

==============================================================================
 SYNOPSIS                                                             *ripgrep*

vim-ripgrep is a small plugin that integrates ripgrep into vim seamlessly. It
provides a single command, |:Rg|, to do this.

This plugin is only available if |'compatible'| is not set.

==============================================================================
 COMMANDS                                                    *ripgrep-commands*

                                                                  *ripgrep-:Rg*
:Rg [args]              Run ripgrep in vim's current directory with the
                        given arguments. When nothing is passed, search for
                        the |word| under the cursor.

                        If |'ignorecase'| or |'smartcase'| is set, |:Rg| will
                        pass the corresponding option to ripgrep.

                        |:Rg| will automatically open the quickfix list if
                        there are any matches.

==============================================================================
 ABOUT                                                          *ripgrep-about*

vim-ripgrep was written by Wolfgang Müller. It was heavily inspired by another
plugin called vim-ripgrep (https://github.com/jremmen/vim-ripgrep), but was
written from scratch with simplicity in mind.

Obtain the latest version at https://git.oriole.systems/vim-ripgrep

 vim:tw=78:et:ft=help:norl: