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

Diff of /weechat/doc/weechat_doc_fr.texi

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

revision 1.48 by flashcode, Sun Oct 23 22:07:21 2005 UTC revision 1.49 by flashcode, Tue Oct 25 17:37:14 2005 UTC
# Line 36  Line 36 
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 - 24 octobre 2005  @subtitle Documentation pour WeeChat v0.1.6-cvs - 25 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    
# Line 1564  obligatoires (sans quoi l'extension ne p Line 1564  obligatoires (sans quoi l'extension ne p
1564  @end itemize  @end itemize
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  @item weechat_plugin_end: fonction appel@'ee au d@'echargement de l'extension  qui doit renvoyer 1 en cas de succ@`es, 0 en cas d'erreur
1569    @item weechat_plugin_end: fonction appel@'ee au d@'echargement de l'extension,
1570    qui doit renvoyer 1 en cas de succ@`es, 0 en cas d'erreur
1571  @end itemize  @end itemize
1572  @end itemize  @end itemize
1573    
# Line 2118  s'est produite.@* Line 2120  s'est produite.@*
2120  *plugin, char *option)}@*  *plugin, char *option)}@*
2121  @*  @*
2122  Renvoie la valeur d'une option de l'extension.@*  Renvoie la valeur d'une option de l'extension.@*
2123    L'option est lue depuis le fichier ~/.weechat/plugins.rc et est
2124    sous cette forme :@*
2125    @code{extension.option=valeur}@*
2126    NB: le nom de l'extension est ajout@'e automatiquement.@*
2127    
2128  @emph{Param@`etres :}  @emph{Param@`etres :}
2129  @itemize @minus  @itemize @minus
# Line 2141  NB: le r@'esultat doit @^etre lib@'er@'e Line 2147  NB: le r@'esultat doit @^etre lib@'er@'e
2147  *plugin, char *option, char *value)}@*  *plugin, char *option, char *value)}@*
2148  @*  @*
2149  Modifie la valeur d'une option de l'extension.@*  Modifie la valeur d'une option de l'extension.@*
2150    L'option est @'ecrite dans le fichier ~/.weechat/plugins.rc et est
2151    sous cette forme :@*
2152    @code{extension.option=valeur}@*
2153    NB: le nom de l'extension est ajout@'e automatiquement.@*
2154    
2155  @emph{Param@`etres :}  @emph{Param@`etres :}
2156  @itemize @minus  @itemize @minus
# Line 2271  de fonction @`a appeler) Line 2281  de fonction @`a appeler)
2281  @item @option{description}: description br@`eve du script.  @item @option{description}: description br@`eve du script.
2282  @end itemize  @end itemize
2283  @*  @*
2284    @emph{Valeur renvoy@'ee :}@*
2285    @*
2286    1 si le script a @'et@'e enregistr@'e, 0 si une erreur s'est produite.@*
2287    @*
2288  @emph{Exemple :}@*  @emph{Exemple :}@*
2289  @*  @*
2290  @code{weechat::register ("essai", "1.0", "fin_essai", "Script d'essai !");}@*  @code{weechat::register ("essai", "1.0", "fin_essai", "Script d'essai !");}@*
# Line 2288  Affiche un message dans un canal.@* Line 2302  Affiche un message dans un canal.@*
2302  @item @option{serveur}: nom interne du serveur  @item @option{serveur}: nom interne du serveur
2303  @end itemize  @end itemize
2304  @*  @*
2305    @emph{Valeur renvoy@'ee :}@*
2306    @*
2307    1 si succ@`es, 0 si une erreur s'est produite.@*
2308    @*
2309  @emph{Exemples :}@*  @emph{Exemples :}@*
2310  @*  @*
2311  @code{weechat::print ("message");}@*  @code{weechat::print ("message");}@*
# Line 2307  Affiche un message dans la barre d'infos Line 2325  Affiche un message dans la barre d'infos
2325  @item @option{message}: message @`a afficher  @item @option{message}: message @`a afficher
2326  @end itemize  @end itemize
2327  @*  @*
2328    @emph{Valeur renvoy@'ee :}@*
2329    @*
2330    1 si succ@`es, 0 si une erreur s'est produite.@*
2331    @*
2332  @emph{Exemple :}@*  @emph{Exemple :}@*
2333  @*  @*
2334  @code{weechat::print_infobar (5, "message");}@*  @code{weechat::print_infobar (5, "message");}@*
# Line 2328  RFC 2812 : @uref{ftp://ftp.rfc-editor.or Line 2350  RFC 2812 : @uref{ftp://ftp.rfc-editor.or
2350  @item @option{fonction}: fonction Perl appel@'ee lorsque le message est re@,{c}u  @item @option{fonction}: fonction Perl appel@'ee lorsque le message est re@,{c}u
2351  @end itemize  @end itemize
2352  @*  @*
2353    @emph{Valeur renvoy@'ee :}@*
2354    @*
2355    1 si la fonction Perl a @'et@'e attach@'ee, 0 si une erreur s'est produite.@*
2356    @*
2357  @emph{Exemple :}@*  @emph{Exemple :}@*
2358  @*  @*
2359  @code{weechat::add_message_handler ("privmsg", ma_fonction);}@*  @code{weechat::add_message_handler ("privmsg", ma_fonction);}@*
# Line 2362  commande (affich@'ee par /help commande) Line 2388  commande (affich@'ee par /help commande)
2388  param@`etres de la commande (affich@'ee par /help commande)  param@`etres de la commande (affich@'ee par /help commande)
2389  @end itemize  @end itemize
2390  @*  @*
2391    @emph{Valeur renvoy@'ee :}@*
2392    @*
2393    1 si la fonction Perl a @'et@'e attach@'ee, 0 si une erreur s'est produite.@*
2394    @*
2395  @emph{Exemple :}@*  @emph{Exemple :}@*
2396  @*  @*
2397  @code{weechat::add_command_handler ("commande", ma_commande);}@*  @code{weechat::add_command_handler ("commande", ma_commande);}@*
# Line 2373  param@`etres de la commande (affich@'ee Line 2403  param@`etres de la commande (affich@'ee
2403  @*  @*
2404    
2405  @item  @item
2406    @command{weechat::remove_handler ( nom, fonction );}@*
2407    @*
2408    Supprime un gestionnaire de message ou de commande.@*
2409    
2410    @emph{Param@`etres :}
2411    @itemize @minus
2412    @item @option{nom}: nom du message IRC ou de la commande
2413    @item @option{fonction}: fonction Perl associ@'ee
2414    @end itemize
2415    @*
2416    @emph{Valeur renvoy@'ee :}@*
2417    @*
2418    1 si succ@`es, 0 si une erreur s'est produite.@*
2419    @*
2420    @emph{Exemple :}@*
2421    @*
2422    @code{weechat::remove_handler ("commande", ma_commande);}@*
2423    @*
2424    
2425    @item
2426  @command{weechat::command ( commande, [canal, [serveur]] );}@*  @command{weechat::command ( commande, [canal, [serveur]] );}@*
2427  @*  @*
2428  Ex@'ecute une commande ou envoie un message @'a un canal.@*  Ex@'ecute une commande ou envoie un message @'a un canal.@*
# Line 2384  Ex@'ecute une commande ou envoie un mess Line 2434  Ex@'ecute une commande ou envoie un mess
2434  @item @option{serveur}: nom interne du serveur  @item @option{serveur}: nom interne du serveur
2435  @end itemize  @end itemize
2436  @*  @*
2437    @emph{Valeur renvoy@'ee :}@*
2438    @*
2439    1 si succ@`es, 0 si une erreur s'est produite.@*
2440    @*
2441  @emph{Exemples :}@*  @emph{Exemples :}@*
2442  @*  @*
2443  @code{weechat::command ("bonjour tout le monde !");}@*  @code{weechat::command ("bonjour tout le monde !");}@*
# Line 2415  syst@`eme de partage WeeChat Line 2469  syst@`eme de partage WeeChat
2469  @item @option{canal}: nom du canal  @item @option{canal}: nom du canal
2470  @end itemize  @end itemize
2471  @*  @*
2472    @emph{Valeur renvoy@'ee :}@*
2473    @*
2474    L'information demand@'e, blanc si une erreur s'est produite ou que
2475    l'information n'a pas @'et@'e trouv@'ee.@*
2476    @*
2477  @emph{Exemples :}@*  @emph{Exemples :}@*
2478  @*  @*
2479  @code{$version = get_info("version");}@*  @code{$version = get_info("version");}@*
# Line 2459  Le tableau renvoy@'e contient les champs Line 2518  Le tableau renvoy@'e contient les champs
2518  @item bytes_per_sec: nombre d'octets transmis par seconde depuis le d@'ebut  @item bytes_per_sec: nombre d'octets transmis par seconde depuis le d@'ebut
2519  @end itemize  @end itemize
2520  @*  @*
2521    @emph{Valeur renvoy@'ee :}@*
2522    @*
2523    La liste des DCC, 0 si une erreur s'est produite.@*
2524    @*
2525    
2526  @item  @item
2527  @command{weechat::get_config ( nom );}@*  @command{weechat::get_config ( option );}@*
2528  @*  @*
2529  Obtenir la valeur d'une option de configuration WeeChat.@*  Obtenir la valeur d'une option de configuration WeeChat.@*
2530    
2531  @emph{Param@`etres :}  @emph{Param@`etres :}
2532  @itemize @minus  @itemize @minus
2533  @item @option{nom}: nom de l'option  @item @option{option}: nom de l'option
2534  @end itemize  @end itemize
2535  @*  @*
2536    @emph{Valeur renvoy@'ee :}@*
2537    @*
2538    La valeur de l'option, blanc si une erreur s'est produite ou que
2539    l'option n'a pas @'et@'e trouv@'ee.@*
2540    @*
2541  @emph{Exemples :}@*  @emph{Exemples :}@*
2542  @*  @*
2543  @code{$value1 = weechat::get_config ("look_set_title");}@*  @code{$value1 = weechat::get_config ("look_nicklist");}@*
2544  @code{$value2 = weechat::get_config ("freenode.server_autojoin");}@*  @code{$value2 = weechat::get_config ("freenode.server_autojoin");}@*
2545  @*  @*
2546    
2547    @item
2548    @command{weechat::set_config ( option, valeur );}@*
2549    @*
2550    Modifier une otion de configuration WeeChat.@*
2551    
2552    @emph{Param@`etres :}
2553    @itemize @minus
2554    @item @option{option}: nom de l'option
2555    @item @option{valeur}: la nouvelle valeur pour l'option
2556    @end itemize
2557    @*
2558    @emph{Valeur renvoy@'ee :}@*
2559    @*
2560    1 si succ@`es, 0 si une erreur s'est produite.@*
2561    @*
2562    @emph{Exemples :}@*
2563    @*
2564    @code{weechat::set_config ("look_nicklist", "off");}@*
2565    @code{weechat::set_config ("freenode.server_autojoin, "#weechat");}@*
2566    @*
2567    
2568    @item
2569    @command{weechat::get_plugin_config ( option );}@*
2570    @*
2571    Renvoie la valeur d'une option de l'extension.@*
2572    L'option est lue depuis le fichier ~/.weechat/plugins.rc et est
2573    sous cette forme :@*
2574    @code{extension.script.option=valeur}@*
2575    NB: le nom de l'extension et du script sont ajout@'es automatiquement.@*
2576    
2577    @emph{Param@`etres :}
2578    @itemize @minus
2579    @item @option{option}: nom de l'option
2580    @end itemize
2581    @*
2582    @emph{Valeur renvoy@'ee :}@*
2583    @*
2584    La valeur de l'option, blanc si une erreur s'est produite ou que
2585    l'option n'a pas @'et@'e trouv@'ee.@*
2586    @*
2587    @emph{Exemple :}@*
2588    @*
2589    @code{$value = weechat::get_plugin_config ("ma_variable");}@*
2590    @*
2591    
2592    @item
2593    @command{weechat::set_plugin_config ( option, valeur );}@*
2594    @*
2595    Modifie la valeur d'une option de l'extension.@*
2596    L'option est @'ecrite dans le fichier ~/.weechat/plugins.rc et est
2597    sous cette forme :@*
2598    @code{extension.script.option=valeur}@*
2599    NB: le nom de l'extension et du script sont ajout@'es automatiquement.@*
2600    
2601    @emph{Param@`etres :}
2602    @itemize @minus
2603    @item @option{option}: nom de l'option
2604    @item @option{valeur}: la nouvelle valeur pour l'option
2605    @end itemize
2606    @*
2607    @emph{Valeur renvoy@'ee :}@*
2608    @*
2609    1 si succ@`es, 0 si une erreur s'est produite.@*
2610    @*
2611    @emph{Exemple :}@*
2612    @*
2613    @code{weechat::set_plugin_config ("ma_variable", "valeur");}@*
2614    @*
2615    
2616  @end itemize  @end itemize
2617    
2618  @subsection Scripts Python  @subsection Scripts Python
# Line 2514  de fonction @`a appeler) Line 2651  de fonction @`a appeler)
2651  @item @option{description}: description br@`eve du script.  @item @option{description}: description br@`eve du script.
2652  @end itemize  @end itemize
2653  @*  @*
2654    @emph{Valeur renvoy@'ee :}@*
2655    @*
2656    1 si le script a @'et@'e enregistr@'e, 0 si une erreur s'est produite.@*
2657    @*
2658  @emph{Exemple :}@*  @emph{Exemple :}@*
2659  @*  @*
2660  @code{weechat.register ("essai", "1.0", "fin_essai", "Script d'essai !")}@*  @code{weechat.register ("essai", "1.0", "fin_essai", "Script d'essai !")}@*
# Line 2531  Affiche un message dans un canal.@* Line 2672  Affiche un message dans un canal.@*
2672  @item @option{serveur}: nom interne du serveur  @item @option{serveur}: nom interne du serveur
2673  @end itemize  @end itemize
2674  @*  @*
2675    @emph{Valeur renvoy@'ee :}@*
2676    @*
2677    1 si succ@`es, 0 si une erreur s'est produite.@*
2678    @*
2679  @emph{Exemples :}@*  @emph{Exemples :}@*
2680  @*  @*
2681  @code{weechat.prnt ("message")}@*  @code{weechat.prnt ("message")}@*
# Line 2550  Affiche un message dans la barre d'infos Line 2695  Affiche un message dans la barre d'infos
2695  @item @option{message}: message @`a afficher  @item @option{message}: message @`a afficher
2696  @end itemize  @end itemize
2697  @*  @*
2698    @emph{Valeur renvoy@'ee :}@*
2699    @*
2700    1 si succ@`es, 0 si une erreur s'est produite.@*
2701    @*
2702  @emph{Exemple :}@*  @emph{Exemple :}@*
2703  @*  @*
2704  @code{weechat.print_infobar (5, "message")}@*  @code{weechat.print_infobar (5, "message")}@*
# Line 2571  RFC 2812 : @uref{ftp://ftp.rfc-editor.or Line 2720  RFC 2812 : @uref{ftp://ftp.rfc-editor.or
2720  @item @option{fonction}: fonction Python appel@'ee lorsque le message est re@,{c}u  @item @option{fonction}: fonction Python appel@'ee lorsque le message est re@,{c}u
2721  @end itemize  @end itemize
2722  @*  @*
2723    @emph{Valeur renvoy@'ee :}@*
2724    @*
2725    1 si la fonction Python a @'et@'e attach@'ee, 0 si une erreur s'est produite.@*
2726    @*
2727  @emph{Exemple :}@*  @emph{Exemple :}@*
2728  @*  @*
2729  @code{weechat.add_message_handler ("privmsg", ma_fonction)}@*  @code{weechat.add_message_handler ("privmsg", ma_fonction)}@*
# Line 2602  commande (affich@'ee par /help commande) Line 2755  commande (affich@'ee par /help commande)
2755  param@`etres de la commande (affich@'ee par /help commande)  param@`etres de la commande (affich@'ee par /help commande)
2756  @end itemize  @end itemize
2757  @*  @*
2758    @emph{Valeur renvoy@'ee :}@*
2759    @*
2760    1 si la fonction Python a @'et@'e attach@'ee, 0 si une erreur s'est produite.@*
2761    @*
2762  @emph{Exemple :}@*  @emph{Exemple :}@*
2763  @*  @*
2764  @code{weechat.add_command_handler ("commande", ma_commande)}@*  @code{weechat.add_command_handler ("commande", ma_commande)}@*
# Line 2610  param@`etres de la commande (affich@'ee Line 2767  param@`etres de la commande (affich@'ee
2767  @*  @*
2768    
2769  @item  @item
2770    @command{weechat.remove_handler ( nom, fonction );}@*
2771    @*
2772    Supprime un gestionnaire de message ou de commande.@*
2773    
2774    @emph{Param@`etres :}
2775    @itemize @minus
2776    @item @option{nom}: nom du message IRC ou de la commande
2777    @item @option{fonction}: fonction Python associ@'ee
2778    @end itemize
2779    @*
2780    @emph{Valeur renvoy@'ee :}@*
2781    @*
2782    1 si succ@`es, 0 si une erreur s'est produite.@*
2783    @*
2784    @emph{Exemple :}@*
2785    @*
2786    @code{weechat.remove_handler ("commande", ma_commande);}@*
2787    @*
2788    
2789    @item
2790  @command{weechat.command ( commande, [canal, [serveur]] )}@*  @command{weechat.command ( commande, [canal, [serveur]] )}@*
2791  @*  @*
2792  Ex@'ecute une commande ou envoie un message @'a un canal.@*  Ex@'ecute une commande ou envoie un message @'a un canal.@*
# Line 2621  Ex@'ecute une commande ou envoie un mess Line 2798  Ex@'ecute une commande ou envoie un mess
2798  @item @option{serveur}: nom interne du serveur  @item @option{serveur}: nom interne du serveur
2799  @end itemize  @end itemize
2800  @*  @*
2801    @emph{Valeur renvoy@'ee :}@*
2802    @*
2803    1 si succ@`es, 0 si une erreur s'est produite.@*
2804    @*
2805  @emph{Exemples :}@*  @emph{Exemples :}@*
2806  @*  @*
2807  @code{weechat.command ("bonjour tout le monde !")}@*  @code{weechat.command ("bonjour tout le monde !")}@*
# Line 2651  syst@`eme de partage WeeChat Line 2832  syst@`eme de partage WeeChat
2832  @item @option{serveur}: nom interne du serveur  @item @option{serveur}: nom interne du serveur
2833  @end itemize  @end itemize
2834  @*  @*
2835    @emph{Valeur renvoy@'ee :}@*
2836    @*
2837    L'information demand@'e, blanc si une erreur s'est produite ou que
2838    l'information n'a pas @'et@'e trouv@'ee.@*
2839    @*
2840  @emph{Exemples :}@*  @emph{Exemples :}@*
2841  @*  @*
2842  @code{$version = weechat.get_info ("version")}@*  @code{$version = weechat.get_info ("version")}@*
# Line 2695  Le tableau renvoy@'e contient les champs Line 2881  Le tableau renvoy@'e contient les champs
2881  @item bytes_per_sec: nombre d'octets transmis par seconde depuis le d@'ebut  @item bytes_per_sec: nombre d'octets transmis par seconde depuis le d@'ebut
2882  @end itemize  @end itemize
2883  @*  @*
2884    @emph{Valeur renvoy@'ee :}@*
2885    @*
2886    La liste des DCC, 0 si une erreur s'est produite.@*
2887    @*
2888    
2889  @item  @item
2890  @command{weechat.get_config ( nom );}@*  @command{weechat.get_config ( nom );}@*
# Line 2706  Obtenir la valeur d'une option de config Line 2896  Obtenir la valeur d'une option de config
2896  @item @option{nom}: nom de l'option  @item @option{nom}: nom de l'option
2897  @end itemize  @end itemize
2898  @*  @*
2899    @emph{Valeur renvoy@'ee :}@*
2900    @*
2901    La valeur de l'option, blanc si une erreur s'est produite ou que
2902    l'option n'a pas @'et@'e trouv@'ee.@*
2903    @*
2904  @emph{Exemples :}@*  @emph{Exemples :}@*
2905  @*  @*
2906  @code{$value1 = weechat.get_config ("look_set_title");}@*  @code{$value1 = weechat.get_config ("look_nicklist");}@*
2907  @code{$value2 = weechat.get_config ("freenode.server_autojoin");}@*  @code{$value2 = weechat.get_config ("freenode.server_autojoin");}@*
2908  @*  @*
2909    
2910    @item
2911    @command{weechat.set_config ( nom, valeur );}@*
2912    @*
2913    Modifier une otion de configuration WeeChat.@*
2914    
2915    @emph{Param@`etres :}
2916    @itemize @minus
2917    @item @option{nom}: nom de l'option
2918    @item @option{valeur}: la nouvelle valeur pour l'option
2919    @end itemize
2920    @*
2921    @emph{Valeur renvoy@'ee :}@*
2922    @*
2923    1 si succ@`es, 0 si une erreur s'est produite.@*
2924    @*
2925    @emph{Exemples :}@*
2926    @*
2927    @code{weechat.set_config ("look_nicklist", "off");}@*
2928    @code{weechat.set_config ("freenode.server_autojoin, "#weechat");}@*
2929    @*
2930    
2931    @item
2932    @command{weechat.get_plugin_config ( option );}@*
2933    @*
2934    Renvoie la valeur d'une option de l'extension.@*
2935    L'option est lue depuis le fichier ~/.weechat/plugins.rc et est
2936    sous cette forme :@*
2937    @code{extension.script.option=valeur}@*
2938    NB: le nom de l'extension et du script sont ajout@'es automatiquement.@*
2939    
2940    @emph{Param@`etres :}
2941    @itemize @minus
2942    @item @option{option}: nom de l'option
2943    @end itemize
2944    @*
2945    @emph{Valeur renvoy@'ee :}@*
2946    @*
2947    La valeur de l'option, blanc si une erreur s'est produite ou que
2948    l'option n'a pas @'et@'e trouv@'ee.@*
2949    @*
2950    @emph{Exemple :}@*
2951    @*
2952    @code{$value = weechat.get_plugin_config ("ma_variable");}@*
2953    @*
2954    
2955    @item
2956    @command{weechat.set_plugin_config ( option, valeur );}@*
2957    @*
2958    Modifie la valeur d'une option de l'extension.@*
2959    L'option est @'ecrite dans le fichier ~/.weechat/plugins.rc et est
2960    sous cette forme :@*
2961    @code{extension.script.option=valeur}@*
2962    NB: le nom de l'extension et du script sont ajout@'es automatiquement.@*
2963    
2964    @emph{Param@`etres :}
2965    @itemize @minus
2966    @item @option{option}: nom de l'option
2967    @item @option{valeur}: la nouvelle valeur pour l'option
2968    @end itemize
2969    @*
2970    @emph{Valeur renvoy@'ee :}@*
2971    @*
2972    1 si succ@`es, 0 si une erreur s'est produite.@*
2973    @*
2974    @emph{Exemple :}@*
2975    @*
2976    @code{weechat.set_plugin_config ("ma_variable", "valeur");}@*
2977    @*
2978    
2979  @end itemize  @end itemize
2980    
2981  @subsection Scripts Ruby  @subsection Scripts Ruby

Legend:
Removed from v.1.48  
changed lines
  Added in v.1.49

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