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_all_clients

Detach every client on this server via $ tmux detach-client -a.

Source and package
Qualified name
libtmux.Server.detach_all_clients
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_all_clients ( self, keep_client: str | None = None, shell_command: str | None = None, ) → None

Description#

tmux's -a always preserves one client; when keep_client is omitted, the most-recently-active client survives.

Examples#

>>> with control_mode() as ctl:
... server.detach_all_clients(keep_client=ctl.client_name)
Parameters
  • keep_client (str | None) # – Client to preserve (-t flag). All other clients on the server, regardless of which session they are attached to, are detached.

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

In other ports Detach every client on the server
  • 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
    no equivalent on Server
  • 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