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

Bash completion nits #1762

Merged
merged 1 commit into from
Jun 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file modified autocomplete/bash_autocomplete
100755 → 100644
Empty file.
4 changes: 4 additions & 0 deletions docs/v2/examples/bash-completions.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ func main() {
To enable auto-completion for the current shell session, a bash script,
`autocomplete/bash_autocomplete` is included in this repo.

> :warning: The `bash-completion` package or equivalent that provides the
> `_get_comp_words_by_ref` function for the target platform must be installed and
> initialized for this completion script to work correctly.

To use `autocomplete/bash_autocomplete` set an environment variable named `PROG`
to the name of your program and then `source` the
`autocomplete/bash_autocomplete` file.
Expand Down