summaryrefslogtreecommitdiff
path: root/doc/en/autogen/user/script_options.asciidoc
blob: e89d3b743d028be0ca8d62174d1e423bfed76a52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
* [[option_script.color.status_autoloaded]] *script.color.status_autoloaded*
** description: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `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: `colorize output of diff`
** type: boolean
** values: on, off (default value: `on`)

* [[option_script.look.diff_command]] *script.look.diff_command*
** description: `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: `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: `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: `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: `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: `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: `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: `local cache expiration time, in minutes (-1 = never expires, 0 = always expire)`
** type: integer
** values: -1 .. 525600 (default value: `1440`)

* [[option_script.scripts.dir]] *script.scripts.dir*
** description: `local cache directory for scripts`
** type: string
** values: any string (default value: `"%h/script"`)

* [[option_script.scripts.hold]] *script.scripts.hold*
** description: `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.url]] *script.scripts.url*
** description: `URL for file with list of scripts`
** 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: `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`)