Core LibraryalphaAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-cxx latest

Connection.set_pane_output

Stop or resume output for one pane, on a connection that asked for it.

Source and package
Qualified name
libtmux::Connection::set_pane_output
Namespace
libtmux
Declared in
Connection
Package
libtmux-cxx
Source
include/libtmux/control.hpp

Description#

The direction is not symmetrical, because tmux is not: a connection that started without pane_output cannot be made to listen to anything, and muting is the only per-pane control it offers. So this narrows what a listening connection receives; it cannot widen a silent one.

Resuming clears both mute and pause, starting at tmux's current output offset. What a caller sees for output produced while muted differs by tmux version, and is not this library's choice either way:

Before tmux 3.7, muting stops delivery to this connection only. What the pane printed while muted is lost — resuming never replays it.

On tmux 3.7+, muting stops tmux from reading the pane's pty at all. The pane freezes for every attached client and tool, not only this connection, and what it printed while muted arrives as a backlog on resume (measured against raw tmux, both directions).

tmux command#

The tmux commands behind set_pane_output.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference