Github url

.tmux

by gpakosz

gpakosz /.tmux

🇫🇷 Oh My Tmux! Pretty & versatile tmux configuration / customization made with ❤️

11.7K Stars 2.0K Forks Last release: Not found Other 176 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

.tmux

Self-contained, pretty and versatile

.tmux.conf

configuration file.

Screenshot

Installation

Requirements:

  • tmux
  • *``` >= 2.1
    >= 2.4 ``` ) running inside Linux, Mac, OpenBSD, Cygwin or WSL
  • awk, perl and sed
  • outside of tmux,
    $TERM
    must be set to
    xterm-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).

If you're new to tmux, I recommend you read tmux 2: Productive Mouse-Free Development by @bphogan.

Troubleshooting

  • **I'm running tmux
    HEAD
    and things don't work properly. What should I do?**

Please open an issue describing what doesn't work with upcoming tmux. I'll do my best to address it.

  • Status line is broken and/or gets duplicated at the bottom of the screen. What gives?

This particularly happens on Linux when the distribution provides a version of glib that received Unicode 9.0 upgrades (glib

\>= 2.50.1

) while providing a version of glibc that didn't (glibc

\< 2.26

). You may also configure

LC\_CTYPE

to use an

UTF-8

locale. Typically VTE based terminal emulators rely on glib's

g\_unichar\_iswide()

function while tmux relies on glibc's

wcwidth()

function. When these two functions disagree, display gets messed up.

This can also happen on macOS when using iTerm2 and "Use Unicode version 9 character widths" is enabled in

Preferences... \> Profiles \> Text

For that reason, the default

~/.tmux.conf.local

file stopped using Unicode characters for which width changed in between Unicode 8.0 and 9.0 standards, as well as Emojis.

  • I installed Powerline and/or (patched) fonts but can't see Powerline symbols.

First, you don't need to install Powerline. You only need fonts patched with Powerline symbols or the standalone

PowerlineSymbols.otf

font. Then make sure your

~/.tmux.conf.local

copy uses the right code points for

tmux\_conf\_theme\_left\_separator\_XXX

values.

  • I'm using Bash On Windows (WSL), colors and Powerline look are broken.

There is currently a bug in the new console powering Bash On Windows preventing text attributes (bold, underscore, ...) to combine properly with colors. The workaround is to search your

~/.tmux.conf.local

copy and replace attributes with

'none'

.

Also, until Window's console replaces its GDI based render with a DirectWrite one, Powerline symbols will be broken.

The alternative is to use the Mintty terminal for WSL.

Features

The "maximize any pane to a new window with

<prefix> +</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> +</prefix>

either from the source window or the maximized window.

Maximize pane

Mouse mode allows you to set the active window, set the active pane, resize panes and automatically switches to copy-mode to select text.

Mouse mode

Bindings

tmux may be controlled from an attached client by using a key combination of a prefix key, followed by a command key. This configuration uses

C-a

as a secondary prefix while keeping

C-b

as the default prefix. In the following list of key bindings: -

<prefix></prefix>

means you have to either hit Ctrl + a or Ctrl + b -

<prefix> c</prefix>

means you have to hit Ctrl + a or Ctrl + b followed by c -

<prefix> C-c</prefix>

means you have to hit Ctrl + a or Ctrl + b followed by Ctrl + c

This configuration uses the following bindings:

  • <prefix> e</prefix>
    opens
    ~/.tmux.conf.local
    with the editor defined by the
    $EDITOR
    environment variable (defaults to
    vim
    when empty)
  • <prefix> r</prefix>
    reloads the configuration
C-l

clears both the screen and the tmux history

<prefix> C-c</prefix>

creates a new session

<prefix> C-f</prefix>

lets you switch to another session by name

<prefix> C-h</prefix>

and

<prefix> C-l</prefix>

let you navigate windows (default

<prefix> n</prefix>

and

<prefix> p</prefix>

are unbound)

<prefix> Tab</prefix>

brings you to the last active window

<prefix> -</prefix>

splits the current pane vertically

<prefix> _</prefix>

splits the current pane horizontally

<prefix> h</prefix>

,

<prefix> j</prefix>

,

<prefix> k</prefix>

and

<prefix> l</prefix>

let you navigate panes ala Vim

<prefix> H</prefix>

,

<prefix> J</prefix>

,

<prefix> K</prefix>

,

<prefix> L</prefix>

let you resize panes

<prefix> &lt;</prefix>

and

<prefix> &gt;</prefix>

let you swap panes

<prefix> +</prefix>

maximizes the current pane to a new window

<prefix> m</prefix>

toggles mouse mode on or off

<prefix> U</prefix>

launches Urlview (if available)

<prefix> F</prefix>

launches Facebook PathPicker (if available)

<prefix> Enter</prefix>

enters copy-mode

<prefix> b</prefix>

lists the paste-buffers

<prefix> p</prefix>

pastes from the top paste-buffer

<prefix> P</prefix>

lets you choose the paste-buffer to paste from

Additionally,

copy-mode-vi

matches my own Vim configuration

Bindings for

copy-mode-vi

:

v

begins selection / visual mode

C-v

toggles between blockwise visual mode and visual mode

H

jumps to the start of line

L

jumps to the end of line

y

copies the selection to the top paste-buffer

Escape

cancels the current operation

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</prefix>

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: Powerline Symbols

To make use of these symbols, there are several options:

Please see the Powerline manual for further details.

Then edit the

~/.tmux.conf.local

file (

<prefix> e</prefix>

) and adjust the following variables:

tmux\_conf\_theme\_left\_separator\_main='\uE0B0' tmux\_conf\_theme\_left\_separator\_sub='\uE0B1' tmux\_conf\_theme\_right\_separator\_main='\uE0B2' tmux\_conf\_theme\_right\_separator\_sub='\uE0B3'

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</prefix>

) 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/Mosh aware hostname information
  • #{hostname\_ssh}
    : SSH/Mosh aware hostname information, blank when not connected to a remote server through SSH/Mosh
  • #{loadavg}
    : load average
  • #{pairing}
    : is session attached to more than one client?
  • #{prefix}
    : is prefix being depressed?
  • #{root}
    : is current user root?
  • #{synchronized}
    : are the panes synchronized?
  • #{uptime\_y}
    : uptime years
  • #{uptime\_d}
    : uptime days, modulo 365 when
    #{uptime\_y}
    is used
  • #{uptime\_h}
    : uptime hours
  • #{uptime\_m}
    : uptime minutes
  • #{uptime\_s}
    : uptime seconds
  • #{username}
    : SSH/Mosh aware username information
  • #{username\_ssh}
    : SSH aware username information, blank when not connected to a remote server through SSH/Mosh

Beside custom variables mentioned above, the

tmux\_conf\_theme\_status\_left

and

tmux\_conf\_theme\_status\_right

variables support usual tmux syntax, e.g. using

#()

to call an external command that inserts weather information provided by

tmux_conf_theme_status_right='#{prefix}#{pairing}#{synchronized} #(curl wttr.in?format=3) , %R , %d %b | #{username}#{root} | #{hostname} ' ```

Weather information from wttr.in

wttr.in: https://github.com/chubin/wttr.in#one-line-output

Accessing the macOS clipboard from within tmux sessions

[Chris Johnsen created the

reattach-to-user-namespace

utility](https://github.com/ChrisJohnsen/tmux-MacOSX-pasteboard) 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.

[MacPorts]: http://www.macports.org/ [Homebrew]: http://brew.sh/

Using the configuration under Cygwin within Mintty

**I don't recommend running this configuration with Cygwin anymore. Forking under Cygwin is extremely slow and this configuration issues a lot of

run-shell

commands under the hood. As such, you will experience high CPU usage. As an alternative consider using Mintty terminal for WSL.**

cygwin

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.

regedit

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.