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.

function libtmux-lisp latest

libtmux:capture-pane-bytes

Read PANE now; return owned output octets and the diagnostic command outcome. START/END accept signed line numbers or :ALL for the corresponding history edge. JOIN-LINES joins wrapped rows; ESCAPE-SEQUENCES retains terminal styles; ESCAPE-CONTROLS asks tmux to render controls as octal; ALTERNATE selects its alternate screen; PENDING-OUTPUT requests tmux's pending input bytes. Tmux owns these capture modes and may reject unavailable combinations. Does not decode or trim bytes. Signals STALE-TARGET or an operational condition with its outcome.

Source and package
Qualified name
libtmux:capture-pane-bytes
Declared in
libtmux
Package
libtmux
Source
src/operations.lisp
(capture-pane-bytes client pane &key start end join-lines escape-sequences escape-controls alternate pending-output cancel-token timeout output-limit)

Public owner: libtmux

tmux command#

The tmux commands behind capture-pane-bytes.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss capture-pane-bytes.

Esc

Type to search.

Reference previewOpen reference