[PHP-DOC] cvs: phpdoc /fr/functions ircg.xml

[Damien Seguy]

dams            Fri Jul 20 03:07:33 2001 EDT

  Added files:                 
    /phpdoc/fr/functions        ircg.xml 
  Log:
  initial transaltion
  

Index: phpdoc/fr/functions/ircg.xml
+++ phpdoc/fr/functions/ircg.xml
 <reference id="ref.ircg">
  <title>IRC</title>
  <titleabbrev>Interface IRC</titleabbrev>
  <partintro>
         <para>
                Client pour IRC : Internet Relay Chat
         </para>
         <para>
          Bas&eacute; sur <ulink url="&url.ircg;">IRCG</ulink>, de Sascha Schumann.
         </para>
  </partintro>
  <refentry id="function.ircg-pconnect">
   <refnamediv>
    <refname>ircg_pconnect</refname>
    <refpurpose>Connecte &agrave; un serveur IRC</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>resource <function>ircg_pconnect</function></funcdef>
      <paramdef>string <parameter>username</parameter></paramdef>
      <paramdef>string <parameter><optional>server_ip</optional></parameter></paramdef>
      <paramdef>int    
<parameter><optional>server_port</optional></parameter></paramdef>
      <paramdef>string 
<parameter><optional>msg_format</optional></parameter></paramdef>
      <paramdef>array  
<parameter><optional>ctcp_messages</optional></parameter></paramdef>
      <paramdef>array  
<parameter><optional>user_settings</optional></parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
           <function>ircg_pconnect</function> essaie d'&eacute;tablir une connexion 
avec le
           serveur IRC <parameter>server_ip</parameter>, et retourne une ressource
           de connexion pour utilisation ult&eacute;rieure.
    </para>
                <para>
                 Le seul param&egrave;tre obligatoire est 
<parameter>username</parameter>,
                 qui repr&eacute;sente le nick (nom d'utilisateur en IRC) initial.
                 <parameter>server_ip</parameter> et <parameter>server_port</parameter>
                 sont optionnels, et par d&eacute;faut, valent respectivement
                 <literal>127.0.0.1</literal> (h&ocirc;te local) et 
<literal>6667</literal>.
                 <note>
                        <para>
                         Actuellement, le param&egrave;tre 
<parameter>server_ip</parameter> n'effectue
                         aucune r&eacute;solution de nom, et n'accepte que les IP au 
format num&eacute;rique.
                        </para>
                 </note>
                </para>
                <para>
                 Vous pouvez personnaliser l'affichage des messages IRC et les 
&eacute;v&eacute;nements
                 qui s'y rattachent avec les formats de messages, 
g&eacute;n&eacute;r&eacute;s par la fonction
                 <function>ircg_register_format_messages</function>, en 
sp&eacute;cifiant
                 le format dans <parameter>msg_format</parameter>.
                </para>
                <para>
                 <parameter>ctcp_messages</parameter>
                </para>
                <para>
                 <parameter>user_settings</parameter>
                </para>
    <para>
     Voir aussi
     <function>ircg_disconnect</function>,
         <function>ircg_is_conn_alive</function> et
         <function>ircg_register_format_messages</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-set-current">
   <refnamediv>
    <refname>ircg_set_current</refname>
    <refpurpose>
           Pr&eacute;pare la connexion courante pour l'affichage
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_set_current</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_set_current</function> s&eacute;lectionne la connexion 
courante pour
         l'affichage dans le contexte d'ex&eacute;cution courant. Tous les messages 
envoy&eacute;s
         par le serveur repr&eacute;sent&eacute; par <parameter>connection</parameter> 
seront recopi&eacute;s
         et envoy&eacute;s &agrave; la sortie standard, avec le format standard, ou 
bien la cha&icirc;ne de
         format sp&eacute;cifi&eacute;e par la fonction 
<function>ircg_register_format_messages</function>
         et cr&eacute;&eacute;e par <function>ircg_lookup_format_messages</function>.
    </para>
    <para>
     Voir aussi
     <function>ircg_register_format_messages</function> et
     <function>ircg_lookup_format_messages</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-join">
   <refnamediv>
    <refname>ircg_join</refname>
    <refpurpose>
           Rejoint un canal IRC
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_join</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string   <parameter>channel</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_join</function> rejoint le canal <parameter>channel</parameter>
         sur le serveur sur le serveur repr&eacute;sent&eacute; par 
<parameter>connection</parameter>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-part">
   <refnamediv>
    <refname>ircg_part</refname>
    <refpurpose>
           Quitte le canal
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_part</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string   <parameter>channel</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_part</function> quitte le canal <parameter>channel</parameter>
         sur le serveur sur le serveur repr&eacute;sent&eacute; par 
<parameter>connection</parameter>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-msg">
   <refnamediv>
    <refname>ircg_msg</refname>
    <refpurpose>
           Envoie un message &agrave; un canal ou un utilisateur
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_msg</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string   <parameter>recipient</parameter></paramdef>
            <paramdef>string   <parameter>message</parameter></paramdef>
            <paramdef>boolean  
<parameter><optional>suppress</optional></parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
           <function>ircg_msg</function> envoie le message 
<parameter>message</parameter>
           &agrave; l'utilisateur ou au canal <parameter>recipient</parameter>, sur le 
serveur
           <parameter>connection</parameter>. Un destinataire 
<parameter>recipient</parameter>
           commen&ccedil;ant par <literal>#</literal> ou <literal>&amp;</literal> 
repr&eacute;sente un
           canal IRC, et sinon, un utilisateur.
    </para>
    <para>
         En donnant la valeur <literal>TRUE</literal> au param&egrave;tre
         <parameter>suppress</parameter>, vous &eacute;viterez que vos propres messages
         soient affich&eacute;s sur votre connexion <parameter>connection</parameter>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-notice">
   <refnamediv>
    <refname>ircg_notice</refname>
    <refpurpose>
           Envoie une note (notice) &agrave; un utilisateur
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_notice</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string   <parameter></parameter></paramdef>
            <paramdef>string   <parameter>message</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_notice</function> envoie le message 
<parameter>message</parameter>
         &agrave; l'utilisateur <parameter>nick</parameter> sur le serveur
         <parameter>connection</parameter>. Consultez votre documentation IRC pour
         conna&icirc;tre la diff&eacute;rence exacte entre un message MSG et une note 
NOTICE.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-nick">
   <refnamediv>
    <refname>ircg_nick</refname>
    <refpurpose>
           Change de nom sur le serveur
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_nick</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string   <parameter>nick</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
          <function>ircg_nick</function> change le nom (nick) que vous portez
          sur la connexion <parameter>connection</parameter>, si ce nom n'est pas
          pris.
    </para>
    <para>
         <function>ircg_nick</function> retourne <literal>TRUE</literal> en
         cas de succ&egrave;s, et <literal>FALSE</literal>
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-topic">
   <refnamediv>
    <refname>ircg_topic</refname>
    <refpurpose>
           Modifie le sujet (topic) d'un canal
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_topic</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string   <parameter>channel</parameter></paramdef>
            <paramdef>string   <parameter>new_topic</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_topic</function> change le sujet du canal de 
<parameter>channel</parameter>
         en <parameter>new_topic</parameter>, sur le serveur 
<parameter>connection</parameter>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-channel_mode">
   <refnamediv>
    <refname>ircg_channel_mode</refname>
    <refpurpose>
          Modifie les flags du canal
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_channel_mode</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string   <parameter>channel</parameter></paramdef>
            <paramdef>string   <parameter>mode_spec</parameter></paramdef>
            <paramdef>string   <parameter>nick</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
          <function>ircg_channel_mode</function> modifie les flags du canal
          <parameter>channel</parameter>, sur le serveur 
<parameter>channel</parameter>.
          Les nouveaux flags sont pass&eacute;s dans le param&egrave;tre 
<parameter>mode_spec</parameter>
          et sont appliqu&eacute;s &agrave; l'utilisateur <parameter>nick</parameter>.
    </para>
        <para>
         Les flags sont activ&eacute;s ou d&eacute;sactiv&eacute;s en 
sp&eacute;cifiant un caract&egrave;re de
         mode et en le pr&eacute;fixant par un caract&egrave;re plus 
(<literal>+</literal>)
         ou un caract&egrave;re moins (<literal>-</literal>).
         Par exemple, le mode op&eacute;rateur est donn&eacute; &agrave; un 
utilisateur avec la
         syntaxe '<literal>+o</literal>' et retir&eacute; au m&ecirc;me utilisateur 
avec la
         syntaxe '<literal>-o</literal>', pass&eacute; dans le param&egrave;tre
         <parameter>mode_spec</parameter>.
        </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-html-encode">
   <refnamediv>
    <refname>ircg_html_encode</refname>
    <refpurpose>
          Pr&eacute;pare l'affichage pour le HTML
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_html_encode</function></funcdef>
            <paramdef>string   <parameter>html_string</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
           ...
    </para>
    <para>
     Voir aussi:
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-whois">
   <refnamediv>
    <refname>ircg_whois</refname>
    <refpurpose>
         Requiert les informations sur un utilisateur
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_whois</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string   <parameter>nick</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
    </para>
    <para>
     Voir aussi:
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-kick">
   <refnamediv>
    <refname>ircg_kick</refname>
    <refpurpose>
          Expulse un utilisateur d'un canal
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_kick</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string <parameter>channel</parameter></paramdef>
            <paramdef>string <parameter>nick</parameter></paramdef>
            <paramdef>string <parameter>reason</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_kick</function> expulse l'utilisateur 
<parameter>nick</parameter>
         du canal <parameter>channel</parameter> sur le serveur 
<parameter>connection</parameter>.
         Le param&egrave;tre <parameter>reason</parameter> doit contenir une 
br&egrave;ve explication
         de la raison de cette expulsion.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-ignore-add">
   <refnamediv>
    <refname>ircg_ignore_add</refname>
    <refpurpose>
          Ajoute un utilisateur sur la liste des utilisateurs ind&eacute;sirables
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_ignore_add</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string <parameter>nick</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_ignore_add</function> ajoute l'utilisateur 
<parameter>nick</parameter>
         dans votre liste d'utilisateurs ind&eacute;sirables, sur le serveur
         <parameter>connection</parameter>.
         Tous les messages qui vous sont envoy&eacute;s par cet utilisateur seront 
ignor&eacute;s.
    </para>
    <para>
     Voir aussi
     <function>ircg_ignore_del</function> .
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-ignore-del">
   <refnamediv>
    <refname>ircg_ignore_del</refname>
    <refpurpose>
           Supprime un utilisateur de la liste des utilisateurs ind&eacute;sirables
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_ignore_del</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string <parameter>nick</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_ignore_del</function> supprime l'utilisateur
         <parameter>nick</parameter> de la liste des utilisateurs ind&eacute;sirables,
         sur le serveur <parameter>connection</parameter>.
    </para>
    <para>
     Voir aussi
     <function>ircg_ignore_add</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-disconnect">
   <refnamediv>
    <refname>ircg_disconnect</refname>
    <refpurpose>
           Ferme la connexion avec un serveur
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_disconnect</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
            <paramdef>string <parameter>reason</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_disconnect</function> ferme la connexion
         ouverter pr&eacute;c&eacute;demment avec un serveur gr&acirc;ce &agrave; la 
fonction
         <function>ircg-pconnect</function>, et repr&eacute;sent&eacute;e par
         <parameter>connection</parameter>.
    </para>
    <para>
     Voir aussi
     <function>ircg_pconnect</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-is-conn-alive">
   <refnamediv>
    <refname>ircg_is_conn_alive</refname>
    <refpurpose>
          V&eacute;rifie l'&eacute;tat de la connexion
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_is_conn_alive</function></funcdef>
      <paramdef>resource <parameter>connection</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
           <function>ircg_is_conn_alive</function> retourne <literal>TRUE</literal>
           si la connexion <parameter>connection</parameter> est toujours active
           et fonctionnelle, et <literal>FALSE</literal> si la connexion n'est
           plus disponible.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-lookup-format-messages">
   <refnamediv>
    <refname>ircg_lookup_format_messages</refname>
    <refpurpose>
           S&eacute;lectionne un format d'affichage pour les messages IRC
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_lookup_format_messages</function></funcdef>
      <paramdef>string <parameter>name</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_lookup_format_messages</function> s&eacute;lectionne un format
         d'affichage pour les messages et les &eacute;v&eacute;nements. Les formats 
peuvent &ecirc;tre
         pr&eacute;d&eacute;finis avec la fonction 
<function>ircg_register_format_messages</function>.
         Un format par d&eacute;faut, appel&eacute; <literal>ircg</literal> est 
toujours disponible.
    </para>
    <para>
     Voir aussi
     <function>ircg_register_format_messages</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ircg-register-format-messages">
   <refnamediv>
    <refname>ircg_register_format_messages</refname>
    <refpurpose>
           Enregistre un nouveau format d'affichage des messages IRC
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>boolean <function>ircg_register_format_messages</function></funcdef>
      <paramdef>string <parameter>name</parameter></paramdef>
      <paramdef>array  <parameter>messages</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
         <function>ircg_register_format_messages</function> vous permet de 
personnaliser
         l'affichage de vos messages IRC. Vous pouvez m&ecirc;me enregistrer plusieurs
         formats et passer de l'un &agrave; l'autre &agrave; la vol&eacute;e avec
         <function>ircg_lookup_format_messages</function>.
    </para>
                <para>
                 <itemizedlist>
                        <listitem><simpara>Message public brut</simpara></listitem>
                        <listitem><simpara>Message priv&eacute; 
re&ccedil;u</simpara></listitem>
                        <listitem><simpara>Message priv&eacute; 
envoy&eacute;</simpara></listitem>
                        <listitem><simpara>Un utilisateur quitte le 
canal</simpara></listitem>
                        <listitem><simpara>Un utilisateur rejoint le 
canal</simpara></listitem>
                        <listitem><simpara>Un utilisateur est expuls&eacute; du 
canal</simpara></listitem>
                        <listitem><simpara>Le sujet du canal est 
modifi&eacute;</simpara></listitem>
                        <listitem><simpara>Erreur</simpara></listitem>
                        <listitem><simpara>Erreur fatale</simpara></listitem>
                        <listitem><simpara>Rejoint la fin de la liste (??? : Join list 
end)</simpara></listitem>
                        <listitem><simpara>Se quitte soi-m&ecirc;me (??? : Self 
part)</simpara></listitem>
                        <listitem><simpara>Un utilisateur s'expulse 
lui-m&ecirc;me</simpara></listitem>
                        <listitem><simpara>Un utilisateur quitte sa 
connexion</simpara></listitem>
                        <listitem><simpara>D&eacute;but de regroupement en 
masse</simpara></listitem>
                        <listitem><simpara>El&eacute;ment de regroupement en 
masse</simpara></listitem>
                        <listitem><simpara>Fin de regroupement en 
masse</simpara></listitem>
                        <listitem><simpara>Whois utilisateur</simpara></listitem>
                        <listitem><simpara>Whois serveur</simpara></listitem>
                        <listitem><simpara>Whois inactif</simpara></listitem>
                        <listitem><simpara>Whois canal</simpara></listitem>
                        <listitem><simpara>Fin de whois</simpara></listitem>
                        <listitem><simpara>Changement de statut Voice pour un 
utilisateur</simpara></listitem>
                        <listitem><simpara>Changement de statu d'op&eacute;rateur pour 
un utilisateur</simpara></listitem>
                        <listitem><simpara>Liste d'utilisateurs 
ind&eacute;sirables</simpara></listitem>
                        <listitem><simpara>Fin de liste d'utilisateurs 
ind&eacute;sirables</simpara></listitem>
                 </itemizedlist>
                 <itemizedlist>
                        <listitem><simpara>%f - origine</simpara></listitem>
                        <listitem><simpara>%t - destination</simpara></listitem>
                        <listitem><simpara>%c - canal</simpara></listitem>
                        <listitem><simpara>%r - message brut</simpara></listitem>
                        <listitem><simpara>%m - message 
encod&eacute;</simpara></listitem>
                        <listitem><simpara>%j - message encod&eacute; 
js</simpara></listitem>
                 </itemizedlist>
                 <itemizedlist>
                        <listitem><simpara>1 - encodage mod</simpara></listitem>
                        <listitem><simpara>2 - nickname decode</simpara></listitem>
                 </itemizedlist>
                </para>
    <para>
     Voir aussi
     <function>ircg_lookup_format_messages</function>.
    </para>
   </refsect1>
  </refentry>
 </reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->