libtmux::Pane

class libtmux::Pane

class [source] ¶

class [source] ¶

class libtmux::Pane

Bases:

• libtmux::detail::Row

One pane, as one listing saw it.

The narrowest thing tmux addresses, and the only one that owns a process: pid is the command tmux started, not the shell's children, so a pane running a program under a shell reports the shell.

Reads its own fields without touching tmux, on the same terms as Session .

Discussed in Architecture , Context managers , Format-token fields , Options and hooks , Traversal

In other ports A tmux pane

• Python libtmux.Pane
• Ruby LibTmux::Pane
• Lua libtmux.Pane
• TypeScript pane.Pane
• Rust pane.Pane
• Go tmux.Pane
• Java io.github.libtmux.Pane.Pane
• .NET LibTmux.Pane
• Swift Pane

Members

• capture method The visible contents, as tmux printed them.
• respawn method Start the pane's command again.
• kill method
• select method
• break_out method Take this pane out into a window of its own, which is returned.
• send_text method Literal text, never interpreted as key names or formats, and never followed by a newline the caller did not ask for.
• clear_history method
• set_title method Name this pane.
• paste method Deliver a buffer's text to this pane, as if it had been typed.
• window method
• options method Pane options, the narrowest scope tmux has, and the end of an inheritance chain that runs pane, window, session, global.
• id method
• index method
• swap_with method
• pipe_to method Copy everything this pane prints to a shell command, until told to stop.
• enter_copy_mode method Put this pane into copy mode, where its contents can be scrolled and selected rather than typed into.
• height method
• width method
• title method
• active method
• command method What is running in the pane now, which is not what started it.
• join method Move this pane into another window, splitting it.
• set_option method
• unset_option method
• window_id method
• refresh method
• option method
• at_top method
• at_bottom method
• at_left method
• at_right method
• show_message method Show a message to the clients watching this pane's session, expanded against this pane.
• pid method
• session method
• tty method
• session_id method
• set_height method
• set_width method
• dead method A pane whose program exited while remain-on-exit kept it on screen.
• in_mode method Copy mode and its relatives, in which sent keys move the cursor rather than reaching the program.
• path method
• expand method Ask tmux to expand a format against this pane.
• exit_status method What the pane's process exited with, once it has.
• kFields attribute
• kNoun attribute
• kSessionNameField attribute
• leave_mode method Leave whatever mode the pane is in.
• left method Position within the window, in cells from its top-left corner — the geometry select_layout 's saved arrangement places panes at.
• Pane method
• piping method Whether this pane's output is currently being copied to a command.
• send_key method
• send_line method The text and then Enter, as one tmux invocation.
• session_name method The owning psmux route carried by Windows live snapshots.
• split method Split this exact pane rather than whichever pane in its window happens to be active.
• stop_piping method Stop copying. Harmless on a pane that was not piping.
• toggle_zoom method Toggle whether this pane's window is zoomed onto it — the whole window given over to one pane, full size.
• top method Its counterpart along the other axis.
• wait_for_text method