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-ruby latest

Pane.pipe

The shell command and its format expansion are explicitly requested here. only_if_closed follows tmux -o: an existing pipe is closed, not retained.

Source and package
Qualified name
LibTmux::Pane#pipe
Module
LibTmux
Declared in
Pane
Package
libtmux
Source
gems/libtmux/lib/libtmux/operations.rb
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Lua TypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
def pipe: ( ?shell_command: ::String?, ?input: bool, ?output: bool, ?only_if_closed: bool, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::CommandResult

Description#

Behavior contract: Pane pipes.

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
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
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