tmux – How to Reload tmux Config Correctly

tmux

According to the man page, if I run this command:

tmux source-file ~/.tmux.conf

tmux is going to execute the commands in ~/.tmux.conf. However if, for example, I add a key binding to tmux.conf, and later remove it, the key binding stays, even if I source the file (which is logical, since there's no actual command to execute for that binding).

So I'm wondering, before sourcing the config, if there a way to somehow clear tmux's internal state (all binding, settings, etc.) so that it starts with the default one?

Best Answer

Changing the tmux configuration and rereading it in an existing tmux session will only change the settings that the configuration file explicitly changes. Removing a key binding from the configuration file, for example, will not unbind that key when you reload the configuration unless you also explicitly unbind it in the configuration.

This is similar to sourcing a shell script with a variable assignment in it; You source it once, which sets the variable, and then you remove it from the file and source it again. This will not remove the shell variable.

The simplest way to reread the configuration file from scratch is to exit tmux and restart it. tmux will exit as soon as all its sessions have ended, which will happen if you, for example, exit all shell sessions from within tmux. You may also issue the tmux command kill-server from within tmux to kill the tmux server and all sessions.

Related Solutions

Vim not running inside tmux

I solved the issue by adding the line

set -g default-terminal xterm

as the first line of my ~/.tmux.conf and it worked fine.

However as @jasonwryan has pointed out, the TMUX FAQ clearly states that:

Most display problems are due to incorrect TERM! Before reporting problems make SURE that TERM settings are correct inside and outside tmux.

Inside tmux TERM must be "screen" or similar (such as "screen-256color"). Outside, it must match your terminal ...

I only post this answer as it actually solved my problem. please feel free to add your alternative solutions.

Simulating GNU Screen’s shelltitle in tmux

Alas, after years, a solution! I also had the same problem with tmux and missed screen's behaviour. In a nutshell:

Add this to .bashrc

if [ -v "TMUX" ]; then
    PS0='$(printf "\033k%s\033" "$(HISTTIMEFORMAT= history 1 | sed -e "s/^[ ]*[0-9]*[ ]*//")")'
    PROMPT_COMMAND="printf '\033kBASH\033\\'"

and this on tmux.conf

set -g allow-rename on

For an explanation of bashrc, PS0 line have a look at this: Pass every command executed in the bash shell to a variable

For PROMPT_COMMAND I've used BASH as a label when returning to bash, you can put whatever you like (ie >_). Or you can omit PROMPT_COMMAND and leave the last command executed to be seen on the label.

Best Answer

Related Solutions

Vim not running inside tmux

Simulating GNU Screen’s shelltitle in tmux

Related Question