Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased LibTmux has not been released. Its API may change during development. This site's structure and URLs may change too.

method libtmux-perl latest

Server.get_environment

get_environment(name => env_name, session => session_target?).

Source and package
Qualified name
LibTmux::Server::get_environment
Module
LibTmux
Declared in
Server
Package
LibTmux
Source
packages/core/lib/LibTmux/Server.pm
Other languages
Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScriptRustGo Java C# C++ Swift Kotlin Scala OCaml F# Clojure
sub get_environment($self, %args)

Description#

Read a session/global variable and return its octets. The native quoted representation is parsed as data; no shell evaluates it. Literal backslashes, newlines and non-UTF-8 bytes remain distinct. Empty text and '0' remain values. Performs I/O without mutation; missing or explicitly unset variables throw "Command" in LibTmux::X, and malformed output throws "Codec" in LibTmux::X. Captured targets follow "set_environment"'s generation checks.

my $value = $server->get_environment(session => $session, name => 'BUILD');

Methods#

Parameters

tmux command#

The tmux commands behind get_environment.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Read one variable from the server's environment

Equivalents of Read one variable from the server's environment in other languages
Language Equivalent
Python no single-variable read; the whole table is returned
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.getEnvironment
Rust server.Server.environment
Go tmux.Server.GetEnvironment
Java no single-variable read; the whole table is returned
C# no single-variable read; the whole table is returned
C++ no single-variable read; the whole table is returned
Swift no single-variable read; the whole table is returned
OCaml No direct public OCaml equivalent is recorded for this operation.

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

Read one variable from a session's environment

Equivalents of Read one variable from a session's environment in other languages
Language Equivalent
Python no single-variable read; the whole table is returned
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript session.Session.getEnvironment
Rust session.Session.environment
Go tmux.Session.GetEnvironment
Java no single-variable read; the whole table is returned
C# no single-variable read; the whole table is returned
C++ no single-variable read; the whole table is returned
Swift no single-variable read; the whole table is returned
OCaml No direct public OCaml equivalent is recorded for this operation.

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

Esc

Type to search.

Reference previewOpen reference