aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ripgrep.txt34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/ripgrep.txt b/doc/ripgrep.txt
new file mode 100644
index 0000000..c050953
--- /dev/null
+++ b/doc/ripgrep.txt
@@ -0,0 +1,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 Wynn Wolf Arbor. 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: