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

Show a popup over a client, running a command inside it.

Source and package
Qualified name
libtmux::server::Server::display_popup
Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server/interactive.rs
pub async fn display_popup( &self, client: Option<&Client>, command: impl Into<OsString>, ) -> Result<(), Error>

Description#

This needs a client with a terminal, so it fails on a server nothing is attached to.

Unlike Self::command_prompt() and Self::display_menu(), this does not wait for a person -- but it does wait for the command. The popup is opened with -E, so it closes when what runs inside it exits, and this returns then. A command that does not end holds the call until the dispatch timeout does.

Errors

Returns Error::ServerMismatch when the client belongs to another server, or an error when no suitable client exists, when tmux refuses the command, and when the dispatch timeout expires before it exits.

Parameters

tmux command#

The tmux commands behind display_popup.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference