Python API

libtmux.Pane.pipe

Python

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

pipe ( self , command : str | None = None , output_only : bool | None = None , input_only : bool | None = None , toggle : bool | None = None ) → None method [source] ¶ method [source] ¶ pipe

Pipe pane output to a shell command via $ tmux pipe-pane.

Parameters

command ( str | None ) – Shell command to pipe to. If None, stops piping.
output_only ( bool | None ) – Only pipe output from the pane (-O flag).
input_only ( bool | None ) – Only pipe input to the pane (-I flag).
toggle ( bool | None ) – Toggle piping on/off (-o flag).

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

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

Examples

Python TypeScript

>>> pane.pipe('cat >> /tmp/output.txt')

Stop piping:

>>> pane.pipe()

await pane.pipeTo("cat >> /tmp/build.log");

0 declared, 0 inherited