OptionsMixin.set_option
Set option for tmux target.
Source and package
- Qualified name
-
libtmux.options .Options Mixin. set _option - Module
- libtmux.options
- Declared in
OptionsMixin- Package
- libtmux
- Source
- src/libtmux/options.py
-
Description#
Examples#
>>> import typing as t>>> from libtmux.common import tmux_cmd>>> from libtmux.constants import OptionScope>>> from libtmux._internal.sparse_array import SparseArray>>> 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().set_option('escape-time', 495)<libtmux.options.MyServer object at ...>>>> MyServer()._show_option('escape-time')495- Parameters
-
-
option(str) # – option to set, e.g. 'aggressive-resize' -
value(int | str) # – option value. True/False will turn in 'on' and 'off', also accepts string of 'on' or 'off' directly. -
prevent_overwrite(bool | None) # -
ignore_errors(bool | None) # -
suppress_warnings(bool | None) # -
scope(OptionScope | _DefaultOption | None) #Scope
-
- Raises
tmux command#
The tmux commands behind set_option.
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.