tmuxtmuxOptions, hooks and formats

Choose documentation 1

latest

tmux catalog version

Latest (3.7c) 3.7c 3.2a
English

option tmux3.7c

user-keys

Set list of user-defined key escape sequences.

Scope
server
Type
Text, array of values
Separator
,
Set
set-option -s user-keys value
Read
show-options -s user-keys

Description#

Set list of user-defined key escape sequences. Each item is associated with a key named ‘User0’, ‘User1’, and so on.

For example:

set -s user-keys[0] "\e[5;30012~"
bind User0 resize-pane -L 3

Releases#

Source#

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

Used by#

Library documentation that names this option.

Rust
options.generated.USER_KEYS
Go
tmux.Server.SetUserKeys, tmux.ServerOptionValues.UserKeys
Esc

Type to search.

Reference preview Open reference