.tmux
Self-contained, pretty and versatile .tmux.conf
configuration file.
Installation
Requirements:
- tmux
2.1+
running inside Linux, Mac, OpenBSD or Cygwin - outside of tmux,
$TERM
must be set toxterm-256color
To install, run the following from your terminal: (you may want to backup your
existing ~/.tmux.conf
first)
$ cd
$ git clone https://github.com/gpakosz/.tmux.git
$ ln -s -f .tmux/.tmux.conf
$ cp .tmux/.tmux.conf.local .
Then proceed to customize your ~/.tmux.conf.local
copy.
If you're a Vim user, setting the $EDITOR
environment variable to vim
will
enable and further customize the vi-style key bindings (see tmux manual).
Features
C-a
acts as secondary prefix, while keeping defaultC-b
prefix- visual theme inspired by Powerline
- maximize any pane to a new window with
<prefix> +
- SSH aware username and hostname status line information
- mouse mode toggle with
<prefix> m
- automatic usage of
reattach-to-user-namespace
if available - laptop battery status line information
- uptime status line information
- optional highlight of focused pane (tmux
2.1+
) - configurable new windows and panes behavior (optionally retain current path)
- SSH aware split pane (reconnects to remote server, experimental)
- Facebook PathPicker integration if available
- Urlview integration if available
This configuration uses the following bindings:
<prefix> C-c
creates a new session<prefix> e
opens~/.tmux.conf.local
with the editor defined by the$EDITOR
environment variable (defaults tovim
when empty)<prefix> r
reloads the configuration<prefix> C-f
lets you switch to another session by name<prefix> C-h
and<prefix> C-l
let you navigate windows (default<prefix> n
and<prefix> p
are unbound)<prefix> Tab
brings you to the last active window<prefix> h
,<prefix> j
,<prefix> k
and<prefix> l
let you navigate panes ala Vim<prefix> H
,<prefix> J
,<prefix> K
,<prefix> L
let you resize panes<prefix> <
and<prefix> >
let you swap panes<prefix> +
maximizes the current pane to a new window<prefix> m
toggles mouse mode on or off<prefix> U
launches Urlview (if available)<prefix> F
launches Facebook PathPicker (if available)<prefix> Enter
enters copy-mode<prefix> b
lists the paste-buffers<prefix> p
pastes from the top paste-buffer<prefix> P
lets you choose the paste-buffer to paste fromC-l
clears both the screen and the history
Additionally, vi-choice
, vi-edit
and vi-copy
named tables are adjusted
to closely match my own Vim configuration
Bindings for the vi-choice
mode-table:
h
collapses the current tree nodel
expands the current tree nodeH
collapses all the tree nodesL
expands all the tree nodesK
jumps to the start of list (tmux2.0+
)L
jumps to the end of list (tmux2.0+
)Escape
cancels the current operation
Bindings for the vi-edit
mode-table:
H
jumps to the start of lineL
jumps to the end of lineq
cancels the current operationEscape
cancels the current operation
Bindings for the vi-copy
mode-table:
v
begins selection / visual modeC-v
toggles between blockwise visual mode and visual modeH
jumps to the start of lineL
jumps to the end of liney
copies the selection to the top paste-bufferEscape
cancels the current operation
The "maximize any pane to a new window with <prefix> +
" feature is different
from builtin resize-pane -Z
as it allows you to further split a maximized
pane. It's also more flexible by allowing you to maximize a pane to a new
window, then change window, then go back and the pane is still in maximized
state in its own window. You can then minimize a pane by using <prefix> +
either from the source window or the maximized window.
Mouse mode allows you to set the active window, set the active pane, resize panes and automatically switches to copy-mode to select text.
Configuration
While this configuration tries to bring sane default settings, you may want to
customize it further to your needs. Instead of altering the ~/.tmux.conf
file
and diverging from upstream, the proper way is to edit the ~/.tmux.conf.local
file.
Please refer to the default .tmux.conf.local
file to know more about variables
you can adjust to alter different behaviors. Pressing <prefix> e
will open
~/.tmux.conf.local
with the editor defined by the $EDITOR
environment
variable (defaults to vim
when empty).
Enabling the Powerline look
Powerline originated as a status-line plugin for Vim. Its popular eye-catching
look is based on the use of special symbols:
To make use of these symbols, there are several options:
- use a font that already bundles those: this is e.g. the case of the 2.030R-ro/1.050R-it version of the Source Code Pro] font
- use a pre-patched font
- use your preferred font along with the Powerline font (that only contains the Powerline symbols): this highly depends on your operating system and your terminal emulator
- patch your preferred font by adding the missing Powerline symbols: this is the most difficult way and is no more documented in the Powerline manual
Please see the Powerline manual for further details.
Then edit the ~/.tmux.conf.local
file (<prefix> e
) and adjust the following
variables:
tmux_conf_theme_left_separator_main=''
tmux_conf_theme_left_separator_sub=''
tmux_conf_theme_right_separator_main=''
tmux_conf_theme_right_separator_sub=''
Configuring the status line
Contrary to the first iterations of this configuration, by now you have total
control on the content and order of status-left
and status-right
.
Edit the ~/.tmux.conf.local
file (<prefix> e
) and adjust the
tmux_conf_theme_status_left
and tmux_conf_theme_status_right
variables to
your own preferences.
This configuration supports the following builtin variables:
#{battery_bar}
: horizontal battery charge bar#{battery_percentage}
: battery percentage#{battery_status}
: is battery charging or discharging?#{battery_vbar}
: vertical battery charge bar#{circled_session_name}
: circled session number, up to 20#{hostname}
: SSH aware hostname information#{hostname_ssh}
: SSH aware hostname information, blank when no SSH connection detected#{loadavg}
: load average#{pairing}
: is session attached to more than one client?#{prefix}
: is prefix being depressed?#{root}
: is current user root?#{uptime_d}
: uptime days#{uptime_h}
: uptime hours#{uptime_m}
: uptime minutes#{uptime_s}
: uptime seconds#{username}
: SSH aware username information#{username_ssh}
: SSH aware username information, blank when no SSH connection detected
Accessing the Mac OSX clipboard from within tmux sessions
Chris Johnsen created the reattach-to-user-namespace
utility that makes pbcopy
and pbpaste
work
again within tmux.
To install reattach-to-user-namespace
, use either MacPorts or
Homebrew:
$ port install tmux-pasteboard
or
$ brew install reattach-to-user-namespace
Once installed, reattach-to-usernamespace
will be automatically detected.
Using the configuration under Cygwin within Mintty
It is possible to use this configuration under Cygwin within Mintty, however support for Unicode symbols and emojis lacks behind Mac and Linux.
Particularly, Mintty's text rendering is implemented with GDI which has limitations:
- color emojis are only available through DirectWrite starting with Windows 8.1
- display of double width symbols, like the battery discharging symbol indicator (U+1F50B) is buggy
To get Unicode symbols displayed properly, you have to use font linking.
Open regedit.exe
then navigate to the registry key at
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\FontLink\SystemLink
and add a new entry for you preferred font to link it with the Segoe UI Symbol
font.