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

Server.hide_environment

Hide a variable from processes tmux starts.

Source and package
Qualified name
libtmux::server::Server::hide_environment
Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server/settings.rs
pub async fn hide_environment(&self, name: &str) -> Result< (), Error >

Description#

Different from Self::unset_environment(), which deletes the server's own entry and lets whatever tmux was started with show through. This keeps an entry and marks it, so a process started afterwards is handed an environment with the name absent even though the tmux server was started with one. It is what EnvironmentEntry::Removed reports.

Errors

Returns an error when tmux rejects the name.

Parameters

tmux command#

The tmux commands behind hide_environment.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference