Add documentation for screen

This commit is contained in:
Colin Hebert 2012-04-04 13:47:24 +01:00 committed by Sorin Ionescu
parent 715f15f7b7
commit 0ec1b2a68d
2 changed files with 32 additions and 6 deletions

32
plugins/screen/README.md Normal file
View file

@ -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/

View file

@ -4,12 +4,6 @@
# Authors: # Authors:
# Sorin Ionescu <sorin.ionescu@gmail.com> # Sorin Ionescu <sorin.ionescu@gmail.com>
# #
# 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 # Aliases
alias sl="screen -list" alias sl="screen -list"