# Libtmux_unix.Client.capture_text

- **Module:** Libtmux_unix
- **Package:** libtmux-unix
- **Language:** OCaml
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-ocaml/blob/205dfda49742592b479247049d186956e4a4cfe9/unix/libtmux_unix.mli#L284
- **Public owner:** Libtmux_unix
- **Page:** https://libtmux.org/en/ocaml/latest/reference/libtmux_unix-client-capture_text/

```
val capture_text :
  ?cancel:Cancellation.t ->
  ?scratch_dir:string ->
  t ->
  Libtmux.Pane.t ->
  start:int -> end_:int -> (Rendered.t, Libtmux.Error.t) result
```

Capture ordinary rendered screen rows, inclusively, via an owned paste buffer and private file. Reject applicable capture/save hooks. The scratch directory defaults to `/tmp` and must be local storage shared with the daemon. Pending and alternate-screen byte modes are unsupported. This observes an interval and establishes no stream continuity barrier.

## Parameters

- `cancel?` (`Cancellation.t`)
- `scratch_dir?` (`string`)
- `arg1` (`t`)
- `arg2` (`Libtmux.Pane.t`)
- `start` (`int`)
- `end_` (`int`)

## tmux command

The tmux commands behind `capture_text`.

- [`capture-pane`](/en/tmux/latest/manual/capture-pane/)
- [`delete-buffer`](/en/tmux/latest/manual/delete-buffer/) (while the connection remains open)
- [`list-buffers`](/en/tmux/latest/manual/list-buffers/)
- [`save-buffer`](/en/tmux/latest/manual/save-buffer/)
- [`show-hooks`](/en/tmux/latest/manual/show-hooks/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_capture_pane_entry`](/en/tmux/latest/reference/c-variable-cmd_capture_pane_entry/) (attribute)
- [`cmd_capture_pane_exec`](/en/tmux/latest/reference/c-function-cmd-capture-pane-c-cmd_capture_pane_exec/) (function)
- [`cmd_delete_buffer_entry`](/en/tmux/latest/reference/c-variable-cmd_delete_buffer_entry/) (attribute)
- [`cmd_set_buffer_exec`](/en/tmux/latest/reference/c-function-cmd-set-buffer-c-cmd_set_buffer_exec/) (function)
- [`cmd_list_buffers_entry`](/en/tmux/latest/reference/c-variable-cmd_list_buffers_entry/) (attribute)
- [`cmd_list_buffers_exec`](/en/tmux/latest/reference/c-function-cmd-list-buffers-c-cmd_list_buffers_exec/) (function)
- [`cmd_save_buffer_entry`](/en/tmux/latest/reference/c-variable-cmd_save_buffer_entry/) (attribute)
- [`cmd_save_buffer_exec`](/en/tmux/latest/reference/c-function-cmd-save-buffer-c-cmd_save_buffer_exec/) (function)
- [`cmd_show_hooks_entry`](/en/tmux/latest/reference/c-variable-cmd_show_hooks_entry/) (attribute)
- [`cmd_show_options_exec`](/en/tmux/latest/reference/c-function-cmd-show-options-c-cmd_show_options_exec/) (function)

## In other ports

Read a pane’s visible contents

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Pane.capture_pane`](/en/py/latest/reference/libtmux-pane-capture_pane/) (method) |
| Ruby | [`LibTmux::Pane#capture`](/en/ruby/latest/reference/libtmux-pane-capture/) (method) |
| Lua | [`libtmux.Pane:capture`](/en/lua/latest/reference/libtmux-pane-capture/) (method) |
| Erlang | [`tmux_pane:capture/2`](/en/erlang/latest/reference/tmux_pane-capture-2/) (function) |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | [`pane.Pane.capture`](/en/ts/latest/reference/pane-pane-capture/) (method) |
| Rust | [`pane.Pane.capture`](/en/rs/latest/reference/pane-pane-capture/) (method) |
| Go | [`tmux.Pane.Capture`](/en/go/latest/reference/tmux-pane-capture/) (method) |
| Java | [`io.github.libtmux.Pane.capture`](/en/java/latest/reference/io-github-libtmux-pane-pane-capture/) (method) |
| Clojure | [`libtmux.core/capture!`](/en/clojure/latest/reference/libtmux-core-capture/) (function) |
| Kotlin | [`io.github.libtmux.kotlin.Pane.capture`](/en/kotlin/latest/reference/io-github-libtmux-kotlin-pane-capture/) (method) |
| Scala | [`io.github.libtmux.scaladsl.Pane.capture`](/en/scala/latest/reference/io-github-libtmux-scaladsl-pane-capture/) (method) |
| C# | [`LibTmux.Pane.CaptureAsync`](/en/csharp/latest/reference/libtmux-pane-captureasync/) (method) |
| F# | [`LibTmux.FSharp.Pane.capture`](/en/fsharp/latest/reference/libtmux-fsharp-pane-capture/) (function) |
| C++ | [`libtmux::Pane::capture`](/en/cxx/latest/reference/libtmux-pane-capture/) (method) |
| Swift | [`Server.capture(_:includingHistory:)`](/en/swift/latest/reference/server-capture(_-includinghistory-)/) (method) |
| Perl | [`LibTmux::Server::capture_pane`](/en/perl/latest/reference/libtmux-server-capture_pane/) (method). 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.