Pane.capture
Behavior: Pane input and capture.
Source and package
- def capture: ( ?start: ::Integer | ::String | nil, ?finish: ::Integer | ::String | nil, ?join: bool, ?escapes: bool, ?escape
_bytes : bool, ?preserve_trailing : bool, ?trim_trailing : bool, ?alternate: bool, ?mode_screen : bool, ?pending: bool, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux:: Command Result -
Description#
Behavior contract: Pane input and capture.
Examples#
Send a command to a shell, poll the pane until its output line appears, then capture it. Match a whole output line so the echoed command cannot satisfy the check. Use Ruby 3.3 or newer with Bundler, and tmux 3.3a or newer, on Unix with
/bin/catand/bin/shavailable. In an empty directory, save thisGemfile:source "https://rubygems.org"gem "libtmux", "0.1.2"Save this complete program as
capture.rb. ItsServer.startblock owns a private tmux server and stops it on exit, including after an error. View source# frozen_string_literal: truebegin# docs:begin mainrequire "libtmux"LibTmux::Server.start do |server|created = server.new_session(name: "capture", command: ["/bin/sh"],environment: {"ENV" => "/dev/null"}, receipt: true)pane = created.panepane.send_text("printf '\\nlibtmux capture ready\\n'")pane.send_keys("Enter")deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + 5captured = pane.capture.stdout.lines(chomp: true)until captured.include?("libtmux capture ready")raise "Output did not arrive within five seconds" if Process.clock_gettime(Process::CLOCK_MONOTONIC) > deadlinesleep 0.05captured = pane.capture.stdout.lines(chomp: true)endraise "Expected output is absent from the pane" unless captured.include?("libtmux capture ready")puts "libtmux capture ready"end# docs:end mainrescue StandardError => errorwarn "#{error.class}: #{error.message}"exit 1endInstall the gem and run the program. An operation or cleanup error makes it exit unsuccessfully:
Terminal window $ bundle install && \bundle exec ruby capture.rbExpected output:
libtmux capture ready
tmux command#
The tmux commands behind capture.
tmux C API#
The C declarations in tmux that implement these commands.
Guides#
Pages that discuss capture.
- Mcp
In other ports#
Read a pane’s visible contents
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Lua | libtmux |
| Erlang | tmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | pane |
| Rust | pane |
| Go | tmux |
| Java | io |
| Clojure | libtmux |
| Kotlin | io |
| Scala | io |
| C# | Lib |
| F# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
| Perl | Lib 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.