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

Session.ShowEnvironment

ShowEnvironment returns an owned session-scoped non-hidden tmux environment. Completed command failures return an empty map unless strict errors are enabled. Externally injected multiline entries return ErrMalformedEnvironment because tmux's multi-entry output does not frame continuation lines. Decode errors are compatible with ErrMalformedEnvironment and return no partial map.

Source and package
Qualified name
tmux.Session.ShowEnvironment
Package
tmux
Declared in
Session
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/environment.go
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRust Java C# C++ Swift Kotlin Scala OCamlfunction F# Clojure
func (s Session) ShowEnvironment( ctx context.Context, ) (map[string]EnvironmentValue, error)
Parameters

tmux command#

The tmux commands behind ShowEnvironment.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

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
Java no equivalent on Session
C# LibTmux.Session.Environment
C++ no equivalent on Session
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