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

Session.show_option

Return option value for the target.

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

Inherited from libtmux.options.OptionsMixin

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

tmux catalog Options

In other ports Read one session option
  • PowerShell
    No source-verified PowerShell equivalent is recorded for this operation.
  • Julia
    No source-verified Julia equivalent is recorded for this operation.
  • Ruby
    No source-verified Ruby equivalent is recorded for this operation.
  • Lua
  • TypeScript
    no single-option read; Session.showOptions returns them all
  • Rust
  • Go
  • Java
    reached through Session.options, whose Options.get reads one
  • C#
    reached through Session.Options, whose TmuxOptions.GetAsync reads one
  • C++
  • Swift
  • Kotlin
    No source-verified Kotlin equivalent is recorded for this operation.
  • Scala
    No source-verified Scala equivalent is recorded for this operation.
  • F#
    No source-verified F# equivalent is recorded for this operation.
Esc

Type to search.

Reference preview Open reference