Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-ruby latest

Server.environment

Behavior: Environment.

Source and package
Qualified name
LibTmux::Server#environment
Module
LibTmux
Declared in
Server
Package
libtmux
Source
gems/libtmux/lib/libtmux/operations.rb
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonLuaTypeScriptRustGo Java C# C++ Swift Kotlin Scala OCamlfunction F# Clojure
def environment: ( ::String, ?hidden: bool, ?timeout: ::Numeric, ?cancel: untyped ) -> ::String?

Description#

Behavior contract: Environment.

Parameters

tmux command#

The tmux commands behind environment.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Read the server's global environment

Equivalents of Read the server's global environment in other languages
Language Equivalent
Python libtmux.Server.show_environment
Lua libtmux.Server:list_environment
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.showEnvironment
Rust server.Server.environment
Go tmux.Server.ShowEnvironment
Java no equivalent on Server
C# LibTmux.Server.Environment
C++ no equivalent on Server
Swift Server.environment(_:)
OCaml Libtmux_unix.Client.capture_environment Pass Environment.Global for server values or Environment.Session with a bound session target. Acquisition is explicit.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Esc

Type to search.

Reference previewOpen reference