36 |
|
|
37 |
@title WeeChat - Guide utilisateur |
@title WeeChat - Guide utilisateur |
38 |
@subtitle Client IRC rapide, l@'eger et extensible |
@subtitle Client IRC rapide, l@'eger et extensible |
39 |
@subtitle Documentation pour WeeChat v0.1.6-cvs - 2 octobre 2005 |
@subtitle Documentation pour WeeChat v0.1.6-cvs - 17 octobre 2005 |
40 |
|
|
41 |
@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> |
@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> |
42 |
|
|
430 |
Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* |
Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* |
431 |
@item col_input_delimiters |
@item col_input_delimiters |
432 |
Couleur pour le texte saisi (d@'elimiteurs)@* |
Couleur pour le texte saisi (d@'elimiteurs)@* |
433 |
Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* |
Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* |
434 |
@item col_input_bg |
@item col_input_bg |
435 |
Couleur de fond pour la fen@^etre de saisie@* |
Couleur de fond pour la fen@^etre de saisie@* |
436 |
Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* |
Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* |
629 |
@item proxy_password |
@item proxy_password |
630 |
Mot de passe pour le serveur proxy@* |
Mot de passe pour le serveur proxy@* |
631 |
Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* |
Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* |
632 |
|
@item plugins_path |
633 |
|
Chemin de recherche des extensions@* |
634 |
|
Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '~/.weechat/plugins'@* |
635 |
|
@item plugins_autoload |
636 |
|
Liste des extensions @`a charger automatiquement au d@'emarrage, "*" signifie toutes (s@'epar@'ees par des virgules, les noms peuvent @^etre partiels, par exemple "perl" est ok pour "libperl.so")@* |
637 |
|
Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '*'@* |
638 |
|
@item plugins_extension |
639 |
|
Extension standard des extensions dans le nom de fichier, pour le chargement automatique (si vide, alors tous les fichiers sont charg@'es si autoload vaut "*")@* |
640 |
|
Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '.so'@* |
641 |
@item server_name |
@item server_name |
642 |
Nom associ@'e au serveur IRC (pour affichage seulement)@* |
Nom associ@'e au serveur IRC (pour affichage seulement)@* |
643 |
Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* |
Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* |
916 |
functions: lister la liste des fonctions internes pour les associations de touches@* |
functions: lister la liste des fonctions internes pour les associations de touches@* |
917 |
reset: restaur les touches aux valeurs par d@'efaut et supprime TOUTES les touches personnelles (utiliser avec pr@'ecaution !)@* |
reset: restaur les touches aux valeurs par d@'efaut et supprime TOUTES les touches personnelles (utiliser avec pr@'ecaution !)@* |
918 |
@* |
@* |
919 |
@item perl [load fichier] | [autoload] | [reload] | [unload] |
@item plugin [load fichier] | [autoload] | [reload] | [unload] |
|
@* |
|
|
liste/charge/d@'echarge des scripts Perl@* |
|
|
@* |
|
|
fichier: script Perl (fichier) @`a charger@* |
|
|
@* |
|
|
Sans param@`etre, la commande /perl liste tous les scripts Perl charg@'es.@* |
|
|
@* |
|
|
@item python [load fichier] | [autoload] | [reload] | [unload] |
|
920 |
@* |
@* |
921 |
liste/charge/d@'echarge des scripts Python@* |
liste/charge/d@'echarge des extensions@* |
922 |
@* |
@* |
923 |
fichier: script Python (fichier) @`a charger@* |
fichier: extension WeeChat (fichier) @`a charger@* |
924 |
@* |
@* |
925 |
Sans param@`etre, la commande /python liste tous les scripts Python charg@'es.@* |
Sans param@`etre, la commande /plugin liste toutes les extensions charg@'ees.@* |
|
@* |
|
|
@item ruby [load fichier] | [autoload] | [reload] | [unload] |
|
|
@* |
|
|
liste/charge/d@'echarge des scripts Ruby@* |
|
|
@* |
|
|
fichier: script Ruby (fichier) @`a charger@* |
|
|
@* |
|
|
Sans param@`etre, la commande /ruby liste tous les scripts Ruby charg@'es.@* |
|
926 |
@* |
@* |
927 |
@item server [nom_serveur] | [nom_serveur nom/IP port [-auto | -noauto] [-ipv6] [-ssl] [-pwd mot_de_passe] [-nicks pseudo1 pseudo2 pseudo3] [-username nom_utilisateur] [-realname nom_r@'eel] [-command commande] [-autojoin canal[,canal]] ] | [del nom_serveur] |
@item server [nom_serveur] | [nom_serveur nom/IP port [-auto | -noauto] [-ipv6] [-ssl] [-pwd mot_de_passe] [-nicks pseudo1 pseudo2 pseudo3] [-username nom_utilisateur] [-realname nom_r@'eel] [-command commande] [-autojoin canal[,canal]] ] | [del nom_serveur] |
928 |
@* |
@* |
1146 |
m: canal mod@'er@'e@* |
m: canal mod@'er@'e@* |
1147 |
l: fixer la limite d'utilisateurs pour le canal@* |
l: fixer la limite d'utilisateurs pour le canal@* |
1148 |
b: param@'etrer un masque de banissement pour garder des utilisateurs dehors@* |
b: param@'etrer un masque de banissement pour garder des utilisateurs dehors@* |
1149 |
|
e: param@'etrer un masque d'exception@* |
1150 |
v: donner/reprendre la possibilit@'e de parler sur un canal mod@'er@'e@* |
v: donner/reprendre la possibilit@'e de parler sur un canal mod@'er@'e@* |
1151 |
k: d@'efinir une cl@'e (mot de passe) pour acc@'eder au canal@* |
k: d@'efinir une cl@'e (mot de passe) pour acc@'eder au canal@* |
1152 |
modes utilisateur :@* |
modes utilisateur :@* |
1504 |
@chapter Extensions |
@chapter Extensions |
1505 |
|
|
1506 |
@menu |
@menu |
1507 |
* Scripts Perl:: |
* Les extensions dans WeeChat:: |
1508 |
* Scripts Python:: |
* Ecrire une extension:: |
1509 |
* Scripts Ruby:: |
* Exemple d'extension:: |
1510 |
|
* Extensions pour scripts:: |
1511 |
@end menu |
@end menu |
1512 |
|
|
1513 |
@node Scripts Perl, Scripts Python, Extensions, Extensions |
@node Les extensions dans WeeChat, Ecrire une extension, Extensions, Extensions |
1514 |
@section Scripts Perl |
@section Les extensions dans WeeChat |
1515 |
|
|
1516 |
|
Une extension (``plugin'' en anglais) est un programme @'ecrit en C |
1517 |
|
qui peut appeler des fonctions de WeeChat d@'efinies dans une |
1518 |
|
interface.@* |
1519 |
|
Ce programme C n'a pas besoin des sources WeeChat pour @^etre |
1520 |
|
compil@'e et peut @^etre charg@'e/d@'echarg@'e dynamiquement dans |
1521 |
|
WeeChat via la commande @command{/plugin}.@* |
1522 |
|
@* |
1523 |
|
L'extension doit @^etre au format biblioth@`eque, chargeable |
1524 |
|
dynamiquement par le syst@^eme d'exploitation.@* |
1525 |
|
Sous GNU/Linux, il s'agit d'un fichier ayant pour extension ``.so''. |
1526 |
|
|
1527 |
|
@node Ecrire une extension, Exemple d'extension, Les extensions dans WeeChat, Extensions |
1528 |
|
@section Ecrire une extension |
1529 |
|
|
1530 |
|
@subsection R@`egles de base |
1531 |
|
|
1532 |
|
L'extension doit appeler le fichier ``weechat-plugin.h'' (disponible |
1533 |
|
dans les sources de WeeChat).@* |
1534 |
|
Ce fichier d@'efinit les structures et types dont l'extension aura |
1535 |
|
besoin pour communiquer avec WeeChat.@* |
1536 |
|
@* |
1537 |
|
L'extension doit comporter certaines variables et fonctions |
1538 |
|
obligatoires (sans quoi l'extension ne peut être chargée) :@* |
1539 |
|
@itemize @bullet |
1540 |
|
@item variables de description de l'extension : |
1541 |
|
@itemize @minus |
1542 |
|
@item plugin_name[]: le nom de l'extension |
1543 |
|
@item plugin_version[]: la version de l'extension |
1544 |
|
@item plugin_description[]: une courte description de l'extension |
1545 |
|
@end itemize |
1546 |
|
@item fonctions d'initialisation et fin de l'extension : |
1547 |
|
@itemize @minus |
1548 |
|
@item weechat_plugin_init: fonction appel@'e au chargement de l'extension |
1549 |
|
@item weechat_plugin_end: fonction appel@'e au d@'echargement de l'extension |
1550 |
|
@end itemize |
1551 |
|
@end itemize |
1552 |
|
|
1553 |
|
@subsection Fonctions de l'interface (API) |
1554 |
|
|
1555 |
|
L'extension peut appeler un certain nombre de fonctions d@'efinies |
1556 |
|
dans la structure t_weechat_plugin.@* |
1557 |
|
Ces fonctions sont d@'etaill@'ees ci-dessous : |
1558 |
|
|
1559 |
@subsection Charger/d@'echarger des scripts Perl |
@itemize @bullet |
1560 |
|
@item |
1561 |
|
@command{int ascii_strcasecmp (t_weechat_plugin *plugin, |
1562 |
|
char *string1, char *string2)}@* |
1563 |
|
@* |
1564 |
|
Effectue une comparaison entre deux cha@^ines, sans tenir compte des |
1565 |
|
majuscules/minuscules ni de la locale.@* |
1566 |
|
|
1567 |
|
@emph{Param@`etres :} |
1568 |
|
@itemize @minus |
1569 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1570 |
|
@item @option{string1}: la premi@`ere cha@^ine @`a comparer |
1571 |
|
@item @option{string2}: la deuxi@`eme cha@^ine @`a comparer |
1572 |
|
@end itemize |
1573 |
|
@* |
1574 |
|
@emph{Valeur renvoy@'ee :}@* |
1575 |
|
@* |
1576 |
|
La diff@'erence entre les deux cha@^ines: n@'egatif si chaine1 < |
1577 |
|
chaine2, nul si chaine1 == chaine 2, positif si chaine1 > chaine2@* |
1578 |
|
@* |
1579 |
|
@emph{Exemple :}@* |
1580 |
|
@* |
1581 |
|
@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* |
1582 |
|
@* |
1583 |
|
|
1584 |
|
@item |
1585 |
|
@command{char **explode_string (t_weechat_plugin *plugin, |
1586 |
|
char *string, char *separators, int num_items_max, int *num_items)}@* |
1587 |
|
@* |
1588 |
|
Explose une cha@^ine en plusieurs selon un/des d@'elimiteur(s).@* |
1589 |
|
|
1590 |
|
@emph{Param@`etres :} |
1591 |
|
@itemize @minus |
1592 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1593 |
|
@item @option{string}: la cha@^ine @`a exploser |
1594 |
|
@item @option{separators}: les d@'elimiteurs utilis@'s pour exploser |
1595 |
|
la cha@^ine |
1596 |
|
@item @option{num_items_max}: nombre maximum de sous-cha@^ines |
1597 |
|
cr@'é@'ees (si 0, alors le nombre est infini) |
1598 |
|
@item @option{num_items}: pointeur vers un entier qui contiendra le |
1599 |
|
nombre de sous-cha@^ines cr@'e@'ees en retour |
1600 |
|
@end itemize |
1601 |
|
@* |
1602 |
|
@emph{Valeur renvoy@'ee :}@* |
1603 |
|
@* |
1604 |
|
Un tableau de cha@^ines, ou NULL si un probl@^eme a @'et@'e rencontr@'e.@* |
1605 |
|
NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction |
1606 |
|
``free_exploded_string'' apr@`es utilisation.@* |
1607 |
|
@* |
1608 |
|
@emph{Exemple :}@* |
1609 |
|
@* |
1610 |
|
@code{char *argv;}@* |
1611 |
|
@code{int argc;}@* |
1612 |
|
@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* |
1613 |
|
@code{...}@* |
1614 |
|
@code{if (argv != NULL)}@* |
1615 |
|
@code{plugin->free_exploded_string (plugin, argv);}@* |
1616 |
|
@* |
1617 |
|
|
1618 |
|
@item |
1619 |
|
@command{char **free_exploded_string (t_weechat_plugin *plugin, |
1620 |
|
char **string)}@* |
1621 |
|
@* |
1622 |
|
Lib@`ere la m@'emoire utilis@'ee pour une explosion de cha@^ine.@* |
1623 |
|
|
1624 |
|
@emph{Param@`etres :} |
1625 |
|
@itemize @minus |
1626 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1627 |
|
@item @option{string}: la cha@^ine explos@'ee par la fonction |
1628 |
|
``explode_string'' |
1629 |
|
@end itemize |
1630 |
|
@* |
1631 |
|
@emph{Valeur renvoy@'ee :}@* |
1632 |
|
@* |
1633 |
|
Aucune.@* |
1634 |
|
@* |
1635 |
|
@emph{Exemple :}@* |
1636 |
|
@* |
1637 |
|
@code{char *argv;}@* |
1638 |
|
@code{int argc;}@* |
1639 |
|
@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* |
1640 |
|
@code{...}@* |
1641 |
|
@code{if (argv != NULL)}@* |
1642 |
|
@code{plugin->free_exploded_string (plugin, argv);}@* |
1643 |
|
@* |
1644 |
|
|
1645 |
|
@item |
1646 |
|
@command{void exec_on_files (t_weechat_plugin *plugin, char *directory, |
1647 |
|
int (*callback)(t_weechat_plugin *, char *))}@* |
1648 |
|
@* |
1649 |
|
Ex@'ecute une fonction sur tous les fichiers d'un r@'epertoire.@* |
1650 |
|
|
1651 |
|
@emph{Param@`etres :} |
1652 |
|
@itemize @minus |
1653 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1654 |
|
@item @option{directory}: le r@'epertoire o@`u les fichiers sont |
1655 |
|
recherch@'es |
1656 |
|
@item @option{callback}: une fonction appel@'ee pour chaque fichier trouv@'e |
1657 |
|
@end itemize |
1658 |
|
@* |
1659 |
|
@emph{Valeur renvoy@'ee :}@* |
1660 |
|
@* |
1661 |
|
Aucune.@* |
1662 |
|
@* |
1663 |
|
@emph{Exemple :}@* |
1664 |
|
@* |
1665 |
|
@code{int callback (t_weechat_plugin *plugin, char *file)}@* |
1666 |
|
@code{@{}@* |
1667 |
|
@code{@ @ @ @ plugin->printf_server (plugin, "fichier: %s", file);}@* |
1668 |
|
@code{@ @ @ @ return 1;}@* |
1669 |
|
@code{@}}@* |
1670 |
|
@code{}@* |
1671 |
|
@code{...}@* |
1672 |
|
@code{plugin->exec_on_files (plugin, "/tmp", &callback);}@* |
1673 |
|
@* |
1674 |
|
|
1675 |
|
@item |
1676 |
|
@command{void printf (t_weechat_plugin *plugin, |
1677 |
|
char *server, char *channel, char *message, ...)}@* |
1678 |
|
@* |
1679 |
|
Affiche un message sur un tampon WeeChat, identifi@'e par le serveur et |
1680 |
|
le canal (tous deux pouvant @^etre NULL).@* |
1681 |
|
|
1682 |
|
@emph{Param@`etres :} |
1683 |
|
@itemize @minus |
1684 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1685 |
|
@item @option{server}: nom du serveur pour trouver le tampon dans |
1686 |
|
lequel afficher (peut @^etre NULL) |
1687 |
|
@item @option{channel}: nom du canal pour trouver le tampon dans |
1688 |
|
lequel afficher (peut @^etre NULL) |
1689 |
|
@item @option{message}: message @`a afficher |
1690 |
|
@end itemize |
1691 |
|
@* |
1692 |
|
@emph{Valeur renvoy@'ee :}@* |
1693 |
|
@* |
1694 |
|
Aucune.@* |
1695 |
|
@* |
1696 |
|
@emph{Exemples :}@* |
1697 |
|
@* |
1698 |
|
@code{plugin->printf (NULL, NULL, "hello");}@* |
1699 |
|
@code{plugin->printf (NULL, "#weechat", "hello");}@* |
1700 |
|
@code{plugin->printf ("freenode", "#weechat", "hello");}@* |
1701 |
|
@* |
1702 |
|
|
1703 |
|
@item |
1704 |
|
@command{void printf_server (t_weechat_plugin *plugin, |
1705 |
|
char *message, ...)}@* |
1706 |
|
@* |
1707 |
|
Affiche un message sur la fen@^etre du serveur courant.@* |
1708 |
|
|
1709 |
|
@emph{Param@`etres :} |
1710 |
|
@itemize @minus |
1711 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1712 |
|
@item @option{message}: message @`a afficher |
1713 |
|
@end itemize |
1714 |
|
@* |
1715 |
|
@emph{Valeur renvoy@'ee :}@* |
1716 |
|
@* |
1717 |
|
Aucune.@* |
1718 |
|
@* |
1719 |
|
@emph{Exemple :}@* |
1720 |
|
@* |
1721 |
|
@code{plugin->printf_server ("hello");}@* |
1722 |
|
@* |
1723 |
|
|
1724 |
|
@item |
1725 |
|
@command{void printf_infobar (t_weechat_plugin *plugin, |
1726 |
|
int time, char *message, ...)}@* |
1727 |
|
@* |
1728 |
|
Affiche un message sur la barre d'infos pour un temps d@'etermin@'e.@* |
1729 |
|
|
1730 |
|
@emph{Param@`etres :} |
1731 |
|
@itemize @minus |
1732 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1733 |
|
@item @option{time}: temps pendant lequel le message est affich@'e, en |
1734 |
|
secondes (0 = jamais effac@'e) |
1735 |
|
@item @option{message}: message @`a afficher |
1736 |
|
@end itemize |
1737 |
|
@* |
1738 |
|
@emph{Valeur renvoy@'ee :}@* |
1739 |
|
@* |
1740 |
|
Aucune.@* |
1741 |
|
@* |
1742 |
|
@emph{Exemple :}@* |
1743 |
|
@* |
1744 |
|
@code{plugin->printf_infobar (5, "hello");}@* |
1745 |
|
@* |
1746 |
|
|
1747 |
|
@item |
1748 |
|
@command{t_plugin_msg_handler *msg_handler_add (t_weechat_plugin |
1749 |
|
*plugin, char *message, t_plugin_handler_func *handler_func, |
1750 |
|
char *handler_args, void *handler_pointer)}@* |
1751 |
|
@* |
1752 |
|
Ajoute un gestionnaire de messages IRC, appel@'e d@`s qu'un message |
1753 |
|
IRC est re@,cu.@* |
1754 |
|
|
1755 |
|
@emph{Param@`etres :} |
1756 |
|
@itemize @minus |
1757 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1758 |
|
@item @option{message}: message IRC (par exemple ``PRIVMSG'') |
1759 |
|
@item @option{handler_func}: fonction appel@'ee lorsque le message est |
1760 |
|
re@,cu |
1761 |
|
@item @option{handler_args}: param@`etres pass@'es @`a la fonction |
1762 |
|
appel@'ee |
1763 |
|
@item @option{handler_pointer}: pointeur pass@'e @`a la fonction |
1764 |
|
appel@'ee |
1765 |
|
@end itemize |
1766 |
|
@* |
1767 |
|
@emph{Valeur renvoy@'ee :}@* |
1768 |
|
@* |
1769 |
|
Le pointeur vers le nouveau gestionnaire de messages.@* |
1770 |
|
@* |
1771 |
|
@emph{Exemple :}@* |
1772 |
|
@* |
1773 |
|
@code{int msg_kick (t_weechat_plugin *plugin, char *server, |
1774 |
|
char *command, char *arguments, char *handler_args, |
1775 |
|
void *handler_pointer)}@* |
1776 |
|
@code{@{}@* |
1777 |
|
@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK re@,cu");}@* |
1778 |
|
@code{@}}@* |
1779 |
|
@code{...}@* |
1780 |
|
@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* |
1781 |
|
@* |
1782 |
|
|
1783 |
|
@item |
1784 |
|
@command{void msg_handler_remove (t_weechat_plugin *plugin, |
1785 |
|
t_plugin_msg_handler *msg_handler)}@* |
1786 |
|
@* |
1787 |
|
Supprime un gestionnaire de messages IRC.@* |
1788 |
|
|
1789 |
|
@emph{Param@`etres :} |
1790 |
|
@itemize @minus |
1791 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1792 |
|
@item @option{msg_handler}: le gestionnaire de messages @`a supprimer |
1793 |
|
@end itemize |
1794 |
|
@* |
1795 |
|
@emph{Valeur renvoy@'ee :}@* |
1796 |
|
@* |
1797 |
|
Aucune.@* |
1798 |
|
@* |
1799 |
|
@emph{Exemple :}@* |
1800 |
|
@* |
1801 |
|
@code{plugin->msg_handler_remove (plugin, my_msg_handler);}@* |
1802 |
|
@* |
1803 |
|
|
1804 |
|
@item |
1805 |
|
@command{void msg_handler_remove_all (t_weechat_plugin *plugin)}@* |
1806 |
|
@* |
1807 |
|
Supprime tous les gestionnaires de messages IRC d'une extension.@* |
1808 |
|
|
1809 |
|
@emph{Param@`etres :} |
1810 |
|
@itemize @minus |
1811 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1812 |
|
@end itemize |
1813 |
|
@* |
1814 |
|
@emph{Valeur renvoy@'ee :}@* |
1815 |
|
@* |
1816 |
|
Aucune.@* |
1817 |
|
@* |
1818 |
|
@emph{Exemple :}@* |
1819 |
|
@* |
1820 |
|
@code{plugin->msg_handler_remove_all (plugin);}@* |
1821 |
|
@* |
1822 |
|
|
1823 |
|
@item |
1824 |
|
@command{t_plugin_cmd_handler *cmd_handler_add (t_weechat_plugin |
1825 |
|
*plugin, char *command, char *description, char *arguments, |
1826 |
|
char *arguments_description, t_plugin_handler_func *handler_func, |
1827 |
|
char *handler_args, void *handler_pointer)}@* |
1828 |
|
@* |
1829 |
|
Ajoute un gestionnaire de commande WeeChat, appel@'e d@`s que |
1830 |
|
l'utilisateur utilise la commande (par exemple /commande).@* |
1831 |
|
|
1832 |
|
@emph{Param@`etres :} |
1833 |
|
@itemize @minus |
1834 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1835 |
|
@item @option{commande}: la nouvelle commande |
1836 |
|
@item @option{description}: description de la commande (affich@'ee par |
1837 |
|
/help commande) |
1838 |
|
@item @option{arguments}: br@`eve description des param@`etres de la |
1839 |
|
commande (affich@'ee par /help commande) |
1840 |
|
@item @option{arguments_description}: longue description des |
1841 |
|
param@`etres de la commande (affich@'ee par /help commande) |
1842 |
|
@item @option{handler_func}: fonction appel@'ee lorsque la commande est |
1843 |
|
ex@'ecut@'ee |
1844 |
|
@item @option{handler_args}: param@`etres pass@'es @`a la fonction |
1845 |
|
appel@'ee |
1846 |
|
@item @option{handler_pointer}: pointeur pass@'e @`a la fonction |
1847 |
|
appel@'ee |
1848 |
|
@end itemize |
1849 |
|
@* |
1850 |
|
@emph{Valeur renvoy@'ee :}@* |
1851 |
|
@* |
1852 |
|
Le pointeur vers le nouveau gestionnaire de commande.@* |
1853 |
|
@* |
1854 |
|
@emph{Exemple :}@* |
1855 |
|
@* |
1856 |
|
@code{int cmd_test (t_weechat_plugin *plugin, char *server, |
1857 |
|
char *command, char *arguments, char *handler_args, |
1858 |
|
void *handler_pointer)}@* |
1859 |
|
@code{@{}@* |
1860 |
|
@code{@ @ @ @ plugin->printf (plugin, server, NULL, "commande test, |
1861 |
|
fichier: %s", (arguments) ? arguments : "aucun");}@* |
1862 |
|
@code{@}}@* |
1863 |
|
@code{...}@* |
1864 |
|
@code{plugin->cmd_handler_add (plugin, "test", "Commande test", |
1865 |
|
"[fichier]", "fichier: un nom de fichier", &cmd_test, NULL, NULL);}@* |
1866 |
|
@* |
1867 |
|
|
1868 |
|
@item |
1869 |
|
@command{void cmd_handler_remove (t_weechat_plugin *plugin, |
1870 |
|
t_plugin_cmd_handler *cmd_handler)}@* |
1871 |
|
@* |
1872 |
|
Supprime un gestionnaire de commande.@* |
1873 |
|
|
1874 |
|
@emph{Param@`etres :} |
1875 |
|
@itemize @minus |
1876 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1877 |
|
@item @option{cmd_handler}: le gestionnaire de commande @`a supprimer |
1878 |
|
@end itemize |
1879 |
|
@* |
1880 |
|
@emph{Valeur renvoy@'ee :}@* |
1881 |
|
@* |
1882 |
|
Aucune.@* |
1883 |
|
@* |
1884 |
|
@emph{Exemple :}@* |
1885 |
|
@* |
1886 |
|
@code{plugin->cmd_handler_remove (plugin, my_cmd_handler);}@* |
1887 |
|
@* |
1888 |
|
|
1889 |
|
@item |
1890 |
|
@command{void cmd_handler_remove_all (t_weechat_plugin *plugin)}@* |
1891 |
|
@* |
1892 |
|
Supprime tous les gestionnaires de commande d'une extension.@* |
1893 |
|
|
1894 |
|
@emph{Param@`etres :} |
1895 |
|
@itemize @minus |
1896 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1897 |
|
@end itemize |
1898 |
|
@* |
1899 |
|
@emph{Valeur renvoy@'ee :}@* |
1900 |
|
@* |
1901 |
|
Aucune.@* |
1902 |
|
@* |
1903 |
|
@emph{Exemple :}@* |
1904 |
|
@* |
1905 |
|
@code{plugin->cmd_handler_remove_all (plugin);}@* |
1906 |
|
@* |
1907 |
|
|
1908 |
|
@item |
1909 |
|
@command{void exec_command (t_weechat_plugin |
1910 |
|
*plugin, char *server, char *channel, char *command)}@* |
1911 |
|
@* |
1912 |
|
Execute une commande WeeChat (ou envoie un message @`a un canal).@* |
1913 |
|
|
1914 |
|
@emph{Param@`etres :} |
1915 |
|
@itemize @minus |
1916 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1917 |
|
@item @option{server}: nom du serveur o@`u ex@'ecuter la commande |
1918 |
|
(peut @^etre NULL) |
1919 |
|
@item @option{channel}: nom du canal o@`u ex@'ecuter la commande (peut |
1920 |
|
@^etre NULL) |
1921 |
|
@item @option{command}: la commande @`a ex@'ecuter |
1922 |
|
@end itemize |
1923 |
|
@* |
1924 |
|
@emph{Valeur renvoy@'ee :}@* |
1925 |
|
@* |
1926 |
|
Aucune.@* |
1927 |
|
@* |
1928 |
|
@emph{Exemples :}@* |
1929 |
|
@* |
1930 |
|
@code{plugin->exec_command (plugin, NULL, NULL, "/help nick");}@* |
1931 |
|
@code{plugin->exec_command (plugin, "freenode", "#weechat", "hello");}@* |
1932 |
|
@* |
1933 |
|
|
1934 |
|
@item |
1935 |
|
@command{char *get_info (t_weechat_plugin |
1936 |
|
*plugin, char *info, char *server, char *channel)}@* |
1937 |
|
@* |
1938 |
|
Renvoie une information sur WeeChat ou un canal.@* |
1939 |
|
|
1940 |
|
@emph{Param@`etres :} |
1941 |
|
@itemize @minus |
1942 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1943 |
|
@item @option{info}: nom de l'info @`a obtenir : |
1944 |
|
@itemize @minus |
1945 |
|
@item @option{version}: obtenir la version de WeeChat |
1946 |
|
@item @option{nick}: obtenir le pseudo |
1947 |
|
@item @option{channel}: obtenir le nom du canal |
1948 |
|
@item @option{server}: obtenir le nom du serveur |
1949 |
|
@item @option{away}: obtenir le drapeau ``away'' |
1950 |
|
@item @option{weechat_dir}: obtenir le r@'epertoire maison de WeeChat |
1951 |
|
@item @option{weechat_libdir}: obtenir le r@'epertoire ``lib'' |
1952 |
|
syst@`eme de WeeChat |
1953 |
|
@item @option{weechat_sharedir}: obtenir le r@'epertoire ``share'' |
1954 |
|
syst@`eme de partage WeeChat |
1955 |
|
@end itemize |
1956 |
|
@item @option{server}: nom du serveur o@`u r@'ecup@'erer l'information |
1957 |
|
(ni n@'ecessaire) |
1958 |
|
@item @option{channel}: nom du canal o@`u r@'ecup@'erer l'information |
1959 |
|
(si n@'ecessaire) |
1960 |
|
@end itemize |
1961 |
|
@* |
1962 |
|
@emph{Valeur renvoy@'ee :}@* |
1963 |
|
@* |
1964 |
|
L'information recherch@'ee, NULL si non trouv@'ee.@* |
1965 |
|
NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction |
1966 |
|
``free'' apr@`es utilisation.@* |
1967 |
|
@* |
1968 |
|
@emph{Exemples :}@* |
1969 |
|
@* |
1970 |
|
@code{char *version = plugin->get_info (plugin, "version", NULL, NULL);}@* |
1971 |
|
@code{char *nick = plugin->get_info (plugin, "nick", "freenode", NULL);}@* |
1972 |
|
@* |
1973 |
|
|
1974 |
|
@item |
1975 |
|
@command{t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)}@* |
1976 |
|
@* |
1977 |
|
Renvoie la liste des DCC en cours ou termin@'es.@* |
1978 |
|
|
1979 |
|
@emph{Param@`etres :} |
1980 |
|
@itemize @minus |
1981 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
1982 |
|
@end itemize |
1983 |
|
@* |
1984 |
|
@emph{Valeur renvoy@'ee :}@* |
1985 |
|
@* |
1986 |
|
La liste cha@^in@'ee des DCC.@* |
1987 |
|
NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction |
1988 |
|
``free_dcc_info'' apr@`es utilisation.@* |
1989 |
|
@* |
1990 |
|
@emph{Exemple :}@* |
1991 |
|
@* |
1992 |
|
@code{t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin);}@* |
1993 |
|
@code{for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = |
1994 |
|
ptr_dcc->next_dcc)}@* |
1995 |
|
@code{@{}@* |
1996 |
|
@code{@ @ @ @ plugin->printf_server (plugin, "DCC type=%d, avec: %s", |
1997 |
|
ptr_dcc->type, ptr_dcc->nick);}@* |
1998 |
|
@code{@}}@* |
1999 |
|
@* |
2000 |
|
|
2001 |
|
@item |
2002 |
|
@command{void free_dcc_info (t_weechat_plugin *plugin, |
2003 |
|
t_plugin_dcc_info *dcc_info)}@* |
2004 |
|
@* |
2005 |
|
Lib@`ere la m@'emoire utilis@'ee par une liste de DCC.@* |
2006 |
|
|
2007 |
|
@emph{Param@`etres :} |
2008 |
|
@itemize @minus |
2009 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
2010 |
|
@item @option{dcc_info}: pointeur vers une structure renvoy@'ee par la |
2011 |
|
fonction ``get_dcc_info'' |
2012 |
|
@end itemize |
2013 |
|
@* |
2014 |
|
@emph{Valeur renvoy@'ee :}@* |
2015 |
|
@* |
2016 |
|
Aucune.@* |
2017 |
|
@* |
2018 |
|
@emph{Exemple :}@* |
2019 |
|
@* |
2020 |
|
@code{plugin->free_dcc_info (plugin, dcc_info);}@* |
2021 |
|
@* |
2022 |
|
|
2023 |
|
@item |
2024 |
|
@command{char *get_config (t_weechat_plugin |
2025 |
|
*plugin, char *option)}@* |
2026 |
|
@* |
2027 |
|
Renvoie la valeur d'une option de configuration WeeChat.@* |
2028 |
|
|
2029 |
|
@emph{Param@`etres :} |
2030 |
|
@itemize @minus |
2031 |
|
@item @option{plugin}: un pointeur vers la structure de l'extension |
2032 |
|
@item @option{option}: nom de l'option @`a lire |
2033 |
|
@end itemize |
2034 |
|
@* |
2035 |
|
@emph{Valeur renvoy@'ee :}@* |
2036 |
|
@* |
2037 |
|
La valeur de l'option, NULL si non trouv@'ee.@* |
2038 |
|
NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction |
2039 |
|
``free'' apr@`es utilisation.@* |
2040 |
|
@* |
2041 |
|
@emph{Exemples :}@* |
2042 |
|
@* |
2043 |
|
@code{char *value1 = plugin->get_config (plugin, "look_set_title");}@* |
2044 |
|
@code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* |
2045 |
|
@* |
2046 |
|
|
2047 |
|
@end itemize |
2048 |
|
|
2049 |
|
@subsection Compiler l'extension |
2050 |
|
|
2051 |
|
La compilation ne n@'ecessite pas les sources WeeChat, mais seulement |
2052 |
|
le fichier ``weechat-plugin.h''.@* |
2053 |
|
|
2054 |
|
Pour compiler une extension compos@'ee d'un fichier ``toto.c'' (sous |
2055 |
|
GNU/Linux) :@* |
2056 |
|
@* |
2057 |
|
gcc -fPIC -Wall -c toto.c@* |
2058 |
|
gcc -shared -fPIC -o libtoto.so toto.o |
2059 |
|
|
2060 |
|
@subsection Charger l'extension dans WeeChat |
2061 |
|
|
2062 |
|
Copier le fichier ``libtoto.so'' dans le r@'epertoire des extensions |
2063 |
|
g@'en@'eral (par exemple /usr/local/lib/weechat/plugins) ou bien dans |
2064 |
|
celui de l'utilisateur (par exemple /home/xxxxx/.weechat/plugins).@* |
2065 |
|
@* |
2066 |
|
Sous WeeChat :@* |
2067 |
|
@command{/plugin load toto} |
2068 |
|
|
2069 |
|
@node Exemple d'extension, Extensions pour scripts, Ecrire une extension, Extensions |
2070 |
|
@section Exemple d'extension |
2071 |
|
|
2072 |
|
Un exemple complet d'extension, qui ajoute une commande /double |
2073 |
|
affichant deux fois les param@`etres pass@'es sur le canal courant |
2074 |
|
(d'accord ce n'est pas tr@`es utile mais ceci est un exemple !) : |
2075 |
|
|
2076 |
|
@verbatim |
2077 |
|
#include <stdlib.h> |
2078 |
|
|
2079 |
|
#include "weechat-plugin.h" |
2080 |
|
|
2081 |
|
char plugin_name[] = "Toto"; |
2082 |
|
char plugin_version[] = "0.1"; |
2083 |
|
char plugin_description[] = "Plugin de test pour WeeChat"; |
2084 |
|
|
2085 |
|
/* gestionnaire de commande "/hello" */ |
2086 |
|
|
2087 |
|
int toto_cmd_double (t_weechat_plugin *plugin, char *server, |
2088 |
|
char *command, char *arguments, |
2089 |
|
char *handler_args, void *handler_pointer) |
2090 |
|
{ |
2091 |
|
if (arguments && arguments[0] && (arguments[0] != '/')) |
2092 |
|
{ |
2093 |
|
plugin->exec_command (plugin, NULL, NULL, arguments); |
2094 |
|
plugin->exec_command (plugin, NULL, NULL, arguments); |
2095 |
|
} |
2096 |
|
return 1; |
2097 |
|
} |
2098 |
|
|
2099 |
|
int weechat_plugin_init (t_weechat_plugin *plugin) |
2100 |
|
{ |
2101 |
|
plugin->cmd_handler_add (plugin, "double", |
2102 |
|
"Affiche deux fois un message", |
2103 |
|
"msg", |
2104 |
|
"msg: message @`a afficher deux fois", |
2105 |
|
&toto_cmd_double, |
2106 |
|
NULL, NULL); |
2107 |
|
return 1; |
2108 |
|
} |
2109 |
|
|
2110 |
|
int weechat_plugin_end (t_weechat_plugin *plugin) |
2111 |
|
{ |
2112 |
|
/* on ne fait rien ici */ |
2113 |
|
return 1; |
2114 |
|
} |
2115 |
|
@end verbatim |
2116 |
|
|
2117 |
|
@node Extensions pour scripts, , Exemple d'extension, Extensions |
2118 |
|
@section Extensions pour scripts |
2119 |
|
|
2120 |
|
Trois extensions sont fournies en standard avec WeeChat pour utiliser |
2121 |
|
des langages de script: Perl, Python et Ruby. |
2122 |
|
|
2123 |
|
@subsection Scripts Perl |
2124 |
|
|
2125 |
|
@subsubsection Charger/d@'echarger des scripts Perl |
2126 |
|
|
2127 |
Les scripts Perl sont charg@'es et d@'echarg@'es avec la commande @command{/perl} |
Les scripts Perl sont charg@'es et d@'echarg@'es avec la commande @command{/perl} |
2128 |
(tapez @kbd{/help perl} dans WeeChat pour obtenir de l'aide sur la commande).@* |
(tapez @kbd{/help perl} dans WeeChat pour obtenir de l'aide sur la commande).@* |
2136 |
Lister les scripts Perl charg@'es : @kbd{/perl}@* |
Lister les scripts Perl charg@'es : @kbd{/perl}@* |
2137 |
@end itemize |
@end itemize |
2138 |
|
|
2139 |
@subsection Interface WeeChat / Perl |
@subsubsection Interface WeeChat / Perl |
2140 |
|
|
2141 |
@itemize @bullet |
@itemize @bullet |
2142 |
@item |
@item |
2157 |
@end itemize |
@end itemize |
2158 |
@* |
@* |
2159 |
@emph{Exemple :}@* |
@emph{Exemple :}@* |
2160 |
|
@* |
2161 |
@code{weechat::register ("essai", "1.0", "fin_essai", "Script d'essai !");}@* |
@code{weechat::register ("essai", "1.0", "fin_essai", "Script d'essai !");}@* |
2162 |
@* |
@* |
2163 |
|
|
2173 |
@item @option{serveur}: nom interne du serveur |
@item @option{serveur}: nom interne du serveur |
2174 |
@end itemize |
@end itemize |
2175 |
@* |
@* |
2176 |
@emph{Exemple :}@* |
@emph{Exemples :}@* |
2177 |
|
@* |
2178 |
@code{weechat::print ("message");}@* |
@code{weechat::print ("message");}@* |
2179 |
@code{weechat::print ("message", "#weechat");}@* |
@code{weechat::print ("message", "#weechat");}@* |
2180 |
@code{weechat::print ("message", "#weechat", "freenode");}@* |
@code{weechat::print ("message", "#weechat", "freenode");}@* |
2193 |
@end itemize |
@end itemize |
2194 |
@* |
@* |
2195 |
@emph{Exemple :}@* |
@emph{Exemple :}@* |
2196 |
|
@* |
2197 |
@code{weechat::print_infobar (5, "message");}@* |
@code{weechat::print_infobar (5, "message");}@* |
2198 |
@* |
@* |
2199 |
|
|
2214 |
@end itemize |
@end itemize |
2215 |
@* |
@* |
2216 |
@emph{Exemple :}@* |
@emph{Exemple :}@* |
2217 |
|
@* |
2218 |
@code{weechat::add_message_handler ("privmsg", ma_fonction);}@* |
@code{weechat::add_message_handler ("privmsg", ma_fonction);}@* |
2219 |
@code{sub ma_fonction}@* |
@code{sub ma_fonction}@* |
2220 |
@code{@{ }@* |
@code{@{ }@* |
2226 |
@* |
@* |
2227 |
|
|
2228 |
@item |
@item |
2229 |
@command{weechat::add_command_handler ( nom, fonction );}@* |
@command{weechat::add_command_handler ( nom, fonction, [description, |
2230 |
|
arguments, arguments_description] );}@* |
2231 |
@* |
@* |
2232 |
Cr@'e@'e une nouvelle commande WeeChat, associ@'ee @`a une fonction Perl.@* |
Cr@'e@'e une nouvelle commande WeeChat, associ@'ee @`a une fonction Perl.@* |
2233 |
La fonction sera appel@'ee lorsque l'utilisateur lancera la commande par @kbd{/nom}.@* |
La fonction sera appel@'ee lorsque l'utilisateur lancera la commande par @kbd{/nom}.@* |
2239 |
la fonction Perl. Soyez prudent en @'ecrasant les commandes WeeChat, car elles |
la fonction Perl. Soyez prudent en @'ecrasant les commandes WeeChat, car elles |
2240 |
ne seront plus accessibles tant que le script Perl sera charg@'e. |
ne seront plus accessibles tant que le script Perl sera charg@'e. |
2241 |
@item @option{fonction}: fonction Perl associ@'ee @`a la commande |
@item @option{fonction}: fonction Perl associ@'ee @`a la commande |
2242 |
|
@item @option{description}: description de la commande (affich@'ee par |
2243 |
|
/help commande) |
2244 |
|
@item @option{arguments}: br@`eve description des param@`etres de la |
2245 |
|
commande (affich@'ee par /help commande) |
2246 |
|
@item @option{arguments_description}: longue description des |
2247 |
|
param@`etres de la commande (affich@'ee par /help commande) |
2248 |
@end itemize |
@end itemize |
2249 |
@* |
@* |
2250 |
@emph{Exemple :}@* |
@emph{Exemple :}@* |
2251 |
|
@* |
2252 |
@code{weechat::add_command_handler ("commande", ma_commande);}@* |
@code{weechat::add_command_handler ("commande", ma_commande);}@* |
2253 |
@code{sub ma_commande}@* |
@code{sub ma_commande}@* |
2254 |
@code{@{ }@* |
@code{@{ }@* |
2270 |
@end itemize |
@end itemize |
2271 |
@* |
@* |
2272 |
@emph{Exemples :}@* |
@emph{Exemples :}@* |
2273 |
|
@* |
2274 |
@code{weechat::command ("bonjour tout le monde !");}@* |
@code{weechat::command ("bonjour tout le monde !");}@* |
2275 |
@code{weechat::command ("/kick toto merci de quitter ce canal", "#weechat");}@* |
@code{weechat::command ("/kick toto merci de quitter ce canal", "#weechat");}@* |
2276 |
@code{weechat::command ("/nick newnick", "", "freenode");}@* |
@code{weechat::command ("/nick newnick", "", "freenode");}@* |
2284 |
@emph{Param@`etres :} |
@emph{Param@`etres :} |
2285 |
@itemize @minus |
@itemize @minus |
2286 |
@item @option{nom}: nom de l'info @`a obtenir : |
@item @option{nom}: nom de l'info @`a obtenir : |
|
@item @option{serveur}: nom interne du serveur |
|
2287 |
@itemize @minus |
@itemize @minus |
2288 |
@item @option{0 ou version}: obtenir la version de WeeChat |
@item @option{version}: obtenir la version de WeeChat |
2289 |
@item @option{1 ou nick}: obtenir le pseudo |
@item @option{nick}: obtenir le pseudo |
2290 |
@item @option{2 ou channel}: obtenir le nom du canal |
@item @option{channel}: obtenir le nom du canal |
2291 |
@item @option{3 ou server}: obtenir le nom du serveur |
@item @option{server}: obtenir le nom du serveur |
2292 |
@item @option{4 ou weechatdir}: obtenir le r@'epertoire maison de WeeChat |
@item @option{away}: obtenir le drapeau ``away'' |
2293 |
@item @option{5 ou away}: obtenir le drapeau "away" du serveur |
@item @option{weechat_dir}: obtenir le r@'epertoire maison de WeeChat |
2294 |
|
@item @option{weechat_libdir}: obtenir le r@'epertoire ``lib'' |
2295 |
|
syst@`eme de WeeChat |
2296 |
|
@item @option{weechat_sharedir}: obtenir le r@'epertoire ``share'' |
2297 |
|
syst@`eme de partage WeeChat |
2298 |
@end itemize |
@end itemize |
2299 |
|
@item @option{serveur}: nom interne du serveur |
2300 |
@end itemize |
@end itemize |
2301 |
@* |
@* |
2302 |
@emph{Exemples :}@* |
@emph{Exemples :}@* |
2303 |
|
@* |
2304 |
@code{$version = get_info("version");}@* |
@code{$version = get_info("version");}@* |
2305 |
@code{$nick = get_info("nick", "freenode");}@* |
@code{$nick = get_info("nick", "freenode");}@* |
2306 |
@* |
@* |
2307 |
|
|
2308 |
|
@item |
2309 |
|
@command{weechat::get_dcc_info ( );}@* |
2310 |
|
@* |
2311 |
|
Obtenir la liste des DCC.@* |
2312 |
|
|
2313 |
|
Le tableau renvoy@'e contient les champs suivants : |
2314 |
|
@itemize @minus |
2315 |
|
@item server: le serveur IRC |
2316 |
|
@item channel: le canal IRC |
2317 |
|
@item type: le type de DCC : |
2318 |
|
@itemize @minus |
2319 |
|
@item 0: discussion (re@,cue) |
2320 |
|
@item 1: discussion (envoy@'ee) |
2321 |
|
@item 2: fichier en r@'eception |
2322 |
|
@item 3: fichier en @'emission |
2323 |
|
@end itemize |
2324 |
|
@item status: statut du DCC : |
2325 |
|
@itemize @minus |
2326 |
|
@item 0: en attente |
2327 |
|
@item 1: en cours de connexion |
2328 |
|
@item 2: actif |
2329 |
|
@item 3: termin@'e |
2330 |
|
@item 4: @'echou@'e |
2331 |
|
@item 5: interrompu par l'utilisateur |
2332 |
|
@end itemize |
2333 |
|
@item start_time: la date et heure de cr@'eation du DCC |
2334 |
|
@item start_transfer: la date et heure de d@'emarrage du transfert |
2335 |
|
@item addr: adresse de l'utilisateur distant |
2336 |
|
@item port: port utilis@'e pour le DCC |
2337 |
|
@item nick: pseudo de l'utilisateur distant |
2338 |
|
@item filename: nom de fichier |
2339 |
|
@item local_filename: nom de fichier local |
2340 |
|
@item size: taille du fichier |
2341 |
|
@item pos: position actuelle dans le fichier |
2342 |
|
@item start_resume: position de d@'emarrage apr@`es une interruption |
2343 |
|
@item bytes_per_sec: nombre d'octets transmis par seconde depuis le d@'ebut |
2344 |
|
@end itemize |
2345 |
|
@* |
2346 |
|
|
2347 |
|
@item |
2348 |
|
@command{weechat::get_config ( nom );}@* |
2349 |
|
@* |
2350 |
|
Obtenir la valeur d'une option de configuration WeeChat.@* |
2351 |
|
|
2352 |
|
@emph{Param@`etres :} |
2353 |
|
@itemize @minus |
2354 |
|
@item @option{nom}: nom de l'option |
2355 |
|
@end itemize |
2356 |
|
@* |
2357 |
|
@emph{Exemples :}@* |
2358 |
|
@* |
2359 |
|
@code{$value1 = weechat::get_config ("look_set_title");}@* |
2360 |
|
@code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* |
2361 |
|
@* |
2362 |
|
|
2363 |
@end itemize |
@end itemize |
2364 |
|
|
2365 |
@node Scripts Python, Scripts Ruby, Scripts Perl, Extensions |
@subsection Scripts Python |
|
@section Scripts Python |
|
2366 |
|
|
2367 |
@subsection Charger/d@'echarger des scripts Python |
@subsubsection Charger/d@'echarger des scripts Python |
2368 |
|
|
2369 |
Les scripts Python sont charg@'es et d@'echarg@'es avec la commande @command{/python} |
Les scripts Python sont charg@'es et d@'echarg@'es avec la commande @command{/python} |
2370 |
(tapez @kbd{/help python} dans WeeChat pour obtenir de l'aide sur la commande).@* |
(tapez @kbd{/help python} dans WeeChat pour obtenir de l'aide sur la commande).@* |
2378 |
Lister les scripts Python charg@'es : @kbd{/python}@* |
Lister les scripts Python charg@'es : @kbd{/python}@* |
2379 |
@end itemize |
@end itemize |
2380 |
|
|
2381 |
@subsection Interface WeeChat / Python |
@subsubsection Interface WeeChat / Python |
2382 |
|
|
2383 |
@itemize @bullet |
@itemize @bullet |
2384 |
@item |
@item |
2399 |
@end itemize |
@end itemize |
2400 |
@* |
@* |
2401 |
@emph{Exemple :}@* |
@emph{Exemple :}@* |
2402 |
|
@* |
2403 |
@code{weechat.register ("essai", "1.0", "fin_essai", "Script d'essai !")}@* |
@code{weechat.register ("essai", "1.0", "fin_essai", "Script d'essai !")}@* |
2404 |
@* |
@* |
2405 |
|
|
2415 |
@item @option{serveur}: nom interne du serveur |
@item @option{serveur}: nom interne du serveur |
2416 |
@end itemize |
@end itemize |
2417 |
@* |
@* |
2418 |
@emph{Exemple :}@* |
@emph{Exemples :}@* |
2419 |
|
@* |
2420 |
@code{weechat.prnt ("message")}@* |
@code{weechat.prnt ("message")}@* |
2421 |
@code{weechat.prnt ("message", "#weechat")}@* |
@code{weechat.prnt ("message", "#weechat")}@* |
2422 |
@code{weechat.prnt ("message", "#weechat", "freenode")}@* |
@code{weechat.prnt ("message", "#weechat", "freenode")}@* |
2435 |
@end itemize |
@end itemize |
2436 |
@* |
@* |
2437 |
@emph{Exemple :}@* |
@emph{Exemple :}@* |
2438 |
|
@* |
2439 |
@code{weechat.print_infobar (5, "message")}@* |
@code{weechat.print_infobar (5, "message")}@* |
2440 |
@* |
@* |
2441 |
|
|
2456 |
@end itemize |
@end itemize |
2457 |
@* |
@* |
2458 |
@emph{Exemple :}@* |
@emph{Exemple :}@* |
2459 |
|
@* |
2460 |
@code{weechat.add_message_handler ("privmsg", ma_fonction)}@* |
@code{weechat.add_message_handler ("privmsg", ma_fonction)}@* |
2461 |
@code{def ma_fonction(serveur, args):}@* |
@code{def ma_fonction(serveur, args):}@* |
2462 |
@code{@ @ @ @ weechat.prnt("serveur="+serveur)}@* |
@code{@ @ @ @ weechat.prnt("serveur="+serveur)}@* |
2478 |
la fonction Python. Soyez prudent en @'ecrasant les commandes WeeChat, car elles |
la fonction Python. Soyez prudent en @'ecrasant les commandes WeeChat, car elles |
2479 |
ne seront plus accessibles tant que le script Python sera charg@'e. |
ne seront plus accessibles tant que le script Python sera charg@'e. |
2480 |
@item @option{fonction}: fonction Python associ@'ee @`a la commande |
@item @option{fonction}: fonction Python associ@'ee @`a la commande |
2481 |
|
@item @option{description}: description de la commande (affich@'ee par |
2482 |
|
/help commande) |
2483 |
|
@item @option{arguments}: br@`eve description des param@`etres de la |
2484 |
|
commande (affich@'ee par /help commande) |
2485 |
|
@item @option{arguments_description}: longue description des |
2486 |
|
param@`etres de la commande (affich@'ee par /help commande) |
2487 |
@end itemize |
@end itemize |
2488 |
@* |
@* |
2489 |
@emph{Exemple :}@* |
@emph{Exemple :}@* |
2490 |
|
@* |
2491 |
@code{weechat.add_command_handler ("commande", ma_commande)}@* |
@code{weechat.add_command_handler ("commande", ma_commande)}@* |
2492 |
@code{def ma_commande(serveur, args):}@* |
@code{def ma_commande(serveur, args):}@* |
2493 |
@code{@ @ @ @ weechat.prnt("serveur:"+serveur+" param@`etres:"+args)}@* |
@code{@ @ @ @ weechat.prnt("serveur:"+serveur+" param@`etres:"+args)}@* |
2506 |
@end itemize |
@end itemize |
2507 |
@* |
@* |
2508 |
@emph{Exemples :}@* |
@emph{Exemples :}@* |
2509 |
|
@* |
2510 |
@code{weechat.command ("bonjour tout le monde !")}@* |
@code{weechat.command ("bonjour tout le monde !")}@* |
2511 |
@code{weechat.command ("/kick toto merci de quitter ce canal", "#weechat")}@* |
@code{weechat.command ("/kick toto merci de quitter ce canal", "#weechat")}@* |
2512 |
@code{weechat.command ("/nick newnick", "", "freenode")}@* |
@code{weechat.command ("/nick newnick", "", "freenode")}@* |
2520 |
@emph{Param@`etres :} |
@emph{Param@`etres :} |
2521 |
@itemize @minus |
@itemize @minus |
2522 |
@item @option{nom}: nom de l'info @`a obtenir : |
@item @option{nom}: nom de l'info @`a obtenir : |
2523 |
|
@itemize @minus |
2524 |
|
@item @option{version}: obtenir la version de WeeChat |
2525 |
|
@item @option{nick}: obtenir le pseudo |
2526 |
|
@item @option{channel}: obtenir le nom du canal |
2527 |
|
@item @option{server}: obtenir le nom du serveur |
2528 |
|
@item @option{away}: obtenir le drapeau ``away'' |
2529 |
|
@item @option{weechat_dir}: obtenir le r@'epertoire maison de WeeChat |
2530 |
|
@item @option{weechat_libdir}: obtenir le r@'epertoire ``lib'' |
2531 |
|
syst@`eme de WeeChat |
2532 |
|
@item @option{weechat_sharedir}: obtenir le r@'epertoire ``share'' |
2533 |
|
syst@`eme de partage WeeChat |
2534 |
|
@end itemize |
2535 |
@item @option{serveur}: nom interne du serveur |
@item @option{serveur}: nom interne du serveur |
2536 |
|
@end itemize |
2537 |
|
@* |
2538 |
|
@emph{Exemples :}@* |
2539 |
|
@* |
2540 |
|
@code{$version = weechat.get_info ("version")}@* |
2541 |
|
@code{$nick = weechat.get_info ("nick", "freenode")}@* |
2542 |
|
@* |
2543 |
|
|
2544 |
|
@item |
2545 |
|
@command{weechat.get_dcc_info ( );}@* |
2546 |
|
@* |
2547 |
|
Obtenir la liste des DCC.@* |
2548 |
|
|
2549 |
|
Le tableau renvoy@'e contient les champs suivants : |
2550 |
@itemize @minus |
@itemize @minus |
2551 |
@item @option{0 ou version}: obtenir la version de WeeChat |
@item server: le serveur IRC |
2552 |
@item @option{1 ou nick}: obtenir le pseudo |
@item channel: le canal IRC |
2553 |
@item @option{2 ou channel}: obtenir le nom du canal |
@item type: le type de DCC : |
2554 |
@item @option{3 ou server}: obtenir le nom du serveur |
@itemize @minus |
2555 |
@item @option{4 ou weechatdir}: obtenir le r@'epertoire maison de WeeChat |
@item 0: discussion (re@,cue) |
2556 |
@item @option{5 ou away}: obtenir le drapeau "away" du serveur |
@item 1: discussion (envoy@'ee) |
2557 |
|
@item 2: fichier en r@'eception |
2558 |
|
@item 3: fichier en @'emission |
2559 |
@end itemize |
@end itemize |
2560 |
|
@item status: statut du DCC : |
2561 |
|
@itemize @minus |
2562 |
|
@item 0: en attente |
2563 |
|
@item 1: en cours de connexion |
2564 |
|
@item 2: actif |
2565 |
|
@item 3: termin@'e |
2566 |
|
@item 4: @'echou@'e |
2567 |
|
@item 5: interrompu par l'utilisateur |
2568 |
|
@end itemize |
2569 |
|
@item start_time: la date et heure de cr@'eation du DCC |
2570 |
|
@item start_transfer: la date et heure de d@'emarrage du transfert |
2571 |
|
@item addr: adresse de l'utilisateur distant |
2572 |
|
@item port: port utilis@'e pour le DCC |
2573 |
|
@item nick: pseudo de l'utilisateur distant |
2574 |
|
@item filename: nom de fichier |
2575 |
|
@item local_filename: nom de fichier local |
2576 |
|
@item size: taille du fichier |
2577 |
|
@item pos: position actuelle dans le fichier |
2578 |
|
@item start_resume: position de d@'emarrage apr@`es une interruption |
2579 |
|
@item bytes_per_sec: nombre d'octets transmis par seconde depuis le d@'ebut |
2580 |
|
@end itemize |
2581 |
|
@* |
2582 |
|
|
2583 |
|
@item |
2584 |
|
@command{weechat.get_config ( nom );}@* |
2585 |
|
@* |
2586 |
|
Obtenir la valeur d'une option de configuration WeeChat.@* |
2587 |
|
|
2588 |
|
@emph{Param@`etres :} |
2589 |
|
@itemize @minus |
2590 |
|
@item @option{nom}: nom de l'option |
2591 |
@end itemize |
@end itemize |
2592 |
@* |
@* |
2593 |
@emph{Exemples :}@* |
@emph{Exemples :}@* |
2594 |
@code{$version = weechat.get_info("version")}@* |
@* |
2595 |
@code{$nick = weechat.get_info("nick", "freenode")}@* |
@code{$value1 = weechat.get_config ("look_set_title");}@* |
2596 |
|
@code{$value2 = weechat.get_config ("freenode.server_autojoin");}@* |
2597 |
@* |
@* |
2598 |
|
|
2599 |
@end itemize |
@end itemize |
2600 |
|
|
2601 |
@node Scripts Ruby, , Scripts Python, Extensions |
@subsection Scripts Ruby |
|
@section Scripts Ruby |
|
2602 |
|
|
2603 |
Non d@'evelopp@'e ! |
Non d@'evelopp@'e ! |
2604 |
|
|
2605 |
|
|
2606 |
@c **************************** Auteurs / Support ***************************** |
@c **************************** Auteurs / Support ***************************** |
2607 |
|
|
2608 |
@node Auteurs / Support, , Extensions, Top |
@node Auteurs / Support, , Extensions, Top |