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

Server.setOption(_:to:scope:)

Sets an option.

Source and package
Qualified name
Server.setOption(_:to:scope:)
Declared in
Server
Package
libtmux-swift
Source
Sources/LibTmux/Options.swift
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptRustGo Java C# C++ Kotlin Scala OCaml F# Clojure

Description#

The name and the value are data: one ending in ; is the name or the value, and never ends the command. The value is stored as given at every scope.

Parameters
Raises

tmux command#

The tmux commands behind setOption(_:to:scope:).

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.

Guides#

Pages that discuss setOption(_:to:scope:).

In other ports#

Set a server option

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

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.
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
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#.

Set a window option

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

Set a pane option

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