tmuxtmuxOptions, hooks and formats

Choose documentation 1

latest

tmux catalog version

Latest (3.7c) 3.7c 3.2a
English

option tmux3.7c

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.

Scope
session
Type
Text, array of values
Default
Show the default
DISPLAY KRB5CCNAME MSYSTEM SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION WAYLAND_DISPLAY WINDOWID XAUTHORITY XDG_CURRENT_DESKTOP XDG_SESSION_DESKTOP XDG_SESSION_TYPE
Set
set-option update-environment value
Read
show-options update-environment

Description#

Set list of environment variables to be copied into the session environment when a new session is created or an existing session is attached. Any variables that do not exist in the source environment are set to be removed from the session environment (as if -r was given to the set-environment command).

Releases#

Source#

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

Used by#

Library documentation that names this option.

Lua
libtmux.SwitchClientOptions.update_environment
Rust
options.generated.UPDATE_ENVIRONMENT
Go
tmux.GlobalSessionScope.SetUpdateEnvironment, tmux.Session.SetUpdateEnvironment, tmux.SessionOptionValues.UpdateEnvironment
Esc

Type to search.

Reference preview Open reference