libtmux Reference MCP Search
On this page

pane.Pane

View as Markdown

Module
pane
Package
@libtmux/libtmux
Source
packages/libtmux/src/pane.ts
class pane.Pane
classoverload [source]
classoverload [source]
class pane.Pane

Discussed in Architecture

44 declared, 0 inherited

Members

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

Type to search.