summaryrefslogtreecommitdiff
path: root/doc/en/autogen/user/script_commands.asciidoc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2014-05-25 12:25:58 +0200
committerSébastien Helleu <flashcode@flashtux.org>2014-05-25 12:47:24 +0200
commitdc0229617ada67fd02815bbc94b245871248b9db (patch)
tree0af7418d7f3ebf8082408fa2ee9e73f5a572360f /doc/en/autogen/user/script_commands.asciidoc
parent76a066c9cca620e1204815f63abbfa8b09f162c6 (diff)
downloadweechat-dc0229617ada67fd02815bbc94b245871248b9db.zip
doc: use .asciidoc extension instead of .txt for doc files
Diffstat (limited to 'doc/en/autogen/user/script_commands.asciidoc')
-rw-r--r--doc/en/autogen/user/script_commands.asciidoc77
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/en/autogen/user/script_commands.asciidoc b/doc/en/autogen/user/script_commands.asciidoc
new file mode 100644
index 000000000..bdac7ab9c
--- /dev/null
+++ b/doc/en/autogen/user/script_commands.asciidoc
@@ -0,0 +1,77 @@
+[[command_script_script]]
+[command]*`script`* WeeChat scripts manager::
+
+----
+/script list [-o|-i]
+ search <text>
+ show <script>
+ load|unload|reload <script> [<script>...]
+ autoload|noautoload|toggleautoload <script> [<script>...]
+ install|remove|installremove|hold [-q] <script> [<script>...]
+ upgrade
+ update
+
+ list: list loaded scripts (all languages)
+ -o: send list of loaded scripts to buffer
+ -i: copy list of loaded scripts in command line (for sending to buffer)
+ search: search scripts by tags or text and display result on scripts buffer
+ show: show detailed info about a script
+ load: load script(s)
+ unload: unload script(s)
+ reload: reload script(s)
+ autoload: autoload the script
+ noautoload: do not autoload the script
+toggleautoload: toggle autoload
+ install: install/upgrade script(s)
+ remove: remove script(s)
+ installremove: install or remove script(s), depending on current state
+ hold: hold/unhold script(s) (a script held will not be upgraded any more and cannot be removed)
+ -q: quiet mode: do not display messages
+ 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 a H r N
+ | | | | | |
+ | | | | | obsolete (new version available)
+ | | | | running (loaded)
+ | | | held
+ | | autoloaded
+ | installed
+ popular script
+
+Keys on script buffer:
+ alt+i install script
+ alt+r remove script
+ alt+l load script
+ alt+L reload script
+ alt+u unload script
+ alt+A autoload script
+ alt+h (un)hold script
+ alt+v view script
+
+Input allowed on script buffer:
+ i/r/l/L/u/h action on script (same as keys above)
+ q close buffer
+ $ 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
+
+Mouse actions on script buffer:
+ wheel scroll list
+ left button select script
+ right button install/remove script
+
+Examples:
+ /script search url
+ /script install iset.pl buffers.pl
+ /script remove iset.pl
+ /script hold urlserver.py
+ /script reload urlserver
+ /script upgrade
+----
+