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.

module libtmux-fsharp latest

Pane

Namespace LibTmux.FSharp.Pane LibTmux.FSharp

Reads captured pane fields and starts explicit pane operations.

View as Markdown

Source and package
Module
LibTmux.FSharp
Package
LibTmux.FSharp
Source
src/LibTmux.FSharp/Hierarchy.fsi
module Pane
module [source]

Discussed in .NET interoperation , Quick start

Members23 members#

Common operations22 members#

  • capture function Captures pane contents using the supplied core request.
  • run function Runs a shell command in the pane and waits for its exit status and output.
  • sendAndWait function Types a line, presses Enter, and waits for a later line to contain the text.
  • sendAndWaitFor function Sends keys as the request describes, then waits as the wait request describes.
  • waitFor function Waits as the request describes: patterns, stop patterns, or any output.
  • waitForText function Waits for a line the pane prints to contain the text.
  • waitUntil function Waits until a condition holds over the rows the pane shows, top to bottom.
  • clearHistory function Clears the pane's scrollback history; what the screen shows stays.
  • findOnScreen function Returns the first visible row showing the text, counted from 1, or None.
  • readSince function Reads what the pane printed since a position, and where this read finished.
  • resize function Resizes the pane as the request says, and returns a handle carrying the state afterwards.
  • respawn function Starts the pane's program again as the request says.
  • sendKeys function Sends text or key names according to the request's literal and Enter settings.
  • sendLine function Types a line into the pane as literal text, then presses Enter.
  • swap function Swaps the pane with another, as the request names it.
  • currentCommand function Reads the captured command name, preserving an empty string.
  • currentPath function Reads the captured working directory, preserving an empty string.
  • kill function Kills the pane and the program in it.
  • pressKey function Presses one key by its tmux name, such as <c>Enter</c>, <c>C-c</c> or <c>Up</c>.
  • select function Makes the pane its window's active pane, and returns a handle carrying the state afterwards.
  • setTitle function Sets the pane's title and returns a handle carrying it.
  • split function Splits the pane and returns the new pane handle.

Other members1 member#

  • sendText function Types text into the pane literally, without pressing Enter.
Esc

Type to search.