Update man pages

mattmc3 · Oct 28, 2023 · 3f18f35 · 3f18f35
1 parent 92e6d9d
commit 3f18f35
Show file tree

Hide file tree

Showing 14 changed files with 80 additions and 29 deletions.
diff --git a/man/antidote-install.md b/man/antidote-install.md
@@ -19,6 +19,10 @@ header: Antidote Manual
 
 **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

diff --git a/man/antidote-load.md b/man/antidote-load.md
@@ -18,13 +18,11 @@ header: Antidote Manual
 
 The default bundle file is **${ZDOTDIR:-\$HOME}/.zsh_plugins.txt**. This can be overridden with the following **zstyle**:
 
-|   bundlefile=~/.zplugins
-|   zstyle \':antidote:bundle\' file $bundlefile
+|   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**:
 
-|   staticfile=~/.zplugins.zsh
-|   zstyle \':antidote:static\' file $staticfile
+|   zstyle \':antidote:static\' file /path/to/my/static_file.zsh
 
 # OPTIONS
 

diff --git a/man/antidote.md b/man/antidote.md
@@ -121,6 +121,29 @@ 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'
+
 # SEE ALSO
 
 For more information, visit https://getantidote.github.io/
diff --git a/man/man1/antidote-bundle.1 b/man/man1/antidote-bundle.1
@@ -8,7 +8,7 @@
 antidote bundle [<bundles>\&...]
 .SH DESCRIPTION
 \f[B]antidote-bundle\f[R] assembles your Zsh plugins.
-Bundles can be git repos, or local files or dirctories.
+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
@@ -60,8 +60,8 @@ 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 befor or after
-a plugin\[cq]s load script.
+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.
@@ -176,7 +176,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote-help.1 b/man/man1/antidote-help.1
@@ -22,7 +22,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote-home.1 b/man/man1/antidote-home.1
@@ -29,7 +29,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote-init.1 b/man/man1/antidote-init.1
@@ -13,7 +13,7 @@ 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 preferrable for some scenarios, so you
+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
@@ -31,7 +31,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote-install.1 b/man/man1/antidote-install.1
@@ -23,6 +23,11 @@ antidote install [-h|--help] [-k|--kind <kind>] [-p|--path <path>]
 .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
@@ -67,7 +72,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote-list.1 b/man/man1/antidote-list.1
@@ -28,7 +28,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote-load.1 b/man/man1/antidote-load.1
@@ -13,20 +13,12 @@ file and then source it.
 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
-\ \ bundlefile=\[ti]/.zplugins
-.PD 0
-.P
-.PD
-\ \ zstyle \[aq]:antidote:bundle\[aq] file $bundlefile
+\ \ 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
-\ \ staticfile=\[ti]/.zplugins.zsh
-.PD 0
-.P
-.PD
-\ \ zstyle \[aq]:antidote:static\[aq] file $staticfile
+\ \ zstyle \[aq]:antidote:static\[aq] file /path/to/my/static_file.zsh
 .SH OPTIONS
 .TP
 -h, --help
@@ -47,7 +39,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote-path.1 b/man/man1/antidote-path.1
@@ -21,7 +21,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote-purge.1 b/man/man1/antidote-purge.1
@@ -27,7 +27,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote-update.1 b/man/man1/antidote-update.1
@@ -27,7 +27,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT
diff --git a/man/man1/antidote.1 b/man/man1/antidote.1
@@ -183,6 +183,35 @@ Then, simply add the following snippet to your .zshrc:
 .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 zstyle:
+.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'
 .SH SEE ALSO
 For more information, visit https://getantidote.github.io/
 .SH BUGS
@@ -191,7 +220,7 @@ See GitHub Issues: <https://github.com/mattmc3/antidote/issues>
 .IP \[bu] 2
 Copyright (c) 2021-2023 Matt McElheny
 .IP \[bu] 2
-antidote contributers:
+antidote contributors:
 <https://github.com/mattmc3/antidote/graphs/contributors>
 .SH LICENSE
 MIT