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:copy-mode

Enter PANE's tmux copy mode, or EXIT it; return a COMMAND-OUTCOME. PAGE-UP scrolls up on entry and cannot be combined with EXIT. This addresses an existing pane and does not create an interactive terminal frontend. Signals STALE-TARGET or an operational condition.

Source and package
Qualified name
libtmux:copy-mode
Declared in
libtmux
Package
libtmux
Source
src/terminal-operations.lisp
(copy-mode client pane &key exit page-up cancel-token timeout output-limit)

Public owner: libtmux

tmux command#

The tmux commands behind copy-mode.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss copy-mode.

Esc

Type to search.

Reference previewOpen reference