Python API

libtmux.Session.show_option

Python

Python
Ruby Unavailable
Lua
TypeScript Unavailable
Rust
Go
Java Unavailable
.NET Unavailable
C++
Swift

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

show_option ( self , option : str , global_ : bool = False , g : bool = False , scope : OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE , ignore_errors : bool | None = None , include_hooks : bool | None = None , include_inherited : bool | None = None ) → t.Any | None method [source] ¶ method [source] ¶ show_option

Inherited from libtmux.options.OptionsMixin

Return option value for the target.

Examples

>>> import typing as t
>>> from libtmux.common import tmux_cmd
>>> from libtmux.constants import OptionScope

>>> class MyServer(OptionsMixin):
...     socket_name = server.socket_name
...     def cmd(self, cmd: str, *args: object):
...         cmd_args: t.List[t.Union[str, int]] = [cmd]
...         if self.socket_name:
...             cmd_args.insert(0, f"-L{self.socket_name}")
...         cmd_args.insert(0, "-f/dev/null")
...         return tmux_cmd(*cmd_args, *args)
...
...     default_option_scope = OptionScope.Server

>>> MyServer().cmd('new-session', '-d')
<libtmux.common.tmux_cmd object at ...>

>>> MyServer().show_option('exit-unattached', global_=True)
False

Parameters

g ( bool ) – Use global_ instead. deprecated 0.50.0

Raises

In other ports Read one session option

Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Session:get_option
TypeScript no single-option read; Session.showOptions returns them all
Rust session.Session.typed_option
Go tmux.Session.RawOption
Java reached through Session.options, whose Options.get reads one
.NET reached through Session.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Session::option
Swift Server.option(_:scope:)

0 declared, 0 inherited