Python API

method libtmux latest

Session.detach_client

Detach every client attached to this session.

Source and package

Qualified name: libtmux.Session.detach_client
Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/session.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure

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

Description#

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

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

Parameters

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

The tmux commands behind detach_client.

The C declarations in tmux that implement these commands.

Detach every client attached to a session

Equivalents of Detach every client attached to a session in other languages
Language	Equivalent
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`session.Session.detach`
Rust	`session.Session.detach_clients`
Go	`tmux.Session.DetachClients`
Java	`io.github.libtmux.Session.detachClients`
C#	`LibTmux.Session.DetachClientAsync`
C++	`libtmux::Session::detach_clients`
Swift	`Server.detachClients(from:)`
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.