Core Library0.xAPI Reference

Choose documentation 1

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

Window.get_option

Source and package
Qualified name
libtmux.Window:get_option
Module
libtmux
Declared in
Window
Package
libtmux
Source
lua/libtmux/_internal/entity.lua
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby TypeScript RustGo Java C# C++Swift Kotlin Scala OCamlfunction F# Clojure

Inherited from libtmux.Configurable

tmux command#

The tmux commands behind get_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.

In other ports#

Read one window option

Equivalents of Read one window option in other languages
Language Equivalent
Python libtmux.Window.show_option
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no single-option read; Window.showOptions returns them all
Rust window.Window.typed_option
Go tmux.Window.RawOption
Java reached through Window.options, whose Options.get reads one
C# reached through Window.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Window::option
Swift Server.option(_:scope:)
OCaml Libtmux_unix.Client.read_option Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl LibTmux::Server::get_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#.

Esc

Type to search.

Reference previewOpen reference