libtmux:set-option
Set one typed tmux option and return its COMMAND-OUTCOME. SCOPE is required and names one explicit table: :SERVER, :GLOBAL-SESSION, :SESSION, :GLOBAL-WINDOW, :WINDOW or :PANE. Local scopes require a captured TARGET of the matching type; global scopes reject one. NAME is resolved in the exact live daemon catalog. Native numbers, Booleans and choices are validated before payload dispatch. User names must match @[A-Za-z0-9_.-]+ and remain strings. KEY addresses a registered array element. FORMAT-P treats VALUE as an explicit tmux format; otherwise VALUE is literal and typed. APPEND is supported for strings, keyed string-array elements and unkeyed array assignment. An unkeyed array VALUE uses that option's native tmux list grammar; use KEY when VALUE must remain one literal element. ONLY-IF-UNSET requests tmux -o: write only when the option, or the selected array key, is absent from the local table. Inherited values permit a local write; present false and empty values refuse replacement. Refusal retains normal condition/outcome evidence through ERROR-OUTCOME. The condition applies to this command; later commands and hooks remain independent. Use UNSET-OPTION to remove state and SET-HOOK for registered hooks. Never retries or acquires a replacement capture.
Source and package
- Qualified name
-
libtmux:set-option - Declared in
libtmux- Package
- libtmux
- Source
- src/configuration-operations.lisp
-
Public owner:
libtmuxDescription#
See also:
libtmux:error-outcome,libtmux:set-hook,libtmux:unset-option.
tmux command#
The tmux commands behind set-option.
tmux C API#
The C declarations in tmux that implement these commands.
Guides#
Pages that discuss set-option.