mirror of
https://github.com/zdharma-continuum/zinit.git
synced 2025-02-23 04:19:33 +01:00
docs: generate
Signed-off-by: GitHub Actions <actions@github.com>
This commit is contained in:
parent
947c1ba03d
commit
0627eb4678
5 changed files with 4934 additions and 0 deletions
185
doc/zsdoc/zinit-additional.zsh.adoc
Normal file
185
doc/zsdoc/zinit-additional.zsh.adoc
Normal file
|
@ -0,0 +1,185 @@
|
|||
|
||||
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.).
|
||||
|
1661
doc/zsdoc/zinit-autoload.zsh.adoc
Normal file
1661
doc/zsdoc/zinit-autoload.zsh.adoc
Normal file
File diff suppressed because it is too large
Load diff
837
doc/zsdoc/zinit-install.zsh.adoc
Normal file
837
doc/zsdoc/zinit-install.zsh.adoc
Normal file
|
@ -0,0 +1,837 @@
|
|||
|
||||
NAME
|
||||
|
||||
zinit-install.zsh - a shell script
|
||||
|
||||
Documentation automatically generated with `zshelldoc'
|
||||
|
||||
== FUNCTIONS
|
||||
+zinit-cmake-hook
|
||||
.zi::get-architecture
|
||||
.zinit-at-eval
|
||||
.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-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-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 <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). 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 283 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 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 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 46 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 1 line(s). Calls functions:
|
||||
|
||||
∞zinit-cp-hook
|
||||
`-- ∞zinit-file-cp-mv-operation
|
||||
|-- 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-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-substitute
|
||||
|
||||
Uses feature(s): _setopt_
|
||||
|
||||
Called by:
|
||||
|
||||
∞zinit-cp-hook
|
||||
∞zinit-mv-hook
|
||||
|
||||
==== ∞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 1 line(s). Calls functions:
|
||||
|
||||
∞zinit-mv-hook
|
||||
`-- ∞zinit-file-cp-mv-operation
|
||||
|-- 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-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 <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
|
||||
|
285
doc/zsdoc/zinit-side.zsh.adoc
Normal file
285
doc/zsdoc/zinit-side.zsh.adoc
Normal file
|
@ -0,0 +1,285 @@
|
|||
|
||||
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-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-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-compile-plugin
|
||||
zinit-autoload.zsh/.zinit-edit
|
||||
zinit-autoload.zsh/.zinit-recall
|
||||
zinit-autoload.zsh/.zinit-uncompile-plugin
|
||||
zinit-autoload.zsh/.zinit-update-or-status-snippet
|
||||
zinit-autoload.zsh/.zinit-update-or-status
|
||||
|
||||
==== .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-compile-plugin
|
||||
zinit-autoload.zsh/.zinit-glance
|
||||
zinit-autoload.zsh/.zinit-stress
|
||||
|
||||
==== .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
|
||||
|
1966
doc/zsdoc/zinit.zsh.adoc
Normal file
1966
doc/zsdoc/zinit.zsh.adoc
Normal file
File diff suppressed because it is too large
Load diff
Loading…
Reference in a new issue