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.unset_option

Unset option for tmux target.

Source and package
Qualified name
libtmux.Session.unset_option
Module
libtmux
Declared in
Session
Package
libtmux
Source
src/libtmux/options.py
Other languages
PowerShell Julia Ruby LuaTypeScriptRustGo Java C# C++Swift Kotlin Scala F#
unset_option ( self, option: str, unset_panes: bool | None = None, global_: bool | None = None, ignore_errors: bool | None = None, scope: OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE, ) → Self

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().set_option('escape-time', 1250)
<libtmux.options.MyServer object at ...>
>>> MyServer()._show_option('escape-time')
1250
>>> MyServer().unset_option('escape-time')
<libtmux.options.MyServer object at ...>
>>> isinstance(MyServer()._show_option('escape-time'), int)
True

tmux catalog Options

In other ports Unset a session option
Esc

Type to search.

Reference preview Open reference