From b60acddefe4cb18267e84b6cdd4314e82352be2c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Cornell=C3=A0?= <marc.cornella@live.com>
Date: Sun, 21 Aug 2016 00:19:59 +0200
Subject: [PATCH] Extract comments into README for ssh-agent plugin

---
 plugins/ssh-agent/README.md            | 38 ++++++++++++++++++++++++++
 plugins/ssh-agent/ssh-agent.plugin.zsh | 30 --------------------
 2 files changed, 38 insertions(+), 30 deletions(-)
 create mode 100644 plugins/ssh-agent/README.md

diff --git a/plugins/ssh-agent/README.md b/plugins/ssh-agent/README.md
new file mode 100644
index 000000000..00af42f01
--- /dev/null
+++ b/plugins/ssh-agent/README.md
@@ -0,0 +1,38 @@
+# ssh-agent plugin
+
+This plugin starts automatically `ssh-agent` to set up and load whichever
+credentials you want for ssh connections.
+
+To enable it, add `ssh-agent` to your plugins:
+
+```zsh
+plugins=(... ssh-agent)
+```
+
+## Instructions
+
+To enable **agent forwarding support** add the following to your zshrc file:
+
+```zsh
+zstyle :omz:plugins:ssh-agent agent-forwarding on
+```
+
+To **load multiple identities** use the `identities` style, For example:
+
+```zsh
+zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github
+```
+
+To **set the maximum lifetime of the identities**, use the `lifetime` style.
+The lifetime may be specified in seconds or as described in sshd_config(5)
+(see _TIME FORMATS_). If left unspecified, the default lifetime is forever.
+
+```zsh
+zstyle :omz:plugins:ssh-agent lifetime 4h
+```
+
+## Credits
+
+Based on code from Joseph M. Reagle: http://www.cygwin.com/ml/cygwin/2001-06/msg00537.html
+
+Agent-forwarding support based on ideas from Florent Thoumie and Jonas Pfenniger
diff --git a/plugins/ssh-agent/ssh-agent.plugin.zsh b/plugins/ssh-agent/ssh-agent.plugin.zsh
index 6fdeb2725..81f27ca00 100644
--- a/plugins/ssh-agent/ssh-agent.plugin.zsh
+++ b/plugins/ssh-agent/ssh-agent.plugin.zsh
@@ -1,32 +1,3 @@
-#
-# INSTRUCTIONS
-#
-#   To enable agent forwarding support add the following to
-#   your .zshrc file:
-#
-#     zstyle :omz:plugins:ssh-agent agent-forwarding on
-#
-#   To load multiple identities use the identities style, For
-#   example:
-#
-#     zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github
-#
-#   To set the maximum lifetime of the identities, use the
-#   lifetime style. The lifetime may be specified in seconds
-#   or as described in sshd_config(5) (see TIME FORMATS)
-#   If left unspecified, the default lifetime is forever.
-#
-#     zstyle :omz:plugins:ssh-agent lifetime 4h
-#
-# CREDITS
-#
-#   Based on code from Joseph M. Reagle
-#   http://www.cygwin.com/ml/cygwin/2001-06/msg00537.html
-#
-#   Agent forwarding support based on ideas from
-#   Florent Thoumie and Jonas Pfenniger
-#
-
 local _plugin__ssh_env
 local _plugin__forwarding
 
@@ -76,4 +47,3 @@ fi
 unfunction _plugin__start_agent
 unset _plugin__forwarding
 unset _plugin__ssh_env
-