/[weechat]/weechat/doc/weechat_doc_pt.texi
ViewVC logotype

Diff of /weechat/doc/weechat_doc_pt.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.50 by flashcode, Sun Oct 30 19:22:54 2005 UTC revision 1.51 by flashcode, Fri Nov 4 11:53:30 2005 UTC
# Line 36  Line 36 
36    
37  @title WeeChat - Guia do Utilizador  @title WeeChat - Guia do Utilizador
38  @subtitle Cliente de IRC rapido, leve e extencivel  @subtitle Cliente de IRC rapido, leve e extencivel
39  @subtitle Documenta@,{c}@~ao do WeeChat v0.1.6-cvs - 30 de outubro de 2005  @subtitle Documenta@,{c}@~ao do WeeChat v0.1.6-cvs - 4 de novembro de 2005
40    
41  @author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>  @author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>
42    
# Line 296  Type: integer (values: between 1 and 10) Line 296  Type: integer (values: between 1 and 10)
296  @item look_color_actions  @item look_color_actions
297  Display actions with different colors@*  Display actions with different colors@*
298  Type: boolean (values: 'on' or 'off'), default value: 'on'@*  Type: boolean (values: 'on' or 'off'), default value: 'on'@*
 @item look_remove_colors_from_msgs  
 Remove colors from incoming messages@*  
 Type: boolean (values: 'on' or 'off'), default value: 'on'@*  
299  @item look_nicklist  @item look_nicklist
300  Display nicklist window (for channel windows)@*  Display nicklist window (for channel windows)@*
301  Type: boolean (values: 'on' or 'off'), default value: 'on'@*  Type: boolean (values: 'on' or 'off'), default value: 'on'@*
# Line 451  Color for input text (nick name)@* Line 448  Color for input text (nick name)@*
448  Type: color (Curses or Gtk color), default value: 'lightcyan'@*  Type: color (Curses or Gtk color), default value: 'lightcyan'@*
449  @item col_input_delimiters  @item col_input_delimiters
450  Color for input text (delimiters)@*  Color for input text (delimiters)@*
451  Type: color (Curses or Gtk color), default value: 'white'@*  Type: color (Curses or Gtk color), default value: 'cyan'@*
452  @item col_input_bg  @item col_input_bg
453  Background for input window@*  Background for input window@*
454  Type: color (Curses or Gtk color), default value: 'default'@*  Type: color (Curses or Gtk color), default value: 'default'@*
# Line 602  Type: boolean (values: 'on' or 'off'), d Line 599  Type: boolean (values: 'on' or 'off'), d
599  @item irc_highlight  @item irc_highlight
600  Comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)@*  Comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)@*
601  Type: string (any string), default value: ''@*  Type: string (any string), default value: ''@*
602    @item irc_colors_receive
603    Keep colors from incoming messages@*
604    Type: boolean (values: 'on' or 'off'), default value: 'on'@*
605    @item irc_colors_send
606    Allow user to send colors with special codes (%B=bold, %Cxx,yy=color, %U=underline, %R=reverse)@*
607    Type: boolean (values: 'on' or 'off'), default value: 'on'@*
608  @item dcc_auto_accept_files  @item dcc_auto_accept_files
609  Automatically accept incoming dcc files@*  Automatically accept incoming dcc files@*
610  Type: boolean (values: 'on' or 'off'), default value: 'off'@*  Type: boolean (values: 'on' or 'off'), default value: 'off'@*
# Line 1829  void *handler_pointer)}@* Line 1832  void *handler_pointer)}@*
1832  @*  @*
1833  @emph{Notes:}@*  @emph{Notes:}@*
1834  @*  @*
1835  Function called when message is received has to return one of these values:@*  Function called when message is received has to return one of these
1836  @itemize @minus  values (prefixed by ``weechat::'' for Perl and ``weechat.'' for
1837  @item @option{PLUGIN_RC_KO or -1}: function failed  Python):@*
1838  @item @option{PLUGIN_RC_OK or 0}: function successfully completed  @itemize @minus
1839  @item @option{PLUGIN_RC_OK_IGNORE_WEECHAT or 1}: message will not be sent to  @item @option{PLUGIN_RC_KO}: function failed
1840    @item @option{PLUGIN_RC_OK}: function successfully completed
1841    @item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent to
1842  WeeChat  WeeChat
1843  @item @option{PLUGIN_RC_OK_IGNORE_PLUGINS or 2}: message will not be sent to  @item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent to
1844  other plugins  other plugins
1845  @item @option{PLUGIN_RC_OK_IGNORE_ALL or 3}: message will not be sent to  @item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to
1846  WeeChat neither other plugins  WeeChat neither other plugins
1847  @end itemize  @end itemize
1848  @*  @*
# Line 1886  file: %s", (arguments) ? arguments : "no Line 1891  file: %s", (arguments) ? arguments : "no
1891  @*  @*
1892  @emph{Notes:}@*  @emph{Notes:}@*
1893  @*  @*
1894  Function called when message is received has to return one of these values:@*  Function called when message is received has to return one of these
1895    values (prefixed by ``weechat::'' for Perl and ``weechat.'' for
1896    Python):@*
1897  @itemize @minus  @itemize @minus
1898  @item @option{PLUGIN_RC_KO or -1}: function failed  @item @option{PLUGIN_RC_KO}: function failed
1899  @item @option{PLUGIN_RC_OK or 0}: function successfully completed  @item @option{PLUGIN_RC_OK}: function successfully completed
1900  @end itemize  @end itemize
1901  @*  @*
1902    
# Line 2209  void weechat_plugin_end (t_weechat_plugi Line 2216  void weechat_plugin_end (t_weechat_plugi
2216  Three plugins are provided with WeeChat to load scripts: Perl,  Three plugins are provided with WeeChat to load scripts: Perl,
2217  Python and Ruby.  Python and Ruby.
2218    
2219  @subsection Perl scripts  @subsection Load/unload scripts
2220    
2221  @subsubsection Carregar/Descarregar Scripts Perl  Perl scripts are loaded and unloaded with @command{/perl},
2222    @command{/python} and @command{/ruby} commands.
2223    (type @kbd{/help} within WeeChat to get help about commands).@*
2224    
2225  Os Scripts Perl s@~ao carregados e descarregados com o comando @command{/perl}.  @emph{Examples:}@*
 (escreve @kbd{/help perl} dentro do WeeChat para obteres ajuda acerca do comando).@*  
   
 @emph{Exemplos:}@*  
2226  @itemize @bullet  @itemize @bullet
2227  @item  @item
2228  Carregar um Script Perl: @kbd{/perl load /tmp/sample.pl}@*  Load a Perl script: @kbd{/perl load /tmp/sample.pl}@*
2229  @item  @item
2230  Descarregar todos os Scripts Perl: @kbd{/perl unload}@*  Unload all Perl scripts: @kbd{/perl unload}@*
2231  @item  @item
2232  Listar todos os Scripts Perl: @kbd{/perl}@*  List all Perl scripts: @kbd{/perl}@*
 @end itemize  
   
 @subsubsection Interface WeeChat / Perl  
   
 @itemize @bullet  
2233  @item  @item
2234  @command{weechat::register ( nome, vers@~ao, fun@,{c}@~ao_de_shutdown, descri@,{c}@~ao );}@*  Load a Python script: @kbd{/python load /tmp/sample.py}@*
 @*  
 Esta @'e a primeira fun@,{c}@~ao a invocar num Script Perl.@*  
 Todos os Scripts Perl para o Weechat devem invocar esta fun@,{c}@~ao.@*  
   
 @emph{Argumentos:}  
 @itemize @minus  
 @item @option{nome}: nome @'unico que indentifique o script (cada Script Perl deve ter um @'unico nome)  
 @item @option{vers@~ao}: vers@~ao do script  
 @item @option{fun@,{c}@~ao_de_shutdown}: fun@,{c}@~ao Perl invocada quando o script é descarregado (par@^ametro opcional, se deixado em branco significa que nada deve ser chamado)  
 @item @option{descri@,{c}@~ao}: breve descri@,{c}@~ao do script.  
 @end itemize  
 @*  
 @emph{Return value:}@*  
 @*  
 1 if script was registered, 0 if error occured.@*  
 @*  
 @emph{Exemplo:}@*  
 @*  
 @code{weechat::register ("sample", "1.0", "sample_end", "Sample script!");}@*  
 @*  
   
2235  @item  @item
2236  @command{weechat::print ( mensagem, [canal, [servidor]] );}@*  Unload all Python scripts: @kbd{/python unload}@*
 @*  
 Imprimne uma mensagem na canal.@*  
   
 @emph{Argumentos:}  
 @itemize @minus  
 @item @option{mensagem}: mensagem a mostrar  
 @item @option{canal}: nome da canal  
 @item @option{servidor}: nome interno da servidor  
 @end itemize  
 @*  
 @emph{Return value:}@*  
 @*  
 1 if successful, 0 if error occured.@*  
 @*  
 @emph{Exemplos:}@*  
 @*  
 @code{weechat::print ("mensagem");}@*  
 @code{weechat::print ("mensagem", "#weechat");}@*  
 @code{weechat::print ("mensagem", "#weechat", "freenode");}@*  
 @*  
   
2237  @item  @item
2238  @command{weechat::print_infobar ( atrasa, mensagem );}@*  List all Python scripts: @kbd{/python}@*
 @*  
 Imprimne uma mensagem na barra do info.@*  
   
 @emph{Argumentos:}  
 @itemize @minus  
 @item @option{atrasa}: depois que isto atrasa (nos segundos), a mensagem estar@'a apagada  
 (se 0, mensagem n@~ao forem apagados).  
 @item @option{mensagem}: mensagem a mostrar  
2239  @end itemize  @end itemize
 @*  
 @emph{Return value:}@*  
 @*  
 1 if successful, 0 if error occured.@*  
 @*  
 @emph{Exemplo:}@*  
 @*  
 @code{weechat::print_infobar (5, "mensagem");}@*  
 @*  
2240    
2241  @item  @subsection WeeChat / Scripts API
 @command{weechat::add_message_handler ( nome, fun@,{c}@~ao );}@*  
 @*  
 Anexa uma fun@,{c}@~ao Perl a uma mensagem de IRC.@*  
 A fun@,{c}@~ao ser@'a invocada de cada vez que a mensagem IRC for recebida.@*  
   
 @emph{Argumentos:}  
 @itemize @minus  
 @item @option{nome}: nome da mensagem IRC@*  
 Para conheceres uma lista de mensagens de IRC, por favor lê o RFC 1459 e/ou o 2812:@*  
 RFC 1459: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@*  
 RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt}  
 @item @option{fun@,{c}@~ao}: fun@,{c}@~ao Perl invocada quando a mensagem é recebida  
 @end itemize  
 @*  
 @emph{Return value:}@*  
 @*  
 1 if Perl function was attached, 0 if error occured.@*  
 @*  
 @emph{Exemplo:}@*  
 @*  
 @code{weechat::add_message_handler ("privmsg", my_function);}@*  
 @code{sub my_function}@*  
 @code{@{ }@*  
 @code{@ @ @ @ ($null, $channel, $message) = split ":",@@_[0],3;}@*  
 @code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@*  
 @code{@ @ @ @ weechat::print ("host=$hostmask, chan=$channel, msg=$message\n");}@*  
 @code{@ @ @ @ return 0;}@*  
 @code{@} }@*  
 @*  
 @emph{Notes:}@*  
 @*  
 Function called when message is received has to return one of these values:@*  
 @itemize @minus  
 @item @option{-1}: function failed  
 @item @option{0}: function successfully completed  
 @item @option{1}: message will not be sent to WeeChat  
 @item @option{2}: message will not be sent to other plugins  
 @item @option{3}: message will not be sent to WeeChat neither other plugins  
 @end itemize  
 @*  
2242    
2243    @itemize @bullet
2244  @item  @item
2245  @command{weechat::add_command_handler ( nome, fun@,{c}@~ao );}@*  Perl: @command{weechat::register ( name, version, shutdown_function,
2246  @*  description );}@*
2247  Cria um novo comando do Weechat, ligado a uma fun@,{c}@~ao Perl.@*  Python: @command{weechat.register ( name, version, shutdown_function,
2248  A fun@,{c}@~ao ser@'a chamada quando o utilizador a invocar utilizando @command{/nome}@*  description )}@*
2249    @*
2250    This is first function to call in script.@*
2251    All scripts for WeeChat should call this function.@*
2252    
2253  @emph{Argumentos:}  @emph{Arguments:}
2254  @itemize @minus  @itemize @minus
2255  @item @option{nome}: nome do novo comando@*  @item @option{name}: unique name to identify script (each script must have
2256  Este nome pode pertencer a um comando já existente, o qual ser@'a sobreposto pela fun@,{c}@~ao Perl. Tem cuidado quando fizeres isto: os comandos originais não estar@~ao acessiveis antes de teres descarregado o Script Perl.  unique name)
2257  @item @option{fun@,{c}@~ao}: fun@,{c}@~ao Perl ligada ao comando  @item @option{version}: script's version
2258  @item @option{description}: command description (displayed by /help  @item @option{shutdown_function}: function called when script is
2259  command)  unloaded (optional parameter, empty string means nothing is called at the end)
2260  @item @option{arguments}: short description of command arguments  @item @option{description}: short description of script.
 (displayed by /help command)  
 @item @option{arguments_description}: long description of command  
 arguments (displayed by /help command)  
2261  @end itemize  @end itemize
2262  @*  @*
2263  @emph{Return value:}@*  @emph{Return value:}@*
2264  @*  @*
2265  1 if Perl function was attached, 0 if error occured.@*  1 if script was registered, 0 if error occured.@*
 @*  
 @emph{Exemplo:}@*  
 @*  
 @code{weechat::add_command_handler ("command", my_command);}@*  
 @code{sub my_command}@*  
 @code{@{ }@*  
 @code{@ @ @ @ weechat::print("Argumentos: ".@@_[0]);}@*  
 @code{@ @ @ @ return 0;}@*  
 @code{@} }@*  
 @*  
 @emph{Notes:}@*  
 @*  
 Function called when command is executed has to return one of these values:@*  
 @itemize @minus  
 @item @option{-1}: function failed  
 @item @option{0}: function successfully completed  
 @end itemize  
 @*  
   
 @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  
2266  @*  @*
2267  @emph{Return value:}@*  @emph{Perl example:}@*
2268  @*  @*
2269  1 if successful, 0 if error occured.@*  @code{weechat::register ("sample", "1.0", "sample_end", "Sample
2270    script!");}@*
2271  @*  @*
2272  @emph{Example:}@*  @emph{Python example:}@*
2273  @*  @*
2274  @code{weechat::remove_handler ("command", my_command);}@*  @code{weechat.register ("sample", "1.0", "sample_end", "Sample
2275    script!")}@*
2276  @*  @*
2277    
2278  @item  @item
2279  @command{weechat::command ( command, [channel, [server]] );}@*  Perl: @command{weechat::print ( message, [channel, [server]] );}@*
2280    Python: @command{weechat.prnt ( message, [channel, [server]] )}@*
2281  @*  @*
2282  Execute a command or send a message to a channel.@*  Print message in a channel.@*
2283    
2284  @emph{Arguments:}  @emph{Arguments:}
2285  @itemize @minus  @itemize @minus
2286  @item @option{command}: command to execute (or message to send in a channel)  @item @option{message}: message to display
2287  @item @option{channel}: name of channel  @item @option{channel}: name of channel
2288  @item @option{server}: internal name of server  @item @option{server}: internal name of server
2289  @end itemize  @end itemize
# Line 2415  Execute a command or send a message to a Line 2292  Execute a command or send a message to a
2292  @*  @*
2293  1 if successful, 0 if error occured.@*  1 if successful, 0 if error occured.@*
2294  @*  @*
2295  @emph{Examples:}@*  @emph{Perl examples:}@*
 @*  
 @code{weechat::command ("hello world!");}@*  
 @code{weechat::command ("/kick toto please leave this chan", "#weechat");}@*  
 @code{weechat::command ("/nick newnick", "", "freenode");}@*  
 @*  
   
 @item  
 @command{weechat::get_info ( nome, [servidor, [canal] ] );}@*  
 @*  
 Comece o v@'ario info sobre WeeChat, servidor ou usu@'ario.@*  
   
 @emph{Argumentos:}  
 @itemize @minus  
 @item @option{nome}: nome do info a recuperar:  
 @itemize @minus  
 @item @option{version}: comece a vers@~ao de WeeChat  
 @item @option{nick}: comece o nickname  
 @item @option{channel}: comece o nome da canal  
 @item @option{server}: comece o nome do servidor  
 @item @option{away}: get ``away'' flag  
 @item @option{weechat_dir}: get WeeChat home dir  
 @item @option{weechat_libdir}: get WeeChat system lib dir  
 @item @option{weechat_sharedir}: get WeeChat system share dir  
 @end itemize  
 @item @option{servidor}: nome interno da servidor  
 @item @option{canal}: nome da canal  
 @end itemize  
 @*  
 @emph{Return value:}@*  
2296  @*  @*
2297  Asked info, empty if error occured or info was not found.@*  @code{weechat::print ("message");}@*
2298    @code{weechat::print ("message", "#weechat");}@*
2299    @code{weechat::print ("message", "#weechat", "freenode");}@*
2300  @*  @*
2301  @emph{Exemplos:}@*  @emph{Python examples:}@*
2302  @*  @*
2303  @code{$version = get_info("version");}@*  @code{weechat.prnt ("message")}@*
2304  @code{$nick = get_info("nick", "freenode");}@*  @code{weechat.prnt ("message", "#weechat")}@*
2305    @code{weechat.prnt ("message", "#weechat", "freenode")}@*
2306  @*  @*
2307    
2308  @item  @item
2309  @command{weechat::get_dcc_info ( );}@*  Perl: @command{weechat::print_infobar ( delay, message );}@*
2310    Python: @command{weechat.print_infobar ( delay, message )}@*
2311  @*  @*
2312  Get DCC list.@*  Print message in infobar.@*
   
 Returned array has following fields:  
 @itemize @minus  
 @item server: IRC server  
 @item channel: IRC channel  
 @item type: DCC type:  
 @itemize @minus  
 @item 0: chat (received)  
 @item 1: chat (sent)  
 @item 2: file (receiving)  
 @item 3: file (sending)  
 @end itemize  
 @item status: DCC status:  
 @itemize @minus  
 @item 0: waiting  
 @item 1: connecting  
 @item 2: active  
 @item 3: done  
 @item 4: failed  
 @item 5: aborted  
 @end itemize  
 @item start_time: date/time of DCC creation  
 @item start_transfer: date/time of transfer start  
 @item addr: remote address  
 @item port: port used for DCC  
 @item nick: remote nick  
 @item filename: filename  
 @item local_filename: local filename  
 @item size: file size  
 @item pos: current position in file  
 @item start_resume: restart position after interruption  
 @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 ( option );}@*  
 @*  
 Get WeeChat config option value.@*  
   
 @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{Examples:}@*  
 @*  
 @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.@*  
2313    
2314  @emph{Arguments:}  @emph{Arguments:}
2315  @itemize @minus  @itemize @minus
2316  @item @option{option}: name of option  @item @option{delay}: after this delay (in seconds), message will be erased
2317  @item @option{value}: new value for option  (if 0, message will not be erased).
2318    @item @option{message}: message to display
2319  @end itemize  @end itemize
2320  @*  @*
2321  @emph{Return value:}@*  @emph{Return value:}@*
2322  @*  @*
2323  1 if successful, 0 if error occured.@*  1 if successful, 0 if error occured.@*
2324  @*  @*
2325  @emph{Examples:}@*  @emph{Perl example:}@*
2326  @*  @*
2327  @code{weechat::set_config ("look_nicklist", "off");}@*  @code{weechat::print_infobar (5, "message");}@*
 @code{weechat::set_config ("freenode.server_autojoin"", "#weechat");}@*  
2328  @*  @*
2329    @emph{Python example:}@*
 @item  
 @command{weechat::get_plugin_config ( option );}@*  
2330  @*  @*
2331  Return value of a plugin option.@*  @code{weechat.print_infobar (5, "message")}@*
 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");}@*  
2332  @*  @*
2333    
2334  @item  @item
2335  @command{weechat::set_plugin_config ( option, value );}@*  Perl: @command{weechat::add_message_handler ( name, function );}@*
2336    Python: @command{weechat.add_message_handler ( name, function )}@*
2337  @*  @*
2338  Update value of a plugin option.@*  Attach a script function to an IRC message.@*
2339  Option is written in file ~/.weechat/plugins.rc and is like:@*  Function will be called each time IRC message will be received.@*
 @code{plugin.script.option=value}@*  
 Note: plugin and script names are automatically added.@*  
2340    
2341  @emph{Arguments:}  @emph{Arguments:}
2342  @itemize @minus  @itemize @minus
2343  @item @option{option}: name of option  @item @option{name}: name of IRC message@*
2344  @item @option{value}: new value for option  To know list of IRC messages, please refer to RFC 1459 and/or 2812:@*
2345  @end itemize  RFC 1459: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@*
2346  @*  RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt}
2347  @emph{Return value:}@*  @item @option{function}: function called when message is received
 @*  
 1 if successful, 0 if error occured.@*  
 @*  
 @emph{Example:}@*  
 @*  
 @code{weechat::set_plugin_config ("my_var", "value");}@*  
 @*  
   
 @end itemize  
   
 @subsection Python scripts  
   
 @subsubsection Carregar/Descarregar Scripts Python  
   
 Os Scripts Python s@~ao carregados e descarregados com o comando @command{/python}.  
 (escreve @kbd{/help python} dentro do WeeChat para obteres ajuda acerca do comando).@*  
   
 @emph{Exemplos:}@*  
 @itemize @bullet  
 @item  
 Carregar um Script Python: @kbd{/python load /tmp/sample.py}@*  
 @item  
 Descarregar todos os Scripts Python: @kbd{/python unload}@*  
 @item  
 Listar todos os Scripts Python: @kbd{/python}@*  
 @end itemize  
   
 @subsubsection Interface WeeChat / Python  
   
 @itemize @bullet  
 @item  
 @command{weechat.register ( nome, vers@~ao, fun@,{c}@~ao_de_shutdown, descri@,{c}@~ao );}@*  
 @*  
 Esta @'e a primeira fun@,{c}@~ao a invocar num Script Python.@*  
 Todos os Scripts Python para o Weechat devem invocar esta fun@,{c}@~ao.@*  
   
 @emph{Argumentos:}  
 @itemize @minus  
 @item @option{nome}: nome @'unico que indentifique o script (cada Script Python deve ter um @'unico nome)  
 @item @option{vers@~ao}: vers@~ao do script  
 @item @option{fun@,{c}@~ao_de_shutdown}: fun@,{c}@~ao Python invocada quando o script é descarregado (par@^ametro opcional, se deixado em branco significa que nada deve ser chamado)  
 @item @option{descri@,{c}@~ao}: breve descri@,{c}@~ao do script.  
 @end itemize  
 @*  
 @emph{Return value:}@*  
 @*  
 1 if script was registered, 0 if error occured.@*  
 @*  
 @emph{Exemplo:}@*  
 @*  
 @code{weechat.register ("sample", "1.0", "sample_end", "Sample script!")}@*  
 @*  
   
 @item  
 @command{weechat.prnt ( mensagem, [canal, [servidor]] )}@*  
 @*  
 Imprimne uma mensagem na canal.@*  
   
 @emph{Argumentos:}  
 @itemize @minus  
 @item @option{mensagem}: mensagem a mostrar  
 @item @option{canal}: nome da canal  
 @item @option{servidor}: nome interno da servidor  
 @end itemize  
 @*  
 @emph{Return value:}@*  
 @*  
 1 if successful, 0 if error occured.@*  
 @*  
 @emph{Exemplos:}@*  
 @*  
 @code{weechat.prnt ("mensagem")}@*  
 @code{weechat.prnt ("mensagem", "#weechat")}@*  
 @code{weechat.prnt ("mensagem", "#weechat", "freenode")}@*  
 @*  
   
 @item  
 @command{weechat.print_infobar ( atrasa, mensagem )}@*  
 @*  
 Imprimne uma mensagem na barra do info.@*  
   
 @emph{Argumentos:}  
 @itemize @minus  
 @item @option{atrasa}: depois que isto atrasa (nos segundos), a mensagem estar@'a apagada  
 (se 0, mensagem n@~ao forem apagados).  
 @item @option{mensagem}: mensagem a mostrar  
2348  @end itemize  @end itemize
2349  @*  @*
2350  @emph{Return value:}@*  @emph{Return value:}@*
2351  @*  @*
2352  1 if successful, 0 if error occured.@*  1 if function was attached, 0 if error occured.@*
2353  @*  @*
2354  @emph{Exemplo:}@*  @emph{Perl example:}@*
2355  @*  @*
2356  @code{weechat.print_infobar (5, "mensagem")}@*  @code{weechat::add_message_handler ("privmsg", my_function);}@*
2357  @*  @code{sub my_function}@*
2358    @code{@{ }@*
2359  @item  @code{@ @ @ @ weechat::print ("server=$_[0]\n");}@*
2360  @command{weechat.add_message_handler ( nome, fun@,{c}@~ao )}@*  @code{@ @ @ @ ($null, $channel, $message) = split ":",$_[1],3;}@*
2361  @*  @code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@*
2362  Anexa uma fun@,{c}@~ao Python a uma mensagem de IRC.@*  @code{@ @ @ @ weechat::print ("host=$hostmask, chan=$channel, msg=$message\n");}@*
2363  A fun@,{c}@~ao ser@'a invocada de cada vez que a mensagem IRC for recebida.@*  @code{@ @ @ @ return 0;}@*
2364    @code{@} }@*
 @emph{Argumentos:}  
 @itemize @minus  
 @item @option{nome}: nome da mensagem IRC@*  
 Para conheceres uma lista de mensagens de IRC, por favor lê o RFC 1459 e/ou o 2812:@*  
 RFC 1459: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@*  
 RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt}  
 @item @option{fun@,{c}@~ao}: fun@,{c}@~ao Python invocada quando a mensagem é recebida  
 @end itemize  
 @*  
 @emph{Return value:}@*  
2365  @*  @*
 1 if Python function was attached, 0 if error occured.@*  
2366  @*  @*
2367  @emph{Exemplo:}@*  @emph{Python example:}@*
2368  @*  @*
2369  @code{weechat.add_message_handler ("privmsg", my_function)}@*  @code{weechat.add_message_handler ("privmsg", my_function)}@*
2370  @code{def my_function(server, args):}@*  @code{def my_function(server, args):}@*
2371  @code{@ @ @ @ weechat.prnt("server="+server)}@*  @code{@ @ @ @ weechat.prnt("server="+server)}@*
2372  @code{@ @ @ @ null, channel, message = string.split(args, ":", 2)}@*  @code{@ @ @ @ null, channel, message = string.split(args, ":", 2)}@*
2373  @code{@ @ @ @ hostmask, null, channel = string.split(string.strip(channel), " ", 2)}@*  @code{@ @ @ @ hostmask, null, channel = string.split(string.strip(channel), " ", 2)}@*
2374  @code{@ @ @ @ weechat.prnt("host="+hostmask+", chan="+channel+", msg="+message)}@*  @code{@ @ @ @ weechat.prnt("host="+hostmask+", channel="+channel+", message="+message)}@*
2375  @code{@ @ @ @ return 0}@*  @code{@ @ @ @ return 0}@*
2376  @*  @*
2377  @emph{Notes:}@*  @emph{Notes:}@*
2378  @*  @*
2379  Function called when message is received has to return one of these values:@*  Function called when message is received has to return one of these
2380  @itemize @minus  values (prefixed by ``weechat::'' for Perl and ``weechat.'' for
2381  @item @option{-1}: function failed  Python):@*
2382  @item @option{0}: function successfully completed  @itemize @minus
2383  @item @option{1}: message will not be sent to WeeChat  @item @option{PLUGIN_RC_KO}: function failed
2384  @item @option{2}: message will not be sent to other plugins  @item @option{PLUGIN_RC_OK}: function successfully completed
2385  @item @option{3}: message will not be sent to WeeChat neither other plugins  @item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent
2386    to WeeChat
2387    @item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent
2388    to other plugins
2389    @item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to
2390    WeeChat neither other plugins
2391  @end itemize  @end itemize
2392  @*  @*
2393    
2394  @item  @item
2395  @command{weechat.add_command_handler ( nome, fun@,{c}@~ao )}@*  Perl: @command{weechat::add_command_handler ( name, function );}@*
2396    Python: @command{weechat.add_command_handler ( name, function )}@*
2397  @*  @*
2398  Cria um novo comando do Weechat, ligado a uma fun@,{c}@~ao Python.@*  Create new WeeChat command, linked with script function.@*
2399  A fun@,{c}@~ao ser@'a chamada quando o utilizador a invocar utilizando @command{/nome}@*  Function will be called when user will launch command with @kbd{/name}.@*
2400    
2401  @emph{Argumentos:}  @emph{Arguments:}
2402  @itemize @minus  @itemize @minus
2403  @item @option{nome}: nome do novo comando@*  @item @option{name}: name of new command@*
2404  Este nome pode pertencer a um comando já existente, o qual ser@'a sobreposto pela fun@,{c}@~ao Python. Tem cuidado quando fizeres isto: os comandos originais não estar@~ao acessiveis antes de teres descarregado o Script Python.  This name may be existing command, so that the command is overrided by
2405  @item @option{fun@,{c}@~ao}: fun@,{c}@~ao Python ligada ao comando  script function. Be careful when overriding WeeChat commands, they'll not be
2406    available until your script will be unloaded.
2407    @item @option{function}: function linked with command
2408  @item @option{description}: command description (displayed by /help  @item @option{description}: command description (displayed by /help
2409  command)  command)
2410  @item @option{arguments}: short description of command arguments  @item @option{arguments}: short description of command arguments
# Line 2734  arguments (displayed by /help command) Line 2415  arguments (displayed by /help command)
2415  @*  @*
2416  @emph{Return value:}@*  @emph{Return value:}@*
2417  @*  @*
2418  1 if Python function was attached, 0 if error occured.@*  1 if function was attached, 0 if error occured.@*
2419  @*  @*
2420  @emph{Exemplo:}@*  @emph{Perl example:}@*
2421    @*
2422    @code{weechat::add_command_handler ("command", my_command);}@*
2423    @code{sub my_command}@*
2424    @code{@{ }@*
2425    @code{@ @ @ @ weechat::print("Server: $_[0], arguments: $_[1]\n");}@*
2426    @code{@ @ @ @ return 0;}@*
2427    @code{@} }@*
2428    @*
2429    @emph{Python example:}@*
2430  @*  @*
2431  @code{weechat.add_command_handler ("command", my_command)}@*  @code{weechat.add_command_handler ("command", my_command)}@*
2432  @code{def my_command(server, args):}@*  @code{def my_command(server, args):}@*
2433  @code{@ @ @ @ weechat.prnt("Servidor:"+server+" Argumentos:"+args)}@*  @code{@ @ @ @ weechat.prnt("server:"+server+" arguments:"+args)}@*
2434    @code{@ @ @ @ return 0}@*
2435  @*  @*
2436  @emph{Notes:}@*  @emph{Notes:}@*
2437  @*  @*
2438  Function called when command is executed has to return one of these values:@*  Function called when command is executed has to return one of these
2439    values (prefixed by ``weechat::'' for Perl and ``weechat.'' for
2440    Python):@*
2441  @itemize @minus  @itemize @minus
2442  @item @option{-1}: function failed  @item @option{PLUGIN_RC_KO}: function failed
2443  @item @option{0}: function successfully completed  @item @option{PLUGIN_RC_OK}: function successfully completed
2444  @end itemize  @end itemize
2445  @*  @*
2446    
2447  @item  @item
2448  @command{weechat.remove_handler ( name, function );}@*  Perl: @command{weechat::remove_handler ( name, function );}@*
2449    Python: @command{weechat.remove_handler ( name, function )}@*
2450  @*  @*
2451  Remove a message or command handler.@*  Remove a message or command handler.@*
2452    
2453  @emph{Arguments:}  @emph{Arguments:}
2454  @itemize @minus  @itemize @minus
2455  @item @option{name}: name of IRC message or command handler  @item @option{name}: name of IRC message or command handler
2456  @item @option{function}: Python function  @item @option{function}: function
2457  @end itemize  @end itemize
2458  @*  @*
2459  @emph{Return value:}@*  @emph{Return value:}@*
2460  @*  @*
2461  1 if successful, 0 if error occured.@*  1 if successful, 0 if error occured.@*
2462  @*  @*
2463  @emph{Example:}@*  @emph{Perl example:}@*
2464    @*
2465    @code{weechat::remove_handler ("command", my_command);}@*
2466  @*  @*
2467  @code{weechat.remove_handler ("command", my_command);}@*  @emph{Python example:}@*
2468    @*
2469    @code{weechat.remove_handler ("command", my_command)}@*
2470  @*  @*
2471    
2472  @item  @item
2473  @command{weechat.command ( command, [channel, [server]] )}@*  Perl: @command{weechat::command ( command, [channel, [server]] );}@*
2474    Python: @command{weechat.command ( command, [channel, [server]] )}@*
2475  @*  @*
2476  Execute a command or send a message to a channel.@*  Execute a command or send a message to a channel.@*
2477    
# Line 2787  Execute a command or send a message to a Line 2486  Execute a command or send a message to a
2486  @*  @*
2487  1 if successful, 0 if error occured.@*  1 if successful, 0 if error occured.@*
2488  @*  @*
2489  @emph{Examples:}@*  @emph{Perl examples:}@*
2490    @*
2491    @code{weechat::command ("hello world!");}@*
2492    @code{weechat::command ("/kick toto please leave this chan", "#weechat");}@*
2493    @code{weechat::command ("/nick newnick", "", "freenode");}@*
2494    @*
2495    @emph{Python examples:}@*
2496  @*  @*
2497  @code{weechat.command ("hello world!")}@*  @code{weechat.command ("hello world!")}@*
2498  @code{weechat.command ("/kick toto please leave this chan", "#weechat")}@*  @code{weechat.command ("/kick toto please leave this chan", "#weechat")}@*
# Line 2795  Execute a command or send a message to a Line 2500  Execute a command or send a message to a
2500  @*  @*
2501    
2502  @item  @item
2503  @command{weechat.get_info ( nome, [servidor] )}@*  Perl: @command{weechat::get_info ( name, [server, [channel] ] );}@*
2504    Python: @command{weechat.get_info ( name, [server, [channel] ] )}@*
2505  @*  @*
2506  Comece o v@'ario info sobre WeeChat, servidor ou usu@'ario.@*  Get various info about WeeChat, server or user.@*
2507    
2508  @emph{Argumentos:}  @emph{Arguments:}
2509  @itemize @minus  @itemize @minus
2510  @item @option{nome}: nome do info a recuperar:  @item @option{name}: name of info to retrieve:
2511  @itemize @minus  @itemize @minus
2512  @item @option{version}: comece a vers@~ao de WeeChat  @item @option{version}: get WeeChat version
2513  @item @option{nick}: comece o nickname  @item @option{nick}: get nickname
2514  @item @option{channel}: comece o nome da canal  @item @option{channel}: get channel name
2515  @item @option{server}: comece o nome do servidor  @item @option{server}: get server name
2516  @item @option{away}: get ``away'' flag  @item @option{away}: get ``away'' flag
2517  @item @option{weechat_dir}: get WeeChat home dir  @item @option{weechat_dir}: get WeeChat home dir
2518  @item @option{weechat_libdir}: get WeeChat system lib dir  @item @option{weechat_libdir}: get WeeChat system lib dir
2519  @item @option{weechat_sharedir}: get WeeChat system share dir  @item @option{weechat_sharedir}: get WeeChat system share dir
2520    
2521  @end itemize  @end itemize
2522  @item @option{servidor}: nome interno da servidor  @item @option{server}: internal name of server
2523    @item @option{channel}: channel name
2524  @end itemize  @end itemize
2525  @*  @*
2526  @emph{Return value:}@*  @emph{Return value:}@*
2527  @*  @*
2528  Asked info, empty if error occured or info was not found.@*  Asked info, empty if error occured or info was not found.@*
2529  @*  @*
2530  @emph{Exemplos:}@*  @emph{Perl examples:}@*
2531    @*
2532    @code{$version = weechat::get_info("version");}@*
2533    @code{$nick = weechat::get_info("nick", "freenode");}@*
2534    @*
2535    @emph{Python examples:}@*
2536  @*  @*
2537  @code{$version = weechat.get_info("version")}@*  @code{$version = weechat.get_info("version")}@*
2538  @code{$nick = weechat.get_info("nick", "freenode")}@*  @code{$nick = weechat.get_info("nick", "freenode")}@*
2539  @*  @*
2540    
2541  @item  @item
2542  @command{weechat::get_dcc_info ( );}@*  Perl: @command{weechat::get_dcc_info ( );}@*
2543    Python: @command{weechat.get_dcc_info ( );}@*
2544  @*  @*
2545  Get DCC list.@*  Get DCC list.@*
2546    
# Line 2869  DCC list, 0 if error occured.@* Line 2583  DCC list, 0 if error occured.@*
2583  @*  @*
2584    
2585  @item  @item
2586  @command{weechat.get_config ( option );}@*  Perl: @command{weechat::get_config ( option );}@*
2587    Python: @command{weechat.get_config ( option )}@*
2588  @*  @*
2589  Get WeeChat config option value.@*  Get WeeChat config option value.@*
2590    
# Line 2882  Get WeeChat config option value.@* Line 2597  Get WeeChat config option value.@*
2597  @*  @*
2598  Value of option, empty if error occured or option was not found.@*  Value of option, empty if error occured or option was not found.@*
2599  @*  @*
2600  @emph{Examples:}@*  @emph{Perl examples:}@*
2601    @*
2602    @code{$value1 = weechat::get_config ("look_nicklist");}@*
2603    @code{$value2 = weechat::get_config ("freenode.server_autojoin");}@*
2604  @*  @*
2605  @code{$value1 = weechat.get_config ("look_nicklist");}@*  @emph{Python examples:}@*
2606  @code{$value2 = weechat.get_config ("freenode.server_autojoin");}@*  @*
2607    @code{$value1 = weechat.get_config ("look_nicklist")}@*
2608    @code{$value2 = weechat.get_config ("freenode.server_autojoin")}@*
2609  @*  @*
2610    
2611  @item  @item
2612  @command{weechat.set_config ( option, value );}@*  Perl: @command{weechat::set_config ( option, value );}@*
2613    Python: @command{weechat.set_config ( option, value )}@*
2614  @*  @*
2615  Get WeeChat config option value.@*  Get WeeChat config option value.@*
2616    
# Line 2903  Get WeeChat config option value.@* Line 2624  Get WeeChat config option value.@*
2624  @*  @*
2625  1 if successful, 0 if error occured.@*  1 if successful, 0 if error occured.@*
2626  @*  @*
2627  @emph{Examples:}@*  @emph{Perl examples:}@*
2628    @*
2629    @code{weechat::set_config ("look_nicklist", "off");}@*
2630    @code{weechat::set_config ("freenode.server_autojoin"",
2631    "#weechat");}@*
2632    @*
2633    @emph{Python examples:}@*
2634  @*  @*
2635  @code{weechat.set_config ("look_nicklist", "off");}@*  @code{weechat.set_config ("look_nicklist", "off")}@*
2636  @code{weechat.set_config ("freenode.server_autojoin"", "#weechat");}@*  @code{weechat.set_config ("freenode.server_autojoin"", "#weechat")}@*
2637  @*  @*
2638    
2639  @item  @item
2640  @command{weechat.get_plugin_config ( option );}@*  Perl: @command{weechat::get_plugin_config ( option );}@*
2641    Python: @command{weechat.get_plugin_config ( option )}@*
2642  @*  @*
2643  Return value of a plugin option.@*  Return value of a plugin option.@*
2644  Option is read from file ~/.weechat/plugins.rc and is like:@*  Option is read from file ~/.weechat/plugins.rc and is like:@*
# Line 2926  Note: plugin and script names are automa Line 2654  Note: plugin and script names are automa
2654  @*  @*
2655  Value of option, empty if error occured or option was not found.@*  Value of option, empty if error occured or option was not found.@*
2656  @*  @*
2657  @emph{Example:}@*  @emph{Perl example:}@*
2658    @*
2659    @code{$value = weechat::get_plugin_config ("my_var");}@*
2660  @*  @*
2661  @code{$value = weechat.get_plugin_config ("my_var");}@*  @emph{Python example:}@*
2662    @*
2663    @code{$value = weechat.get_plugin_config ("my_var")}@*
2664  @*  @*
2665    
2666  @item  @item
2667  @command{weechat.set_plugin_config ( option, value );}@*  Perl: @command{weechat::set_plugin_config ( option, value );}@*
2668    Python: @command{weechat.set_plugin_config ( option, value )}@*
2669  @*  @*
2670  Update value of a plugin option.@*  Update value of a plugin option.@*
2671  Option is written in file ~/.weechat/plugins.rc and is like:@*  Option is written in file ~/.weechat/plugins.rc and is like:@*
# Line 2949  Note: plugin and script names are automa Line 2682  Note: plugin and script names are automa
2682  @*  @*
2683  1 if successful, 0 if error occured.@*  1 if successful, 0 if error occured.@*
2684  @*  @*
2685  @emph{Example:}@*  @emph{Perl example:}@*
2686  @*  @*
2687  @code{weechat.set_plugin_config ("my_var", "value");}@*  @code{weechat::set_plugin_config ("my_var", "value");}@*
2688    @*
2689    @emph{Python example:}@*
2690    @*
2691    @code{weechat.set_plugin_config ("my_var", "value")}@*
2692  @*  @*
2693    
2694  @end itemize  @end itemize
2695    
 @subsection Ruby scripts  
   
 N@~AO DESENVOLVIDO!  
   
2696    
2697  @c **************************** Autores/Suporte *****************************  @c **************************** Autores/Suporte *****************************
2698    

Legend:
Removed from v.1.50  
changed lines
  Added in v.1.51

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26