83 lines
1.9 KiB
Groff
83 lines
1.9 KiB
Groff
.\" Automatically generated by Pandoc
|
|
.\"
|
|
.TH "antidote\-install" "1" "" "" "Antidote Manual"
|
|
.SH NAME
|
|
\f[B]antidote install\f[R] \- install a bundle
|
|
.SH SYNOPSIS
|
|
.PP
|
|
antidote install [\-h|\-\-help] [\-k|\-\-kind <kind>] [\-p|\-\-path
|
|
<path>]
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-a|\-\-autoload <path>]
|
|
[\-c|\-\-conditional <func>]
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-pre <func>] [\-\-post <func>]
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-b|\-\-branch <branch>] <bundle>
|
|
[<bundlefile>]
|
|
.SH DESCRIPTION
|
|
\f[B]antidote\-install\f[R] clones a new bundle and adds it to your
|
|
plugins file.
|
|
.PP
|
|
The default bundle file is
|
|
\f[B]${ZDOTDIR:\-$HOME}/.zsh_plugins.txt\f[R].
|
|
This can be overridden with the following \f[B]zstyle\f[R]:
|
|
.PP
|
|
\ \ zstyle \[aq]:antidote:bundle\[aq] file /path/to/my/bundle_file.txt
|
|
.SH OPTIONS
|
|
.TP
|
|
\-h, \-\-help
|
|
Show the help documentation.
|
|
.TP
|
|
\-k, \-\-kind
|
|
The kind of bundle.
|
|
Valid values: autoload, fpath, path, clone, defer, zsh.
|
|
.TP
|
|
\-p, \-\-path
|
|
A relative subpath within the bundle where the plugin is located.
|
|
.TP
|
|
\-b, \-\-branch
|
|
The git branch to use.
|
|
.TP
|
|
\-a, \-\-autoload
|
|
A relative subpath within the bundle where autoload function files are
|
|
located.
|
|
.TP
|
|
\-c, \-\-conditional
|
|
A conditional function used to check whether to load the bundle.
|
|
.TP
|
|
\-\-pre
|
|
A function to be called prior to loading the bundle.
|
|
.TP
|
|
\-\-post
|
|
A function to be called after loading the bundle.
|
|
.TP
|
|
<bundle>
|
|
Bundle to be installed.
|
|
.TP
|
|
[<bundlefile>]
|
|
Bundle file to write to if not using the default.
|
|
Defaults to \f[B]${ZDOTDIR:\-$HOME}/.zsh_plugins.txt\f[R] or zstyle
|
|
setting.
|
|
.SH EXAMPLES
|
|
.PP
|
|
\ \ antidote install zsh\-users/zsh\-history\-substring\-search
|
|
.SH BUGS
|
|
See GitHub Issues: \c
|
|
.UR https://github.com/mattmc3/antidote/issues
|
|
.UE \c
|
|
.SH AUTHORS
|
|
.IP \[bu] 2
|
|
Copyright (c) 2021\-2024 Matt McElheny
|
|
.IP \[bu] 2
|
|
antidote contributors: \c
|
|
.UR https://github.com/mattmc3/antidote/graphs/contributors
|
|
.UE \c
|
|
.SH LICENSE
|
|
MIT
|