Ruby API

Up Root

method libtmux-ruby latest

Server.list_panes

Behavior: Live acquisition.

Source and package

Qualified name: LibTmux::Server#list_panes
Module: LibTmux
Declared in: Server
Package: libtmux
Source: gems/libtmux/lib/libtmux/server.rb
Other languages: Perlmethod Erlangfunction PowerShellcmdlet Juliafunction Elixirfunction Haskell Common Lispfunction PythonLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamlF#function Clojurefunction

def list_panes: ( ?timeout: ::Numeric, ?cancel: untyped ) -> ::Array[::LibTmux::Pane] method libtmux [source] ¶

Description#

Behavior contract: Live acquisition.

Examples#

List panes across the server, within one session, and within one window. Use Ruby 3.3 or newer with Bundler, and tmux 3.3a or newer, on Unix with /bin/cat and /bin/sh available. In an empty directory, save this Gemfile:

source "https://rubygems.org"

gem "libtmux", "0.1.2"

Save this complete program as list_panes.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

require "libtmux"

begin
  LibTmux::Server.start do |server|
    work = server.new_session(name: "work", command: ["/bin/cat"], receipt: true)
    work.pane.split(direction: :horizontal, command: ["/bin/cat"])
    server.new_session(name: "other", command: ["/bin/cat"])
    puts "server panes: #{server.list_panes.length}"
    puts "work panes: #{work.entity.list_panes.length}"
    puts "window panes: #{work.window.list_panes.length}"
  end
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the gem and run the program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle install && \
  bundle exec ruby list_panes.rb

Expected output:

server panes: 3
work panes: 2
window panes: 2

Parameters

timeout (::Numeric) #
cancel (untyped) #

tmux command#

The tmux commands behind list_panes.

list-panes -a server scope, cmd_list_panes_server

tmux C API#

The C declarations in tmux that implement these commands.

cmd_list_panes_entry cmd_list_panes_server

Guides#

Pages that discuss list_panes.

Server bindings

In other ports#

List the server's panes

Equivalents of List the server's panes in other languages
Language	Equivalent
Python	`libtmux.Server.panes`
Lua	`libtmux.Snapshot.panes`
PowerShell	`LibTmux\Get-TmuxPane` Use the `-Server` parameter set to acquire panes across the server.
Julia	`LibTmux.panes` `panes` with a `Snapshot` reads every captured physical pane. Use `paneoccurrences` for session placements.
Erlang	`tmux_snapshot:panes/1` Returns unique captured physical panes without tmux I/O.
Elixir	`LibTmux.Snapshot.panes/1` Returns a `Selection` of every captured physical pane without contacting tmux.
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp	`libtmux:panes` `panes` on a snapshot returns captured physical panes once each.
TypeScript	`server.Server.panes`
Rust	`server.Server.panes`
Go	`tmux.Server.Panes`
Java	`io.github.libtmux.Server.panes`
Clojure	`libtmux.core/panes!` Acquires a new graph and returns its pane occurrences.
Kotlin	`io.github.libtmux.kotlin.Server.panes`
Scala	`io.github.libtmux.scaladsl.Server.panes`
C#	`LibTmux.Server.Panes`
F#	`LibTmux.FSharp.Server.panes` Builds a deferred pane query on the shared .NET `LibTmux.Server`. `Query.list` acquires panes across that server.
C++	`libtmux::Server::panes`
Swift	`Server.panes()`
OCaml	`Libtmux.Snapshot.panes`
Perl	`LibTmux::Snapshot::panes` One entry per captured physical pane; raw listings preserve contextual rows separately.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.list_panes

Description#

Examples#

tmux command#

tmux C API#

Guides#

In other ports#

Description#

Examples#

tmux command#

tmux C API#

Guides#

In other ports#

Related types#