# tmux 3.2a options

Source: https://libtmux.org/en/tmux/3.2a/catalog/options/

> Settings for the server, sessions, windows and panes, with their types, defaults and allowed values. Reference for tmux 3.2a.

Settings for the server, sessions, windows and panes, with their types, defaults and allowed values. The list covers tmux 3.2a, 104 entries.

## Session options47

[activity-action](https://libtmux.org/en/tmux/3.2a/catalog/options/activity-action/)

Set action on window activity when monitor-activity is on.

[assume-paste-time](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/base-index/)

Set the base index from which an unused index should be searched when a new window is created.

[bell-action](https://libtmux.org/en/tmux/3.2a/catalog/options/bell-action/)

Set action on a bell in a window when monitor-bell is on.

[default-command](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/default-shell/)

Specify the default shell.

[default-size](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/destroy-unattached/)

If enabled and the session is no longer attached to any clients, it is destroyed.

[detach-on-destroy](https://libtmux.org/en/tmux/3.2a/catalog/options/detach-on-destroy/)

If on (the default), the client is detached when the session it is attached to is destroyed.

[display-panes-active-colour](https://libtmux.org/en/tmux/3.2a/catalog/options/display-panes-active-colour/)

Set the colour used by the display-panes command to show the indicator for the active pane.

[display-panes-colour](https://libtmux.org/en/tmux/3.2a/catalog/options/display-panes-colour/)

Set the colour used by the display-panes command to show the indicators for inactive panes.

[display-panes-time](https://libtmux.org/en/tmux/3.2a/catalog/options/display-panes-time/)

Set the time in milliseconds for which the indicators shown by the display-panes command appear.

[display-time](https://libtmux.org/en/tmux/3.2a/catalog/options/display-time/)

Set the amount of time for which status line messages and other on-screen indicators are displayed.

[history-limit](https://libtmux.org/en/tmux/3.2a/catalog/options/history-limit/)

Set the maximum number of lines held in window history.

[key-table](https://libtmux.org/en/tmux/3.2a/catalog/options/key-table/)

Set the default key table to key-table instead of root.

[lock-after-time](https://libtmux.org/en/tmux/3.2a/catalog/options/lock-after-time/)

Lock the session (like the lock-session command) after number seconds of inactivity.

[lock-command](https://libtmux.org/en/tmux/3.2a/catalog/options/lock-command/)

Command to run when locking each client.

[message-command-style](https://libtmux.org/en/tmux/3.2a/catalog/options/message-command-style/)

Set status line message command style.

[message-style](https://libtmux.org/en/tmux/3.2a/catalog/options/message-style/)

Set status line message style.

[mouse](https://libtmux.org/en/tmux/3.2a/catalog/options/mouse/)

If on, tmux captures the mouse and allows mouse events to be bound as key bindings.

[prefix](https://libtmux.org/en/tmux/3.2a/catalog/options/prefix/)

Set the key accepted as a prefix key.

[prefix2](https://libtmux.org/en/tmux/3.2a/catalog/options/prefix2/)

Set a secondary key accepted as a prefix key.

[renumber-windows](https://libtmux.org/en/tmux/3.2a/catalog/options/renumber-windows/)

If on, when a window is closed in a session, automatically renumber the other windows in numerical order.

[repeat-time](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/set-titles/)

Attempt to set the client terminal title using the tsl and fslterminfo(5) entries if they exist.

[set-titles-string](https://libtmux.org/en/tmux/3.2a/catalog/options/set-titles-string/)

String used to set the client terminal title if set-titles is on.

[silence-action](https://libtmux.org/en/tmux/3.2a/catalog/options/silence-action/)

Set action on window silence when monitor-silence is on.

[status](https://libtmux.org/en/tmux/3.2a/catalog/options/status/)

Show or hide the status line or specify its size.

[status-bg](https://libtmux.org/en/tmux/3.2a/catalog/options/status-bg/)

Background colour of the status line. This option is deprecated, use 'status-style' instead.

[status-fg](https://libtmux.org/en/tmux/3.2a/catalog/options/status-fg/)

Foreground colour of the status line. This option is deprecated, use 'status-style' instead.

[status-format](https://libtmux.org/en/tmux/3.2a/catalog/options/status-format/)

Specify the format to be used for each line of the status line.

[status-interval](https://libtmux.org/en/tmux/3.2a/catalog/options/status-interval/)

Update the status line every interval seconds.

[status-justify](https://libtmux.org/en/tmux/3.2a/catalog/options/status-justify/)

Set the position of the window list in the status line: left, centre or right.

[status-keys](https://libtmux.org/en/tmux/3.2a/catalog/options/status-keys/)

Use vi or emacs-style key bindings in the status line, for example at the command prompt.

[status-left](https://libtmux.org/en/tmux/3.2a/catalog/options/status-left/)

Display string (by default the session name) to the left of the status line.

[status-left-length](https://libtmux.org/en/tmux/3.2a/catalog/options/status-left-length/)

Set the maximum length of the left component of the status line.

[status-left-style](https://libtmux.org/en/tmux/3.2a/catalog/options/status-left-style/)

Set the style of the left part of the status line.

[status-position](https://libtmux.org/en/tmux/3.2a/catalog/options/status-position/)

Set the position of the status line.

[status-right](https://libtmux.org/en/tmux/3.2a/catalog/options/status-right/)

Display string to the right of the status line.

[status-right-length](https://libtmux.org/en/tmux/3.2a/catalog/options/status-right-length/)

Set the maximum length of the right component of the status line.

[status-right-style](https://libtmux.org/en/tmux/3.2a/catalog/options/status-right-style/)

Set the style of the right part of the status line.

[status-style](https://libtmux.org/en/tmux/3.2a/catalog/options/status-style/)

Set status line style.

[update-environment](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/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 options34

[aggressive-resize](https://libtmux.org/en/tmux/3.2a/catalog/options/aggressive-resize/)

Aggressively resize the chosen window.

[automatic-rename](https://libtmux.org/en/tmux/3.2a/catalog/options/automatic-rename/)

Control automatic window renaming.

[automatic-rename-format](https://libtmux.org/en/tmux/3.2a/catalog/options/automatic-rename-format/)

The format (see FORMATS) used when the automatic-rename option is enabled.

[clock-mode-colour](https://libtmux.org/en/tmux/3.2a/catalog/options/clock-mode-colour/)

Set clock colour.

[clock-mode-style](https://libtmux.org/en/tmux/3.2a/catalog/options/clock-mode-style/)

Set clock hour format.

[copy-mode-current-match-style](https://libtmux.org/en/tmux/3.2a/catalog/options/copy-mode-current-match-style/)

Set the style of the current search match in copy mode.

[copy-mode-mark-style](https://libtmux.org/en/tmux/3.2a/catalog/options/copy-mode-mark-style/)

Set the style of the line containing the mark in copy mode.

[copy-mode-match-style](https://libtmux.org/en/tmux/3.2a/catalog/options/copy-mode-match-style/)

Set the style of search matches in copy mode.

[main-pane-height](https://libtmux.org/en/tmux/3.2a/catalog/options/main-pane-height/)

Set the width or height of the main (left or top) pane in the main-horizontal or main-vertical layouts.

[main-pane-width](https://libtmux.org/en/tmux/3.2a/catalog/options/main-pane-width/)

Set the width or height of the main (left or top) pane in the main-horizontal or main-vertical layouts.

[mode-keys](https://libtmux.org/en/tmux/3.2a/catalog/options/mode-keys/)

Use vi or emacs-style key bindings in copy mode.

[mode-style](https://libtmux.org/en/tmux/3.2a/catalog/options/mode-style/)

Set window modes style.

[monitor-activity](https://libtmux.org/en/tmux/3.2a/catalog/options/monitor-activity/)

Monitor for activity in the window.

[monitor-bell](https://libtmux.org/en/tmux/3.2a/catalog/options/monitor-bell/)

Monitor for a bell in the window.

[monitor-silence](https://libtmux.org/en/tmux/3.2a/catalog/options/monitor-silence/)

Monitor for silence (no activity) in the window within interval seconds.

[other-pane-height](https://libtmux.org/en/tmux/3.2a/catalog/options/other-pane-height/)

Set the height of the other panes (not the main pane) in the main-horizontal layout.

[other-pane-width](https://libtmux.org/en/tmux/3.2a/catalog/options/other-pane-width/)

Like other-pane-height, but set the width of other panes in the main-vertical layout.

[pane-active-border-style](https://libtmux.org/en/tmux/3.2a/catalog/options/pane-active-border-style/)

Set the pane border style for the currently active pane.

[pane-base-index](https://libtmux.org/en/tmux/3.2a/catalog/options/pane-base-index/)

Like base-index, but set the starting index for pane numbers.

[pane-border-format](https://libtmux.org/en/tmux/3.2a/catalog/options/pane-border-format/)

Set the text shown in pane border status lines.

[pane-border-lines](https://libtmux.org/en/tmux/3.2a/catalog/options/pane-border-lines/)

Set the type of characters used for drawing pane borders.

[pane-border-status](https://libtmux.org/en/tmux/3.2a/catalog/options/pane-border-status/)

Turn pane border status lines off or set their position.

[pane-border-style](https://libtmux.org/en/tmux/3.2a/catalog/options/pane-border-style/)

Set the pane border style for panes aside from the active pane.

[window-size](https://libtmux.org/en/tmux/3.2a/catalog/options/window-size/)

Configure how tmux determines the window size.

[window-status-activity-style](https://libtmux.org/en/tmux/3.2a/catalog/options/window-status-activity-style/)

Set status line style for windows with an activity alert.

[window-status-bell-style](https://libtmux.org/en/tmux/3.2a/catalog/options/window-status-bell-style/)

Set status line style for windows with a bell alert.

[window-status-current-format](https://libtmux.org/en/tmux/3.2a/catalog/options/window-status-current-format/)

Like window-status-format, but is the format used when the window is the current window.

[window-status-current-style](https://libtmux.org/en/tmux/3.2a/catalog/options/window-status-current-style/)

Set status line style for the currently active window.

[window-status-format](https://libtmux.org/en/tmux/3.2a/catalog/options/window-status-format/)

Set the format in which the window is displayed in the status line window list.

[window-status-last-style](https://libtmux.org/en/tmux/3.2a/catalog/options/window-status-last-style/)

Set status line style for the last active window.

[window-status-separator](https://libtmux.org/en/tmux/3.2a/catalog/options/window-status-separator/)

Sets the separator drawn between windows in the status line.

[window-status-style](https://libtmux.org/en/tmux/3.2a/catalog/options/window-status-style/)

Set status line style for a single window.

[wrap-search](https://libtmux.org/en/tmux/3.2a/catalog/options/wrap-search/)

If this option is set, searches will wrap around the end of the pane contents.

[xterm-keys](https://libtmux.org/en/tmux/3.2a/catalog/options/xterm-keys/)

Whether xterm-style function key sequences should be sent. This option is no longer used.

## Window and pane options6

[allow-rename](https://libtmux.org/en/tmux/3.2a/catalog/options/allow-rename/)

Allow programs in the pane to change the window name using a terminal escape sequence (\ek...\e\\\\).

[alternate-screen](https://libtmux.org/en/tmux/3.2a/catalog/options/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.

[remain-on-exit](https://libtmux.org/en/tmux/3.2a/catalog/options/remain-on-exit/)

A pane with this flag set is not destroyed when the program running in it exits.

[synchronize-panes](https://libtmux.org/en/tmux/3.2a/catalog/options/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).

[window-active-style](https://libtmux.org/en/tmux/3.2a/catalog/options/window-active-style/)

Set the pane style when it is the active pane.

[window-style](https://libtmux.org/en/tmux/3.2a/catalog/options/window-style/)

Set the pane style.

## Server options17

[backspace](https://libtmux.org/en/tmux/3.2a/catalog/options/backspace/)

Set the key sent by tmux for backspace.

[buffer-limit](https://libtmux.org/en/tmux/3.2a/catalog/options/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.

[command-alias](https://libtmux.org/en/tmux/3.2a/catalog/options/command-alias/)

This is an array of custom aliases for commands.

[copy-command](https://libtmux.org/en/tmux/3.2a/catalog/options/copy-command/)

Give the command to pipe to if the copy-pipe copy mode command is used without arguments.

[default-terminal](https://libtmux.org/en/tmux/3.2a/catalog/options/default-terminal/)

Set the default terminal for new windows created in this session - the default value of the TERM environment variable.

[editor](https://libtmux.org/en/tmux/3.2a/catalog/options/editor/)

Set the command used when tmux runs an editor.

[escape-time](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/exit-empty/)

If enabled (the default), the server will exit when there are no active sessions.

[exit-unattached](https://libtmux.org/en/tmux/3.2a/catalog/options/exit-unattached/)

If enabled, the server will exit when there are no attached clients.

[extended-keys](https://libtmux.org/en/tmux/3.2a/catalog/options/extended-keys/)

When on or always, the escape sequence to enable extended keys is sent to the terminal, if tmux knows that it is supported.

[focus-events](https://libtmux.org/en/tmux/3.2a/catalog/options/focus-events/)

When enabled, focus events are requested from the terminal if supported and passed through to applications running in tmux.

[history-file](https://libtmux.org/en/tmux/3.2a/catalog/options/history-file/)

If not empty, a file to which tmux will write command prompt history on exit and load it from on start.

[message-limit](https://libtmux.org/en/tmux/3.2a/catalog/options/message-limit/)

Set the number of error or information messages to save in the message log for each client.

[set-clipboard](https://libtmux.org/en/tmux/3.2a/catalog/options/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](https://libtmux.org/en/tmux/3.2a/catalog/options/terminal-features/)

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

[terminal-overrides](https://libtmux.org/en/tmux/3.2a/catalog/options/terminal-overrides/)

Allow terminal descriptions read using terminfo(5) to be overridden.

[user-keys](https://libtmux.org/en/tmux/3.2a/catalog/options/user-keys/)

Set list of user-defined key escape sequences.