Server.unsetOption(_:scope:)

Swift API

Declared in: Server
Package: libtmux-swift
Source: Sources/LibTmux/Options.swift
Other languages: Python Ruby Lua TypeScript Rust Go Java .NET C++

unsetOption(_:scope:) ( name : String , scope : OptionScope ) → TmuxReply methodasync [source] ¶ methodasync [source] ¶ unsetOption(_:scope:)

Puts an option back the way it was before anyone set it.

What that means depends on the option. A user option — @-prefixed, which tmux never interprets — is deleted outright and stops being listed. One of tmux's own reverts to its built-in default, so it is still listed, carrying a value nobody chose.

Unsetting a name nothing was set to succeeds and changes nothing.

Raises

TmuxError

Discussed in Options and hooks

In other ports Unset a server option

Python libtmux.Server.unset_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Server:unset_option
TypeScript server.Server.unsetOption
Rust server.Server.unset_option
Go tmux.Server.UnsetOption
Java reached through Server.options, whose Options carries the write
.NET reached through Server.Options, whose TmuxOptions carries the write
C++ no equivalent on Server

In other ports Unset a session option

Python libtmux.Session.unset_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Session:unset_option
TypeScript session.Session.unsetOption
Rust session.Session.unset_option
Go tmux.Session.UnsetOption
Java reached through Session.options, whose Options carries the write
.NET reached through Session.Options, whose TmuxOptions carries the write
C++ libtmux::Session::unset_option

In other ports Unset a window option

Python libtmux.Window.unset_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Window:unset_option
TypeScript window.Window.unsetOption
Rust window.Window.unset_option
Go tmux.Window.UnsetOption
Java reached through Window.options, whose Options carries the write
.NET reached through Window.Options, whose TmuxOptions carries the write
C++ libtmux::Window::unset_option

In other ports Unset a pane option

Python libtmux.Pane.unset_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Pane:unset_option
TypeScript pane.Pane.unsetOption
Rust pane.Pane.unset_option
Go tmux.Pane.UnsetOption
Java reached through Pane.options, whose Options carries the write
.NET reached through Pane.Options, whose TmuxOptions carries the write
C++ libtmux::Pane::unset_option

0 declared, 0 inherited