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

Session.display

Show a message on the clients viewing this session.

Source and package
Qualified name
libtmux::session::Session::display
Module
session
Declared in
Session
Package
libtmux
Source
crates/libtmux/src/session.rs
pub async fn display(&self, message: &str) -> Result< (), Error >

Description#

The showing half of tmux's display-message. Nothing is returned because nothing is read: use Self::format() to get text back. Succeeds when nobody is watching, having shown it to nobody. Like Self::format(), this interprets the message as a tmux format; command and recursive formats can run shell commands.

Errors

Returns an error when tmux cannot be reached or refuses the message.

Parameters

tmux command#

The tmux commands behind display.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference