Server.option(_:scope:)

Swift API

Declared in: Server
Package: libtmux-swift
Source: Sources/LibTmux/Options.swift
Other languages: Python Ruby Lua TypeScript Rust Go Java .NET C++

option(_:scope:) ( name : String , scope : OptionScope ) → String? methodasync [source] ¶ methodasync [source] ¶ option(_:scope:)

The value of one option, or nil if it is not set in that table.

Presence comes from the table listing and the value from show-options -v, because neither answers both portably: the listing quotes a value containing spaces, while -v reports "not set" as exit 0 with empty output on 3.2a and exit 1 on 3.7 — and reading emptiness as absence would erase the difference between an option nobody set and one deliberately set to "".

Raises

TmuxError

Discussed in Options and hooks

In other ports Read one server option

Python libtmux.Server.show_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Server:get_option
TypeScript no single-option read; Server.showOptions returns them all
Rust server.Server.typed_option
Go tmux.Server.RawOption
Java reached through Server.options, whose Options.get reads one
.NET reached through Server.Options, whose TmuxOptions.GetAsync reads one
C++ no single-option read; Server::options returns them all

In other ports Read one session option

Python libtmux.Session.show_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Session:get_option
TypeScript no single-option read; Session.showOptions returns them all
Rust session.Session.typed_option
Go tmux.Session.RawOption
Java reached through Session.options, whose Options.get reads one
.NET reached through Session.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Session::option

In other ports Read one window option

Python libtmux.Window.show_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Window:get_option
TypeScript no single-option read; Window.showOptions returns them all
Rust window.Window.typed_option
Go tmux.Window.RawOption
Java reached through Window.options, whose Options.get reads one
.NET reached through Window.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Window::option

In other ports Read one pane option

Python libtmux.Pane.show_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Pane:get_option
TypeScript no single-option read; Pane.showOptions returns them all
Rust pane.Pane.typed_option
Go tmux.Pane.RawOption
Java reached through Pane.options, whose Options.get reads one
.NET reached through Pane.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Pane::option

0 declared, 0 inherited