Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased LibTmux has not been released. Its API may change during development. This site's structure and URLs may change too.

method libtmux-perl latest

Server.capture_pane

capture_pane(pane => Pane|pane_id, start => integer?, end => integer?).

Source and package
Qualified name
LibTmux::Server::capture_pane
Module
LibTmux
Declared in
Server
Package
LibTmux
Source
packages/core/lib/LibTmux/Server.pm
Other languages
Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamlF#Clojure
sub capture_pane($self, %args)

Description#

Read a LibTmux::Pane and return raw terminal octets, including tmux's final newline. Optional start/end select native history rows; no UTF-8 replacement is performed. This I/O reads current observed content without waiting for application work. Command/transport failures propagate through LibTmux::X.

my $bytes = $server->capture_pane(pane => $pane, start => -20);

Methods#

Parameters

tmux command#

The tmux commands behind capture_pane.

capture-pane display-message (daemon identity or target preflight)

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Read a pane’s visible contents

Equivalents of Read a pane’s visible contents in other languages
Language Equivalent
Python libtmux.Pane.capture_pane
Ruby LibTmux::Pane#capture
Lua libtmux.Pane:capture
Erlang tmux_pane:capture/2
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.capture
Rust pane.Pane.capture
Go tmux.Pane.Capture
Java io.github.libtmux.Pane.capture
Clojure libtmux.core/capture!
Kotlin io.github.libtmux.kotlin.Pane.capture
Scala io.github.libtmux.scaladsl.Pane.capture
C# LibTmux.Pane.CaptureAsync
F# LibTmux.FSharp.Pane.capture
C++ libtmux::Pane::capture
Swift Server.capture(_:includingHistory:)
OCaml Libtmux_unix.Client.capture_text

No equivalent is recorded in PowerShell, Julia, Elixir or Common Lisp.

Esc

Type to search.

Reference previewOpen reference