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:pipe-pane

Configure PANE's tmux-owned pipe and return a COMMAND-OUTCOME. SHELL-COMMAND is shell source, literal to tmux by default; FORMAT-P explicitly enables tmux format and time expansion before shell execution. DIRECTION is :OUTPUT (pane to shell), :INPUT (shell to pane), or :BOTH. Omit SHELL-COMMAND, or pass an empty string, to close the pipe. TOGGLE closes an existing pipe without starting its replacement. Replacing a pipe closes the previous one. Completion acknowledges configuration, not shell startup, success or output consumption. The daemon owns the pipe child; closing CLIENT leaves it running. Literal commands exceeding tmux's time-format capacity fail before I/O. Signals STALE-TARGET or an operational condition; never retries configuration.

Source and package
Qualified name
libtmux:pipe-pane
Declared in
libtmux
Package
libtmux
Source
src/process-operations.lisp
(pipe-pane client pane &key shell-command format-p (direction :output) toggle cancel-token timeout output-limit)

Public owner: libtmux

tmux command#

The tmux commands behind pipe-pane.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss pipe-pane.

Esc

Type to search.

Reference previewOpen reference