Pane
One pane on one tmux server, as a handle rather than a copy of it.
Source and package
-
Description#
Reached from
Window.panes(),Session.activePane()or a split; the constructor throws. The tmux format row the handle was built from reads back throughPane.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
%ntogether, because a restarted server issues%0again to a different pane.Pane.equals()asks that question;Pane.sameTmuxIdAs()asks the weaker one.
Members49#
Parent objects3#
Common operations42#
- capture method Capture this pane's contents as lines.
- 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.
- kill method Destroy this pane.
- respawn method Restart this pane's command in place.
- select method Make this pane active in its window.
- resize method Resize this pane; tmux ignores a dimension its layout cannot honour.
- breakOut method Move this pane out into a window of its own, in the session it is in.
- setTitle method Set this pane's title.
- swapWith method Exchange positions with another pane.
- clearHistory method Discard this pane's scrollback history.
- pasteBuffer method Paste a named buffer into this pane, as if it were typed.
- showOptions method Every option set on this pane itself, not the ones it inherits.
- joinTo method Move this pane into another window as a split.
- pipeTo method Send everything this pane writes to a shell command as well as its screen.
- setOption method Set an option on this pane.
- unsetOption method Remove an option from this pane.
- showHooks method Read hooks set on this pane itself.
- enterCopyMode method Enter this pane's copy mode.
- setHook method Bind a tmux command to a pane-scoped hook.
- unsetHook method Remove every command bound to a pane-scoped hook.
- refreshed method This pane, read again at a new instant.
- displayMessage method Expand a tmux format string against 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
otheris 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
othercarries the same%n, wherever it came from. - unzoom method Restore this pane's window to its layout, whatever it was doing before.
- waitForCommand method Resolve with the exit status of the next command this pane's shell finishes.
- waitForExit method Resolve with how this pane's program ended, whoever started it.
- waitForText method Resolve with the first line of this pane's screen that
patternmatches: a substring, or a regular expression tested against each line. A line the pane's width wrapped is one line here, matched and returned whole, so the result can be wider than the pane. - zoom method Make this pane fill its window, whatever it was doing before.
Other members4#
Guides#
Pages that discuss Pane.
- Concepts
- Topics
In other ports#
A tmux pane
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Lua | libtmux |
| PowerShell | Lib This cmdlet reads shared .NET LibTmux.Pane objects. Its -Server, -Session, and -Window parameter sets select the scope. |
| Julia | Lib PaneSnapshot holds captured pane data. Actions use its PaneRef; PaneOccurrence adds a window placement in a session. |
| Erlang | #tmux |
| Elixir | Lib 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 is an immutable captured physical pane. |
| Rust | pane |
| Go | tmux |
| Java | io |
| Clojure | libtmux Traverses captured pane maps without I/O. Use keyword lookup for scalar observations and the preserved :tmux/ref for effects. |
| Kotlin | io |
| Scala | io |
| C# | Lib |
| F# | Lib This F# module reads captured fields and starts explicit operations on the shared .NET LibTmux.Pane type. |
| C++ | libtmux:: |
| Swift | Pane |
| OCaml | Libtmux |
| Perl | Lib A physical pane retains its captured graph, without retaining transport. |