Skip to content

Latest commit

 

History

History
314 lines (297 loc) · 55.3 KB

File metadata and controls

314 lines (297 loc) · 55.3 KB

tmux option and hook reference

This generated catalog records every canonical built-in option and hook in the 13 released tmux versions listed below. It describes native types and storage scopes; it does not establish runtime or platform compatibility. Edit the catalog, then regenerate:

$ python scripts/generate_options.py

Check generated Lua metadata and this reference without changing files:

$ python scripts/generate_options.py --check

Both commands run offline with Python and the pinned StyLua formatter. --verify-source additionally accepts a local tmux Git checkout and checks every release tag, pinned source digest, definition and line anchor. It does not download sources, build tmux or start a server.

Values and scopes

Built-in names select their native storage scope; command flags alone do not enforce the caller's intended scope. Session and window defaults are separate global stores. Pane-capable options also support window storage; there is no global pane store. Unknown release strings require new source evidence: the private catalog does not fall back to the latest version.

Flags use booleans, numbers use exact bounded integers, and choices use literal strings, including numeric-looking choices such as "24". Keys, colours, styles and commands retain their native string grammars. A command value is tmux command-list source, not shell argv. Native grammar validation and remote conditions such as shell suitability still require tmux.

Arrays retain native zero-based sparse indices and their element type. The separator is a set of splitting characters, not a reversible codec. An omitted array separator means space/comma; an empty separator preserves one complete command-list entry. Indexed assignment avoids splitting. All built-in hooks are command arrays; a scalar command option is not a hook. User options beginning with @ are separate string scalars.

Global built-in unset restores the default; local unset removes an override. Native aliases, prefix matching, default values and descriptive option text are outside this catalog. Source integer limits assume the supported target ABIs' 32-bit int and 16-bit short; the largest bound is 4294967295.

Source releases

Release Built-ins, including hooks Hooks
3.2a 165 61
3.3 181 65
3.3a 181 65
3.4 186 65
3.5 190 66
3.5a 190 66
3.6 210 68
3.6a 210 68
3.6b 210 68
3.7 221 68
3.7a 221 68
3.7b 221 68
3.7c 221 68

Full commit identities, hashes for options-table.c, options.c and tmux.h, and per-entry source anchors are recorded in the source catalog. Repeated release labels below mean the extracted metadata is identical, not that defaults or other native behavior are identical.

Options

Name Releases Scope Value Array separator
activity-action 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session none, any, current, other —
aggressive-resize 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window flag —
allow-passthrough 3.3, 3.3a window, pane flag —
allow-passthrough 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane off, on, all —
allow-rename 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane flag —
allow-set-title 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane flag —
alternate-screen 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane flag —
assume-paste-time 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..2147483647 —
automatic-rename 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window flag —
automatic-rename-format 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window string —
backspace 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server key —
base-index 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..2147483647 —
bell-action 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session none, any, current, other —
buffer-limit 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server 1..2147483647 —
clock-mode-colour 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window colour —
clock-mode-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a window 12, 24 —
clock-mode-style 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window 12, 24, 12-with-seconds, 24-with-seconds —
codepoint-widths 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server string; sparse array ","
command-alias 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server string; sparse array ","
copy-command 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server string —
copy-mode-current-line-number-style 3.7, 3.7a, 3.7b, 3.7c window style string —
copy-mode-current-match-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
copy-mode-line-number-style 3.7, 3.7a, 3.7b, 3.7c window style string —
copy-mode-line-numbers 3.7, 3.7a, 3.7b, 3.7c window off, default, absolute, relative, hybrid —
copy-mode-mark-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
copy-mode-match-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
copy-mode-position-format 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane string —
copy-mode-position-style 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
copy-mode-selection-style 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
cursor-colour 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane colour —
cursor-style 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane default, blinking-block, block, blinking-underline, underline, blinking-bar, bar —
default-client-command 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server command —
default-command 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string —
default-shell 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string —
default-size 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string —
default-terminal 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server string —
destroy-unattached 3.2a, 3.3, 3.3a session flag —
destroy-unattached 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session off, on, keep-last, keep-group —
detach-on-destroy 3.2a, 3.3, 3.3a session off, on, no-detached —
detach-on-destroy 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session off, on, no-detached, previous, next —
display-panes-active-colour 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session colour —
display-panes-colour 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session colour —
display-panes-time 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 1..2147483647 —
display-time 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..2147483647 —
editor 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server string —
escape-time 3.2a server 0..2147483647 —
escape-time 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server 0..2147483647 —
exit-empty 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server flag —
exit-unattached 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server flag —
extended-keys 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server off, on, always —
extended-keys-format 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server csi-u, xterm —
fill-character 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window string —
focus-events 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server flag —
focus-follows-mouse 3.7, 3.7a, 3.7b, 3.7c session flag —
get-clipboard 3.7, 3.7a, 3.7b, 3.7c server off, buffer, request, both —
history-file 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server string —
history-limit 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..2147483647 —
initial-repeat-time 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..2000000 —
input-buffer-size 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server 1048576..4294967295 —
key-table 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string —
lock-after-time 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..2147483647 —
lock-command 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string —
main-pane-height 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window string —
main-pane-width 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window string —
menu-border-lines 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window single, double, heavy, simple, rounded, padded, none —
menu-border-style 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
menu-selected-style 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
menu-style 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
message-command-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session style string —
message-format 3.7, 3.7a, 3.7b, 3.7c session string —
message-limit 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server 0..2147483647 —
message-line 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0, 1, 2, 3, 4 —
message-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session style string —
mode-keys 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window emacs, vi —
mode-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
monitor-activity 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window flag —
monitor-bell 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window flag —
monitor-silence 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window 0..2147483647 —
mouse 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session flag —
other-pane-height 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window string —
other-pane-width 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window string —
pane-active-border-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b window style string —
pane-active-border-style 3.7, 3.7a, 3.7b, 3.7c window, pane style string —
pane-base-index 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window 0..65535 —
pane-border-format 3.2a window string —
pane-border-format 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane string —
pane-border-indicators 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window off, colour, arrows, both —
pane-border-lines 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a window single, double, heavy, simple, number —
pane-border-lines 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window single, double, heavy, simple, number, spaces —
pane-border-status 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window off, top, bottom —
pane-border-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b window style string —
pane-border-style 3.7, 3.7a, 3.7b, 3.7c window, pane style string —
pane-colours 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane colour; sparse array " ,"
pane-scrollbars 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window off, modal, on —
pane-scrollbars-position 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window right, left —
pane-scrollbars-style 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane style string —
pane-status-current-style 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
pane-status-style 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
popup-border-lines 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window single, double, heavy, simple, rounded, padded, none —
popup-border-style 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
popup-style 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
prefix 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session key —
prefix-timeout 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server 0..2147483647 —
prefix2 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session key —
prompt-command-cursor-style 3.7, 3.7a, 3.7b, 3.7c session default, blinking-block, block, blinking-underline, underline, blinking-bar, bar —
prompt-cursor-colour 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session colour —
prompt-cursor-style 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session default, blinking-block, block, blinking-underline, underline, blinking-bar, bar —
prompt-history-limit 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server 0..2147483647 —
remain-on-exit 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b window, pane off, on, failed —
remain-on-exit 3.7, 3.7a, 3.7b, 3.7c window, pane off, on, failed, key —
remain-on-exit-format 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane string —
renumber-windows 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session flag —
repeat-time 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a session 0..32767 —
repeat-time 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..2000000 —
scroll-on-clear 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane flag —
session-status-current-style 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
session-status-style 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
set-clipboard 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server off, external, on —
set-titles 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session flag —
set-titles-string 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string —
silence-action 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session none, any, current, other —
status 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session off, on, 2, 3, 4, 5 —
status-bg 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session colour —
status-fg 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session colour —
status-format 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string; sparse array " ,"
status-interval 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..2147483647 —
status-justify 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session left, centre, right, absolute-centre —
status-keys 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session emacs, vi —
status-left 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string —
status-left-length 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..32767 —
status-left-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session style string —
status-position 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session top, bottom —
status-right 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string —
status-right-length 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session 0..32767 —
status-right-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session style string —
status-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session style string —
synchronize-panes 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane flag —
terminal-features 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server string; sparse array ","
terminal-overrides 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server string; sparse array ","
tiled-layout-max-columns 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window 0..65535 —
tree-mode-preview-format 3.7, 3.7a, 3.7b, 3.7c window, pane string —
tree-mode-preview-style 3.7, 3.7a, 3.7b, 3.7c window style string —
update-environment 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string; sparse array " ,"
user-keys 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server string; sparse array ","
variation-selector-always-wide 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c server flag —
visual-activity 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session off, on, both —
visual-bell 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session off, on, both —
visual-silence 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session off, on, both —
window-active-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane style string —
window-pane-current-status-format 3.7, 3.7a, 3.7b, 3.7c window string —
window-pane-status-format 3.7, 3.7a, 3.7b, 3.7c window string —
window-size 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window largest, smallest, manual, latest —
window-status-activity-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
window-status-bell-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
window-status-current-format 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window string —
window-status-current-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
window-status-format 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window string —
window-status-last-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
window-status-separator 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window string —
window-status-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window style string —
window-style 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane style string —
word-separators 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session string —
wrap-search 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window flag —
xterm-keys 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window flag —

Hooks

Name Releases Scope Value Array separator
after-bind-key 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-capture-pane 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-copy-mode 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-display-message 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-display-panes 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-kill-pane 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-list-buffers 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-list-clients 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-list-keys 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-list-panes 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-list-sessions 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-list-windows 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-load-buffer 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-lock-server 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-new-session 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-new-window 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-paste-buffer 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-pipe-pane 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-queue 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-refresh-client 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-rename-session 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-rename-window 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-resize-pane 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-resize-window 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-save-buffer 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-select-layout 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-select-pane 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-select-window 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-send-keys 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-set-buffer 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-set-environment 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-set-hook 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-set-option 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-show-environment 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-show-messages 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-show-options 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-split-window 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
after-unbind-key 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
alert-activity 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
alert-bell 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
alert-silence 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
client-active 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
client-attached 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
client-dark-theme 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
client-detached 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
client-focus-in 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
client-focus-out 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
client-light-theme 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
client-resized 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
client-session-changed 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
command-error 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
pane-died 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane command; sparse array empty
pane-exited 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane command; sparse array empty
pane-focus-in 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane command; sparse array empty
pane-focus-out 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane command; sparse array empty
pane-mode-changed 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane command; sparse array empty
pane-set-clipboard 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane command; sparse array empty
pane-title-changed 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window, pane command; sparse array empty
session-closed 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
session-created 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
session-renamed 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
session-window-changed 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
window-layout-changed 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window command; sparse array empty
window-linked 3.2a window command; sparse array empty
window-linked 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty
window-pane-changed 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window command; sparse array empty
window-renamed 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window command; sparse array empty
window-resized 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c window command; sparse array empty
window-unlinked 3.2a window command; sparse array empty
window-unlinked 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a, 3.6b, 3.7, 3.7a, 3.7b, 3.7c session command; sparse array empty