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

Server.showGlobalOptions

Read the defaults every session or window inherits.

Source and package
Qualified name
Server.showGlobalOptions
Module
server
Declared in
Server
Package
libtmux
Source
packages/libtmux/src/server.ts
Other languages
PowerShell Julia Elixir Python Ruby Lua Rust Go Java C# C++ Swift Kotlin Scala F#
showGlobalOptions( scope: "session" | "window", options?: CommandOptions, ): Promise<ReadonlyMap<string, string>>

Description#

Most of tmux's options live here rather than on an object: a session that has set nothing reports nothing, while the values actually governing it are these. history-limit and default-shell are both global session options and remain-on-exit a global window one; none of the three is readable any other way.

Examples#

const defaults = await server.showGlobalOptions("session");
defaults.get("default-shell");
Parameters

tmux command#

The tmux commands behind showGlobalOptions.

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 the defaults every session inherits

Equivalents of Read the defaults every session inherits in other languages
Language Equivalent
Python no equivalent on Server
Rust no whole-table read; Server.get_global_option reads one
Go no equivalent on Server
Java io.github.libtmux.Server.globalOptions
C# no equivalent on Server
C++ libtmux::Server::global_options
Swift no equivalent on Server

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Elixir, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference