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

Client.suspend

Suspend this client, as if its user pressed the suspend key.

Source and package
Qualified name
libtmux::client::Client::suspend
Module
client
Declared in
Client
Package
libtmux
Source
crates/libtmux/src/client.rs
pub async fn suspend(&self) -> Result<(), Error>

Description#

The handle survives, and deliberately: unlike Self::detach(), this stops the client rather than ending it. Some tmux releases omit a suspended client from Server::clients(); others keep it listed. The client resumes when its process continues with SIGCONT.

Errors

Returns an error when tmux refuses the command. A later Self::refresh() can return Error::ClientSuspended or succeed, depending on whether that tmux release omits the stopped client.

tmux command#

The tmux commands behind suspend.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference