From ba7fcceac56753108b59280b77fdc7e11ec141f2 Mon Sep 17 00:00:00 2001 From: Ben O'Hara Date: Tue, 12 Jun 2012 21:23:48 +1000 Subject: [PATCH] [Fix #117] Add documentation for ssh-agent --- modules/ssh-agent/README.md | 36 ++++++++++++++++++++++++++++++++++++ modules/ssh-agent/init.zsh | 9 --------- 2 files changed, 36 insertions(+), 9 deletions(-) create mode 100644 modules/ssh-agent/README.md diff --git a/modules/ssh-agent/README.md b/modules/ssh-agent/README.md new file mode 100644 index 0000000..4836f61 --- /dev/null +++ b/modules/ssh-agent/README.md @@ -0,0 +1,36 @@ +SSH-Agent +========= + +Provides for an easier use of [ssh-agent][1]. + +Settings +-------- + +### Agent Forwarding + +To enable ssh-agent forwarding, add the following line to *zshrc*: + + zstyle ':omz:module:ssh-agent' forwarding 'yes' + +### Identities + +To load multiple identities, add the following line to *zshrc*: + + zstyle ':omz:module:ssh-agent' identities 'id_rsa' 'id_rsa2' 'id_github' + +Authors +------- + +*The authors of this module should be contacted via the [issue tracker][2].* + + - [Robby Russell](https://github.com/robbyrussell) + - [Theodore Robert Campbell Jr](https://github.com/trcjr) + - [Joseph M. Reagle Jr.](https://github.com/reagle) + - [Florent Thoumie](https://github.com/flz) + - [Jonas Pfenniger](https://github.com/zimbatm) + - [Gareth Owen](https://github.com/gwjo) + - [Sorin Ionescu](https://github.com/sorin-ionescu) + +[1]: http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-agent&sektion=1 +[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues + diff --git a/modules/ssh-agent/init.zsh b/modules/ssh-agent/init.zsh index 7163869..b070f06 100644 --- a/modules/ssh-agent/init.zsh +++ b/modules/ssh-agent/init.zsh @@ -10,15 +10,6 @@ # gwjo # Sorin Ionescu # -# Usage: -# To enable agent forwarding, add the following to your .zshrc: -# -# zstyle ':omz:module:ssh-agent' forwarding 'yes' -# -# To load multiple identities, add the following to your .zshrc: -# -# zstyle ':omz:module:ssh-agent' identities 'id_rsa' 'id_rsa2' 'id_github' -# if (( ! $+commands[ssh-agent] )); then return 1