Core Library0.xAPI Reference

Choose documentation 1

latest

Current version

latest
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-raku latest

Model.PaneRef

Value-only command target for a physical pane in one daemon incarnation.

Source and package
Qualified name
LibTmux::Model::PaneRef
Module
LibTmux
Declared in
Model
Package
LibTmux
Source
lib/LibTmux/Model.rakumod
Anonymous class

Description#

Value-only command target for a physical pane in one daemon incarnation.

Members38#

Common operations21#

  • capture method Acquire screen/history bytes with explicit bounds and whitespace options.
  • send-keys method Send native key names, repeating them the requested number of times.
  • split method Create a detached split by default, returning the reported pane ID.
  • kill method Destroy the addressed entity; retained observations remain unchanged.
  • respawn method Restart the target's process; kill must be explicit when replacing a running process.
  • select method Select the exact pane or verified session-relative window placement.
  • resize method Set absolute dimensions or adjust one direction; these forms cannot be mixed.
  • break method Move this pane to a new window in an explicit session, returning the reported window ID.
  • set-title method Set title text through one literal FORMAT expansion; tmux title rules still apply.
  • swap method Swap the two verified pane identities or session-relative window placements.
  • clear-history method Discard scrollback; visible screen contents and application state are unaffected.
  • join method Move this pane into the target's split tree; its scoped ID remains unchanged.
  • pipe method The pipe command deliberately uses tmux's FORMAT and strftime shell-command syntax.
  • copy-mode method Enter copy mode, optionally paging upward or exiting when scrolling to the bottom.
  • inspect method Acquire a fresh graph and require exactly one observed entity with this ID.
  • move method Move this pane beside an explicit pane target without changing its ID.
  • send-prefix method Send the configured primary or secondary prefix key to this pane.
  • command method A bounded, identity-guarded explicit command. Arguments keep tmux semantics.
  • clock-mode method Enter tmux's clock mode for this pane.
  • reset method Reset terminal state and clear history in one tmux queue; failure can leave partial effects.
  • send-text method Send literal bytes as text without appending Enter.

Other members17#

  • capture-pending method Acquire incomplete terminal escape input as bytes, separate from screen capture.
  • copy-command method Dispatch a native copy-mode command with separate argument values.
  • entity method Return the registered entity schema without I/O.
  • float method Convert this tile into a floating pane with explicit dimensions.
  • hooks method Construct a value-only hook facade; its reads and writes are explicit operations.
  • move-floating method Move a floating pane to explicit coordinates in the supported profile.
  • new-floating method Create a floating pane. Modal input ownership requires the modal capability.
  • options method Construct a value-only option facade scoped to this captured identity.
  • reset-terminal method Reset tmux's terminal state for this pane; this does not restart its process.
  • same-entity method Compare scoped identity without acquiring current state.
  • set-input method Enable or disable delivery of keyboard input to this pane.
  • set-z-index method Set a floating pane's nonnegative stacking index.
  • stack method Change a floating pane's relative stacking order using a closed placement name.
  • tile method Convert this floating pane into a tile while preserving its ID.
  • toggle-mark method Toggle the global marked-pane target using this pane.
  • toggle-zoom method Toggle this pane's window zoom state.
  • unmark method Clear the server's marked pane.
Esc

Type to search.

Reference previewOpen reference