Ruby

Choose a port 16

Scripting & web

PythonNo matching page

LuaNo matching page

JuliaNo matching page

TypeScriptNo matching page

Compiled & native

RustNo matching page

GoNo matching page

C++No matching page

SwiftNo matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

.NET

C#No matching page

F#No matching page

PowerShellNo matching page

BEAM

ElixirNo matching page

tmux

GitHub RubyGems

Packages

Packages and source 9

Source

libtmuxgems/libtmux libtmux-rubylibtmux/libtmux-ruby libtmux-asyncgems/libtmux-async libtmux-mcpgems/libtmux-mcp libtmux-workspacegems/libtmux-workspace

Packages

libtmuxRubyGems libtmux-asyncRubyGems libtmux-mcpRubyGems libtmux-workspaceRubyGems

Ruby · libtmux/libtmux-ruby

Auto Light Dark

Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Topics Examples CLI Manual API Reference

concept Working example; may change without notice. Read more

v0.1.1

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Ruby API

method libtmux-ruby v0.1.1

Server.snapshot

Behavior: Snapshot acquisition.

Source and package

Qualified name: LibTmux::Async::Server#snapshot
Module: LibTmux::Async
Declared in: Server
Package: libtmux-async
Source: gems/libtmux/lib/libtmux/server.rb

def snapshot: ( ?timeout: ::Numeric, ?cancel: untyped, ?clients: bool, ?max_bytes: ::Integer, ?max_rows: ::Integer, ?max_field_bytes: ::Integer ) -> ::LibTmux::Snapshot method libtmux-async [source] ¶

Public owner: LibTmux::Server#snapshot

Description#

Behavior contract: Snapshot acquisition.

Parameters

timeout (::Numeric) #
cancel (untyped) #
clients (bool) #
max_bytes (::Integer) #
max_rows (::Integer) #
max_field_bytes (::Integer) #

tmux command#

The tmux commands behind snapshot.

list-clients list-panes -a server scope, cmd_list_panes_server list-sessions list-windows -a server scope, cmd_list_windows_exec

tmux C API#

The C declarations in tmux that implement these commands.

cmd_list_clients_entry cmd_list_clients_exec cmd_list_panes_entry cmd_list_panes_server cmd_list_sessions_entry cmd_list_sessions_exec cmd_list_windows_entry cmd_list_windows_exec

Guides#

Pages that discuss snapshot.

Server bindings

Reference preview