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

Suspend a client via $ tmux suspend-client.

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

Description#

Requires an attached client.

Examples#

>>> with control_mode() as ctl:
... server.suspend_client()
Parameters

tmux command#

The tmux commands behind suspend_client.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Suspend one client

Equivalents of Suspend one client 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.SuspendClient
Java no equivalent on Server
C# LibTmux.Server.SuspendClientAsync
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