summaryrefslogtreecommitdiff
path: root/plugins/ssh-agent/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <hello@mcornella.com>2021-10-11 12:15:47 +0200
committerMarc Cornellà <hello@mcornella.com>2021-10-11 12:15:47 +0200
commita0ac789f2abf475346505cd372a3843b3b93d91e (patch)
tree95f020ade804345f80e9cdfa81869e5e5a5e332f /plugins/ssh-agent/README.md
parent9bd0ac9b005189edceb0ac53f361fcc020f8e6b6 (diff)
downloadzsh-a0ac789f2abf475346505cd372a3843b3b93d91e.tar.gz
zsh-a0ac789f2abf475346505cd372a3843b3b93d91e.tar.bz2
zsh-a0ac789f2abf475346505cd372a3843b3b93d91e.zip
feat(ssh-agent): allow lazy-loading SSH identities (#6309)
Fixes #7477
Diffstat (limited to 'plugins/ssh-agent/README.md')
-rw-r--r--plugins/ssh-agent/README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/plugins/ssh-agent/README.md b/plugins/ssh-agent/README.md
index d1a504b1e..1d6914ec6 100644
--- a/plugins/ssh-agent/README.md
+++ b/plugins/ssh-agent/README.md
@@ -21,7 +21,23 @@ zstyle :omz:plugins:ssh-agent agent-forwarding on
----
-To **load multiple identities** use the `identities` style, For example:
+To **NOT load any identities on start** use the `lazy` setting. This is particularly
+useful when combined with the `AddKeysToAgent` setting (available since OpenSSH 7.2),
+since it allows to enter the password only on first use. _NOTE: you can know your
+OpenSSH version with `ssh -V`._
+
+```zsh
+zstyle :omz:plugins:ssh-agent lazy yes
+```
+
+You can enable `AddKeysToAgent` by passing `-o AddKeysToAgent=yes` to the `ssh` command,
+or by adding `AddKeysToAgent yes` to your `~/.ssh/config` file [1].
+See the [OpenSSH 7.2 Release Notes](http://www.openssh.com/txt/release-7.2).
+
+----
+
+To **load multiple identities** use the `identities` style (**this has no effect
+if the `lazy` setting is enabled**). For example:
```zsh
zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github