mirror of
https://github.com/weechat/weechat.git
synced 2026-06-30 23:06:38 +02:00
Added quickstart guide
This commit is contained in:
Sebastien Helleu
+3
-1
@@ -18,8 +18,9 @@
|
||||
LANGCODE = en
|
||||
BOOK = weechat.$(LANGCODE)
|
||||
BOOK_INCLUDE = weechat_commands.xml irc_commands.xml key_functions.xml config.xml
|
||||
QUICKSTART = weechat_quickstart.en.txt
|
||||
|
||||
EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE)
|
||||
EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE) $(QUICKSTART)
|
||||
|
||||
docdir = $(datadir)/doc/$(PACKAGE)
|
||||
|
||||
@@ -52,6 +53,7 @@ html1-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html-one.xsl ../weechat-doc.
|
||||
install-data-hook:
|
||||
$(mkinstalldirs) $(DESTDIR)$(docdir)/html/$(LANGCODE)/
|
||||
$(INSTALL_DATA) html/* $(DESTDIR)$(docdir)/html/$(LANGCODE)/
|
||||
$(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/
|
||||
|
||||
# clean
|
||||
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
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)
|
||||
|
||||
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).
|
||||
|
||||
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.
|
||||
|
||||
3. Create a server
|
||||
|
||||
For example irc.quakenet.org, port 6667:
|
||||
/server quakenet irc.quakenet.org 6667
|
||||
(/help server for full command help)
|
||||
|
||||
4. Set custom server options
|
||||
|
||||
Nicks:
|
||||
/set quakenet.server_nick1 = "mynick"
|
||||
/set quakenet.server_nick2 = "mynick2"
|
||||
/set quakenet.server_nick3 = "mynick3"
|
||||
|
||||
Username/realname:
|
||||
/set quakenet.server_username = "My username"
|
||||
/set quakenet.server_realname = "My real name"
|
||||
|
||||
Auto-connect to server:
|
||||
/set quakenet.server_autoconnect = on
|
||||
|
||||
Auto-join for some channels:
|
||||
/set quakenet.server_autojoin = "#chan1,#chan2"
|
||||
|
||||
Other options:
|
||||
You can see servers options and values with /set quakenet
|
||||
To set an option, use /set quakenet.server_option = value
|
||||
|
||||
5. Connect to server and auto-join channels:
|
||||
|
||||
/connect quakenet
|
||||
|
||||
6. Join/part channels
|
||||
|
||||
Join a channel:
|
||||
/join #channel
|
||||
Part a channel:
|
||||
/part [quit message]
|
||||
Part a channel and close buffer:
|
||||
/close [quit message]
|
||||
(/close is an alias on /buffer close)
|
||||
|
||||
7. Buffer/window management
|
||||
|
||||
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
|
||||
|
||||
According to your keyboard and/or your needs, you can rebind any key
|
||||
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
|
||||
|
||||
9. 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:
|
||||
http://weechat.flashtux.org/plugins.php
|
||||
Please look at WeeChat documentation to load/unload plugins or scripts.
|
||||
|
||||
10. More documentation
|
||||
|
||||
You can now use WeeChat and read FAQ/documentation for any other question:
|
||||
http://weechat.flashtux.org/faq.php
|
||||
http://weechat.flashtux.org/doc.php
|
||||
|
||||
Enjoy WeeChat!
|
||||
|
||||
--
|
||||
(c) 2006-05-31, written by FlashCode <flashcode@flashtux.org>
|
||||
This document is part of WeeChat and is distributed under GPL licence.
|
||||
+3
-1
@@ -18,8 +18,9 @@
|
||||
LANGCODE = fr
|
||||
BOOK = weechat.$(LANGCODE)
|
||||
BOOK_INCLUDE = weechat_commands.xml irc_commands.xml key_functions.xml config.xml
|
||||
QUICKSTART = weechat_quickstart.fr.txt
|
||||
|
||||
EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE)
|
||||
EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE) $(QUICKSTART)
|
||||
|
||||
docdir = $(datadir)/doc/$(PACKAGE)
|
||||
|
||||
@@ -52,6 +53,7 @@ html1-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html-one.xsl ../weechat-doc.
|
||||
install-data-hook:
|
||||
$(mkinstalldirs) $(DESTDIR)$(docdir)/html/$(LANGCODE)/
|
||||
$(INSTALL_DATA) html/* $(DESTDIR)$(docdir)/html/$(LANGCODE)/
|
||||
$(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/
|
||||
|
||||
# clean
|
||||
|
||||
|
||||
@@ -0,0 +1,110 @@
|
||||
Guide de démarrage rapide WeeChat (version française)
|
||||
=================================
|
||||
|
||||
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)
|
||||
|
||||
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).
|
||||
|
||||
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.
|
||||
|
||||
3. Créer un serveur
|
||||
|
||||
Par exemple irc.quakenet.org, port 6667:
|
||||
/server quakenet irc.quakenet.org 6667
|
||||
(/help server pour l'aide complète sur la commande)
|
||||
|
||||
4. Définir les options du serveur
|
||||
|
||||
Pseudos :
|
||||
/set quakenet.server_nick1 = "mynick"
|
||||
/set quakenet.server_nick2 = "mynick2"
|
||||
/set quakenet.server_nick3 = "mynick3"
|
||||
|
||||
Nom d'utilisateur/réel :
|
||||
/set quakenet.server_username = "Mon nom d'utilisateur"
|
||||
/set quakenet.server_realname = "Mon nom réel"
|
||||
|
||||
Connexion auto au serveur :
|
||||
/set quakenet.server_autoconnect = on
|
||||
|
||||
Rejoindre automatiquement des canaux :
|
||||
/set quakenet.server_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
|
||||
|
||||
5. Se connecter au serveur et rejoindre les canaux :
|
||||
|
||||
/connect quakenet
|
||||
|
||||
6. Rejoindre/quittre les canaux
|
||||
|
||||
Joindre un canal :
|
||||
/join #channel
|
||||
Quitter un canal :
|
||||
/part [message de fin]
|
||||
Quitter un canal et fermer le tampon :
|
||||
/close [message de fin]
|
||||
(/close est un alias sur /buffer close)
|
||||
|
||||
7. 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
|
||||
/window splitv 33
|
||||
|
||||
8. Gérer les raccourcis clavier
|
||||
|
||||
Selon votre clavier et 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" :
|
||||
/key (pressez meta-k) (pressez meta-y) /buffer close
|
||||
Vous aurez une ligne de commande qui ressemble à ceci :
|
||||
/key meta-y /buffer close
|
||||
|
||||
9. 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 :
|
||||
http://weechat.flashtux.org/plugins.php
|
||||
Merci de regarder la documentation WeeChat pour charger/décharget des
|
||||
extensions ou des scripts.
|
||||
|
||||
10. Plus de documentation
|
||||
|
||||
Vous pouvez maintenant utiliser WeeChat et lire la FAQ/documentation pour
|
||||
toute autre question :
|
||||
http://weechat.flashtux.org/faq.php
|
||||
http://weechat.flashtux.org/doc.php
|
||||
|
||||
Bon WeeChat !
|
||||
|
||||
--
|
||||
(c) 2006-05-31, écrit par FlashCode <flashcode@flashtux.org>
|
||||
Ce document fait partie de WeeChat et est distribué sous license GPL.
|
||||
@@ -18,8 +18,9 @@
|
||||
LANGCODE = en
|
||||
BOOK = weechat.$(LANGCODE)
|
||||
BOOK_INCLUDE = weechat_commands.xml irc_commands.xml key_functions.xml config.xml
|
||||
QUICKSTART = weechat_quickstart.en.txt
|
||||
|
||||
EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE)
|
||||
EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE) $(QUICKSTART)
|
||||
|
||||
docdir = $(datadir)/doc/$(PACKAGE)
|
||||
|
||||
@@ -52,6 +53,7 @@ html1-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html-one.xsl ../weechat-doc.
|
||||
install-data-hook:
|
||||
$(mkinstalldirs) $(DESTDIR)$(docdir)/html/$(LANGCODE)/
|
||||
$(INSTALL_DATA) html/* $(DESTDIR)$(docdir)/html/$(LANGCODE)/
|
||||
$(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/
|
||||
|
||||
# clean
|
||||
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
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)
|
||||
|
||||
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).
|
||||
|
||||
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.
|
||||
|
||||
3. Create a server
|
||||
|
||||
For example irc.quakenet.org, port 6667:
|
||||
/server quakenet irc.quakenet.org 6667
|
||||
(/help server for full command help)
|
||||
|
||||
4. Set custom server options
|
||||
|
||||
Nicks:
|
||||
/set quakenet.server_nick1 = "mynick"
|
||||
/set quakenet.server_nick2 = "mynick2"
|
||||
/set quakenet.server_nick3 = "mynick3"
|
||||
|
||||
Username/realname:
|
||||
/set quakenet.server_username = "My username"
|
||||
/set quakenet.server_realname = "My real name"
|
||||
|
||||
Auto-connect to server:
|
||||
/set quakenet.server_autoconnect = on
|
||||
|
||||
Auto-join for some channels:
|
||||
/set quakenet.server_autojoin = "#chan1,#chan2"
|
||||
|
||||
Other options:
|
||||
You can see servers options and values with /set quakenet
|
||||
To set an option, use /set quakenet.server_option = value
|
||||
|
||||
5. Connect to server and auto-join channels:
|
||||
|
||||
/connect quakenet
|
||||
|
||||
6. Join/part channels
|
||||
|
||||
Join a channel:
|
||||
/join #channel
|
||||
Part a channel:
|
||||
/part [quit message]
|
||||
Part a channel and close buffer:
|
||||
/close [quit message]
|
||||
(/close is an alias on /buffer close)
|
||||
|
||||
7. Buffer/window management
|
||||
|
||||
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
|
||||
|
||||
According to your keyboard and/or your needs, you can rebind any key
|
||||
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
|
||||
|
||||
9. 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:
|
||||
http://weechat.flashtux.org/plugins.php
|
||||
Please look at WeeChat documentation to load/unload plugins or scripts.
|
||||
|
||||
10. More documentation
|
||||
|
||||
You can now use WeeChat and read FAQ/documentation for any other question:
|
||||
http://weechat.flashtux.org/faq.php
|
||||
http://weechat.flashtux.org/doc.php
|
||||
|
||||
Enjoy WeeChat!
|
||||
|
||||
--
|
||||
(c) 2006-05-31, written by FlashCode <flashcode@flashtux.org>
|
||||
This document is part of WeeChat and is distributed under GPL licence.
|
||||
@@ -18,8 +18,9 @@
|
||||
LANGCODE = fr
|
||||
BOOK = weechat.$(LANGCODE)
|
||||
BOOK_INCLUDE = weechat_commands.xml irc_commands.xml key_functions.xml config.xml
|
||||
QUICKSTART = weechat_quickstart.fr.txt
|
||||
|
||||
EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE)
|
||||
EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE) $(QUICKSTART)
|
||||
|
||||
docdir = $(datadir)/doc/$(PACKAGE)
|
||||
|
||||
@@ -52,6 +53,7 @@ html1-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html-one.xsl ../weechat-doc.
|
||||
install-data-hook:
|
||||
$(mkinstalldirs) $(DESTDIR)$(docdir)/html/$(LANGCODE)/
|
||||
$(INSTALL_DATA) html/* $(DESTDIR)$(docdir)/html/$(LANGCODE)/
|
||||
$(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/
|
||||
|
||||
# clean
|
||||
|
||||
|
||||
@@ -0,0 +1,110 @@
|
||||
Guide de démarrage rapide WeeChat (version française)
|
||||
=================================
|
||||
|
||||
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)
|
||||
|
||||
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).
|
||||
|
||||
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.
|
||||
|
||||
3. Créer un serveur
|
||||
|
||||
Par exemple irc.quakenet.org, port 6667:
|
||||
/server quakenet irc.quakenet.org 6667
|
||||
(/help server pour l'aide complète sur la commande)
|
||||
|
||||
4. Définir les options du serveur
|
||||
|
||||
Pseudos :
|
||||
/set quakenet.server_nick1 = "mynick"
|
||||
/set quakenet.server_nick2 = "mynick2"
|
||||
/set quakenet.server_nick3 = "mynick3"
|
||||
|
||||
Nom d'utilisateur/réel :
|
||||
/set quakenet.server_username = "Mon nom d'utilisateur"
|
||||
/set quakenet.server_realname = "Mon nom réel"
|
||||
|
||||
Connexion auto au serveur :
|
||||
/set quakenet.server_autoconnect = on
|
||||
|
||||
Rejoindre automatiquement des canaux :
|
||||
/set quakenet.server_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
|
||||
|
||||
5. Se connecter au serveur et rejoindre les canaux :
|
||||
|
||||
/connect quakenet
|
||||
|
||||
6. Rejoindre/quittre les canaux
|
||||
|
||||
Joindre un canal :
|
||||
/join #channel
|
||||
Quitter un canal :
|
||||
/part [message de fin]
|
||||
Quitter un canal et fermer le tampon :
|
||||
/close [message de fin]
|
||||
(/close est un alias sur /buffer close)
|
||||
|
||||
7. 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
|
||||
/window splitv 33
|
||||
|
||||
8. Gérer les raccourcis clavier
|
||||
|
||||
Selon votre clavier et 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" :
|
||||
/key (pressez meta-k) (pressez meta-y) /buffer close
|
||||
Vous aurez une ligne de commande qui ressemble à ceci :
|
||||
/key meta-y /buffer close
|
||||
|
||||
9. 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 :
|
||||
http://weechat.flashtux.org/plugins.php
|
||||
Merci de regarder la documentation WeeChat pour charger/décharget des
|
||||
extensions ou des scripts.
|
||||
|
||||
10. Plus de documentation
|
||||
|
||||
Vous pouvez maintenant utiliser WeeChat et lire la FAQ/documentation pour
|
||||
toute autre question :
|
||||
http://weechat.flashtux.org/faq.php
|
||||
http://weechat.flashtux.org/doc.php
|
||||
|
||||
Bon WeeChat !
|
||||
|
||||
--
|
||||
(c) 2006-05-31, écrit par FlashCode <flashcode@flashtux.org>
|
||||
Ce document fait partie de WeeChat et est distribué sous license GPL.
|
||||
Reference in New Issue
Block a user