pane.Pane

class pane.Pane

classoverload [source] ¶

classoverload [source] ¶

class pane.Pane

One pane on one tmux server, as a handle rather than a copy of it.

Reached from Window.panes , Session.activePane or a split; the constructor throws. The tmux format row the handle was built from reads back through Pane.format , and by tmux's own field names directly on the handle. Those values are a snapshot taken when the handle was made and do not follow the pane — Pane.refreshed takes a new one.

Identity is the socket, the daemon that answered on it, and %n together, because a restarted server issues %0 again to a different pane. Pane.equals asks that question; Pane.sameTmuxIdAs asks the weaker one.

Discussed in Architecture

In other ports A tmux pane

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

Members

• capture method Capture this pane's contents as lines.
• respawn method Restart this pane's command in place.
• kill method Destroy this pane.
• select method Make this pane active in its window.
• breakOut method Move this pane out into a window of its own, in the session it is in.
• sendKeys method Send keys to this pane, following them with Enter unless told not to.
• split method Split this pane and resolve the created pane.
• clearHistory method Discard this pane's scrollback history.
• setTitle method Set this pane's title.
• pasteBuffer method Paste a named buffer into this pane, as if it were typed.
• window method The window placement containing this pane.
• resize method Resize this pane; tmux ignores a dimension its layout cannot honour.
• showOptions method Every option set on this pane itself, not the ones it inherits.
• swapWith method Exchange positions with another pane.
• pipeTo method Send everything this pane writes to a shell command as well as its screen.
• enterCopyMode method Enter this pane's copy mode.
• showHooks method Read hooks set on this pane itself.
• joinTo method Move this pane into another window as a split.
• setOption method Set an option on this pane.
• unsetOption method Remove an option from this pane.
• refreshed method This pane, read again at a new instant.
• setHook method Bind a tmux command to a pane-scoped hook.
• unsetHook method Remove every command bound to a pane-scoped hook.
• server attribute The server this pane belongs to.
• displayMessage method Expand a tmux format string against this pane.
• session method The session containing this pane.
• sendPrefix method Send the configured prefix key to this pane.
• cmd method Run a tmux command this package does not model, addressed at this pane.
• customizeMode method Open tmux's interactive option editor in this pane.
• chooseTree method Open the interactive session and window chooser in this pane.
• chooseBuffer method Open the interactive buffer chooser in this pane.
• findWindow method Search windows interactively from this pane.
• displayPopup method Open a popup over the client showing this pane.
• showResolvedOptions method The option values that govern this pane, own and inherited together.
• displayMenu method Show a menu over the client showing this pane.
• equals method Whether other is this same pane on this same server.
• exitCopyMode method Leave this pane's copy mode.
• killIfWindowUnshared method Destroy this pane only if its window has one placement.
• plan method The same mutations, described instead of run.
• sameTmuxIdAs method Whether other carries the same %n, wherever it came from.
• unzoom method Restore this pane's window to its layout, whatever it was doing before.
• zoom method Make this pane fill its window, whatever it was doing before.
• constructor method
• format property The raw tmux format row, addressed by tmux's own token names.
• paneBrand attribute
• toString method How this handle renders in a log line, a template literal, or an error.