weechat/doc/en/autogen/user/spell_options.adoc

82 lines
4.6 KiB
Plaintext

//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_spell.check.commands]] *spell.check.commands*
** description: pass:none[comma separated list of commands for which spell checking is enabled (spell checking is disabled for all other commands)]
** type: string
** values: any string
** default value: `+"ame,amsg,away,command,cycle,kick,kickban,me,msg,notice,part,query,quit,topic"+`
* [[option_spell.check.default_dict]] *spell.check.default_dict*
** description: pass:none[default dictionary (or comma separated list of dictionaries) to use when buffer has no dictionary defined (leave blank to disable spell checker on buffers for which you didn't explicitly enabled it)]
** type: string
** values: any string
** default value: `+""+`
* [[option_spell.check.during_search]] *spell.check.during_search*
** description: pass:none[check words during text search in buffer]
** type: boolean
** values: on, off
** default value: `+off+`
* [[option_spell.check.enabled]] *spell.check.enabled*
** description: pass:none[enable spell checker for command line]
** type: boolean
** values: on, off
** default value: `+off+`
* [[option_spell.check.real_time]] *spell.check.real_time*
** description: pass:none[real-time spell checking of words (slower, disabled by default: words are checked only if there's delimiter after)]
** type: boolean
** values: on, off
** default value: `+off+`
* [[option_spell.check.suggestions]] *spell.check.suggestions*
** description: pass:none[number of suggestions to display in bar item "spell_suggest" for each dictionary set in buffer (-1 = disable suggestions, 0 = display all possible suggestions in all languages)]
** type: integer
** values: -1 .. 2147483647
** default value: `+-1+`
* [[option_spell.check.word_min_length]] *spell.check.word_min_length*
** description: pass:none[minimum length for a word to be spell checked (use 0 to check all words)]
** type: integer
** values: 0 .. 2147483647
** default value: `+2+`
* [[option_spell.color.misspelled]] *spell.color.misspelled*
** description: pass:none[text color for misspelled words (input 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: `+lightred+`
* [[option_spell.color.suggestion]] *spell.color.suggestion*
** description: pass:none[text color for suggestion on a misspelled word in bar item "spell_suggest"]
** 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_spell.color.suggestion_delimiter_dict]] *spell.color.suggestion_delimiter_dict*
** description: pass:none[text color for delimiters displayed between two dictionaries in bar item "spell_suggest"]
** 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_spell.color.suggestion_delimiter_word]] *spell.color.suggestion_delimiter_word*
** description: pass:none[text color for delimiters displayed between two words in bar item "spell_suggest"]
** 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_spell.look.suggestion_delimiter_dict]] *spell.look.suggestion_delimiter_dict*
** description: pass:none[delimiter displayed between two dictionaries in bar item "spell_suggest"]
** type: string
** values: any string
** default value: `+" / "+`
* [[option_spell.look.suggestion_delimiter_word]] *spell.look.suggestion_delimiter_word*
** description: pass:none[delimiter displayed between two words in bar item "spell_suggest"]
** type: string
** values: any string
** default value: `+","+`