Python API

method libtmux latest

Session.show_options

Return all options for the target.

Source and package

Qualified name: libtmux.Session.show_options
Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/options.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScriptRustGoJavaC#C++Swift Kotlin Scala OCamlfunction F# Clojure

Examples#

>>> options = server.show_options()
>>> isinstance(options, dict)
True

>>> 'buffer-limit' in options
True

Parameters

global_ (bool) # – Pass -g flag for global options, default False.
scope (OptionScope | _DefaultOptionScope | None) # – Option scope (Server/Session/Window/Pane), defaults to object's scope.
include_hooks (bool | None) # – Include hook options (-H flag).
include_inherited (bool | None) # – Include inherited options (-A flag).
quiet (bool | None) # – Suppress errors silently (-q flag). added 0.56

Returns

ExplodedComplexUntypedOptionsDict Dictionary with all options, arrays exploded and values converted.

Raises

The tmux commands behind show_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 session

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