C++ API

method libtmux-cxx latest

Window.options

Window options.

Source and package

Qualified name: libtmux::Window::options
Namespace: libtmux
Declared in: Window
Package: libtmux-cxx
Source: include/libtmux/entities.hpp
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustGoJavaC#Swift Kotlin Scala OCamlfunction F# Clojure

[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<std::vector<OptionEntry>, CommandFailure> options() const; method readonly [source] ¶: Description#

tmux looks a named option up in the table it belongs to, so the scope here selects which window provides the context and the inheritance chain, not which names are legal.

tmux command#

The tmux commands behind options.

The C declarations in tmux that implement these commands.

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

Read the options set on a window

Equivalents of Read the options set on a window in other languages
Language	Equivalent
Python	`libtmux.Window.show_options`
Ruby	`LibTmux::Window#options`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`window.Window.showOptions`
Rust	`window.Window.options`
Go	`tmux.Window.Options`
Java	`io.github.libtmux.Window.options`
C#	`LibTmux.Window.Options`
Swift	`Server.options(_:)`
OCaml	`Libtmux_unix.Client.capture_options` Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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