On this page

libtmux.Pane

Module: libtmux
Package: libtmux
Source: src/libtmux/pane.py

class libtmux.Pane class [source] ¶ class [source] ¶ class libtmux.Pane

Bases:

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 pane. openbsd manpage for TMUX(1). "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." https://man.openbsd.org/tmux.1#WINDOWS_AND_PANES. Accessed April 1st, 2018.

59 declared, 198 inherited

Members

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

Inherited members

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

active_window_index libtmux.neo.Obj
alternate_saved_x libtmux.neo.Obj
alternate_saved_y libtmux.neo.Obj
bracket_paste_flag libtmux.neo.Obj
buffer_name libtmux.neo.Obj
buffer_sample libtmux.neo.Obj
buffer_size libtmux.neo.Obj
client_activity libtmux.neo.Obj
client_cell_height libtmux.neo.Obj
client_cell_width libtmux.neo.Obj
client_control_mode libtmux.neo.Obj
client_created libtmux.neo.Obj
client_discarded libtmux.neo.Obj
client_flags libtmux.neo.Obj
client_height libtmux.neo.Obj
client_key_table libtmux.neo.Obj
client_last_session libtmux.neo.Obj
client_mode_format libtmux.neo.Obj
client_name libtmux.neo.Obj
client_pid libtmux.neo.Obj
client_prefix libtmux.neo.Obj
client_readonly libtmux.neo.Obj
client_session libtmux.neo.Obj
client_termfeatures libtmux.neo.Obj
client_termname libtmux.neo.Obj
client_termtype libtmux.neo.Obj
client_tty libtmux.neo.Obj
client_uid libtmux.neo.Obj
client_user libtmux.neo.Obj
client_utf8 libtmux.neo.Obj
client_width libtmux.neo.Obj
client_written libtmux.neo.Obj
command_list_alias libtmux.neo.Obj
command_list_name libtmux.neo.Obj
command_list_usage libtmux.neo.Obj
config_files libtmux.neo.Obj
copy_cursor_line libtmux.neo.Obj
copy_cursor_word libtmux.neo.Obj
copy_cursor_x libtmux.neo.Obj
copy_cursor_y libtmux.neo.Obj
current_file libtmux.neo.Obj
cursor_character libtmux.neo.Obj
cursor_flag libtmux.neo.Obj
cursor_x libtmux.neo.Obj
cursor_y libtmux.neo.Obj
history_bytes libtmux.neo.Obj
history_limit libtmux.neo.Obj
history_size libtmux.neo.Obj
hooks libtmux.hooks.HooksMixin
insert_flag libtmux.neo.Obj
keypad_cursor_flag libtmux.neo.Obj
keypad_flag libtmux.neo.Obj
last_window_index libtmux.neo.Obj
line libtmux.neo.Obj
mouse_all_flag libtmux.neo.Obj
mouse_any_flag libtmux.neo.Obj
mouse_button_flag libtmux.neo.Obj
mouse_sgr_flag libtmux.neo.Obj
mouse_standard_flag libtmux.neo.Obj
next_session_id libtmux.neo.Obj
origin_flag libtmux.neo.Obj
pane_active libtmux.neo.Obj
pane_at_bottom libtmux.neo.Obj
pane_at_left libtmux.neo.Obj
pane_at_right libtmux.neo.Obj
pane_at_top libtmux.neo.Obj
pane_bg libtmux.neo.Obj
pane_bottom libtmux.neo.Obj
pane_current_command libtmux.neo.Obj
pane_current_path libtmux.neo.Obj
pane_dead libtmux.neo.Obj
pane_dead_signal libtmux.neo.Obj
pane_dead_status libtmux.neo.Obj
pane_dead_time libtmux.neo.Obj
pane_fg libtmux.neo.Obj
pane_flags libtmux.neo.Obj
pane_floating_flag libtmux.neo.Obj
pane_format libtmux.neo.Obj
pane_height libtmux.neo.Obj
pane_id libtmux.neo.Obj
pane_in_mode libtmux.neo.Obj
pane_index libtmux.neo.Obj
pane_input_off libtmux.neo.Obj
pane_last libtmux.neo.Obj
pane_left libtmux.neo.Obj
pane_marked libtmux.neo.Obj
pane_marked_set libtmux.neo.Obj
pane_mode libtmux.neo.Obj
pane_path libtmux.neo.Obj
pane_pb_progress libtmux.neo.Obj
pane_pb_state libtmux.neo.Obj
pane_pid libtmux.neo.Obj
pane_pipe libtmux.neo.Obj
pane_pipe_pid libtmux.neo.Obj
pane_right libtmux.neo.Obj
pane_search_string libtmux.neo.Obj
pane_start_command libtmux.neo.Obj
pane_start_path libtmux.neo.Obj
pane_synchronized libtmux.neo.Obj
pane_tabs libtmux.neo.Obj
pane_title libtmux.neo.Obj
pane_top libtmux.neo.Obj
pane_tty libtmux.neo.Obj
pane_width libtmux.neo.Obj
pane_x libtmux.neo.Obj
pane_y libtmux.neo.Obj
pane_z libtmux.neo.Obj
pane_zoomed_flag libtmux.neo.Obj
pid libtmux.neo.Obj
scroll_position libtmux.neo.Obj
scroll_region_lower libtmux.neo.Obj
scroll_region_upper libtmux.neo.Obj
search_match libtmux.neo.Obj
selection_end_x libtmux.neo.Obj
selection_end_y libtmux.neo.Obj
selection_start_x libtmux.neo.Obj
selection_start_y libtmux.neo.Obj
session_activity libtmux.neo.Obj
session_alerts libtmux.neo.Obj
session_attached libtmux.neo.Obj
session_attached_list libtmux.neo.Obj
session_created libtmux.neo.Obj
session_format libtmux.neo.Obj
session_group libtmux.neo.Obj
session_group_attached libtmux.neo.Obj
session_group_attached_list libtmux.neo.Obj
session_group_list libtmux.neo.Obj
session_group_many_attached libtmux.neo.Obj
session_group_size libtmux.neo.Obj
session_grouped libtmux.neo.Obj
session_id libtmux.neo.Obj
session_last_attached libtmux.neo.Obj
session_many_attached libtmux.neo.Obj
session_marked libtmux.neo.Obj
session_name libtmux.neo.Obj
session_path libtmux.neo.Obj
session_stack libtmux.neo.Obj
session_windows libtmux.neo.Obj
socket_path libtmux.neo.Obj
start_time libtmux.neo.Obj
synchronized_output_flag libtmux.neo.Obj
uid libtmux.neo.Obj
user libtmux.neo.Obj
version libtmux.neo.Obj
window_active libtmux.neo.Obj
window_active_clients libtmux.neo.Obj
window_active_clients_list libtmux.neo.Obj
window_active_sessions libtmux.neo.Obj
window_active_sessions_list libtmux.neo.Obj
window_activity libtmux.neo.Obj
window_activity_flag libtmux.neo.Obj
window_bell_flag libtmux.neo.Obj
window_bigger libtmux.neo.Obj
window_cell_height libtmux.neo.Obj
window_cell_width libtmux.neo.Obj
window_end_flag libtmux.neo.Obj
window_flags libtmux.neo.Obj
window_format libtmux.neo.Obj
window_height libtmux.neo.Obj
window_id libtmux.neo.Obj
window_index libtmux.neo.Obj
window_last_flag libtmux.neo.Obj
window_layout libtmux.neo.Obj
window_linked libtmux.neo.Obj
window_linked_sessions libtmux.neo.Obj
window_linked_sessions_list libtmux.neo.Obj
window_marked_flag libtmux.neo.Obj
window_name libtmux.neo.Obj
window_offset_x libtmux.neo.Obj
window_offset_y libtmux.neo.Obj
window_panes libtmux.neo.Obj
window_raw_flags libtmux.neo.Obj
window_silence_flag libtmux.neo.Obj
window_stack_index libtmux.neo.Obj
window_start_flag libtmux.neo.Obj
window_visible_layout libtmux.neo.Obj
window_width libtmux.neo.Obj
window_zoomed_flag libtmux.neo.Obj
wrap_flag libtmux.neo.Obj
__init__ libtmux.options.OptionsMixin When not a user (custom) option, scope can be implied.
_refresh libtmux.neo.Obj Refresh dataclass fields from a single list-* row.
_show_hook libtmux.hooks.HooksMixin Return value for the hook.
_show_option libtmux.options.OptionsMixin Return option value for the target.
_show_option_raw libtmux.options.OptionsMixin Return raw option output for target.
_show_options libtmux.options.OptionsMixin Return a dict of options for the target.
_show_options_dict libtmux.options.OptionsMixin Return dict of options for the target.
_show_options_raw libtmux.options.OptionsMixin Return a dict of options for the target.
run_hook libtmux.hooks.HooksMixin Run a hook immediately. Useful for testing.
set_hook libtmux.hooks.HooksMixin Set hook for tmux target.
set_hooks libtmux.hooks.HooksMixin Set multiple indexed hooks at once.
set_option libtmux.options.OptionsMixin Set option for tmux target.
show_hook libtmux.hooks.HooksMixin Return value for a hook.
show_hooks libtmux.hooks.HooksMixin Return a dict of hooks for the target.
show_option libtmux.options.OptionsMixin Return option value for the target.
show_options libtmux.options.OptionsMixin Return all options for the target.
unset_hook libtmux.hooks.HooksMixin Unset hook for tmux target.
unset_option libtmux.options.OptionsMixin Unset option for tmux target.
_tmux_bin libtmux.hooks.HooksMixin Resolve tmux_bin from self (Server) or self.server (Session/Window/Pane).