Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased LibTmux has not been released. Its API may change during development. This site's structure and URLs may change too.

method libtmux-perl latest

Server.send_text

send_text(pane => Pane|pane_id, text => string|bytes, enter => boolean?).

Source and package
Qualified name
LibTmux::Server::send_text
Module
LibTmux
Declared in
Server
Package
LibTmux
Source
packages/core/lib/LibTmux/Server.pm
sub send_text($self, %args)

Description#

Send literal text/bytes to a LibTmux::Pane, then optionally send Enter. Empty text is permitted. Acceptance does not prove application completion. Use an application-specific observable handshake before relying on output; "capture_pane" reads observed terminal content.

Returns undef after command acceptance. Performs I/O; failures propagate through LibTmux::X. Captured objects are not modified.

$server->send_text(pane => $pane, text => 'hello', enter => true);

Methods#

Parameters

tmux command#

The tmux commands behind send_text.

display-message (daemon identity or target preflight) send-keys

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference