aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2026-11-14 11:22:13 -0800
committerEugene Triguba <hello@eugenetriguba.com>2026-11-14 11:22:13 -0800
commit213d56ebc1819461b5d8dfe06797fcaaddc4088c (patch)
tree71948241630463239217a721e9a9874c6ebd0ea1
parentRelease v0.5.0 (diff)
downloadtmux-toggle-term-213d56ebc1819461b5d8dfe06797fcaaddc4088c.zip
Update README for prefix default change
-rw-r--r--README.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/README.md b/README.md
index 0e3faa0..4da9062 100644
--- a/README.md
+++ b/README.md
@@ -21,13 +21,13 @@ run-shell '~/.tmux/plugins/tmux-toggle-term/src/main.sh'
### Toggle Split Terminal
-`C-;` → Toggle a split terminal for the current tmux window
+`Prefix + C-;` → Toggle a split terminal for the current tmux window
![Split Pane](https://git.eugenetriguba.com/tmux-toggle-term/plain/docs/split-open.webp)
### Toggle Floating Terminal
-`C-f` → Toggle a global floating popup terminal
+`Prefix + C-f` → Toggle a global floating popup terminal
![Floating Window](https://git.eugenetriguba.com/tmux-toggle-term/plain/docs/float-open.webp)
@@ -55,21 +55,21 @@ set -g @toggle-term-split-key 'M-t'
set -g @toggle-term-float-key 'M-f'
```
-### Using Tmux Prefix Keys
+### Binding Without the Tmux Prefix
-By default, the plugin binds keys don't require the tmux prefix. If you prefer to
-use the tmux prefix key, you can enable it by setting the use-prefix options:
+By default, the plugin binds its keys in the tmux prefix table, so you press the
+tmux prefix before the key. If you'd rather trigger the toggles directly,
+without the prefix, disable the `toggle-term-<mode>-use-prefix` options:
```tmux
-set -g @toggle-term-float-key 'f'
-set -g @toggle-term-float-use-prefix 'true'
+set -g @toggle-term-float-key 'M-f'
+set -g @toggle-term-float-use-prefix 'false'
-set -g @toggle-term-split-key ';'
-set -g @toggle-term-split-use-prefix 'true'
+set -g @toggle-term-split-key 'M-t'
+set -g @toggle-term-split-use-prefix 'false'
```
With the above configuration:
-- **Prefix + f** → Toggle floating terminal
-- **Prefix + ;** → Toggle split terminal
-
+- **M-f** → Toggle floating terminal
+- **M-t** → Toggle split terminal