Session.options
Behavior: Options and hooks.
Source and package
- def options: () -> ::Lib
Tmux:: Options -
Public owner:
LibTmux::Entity#optionsDescription#
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 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 d8ce4bbee0ca7748a81929f81f7d8d07f8c51267Save this dependency file as Gemfile:
source "https://rubygems.org"gem "libtmux", path: "libtmux-source/gems/libtmux"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: truebegin# docs:begin mainrequire "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 mainrescue StandardError => errorwarn "#{error.class}: #{error.message}"exit 1endInstall 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 options.rbExpected output:
history-limit: 5000inherited: falsehook: display-message createdtmux catalog Options
In other ports Read the options set on a session
- PowerShell No source-verified PowerShell equivalent is recorded for this operation.
- Julia No source-verified Julia equivalent is recorded for this operation.
- Python
- Lua No source-verified Lua equivalent is recorded for this operation.
- TypeScript
- Rust
- Go
- Java
- C#
- C++
- Swift
- Kotlin No source-verified Kotlin equivalent is recorded for this operation.
- Scala No source-verified Scala equivalent is recorded for this operation.
- F# No source-verified F# equivalent is recorded for this operation.
- PowerShell