libtmux._internal.control_mode.ControlMode

class libtmux._internal.control_mode.ControlMode

class [source] ¶

class [source] ¶

class libtmux._internal.control_mode.ControlMode

Context manager that spawns a tmux control-mode client.

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

Copy

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

Discussed in Control mode vs one-shot

Members

• _proc attribute
• _write_fd attribute
• client_name attribute
• server attribute
• session attribute
• stdout attribute
• __enter__ method Spawn control-mode client and wait for registration.
• __exit__ method Terminate control-mode client.
• __init__ method