Python API

libtmux.Session.show_options

Python

Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/options.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++Swift

show_options ( self , global_ : bool = False , scope : OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE , include_hooks : bool | None = None , include_inherited : bool | None = None , quiet : bool | None = None ) → ExplodedComplexUntypedOptionsDict method [source] ¶ method [source] ¶ show_options

Inherited from libtmux.options.OptionsMixin

Return all options for the target.

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

In other ports Read the options set on a session

Ruby LibTmux::Session#options
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript session.Session.showOptions
Rust session.Session.options
Go tmux.Session.Options
Java io.github.libtmux.Session.Session.options
.NET LibTmux.Session.Options
C++ libtmux::Session::options
Swift Server.options(_:)

Examples

Python TypeScript Rust

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

>>> 'buffer-limit' in options
True

const options = await session.showOptions();
options.get("status");

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("opts").await?;

session.set_option("status-left-length", "30").await?;
let options = session.options().await?;
assert!(options.contains_key("status-left-length"));

guard.shutdown().await?;

0 declared, 0 inherited