Pane.capture
LibTmux 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 ) -> ::Lib
Tmux:: Command Result -
Description#
Behavior contract: Pane input and capture.
Examples#
Send a command to a shell, wait for its output notification, then capture the pane. Match a whole output line so the echoed command cannot satisfy the check. Use Ruby 4.0.7, Bundler, Git and tmux 3.2a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:
Terminal window $ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \git -C libtmux-source checkout dcc9f8b5a6970144a9e7d80cd5f381d8f6198372Save this dependency file as Gemfile:
source "https://rubygems.org"gem "libtmux", path: "libtmux-source/gems/libtmux"Save this complete program as capture.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error. View source
# frozen_string_literal: truerequire "libtmux"beginLibTmux::Server.start do |server|created = server.new_session(name: "capture", command: ["/bin/sh"],environment: {"ENV" => "/dev/null"}, receipt: true)pane = created.paneserver.open_control(session: created.entity.ref) do |control|control.exchange("display-message -p ready", timeout: 1)output = control.subscribe(pane_id: pane.id, max_bytes: 8192, max_events: 32)pane.send_text("printf '\\nlibtmux capture ready\\n'")pane.send_keys("Enter")deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + 5bytes = "".buntil bytes.lines(chomp: true).include?("libtmux capture ready")remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)raise "Output did not arrive within five seconds" unless remaining.positive?bytes << output.next(timeout: remaining).dataendcaptured = pane.capture.stdout.lines(chomp: true)raise "Expected output is absent from the pane" unless captured.include?("libtmux capture ready")puts "libtmux capture ready"endendrescue StandardError => errorwarn "#{error.class}: #{error.message}"exit 1endInstall the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:
Terminal window $ bundle config set --local path vendor/bundle && \bundle install --jobs 2 && \bundle exec ruby capture.rbExpected output:
libtmux capture readytmux command
capture-paneIn other ports Read a pane’s visible contents
- PowerShell No source-verified PowerShell equivalent is recorded for this operation.
- Julia No source-verified Julia equivalent is recorded for this operation.
- Python
- Lua
- TypeScript
- Rust
- Go
- Java
- C#
- C++
- Swift
- Kotlin
- Scala
- F#
- PowerShell