diff --git a/README.md b/README.md index f55735e..8ee5911 100644 --- a/README.md +++ b/README.md @@ -5,35 +5,43 @@ This project implements byobu-like function key bindings for common tmux command ## Key bindings -### Function keys: +### Function keys -* F2: New window -* F3: Previous window -* F4: Next window -* F6: Detach session -* Ctrl-F6: Kill pane -* F7: Copy mode -* F8: Rename window -* Ctrl-F8: Rename session -* Shift-F12: Toggle bindings on/off +These keys work without the tmux prefix (`Ctrl-B` by default). -Alt+arrow keys can be used to switch between panes. +* `F2`: New window +* `F3`: Previous window +* `F4`: Next window +* `F6`: Detach session +* `Ctrl`-`F6`: Kill pane +* `F7`: Copy mode +* `F8`: Rename window +* `Ctrl`-`F8`: Rename session +* `Shift`-`F12`: Toggle bindings on/off +* `Alt`+`arrow keys` can be used to switch between panes. -### With fmux prefix +### With tmux prefix * `|`: Split window horizontally * `-`: Split window vertically -* Shift-W/A/S/D: Resize current pane -* `r`: Reload config from `~/.tmux.conf~` +* `Shift`-`W`/`A`/`S`/`D`: Resize current pane +* `r`: Reload config from `~/.tmux.conf` +* `Alt`-`Left` or `Right` arrows: Move window left or right, repsectively In case any of these bindings interfere with other commands, they can be temporarily toggled on or off with `Shfit-F12`. +### Local configuration options + +This configuration file sources `~/.tmux-local.conf` if you want to make additional modifications. + ## Installation 1. Clone this repository to your home folder. 2. Establish a symbolic link from the tmux.conf file in the repository folder your home folder: ln -s /home/$USER/fmux/tmux.conf /home/$USER/.tmux.conf - If your tmux version is 2.9 or greater, use `tmux-2.9.conf` instead. Version 2.9 introduced some [breaking changes](https://github.com/tmux/tmux/issues/1689) to the style formatting. -3. Start a new tmux session, or reload the configuration file in existing session(s). + + If your tmux version is 2.9 or below, use `tmux-2.9.conf` instead. Version 3.0 introduced several changes in configuration file parsing. (tmux 2.9 also introduced some [changes](https://github.com/tmux/tmux/issues/1689) to the style formatting, but they do not break functionality. [I do hope to fix this soon](https://github.com/selectric401/fmux/issues/1).) +3. Run `touch ~/.tmux-local.conf`. +4. Start a new tmux session, or reload the configuration file in existing session(s). diff --git a/f-keys b/f-keys index 2a5cb83..93b8f91 100644 --- a/f-keys +++ b/f-keys @@ -26,10 +26,10 @@ bind -n M-Up select-pane -U bind -n M-Down select-pane -D # resize panes using Shift-WASD -bind-key S resize-pane -D 5 -bind-key W resize-pane -U 5 -bind-key A resize-pane -L 5 -bind-key D resize-pane -R 5 +bind-key S resize-pane -D 1 +bind-key W resize-pane -U 1 +bind-key A resize-pane -L 1 +bind-key D resize-pane -R 1 # reload config file bind r source-file ~/.tmux.conf