summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2017-01-06 22:52:57 -0500
committerAndrew Gallant <jamslam@gmail.com>2017-01-06 22:52:57 -0500
commit8f7b9be356c005435f5612904f38ed5d95cc2aa0 (patch)
treeb1bd81ccf1abf8a58b865a4c1f4c9c6d44c811ea /doc
parent851799f42be4409d4e2498960725e11d0514a0e7 (diff)
Add docs for shell completion files.
Add small howtos for installing shell completion files to the README and the man page. They are still incomplete. We're missing Zsh and PowerShell. Fixes #262
Diffstat (limited to 'doc')
-rw-r--r--doc/rg.111
-rw-r--r--doc/rg.1.md10
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/rg.1 b/doc/rg.1
index 6ce5bd65..7b87ea40 100644
--- a/doc/rg.1
+++ b/doc/rg.1
@@ -409,3 +409,14 @@ ripgrep.
Note that this must be passed to every invocation of rg.
.RS
.RE
+.SH SHELL COMPLETION
+.PP
+Shell completion files are included in the release tarball for Bash,
+Fish, Zsh and PowerShell.
+.PP
+For \f[B]bash\f[], move \f[C]rg.bash\-completion\f[] to
+\f[C]$XDG_CONFIG_HOME/bash_completion\f[] or
+\f[C]/etc/bash_completion.d/\f[].
+.PP
+For \f[B]fish\f[], move \f[C]rg.fish\f[] to
+\f[C]$HOME/.config/fish/completions\f[].
diff --git a/doc/rg.1.md b/doc/rg.1.md
index 748e5aa5..0bd08504 100644
--- a/doc/rg.1.md
+++ b/doc/rg.1.md
@@ -273,3 +273,13 @@ Project home page: https://github.com/BurntSushi/ripgrep
: Clear the file type globs previously defined for TYPE. This only clears
the default type definitions that are found inside of ripgrep. Note
that this must be passed to every invocation of rg.
+
+# SHELL COMPLETION
+
+Shell completion files are included in the release tarball for Bash, Fish, Zsh
+and PowerShell.
+
+For **bash**, move `rg.bash-completion` to `$XDG_CONFIG_HOME/bash_completion`
+or `/etc/bash_completion.d/`.
+
+For **fish**, move `rg.fish` to `$HOME/.config/fish/completions`.