tmuxtmuxOptions, hooks and formats

Choose documentation 1

latest

tmux catalog version

Latest (3.7c) 3.7c 3.2a
English

option tmux3.7c

terminal-features

Set terminal features for terminal types read from terminfo(5).

Scope
server
Type
Text, array of values
Default
xterm*:clipboard:ccolour:cstyle:focus:title,screen*:title,rxvt*:ignorefkeys
Separator
,
Set
set-option -s terminal-features value
Read
show-options -s terminal-features

Description#

Set terminal features for terminal types read from terminfo(5). tmux has a set of named terminal features. Each will apply appropriate changes to the terminfo(5) entry in use.

tmux can detect features for a few common terminals; this option can be used to easily tell tmux about features supported by terminals it cannot detect. The terminal-overrides option allows individual terminfo(5) capabilities to be set instead, terminal-features is intended for classes of functionality supported in a standard way but not reported by terminfo(5). Care must be taken to configure this only with features the terminal actually supports.

This is an array option where each entry is a colon-separated string made up of a terminal type pattern (matched using glob(7) patterns) followed by a list of terminal features. The available features are:

256
Supports 256 colours with the SGR escape sequences.
clipboard
Allows setting the system clipboard.
ccolour
Allows setting the cursor colour.
cstyle
Allows setting the cursor style.
extkeys
Supports extended keys.
focus
Supports focus reporting.
hyperlinks
Supports OSC 8 hyperlinks.
ignorefkeys
Ignore function keys from terminfo(5) and use the tmux internal set only.
margins
Supports DECSLRM margins.
mouse
Supports xterm(1) mouse sequences.
osc7
Supports the OSC 7 working directory extension.
overline
Supports the overline SGR attribute.
progressbar
Supports the OSC 9;4 progress bar extension.
rectfill
Supports the DECFRA rectangle fill escape sequence.
RGB
Supports RGB colour with the SGR escape sequences.
sixel
Supports SIXEL graphics.
strikethrough
Supports the strikethrough SGR escape sequence.
sync
Supports synchronized updates.
title
Supports xterm(1) title setting.
usstyle
Allows underscore style and colour to be set.

Releases#

Source#

Defined in
options-table.c:527
C source reference
options_table
CLI Manual
Original manual entry

Used by#

Library documentation that names this option.

Rust
options.generated.TERMINAL_FEATURES
Go
tmux.Server.SetTerminalFeatures, tmux.ServerOptionValues.ParsedTerminalFeatures, tmux.ServerOptionValues.TerminalFeatures, tmux.TerminalFeatures
Esc

Type to search.

Reference preview Open reference