stow/oh-my-zsh/.oh-my-zsh/plugins/tmux/README.md

   1 # tmux
   2
   3 This plugin provides aliases for [tmux](https://tmux.github.io/), the terminal multiplexer.
   4 To use it add `tmux` to the plugins array in your zshrc file.
   5
   6 ```zsh
   7 plugins=(... tmux)
   8 ```
   9
  10 The plugin also supports the following:
  11
  12 - determines if tmux is installed or not, if not, prompts user to install tmux
  13 - determines if the terminal supports the 256 colors or not, sets the appropriate configuration variable
  14 - sets the correct local config file to use
  15
  16 ## Aliases
  17
  18 | Alias      | Command                    | Description                                              |
  19 | ---------- | -------------------------- | -------------------------------------------------------- |
  20 | `ta`       | tmux attach -t             | Attach new tmux session to already running named session |
  21 | `tad`      | tmux attach -d -t          | Detach named tmux session                                |
  22 | `ts`       | tmux new-session -s        | Create a new named tmux session                          |
  23 | `tl`       | tmux list-sessions         | Displays a list of running tmux sessions                 |
  24 | `tksv`     | tmux kill-server           | Terminate all running tmux sessions                      |
  25 | `tkss`     | tmux kill-session -t       | Terminate named running tmux session                     |
  26 | `tmux`     | `_zsh_tmux_plugin_run`     | Start a new tmux session                                 |
  27 | `tmuxconf` | `$EDITOR $ZSH_TMUX_CONFIG` | Open .tmux.conf file with an editor                      |
  28
  29 ## Configuration Variables
  30
  31 | Variable                            | Description                                                                   |
  32 | ----------------------------------- | ----------------------------------------------------------------------------- |
  33 | `ZSH_TMUX_AUTOSTART`                | Automatically starts tmux (default: `false`)                                  |
  34 | `ZSH_TMUX_AUTOSTART_ONCE`           | Autostart only if tmux hasn't been started previously (default: `true`)       |
  35 | `ZSH_TMUX_AUTOCONNECT`              | Automatically connect to a previous session if it exits (default: `true`)     |
  36 | `ZSH_TMUX_AUTOQUIT`                 | Automatically closes terminal once tmux exits (default: `ZSH_TMUX_AUTOSTART`) |
  37 | `ZSH_TMUX_FIXTERM`                  | Sets `$TERM` to 256-color term or not based on current terminal support       |
  38 | `ZSH_TMUX_ITERM2`                   | Sets the `-CC` option for iTerm2 tmux integration (default: `false`)          |
  39 | `ZSH_TMUX_FIXTERM_WITHOUT_256COLOR` | `$TERM` to use for non 256-color terminals (default: `screen`)                |
  40 | `ZSH_TMUX_FIXTERM_WITH_256COLOR`    | `$TERM` to use for 256-color terminals (default: `screen-256color`            |
  41 | `ZSH_TMUX_CONFIG`                   | Set the configuration path (default: `$HOME/.tmux.conf`)                      |
  42 | `ZSH_TMUX_UNICODE`                  | Set `tmux -u` option to support unicode                                       |
  43 | `ZSH_TMUX_DEFAULT_SESSION_NAME`     | Set tmux default session name when autostart is enabled                       |