OptionsMixin.show_options
Return all options for the target.
Source and package
- Qualified name
-
libtmux.options .Options Mixin. show _options - Module
- libtmux.options
- Declared in
OptionsMixin- Package
- libtmux
- Source
- src/libtmux/options.py
- show_options ( self, global_: bool = False, scope: Option
Scope | _DefaultOption | None = DEFAULT_OPTION_SCOPE, include_hooks: bool | None = None, include_inherited: bool | None = None, quiet: bool | None = None, ) ExplodedScope Complex Untyped Options Dict -
Examples#
>>> options = server.show_options()>>> isinstance(options, dict)True>>> 'buffer-limit' in optionsTrue- Parameters
-
-
global_(bool) # – Pass-gflag for global options, default False. -
scope(OptionScope | _DefaultOption | None) # – Option scope (Server/Session/Window/Pane), defaults to object's scope.Scope -
include_hooks(bool | None) # – Include hook options (-Hflag). -
include_inherited(bool | None) # – Include inherited options (-Aflag). -
quiet(bool | None) # – Suppress errors silently (-qflag). added 0.56
-
- Returns
-
ExplodedComplexUntypedOptionsDict Dictionary with all options, arrays exploded and values converted.
- Raises
tmux command#
The tmux commands behind show_options.
tmux C API#
The C declarations in tmux that implement these commands.
tmux options#
Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.