# Libtmux_unix.Client.unset_option

- **Module:** Libtmux_unix
- **Package:** libtmux-unix
- **Language:** OCaml
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-ocaml/blob/205dfda49742592b479247049d186956e4a4cfe9/unix/libtmux_unix.mli#L459
- **Public owner:** Libtmux_unix
- **Page:** https://libtmux.org/en/ocaml/latest/reference/libtmux_unix-client-unset_option/

```
val unset_option :
  ?cancel:Cancellation.t ->
  ?index:int ->
  t -> Libtmux.Options.scope -> string -> (unit, Libtmux.Error.t) result
```

Remove a local override or one array element. Global built-ins reset to their tmux defaults; this does not recursively unset child overrides.

## Parameters

- `cancel?` (`Cancellation.t`)
- `index?` (`int`)
- `arg1` (`t`)
- `arg2` (`Libtmux.Options.scope`)
- `arg3` (`string`)

## tmux command

The tmux commands behind `unset_option`.

- [`set-option`](/en/tmux/latest/manual/set-option/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_set_option_entry`](/en/tmux/latest/reference/c-variable-cmd_set_option_entry/) (attribute)
- [`cmd_set_option_exec`](/en/tmux/latest/reference/c-function-cmd-set-option-c-cmd_set_option_exec/) (function)

## tmux options

Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.

- [Options](/en/tmux/latest/catalog/options/) (option)

## In other ports

Unset a server option

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Server.unset_option`](/en/py/latest/reference/libtmux-server-unset_option/) (method) |
| Lua | [`libtmux.Server:unset_option`](/en/lua/latest/reference/libtmux-server-unset_option/) (method) |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | [`server.Server.unsetOption`](/en/ts/latest/reference/server-server-unsetoption/) (method) |
| Rust | [`server.Server.unset_option`](/en/rs/latest/reference/server-server-unset_option/) (method) |
| Go | [`tmux.Server.UnsetOption`](/en/go/latest/reference/tmux-server-unsetoption/) (method) |
| 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` |
| Swift | [`Server.unsetOption(_:scope:)`](/en/swift/latest/reference/server-unsetoption(_-scope-)/) (method) |
| Perl | [`LibTmux::Server::unset_option`](/en/perl/latest/reference/libtmux-server-unset_option/) (method). 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

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Session.unset_option`](/en/py/latest/reference/libtmux-session-unset_option/) (method) |
| Lua | [`libtmux.Session:unset_option`](/en/lua/latest/reference/libtmux-session-unset_option/) (method) |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | [`session.Session.unsetOption`](/en/ts/latest/reference/session-session-unsetoption/) (method) |
| Rust | [`session.Session.unset_option`](/en/rs/latest/reference/session-session-unset_option/) (method) |
| Go | [`tmux.Session.UnsetOption`](/en/go/latest/reference/tmux-session-unsetoption/) (method) |
| 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`](/en/cxx/latest/reference/libtmux-session-unset_option/) (method) |
| Swift | [`Server.unsetOption(_:scope:)`](/en/swift/latest/reference/server-unsetoption(_-scope-)/) (method) |
| Perl | [`LibTmux::Server::unset_option`](/en/perl/latest/reference/libtmux-server-unset_option/) (method). 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

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Window.unset_option`](/en/py/latest/reference/libtmux-window-unset_option/) (method) |
| Lua | [`libtmux.Window:unset_option`](/en/lua/latest/reference/libtmux-window-unset_option/) (method) |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | [`window.Window.unsetOption`](/en/ts/latest/reference/window-window-unsetoption/) (method) |
| Rust | [`window.Window.unset_option`](/en/rs/latest/reference/window-window-unset_option/) (method) |
| Go | [`tmux.Window.UnsetOption`](/en/go/latest/reference/tmux-window-unsetoption/) (method) |
| 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`](/en/cxx/latest/reference/libtmux-window-unset_option/) (method) |
| Swift | [`Server.unsetOption(_:scope:)`](/en/swift/latest/reference/server-unsetoption(_-scope-)/) (method) |
| Perl | [`LibTmux::Server::unset_option`](/en/perl/latest/reference/libtmux-server-unset_option/) (method). 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

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Pane.unset_option`](/en/py/latest/reference/libtmux-pane-unset_option/) (method) |
| Lua | [`libtmux.Pane:unset_option`](/en/lua/latest/reference/libtmux-pane-unset_option/) (method) |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | [`pane.Pane.unsetOption`](/en/ts/latest/reference/pane-pane-unsetoption/) (method) |
| Rust | [`pane.Pane.unset_option`](/en/rs/latest/reference/pane-pane-unset_option/) (method) |
| Go | [`tmux.Pane.UnsetOption`](/en/go/latest/reference/tmux-pane-unsetoption/) (method) |
| 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`](/en/cxx/latest/reference/libtmux-pane-unset_option/) (method) |
| Swift | [`Server.unsetOption(_:scope:)`](/en/swift/latest/reference/server-unsetoption(_-scope-)/) (method) |
| Perl | [`LibTmux::Server::unset_option`](/en/perl/latest/reference/libtmux-server-unset_option/) (method). 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#.