Syntax rewrite for S-commands

Rewrote the syntax documentation for all commands starting with S.
This commit is contained in:
Geert Hauwaerts 2014-07-30 14:29:06 +02:00
commit 822db3090f
9 changed files with 226 additions and 92 deletions

View file

@ -1,19 +1,32 @@
%9Syntax:%9
@SYNTAX:script@
Irssi has very powerful support for scripts written in Perl - they can extend functionality of Irssi in almost unlimited way, and they still keep the client's core unbloated, light and fast. You can control loading and execution of such scripts by this command.
%9Parameters:%9
Without any parameters, /SCRIPT acts in same way as if you would call /SCRIPT LIST.
LIST: Displays the list of loaded scripts.
EXEC: Executes the given code.
LOAD: Loads the given script into the memory and executes it.
UNLOAD: Unloads the given script from the memory.
RESET: Unloads all the scripts.
-permanent: In combination with EXEC, the code will be loaded into the
memory.
/SCRIPT LIST displays list of all currently loaded scripts, together with full path to their source files.
If no argument is given, the list of active scripts will be displayed.
/SCRIPT EXEC executes the <commands> as a little perl script. It doesn't preserve it loaded in memory, unless -permanent is specified.
%9Description:%9
/SCRIPT LOAD loads the <script> in memory and executes it.
Interact with the Perl engine to execute scripts.
/SCRIPT UNLOAD unloads the <script> from memory.
%9Examples:%9
/SCRIPT RESET unloads all loaded scripts and resets the perl interpreter.
/SCRIPT
/SCRIPT LIST
/SCRIPT LOAD ~/.irssi/scripts/nickserv.pl
/SCRIPT UNLOAD nickserv
/SCRIPT RESET
/SCRIPT EXEC foreach my $channel (Irssi::channels()) { Irssi::print($channel->{name} . " @ " . $channel->{server}->{tag}); }
See also: LOAD, UNLOAD
%9See also:%9 LOAD, SAVE, UNLOAD