Core LibraryalphaAPI Reference

Choose documentation 3

v0.1.0.alpha.3

Current version

v0.1.0.alpha.3
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

method libtmux-ruby v0.1.0.alpha.3

Session.list_window_links

Behavior: Live acquisition.

Source and package
Qualified name
LibTmux::Session#list_window_links
Module
LibTmux
Declared in
Session
Package
libtmux
Source
gems/libtmux/lib/libtmux/operations.rb

Description#

Behavior contract: Live acquisition.

Examples#

Link one window at two more indexes of its session and list the three links that share one window ID. 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:

Terminal window
$ 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 link_window.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
begin
# docs:begin main
require "libtmux"
LibTmux::Server.start do |server|
session = server.new_session(name: "links", command: ["/bin/cat"])
window = session.list_windows.fetch(0)
session.link_window(window.ref, index: 4)
session.link_window(window.ref, index: 9)
links = session.list_window_links
puts "indexes: #{links.map(&:index).join(', ')}"
puts "windows: #{links.map { |link| link.window.id }.uniq.join(', ')}"
end
# docs:end main
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:

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

Expected output:

indexes: 0, 4, 9
windows: @0
Parameters
Esc

Type to search.

Reference preview Open reference