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

209 lines
18 KiB
Plaintext

//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_script.color.status_autoloaded]] *script.color.status_autoloaded*
** description: pass:none[color for status "autoloaded" ("a")]
** 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_script.color.status_held]] *script.color.status_held*
** description: pass:none[color for status "held" ("H")]
** 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_script.color.status_installed]] *script.color.status_installed*
** description: pass:none[color for status "installed" ("i")]
** 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_script.color.status_obsolete]] *script.color.status_obsolete*
** description: pass:none[color for status "obsolete" ("N")]
** 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_script.color.status_popular]] *script.color.status_popular*
** description: pass:none[color for status "popular" ("*")]
** 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_script.color.status_running]] *script.color.status_running*
** description: pass:none[color for status "running" ("r")]
** 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_script.color.status_unknown]] *script.color.status_unknown*
** description: pass:none[color for status "unknown" ("?")]
** 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_script.color.text]] *script.color.text*
** description: pass:none[text color in script 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: `+default+`)
* [[option_script.color.text_bg]] *script.color.text_bg*
** description: pass:none[background color in script 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: `+default+`)
* [[option_script.color.text_bg_selected]] *script.color.text_bg_selected*
** description: pass:none[background color for selected line in script 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: `+red+`)
* [[option_script.color.text_date]] *script.color.text_date*
** description: pass:none[text color of dates in script 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: `+default+`)
* [[option_script.color.text_date_selected]] *script.color.text_date_selected*
** description: pass:none[text color of dates for selected line in script 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_script.color.text_delimiters]] *script.color.text_delimiters*
** description: pass:none[text color of delimiters in script 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: `+default+`)
* [[option_script.color.text_description]] *script.color.text_description*
** description: pass:none[text color of description in script 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: `+default+`)
* [[option_script.color.text_description_selected]] *script.color.text_description_selected*
** description: pass:none[text color of description for selected line in script 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_script.color.text_extension]] *script.color.text_extension*
** description: pass:none[text color of extension in script 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: `+default+`)
* [[option_script.color.text_extension_selected]] *script.color.text_extension_selected*
** description: pass:none[text color of extension for selected line in script 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_script.color.text_name]] *script.color.text_name*
** description: pass:none[text color of script name in script 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_script.color.text_name_selected]] *script.color.text_name_selected*
** description: pass:none[text color of script name for selected line in script 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_script.color.text_selected]] *script.color.text_selected*
** description: pass:none[text color for selected line in script 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_script.color.text_tags]] *script.color.text_tags*
** description: pass:none[text color of tags in script 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: `+brown+`)
* [[option_script.color.text_tags_selected]] *script.color.text_tags_selected*
** description: pass:none[text color of tags for selected line in script 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_script.color.text_version]] *script.color.text_version*
** description: pass:none[text color of version in script 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: `+magenta+`)
* [[option_script.color.text_version_loaded]] *script.color.text_version_loaded*
** description: pass:none[text color of version loaded in script 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: `+default+`)
* [[option_script.color.text_version_loaded_selected]] *script.color.text_version_loaded_selected*
** description: pass:none[text color of version loaded for selected line in script 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_script.color.text_version_selected]] *script.color.text_version_selected*
** description: pass:none[text color of version for selected line in script 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: `+lightmagenta+`)
* [[option_script.look.columns]] *script.look.columns*
** description: pass:none[format of columns displayed in script buffer: following column identifiers are replaced by their value: %a=author, %d=description, %D=date added, %e=extension, %l=language, %L=license, %n=name with extension, %N=name, %r=requirements, %s=status, %t=tags, %u=date updated, %v=version, %V=version loaded, %w=min_weechat, %W=max_weechat)]
** type: string
** values: any string (default value: `+"%s %n %V %v %u | %d | %t"+`)
* [[option_script.look.diff_color]] *script.look.diff_color*
** description: pass:none[colorize output of diff]
** type: boolean
** values: on, off (default value: `+on+`)
* [[option_script.look.diff_command]] *script.look.diff_command*
** description: pass:none[command used to show differences between script installed and the new version in repository ("auto" = auto detect diff command (git or diff), empty value = disable diff, other string = name of command, for example "diff")]
** type: string
** values: any string (default value: `+"auto"+`)
* [[option_script.look.display_source]] *script.look.display_source*
** description: pass:none[display source code of script on buffer with detail on a script (script is downloaded in a temporary file when detail on script is displayed)]
** type: boolean
** values: on, off (default value: `+on+`)
* [[option_script.look.quiet_actions]] *script.look.quiet_actions*
** description: pass:none[quiet actions on script buffer: do not display messages on core buffer when scripts are installed/removed/loaded/unloaded (only errors are displayed)]
** type: boolean
** values: on, off (default value: `+on+`)
* [[option_script.look.sort]] *script.look.sort*
** description: pass:none[default sort keys for scripts: comma-separated list of identifiers: a=author, A=autoloaded, d=date added, e=extension, i=installed, l=language, n=name, o=obsolete, p=popularity, r=running, u=date updated; char "-" can be used before identifier to reverse order; example: "i,u": installed scripts first, sorted by update date]
** type: string
** values: any string (default value: `+"p,n"+`)
* [[option_script.look.translate_description]] *script.look.translate_description*
** description: pass:none[translate description of scripts (if translation is available in your language, otherwise English version is used)]
** type: boolean
** values: on, off (default value: `+on+`)
* [[option_script.look.use_keys]] *script.look.use_keys*
** description: pass:none[use keys alt+X in script buffer to do actions on scripts (alt+i = install, alt+r = remove, ...); if disabled, only the input is allowed: i, r, ...]
** type: boolean
** values: on, off (default value: `+on+`)
* [[option_script.scripts.autoload]] *script.scripts.autoload*
** description: pass:none[autoload scripts installed (make a link in "autoload" directory to script in parent directory)]
** type: boolean
** values: on, off (default value: `+on+`)
* [[option_script.scripts.cache_expire]] *script.scripts.cache_expire*
** description: pass:none[local cache expiration time, in minutes (-1 = never expires, 0 = always expire)]
** type: integer
** values: -1 .. 525600 (default value: `+1440+`)
* [[option_script.scripts.download_timeout]] *script.scripts.download_timeout*
** description: pass:none[timeout (in seconds) for download of scripts and list of scripts]
** type: integer
** values: 1 .. 3600 (default value: `+30+`)
* [[option_script.scripts.hold]] *script.scripts.hold*
** description: pass:none[scripts to "hold": comma-separated list of scripts which will never been upgraded and can not be removed, for example: "buffers.pl,iset.pl"]
** type: string
** values: any string (default value: `+""+`)
* [[option_script.scripts.path]] *script.scripts.path*
** description: pass:none[local cache directory for scripts; "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default) (note: content is evaluated, see /help eval)]
** type: string
** values: any string (default value: `+"%h/script"+`)
* [[option_script.scripts.url]] *script.scripts.url*
** description: pass:none[URL for file with list of scripts; by default HTTPS is forced, see option script.scripts.url_force_https]
** type: string
** values: any string (default value: `+"http://weechat.org/files/plugins.xml.gz"+`)
* [[option_script.scripts.url_force_https]] *script.scripts.url_force_https*
** description: pass:none[force use of HTTPS for downloads (index and scripts); you should disable this option only if you have problems with the downloads]
** type: boolean
** values: on, off (default value: `+on+`)