Skip to content

Commit

Permalink
Add *config* section in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
cykerway committed Aug 17, 2021
1 parent 46d9a29 commit 4fcd018
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,20 @@ to complete alias `sctl` aliased to `systemctl`:
condreload
...

## config

to config `complete-alias`, set these envars *before* sourcing the main script:

- `COMPAL_AUTO_UNMASK`

this is a bool; default is `0`; when set to `1`, enables auto unmask; when
set to `0`, uses manual unmask;

auto unmask automatically manages non-alias command completions, but incurs
a small overhead on source; manual unmask is the traditional way of setting
non-alias command completions, which is static and faster but requires user
intervention if the preset is not satisfying;

## compat

- support for gnu bash(>=4.4) on linux is aimed;
Expand Down

0 comments on commit 4fcd018

Please sign in to comment.