mirror of
https://github.com/weechat/weechat.git
synced 2026-06-29 14:26:39 +02:00
Update of english and french quickstart guides
This commit is contained in:
Sebastien Helleu
@@ -1,100 +1,163 @@
|
||||
WeeChat quick start guide (english version)
|
||||
=========================
|
||||
===========================================
|
||||
|
||||
1. Launch weechat
|
||||
|
||||
According to choosed GUI, you have to launch:
|
||||
- weechat-curses for Curses GUI
|
||||
- weechat-gtk for Gtk GUI (under development)
|
||||
- weechat-qt for Qt GUI (not developed)
|
||||
- weechat-wxwidgets for WxWidgets GUI (not developed)
|
||||
Run "weechat-curses" from your shell.
|
||||
|
||||
A recommended terminal emulator for X (but not mandatory) is rxvt-unicode
|
||||
(it has good UTF-8 support, and no problem with default keyboard bindings).
|
||||
|
||||
2. Online help / options
|
||||
|
||||
WeeChat has help for all commands, just issue /help
|
||||
To get help on a command, issue /help command
|
||||
|
||||
To set options, use /set option = value
|
||||
You can use /set option with partial name (display all options
|
||||
containg letters), or with only a full option name without value
|
||||
(to see long help for option).
|
||||
To set options, use /set config.section.option = value
|
||||
(where config is configuration name ("weechat" for core, or a plugin
|
||||
name), "section" the section of this configuration and "option" the
|
||||
option name).
|
||||
|
||||
Important note: settings are saved when WeeChat ends (or with "/save"
|
||||
command). Do NOT edit setup file while WeeChat is running, because WeeChat
|
||||
may write this file at any time, and it's not possible to reload it.
|
||||
To change any settings, use "/set" command, WeeChat immediately uses new
|
||||
settings.
|
||||
WeeChat immediately uses new value (you *never* need to restart WeeChat
|
||||
after changes to configuration).
|
||||
|
||||
3. Create a server
|
||||
You can use /set option with partial name and wildcard "*" at beginning or
|
||||
end to display all options containg letters.
|
||||
For example:
|
||||
/set => display all options (WeeChat and plugins)
|
||||
/set weechat.* => display WeeChat options
|
||||
/set irc.* => display IRC plugin options
|
||||
|
||||
For example irc.quakenet.org, port 6667:
|
||||
/server add quakenet irc.quakenet.org 6667
|
||||
(/help server for full command help)
|
||||
You can display help for an option with /help, for example:
|
||||
/help weechat.look.highlight
|
||||
|
||||
4. Set custom server options
|
||||
|
||||
Nicks:
|
||||
/set quakenet.server_nick1 = "mynick"
|
||||
/set quakenet.server_nick2 = "mynick2"
|
||||
/set quakenet.server_nick3 = "mynick3"
|
||||
All settings are saved when WeeChat ends (or with "/save" command to force
|
||||
write of options).
|
||||
|
||||
Username/realname:
|
||||
/set quakenet.server_username = "My username"
|
||||
/set quakenet.server_realname = "My real name"
|
||||
You can edit configuration files (*.conf) by hand and reload them by
|
||||
/reload command if you don't want to use /set command.
|
||||
|
||||
Auto-connect to server:
|
||||
/set quakenet.server_autoconnect = on
|
||||
3. Core vs plugins
|
||||
|
||||
Auto-join for some channels:
|
||||
/set quakenet.server_autojoin = "#chan1,#chan2"
|
||||
WeeChat "core" is only used to display data on screen and interact with
|
||||
user, that means weechat core without plugins is useless
|
||||
(faithful users: IRC was part of core for versions <= 0.2.6).
|
||||
|
||||
All network protocols like IRC are provided in separate plugins.
|
||||
|
||||
Use /plugin command to list loaded plugins, you should see "irc" and
|
||||
other plugins in list.
|
||||
|
||||
4. Create an IRC server
|
||||
|
||||
You can add an IRC server with /server command, for example:
|
||||
/server add oftc irc.oftc.org 6667
|
||||
|
||||
As usual, help is available if you're lost:
|
||||
/help server
|
||||
|
||||
5. Set custom IRC server options
|
||||
|
||||
WeeChat uses default values for all servers ("fallbacks"), if you
|
||||
don't specify a specific value for a server option.
|
||||
These default options are "irc.server_default.*".
|
||||
|
||||
For example there's default nicks (based on your un*x login), and you can
|
||||
override them for oftc server with following command:
|
||||
/set irc.server.oftc.nicks = "mynick1,mynick2,mynick3,mynick4,mynick5"
|
||||
|
||||
To set username and realname:
|
||||
/set irc.server.oftc.username = "My user name"
|
||||
/set irc.server.oftc.realname = "My real name"
|
||||
|
||||
To enable auto-connect to server at startup:
|
||||
/set irc.server.oftc.autoconnect = on
|
||||
|
||||
To auto-join some channels when connecting to server:
|
||||
/set irc.server.oftc.autojoin = "#channel1,#channel2"
|
||||
|
||||
Other options:
|
||||
You can see servers options and values with /set quakenet
|
||||
To set an option, use /set quakenet.server_option = value
|
||||
You can setup other options with following command:
|
||||
/set irc.server.oftc.xxx = value
|
||||
where "xxx" is option name - you can see all possible options with:
|
||||
/set irc.server_default.*
|
||||
|
||||
5. Connect to server and auto-join channels:
|
||||
6. Connect to IRC server and auto-join channels
|
||||
|
||||
/connect quakenet
|
||||
/connect oftc
|
||||
|
||||
6. Join/part channels
|
||||
Note: this command can be used to create and connect to a new server
|
||||
without using /server command (should I repeat you can see help for
|
||||
this command with /help connect ? ;)
|
||||
|
||||
7. Join/part IRC channels
|
||||
|
||||
Join a channel:
|
||||
/join #channel
|
||||
Part a channel:
|
||||
/part [quit message]
|
||||
Part a channel and close buffer:
|
||||
Close server or channel buffer:
|
||||
/close [quit message]
|
||||
(/close is an alias on /buffer close)
|
||||
|
||||
7. Buffer/window management
|
||||
8. Buffer/window management
|
||||
|
||||
A buffer is a component linked to a plugin with a number with a category
|
||||
and a name. Buffer contains data displayed on screen.
|
||||
|
||||
A window is a view on a buffer. By default there's only one window
|
||||
displaying one buffer. If you split screen, you will see many windows
|
||||
with many buffers at same time.
|
||||
|
||||
Commands to manage buffers and windows:
|
||||
/buffer
|
||||
/window
|
||||
(I'll not repeat here that you can get help with /help on these commands)
|
||||
|
||||
You can manage buffers with "/buffer" command and windows
|
||||
with "/window" command.
|
||||
For example, to split verticaly screen into a small window (1/3 width),
|
||||
and a large (2/3), use command:
|
||||
/window splitv 33
|
||||
|
||||
8. Key bindings
|
||||
9. Key bindings
|
||||
|
||||
WeeChat uses many keys by default. All these keys are in documentation,
|
||||
but you should know at least some vital keys:
|
||||
- alt + left/right arrows (or F5/F6): switch to previous/next buffer
|
||||
- F7/F8: switch to previous/next window (when screen is splited)
|
||||
- F9/F10: scroll title bar
|
||||
- F11/F12: scroll nicklist
|
||||
- tab: complete text in input bar, like in your shell
|
||||
- page up/down: scroll text in current buffer
|
||||
- alt + A: jump to buffer with activity (in hotlist)
|
||||
|
||||
According to your keyboard and/or your needs, you can rebind any key
|
||||
with "/key" command.
|
||||
to a command with "/key" command.
|
||||
A useful key is meta-k (alt-k) to find key codes.
|
||||
|
||||
For example, to bind meta-y (alt-y) to command "/buffer close":
|
||||
/key (press meta-k) (press meta-y) /buffer close
|
||||
You'll have a command line like:
|
||||
/key meta-y /buffer close
|
||||
To remove key:
|
||||
/key unbind meta-y
|
||||
|
||||
9. Plugins/scripts
|
||||
10. Plugins/scripts
|
||||
|
||||
On some distros like Debian, plugins are available via a separate package
|
||||
(like weechat-plugins).
|
||||
Plugins are automatically loaded when found.
|
||||
Many plugins/scripts are available for WeeChat, please look at:
|
||||
|
||||
Some plugins let you use scripts in WeeChat (in many languages like Perl,
|
||||
Python, Ruby and Lua). These plugins must be loaded with /plugin command
|
||||
and they provide commands like /perl, used to load scripts.
|
||||
|
||||
Many external plugins/scripts (from contributors) are available for
|
||||
WeeChat, please look at:
|
||||
http://weechat.flashtux.org/plugins.php
|
||||
|
||||
Please look at WeeChat documentation to load/unload plugins or scripts.
|
||||
|
||||
10. More documentation
|
||||
11. More documentation
|
||||
|
||||
You can now use WeeChat and read FAQ/documentation for any other question:
|
||||
http://weechat.flashtux.org/faq.php
|
||||
@@ -103,5 +166,6 @@ WeeChat quick start guide (english version)
|
||||
Enjoy WeeChat!
|
||||
|
||||
--
|
||||
(c) 2006-05-31, written by FlashCode <flashcode@flashtux.org>
|
||||
This document is part of WeeChat and is distributed under GPL licence.
|
||||
(c) 2006-2008, written by FlashCode <flashcode@flashtux.org>
|
||||
Last edited on 2008-08-30.
|
||||
This document is part of WeeChat and is distributed under GPL 3 licence.
|
||||
|
||||
@@ -1,63 +1,101 @@
|
||||
Guide de démarrage rapide WeeChat (version française)
|
||||
=================================
|
||||
Guide de démarrage rapide WeeChat (version française)
|
||||
=====================================================
|
||||
|
||||
1. Démarrer weechat
|
||||
1. Démarrer weechat
|
||||
|
||||
Selon l'interface choisie, vous devez lancer :
|
||||
- weechat-curses pour l'interface Curses
|
||||
- weechat-gtk pour l'interface Gtk (en développement)
|
||||
- weechat-qt pour l'interface Qt (non développée)
|
||||
- weechat-wxwidgets pour l'interface WxWidgets (non développée)
|
||||
Lancer "weechat-curses" depuis votre shell.
|
||||
|
||||
Un émulateur de terminal recommandé pour X (mais pas obligatoire) est
|
||||
rxvt-unicode (il a un bon support UTF-8, et aucun problème avec les
|
||||
touches par défaut).
|
||||
|
||||
2. Aide en ligne / options
|
||||
|
||||
WeeChat dispose d'aide pour toutes les commandes, tapez simplement /help
|
||||
Pour avoir de l'aide sur une commande, tapez /help commande
|
||||
|
||||
Pour modifier des options, utilisez /set option = valeur
|
||||
Vous pouvez utiliser /set avec un nom partiel d'option (affiche alors
|
||||
les options contenant ces lettres), ou avec un nom complet d'option
|
||||
sans valeur (pour voir l'aide complète de l'option).
|
||||
Pour modifier des options, utilisez /set config.section.option = valeur
|
||||
(où "config" est le nom de la configuration ("weechat" pour le coeur, ou
|
||||
un nom d'extension), "section" la section de cette configuration et
|
||||
"option" le nom de l'option).
|
||||
|
||||
Note importante: les options sont sauvées lorsque WeeChat quitte (ou avec
|
||||
la commande "/save"). N'éditez PAS le fichier de configuration pendant que
|
||||
WeeChat tourne, car WeeChat peut écrire ce fichier à tout moment, et il
|
||||
n'est pas possible de le recharger.
|
||||
Pour changer toute option, utilisez la commande "/set", WeeChat prend en
|
||||
compte immédiatement les nouvelles valeurs.
|
||||
WeeChat utilise immédiatement la nouvelle valeur (vous n'avez *jamais*
|
||||
besoin de redémarrer WeeChat après avoir changé la configuration).
|
||||
|
||||
3. Créer un serveur
|
||||
Vous pouvez utiliser /set avec un nom partiel d'option et le caractère
|
||||
joker "*" au début ou à la fin pour afficher toutes les options contenant
|
||||
ces lettres.
|
||||
Par exemple :
|
||||
/set => affiche toutes les options (WeeChat et extensions)
|
||||
/set weechat.* => affiche les options WeeChat
|
||||
/set irc.* => affiche les options de l'extension IRC
|
||||
|
||||
Par exemple irc.quakenet.org, port 6667:
|
||||
/server add quakenet irc.quakenet.org 6667
|
||||
(/help server pour l'aide complète sur la commande)
|
||||
Vous pouvez afficher de l'aide sur une option avec /help, par exemple :
|
||||
/help weechat.look.highlight
|
||||
|
||||
4. Définir les options du serveur
|
||||
|
||||
Pseudos :
|
||||
/set quakenet.server_nick1 = "mynick"
|
||||
/set quakenet.server_nick2 = "mynick2"
|
||||
/set quakenet.server_nick3 = "mynick3"
|
||||
Toutes les options sont sauvées quand WeeChat quitte (ou avec la commande
|
||||
"/save" pour forcer une écriture des options).
|
||||
|
||||
Nom d'utilisateur/réel :
|
||||
/set quakenet.server_username = "Mon nom d'utilisateur"
|
||||
/set quakenet.server_realname = "Mon nom réel"
|
||||
Vous pouvez éditer les fichiers de configuration (*.conf) à la main et les
|
||||
recharger par la commande /reload si vous ne souhaitez pas utiliser la
|
||||
commande /set.
|
||||
|
||||
Connexion auto au serveur :
|
||||
/set quakenet.server_autoconnect = on
|
||||
3. Coeur vs extensions
|
||||
|
||||
Rejoindre automatiquement des canaux :
|
||||
/set quakenet.server_autojoin = "#canal1,#canal2"
|
||||
Le coeur de WeeChat ("core") ne fait qu'afficher les données à l'écran et
|
||||
interagir avec l'utilisateur, cela signifie que le coeur sans extension
|
||||
n'a pas grand intérêt (utilisateurs fidèles: IRC faisait partie du coeur
|
||||
dans les versions <= 0.2.6).
|
||||
|
||||
Tous les protocoles réseau comme IRC sont fournis sous forme d'extensions.
|
||||
|
||||
Utilisez la commande /plugin pour voir les extensions chargées, vous
|
||||
devriez voir "irc" et d'autres extensions dans cette liste.
|
||||
|
||||
4. Créer un serveur IRC
|
||||
|
||||
Vous pouvez ajouter un serveur IRC par la commande /server, par exemple :
|
||||
/server add oftc irc.oftc.org 6667
|
||||
|
||||
Comme d'habitude, de l'aide est disponible si vous êtes perdus :
|
||||
/help server
|
||||
|
||||
5. Définir les options du serveur IRC
|
||||
|
||||
WeeChat utilise des valeurs par défaut pour tous les serveurs, si vous ne
|
||||
spécifiez pas de valeur spécifique pour une option de serveur.
|
||||
Ces options par défaut sont "irc.server_default.*".
|
||||
|
||||
Par exemple il y a des pseudos par défaut (basés sur votre login un*x), et
|
||||
vous pouvez les écraser pour le serveur oftc avec la commande suivante :
|
||||
/set irc.server.oftc.nicks = "pseudo1,pseudo2,pseudo3,pseudo4,pseudo5"
|
||||
|
||||
Pour modifier le nom d'utilisateur et nom réel :
|
||||
/set irc.server.oftc.username = "Mon nom d'utilisateur"
|
||||
/set irc.server.oftc.realname = "Mon nom réel"
|
||||
|
||||
Pour activer la connexion automatique au serveur lors du démarrage :
|
||||
/set irc.server.oftc.autoconnect = on
|
||||
|
||||
Pour rejoindre automatiquement des canaux lors de la connexion au serveur :
|
||||
/set irc.server.oftc.autojoin = "#canal1,#canal2"
|
||||
|
||||
Autres options :
|
||||
Vous pouvez voir les options du serveur et les valeurs avec /set quakenet
|
||||
Pour modifier une option, utilisez /set quakenet.server_option = valeur
|
||||
Vous pouvez modifier les autres options avec la commande suivante :
|
||||
/set irc.server.oftc.xxx = valeur
|
||||
où "xxx" est le nom d'une option - vous pouvez vois les options possibles
|
||||
avec :
|
||||
/set irc.server_default.*
|
||||
|
||||
5. Se connecter au serveur et rejoindre les canaux
|
||||
6. Se connecter au serveur IRC et rejoindre les canaux
|
||||
|
||||
/connect quakenet
|
||||
/connect oftc
|
||||
|
||||
6. Rejoindre/quitter les canaux
|
||||
Note : cette commande peut aussi être utilisée pour créer et se connecter
|
||||
au serveur sans utiliser la commande /server (devrais-je répéter que vous
|
||||
pouvez voir l'aide pour cette commande avec /help connect ? ;)
|
||||
|
||||
7. Joindre/quitter les canaux IRC
|
||||
|
||||
Joindre un canal :
|
||||
/join #channel
|
||||
@@ -67,36 +105,68 @@ Guide de d
|
||||
/close [message de fin]
|
||||
(/close est un alias sur /buffer close)
|
||||
|
||||
7. Gérer les tampons/fenêtres
|
||||
8. Gérer les tampons/fenêtres
|
||||
|
||||
Vous pouvez gérer les tampons avec la commande "/buffer" et les fenêtres
|
||||
avec la commande "/window".
|
||||
Par exemple, pour découper verticalement l'écran en une petite fenêtre
|
||||
(1/3 de la largeur) et une large (2/3 de la largeur), utilisez la commande
|
||||
Un tampon ("buffer") est un composant lié à une extension, avec une
|
||||
catégorie et un nom. Le tampon contient les données affichées à l'écran.
|
||||
|
||||
Une fenêtre ("window") est une vue sur un tampon. Par défaut il n'y a
|
||||
qu'une fenêtre affichant un tampon. Si vous divisez l'écran, vous verrez
|
||||
alors plusieurs fenêtres avec plusieurs tampons en même temps.
|
||||
|
||||
Commandes pour gérer les tampons et les fenêtres :
|
||||
/buffer
|
||||
/window
|
||||
(je ne répéterai pas que vous pouvez avoir de l'aide sur ces commandes
|
||||
avec /help)
|
||||
|
||||
Par exemple, pour découper verticalement l'écran en une petite fenêtre
|
||||
(1/3 de la largeur) et une large (2/3), utilisez la commande :
|
||||
/window splitv 33
|
||||
|
||||
8. Gérer les raccourcis clavier
|
||||
9. Raccourcis clavier
|
||||
|
||||
Selon votre clavier et vos besoins, vous pouvez associer n'importe quelle
|
||||
touche à une commande avec la commande "/key".
|
||||
WeeChat utilise un certain nombre de touches par défaut. Toutes ces
|
||||
touches sont dans la documentation, mais vous devriez connaître au moins
|
||||
les touches vitales :
|
||||
- alt + flèches gauche/droite (ou F5/F6): aller au tampon précédent/suivant
|
||||
- F7/F8: aller à la fenêtre précédente/suivante (quand l'écran est divisé)
|
||||
- F9/F10: faire défiler la barre de titre
|
||||
- F11/F12: faire défiler la liste des pseudos
|
||||
- tab: compléter le texte de la barre d'entrée, comme avec votre shell
|
||||
- page préc/suiv: faire défiler le texte dans le tampon courant
|
||||
- alt + A: sauter au tampon avec de l'activité (dans la "hotlist")
|
||||
|
||||
Selon votre clavier et/ou vos besoins, vous pouvez associer n'importe
|
||||
quelle touche à une commande avec la commande "/key".
|
||||
Une touche utile est meta-k (alt-k) pour trouver le code des touches.
|
||||
|
||||
Par exemple, pour associer meta-y (alt-y) à la commande "/buffer close" :
|
||||
Par exemple, pour associer meta-y (alt-y) à la commande "/buffer close" :
|
||||
/key (pressez meta-k) (pressez meta-y) /buffer close
|
||||
Vous aurez une ligne de commande qui ressemble à ceci :
|
||||
Vous aurez une ligne de commande qui ressemble à ceci :
|
||||
/key meta-y /buffer close
|
||||
Pour enlever la touche :
|
||||
/key unbind meta-y
|
||||
|
||||
9. Extensions/scripts
|
||||
10. Extensions/scripts
|
||||
|
||||
Sur certaines distributions comme Debian, les extensions sont disponibles
|
||||
via un paquet séparé (par exemple weechat-plugins).
|
||||
Les extensions sont automatiquement chargées lorsqu'elles sont trouvées.
|
||||
Plusieurs extensions/scripts sont disponibles pour WeeChat, voir ici :
|
||||
via un paquet séparé (par exemple weechat-plugins).
|
||||
Les extensions sont automatiquement chargées lorsqu'elles sont trouvées.
|
||||
|
||||
Des extensions permettent d'utiliser des scripts dans WeeChat (dans
|
||||
différent langages comme Perl, Python, Ruby et Lua). Ces extensions
|
||||
doivent être chargées avec la commande /plugin et elles fournissent des
|
||||
commandes telles que /perl, utilisées pour charger les scripts.
|
||||
|
||||
Plusieurs extensions/scripts (de contributeurs) sont disponibles pour
|
||||
WeeChat, voir ici :
|
||||
http://weechat.flashtux.org/plugins.php
|
||||
Merci de regarder la documentation WeeChat pour charger/décharger des
|
||||
|
||||
Merci de regarder la documentation WeeChat pour charger/décharger des
|
||||
extensions ou des scripts.
|
||||
|
||||
10. Plus de documentation
|
||||
11. Plus de documentation
|
||||
|
||||
Vous pouvez maintenant utiliser WeeChat et lire la FAQ/documentation pour
|
||||
toute autre question :
|
||||
@@ -106,5 +176,6 @@ Guide de d
|
||||
Bon WeeChat !
|
||||
|
||||
--
|
||||
(c) 2006-05-31, écrit par FlashCode <flashcode@flashtux.org>
|
||||
Ce document fait partie de WeeChat et est distribué sous license GPL.
|
||||
(c) 2006-2008, écrit par FlashCode <flashcode@flashtux.org>
|
||||
Dernière édition le 30/08/2008.
|
||||
Ce document fait partie de WeeChat et est distribué sous license GPL 3.
|
||||
|
||||
Reference in New Issue
Block a user