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

49 lines
3.0 KiB
Plaintext

//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_aspell.check.commands]] *aspell.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_aspell.check.default_dict]] *aspell.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 aspell on buffers for which you didn't explicitly enabled it)]
** type: string
** values: any string (default value: `+""+`)
* [[option_aspell.check.during_search]] *aspell.check.during_search*
** description: pass:none[check words during text search in buffer]
** type: boolean
** values: on, off (default value: `+off+`)
* [[option_aspell.check.enabled]] *aspell.check.enabled*
** description: pass:none[enable aspell check for command line]
** type: boolean
** values: on, off (default value: `+off+`)
* [[option_aspell.check.real_time]] *aspell.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_aspell.check.suggestions]] *aspell.check.suggestions*
** description: pass:none[number of suggestions to display in bar item "aspell_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_aspell.check.word_min_length]] *aspell.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_aspell.color.misspelled]] *aspell.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_aspell.color.suggestions]] *aspell.color.suggestions*
** description: pass:none[text color for suggestions on a misspelled word (status 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+`)