Python API

libtmux.Pane.show_options

Python

Module: libtmux
Declared in: Pane
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

Discussed in Options and hooks

In other ports Read the options set on a pane

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

Examples

Python TypeScript Rust

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

>>> 'buffer-limit' in options
True

const options = await pane.showOptions();
options.get("remain-on-exit");

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("opts").await?;
let window = session.active_window().await?.expect("a session has a window");
let pane = window.active_pane().await?.expect("a window has a pane");

pane.set_option("@marker", "set").await?;
assert!(pane.options().await?.contains_key("@marker"));

guard.shutdown().await?;

0 declared, 0 inherited