OCaml API

function libtmux-ocaml latest

Client.capture_text

Inclusive ordinary screen rows, using a bounded private file transfer. Qualified local scratch storage must be shared with the daemon.

Source and package

Qualified name: Libtmux_eio.Client.capture_text
Module: Libtmux_eio
Declared in: Client
Package: libtmux-eio
Source: eio/libtmux_eio.mli
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaF#Clojure

val capture_text : ?scratch_dir:string -> t -> Libtmux.Pane.t -> start:int -> end_:int -> (Rendered.t, Libtmux.Error.t) result function libtmux-eio [source] ¶

Public owner: Libtmux_eio

Parameters

tmux command#

The tmux commands behind capture_text.

capture-pane delete-buffer (while the connection remains open) list-buffers save-buffer show-hooks

The C declarations in tmux that implement these commands.

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:)`
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.