Python API

Up Root

class libtmux latest

Client

tmux(1) Client [client_manual].

Base types Obj

Source and package

Qualified name: libtmux.Client
Module: libtmux
Package: libtmux
Source: src/libtmux/client.py

class libtmux.Client class [source] ¶

Description#

A tmux client is an attached terminal. The same tmux server can have multiple clients attached simultaneously (e.g. $ tmux attach from several terminals) and each receives its own view of the active session, window, and pane.

Examples#

>>> with control_mode() as ctl:
...     attached = [
...         c
...         for c in server.clients
...         if c.client_name == ctl.client_name
...     ]
>>> bool(attached)
True

>>> with control_mode() as ctl:
...     client = server.clients.get(client_name=ctl.client_name)
...     client.client_readonly in {"0", "1"}
True

References#

[client_manual]: tmux 3.7c manual, Clients and sessions. "Clients are attached to sessions to interact with them..." attach-session attaches a terminal. switch-client selects its session or key table. show-messages shows server messages or information. Upstream source; OpenBSD tmux(1) manual.

Warning

client_session, session_id, window_id and pane_id are snapshots of the client's currently attached view at the moment this object was read — not stable identity for the client. When the client switches sessions via switch-client, moves focus via select-window / select-pane, or detaches, these fields go stale until refresh() re-reads them from list-clients. The client_name (tty path on Unix) is the client's stable identity.

Prefer attached_session, attached_window, and attached_pane when you need the client's current attachment. Each property re-reads tmux before returning, so the Session / Window / Pane you get back reflects where the client is attached now, not where it was when this Client was constructed. If tmux no longer reports this client_name through list-clients, these properties return None.

attached_pane follows the attached session's current window. That can differ from the per-client active pane set by select-pane -P; see attached_pane for the exact behavior. Each property re-reads tmux on every access.

Members7#

Parent objects1#

server: Server attribute

Common operations1#

attached_session property Return the Session this client is currently attached to.

Other members5#

attached_pane property Return the Pane this client is currently viewing.
attached_window property Return the Window this client is currently viewing.
from_client_name method Create Client from an existing client_name.
refresh method Refresh client attributes from tmux.
_resolve_attached method Resolve live attachment with a single list-clients refresh.

Inherited members179 members#

Reached through libtmux.neo.Obj.

active_window_index attribute inherited
alternate_saved_x attribute inherited
alternate_saved_y attribute inherited
bracket_paste_flag attribute inherited
buffer_name attribute inherited
buffer_sample attribute inherited
buffer_size attribute inherited
client_activity attribute inherited
client_cell_height attribute inherited
client_cell_width attribute inherited
client_control_mode attribute inherited
client_created attribute inherited
client_discarded attribute inherited
client_flags attribute inherited
client_height attribute inherited
client_key_table attribute inherited
client_last_session attribute inherited
client_mode_format attribute inherited
client_name attribute inherited
client_pid attribute inherited
client_prefix attribute inherited
client_readonly attribute inherited
client_session attribute inherited
client_termfeatures attribute inherited
client_termname attribute inherited
client_termtype attribute inherited
client_tty attribute inherited
client_uid attribute inherited
client_user attribute inherited
client_utf8 attribute inherited
client_width attribute inherited
client_written attribute inherited
command_list_alias attribute inherited
command_list_name attribute inherited
command_list_usage attribute inherited
config_files attribute inherited
copy_cursor_line attribute inherited
copy_cursor_word attribute inherited
copy_cursor_x attribute inherited
copy_cursor_y attribute inherited
current_file attribute inherited
cursor_character attribute inherited
cursor_flag attribute inherited
cursor_x attribute inherited
cursor_y attribute inherited
history_bytes attribute inherited
history_limit attribute inherited
history_size attribute inherited
insert_flag attribute inherited
keypad_cursor_flag attribute inherited
keypad_flag attribute inherited
last_window_index attribute inherited
line attribute inherited
mouse_all_flag attribute inherited
mouse_any_flag attribute inherited
mouse_button_flag attribute inherited
mouse_sgr_flag attribute inherited
mouse_standard_flag attribute inherited
next_session_id attribute inherited
origin_flag attribute inherited
pane_active attribute inherited
pane_at_bottom attribute inherited
pane_at_left attribute inherited
pane_at_right attribute inherited
pane_at_top attribute inherited
pane_bg attribute inherited
pane_bottom attribute inherited
pane_current_command attribute inherited
pane_current_path attribute inherited
pane_dead attribute inherited
pane_dead_signal attribute inherited
pane_dead_status attribute inherited
pane_dead_time attribute inherited
pane_fg attribute inherited
pane_flags attribute inherited
pane_floating_flag attribute inherited
pane_format attribute inherited
pane_height attribute inherited
pane_id attribute inherited
pane_in_mode attribute inherited
pane_index attribute inherited
pane_input_off attribute inherited
pane_last attribute inherited
pane_left attribute inherited
pane_marked attribute inherited
pane_marked_set attribute inherited
pane_mode attribute inherited
pane_path attribute inherited
pane_pb_progress attribute inherited
pane_pb_state attribute inherited
pane_pid attribute inherited
pane_pipe attribute inherited
pane_pipe_pid attribute inherited
pane_right attribute inherited
pane_search_string attribute inherited
pane_start_command attribute inherited
pane_start_path attribute inherited
pane_synchronized attribute inherited
pane_tabs attribute inherited
pane_title attribute inherited
pane_top attribute inherited
pane_tty attribute inherited
pane_width attribute inherited
pane_x attribute inherited
pane_y attribute inherited
pane_z attribute inherited
pane_zoomed_flag attribute inherited
pid attribute inherited
scroll_position attribute inherited
scroll_region_lower attribute inherited
scroll_region_upper attribute inherited
search_match attribute inherited
selection_end_x attribute inherited
selection_end_y attribute inherited
selection_start_x attribute inherited
selection_start_y attribute inherited
session_activity attribute inherited
session_alerts attribute inherited
session_attached attribute inherited
session_attached_list attribute inherited
session_created attribute inherited
session_format attribute inherited
session_group attribute inherited
session_group_attached attribute inherited
session_group_attached_list attribute inherited
session_group_list attribute inherited
session_group_many_attached attribute inherited
session_group_size attribute inherited
session_grouped attribute inherited
session_id attribute inherited
session_last_attached attribute inherited
session_many_attached attribute inherited
session_marked attribute inherited
session_name attribute inherited
session_path attribute inherited
session_stack attribute inherited
session_windows attribute inherited
socket_path attribute inherited
start_time attribute inherited
synchronized_output_flag attribute inherited
uid attribute inherited
user attribute inherited
version attribute inherited
window_active attribute inherited
window_active_clients attribute inherited
window_active_clients_list attribute inherited
window_active_sessions attribute inherited
window_active_sessions_list attribute inherited
window_activity attribute inherited
window_activity_flag attribute inherited
window_bell_flag attribute inherited
window_bigger attribute inherited
window_cell_height attribute inherited
window_cell_width attribute inherited
window_end_flag attribute inherited
window_flags attribute inherited
window_format attribute inherited
window_height attribute inherited
window_id attribute inherited
window_index attribute inherited
window_last_flag attribute inherited
window_layout attribute inherited
window_linked attribute inherited
window_linked_sessions attribute inherited
window_linked_sessions_list attribute inherited
window_marked_flag attribute inherited
window_name attribute inherited
window_offset_x attribute inherited
window_offset_y attribute inherited
window_panes attribute inherited
window_raw_flags attribute inherited
window_silence_flag attribute inherited
window_stack_index attribute inherited
window_start_flag attribute inherited
window_visible_layout attribute inherited
window_width attribute inherited
window_zoomed_flag attribute inherited
wrap_flag attribute inherited
_refresh method inherited Refresh dataclass fields from a single list-* row.

Guides#

Pages that discuss Client.

Concepts: Server, session, window, pane
Topics: Architecture

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Client

Description#

Examples#

References#

Members7#

Parent objects1#

Common operations1#

Other members5#

Inherited members179 members#

Guides#

Description#

Examples#

References#

Members7#

Parent objects1#

Common operations1#

Other members5#

Inherited members179 members#

Guides#

Related types#