Python API

libtmux.options.OptionsMixin.show_options

Python

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

Return all options for the target.

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

0 declared, 0 inherited