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-swift latest

Server.environment(_:)

Every variable in an environment, in the order tmux printed them.

Source and package
Qualified name
Server.environment(_:)
Declared in
Server
Package
libtmux-swift
Source
Sources/LibTmux/Environment.swift
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGo Java C# C++ Kotlin Scala OCamlfunction F# Clojure

Description#

A value holding a newline is one variable with that value, the same as environmentValue(_:in:) reports. A client that is not UTF-8 gets the newline from tmux as _, so the value is read with that character.

Parameters
Raises

tmux command#

The tmux commands behind environment(_:).

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss environment(_:).

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
Ruby LibTmux::Server#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
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#.

Read a session's environment

Equivalents of Read a session's environment in other languages
Language Equivalent
Python libtmux.Session.show_environment
Ruby LibTmux::Session#environment
Lua libtmux.Session:list_environment
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript session.Session.showEnvironment
Rust session.Session.environment
Go tmux.Session.ShowEnvironment
Java no equivalent on Session
C# LibTmux.Session.Environment
C++ no equivalent on Session
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