summaryrefslogtreecommitdiff
path: root/plugins/gpg-agent
diff options
context:
space:
mode:
authorG'lek Tarssza <glek@glektarssza.com>2025-09-05 19:55:42 -0600
committerGitHub <noreply@github.com>2025-09-06 09:55:42 +0800
commit26863c50b3eaad4b13f7dfa07e06053e1d4834a2 (patch)
treeb8ad7b94bca3bc53a409fe92778304c25c9aa3bd /plugins/gpg-agent
parentb9c9fcfd3fb93c43b456ddb608308c9ac9bffab1 (diff)
downloadzsh-26863c50b3eaad4b13f7dfa07e06053e1d4834a2.tar.gz
zsh-26863c50b3eaad4b13f7dfa07e06053e1d4834a2.tar.bz2
zsh-26863c50b3eaad4b13f7dfa07e06053e1d4834a2.zip
docs(gpg-agent): clarify plugin purpose (#13289)
Diffstat (limited to 'plugins/gpg-agent')
-rw-r--r--plugins/gpg-agent/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/plugins/gpg-agent/README.md b/plugins/gpg-agent/README.md
index 8eeb94f92..d66c37a5b 100644
--- a/plugins/gpg-agent/README.md
+++ b/plugins/gpg-agent/README.md
@@ -1,6 +1,11 @@
# gpg-agent
-Enables [GPG's gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/) if it is not running.
+Applies some fixes for some common issues encountered with [GPG's gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/).
+
+More specifically, this plugin:
+
+- Updates the `GPG_TTY` environment variable before each shell execution.
+- Updates the `SSH_AUTH_SOCK` environment variable if `enable-ssh-support` is turned on.
To use it, add `gpg-agent` to the plugins array of your zshrc file: