Session.list_panes
Behavior: Live acquisition.
Source and package
- Qualified name
-
LibTmux:: Session# list _panes - Module
- LibTmux
- Declared in
Session- Package
- libtmux
- Source
- gems/libtmux/lib/libtmux/entity.rb
- Other languages
- PowerShellcmdlet Julia Elixir Python Lua TypeScriptRustGo Java C#C++Swift Kotlin Scala F#function
-
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/catand/bin/shavailable. In an empty directory, save thisGemfile:source "https://rubygems.org"gem "libtmux", "0.1.1"Save this complete program as
list_panes.rb. ItsServer.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|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}"endrescue 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 list_panes.rbExpected output:
server panes: 3work panes: 2window panes: 2
tmux command#
The tmux commands behind list_panes.
list-panes -s session scope, cmd_list_panes_session tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
List a session's panes
| Language | Equivalent |
|---|---|
| Python | libtmux |
| PowerShell | Lib Use the -Session parameter set to acquire panes across that session’s windows. |
| Julia | Traverse windows(session) and panes(window) in the captured snapshot. panes(snapshot) has server-wide scope. |
| TypeScript | session |
| Rust | session |
| Go | tmux |
| Java | no direct accessor; traverse Session.windows and Window.panes |
| C# | Lib |
| F# | Lib Builds a deferred pane query from one LibTmux.Session and its server. Query.list() acquires panes across that session’s windows. |
| C++ | libtmux:: |
| Swift | Snapshot |
No equivalent is recorded in Lua, Elixir, Kotlin or Scala.