Ruby API

method libtmux-ruby v0.1.0.alpha.3

Server.list_windows

Behavior: Live acquisition.

Source and package

Qualified name: LibTmux::Server#list_windows
Module: LibTmux
Declared in: Server
Package: libtmux
Source: gems/libtmux/lib/libtmux/server.rb
Other languages: PowerShellcmdlet Juliafunction PythonLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaF#function

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

Description#

Behavior contract: Live acquisition.

Examples#

List all server windows and the windows belonging to one session. Use Ruby 4.0.7, Bundler, Git and tmux 3.3a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267

Save this dependency file as Gemfile:

source "https://rubygems.org"

gem "libtmux", path: "libtmux-source/gems/libtmux"

Save this complete program as list_windows.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"])
    work.new_window(name: "logs", command: ["/bin/cat"])
    server.new_session(name: "other", command: ["/bin/cat"])
    puts "server windows: #{server.list_windows.length}"
    puts "work windows: #{work.list_windows.length}"
  end
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

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

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby list_windows.rb

Expected output:

server windows: 3
work windows: 2

Parameters

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

tmux command list-windows

In other ports List the server's windows

PowerShell
LibTmux\Get-TmuxWindow
Use the -Server parameter set to acquire window placements across all sessions.
Julia
LibTmux.windows
windows with a Snapshot reads every captured physical window. Use windowlinks for session placements.
Python
libtmux.Server.windows
Lua
libtmux.Snapshot.windows
TypeScript
server.Server.windows
Rust
server.Server.windows
Go
tmux.Server.Windows
Java
io.github.libtmux.Server.windows
C#
LibTmux.Server.Windows
C++
libtmux::Server::windows
Swift
Server.windows()
Kotlin
io.github.libtmux.kotlin.Server.windows
Scala
io.github.libtmux.scaladsl.Server.windows
F#
LibTmux.FSharp.Server.windows
Builds a deferred query for placements across all sessions. Query.list acquires the results; a linked window appears once for each session placement.

Scripting & web

Compiled & native

JVM

.NET

tmux

Server.list_windows

Description#

Examples#

Description#

Examples#

Related types#