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

Window.Options

Options returns a freshly decoded, caller-owned view of known options at this exact window target, including inherited values. The receiver's exact linked session context controls tmux format evaluation. A read failure is returned rather than answered with zero values. Each returned accessor names the setter that writes it, so WindowOptionValues.MainPaneWidth pairs with Window.SetMainPaneWidth.

Source and package
Qualified name
tmux.Window.Options
Package
tmux
Declared in
Window
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/option_read.go
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustJavaC#C++Swift Kotlin Scala OCamlfunction F# Clojure
Parameters

tmux options#

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

Guides#

Pages that discuss Options.

In other ports#

Read the options set on a window

Equivalents of Read the options set on a window in other languages
Language Equivalent
Python libtmux.Window.show_options
Ruby LibTmux::Window#options
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript window.Window.showOptions
Rust window.Window.options
Java io.github.libtmux.Window.options
C# LibTmux.Window.Options
C++ libtmux::Window::options
Swift Server.options(_:)
OCaml Libtmux_unix.Client.capture_options Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference