io.github.libtmux.Options.Options

class io.github.libtmux.Options.Options

classreadonly [source] ¶

classreadonly [source] ¶

class io.github.libtmux.Options.Options

The tmux options at one scope.

tmux keeps options on the server, on a session, on a window and on a pane, and the same option name can exist at more than one of them. A scope is therefore chosen when the view is obtained, not passed to every call, so a caller cannot read one scope and write another.

Array options keep the subscript tmux prints — command-alias[0] — because that is what addresses the individual entry when setting it back.

Discussed in Architecture

Members

• all method Every option set at this scope, in tmux's order. Inherited values are not listed.
• append method Adds to the end of a string option, rather than replacing it.
• effective method Every option in effect at this scope, including the ones inherited rather than set here.
• get method The value in effect at this scope, inherited from a parent scope when this one does not set it.
• global method
• pane method
• server method
• session method
• set method As String), written the way tmux reads the key's type.
• setExpanded method Sets one option to what a tmux format comes to, rather than to the format itself.
• setIfAbsent method Sets one option only if this scope does not already set it.
• unset method Removes one option at this scope, so it falls back to whatever it inherits.
• window method