`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.

Scope: window, pane
Type: Flag (on or off)
Default: on
Set: set-option -w alternate-screen value
Read: show-options -w alternate-screen

Description#

This option configures whether programs running inside the pane may use the terminal alternate screen feature, which allows the smcup and rmcupterminfo(5) capabilities. The alternate screen feature preserves the contents of the window when an interactive application starts and restores it on exit, so that any output visible before the application starts reappears unchanged after it exits.

Releases#

tmux 3.7c : present
tmux 3.2a : present

Source#

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

Used by#

Library documentation that names this option.

Rust: options.generated.ALTERNATE_SCREEN
Go: tmux.GlobalWindowScope.SetAlternateScreen, tmux.Pane.SetAlternateScreen, tmux.PaneOptionValues.AlternateScreen, tmux.Window.SetAlternateScreen, tmux.WindowOptionValues.AlternateScreen