Core LibrarystableAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

method libtmux stable

Server.show_options

Return all options for the target.

Source and package
Qualified name
libtmux.Server.show_options
Module
libtmux
Declared in
Server
Package
libtmux
Source
src/libtmux/options.py
Other languages
PowerShell Julia Ruby Lua TypeScriptRustGoJavaC#C++Swift Kotlin Scala F#
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

Inherited from libtmux.options.OptionsMixin

Examples#

>>> options = server.show_options()
>>> isinstance(options, dict)
True
>>> 'buffer-limit' in options
True
Parameters
Returns

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

Raises

tmux catalog Options

In other ports Read the options set on the server
Esc

Type to search.

Reference preview Open reference