Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document how to install the completion files #262

Closed
daxim opened this issue Dec 1, 2016 · 3 comments
Closed

document how to install the completion files #262

daxim opened this issue Dec 1, 2016 · 3 comments
Labels
doc An issue with or an improvement to documentation.

Comments

@daxim
Copy link

daxim commented Dec 1, 2016

The release archive ripgrep-0.3.1-x86_64-unknown-linux-musl.tar.gz contains a number of completion files, but no instructions how to use them AFAICS.

@BurntSushi BurntSushi added the doc An issue with or an improvement to documentation. label Dec 1, 2016
@BurntSushi
Copy link
Owner

I would love to provide documentation, but I don't know how to use them myself. I could figure out bash, but I'm unlikely to figure out the others.

@kbknapp
Copy link
Contributor

kbknapp commented Dec 2, 2016

@daxim
Copy link
Author

daxim commented Dec 2, 2016

Thank you, I used that info in order to write the following documentation patch.

Shell completions
=================

Bash
----

Move `rg.bash-completion` to [`$XDG_CONFIG_HOME/bash_completion`](https://github.com/scop/bash-completion/blob/master/doc/bash_completion.txt#L4) or `/etc/bash_completion.d/`.

Fish
----

Move `rg.fish` to `$HOME/.config/fish/completions`.

Apply it where you see fit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc An issue with or an improvement to documentation.
Projects
None yet
Development

No branches or pull requests

3 participants