35 |
|
|
36 |
@title WeeChat - Guia do Utilizador |
@title WeeChat - Guia do Utilizador |
37 |
@subtitle Cliente de IRC rapido, leve e extencivel |
@subtitle Cliente de IRC rapido, leve e extencivel |
38 |
@subtitle Documenta@,{c}@~ao do WeeChat v0.1.2-cvs - 30 de Abril de 2005 |
@subtitle Documenta@,{c}@~ao do WeeChat v0.1.2-cvs - 08 de Maio de 2005 |
39 |
|
|
40 |
@image{weechat_image} |
@image{weechat_image} |
41 |
|
|
398 |
|
|
399 |
@itemize @bullet |
@itemize @bullet |
400 |
@item |
@item |
401 |
@command{IRC::register ( nome, vers@~ao, fun@,{c}@~ao_de_shutdown, descri@,{c}@~ao );}@* |
@command{weechat::register ( nome, vers@~ao, fun@,{c}@~ao_de_shutdown, descri@,{c}@~ao );}@* |
402 |
@* |
@* |
403 |
Esta @'e a primeira fun@,{c}@~ao a invocar num Script Perl.@* |
Esta @'e a primeira fun@,{c}@~ao a invocar num Script Perl.@* |
404 |
Todos os Scripts Perl para o Weechat devem invocar esta fun@,{c}@~ao.@* |
Todos os Scripts Perl para o Weechat devem invocar esta fun@,{c}@~ao.@* |
412 |
@end itemize |
@end itemize |
413 |
@* |
@* |
414 |
@emph{Exemplo:}@* |
@emph{Exemplo:}@* |
415 |
@code{IRC::register ("sample", "1.0", "sample_end", "Sample script!");}@* |
@code{weechat::register ("sample", "1.0", "sample_end", "Sample script!");}@* |
416 |
@* |
@* |
417 |
|
|
418 |
@item |
@item |
419 |
@command{IRC::print ( mensagem );}@* |
@command{weechat::print ( mensagem, [canal, [servidor]] );}@* |
420 |
|
@* |
421 |
|
Imprimne uma mensagem na canal.@* |
422 |
|
|
423 |
|
@emph{Argumentos:} |
424 |
|
@itemize @minus |
425 |
|
@item @option{mensagem}: mensagem a mostrar |
426 |
|
@item @option{canal}: nome da canal |
427 |
|
@item @option{servidor}: nome interno da servidor |
428 |
|
@end itemize |
429 |
|
@* |
430 |
|
@emph{Exemplo:}@* |
431 |
|
@code{weechat::print ("mensagem");}@* |
432 |
|
@code{weechat::print ("mensagem", "#weechat");}@* |
433 |
|
@code{weechat::print ("mensagem", "#weechat", "freenode");}@* |
434 |
@* |
@* |
435 |
Imprimne uma mensagem na janela actual (canal ou servidor).@* |
|
436 |
|
@item |
437 |
|
@command{weechat::print_infobar ( atrasa, mensagem );}@* |
438 |
|
@* |
439 |
|
Imprimne uma mensagem na barra do info.@* |
440 |
|
|
441 |
@emph{Argumentos:} |
@emph{Argumentos:} |
442 |
@itemize @minus |
@itemize @minus |
443 |
|
@item @option{atrasa}: depois que isto atrasa (nos segundos), a mensagem estar@'a apagada |
444 |
|
(se 0, mensagem n@~ao forem apagados). |
445 |
@item @option{mensagem}: mensagem a mostrar |
@item @option{mensagem}: mensagem a mostrar |
446 |
@end itemize |
@end itemize |
447 |
@* |
@* |
448 |
@emph{Exemplo:}@* |
@emph{Exemplo:}@* |
449 |
@code{IRC::print ("mensagem");}@* |
@code{weechat::print_infobar (5, "mensagem");}@* |
450 |
|
@* |
451 |
|
|
452 |
|
@item |
453 |
|
@command{weechat::add_message_handler ( nome, fun@,{c}@~ao );}@* |
454 |
|
@* |
455 |
|
Anexa uma fun@,{c}@~ao Perl a uma mensagem de IRC.@* |
456 |
|
A fun@,{c}@~ao ser@'a invocada de cada vez que a mensagem IRC for recebida.@* |
457 |
|
|
458 |
|
@emph{Argumentos:} |
459 |
|
@itemize @minus |
460 |
|
@item @option{nome}: nome da mensagem IRC@* |
461 |
|
Para conheceres uma lista de mensagens de IRC, por favor lê o RFC 1459 e/ou o 2812:@* |
462 |
|
RFC 1459: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@* |
463 |
|
RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} |
464 |
|
@item @option{fun@,{c}@~ao}: fun@,{c}@~ao Perl invocada quando a mensagem é recebida |
465 |
|
@end itemize |
466 |
|
@* |
467 |
|
@emph{Exemplo:}@* |
468 |
|
@code{weechat::add_message_handler ("privmsg", my_function);}@* |
469 |
|
@code{sub my_function}@* |
470 |
|
@code{@{ }@* |
471 |
|
@code{@ @ @ @ ($null, $channel, $message) = split ":",@@_[0],3;}@* |
472 |
|
@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* |
473 |
|
@code{@ @ @ @ weechat::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* |
474 |
|
@code{@} }@* |
475 |
|
@* |
476 |
|
|
477 |
|
@item |
478 |
|
@command{weechat::add_command_handler ( nome, fun@,{c}@~ao );}@* |
479 |
|
@* |
480 |
|
Cria um novo comando do Weechat, ligado a uma fun@,{c}@~ao Perl.@* |
481 |
|
A fun@,{c}@~ao ser@'a chamada quando o utilizador a invocar utilizando @command{/nome}@* |
482 |
|
|
483 |
|
@emph{Argumentos:} |
484 |
|
@itemize @minus |
485 |
|
@item @option{nome}: nome do novo comando@* |
486 |
|
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. |
487 |
|
@item @option{fun@,{c}@~ao}: fun@,{c}@~ao Perl ligada ao comando |
488 |
|
@end itemize |
489 |
|
@* |
490 |
|
@emph{Exemplo:}@* |
491 |
|
@code{weechat::add_command_handler ("command", my_command);}@* |
492 |
|
@code{sub my_command}@* |
493 |
|
@code{@{ }@* |
494 |
|
@code{@ @ @ @ weechat::print("Argumentos: ".@@_[0]);}@* |
495 |
|
@code{@ @ @ @ return 0;}@* |
496 |
|
@code{@} }@* |
497 |
|
@* |
498 |
|
|
499 |
|
@item |
500 |
|
@command{weechat::command ( command, [channel, [server]] );}@* |
501 |
|
@* |
502 |
|
Execute a command or send a message to a channel.@* |
503 |
|
|
504 |
|
@emph{Arguments:} |
505 |
|
@itemize @minus |
506 |
|
@item @option{command}: command to execute (or message to send in a channel) |
507 |
|
@item @option{channel}: name of channel |
508 |
|
@item @option{server}: internal name of server |
509 |
|
@end itemize |
510 |
|
@* |
511 |
|
@emph{Examples:}@* |
512 |
|
@code{weechat::command ("hello world!");}@* |
513 |
|
@code{weechat::command ("/kick toto please leave this chan", "#weechat");}@* |
514 |
|
@code{weechat::command ("/nick newnick", "", "freenode");}@* |
515 |
|
@* |
516 |
|
|
517 |
|
@item |
518 |
|
@command{weechat::get_info ( nome, [servidor] );}@* |
519 |
|
@* |
520 |
|
Comece o v@'ario info sobre WeeChat, servidor ou usu@'ario.@* |
521 |
|
|
522 |
|
@emph{Argumentos:} |
523 |
|
@itemize @minus |
524 |
|
@item @option{nome}: nome do info a recuperar: |
525 |
|
@item @option{servidor}: nome interno da servidor |
526 |
|
@itemize @minus |
527 |
|
@item @option{0 ou version}: comece a vers@~ao de WeeChat |
528 |
|
@item @option{1 ou nick}: comece o nickname |
529 |
|
@item @option{2 ou channel}: comece o nome da canal |
530 |
|
@item @option{3 ou server}: comece o nome do servidor |
531 |
|
@item @option{4 ou weechatdir}: comece a WeeChat o diret@'orio home |
532 |
|
@item @option{5 ou away}: comece a bandeira ausente para o servidor |
533 |
|
@end itemize |
534 |
|
@end itemize |
535 |
|
@* |
536 |
|
@emph{Exemplos:}@* |
537 |
|
@code{$version = get_info("version");}@* |
538 |
|
@code{$nick = get_info("nick", "freenode");}@* |
539 |
|
@* |
540 |
|
|
541 |
|
@end itemize |
542 |
|
|
543 |
|
@node Scripts Python, Scripts Ruby, Scripts Perl, Extencoes |
544 |
|
@section Scripts Python |
545 |
|
|
546 |
|
@subsection Carregar/Descarregar Scripts Python |
547 |
|
|
548 |
|
Os Scripts Python s@~ao carregados e descarregados com o comando @command{/python}. |
549 |
|
(escreve @kbd{/help python} dentro do WeeChat para obteres ajuda acerca do comando).@* |
550 |
|
|
551 |
|
@emph{Exemplos:}@* |
552 |
|
@itemize @bullet |
553 |
|
@item |
554 |
|
Carregar um Script Python: @kbd{/python load /tmp/sample.py}@* |
555 |
|
@item |
556 |
|
Descarregar todos os Scripts Python: @kbd{/python unload}@* |
557 |
|
@item |
558 |
|
Listar todos os Scripts Python: @kbd{/python}@* |
559 |
|
@end itemize |
560 |
|
|
561 |
|
@subsection Interface WeeChat / Python |
562 |
|
|
563 |
|
@itemize @bullet |
564 |
|
@item |
565 |
|
@command{weechat.register ( nome, vers@~ao, fun@,{c}@~ao_de_shutdown, descri@,{c}@~ao );}@* |
566 |
|
@* |
567 |
|
Esta @'e a primeira fun@,{c}@~ao a invocar num Script Python.@* |
568 |
|
Todos os Scripts Python para o Weechat devem invocar esta fun@,{c}@~ao.@* |
569 |
|
|
570 |
|
@emph{Argumentos:} |
571 |
|
@itemize @minus |
572 |
|
@item @option{nome}: nome @'unico que indentifique o script (cada Script Python deve ter um @'unico nome) |
573 |
|
@item @option{vers@~ao}: vers@~ao do script |
574 |
|
@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) |
575 |
|
@item @option{descri@,{c}@~ao}: breve descri@,{c}@~ao do script. |
576 |
|
@end itemize |
577 |
|
@* |
578 |
|
@emph{Exemplo:}@* |
579 |
|
@code{weechat.register ("sample", "1.0", "sample_end", "Sample script!");}@* |
580 |
@* |
@* |
581 |
|
|
582 |
@item |
@item |
583 |
@command{IRC::print_with_channel ( canal, [servidor,] mensagem );}@* |
@command{weechat.prnt ( mensagem, [canal, [servidor]] );}@* |
584 |
@* |
@* |
585 |
Imprimne uma mensagem na canal.@* |
Imprimne uma mensagem na canal.@* |
586 |
|
|
587 |
@emph{Argumentos:} |
@emph{Argumentos:} |
588 |
@itemize @minus |
@itemize @minus |
589 |
|
@item @option{mensagem}: mensagem a mostrar |
590 |
@item @option{canal}: nome da canal |
@item @option{canal}: nome da canal |
591 |
@item @option{servidor}: nome interno da servidor |
@item @option{servidor}: nome interno da servidor |
|
@item @option{mensagem}: mensagem a mostrar |
|
592 |
@end itemize |
@end itemize |
593 |
@* |
@* |
594 |
@emph{Exemplos:}@* |
@emph{Exemplo:}@* |
595 |
@code{IRC::print_with_channel ("#weechat", "freenode", "mensagem");}@* |
@code{weechat.prnt ("mensagem");}@* |
596 |
@code{IRC::print_with_channel ("#weechat", "mensagem");}@* |
@code{weechat.prnt ("mensagem", "#weechat");}@* |
597 |
|
@code{weechat.prnt ("mensagem", "#weechat", "freenode");}@* |
598 |
@* |
@* |
599 |
|
|
600 |
@item |
@item |
601 |
@command{IRC::print_infobar ( atrasa, mensagem );}@* |
@command{weechat.print_infobar ( atrasa, mensagem );}@* |
602 |
@* |
@* |
603 |
Imprimne uma mensagem na barra do info.@* |
Imprimne uma mensagem na barra do info.@* |
604 |
|
|
610 |
@end itemize |
@end itemize |
611 |
@* |
@* |
612 |
@emph{Exemplo:}@* |
@emph{Exemplo:}@* |
613 |
@code{IRC::print_infobar (5, "mensagem");}@* |
@code{weechat.print_infobar (5, "mensagem");}@* |
614 |
@* |
@* |
615 |
|
|
616 |
@item |
@item |
617 |
@command{IRC::add_message_handler ( nome, fun@,{c}@~ao );}@* |
@command{weechat.add_message_handler ( nome, fun@,{c}@~ao );}@* |
618 |
@* |
@* |
619 |
Anexa uma fun@,{c}@~ao Perl a uma mensagem de IRC.@* |
Anexa uma fun@,{c}@~ao Python a uma mensagem de IRC.@* |
620 |
A fun@,{c}@~ao ser@'a invocada de cada vez que a mensagem IRC for recebida.@* |
A fun@,{c}@~ao ser@'a invocada de cada vez que a mensagem IRC for recebida.@* |
621 |
|
|
622 |
@emph{Argumentos:} |
@emph{Argumentos:} |
625 |
Para conheceres uma lista de mensagens de IRC, por favor lê o RFC 1459 e/ou o 2812:@* |
Para conheceres uma lista de mensagens de IRC, por favor lê o RFC 1459 e/ou o 2812:@* |
626 |
RFC 1459: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@* |
RFC 1459: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@* |
627 |
RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} |
RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} |
628 |
@item @option{fun@,{c}@~ao}: fun@,{c}@~ao Perl invocada quando a mensagem é recebida |
@item @option{fun@,{c}@~ao}: fun@,{c}@~ao Python invocada quando a mensagem é recebida |
629 |
@end itemize |
@end itemize |
630 |
@* |
@* |
631 |
@emph{Exemplo:}@* |
@emph{Exemplo:}@* |
632 |
@code{IRC::add_message_handler ("privmsg", my_function);}@* |
@code{weechat.add_message_handler ("privmsg", my_function);}@* |
633 |
@code{sub my_function}@* |
@code{sub my_function}@* |
634 |
@code{@{ }@* |
@code{@{ }@* |
635 |
@code{@ @ @ @ ($null, $channel, $message) = split ":",@@_[0],3;}@* |
@code{@ @ @ @ ($null, $channel, $message) = split ":",@@_[0],3;}@* |
636 |
@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* |
@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* |
637 |
@code{@ @ @ @ IRC::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* |
@code{@ @ @ @ weechat.prnt ("host=$hostmask, chan=$channel, msg=$message\n");}@* |
638 |
@code{@} }@* |
@code{@} }@* |
639 |
@* |
@* |
640 |
|
|
641 |
@item |
@item |
642 |
@command{IRC::add_command_handler ( nome, fun@,{c}@~ao );}@* |
@command{weechat.add_command_handler ( nome, fun@,{c}@~ao );}@* |
643 |
@* |
@* |
644 |
Cria um novo comando do Weechat, ligado a uma fun@,{c}@~ao Perl.@* |
Cria um novo comando do Weechat, ligado a uma fun@,{c}@~ao Python.@* |
645 |
A fun@,{c}@~ao ser@'a chamada quando o utilizador a invocar utilizando @command{/nome}@* |
A fun@,{c}@~ao ser@'a chamada quando o utilizador a invocar utilizando @command{/nome}@* |
646 |
|
|
647 |
@emph{Argumentos:} |
@emph{Argumentos:} |
648 |
@itemize @minus |
@itemize @minus |
649 |
@item @option{nome}: nome do novo comando@* |
@item @option{nome}: nome do novo comando@* |
650 |
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. |
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. |
651 |
@item @option{fun@,{c}@~ao}: fun@,{c}@~ao Perl ligada ao comando |
@item @option{fun@,{c}@~ao}: fun@,{c}@~ao Python ligada ao comando |
652 |
@end itemize |
@end itemize |
653 |
@* |
@* |
654 |
@emph{Exemplo:}@* |
@emph{Exemplo:}@* |
655 |
@code{IRC::add_command_handler ("command", my_command);}@* |
@code{weechat.add_command_handler ("command", my_command);}@* |
656 |
@code{sub my_command}@* |
@code{sub my_command}@* |
657 |
@code{@{ }@* |
@code{@{ }@* |
658 |
@code{@ @ @ @ IRC::print("Argumentos: ".@@_[0]);}@* |
@code{@ @ @ @ weechat.prnt("Argumentos: ".@@_[0]);}@* |
659 |
@code{@ @ @ @ return 0;}@* |
@code{@ @ @ @ return 0;}@* |
660 |
@code{@} }@* |
@code{@} }@* |
661 |
@* |
@* |
662 |
|
|
663 |
@item |
@item |
664 |
@command{IRC::get_info ( [servidor,] nome );}@* |
@command{weechat.command ( command, [channel, [server]] );}@* |
665 |
|
@* |
666 |
|
Execute a command or send a message to a channel.@* |
667 |
|
|
668 |
|
@emph{Arguments:} |
669 |
|
@itemize @minus |
670 |
|
@item @option{command}: command to execute (or message to send in a channel) |
671 |
|
@item @option{channel}: name of channel |
672 |
|
@item @option{server}: internal name of server |
673 |
|
@end itemize |
674 |
|
@* |
675 |
|
@emph{Examples:}@* |
676 |
|
@code{weechat.command ("hello world!");}@* |
677 |
|
@code{weechat.command ("/kick toto please leave this chan", "#weechat");}@* |
678 |
|
@code{weechat.command ("/nick newnick", "", "freenode");}@* |
679 |
|
@* |
680 |
|
|
681 |
|
@item |
682 |
|
@command{weechat.get_info ( nome, [servidor] );}@* |
683 |
@* |
@* |
684 |
Comece o v@'ario info sobre WeeChat, servidor ou usu@'ario.@* |
Comece o v@'ario info sobre WeeChat, servidor ou usu@'ario.@* |
685 |
|
|
686 |
@emph{Argumentos:} |
@emph{Argumentos:} |
687 |
@itemize @minus |
@itemize @minus |
|
@item @option{servidor}: nome interno da servidor |
|
688 |
@item @option{nome}: nome do info a recuperar: |
@item @option{nome}: nome do info a recuperar: |
689 |
|
@item @option{servidor}: nome interno da servidor |
690 |
@itemize @minus |
@itemize @minus |
691 |
@item @option{0 ou version}: comece a vers@~ao de WeeChat |
@item @option{0 ou version}: comece a vers@~ao de WeeChat |
692 |
@item @option{1 ou nick}: comece o nickname |
@item @option{1 ou nick}: comece o nickname |
698 |
@end itemize |
@end itemize |
699 |
@* |
@* |
700 |
@emph{Exemplos:}@* |
@emph{Exemplos:}@* |
701 |
@code{$version = get_info("version");}@* |
@code{$version = weechat.get_info("version");}@* |
702 |
@code{$nick = get_info("freenode", "nick");}@* |
@code{$nick = weechat.get_info("nick", "freenode");}@* |
703 |
@* |
@* |
704 |
|
|
705 |
@end itemize |
@end itemize |
706 |
|
|
|
@node Scripts Python, Scripts Ruby, Scripts Perl, Extencoes |
|
|
@section Scripts Python |
|
|
|
|
|
N@~AO DESENVOLVIDO! |
|
|
|
|
707 |
@node Scripts Ruby, , Scripts Python, Extencoes |
@node Scripts Ruby, , Scripts Python, Extencoes |
708 |
@section Scripts Ruby |
@section Scripts Ruby |
709 |
|
|