Core Library0.xAPI 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-rs latest

Pane.pipe

Pipe the pane's output to a shell command.

Source and package
Qualified name
libtmux::pane::Pane::pipe
Module
pane
Declared in
Pane
Package
libtmux
Source
crates/libtmux/src/pane.rs
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
pub async fn pipe( &self, command: Option<impl Into<OsString>> ) -> Result<(), Error>

Description#

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-%Y writes 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.

Parameters

tmux command#

The tmux commands behind pipe.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

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
Go tmux.Pane.Pipe
Java io.github.libtmux.Pane.pipeTo
C# LibTmux.Pane.PipeAsync
C++ libtmux::Pane::pipe_to
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#.

Esc

Type to search.

Reference previewOpen reference