Pane
One tmux pane, as one capture saw it.
Source and package
- Qualified name
-
io.github .libtmux. Pane - Package
- io.github.libtmux
- Distribution
- io.github.libtmux:libtmux
- Source
- libtmux/src/main/java/io/github/libtmux/Pane.java
- Other languages
- Perlclass ErlangPowerShellcmdlet Juliastruct Elixirstruct Haskell Common Lispclass PythonRubyLuaTypeScriptRustGoC#C++SwiftKotlinScalaOCamlF#module Clojurefunction
-
Description#
Identity is the server and the pane id. An index is state: panes renumber as neighbours come and go.
A method named for a captured field returns what
#info()holds and does no I/O;#refresh()reads again. Every other method asks tmux now.
Members61#
Parent objects2#
Common operations33#
- capture method This pane's visible content, one element per line.
- split method Splits this pane in half, putting the new one below it.
- kill method Closes this pane.
- respawn method Kills whatever runs here and starts the pane's default command again.
- select method Makes this the active pane of its window.
- resize method Grows this pane by a number of cells in one direction.
- id method The pane's stable id.
- index method The pane's position, which shifts as neighbours come and go.
- breakOut method Moves this pane into a window of its own, leaving tmux to name it.
- retitle method Retitles this pane and returns its replacement capture.
- title method The pane title, which a program running inside it can change.
- active method Whether this was its window's active pane when captured.
- currentCommand method The command tmux reported running here.
- swapWith method Swaps this pane's position with another's.
- clearHistory method Discards this pane's scrollback.
- pasteBuffer method Pastes a named buffer into this pane, as though it had been typed.
- options method This pane's own options.
- joinTo method Moves this pane into another window, splitting it.
- pipeTo method Sends everything this pane prints to a shell command, until
#stopPiping(). - hooks method This pane's own hooks.
- currentPath method The working directory tmux reported for the pane.
- copyMode method Puts this pane into copy mode, where its scrollback can be navigated.
- pid method The process id of the program running in the pane, captured at the time of the read this handle came from.
- refresh method Takes a new capture and returns this pane as it is now.
- sendLine method Sends a line to this pane and presses Enter, which is how a command gets run.
- equals method
- floating method Whether this pane floats, or empty when the running tmux cannot say.
- send method Sends keys to this pane without pressing Enter.
- await method Waits until a condition holds for this pane as tmux reports it, and says why the wait ended.
- awaitText method Waits until this pane's text contains something, and says why the wait ended.
- expand method Expands a tmux format in this pane's context, and answers with what it came to.
- run method Runs a shell command in this pane to its end, and answers with its exit status and output.
- sendKeys method Sends an ordered group of key names to this pane, as tmux resolves them.
Other members26#
- batch method Collects commands fenced to the server incarnation that produced this pane.
- created method Runs a command that reports one new pane, and hands back a handle on it.
- createdFormat method The format a creating command reports its new pane through.
- currentPathText method The working directory tmux reported for the pane, exactly as tmux reported it.
- dead method Whether this pane's process has exited, read fresh rather than from the capture.
- edges method Which sides of its window the pane touches.
- exitMode method Leaves whichever mode this pane is in.
- hashCode method
- identity method Which server incarnation this pane belongs to: its echo record and its input hold.
- info method The fields this capture stored. A later title change is not visible here.
- mode method Which mode this pane is in at this moment, or empty when it is in none.
- noteTyped method Notes text that reached this pane without going through this handle, so a wait discounts its echo the way it discounts text sent through
#sendLiteral(). - Pane method
- paste method Pastes text into this pane as one block, leaving nothing behind on the server.
- position method Where the pane's top-left corner sat in its window when captured, in terminal cells.
- resizeTo method Resizes this pane.
- respawnArgv method
- respawnIn method Restarts the configured pane process in a caller-supplied literal directory, resolved against this process's working directory when relative.
- sendLiteral method Sends an ordered group of strings to this pane as the characters they spell.
- size method How large the pane was when captured, in terminal cells.
- snapshot method
- stopPiping method Stops sending this pane's output anywhere. Doing so twice is not an error.
- through method This pane's captured state, addressed through another view of the same server.
- toString method
- variables method Reads validated tmux variables in this pane's format context.
- watchText method As
Duration), and also returns what the pane showed.
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. |
| TypeScript | pane |
| Rust | pane |
| Go | tmux |
| 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. |