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

Server.RawOption

RawOption returns one exact server-scope option value. A successful string is caller-owned; ok reports presence. Targeted reads do not use list leniency, and completed failures return a secret-safe option error. An unindexed empty array is indistinguishable from an empty scalar; use Options for typed array presence.

Source and package
Qualified name
tmux.Server.RawOption
Package
tmux
Declared in
Server
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 server option

Equivalents of Read one server option in other languages
Language Equivalent
Python libtmux.Server.show_option
Lua libtmux.Server:get_option
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no single-option read; Server.showOptions returns them all
Rust server.Server.typed_option
Java reached through Server.options, whose Options.get reads one
C# reached through Server.Options, whose TmuxOptions.GetAsync reads one
C++ no single-option read; Server::options returns them all
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 => '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#.

Esc

Type to search.

Reference previewOpen reference