Ruby API

method libtmux-ruby latest

Session.link_window

Behavior: Window links.

Source and package

Qualified name: LibTmux::Session#link_window
Module: LibTmux
Declared in: Session
Package: libtmux
Source: gems/libtmux/lib/libtmux/operations.rb
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure

def link_window: ( ::LibTmux::EntityRef, index: ::Integer, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::CommandResult method libtmux [source] ¶

Description#

Behavior contract: Window links.

Examples#

Link one window at two more indexes of its session and list the three links that share one window ID. 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 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 gem and run the program. An operation or cleanup error makes it exit unsuccessfully:

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

Expected output:

indexes: 0, 4, 9
windows: @0

Parameters

arg1 (::LibTmux::EntityRef) #
index (::Integer) #
timeout (::Numeric) #
cancel (untyped) #

Raises

ArgumentError

tmux command#

The tmux commands behind link_window.

link-window

tmux C API#

The C declarations in tmux that implement these commands.

cmd_link_window_entry cmd_move_window_exec

Guides#

Pages that discuss link_window.

Server bindings

In other ports#

Link a window into another session

Equivalents of Link a window into another session in other languages
Language	Equivalent
Python	`libtmux.Window.link`
Lua	`libtmux.WindowLink:link`
Erlang	`tmux_window_link:link/3`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`window.Window.link`
Rust	`window.Window.link_to`
Go	`tmux.Window.Link`
Java	`io.github.libtmux.Window.linkTo`
C#	`LibTmux.Window.LinkAsync`
C++	`libtmux::Window::link_to`
Swift	`Server.link(_:into:)`
OCaml	`Libtmux_unix.Client.link_window`
Perl	`LibTmux::Server::link_window` Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes.

No equivalent is recorded in PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Session.link_window

Description#

Examples#

tmux command#

tmux C API#

Guides#

In other ports#

Description#

Examples#

tmux command#

tmux C API#

Guides#

In other ports#

Related types#