Options.get
The value in effect at this scope, inherited from a parent scope when this one does not set it.
Source and package
- Qualified name
-
io.github .libtmux .Options. get - Package
- io.github.libtmux
- Declared in
Options- Distribution
- io.github.libtmux:libtmux
- Source
- libtmux/src/main/java/io/github/libtmux/Options.java
-
Description#
This is what tmux itself will act on. To ask the narrower question — whether this scope sets the option at all — look for the name in
#all(), which lists only what is set here.- Type parameters
- Parameters
- Returns
-
empty only when tmux does not know the option, which it reports as an error; an option genuinely set to the empty string comes back as an empty value, not as absent. A value spanning several lines comes back whole for
get(name) - Raises
-
-
Server
Unavailable – if no daemon is running forException get(name) -
Lib
Tmux – if the read otherwise fails, including a name tmux finds ambiguous — option names may be abbreviated, and a prefix matching several is a question tmux declined to answer rather than an option it does not have forException get(name) -
Lib
Tmux – if tmux reports a value the key's type cannot hold, which means the key was declared with the wrong type forException get(key)
-
tmux command#
The tmux commands behind get.
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.