TypeScript API

method libtmux-ts latest

Session.setOption

Set an option on this session.

Source and package

Qualified name: Session.setOption
Module: session
Declared in: Session
Package: libtmux
Source: packages/libtmux/src/session.ts
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaRustGo Java C# C++Swift Kotlin Scala OCaml F# Clojure

Examples#

await session.setOption("status", "off");

Parameters

The tmux commands behind setOption.

The C declarations in tmux that implement these commands.

Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.

Set a session option

Equivalents of Set a session option in other languages
Language	Equivalent
Python	`libtmux.Session.set_option`
Lua	`libtmux.Session:set_option`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Rust	`session.Session.set_option`
Go	`tmux.Session.SetOption`
Java	reached through `Session.options`, whose `Options` carries the write
C#	reached through `Session.Options`, whose `TmuxOptions` carries the write
C++	`libtmux::Session::set_option`
Swift	`Server.setOption(_:to:scope:)`
OCaml	`Libtmux_unix.Client.set_option`
Perl	`LibTmux::Server::set_option` Pass scope => 'session' 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#.