0963a9a4cca55856582360051aaa41497388985f

Author
Niklas Gögge <n.goeggi@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

iterm2: add README (#7230)

Diff

 1diff --git a/plugins/iterm2/README.md b/plugins/iterm2/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..50cdebf5ef1ea343c067a2b2141a356ffa91e3c5
 4--- /dev/null
 5+++ b/plugins/iterm2/README.md
 6@@ -0,0 +1,29 @@
 7+# iTerm2 plugin
 8+
 9+This plugin adds a few functions that are useful when using [iTerm2](https://www.iterm2.com/).
10+
11+To use it, add _iterm2_ to the plugins array of your zshrc file:
12+```
13+plugins=(... iterm2)
14+```
15+
16+## Plugin commands
17+
18+* `_iterm2_command <iterm2-command>`
19+  executes an arbitrary iTerm2 command via an escape code sequence.
20+  See https://iterm2.com/documentation-escape-codes.html for all supported commands.
21+
22+* `iterm2_profile <profile-name>`
23+  changes the current terminal window's profile (colors, fonts, settings, etc).
24+  `profile-name` is the name of another iTerm2 profile. The profile name can contain spaces.
25+
26+* `iterm2_tab_color <red> <green> <blue>`
27+  changes the color of iTerm2's currently active tab.
28+  `red`/`green`/`blue` are on the range 0-255.
29+
30+* `iterm2_tab_color_reset`
31+  resets the color of iTerm2's current tab back to default.
32+
33+## Contributors
34+
35+- [Aviv Rosenberg](https://github.com/avivrosenberg)