Python API

Up Root

class libtmux latest

Pane

tmux(1) Pane [pane_manual].

Base types ObjOptionsMixinHooksMixin

Source and package

Qualified name: libtmux.Pane
Module: libtmux
Package: libtmux
Source: src/libtmux/pane.py
Other languages: Perlclass ErlangPowerShellcmdlet Juliastruct Elixirstruct Haskell Common Lispclass RubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamlF#module Clojurefunction

class libtmux.Pane class [source] ¶

Description#

Pane instances can send commands directly to a pane, or traverse between linked tmux objects.

Examples#

>>> pane
Pane(%1 Window(@1 1:..., Session($1 ...)))

>>> pane in window.panes
True

>>> pane.window
Window(@1 1:..., Session($1 ...))

>>> pane.session
Session($1 ...)

The pane can be used as a context manager to ensure proper cleanup:

>>> with window.split() as pane:
...     pane.send_keys('echo "Hello"')
...     # Do work with the pane
...     # Pane will be killed automatically when exiting the context

References#

[pane_manual]: tmux 3.7c manual, Windows and panes. "Each window displayed by tmux may be split into one or more panes; each pane takes up a certain area of the display and is a separate terminal." Create a pane with split-window. Upstream source; OpenBSD tmux(1) manual.

Members59#

Parent objects3#

window property Parent window of pane.
session property Parent session of pane.
server: Server attribute

Common operations45#

capture_pane method Capture text from pane.
send_keys method $ tmux send-keys to the pane.
split method Split window and return Pane, by default beneath current pane.
kill method Kill Pane.
respawn method Respawn the pane process via $ tmux respawn-pane.
select method Select pane.
resize method Resize tmux pane.
id property Alias of Pane.pane_id.
index property Alias of Pane.pane_index.
break_pane method Break this pane out into a new window via $ tmux break-pane.
set_title method Set pane title via select-pane -T.
height property Alias of Pane.pane_height.
width property Alias of Pane.pane_width.
title property Alias for pane_title.
swap method Swap this pane with another via $ tmux swap-pane.
clear_history method Clear pane history buffer via $ tmux clear-history.
paste_buffer method Paste a buffer into the pane via $ tmux paste-buffer.
join method Join this pane into another window/pane via $ tmux join-pane.
pipe method Pipe pane output to a shell command via $ tmux pipe-pane.
copy_mode method Enter copy mode via $ tmux copy-mode.
refresh method Refresh pane attributes from tmux.
move method Move this pane to another window via $ tmux move-pane.
at_top property Typed, converted wrapper around Pane.pane_at_top.
at_bottom property Typed, converted wrapper around Pane.pane_at_bottom.
at_left property Typed, converted wrapper around Pane.pane_at_left.
at_right property Typed, converted wrapper around Pane.pane_at_right.
display_message method Display message to pane.
send_prefix method Send the prefix key to the pane via $ tmux send-prefix.
cmd method Execute tmux subcommand within pane context.
set_height method Set pane height.
set_width method Set pane width.
clock_mode method Enter clock mode via $ tmux clock-mode.
customize_mode method Enter customize mode via $ tmux customize-mode.
choose_tree method Enter tree chooser via $ tmux choose-tree.
choose_buffer method Enter buffer chooser via $ tmux choose-buffer.
find_window method Search for a window matching a string via $ tmux find-window.
display_popup method Display a popup overlay via $ tmux display-popup.
choose_client method Enter client chooser via $ tmux choose-client.
clear method Clear pane.
reset method Reset terminal state and clear pane history.
enter method Send carriage return to pane.
display_panes method Show pane numbers via $ tmux display-panes.
from_env method Return the pane this process is running inside of.
from_pane_id method Create Pane from existing pane_id.
new_pane method Create a floating Pane via $ tmux new-pane (tmux 3.7+).

Other members11#

default_hook_scope: OptionScope | None attribute
default_option_scope: OptionScope | None attribute
get method Return key-based lookup. Deprecated by attributes.
resize_pane method Resize pane, deprecated by Pane.resize().
select_pane method Select pane.
split_window method Split window at pane and return newly created Pane.
__enter__ method Enter the context, returning self.
__eq__ method Equal operator for Pane object.
__exit__ method Exit the context, killing the pane if it exists.
__getitem__ method Return item lookup by key. Deprecated in favor of attributes.
__repr__ method Representation of Pane object.

Inherited members198 members#

Reached through libtmux.neo.Obj, libtmux.options.OptionsMixin, libtmux.hooks.HooksMixin.

pane_active attribute inherited
pane_current_command attribute inherited
show_options method inherited Return all options for the target.
set_option method inherited Set option for tmux target.
unset_option method inherited Unset option for tmux target.
show_hooks method inherited Return a dict of hooks for the target.
pane_current_path attribute inherited
show_option method inherited Return option value for the target.
pid attribute inherited
window_id attribute inherited
set_hook method inherited Set hook for tmux target.
unset_hook method inherited Unset hook for tmux target.
pane_dead attribute inherited
session_id attribute inherited
pane_in_mode attribute inherited
run_hook method inherited Run a hook immediately. Useful for testing.
pane_path attribute inherited
set_hooks method inherited Set multiple indexed hooks at once.
show_hook method inherited Return value for a hook.
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
hooks 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_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_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_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_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
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_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_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
__init__ method inherited When not a user (custom) option, scope can be implied.
_refresh method inherited Refresh dataclass fields from a single list-* row.
_show_hook method inherited Return value for the hook.
_show_option method inherited Return option value for the target.
_show_option_raw method inherited Return raw option output for target.
_show_options method inherited Return a dict of options for the target.
_show_options_dict method inherited Return dict of options for the target.
_show_options_raw method inherited Return a dict of options for the target.
_tmux_bin property inherited Resolve tmux_bin from self (Server) or self.server (Session/Window/Pane).

Guides#

Pages that discuss Pane.

Concepts: Server, session, window, pane
Meta: Link to libtmux from Sphinx
Ports: Python workspace internal API
Topics: Architecture
Ownership and cleanup

In other ports#

A tmux pane

Equivalents of A tmux pane in other languages
Language	Equivalent
Ruby	`LibTmux::Pane`
Lua	`libtmux.Pane`
PowerShell	`LibTmux\Get-TmuxPane` This cmdlet reads shared .NET `LibTmux.Pane` objects. Its `-Server`, `-Session`, and `-Window` parameter sets select the scope.
Julia	`LibTmux.PaneSnapshot` `PaneSnapshot` holds captured pane data. Actions use its `PaneRef`; `PaneOccurrence` adds a window placement in a session.
Erlang	`#tmux_model:pane{}`
Elixir	`LibTmux.Pane` `Pane` is an immutable physical pane observation. It does not send keys or capture text.
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp	`libtmux:pane` `pane` is an immutable captured physical pane.
TypeScript	`pane.Pane`
Rust	`pane.Pane`
Go	`tmux.Pane`
Java	`io.github.libtmux.Pane`
Clojure	`libtmux.data/panes` Traverses captured pane maps without I/O. Use keyword lookup for scalar observations and the preserved :tmux/ref for effects.
Kotlin	`io.github.libtmux.kotlin.Pane`
Scala	`io.github.libtmux.scaladsl.Pane`
C#	`LibTmux.Pane`
F#	`LibTmux.FSharp.Pane` This F# module reads captured fields and starts explicit operations on the shared .NET `LibTmux.Pane` type.
C++	`libtmux::Pane`
Swift	`Pane`
OCaml	`Libtmux.Pane.t`
Perl	`LibTmux::Pane` A physical pane retains its captured graph, without retaining transport.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Pane

Description#

Examples#

References#

Members59#

Parent objects3#

Common operations45#

Other members11#

Inherited members198 members#

Guides#

In other ports#

Description#

Examples#

References#

Members59#

Parent objects3#

Common operations45#

Other members11#

Inherited members198 members#

Guides#

In other ports#

Related types#