Core LibraryAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

class libtmux-scala latest

Pane

Package io.github.libtmux.scaladsl.cats.Pane io.github.libtmux.scaladsl.cats

A tmux pane with input, output, and layout operations in the effect type F .

View as Markdown

Source and package
Module
io.github.libtmux.scaladsl.cats
Package
io.github.libtmux:libtmux-scala_3
Source
libtmux-scala-cats/src/main/scala/io/github/libtmux/scaladsl/cats/Handles.scala
Other languages
PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlin F#
final class Pane[F[_]]object Pane
class [source]
In other ports A tmux pane

Members54 members#

Parent objects2 members#

  • window method The window link this pane was reached through.
  • server property

Common operations5 members#

  • capture method This pane's visible content, one element per line.
  • sendKeys method Sends an ordered group of key names to this pane, as tmux resolves them.
  • split method Splits this pane in half, putting the new one below it.
  • awaitText method Waits until text appears, or timeout passes first.
  • sendLine method Sends a line to this pane and presses Enter, which is how a command gets run.

Other members47 members#

  • active method Whether this was its window's active pane when captured.
  • asJava method The Java handle this wraps: the one escape hatch, as on every handle.
  • await method Waits until settled holds for this pane as it is now. settled runs on the blocking worker with each fresh capture.
  • batch method An immutable batch plan; each run dispatches a fresh Java Batch through this pane's server's Execution.
  • breakOut method Moves this pane into a window of its own, leaving tmux to name it.
  • clearHistory method Discards this pane's scrollback.
  • copyMode method Puts this pane into copy mode, where its scrollback can be navigated.
  • currentCommand method The command tmux reported running here.
  • currentPath method The working directory tmux reported for the pane.
  • 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.
  • equals method
  • exitMode method Leaves whichever mode this pane is in.
  • expand method Expands a tmux format in this pane's context, and answers with what it came to.
  • floating method Whether this pane floats, or empty when the running tmux cannot say.
  • hashCode method
  • hooks method This pane's own hooks.
  • id method The pane's stable id.
  • index method The pane's position, which shifts as neighbours come and go.
  • info method The fields this capture stored.
  • joinTo method Moves this pane into another window, splitting it.
  • kill method Closes this pane.
  • 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 .
  • options method This pane's own options.
  • paste method Pastes text into this pane as one block, leaving nothing behind on the server.
  • pasteBuffer method Pastes a named buffer into this pane, as though it had been typed.
  • pid method The process id of the program running in the pane, captured at the time of the read this handle came from.
  • pipeTo method Sends everything this pane prints to a shell command, until #stopPiping .
  • position method Where the pane's top-left corner sat in its window when captured, in terminal cells.
  • refresh method Takes a new capture and returns this pane as it is now.
  • resize method Grows this pane by a number of cells in one direction.
  • resizeTo method Resizes this pane.
  • respawn method Kills whatever runs here and starts the pane's default command again.
  • respawnIn method Restarts the configured pane process in a caller-supplied literal directory, resolved against this process's working directory when relative.
  • retitle method Retitles this pane and returns its replacement capture.
  • run method Runs a shell command in this pane to its end, and answers with its exit status and output.
  • select method Makes this the active pane of its window.
  • send method Sends keys to this pane without pressing Enter.
  • 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.
  • stopPiping method Stops sending this pane's output anywhere.
  • swapWith method Swaps this pane's position with another's.
  • title method The pane title, which a program running inside it can change.
  • toString method
  • variables method Reads validated tmux variables in this pane's format context.
Esc

Type to search.