Rust API

pane.Pane.pipe

Rust

Module: pane
Declared in: Pane
Package: libtmux
Source: crates/libtmux/src/pane.rs
Other languages: Python Ruby Lua TypeScript Go Java .NET C++Swift

pipe ( self , command : Option<impl Into<OsString>> ) → Result<(), Error> method [source] ¶ method [source] ¶ pipe

Pipe the pane's output to a shell command.

Passing None stops any pipe already running for this pane.

tmux expands the command as a format, through strftime first: it calls format_expand_time for pipe-pane as it does for display-message. So #{pane_id} resolves, and a % is a time conversion -- `>> log-%Ywrites to a file named for the year. Write%%for a literal%`, and see crate::Server::format for what an undefined conversion does differently on macOS.

Errors

Returns an error when tmux refuses the command.

In other ports Copy a pane's output to a shell command

Python libtmux.Pane.pipe
Ruby LibTmux::Pane#pipe
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript pane.Pane.pipeTo
Go tmux.Pane.Pipe
Java io.github.libtmux.Pane.Pane.pipeTo
.NET LibTmux.Pane.PipeAsync
C++ libtmux::Pane::pipe_to
Swift Server.pipe(_:to:)

0 declared, 0 inherited