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 - 25 octobre 2005 |
@subtitle Documentation pour WeeChat v0.1.6-cvs - 28 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 |
|
|
588 |
Cr@'eer un tube FIFO pour le contr@^ole @`a distance@* |
Cr@'eer un tube FIFO pour le contr@^ole @`a distance@* |
589 |
Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* |
Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* |
590 |
@item irc_highlight |
@item irc_highlight |
591 |
Liste des mots pour la notification (s@'epar@'es par des virgules, le comparaison ne tient pas compte de la casse)@* |
Liste des mots pour la notification (s@'epar@'es par des virgules, le comparaison ne tient pas compte de la casse, les mots peuvent commencer ou se terminer par "*" pour une comparaison partielle)@* |
592 |
Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* |
Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* |
593 |
@item dcc_auto_accept_files |
@item dcc_auto_accept_files |
594 |
Accepte automatiquement les fichiers dcc entrants@* |
Accepte automatiquement les fichiers dcc entrants@* |
1565 |
@item fonctions d'initialisation et fin de l'extension : |
@item fonctions d'initialisation et fin de l'extension : |
1566 |
@itemize @minus |
@itemize @minus |
1567 |
@item weechat_plugin_init: fonction appel@'ee au chargement de l'extension, |
@item weechat_plugin_init: fonction appel@'ee au chargement de l'extension, |
1568 |
qui doit renvoyer 1 en cas de succ@`es, 0 en cas d'erreur |
qui doit renvoyer PLUGIN_RC_OK (0) en cas de succ@`es, PLUGIN_RC_KO (-1) |
1569 |
@item weechat_plugin_end: fonction appel@'ee au d@'echargement de l'extension, |
en cas d'erreur |
1570 |
qui doit renvoyer 1 en cas de succ@`es, 0 en cas d'erreur |
@item weechat_plugin_end: fonction appel@'ee au d@'echargement de l'extension |
1571 |
@end itemize |
@end itemize |
1572 |
@end itemize |
@end itemize |
1573 |
|
|
1639 |
@itemize @minus |
@itemize @minus |
1640 |
@item @option{plugin}: un pointeur vers la structure de l'extension |
@item @option{plugin}: un pointeur vers la structure de l'extension |
1641 |
@item @option{string}: la cha@^ine @`a exploser |
@item @option{string}: la cha@^ine @`a exploser |
1642 |
@item @option{separators}: les d@'elimiteurs utilis@'s pour exploser |
@item @option{separators}: les d@'elimiteurs utilis@'es pour exploser |
1643 |
la cha@^ine |
la cha@^ine |
1644 |
@item @option{num_items_max}: nombre maximum de sous-cha@^ines |
@item @option{num_items_max}: nombre maximum de sous-cha@^ines |
1645 |
cr@'é@'ees (si 0, alors le nombre est infini) |
cr@'e@'ees (si 0, alors le nombre est infini) |
1646 |
@item @option{num_items}: pointeur vers un entier qui contiendra le |
@item @option{num_items}: pointeur vers un entier qui contiendra le |
1647 |
nombre de sous-cha@^ines cr@'e@'ees en retour |
nombre de sous-cha@^ines cr@'e@'ees en retour |
1648 |
@end itemize |
@end itemize |
1725 |
char *server, char *channel, char *message, ...)}@* |
char *server, char *channel, char *message, ...)}@* |
1726 |
@* |
@* |
1727 |
Affiche un message sur un tampon WeeChat, identifi@'e par le serveur et |
Affiche un message sur un tampon WeeChat, identifi@'e par le serveur et |
1728 |
le canal (tous deux pouvant @^etre NULL).@* |
le canal (tous deux pouvant @^etre NULL pour le tampon courant).@* |
1729 |
|
|
1730 |
@emph{Param@`etres :} |
@emph{Param@`etres :} |
1731 |
@itemize @minus |
@itemize @minus |
1797 |
*plugin, char *message, t_plugin_handler_func *handler_func, |
*plugin, char *message, t_plugin_handler_func *handler_func, |
1798 |
char *handler_args, void *handler_pointer)}@* |
char *handler_args, void *handler_pointer)}@* |
1799 |
@* |
@* |
1800 |
Ajoute un gestionnaire de messages IRC, appel@'e d@`s qu'un message |
Ajoute un gestionnaire de messages IRC, appel@'e d@`es qu'un message |
1801 |
IRC est re@,cu.@* |
IRC est re@,cu.@* |
1802 |
|
|
1803 |
@emph{Param@`etres :} |
@emph{Param@`etres :} |
1823 |
void *handler_pointer)}@* |
void *handler_pointer)}@* |
1824 |
@code{@{}@* |
@code{@{}@* |
1825 |
@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK re@,cu");}@* |
@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK re@,cu");}@* |
1826 |
|
@code{@ @ @ @ return PLUGIN_RC_OK;}@* |
1827 |
@code{@}}@* |
@code{@}}@* |
1828 |
@code{...}@* |
@code{...}@* |
1829 |
@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* |
@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* |
1830 |
@* |
@* |
1831 |
|
@emph{Notes :}@* |
1832 |
|
@* |
1833 |
|
La fonction appel@'ee lorsque le message est re@,cu doit renvoyer une |
1834 |
|
des valeurs suivantes :@* |
1835 |
|
@itemize @minus |
1836 |
|
@item @option{PLUGIN_RC_KO ou -1}: la fonction a @'echou@'e |
1837 |
|
@item @option{PLUGIN_RC_OK ou 0}: la fonction a r@'eussi |
1838 |
|
@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT ou 1}: le message ne sera pas transmis |
1839 |
|
@`a WeeChat |
1840 |
|
@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS ou 2}: le message ne sera pas transmis |
1841 |
|
@`a d'autres extensions |
1842 |
|
@item @option{PLUGIN_RC_OK_IGNORE_ALL ou 3}: le message ne sera transmis ni @`a |
1843 |
|
WeeChat ni @`a d'autres extensions |
1844 |
|
@end itemize |
1845 |
|
@* |
1846 |
|
|
1847 |
@item |
@item |
1848 |
@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin |
@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin |
1850 |
char *arguments_description, t_plugin_handler_func *handler_func, |
char *arguments_description, t_plugin_handler_func *handler_func, |
1851 |
char *handler_args, void *handler_pointer)}@* |
char *handler_args, void *handler_pointer)}@* |
1852 |
@* |
@* |
1853 |
Ajoute un gestionnaire de commande WeeChat, appel@'e d@`s que |
Ajoute un gestionnaire de commande WeeChat, appel@'e d@`es que |
1854 |
l'utilisateur utilise la commande (par exemple /commande).@* |
l'utilisateur utilise la commande (par exemple /commande).@* |
1855 |
|
|
1856 |
@emph{Param@`etres :} |
@emph{Param@`etres :} |
1883 |
@code{@{}@* |
@code{@{}@* |
1884 |
@code{@ @ @ @ plugin->printf (plugin, server, NULL, "commande test, |
@code{@ @ @ @ plugin->printf (plugin, server, NULL, "commande test, |
1885 |
fichier: %s", (arguments) ? arguments : "aucun");}@* |
fichier: %s", (arguments) ? arguments : "aucun");}@* |
1886 |
|
@code{@ @ @ @ return PLUGIN_RC_OK;}@* |
1887 |
@code{@}}@* |
@code{@}}@* |
1888 |
@code{...}@* |
@code{...}@* |
1889 |
@code{plugin->cmd_handler_add (plugin, "test", "Commande test", |
@code{plugin->cmd_handler_add (plugin, "test", "Commande test", |
1890 |
"[fichier]", "fichier: un nom de fichier", &cmd_test, NULL, NULL);}@* |
"[fichier]", "fichier: un nom de fichier", &cmd_test, NULL, NULL);}@* |
1891 |
@* |
@* |
1892 |
|
@emph{Notes :}@* |
1893 |
|
@* |
1894 |
|
La fonction appel@'ee lorsque la commande est ex@'ecut@'ee doit |
1895 |
|
renvoyer une des valeurs suivantes :@* |
1896 |
|
@itemize @minus |
1897 |
|
@item @option{PLUGIN_RC_KO ou -1}: la fonction a @'echou@'e |
1898 |
|
@item @option{PLUGIN_RC_OK ou 0}: la fonction a r@'eussi |
1899 |
|
@end itemize |
1900 |
|
@* |
1901 |
|
|
1902 |
@item |
@item |
1903 |
@command{void handler_remove (t_weechat_plugin *plugin, |
@command{void handler_remove (t_weechat_plugin *plugin, |
2204 |
plugin->exec_command (plugin, NULL, NULL, arguments); |
plugin->exec_command (plugin, NULL, NULL, arguments); |
2205 |
plugin->exec_command (plugin, NULL, NULL, arguments); |
plugin->exec_command (plugin, NULL, NULL, arguments); |
2206 |
} |
} |
2207 |
return 1; |
return PLUGIN_RC_OK; |
2208 |
} |
} |
2209 |
|
|
2210 |
int weechat_plugin_init (t_weechat_plugin *plugin) |
int weechat_plugin_init (t_weechat_plugin *plugin) |
2215 |
"msg: message a afficher deux fois", |
"msg: message a afficher deux fois", |
2216 |
&toto_cmd_double, |
&toto_cmd_double, |
2217 |
NULL, NULL); |
NULL, NULL); |
2218 |
return 1; |
return PLUGIN_RC_OK; |
2219 |
} |
} |
2220 |
|
|
2221 |
int weechat_plugin_end (t_weechat_plugin *plugin) |
void weechat_plugin_end (t_weechat_plugin *plugin) |
2222 |
{ |
{ |
2223 |
/* on ne fait rien ici */ |
/* on ne fait rien ici */ |
|
return 1; |
|
2224 |
} |
} |
2225 |
@end verbatim |
@end verbatim |
2226 |
|
|
2348 |
@code{@ @ @ @ ($null, $canal, $message) = split ":",$_[1],3;}@* |
@code{@ @ @ @ ($null, $canal, $message) = split ":",$_[1],3;}@* |
2349 |
@code{@ @ @ @ ($masque, $null, $canal) = split " ", $canal;}@* |
@code{@ @ @ @ ($masque, $null, $canal) = split " ", $canal;}@* |
2350 |
@code{@ @ @ @ weechat::print ("masque=$masque, canal=$canal, msg=$message\n");}@* |
@code{@ @ @ @ weechat::print ("masque=$masque, canal=$canal, msg=$message\n");}@* |
2351 |
|
@code{@ @ @ @ return 0;}@* |
2352 |
@code{@} }@* |
@code{@} }@* |
2353 |
@* |
@* |
2354 |
|
@emph{Notes :}@* |
2355 |
|
@* |
2356 |
|
La fonction appel@'ee lorsque le message est re@,cu doit renvoyer une |
2357 |
|
des valeurs suivantes :@* |
2358 |
|
@itemize @minus |
2359 |
|
@item @option{-1}: la fonction a @'echou@'e |
2360 |
|
@item @option{0}: la fonction a r@'eussi |
2361 |
|
@item @option{1}: le message ne sera pas transmis @`a WeeChat |
2362 |
|
@item @option{2}: le message ne sera pas transmis @`a d'autres extensions |
2363 |
|
@item @option{3}: le message ne sera transmis ni @`a WeeChat ni @`a |
2364 |
|
d'autres extensions |
2365 |
|
@end itemize |
2366 |
|
@* |
2367 |
|
|
2368 |
@item |
@item |
2369 |
@command{weechat::add_command_handler ( nom, fonction, [description, |
@command{weechat::add_command_handler ( nom, fonction, [description, |
2400 |
@code{@ @ @ @ return 0;}@* |
@code{@ @ @ @ return 0;}@* |
2401 |
@code{@} }@* |
@code{@} }@* |
2402 |
@* |
@* |
2403 |
|
@emph{Notes :}@* |
2404 |
|
@* |
2405 |
|
La fonction appel@'ee lorsque la commande est ex@'ecut@'ee doit renvoyer une |
2406 |
|
des valeurs suivantes :@* |
2407 |
|
@itemize @minus |
2408 |
|
@item @option{-1}: la fonction a @'echou@'e |
2409 |
|
@item @option{0}: la fonction a r@'eussi |
2410 |
|
@end itemize |
2411 |
|
@* |
2412 |
|
|
2413 |
@item |
@item |
2414 |
@command{weechat::remove_handler ( nom, fonction );}@* |
@command{weechat::remove_handler ( nom, fonction );}@* |
2740 |
@code{@ @ @ @ null, canal, message = string.split(args, ":", 2)}@* |
@code{@ @ @ @ null, canal, message = string.split(args, ":", 2)}@* |
2741 |
@code{@ @ @ @ masque, null, canal = string.split(string.strip(canal), " ", 2)}@* |
@code{@ @ @ @ masque, null, canal = string.split(string.strip(canal), " ", 2)}@* |
2742 |
@code{@ @ @ @ weechat.prnt("masque="+masque+", canal="+canal+", message="+message)}@* |
@code{@ @ @ @ weechat.prnt("masque="+masque+", canal="+canal+", message="+message)}@* |
2743 |
|
@code{@ @ @ @ return 0}@* |
2744 |
|
@* |
2745 |
|
@emph{Notes :}@* |
2746 |
|
@* |
2747 |
|
La fonction appel@'ee lorsque le message est re@,cu doit renvoyer une |
2748 |
|
des valeurs suivantes :@* |
2749 |
|
@itemize @minus |
2750 |
|
@item @option{-1}: la fonction a @'echou@'e |
2751 |
|
@item @option{0}: la fonction a r@'eussi |
2752 |
|
@item @option{1}: le message ne sera pas transmis @`a WeeChat |
2753 |
|
@item @option{2}: le message ne sera pas transmis @`a d'autres extensions |
2754 |
|
@item @option{3}: le message ne sera transmis ni @`a WeeChat ni @`a |
2755 |
|
d'autres extensions |
2756 |
|
@end itemize |
2757 |
@* |
@* |
2758 |
|
|
2759 |
@item |
@item |
2786 |
@code{weechat.add_command_handler ("commande", ma_commande)}@* |
@code{weechat.add_command_handler ("commande", ma_commande)}@* |
2787 |
@code{def ma_commande(serveur, args):}@* |
@code{def ma_commande(serveur, args):}@* |
2788 |
@code{@ @ @ @ weechat.prnt("serveur:"+serveur+" param@`etres:"+args)}@* |
@code{@ @ @ @ weechat.prnt("serveur:"+serveur+" param@`etres:"+args)}@* |
2789 |
|
@code{@ @ @ @ return 0}@* |
2790 |
|
@* |
2791 |
|
@emph{Notes :}@* |
2792 |
|
@* |
2793 |
|
La fonction appel@'ee lorsque la commande est ex@'ecut@'ee doit renvoyer une |
2794 |
|
des valeurs suivantes :@* |
2795 |
|
@itemize @minus |
2796 |
|
@item @option{-1}: la fonction a @'echou@'e |
2797 |
|
@item @option{0}: la fonction a r@'eussi |
2798 |
|
@end itemize |
2799 |
@* |
@* |
2800 |
|
|
2801 |
@item |
@item |