mirror of
https://github.com/jaclu/tmux-power-zoom.git
synced 2026-09-10 07:06:18 -04:00
Merge branch 'main' of github.com:jaclu/tmux-power-zoom
This commit is contained in:
commit
a09ba04a40
74
README.md
74
README.md
|
|
@ -1,74 +0,0 @@
|
|||
# tmux-power-zoom
|
||||
|
||||
Zoom pane to separate window, and un-zoom back into the original location.
|
||||
|
||||
This way you can open other panes whilst focusing on the zoomed pane, without
|
||||
risking getting a crowded mess of panes.
|
||||
|
||||
You can also restore by triggering the power-zoom action on the place-holder
|
||||
pane.
|
||||
|
||||
## Purpose
|
||||
|
||||
Often when I zoom a pane, work in it for a while and then figure out I need to
|
||||
open a pane to check something, I have forgotten I am working in a zoomed pane.
|
||||
So as I open a new pane the new pane becomes squeezed in next to the original
|
||||
pane, often far to small to be practically usable.
|
||||
|
||||
This plugin zooms panes into a new window, makes it convenient to open support
|
||||
panes. Hitting Smart Zoom again will unzoom and move the pane back to it's
|
||||
original location. The temp window closes, if no other panes are present.
|
||||
|
||||
The temp windows name uses title and ID of the zoomed pane, so that if other
|
||||
panes were open and left running, it will later be a hint as the purpose of
|
||||
that window.
|
||||
|
||||
## Usage
|
||||
|
||||
Hit `<prefix>` + `@power_zoom_trigger` to toggle Power Zoom.
|
||||
If `@power_zoom_mouse` is enabled, right double click also toggles Power Zoom.
|
||||
|
||||
## Install
|
||||
|
||||
### Dependencies
|
||||
|
||||
`tmux 2.6` or higher.
|
||||
|
||||
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
|
||||
|
||||
Add plugin to the list of TPM plugins in `.tmux.conf`:
|
||||
|
||||
set -g @plugin 'jaclu/tmux-power-zoom'
|
||||
|
||||
Hit `prefix + I` to fetch the plugin and source it.
|
||||
|
||||
### Manual Installation
|
||||
|
||||
Clone the repo:
|
||||
|
||||
git clone https://github.com/jaclu/tmux-power-zoom.git ~/clone/path
|
||||
|
||||
Add this line to the bottom of `.tmux.conf`:
|
||||
|
||||
run-shell ~/clone/path/power-zoom.tmux
|
||||
|
||||
Reload TMUX environment with `$ tmux source-file ~/.tmux.conf`, and that's it.
|
||||
|
||||
## Configuration Options
|
||||
|
||||
Option | Default | Description
|
||||
`@power_zoom_trigger` | Z | Key that triggers Power Zoom to toggle
|
||||
`@power_zoom_without_prefix` | 0 | If set to 1, trigger key is independent of `<prefix>`
|
||||
`@power_zoom_mouse` | 0 | If set to 1, right double click toggles Power Zoom
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome, and they are greatly appreciated. Every little bit
|
||||
helps, and credit will always be given.
|
||||
|
||||
The best way to send feedback is to file an issue at
|
||||
https://github.com/jaclu/tmux-menus/issues
|
||||
|
||||
##### License
|
||||
|
||||
[MIT](LICENSE.md)
|
||||
Loading…
Reference in a new issue