Lua API

method libtmux-lua latest

Session.set_option

Source and package

Qualified name: libtmux.Session:set_option
Module: libtmux
Declared in: Session
Package: libtmux
Source: lua/libtmux/_internal/entity.lua
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby TypeScriptRustGo Java C# C++Swift Kotlin Scala OCaml F# Clojure

Parameters

name (string) #
value (boolean|string|number|libtmux.HookProgram|libtmux.OptionArrayInput) #
options (libtmux.SettingSetOptions?) #

tmux command#

The tmux commands behind set_option.

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`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`session.Session.setOption`
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#.