set_option
Source and package
- Module
- LibTmux
- Package
- LibTmux
- Source
- src/configuration.jl
- set_option( connection::Lib
Tmux , scope, name::Abstract.Control Connection String , value::AbstractString ; index, kwargs... ) set_option( server::LibTmux , scope, name::Abstract.Server String , value::AbstractString ; index, kwargs... ) -
Methods#
set_option( connection::Lib
Tmux , scope, name::Abstract.Control Connection String , value::AbstractString ; index, kwargs... )[source]#Set an exact option without format expansion. Unrestricted string options and string arrays preserve literal tabs/newlines. Numeric, flag, choice, colour, key, style and other validated options require printable UTF-8 values because tmux may reflect an invalid value in control diagnostics. tmux validates the remaining value rules. Scalar command options use
set_hook's literal grammar; an empty value stores an empty command list. Hook arrays requireset_hook. ReturnControlResult; cancellation does not roll back an admitted mutation.set_option(connection::ControlConnection, scope, name, value; index=nothing, kwargs...)set_option( server::Lib
Tmux , scope, name::Abstract.Server String , value::AbstractString ; index, kwargs... )[source]#Pass a value to tmux without format expansion and return
CommandResult. Scope and names followget_option. tmux applies each option's value rules, including flag and numeric parsing. Without an index, its whole-array assignment rules apply. For executable command bodies useset_hook.set_option(server, scope, name, value; index=nothing, kwargs...)- Parameters