satwell
/
borgmatic
forked from borgmatic-collective/borgmatic
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Clarify completion docs.

This commit is contained in:
Dan Helfman 2022-06-01 10:57:23 -07:00
parent d751cceeb0
commit cd834311eb
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/how-to/set-up-backups.md
View File

@ -312,23 +312,31 @@ Access](https://projects.torsion.org/borgmatic-collective/borgmatic/issues/293).
borgmatic includes a shell completion script (currently only for Bash) to borgmatic includes a shell completion script (currently only for Bash) 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. But if it's not,
you can install the shell completion script globally: start by installing the `bash-completion` Linux package or the
[`bash-completion@2`](https://formulae.brew.sh/formula/bash-completion@2)
macOS Homebrew formula. Then, install the shell completion script globally:
```bash ```bash
sudo su -c "borgmatic --bash-completion > $(pkg-config --variable=completionsdir bash-completion)/borgmatic" sudo su -c "borgmatic --bash-completion > $(pkg-config --variable=completionsdir bash-completion)/borgmatic"
``` ```
Alternatively, if you'd like to install the script for just the current user: If you don't have `pkg-config` installed, you can try the following path
instead:
```bash
sudo su -c "borgmatic --bash-completion > /usr/share/bash-completion/completions/borgmatic"
```
Or, if you'd like to install the script for just the current user:
```bash ```bash
mkdir --parents ~/.local/share/bash-completion/completions mkdir --parents ~/.local/share/bash-completion/completions
borgmatic --bash-completion > ~/.local/share/bash-completion/completions/borgmatic borgmatic --bash-completion > ~/.local/share/bash-completion/completions/borgmatic
``` ```
In either case, you may also need to install the `bash-completion` Linux Finally, restart your shell (`exit` and open a new shell) so the completions
package and restart your shell (`exit` and open a new shell). take effect.
For macOS, you can enable shell completion by setting up [`bash-completion@2`](https://formulae.brew.sh/formula/bash-completion@2) and then running above global command. `sudo` is not required.
### Colored output ### Colored output