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.

typealias libtmux-ts latest

OptionScope

Which table an option is read from or written to.

Source and package
Qualified name
OptionScope
Module
constants
Package
libtmux
Source
packages/libtmux/src/constants.ts
type constants.OptionScope = (typeof OptionScope)[keyof typeof OptionScope]

Description#

The scopes are not one chain. A pane option falls back to the window's, and an unset window or pane option falls back to the global window options; a session option falls back to the global session options, and server options belong to no session, window or pane at all. So setting something at window scope reaches every pane in it that has not set its own, and setting it at session scope does not.

Members4#

OptionScope constant object properties
NameValueDescription
Server "server"
Session "session"
Window "window"
Pane "pane"
Esc

Type to search.

Reference previewOpen reference