Core Library0.xAPI Reference

Choose documentation 1

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

PaneRef.capture

Acquire screen/history bytes with explicit bounds and whitespace options.

Source and package
Qualified name
LibTmux::Model::PaneRef.capture
Module
LibTmux::Model
Declared in
PaneRef
Package
LibTmux
Source
lib/LibTmux/Model.rakumod
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamlF#Clojure
method capture(Int :$start, Int :$end, Bool :$history = False, Bool :$join-wrapped = False, Bool :$escape-sequences = False, Bool :$escape-controls = False, Bool :$alternate = False, Bool :$trailing-spaces = False --> Blob:D)

Description#

Acquire screen/history bytes with explicit bounds and whitespace options.

tmux command#

The tmux commands behind capture.

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
Perl LibTmux::Server::capture_pane Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes.

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

Esc

Type to search.

Reference previewOpen reference