Ruby API

method libtmux-ruby v0.1.1

Options.set

Behavior: Options and hooks.

Source and package

Qualified name: LibTmux::Options#set
Module: LibTmux
Declared in: Options
Package: libtmux
Source: gems/libtmux/lib/libtmux/options.rb

def set: ( ::String, ::String | ::Integer | bool, ?index: ::Integer?, ?append: bool, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::CommandResult method libtmux [source] ¶

Description#

Behavior contract: Options and hooks.

Examples#

Set and read a session option, convert its value to an Integer, and attach a hook command to the same session. 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.1"

Save this complete program as options.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: "work", command: ["/bin/cat"])
    session.options.set("history-limit", 5000)
    limit = session.options.get("history-limit")
    puts "history-limit: #{limit.as(:integer)}"
    puts "inherited: #{limit.inherited?}"
    session.hooks.set("after-new-window", command: "display-message created")
    puts "hook: #{session.hooks.get('after-new-window').as(:string)}"
  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 options.rb

Expected output:

history-limit: 5000
inherited: false
hook: display-message created

Parameters

arg1 (::String) #
arg2 (::String | ::Integer | bool) #
index (::Integer?) #
append (bool) #
timeout (::Numeric) #
cancel (untyped) #

tmux command#

The tmux commands behind set.

set-option

tmux C API#

The C declarations in tmux that implement these commands.

cmd_set_option_entry cmd_set_option_exec

tmux options#

Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.

Options

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Options.set

Description#

Examples#

tmux command#

tmux C API#

tmux options#

Description#

Examples#

tmux command#

tmux C API#

tmux options#

Related types#