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.

Go API

method libtmux-go latest

Pane.Pipe

Pipe starts, toggles, or stops piping for the receiver's exact linked pane. tmux expands formats and time formats in Command before running it with sh -c. The library's protection for a final semicolon applies only to tmux's outer command parser; it does not quote or neutralize the child shell.

Source and package
Qualified name
tmux.Pane.Pipe
Package
tmux
Declared in
Pane
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/pane_process.go
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustJavaC#C++Swift Kotlin Scala OCaml F# Clojure

Description#

A nil Command, and an explicit empty Command under tmux semantics, stops the current pipe. Successful return means tmux installed, toggled, or stopped the pipe; it does not report child-shell success or lifetime. Only stderr produces a redacted CommandError. Accepted pipe changes are not rolled back.

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
Rust pane.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