Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added how to customise key bindings #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: added how to customise key bindings #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Sessions are a second class citizen in tmux environment:

This plugin solves the above problems.

### Features
### Key Bindings

- `prefix + g` - prompts for session name and switches to it. Performs 'kind-of'
name completion.<br/>
Expand All @@ -29,12 +29,24 @@ This plugin solves the above problems.
- `prefix + @` - promote current pane into a new session.<br/>
Analogous to how `prefix + !` breaks current pane to a new window.
- `prefix + ctrl-@` - promote current window into a new session.
- `prefix + t<secondary-key>` - join currently marked pane (`prefix + m`) to current session/window, and switch to it
- `prefix + t + <secondary-key>` - join currently marked pane (`prefix + m`) to current session/window, and switch to it
- secondary-keys
- `h`, `-`, `"`: join horizontally
- `v`, `|`, `%`: join vertically
- `f`, `@`: join full screen

To change these, add the related option to your `.tmux.conf`:

set -g @sessionist-goto 'C-f'
set -g @sessionist-alternate 'L'
set -g @sessionist-new 'C-c'
set -g @sessionist-promote-pane 'C-b'
set -g @sessionist-promote-window 'C-B'
set -g @sessionist-join-pane 'no-key'
set -g @sessionist-kill-session 'C-x'

To unbind, simply set the variable to arbitrary text (e.g. `no-key`)

### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)

Add plugin to the list of TPM plugins in `.tmux.conf`:
Expand Down