Python API

method libtmux latest

Session.set_environment

Source and package

Qualified name: libtmux.Session.set_environment
Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/common.py
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp RubyLuaTypeScriptRustGo Java C# C++ Swift Kotlin Scala OCaml F# Clojure

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

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

tmux command#

The tmux commands behind set_environment.

The C declarations in tmux that implement these commands.

Pages that discuss set_environment.

Set a variable in a session's environment

Equivalents of Set a variable in a session's environment in other languages
Language	Equivalent
Ruby	`LibTmux::Session#set_environment`
Lua	`libtmux.Session:set_environment`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`session.Session.setEnvironment`
Rust	`session.Session.set_environment`
Go	`tmux.Session.SetEnvironment`
Java	no equivalent on `Session`
C#	no equivalent on `Session`
C++	no equivalent on `Session`
Swift	`Server.setEnvironment(_:to:in:)`
OCaml	`Libtmux_unix.Client.set_environment`
Perl	`LibTmux::Server::set_environment` Pass an explicit session ID. Empty text and zero-like text remain values.

No equivalent is recorded in PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.