zsh/zdharma-continuum.zinit
1
0
Fork 0
mirror of https://github.com/zdharma-continuum/zinit.git synced 2026-09-10 07:36:38 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
zdharma-continuum.zinit/doc/zsdoc/zinit-install.zsh.adoc
Vladislav Doster 3b06cc31c9 docs: re-generate zinit zshelldocs 
Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2026-08-27 22:09:07 -05:00

838 lines
17 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

NAME
zinit-install.zsh - a shell script
Documentation automatically generated with `zshelldoc'
== FUNCTIONS
+zinit-cmake-hook
.zi::get-architecture
.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
∞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-file-cp-mv-operation
∞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-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.zsh/.zinit-cd-quiet
|-- zinit-side.zsh/.zinit-store-ices
|-- zinit.zsh/+zi-log
|-- zinit.zsh/.zinit-cd-quiet
`-- 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 66 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 198 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 <URL>'. 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). Calls functions:
.zinit-mirror-using-svn
`-- zinit.zsh/.zinit-cd-quiet
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 222 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-cd-quiet
`-- 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 77 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.zsh/.zinit-cd-quiet
|   |-- zinit-side.zsh/.zinit-store-ices
|   |-- zinit.zsh/+zi-log
|   |-- zinit.zsh/.zinit-cd-quiet
|   `-- 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 24 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.
Executable permissions are determined solely by the execute bit already
stored in the archive — i.e. whatever the package author intended.
No heuristics (file(1), shebang scanning, etc.) are applied.
$1 - url
$2 - file
____
Has 277 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
==== 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.).
==== ∞zinit-atclone-hook
Has 23 line(s). Calls functions:
∞zinit-atclone-hook
|-- zinit-side.zsh/.zinit-countdown
|-- zinit.zsh/.zinit-cd-quiet
|-- zinit.zsh/.zinit-restore-dir
`-- 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-atpull-e-hook
Has 20 line(s). Calls functions:
∞zinit-atpull-e-hook
|-- zinit-side.zsh/.zinit-at-eval
|-- zinit-side.zsh/.zinit-countdown
|-- zinit.zsh/.zinit-cd-quiet
`-- zinit.zsh/.zinit-restore-dir
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
==== ∞zinit-atpull-hook
Has 20 line(s). Calls functions:
∞zinit-atpull-hook
|-- zinit-side.zsh/.zinit-at-eval
|-- zinit-side.zsh/.zinit-countdown
|-- zinit.zsh/.zinit-cd-quiet
`-- zinit.zsh/.zinit-restore-dir
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
==== ∞zinit-compile-plugin-hook
Has 20 line(s). Calls functions:
∞zinit-compile-plugin-hook
`-- zinit-autoload.zsh/.zinit-compile-plugin
Uses feature(s): _setopt_, _source_
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 50 line(s). Calls functions:
∞zinit-configure-base-hook
|-- zinit.zsh/+zi-log
|-- zinit.zsh/.zinit-cd-quiet
|-- zinit.zsh/.zinit-restore-dir
`-- 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-cd-quiet
|-- zinit.zsh/.zinit-restore-dir
`-- 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-cd-quiet
|-- zinit.zsh/.zinit-restore-dir
`-- 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 1 line(s). Calls functions:
∞zinit-cp-hook
`-- ∞zinit-file-cp-mv-operation
|-- zinit.zsh/+zi-log
|-- zinit.zsh/.zinit-cd-quiet
`-- zinit.zsh/@zinit-substitute
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-file-cp-mv-operation
Has 49 line(s). Calls functions:
∞zinit-file-cp-mv-operation
|-- zinit.zsh/+zi-log
|-- zinit.zsh/.zinit-cd-quiet
`-- zinit.zsh/@zinit-substitute
Called by:
∞zinit-cp-hook
∞zinit-mv-hook
==== ∞zinit-make-base-hook
____
A base common implementation of the make ice
____
Has 58 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 1 line(s). Calls functions:
∞zinit-mv-hook
`-- ∞zinit-file-cp-mv-operation
|-- zinit.zsh/+zi-log
|-- zinit.zsh/.zinit-cd-quiet
`-- zinit.zsh/@zinit-substitute
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
==== ∞zinit-ps-on-update-hook
Has 19 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 80 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 <names ...>'
____
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
Reference in a new issue View git blame Copy permalink