Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Installing tmux-256color for macOS

Installing tmux-256color for macOS

  • macOS 10.15.5
  • tmux 3.1b

macOS has ncurses version 5.7 which does not ship the terminfo description for tmux. There're two ways that can help you to solve this problem.

The Fast Blazing Solution

Instead of tmux-256color, use screen-256color which comes with system. Place this command into ~/.tmux.conf or ~/.config/tmux/tmux.conf(for version 3.1 and later):

set-option default-terminal "screen-256color"

The screen-256color in most cases is enough and more portable solution. But it does not support any italic font style.

The Right Way

Unfortunately, The latest (6.2) ncurses version does not work properly. Make sure to use ncurses which comes with macOS:

$ which tic
/usr/bin/tic

If you see another path to terminal info compiler, you must fix the $PATH for a shell, or uninstall a local ncurses by using a package manager.

Let's download and unpack the latest nucurses terminal descriptions:

$ curl -LO https://invisible-island.net/datafiles/current/terminfo.src.gz && gunzip terminfo.src.gz

And compile tmux-256color terminal info. The result is placed into ~/.terminfo:

$ /usr/bin/tic -xe tmux-256color terminfo.src

If you want to use tmux-256color for all users, use sudo. The result is placed into /usr/share/terminfo:

$ sudo /usr/bin/tic -xe tmux-256color terminfo.src

You may also to compile few more infos, it is up to you:

$ /usr/bin/tic -xe alacritty-direct,tmux-256color terminfo.src

If you see something like:

"terminfo.src", line 1650, terminal 'pccon+base': enter_bold_mode but no exit_attribute_mode
"terminfo.src", line 1650, terminal 'pccon+base': enter_reverse_mode but no exit_attribute_mode

do not worry, all should be fine. Make sure that you can use the compiled description:

$ infocmp -x tmux-256color

And finally, set default terminal in tmux configuration file:

set-option default-terminal "tmux-256color"

RGB Colors

Also, do not forget to enable RGB colors (24 bit colors, or true colors, as you like). The $TERM outside tmux must support 256 colors. Also, it must contains Tc or RGB flag in terminfo description:

$ tmux info | grep -e RGB -e Tc

If both are missing, then you need to override terminal description in tmux configuration file:

set-option -a terminal-overrides ",XXX:RGB"

where XXX is a terminal outside tmux, like xterm-256color. And finally, terminal-overrides suports a pattern matching:

set-option -a terminal-overrides ",*256col*:RGB"

If you use Alacritty terminal, make sure the $TERM outside tmux is alacritty-direct. The alacritty terminal description does not have RGB flag. Otherwise, override description:

set-option -a terminal-overrides ",alacritty:RGB"
@carlocab
Copy link

carlocab commented May 1, 2021

Roughly speaking, yes. You can try pointing them to /opt/homebrew/opt/ncurses/share/terminfo, except that system ncurses will not understand many of the entries there.

@occult
Copy link

occult commented Jun 14, 2021

Nice job! Thanks for explaining this. My backspace character was creating spaces due to this.

@jettandres
Copy link

jettandres commented Jun 23, 2021

thank you so much for this! I finally got tmux, vim, and zsh working in harmony!

@brandoncc
Copy link

brandoncc commented Jul 15, 2021

You are amazing, thank you!!!

@xanoni
Copy link

xanoni commented Aug 12, 2021

YOU SAVED MY PRODUCTIVITY AND SANENESS THANK YOU SIR

@ayamir
Copy link

ayamir commented Feb 3, 2022

Thanks!

@mikiya09
Copy link

mikiya09 commented Feb 4, 2022

Thank you!!!!!!!!!!!!!!!!!!!!!!

@ggustafsson
Copy link

ggustafsson commented Feb 23, 2022

I followed this guide and I thought it worked but after a few weeks I realised that the generated tmux-256color file is a bit broken, try running the "dialog" program and you'll get some messy stuff. Generating a terminfo file based on the Tmux developer nicm's gist (https://gist.github.com/nicm/ea9cf3c93f22e0246ec858122d9abea1) instead of the Ncurses terminfo source however works great (as far as I can tell, dialog + italic font works). tic -x <gist>. @carlocab has already mentioned this.

My tmux-256color file can be found here if anybody needs it (until it is included in macOS): https://github.com/ggustafsson/Dot-Files/blob/master/Misc/tmux-256color

(Note: I'm still on Big Sur. I don't have a clue if the situation has been remedied in Monterey or not yet.)

@YodaEmbedding
Copy link

YodaEmbedding commented May 12, 2022

A good resource which explains each step in detail. Works for me on MacOS 10.15:
https://gpanders.com/blog/the-definitive-guide-to-using-tmux-256color-on-macos/

A short gist for MacOS <10.15:
https://gist.github.com/joshuarli/247018f8617e6715e1e0b5fd2d39bb6c

@deCHN
Copy link

deCHN commented Jun 17, 2022

With macOS 12.4 and Apple M1 chip, Tmux 3.3a, I cannot enable the RGB / Tc color with this set in tmux.conf:

set default-terminal "screen-256color"
set -a terminal-overrides ",*256col*:RGB"

Restart tmux server and run:

$ tmux info | grep -e RGB -e Tc
 197: RGB: [missing]
 223: Tc: [missing]
$ echo $TERM
screen-256color

What do I still miss to enable RGB color? Thanks!

@tparvu
Copy link

tparvu commented Jun 17, 2022

Thanks much! Worked for me on Darwin Kernel Version 21.5.0.

@nkhlmn
Copy link

nkhlmn commented Jun 18, 2022

I'm on macOS 12.4 and when I run /usr/bin/tic -xe tmux-256color terminfo.src I get tic: Can't open terminfo.src.
Anyone know what the issue is?

EDIT:
The following method worked for me:

$ /*/*/Cellar/ncurses/6.3/bin/infocmp -x tmux-256color >tmux-256color.src
$ sudo /usr/bin/tic -x tmux-256color.src

Outlined here: tmux/tmux#3218

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment