Add documentation for screen plugin

This commit is contained in:
Colin Hebert 2012-04-04 13:47:24 +01:00
parent 8ad3ebd88f
commit f1ee1c5681
2 changed files with 31 additions and 6 deletions

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

@ -0,0 +1,31 @@
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 screen session
- `sr`, Attach to a screen session if possible, otherwise start a new one
Settings
--------
### Auto-start
Start a screen session automatically when a Zsh session is opened.
To enable this feature, one line has to be added to the configuration file:
zstyle ':omz:plugin:screen' auto-start 'yes'
Authors
-------
*The authors of this plugin should be contacted via the github bug tracker.*
- [Sorin Ionescu](/sorin-ionescu)
[1]: http://www.gnu.org/software/screen/

View file

@ -4,12 +4,6 @@
# Authors:
# 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
alias sl="screen -list"