tmuxtmuxOptions, hooks and formats

Choose documentation 1

latest

tmux catalog version

Latest (3.7c) 3.7c 3.2a
English

tmux 3.7c options, hooks and formats

tmux 3.7c options

Settings for the server, sessions, windows and panes, with their types, defaults and allowed values. The list covers tmux 3.7c, 153 entries.

Session options54

activity-action
Set action on window activity when monitor-activity is on.
assume-paste-time
If keys are entered faster than one in milliseconds, they are assumed to have been pasted rather than typed and tmux key bindings are not processed.
base-index
Set the base index from which an unused index should be searched when a new window is created.
bell-action
Set action on a bell in a window when monitor-bell is on.
default-command
Set the command used for new windows (if not specified when the window is created) to shell-command, which may be any sh(1) command.
default-shell
Specify the default shell.
default-size
Set the default size of new windows when the window-size option is set to manual or when a session is created with new-session-d.
destroy-unattached
If on, destroy the session after the last client has detached.
detach-on-destroy
If on (the default), the client is detached when the session it is attached to is destroyed.
display-panes-active-colour
Set the colour used by the display-panes command to show the indicator for the active pane.
display-panes-colour
Set the colour used by the display-panes command to show the indicators for inactive panes.
display-panes-time
Set the time in milliseconds for which the indicators shown by the display-panes command appear.
display-time
Set the amount of time for which status line messages and other on-screen indicators are displayed.
focus-follows-mouse
When enabled and mouse is on, moving the mouse into a pane selects it.
history-limit
Set the maximum number of lines held in pane history.
initial-repeat-time
Set the time in milliseconds for the initial repeat when a key is bound with the -r flag.
key-table
Set the default key table to key-table instead of root.
lock-after-time
Lock the session (like the lock-session command) after number seconds of inactivity.
lock-command
Command to run when locking each client.
message-command-style
Set status line message command style.
message-format
Set the format string for the prompt and message area.
message-line
Set line on which status line messages and the command prompt are shown.
message-style
Set status line message style.
mouse
If on, tmux captures the mouse and allows mouse events to be bound as key bindings.
prefix
Set the key accepted as a prefix key.
prefix2
Set a secondary key accepted as a prefix key.
prompt-command-cursor-style
Set the style of the cursor in the command prompt when vi keys are enabled and the prompt is in command mode.
prompt-cursor-colour
Set the colour of the cursor in the command prompt.
prompt-cursor-style
Set the style of the cursor in the command prompt.
renumber-windows
If on, when a window is closed in a session, automatically renumber the other windows in numerical order.
repeat-time
Allow multiple commands to be entered without pressing the prefix key again in the specified time milliseconds (the default is 500).
set-titles
Attempt to set the client terminal title using the tsl and fslterminfo(5) entries if they exist.
set-titles-string
String used to set the client terminal title if set-titles is on.
silence-action
Set action on window silence when monitor-silence is on.
status
Show or hide the status line or specify its size.
status-bg
Background colour of the status line. This option is deprecated, use 'status-style' instead.
status-fg
Foreground colour of the status line. This option is deprecated, use 'status-style' instead.
status-format
Specify the format to be used for each line of the status line.
status-interval
Update the status line every interval seconds.
status-justify
Set the position of the window list in the status line: left, centre or right.
status-keys
Use vi or emacs-style key bindings in the status line, for example at the command prompt.
status-left
Display string (by default the session name) to the left of the status line.
status-left-length
Set the maximum length of the left component of the status line.
status-left-style
Set the style of the left part of the status line.
status-position
Set the position of the status line.
status-right
Display string to the right of the status line.
status-right-length
Set the maximum length of the right component of the status line.
status-right-style
Set the style of the right part of the status line.
status-style
Set status line style.
update-environment
Set list of environment variables to be copied into the session environment when a new session is created or an existing session is attached.
visual-activity
If on, display a message instead of sending a bell when activity occurs in a window for which the monitor-activity window option is enabled.
visual-bell
If on, a message is shown on a bell in a window for which the monitor-bell window option is enabled instead of it being passed through to the terminal (which normally makes a sound).
visual-silence
If monitor-silence is enabled, prints a message after the interval has expired on a given window instead of sending a bell.
word-separators
Sets the session's conception of what characters are considered word separators, for the purposes of the next and previous word commands in copy mode.

Window options55

aggressive-resize
Aggressively resize the chosen window.
automatic-rename
Control automatic window renaming.
automatic-rename-format
The format (see FORMATS) used when the automatic-rename option is enabled.
clock-mode-colour
Set clock colour.
clock-mode-style
Set clock hour format.
copy-mode-current-line-number-style
Set style of current line number in copy mode.
copy-mode-current-match-style
Set the style of the current search match in copy mode.
copy-mode-line-number-style
Set style of line numbers in copy mode.
copy-mode-line-numbers
Show line numbers in copy mode.
copy-mode-mark-style
Set the style of the line containing the mark in copy mode.
copy-mode-match-style
Set the style of search matches in copy mode.
copy-mode-position-style
Set the style of the position indicator in copy mode.
copy-mode-selection-style
Set the style of the selection in copy mode.
fill-character
Set the character used to fill areas of the terminal unused by a window.
main-pane-height
Set the width or height of the main (left or top) pane in the main-horizontal, main-horizontal-mirrored, main-vertical, or main-vertical-mirrored layouts.
main-pane-width
Set the width or height of the main (left or top) pane in the main-horizontal, main-horizontal-mirrored, main-vertical, or main-vertical-mirrored layouts.
menu-border-lines
Set the type of characters used for drawing menu borders.
menu-border-style
Set the menu border style.
menu-selected-style
Set the selected menu item style.
menu-style
Set the menu style.
mode-keys
Use vi or emacs-style key bindings in copy mode.
mode-style
Set window modes style.
monitor-activity
Monitor for activity in the window.
monitor-bell
Monitor for a bell in the window.
monitor-silence
Monitor for silence (no activity) in the window within interval seconds.
other-pane-height
Set the height of the other panes (not the main pane) in the main-horizontal and main-horizontal-mirrored layouts.
other-pane-width
Like other-pane-height, but set the width of other panes in the main-vertical and main-vertical-mirrored layouts.
pane-base-index
Like base-index, but set the starting index for pane numbers.
pane-border-indicators
Indicate active pane by colouring only half of the border in windows with exactly two panes, by displaying arrow markers, by drawing both or neither.
pane-border-lines
Set the type of characters used for drawing pane borders.
pane-border-status
Turn pane border status lines off or set their position.
pane-scrollbars
When enabled, a character based scrollbar appears on the left or right of each pane.
pane-scrollbars-position
Sets which side of the pane to display pane scrollbars on.
pane-status-current-style
Set status line style for the currently active pane.
pane-status-style
Set status line style for a single pane.
popup-border-lines
Set the type of characters used for drawing popup borders.
popup-border-style
Set the popup border style.
popup-style
Set the popup style.
session-status-current-style
Set status line style for the currently active session.
session-status-style
Set status line style for a single session.
tiled-layout-max-columns
Set the maximum number of columns in the tiled layout.
tree-mode-preview-style
Set the style of the preview indicator in tree mode.
window-pane-current-status-format
Like window-status-format, but is the format used when the window is the current window.
window-pane-status-format
Set the format in which the window pane is displayed in the status line window pane list.
window-size
Configure how tmux determines the window size.
window-status-activity-style
Set status line style for windows with an activity alert.
window-status-bell-style
Set status line style for windows with a bell alert.
window-status-current-format
Like window-status-format, but is the format used when the window is the current window.
window-status-current-style
Set status line style for the currently active window.
window-status-format
Set the format in which the window is displayed in the status line window list.
window-status-last-style
Set status line style for the last active window.
window-status-separator
Sets the separator drawn between windows in the status line.
window-status-style
Set status line style for a single window.
wrap-search
If this option is set, searches will wrap around the end of the pane contents.
xterm-keys
Whether xterm-style function key sequences should be sent. This option is no longer used.

Window and pane options19

allow-passthrough
Allow programs in the pane to bypass tmux using a terminal escape sequence (\ePtmux;...\e\\).
allow-rename
Allow programs in the pane to change the window name using a terminal escape sequence (\ek...\e\\).
allow-set-title
Allow programs in the pane to change the title using the terminal escape sequences (\e]2;...\e\\ or \e]0;...\e\\).
alternate-screen
This option configures whether programs running inside the pane may use the terminal alternate screen feature, which allows the smcup and rmcupterminfo(5) capabilities.
copy-mode-position-format
Format of the position indicator in copy mode.
cursor-colour
Set the colour of the cursor.
cursor-style
Set the style of the cursor.
pane-active-border-style
Set the pane border style for the currently active pane.
pane-border-format
Set the text shown in pane border status lines.
pane-border-style
Set the pane border style for panes aside from the active pane.
pane-colours
The default colour palette.
pane-scrollbars-style
Set the scrollbars style.
remain-on-exit
A pane with this flag set is not destroyed when the program running in it exits.
remain-on-exit-format
Set the text shown at the bottom of exited panes when remain-on-exit is enabled.
scroll-on-clear
When the entire screen is cleared and this option is on, scroll the contents of the screen into history before clearing it.
synchronize-panes
Duplicate input to all other panes in the same window where this option is also on (only for panes that are not in any mode).
tree-mode-preview-format
Format of the preview indicator in tree mode.
window-active-style
Set the pane style when it is the active pane.
window-style
Set the pane style.

Server options25

backspace
Set the key sent by tmux for backspace.
buffer-limit
Set the number of buffers; as new buffers are added to the top of the stack, old ones are removed from the bottom if necessary to maintain this maximum length.
codepoint-widths
An array option allowing widths of Unicode codepoints to be overridden.
command-alias
This is an array of custom aliases for commands.
copy-command
Give the command to pipe to if the copy-pipe copy mode command is used without arguments.
default-client-command
Set the default command to run when tmux is called without a command.
default-terminal
Set the default terminal for new windows created in this session - the default value of the TERM environment variable.
editor
Set the command used when tmux runs an editor.
escape-time
Set the time in milliseconds for which tmux waits after an escape is input to determine if it is part of a function or meta key sequences.
exit-empty
If enabled (the default), the server will exit when there are no active sessions.
exit-unattached
If enabled, the server will exit when there are no attached clients.
extended-keys
Controls how modified keys (keys pressed together with Control, Meta, or Shift) are reported.
extended-keys-format
Selects one of the two possible formats for reporting modified keys to applications.
focus-events
When enabled, focus events are requested from the terminal if supported and passed through to applications running in tmux.
get-clipboard
Controls the behaviour when an application requests the clipboard from tmux.
history-file
If not empty, a file to which tmux will write command prompt history on exit and load it from on start.
input-buffer-size
Maximum of bytes allowed to read in escape and control sequences.
message-limit
Set the number of error or information messages to save in the message log for each client.
prefix-timeout
Set the time in milliseconds for which tmux waits after prefix is input before dismissing it.
prompt-history-limit
Set the number of history items to save in the history file for each type of command prompt.
set-clipboard
Attempt to set the terminal clipboard content using the xterm(1) escape sequence, if there is an Ms entry in the terminfo(5) description (see the TERMINFO EXTENSIONS section).
terminal-features
Set terminal features for terminal types read from terminfo(5).
terminal-overrides
Allow terminal descriptions read using terminfo(5) to be overridden.
user-keys
Set list of user-defined key escape sequences.
variation-selector-always-wide
Always treat Unicode variation selector 16 as marking a wide character.
Esc

Type to search.

Reference preview Open reference