diff --git a/shell-completion/hledger-completion.bash b/shell-completion/hledger-completion.bash index 43497bfe1..1ee302c4c 100644 --- a/shell-completion/hledger-completion.bash +++ b/shell-completion/hledger-completion.bash @@ -8,6 +8,23 @@ # That said, we *do* remove colon (:) from COMP_WORDBREAKS which impacts # the rest of the session and completion for other programs. +# INSTALLATION: +# To install you can simply source this file from your shell's startup files. + +# Alternatively, copy/symlink it into `${BASH_COMPLETION_USER_DIR}/completions` +# or `${XDG_DATA_HOME:-$HOME/.local/share}/bash-completion/completions`, rename +# it to either `hledger`, `_hledger` or `hledger.bash`, and it will be loaded +# dynamically the first time you use the `hledger` command. Optionally, create +# symlinks to this file for any extensions used e.g.: + +# mkdir -p "${BASH_COMPLETION_USER_DIR:-${XDG_DATA_HOME:-$HOME/.local/share}/bash-completion}/completions" && +# cd "${BASH_COMPLETION_USER_DIR:-${XDG_DATA_HOME:-$HOME/.local/share}/bash-completion}/completions" && +# cp /path/to/hledger-completion.bash hledger && +# ln -s hledger hledger-ui && +# ln -s hledger hledger-web && +# : done. + + _hledger_completion() { local cur prev words cword _init_completion -n : || return 0 diff --git a/shell-completion/hledger-completion.bash.m4 b/shell-completion/hledger-completion.bash.m4 index e6eaef966..78bb79abc 100644 --- a/shell-completion/hledger-completion.bash.m4 +++ b/shell-completion/hledger-completion.bash.m4 @@ -8,6 +8,23 @@ # That said, we *do* remove colon (:) from COMP_WORDBREAKS which impacts # the rest of the session and completion for other programs. +# INSTALLATION: +# To install you can simply source this file from your shell's startup files. + +# Alternatively, copy/symlink it into `${BASH_COMPLETION_USER_DIR}/completions` +# or `${XDG_DATA_HOME:-$HOME/.local/share}/bash-completion/completions`, rename +# it to either `hledger`, `_hledger` or `hledger.bash`, and it will be loaded +# dynamically the first time you use the `hledger` command. Optionally, create +# symlinks to this file for any extensions used e.g.: + +# mkdir -p "${BASH_COMPLETION_USER_DIR:-${XDG_DATA_HOME:-$HOME/.local/share}/bash-completion}/completions" && +# cd "${BASH_COMPLETION_USER_DIR:-${XDG_DATA_HOME:-$HOME/.local/share}/bash-completion}/completions" && +# cp /path/to/hledger-completion.bash hledger && +# ln -s hledger hledger-ui && +# ln -s hledger hledger-web && +# : done. + + _hledger_completion() { local cur prev words cword _init_completion -n : || return 0