NAME
zi.zsh - a shell script
SYNOPSIS
Documentation automatically generated with `zsdoc'
FUNCTIONS
❮▼❯ @autoload pmodload zi .zi-add-fpath .zi-add-report .zi-any-to-pid .zi-any-to-user-plugin zicdclear zicdreplay zicompdef .zi-compdef-clear .zi-compdef-replay zicompinit zicompinit_fast +zi-deploy-message .zi-diff .zi-diff-env .zi-diff-functions .zi-diff-options .zi-diff-parameter .zi-find-other-matches .zi-formatter-auto .zi-formatter-bar .zi-formatter-bar-util .zi-formatter-pid .zi-formatter-th-bar .zi-formatter-url .zi-get-mtime-into .zi-get-object-path .zi-ice .zi-load .zi-load-ices .zi-load-object .zi-load-plugin .zi-load-snippet .zi-main-message-formatter +zi-message .zi-pack-ice .zi-parse-opts +zi-prehelp-usage-message .zi-prepare-home @zi-register-annex @zi-register-hook .zi-register-plugin :zi-reload-and-run .zi-run .zi-run-task -zi_scheduler_add_sh .zi-set-m-func .zi-setup-params .zi-submit-turbo @zi-substitute :zi-tmp-subst-alias :zi-tmp-subst-autoload :zi-tmp-subst-bindkey :zi-tmp-subst-compdef .zi-tmp-subst-off .zi-tmp-subst-on :zi-tmp-subst-zle :zi-tmp-subst-zstyle zi-turbo .zi-util-shands-path zpcdclear zpcdreplay zpcompdef zpcompinit @zsh-plugin-run-on-unload @zsh-plugin-run-on-update AUTOLOAD add-zsh-hook AUTOLOAD compinit AUTOLOAD is-at-least PRECMD-HOOK @zi-scheduler
DETAILS
Script Body
Has 279 line(s). Calls functions:
Script-Body |-- add-zsh-hook |-- is-at-least |-- side.zsh/.zi-check-module `-- @zi-register-hook
Uses feature(s): add-zsh-hook, alias, autoload, is-at-least, setopt, source, zmodload, zstyle
❮▼❯ ~
]]] Compatibility functions. [[[
Has 1 line(s). Calls functions:
❮▼❯
`-- zi
|-- additional.zsh/.zi-clear-debug-report
|-- additional.zsh/.zi-debug-start
|-- additional.zsh/.zi-debug-stop
|-- additional.zsh/.zi-debug-unload
|-- autoload.zsh/.zi-analytics-menu
|-- autoload.zsh/.zi-cdisable
|-- autoload.zsh/.zi-cenable
|-- autoload.zsh/.zi-clear-completions
|-- autoload.zsh/.zi-compiled
|-- autoload.zsh/.zi-compile-uncompile-all
|-- autoload.zsh/.zi-help
|-- autoload.zsh/.zi-list-bindkeys
|-- autoload.zsh/.zi-list-compdef-replay
|-- autoload.zsh/.zi-ls
|-- autoload.zsh/.zi-module
|-- autoload.zsh/.zi-recently
|-- autoload.zsh/.zi-registered-ice-mods
|-- autoload.zsh/.zi-registered-subcommands
|-- autoload.zsh/.zi-search-completions
|-- autoload.zsh/.zi-self-update
|-- autoload.zsh/.zi-show-all-reports
|-- autoload.zsh/.zi-show-completions
|-- autoload.zsh/.zi-show-debug-report
|-- autoload.zsh/.zi-show-registered-plugins
|-- autoload.zsh/.zi-show-report
|-- autoload.zsh/.zi-show-times
|-- autoload.zsh/.zi-show-zstatus
|-- autoload.zsh/.zi-uncompile-plugin
|-- autoload.zsh/.zi-uninstall-completions
|-- autoload.zsh/.zi-unload
|-- autoload.zsh/.zi-update-or-status
|-- autoload.zsh/.zi-update-or-status-all
|-- compinit
|-- install.zsh/.zi-compile-plugin
|-- install.zsh/.zi-compinit
|-- install.zsh/.zi-forget-completion
|-- install.zsh/.zi-install-completions
|-- +zi-message
`-- +zi-prehelp-usage-message
`-- +zi-message
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
@autoload
]]] FUNCTION: @autoload. [[[
Has 1 line(s). Calls functions:
@autoload
`-- :zi-tmp-subst-autoload
|-- is-at-least
`-- +zi-message
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
pmodload
FUNCTION: pmodload. [[[ Compatibility with Prezto. Calls can be recursive.
Has 15 line(s). Calls functions:
pmodload
Uses feature(s): zstyle
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
zi
FUNCTION: zi. [[[ Main function directly exposed to user, obtains subcommand and its arguments, has completion.
Has 550 line(s). Calls functions:
zi
|-- additional.zsh/.zi-clear-debug-report
|-- additional.zsh/.zi-debug-start
|-- additional.zsh/.zi-debug-stop
|-- additional.zsh/.zi-debug-unload
|-- autoload.zsh/.zi-analytics-menu
|-- autoload.zsh/.zi-cdisable
|-- autoload.zsh/.zi-cenable
|-- autoload.zsh/.zi-clear-completions
|-- autoload.zsh/.zi-compiled
|-- autoload.zsh/.zi-compile-uncompile-all
|-- autoload.zsh/.zi-help
|-- autoload.zsh/.zi-list-bindkeys
|-- autoload.zsh/.zi-list-compdef-replay
|-- autoload.zsh/.zi-ls
|-- autoload.zsh/.zi-module
|-- autoload.zsh/.zi-recently
|-- autoload.zsh/.zi-registered-ice-mods
|-- autoload.zsh/.zi-registered-subcommands
|-- autoload.zsh/.zi-search-completions
|-- autoload.zsh/.zi-self-update
|-- autoload.zsh/.zi-show-all-reports
|-- autoload.zsh/.zi-show-completions
|-- autoload.zsh/.zi-show-debug-report
|-- autoload.zsh/.zi-show-registered-plugins
|-- autoload.zsh/.zi-show-report
|-- autoload.zsh/.zi-show-times
|-- autoload.zsh/.zi-show-zstatus
|-- autoload.zsh/.zi-uncompile-plugin
|-- autoload.zsh/.zi-uninstall-completions
|-- autoload.zsh/.zi-unload
|-- autoload.zsh/.zi-update-or-status
|-- autoload.zsh/.zi-update-or-status-all
|-- compinit
|-- install.zsh/.zi-compile-plugin
|-- install.zsh/.zi-compinit
|-- install.zsh/.zi-forget-completion
|-- install.zsh/.zi-install-completions
|-- +zi-message
`-- +zi-prehelp-usage-message
`-- +zi-message
Uses feature(s): autoload, compinit, eval, setopt, source
Called by:
❮▼❯ zi-turbo
~~~~~
FUNCTION: .zi-add-fpath. [[[
Has 10 line(s). Calls functions:
.zi-add-fpath
Called by:
zi
~~~~~~
FUNCTION: .zi-add-report. [[[ Adds a report line for given plugin.$1 - uspl2, i.e. user/plugin $2, ... - the text
Has 3 line(s). Doesn’t call other functions.
Called by:
.zi-load-plugin .zi-load-snippet :zi-tmp-subst-alias :zi-tmp-subst-autoload :zi-tmp-subst-bindkey :zi-tmp-subst-compdef :zi-tmp-subst-zle :zi-tmp-subst-zstyle
~~~~~~
FUNCTION: .zi-any-to-pid. [[[
Has 21 line(s). Calls functions:
.zi-any-to-pid
Uses feature(s): setopt
Called by:
side.zsh/.zi-any-colorify-as-uspl2 side.zsh/.zi-exists-physically-message side.zsh/.zi-first
~~~~~~~~
FUNCTION: .zi-any-to-user-plugin. [[[ Allows elastic plugin-spec across the code.$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) $2 - plugin (only when $1 - i.e. user - given)Returns user and plugin in $reply.
Has 25 line(s). Doesn’t call other functions.
Uses feature(s): setopt
Called by:
.zi-add-fpath .zi-get-object-path .zi-load .zi-run :zi-tmp-subst-autoload autoload.zsh/.zi-any-to-uspl2 autoload.zsh/.zi-changes autoload.zsh/.zi-compiled autoload.zsh/.zi-compile-uncompile-all autoload.zsh/.zi-create autoload.zsh/.zi-delete autoload.zsh/.zi-find-completions-of-plugin autoload.zsh/.zi-glance autoload.zsh/.zi-show-report autoload.zsh/.zi-stress autoload.zsh/.zi-uncompile-plugin autoload.zsh/.zi-unload autoload.zsh/.zi-unregister-plugin autoload.zsh/.zi-update-all-parallel autoload.zsh/.zi-update-or-status-all autoload.zsh/.zi-update-or-status install.zsh/.zi-install-completions side.zsh/.zi-any-colorify-as-uspl2 side.zsh/.zi-compute-ice side.zsh/.zi-exists-physically-message side.zsh/.zi-exists-physically side.zsh/.zi-first
zicdclear
]]] FUNCTION: zicdclear. [[[ A wrapper for `zi cdclear -q' which can be called from hook ices like the atinit'', atload'', etc. ices.
Has 1 line(s). Calls functions:
zicdclear
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
zicdreplay
FUNCTION: zicdreplay. [[[ A function that can be invoked from within `atinit', `atload', etc. ice-mod. It works like `zi cdreplay', which cannot be invoked from such hook ices.
Has 1 line(s). Calls functions:
zicdreplay
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
zicompdef
]]] FUNCTION: zicompdef. [[[ Stores compdef for a replay with `zicdreplay' (turbo mode) or with `zi cdreplay' (normal mode). An utility function of an undefined use case.
Has 1 line(s). Doesn’t call other functions.
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
~~~~~~~
FUNCTION: .zi-compdef-clear. [[[ Implements user-exposed functionality to clear gathered compdefs.
Has 3 line(s). Calls functions:
.zi-compdef-clear `-- +zi-message
Called by:
zicdclear zi zpcdclear
~~~~~~
FUNCTION: .zi-compdef-replay. [[[ Runs gathered compdef calls. This allows to run `compinit' after loading plugins.
Has 16 line(s). Calls functions:
.zi-compdef-replay `-- +zi-message
Uses feature(s): compdef
Called by:
zicdreplay zi zpcdreplay
zicompinit
]]] FUNCTION: zicompinit. [[[ A function that can be invoked from within `atinit', `atload', etc. ice-mod. It runs `autoload compinit; compinit' and respects ZI[ZCOMPDUMP_PATH] and ZI[COMPINIT_OPTS].
Has 1 line(s). Calls functions:
zicompinit `-- compinit
Uses feature(s): autoload, compinit
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
zicompinit_fast
]]] FUNCTION: zicompinit_fast. [[[ Checking the cached .zcompdump file to see if it must be regenerated adds a noticable delay to zsh startup. This restricts checking it once a day, determines when to regenerate, as compinit doesn't always need to modify the compdump and compiles mapped to share (total mem reduction) run in background in multiple shells. A function that can be invoked from within `atinit', `atload'
Has 13 line(s). Calls functions:
zicompinit_fast `-- compinit
Uses feature(s): autoload, compinit, zcompile
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
+zi-deploy-message
FUNCTION: +zi-deploy-message. [[[ Deploys a sub-prompt message to be displayed OR a `zle .reset-prompt' call to be invoked
Has 13 line(s). Doesn’t call other functions.
Uses feature(s): read, zle
Called by:
.zi-load-snippet .zi-load autoload.zsh/.zi-recall
~~~~
FUNCTION: .zi-diff. [[[ Performs diff actions of all types
Has 4 line(s). Calls functions:
.zi-diff
Called by:
.zi-load-plugin additional.zsh/.zi-debug-start additional.zsh/.zi-debug-stop
~~~~
FUNCTION: .zi-diff-env. [[[ Implements detection of change in PATH and FPATH.$1 - user/plugin (i.e. uspl2 format) $2 - command, can be "begin" or "end"
Has 15 line(s). Doesn’t call other functions.
Called by:
.zi-diff .zi-load-plugin
~~~~~~
FUNCTION: .zi-diff-functions. [[[ Implements detection of newly created functions. Performs data gathering, computation is done in *-compute().$1 - user/plugin (i.e. uspl2 format) $2 - command, can be "begin" or "end"
Has 3 line(s). Doesn’t call other functions.
Called by:
.zi-diff
~~~~~~
FUNCTION: .zi-diff-options. [[[ Implements detection of change in option state. Performs data gathering, computation is done in *-compute().$1 - user/plugin (i.e. uspl2 format) $2 - command, can be "begin" or "end"
Has 2 line(s). Doesn’t call other functions.
Called by:
.zi-diff
~~~~~~
FUNCTION: .zi-diff-parameter. [[[ Implements detection of change in any parameter's existence and type. Performs data gathering, computation is done in *-compute().$1 - user/plugin (i.e. uspl2 format) $2 - command, can be "begin" or "end"
Has 6 line(s). Doesn’t call other functions.
Called by:
.zi-diff
~~~~~~~~
FUNCTION: .zi-find-other-matches. [[[ Plugin's main source file is in general `name.plugin.zsh'. However, there can be different conventions, if that file is not found, then this functions examines other conventions in the most sane order.
Has 17 line(s). Doesn’t call other functions.
Called by:
.zi-load-plugin .zi-load-snippet side.zsh/.zi-first
~~~~~~
FUNCTION: .zi-formatter-auto[[[ The automatic message formatting tool automatically detects, formats, and colorizes the following pieces of text: [URLs], [plugin IDs (user/repo) if exists on the disk], [numbers], [time], [single-word id-as plugins], [single word commands], [single word functions], [zi commands], [ice modifiers (e.g: mv'a -> b')], [single-char bits and quoted strings (`...', ,'...', "...")].
Has 46 line(s). Calls functions:
.zi-formatter-auto
Uses feature(s): setopt
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
~~~~~~~
FUNCTION: .zi-formatter-bar. [[[
Has 1 line(s). Calls functions:
.zi-formatter-bar
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
~~~~~~~~
FUNCTION: .zi-formatter-bar-util. [[[
Has 6 line(s). Doesn’t call other functions.
Called by:
.zi-formatter-bar .zi-formatter-th-bar
~~~~~~~
FUNCTION: .zi-formatter-pid. [[[
Has 10 line(s). Calls functions:
.zi-formatter-pid `-- side.zsh/.zi-any-colorify-as-uspl2
Uses feature(s): source
Called by:
.zi-formatter-auto
~~~~~~~~
FUNCTION: .zi-formatter-th-bar. [[[
Has 1 line(s). Calls functions:
.zi-formatter-th-bar
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
~~~~~~~
FUNCTION: .zi-formatter-url. [[[
Has 14 line(s). Doesn’t call other functions.
Called by:
.zi-formatter-auto
~~~~~~
FUNCTION: .zi-get-mtime-into. [[[
Has 7 line(s). Doesn’t call other functions.
Called by:
Script-Body autoload.zsh/.zi-self-update autoload.zsh/.zi-update-or-status-all
~~~~~~~
FUNCTION: .zi-get-object-path. [[[
Has 23 line(s). Calls functions:
.zi-get-object-path
Called by:
.zi-load-ices .zi-load-snippet .zi-run zi autoload.zsh/.zi-get-path install.zsh/.zi-setup-plugin-dir install.zsh/.zi-update-snippet side.zsh/.zi-first side.zsh/.zi-two-paths
~~~
FUNCTION: .zi-ice. [[[ Parses ICE specification, puts the result into ICE global hash. The ice-spec is valid for next command only (i.e. it "melts"), but it can then stick to plugin and activate e.g. at update.
Has 12 line(s). Doesn’t call other functions.
Uses feature(s): setopt
Called by:
zi
~~~~
FUNCTION: .zi-load. [[[ Implements the exposed-to-user action of loading a plugin.$1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) $2 - plugin name, if the third format is used
Has 78 line(s). Calls functions: