Python API

libtmux.Session.detach_client

Python

Python
Ruby Unavailable
Lua Unavailable
TypeScript
Rust
Go
Java
.NET
C++
Swift

Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/session.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++Swift

detach_client ( self , shell_command : str | None = None ) → None method [source] ¶ method [source] ¶ detach_client

Detach every client attached to this session.

Maps to $ tmux detach-client -s <session_id> — the only detach-client flag group that is genuinely session-scoped.

Parameters

shell_command ( str | None ) – Run a shell command on the detached client(s) after detach (-E flag).

In other ports Detach every client attached to a session

Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript session.Session.detach
Rust session.Session.detach_clients
Go tmux.Session.DetachClients
Java io.github.libtmux.Session.Session.detachClients
.NET LibTmux.Session.DetachClientAsync
C++ libtmux::Session::detach_clients
Swift Server.detachClients(from:)

Examples

Python TypeScript Rust

>>> with control_mode() as ctl:
...     session.detach_client()

await session.detach();

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("busy").await?;

// Nothing is attached in a headless fixture, so this is a no-op.
session.detach_clients().await?;

guard.shutdown().await?;

0 declared, 0 inherited