Core Library0.xAPI Reference

Choose documentation 3

v0.1.1

Current version

v0.1.1
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

class libtmux-ruby v0.1.1

Pane

Base types LibTmux::Entity
Source and package
Qualified name
LibTmux::Pane
Module
LibTmux
Package
libtmux
Source
gems/libtmux/lib/libtmux/entity.rb
Other languages
PowerShellcmdlet Juliastruct Elixirstruct PythonLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaF#module
class LibTmux::Pane

Members27#

Parent objects1#

  • server method Returns the value of attribute server.

Common operations16#

  • capture method Behavior: Pane input and capture.
  • send_keys method Behavior: Pane input and capture.
  • split method Behavior: Creation.
  • respawn method Behavior: Entity mutation.
  • kill method Behavior: Entity removal.
  • select method Behavior: Entity mutation.
  • break_out method Exact tmux 3.7 ignores -n on break-pane and crashes without it, so the name is applied again afterwards. Before 3.6 a sole pane's break prints no ID, so the window is read back from the pane.
  • resize method Behavior: Entity mutation.
  • options method Behavior: Options and hooks.
  • swap method Behavior: Entity mutation.
  • pipe method The shell command and its format expansion are explicitly requested here. only_if_closed follows tmux -o: an existing pipe is closed, not retained.
  • copy_mode method Behavior: Copy mode.
  • hooks method Behavior: Options and hooks.
  • join method Behavior: Entity mutation.
  • move method Behavior: Entity mutation.
  • send_text method Behavior: Pane input and capture.

Other members10#

  • == method Behavior: Live handles.
  • copy_command method Behavior: Copy mode.
  • display method Behavior: Formats.
  • eql? method Behavior: Live handles.
  • hash method Behavior: Live handles.
  • id method Behavior: Live handles.
  • inspect method Behavior: Live handles.
  • paste method Behavior: Pane input and capture.
  • ref method Returns the value of attribute ref.
  • snapshot method Behavior: Snapshot acquisition.

Guides#

Pages that discuss Pane.

In other ports#

A tmux pane

Equivalents of A tmux pane in other languages
Language Equivalent
Python libtmux.Pane
Lua libtmux.Pane
PowerShell LibTmux\Get-TmuxPane This cmdlet reads shared .NET LibTmux.Pane objects. Its -Server, -Session, and -Window parameter sets select the scope.
Julia LibTmux.PaneSnapshot PaneSnapshot holds captured pane data. Actions use its PaneRef; PaneOccurrence adds a window placement in a session.
Elixir LibTmux.Pane Pane is an immutable physical pane observation. It does not send keys or capture text.
TypeScript pane.Pane
Rust pane.Pane
Go tmux.Pane
Java io.github.libtmux.Pane
Kotlin io.github.libtmux.kotlin.Pane
Scala io.github.libtmux.scaladsl.Pane
C# LibTmux.Pane
F# LibTmux.FSharp.Pane This F# module reads captured fields and starts explicit operations on the shared .NET LibTmux.Pane type.
C++ libtmux::Pane
Swift Pane
Esc

Type to search.

Reference previewOpen reference