Python API

libtmux.Session.set_environment

Python

Python
Ruby
Lua
TypeScript
Rust
Go
Java Unavailable
.NET Unavailable
C++ Unavailable
Swift

Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/common.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++ Swift

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

Inherited from libtmux.common.EnvironmentMixin

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.

Discussed in Environment

In other ports Set a variable in a session's environment

Ruby LibTmux::Session#set_environment
Lua libtmux.Session:set_environment
TypeScript session.Session.setEnvironment
Rust session.Session.set_environment
Go tmux.Session.SetEnvironment
Java no equivalent on Session
.NET no equivalent on Session
C++ no equivalent on Session
Swift Server.setEnvironment(_:to:in:)

0 declared, 0 inherited