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.set_environment

Set a local environment value for future pane processes. hidden defaults to false; hidden values remain internal to tmux. Existing processes keep their environment.

Source and package
Qualified name
Libtmux_unix.Client.set_environment
Module
Libtmux_unix
Declared in
Client
Package
libtmux-unix
Source
unix/libtmux_unix.mli
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGo Java C# C++ Swift Kotlin Scala F# Clojure
val set_environment : ?cancel:Cancellation.t -> ?hidden:bool -> t -> Libtmux.Environment.scope -> name:string -> string -> (unit, Libtmux.Error.t) result

Public owner: Libtmux_unix

Parameters

tmux command#

The tmux commands behind set_environment.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Set a variable in the server's environment

Equivalents of Set a variable in the server's environment in other languages
Language Equivalent
Python libtmux.Server.set_environment
Ruby LibTmux::Server#set_environment
Lua libtmux.Server:set_environment
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.setEnvironment
Rust server.Server.set_environment
Go tmux.Server.SetEnvironment
Java no equivalent on Server
C# no equivalent on Server
C++ no equivalent on Server
Swift Server.setEnvironment(_:to:in:)
Perl LibTmux::Server::set_environment Omit session for the global environment. Missing or explicitly unset values remain failures.

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

Set a variable in a session's environment

Equivalents of Set a variable in a session's environment in other languages
Language Equivalent
Python libtmux.Session.set_environment
Ruby LibTmux::Session#set_environment
Lua libtmux.Session:set_environment
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript session.Session.setEnvironment
Rust session.Session.set_environment
Go tmux.Session.SetEnvironment
Java no equivalent on Session
C# no equivalent on Session
C++ no equivalent on Session
Swift Server.setEnvironment(_:to:in:)
Perl LibTmux::Server::set_environment Pass an explicit session ID. Empty text and zero-like text remain values.

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

Esc

Type to search.

Reference previewOpen reference