zplugin-install.zsh(1) ====================== :compat-mode!: NAME ---- zplugin-install.zsh - a shell script SYNOPSIS -------- Documentation automatically generated with `zshelldoc' FUNCTIONS --------- zpextract -zplg-at-eval -zplg-compile-plugin -zplg-compinit -zplg-download-file-stdout -zplg-download-snippet -zplg-forget-completion -zplg-get-latest-gh-r-version -zplg-get-package -zplg-install-completions -zplg-mirror-using-svn -zplg-parse-json -zplg-setup-plugin-dir AUTOLOAD compinit DETAILS ------- Script Body ~~~~~~~~~~~ Has 3 line(s). No functions are called (may set up e.g. a hook, a Zle widget bound to a key, etc.). Uses feature(s): _source_ zpextract ~~~~~~~~~ ____ If the file is an archive, it is extracted by this function. Next stage is scanning of files with the common utility `file', to detect executables. They are given +x mode. There are also messages to the user on performed actions. $1 - url $2 - file ____ Has 156 line(s). Doesn't call other functions. Uses feature(s): _setopt_, _unfunction_, _zparseopts_ Called by: -zplg-get-package -zplg-setup-plugin-dir -zplg-at-eval ~~~~~~~~~~~~~ Has 3 line(s). Calls functions: -zplg-at-eval `-- zplugin.zsh/-zplg-substitute Uses feature(s): _eval_ Called by: -zplg-download-snippet -zplg-compile-plugin ~~~~~~~~~~~~~~~~~~~~ ____ Compiles given plugin (its main source file, and also an additional "....zsh" file if it exists). $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) $2 - plugin (only when $1 - i.e. user - given) ____ Has 58 line(s). Calls functions: -zplg-compile-plugin |-- zplugin-side.zsh/-zplg-compute-ice `-- zplugin-side.zsh/-zplg-first Uses feature(s): _eval_, _zcompile_ Called by: -zplg-setup-plugin-dir zplugin-autoload.zsh/-zplg-compile-uncompile-all zplugin.zsh/zplugin -zplg-compinit ~~~~~~~~~~~~~~ ____ User-exposed `compinit' frontend which first ensures that all completions managed by Zplugin are forgotten by Zshell. After that it runs normal `compinit', which should more easily detect Zplugin's completions. No arguments. ____ Has 21 line(s). Calls functions: -zplg-compinit |-- compinit `-- -zplg-forget-completion Uses feature(s): _autoload_, _compinit_, _setopt_, _unfunction_ Called by: -zplg-install-completions zplugin-autoload.zsh/-zplg-uninstall-completions zplugin.zsh/zplugin -zplg-download-file-stdout ~~~~~~~~~~~~~~~~~~~~~~~~~~ ____ Downloads file to stdout. Supports following backend commands: curl, wget, lftp, lynx. Used by snippet loading. ____ Has 36 line(s). Calls functions: -zplg-download-file-stdout Uses feature(s): _setopt_, _trap_, _type_ Called by: -zplg-download-snippet -zplg-get-package -zplg-setup-plugin-dir -zplg-download-snippet ~~~~~~~~~~~~~~~~~~~~~~ ____ Downloads snippet – either a file – with curl, wget, lftp or lynx, or a directory, with Subversion – when svn-ICE is active. Github supports Subversion protocol and allows to clone subdirectories. This is used to provide a layer of support for Oh-My-Zsh and Prezto. ____ Has 310 line(s). Calls functions: -zplg-download-snippet |-- -zplg-at-eval |   `-- zplugin.zsh/-zplg-substitute |-- -zplg-download-file-stdout |-- -zplg-install-completions |   |-- -zplg-compinit |   |   |-- compinit |   |   `-- -zplg-forget-completion |   |-- -zplg-forget-completion |   |-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2 |   |-- zplugin-side.zsh/-zplg-exists-physically-message |   `-- zplugin.zsh/-zplg-any-to-user-plugin |-- -zplg-mirror-using-svn |-- zplugin-side.zsh/-zplg-countdown |-- zplugin-side.zsh/-zplg-store-ices `-- zplugin.zsh/-zplg-substitute Uses feature(s): _eval_, _setopt_, _zcompile_ Called by: zplugin.zsh/-zplg-load-snippet -zplg-forget-completion ~~~~~~~~~~~~~~~~~~~~~~~ ____ Implements alternation of Zsh state so that already initialized completion stops being visible to Zsh. $1 - completion function name, e.g. "_cp"; can also be "cp" ____ Has 18 line(s). Doesn't call other functions. Uses feature(s): _unfunction_ Called by: -zplg-compinit -zplg-install-completions zplugin-autoload.zsh/-zplg-uninstall-completions zplugin.zsh/zplugin -zplg-get-latest-gh-r-version ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ____ Gets version string of latest release of given Github package. Connects to Github releases page. ____ Has 14 line(s). Calls functions: -zplg-get-latest-gh-r-version `-- zplugin.zsh/-zplg-any-to-user-plugin Uses feature(s): _setopt_ Called by: zplugin-autoload.zsh/-zplg-update-or-status -zplg-get-package ~~~~~~~~~~~~~~~~~ Has 152 line(s). Calls functions: -zplg-get-package |-- zpextract |-- -zplg-download-file-stdout |-- -zplg-parse-json `-- zplugin.zsh/-zplg-substitute Uses feature(s): _eval_, _setopt_ Called by: zplugin.zsh/-zplg-load _Environment variables used:_ zplugin.zsh -> ZPFX -zplg-install-completions ~~~~~~~~~~~~~~~~~~~~~~~~~ ____ Installs all completions of given plugin. After that they are visible to `compinit'. Visible completions can be selectively disabled and enabled. User can access completion data with `clist' or `completions' subcommand. $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) $2 - plugin (only when $1 - i.e. user - given) $3 - if 1, then reinstall, otherwise only install completions that aren't there ____ Has 38 line(s). Calls functions: -zplg-install-completions |-- -zplg-compinit |   |-- compinit |   `-- -zplg-forget-completion |-- -zplg-forget-completion |-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2 |-- zplugin-side.zsh/-zplg-exists-physically-message `-- zplugin.zsh/-zplg-any-to-user-plugin Uses feature(s): _setopt_ Called by: -zplg-download-snippet -zplg-setup-plugin-dir zplugin.zsh/zplugin -zplg-mirror-using-svn ~~~~~~~~~~~~~~~~~~~~~~ ____ Used to clone subdirectories from Github. If in update mode (see $2), then invokes `svn update', in normal mode invokes `svn checkout --non-interactive -q '. In test mode only compares remote and local revision and outputs true if update is needed. $1 - URL $2 - mode, "" - normal, "-u" - update, "-t" - test $3 - subdirectory (not path) with working copy, needed for -t and -u ____ Has 27 line(s). Doesn't call other functions. Uses feature(s): _setopt_ Called by: -zplg-download-snippet -zplg-parse-json ~~~~~~~~~~~~~~~~ ____ Retrievies the ice-list from given profile from the JSON of the package.json. ____ Has 107 line(s). Calls functions: -zplg-parse-json Uses feature(s): _setopt_ Called by: -zplg-get-package -zplg-setup-plugin-dir ~~~~~~~~~~~~~~~~~~~~~~ ____ Clones given plugin into PLUGIN_DIR. Supports multiple sites (respecting `from' and `proto' ice modifiers). Invokes compilation of plugin's main file. $1 - user $2 - plugin ____ Has 223 line(s). Calls functions: -zplg-setup-plugin-dir |-- zpextract |-- -zplg-compile-plugin |   |-- zplugin-side.zsh/-zplg-compute-ice |   `-- zplugin-side.zsh/-zplg-first |-- -zplg-download-file-stdout |-- -zplg-install-completions |   |-- -zplg-compinit |   |   |-- compinit |   |   `-- -zplg-forget-completion |   |-- -zplg-forget-completion |   |-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2 |   |-- zplugin-side.zsh/-zplg-exists-physically-message |   `-- zplugin.zsh/-zplg-any-to-user-plugin |-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2 |-- zplugin-side.zsh/-zplg-countdown |-- zplugin-side.zsh/-zplg-store-ices `-- zplugin.zsh/-zplg-substitute Uses feature(s): _eval_, _setopt_ Called by: zplugin-autoload.zsh/-zplg-update-or-status zplugin.zsh/-zplg-load compinit ~~~~~~~~ ____ Initialisation for new style completion. This mainly contains some helper functions and setup. Everything else is split into different files that will automatically be made autoloaded (see the end of this file). The names of the files that will be considered for autoloading are those that begin with an underscores (like `_condition). The first line of each of these files is read and must indicate what should be done with its contents: `#compdef ' ____ Has 549 line(s). Doesn't call other functions. Uses feature(s): _autoload_, _bindkey_, _compdef_, _compdump_, _eval_, _read_, _setopt_, _unfunction_, _zle_, _zstyle_ Called by: -zplg-compinit