C++ API

method libtmux-cxx latest

Pane.pipe_to

Copy everything this pane prints to a shell command, until told to stop.

Source and package

Qualified name: libtmux::Pane::pipe_to
Namespace: libtmux
Declared in: Pane
Package: libtmux-cxx
Source: include/libtmux/entities.hpp
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustGoJavaC#Swift Kotlin Scala OCaml F# Clojure

[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<void, CommandFailure> pipe_to(std::string_view command) const; method readonly [source] ¶

Description#

The command runs on the tmux server's machine with the pane's output on its standard input.

Starting a second pipe replaces the first: tmux keeps one per pane, so there is nothing to close and nothing to leak.

Parameters

The tmux commands behind pipe_to.

The C declarations in tmux that implement these commands.

Copy a pane's output to a shell command

Equivalents of Copy a pane's output to a shell command in other languages
Language	Equivalent
Python	`libtmux.Pane.pipe`
Ruby	`LibTmux::Pane#pipe`
Erlang	`tmux_pane:pipe/3`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`pane.Pane.pipeTo`
Rust	`pane.Pane.pipe`
Go	`tmux.Pane.Pipe`
Java	`io.github.libtmux.Pane.pipeTo`
C#	`LibTmux.Pane.PipeAsync`
Swift	`Server.pipe(_:to:)`
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Lua, PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.