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-rs latest

Pane.unset_option

Remove one option, restoring whatever it inherits.

Source and package
Qualified name
libtmux::pane::Pane::unset_option
Module
pane
Declared in
Pane
Package
libtmux
Source
crates/libtmux/src/pane/settings.rs
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptGo Java C# C++Swift Kotlin Scala OCaml F# Clojure
pub async fn unset_option(&self, name: &str) -> Result< (), Error >

Description#

Errors

Returns an error when tmux rejects the name.

Returns crate::Error::OptionScopeMismatch when tmux keeps the option in another of its tables.

Parameters

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.

Guides#

Pages that discuss unset_option.

In other ports#

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
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
Swift Server.unsetOption(_:scope:)
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