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.

function libtmux-ocaml latest

Client.capture_environment

Acquire a bounded table through a read-only command process. Its response must identify the bound daemon while the original pidfd remains live. Unsupported external variable names fail decoding; they are not omitted.

Source and package
Qualified name
Libtmux_eio.Client.capture_environment
Module
Libtmux_eio
Declared in
Client
Package
libtmux-eio
Source
eio/libtmux_eio.mli
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGo Java C# C++ Swift Kotlin Scala F# Clojure
val capture_environment : ?hidden:bool -> t -> Libtmux.Environment.scope -> (Libtmux.Environment.t, Libtmux.Error.t) result

Public owner: Libtmux_eio

Parameters

tmux command#

The tmux commands behind capture_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
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
Swift Server.environment(_:)
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
Swift Server.environment(_:)
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