From 0ec1b2a68d253f8f9bc33ec7d5b5f2526e1e2952 Mon Sep 17 00:00:00 2001 From: Colin Hebert Date: Wed, 4 Apr 2012 13:47:24 +0100 Subject: [PATCH] Add documentation for screen --- plugins/screen/README.md | 32 ++++++++++++++++++++++++++++++++ plugins/screen/init.zsh | 6 ------ 2 files changed, 32 insertions(+), 6 deletions(-) create mode 100644 plugins/screen/README.md diff --git a/plugins/screen/README.md b/plugins/screen/README.md new file mode 100644 index 0000000..00dfd9f --- /dev/null +++ b/plugins/screen/README.md @@ -0,0 +1,32 @@ +screen +====== + +Defines [GNU Screen][1] aliases and provides for auto launching it at start-up. + +Aliases +------- + + - `sl` list sessions/socket directory. + - `sn` start a new session. + - `sr` attach to a session if one exists or start a new one. + +Settings +-------- + +### Auto-start + +Start a Screen session automatically when Zsh is launched. + +To enable this feature, add the following line to *zshrc*: + + zstyle ':omz:plugin:screen' auto-start 'yes' + +Authors +------- + +*The authors of this plugin should be contacted via the GitHub issue tracker.* + + - [Sorin Ionescu](/sorin-ionescu) + +[1]: http://www.gnu.org/software/screen/ + diff --git a/plugins/screen/init.zsh b/plugins/screen/init.zsh index 2528e83..2a789bc 100644 --- a/plugins/screen/init.zsh +++ b/plugins/screen/init.zsh @@ -4,12 +4,6 @@ # Authors: # Sorin Ionescu # -# Usage: -# To auto start it, add the following to zshrc: -# -# # Auto launch GNU Screen at start-up. -# zstyle ':omz:plugin:screen' auto-start 'yes' -# # Aliases alias sl="screen -list"