On this page

libtmux.common.EnvironmentMixin.set_environment

Module: libtmux.common
Declared in: EnvironmentMixin
Package: libtmux
Source: src/libtmux/common.py

set_environment ( self , name : str , value : str , expand_format : bool | None = None , hidden : bool | None = None ) → None method [source] ¶ method [source] ¶ set_environment

Set environment $ tmux set-environment <name> <value>.

Parameters

name ( str ) – The environment variable name, e.g. 'PATH'.
value ( str ) – Environment value.
expand_format ( bool | None ) – Expand tmux format strings in the value (-F flag). added 0.56
hidden ( bool | None ) – Mark the variable as hidden (-h flag). added 0.56

Raises

ValueError – If tmux returns an error.

0 declared, 0 inherited