removed windows and linux split subdir

.antidote/man/antidote-bundle.md

@@ -0,0 +1,102 @@
+---
+title: antidote-bundle
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote bundle** - download a bundle and print its source line
+
+# SYNOPSIS
+
+| antidote bundle [\<bundles\>...]
+
+# DESCRIPTION
+
+**antidote-bundle** assembles your Zsh plugins. Bundles can be git repos, or local files or directories. If a plugin is a repo, it will be cloned if necessary. The zsh code necessary to load (source) the plugin is then printed.
+
+|   antidote bundle gituser/gitrepo
+|   antidote bundle $ZSH_CUSTOM/plugins/myplugin
+|   antidote bundle ${ZDOTDIR:-\$HOME}/.zlibs/myfile.zsh
+
+Bundles also support annotations. Annotations allow you have finer grained control over your plugins. Annotations are used in the form \'keyword:value\'.
+
+`kind`
+:   - **zsh**: A zsh plugin. This is the default kind of bundle.
+:   - **fpath**: Only add the plugin to your _\$fpath_.
+:   - **path**: Add the plugin to your _\$PATH_.
+:   - **clone**: Only clone a plugin, but don't do anything else with it.
+:   - **defer**: Defers loading of a plugin using \'romkatv/zsh-defer\'.
+:   - **autoload**: Autoload all the files in the plugin directory as zsh functions.
+
+`branch`
+:   The branch annotation allows you to change the default branch of a plugin's repo from **main** to a branch of your choosing.
+
+`path`
+:   The path annotation allows you to use a subdirectory or file within a plugin's structure instead of the root plugin (eg: \'path:plugins/subplugin\').
+
+`conditional`
+:   The conditonal annotation allows you to wrap an **if** statement around a plugin's load script. Supply the name of a zero argument zsh function to conditional to perform the test (eg: \'conditional:is-macos\').
+
+`pre` / `post`
+:   The pre and post annotations allow you to call a function before or after a plugin's load script. This is helpful when configuring plugins, since the configuration functions will only run for active plugins. Supply the name of a zero argument zsh function to pre or post.
+
+`autoload`
+:   The autoload annotation allows you to autoload a zsh functions directory in addition to however the plugin was loaded as specified by \'kind\'. Supply a relative path to autoload (eg: \'autoload:functions\').
+
+Cloned repo directory names can be overridden with the following **zstyle**:
+
+|   zstyle \':antidote:bundle\' use-friendly-names \'yes\'
+
+# OPTIONS
+
+-h, \--help
+:   Show the help documentation.
+
+[*\<bundles\>...*]
+:   Zsh plugin bundles
+
+# EXAMPLES
+
+Using the **kind:** annotation...
+
+|   # a regular plugin (kind:zsh is implied, so it's unnecessary)
+|   antidote bundle zsh-users/zsh-history-substring-search kind:zsh
+
+|   # add prompt plugins to $fpath
+|   antidote bundle sindresorhus/pure kind:fpath
+
+|   # add utility plugins to $PATH
+|   antidote bundle romkatv/zsh-bench kind:path
+
+|   # clone a repo for use in other ways
+|   antidote bundle mbadolato/iTerm2-Color-Schemes kind:clone
+
+|   # autoload a functions directory
+|   antidote bundle sorin-ionescu/prezto path:modules/utility/functions kind:autoload
+
+|   # defer a plugin to speed up load times
+|   antidote bundle olets/zsh-abbr kind:defer
+
+Using the **branch:** annotation...
+
+|   # don't use the main branch, use develop instead
+|   antidote bundle zsh-users/zsh-autosuggestions branch:develop
+
+Using the **path:** annotation...
+
+|   # load oh-my-zsh
+|   antidote bundle ohmyzsh/ohmyzsh path:lib
+|   antidote bundle ohmyzsh/ohmyzsh path:plugins/git
+
+Using the **conditional:** annotation...
+
+|   # define a conditional function prior to loading antidote
+|   function is_macos {
+|     [[ $OSTYPE == darwin* ]] || return 1
+|   }
+|
+|   # conditionally load a plugin using the function you made
+|   antidote bundle ohmyzsh/ohmyzsh path:plugins/macos conditional:is_macos
+

.antidote/man/antidote-help.md

@@ -0,0 +1,25 @@
+---
+title: antidote-help
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote help** - show antidote documentation
+
+# SYNOPSIS
+
+| antidote help [\<command\>]
+
+# DESCRIPTION
+
+**antidote-help** is used to show context-sensitive help for antidote and its commands.
+
+# OPTIONS
+
+-h, \--help
+:   Inception-style meta-help recursively.
+
+[*\<command\>*]
+:   Show help for a specific command.

.antidote/man/antidote-home.md

@@ -0,0 +1,32 @@
+---
+title: antidote-home
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote home** - print where antidote is cloning bundles
+
+# SYNOPSIS
+
+| antidote home
+
+# DESCRIPTION
+
+**antidote-home** shows you where antidote stores its cloned repos. It is not the home of the antidote utility itself.
+
+|   antidote home
+
+You can override antidote's default home directory by setting the _\$ANTIDOTE_HOME_ variable in your **.zshrc**.
+
+# OPTIONS
+
+-h, \--help
+:   Show the help documentation.
+
+# EXAMPLES
+
+You can clear out all your cloned repos like so:
+
+|   rm -rfi $(antidote home)

.antidote/man/antidote-init.md

@@ -0,0 +1,28 @@
+---
+title: antidote-init
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote init** - initialize the shell for dynamic bundles
+
+# SYNOPSIS
+
+| source <(antidote init)
+
+# DESCRIPTION
+
+**antidote-init** changes how the **antidote** command works by causing **antidote bundle** to automatically source its own output instead of just generating the Zsh script for a static file.
+
+This behavior exists mainly to support legacy antigen/antibody usage. Static bundling is highly recommended for the best performance. However, dynamic bundling may be preferable for some scenarios, so you can rely on this functionality remaining a key feature in **antidote** to support users preferring dynamic bundles.
+
+Typical usage involves adding this snippet to your **.zshrc** before using **antidote bundle** commands:
+
+|  source <(antidote init)
+
+# OPTIONS
+
+-h, \--help
+:   Show the help documentation.

.antidote/man/antidote-install.md

@@ -0,0 +1,60 @@
+---
+title: antidote-install
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote install** - install a bundle
+
+# SYNOPSIS
+
+| antidote install [-h|\--help] [-k|\--kind \<kind\>] [-p|\--path \<path\>]
+|                  [-a|\--autoload \<path\>] [-c|\--conditional \<func\>]
+|                  [\--pre \<func\>] [\--post \<func\>]
+|                  [-b|\--branch \<branch\>] \<bundle\> [\<bundlefile\>]
+
+# DESCRIPTION
+
+**antidote-install** clones a new bundle and adds it to your plugins file.
+
+The default bundle file is **${ZDOTDIR:-\$HOME}/.zsh_plugins.txt**. This can be overridden with the following **zstyle**:
+
+|   zstyle \':antidote:bundle\' file /path/to/my/bundle_file.txt
+
+# OPTIONS
+
+-h, \--help
+:   Show the help documentation.
+
+-k, \--kind <kind>
+:   The kind of bundle. Valid values: autoload, fpath, path, clone, defer, zsh.
+
+-p, \--path <path>
+:   A relative subpath within the bundle where the plugin is located.
+
+-b, \--branch <path>
+:   The git branch to use.
+
+-a, \--autoload <path>
+:   A relative subpath within the bundle where autoload function files are located.
+
+-c, \--conditional <func>
+:   A conditional function used to check whether to load the bundle.
+
+\--pre <func>
+:   A function to be called prior to loading the bundle.
+
+\--post <func>
+:   A function to be called after loading the bundle.
+
+\<bundle\>
+:   Bundle to be installed.
+
+[\<bundlefile\>]
+:   Bundle file to write to if not using the default. Defaults to **${ZDOTDIR:-\$HOME}/.zsh_plugins.txt** or zstyle setting.
+
+# EXAMPLES
+
+|   antidote install zsh-users/zsh-history-substring-search

.antidote/man/antidote-list.md

@@ -0,0 +1,31 @@
+---
+title: antidote-list
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote list** - list cloned bundles
+
+# SYNOPSIS
+
+| antidote list [-h|\--help] [-s|\--short] [-d|\--dirs] [-u|\--url]
+
+# DESCRIPTION
+
+**antidote-list** lists the cloned bundles in **antidote home**.
+
+# OPTIONS
+
+-h, \--help
+:   Show the help documentation.
+
+-s, \--short
+:   Show shortened repos where possible.
+
+-d, \--dirs
+:   Show only bundle directories.
+
+-u, \--url
+:   Show bundle URLs.

.antidote/man/antidote-load.md

@@ -0,0 +1,36 @@
+---
+title: antidote-load
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote load** - statically source bundles
+
+# SYNOPSIS
+
+| antidote load [\<bundlefile\> [\<staticfile\>]]
+
+# DESCRIPTION
+
+**antidote-load** will turn the bundle file into a static load file and then source it.
+
+The default bundle file is **${ZDOTDIR:-\$HOME}/.zsh_plugins.txt**. This can be overridden with the following **zstyle**:
+
+|   zstyle \':antidote:bundle\' file /path/to/my/bundle_file.txt
+
+The default static file is **${ZDOTDIR:-\$HOME}/.zsh_plugins.zsh**. This can be overridden with the following **zstyle**:
+
+|   zstyle \':antidote:static\' file /path/to/my/static_file.zsh
+
+# OPTIONS
+
+-h, \--help
+:   Show the help documentation.
+
+[\<bundlefile\>]
+:   The plugins file to source if not using the default. Defaults to **${ZDOTDIR:-\$HOME}/.zsh_plugins.txt** or zstyle setting.
+
+[\<staticfile\>]
+:   The static plugins file to generate if not using the default. Defaults to **${ZDOTDIR:-\$HOME}/.zsh_plugins.zsh** or zstyle setting.

.antidote/man/antidote-path.md

@@ -0,0 +1,25 @@
+---
+title: antidote-path
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote path** - print the path of a cloned bundle
+
+# SYNOPSIS
+
+| antidote path \<bundle\>
+
+# DESCRIPTION
+
+**antidote-path** prints the path of a cloned bundle.
+
+# OPTIONS
+
+-h, \--help
+:   Show the help documentation.
+
+[\<bundle\>]
+:   The bundle whose cloned path will be printed.

.antidote/man/antidote-purge.md

@@ -0,0 +1,32 @@
+---
+title: antidote-purge
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote purge** - remove a bundle
+
+# SYNOPSIS
+
+| antidote purge \<bundle\>
+
+# DESCRIPTION
+
+**antidote-purge** removes a cloned bundle.
+
+# OPTIONS
+
+-h, \--help
+:   Show the help documentation.
+
+-a, \--all
+:   Purge all cloned bundles.
+
+\<bundle\>
+:   Bundle to be purged.
+
+# EXAMPLES
+
+|   antidote purge zsh-users/zsh-history-substring-search

.antidote/man/antidote-update.md

@@ -0,0 +1,32 @@
+---
+title: antidote-update
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote update** - update bundles
+
+# SYNOPSIS
+
+| antidote update [-h|\--help] [-s|\--self] [-b|\--bundles]
+
+# DESCRIPTION
+
+**antidote-update** updates antidote and its cloned bundles.
+
+# OPTIONS
+
+-h, \--help
+:   Show the help documentation.
+
+-s, \--self
+:   Update antidote.
+
+-b, \--bundles
+:   Update bundles.
+
+# EXAMPLES
+
+| antidote update

.antidote/man/antidote.md

@@ -0,0 +1,174 @@
+---
+title: antidote
+section: 1
+header: Antidote Manual
+---
+
+# NAME
+
+**antidote** - the cure to slow zsh plugin management
+
+# SYNOPSIS
+
+| antidote [-v | --version] [-h | --help] \<command\> [\<args\> ...]
+
+# DESCRIPTION
+
+**antidote** is a Zsh plugin manager made from the ground up thinking about performance.
+
+It is fast because it can do things concurrently, and generates an ultra-fast static plugin file that you can easily load from your Zsh config.
+
+It is written natively in Zsh, is well tested, and picks up where Antigen and Antibody left off.
+
+# OPTIONS
+
+-h, \--help
+:   Show context-sensitive help for antidote.
+
+-v, \--version
+:   Show currently installed antidote version.
+
+# COMMANDS
+
+`help`
+:   Show documentation
+
+`load`
+:   Statically source all bundles from the plugins file
+
+`bundle`
+:   Clone bundle(s) and generate the static load script
+
+`install`
+:   Clone a new bundle and add it to your plugins file
+
+`update`
+:   Update antidote and its cloned bundles
+
+`purge`
+:   Remove a cloned bundle
+
+`home`
+:   Print where antidote is cloning bundles
+
+`list`
+:   List cloned bundles
+
+`path`
+:   Print the path of a cloned bundle
+
+`init`
+:   Initialize the shell for dynamic bundles
+
+# EXAMPLES
+
+## A Simple Config
+
+Create a _.zsh_plugins.txt_ file with a list of the plugins you want:
+
+|    # ${ZDOTDIR:-\$HOME}/.zsh_plugins.txt
+|    zsh-users/zsh-syntax-highlighting
+|    zsh-users/zsh-history-substring-search
+|    zsh-users/zsh-autosuggestions
+
+Now, simply load your newly created static plugins file in your _.zshrc_.
+
+|    # ${ZDOTDIR:-\$HOME}/.zshrc
+|    source /path/to/antidote/antidote.zsh
+|    antidote load
+
+## A More Advanced Config
+
+Your _.zsh_plugins.txt_ file supports annotations. Annotations tell antidote how to do things like load plugins from alternate paths. This lets you use plugins from popular frameworks like Oh-My-Zsh:
+
+|    # ${ZDOTDIR:-\$HOME}/.zsh_plugins.txt
+|    ohmyzsh/ohmyzsh path:lib
+|    ohmyzsh/ohmyzsh path:plugins/git
+|    ohmyzsh/ohmyzsh path:plugins/magic-enter
+|    etc...
+
+## Dynamic Bundling
+
+Users familiar with legacy plugin managers like Antigen might prefer to use dynamic bundling. With dynamic bundling you sacrifice some performance to avoid having separate plugin files. To use dynamic bundling, we need to change how **antidote bundle** handles your plugins. We do this by sourcing the output from **antidote init**.
+
+An example config might look like this:
+
+|    source /path/to/antidote/antidote.zsh
+|    source <(antidote init)
+|    antidote bundle zsh-users/zsh-autosuggestions
+|    antidote bundle ohmyzsh/ohmyzsh path:lib
+|    antidote bundle ohmyzsh/ohmyzsh path:plugins/git
+
+Instead of calling **antidote bundle** over and over, you might prefer to load bundles with a HEREDOC.
+
+|    source /path/to/antidote/antidote.zsh
+|    source <(antidote init)
+|    antidote bundle <<EOBUNDLES
+|        zsh-users/zsh-syntax-highlighting         # regular plugins
+|        ohmyzsh/ohmyzsh path:lib                  # directories
+|        ohmyzsh/ohmyzsh path:plugins/magic-enter  # frameworks
+|        https://github.com/zsh-users/zsh-history-substring-search  # URLs
+|    EOBUNDLES
+
+## Installation
+
+To install antidote you can clone it with git:
+
+|   git clone --depth=1 https://github.com/mattmc3/antidote.git ${ZDOTDIR:-\$HOME}/.antidote
+
+Then, simply add the following snippet to your .zshrc:
+
+|   source ${ZDOTDIR:-\$HOME}/.antidote/antidote.zsh
+|   antidote load
+
+# CUSTOMIZATION
+
+The location where antidote clones repositories can bu customized by setting **$ANTIDOTE_HOME**:
+
+|   ANTIDOTE_HOME=/path/to/my/repos
+
+The bundle directory in ANTIDOTE_HOME can be changed to use friendly names with the following **zstyle**:
+
+|   zstyle \':antidote:bundle\' use-friendly-names on
+
+The default bundle file is **${ZDOTDIR:-\$HOME}/.zsh_plugins.txt**. This can be overridden with the following **zstyle**:
+
+|   zstyle \':antidote:bundle\' file /path/to/my/bundle_file.txt
+
+The default static file is **${ZDOTDIR:-\$HOME}/.zsh_plugins.zsh**. This can be overridden with the following **zstyle**:
+
+|   zstyle \':antidote:static\' file /path/to/my/static_file.zsh
+
+The default options used by romkatv/zsh-defer can be changed with the following **zstyle**:
+
+|   zstyle ':antidote:bundle:*' defer-options '-a'
+|   zstyle ':antidote:bundle:foo/bar' defer-options '-p'
+
+Bundles can be Zsh compiled with the following **zstyle**:
+
+|   zstyle ':antidote:bundle:*' zcompile 'yes'
+
+Or, if you only want to zcompile specific bundles, you can set those individually:
+
+|   zstyle ':antidote:bundle:*' zcompile 'yes'
+|   zstyle ':antidote:bundle:zsh-users/zsh-syntax-highlighting' zcompile 'no'
+
+The static file can be Zsh compiled with the following **zstyle**:
+
+|   zstyle ':antidote:static' zcompile 'yes'
+
+Or, to Zsh compile everything, static file and all bundles:
+
+|   zstyle ':antidote:*' zcompile 'yes'
+
+By default, antidote appends to the end of your $fpath. This is highly recommended, however if you really want to change that behavior, there's a zstyle for that:
+
+|   zstyle ':antidote:fpath' rule 'prepend'
+
+By default, antidote uses romkatv/zsh-defer for deferred plugins. If there's a fork you'd prefer to use, you can specify that with this zstyle:
+
+|   zstyle ':antidote:defer' bundle 'getantidote/zsh-defer'
+
+# SEE ALSO
+
+For more information, visit https://antidote.sh

.antidote/man/man1/antidote-bundle.1

@@ -0,0 +1,185 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote\-bundle" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote bundle\f[R] \- download a bundle and print its source line
+.SH SYNOPSIS
+.PP
+antidote bundle [<bundles>\&...]
+.SH DESCRIPTION
+\f[B]antidote\-bundle\f[R] assembles your Zsh plugins.
+Bundles can be git repos, or local files or directories.
+If a plugin is a repo, it will be cloned if necessary.
+The zsh code necessary to load (source) the plugin is then printed.
+.PP
+\ \ antidote bundle gituser/gitrepo
+.PD 0
+.P
+.PD
+\ \ antidote bundle $ZSH_CUSTOM/plugins/myplugin
+.PD 0
+.P
+.PD
+\ \ antidote bundle ${ZDOTDIR:\-$HOME}/.zlibs/myfile.zsh
+.PP
+Bundles also support annotations.
+Annotations allow you have finer grained control over your plugins.
+Annotations are used in the form \[aq]keyword:value\[aq].
+.TP
+\f[CR]kind\f[R]
+.IP \[bu] 2
+\f[B]zsh\f[R]: A zsh plugin.
+This is the default kind of bundle.
+.IP \[bu] 2
+\f[B]fpath\f[R]: Only add the plugin to your \f[I]$fpath\f[R].
+.IP \[bu] 2
+\f[B]path\f[R]: Add the plugin to your \f[I]$PATH\f[R].
+.IP \[bu] 2
+\f[B]clone\f[R]: Only clone a plugin, but don\[cq]t do anything else
+with it.
+.IP \[bu] 2
+\f[B]defer\f[R]: Defers loading of a plugin using
+\[aq]romkatv/zsh\-defer\[aq].
+.IP \[bu] 2
+\f[B]autoload\f[R]: Autoload all the files in the plugin directory as
+zsh functions.
+.TP
+\f[CR]branch\f[R]
+The branch annotation allows you to change the default branch of a
+plugin\[cq]s repo from \f[B]main\f[R] to a branch of your choosing.
+.TP
+\f[CR]path\f[R]
+The path annotation allows you to use a subdirectory or file within a
+plugin\[cq]s structure instead of the root plugin (eg:
+\[aq]path:plugins/subplugin\[aq]).
+.TP
+\f[CR]conditional\f[R]
+The conditonal annotation allows you to wrap an \f[B]if\f[R] statement
+around a plugin\[cq]s load script.
+Supply the name of a zero argument zsh function to conditional to
+perform the test (eg: \[aq]conditional:is\-macos\[aq]).
+.TP
+\f[CR]pre\f[R] / \f[CR]post\f[R]
+The pre and post annotations allow you to call a function before or
+after a plugin\[cq]s load script.
+This is helpful when configuring plugins, since the configuration
+functions will only run for active plugins.
+Supply the name of a zero argument zsh function to pre or post.
+.TP
+\f[CR]autoload\f[R]
+The autoload annotation allows you to autoload a zsh functions directory
+in addition to however the plugin was loaded as specified by
+\[aq]kind\[aq].
+Supply a relative path to autoload (eg: \[aq]autoload:functions\[aq]).
+.PP
+Cloned repo directory names can be overridden with the following
+\f[B]zstyle\f[R]:
+.PP
+\ \ zstyle \[aq]:antidote:bundle\[aq] use\-friendly\-names \[aq]yes\[aq]
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Show the help documentation.
+.TP
+[\f[I]<bundles>\&...\f[R]]
+Zsh plugin bundles
+.SH EXAMPLES
+Using the \f[B]kind:\f[R] annotation\&...
+.PP
+\ \ # a regular plugin (kind:zsh is implied, so it\[cq]s unnecessary)
+.PD 0
+.P
+.PD
+\ \ antidote bundle zsh\-users/zsh\-history\-substring\-search kind:zsh
+.PP
+\ \ # add prompt plugins to $fpath
+.PD 0
+.P
+.PD
+\ \ antidote bundle sindresorhus/pure kind:fpath
+.PP
+\ \ # add utility plugins to $PATH
+.PD 0
+.P
+.PD
+\ \ antidote bundle romkatv/zsh\-bench kind:path
+.PP
+\ \ # clone a repo for use in other ways
+.PD 0
+.P
+.PD
+\ \ antidote bundle mbadolato/iTerm2\-Color\-Schemes kind:clone
+.PP
+\ \ # autoload a functions directory
+.PD 0
+.P
+.PD
+\ \ antidote bundle sorin\-ionescu/prezto path:modules/utility/functions
+kind:autoload
+.PP
+\ \ # defer a plugin to speed up load times
+.PD 0
+.P
+.PD
+\ \ antidote bundle olets/zsh\-abbr kind:defer
+.PP
+Using the \f[B]branch:\f[R] annotation\&...
+.PP
+\ \ # don\[cq]t use the main branch, use develop instead
+.PD 0
+.P
+.PD
+\ \ antidote bundle zsh\-users/zsh\-autosuggestions branch:develop
+.PP
+Using the \f[B]path:\f[R] annotation\&...
+.PP
+\ \ # load oh\-my\-zsh
+.PD 0
+.P
+.PD
+\ \ antidote bundle ohmyzsh/ohmyzsh path:lib
+.PD 0
+.P
+.PD
+\ \ antidote bundle ohmyzsh/ohmyzsh path:plugins/git
+.PP
+Using the \f[B]conditional:\f[R] annotation\&...
+.PP
+\ \ # define a conditional function prior to loading antidote
+.PD 0
+.P
+.PD
+\ \ function is_macos {
+.PD 0
+.P
+.PD
+\ \ \ \ [[ $OSTYPE == darwin* ]] || return 1
+.PD 0
+.P
+.PD
+\ \ }
+.PD 0
+.P
+.PD
+.PD 0
+.P
+.PD
+\ \ # conditionally load a plugin using the function you made
+.PD 0
+.P
+.PD
+\ \ antidote bundle ohmyzsh/ohmyzsh path:plugins/macos
+conditional:is_macos
+.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

.antidote/man/man1/antidote-help.1

@@ -0,0 +1,31 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote\-help" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote help\f[R] \- show antidote documentation
+.SH SYNOPSIS
+.PP
+antidote help [<command>]
+.SH DESCRIPTION
+\f[B]antidote\-help\f[R] is used to show context\-sensitive help for
+antidote and its commands.
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Inception\-style meta\-help recursively.
+.TP
+[\f[I]<command>\f[R]]
+Show help for a specific command.
+.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

.antidote/man/man1/antidote-home.1

@@ -0,0 +1,38 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote\-home" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote home\f[R] \- print where antidote is cloning bundles
+.SH SYNOPSIS
+.PP
+antidote home
+.SH DESCRIPTION
+\f[B]antidote\-home\f[R] shows you where antidote stores its cloned
+repos.
+It is not the home of the antidote utility itself.
+.PP
+\ \ antidote home
+.PP
+You can override antidote\[cq]s default home directory by setting the
+\f[I]$ANTIDOTE_HOME\f[R] variable in your \f[B].zshrc\f[R].
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Show the help documentation.
+.SH EXAMPLES
+You can clear out all your cloned repos like so:
+.PP
+\ \ rm \-rfi $(antidote home)
+.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

.antidote/man/man1/antidote-init.1

@@ -0,0 +1,40 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote\-init" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote init\f[R] \- initialize the shell for dynamic bundles
+.SH SYNOPSIS
+.PP
+source <(antidote init)
+.SH DESCRIPTION
+\f[B]antidote\-init\f[R] changes how the \f[B]antidote\f[R] command
+works by causing \f[B]antidote bundle\f[R] to automatically source its
+own output instead of just generating the Zsh script for a static file.
+.PP
+This behavior exists mainly to support legacy antigen/antibody usage.
+Static bundling is highly recommended for the best performance.
+However, dynamic bundling may be preferable for some scenarios, so you
+can rely on this functionality remaining a key feature in
+\f[B]antidote\f[R] to support users preferring dynamic bundles.
+.PP
+Typical usage involves adding this snippet to your \f[B].zshrc\f[R]
+before using \f[B]antidote bundle\f[R] commands:
+.PP
+\ source <(antidote init)
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Show the help documentation.
+.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

.antidote/man/man1/antidote-install.1

@@ -0,0 +1,83 @@
+.\" 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

.antidote/man/man1/antidote-list.1

@@ -0,0 +1,38 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote\-list" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote list\f[R] \- list cloned bundles
+.SH SYNOPSIS
+.PP
+antidote list [\-h|\-\-help] [\-s|\-\-short] [\-d|\-\-dirs]
+[\-u|\-\-url]
+.SH DESCRIPTION
+\f[B]antidote\-list\f[R] lists the cloned bundles in \f[B]antidote
+home\f[R].
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Show the help documentation.
+.TP
+\-s, \-\-short
+Show shortened repos where possible.
+.TP
+\-d, \-\-dirs
+Show only bundle directories.
+.TP
+\-u, \-\-url
+Show bundle URLs.
+.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

.antidote/man/man1/antidote-load.1

@@ -0,0 +1,50 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote\-load" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote load\f[R] \- statically source bundles
+.SH SYNOPSIS
+.PP
+antidote load [<bundlefile> [<staticfile>]]
+.SH DESCRIPTION
+\f[B]antidote\-load\f[R] will turn the bundle file into a static load
+file and then source it.
+.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
+.PP
+The default static file is
+\f[B]${ZDOTDIR:\-$HOME}/.zsh_plugins.zsh\f[R].
+This can be overridden with the following \f[B]zstyle\f[R]:
+.PP
+\ \ zstyle \[aq]:antidote:static\[aq] file /path/to/my/static_file.zsh
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Show the help documentation.
+.TP
+[<bundlefile>]
+The plugins file to source if not using the default.
+Defaults to \f[B]${ZDOTDIR:\-$HOME}/.zsh_plugins.txt\f[R] or zstyle
+setting.
+.TP
+[<staticfile>]
+The static plugins file to generate if not using the default.
+Defaults to \f[B]${ZDOTDIR:\-$HOME}/.zsh_plugins.zsh\f[R] or zstyle
+setting.
+.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

.antidote/man/man1/antidote-path.1

@@ -0,0 +1,30 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote\-path" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote path\f[R] \- print the path of a cloned bundle
+.SH SYNOPSIS
+.PP
+antidote path <bundle>
+.SH DESCRIPTION
+\f[B]antidote\-path\f[R] prints the path of a cloned bundle.
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Show the help documentation.
+.TP
+[<bundle>]
+The bundle whose cloned path will be printed.
+.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

.antidote/man/man1/antidote-purge.1

@@ -0,0 +1,36 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote\-purge" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote purge\f[R] \- remove a bundle
+.SH SYNOPSIS
+.PP
+antidote purge <bundle>
+.SH DESCRIPTION
+\f[B]antidote\-purge\f[R] removes a cloned bundle.
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Show the help documentation.
+.TP
+\-a, \-\-all
+Purge all cloned bundles.
+.TP
+<bundle>
+Bundle to be purged.
+.SH EXAMPLES
+.PP
+\ \ antidote purge 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

.antidote/man/man1/antidote-update.1

@@ -0,0 +1,36 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote\-update" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote update\f[R] \- update bundles
+.SH SYNOPSIS
+.PP
+antidote update [\-h|\-\-help] [\-s|\-\-self] [\-b|\-\-bundles]
+.SH DESCRIPTION
+\f[B]antidote\-update\f[R] updates antidote and its cloned bundles.
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Show the help documentation.
+.TP
+\-s, \-\-self
+Update antidote.
+.TP
+\-b, \-\-bundles
+Update bundles.
+.SH EXAMPLES
+.PP
+antidote update
+.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

.antidote/man/man1/antidote.1

@@ -0,0 +1,265 @@
+.\" Automatically generated by Pandoc
+.\"
+.TH "antidote" "1" "" "" "Antidote Manual"
+.SH NAME
+\f[B]antidote\f[R] \- the cure to slow zsh plugin management
+.SH SYNOPSIS
+.PP
+antidote [\-v | \[en]version] [\-h | \[en]help] <command> [<args> \&...]
+.SH DESCRIPTION
+\f[B]antidote\f[R] is a Zsh plugin manager made from the ground up
+thinking about performance.
+.PP
+It is fast because it can do things concurrently, and generates an
+ultra\-fast static plugin file that you can easily load from your Zsh
+config.
+.PP
+It is written natively in Zsh, is well tested, and picks up where
+Antigen and Antibody left off.
+.SH OPTIONS
+.TP
+\-h, \-\-help
+Show context\-sensitive help for antidote.
+.TP
+\-v, \-\-version
+Show currently installed antidote version.
+.SH COMMANDS
+.TP
+\f[CR]help\f[R]
+Show documentation
+.TP
+\f[CR]load\f[R]
+Statically source all bundles from the plugins file
+.TP
+\f[CR]bundle\f[R]
+Clone bundle(s) and generate the static load script
+.TP
+\f[CR]install\f[R]
+Clone a new bundle and add it to your plugins file
+.TP
+\f[CR]update\f[R]
+Update antidote and its cloned bundles
+.TP
+\f[CR]purge\f[R]
+Remove a cloned bundle
+.TP
+\f[CR]home\f[R]
+Print where antidote is cloning bundles
+.TP
+\f[CR]list\f[R]
+List cloned bundles
+.TP
+\f[CR]path\f[R]
+Print the path of a cloned bundle
+.TP
+\f[CR]init\f[R]
+Initialize the shell for dynamic bundles
+.SH EXAMPLES
+.SS A Simple Config
+Create a \f[I].zsh_plugins.txt\f[R] file with a list of the plugins you
+want:
+.PP
+\ \ \ # ${ZDOTDIR:\-$HOME}/.zsh_plugins.txt
+.PD 0
+.P
+.PD
+\ \ \ zsh\-users/zsh\-syntax\-highlighting
+.PD 0
+.P
+.PD
+\ \ \ zsh\-users/zsh\-history\-substring\-search
+.PD 0
+.P
+.PD
+\ \ \ zsh\-users/zsh\-autosuggestions
+.PP
+Now, simply load your newly created static plugins file in your
+\f[I].zshrc\f[R].
+.PP
+\ \ \ # ${ZDOTDIR:\-$HOME}/.zshrc
+.PD 0
+.P
+.PD
+\ \ \ source /path/to/antidote/antidote.zsh
+.PD 0
+.P
+.PD
+\ \ \ antidote load
+.SS A More Advanced Config
+Your \f[I].zsh_plugins.txt\f[R] file supports annotations.
+Annotations tell antidote how to do things like load plugins from
+alternate paths.
+This lets you use plugins from popular frameworks like Oh\-My\-Zsh:
+.PP
+\ \ \ # ${ZDOTDIR:\-$HOME}/.zsh_plugins.txt
+.PD 0
+.P
+.PD
+\ \ \ ohmyzsh/ohmyzsh path:lib
+.PD 0
+.P
+.PD
+\ \ \ ohmyzsh/ohmyzsh path:plugins/git
+.PD 0
+.P
+.PD
+\ \ \ ohmyzsh/ohmyzsh path:plugins/magic\-enter
+.PD 0
+.P
+.PD
+\ \ \ etc\&...
+.SS Dynamic Bundling
+Users familiar with legacy plugin managers like Antigen might prefer to
+use dynamic bundling.
+With dynamic bundling you sacrifice some performance to avoid having
+separate plugin files.
+To use dynamic bundling, we need to change how \f[B]antidote bundle\f[R]
+handles your plugins.
+We do this by sourcing the output from \f[B]antidote init\f[R].
+.PP
+An example config might look like this:
+.PP
+\ \ \ source /path/to/antidote/antidote.zsh
+.PD 0
+.P
+.PD
+\ \ \ source <(antidote init)
+.PD 0
+.P
+.PD
+\ \ \ antidote bundle zsh\-users/zsh\-autosuggestions
+.PD 0
+.P
+.PD
+\ \ \ antidote bundle ohmyzsh/ohmyzsh path:lib
+.PD 0
+.P
+.PD
+\ \ \ antidote bundle ohmyzsh/ohmyzsh path:plugins/git
+.PP
+Instead of calling \f[B]antidote bundle\f[R] over and over, you might
+prefer to load bundles with a HEREDOC.
+.PP
+\ \ \ source /path/to/antidote/antidote.zsh
+.PD 0
+.P
+.PD
+\ \ \ source <(antidote init)
+.PD 0
+.P
+.PD
+\ \ \ antidote bundle <<EOBUNDLES
+.PD 0
+.P
+.PD
+\ \ \ \ \ \ \ zsh\-users/zsh\-syntax\-highlighting # regular plugins
+.PD 0
+.P
+.PD
+\ \ \ \ \ \ \ ohmyzsh/ohmyzsh path:lib # directories
+.PD 0
+.P
+.PD
+\ \ \ \ \ \ \ ohmyzsh/ohmyzsh path:plugins/magic\-enter # frameworks
+.PD 0
+.P
+.PD
+\ \ \ \ \ \ \ https://github.com/zsh\-users/zsh\-history\-substring\-search
+# URLs
+.PD 0
+.P
+.PD
+\ \ \ EOBUNDLES
+.SS Installation
+To install antidote you can clone it with git:
+.PP
+\ \ git clone \[en]depth=1 https://github.com/mattmc3/antidote.git
+${ZDOTDIR:\-$HOME}/.antidote
+.PP
+Then, simply add the following snippet to your .zshrc:
+.PP
+\ \ source ${ZDOTDIR:\-$HOME}/.antidote/antidote.zsh
+.PD 0
+.P
+.PD
+\ \ antidote load
+.SH CUSTOMIZATION
+The location where antidote clones repositories can bu customized by
+setting \f[B]$ANTIDOTE_HOME\f[R]:
+.PP
+\ \ ANTIDOTE_HOME=/path/to/my/repos
+.PP
+The bundle directory in ANTIDOTE_HOME can be changed to use friendly
+names with the following \f[B]zstyle\f[R]:
+.PP
+\ \ zstyle \[aq]:antidote:bundle\[aq] use\-friendly\-names on
+.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
+.PP
+The default static file is
+\f[B]${ZDOTDIR:\-$HOME}/.zsh_plugins.zsh\f[R].
+This can be overridden with the following \f[B]zstyle\f[R]:
+.PP
+\ \ zstyle \[aq]:antidote:static\[aq] file /path/to/my/static_file.zsh
+.PP
+The default options used by romkatv/zsh\-defer can be changed with the
+following \f[B]zstyle\f[R]:
+.PP
+\ \ zstyle \[cq]:antidote:bundle:*\[cq] defer\-options `\-a'
+.PD 0
+.P
+.PD
+\ \ zstyle `:antidote:bundle:foo/bar' defer\-options `\-p'
+.PP
+Bundles can be Zsh compiled with the following \f[B]zstyle\f[R]:
+.PP
+\ \ zstyle \[cq]:antidote:bundle:*\[cq] zcompile `yes'
+.PP
+Or, if you only want to zcompile specific bundles, you can set those
+individually:
+.PP
+\ \ zstyle \[cq]:antidote:bundle:*\[cq] zcompile `yes'
+.PD 0
+.P
+.PD
+\ \ zstyle `:antidote:bundle:zsh\-users/zsh\-syntax\-highlighting'
+zcompile `no'
+.PP
+The static file can be Zsh compiled with the following \f[B]zstyle\f[R]:
+.PP
+\ \ zstyle `:antidote:static' zcompile `yes'
+.PP
+Or, to Zsh compile everything, static file and all bundles:
+.PP
+\ \ zstyle \[cq]:antidote:*\[cq] zcompile `yes'
+.PP
+By default, antidote appends to the end of your $fpath.
+This is highly recommended, however if you really want to change that
+behavior, there\[cq]s a zstyle for that:
+.PP
+\ \ zstyle `:antidote:fpath' rule `prepend'
+.PP
+By default, antidote uses romkatv/zsh\-defer for deferred plugins.
+If there\[cq]s a fork you\[cq]d prefer to use, you can specify that with
+this zstyle:
+.PP
+\ \ zstyle `:antidote:defer' bundle `getantidote/zsh\-defer'
+.SH SEE ALSO
+For more information, visit https://antidote.sh
+.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