Core LibrarystableAPI Reference

Choose documentation 3

stable

Current version

stable
English

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

Python API

method libtmux stable

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
PowerShell Julia Ruby Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala F#
detach_client ( self, target_client: str | None = None, shell_command: str | None = None, ) → None

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 .

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

tmux command detach-client

In other ports Detach one client
  • PowerShell
    No source-verified PowerShell equivalent is recorded for this operation.
  • Julia
    No source-verified Julia equivalent is recorded for this operation.
  • Ruby
    No source-verified Ruby equivalent is recorded for this operation.
  • Lua
    No source-verified Lua equivalent is recorded for this operation.
  • TypeScript
    no equivalent on Server
  • Rust
    no equivalent on Server
  • Go
  • Java
    no equivalent on Server
  • C#
  • C++
    no equivalent on Server
  • Swift
  • Kotlin
    No source-verified Kotlin equivalent is recorded for this operation.
  • Scala
    No source-verified Scala equivalent is recorded for this operation.
  • F#
    No source-verified F# equivalent is recorded for this operation.
Esc

Type to search.

Reference preview Open reference