C++ API

method libtmux-cxx latest

Session.option

Source and package

Qualified name: libtmux::Session::option
Namespace: libtmux
Declared in: Session
Package: libtmux-cxx
Source: include/libtmux/entities.hpp
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript RustGo Java C# 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<OptionEntry, CommandFailure> option(std::string_view name) const; method readonly [source] ¶

Parameters

tmux command#

The tmux commands behind option.

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 one session option

Equivalents of Read one session option in other languages
Language	Equivalent
Python	`libtmux.Session.show_option`
Lua	`libtmux.Session:get_option`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
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
C#	reached through `Session.Options`, whose `TmuxOptions.GetAsync` reads one
Swift	`Server.option(_:scope:)`
OCaml	`Libtmux_unix.Client.read_option` Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl	`LibTmux::Server::get_option` Pass scope => 'session' and the explicit target ID where applicable; inherited and global reads are deliberate options.

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