Update documentation for tmux
This commit is contained in:
parent
35dcbdb67c
commit
3457ca359a
|
@ -1,34 +1,37 @@
|
|||
tmux Plugin
|
||||
===========
|
||||
tmux
|
||||
====
|
||||
|
||||
Plugin enhancing the [tmux](http://tmux.sourceforge.net/) multiplexer.
|
||||
Defines [tmux][1] aliases and provides for auto launching it at start-up.
|
||||
|
||||
Aliases
|
||||
-------
|
||||
|
||||
- `ta`, Attach or switch to a tmux session
|
||||
- `tl`, List sessions managed by the tmux server
|
||||
- `ta` attach or switch to a tmux session.
|
||||
- `tl` list sessions managed by the tmux server.
|
||||
|
||||
Settings
|
||||
--------
|
||||
|
||||
### Auto-start
|
||||
|
||||
Start a tmux session automatically when a Zsh session is opened.
|
||||
Start a tmux session automatically when Zsh is launched.
|
||||
|
||||
To enable this feature, one line has to be added to the configuration file:
|
||||
To enable this feature, add the following line to *zshrc*:
|
||||
|
||||
zstyle ':omz:plugin:tmux' auto-start 'yes'
|
||||
|
||||
This will automatically create a background session named "#OMZ" and attach every new shell to it.
|
||||
It will create a background session named _#OMZ_ and attach every new shell to
|
||||
it.
|
||||
|
||||
To avoid keeping open sessions, this plugin sets ``destroy-unattached off`` on the background session and ``destroy-unattached on`` on every other session (global setting).
|
||||
To avoid keeping open sessions, this plugin sets `destroy-unattached off` on
|
||||
the background session and `destroy-unattached on` on every other session
|
||||
(global setting).
|
||||
|
||||
Caveats
|
||||
-------
|
||||
|
||||
For some reasons, tmux seems to cause kernel panics on Mac OS X.
|
||||
A discussion about this and OMZ has already been opened [here](http://git.io/jkPqHg).
|
||||
tmux is known to cause kernel panics on Mac OS X. A discussion about this and
|
||||
OMZ has already been opened [here][2].
|
||||
|
||||
Authors
|
||||
-------
|
||||
|
@ -37,3 +40,7 @@ Authors
|
|||
|
||||
- [Sorin Ionescu](/sorin-ionescu)
|
||||
- [Colin Hebert](/ColinHebert)
|
||||
|
||||
[1]: http://tmux.sourceforge.net
|
||||
[2]: http://git.io/jkPqHg
|
||||
|
||||
|
|
|
@ -5,16 +5,6 @@
|
|||
# Sorin Ionescu <sorin.ionescu@gmail.com>
|
||||
# Colin Hebert <hebert.colin@gmail.com>
|
||||
#
|
||||
# Usage:
|
||||
# To auto start it, add the following to zshrc:
|
||||
#
|
||||
# # Auto launch tmux at start-up.
|
||||
# zstyle ':omz:plugin:tmux' auto-start 'yes'
|
||||
#
|
||||
# Warning:
|
||||
# Tmux is known to cause kernel panics on Mac OS X.
|
||||
# For more information, see http://git.io/jkPqHg.
|
||||
#
|
||||
|
||||
# Aliases
|
||||
alias ta="tmux attach-session"
|
||||
|
|
Loading…
Reference in a new issue