diff --git a/doc/zsdoc/zinit-additional.zsh.adoc b/doc/zsdoc/zinit-additional.zsh.adoc deleted file mode 100644 index c0364f1b9..000000000 --- a/doc/zsdoc/zinit-additional.zsh.adoc +++ /dev/null @@ -1,185 +0,0 @@ - -NAME - -zinit-additional.zsh - a shell script - -Documentation automatically generated with `zshelldoc' - -== FUNCTIONS - +zinit-debug - .zinit-debug-clear - .zinit-debug-report - .zinit-debug-revert - .zinit-debug-start - .zinit-debug-status - .zinit-debug-stop - .zinit-service - .zinit-wrap-track-functions - :zinit-tmp-subst-source - -=== DETAILS - -==== Script Body - -Has 1 line(s). No functions are called (may set up e.g. a hook, a Zle widget bound to a key, etc.). - -==== +zinit-debug - -____ - - Debug command entry point - -____ - -Has 35 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_, _zmodload_, _zparseopts_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-debug-clear - -____ - - Clear latest debug report - -____ - -Has 7 line(s). Calls functions: - - .zinit-debug-clear - |-- zinit-autoload.zsh/.zinit-clear-report-for - `-- zinit.zsh/+zi-log - -Called by: - - zinit-autoload.zsh/.zinit-unload - -==== .zinit-debug-report - -____ - - Displays debug report (data recorded in interactive session). - -____ - -Has 6 line(s). Calls functions: - - .zinit-debug-report - |-- zinit-autoload.zsh/.zinit-show-report - `-- zinit.zsh/+zi-log - -Uses feature(s): _source_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-debug-revert - -____ - - Revert changes made during debug mode - -____ - -Has 7 line(s). Calls functions: - - .zinit-debug-revert - |-- zinit-autoload.zsh/.zinit-unload - `-- zinit.zsh/+zi-log - -Uses feature(s): _source_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-debug-start - -____ - - Start debug mode - -____ - -Has 13 line(s). Calls functions: - - .zinit-debug-start - |-- zinit.zsh/+zi-log - |-- zinit.zsh/.zinit-diff - `-- zinit.zsh/.zinit-tmp-subst-on - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-debug-status - -____ - - Revert changes made during debug mode - -____ - -Has 2 line(s). Calls functions: - - .zinit-debug-status - `-- zinit.zsh/+zi-log - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-debug-stop - -____ - - Stop debug mode - -____ - -Has 14 line(s). Calls functions: - - .zinit-debug-stop - |-- zinit.zsh/+zi-log - |-- zinit.zsh/.zinit-diff - `-- zinit.zsh/.zinit-tmp-subst-off - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-service - -____ - - Handles given service, i.e. obtains lock, runs it, or waits if no lock - - $1 - type "p" or "s" (plugin or snippet) - $2 - mode - for plugin (light or load) - $3 - id - URL or plugin ID or alias name (from id-as'') - -____ - -Has 37 line(s). Calls functions: - - .zinit-service - |-- zinit.zsh/.zinit-load - `-- zinit.zsh/.zinit-load-snippet - -Uses feature(s): _kill_, _read_, _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-wrap-track-functions - -Has 19 line(s). Doesn't call other functions. - -Uses feature(s): _eval_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== :zinit-tmp-subst-source - -Has 25 line(s). Calls functions: - - :zinit-tmp-subst-source - `-- zinit.zsh/+zi-log - -Uses feature(s): _eval_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - diff --git a/doc/zsdoc/zinit-autoload.zsh.adoc b/doc/zsdoc/zinit-autoload.zsh.adoc deleted file mode 100644 index 55be36e89..000000000 --- a/doc/zsdoc/zinit-autoload.zsh.adoc +++ /dev/null @@ -1,1643 +0,0 @@ - -NAME - -zinit-autoload.zsh - a shell script - -Documentation automatically generated with `zshelldoc' - -== FUNCTIONS - .zi-check-for-git-changes - .zinit-any-to-uspl2 - .zinit-at-eval - .zinit-build-module - .zinit-cd - .zinit-cdisable - .zinit-cenable - .zinit-changes - .zinit-check-comp-consistency - .zinit-check-which-completions-are-enabled - .zinit-check-which-completions-are-installed - .zinit-clear-completions - .zinit-clear-report-for - .zinit-compile-uncompile-all - .zinit-compiled - .zinit-confirm - .zinit-create - .zinit-delete - .zinit-diff-env-compute - .zinit-diff-functions-compute - .zinit-diff-options-compute - .zinit-diff-parameter-compute - .zinit-edit - .zinit-exists-message - .zinit-find-completions-of-plugin - .zinit-format-env - .zinit-format-functions - .zinit-format-options - .zinit-format-parameter - .zinit-get-completion-owner - .zinit-get-completion-owner-uspl2col - .zinit-get-path - .zinit-glance - .zinit-help - .zinit-list-bindkeys - .zinit-list-compdef-replay - .zinit-list-plugins - .zinit-list-snippets - .zinit-module - .zinit-pager - .zinit-prepare-readlink - .zinit-prompt - .zinit-recall - .zinit-recently - .zinit-restore-extendedglob - .zinit-run-delete-hooks - .zinit-save-set-extendedglob - .zinit-search-completions - .zinit-self-update - .zinit-show-all-reports - .zinit-show-completions - .zinit-show-debug-report - .zinit-show-report - .zinit-show-times - .zinit-show-zstatus - .zinit-stress - .zinit-uncompile-plugin - .zinit-uninstall-completions - .zinit-unload - .zinit-unregister-plugin - .zinit-update-all-parallel - .zinit-update-or-status - .zinit-update-or-status-all - .zinit-update-or-status-snippet - .zinit-wait-for-update-jobs - zi::version - -=== DETAILS - -==== Script Body - -Has 5 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_ - -==== .zi-check-for-git-changes - -____ - - Check for Git updates - - $1 - Absolute path to Git repository" - -____ - -Has 12 line(s). Calls functions: - - .zi-check-for-git-changes - `-- zinit.zsh/+zi-log - -Called by: - - .zinit-self-update - -==== .zinit-any-to-uspl2 - -____ - - Converts given plugin-spec to format that's used in keys for hash tables. - So basically, creates string "user/plugin" (this format is called: uspl2). - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - (optional) plugin (only when $1 - i.e. user - given) - -____ - -Has 2 line(s). Calls functions: - - .zinit-any-to-uspl2 - `-- zinit.zsh/.zinit-any-to-user-plugin - -Called by: - - .zinit-clear-report-for - .zinit-exists-message - -==== .zinit-at-eval - -Has 5 line(s). Calls functions: - - .zinit-at-eval - `-- zinit.zsh/@zinit-substitute - -Uses feature(s): _eval_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-build-module - -____ - - Performs ./configure && make on the module and displays information - how to load the module in .zshrc. - -____ - -Has 39 line(s). Calls functions: - - .zinit-build-module - |-- .zinit-module - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_, _trap_ - -Called by: - - .zinit-module - -==== .zinit-cd - -____ - - Jumps to plugin's directory (in Zinit's home directory). - - User-action entry point. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 15 line(s). Calls functions: - - .zinit-cd - |-- .zinit-get-path - |   `-- zinit.zsh/.zinit-get-object-path - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-cdisable - -____ - - Enables given installed completion. - - User-action entry point. - - $1 - e.g. "_mkdir" or "mkdir" - -____ - -Has 30 line(s). Calls functions: - - .zinit-cdisable - |-- .zinit-check-comp-consistency - |-- .zinit-get-completion-owner-uspl2col - |   |-- .zinit-get-completion-owner - |   `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - `-- .zinit-prepare-readlink - -Called by: - - zinit.zsh/zinit - -==== .zinit-cenable - -____ - - Disables given installed completion. - - User-action entry point. - - $1 - e.g. "_mkdir" or "mkdir" - -____ - -Has 31 line(s). Calls functions: - - .zinit-cenable - |-- .zinit-check-comp-consistency - |-- .zinit-get-completion-owner-uspl2col - |   |-- .zinit-get-completion-owner - |   `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - `-- .zinit-prepare-readlink - -Called by: - - zinit.zsh/zinit - -==== .zinit-changes - -____ - - Shows `git log` of given plugin. - - User-action entry point. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 9 line(s). Calls functions: - - .zinit-changes - |-- zinit-side.zsh/.zinit-exists-physically-message - `-- zinit.zsh/.zinit-any-to-user-plugin - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-check-comp-consistency - -____ - - Zinit creates symlink for each installed completion. - This function checks whether given completion (i.e. - file like "_mkdir") is indeed a symlink. Backup file - is a completion that is disabled - has the leading "_" - removed. - - $1 - path to completion within plugin's directory - $2 - path to backup file within plugin's directory - -____ - -Has 11 line(s). Doesn't call other functions. - -Called by: - - .zinit-cdisable - .zinit-cenable - -==== .zinit-check-which-completions-are-enabled - -____ - - For each argument that each should be a path to completion - within a plugin's dir, it checks whether that completion - is disabled - returns 0 or 1 on corresponding positions - in reply. - - Uninstalled completions will be reported as "0" - - i.e. disabled - - $1, ... - path to completion within plugin's directory - -____ - -Has 11 line(s). Doesn't call other functions. - -Called by: - - .zinit-show-report - -==== .zinit-check-which-completions-are-installed - -____ - - For each argument that each should be a path to completion - within a plugin's dir, it checks whether that completion - is installed - returns 0 or 1 on corresponding positions - in reply. - - $1, ... - path to completion within plugin's directory - -____ - -Has 12 line(s). Doesn't call other functions. - -Called by: - - .zinit-show-report - -==== .zinit-clear-completions - -____ - - Delete stray and improper completions. - - Completions live even when plugin isn't loaded - if they are - installed and enabled. - - User-action entry point. - -____ - -Has 37 line(s). Calls functions: - - .zinit-clear-completions - |-- .zinit-get-completion-owner - |-- .zinit-prepare-readlink - `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/.zinit-prepare-home - zinit.zsh/zinit - -==== .zinit-clear-report-for - -____ - - Clears all report data for given user/plugin. This is - done by resetting all related global ZINIT_* hashes. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - (optional) plugin (only when $1 - i.e. user - given) - -____ - -Has 23 line(s). Calls functions: - - .zinit-clear-report-for - `-- .zinit-any-to-uspl2 - `-- zinit.zsh/.zinit-any-to-user-plugin - -Called by: - - .zinit-unload - zinit-additional.zsh/.zinit-debug-clear - -==== .zinit-compile-uncompile-all - -____ - - Compiles or uncompiles all existing (on disk) plugins. - - User-action entry point. - -____ - -Has 23 line(s). Calls functions: - - .zinit-compile-uncompile-all - |-- .zinit-uncompile-plugin - |   |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- zinit-install.zsh/.zinit-compile-plugin - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-compiled - -____ - - Displays list of plugins that are compiled. - - User-action entry point. - -____ - -Has 26 line(s). Calls functions: - - .zinit-compiled - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-confirm - -____ - - Prints given question, waits for "y" key, evals - given expression if "y" obtained - - $1 - question - $2 - expression - -____ - -Has 17 line(s). Calls functions: - - .zinit-confirm - `-- zinit.zsh/+zi-log - -Uses feature(s): _eval_, _read_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-create - -____ - - Creates a plugin, also on Github (if not "_local/name" plugin). - - User-action entry point. - - $1 - (optional) plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - (optional) plugin (only when $1 - i.e. user - given) - -____ - -Has 102 line(s). Calls functions: - - .zinit-create - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- zinit-side.zsh/.zinit-exists-physically - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _autoload_, _setopt_, _vared_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-delete - -____ - - Deletes a plugin or snippet and related files and hooks. - - $1 - snippet url or plugin - -____ - -Has 111 line(s). Calls functions: - - .zinit-delete - |-- .zinit-prompt - |-- .zinit-run-delete-hooks - |   `-- zinit.zsh/+zi-log - |-- zinit-side.zsh/.zinit-compute-ice - |-- zinit.zsh/+zi-log - |-- zinit.zsh/.zinit-any-to-user-plugin - `-- zinit.zsh/zinit - -Uses feature(s): _setopt_, _zmodload_, _zparseopts_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-diff-env-compute - -____ - - Computes ZINIT_PATH, ZINIT_FPATH that hold (f)path components - added by plugin. Uses data gathered earlier by .zinit-diff-env(). - - $1 - user/plugin - -____ - -Has 30 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-show-report - .zinit-unload - -==== .zinit-diff-functions-compute - -____ - - Computes FUNCTIONS that holds new functions added by plugin. - Uses data gathered earlier by .zinit-diff-functions(). - - $1 - user/plugin - -____ - -Has 19 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-show-report - .zinit-unload - -==== .zinit-diff-options-compute - -____ - - Computes OPTIONS that holds options changed by plugin. - Uses data gathered earlier by .zinit-diff-options(). - - $1 - user/plugin - -____ - -Has 17 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-show-report - .zinit-unload - -==== .zinit-diff-parameter-compute - -____ - - Computes ZINIT_PARAMETERS_PRE, ZINIT_PARAMETERS_POST that hold - parameters created or changed (their type) by plugin. Uses - data gathered earlier by .zinit-diff-parameter(). - - $1 - user/plugin - -____ - -Has 28 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-show-report - .zinit-unload - -==== .zinit-edit - -____ - - Runs $EDITOR on source of given plugin. If the variable is not - set then defaults to `vim'. - - User-action entry point. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 22 line(s). Calls functions: - - .zinit-edit - `-- zinit-side.zsh/.zinit-compute-ice - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-exists-message - -____ - - Checks if plugin is loaded. Testable. Also outputs error - message if plugin is not loaded. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - (optional) plugin (only when $1 - i.e. user - given) - -____ - -Has 7 line(s). Calls functions: - - .zinit-exists-message - |-- .zinit-any-to-uspl2 - |   `-- zinit.zsh/.zinit-any-to-user-plugin - `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - -Called by: - - .zinit-show-report - .zinit-unload - -==== .zinit-find-completions-of-plugin - -____ - - Searches for completions owned by given plugin. - Returns them in `reply' array. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 6 line(s). Calls functions: - - .zinit-find-completions-of-plugin - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _setopt_ - -Called by: - - .zinit-show-report - -==== .zinit-format-env - -____ - - Creates one-column text about FPATH or PATH elements - added when given plugin was loaded. - - $1 - user/plugin (i.e. uspl2 format of plugin-spec) - $2 - if 1, then examine PATH, if 2, then examine FPATH - -____ - -Has 16 line(s). Doesn't call other functions. - -Called by: - - .zinit-show-report - -==== .zinit-format-functions - -____ - - Creates a one or two columns text with functions created - by given plugin. - - $1 - user/plugin (i.e. uspl2 format of plugin-spec) - -____ - -Has 36 line(s). Doesn't call other functions. - -Called by: - - .zinit-show-report - -==== .zinit-format-options - -____ - - Creates one-column text about options that changed when - plugin "$1" was loaded. - - $1 - user/plugin (i.e. uspl2 format of plugin-spec) - -____ - -Has 21 line(s). Calls functions: - - .zinit-format-options - |-- .zinit-restore-extendedglob - `-- .zinit-save-set-extendedglob - -Called by: - - .zinit-show-report - -==== .zinit-format-parameter - -____ - - Creates one column text that lists global parameters that - changed when the given plugin was loaded. - - $1 - user/plugin (i.e. uspl2 format of plugin-spec) - -____ - -Has 35 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-show-report - -==== .zinit-get-completion-owner - -____ - - Returns "user---plugin" string (uspl1 format) of plugin that - owns given completion. - - Both :A and readlink will be used, then readlink's output if - results differ. Readlink might not be available. - - :A will read the link "twice" and give the final repository - directory, possibly without username in the uspl format; - readlink will read the link "once" - - $1 - absolute path to completion file (in COMPLETIONS_DIR) - $2 - readlink command (":" or "readlink") - -____ - -Has 22 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-clear-completions - .zinit-get-completion-owner-uspl2col - .zinit-show-completions - -==== .zinit-get-completion-owner-uspl2col - -____ - - For shortening of code - returns colorized plugin name - that owns given completion. - - $1 - absolute path to completion file (in COMPLETIONS_DIR) - $2 - readlink command (":" or "readlink") - -____ - -Has 2 line(s). Calls functions: - - .zinit-get-completion-owner-uspl2col - |-- .zinit-get-completion-owner - `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - -Called by: - - .zinit-cdisable - .zinit-cenable - -==== .zinit-get-path - -____ - - Returns path of given ID-string, which may be a plugin-spec - (like "user/plugin" or "user" "plugin"), an absolute path - ("%" "/home/..." and also "%SNIPPETS/..." etc.), or a plugin - nickname (i.e. id-as'' ice-mod), or a snippet nickname. - -____ - -Has 8 line(s). Calls functions: - - .zinit-get-path - `-- zinit.zsh/.zinit-get-object-path - -Uses feature(s): _setopt_ - -Called by: - - .zinit-cd - .zinit-uninstall-completions - -==== .zinit-glance - -____ - - Shows colorized source code of plugin. Is able to use pygmentize, - highlight, GNU source-highlight. - - User-action entry point. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 39 line(s). Calls functions: - - .zinit-glance - |-- .zinit-pager - |-- zinit-side.zsh/.zinit-exists-physically-message - |-- zinit-side.zsh/.zinit-first - |-- zinit.zsh/+zi-log - `-- zinit.zsh/.zinit-any-to-user-plugin - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-help - -____ - - Shows usage information. - - User-action entry point. - -____ - -Has 64 line(s). Doesn't call other functions. - -Called by: - - zinit.zsh/zinit - -==== .zinit-list-bindkeys - -Has 44 line(s). Calls functions: - - .zinit-list-bindkeys - `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - -Called by: - - zinit.zsh/zinit - -==== .zinit-list-compdef-replay - -____ - - Shows recorded compdefs (called by plugins loaded earlier). - Plugins often call `compdef' hoping for `compinit' being - already ran. Zinit solves this by recording compdefs. - - User-action entry point. - -____ - -Has 5 line(s). Doesn't call other functions. - -Called by: - - zinit.zsh/zinit - -==== .zinit-list-plugins - -____ - - Lists loaded plugins (subcommands list, lodaded) - -____ - -Has 21 line(s). Calls functions: - - .zinit-list-plugins - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-list-snippets - -Has 20 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-module - -____ - - Function that has sub-commands passed as long-options (with two dashes, --). - It's an attempt to plugin only this one function into `zinit' function - defined in zinit.zsh, to not make this file longer than it's needed. - -____ - -Has 24 line(s). Calls functions: - - .zinit-module - `-- .zinit-build-module - `-- zinit.zsh/+zi-log - -Called by: - - .zinit-build-module - zinit.zsh/Script-Body - zinit.zsh/zinit - -==== .zinit-pager - -____ - - BusyBox less lacks the -X and -i options, so it can use more - -____ - -Has 14 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-glance - .zinit-self-update - .zinit-update-or-status - -==== .zinit-prepare-readlink - -____ - - Prepares readlink command, used for establishing completion's owner. - - $REPLY = ":" or "readlink" - -____ - -Has 4 line(s). Doesn't call other functions. - -Uses feature(s): _type_ - -Called by: - - .zinit-cdisable - .zinit-cenable - .zinit-clear-completions - .zinit-show-completions - -==== .zinit-prompt - -____ - - Prompt user to confirm - - $1 - prompt - - $REPLY - 0 or 1 - -____ - -Has 4 line(s). Doesn't call other functions. - -Uses feature(s): _read_ - -Called by: - - .zinit-delete - -==== .zinit-recall - -Has 38 line(s). Calls functions: - - .zinit-recall - |-- zinit-side.zsh/.zinit-compute-ice - `-- zinit.zsh/+zinit-deploy-message - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-recently - -____ - - Shows plugins that obtained commits in specified past time. - - User-action entry point. - - $1 - time spec, e.g. "1 week" - -____ - -Has 28 line(s). Calls functions: - - .zinit-recently - `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-restore-extendedglob - -____ - - Restores extendedglob-option from state saved earlier. - -____ - -Has 1 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-format-options - .zinit-unload - -==== .zinit-run-delete-hooks - -Has 33 line(s). Calls functions: - - .zinit-run-delete-hooks - `-- zinit.zsh/+zi-log - -Uses feature(s): _eval_ - -Called by: - - .zinit-delete - -==== .zinit-save-set-extendedglob - -____ - - Enables extendedglob-option first saving if it was already - enabled, for restoration of this state later. - -____ - -Has 2 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-format-options - .zinit-unload - -==== .zinit-search-completions - -____ - - While .zinit-show-completions() shows what completions are - installed, this functions searches through all plugin dirs - showing what's available in general (for installation). - - User-action entry point. - -____ - -Has 43 line(s). Calls functions: - - .zinit-search-completions - `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-self-update - -____ - - Updates Zinit code (does a git pull) - -____ - -Has 44 line(s). Calls functions: - - .zinit-self-update - |-- .zi-check-for-git-changes - |   `-- zinit.zsh/+zi-log - |-- .zinit-pager - |-- zinit.zsh/+zi-log - `-- zinit.zsh/.zinit-get-mtime-into - -Uses feature(s): _setopt_, _source_, _zcompile_ - -Called by: - - .zinit-update-or-status-all - zinit.zsh/zinit - -==== .zinit-show-all-reports - -____ - - Displays reports of all loaded plugins. - - User-action entry point. - -____ - -Has 5 line(s). Calls functions: - - .zinit-show-all-reports - `-- .zinit-show-report - |-- .zinit-check-which-completions-are-enabled - |-- .zinit-check-which-completions-are-installed - |-- .zinit-diff-env-compute - |-- .zinit-diff-functions-compute - |-- .zinit-diff-options-compute - |-- .zinit-diff-parameter-compute - |-- .zinit-exists-message - |   |-- .zinit-any-to-uspl2 - |   |   `-- zinit.zsh/.zinit-any-to-user-plugin - |   `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- .zinit-find-completions-of-plugin - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- .zinit-format-env - |-- .zinit-format-functions - |-- .zinit-format-options - |   |-- .zinit-restore-extendedglob - |   `-- .zinit-save-set-extendedglob - |-- .zinit-format-parameter - `-- zinit.zsh/.zinit-any-to-user-plugin - -Called by: - - zinit.zsh/zinit - -==== .zinit-show-completions - -____ - - Display installed (enabled and disabled), completions. Detect - stray and improper ones. - - Completions live even when plugin isn't loaded - if they are - installed and enabled. - - User-action entry point. - -____ - -Has 72 line(s). Calls functions: - - .zinit-show-completions - |-- .zinit-get-completion-owner - |-- .zinit-prepare-readlink - `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-show-debug-report - -____ - - Displays dtrace report (data recorded in interactive session). - - User-action entry point. - -____ - -Has 1 line(s). Calls functions: - - .zinit-show-debug-report - `-- .zinit-show-report - |-- .zinit-check-which-completions-are-enabled - |-- .zinit-check-which-completions-are-installed - |-- .zinit-diff-env-compute - |-- .zinit-diff-functions-compute - |-- .zinit-diff-options-compute - |-- .zinit-diff-parameter-compute - |-- .zinit-exists-message - |   |-- .zinit-any-to-uspl2 - |   |   `-- zinit.zsh/.zinit-any-to-user-plugin - |   `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- .zinit-find-completions-of-plugin - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- .zinit-format-env - |-- .zinit-format-functions - |-- .zinit-format-options - |   |-- .zinit-restore-extendedglob - |   `-- .zinit-save-set-extendedglob - |-- .zinit-format-parameter - `-- zinit.zsh/.zinit-any-to-user-plugin - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-show-report - -____ - - Displays report of the plugin given. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user (+ plugin in $2), plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 71 line(s). Calls functions: - - .zinit-show-report - |-- .zinit-check-which-completions-are-enabled - |-- .zinit-check-which-completions-are-installed - |-- .zinit-diff-env-compute - |-- .zinit-diff-functions-compute - |-- .zinit-diff-options-compute - |-- .zinit-diff-parameter-compute - |-- .zinit-exists-message - |   |-- .zinit-any-to-uspl2 - |   |   `-- zinit.zsh/.zinit-any-to-user-plugin - |   `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- .zinit-find-completions-of-plugin - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- .zinit-format-env - |-- .zinit-format-functions - |-- .zinit-format-options - |   |-- .zinit-restore-extendedglob - |   `-- .zinit-save-set-extendedglob - |-- .zinit-format-parameter - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _setopt_ - -Called by: - - .zinit-show-all-reports - .zinit-show-debug-report - zinit-additional.zsh/.zinit-debug-report - zinit.zsh/zinit - -==== .zinit-show-times - -____ - - Shows loading times of all loaded plugins. - - User-action entry point. - -____ - -Has 65 line(s). Calls functions: - - .zinit-show-times - `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-show-zstatus - -____ - - Shows Zinit status, i.e. number of loaded plugins, - of available completions, etc. - - User-action entry point. - -____ - -Has 48 line(s). Calls functions: - - .zinit-show-zstatus - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-stress - -____ - - Compiles plugin with various options on and off to see - how well the code is written. The options are: - - NO_SHORT_LOOPS, IGNORE_BRACES, IGNORE_CLOSE_BRACES, SH_GLOB, - CSH_JUNKIE_QUOTES, NO_MULTI_FUNC_DEF. - - User-action entry point. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 38 line(s). Calls functions: - - .zinit-stress - |-- zinit-side.zsh/.zinit-exists-physically-message - |-- zinit-side.zsh/.zinit-first - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _setopt_, _zcompile_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-uncompile-plugin - -____ - - Uncompiles given plugin. - - User-action entry point. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user (+ plugin in $2), plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 22 line(s). Calls functions: - - .zinit-uncompile-plugin - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _setopt_ - -Called by: - - .zinit-compile-uncompile-all - zinit.zsh/zinit - -==== .zinit-uninstall-completions - -____ - - Removes all completions of given plugin from Zshell (i.e. from FPATH). - The FPATH is typically `~/.zinit/completions/'. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 46 line(s). Calls functions: - - .zinit-uninstall-completions - |-- .zinit-get-path - |   `-- zinit.zsh/.zinit-get-object-path - |-- zinit-install.zsh/.zinit-compinit - |-- zinit-install.zsh/.zinit-forget-completion - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_, _source_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-unload - -____ - - 1. call the zsh plugin's standard *_plugin_unload function - 2. call the code provided by the zsh plugin's standard @zsh-plugin-run-at-update - 3. delete bindkeys (...) - 4. delete zstyles - 5. restore options - 6. remove aliases - 7. restore zle state - 8. unfunction functions (created by plugin) - 9. clean-up fpath and path - 10. delete created variables - 11. forget the plugin - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 385 line(s). Calls functions: - - .zinit-unload - |-- .zinit-clear-report-for - |   `-- .zinit-any-to-uspl2 - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- .zinit-diff-env-compute - |-- .zinit-diff-functions-compute - |-- .zinit-diff-options-compute - |-- .zinit-diff-parameter-compute - |-- .zinit-exists-message - |   |-- .zinit-any-to-uspl2 - |   |   `-- zinit.zsh/.zinit-any-to-user-plugin - |   `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- .zinit-restore-extendedglob - |-- .zinit-save-set-extendedglob - |-- .zinit-unregister-plugin - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- zinit-additional.zsh/.zinit-debug-clear - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- zinit.zsh/+zi-log - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _alias_, _bindkey_, _eval_, _setopt_, _unalias_, _unfunction_, _zle_, _zstyle_ - -Called by: - - zinit-additional.zsh/.zinit-debug-revert - zinit.zsh/.zinit-run-task - zinit.zsh/zinit - -==== .zinit-unregister-plugin - -____ - - Removes the plugin from ZINIT_REGISTERED_PLUGINS array and from the - zsh_loaded_plugins array (managed according to the plugin standard) - -____ - -Has 6 line(s). Calls functions: - - .zinit-unregister-plugin - `-- zinit.zsh/.zinit-any-to-user-plugin - -Called by: - - .zinit-unload - -==== .zinit-update-all-parallel - -Has 84 line(s). Calls functions: - - .zinit-update-all-parallel - |-- .zinit-update-or-status - |   |-- .zinit-pager - |   |-- .zinit-update-or-status-snippet - |   |   |-- zinit-install.zsh/.zinit-update-snippet - |   |   `-- zinit-side.zsh/.zinit-compute-ice - |   |-- zinit-install.zsh/.zinit-get-latest-gh-r-url-part - |   |-- zinit-install.zsh/.zinit-setup-plugin-dir - |   |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |   |-- zinit-side.zsh/.zinit-compute-ice - |   |-- zinit-side.zsh/.zinit-exists-physically - |   |-- zinit-side.zsh/.zinit-exists-physically-message - |   |-- zinit-side.zsh/.zinit-store-ices - |   |-- zinit-side.zsh/.zinit-two-paths - |   |-- zinit.zsh/+zi-log - |   |-- zinit.zsh/.zinit-any-to-user-plugin - |   `-- zinit.zsh/.zinit-set-m-func - |-- .zinit-update-or-status-snippet - |   |-- zinit-install.zsh/.zinit-update-snippet - |   `-- zinit-side.zsh/.zinit-compute-ice - |-- .zinit-wait-for-update-jobs - |   `-- zinit.zsh/+zi-log - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- zinit.zsh/+zi-log - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _setopt_ - -Called by: - - .zinit-update-or-status-all - -==== .zinit-update-or-status - -____ - - Updates (git pull) or does `git status' for given plugin. - - User-action entry point. - - $1 - "status" for status, other for update - $2 - plugin spec (4 formats: user---plugin, user/plugin, user (+ plugin in $2), plugin) - $3 - plugin (only when $1 - i.e. user - given) - -____ - -Has 325 line(s). Calls functions: - - .zinit-update-or-status - |-- .zinit-pager - |-- .zinit-update-or-status-snippet - |   |-- zinit-install.zsh/.zinit-update-snippet - |   `-- zinit-side.zsh/.zinit-compute-ice - |-- zinit-install.zsh/.zinit-get-latest-gh-r-url-part - |-- zinit-install.zsh/.zinit-setup-plugin-dir - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- zinit-side.zsh/.zinit-compute-ice - |-- zinit-side.zsh/.zinit-exists-physically - |-- zinit-side.zsh/.zinit-exists-physically-message - |-- zinit-side.zsh/.zinit-store-ices - |-- zinit-side.zsh/.zinit-two-paths - |-- zinit.zsh/+zi-log - |-- zinit.zsh/.zinit-any-to-user-plugin - `-- zinit.zsh/.zinit-set-m-func - -Uses feature(s): _kill_, _read_, _setopt_, _source_, _trap_, _wait_ - -Called by: - - .zinit-update-all-parallel - .zinit-update-or-status-all - zinit.zsh/zinit - -==== .zinit-update-or-status-all - -____ - - Updates (git pull) or does `git status` for all existing plugins. - This includes also plugins that are not loaded into Zsh (but exist - on disk). Also updates (i.e. redownloads) snippets. - - User-action entry point. - -____ - -Has 133 line(s). Calls functions: - - .zinit-update-or-status-all - |-- .zinit-self-update - |   |-- .zi-check-for-git-changes - |   |   `-- zinit.zsh/+zi-log - |   |-- .zinit-pager - |   |-- zinit.zsh/+zi-log - |   `-- zinit.zsh/.zinit-get-mtime-into - |-- .zinit-update-all-parallel - |   |-- .zinit-update-or-status - |   |   |-- .zinit-pager - |   |   |-- .zinit-update-or-status-snippet - |   |   |   |-- zinit-install.zsh/.zinit-update-snippet - |   |   |   `-- zinit-side.zsh/.zinit-compute-ice - |   |   |-- zinit-install.zsh/.zinit-get-latest-gh-r-url-part - |   |   |-- zinit-install.zsh/.zinit-setup-plugin-dir - |   |   |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |   |   |-- zinit-side.zsh/.zinit-compute-ice - |   |   |-- zinit-side.zsh/.zinit-exists-physically - |   |   |-- zinit-side.zsh/.zinit-exists-physically-message - |   |   |-- zinit-side.zsh/.zinit-store-ices - |   |   |-- zinit-side.zsh/.zinit-two-paths - |   |   |-- zinit.zsh/+zi-log - |   |   |-- zinit.zsh/.zinit-any-to-user-plugin - |   |   `-- zinit.zsh/.zinit-set-m-func - |   |-- .zinit-update-or-status-snippet - |   |   |-- zinit-install.zsh/.zinit-update-snippet - |   |   `-- zinit-side.zsh/.zinit-compute-ice - |   |-- .zinit-wait-for-update-jobs - |   |   `-- zinit.zsh/+zi-log - |   |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |   |-- zinit.zsh/+zi-log - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- .zinit-update-or-status - |   |-- .zinit-pager - |   |-- .zinit-update-or-status-snippet - |   |   |-- zinit-install.zsh/.zinit-update-snippet - |   |   `-- zinit-side.zsh/.zinit-compute-ice - |   |-- zinit-install.zsh/.zinit-get-latest-gh-r-url-part - |   |-- zinit-install.zsh/.zinit-setup-plugin-dir - |   |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |   |-- zinit-side.zsh/.zinit-compute-ice - |   |-- zinit-side.zsh/.zinit-exists-physically - |   |-- zinit-side.zsh/.zinit-exists-physically-message - |   |-- zinit-side.zsh/.zinit-store-ices - |   |-- zinit-side.zsh/.zinit-two-paths - |   |-- zinit.zsh/+zi-log - |   |-- zinit.zsh/.zinit-any-to-user-plugin - |   `-- zinit.zsh/.zinit-set-m-func - |-- .zinit-update-or-status-snippet - |   |-- zinit-install.zsh/.zinit-update-snippet - |   `-- zinit-side.zsh/.zinit-compute-ice - |-- zinit-install.zsh/.zinit-compinit - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- zinit.zsh/+zi-log - |-- zinit.zsh/.zinit-any-to-user-plugin - `-- zinit.zsh/.zinit-get-mtime-into - -Uses feature(s): _setopt_, _source_ - -Called by: - - zinit.zsh/zinit - -==== .zinit-update-or-status-snippet - -____ - - - Implements update or status operation for snippet given by URL. - - $1 - "status" or "update" - $2 - snippet URL - -____ - -Has 34 line(s). Calls functions: - - .zinit-update-or-status-snippet - |-- zinit-install.zsh/.zinit-update-snippet - `-- zinit-side.zsh/.zinit-compute-ice - -Uses feature(s): _source_ - -Called by: - - .zinit-update-all-parallel - .zinit-update-or-status-all - .zinit-update-or-status - -==== .zinit-wait-for-update-jobs - -Has 18 line(s). Calls functions: - - .zinit-wait-for-update-jobs - `-- zinit.zsh/+zi-log - -Uses feature(s): _wait_ - -Called by: - - .zinit-update-all-parallel - -==== zi::version - -____ - - Shows usage information. - - User-action entry point. - -____ - -Has 2 line(s). Calls functions: - - zi::version - `-- zinit.zsh/+zi-log - -Called by: - - zinit.zsh/zinit - diff --git a/doc/zsdoc/zinit-install.zsh.adoc b/doc/zsdoc/zinit-install.zsh.adoc deleted file mode 100644 index 9616b218d..000000000 --- a/doc/zsdoc/zinit-install.zsh.adoc +++ /dev/null @@ -1,865 +0,0 @@ - -NAME - -zinit-install.zsh - a shell script - -Documentation automatically generated with `zshelldoc' - -== FUNCTIONS - +zinit-cmake-hook - .zi::get-architecture - .zinit-at-eval - .zinit-compile-plugin - .zinit-compinit - .zinit-download-file-stdout - .zinit-download-snippet - .zinit-extract - .zinit-forget-completion - .zinit-get-cygwin-package - .zinit-get-latest-gh-r-url-part - .zinit-get-package - .zinit-get-url-mtime - .zinit-install-completions - .zinit-jq-check - .zinit-json-get-value - .zinit-json-to-array - .zinit-mirror-using-svn - .zinit-setup-plugin-dir - .zinit-single-line - .zinit-update-snippet - __zinit-cmake-base-hook - zicp - ziextract - zimv - zpextract - ∞zinit-atclone-hook - ∞zinit-atpull-e-hook - ∞zinit-atpull-hook - ∞zinit-compile-plugin-hook - ∞zinit-configure-base-hook - ∞zinit-configure-e-hook - ∞zinit-configure-hook - ∞zinit-cp-hook - ∞zinit-extract-hook - ∞zinit-make-base-hook - ∞zinit-make-e-hook - ∞zinit-make-ee-hook - ∞zinit-make-hook - ∞zinit-mv-hook - ∞zinit-ps-on-update-hook - ∞zinit-reset-hook -AUTOLOAD compinit - -=== DETAILS - -==== Script Body - -Has 6 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_ - -==== +zinit-cmake-hook - -Has 1 line(s). Calls functions: - - +zinit-cmake-hook - `-- __zinit-cmake-base-hook - `-- zinit.zsh/+zi-log - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zi::get-architecture - -Has 39 line(s). Calls functions: - - .zi::get-architecture - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-at-eval - -Has 9 line(s). Calls functions: - - .zinit-at-eval - `-- zinit.zsh/@zinit-substitute - -Uses feature(s): _eval_ - -Called by: - - ∞zinit-atpull-e-hook - ∞zinit-atpull-hook - -==== .zinit-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 89 line(s). Calls functions: - - .zinit-compile-plugin - |-- zinit-side.zsh/.zinit-compute-ice - |-- zinit-side.zsh/.zinit-first - `-- zinit.zsh/+zi-log - -Uses feature(s): _eval_, _setopt_, _zcompile_ - -Called by: - - ∞zinit-compile-plugin-hook - zinit-autoload.zsh/.zinit-compile-uncompile-all - zinit.zsh/zinit - -==== .zinit-compinit - -____ - - User-exposed `compinit' frontend which first ensures that all - completions managed by Zinit are forgotten by Zshell. After - that it runs normal `compinit', which should more easily detect - Zinit's completions. - - No arguments. - -____ - -Has 26 line(s). Calls functions: - - .zinit-compinit - |-- .zinit-forget-completion - |-- compinit - `-- zinit.zsh/+zi-log - -Uses feature(s): _autoload_, _compinit_, _setopt_, _unfunction_ - -Called by: - - .zinit-install-completions - zinit-autoload.zsh/.zinit-uninstall-completions - zinit-autoload.zsh/.zinit-update-or-status-all - zinit.zsh/.zinit-prepare-home - zinit.zsh/zinit - -==== .zinit-download-file-stdout - -____ - - Downloads file to stdout. Supports following backend commands: - curl, wget, lftp, lynx. Used by snippet loading. - -____ - -Has 53 line(s). Calls functions: - - .zinit-download-file-stdout - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_, _trap_, _type_ - -Called by: - - .zinit-download-snippet - .zinit-get-cygwin-package - .zinit-get-package - .zinit-setup-plugin-dir - -==== .zinit-download-snippet - -____ - - Downloads snippet - file – with curl, wget, lftp or lynx, - 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 377 line(s). Calls functions: - - .zinit-download-snippet - |-- .zinit-download-file-stdout - |   `-- zinit.zsh/+zi-log - |-- .zinit-get-url-mtime - |-- .zinit-install-completions - |   |-- .zinit-compinit - |   |   |-- .zinit-forget-completion - |   |   |-- compinit - |   |   `-- zinit.zsh/+zi-log - |   |-- .zinit-forget-completion - |   |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |   |-- zinit-side.zsh/.zinit-exists-physically-message - |   |-- zinit.zsh/+zi-log - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- .zinit-mirror-using-svn - |-- zinit-side.zsh/.zinit-store-ices - |-- zinit.zsh/+zi-log - `-- zinit.zsh/is-at-least - -Uses feature(s): _is-at-least_, _setopt_, _trap_, _zcompile_ - -Called by: - - .zinit-update-snippet - zinit.zsh/.zinit-load-snippet - -==== .zinit-extract - -Has 30 line(s). Calls functions: - - .zinit-extract - |-- ziextract - |   `-- zinit.zsh/+zi-log - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_ - -Called by: - - ∞zinit-extract-hook - -==== .zinit-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 20 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_, _unfunction_ - -Called by: - - .zinit-compinit - .zinit-install-completions - zinit-autoload.zsh/.zinit-uninstall-completions - zinit.zsh/zinit - -==== .zinit-get-cygwin-package - -Has 70 line(s). Calls functions: - - .zinit-get-cygwin-package - |-- .zinit-download-file-stdout - |   `-- zinit.zsh/+zi-log - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_ - -Called by: - - .zinit-setup-plugin-dir - -==== .zinit-get-latest-gh-r-url-part - -____ - - Gets version string of latest release of given Github - package. Connects to Github releases page. - -____ - -Has 55 line(s). Calls functions: - - .zinit-get-latest-gh-r-url-part - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_ - -Called by: - - .zinit-setup-plugin-dir - zinit-autoload.zsh/.zinit-update-or-status - -==== .zinit-get-package - -Has 195 line(s). Calls functions: - - .zinit-get-package - |-- .zinit-download-file-stdout - |   `-- zinit.zsh/+zi-log - |-- .zinit-jq-check - |   `-- zinit.zsh/+zi-log - |-- .zinit-json-to-array - |   `-- .zinit-jq-check - |   `-- zinit.zsh/+zi-log - |-- ziextract - |   `-- zinit.zsh/+zi-log - |-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Uses feature(s): _eval_, _setopt_, _trap_ - -Called by: - - zinit.zsh/.zinit-load - -==== .zinit-get-url-mtime - -____ - - For the given URL returns the date in the Last-Modified - header as a time stamp - -____ - -Has 35 line(s). Doesn't call other functions. - -Uses feature(s): _read_, _setopt_, _trap_, _type_ - -Called by: - - .zinit-download-snippet - -==== .zinit-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 'completions' subcommand. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin if $1 (i.e., user) given - $3 - if 1, then reinstall, otherwise only install completions that are not present - -____ - -Has 62 line(s). Calls functions: - - .zinit-install-completions - |-- .zinit-compinit - |   |-- .zinit-forget-completion - |   |-- compinit - |   `-- zinit.zsh/+zi-log - |-- .zinit-forget-completion - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- zinit-side.zsh/.zinit-exists-physically-message - |-- zinit.zsh/+zi-log - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _setopt_ - -Called by: - - .zinit-download-snippet - .zinit-setup-plugin-dir - zinit.zsh/zinit - -==== .zinit-jq-check - -____ - - Check if jq is available and outputs an error message with instructions if - that's not the case - -____ - -Has 8 line(s). Calls functions: - - .zinit-jq-check - `-- zinit.zsh/+zi-log - -Called by: - - .zinit-get-package - .zinit-json-get-value - .zinit-json-to-array - -==== .zinit-json-get-value - -____ - - Wrapper around jq that return the value of a property - - $1: JSON structure - $2: jq path - -____ - -Has 4 line(s). Calls functions: - - .zinit-json-get-value - `-- .zinit-jq-check - `-- zinit.zsh/+zi-log - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-json-to-array - -____ - - Wrapper around jq that sets key/values of an associative array, replicating - the structure of a given JSON object - - $1: JSON structure - $2: jq path - $3: name of the associative array to store the key/value pairs in - -____ - -Has 13 line(s). Calls functions: - - .zinit-json-to-array - `-- .zinit-jq-check - `-- zinit.zsh/+zi-log - -Uses feature(s): _eval_, _setopt_ - -Called by: - - .zinit-get-package - -==== .zinit-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 29 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-download-snippet - -==== .zinit-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 213 line(s). Calls functions: - - .zinit-setup-plugin-dir - |-- .zinit-download-file-stdout - |   `-- zinit.zsh/+zi-log - |-- .zinit-get-cygwin-package - |   |-- .zinit-download-file-stdout - |   |   `-- zinit.zsh/+zi-log - |   `-- zinit.zsh/+zi-log - |-- .zinit-get-latest-gh-r-url-part - |   `-- zinit.zsh/+zi-log - |-- .zinit-install-completions - |   |-- .zinit-compinit - |   |   |-- .zinit-forget-completion - |   |   |-- compinit - |   |   `-- zinit.zsh/+zi-log - |   |-- .zinit-forget-completion - |   |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |   |-- zinit-side.zsh/.zinit-exists-physically-message - |   |-- zinit.zsh/+zi-log - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- ziextract - |   `-- zinit.zsh/+zi-log - |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |-- zinit-side.zsh/.zinit-store-ices - |-- zinit.zsh/+zi-log - `-- zinit.zsh/.zinit-get-object-path - -Uses feature(s): _setopt_, _trap_ - -Called by: - - zinit-autoload.zsh/.zinit-update-or-status - zinit.zsh/.zinit-load - -==== .zinit-single-line - -____ - - Display cURL progress bar on a single line - -____ - -Has 20 line(s). Doesn't call other functions. - -Uses feature(s): _read_, _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-update-snippet - -Has 76 line(s). Calls functions: - - .zinit-update-snippet - |-- .zinit-download-snippet - |   |-- .zinit-download-file-stdout - |   |   `-- zinit.zsh/+zi-log - |   |-- .zinit-get-url-mtime - |   |-- .zinit-install-completions - |   |   |-- .zinit-compinit - |   |   |   |-- .zinit-forget-completion - |   |   |   |-- compinit - |   |   |   `-- zinit.zsh/+zi-log - |   |   |-- .zinit-forget-completion - |   |   |-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - |   |   |-- zinit-side.zsh/.zinit-exists-physically-message - |   |   |-- zinit.zsh/+zi-log - |   |   `-- zinit.zsh/.zinit-any-to-user-plugin - |   |-- .zinit-mirror-using-svn - |   |-- zinit-side.zsh/.zinit-store-ices - |   |-- zinit.zsh/+zi-log - |   `-- zinit.zsh/is-at-least - |-- zinit.zsh/+zi-log - |-- zinit.zsh/.zinit-get-object-path - `-- zinit.zsh/.zinit-pack-ice - -Uses feature(s): _eval_, _setopt_ - -Called by: - - zinit-autoload.zsh/.zinit-update-or-status-snippet - -==== __zinit-cmake-base-hook - -____ - - FUNCTION: __zinit-cmake-base-hook [[[ - A base common implementation of the cmake ice - -____ - -Has 23 line(s). Calls functions: - - __zinit-cmake-base-hook - `-- zinit.zsh/+zi-log - -Uses feature(s): _eval_, _setopt_ - -Called by: - - +zinit-cmake-hook - -==== zicp - -Has 30 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - zimv - -==== ziextract - -____ - - 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 294 line(s). Calls functions: - - ziextract - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_, _unfunction_, _zparseopts_ - -Called by: - - .zinit-extract - .zinit-get-package - .zinit-setup-plugin-dir - zpextract - -==== zimv - -Has 3 line(s). Calls functions: - - zimv - `-- zicp - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== zpextract - -Has 1 line(s). Calls functions: - - zpextract - `-- ziextract - `-- zinit.zsh/+zi-log - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-atclone-hook - -Has 26 line(s). Calls functions: - - ∞zinit-atclone-hook - |-- zinit-side.zsh/.zinit-countdown - `-- zinit.zsh/@zinit-substitute - -Uses feature(s): _eval_, _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-atpull-e-hook - -Has 22 line(s). Calls functions: - - ∞zinit-atpull-e-hook - |-- .zinit-at-eval - |   `-- zinit.zsh/@zinit-substitute - `-- zinit-side.zsh/.zinit-countdown - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-atpull-hook - -Has 22 line(s). Calls functions: - - ∞zinit-atpull-hook - |-- .zinit-at-eval - |   `-- zinit.zsh/@zinit-substitute - `-- zinit-side.zsh/.zinit-countdown - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-compile-plugin-hook - -Has 19 line(s). Calls functions: - - ∞zinit-compile-plugin-hook - `-- .zinit-compile-plugin - |-- zinit-side.zsh/.zinit-compute-ice - |-- zinit-side.zsh/.zinit-first - `-- zinit.zsh/+zi-log - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-configure-base-hook - -____ - - A base common implementation of the configure ice - -____ - -Has 45 line(s). Calls functions: - - ∞zinit-configure-base-hook - |-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Uses feature(s): _eval_, _setopt_ - -Called by: - - ∞zinit-configure-e-hook - ∞zinit-configure-hook - -==== ∞zinit-configure-e-hook - -Has 1 line(s). Calls functions: - - ∞zinit-configure-e-hook - `-- ∞zinit-configure-base-hook - |-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-configure-hook - -____ - - The non-! version of configure'' ice. Runs in between - of make'!' and make''. Configure script naturally runs - before make. - -____ - -Has 1 line(s). Calls functions: - - ∞zinit-configure-hook - `-- ∞zinit-configure-base-hook - |-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-cp-hook - -Has 30 line(s). Calls functions: - - ∞zinit-cp-hook - `-- zinit.zsh/@zinit-substitute - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-extract-hook - -Has 10 line(s). Calls functions: - - ∞zinit-extract-hook - |-- .zinit-extract - |   |-- ziextract - |   |   `-- zinit.zsh/+zi-log - |   `-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-make-base-hook - -____ - - A base common implementation of the make ice - -____ - -Has 57 line(s). Calls functions: - - ∞zinit-make-base-hook - |-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Uses feature(s): _eval_, _setopt_ - -Called by: - - ∞zinit-make-e-hook - ∞zinit-make-ee-hook - ∞zinit-make-hook - -==== ∞zinit-make-e-hook - -Has 1 line(s). Calls functions: - - ∞zinit-make-e-hook - `-- ∞zinit-make-base-hook - |-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-make-ee-hook - -Has 1 line(s). Calls functions: - - ∞zinit-make-ee-hook - `-- ∞zinit-make-base-hook - |-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-make-hook - -Has 1 line(s). Calls functions: - - ∞zinit-make-hook - `-- ∞zinit-make-base-hook - |-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-mv-hook - -Has 35 line(s). Calls functions: - - ∞zinit-mv-hook - |-- zinit.zsh/+zi-log - `-- zinit.zsh/@zinit-substitute - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-ps-on-update-hook - -Has 18 line(s). Calls functions: - - ∞zinit-ps-on-update-hook - `-- zinit.zsh/+zi-log - -Uses feature(s): _eval_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== ∞zinit-reset-hook - -Has 79 line(s). Calls functions: - - ∞zinit-reset-hook - `-- zinit.zsh/+zi-log - -Uses feature(s): _eval_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== 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 573 line(s). Doesn't call other functions. - -Uses feature(s): _autoload_, _bindkey_, _compdef_, _compdump_, _eval_, _read_, _setopt_, _unfunction_, _zle_, _zstyle_ - -Called by: - - .zinit-compinit - diff --git a/doc/zsdoc/zinit-side.zsh.adoc b/doc/zsdoc/zinit-side.zsh.adoc deleted file mode 100644 index 8516e7b51..000000000 --- a/doc/zsdoc/zinit-side.zsh.adoc +++ /dev/null @@ -1,287 +0,0 @@ - -NAME - -zinit-side.zsh - a shell script - -Documentation automatically generated with `zshelldoc' - -== FUNCTIONS - .zinit-any-colorify-as-uspl2 - .zinit-compute-ice - .zinit-countdown - .zinit-exists-physically - .zinit-exists-physically-message - .zinit-first - .zinit-store-ices - .zinit-two-paths - -=== DETAILS - -==== Script Body - -Has 1 line(s). No functions are called (may set up e.g. a hook, a Zle widget bound to a key, etc.). - -==== .zinit-any-colorify-as-uspl2 - -____ - - Returns ANSI-colorified "user/plugin" string, from any supported - plugin spec (user---plugin, user/plugin, user plugin, plugin). - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - - $REPLY - ANSI-colorified "user/plugin" string - -____ - -Has 22 line(s). Calls functions: - - .zinit-any-colorify-as-uspl2 - |-- zinit.zsh/.zinit-any-to-pid - `-- zinit.zsh/.zinit-any-to-user-plugin - -Called by: - - .zinit-exists-physically-message - zinit-autoload.zsh/.zinit-clear-completions - zinit-autoload.zsh/.zinit-compile-uncompile-all - zinit-autoload.zsh/.zinit-compiled - zinit-autoload.zsh/.zinit-create - zinit-autoload.zsh/.zinit-exists-message - zinit-autoload.zsh/.zinit-get-completion-owner-uspl2col - zinit-autoload.zsh/.zinit-list-bindkeys - zinit-autoload.zsh/.zinit-recently - zinit-autoload.zsh/.zinit-search-completions - zinit-autoload.zsh/.zinit-show-completions - zinit-autoload.zsh/.zinit-show-times - zinit-autoload.zsh/.zinit-uncompile-plugin - zinit-autoload.zsh/.zinit-unload - zinit-autoload.zsh/.zinit-update-all-parallel - zinit-autoload.zsh/.zinit-update-or-status-all - zinit-autoload.zsh/.zinit-update-or-status - zinit-install.zsh/.zinit-install-completions - zinit-install.zsh/.zinit-setup-plugin-dir - zinit.zsh/.zinit-formatter-pid - -==== .zinit-compute-ice - -____ - - Computes ICE array - - input - - static - - saved - taking priorities into account. - Can also pack resulting ices into ZINIT_SICE (see $2). - Returns filepath to snippet directory and optional snippet file name (only - valid if ICE[svn] is not set). - - $1 - URL (also plugin-spec) - $2 - "pack" or "nopack" or "pack-nf" - packing means ICE - wins with static ice; "pack-nf" means that disk-ices will - be ignored (no-file?) - $3 - name of output associative array, "ICE" is the default - $4 - name of output string parameter, to hold path to directory ("local_dir") - $5 - name of output string parameter, to hold filename ("filename") - $6 - name of output string parameter, to hold is-snippet 0/1-bool ("is_snippet") - - $REPLY - snippet directory filepath - -____ - -Has 110 line(s). Calls functions: - - .zinit-compute-ice - |-- .zinit-exists-physically-message - |   |-- .zinit-any-colorify-as-uspl2 - |   |   |-- zinit.zsh/.zinit-any-to-pid - |   |   `-- zinit.zsh/.zinit-any-to-user-plugin - |   |-- .zinit-exists-physically - |   |   `-- zinit.zsh/.zinit-any-to-user-plugin - |   |-- zinit.zsh/+zi-log - |   |-- zinit.zsh/.zinit-any-to-pid - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- .zinit-two-paths - |   |-- .zinit-first - |   |   |-- zinit.zsh/.zinit-any-to-pid - |   |   |-- zinit.zsh/.zinit-any-to-user-plugin - |   |   |-- zinit.zsh/.zinit-find-other-matches - |   |   `-- zinit.zsh/.zinit-get-object-path - |   `-- zinit.zsh/.zinit-get-object-path - |-- zinit.zsh/.zinit-any-to-user-plugin - `-- zinit.zsh/.zinit-pack-ice - -Uses feature(s): _setopt_ - -Called by: - - zinit-autoload.zsh/.zinit-delete - zinit-autoload.zsh/.zinit-edit - zinit-autoload.zsh/.zinit-recall - zinit-autoload.zsh/.zinit-update-or-status-snippet - zinit-autoload.zsh/.zinit-update-or-status - zinit-install.zsh/.zinit-compile-plugin - -==== .zinit-countdown - -____ - - Displays a countdown 5...4... etc. - - $REPLY - 1 if Ctrl-C is pressed, otherwise 0 - -____ - -Has 20 line(s). Calls functions: - - .zinit-countdown - `-- zinit.zsh/+zi-log - -Uses feature(s): _trap_ - -Called by: - - zinit-install.zsh/∞zinit-atclone-hook - zinit-install.zsh/∞zinit-atpull-e-hook - zinit-install.zsh/∞zinit-atpull-hook - -==== .zinit-exists-physically - -____ - - Checks if directory of given plugin exists in PLUGIN_DIR. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 8 line(s). Calls functions: - - .zinit-exists-physically - `-- zinit.zsh/.zinit-any-to-user-plugin - -Called by: - - .zinit-exists-physically-message - zinit-autoload.zsh/.zinit-create - zinit-autoload.zsh/.zinit-update-or-status - -==== .zinit-exists-physically-message - -____ - - Checks if directory of given plugin exists in PLUGIN_DIR, and outputs error - message if it doesn't. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 25 line(s). Calls functions: - - .zinit-exists-physically-message - |-- .zinit-any-colorify-as-uspl2 - |   |-- zinit.zsh/.zinit-any-to-pid - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- .zinit-exists-physically - |   `-- zinit.zsh/.zinit-any-to-user-plugin - |-- zinit.zsh/+zi-log - |-- zinit.zsh/.zinit-any-to-pid - `-- zinit.zsh/.zinit-any-to-user-plugin - -Uses feature(s): _setopt_ - -Called by: - - .zinit-compute-ice - zinit-autoload.zsh/.zinit-changes - zinit-autoload.zsh/.zinit-glance - zinit-autoload.zsh/.zinit-stress - zinit-autoload.zsh/.zinit-update-or-status - zinit-install.zsh/.zinit-install-completions - -==== .zinit-first - -____ - - Finds the main file of plugin. There are multiple file name formats, they are - ordered in order starting from more correct ones, and matched. - .zinit-load-plugin() has similar code parts and doesn't call .zinit-first() – - for performance. Obscure matching is done in .zinit-find-other-matches, here - and in .zinit-load(). Obscure = non-standard main-file naming convention. - - $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin) - $2 - plugin (only when $1 - i.e. user - given) - -____ - -Has 20 line(s). Calls functions: - - .zinit-first - |-- zinit.zsh/.zinit-any-to-pid - |-- zinit.zsh/.zinit-any-to-user-plugin - |-- zinit.zsh/.zinit-find-other-matches - `-- zinit.zsh/.zinit-get-object-path - -Called by: - - .zinit-two-paths - zinit-autoload.zsh/.zinit-glance - zinit-autoload.zsh/.zinit-stress - zinit-install.zsh/.zinit-compile-plugin - -==== .zinit-store-ices - -____ - - Saves ice mods in given hash onto disk. - - $1 - directory where to create or delete files - $2 - name of hash that holds values - $3 - additional keys of hash to store, space separated - $4 - additional keys of hash to store, empty-meaningful ices, space separated - $5 – URL, if applicable - $6 – mode, svn=1, 0=single file - -____ - -Has 30 line(s). Doesn't call other functions. - -Called by: - - zinit-autoload.zsh/.zinit-update-or-status - zinit-install.zsh/.zinit-download-snippet - zinit-install.zsh/.zinit-setup-plugin-dir - -==== .zinit-two-paths - -____ - - Obtains a snippet URL without specification if it is an SVN URL (points to - directory) or regular URL (points to file), returns 2 possible paths for - further examination - - $REPLY - two filepaths - -____ - -Has 24 line(s). Calls functions: - - .zinit-two-paths - |-- .zinit-first - |   |-- zinit.zsh/.zinit-any-to-pid - |   |-- zinit.zsh/.zinit-any-to-user-plugin - |   |-- zinit.zsh/.zinit-find-other-matches - |   `-- zinit.zsh/.zinit-get-object-path - `-- zinit.zsh/.zinit-get-object-path - -Uses feature(s): _setopt_ - -Called by: - - .zinit-compute-ice - zinit-autoload.zsh/.zinit-update-or-status - diff --git a/doc/zsdoc/zinit.zsh.adoc b/doc/zsdoc/zinit.zsh.adoc deleted file mode 100644 index 4d0b4ef00..000000000 --- a/doc/zsdoc/zinit.zsh.adoc +++ /dev/null @@ -1,1973 +0,0 @@ - -NAME - -zinit.zsh - a shell script - -Documentation automatically generated with `zshelldoc' - -== FUNCTIONS - +zi-log - +zinit-deploy-message - +zinit-message - +zinit-prehelp-usage-message - -zinit_scheduler_add_sh - .zinit-add-fpath - .zinit-add-report - .zinit-any-to-pid - .zinit-any-to-user-plugin - .zinit-compdef-clear - .zinit-compdef-replay - .zinit-diff - .zinit-diff-env - .zinit-diff-functions - .zinit-diff-options - .zinit-diff-parameter - .zinit-find-other-matches - .zinit-formatter-auto - .zinit-formatter-bar - .zinit-formatter-bar-util - .zinit-formatter-pid - .zinit-formatter-th-bar - .zinit-formatter-url - .zinit-get-mtime-into - .zinit-get-object-path - .zinit-ice - .zinit-load - .zinit-load-ices - .zinit-load-object - .zinit-load-plugin - .zinit-load-snippet - .zinit-main-message-formatter - .zinit-pack-ice - .zinit-parse-opts - .zinit-prepare-home - .zinit-register-plugin - .zinit-run - .zinit-run-task - .zinit-set-m-func - .zinit-setup-params - .zinit-submit-turbo - .zinit-tmp-subst-off - .zinit-tmp-subst-on - .zinit-util-shands-path - :zinit-reload-and-run - :zinit-tmp-subst-alias - :zinit-tmp-subst-autoload - :zinit-tmp-subst-bindkey - :zinit-tmp-subst-compdef - :zinit-tmp-subst-zle - :zinit-tmp-subst-zstyle - @autoload - @zinit-register-annex - @zinit-register-hook - @zinit-substitute - @zsh-plugin-run-on-unload - @zsh-plugin-run-on-update - pmodload - zicdclear - zicdreplay - zicompdef - zicompinit - zinit - zpcdclear - zpcdreplay - zpcompdef - zpcompinit - zplugin -AUTOLOAD add-zsh-hook -AUTOLOAD colors -AUTOLOAD compinit -AUTOLOAD is-at-least -PRECMD-HOOK @zinit-scheduler - -=== DETAILS - -==== Script Body - -Has 259 line(s). Calls functions: - - Script-Body - |-- +zi-log - |-- .zinit-get-mtime-into - |-- .zinit-prepare-home - |   |-- zinit-autoload.zsh/.zinit-clear-completions - |   `-- zinit-install.zsh/.zinit-compinit - |-- @zinit-register-hook - |-- add-zsh-hook - |-- colors - |-- is-at-least - |-- zinit - |   |-- +zi-log - |   |-- +zinit-prehelp-usage-message - |   |   `-- +zi-log - |   |-- .zinit-add-fpath - |   |   `-- .zinit-any-to-user-plugin - |   |-- .zinit-compdef-clear - |   |   `-- +zi-log - |   |-- .zinit-compdef-replay - |   |   `-- +zi-log - |   |-- .zinit-get-object-path - |   |   `-- .zinit-any-to-user-plugin - |   |-- .zinit-ice - |   |   `-- +zi-log - |   |-- .zinit-load-ices - |   |   `-- .zinit-get-object-path - |   |   `-- .zinit-any-to-user-plugin - |   |-- .zinit-load-object - |   |   |-- .zinit-load - |   |   |   |-- +zinit-deploy-message - |   |   |   |-- .zinit-any-to-user-plugin - |   |   |   |-- .zinit-load-plugin - |   |   |   |   |-- .zinit-add-report - |   |   |   |   |-- .zinit-diff - |   |   |   |   |   |-- .zinit-diff-env - |   |   |   |   |   |-- .zinit-diff-functions - |   |   |   |   |   |-- .zinit-diff-options - |   |   |   |   |   `-- .zinit-diff-parameter - |   |   |   |   |-- .zinit-diff-env - |   |   |   |   |-- .zinit-find-other-matches - |   |   |   |   |-- .zinit-tmp-subst-off - |   |   |   |   |-- .zinit-tmp-subst-on - |   |   |   |   `-- :zinit-tmp-subst-autoload - |   |   |   |   |-- +zi-log - |   |   |   |   |-- .zinit-add-report - |   |   |   |   |-- .zinit-any-to-user-plugin - |   |   |   |   `-- is-at-least - |   |   |   |-- .zinit-load-snippet - |   |   |   |   |-- +zi-log - |   |   |   |   |-- +zinit-deploy-message - |   |   |   |   |-- .zinit-add-report - |   |   |   |   |-- .zinit-find-other-matches - |   |   |   |   |-- .zinit-get-object-path - |   |   |   |   |   `-- .zinit-any-to-user-plugin - |   |   |   |   |-- .zinit-pack-ice - |   |   |   |   |-- .zinit-set-m-func - |   |   |   |   |   `-- +zi-log - |   |   |   |   |-- .zinit-setup-params - |   |   |   |   `-- zinit-install.zsh/.zinit-download-snippet - |   |   |   |-- .zinit-pack-ice - |   |   |   |-- .zinit-register-plugin - |   |   |   |   `-- +zi-log - |   |   |   |-- .zinit-set-m-func - |   |   |   |   `-- +zi-log - |   |   |   |-- .zinit-setup-params - |   |   |   |-- zinit-install.zsh/.zinit-get-package - |   |   |   `-- zinit-install.zsh/.zinit-setup-plugin-dir - |   |   `-- .zinit-load-snippet - |   |   |-- +zi-log - |   |   |-- +zinit-deploy-message - |   |   |-- .zinit-add-report - |   |   |-- .zinit-find-other-matches - |   |   |-- .zinit-get-object-path - |   |   |   `-- .zinit-any-to-user-plugin - |   |   |-- .zinit-pack-ice - |   |   |-- .zinit-set-m-func - |   |   |   `-- +zi-log - |   |   |-- .zinit-setup-params - |   |   `-- zinit-install.zsh/.zinit-download-snippet - |   |-- .zinit-parse-opts - |   |-- .zinit-run - |   |   |-- +zi-log - |   |   |-- .zinit-any-to-user-plugin - |   |   `-- .zinit-get-object-path - |   |   `-- .zinit-any-to-user-plugin - |   |-- .zinit-submit-turbo - |   |-- compinit - |   |-- zinit-additional.zsh/+zinit-debug - |   |-- zinit-autoload.zsh/.zinit-cdisable - |   |-- zinit-autoload.zsh/.zinit-cenable - |   |-- zinit-autoload.zsh/.zinit-clear-completions - |   |-- zinit-autoload.zsh/.zinit-compile-uncompile-all - |   |-- zinit-autoload.zsh/.zinit-compiled - |   |-- zinit-autoload.zsh/.zinit-delete - |   |-- zinit-autoload.zsh/.zinit-help - |   |-- zinit-autoload.zsh/.zinit-list-bindkeys - |   |-- zinit-autoload.zsh/.zinit-list-compdef-replay - |   |-- zinit-autoload.zsh/.zinit-list-plugins - |   |-- zinit-autoload.zsh/.zinit-list-snippets - |   |-- zinit-autoload.zsh/.zinit-module - |   |-- zinit-autoload.zsh/.zinit-recently - |   |-- zinit-autoload.zsh/.zinit-search-completions - |   |-- zinit-autoload.zsh/.zinit-self-update - |   |-- zinit-autoload.zsh/.zinit-show-all-reports - |   |-- zinit-autoload.zsh/.zinit-show-completions - |   |-- zinit-autoload.zsh/.zinit-show-report - |   |-- zinit-autoload.zsh/.zinit-show-times - |   |-- zinit-autoload.zsh/.zinit-show-zstatus - |   |-- zinit-autoload.zsh/.zinit-uncompile-plugin - |   |-- zinit-autoload.zsh/.zinit-uninstall-completions - |   |-- zinit-autoload.zsh/.zinit-unload - |   |-- zinit-autoload.zsh/.zinit-update-or-status - |   |-- zinit-autoload.zsh/.zinit-update-or-status-all - |   |-- zinit-autoload.zsh/zi::version - |   |-- zinit-install.zsh/.zinit-compile-plugin - |   |-- zinit-install.zsh/.zinit-compinit - |   |-- zinit-install.zsh/.zinit-forget-completion - |   `-- zinit-install.zsh/.zinit-install-completions - `-- zinit-autoload.zsh/.zinit-module - -Uses feature(s): _add-zsh-hook_, _alias_, _autoload_, _bindkey_, _colors_, _export_, _is-at-least_, _setopt_, _source_, _zle_, _zmodload_, _zstyle_ - -_Exports (environment):_ PMSPEC [big]*//* ZPFX [big]*//* ZSH_CACHE_DIR - -==== +zi-log - -____ - - Logging function - -____ - -Has 20 line(s). Doesn't call other functions. - -Called by: - - +zinit-message - +zinit-prehelp-usage-message - .zinit-compdef-clear - .zinit-compdef-replay - .zinit-ice - .zinit-load-snippet - .zinit-register-plugin - .zinit-run - .zinit-set-m-func - :zinit-tmp-subst-autoload - Script-Body - zinit - zinit-additional.zsh/.zinit-debug-clear - zinit-additional.zsh/.zinit-debug-report - zinit-additional.zsh/.zinit-debug-revert - zinit-additional.zsh/.zinit-debug-start - zinit-additional.zsh/.zinit-debug-status - zinit-additional.zsh/.zinit-debug-stop - zinit-additional.zsh/:zinit-tmp-subst-source - zinit-autoload.zsh/.zi-check-for-git-changes - zinit-autoload.zsh/.zinit-build-module - zinit-autoload.zsh/.zinit-cd - zinit-autoload.zsh/.zinit-confirm - zinit-autoload.zsh/.zinit-delete - zinit-autoload.zsh/.zinit-glance - zinit-autoload.zsh/.zinit-list-plugins - zinit-autoload.zsh/.zinit-run-delete-hooks - zinit-autoload.zsh/.zinit-self-update - zinit-autoload.zsh/.zinit-show-zstatus - zinit-autoload.zsh/.zinit-uninstall-completions - zinit-autoload.zsh/.zinit-unload - zinit-autoload.zsh/.zinit-update-all-parallel - zinit-autoload.zsh/.zinit-update-or-status-all - zinit-autoload.zsh/.zinit-update-or-status - zinit-autoload.zsh/.zinit-wait-for-update-jobs - zinit-autoload.zsh/zi::version - zinit-install.zsh/.zi::get-architecture - zinit-install.zsh/.zinit-compile-plugin - zinit-install.zsh/.zinit-compinit - zinit-install.zsh/.zinit-download-file-stdout - zinit-install.zsh/.zinit-download-snippet - zinit-install.zsh/.zinit-extract - zinit-install.zsh/.zinit-get-cygwin-package - zinit-install.zsh/.zinit-get-latest-gh-r-url-part - zinit-install.zsh/.zinit-get-package - zinit-install.zsh/.zinit-install-completions - zinit-install.zsh/.zinit-jq-check - zinit-install.zsh/.zinit-setup-plugin-dir - zinit-install.zsh/.zinit-update-snippet - zinit-install.zsh/__zinit-cmake-base-hook - zinit-install.zsh/ziextract - zinit-install.zsh/∞zinit-configure-base-hook - zinit-install.zsh/∞zinit-make-base-hook - zinit-install.zsh/∞zinit-mv-hook - zinit-install.zsh/∞zinit-ps-on-update-hook - zinit-install.zsh/∞zinit-reset-hook - zinit-side.zsh/.zinit-countdown - zinit-side.zsh/.zinit-exists-physically-message - -==== +zinit-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: - - .zinit-load-snippet - .zinit-load - zinit-autoload.zsh/.zinit-recall - -==== +zinit-message - -____ - - Wrapper function to maintain backward compatibility - -____ - -Has 1 line(s). Calls functions: - - +zinit-message - `-- +zi-log - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== +zinit-prehelp-usage-message - -Has 38 line(s). Calls functions: - - +zinit-prehelp-usage-message - `-- +zi-log - -Called by: - - zinit - -==== -zinit_scheduler_add_sh - -____ - - Copies task into ZINIT_RUN array, called when a task timeouts. - A small function ran from pattern in /-substitution as a math - function. - -____ - -Has 7 line(s). Doesn't call other functions. - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-add-fpath - -Has 10 line(s). Calls functions: - - .zinit-add-fpath - `-- .zinit-any-to-user-plugin - -Called by: - - zinit - -==== .zinit-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: - - .zinit-load-plugin - .zinit-load-snippet - :zinit-tmp-subst-alias - :zinit-tmp-subst-autoload - :zinit-tmp-subst-bindkey - :zinit-tmp-subst-compdef - :zinit-tmp-subst-zle - :zinit-tmp-subst-zstyle - -==== .zinit-any-to-pid - -Has 22 line(s). Calls functions: - - .zinit-any-to-pid - `-- .zinit-util-shands-path - -Uses feature(s): _setopt_ - -Called by: - - zinit-side.zsh/.zinit-any-colorify-as-uspl2 - zinit-side.zsh/.zinit-exists-physically-message - zinit-side.zsh/.zinit-first - -==== .zinit-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) - - $REPLY - user and plugin - -____ - -Has 29 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-add-fpath - .zinit-get-object-path - .zinit-load - .zinit-run - :zinit-tmp-subst-autoload - zinit-autoload.zsh/.zinit-any-to-uspl2 - zinit-autoload.zsh/.zinit-changes - zinit-autoload.zsh/.zinit-compile-uncompile-all - zinit-autoload.zsh/.zinit-compiled - zinit-autoload.zsh/.zinit-create - zinit-autoload.zsh/.zinit-delete - zinit-autoload.zsh/.zinit-find-completions-of-plugin - zinit-autoload.zsh/.zinit-glance - zinit-autoload.zsh/.zinit-show-report - zinit-autoload.zsh/.zinit-stress - zinit-autoload.zsh/.zinit-uncompile-plugin - zinit-autoload.zsh/.zinit-unload - zinit-autoload.zsh/.zinit-unregister-plugin - zinit-autoload.zsh/.zinit-update-all-parallel - zinit-autoload.zsh/.zinit-update-or-status-all - zinit-autoload.zsh/.zinit-update-or-status - zinit-install.zsh/.zinit-install-completions - zinit-side.zsh/.zinit-any-colorify-as-uspl2 - zinit-side.zsh/.zinit-compute-ice - zinit-side.zsh/.zinit-exists-physically-message - zinit-side.zsh/.zinit-exists-physically - zinit-side.zsh/.zinit-first - -==== .zinit-compdef-clear - -____ - - Implements user-exposed functionality to clear gathered compdefs. - -____ - -Has 3 line(s). Calls functions: - - .zinit-compdef-clear - `-- +zi-log - -Called by: - - zicdclear - zinit - zpcdclear - -==== .zinit-compdef-replay - -____ - - Runs gathered compdef calls. This allows to run 'compinit' after loading plugins. - -____ - -Has 17 line(s). Calls functions: - - .zinit-compdef-replay - `-- +zi-log - -Uses feature(s): _compdef_ - -Called by: - - zicdreplay - zinit - zpcdreplay - -==== .zinit-diff - -____ - - Performs diff actions of all types - -____ - -Has 4 line(s). Calls functions: - - .zinit-diff - |-- .zinit-diff-env - |-- .zinit-diff-functions - |-- .zinit-diff-options - `-- .zinit-diff-parameter - -Called by: - - .zinit-load-plugin - zinit-additional.zsh/.zinit-debug-start - zinit-additional.zsh/.zinit-debug-stop - -==== .zinit-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 18 line(s). Doesn't call other functions. - -Called by: - - .zinit-diff - .zinit-load-plugin - -==== .zinit-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 8 line(s). Doesn't call other functions. - -Called by: - - .zinit-diff - -==== .zinit-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 7 line(s). Doesn't call other functions. - -Called by: - - .zinit-diff - -==== .zinit-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 9 line(s). Doesn't call other functions. - -Called by: - - .zinit-diff - -==== .zinit-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 22 line(s). Doesn't call other functions. - -Called by: - - .zinit-load-plugin - .zinit-load-snippet - zinit-side.zsh/.zinit-first - -==== .zinit-formatter-auto - -Has 50 line(s). Calls functions: - - .zinit-formatter-auto - |-- .zinit-formatter-pid - |   `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - `-- .zinit-formatter-url - -Uses feature(s): _type_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-formatter-bar - -Has 1 line(s). Calls functions: - - .zinit-formatter-bar - `-- .zinit-formatter-bar-util - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-formatter-bar-util - -Has 7 line(s). Doesn't call other functions. - -Called by: - - .zinit-formatter-bar - .zinit-formatter-th-bar - -==== .zinit-formatter-pid - -Has 11 line(s). Calls functions: - - .zinit-formatter-pid - `-- zinit-side.zsh/.zinit-any-colorify-as-uspl2 - -Uses feature(s): _source_ - -Called by: - - .zinit-formatter-auto - -==== .zinit-formatter-th-bar - -Has 1 line(s). Calls functions: - - .zinit-formatter-th-bar - `-- .zinit-formatter-bar-util - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-formatter-url - -Has 19 line(s). Doesn't call other functions. - -Called by: - - .zinit-formatter-auto - -==== .zinit-get-mtime-into - -Has 7 line(s). Doesn't call other functions. - -Called by: - - Script-Body - zinit-autoload.zsh/.zinit-self-update - zinit-autoload.zsh/.zinit-update-or-status-all - -==== .zinit-get-object-path - -Has 28 line(s). Calls functions: - - .zinit-get-object-path - `-- .zinit-any-to-user-plugin - -Called by: - - .zinit-load-ices - .zinit-load-snippet - .zinit-run - zinit - zinit-autoload.zsh/.zinit-get-path - zinit-install.zsh/.zinit-setup-plugin-dir - zinit-install.zsh/.zinit-update-snippet - zinit-side.zsh/.zinit-first - zinit-side.zsh/.zinit-two-paths - -==== .zinit-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 21 line(s). Calls functions: - - .zinit-ice - `-- +zi-log - -Uses feature(s): _setopt_ - -Called by: - - zinit - -==== .zinit-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 95 line(s). Calls functions: - - .zinit-load - |-- +zinit-deploy-message - |-- .zinit-any-to-user-plugin - |-- .zinit-load-plugin - |   |-- .zinit-add-report - |   |-- .zinit-diff - |   |   |-- .zinit-diff-env - |   |   |-- .zinit-diff-functions - |   |   |-- .zinit-diff-options - |   |   `-- .zinit-diff-parameter - |   |-- .zinit-diff-env - |   |-- .zinit-find-other-matches - |   |-- .zinit-tmp-subst-off - |   |-- .zinit-tmp-subst-on - |   `-- :zinit-tmp-subst-autoload - |   |-- +zi-log - |   |-- .zinit-add-report - |   |-- .zinit-any-to-user-plugin - |   `-- is-at-least - |-- .zinit-load-snippet - |   |-- +zi-log - |   |-- +zinit-deploy-message - |   |-- .zinit-add-report - |   |-- .zinit-find-other-matches - |   |-- .zinit-get-object-path - |   |   `-- .zinit-any-to-user-plugin - |   |-- .zinit-pack-ice - |   |-- .zinit-set-m-func - |   |   `-- +zi-log - |   |-- .zinit-setup-params - |   `-- zinit-install.zsh/.zinit-download-snippet - |-- .zinit-pack-ice - |-- .zinit-register-plugin - |   `-- +zi-log - |-- .zinit-set-m-func - |   `-- +zi-log - |-- .zinit-setup-params - |-- zinit-install.zsh/.zinit-get-package - `-- zinit-install.zsh/.zinit-setup-plugin-dir - -Uses feature(s): _eval_, _setopt_, _source_, _zle_ - -Called by: - - .zinit-load-object - .zinit-run-task - zinit-additional.zsh/.zinit-service - -==== .zinit-load-ices - -Has 22 line(s). Calls functions: - - .zinit-load-ices - `-- .zinit-get-object-path - `-- .zinit-any-to-user-plugin - -Called by: - - zinit - -==== .zinit-load-object - -Has 12 line(s). Calls functions: - - .zinit-load-object - |-- .zinit-load - |   |-- +zinit-deploy-message - |   |-- .zinit-any-to-user-plugin - |   |-- .zinit-load-plugin - |   |   |-- .zinit-add-report - |   |   |-- .zinit-diff - |   |   |   |-- .zinit-diff-env - |   |   |   |-- .zinit-diff-functions - |   |   |   |-- .zinit-diff-options - |   |   |   `-- .zinit-diff-parameter - |   |   |-- .zinit-diff-env - |   |   |-- .zinit-find-other-matches - |   |   |-- .zinit-tmp-subst-off - |   |   |-- .zinit-tmp-subst-on - |   |   `-- :zinit-tmp-subst-autoload - |   |   |-- +zi-log - |   |   |-- .zinit-add-report - |   |   |-- .zinit-any-to-user-plugin - |   |   `-- is-at-least - |   |-- .zinit-load-snippet - |   |   |-- +zi-log - |   |   |-- +zinit-deploy-message - |   |   |-- .zinit-add-report - |   |   |-- .zinit-find-other-matches - |   |   |-- .zinit-get-object-path - |   |   |   `-- .zinit-any-to-user-plugin - |   |   |-- .zinit-pack-ice - |   |   |-- .zinit-set-m-func - |   |   |   `-- +zi-log - |   |   |-- .zinit-setup-params - |   |   `-- zinit-install.zsh/.zinit-download-snippet - |   |-- .zinit-pack-ice - |   |-- .zinit-register-plugin - |   |   `-- +zi-log - |   |-- .zinit-set-m-func - |   |   `-- +zi-log - |   |-- .zinit-setup-params - |   |-- zinit-install.zsh/.zinit-get-package - |   `-- zinit-install.zsh/.zinit-setup-plugin-dir - `-- .zinit-load-snippet - |-- +zi-log - |-- +zinit-deploy-message - |-- .zinit-add-report - |-- .zinit-find-other-matches - |-- .zinit-get-object-path - |   `-- .zinit-any-to-user-plugin - |-- .zinit-pack-ice - |-- .zinit-set-m-func - |   `-- +zi-log - |-- .zinit-setup-params - `-- zinit-install.zsh/.zinit-download-snippet - -Called by: - - zinit - -==== .zinit-load-plugin - -____ - - Lower-level function for loading a plugin. - - $1 - user - $2 - plugin - $3 - mode (light or load) - -____ - -Has 128 line(s). Calls functions: - - .zinit-load-plugin - |-- .zinit-add-report - |-- .zinit-diff - |   |-- .zinit-diff-env - |   |-- .zinit-diff-functions - |   |-- .zinit-diff-options - |   `-- .zinit-diff-parameter - |-- .zinit-diff-env - |-- .zinit-find-other-matches - |-- .zinit-tmp-subst-off - |-- .zinit-tmp-subst-on - `-- :zinit-tmp-subst-autoload - |-- +zi-log - |-- .zinit-add-report - |-- .zinit-any-to-user-plugin - `-- is-at-least - -Uses feature(s): _eval_, _setopt_, _source_, _unfunction_, _zle_ - -Called by: - - .zinit-load - -==== .zinit-load-snippet - -____ - - Implements the exposed-to-user action of loading a snippet. - - $1 - url (can be local, absolute path). - -____ - -Has 203 line(s). Calls functions: - - .zinit-load-snippet - |-- +zi-log - |-- +zinit-deploy-message - |-- .zinit-add-report - |-- .zinit-find-other-matches - |-- .zinit-get-object-path - |   `-- .zinit-any-to-user-plugin - |-- .zinit-pack-ice - |-- .zinit-set-m-func - |   `-- +zi-log - |-- .zinit-setup-params - `-- zinit-install.zsh/.zinit-download-snippet - -Uses feature(s): _autoload_, _eval_, _setopt_, _source_, _unfunction_, _zparseopts_, _zstyle_ - -Called by: - - .zinit-load-object - .zinit-load - .zinit-run-task - pmodload - zinit-additional.zsh/.zinit-service - -==== .zinit-main-message-formatter - -Has 18 line(s). Doesn't call other functions. - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== .zinit-pack-ice - -____ - - Remembers all ice-mods, assigns them to concrete plugin. Ice spec - is in general forgotten for second-next command (i.e., ice melts quickly), however they - glue to the object (plugin or snippet) mentioned in the next command for later use with (e.g. 'zinit update ...'). - -____ - -Has 3 line(s). Doesn't call other functions. - -Called by: - - .zinit-load-snippet - .zinit-load - @zsh-plugin-run-on-unload - @zsh-plugin-run-on-update - zinit-install.zsh/.zinit-update-snippet - zinit-side.zsh/.zinit-compute-ice - -==== .zinit-parse-opts - -Has 2 line(s). Doesn't call other functions. - -Called by: - - zinit - -==== .zinit-prepare-home - -____ - - Creates all directories needed by Zinit, first checks if they - already exist. - -____ - -Has 45 line(s). Calls functions: - - .zinit-prepare-home - |-- zinit-autoload.zsh/.zinit-clear-completions - `-- zinit-install.zsh/.zinit-compinit - -Uses feature(s): _source_ - -Called by: - - Script-Body - -==== .zinit-register-plugin - -____ - - Adds the plugin to ZINIT_REGISTERED_PLUGINS array and to the - zsh_loaded_plugins array (managed according to the plugin standard: - https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html). - -____ - -Has 23 line(s). Calls functions: - - .zinit-register-plugin - `-- +zi-log - -Called by: - - .zinit-load - -==== .zinit-run - -____ - - Run code inside plugins folder - It uses the 'correct' parameter from uppers scope zinit(). - -____ - -Has 24 line(s). Calls functions: - - .zinit-run - |-- +zi-log - |-- .zinit-any-to-user-plugin - `-- .zinit-get-object-path - `-- .zinit-any-to-user-plugin - -Uses feature(s): _eval_, _setopt_ - -Called by: - - zinit - -==== .zinit-run-task - -____ - - A backend, worker function of .zinit-scheduler. It obtains the tasks - index and a few of its properties (like the type: plugin, snippet, - service plugin, service snippet) and executes it first checking for - additional conditions (like non-numeric wait'' ice). - - $1 - current pass: 1 or 2 - $2 - time assigned to the task - $3 - type: plugin, service plugin, service snippet, snippet - $4 - tasks index in the ZINIT[WAIT_ICE_...] fields - $5 - mode: load, light - $6 - details: alias name (derived from id-as''), plugin-spec, or snippet URL - -____ - -Has 47 line(s). Calls functions: - - .zinit-run-task - |-- .zinit-load - |   |-- +zinit-deploy-message - |   |-- .zinit-any-to-user-plugin - |   |-- .zinit-load-plugin - |   |   |-- .zinit-add-report - |   |   |-- .zinit-diff - |   |   |   |-- .zinit-diff-env - |   |   |   |-- .zinit-diff-functions - |   |   |   |-- .zinit-diff-options - |   |   |   `-- .zinit-diff-parameter - |   |   |-- .zinit-diff-env - |   |   |-- .zinit-find-other-matches - |   |   |-- .zinit-tmp-subst-off - |   |   |-- .zinit-tmp-subst-on - |   |   `-- :zinit-tmp-subst-autoload - |   |   |-- +zi-log - |   |   |-- .zinit-add-report - |   |   |-- .zinit-any-to-user-plugin - |   |   `-- is-at-least - |   |-- .zinit-load-snippet - |   |   |-- +zi-log - |   |   |-- +zinit-deploy-message - |   |   |-- .zinit-add-report - |   |   |-- .zinit-find-other-matches - |   |   |-- .zinit-get-object-path - |   |   |   `-- .zinit-any-to-user-plugin - |   |   |-- .zinit-pack-ice - |   |   |-- .zinit-set-m-func - |   |   |   `-- +zi-log - |   |   |-- .zinit-setup-params - |   |   `-- zinit-install.zsh/.zinit-download-snippet - |   |-- .zinit-pack-ice - |   |-- .zinit-register-plugin - |   |   `-- +zi-log - |   |-- .zinit-set-m-func - |   |   `-- +zi-log - |   |-- .zinit-setup-params - |   |-- zinit-install.zsh/.zinit-get-package - |   `-- zinit-install.zsh/.zinit-setup-plugin-dir - |-- .zinit-load-snippet - |   |-- +zi-log - |   |-- +zinit-deploy-message - |   |-- .zinit-add-report - |   |-- .zinit-find-other-matches - |   |-- .zinit-get-object-path - |   |   `-- .zinit-any-to-user-plugin - |   |-- .zinit-pack-ice - |   |-- .zinit-set-m-func - |   |   `-- +zi-log - |   |-- .zinit-setup-params - |   `-- zinit-install.zsh/.zinit-download-snippet - `-- zinit-autoload.zsh/.zinit-unload - -Uses feature(s): _eval_, _source_, _zle_, _zpty_ - -Called by: - - @zinit-scheduler - -==== .zinit-set-m-func - -____ - - ]]] - Sets and withdraws the temporary, atclone/atpull time function `m`. - -____ - -Has 17 line(s). Calls functions: - - .zinit-set-m-func - `-- +zi-log - -Uses feature(s): _setopt_ - -Called by: - - .zinit-load-snippet - .zinit-load - zinit-autoload.zsh/.zinit-update-or-status - -==== .zinit-setup-params - -Has 3 line(s). Doesn't call other functions. - -Called by: - - .zinit-load-snippet - .zinit-load - -==== .zinit-submit-turbo - -____ - - If `zinit load`, `zinit light` or `zinit snippet` will be - preceded with 'wait', 'load', 'unload' or 'on-update-of'/'subscribe' - ice-mods then the plugin or snipped is to be loaded in turbo-mode, - and this function adds it to internal data structures. @zinit-scheduler uses the data to - create load or unload tasks. - -____ - -Has 16 line(s). Doesn't call other functions. - -Called by: - - zinit - -==== .zinit-tmp-subst-off - -____ - - Turn off temporary substituting of functions completely for a given mode ("load", "light", - "light-b" (i.e. the `trackbinds' mode) or "compdef"). - -____ - -Has 21 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_, _unfunction_ - -Called by: - - .zinit-load-plugin - zinit-additional.zsh/.zinit-debug-stop - -==== .zinit-tmp-subst-on - -____ - - Turn on temporary substituting of functions of builtins and functions according to passed - mode ("load", "light", "light-b" or "compdef"). The temporary substituting of functions is - to gather report data, and to hijack 'autoload', 'bindkey' and 'compdef' calls. - -____ - -Has 32 line(s). Doesn't call other functions. - -Uses feature(s): _source_ - -Called by: - - .zinit-load-plugin - zinit-additional.zsh/.zinit-debug-start - -==== .zinit-util-shands-path - -____ - - Replaces parts of path with %HOME, etc. - -____ - -Has 9 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - .zinit-any-to-pid - -==== :zinit-reload-and-run - -____ - - Marks given function ($3) for autoloading, and executes it triggering the - load. $1 is the fpath dedicated to the function, $2 are autoload options. - This function replaces "autoload -X", because using that on older Zsh - versions causes problems with traps. - - So basically one creates function stub that calls :zinit-reload-and-run() - instead of "autoload -X". - - Author: Bart Schaefer - - $1 - FPATH dedicated to function - $2 - autoload options - $3 - function name (one that needs autoloading) - -____ - -Has 11 line(s). Doesn't call other functions. - -Uses feature(s): _autoload_, _unfunction_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== :zinit-tmp-subst-alias - -____ - - Function defined to hijack plugin's calls to the `alias' builtin. - - The hijacking is to gather report data (which is used in unload). - -____ - -Has 36 line(s). Calls functions: - - :zinit-tmp-subst-alias - `-- .zinit-add-report - -Uses feature(s): _alias_, _setopt_, _zparseopts_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== :zinit-tmp-subst-autoload - -____ - - Hijack plugin's calls to the 'autoload' builtin. - - The hijacking gathers report data and runs custom `autoload' function, that doesn't need FPATH. - -____ - -Has 111 line(s). Calls functions: - - :zinit-tmp-subst-autoload - |-- +zi-log - |-- .zinit-add-report - |-- .zinit-any-to-user-plugin - `-- is-at-least - -Uses feature(s): _autoload_, _eval_, _is-at-least_, _setopt_, _zparseopts_ - -Called by: - - .zinit-load-plugin - @autoload - -==== :zinit-tmp-subst-bindkey - -____ - - Function defined to hijack plugin's calls to the `bindkey' builtin. - - The hijacking is to gather report data (which is used in unload). - -____ - -Has 120 line(s). Calls functions: - - :zinit-tmp-subst-bindkey - |-- .zinit-add-report - `-- is-at-least - -Uses feature(s): _bindkey_, _is-at-least_, _setopt_, _zparseopts_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== :zinit-tmp-subst-compdef - -____ - - Function defined to hijack plugin's calls to the `compdef' function. - The hijacking is not only for reporting, but also to save compdef - calls so that `compinit' can be called after loading plugins. - -____ - -Has 6 line(s). Calls functions: - - :zinit-tmp-subst-compdef - `-- .zinit-add-report - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== :zinit-tmp-subst-zle - -____ - - Function defined to hijack plugin's calls to the `zle' builtin. - - The hijacking is to gather report data (which is used in unload). - -____ - -Has 36 line(s). Calls functions: - - :zinit-tmp-subst-zle - `-- .zinit-add-report - -Uses feature(s): _setopt_, _zle_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== :zinit-tmp-subst-zstyle - -____ - - Function defined to hijack plugin's calls to the `zstyle' builtin. - - The hijacking is to gather report data (which is used in unload). - -____ - -Has 23 line(s). Calls functions: - - :zinit-tmp-subst-zstyle - `-- .zinit-add-report - -Uses feature(s): _setopt_, _zparseopts_, _zstyle_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== @autoload - -Has 4 line(s). Calls functions: - - @autoload - `-- :zinit-tmp-subst-autoload - |-- +zi-log - |-- .zinit-add-report - |-- .zinit-any-to-user-plugin - `-- is-at-least - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== @zinit-register-annex - -____ - - Registers the z-annex inside Zinit – i.e. an Zinit extension - -____ - -Has 11 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== @zinit-register-hook - -____ - - Registers the z-annex inside Zinit (i.e., an Zinit extension) - -____ - -Has 6 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - Script-Body - -==== @zinit-scheduler - -____ - - Searches for timeout tasks, executes them. Theres an array of tasks - waiting for execution, this scheduler manages them, detects which ones - should be run at current moment, decides to remove (or not) them from - the array after execution. - - $1 - if "following", then it is non-first (second and more) - invocation of the scheduler; this results in chain of 'sched' - invocations that results in repetitive @zinit-scheduler activity. - - if "burst", then all tasks are marked timeout and executed one - by one; this is handy if e.g. a docker image starts up and - needs to install all turbo-mode plugins without any hesitation - (delay), i.e. "burst" allows to run package installations from - script, not from prompt. - -____ - -Has 75 line(s). *Is a precmd hook*. Calls functions: - - @zinit-scheduler - |-- .zinit-run-task - |   |-- .zinit-load - |   |   |-- +zinit-deploy-message - |   |   |-- .zinit-any-to-user-plugin - |   |   |-- .zinit-load-plugin - |   |   |   |-- .zinit-add-report - |   |   |   |-- .zinit-diff - |   |   |   |   |-- .zinit-diff-env - |   |   |   |   |-- .zinit-diff-functions - |   |   |   |   |-- .zinit-diff-options - |   |   |   |   `-- .zinit-diff-parameter - |   |   |   |-- .zinit-diff-env - |   |   |   |-- .zinit-find-other-matches - |   |   |   |-- .zinit-tmp-subst-off - |   |   |   |-- .zinit-tmp-subst-on - |   |   |   `-- :zinit-tmp-subst-autoload - |   |   |   |-- +zi-log - |   |   |   |-- .zinit-add-report - |   |   |   |-- .zinit-any-to-user-plugin - |   |   |   `-- is-at-least - |   |   |-- .zinit-load-snippet - |   |   |   |-- +zi-log - |   |   |   |-- +zinit-deploy-message - |   |   |   |-- .zinit-add-report - |   |   |   |-- .zinit-find-other-matches - |   |   |   |-- .zinit-get-object-path - |   |   |   |   `-- .zinit-any-to-user-plugin - |   |   |   |-- .zinit-pack-ice - |   |   |   |-- .zinit-set-m-func - |   |   |   |   `-- +zi-log - |   |   |   |-- .zinit-setup-params - |   |   |   `-- zinit-install.zsh/.zinit-download-snippet - |   |   |-- .zinit-pack-ice - |   |   |-- .zinit-register-plugin - |   |   |   `-- +zi-log - |   |   |-- .zinit-set-m-func - |   |   |   `-- +zi-log - |   |   |-- .zinit-setup-params - |   |   |-- zinit-install.zsh/.zinit-get-package - |   |   `-- zinit-install.zsh/.zinit-setup-plugin-dir - |   |-- .zinit-load-snippet - |   |   |-- +zi-log - |   |   |-- +zinit-deploy-message - |   |   |-- .zinit-add-report - |   |   |-- .zinit-find-other-matches - |   |   |-- .zinit-get-object-path - |   |   |   `-- .zinit-any-to-user-plugin - |   |   |-- .zinit-pack-ice - |   |   |-- .zinit-set-m-func - |   |   |   `-- +zi-log - |   |   |-- .zinit-setup-params - |   |   `-- zinit-install.zsh/.zinit-download-snippet - |   `-- zinit-autoload.zsh/.zinit-unload - `-- add-zsh-hook - -Uses feature(s): _add-zsh-hook_, _sched_, _setopt_, _zle_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== @zinit-substitute - -Has 40 line(s). Doesn't call other functions. - -Uses feature(s): _setopt_ - -Called by: - - zinit-autoload.zsh/.zinit-at-eval - zinit-install.zsh/.zinit-at-eval - zinit-install.zsh/.zinit-get-package - zinit-install.zsh/∞zinit-atclone-hook - zinit-install.zsh/∞zinit-configure-base-hook - zinit-install.zsh/∞zinit-cp-hook - zinit-install.zsh/∞zinit-extract-hook - zinit-install.zsh/∞zinit-make-base-hook - zinit-install.zsh/∞zinit-mv-hook - -==== @zsh-plugin-run-on-unload - -____ - - The Plugin Standard required mechanism, see: - https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html - -____ - -Has 2 line(s). Calls functions: - - @zsh-plugin-run-on-unload - `-- .zinit-pack-ice - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== @zsh-plugin-run-on-update - -____ - - The Plugin Standard required mechanism - -____ - -Has 2 line(s). Calls functions: - - @zsh-plugin-run-on-update - `-- .zinit-pack-ice - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== pmodload - -Has 15 line(s). Calls functions: - - pmodload - `-- .zinit-load-snippet - |-- +zi-log - |-- +zinit-deploy-message - |-- .zinit-add-report - |-- .zinit-find-other-matches - |-- .zinit-get-object-path - |   `-- .zinit-any-to-user-plugin - |-- .zinit-pack-ice - |-- .zinit-set-m-func - |   `-- +zi-log - |-- .zinit-setup-params - `-- zinit-install.zsh/.zinit-download-snippet - -Uses feature(s): _zstyle_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== zicdclear - -____ - - A wrapper for "zinit cdclear -q" which can be called from hook - ices like the atinit"", atload"", etc. ices. - -____ - -Has 1 line(s). Calls functions: - - zicdclear - `-- .zinit-compdef-clear - `-- +zi-log - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== zicdreplay - -____ - - A function that can be invoked from within "atinit", "atload", etc. - ice-mod. It works like "zinit cdreplay", which cannot be invoked from such hook ices - -____ - -Has 1 line(s). Calls functions: - - zicdreplay - `-- .zinit-compdef-replay - `-- +zi-log - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== zicompdef - -____ - - Stores compdef for a replay with "zicdreplay" (turbo mode) or - with "zinit cdreplay" (normal mode). An utility functton 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.). - -==== zicompinit - -____ - - A function that can be invoked from within "atinit", "atload", etc. - ice-mod. It runs "autoload compinit; compinit" and respects - ZINIT[ZCOMPDUMP_PATH] and ZINIT[COMPINIT_OPTS]. - -____ - -Has 2 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.). - -==== zinit - -____ - - Entrypoint function directly exposed to user, consumes subcommands with respective arguments, - and completion. - -____ - -Has 553 line(s). Calls functions: - - zinit - |-- +zi-log - |-- +zinit-prehelp-usage-message - |   `-- +zi-log - |-- .zinit-add-fpath - |   `-- .zinit-any-to-user-plugin - |-- .zinit-compdef-clear - |   `-- +zi-log - |-- .zinit-compdef-replay - |   `-- +zi-log - |-- .zinit-get-object-path - |   `-- .zinit-any-to-user-plugin - |-- .zinit-ice - |   `-- +zi-log - |-- .zinit-load-ices - |   `-- .zinit-get-object-path - |   `-- .zinit-any-to-user-plugin - |-- .zinit-load-object - |   |-- .zinit-load - |   |   |-- +zinit-deploy-message - |   |   |-- .zinit-any-to-user-plugin - |   |   |-- .zinit-load-plugin - |   |   |   |-- .zinit-add-report - |   |   |   |-- .zinit-diff - |   |   |   |   |-- .zinit-diff-env - |   |   |   |   |-- .zinit-diff-functions - |   |   |   |   |-- .zinit-diff-options - |   |   |   |   `-- .zinit-diff-parameter - |   |   |   |-- .zinit-diff-env - |   |   |   |-- .zinit-find-other-matches - |   |   |   |-- .zinit-tmp-subst-off - |   |   |   |-- .zinit-tmp-subst-on - |   |   |   `-- :zinit-tmp-subst-autoload - |   |   |   |-- +zi-log - |   |   |   |-- .zinit-add-report - |   |   |   |-- .zinit-any-to-user-plugin - |   |   |   `-- is-at-least - |   |   |-- .zinit-load-snippet - |   |   |   |-- +zi-log - |   |   |   |-- +zinit-deploy-message - |   |   |   |-- .zinit-add-report - |   |   |   |-- .zinit-find-other-matches - |   |   |   |-- .zinit-get-object-path - |   |   |   |   `-- .zinit-any-to-user-plugin - |   |   |   |-- .zinit-pack-ice - |   |   |   |-- .zinit-set-m-func - |   |   |   |   `-- +zi-log - |   |   |   |-- .zinit-setup-params - |   |   |   `-- zinit-install.zsh/.zinit-download-snippet - |   |   |-- .zinit-pack-ice - |   |   |-- .zinit-register-plugin - |   |   |   `-- +zi-log - |   |   |-- .zinit-set-m-func - |   |   |   `-- +zi-log - |   |   |-- .zinit-setup-params - |   |   |-- zinit-install.zsh/.zinit-get-package - |   |   `-- zinit-install.zsh/.zinit-setup-plugin-dir - |   `-- .zinit-load-snippet - |   |-- +zi-log - |   |-- +zinit-deploy-message - |   |-- .zinit-add-report - |   |-- .zinit-find-other-matches - |   |-- .zinit-get-object-path - |   |   `-- .zinit-any-to-user-plugin - |   |-- .zinit-pack-ice - |   |-- .zinit-set-m-func - |   |   `-- +zi-log - |   |-- .zinit-setup-params - |   `-- zinit-install.zsh/.zinit-download-snippet - |-- .zinit-parse-opts - |-- .zinit-run - |   |-- +zi-log - |   |-- .zinit-any-to-user-plugin - |   `-- .zinit-get-object-path - |   `-- .zinit-any-to-user-plugin - |-- .zinit-submit-turbo - |-- compinit - |-- zinit-additional.zsh/+zinit-debug - |-- zinit-autoload.zsh/.zinit-cdisable - |-- zinit-autoload.zsh/.zinit-cenable - |-- zinit-autoload.zsh/.zinit-clear-completions - |-- zinit-autoload.zsh/.zinit-compile-uncompile-all - |-- zinit-autoload.zsh/.zinit-compiled - |-- zinit-autoload.zsh/.zinit-delete - |-- zinit-autoload.zsh/.zinit-help - |-- zinit-autoload.zsh/.zinit-list-bindkeys - |-- zinit-autoload.zsh/.zinit-list-compdef-replay - |-- zinit-autoload.zsh/.zinit-list-plugins - |-- zinit-autoload.zsh/.zinit-list-snippets - |-- zinit-autoload.zsh/.zinit-module - |-- zinit-autoload.zsh/.zinit-recently - |-- zinit-autoload.zsh/.zinit-search-completions - |-- zinit-autoload.zsh/.zinit-self-update - |-- zinit-autoload.zsh/.zinit-show-all-reports - |-- zinit-autoload.zsh/.zinit-show-completions - |-- zinit-autoload.zsh/.zinit-show-report - |-- zinit-autoload.zsh/.zinit-show-times - |-- zinit-autoload.zsh/.zinit-show-zstatus - |-- zinit-autoload.zsh/.zinit-uncompile-plugin - |-- zinit-autoload.zsh/.zinit-uninstall-completions - |-- zinit-autoload.zsh/.zinit-unload - |-- zinit-autoload.zsh/.zinit-update-or-status - |-- zinit-autoload.zsh/.zinit-update-or-status-all - |-- zinit-autoload.zsh/zi::version - |-- zinit-install.zsh/.zinit-compile-plugin - |-- zinit-install.zsh/.zinit-compinit - |-- zinit-install.zsh/.zinit-forget-completion - `-- zinit-install.zsh/.zinit-install-completions - -Uses feature(s): _autoload_, _compinit_, _eval_, _setopt_, _source_ - -Called by: - - Script-Body - zplugin - zinit-autoload.zsh/.zinit-delete - -==== zpcdclear - -Has 1 line(s). Calls functions: - - zpcdclear - `-- .zinit-compdef-clear - `-- +zi-log - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== zpcdreplay - -Has 1 line(s). Calls functions: - - zpcdreplay - `-- .zinit-compdef-replay - `-- +zi-log - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== zpcompdef - -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.). - -==== zpcompinit - -Has 2 line(s). Calls functions: - - zpcompinit - `-- compinit - -Uses feature(s): _autoload_, _compinit_ - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== zplugin - -Has 1 line(s). Calls functions: - - zplugin - `-- zinit - |-- +zi-log - |-- +zinit-prehelp-usage-message - |   `-- +zi-log - |-- .zinit-add-fpath - |   `-- .zinit-any-to-user-plugin - |-- .zinit-compdef-clear - |   `-- +zi-log - |-- .zinit-compdef-replay - |   `-- +zi-log - |-- .zinit-get-object-path - |   `-- .zinit-any-to-user-plugin - |-- .zinit-ice - |   `-- +zi-log - |-- .zinit-load-ices - |   `-- .zinit-get-object-path - |   `-- .zinit-any-to-user-plugin - |-- .zinit-load-object - |   |-- .zinit-load - |   |   |-- +zinit-deploy-message - |   |   |-- .zinit-any-to-user-plugin - |   |   |-- .zinit-load-plugin - |   |   |   |-- .zinit-add-report - |   |   |   |-- .zinit-diff - |   |   |   |   |-- .zinit-diff-env - |   |   |   |   |-- .zinit-diff-functions - |   |   |   |   |-- .zinit-diff-options - |   |   |   |   `-- .zinit-diff-parameter - |   |   |   |-- .zinit-diff-env - |   |   |   |-- .zinit-find-other-matches - |   |   |   |-- .zinit-tmp-subst-off - |   |   |   |-- .zinit-tmp-subst-on - |   |   |   `-- :zinit-tmp-subst-autoload - |   |   |   |-- +zi-log - |   |   |   |-- .zinit-add-report - |   |   |   |-- .zinit-any-to-user-plugin - |   |   |   `-- is-at-least - |   |   |-- .zinit-load-snippet - |   |   |   |-- +zi-log - |   |   |   |-- +zinit-deploy-message - |   |   |   |-- .zinit-add-report - |   |   |   |-- .zinit-find-other-matches - |   |   |   |-- .zinit-get-object-path - |   |   |   |   `-- .zinit-any-to-user-plugin - |   |   |   |-- .zinit-pack-ice - |   |   |   |-- .zinit-set-m-func - |   |   |   |   `-- +zi-log - |   |   |   |-- .zinit-setup-params - |   |   |   `-- zinit-install.zsh/.zinit-download-snippet - |   |   |-- .zinit-pack-ice - |   |   |-- .zinit-register-plugin - |   |   |   `-- +zi-log - |   |   |-- .zinit-set-m-func - |   |   |   `-- +zi-log - |   |   |-- .zinit-setup-params - |   |   |-- zinit-install.zsh/.zinit-get-package - |   |   `-- zinit-install.zsh/.zinit-setup-plugin-dir - |   `-- .zinit-load-snippet - |   |-- +zi-log - |   |-- +zinit-deploy-message - |   |-- .zinit-add-report - |   |-- .zinit-find-other-matches - |   |-- .zinit-get-object-path - |   |   `-- .zinit-any-to-user-plugin - |   |-- .zinit-pack-ice - |   |-- .zinit-set-m-func - |   |   `-- +zi-log - |   |-- .zinit-setup-params - |   `-- zinit-install.zsh/.zinit-download-snippet - |-- .zinit-parse-opts - |-- .zinit-run - |   |-- +zi-log - |   |-- .zinit-any-to-user-plugin - |   `-- .zinit-get-object-path - |   `-- .zinit-any-to-user-plugin - |-- .zinit-submit-turbo - |-- compinit - |-- zinit-additional.zsh/+zinit-debug - |-- zinit-autoload.zsh/.zinit-cdisable - |-- zinit-autoload.zsh/.zinit-cenable - |-- zinit-autoload.zsh/.zinit-clear-completions - |-- zinit-autoload.zsh/.zinit-compile-uncompile-all - |-- zinit-autoload.zsh/.zinit-compiled - |-- zinit-autoload.zsh/.zinit-delete - |-- zinit-autoload.zsh/.zinit-help - |-- zinit-autoload.zsh/.zinit-list-bindkeys - |-- zinit-autoload.zsh/.zinit-list-compdef-replay - |-- zinit-autoload.zsh/.zinit-list-plugins - |-- zinit-autoload.zsh/.zinit-list-snippets - |-- zinit-autoload.zsh/.zinit-module - |-- zinit-autoload.zsh/.zinit-recently - |-- zinit-autoload.zsh/.zinit-search-completions - |-- zinit-autoload.zsh/.zinit-self-update - |-- zinit-autoload.zsh/.zinit-show-all-reports - |-- zinit-autoload.zsh/.zinit-show-completions - |-- zinit-autoload.zsh/.zinit-show-report - |-- zinit-autoload.zsh/.zinit-show-times - |-- zinit-autoload.zsh/.zinit-show-zstatus - |-- zinit-autoload.zsh/.zinit-uncompile-plugin - |-- zinit-autoload.zsh/.zinit-uninstall-completions - |-- zinit-autoload.zsh/.zinit-unload - |-- zinit-autoload.zsh/.zinit-update-or-status - |-- zinit-autoload.zsh/.zinit-update-or-status-all - |-- zinit-autoload.zsh/zi::version - |-- zinit-install.zsh/.zinit-compile-plugin - |-- zinit-install.zsh/.zinit-compinit - |-- zinit-install.zsh/.zinit-forget-completion - `-- zinit-install.zsh/.zinit-install-completions - -Not called by script or any function (may be e.g. a hook, a Zle widget, etc.). - -==== add-zsh-hook - -____ - - Add to HOOK the given FUNCTION. - HOOK is one of chpwd, precmd, preexec, periodic, zshaddhistory, - zshexit, zsh_directory_name (the _functions subscript is not required). - - With -d, remove the function from the hook instead; delete the hook - variable if it is empty. - - -D behaves like -d, but pattern characters are active in the - function name, so any matching function will be deleted from the hook. - - -____ - -Has 93 line(s). Doesn't call other functions. - -Uses feature(s): _autoload_, _getopts_ - -Called by: - - @zinit-scheduler - Script-Body - -==== colors - -____ - - Put standard ANSI color codes in shell parameters for easy use. - Note that some terminals do not support all combinations. - -____ - -Has 120 line(s). Doesn't call other functions. - -Called by: - - Script-Body - -==== 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 573 line(s). Doesn't call other functions. - -Uses feature(s): _autoload_, _bindkey_, _compdef_, _compdump_, _eval_, _read_, _setopt_, _unfunction_, _zle_, _zstyle_ - -Called by: - - zicompinit - zinit - zpcompinit - -==== is-at-least - -____ - - - Test whether $ZSH_VERSION (or some value of your choice, if a second argument - is provided) is greater than or equal to x.y.z-r (in argument one). In fact, - it'll accept any dot/dash-separated string of numbers as its second argument - and compare it to the dot/dash-separated first argument. Leading non-number - parts of a segment (such as the "zefram" in 3.1.2-zefram4) are not considered - when the comparison is done; only the numbers matter. Any left-out segments - in the first argument that are present in the version string compared are - considered as zeroes, eg 3 == 3.0 == 3.0.0 == 3.0.0.0 and so on. - - -____ - -Has 56 line(s). Doesn't call other functions. - -Called by: - - :zinit-tmp-subst-autoload - :zinit-tmp-subst-bindkey - Script-Body - zinit-install.zsh/.zinit-download-snippet - diff --git a/zinit-install.zsh b/zinit-install.zsh index 23adab40b..4de24156a 100644 --- a/zinit-install.zsh +++ b/zinit-install.zsh @@ -1620,7 +1620,7 @@ ziextract() { ziextract "$file" $opt_move $opt_move2 $opt_norm $opt_nobkp ${${${#files}:#1}:+--nobkp} ret_val+=$? } - # Second, try to find the archive via `file' tool + # Second, try to find the archive via file command if (( !${#files} )) { local -a output infiles stage2_processed archives infiles=( **/*~(._zinit*|._backup|.git)(|/*)~*/*/*(-.DN) ) @@ -1633,7 +1633,7 @@ ziextract() { type=${(L)desc/(#b)(#i)(* |(#s))(zip|rar|xz|7-zip|gzip|bzip2|tar|exe|PE32) */$match[2]} if [[ $type = (zip|rar|xz|7-zip|gzip|bzip2|tar|exe|pe32) ]] { (( !OPTS[opt_-q,--quiet] )) && \ - +zi-log "{info}[{pre}ziextract{info}]{msg2} detected a {meta}$type{rst} archive in the file {file}$fname{rst}." + +zi-log "{m} Detected {meta}$type{rst} archive in file {file}$fname{rst}" ziextract "$fname" "$type" $opt_move $opt_move2 $opt_norm --norm ${${${#archives}:#1}:+--nobkp} integer iret_val=$? ret_val+=iret_val @@ -1655,11 +1655,9 @@ ziextract() { if [[ $type != $type2 && \ $type2 = (zip|rar|xz|7-zip|gzip|bzip2|tar) ]] { - # TODO: if multiple archives are really in the archive, - # this might delete too soon… However, it's unusual case. + # this might delete too soon if multiple archives in archive [[ $fname != $infname && $norm -eq 0 ]] && command rm -f "$infname" - (( !OPTS[opt_-q,--quiet] )) && \ - +zi-log "{info}[{pre}ziextract{info}]{msg2} detected a {obj}${type2}{rst} archive in the file {file}${fname}{rst}." + (( !OPTS[opt_-q,--quiet] )) && +zi-log "{m} Detected {obj}${type2}{rst} archive in {file}${fname}{rst}" ziextract "$fname" "$type2" $opt_move $opt_move2 $opt_norm ${${${#archives}:#1}:+--nobkp} ret_val+=$? stage2_processed+=( $fname ) @@ -1681,7 +1679,7 @@ ziextract() { return 1 } if [[ ! -e $file ]] { - +zi-log "{info}[{pre}ziextract{info}]{error} ERROR:{msg} the file \`{meta}${file}{msg}' doesn't exist.{rst}" + +zi-log "{e} No file {obj}${file}{rst} found" return 1 } if (( !nobkp )) { @@ -1693,7 +1691,7 @@ ziextract() { .zinit-extract-wrapper() { local file="$1" fun="$2" retval (( !OPTS[opt_-q,--quiet] )) && \ - +zi-log "{m} Extracting files in {obj}$file{rst}" + +zi-log "{m} Extracting archive {obj}$file{rst}" $fun; retval=$? if (( retval == 0 )) { local -aU files @@ -1711,7 +1709,7 @@ ziextract() { ((#i)*.zip) →zinit-extract(){ →zinit-check unzip "$file" || return 1 - command tar -xzf "${file}" --strip-components=1 + unzip -q "${file}" } ;; ((#i)*.rar)