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

Client.ClientTarget

A value-only client target. No subprocess or connection is retained.

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

Description#

A value-only client target. No subprocess or connection is retained.

Members26#

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

Type to search.

Reference previewOpen reference