# LibTmux::Options#get

- **Module:** LibTmux
- **Package:** libtmux
- **Language:** Ruby
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ruby/blob/da7b6191b9439e3c84fa1c9eeaa9168263ee7af4/gems/libtmux/lib/libtmux/options.rb#L77
- **Page:** https://libtmux.org/en/ruby/v0.1.1/reference/libtmux-options-get/

```
def get: (
  ::String,
  ?index: ::Integer?,
  ?inherited: bool,
  ?timeout: ::Numeric,
  ?cancel: untyped
) -> ::LibTmux::OptionValue
```

Behavior: Options and hooks.

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`:

```ruby
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.

[Source example](https://github.com/libtmux/libtmux-ruby/blob/da7b6191b9439e3c84fa1c9eeaa9168263ee7af4/examples/api/options.rb).

```ruby
# 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:

```console
$ bundle install && \
  bundle exec ruby options.rb
```

Expected output:

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

## Parameters

- `arg1` (`::String`)
- `index` (`::Integer?`)
- `inherited` (`bool`)
- `timeout` (`::Numeric`)
- `cancel` (`untyped`)

## tmux command

The tmux commands behind `get`.

- [`show-options`](/en/tmux/latest/manual/show-options/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_show_options_entry`](/en/tmux/latest/reference/c-variable-cmd_show_options_entry/) (attribute)
- [`cmd_show_options_exec`](/en/tmux/latest/reference/c-function-cmd-show-options-c-cmd_show_options_exec/) (function)

## tmux options

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

- [Options](/en/tmux/latest/catalog/options/) (option)