Core LibraryAPI Reference

Choose documentation 3

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

function LibTmux.jl latest

send_keys

Module LibTmux.send_keys LibTmux
Source and package
Module
LibTmux
Package
LibTmux
Source
src/pane_io.jl

Methods#

send_keys( connection::LibTmux.ControlConnection, pane::LibTmux.PaneRef, keys::AbstractString...; literal, kwargs... )[source]#

Send valid UTF-8 key arguments to an exact pane over its pinned connection. literal=true disables tmux key lookup. No Enter or format expansion is added. Control bytes in key data are encoded as tmux parser escapes and never become command separators. Completion means tmux accepted the keys, not that a pane application processed them. Returns ControlResult after the completion fence.

send_keys(connection::ControlConnection, pane::PaneRef, keys...; literal=false, kwargs...)

send_keys( server::LibTmux.Server, pane::LibTmux.PaneRef, keys::AbstractString...; literal, kwargs... )[source]#

Send explicit tmux key arguments to an exact pane. Named tokens such as Enter and C-c use tmux's normal key lookup; unrecognized tokens are text. literal=true disables key lookup. No Enter, separator or format expansion is added. Invalid UTF-8 raises InvalidUTF8Error before submission. Large text and binary data belong in paste_text or paste_bytes .

send_keys(server, pane, keys...; literal=false, kwargs...)
Esc

Type to search.

Reference preview Open reference