diff options
| author | Eugene Triguba <hello@eugenetriguba.com> | 2025-08-17 13:17:54 -0400 |
|---|---|---|
| committer | Eugene Triguba <hello@eugenetriguba.com> | 2025-08-17 13:17:54 -0400 |
| commit | 7587dd3aaf7aa477935fa6badf679203a4f279ba (patch) | |
| tree | b5c0043c9463b7c11c8b9b2232cdbede2f9a9bbe /README.md | |
| parent | update changelog (diff) | |
| download | tmux-toggle-term-0.3.0.zip | |
Add ability to use prefix key with key bindingsv0.3.0
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 23 insertions, 4 deletions
@@ -7,7 +7,7 @@ A terminal toggle for tmux that supports a per-window split pane and a global fl Using [TPM](https://github.com/tmux-plugins/tpm): ```tmux -set -g @plugin 'https://git.sr.ht/~eugenetriguba/tmux-toggle-term' +set-option -g @plugin 'https://git.sr.ht/~eugenetriguba/tmux-toggle-term' ``` Reload tmux and press prefix + I to install. @@ -26,13 +26,32 @@ Reload tmux and press prefix + I to install.  -### Customization +## Customization -If needed, you can override the default keybindings by setting the -`toggle-term-split-key` and `toggle-term-float-key` options. +### Custom Key Bindings + +You can override the default keybindings by setting the +`toggle-term-split-key` and `toggle-term-float-key` options: ```tmux set -g @toggle-term-split-key 'M-t' set -g @toggle-term-float-key 'M-f' ``` +### Using Tmux Prefix Keys + +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: + +```tmux +set -g @toggle-term-float-key 'f' +set -g @toggle-term-float-use-prefix 'true' + +set -g @toggle-term-split-key ';' +set -g @toggle-term-split-use-prefix 'true' +``` + +With the above configuration: +- **Prefix + f** → Toggle floating terminal +- **Prefix + ;** → Toggle split terminal + |