Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux latest

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
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure
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).

tmux command#

The tmux commands behind detach_all_clients.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Detach every client on the server

Equivalents of Detach every client on the server 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.DetachAllClients
Java no equivalent on Server
C# LibTmux.Server.DetachAllClientsAsync
C++ no equivalent on Server
Swift no equivalent on Server
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#.

Esc

Type to search.

Reference previewOpen reference