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.

property libtmux latest

Server.clients

Clients attached to this tmux server.

Source and package
Qualified name
libtmux.Server.clients
Module
libtmux
Declared in
Server
Package
libtmux
Source
src/libtmux/server.py
Other languages
Perlmethod Erlang PowerShellcmdlet Juliafunction Elixirfunction Haskell Common Lispfunction Ruby Lua TypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamlfunction F#function Clojure
clients (self) → QueryList[Client]

Description#

Each attached terminal is a separate Client. server.clients returns the typed view; client.client_readonly, client.client_termtype, client.client_session etc. read tmux's client_* format tokens.

Returns an empty QueryList when tmux's list-clients fails for any reason — no running daemon, a missing socket, a permission error, or a subprocess failure. To distinguish "no clients attached" from "tmux unreachable", call Server.is_alive() or Server.raise_if_dead().

Examples#

>>> with control_mode() as ctl:
... names = [c.client_name for c in server.clients]
... ctl.client_name in names
True
Returns

QueryList of Client

tmux command#

The tmux commands behind clients.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

List the server's attached clients

Equivalents of List the server's attached clients in other languages
Language Equivalent
Ruby LibTmux::Server#list_clients
PowerShell LibTmux\Get-TmuxClient Acquires attached clients through -Server and returns shared .NET LibTmux.Client objects.
Julia LibTmux.clients clients reads attached clients from a captured Snapshot without contacting tmux.
Elixir LibTmux.Snapshot.clients/1 Returns a Selection of captured attached clients without contacting tmux.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:clients clients returns fresh attached-client observations from a retained snapshot.
TypeScript server.Server.clients
Rust server.Server.clients
Go tmux.Server.Clients
Java io.github.libtmux.Server.clients
Clojure libtmux.core/clients!
Kotlin io.github.libtmux.kotlin.Server.clients
Scala io.github.libtmux.scaladsl.Server.clients
C# LibTmux.Server.Clients
F# LibTmux.FSharp.Server.clients Builds a deferred client query on the shared .NET LibTmux.Server. Query.list acquires attached clients.
C++ libtmux::Server::clients
Swift Server.clients()
OCaml Libtmux.Snapshot.clients Reads captured attached-client observations, separate from transport Client.t handles.
Perl LibTmux::Snapshot::clients Local captured client membership; Server::clients explicitly acquires a new graph.

No equivalent is recorded in Lua or Erlang.

Esc

Type to search.

Reference previewOpen reference