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.

class libtmux latest

ControlMode

Context manager that spawns a tmux control-mode client.

Source and package
Qualified name
libtmux._internal.control_mode.ControlMode
Module
libtmux._internal.control_mode
Package
libtmux
Source
src/libtmux/_internal/control_mode.py
class libtmux._internal.control_mode.ControlMode

Description#

Creates a real client attached to the session, visible in Server.list_clients(). The client communicates via the tmux control protocol on stdout.

While active, Server.list_clients() will include this client.

Examples#

>>> with ControlMode(server=server, session=session) as ctl:
... clients = server.list_clients()
... assert len(clients) > 0
... assert ctl.client_name != ''

Members9#

Guides#

Pages that discuss ControlMode.

Esc

Type to search.

Reference previewOpen reference