diff options
Diffstat (limited to 'doc/en/autogen')
| -rw-r--r-- | doc/en/autogen/plugin_api/completions.adoc | 2 | ||||
| -rw-r--r-- | doc/en/autogen/plugin_api/hdata.adoc | 20 | ||||
| -rw-r--r-- | doc/en/autogen/plugin_api/infolists.adoc | 2 | ||||
| -rw-r--r-- | doc/en/autogen/plugin_api/plugins_priority.adoc | 15 | ||||
| -rw-r--r-- | doc/en/autogen/user/fset_commands.adoc | 159 | ||||
| -rw-r--r-- | doc/en/autogen/user/fset_options.adoc | 483 |
6 files changed, 674 insertions, 7 deletions
diff --git a/doc/en/autogen/plugin_api/completions.adoc b/doc/en/autogen/plugin_api/completions.adoc index 418382849..564c26e24 100644 --- a/doc/en/autogen/plugin_api/completions.adoc +++ b/doc/en/autogen/plugin_api/completions.adoc @@ -16,6 +16,8 @@ | exec | exec_commands_ids | ids (numbers and names) of executed commands +| fset | fset_options | configuration files, sections, options and words of options + | guile | guile_script | list of scripts | irc | irc_channel | current IRC channel diff --git a/doc/en/autogen/plugin_api/hdata.adoc b/doc/en/autogen/plugin_api/hdata.adoc index f31150142..eebe899e1 100644 --- a/doc/en/autogen/plugin_api/hdata.adoc +++ b/doc/en/autogen/plugin_api/hdata.adoc @@ -8,6 +8,26 @@ |=== | Plugin | Name | Description | Lists | Variables +| fset +| [[hdata_fset_option]]<<hdata_fset_option,fset_option>> +| fset options +| - +| _file_ (string) + +_section_ (string) + +_option_ (string) + +_name_ (string) + +_parent_name_ (string) + +_type_ (integer) + +_default_value_ (string) + +_value_ (string) + +_parent_value_ (string) + +_min_ (string) + +_max_ (string) + +_description_ (string) + +_string_values_ (string) + +_marked_ (integer) + + + | guile | [[hdata_guile_script]]<<hdata_guile_script,guile_script>> | list of scripts diff --git a/doc/en/autogen/plugin_api/infolists.adoc b/doc/en/autogen/plugin_api/infolists.adoc index b3dbc6338..972063964 100644 --- a/doc/en/autogen/plugin_api/infolists.adoc +++ b/doc/en/autogen/plugin_api/infolists.adoc @@ -8,6 +8,8 @@ | alias | alias | list of aliases | alias pointer (optional) | alias name (wildcard "*" is allowed) (optional) +| fset | fset_option | list of fset options | fset option pointer (optional) | option name (wildcard "*" is allowed) (optional) + | guile | guile_script | list of scripts | script pointer (optional) | script name (wildcard "*" is allowed) (optional) | irc | irc_channel | list of channels for an IRC server | channel pointer (optional) | server,channel (channel is optional) diff --git a/doc/en/autogen/plugin_api/plugins_priority.adoc b/doc/en/autogen/plugin_api/plugins_priority.adoc index 1ad2eebae..897838e0e 100644 --- a/doc/en/autogen/plugin_api/plugins_priority.adoc +++ b/doc/en/autogen/plugin_api/plugins_priority.adoc @@ -2,13 +2,14 @@ // This file is auto-generated by script docgen.py. // DO NOT EDIT BY HAND! // -. charset (14000) -. logger (13000) -. exec (12000) -. trigger (11000) -. aspell (10000) -. alias (9000) -. buflist (8000) +. charset (15000) +. logger (14000) +. exec (13000) +. trigger (12000) +. aspell (11000) +. alias (10000) +. buflist (9000) +. fset (8000) . fifo (7000) . xfer (6000) . irc (5000) diff --git a/doc/en/autogen/user/fset_commands.adoc b/doc/en/autogen/user/fset_commands.adoc new file mode 100644 index 000000000..7733cc3b1 --- /dev/null +++ b/doc/en/autogen/user/fset_commands.adoc @@ -0,0 +1,159 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +[[command_fset_fset]] +* `+fset+`: fast set WeeChat and plugins options + +---- +/fset -bar + -refresh + -up|-down [<number>] + -left|-right [<percent>] + -go <line>|end + -toggle + -add [<value>] + -reset + -unset + -set + -setnew + -append + -mark + -format + -export [-help|-nohelp] <filename> + <filter> + + -bar: add the help bar + -refresh: refresh list of options, then whole screen (command: /window refresh) + -up: move the selected line up by "number" lines + -down: move the selected line down by "number" lines + -left: scroll the fset buffer by "percent" of width on the left + -right: scroll the fset buffer by "percent" of width on the right + -go: select a line by number, first line number is 0 ("end" to select the last line) + -toggle: toggle the boolean value, set a new value for other types + -add: add "value" (which can be a negative number) for integers and colors, set/append to value for other types (set for a negative value, append for a positive value) + -reset: reset the value of option + -unset: unset the option + -set: add the /set command in input to edit the value of option (move the cursor at the beginning of value) + -setnew: add the /set command in input to edit a new value for the option + -append: add the /set command to append something in the value of option (move the cursor at the end of value) + -mark: toggle mark + -format: switch to the next available format + -export: export the options and values displayed in a file (each line has format: "/set name value" or "/unset name") + -help: force writing of help on options in exported file (see /help fset.look.export_help_default) + -nohelp: do not write help on options in exported file (see /help fset.look.export_help_default) + filter: set a new filter to see only matching options (this filter can be used as input in fset buffer as well); allowed formats are: + * show all options (no filter) + xxx show only options with "xxx" in name + f:xxx show only configuration file "xxx" + t:xxx show only type "xxx" (bool/int/str/col) + d show only changed options + d:xxx show only changed options with "xxx" in name + d=xxx show only changed options with "xxx" in value + d==xxx show only changed options with exact value "xxx" + =xxx show only options with "xxx" in value + ==xxx show only options with exact value "xxx" + c:xxx show only options matching the evaluated condition "xxx", using following variables: file, section, option, name, parent_name, type, type_en, type_short (bool/int/str/col), type_tiny (b/i/s/c), default_value, default_value_undef, value, quoted_value, value_undef, value_changed, parent_value, min, max, description, description2, description_en, description_en2, string_values + +The lines with options are displayed using string evaluation (see /help eval for the format), with these options: + - fset.format.option{1,2}: formats for an option which is not marked nor the selected line + - fset.format.option_marked{1,2}: formats for a marked option + - fset.format.option_selected{1,2}: formats for the selected option + +The following variables can be used in these options: + - option data, with color and padded by spaces on the right: + - ${file}: configuration file (for example "weechat" or "irc") + - ${section}: section + - ${option}: option name + - ${name}: full option name (file.section.option) + - ${parent_name}: parent option name + - ${type}: option type (translated) + - ${type_en}: option type (in English) + - ${type_short}: short option type (bool/int/str/col) + - ${type_tiny}: tiny option type (b/i/s/c) + - ${default_value}: option default value + - ${default_value_undef}: "1" if default value is null, otherwise "0" + - ${value}: option value + - ${value_undef}: "1" if value is null, otherwise "0" + - ${value_changed}: "1" if value is different from default value, otherwise "0" + - ${value2}: option value, with inherited value if null + - ${parent_value}: parent option value + - ${min}: min value + - ${max}: max value + - ${description}: option description (translated) + - ${description2}: option description (translated), "(no description)" (translated) if there's no description + - ${description_en}: option description (in English) + - ${description_en2}: option description (in English), "(no description)" if there's no description + - ${string_values}: string values allowed for set of an integer option using strings + - ${marked}: "1" if option is marked, otherwise "0" + - ${index}: index of option in list + - option data, with color but no spaces: + - same names prefixed by underscore, for example: ${_name}, ${_type}, ... + - option data, raw format (no colors/spaces): + - same names prefixed by two underscores, for example: ${__name}, ${__type}, ... + - option data, only spaces: + - same names prefixed with "empty_", for example: ${empty_name}, ${empty_type} + - other data: + - ${selected_line}: "1" if the line is selected, otherwise "0" + - ${newline}: insert a new line at point, so the option is displayed on multiple lines + +Keys and input to move in on fset buffer: + up move one line up + down move one line down + pgup move one page up + pgdn move one page down + alt-home << move to first line + alt-end >> move to last line + F11 < scroll horizontally on the left + F12 > scroll horizontally on the right + +Keys and input to set options on fset buffer: + alt+space t toggle boolean value + alt+'-' - subtract 1 from value for integer/color, set value for other types + alt+'+' + add 1 to value for integer/color, append to value for other types + alt+f, alt+r r reset value + alt+f, alt+u u unset value + alt+enter s set value + alt+f, alt+n n set new value + alt+f, alt+a a append to value + alt+',' , mark/unmark option + shift+up move one line up and mark/unmark option + shift+down mark/unmark option and move one line down + m:xxx mark options displayed that are matching filter "xxx" (any filter on option or value is allowed, see filters above) + u:xxx unmark options displayed that are matching filter "xxx" (any filter on option or value is allowed, see filters above) + +Other keys and input on fset buffer: + ctrl+L refresh options and whole screen (command: /fset -refresh) + $ refresh options (keep marked options) + $$ refresh options (unmark all options) + p toggle plugin description options (plugins.desc.*) + v toggle help bar + s:x,y sort options by fields x,y (see /help fset.look.sort) + s: reset sort to its default value (see /help fset.look.sort) + w:xxx export options in file "xxx" + w-:xxx export options in file "xxx" without help + w+:xxx export options in file "xxx" with help + ctrl+X x switch the format used to display options + q close fset buffer + +Mouse actions on fset buffer: + wheel up/down move line up/down + left button move line here + right button toggle boolean (on/off) or edit the option value + right button + drag left/right increase/decrease value for integer/color, set/append to value for other types + right button + drag up/down mark/unmark multiple options + +Note: spaces at beginning of input are ignored, so for example "q" closes the fset buffer while " q" searches all options with "q" inside name. + +Examples: + show IRC options changed: + /fset d:irc.* + show all options with "nicklist" in name: + /fset nicklist + show all values which contain "red": + /fset =red + show all values which are exactly "red": + /fset ==red + show all integer options in irc plugin: + /fset c:${file} == irc && ${type_en} == integer +---- diff --git a/doc/en/autogen/user/fset_options.adoc b/doc/en/autogen/user/fset_options.adoc new file mode 100644 index 000000000..6497f78e8 --- /dev/null +++ b/doc/en/autogen/user/fset_options.adoc @@ -0,0 +1,483 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +* [[option_fset.color.default_value]] *fset.color.default_value* +** description: pass:none[color for default value] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.default_value_selected]] *fset.color.default_value_selected* +** description: pass:none[color for default value on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.description]] *fset.color.description* +** description: pass:none[color for description] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.description_selected]] *fset.color.description_selected* +** description: pass:none[color for description on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.file]] *fset.color.file* +** description: pass:none[color for file] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.file_changed]] *fset.color.file_changed* +** description: pass:none[color for file if value is changed] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+brown+` + +* [[option_fset.color.file_changed_selected]] *fset.color.file_changed_selected* +** description: pass:none[color for file if value is changed on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+yellow+` + +* [[option_fset.color.file_selected]] *fset.color.file_selected* +** description: pass:none[color for file on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.help_default_value]] *fset.color.help_default_value* +** description: pass:none[color for default value in help bar] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.help_description]] *fset.color.help_description* +** description: pass:none[color for description in help bar] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.help_name]] *fset.color.help_name* +** description: pass:none[color for name in help bar] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.help_quotes]] *fset.color.help_quotes* +** description: pass:none[color for quotes around string values] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+darkgray+` + +* [[option_fset.color.help_values]] *fset.color.help_values* +** description: pass:none[color for allowed values] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.index]] *fset.color.index* +** description: pass:none[color for index of option] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+cyan+` + +* [[option_fset.color.index_selected]] *fset.color.index_selected* +** description: pass:none[color for index of option on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+lightcyan+` + +* [[option_fset.color.line_marked_bg1]] *fset.color.line_marked_bg1* +** description: pass:none[background color for a marked line (used with the first format, see option fset.format.option1)] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.line_marked_bg2]] *fset.color.line_marked_bg2* +** description: pass:none[background color for a marked line (used with the second format, see option fset.format.option2)] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.line_selected_bg1]] *fset.color.line_selected_bg1* +** description: pass:none[background color for the selected line (used with the first format, see option fset.format.option1)] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+blue+` + +* [[option_fset.color.line_selected_bg2]] *fset.color.line_selected_bg2* +** description: pass:none[background color for the selected line (used with the second format, see option fset.format.option2)] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+red+` + +* [[option_fset.color.marked]] *fset.color.marked* +** description: pass:none[color for mark indicator] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+brown+` + +* [[option_fset.color.marked_selected]] *fset.color.marked_selected* +** description: pass:none[color for mark indicator on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+yellow+` + +* [[option_fset.color.max]] *fset.color.max* +** description: pass:none[color for max value] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.max_selected]] *fset.color.max_selected* +** description: pass:none[color for max value on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.min]] *fset.color.min* +** description: pass:none[color for min value] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.min_selected]] *fset.color.min_selected* +** description: pass:none[color for min value on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.name]] *fset.color.name* +** description: pass:none[color for name] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.name_changed]] *fset.color.name_changed* +** description: pass:none[color for name if value is changed] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+brown+` + +* [[option_fset.color.name_changed_selected]] *fset.color.name_changed_selected* +** description: pass:none[color for name if value is changed on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+yellow+` + +* [[option_fset.color.name_selected]] *fset.color.name_selected* +** description: pass:none[color for name on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.option]] *fset.color.option* +** description: pass:none[color for option] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.option_changed]] *fset.color.option_changed* +** description: pass:none[color for option if value is changed] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+brown+` + +* [[option_fset.color.option_changed_selected]] *fset.color.option_changed_selected* +** description: pass:none[color for option if value is changed on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+yellow+` + +* [[option_fset.color.option_selected]] *fset.color.option_selected* +** description: pass:none[color for option on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.parent_name]] *fset.color.parent_name* +** description: pass:none[color for name of parent option] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.parent_name_selected]] *fset.color.parent_name_selected* +** description: pass:none[color for name of parent option on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.parent_value]] *fset.color.parent_value* +** description: pass:none[color for value of parent option] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+cyan+` + +* [[option_fset.color.parent_value_selected]] *fset.color.parent_value_selected* +** description: pass:none[color for value of parent option on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+lightcyan+` + +* [[option_fset.color.quotes]] *fset.color.quotes* +** description: pass:none[color for quotes around string values] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+darkgray+` + +* [[option_fset.color.quotes_changed]] *fset.color.quotes_changed* +** description: pass:none[color for quotes around string values which are changed] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.quotes_changed_selected]] *fset.color.quotes_changed_selected* +** description: pass:none[color for quotes around string values which are changed on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.quotes_selected]] *fset.color.quotes_selected* +** description: pass:none[color for quotes around string values on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.section]] *fset.color.section* +** description: pass:none[color for section] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.section_changed]] *fset.color.section_changed* +** description: pass:none[color for section if value is changed] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+brown+` + +* [[option_fset.color.section_changed_selected]] *fset.color.section_changed_selected* +** description: pass:none[color for section if value is changed on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+yellow+` + +* [[option_fset.color.section_selected]] *fset.color.section_selected* +** description: pass:none[color for section on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.string_values]] *fset.color.string_values* +** description: pass:none[color for string values] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.string_values_selected]] *fset.color.string_values_selected* +** description: pass:none[color for string values on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.title_count_options]] *fset.color.title_count_options* +** description: pass:none[color for the count of options found with the current filter in title of buffer] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+cyan+` + +* [[option_fset.color.title_current_option]] *fset.color.title_current_option* +** description: pass:none[color for current option number in title of buffer] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+lightcyan+` + +* [[option_fset.color.title_filter]] *fset.color.title_filter* +** description: pass:none[color for filter in title of buffer] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+yellow+` + +* [[option_fset.color.title_marked_options]] *fset.color.title_marked_options* +** description: pass:none[color for number of marked options in title of buffer] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+lightgreen+` + +* [[option_fset.color.title_sort]] *fset.color.title_sort* +** description: pass:none[color for sort in title of buffer] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.type]] *fset.color.type* +** description: pass:none[color for type] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+green+` + +* [[option_fset.color.type_selected]] *fset.color.type_selected* +** description: pass:none[color for type on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+lightgreen+` + +* [[option_fset.color.unmarked]] *fset.color.unmarked* +** description: pass:none[color for mark indicator when the option is not marked] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+default+` + +* [[option_fset.color.unmarked_selected]] *fset.color.unmarked_selected* +** description: pass:none[color for mark indicator when the option is not marked on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+white+` + +* [[option_fset.color.value]] *fset.color.value* +** description: pass:none[color for value] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+cyan+` + +* [[option_fset.color.value_changed]] *fset.color.value_changed* +** description: pass:none[color for value changed (different from default)] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+brown+` + +* [[option_fset.color.value_changed_selected]] *fset.color.value_changed_selected* +** description: pass:none[color for value changed (different from default) on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+yellow+` + +* [[option_fset.color.value_selected]] *fset.color.value_selected* +** description: pass:none[color for value on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+lightcyan+` + +* [[option_fset.color.value_undef]] *fset.color.value_undef* +** description: pass:none[color for undefined value] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+magenta+` + +* [[option_fset.color.value_undef_selected]] *fset.color.value_undef_selected* +** description: pass:none[color for undefined value on the selected line] +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline +** default value: `+lightmagenta+` + +* [[option_fset.format.export_help]] *fset.format.export_help* +** description: pass:none[format of help line written before each option exported in a file (note: content is evaluated, see /help fset)] +** type: string +** values: any string +** default value: `+"# ${description2}"+` + +* [[option_fset.format.export_option]] *fset.format.export_option* +** description: pass:none[format of each option exported in a file (note: content is evaluated, see /help fset)] +** type: string +** values: any string +** default value: `+"/set ${name} ${quoted_value}"+` + +* [[option_fset.format.export_option_null]] *fset.format.export_option_null* +** description: pass:none[format of each option with "null" value exported in a file (note: content is evaluated, see /help fset)] +** type: string +** values: any string +** default value: `+"/unset ${name}"+` + +* [[option_fset.format.option1]] *fset.format.option1* +** description: pass:none[first format of each line with an option which is not marked nor the selected one (note: content is evaluated, see /help fset); formats can be switched with key ctrl+X] +** type: string +** values: any string +** default value: `+"${marked} ${name} ${type} ${value2}"+` + +* [[option_fset.format.option2]] *fset.format.option2* +** description: pass:none[second format of each line with an option which is not marked not the selected one (note: content is evaluated, see /help fset); formats can be switched with key ctrl+X] +** type: string +** values: any string +** default value: `+"${marked} ${name} ${type} ${value2}${newline} ${empty_name} ${_default_value}${color:darkgray} -- ${min}..${max}${newline} ${empty_name} ${description}"+` + +* [[option_fset.look.auto_unmark]] *fset.look.auto_unmark* +** description: pass:none[automatically unmark all options after an action on marked options or after a refresh] +** type: boolean +** values: on, off +** default value: `+off+` + +* [[option_fset.look.condition_catch_set]] *fset.look.condition_catch_set* +** description: pass:none[condition to catch /set command and display results in the fset buffer; following variables can be used: ${name} (name of option given for the /set command), ${count} (number of options found with the /set argument); an empty string disables the catch of /set command; with value "1", the fset buffer is always used with /set command] +** type: string +** values: any string +** default value: `+"${count} >= 1"+` + +* [[option_fset.look.export_help_default]] *fset.look.export_help_default* +** description: pass:none[write help for each option exported by default (this can be overridden with arguments "-help" and "-nohelp" for command /fset -export)] +** type: boolean +** values: on, off +** default value: `+on+` + +* [[option_fset.look.format_number]] *fset.look.format_number* +** description: pass:none[number of format used to display options; this is dynamically changed by the key ctrl-X on the fset buffer] +** type: integer +** values: 1 .. 2 +** default value: `+1+` + +* [[option_fset.look.marked_string]] *fset.look.marked_string* +** description: pass:none[string displayed when an option is marked (to do an action on multiple options)] +** type: string +** values: any string +** default value: `+"*"+` + +* [[option_fset.look.scroll_horizontal]] *fset.look.scroll_horizontal* +** description: pass:none[left/right scroll in fset buffer (percent of width)] +** type: integer +** values: 1 .. 100 +** default value: `+10+` + +* [[option_fset.look.show_help_bar]] *fset.look.show_help_bar* +** description: pass:none[display help bar in fset buffer (description of option, allowed values and default value)] +** type: boolean +** values: on, off +** default value: `+on+` + +* [[option_fset.look.show_plugins_desc]] *fset.look.show_plugins_desc* +** description: pass:none[show the plugin description options (plugins.desc.*)] +** type: boolean +** values: on, off +** default value: `+off+` + +* [[option_fset.look.sort]] *fset.look.sort* +** description: pass:none[comma-separated list of fields to sort options (see /help fset for a list of fields); char "-" can be used before field to reverse order, char "~" can be used to do a case insensitive comparison; example: "-~name" for case insensitive and reverse sort on option name] +** type: string +** values: any string +** default value: `+"~name"+` + +* [[option_fset.look.unmarked_string]] *fset.look.unmarked_string* +** description: pass:none[string displayed when an option is not marked] +** type: string +** values: any string +** default value: `+" "+` + +* [[option_fset.look.use_color_value]] *fset.look.use_color_value* +** description: pass:none[use the color to display value of color options] +** type: boolean +** values: on, off +** default value: `+off+` + +* [[option_fset.look.use_keys]] *fset.look.use_keys* +** description: pass:none[use keys alt+X in fset buffer to do actions on options; if disabled, only the input is allowed] +** type: boolean +** values: on, off +** default value: `+on+` + +* [[option_fset.look.use_mute]] *fset.look.use_mute* +** description: pass:none[use /mute command to set options] +** type: boolean +** values: on, off +** default value: `+off+` |