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

Server.set_global_option

Set one global session option to text, unchecked.

Source and package
Qualified name
libtmux::server::Server::set_global_option
Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server/settings.rs
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure
pub async fn set_global_option( &self, name: &str, value: impl Into<OsString>, ) -> Result<(), Error>

Description#

Sessions inherit from this table, so it is where a default belongs. Self::set_typed_global_option() checks the value first.

Errors

Returns an error when tmux rejects the name or value.

Parameters

tmux command#

The tmux commands behind set_global_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#

Set a default every session inherits

Equivalents of Set a default every session inherits in other languages
Language Equivalent
Python no equivalent on Server
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.setGlobalOption
Go no equivalent on Server
Java no equivalent on Server
C# no equivalent on Server
C++ libtmux::Server::set_global_option
Swift no equivalent on Server
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl LibTmux::Server::set_option Pass scope => 'session', global => true to set a session default.

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

Esc

Type to search.

Reference previewOpen reference