From 1abf04cb01e8c5a987632a5bddaa3e10fb5fe035 Mon Sep 17 00:00:00 2001 From: Sagar Patil Date: Wed, 17 Oct 2018 23:27:34 +0530 Subject: tmux: add README (#7293) --- plugins/tmux/README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 plugins/tmux/README.md (limited to 'plugins/tmux') diff --git a/plugins/tmux/README.md b/plugins/tmux/README.md new file mode 100644 index 000000000..427119d3d --- /dev/null +++ b/plugins/tmux/README.md @@ -0,0 +1,39 @@ +# tmux + +This plugin provides aliases for [tmux](http://tmux.github.io/), the terminal multiplexer. +To use it add `tmux` to the plugins array in your zshrc file. + +```zsh +plugins=(... tmux) +``` + +The plugin also supports the following - +- determines if tmux is installed or not, if not, prompts user to install tmux +- determines if the terminal supports the 256 colors or not, sets the appropriate configuration variable +- sets the correct local config file to use + +## Aliases + +| Alias | Command | Description | +| ------ | -----------------------|---------------------------------------------------------- | +| `ta` | tmux attach -t | Attach new tmux session to already running named session | +| `tad` | tmux attach -d -t | Detach named tmux session | +| `ts` | tmux new-session -s | Create a new named tmux session | +| `tl` | tmux list-sessions | Displays a list of running tmux sessions | +| `tksv` | tmux kill-server | Terminate all running tmux sessions | +| `tkss` | tmux kill-session -t | Terminate named running tmux session | +| `tmux` | `_zsh_tmux_plugin_run` | Start a new tmux session | + + +## Configuration Variables + +| Variable | Description | +|-------------------------------------|-------------------------------------------------------------------------------| +| `ZSH_TMUX_AUTOSTART` | Automatically starts tmux (default: `false`) | +| `ZSH_TMUX_AUTOSTART_ONCE` | Autostart only if tmux hasn't been started previously (default: `true`) | +| `ZSH_TMUX_AUTOCONNECT` | Automatically connect to a previous session if it exits (default: `true`) | +| `ZSH_TMUX_AUTOQUIT` | Automatically closes terminal once tmux exits (default: `ZSH_TMUX_AUTOSTART`) | +| `ZSH_TMUX_FIXTERM` | Sets `$TERM` to 256-color term or not based on current terminal support | +| `ZSH_TMUX_ITERM2` | Sets the `-CC` option for iTerm2 tmux integration (default: `false`) | +| `ZSH_TMUX_FIXTERM_WITHOUT_256COLOR` | `$TERM` to use for non 256-color terminals (default: `screen`) | +| `ZSH_TMUX_FIXTERM_WITH_256COLOR` | `$TERM` to use for 256-color terminals (default: `screen-256color` | -- cgit v1.2.3-70-g09d2 From b1424e289375439eef04254f3817dc3fa4b18a8f Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Fri, 16 Nov 2018 19:40:06 +0100 Subject: tmux: use echoti instead of tput for FreeBSD compatibility Fixes #7407 FreeBSD's tput needs termcap codes instead of terminfo capnames, so using `tput colors` has the wrong effect. See #7407 --- plugins/tmux/tmux.plugin.zsh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins/tmux') diff --git a/plugins/tmux/tmux.plugin.zsh b/plugins/tmux/tmux.plugin.zsh index 7ddf42099..64687641c 100644 --- a/plugins/tmux/tmux.plugin.zsh +++ b/plugins/tmux/tmux.plugin.zsh @@ -36,7 +36,7 @@ alias tkss='tmux kill-session -t' : ${ZSH_TMUX_FIXTERM_WITH_256COLOR:=screen-256color} # Determine if the terminal supports 256 colors -if [[ $(tput colors) == 256 ]]; then +if [[ $(echoti colors) == 256 ]]; then export ZSH_TMUX_TERM=$ZSH_TMUX_FIXTERM_WITH_256COLOR else export ZSH_TMUX_TERM=$ZSH_TMUX_FIXTERM_WITHOUT_256COLOR -- cgit v1.2.3-70-g09d2 From e780209c33883d0ecab39dd50663e2e1424250c9 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Mon, 26 Nov 2018 19:57:52 +0100 Subject: tmux: use $terminfo to avoid echoti errors See https://github.com/robbyrussell/oh-my-zsh/issues/7407#issuecomment-441665143 --- plugins/tmux/tmux.plugin.zsh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins/tmux') diff --git a/plugins/tmux/tmux.plugin.zsh b/plugins/tmux/tmux.plugin.zsh index 64687641c..2f3c3e79d 100644 --- a/plugins/tmux/tmux.plugin.zsh +++ b/plugins/tmux/tmux.plugin.zsh @@ -36,7 +36,7 @@ alias tkss='tmux kill-session -t' : ${ZSH_TMUX_FIXTERM_WITH_256COLOR:=screen-256color} # Determine if the terminal supports 256 colors -if [[ $(echoti colors) == 256 ]]; then +if [[ $terminfo[colors] == 256 ]]; then export ZSH_TMUX_TERM=$ZSH_TMUX_FIXTERM_WITH_256COLOR else export ZSH_TMUX_TERM=$ZSH_TMUX_FIXTERM_WITHOUT_256COLOR -- cgit v1.2.3-70-g09d2