Python API

method libtmux latest

Server.detach_client

Detach a specific client via $ tmux detach-client.

Source and package

Qualified name: libtmux.Server.detach_client
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure

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

Description#

Maps to $ tmux detach-client [-t <target_client>]. tmux resolves -t over the global client list (see cmd-find.c); the named client may be attached to any session, so this method lives on Server rather than Session.

>>> with control_mode() as ctl:
...     server.detach_client(target_client=ctl.client_name)

Parameters

target_client (str | None) # – Client name (-t flag). When omitted, tmux falls back to the most-recently-active client.
shell_command (str | None) # – Run a shell command on the detached client after detach (-E flag).

The tmux commands behind detach_client.

The C declarations in tmux that implement these commands.

Detach one client

Equivalents of Detach one client in other languages
Language	Equivalent
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	no equivalent on `Server`
Rust	no equivalent on `Server`
Go	`tmux.Server.DetachClient`
Java	no equivalent on `Server`
C#	`LibTmux.Server.DetachClientAsync`
C++	no equivalent on `Server`
Swift	`Server.detach(_:)`
OCaml	`Libtmux_unix.Client.request_detach_client_at`
Perl	`LibTmux::Server::detach_client` Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes.

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