C++ API

method libtmux-cxx latest

Server.options

Source and package

Qualified name: libtmux::Server::options
Namespace: libtmux
Declared in: Server
Package: libtmux-cxx
Source: include/libtmux/server.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(std::string_view target = {}) const; method readonly [source] ¶

Parameters

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 the server

Equivalents of Read the options set on the server in other languages
Language	Equivalent
Python	`libtmux.Server.show_options`
Ruby	`LibTmux::Server#options`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`server.Server.showOptions`
Rust	`server.Server.options`
Go	`tmux.Server.Options`
Java	`io.github.libtmux.Server.options`
C#	`LibTmux.Server.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#.