add to readme

This commit is contained in:
Isaac 2023-04-28 14:02:06 -07:00
parent 98e3a81fcf
commit f7e4024fca
No known key found for this signature in database
GPG key ID: E69FB5A841448A48

View file

@ -334,10 +334,13 @@ Access](https://projects.torsion.org/borgmatic-collective/borgmatic/issues/293).
### Shell completion ### Shell completion
borgmatic includes a shell completion script (currently only for Bash) to borgmatic includes a shell completion script (currently only for Bash and Fish) to
support tab-completing borgmatic command-line actions and flags. Depending on support tab-completing borgmatic command-line actions and flags. Depending on
how you installed borgmatic, this may be enabled by default. But if it's not, how you installed borgmatic, this may be enabled by default.
start by installing the `bash-completion` Linux package or the
#### Bash
If completions aren't enabled, start by installing the `bash-completion` Linux package or the
[`bash-completion@2`](https://formulae.brew.sh/formula/bash-completion@2) [`bash-completion@2`](https://formulae.brew.sh/formula/bash-completion@2)
macOS Homebrew formula. Then, install the shell completion script globally: macOS Homebrew formula. Then, install the shell completion script globally:
@ -362,6 +365,14 @@ borgmatic --bash-completion > ~/.local/share/bash-completion/completions/borgmat
Finally, restart your shell (`exit` and open a new shell) so the completions Finally, restart your shell (`exit` and open a new shell) so the completions
take effect. take effect.
#### Fish
To add completions for fish, install the completions file globally:
```fish
borgmatic --fish-completion | sudo tee /usr/share/fish/vendor_completions.d/borgmatic.fish
source /usr/share/fish/vendor_completions.d/borgmatic.fish
```
### Colored output ### Colored output