Back to Ohmyzsh

tmux

plugins/tmux/README.md

latest4.3 KB
Original Source

tmux

This plugin provides aliases for tmux, 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

AliasCommandDescription
tatmux attach -tAttach new tmux session to already running named session
tadtmux attach -d -tDetach named tmux session
tds_tmux_directory_sessionCreates or attaches to a session for the current path
tksstmux kill-session -tTerminate named running tmux session
tksvtmux kill-serverTerminate all running tmux sessions
tltmux list-sessionsDisplays a list of running tmux sessions
totmux new-session -A -sCreate or attach to a named tmux session
tmux_zsh_tmux_plugin_runStart a new tmux session
tmuxconf$EDITOR $ZSH_TMUX_CONFIGOpen .tmux.conf file with an editor
tstmux new-session -sCreate a new named tmux session

Configuration Variables

VariableDescription
ZSH_TMUX_AUTOREFRESHAutomatically refresh global environments (default: false)
ZSH_TMUX_AUTOSTARTAutomatically starts tmux (default: false)
ZSH_TMUX_AUTOSTART_ONCEAutostart only if tmux hasn't been started previously (default: true)
ZSH_TMUX_AUTOCONNECTAutomatically connect to a previous session if it exits (default: true)
ZSH_TMUX_AUTOQUITAutomatically closes terminal once tmux exits (default: ZSH_TMUX_AUTOSTART)
ZSH_TMUX_CONFIGSet the configuration path (default: $HOME/.tmux.conf, $XDG_CONFIG_HOME/tmux/tmux.conf)
ZSH_TMUX_DEFAULT_SESSION_NAMESet tmux default session name when autostart is enabled
ZSH_TMUX_AUTONAME_SESSIONAutomatically name new sessions based on the basename of $PWD (default: false)
ZSH_TMUX_DETACHEDSet the detached mode (default: false)
ZSH_TMUX_FIXTERMSets $TERM to 256-color term or not based on current terminal support
ZSH_TMUX_FIXTERM_WITHOUT_256COLOR$TERM to use for non 256-color terminals (default: tmux if available, screen otherwise)
ZSH_TMUX_FIXTERM_WITH_256COLOR$TERM to use for 256-color terminals (default: tmux-256color if available, screen-256color otherwise)
ZSH_TMUX_ITERM2Sets the -CC option for iTerm2 tmux integration (default: false)
ZSH_TMUX_UNICODESet tmux -u option to support unicode