Skript-Plugins
Vier Plugins werden von WeeChat angeboten um Skriptsprachen zu nutzen:
Perl, Python, Ruby und Lua.
Laden / Entfernen von Skripten
Scripts are loaded and unloaded with /perl,
/python, /ruby and
/lua commands
(type /help in WeeChat for help about commands).
Skripte werden mit den Kommandos /perl, /python,
/ruby und /lua geladen oder
entfernt. (Benutze /help in WeeChat für Hilfe zu
den Kommandos).
Beispiele:
Laden eines Perl-Skripts:
/perl load /tmp/test.pl
Liste alle geladenen Perl-Skripte auf:
/perl
Laden eines Python-Skripts:
/python load /tmp/test.py
Liste alle geladenen Python-Skripte auf:
/python
Laden eines Ruby-Skripts:
/ruby load /tmp/test.rb
Liste alle geladenen Ruby-Skripte auf:
/ruby
Laden eines Lua-Skripts:
/lua load /tmp/test.lua
Liste alle geladenen Lua-Skripte auf:
/luaSyntax in den SkriptsprachenPerl
In einem WeeChat-PerlSkript ist allen API-Funktionen und Variablen
ein "weechat::" vorangestellt.
Beispiel:
weechat::register("test", "1.0", "end_test", "WeeChat perl script");Python
Ein WeeChat-Pythonskript muss mit einer Importdirektive für WeeChat
beginnen:
import weechat
Allen API-Funktionen und Variablen ist ein
"weechat." vorangestellt.
Beispiel:
weechat.register("test", "1.0", "end_test", "WeeChat python script")Ruby
In einem WeeChat-Rubyskript muss der gesamte Code innerhalb von
Funktionen stehen. Für den Hauptteil ist die Funktion
"weechat_init" zu definieren, die automatisch
aufgerufen wird, wenn das Skript in WeeChat geladen wird.
Beispiel:
def weechat_init
Weechat.register("test", "1.0", "end_test", "WeeChat ruby script")
Weechat.add_command_handler("command", "my_command")
return Weechat::PLUGIN_RC_OK
end
def my_command(server, args)
Weechat.print("my command")
return Weechat::PLUGIN_RC_OK
end
Allen API-Funktionen ist "Weechat."
und Variablen "Weechat::" vorangestellt.
Lua
In einem WeeChat-Luaskript ist allen Funktionen ein
"weechat." vorangestellt. Variablen beginnen
mit "weechat." und enden mit
"()".
Beispiel:
function message_handler(server, args)
weechat.print("I am a message handler")
return weechat.PLUGIN_RC_OK()
end
WeeChat / Skript-APIregister
Perl-Prototyp:
weechat::register(name, version, end_function, description,
[charset]);
Python-Prototyp:
weechat.register(name, version, end_function, description,
[charset])
Ruby-Prototyp:
Weechat.register(name, version, end_function, description,
[charset])
Lua-Prototyp:
weechat.register(name, version, end_function, description,
[charset])
Das ist die erste Funktion, die in einem Skript aufgerufen wird.
Alle WeeChat-Skripte müssen diese Funktion aufrufen.
Argumente:
: eindeutiger Name des Skripts
(jedes Skript muss einen eindeutigen Namen besitzen)
: Version des Skripts
: Funktion, die aufgerufen
wird, wenn das Skript entfernt werden soll (optional; ein
leerer String bedeutet, dass nichts aufgerufen wird)
: eine kurze Beschreibung des
Skripts
: Zeichensatz, der von dem Script
benutzt wird, sollten Sie setzen, wenn das Script nicht in
UTF-8 geschrieben ist
Rückgabewert: 1 wenn das Skript registriert werden konnte, 0 wenn
ein Fehler aufgetaucht ist.
Beispiele:
# perl
weechat::register("test", "1.0", "end_test", "Test script!", "ISO-8859-1");
# python
weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1")
# ruby
Weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1")
-- lua
weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1")
set_charset
Perl-Prototyp:
weechat::set_charset(charset);
Python-Prototyp:
weechat.set_charset(charset)
Ruby-Prototyp:
Weechat.set_charset(charset)
Lua-Prototyp:
weechat.set_charset(charset)
Legt einen neuen Script-Zeichensatz fest.
Argumente:
: neuer Script-Zeichensatz
Rückgabewert: 1, wenn der Zeichensatz erfolgreich gesetzt wurd, 0,
wenn ein Fehler aufgetreten ist
Beispiele:
# perl
weechat::set_charset("ISO-8859-1");
# python
weechat.set_charset("ISO-8859-1")
# ruby
Weechat.set_charset("ISO-8859-1")
-- lua
weechat.set_charset("ISO-8859-1")
print
Perl-Prototyp:
weechat::print(message, [channel, [server]])
Python-Prototyp:
weechat.prnt(message, [channel, [server]])
Ruby-Prototyp:
Weechat.print(message, [channel, [server]])
Lua-Prototyp:
weechat.print(message, [channel, [server]])
Sende eine Nachricht an einen WeeChat-Puffer, identifiziert durch
Server und Channel.
Argumente:
: Nachricht
: Name des Channels, zu welchem der
Puffer gehört, in dem die
Nachricht angezeigt werden soll
: interner Name des Servers, zu
welchem der Puffer gehört, in dem die Nachricht angezeigt
werden soll
To display colored text, see .
Rückgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist
Beispiele:
# perl
weechat::print("message");
weechat::print("message", "#weechat");
weechat::print("message", "#weechat", "freenode");
weechat::print("test: \x0305 rot \x0F normal");
# python
weechat.prnt("message")
weechat.prnt("message", "#weechat")
weechat.prnt("message", "#weechat", "freenode")
# ruby
Weechat.print("message")
Weechat.print("message", "#weechat")
Weechat.print("message", "#weechat", "freenode")
-- lua
weechat.print("message")
weechat.print("message", "#weechat")
weechat.print("message", "#weechat", "freenode")
print_server
Perl prototype:
weechat::print_server(message)
Python prototype:
weechat.print_server(message)
Ruby prototype:
Weechat.print_server(message)
Lua prototype:
weechat.print_server(message)
Display a message on server buffer.
Arguments:
: message
To display colored text, see .
Return value: 1 if success, 0 if an error occurred.
Examples:
# perl
weechat::print_server("message");
weechat::print_server("test: \x0305 rot \x0F normal");
# python
weechat.print_server("message")
# ruby
Weechat.print_server("message")
-- lua
weechat.print_server("message")
log
Perl-Prototyp:
weechat::log(message, [channel, [server]]);
Python-Prototyp:
weechat.log(message, [channel, [server]])
Ruby-Prototyp:
Weechat.log(message, [channel, [server]])
Lua-Prototyp:
weechat.log(message, [channel, [server]])
Schreibe eine Nachricht in die Logdatei eines Servers oder Channels.
Argumente:
: Nachricht
: Name des Channels, zu welchem der
Puffer der Logdatei gehört
: interner Name des Servers, zu
welchem der Puffer der Logdatei gehört
Rückgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist.
Beispiel:
# perl
weechat::log("message", "#weechat", "freenode");
# python
weechat.log("message", "#weechat", "freenode")
# ruby
Weechat.log("message", "#weechat", "freenode")
-- lua
weechat.log("message", "#weechat", "freenode")
add_message_handler
Perl-Prototyp:
weechat::add_message_handler(message, function);
Python-Prototyp:
weechat.add_message_handler(message, function)
Ruby-Prototyp:
Weechat.add_message_handler(message, function)
Lua-Prototyp:
weechat.add_message_handler(message, function)
Erzeuge einen Nachrichten-Handler, der bei Empfang einer
IRC-Nachricht aufgerufen wird.
Argumente:
: Name (Typ) der IRC-Nachricht. Für
eine Liste
der bekannten Typen von IRC-Nachrichten konsultieren sie
bitte die
RFCs
1459
und
2812.
Mehr noch, sie können spezielle Ereignisse abfangen, indem
sie einen speziellen Namen verwenden, der mit
"weechat_" beginnt (siehe
).
: Funktion, die bei Empfang einer
Nachricht aufgerufen werden soll
Rückgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist.
Beispiele:
# perl
weechat::add_message_handler ("privmsg", "my_function");
sub my_function
{
weechat::print("server=$_[0]");
($null, $channel, $message) = split ":",$_[1],3;
($mask, $null, $channel) = split " ", $channel;
weechat::print("mask=$mask, channel=$channel, msg=$message");
return weechat::PLUGIN_RC_OK;
}
# python
weechat.add_message_handler ("privmsg", "my_function")
def my_function(server, args):
weechat.prnt("server="+server)
null, channel, message = string.split(args, ":", 2)
mask, null, channel = string.split(string.strip(channel), " ", 2)
weechat.prnt("mask="+mask+", canal="+channel+", message="+message)
return weechat.PLUGIN_RC_OK
# ruby
Weechat.add_message_handler("privmsg", "my_function")
def my_function(server, args)
Weechat.print("server=#{server}, args=#{args}")
return Weechat::PLUGIN_RC_OK
end
-- lua
weechat.add_message_handler ("privmsg", "my_function")
function my_function(server, args)
weechat.print("server=" .. server .. ", args=" .. args)
return weechat.PLUGIN_RC_OK()
end
Hinweis: die Funktion, die aufgerufen wird wenn eine Nachricht
empfangen wurde, muss einen der folgenden Werte zurückgeben:
PLUGIN_RC_KO: Funktion fehlgeschlagen
PLUGIN_RC_OK: Funktion war erfolgreich
PLUGIN_RC_OK_IGNORE_WEECHAT: Die Nachricht
wird nicht an WeeChat übergeben
PLUGIN_RC_OK_IGNORE_PLUGINS: Die Nachricht
wird nicht an andere Plugins
weitergegeben
PLUGIN_RC_OK_IGNORE_ALL: Die Nachricht
wird weder an WeeChat noch an andere Plugins übergeben
PLUGIN_RC_OK_WITH_HIGHLIGHT: Funktion
erfolgreich vervollständigt und eine Hervorhebung bei den
empfangenen Nachrichten eingebaut
add_command_handler
Perl-Prototyp:
weechat::add_command_handler(command, function,
[description, arguments, arguments_description,
completion_template]);
Python-Prototyp:
weechat.add_command_handler(command, function,
[description, arguments, arguments_description,
completion_template])
Ruby-Prototyp:
Weechat.add_command_handler(command, function,
[description, arguments, arguments_description,
completion_template])
Lua-Prototyp:
weechat.add_command_handler(command, function,
[description, arguments, arguments_description,
completion_template])
Erzeugt einen Kommando-Handler, der aufgerufen wird, wenn der
Anwender das Kommando benutzt (Beispiel: /command).
Argumente:
:
Name des neuen Kommandos, der auch Name eines bereits
existierenden Kommandos sein kann (mit Bedacht zu verwenden,
das ersetzte Kommando ist nicht verfügbar, bis das Plugin
entfernt wurde)
: Funktion, die aufgerufen wird,
wenn das Kommando ausgeführt wird
: eine kurze Beschreibung der
Argumente des Kommandos (werden angezeigt bei /help command)
: eine ausführliche
Beschreibung der Argumente des Kommandos (werden angezeigt
bei /help command)
:
Vorlage für die Vervollständigung; zum Beispiel bedeutet
"abc|%w def|%i", dass das
erste Argument "abc" oder ein WeeChat-Kommando sein kann
und das zweite Argument "def" oder ein IRC-Kommando.
(siehe )
Rückgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist
Beispiele:
# perl
weechat::add_command_handler("command", "my_command");
sub my_command
{
weechat::print("server= $_[0], args: $_[1]");
return weechat::PLUGIN_RC_OK;
}
# python
weechat.add_command_handler("command", "my_command")
def my_command(server, args):
weechat.prnt("server="+server+", args="+args)
return weechat.PLUGIN_RC_OK
# ruby
Weechat.add_command_handler("command", "my_command")
def my_command(server, args)
Weechat.print("server=#{server}, args=#{args}")
return Weechat::PLUGIN_RC_OK
end
-- lua
weechat.add_command_handler("command", "my_command")
def my_command(server, args)
weechat.print("server="..server..", args="..args)
return weechat.PLUGIN_RC_OK()
end
Hinweis: die Funktion, die aufgerufen wird wenn eine Nachricht
empfangen wurde, muss einen der folgenden Werte zurückgeben:
PLUGIN_RC_KO : Funktion ist fehlgeschlagen
PLUGIN_RC_OK : Funktion war erfolgreich
add_timer_handler
Perl-Prototyp:
weechat::add_timer_handler(interval, function);
Python-Prototyp:
weechat.add_timer_handler(interval, function)
Ruby-Prototyp:
Weechat.add_timer_handler(interval, function)
Lua-Prototyp:
weechat.add_timer_handler(interval, function)
Erzeugt einen zeitgesteuerten Handler, der periodisch eine Funktion
aufruft.
Argumente:
: Interval (in Sekunden) zwischen
zwei Aufrufen der Funktion.
: Funktion, die aufgerufen wird
Rückgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist
Beispiele:
# perl
weechat::add_timer_handler(60, "my_timer");
sub my_timer
{
weechat::print("this is timer handler");
return weechat::PLUGIN_RC_OK;
}
# python
weechat.add_timer_handler(60, "my_timer")
def my_timer():
weechat.prnt("this is timer handler")
return weechat.PLUGIN_RC_OK
# ruby
Weechat.add_timer_handler(60, "my_timer")
def my_timer()
Weechat.print("this is timer handler")
return Weechat::PLUGIN_RC_OK
end
-- lua
weechat.add_timer_handler(60, "my_timer")
function my_timer()
weechat.print("this is timer handler")
return weechat.PLUGIN_RC_OK()
end
Note: function called has to return one of following values:
Hinweis: die Funktion, die aufgerufen wird, muss
einen der folgenden Werte zurückgeben:
PLUGIN_RC_KO: Funktion ist fehlgeschlagen
PLUGIN_RC_OK: Funktion war erfolgreich
completed
add_keyboard_handler
Perl-Prototyp:
weechat::add_keyboard_handler(function);
Python-Prototyp:
weechat.add_keyboard_handler(function)
Ruby-Prototyp:
Weechat.add_keyboard_handler(function)
Lua-Prototyp:
weechat.add_keyboard_handler(function)
Erzeugt einen Keyboard-Handler, der für jeden Tastendruck
aufgerufen wird.
Argumente:
: Funktion, die aufgerufen wird
Rückgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist
Beispiele:
# perl
weechat::add_keyboard_handler("my_keyboard");
sub my_keyboard
{
my $key = shift;
my $input_before = shift;
my $input_after = shift;
weechat::print("keyboard handler: key = '$key', "
."input before = '$input_before' "
."after = '$input_after'");
return weechat::PLUGIN_RC_OK;
}
# python
weechat.add_keyboard_handler("my_keyboard")
def my_keyboard(key, input_before, input_after):
weechat.prnt("keyboard handler: key = '%s', " \
"input before = '%s' after = '%s'"
%(key, input_before, input_after))
return weechat.PLUGIN_RC_OK
# ruby
Weechat.add_keyboard_handler("my_keyboard")
def my_keyboard(key, input_before, input_after)
Weechat.print("keyboard handler: key = '#{key}', " \
"input before = '#{input_before}' " \
"after = '#{input_after}'")
return Weechat::PLUGIN_RC_OK
end
-- lua
weechat.add_keyboard_handler("my_keyboard")
function my_keyboard(key, input_before, input_after)
weechat.print("keyboard handler: key = '"..key..
"', input before = '"..input_before..
"' after = '"..input_after.."'")
return weechat.PLUGIN_RC_OK()
end
Hinweis: Die aufgerufene Funktion muss einen der folgenden Werte
zurückgeben:
PLUGIN_RC_KO: Funktion ist fehlgeschlagen
PLUGIN_RC_OK: Funktion war erfolgreich
add_event_handler
Perl-Prototyp:
weechat::add_event_handler(event, function);
Python-Prototyp:
weechat.add_event_handler(event, function)
Ruby-Prototyp:
Weechat.add_event_handler(event, function)
Lua-Prototyp:
weechat.add_event_handler(event, function)
Fügt einen Ereignis-Handler hinzu, der beim Auftreten eines
Ereignisses aufgerufen wird.
Argumente:
: Ereignis
(see )
: aufgerufene Funktion
Rückgabewerte: 1 bei Erfolg, 0 bei aufgetretenen Fehlern
Beispiele:
# perl
weechat::add_event_handler("buffer_open", "my_event");
sub my_event
{
weechat::print("buffer open");
return weechat::PLUGIN_RC_OK;
}
# python
weechat.add_event_handler("buffer_open", "my_event")
def my_event():
weechat.prnt("buffer open")
return weechat.PLUGIN_RC_OK
# ruby
Weechat.add_event_handler("buffer_open", "my_event")
def my_event()
Weechat.print("buffer open")
return Weechat::PLUGIN_RC_OK
end
-- lua
weechat.add_event_handler("buffer_open", "my_event")
function my_event()
weechat.print("buffer open")
return weechat.PLUGIN_RC_OK()
end
Bemerkung: aufgerufene Funktion muss einen der folgenden Werte
zurückgeben:
PLUGIN_RC_KO: Funktion fehlgeschlagen
PLUGIN_RC_OK: Funktion erfolgreich beendet
remove_handler
Perl-Prototyp:
weechat::remove_handler(name, function);
Python-Prototyp:
weechat.remove_handler(name, function)
Ruby-Prototyp:
Weechat.remove_handler(name, function)
Lua-Prototyp:
weechat.remove_handler(name, function)
Entfernt einen Nachrichten- oder Kommando-Handler.
Argumente:
: Name der IRC-Message oder Kommando
: Funktion
Rückgabewert: 1 bei Erfolg, 0 bei Auftreten eines Fehlers
Beispiele:
# perl
weechat::remove_handler("command", "my_command");
# python
weechat.remove_handler("command", "my_command")
# ruby
Weechat.remove_handler("command", "my_command")
-- lua
weechat.remove_handler("command", "my_command")
remove_timer_handler
Perl-Prototyp:
weechat::remove_timer_handler(function);
Python-Prototyp:
weechat.remove_timer_handler(function)
Ruby-Prototyp:
Weechat.remove_timer_handler(function)
Lua-Prototyp:
weechat.remove_timer_handler(function)
Entfernt einen zeitgesteuerten Handler.
Argumente:
: Funktion
Rückgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist
Beispiele:
# perl
weechat::remove_timer_handler("my_timer");
# python
weechat.remove_timer_handler("my_timer")
# ruby
Weechat.remove_timer_handler("my_timer")
-- lua
weechat.remove_timer_handler("my_timer")
remove_keyboard_handler
Perl-Prototyp:
weechat::remove_keyboard_handler(function);
Python-Prototyp:
weechat.remove_keyboard_handler(function)
Ruby-Prototyp:
Weechat.remove_keyboard_handler(function)
Lua-Prototyp:
weechat.remove_keyboard_handler(function)
Entfernt einen Keyboard-Handler.
Argumente:
: Funktion
Rückgabewerte: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist.
Beispiele:
# perl
weechat::remove_keyboard_handler("my_keyboard");
# python
weechat.remove_keyboard_handler("my_keyboard")
# ruby
Weechat.remove_keyboard_handler("my_keyboard")
-- lua
weechat.remove_keyboard_handler("my_keyboard")
remove_event_handler
Perl-Prototyp:
weechat::remove_event_handler(function);
Python-Prototyp:
weechat.remove_event_handler(function)
Ruby-Prototyp:
Weechat.remove_event_handler(function)
Lua-Prototyp:
weechat.remove_event_handler(function)
Entfernt einen Ereignis-Handler.
Argumente:
: Funktion
Rückgabewerte: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist.
Beispiele:
# perl
weechat::remove_event_handler("my_event");
# python
weechat.remove_event_handler("my_event")
# ruby
Weechat.remove_event_handler("my_event")
-- lua
weechat.remove_event_handler("my_event")
add_modifier
Perl-Prototyp:
weechat::add_modifier(type, message, function);
Python-Prototyp:
weechat.add_modifier(type, message, function)
Ruby-Prototyp:
Weechat.add_modifier(type, message, function)
Lua-Prototyp:
weechat.add_modifier(type, message, function)
Fügt einen Nachrichtenmodifikator hinzu.
Argumente:
: Modifikatorart:
ArtBeschreibungirc_inwird bei eingehenden IRC-Nachrichten aufgerufenirc_user
wird bei jeder Benutzernachricht (oder Befehl)
aufgerufen (bevor WeeChat die Nachricht parst)
irc_out
wird unmittelbar vor dem Abschicken einer ausgehenden
Nachricht an den IRC-Server aufgerufen (auch bei
Nachrichten, die WeeChat automatisch an den Server
sendet)
:Name der IRC-Nachricht (wird nur bei
den Arten "irc_in" and "irc_out" benutzt) Um eine Liste der
IRC-Nachrichten zu erhalten, lies bitte folgende Dokumente:
RFCs
1459
and
2812.
Außerdem gibt es den Wert "*", der alle Nachrichten
anspricht (ohne Filter).
: aufgerufene Funktion
Rückgabewert: 1 bei Erfolg, 0 bei einem aufgetretenem Fehler
Beispiele:
# perl
weechat::add_modifier("irc_in", "privmsg", "mod_in");
weechat::add_modifier("irc_out", "privmsg", "mod_out");
sub mod_in
{
return "$_[1] [modifier IN]";
}
sub mod_out
{
return "$_[1] [modifier OUT]";
}
# python
weechat.add_modifier("irc_in", "privmsg", "mod_in")
weechat.add_modifier("irc_out", "privmsg", "mod_out")
def mod_in(server, args):
return args + " [modifier IN]"
def mod_out(server, args):
return args + " [modifier OUT]"
# ruby
Weechat.add_modifier("irc_in", "privmsg", "mod_in")
Weechat.add_modifier("irc_out", "privmsg", "mod_out")
def mod_in(server, args)
return args + " [modifier IN]"
end
def mod_out(server, args)
return args + " [modifier OUT]"
end
-- lua
weechat.add_modifier("irc_in", "privmsg", "mod_in")
weechat.add_modifier("irc_out", "privmsg", "mod_out")
function mod_in(server, args)
return args .. " [modifier IN]"
end
function mod_out(server, args)
return args .. " [modifier OUT]"
end
remove_modifier
Perl-Prototyp:
weechat::remove_modifier(type, message, function);
Python-Prototyp:
weechat.remove_modifier(type, message, function)
Ruby-Prototyp:
Weechat.remove_modifier(type, message, function)
Lua-Prototyp:
weechat.remove_modifier(type, message, function)
Entfernt einen Nachrichtenmodifikator.
Argumente:
: Modifikatorart
: Nachrichtenart, die der Modifikator
verwaltet
: Funktion
Rückgabewert: 1 bei Erfolg, 0 bei einem aufgetretenem Fehler
Beispiele:
# perl
weechat::remove_modifier("irc_in", "privmsg", "mod_in");
# python
weechat.remove_modifier("irc_in", "privmsg", "mod_in")
# ruby
Weechat.remove_modifier("irc_in", "privmsg", "mod_in")
-- lua
weechat.remove_modifier("irc_in", "privmsg", "mod_in")
command
Perl-Prototyp:
weechat::command(command, [channel, [server]]);
Python-Prototyp:
weechat.command(command, [channel, [server]])
Ruby-Prototyp:
Weechat.command(command, [channel, [server]])
Lua-Prototyp:
weechat.command(command, [channel, [server]])
Führt ein WeeChat-Kommando aus (oder sendet eine Nachricht an einen
Channel).
Argumente:
: Kommando
: Name des Channels, für den das
Kommando ausgeführt werden soll
: interner Name des Servers, für den
das Kommando ausgeführt werden soll
Rückgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist
Beispiele:
# perl
weechat::command("hello everybody!");
weechat::command("/kick toto please leave this channel", "#weechat");
weechat::command("/nick newnick", "", "freenode");
# python
weechat.command("hello everybody!")
weechat.command("/kick toto please leave this channel", "#weechat")
weechat.command("/nick newnick", "", "freenode")
# ruby
Weechat.command("hello everybody!")
Weechat.command("/kick toto please leave this channel", "#weechat")
Weechat.command("/nick newnick", "", "freenode")
-- lua
weechat.command("hello everybody!")
weechat.command("/kick toto please leave this channel", "#weechat")
weechat.command("/nick newnick", "", "freenode")
get_info
Perl-Prototyp:
weechat::get_info(name, [server]);
Python-Prototyp:
weechat.get_info(name, [server])
Ruby-Prototyp:
Weechat.get_info(name, [server])
Lua-Prototyp:
weechat.get_info(name, [server])
Gibt ein Info über WweeChat oder einen Channel zurück.
Argumente:
: Name (Typ) des Infos, das gelesen
werden soll (siehe )
: interner Name des Servers
Rückgabewert: angefragte Infos, oder leerer String, wenn ein
Fehler aufgetreten ist.
Beispiele:
# perl
$version = get_info("version");
$nick = get_info("nick", "freenode");
# python
version = weechat.get_info("version")
nick = weechat.get_info("nick", "freenode")
# ruby
version = Weechat.get_info("version")
nick = Weechat.get_info("nick", "freenode")
-- lua
version = weechat.get_info("version")
nick = weechat.get_info("nick", "freenode")
get_dcc_info
Perl-Prototyp:
weechat::get_dcc_info();
Python-Prototyp:
weechat.get_dcc_info()
Ruby-Prototyp:
Weechat.get_dcc_info()
Lua-Prototyp:
weechat.get_dcc_info()
Gibt eine Liste der gegenwärtig aktiven oder beendeten DCCs zurück.
Rückgabewert: Liste der DCCS
(siehe ).
Beispiele:
# perl
my @dccs = weechat::get_dcc_info();
if (@dccs)
{
foreach my $dcc (@dccs)
{
while (my ($key, $value) = each %$dcc)
{
weechat::print("$key = '$value'");
}
}
}
else
{
weechat::print("no DCC");
}
# python
dccs = weechat.get_dcc_info()
if dccs != None:
if dccs == []:
weechat.prnt("no DCC")
else:
for d in dccs:
for b in d.keys():
weechat.prnt("%s = '%s'" %(b, d[b]))
else:
weechat.prnt("error while getting DCC")
# ruby
dccs = Weechat.get_dcc_info()
if dccs != nil
if dccs == []
Weechat.print("no DCC")
else
dccs.each do |m|
m.each do |key, value|
Weechat.print("#{key} = '#{value}'")
end
end
end
else
Weechat.print("error while getting DCC")
end
-- lua
dccs = weechat.get_dcc_info()
if dccs ~= nil then
if dccs then
dcc, dccinfos = next (dccs, nil)
while (dcc) do
key, value = next (dccinfos, nil)
while (key) do
weechat.print(key.." = '"..value.."'")
key, value = next (dccinfos, key)
end
dcc, dccinfos = next (dccs, dcc)
end
else
weechat.print("no DCC")
end
else
weechat.print("error while getting DCC")
end
get_server_info
Perl-Prototyp:
weechat::get_server_info();
Python-Prototyp:
weechat.get_server_info()
Ruby-Prototyp:
Weechat.get_server_info()
Lua-Prototyp:
weechat.get_server_info()
Gibt eine Liste der IRC-Server zurück (verbunden oder nicht).
Rückgabewert: Liste der Server
(siehe ).
Beispiele:
# perl
my $servers = weechat::get_server_info();
if ($servers)
{
while (my ($srvname, $srvinfos) = each %$servers)
{
while ( my ($key, $value) = each %$srvinfos)
{
weechat::print("$srvname -> $key = '$value'");
}
}
}
else
{
weechat::print("no server");
}
# python
servers = weechat.get_server_info()
if servers != None:
if servers == {}:
weechat.prnt("no server")
else:
for s in servers:
for i in servers[s]:
weechat.prnt("%s -> %s = '%s'" % (s, i, str(servers[s][i])))
else:
weechat.prnt("error while getting servers")
# ruby
servers = Weechat.get_server_info()
if servers != nil
if servers == []
Weechat.print("no server")
else
servers.each do |n, s|
s.each do |key, value|
Weechat.print("#{n} -> #{key} = '#{value}'")
end
end
end
else
Weechat.print("error while getting servers")
end
-- lua
servers = weechat.get_server_info()
if servers ~= nil then
if servers then
srv, srvinfos = next (servers, nil)
while (srv) do
key, value = next (srvinfos, nil)
while (key) do
weechat.print(srv.." -> "..key.." = '"..value.."'")
key, value = next (srvinfos, key)
end
srv, srvinfos = next (servers, srv)
end
else
weechat.print("no server")
end
else
weechat.print("error while getting servers")
end
get_channel_info
Perl-Prototyp:
weechat::get_channel_info(server);
Python-Prototyp:
weechat.get_channel_info(server)
Ruby-Prototyp:
Weechat.get_channel_info(server)
Lua-Prototyp:
weechat.get_channel_info(server)
Gibt eine Liste der Channels für einen Server zurück.
Rückgabewert: Liste der Channel für einen Server
(siehe ).
Beispiele:
# perl
my $channels = weechat::get_channel_info(weechat::get_info("server"));
if ($channels)
{
while (my ($channame, $chaninfos) = each %$channels)
{
while (my ($key, $value) = each %$chaninfos)
{
weechat::print("$channame -> $key = '$value'");
}
}
}
else
{
weechat::print("no channel");
}
# python
chans = weechat.get_channel_info(weechat.get_info("server"))
if chans != None:
if chans == {}:
weechat.prnt("no channel")
else:
for s in chans:
for i in chans[s]:
weechat.prnt("%s -> %s = '%s'" % (s, i, str(chans[s][i])))
else:
weechat.prnt("error while getting channels")
# ruby
channels = Weechat.get_channel_info(Weechat.get_info("server"))
if channels != nil
if channels == {}
Weechat.print("no channel")
else
channels.each do |n, c|
c.each do |key, value|
Weechat.print("#{n} -> #{key} = '#{value}'")
end
end
end
else
Weechat.print("error while getting channels")
end
-- lua
chans = weechat.get_channel_info(weechat.get_info("server"))
if chans ~= nil then
if chans then
chan, chaninfos = next (chans, nil)
while (chan) do
key, value = next (chaninfos, nil)
while (key) do
weechat.print(chan.." -> "..key.." = '"..value.."'")
key, value = next (chaninfos, key)
end
chan, chaninfos = next (chans, chan)
end
else
weechat.print("no channel")
end
else
weechat.print("error while getting channels")
end
get_nick_info
Perl-Prototyp:
weechat::get_nick_info(server, channel);
Python-Prototyp:
weechat.get_nick_info(server, channel)
Ruby-Prototyp:
Weechat.get_nick_info(server, channel)
Lua-Prototyp:
weechat.get_nick_info(server, channel)
Gibt eine Liste der Nicknamen für einen Channel zurück.
Rückgabewert: Liste der Nicknamen eines Channels
(siehe ).
Beispiele:
# perl
my $nicks = weechat::get_nick_info("freenode", "#weechat");
if ($nicks)
{
while (my ($nickname, $nickinfos) = each %$nicks)
{
while ( my ($key, $value) = each %$nickinfos)
{
weechat::print("$nickname -> $key = '$value'");
}
}
}
else
{
weechat::print("no nick");
}
# python
nicks = weechat.get_nick_info("freenode", "#weechat")
if nicks != None:
if nicks == {}:
weechat.prnt("no nick")
else:
for n in nicks:
for f in nicks[n]:
weechat.prnt("%s -> %s = '%s'" % (n, f, str(nicks[n][f])))
else:
weechat.prnt("error while getting nicks")
# ruby
nicks = Weechat.get_nick_info("freenode", "#weechat")
if nicks != nil
if nicks == {}
Weechat.print("no nick")
else
nicks.each do |nk, nattr|
nattr.each do |key, value|
Weechat.print("#{nk} -> #{key} = '#{value}'")
end
end
end
else
Weechat.print("error while getting nicks")
end
-- lua
nicks = weechat.get_nick_info("freenode", "#weechat")
if nicks ~= nil then
if nicks then
nick, nickinfos = next (nicks, nil)
while (nick) do
key, value = next (nickinfos, nil)
while (key) do
weechat.print(nick.." -> "..key.." = '"..value.."'")
key, value = next (nickinfos, key)
end
nick, nickinfos = next (nicks, nick)
end
else
weechat.print("no nick")
end
else
weechat.print("error while getting nicks")
end
get_config
Perl-Prototyp:
weechat::get_config(option);
Python-Prototyp:
weechat.get_config(option)
Ruby-Prototyp:
Weechat.get_config(option)
Lua-Prototyp:
weechat.get_config(option)
Gibt den Wert einer Option der WeeChat-Konfiguration zurück.
Argumente:
: Name der Option
Rückgabewert: Wert der Option, leerer String wenn nichts gefunden
wurde.
Beispiele:
# perl
$value1 = weechat::get_config("look_nicklist");
$value2 = weechat::get_config("freenode.server_autojoin");
# python
value1 = weechat.get_config("look_nicklist")
value2 = weechat.get_config("freenode.server_autojoin")
# ruby
value1 = Weechat.get_config("look_nicklist")
value2 = Weechat.get_config("freenode.server_autojoin")
-- lua
value1 = weechat.get_config("look_nicklist")
value2 = weechat.get_config("freenode.server_autojoin")
set_config
Perl-Prototyp:
weechat::set_config(option, value);
Python-Prototyp:
weechat.set_config(option, value)
Ruby-Prototyp:
Weechat.set_config(option, value)
Lua-Prototyp:
weechat.set_config(option, value)
Setze den Wert einer Option der WeeChat-Konfiguration.
Argumente:
: Name der Option, die gesetzt werden
soll
: neuer Wert der Option
Rückgabewert: 1 wenn der Wert gesetzt wurde, 0 wenn ein Fehler
aufgetreten ist.
Beispiele:
# perl
weechat::set_config("look_nicklist", "off");
weechat::set_config("freenode.server_autojoin", "#weechat");
# python
weechat.set_config("look_nicklist", "off")
weechat.set_config("freenode.server_autojoin", "#weechat")
# ruby
Weechat.set_config("look_nicklist", "off")
Weechat.set_config("freenode.server_autojoin", "#weechat")
-- lua
weechat.set_config("look_nicklist", "off")
weechat.set_config("freenode.server_autojoin", "#weechat")
get_plugin_config
Perl-Prototyp:
weechat::get_plugin_config(option);
Python-Prototyp:
weechat.get_plugin_config(option)
Ruby-Prototyp:
Weechat.get_plugin_config(option)
Lua-Prototyp:
weechat.get_plugin_config(option)
Gibt den Wert einer Option eines Plugins zurück. Die Option wird
aus der Datei "~/.weechat/plugins.rc" gelesen
und sieht so aus: "plugin.option=value"
(Hinweis: Der Name des Plugins wird automatisch gesetzt).
Argumente:
: Name der zu lesenden Option
Rückgabewert: Wert der Option, leerer String wenn die Option nicht
gefunden wurde.
Beispiele:
# perl
$value = weechat::get_plugin_config("my_var");
# python
value = weechat.get_plugin_config("my_var")
# ruby
value = Weechat.get_plugin_config("my_var")
-- lua
value = weechat.get_plugin_config("my_var")
set_plugin_config
Perl-Prototyp:
weechat::set_plugin_config(option, value);
Python-Prototyp:
weechat.set_plugin_config(option, value)
Ruby-Prototyp:
Weechat.set_plugin_config(option, value)
Lua-Prototyp:
weechat.set_plugin_config(option, value)
Setzt den Wert einer Option eines Plugins. Die Option bzw. ihr Wert
wird in "~/.weechat/plugins.rc" geschrieben und
sieht so aus: "plugin.option=value"
(Hinweis: der Name des Plugins wird automatisch gesetzt).
Argumente:
: Name der Option, die gesetzt werden
soll
: Der neue Wert der Option
Rückgabewert: 1 wenn die Option gesetzt wurde, 0 wenn ein Fehler
aufgetreten ist.
Beispiele:
# perl
weechat::set_plugin_config("my_var", "value");
# python
weechat.set_plugin_config("my_var", "value")
# ruby
Weechat.set_plugin_config("my_var", "value")
-- lua
weechat.set_plugin_config("my_var", "value")
get_irc_color
Perl-Prototyp:
weechat::get_irc_color(color);
Python-Prototyp:
weechat.get_irc_color(color)
Ruby-Prototyp:
Weechat.get_irc_color(color)
Lua-Prototyp:
weechat.get_irc_color(color)
Hole IRC-Farbindex mit dem Farbnamen.
Rückgabewert: IRC-Farbindex, -1 wenn die Farbe nicht gefunden wurde
(siehe ).
Beispiele:
# perl
my $color_blue = weechat::get_irc_color("blue");
# python
color_blue = weechat.get_irc_color("blue")
# ruby
color_blue = Weechat.get_irc_color("blue")
-- lua
color_blue = weechat.get_irc_color("blue")
input_color
Perl-Prototyp:
weechat::input_color(color);
Python-Prototyp:
weechat.input_color(color)
Ruby-Prototyp:
Weechat.input_color(color)
Lua-Prototyp:
weechat.input_color(color)
Erzeugt einen Farbcode im Eingabepuffer.Add color in input buffer.
Rückgabewert: keiner.
Bespiele:
# perl
weechat::input_color(weechat::get_irc_color("blue"), 10, 5);
# python
weechat.input_color(weechat.get_irc_color("blue"), 10, 5)
# ruby
Weechat.input_color(Weechat.get_irc_color("blue"), 10, 5)
-- lua
weechat.input_color(weechat.get_irc_color("blue"), 10, 5)
get_window_info
Perl-Prototyp:
weechat::get_window_info();
Python-Prototyp:
weechat.get_window_info()
Ruby-Prototyp:
Weechat.get_window_info()
Lua-Prototyp:
weechat.get_window_info()
Gibt die Liste der WeeChat-Fenster zurück.
Rückgabewert: List der WeeChat-Fenster
(see ).
Besipiele:
# perl
my @wf = weechat::get_window_info();
if (@wf)
{
weechat::print("**** Fenster-Informationen ****");
foreach my $w (@wf)
{
while ( my ($key, $value) = each %$w)
{
weechat::print(" > $key => $value");
}
weechat::print("----------------------");
}
}
else
{
weechat::print("**** Keine Fenster-Informationen ****");
}
# python
wf = weechat.get_window_info()
if wf != None and wf != []:
weechat.prnt ("**** Fenster-Informationen ****")
for w in wf:
for i in w:
weechat.prnt (" > %s => %s" % (i, w[i]))
weechat.prnt ("----------------------")
else:
weechat.prnt ("**** Keine Fenster-Informationen ****")
# ruby
wf = Weechat.get_window_info()
if wf != nil and wf != []
Weechat.print("**** Fenster-Informationen ****")
wf.each do |w|
w.each do |key, value|
Weechat.print(" > #{key} => #{value}")
end
Weechat.print("----------------------")
end
else
Weechat.print("**** Keine Fenster-Informationen ****")
end
-- lua
wf = weechat.get_window_info()
if wf then
weechat.print ("**** Fenster-Informationen ****")
w, winfos = next (wf, nil)
while (w) do
key, value = next (winfos, nil)
while (key) do
weechat.print(" > " .. key .. " => " .. value)
key, value = next (winfos, key)
end
weechat.print ("----------------------")
w, winfos = next (wf, w)
end
else
weechat.print("**** Keine Fenster-Informationen ****")
end
get_buffer_info
Perl-Prototyp:
weechat::get_buffer_info();
Python-Prototyp:
weechat.get_buffer_info()
Ruby-Prototyp:
Weechat.get_buffer_info()
Lua-Prototyp:
weechat.get_buffer_info()
Gibt eine Liste der WeeChat-Puffer.
Rückgabewert: Liste der WeeChat-Puffer
(siehe ).
Beispiele:
# perl
my $bf = weechat::get_buffer_info();
if ($bf)
{
while ( my ($nobuf, $binfos) = each %$bf)
{
while ( my ($key, $value) = each %$binfos)
{
weechat::print(" > $key => $value");
}
weechat::print("----------------------");
}
}
else
{
weechat::print("**** keine Pufferinformationen ****");
}
# python
bf = weechat.get_buffer_info()
if bf != None and bf != {}:
for b in bf:
weechat.prnt ("**** Informationen für Puffer Nr. %d ****" % b)
for c in bf[b]:
weechat.prnt (" > %s => %s" % (c, bf[b][c]))
weechat.prnt ("----------------------")
else:
weechat.prnt ("**** keine Pufferinformationen ****")
# ruby
bf = Weechat.get_buffer_info()
if bf != nil and bf != {}
bf.each do |n, c|
Weechat.print("**** Informationen für Puffer Nr. #{n} ****")
c.each do |key, value|
Weechat.print(" > #{key} => #{value}")
end
Weechat.print("----------------------")
end
else
Weechat.print("**** keine Pufferinformationen ****")
end
-- lua
bf = weechat.get_buffer_info()
if bf then
b, binfos = next (bf, nil)
while (b) do
weechat.print("**** Informationen für Puffer Nr. " .. b .. " ****")
key, value = next (binfos, nil)
while (key) do
weechat.print(" > " .. key .. " => " .. value)
key, value = next (binfos, key)
end
weechat.print ("----------------------")
b, infos = next (bf, b)
end
else
weechat.print("**** keine Pufferinformationen ****")
end
get_buffer_data
Perl-Prototyp:
weechat::get_buffer_data(server, channel);
Python-Prototyp:
weechat.get_buffer_data(server, channel)
Ruby-Prototyp:
Weechat.get_buffer_data(server, channel)
Lua-Prototyp:
weechat.get_buffer_data(server, channel)
Gibt den Inhalt eines Puffers zurück.
Rückgabewert: Liste der Pufferzeilen
(see ).
Beispiele:
# perl
my $server = weechat::get_info("server");
my $channel = weechat::get_info("channel");
my @bc = weechat::get_buffer_data($server, $channel);
if (@bc)
{
weechat::print("**** Pufferdaten für '$channel'\@'$server' ****");
foreach my $l (@bc) {
while ( my ($key, $value) = each %$l) {
weechat::print(" > $key => $value");
}
weechat::print("----------------------");
}
}
else
{
weechat::print("**** keine Pufferdaten ****");
}
# python
server = weechat.get_info("server")
channel = weechat.get_info("channel")
bc = weechat.get_buffer_data(server, channel)
if bc != None and bc != []:
weechat.prnt ("**** Pufferdaten für '%s'@'%s' ****" % (channel, server))
for l in bc:
for i in l:
weechat.prnt (" > %s => %s" % (i, l[i]))
weechat.prnt ("----------------------")
else:
weechat.prnt ("**** keine Pufferdaten ****")
# ruby
server = Weechat.get_info("server")
channel = Weechat.get_info("channel")
bc = Weechat.get_buffer_data(server, channel)
if bc != nil and bc != []
Weechat.print("**** Pufferdaten für '#{channel}'@'#{server}' ****")
bc.each do |l|
l.each do |key, value|
Weechat.print(" > #{key} => #{value}")
end
Weechat.print("----------------------")
end
else
Weechat.print("**** keine Pufferdaten ****")
end
-- lua
server = weechat.get_info("server")
channel = weechat.get_info("channel")
bc = weechat.get_buffer_data(server, channel)
if bc then
b, bdatas = next (bc, nil)
weechat.print("**** Pufferdaten für '" .. channel .. "'@'" .. server .. "' ****")
while (b) do
key, value = next (bdatas, nil)
while (key) do
weechat.print(" > " .. key .. " => " .. value)
key, value = next (bdatas, key)
end
weechat.print ("----------------------")
b, bdatas = next (bc, b)
end
else
weechat.print("**** keine Pufferdaten ****")
end