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.ClientRef

A captured client identity with explicit inspection and inherited client commands.

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

Description#

A captured client identity with explicit inspection and inherited client commands.

Members3#

  • entity method Return the registered client schema without I/O.
  • inspect method Acquire a fresh graph and require the observed name, process and creation time.
  • same-entity method Compare captured identities without checking whether the client remains attached.

Inherited members21 members#

Reached through LibTmux::Client::ClientTarget.

  • detach method inherited Request detachment of this exact observed client. Completion is not exit proof.
  • prompt-history method inherited Return raw prompt-history output, without claiming newline-safe entry framing.
  • clear-prompt-history method inherited Clear the daemon's selected prompt history; it is shared across clients.
  • prompt-async method inherited Prompt with explicit tmux template syntax. Commas separate prompts and inputs.
  • refresh method inherited Refresh the display, status, or viewport using one explicit action.
  • switch method inherited Switch session by ID. Updating the session environment is opt-in.
  • find-window method inherited Open the native finder using tmux match/FORMAT syntax, not literal substring data.
  • popup-async method inherited Start an explicitly supplied shell command in a popup; wait asynchronously.
  • confirm-async method inherited Ask confirmation before one Invocation. A refusal is returned as a Result.
  • menu-async method inherited Show a menu. Completion follows tmux's command lifecycle, not rendering proof.
  • lock method inherited Invoke the configured lock command for this client.
  • suspend method inherited Suspend the client's terminal process through tmux.
  • choose method inherited Enter a pane mode shared by every client viewing that pane.
  • clone method inherited Revalidate changed target values; this performs no existence check or I/O.
  • close-popup method inherited Explicitly remove the current popup/overlay, including one left after timeout.
  • display-format method inherited Evaluate explicit FORMAT and strftime syntax in an existing pane context.
  • display-message method inherited Display literal FORMAT/time text; tmux still interprets display styles.
  • display-panes-async method inherited Display pane numbers, with an optional explicit tmux selection template.
  • key-table method inherited Select an existing key table; its name is passed without FORMAT expansion.
  • switch-relative method inherited Switch relative to this client's current/previous session.
  • toggle-read-only method inherited Toggle read-only and ignore-size flags while retaining the observed session.
Esc

Type to search.

Reference previewOpen reference