summaryrefslogtreecommitdiff
path: root/doc/en/autogen
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en/autogen')
-rw-r--r--doc/en/autogen/plugin_api/completions.txt6
-rw-r--r--doc/en/autogen/plugin_api/hdata.txt27
-rw-r--r--doc/en/autogen/plugin_api/infolists.txt2
-rw-r--r--doc/en/autogen/user/script_commands.txt47
-rw-r--r--doc/en/autogen/user/script_options.txt155
5 files changed, 237 insertions, 0 deletions
diff --git a/doc/en/autogen/plugin_api/completions.txt b/doc/en/autogen/plugin_api/completions.txt
index bec6757fb..e0a545eb5 100644
--- a/doc/en/autogen/plugin_api/completions.txt
+++ b/doc/en/autogen/plugin_api/completions.txt
@@ -56,6 +56,12 @@
| ruby | ruby_script | list of scripts
+| script | script_files | files in script directories
+
+| script | script_scripts | list of scripts in repository
+
+| script | script_scripts_installed | list of scripts installed (from repository)
+
| tcl | tcl_script | list of scripts
| weechat | bars_names | names of bars
diff --git a/doc/en/autogen/plugin_api/hdata.txt b/doc/en/autogen/plugin_api/hdata.txt
index ee775c2dc..4c1276f56 100644
--- a/doc/en/autogen/plugin_api/hdata.txt
+++ b/doc/en/autogen/plugin_api/hdata.txt
@@ -257,6 +257,33 @@
'last_script' +
'scripts'
+| script | script_script | scripts from repository |
+ 'name' (string) +
+ 'name_with_extension' (string) +
+ 'language' (integer) +
+ 'author' (string) +
+ 'mail' (string) +
+ 'version' (string) +
+ 'license' (string) +
+ 'description' (string) +
+ 'tags' (string) +
+ 'requirements' (string) +
+ 'min_weechat' (string) +
+ 'max_weechat' (string) +
+ 'md5sum' (string) +
+ 'url' (string) +
+ 'popularity' (integer) +
+ 'date_added' (time) +
+ 'date_updated' (time) +
+ 'status' (integer) +
+ 'version_loaded' (string) +
+ 'displayed' (integer) +
+ 'install_order' (integer) +
+ 'prev_script' (pointer, hdata: 'script_script') +
+ 'next_script' (pointer, hdata: 'script_script') |
+ 'last_repo_script' +
+ 'repo_scripts'
+
| tcl | tcl_script | list of scripts |
'filename' (string) +
'interpreter' (pointer) +
diff --git a/doc/en/autogen/plugin_api/infolists.txt b/doc/en/autogen/plugin_api/infolists.txt
index 9b6b937fd..ba4720c4f 100644
--- a/doc/en/autogen/plugin_api/infolists.txt
+++ b/doc/en/autogen/plugin_api/infolists.txt
@@ -30,6 +30,8 @@
| ruby | ruby_script | list of scripts | script pointer (optional) | script name (can start or end with "*" as wildcard) (optional)
+| script | script_script | list of scripts | script pointer (optional) | script name with extension (can start or end with "*" as wildcard) (optional)
+
| tcl | tcl_script | list of scripts | script pointer (optional) | script name (can start or end with "*" as wildcard) (optional)
| weechat | bar | list of bars | bar pointer (optional) | bar name (can start or end with "*" as wildcard) (optional)
diff --git a/doc/en/autogen/user/script_commands.txt b/doc/en/autogen/user/script_commands.txt
new file mode 100644
index 000000000..ab430e4bd
--- /dev/null
+++ b/doc/en/autogen/user/script_commands.txt
@@ -0,0 +1,47 @@
+[[command_script_script]]
+[command]*`script`* WeeChat scripts manager::
+........................................
+/script list
+ show <script>
+ load|unload <script> [<script>...]
+ install|remove|hold <script> [<script>...]
+ upgrade
+ update
+
+ list: list loaded scripts (all languages)
+ show: show detailed info about a script
+ load: load script(s)
+ unload: unload script(s)
+ install: install/upgrade script(s)
+ remove: remove script(s)
+ hold: hold/unhold script(s) (a script held will not be upgraded any more and cannot be removed)
+ upgrade: upgrade all installed scripts which are obsolete (new version available)
+ update: update local scripts cache
+
+Without argument, this command opens a buffer with list of scripts.
+
+On script buffer, the possible status for each script are:
+ * i H r N
+ | | | | |
+ | | | | obsolete (new version available)
+ | | | running (loaded)
+ | | held
+ | installed
+ popular script
+
+Keys on script buffer:
+ alt+i install script
+ alt+r remove script
+ alt+l load script
+ alt+u unload script
+ alt+h (un)hold script
+
+Input allowed on script buffer:
+ q close buffer
+ r refresh buffer
+ s:x,y sort buffer using keys x and y (see /help script.look.sort)
+ s: reset sort (use default sort)
+ word(s) filter scripts: search word(s) in scripts (description, tags, ...)
+ * remove filter
+........................................
+
diff --git a/doc/en/autogen/user/script_options.txt b/doc/en/autogen/user/script_options.txt
new file mode 100644
index 000000000..bf858a874
--- /dev/null
+++ b/doc/en/autogen/user/script_options.txt
@@ -0,0 +1,155 @@
+* [[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 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 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 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 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 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 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 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 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 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 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 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 underline (default value: `darkgray`)
+
+* [[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 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 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 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 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 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 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 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 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 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 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 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 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 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.sort]] *script.look.sort*
+** description: `default sort keys for scripts: comma-separated list of identifiers: a=author, 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.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: `60`)
+
+* [[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://www.weechat.org/files/plugins.xml.gz"`)
+