Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

Python documentation

libtmux.Server.detach_client

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

View as Markdown

Module
libtmux
Declared in
Server
Package
libtmux
Source
src/libtmux/server.py
Other languages
Ruby Lua TypeScript Rust Go Java .NET C++ Swift
detach_client ( self , target_client : str | None = None , shell_command : str | None = None ) → None
method [source]
method [source]
detach_client

Detach a specific client via $ tmux detach-client.

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 .

Examples

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

In other ports Detach one client

0 declared, 0 inherited

Esc

Type to search.