diff options
Diffstat (limited to 'doc/en/weechat_user.en.adoc')
| -rw-r--r-- | doc/en/weechat_user.en.adoc | 154 |
1 files changed, 103 insertions, 51 deletions
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc index c6178ca0e..136179844 100644 --- a/doc/en/weechat_user.en.adoc +++ b/doc/en/weechat_user.en.adoc @@ -226,13 +226,13 @@ List of commonly used options: Compile <<fset,Fset plugin>>. | ENABLE_GUILE | `ON`, `OFF` | ON | - Compile <<scripts_plugins,Guile plugin>> (Scheme). + Compile <<scripting_plugins,Guile plugin>> (Scheme). | ENABLE_IRC | `ON`, `OFF` | ON | Compile <<irc,IRC plugin>>. | ENABLE_JAVASCRIPT | `ON`, `OFF` | OFF | - Compile <<scripts_plugins,JavaScript plugin>>. + Compile <<scripting_plugins,JavaScript plugin>>. | ENABLE_LARGEFILE | `ON`, `OFF` | ON | Support of large files. @@ -241,7 +241,7 @@ List of commonly used options: Compile <<buffer_logging,Logger plugin>>. | ENABLE_LUA | `ON`, `OFF` | ON | - Compile <<scripts_plugins,Lua plugin>>. + Compile <<scripting_plugins,Lua plugin>>. | ENABLE_NCURSES | `ON`, `OFF` | ON | Compile Ncurses interface. @@ -250,35 +250,35 @@ List of commonly used options: Enable NLS (translations). | ENABLE_PERL | `ON`, `OFF` | ON | - Compile <<scripts_plugins,Perl plugin>>. + Compile <<scripting_plugins,Perl plugin>>. | ENABLE_PHP | `ON`, `OFF` | ON | - Compile <<scripts_plugins,PHP plugin>>. + Compile <<scripting_plugins,PHP plugin>>. | ENABLE_PYTHON | `ON`, `OFF` | ON | - Compile <<scripts_plugins,Python plugin>>. + Compile <<scripting_plugins,Python plugin>>. | ENABLE_PYTHON2 | `ON`, `OFF` | OFF | - Compile <<scripts_plugins,Python plugin>> using Python 2 instead of Python 3. + Compile <<scripting_plugins,Python plugin>> using Python 2 instead of Python 3. | ENABLE_RELAY | `ON`, `OFF` | ON | Compile <<relay,Relay plugin>>. | ENABLE_RUBY | `ON`, `OFF` | ON | - Compile <<scripts_plugins,Ruby plugin>>. + Compile <<scripting_plugins,Ruby plugin>>. | ENABLE_SCRIPT | `ON`, `OFF` | ON | - Compile <<scripts_plugins,Script plugin>>. + Compile <<script_manager,Script plugin>>. | ENABLE_SCRIPTS | `ON`, `OFF` | ON | - Compile <<scripts_plugins,script plugins>> (Python, Perl, Ruby, Lua, Tcl, + Compile <<scripting_plugins,script plugins>> (Python, Perl, Ruby, Lua, Tcl, Guile, JavaScript, PHP). | ENABLE_SPELL | `ON`, `OFF` | ON | Compile <<spell_checking,Spell plugin>>. | ENABLE_TCL | `ON`, `OFF` | ON | - Compile <<scripts_plugins,Tcl plugin>>. + Compile <<scripting_plugins,Tcl plugin>>. | ENABLE_TRIGGER | `ON`, `OFF` | ON | Compile <<trigger,Trigger plugin>>. @@ -1842,7 +1842,7 @@ These keys and actions are used on the fset buffer (see <<fset,Fset plugin>>). [[key_bindings_script_buffer]] === Script buffer -These keys and actions are used on the script buffer (see <<scripts_plugins,Script plugin>>). +These keys and actions are used on the script buffer (see <<script_manager,script manager>>). [width="100%",cols="^.^3,^.^2,.^8,.^5",options="header"] |=== @@ -4916,84 +4916,136 @@ To learn more about plugin or script development (through API), please read the link:weechat_plugin_api.en.html[WeeChat plugin API reference] or the link:weechat_scripting.en.html[WeeChat scripting guide]. -[[scripts_plugins]] +[[scripts]] === Scripts WeeChat provides 8 scripting plugins: Python, Perl, Ruby, Lua, Tcl, Guile (scheme), JavaScript and PHP. These plugins can load, execute and unload scripts for these languages. -Another plugin called "script" is a script manager and is used to load/unload -scripts of any language, and install/remove scripts of WeeChat scripts -repository, which are visible at this URL: https://weechat.org/scripts - For more information about how to write scripts, or WeeChat API for scripts, please read the link:weechat_scripting.en.html[WeeChat scripting guide]. +[[script_manager]] +==== Script manager + +The script manager (command <<command_script_script,/script>>) is used to +load/unload scripts of any language, and install/remove scripts of WeeChat +scripts repository, which are visible at this URL: https://weechat.org/scripts + +For privacy considerations, the download of scripts is disabled by default. + +To enable it, type this command: + +---- +/set script.scripts.download_enabled on +---- + +Then you can download the list of scripts and display them in a new buffer +with the <<command_script_script,/script>> command: + +[subs="quotes,attributes"] +:x: * +.... +┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│1.weechat│368/368 scripts (filter: {x}) | Sort: i,p,n | Alt+key/input: i=install, r=remove, l=load, L=reload, u=│ +│2.scripts│{x} autosort.py 3.9 2020-10-11 | Automatically keep buffers grouped by server│ +│ │{x} multiline.pl 0.6.3 2016-01-02 | Multi-line edit box, also supports editing o│ +│ │{x} highmon.pl 2.7 2020-06-21 | Adds a highlight monitor buffer. │ +│ │##{x}ia r grep.py 0.8.5 0.8.5 2021-05-11 | Search regular expression in buffers or log ##│ +│ │{x} autojoin.py 0.3.1 2019-10-06 | Configure autojoin for all servers according│ +│ │{x} colorize_nicks.py 28 2021-03-06 | Use the weechat nick colors in the chat area│ +│ │{x}ia r go.py 2.7 2.7 2021-05-26 | Quick jump to buffers. │ +│ │{x} text_item.py 0.9 2019-05-25 | Add bar items with plain text. │ +│ │ aesthetic.py 1.0.6 2020-10-25 | Make messages more A E S T H E T I C A L L Y│ +│ │ aformat.py 0.2 2018-06-21 | Alternate text formatting, useful for relays│ +│ │ alternatetz.py 0.3 2018-11-11 | Add an alternate timezone item. │ +│ │ amarok2.pl 0.7 2012-05-08 | Amarok 2 control and now playing script. │ +│ │ amqp_notify.rb 0.1 2011-01-12 | Send private messages and highlights to an A│ +│ │ announce_url_title.py 19 2021-06-05 | Announce URL title to user or to channel. │ +│ │ anotify.py 1.0.2 2020-05-16 | Notifications of private messages, highlight│ +│ │ anti_password.py 1.2.1 2021-03-13 | Prevent a password from being accidentally s│ +│ │ apply_corrections.py 1.3 2018-06-21 | Display corrected text when user sends s/typ│ +│ │ arespond.py 0.1.1 2020-10-11 | Simple autoresponder. │ +│ │ atcomplete.pl 0.001 2016-10-29 | Tab complete nicks when prefixed with "@". │ +│ │ audacious.pl 0.3 2009-05-03 | Display which song Audacious is currently pl│ +│ │ auth.rb 0.3 2014-05-30 | Automatically authenticate with NickServ usi│ +│ │ auto_away.py 0.4 2018-11-11 | A simple auto-away script. │ +│ │ autoauth.py 1.3 2021-11-07 | Permits to auto-authenticate when changing n│ +│ │ autobump.py 0.1.0 2019-06-14 | Bump buffers upon activity. │ +│ │ autoconf.py 0.4 2021-05-11 | Auto save/load changed options in a .weerc f│ +│ │ autoconnect.py 0.3.3 2019-10-06 | Reopen servers and channels opened last time│ +│ │[12:55] [2] [script] 2:scripts │ +│ │█ │ +└──────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ +.... + [[script_commands]] -==== Script commands +===== Script commands include::includes/autogen_user_commands.en.adoc[tag=script_commands] +[[script_options]] +===== Script options + +Sections in file _script.conf_: + +[width="100%",cols="3m,6m,16",options="header"] +|=== +| Section | Control command | Description +| look | /set script.look.* | Look and feel. +| color | /set script.color.* | Colors. +| scripts | /set script.scripts.* | Options for download of scripts. +|=== + +Options: + +include::includes/autogen_user_options.en.adoc[tag=script_options] + +[[scripting_plugins]] +==== Scripting plugins + [[python_commands]] -==== Python commands +===== Python commands include::includes/autogen_user_commands.en.adoc[tag=python_commands] [[perl_commands]] -==== Perl commands +===== Perl commands include::includes/autogen_user_commands.en.adoc[tag=perl_commands] [[ruby_commands]] -==== Ruby commands +===== Ruby commands include::includes/autogen_user_commands.en.adoc[tag=ruby_commands] [[lua_commands]] -==== Lua commands +===== Lua commands include::includes/autogen_user_commands.en.adoc[tag=lua_commands] [[tcl_commands]] -==== Tcl commands +===== Tcl commands include::includes/autogen_user_commands.en.adoc[tag=tcl_commands] [[guile_commands]] -==== Guile commands +===== Guile commands include::includes/autogen_user_commands.en.adoc[tag=guile_commands] [[javascript_commands]] -==== JavaScript commands +===== JavaScript commands include::includes/autogen_user_commands.en.adoc[tag=javascript_commands] [[php_commands]] -==== PHP commands +===== PHP commands include::includes/autogen_user_commands.en.adoc[tag=php_commands] -[[script_options]] -==== Script options - -Sections in file _script.conf_: - -[width="100%",cols="3m,6m,16",options="header"] -|=== -| Section | Control command | Description -| look | /set script.look.* | Look and feel. -| color | /set script.color.* | Colors. -| scripts | /set script.scripts.* | Options for download of scripts. -|=== - -Options: - -include::includes/autogen_user_options.en.adoc[tag=script_options] - [[python_options]] -==== Python options +===== Python options Sections in file _python.conf_: @@ -5008,7 +5060,7 @@ Options: include::includes/autogen_user_options.en.adoc[tag=python_options] [[perl_options]] -==== Perl options +===== Perl options Sections in file _perl.conf_: @@ -5023,7 +5075,7 @@ Options: include::includes/autogen_user_options.en.adoc[tag=perl_options] [[ruby_options]] -==== Ruby options +===== Ruby options Sections in file _ruby.conf_: @@ -5038,7 +5090,7 @@ Options: include::includes/autogen_user_options.en.adoc[tag=ruby_options] [[lua_options]] -==== Lua options +===== Lua options Sections in file _lua.conf_: @@ -5053,7 +5105,7 @@ Options: include::includes/autogen_user_options.en.adoc[tag=lua_options] [[tcl_options]] -==== Tcl options +===== Tcl options Sections in file _tcl.conf_: @@ -5068,7 +5120,7 @@ Options: include::includes/autogen_user_options.en.adoc[tag=tcl_options] [[guile_options]] -==== Guile options +===== Guile options Sections in file _guile.conf_: @@ -5083,7 +5135,7 @@ Options: include::includes/autogen_user_options.en.adoc[tag=guile_options] [[javascript_options]] -==== Javascript options +===== Javascript options Sections in file _javascript.conf_: @@ -5098,7 +5150,7 @@ Options: include::includes/autogen_user_options.en.adoc[tag=javascript_options] [[php_options]] -==== PHP options +===== PHP options Sections in file _php.conf_: |