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.RawOption

RawOption returns one exact window option value at this exact window target. A successful string is caller-owned; the receiver's exact linked session context controls tmux format evaluation, and a completed failure is returned.

Source and package
Qualified name
tmux.Window.RawOption
Package
tmux
Declared in
Window
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/option_read.go
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Rust Java C# 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.

In other ports#

Read one window option

Equivalents of Read one window option in other languages
Language Equivalent
Python libtmux.Window.show_option
Lua libtmux.Window:get_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
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