diff options
Diffstat (limited to 'doc/weechat_doc_es.texi')
| -rw-r--r-- | doc/weechat_doc_es.texi | 266 |
1 files changed, 256 insertions, 10 deletions
diff --git a/doc/weechat_doc_es.texi b/doc/weechat_doc_es.texi index d923621f0..88ef1414e 100644 --- a/doc/weechat_doc_es.texi +++ b/doc/weechat_doc_es.texi @@ -36,7 +36,7 @@ @title WeeChat - Gui@'on de usuario. @subtitle Cliente IRC r@'apido, peque@~no y extensible -@subtitle Documentaci@'on para WeeChat v0.1.6-cvs - 24 de octubre de 2005 +@subtitle Documentaci@'on para WeeChat v0.1.6-cvs - 25 de octubre de 2005 @author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> @@ -1560,8 +1560,10 @@ them the plugin can't load):@* @end itemize @item functions for init and end of plugin: @itemize @minus -@item weechat_plugin_init: function called when plugin is loaded -@item weechat_plugin_end: function called when plugin is unloaded +@item weechat_plugin_init: function called when plugin is loaded, +must return 1 if successful, 0 if error +@item weechat_plugin_end: function called when plugin is unloaded, +must return 1 if successful, 0 if error @end itemize @end itemize @@ -2065,7 +2067,7 @@ use.@* @* @emph{Examples:}@* @* -@code{char *value1 = plugin->get_config (plugin, "look_set_title");}@* +@code{char *value1 = plugin->get_config (plugin, "look_nicklist");}@* @code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* @* @@ -2246,6 +2248,10 @@ tener un nombre distinto) @item @option{descripci@'on}: descripci@'on breve del programa @end itemize @* +@emph{Return value:}@* +@* +1 if script was registered, 0 if error occured.@* +@* @emph{Ejemplo:}@* @* @code{weechat::register ("ejemplo", "1.0", "fin_ejemplo", "programa de ejemplo...");}@* @@ -2263,6 +2269,10 @@ Escribe un mensaje en un canal.@* @item @option{servidor}: (opcional) nombre interno del servidor @end itemize @* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* @emph{Ejemplos:}@* @* @code{weechat::print ("mensaje");}@* @@ -2282,6 +2292,10 @@ Escribir un mensaje en la barra de informaciones.@* @item @option{message}: mensaje que se escribir@'a en la barra de informaciones. @end itemize @* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* @emph{Ejemplo:}@* @* @code{weechat::print_infobar (5, "mensaje");}@* @@ -2303,6 +2317,10 @@ RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} @item @option{funci@'on}: funci@'on en Perl llamada cuando se reciba el mensaje. @end itemize @* +@emph{Return value:}@* +@* +1 if Perl function was attached, 0 if error occured.@* +@* @emph{Ejemplo:}@* @* @code{weechat::add_message_handler ("privmsg", mi_funcion);}@* @@ -2336,6 +2354,10 @@ command) arguments (displayed by /help command) @end itemize @* +@emph{Return value:}@* +@* +1 if Perl function was attached, 0 if error occured.@* +@* @emph{Ejemplo:}@* @* @code{weechat::add_command_handler ("comando", mi_comando);}@* @@ -2347,6 +2369,26 @@ arguments (displayed by /help command) @* @item +@command{weechat::remove_handler ( name, function );}@* +@* +Remove a message or command handler.@* + +@emph{Arguments:} +@itemize @minus +@item @option{name}: name of IRC message or command handler +@item @option{function}: Perl function +@end itemize +@* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* +@emph{Example:}@* +@* +@code{weechat::remove_handler ("command", my_command);}@* +@* + +@item @command{weechat::command ( command, [channel, [server]] );}@* @* Execute a command or send a message to a channel.@* @@ -2358,6 +2400,10 @@ Execute a command or send a message to a channel.@* @item @option{server}: internal name of server @end itemize @* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* @emph{Examples:}@* @* @code{weechat::command ("hello world!");}@* @@ -2387,6 +2433,10 @@ Obtener informaciones distintas sobre WeeChat, el servidor o el usuario.@* @item @option{canal}: nombre del canal @end itemize @* +@emph{Return value:}@* +@* +Asked info, empty if error occured or info was not found.@* +@* @emph{Ejemplos:}@* @* @code{$version = weechat::get_info("version");}@* @@ -2431,23 +2481,97 @@ Returned array has following fields: @item bytes_per_sec: bytes sent/received per second @end itemize @* +@emph{Return value:}@* +@* +DCC list, 0 if error occured.@* +@* @item -@command{weechat::get_config ( name );}@* +@command{weechat::get_config ( option );}@* @* Get WeeChat config option value.@* @emph{Arguments:} @itemize @minus -@item @option{name}: name of option +@item @option{option}: name of option @end itemize @* +@emph{Return value:}@* +@* +Value of option, empty if error occured or option was not found.@* +@* @emph{Examples:}@* @* -@code{$value1 = weechat::get_config ("look_set_title");}@* +@code{$value1 = weechat::get_config ("look_nicklist");}@* @code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* @* +@item +@command{weechat::set_config ( option, value );}@* +@* +Get WeeChat config option value.@* + +@emph{Arguments:} +@itemize @minus +@item @option{option}: name of option +@item @option{value}: new value for option +@end itemize +@* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* +@emph{Examples:}@* +@* +@code{weechat::set_config ("look_nicklist", "off");}@* +@code{weechat::set_config ("freenode.server_autojoin"", "#weechat");}@* +@* + +@item +@command{weechat::get_plugin_config ( option );}@* +@* +Return value of a plugin option.@* +Option is read from file ~/.weechat/plugins.rc and is like:@* +@code{plugin.script.option=value}@* +Note: plugin and script names are automatically added.@* + +@emph{Arguments:} +@itemize @minus +@item @option{option}: name of option +@end itemize +@* +@emph{Return value:}@* +@* +Value of option, empty if error occured or option was not found.@* +@* +@emph{Example:}@* +@* +@code{$value = weechat::get_plugin_config ("my_var");}@* +@* + +@item +@command{weechat::set_plugin_config ( option, value );}@* +@* +Update value of a plugin option.@* +Option is written in file ~/.weechat/plugins.rc and is like:@* +@code{plugin.script.option=value}@* +Note: plugin and script names are automatically added.@* + +@emph{Arguments:} +@itemize @minus +@item @option{option}: name of option +@item @option{value}: new value for option +@end itemize +@* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* +@emph{Example:}@* +@* +@code{weechat::set_plugin_config ("my_var", "value");}@* +@* + @end itemize @subsection Python scripts @@ -2485,6 +2609,10 @@ tener un nombre distinto) @item @option{descripci@'on}: descripci@'on breve del programa @end itemize @* +@emph{Return value:}@* +@* +1 if script was registered, 0 if error occured.@* +@* @emph{Ejemplo:}@* @* @code{weechat.register ("ejemplo", "1.0", "fin_ejemplo", "programa de ejemplo...")}@* @@ -2502,6 +2630,10 @@ Escribe un mensaje en un canal.@* @item @option{servidor}: (opcional) nombre interno del servidor @end itemize @* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* @emph{Ejemplos:}@* @* @code{weechat.prnt ("mensaje")}@* @@ -2521,6 +2653,10 @@ Escribir un mensaje en la barra de informaciones.@* @item @option{mensaje}: mensaje que se escribir@'a en la barra de informaciones. @end itemize @* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* @emph{Ejemplo:}@* @* @code{weechat.print_infobar (5, "mensaje")}@* @@ -2542,6 +2678,10 @@ RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} @item @option{funci@'on}: funci@'on en Python llamada cuando se reciba el mensaje. @end itemize @* +@emph{Return value:}@* +@* +1 if Python function was attached, 0 if error occured.@* +@* @emph{Ejemplo:}@* @* @code{weechat.add_message_handler ("privmsg", mi_funcion)}@* @@ -2573,6 +2713,10 @@ command) arguments (displayed by /help command) @end itemize @* +@emph{Return value:}@* +@* +1 if Python function was attached, 0 if error occured.@* +@* @emph{Ejemplo:}@* @* @code{weechat.add_command_handler ("comando", mi_comando)}@* @@ -2581,6 +2725,26 @@ arguments (displayed by /help command) @* @item +@command{weechat.remove_handler ( name, function );}@* +@* +Remove a message or command handler.@* + +@emph{Arguments:} +@itemize @minus +@item @option{name}: name of IRC message or command handler +@item @option{function}: Python function +@end itemize +@* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* +@emph{Example:}@* +@* +@code{weechat.remove_handler ("command", my_command);}@* +@* + +@item @command{weechat.command ( command, [channel, [server]] )}@* @* Execute a command or send a message to a channel.@* @@ -2592,6 +2756,10 @@ Execute a command or send a message to a channel.@* @item @option{server}: internal name of server @end itemize @* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* @emph{Examples:}@* @* @code{weechat.command ("hello world!")}@* @@ -2620,6 +2788,10 @@ Obtener informaciones distintas sobre WeeChat, el servidor o el usuario.@* @item @option{servidor}: nombre interno del servidor @end itemize @* +@emph{Return value:}@* +@* +Asked info, empty if error occured or info was not found.@* +@* @emph{Ejemplos:}@* @* @code{$version = weechat.get_info("version")}@* @@ -2664,23 +2836,97 @@ Returned array has following fields: @item bytes_per_sec: bytes sent/received per second @end itemize @* +@emph{Return value:}@* +@* +DCC list, 0 if error occured.@* +@* @item -@command{weechat.get_config ( name );}@* +@command{weechat.get_config ( option );}@* @* Get WeeChat config option value.@* @emph{Arguments:} @itemize @minus -@item @option{name}: name of option +@item @option{option}: name of option @end itemize @* +@emph{Return value:}@* +@* +Value of option, empty if error occured or option was not found.@* +@* @emph{Examples:}@* @* -@code{$value1 = weechat.get_config ("look_set_title");}@* +@code{$value1 = weechat.get_config ("look_nicklist");}@* @code{$value2 = weechat.get_config ("freenode.server_autojoin");}@* @* +@item +@command{weechat.set_config ( option, value );}@* +@* +Get WeeChat config option value.@* + +@emph{Arguments:} +@itemize @minus +@item @option{option}: name of option +@item @option{value}: new value for option +@end itemize +@* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* +@emph{Examples:}@* +@* +@code{weechat.set_config ("look_nicklist", "off");}@* +@code{weechat.set_config ("freenode.server_autojoin"", "#weechat");}@* +@* + +@item +@command{weechat.get_plugin_config ( option );}@* +@* +Return value of a plugin option.@* +Option is read from file ~/.weechat/plugins.rc and is like:@* +@code{plugin.script.option=value}@* +Note: plugin and script names are automatically added.@* + +@emph{Arguments:} +@itemize @minus +@item @option{option}: name of option +@end itemize +@* +@emph{Return value:}@* +@* +Value of option, empty if error occured or option was not found.@* +@* +@emph{Example:}@* +@* +@code{$value = weechat.get_plugin_config ("my_var");}@* +@* + +@item +@command{weechat.set_plugin_config ( option, value );}@* +@* +Update value of a plugin option.@* +Option is written in file ~/.weechat/plugins.rc and is like:@* +@code{plugin.script.option=value}@* +Note: plugin and script names are automatically added.@* + +@emph{Arguments:} +@itemize @minus +@item @option{option}: name of option +@item @option{value}: new value for option +@end itemize +@* +@emph{Return value:}@* +@* +1 if successful, 0 if error occured.@* +@* +@emph{Example:}@* +@* +@code{weechat.set_plugin_config ("my_var", "value");}@* +@* + @end itemize @subsection Ruby scripts |