1abf04cb01e8c5a987632a5bddaa3e10fb5fe035

Author
Sagar Patil <sagar010797@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

tmux: add README (#7293)

Diff

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