Introduction
************

Description
===========

WeeChat (Wee Enhanced Environment for Chat) est un client IRC libre, rapide et léger, concu pour différents systèmes d'exploitation.

Ses principales caractéristiques sont les suivantes :

  - connexion multi-serveurs

  - plusieurs interfaces : Curses, Gtk et Qt

  - petit, rapide et léger

  - paramétrable et extensible avec des scripts

  - conforme aux RFCs 1459, 2810, 2811, 2812, et 2813

  - multi-plateformes (Gnu/Linux, *BSD, Windows et d'autres systèmes)

  - 100% GPL, logiciel libre

La page d'accueil de WeeChat est ici :

http://weechat.flashtux.org

Pré-requis
==========

Pour installer WeeChat, vous devez avoir :

  * Un système Gnu/Linux (avec le compilateur et les outils associés pour le paquet des sources)

  * Droits "root" (pour installer WeeChat)

  * Selon l'interface, une des bibliothèques suivantes :

       - Curses: la librairie ncurses,

       - Gtk: *** interface non développée ***,

       - Qt: *** interface non développée ***,

Installation
************

Paquet binaire
==============

Les paquets binaires sont disponibles pour les distributions suivantes :

  * Debian (ou toute distribution compatible Debian)

     Pour installer : dpkg -i /chemin/weechat_x.y.z-1_i386.deb

  * Mandrake/Redhat (ou toute distribution compatible avec les RPM)

     Pour installer : rpm -i /chemin/weechat-x.y.z-1.i386.rpm

  * Gentoo

     Pour installer : voir la documentation Gentoo

  * *BSD (non disponible !)

  * Slackware (non disponible !)

  * Windows (non disponible !)

où x.y.z est la version (par exemple 0.0.1)

Paquet source
=============

Tapez simplement dans une console ou un terminal :

./configure

make

Note: pour ne construire que certaines interfaces, vous pouvez passer des paramètres à ./configure, tapez ./configure --help pour de l'aide sur ces options.

Obtenez les droits root et installez WeeChat :

su -

(entrez le mot de passe de root)

make install

Sources CVS
===========

Attention: les sources CVS sont réservés aux utilisateurs avancés : il se peut que WeeChat ne compile pas et qu'il soit trs̀ instable. Vous êtes prévenus !

Pour récupérer les sources CVS, tapez ces commandes :

cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/weechat login

cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/weechat co weechat

(lorsqu'un mot de passe est demandé, tapez simplement sur Entrée)

Exécutez ce script :

./autogen.sh

Suivez alors les instructions du paquet sources - see Paquet source.

Utilisation
***********

Lancer WeeChat
==============

Paramètres de ligne de commande
-------------------------------

-h, --help
     Afficher l'aide

-l, --license
     Afficher la licence de WeeChat

-v, --version
     Afficher la version de WeeChat

Lancer WeeChat
--------------

Tapez simplement cette commande pour lancer WeeChat :

weechat-curses

ou weechat-gtk (pour l'interface Gtk)

ou weechat-qt (pour l'interface Qt)

Lorsque vous lancez WeeChat pour la première fois, un fichier de configuration par défaut est créé, avec les options par défaut.

Le fichier de configuration par défaut est : ~/.weechat/weechat.rc

Vous pouvez éditer ce fichier pour configurer WeeChat à votre convenance, ou vous pouvez modifier les paramètres dans WeeChat avec la commande /set - see Commandes WeeChat.

Raccourcis clavier
==================

Flèche gauche / Flèche droite
     Aller au caractère précédent / suivant sur la ligne de commande

Ctrl + flèche gauche / Ctrl + flèche droite
     Aller au mot précédent / suivant sur la ligne de commande

Home / End
     Aller au début / à la fin de la ligne de commande

Backspace / Delete
     Effacer le mot précédent / suivant sur la ligne de commande

Ctrl + Backspace
     Effacer le mot précédent sur la ligne de commande

Tab
     Compléter la commande ou le pseudo (Tab à nouveau : trouver la complétion suivante)

Tout caractère
     Insérer le caractère à la position du curseur sur la ligne de commande

Entrée
     Exécuter la commande ou envoyer le message

Flèche haut / Flèche bas
     Rappeler les dernières commandes/messages

PageUp / PageDown
     Afficher l'historique de la fenêtre

F6 / F7
     Aller à la fenêtre précédente / suivante

Alt + flèche gauche / Alt + flèche droite
     Identique à F6 / F7

Commandes WeeChat
=================

NON ECRIT !

Extensions
**********

Scripts Perl
============

Charger/décharger des scripts Perl
----------------------------------

Les scripts Perl sont chargés et déchargés avec la commande /perl (tapez /help perl dans WeeChat pour obtenir de l'aide sur la commande).

  * Exemple de chargement d'un script Perl :

     /perl load /tmp/essai.pl

  * Exemple de déchargement d'un script Perl :

     /perl unload essai

     A noter: le nom "essai" est le premier paramètre de la fonction IRC::register.

  * Liste des scripts Perl chargés :

     /perl

Interface WeeChat / Perl
------------------------

  * IRC::register ( nom, version, fonction_de_fin, description );

     C'est la première fonction à appeler dans le script Perl.

     Tout script Perl pour WeeChat doit appeler cette fonction.

     Paramètres :

       - nom: nom unique pour identifier le script (chaque script doit avoir un nom différent)

       - version: version du script

       - fonction_de_fin: fonction Perl appelée quand le script est déchargé (paramètre facultatif, une chaîne vide signifiant qu'il n'y a pas de fonction à appeler)

       - description: description brève du script.

     Exemple :

     IRC::register ("essai", "1.0", "fin_essai", "Script d'essai !");

  * IRC::print ( message );

     Affiche un message dans la fenêtre courante (canal ou serveur).

     Paramètres :

       - message: message à afficher

     Exemple :

     IRC::print ("message");

  * IRC::add_message_handler ( nom, fonction );

     Attache une fonction Perl à un message IRC particulier.

     La fonction sera appelée à chaque fois que le message IRC sera reçu.

     Paramètres :

       - nom: nom du message IRC pour lequel la fonction est appelée
          Pour connaître la liste des messages IRC disponibles, merci de consulter les RFC 1459 et/ou 2812 :

          RFC 1459 : ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt

          RFC 2812 : ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt

       - fonction: fonction Perl appelée lorsque le message est reçu

     Exemple :

     IRC::add_message_handler ("privmsg", ma_fonction);

     sub ma_fonction

     {

         ($null, $canal, $message) = split ":",@_[0],3;

         ($masque, $null, $canal) = split " ", $canal;

         IRC::print ("masque=$masque, canal=$canal, message=$message\n");

     }

  * IRC::add_command_handler ( nom, fonction );

     Créé une nouvelle commande WeeChat, associée à une fonction Perl.

     La fonction sera appelée lorsque l'utilisateur lancera la commande par /nom.

     Paramètres :

       - nom: nom de la nouvelle commande
          Il peut s'agir d'une commande existante, auquel cas celle-ci est écrasée par la fonction Perl. Soyez prudent en écrasant les commandes WeeChat, car elles ne seront plus accessibles tant que le script Perl sera chargé.

       - fonction: fonction Perl associée à la commande

     Exemple :

     IRC::add_command_handler ("commande", ma_commande);

     sub ma_commande

     {

         IRC::print("Paramètres : ".@_[0]);

         return 0;

     }

Scripts Python
==============

Non développé !

Scripts Ruby
============

Non développé !

Auteurs / Support
*****************

Auteurs
=======

WeeChat est développé par :

  * FlashCode <flashcode AT flashtux.org>

  * Bounga <bounga AT altern.org>

  * Xahlexx <xahlexx AT tuxfamily.org>

  * Crevetor <crevetor AT caramail.com>

Obtenir du support
==================

Avant de faire appel au support, merci de lire la documentation et la FAQ de WeeChat.

(la documentation est le document que vous êtes en train de lire, si vous n'avez pas tout lu jusqu'ici, il est encore temps de recommencer !)

  * Support par IRC:

     - serveur : irc.freenode.net

     - canal : #weechat

  * Forum WeeChat : bientôt !

  * Support par la liste de diffusion :

     - pour souscrire/désinscrire :
     http://mail.nongnu.org/mailman/listinfo/weechat-support.

     - pour envoyer un mail à la liste de diffusion, envoyer à :
     weechat-support@nongnu.org.

     Les archives de la liste de diffusion sont ici :

     http://mail.nongnu.org/archive/html/weechat-support

  * Voir la page support WeeChat pour plus de détails :

     http://weechat.flashtux.org/support.php