Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-swift latest

Server.unsetOption(_:scope:)

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

Source and package
Qualified name
Server.unsetOption(_:scope:)
Declared in
Server
Package
libtmux-swift
Source
Sources/LibTmux/Options.swift
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptRustGo Java C# C++ Kotlin Scala OCaml F# Clojure

Description#

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.

Parameters
Raises

tmux command#

The tmux commands behind unsetOption(_:scope:).

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.

Guides#

Pages that discuss unsetOption(_:scope:).

In other ports#

Unset a server option

Equivalents of Unset a server option in other languages
Language Equivalent
Python libtmux.Server.unset_option
Lua libtmux.Server:unset_option
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.unsetOption
Rust server.Server.unset_option
Go tmux.Server.UnsetOption
Java reached through Server.options, whose Options carries the write
C# reached through Server.Options, whose TmuxOptions carries the write
C++ no equivalent on Server
OCaml Libtmux_unix.Client.unset_option
Perl LibTmux::Server::unset_option Pass scope => 'server' 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#.

Unset a session option

Equivalents of Unset a session option in other languages
Language Equivalent
Python libtmux.Session.unset_option
Lua libtmux.Session:unset_option
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript session.Session.unsetOption
Rust session.Session.unset_option
Go tmux.Session.UnsetOption
Java reached through Session.options, whose Options carries the write
C# reached through Session.Options, whose TmuxOptions carries the write
C++ libtmux::Session::unset_option
OCaml Libtmux_unix.Client.unset_option
Perl LibTmux::Server::unset_option 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#.

Unset a window option

Equivalents of Unset a window option in other languages
Language Equivalent
Python libtmux.Window.unset_option
Lua libtmux.Window:unset_option
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript window.Window.unsetOption
Rust window.Window.unset_option
Go tmux.Window.UnsetOption
Java reached through Window.options, whose Options carries the write
C# reached through Window.Options, whose TmuxOptions carries the write
C++ libtmux::Window::unset_option
OCaml Libtmux_unix.Client.unset_option
Perl LibTmux::Server::unset_option Pass scope => 'window' 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#.

Unset a pane option

Equivalents of Unset a pane option in other languages
Language Equivalent
Python libtmux.Pane.unset_option
Lua libtmux.Pane:unset_option
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.unsetOption
Rust pane.Pane.unset_option
Go tmux.Pane.UnsetOption
Java reached through Pane.options, whose Options carries the write
C# reached through Pane.Options, whose TmuxOptions carries the write
C++ libtmux::Pane::unset_option
OCaml Libtmux_unix.Client.unset_option
Perl LibTmux::Server::unset_option Pass scope => 'pane' 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#.

Esc

Type to search.

Reference previewOpen reference