Session.unset_option
Unset option for tmux target.
Source and package
- unset_option ( self, option: str, unset_panes: bool | None = None, global_: bool | None = None, ignore_errors: bool | None = None, scope: Option
Scope | _DefaultOption | None = DEFAULT_OPTION_SCOPE, ) SelfScope -
Inherited from
libtmux.options.OptionsMixinDescription#
Wraps
$ tmux set-option -u <option>/$ tmux set-option -U <option>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- Parameters
-
-
option(str) # – option to unset, e.g. 'aggressive-resize' -
unset_panes(bool | None) # -
ignore_errors(bool | None) # -
scope(OptionScope | _DefaultOption | None) #Scope
-
- Raises
tmux command#
The tmux commands behind unset_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.
In other ports#
Unset a session option
| Language | Equivalent |
|---|---|
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | session |
| Rust | session |
| Go | tmux |
| Java | reached through Session.options, whose Options carries the write |
| C# | reached through Session.Options, whose TmuxOptions carries the write |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
| Perl | Lib Pass scope => 'session' and the explicit target ID where applicable; inherited and global reads are deliberate options. |
No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.