diff options
author | Sebastien Helleu <flashcode@flashtux.org> | 2005-03-20 07:22:53 +0000 |
---|---|---|
committer | Sebastien Helleu <flashcode@flashtux.org> | 2005-03-20 07:22:53 +0000 |
commit | f5074da15653f0133b63b0478b32dc2753ece2db (patch) | |
tree | da5c08e597616c4476e2e9604f9f0b312410bbbc /doc | |
parent | a23af790dfabecf304c017eb91c09cbdb13ae3fe (diff) | |
download | weechat-f5074da15653f0133b63b0478b32dc2753ece2db.zip |
Version 0.1.1
Diffstat (limited to 'doc')
-rw-r--r-- | doc/weechat_doc_en.texi | 80 | ||||
-rw-r--r-- | doc/weechat_doc_es.texi | 83 | ||||
-rw-r--r-- | doc/weechat_doc_fr.texi | 88 | ||||
-rw-r--r-- | doc/weechat_doc_pt.texi | 48 | ||||
-rw-r--r-- | doc/weechat_image.pdf | bin | 15499 -> 44778 bytes |
5 files changed, 286 insertions, 13 deletions
diff --git a/doc/weechat_doc_en.texi b/doc/weechat_doc_en.texi index 2b0a63a1c..e77362408 100644 --- a/doc/weechat_doc_en.texi +++ b/doc/weechat_doc_en.texi @@ -35,7 +35,7 @@ @title WeeChat - User guide @subtitle Fast, light and extensible IRC client -@subtitle Documentation for WeeChat v0.1.1-cvs - March, 11 2005 +@subtitle Documentation for WeeChat v0.1.1 - March, 20 2005 @image{weechat_image} @@ -209,6 +209,7 @@ Then follow instructions for source package - @xref{Source package}. * Config file::
* Key bindings::
* WeeChat commands:: +* FIFO pipe:: @end menu @node Run WeeChat, Config file, Usage, Usage @@ -487,7 +488,7 @@ Default quit message ('%v' will be replaced by WeeChat version in string)@* Type: string (any string), default value: 'WeeChat %v'@* @item irc_away_check Interval between two checks for away (in minutes, 0 = never check)@* -Type: integer (values: between 0 and 2147483647), default value: 1@* +Type: integer (values: between 0 and 2147483647), default value: 0@* @item irc_lag_check Interval between two checks for lag (in seconds)@* Type: integer (values: between 30 and 2147483647), default value: 60@* @@ -693,7 +694,7 @@ Switch to buffer by number@* @* @end table -@node WeeChat commands, , Key bindings, Usage +@node WeeChat commands, FIFO pipe, Key bindings, Usage @section WeeChat commands WeeChat internal commands:@* @@ -818,6 +819,13 @@ toggle away status@* -all: toggle away status on all connected servers@* message: message for away (if no message is given, away status is removed)@* @* +@item ban [channel] [nickname [nickname ...]] +@* +bans nicks or hosts@* +@* +channel: channel for ban@* +nickname: user or host to ban@* +@* @item ctcp nickname type @* send a ctcp message@* @@ -833,6 +841,10 @@ action: 'send' (file) or 'chat' or 'close' (chat)@* nickname: nickname to send file or chat@* file: filename (on local host)@* @* +@item dehalfop nickname [nickname] +@* +removes half channel operator status from nickname(s)@* +@* @item deop nickname [nickname] @* removes channel operator status from nickname(s)@* @@ -845,6 +857,10 @@ removes voice from nickname(s)@* @* shutdown the server@* @* +@item halfop nickname [nickname] +@* +gives half channel operator status to nickname(s)@* +@* @item info [target] @* get information describing the server@* @@ -879,6 +895,14 @@ channel: channel where user is@* nickname: nickname to kick@* comment: comment for kick@* @* +@item kickban [channel] nickname [comment] +@* +kicks and bans a nick from a channel@* +@* +channel: channel where user is@* +nickname: nickname to kick and ban@* +comment: comment for kick@* +@* @item kill nickname comment @* close client-server connection@* @@ -1089,6 +1113,13 @@ find the route to specific server@* @* target: server@* @* +@item unban [channel] nickname [nickname ...] +@* +unbans nicks or hosts@* +@* +channel: channel for unban@* +nickname: user or host to unban@* +@* @item userhost nickname [nickname ...] @* return a list of information about nicknames@* @@ -1143,6 +1174,49 @@ target: reply should match this mask@* @end table +@node FIFO pipe, , WeeChat commands, Usage +@section FIFO pipe + +You can remote control WeeChat, by sending commands or text to a FIFO pipe +(you have to enable option "irc_fifo_pipe", it is disabled by default).@* +The FIFO pipe is located in ~/.weechat/ and is called "weechat_fifo_xxxxx" +(where xxxxx is the process ID (PID) of running WeeChat).@* +So if many WeeChat are running, you have many FIFO pipe, one for each session.@* +@* +The syntax for the FIFO pipe commands/text is:@* +@command{server,channel *text or command here}@* +where server and channel are optional, but if channel is here, server should be too.@* +@* +Some examples: +@table @asis +@item @bullet{} change your nick on freenode to "mynick|out": +@* +@command{echo "freenode */nick mynick|out" >~/.weechat/weechat_fifo_12345} +@item @bullet{} display text on #weechat channel: +@* +@command{echo "freenode,#weechat *hello everybody!" >~/.weechat/weechat_fifo_12345} +@item @bullet{} display text on current channel (buffer displayed by WeeChat): +@* +@command{echo "*hello!" >~/.weechat/weechat_fifo_12345}@* +@* +@b{Warning:} this is dangerous and you should not do that except if you know what you do! +@item @bullet{} send 2 commands to unload/reload Perl scripts (you have to separate them with \n): +@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} +@end table +@* +You can write a script to send command to all running WeeChat at same time, for example:@* +@verbatim + #!/bin/sh + if [ $# -eq 1 ]; then + for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do + echo -e "$1" >$fifo + done + fi +@end verbatim +@* +If the script is called "auto_weechat_command", you can run it with:@* +@command{./auto_weechat_command "freenode,#weechat *hello"} + @c ******************************* Extensions ********************************* diff --git a/doc/weechat_doc_es.texi b/doc/weechat_doc_es.texi index 1069ab7a3..69ac58d2a 100644 --- a/doc/weechat_doc_es.texi +++ b/doc/weechat_doc_es.texi @@ -35,7 +35,7 @@ @title WeeChat - Gui@'on de usuario. @subtitle Cliente IRC r@'apido, peque@~no y extensible -@subtitle Documentaci@'on para WeeChat v0.1.1-cvs - 11 de marzo de 2005 +@subtitle Documentaci@'on para WeeChat v0.1.1 - 20 de marzo de 2005 @image{weechat_image} @@ -210,6 +210,7 @@ Luego, lee las instructiones para Paquetes de fuentes - @xref{Paquetes de fuente * Ficheros de configuracion:: * Atajos de teclado:: * Comandos WeeChat:: +* FIFO pipe:: @end menu @node Iniciar WeeChat, Ficheros de configuracion, Uso, Uso @@ -486,7 +487,7 @@ Mensaje de fin por defecto ('%v' ser@'a reemplazado por la versi@'on de WeeChat Typo: cadena (cualquier cadena), valor por defecto: 'WeeChat %v'@* @item irc_away_check Intervalo entre dos comprobaciones de ausencia (en minutos, 0 = no comprobar)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 1@* +Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 0@* @item irc_lag_check Intervalo entre dos medidas de lag (en segundos)@* Typo: entero (valores: entre 30 y 2147483647), valor por defecto: 60@* @@ -496,6 +497,9 @@ Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 1@* @item irc_lag_disconnect Desconexi@'on tras un lag importante (en minutos, 0 = no desconectar nunca)@* Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 5@* +@item irc_fifo_pipe +Create a FIFO pipe for remote control@* +Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* @item dcc_auto_accept_files Aceptar autom@'aticamente los ficheros dcc entrantes@* Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* @@ -693,7 +697,7 @@ Saltar a la memoria temporal con ese n@'umero@* @* @end table -@node Comandos WeeChat, , Atajos de teclado, Uso +@node Comandos WeeChat, FIFO pipe, Atajos de teclado, Uso @section Comandos WeeChat Comandos internos WeeChat:@* @@ -818,6 +822,13 @@ revertir el estado ausente@* -all: revertir el estado ausente en todos los servidores conectados@* mensaje: mensaje para el estado ausente (si no se da ningún mensaje, se elimina el estado ausente)@* @* +@item ban [canal] [usariio [usuario ...]] +@* +bans nicks or hosts@* +@* +channel: channel for ban@* +nickname: user or host to ban@* +@* @item ctcp usuario tipo @* enviar un mensaje ctcp@* @@ -833,6 +844,10 @@ acci@'on: 'send' (env@'io de archivo) @'o 'chat' (charla) @'o 'close' (cerrar ch usuario: nombre de usuario a quien enviar el archivo o la charla@* fichero: nombre del fichero (en la m@'aquina local)@* @* +@item dehalfop pseudo [pseudo] +@* +elimina el estado de media operador de canal a/a los usuario(s)@* +@* @item deop pseudo [pseudo] @* elimina el estado de operador de canal a/a los usuario(s)@* @@ -845,6 +860,10 @@ elimina la voz a/a los usuario(s)@* @* cerrar el servidor@* @* +@item halfop pseudo [pseudo] +@* +dar el estado de media operador de canal a/a los usuario(s)@* +@* @item info [target] @* obtener informaci@'on describiendo al servidor@* @@ -879,6 +898,14 @@ canal: canal en el que est@'a el usuario@* usuario: usuario a expulsar@* comentario: comentario para la expulsi@'on@* @* +@item kickban [canal] usuario [comentario] +@* +kicks and bans a nick from a channel@* +@* +channel: channel where user is@* +nickname: nickname to kick and ban@* +comment: comment for kick@* +@* @item kill usuario comentario @* cerrar la conexi@'on cliente-servidor@* @@ -1089,6 +1116,13 @@ encontrar la ruta hacia el servidor especificado@* @* target: servidor objetivo@* @* +@item unban [canal] usuario [usuario ...] +@* +unbans nicks or hosts@* +@* +channel: channel for unban@* +nickname: user or host to unban@* +@* @item userhost usuario [usuario ...] @* devuelve una lista de informaci@'on sobre usuarios@* @@ -1143,6 +1177,49 @@ destinatario: la respuesta deber@'ia concordar con esta m@'ascara@* @end table +@node FIFO pipe, , Comandos WeeChat, Uso +@section FIFO pipe + +You can remote control WeeChat, by sending commands or text to a FIFO pipe +(you have to enable option "irc_fifo_pipe", it is disabled by default).@* +The FIFO pipe is located in ~/.weechat/ and is called "weechat_fifo_xxxxx" +(where xxxxx is the process ID (PID) of running WeeChat).@* +So if many WeeChat are running, you have many FIFO pipe, one for each session.@* +@* +The syntax for the FIFO pipe commands/text is:@* +@command{server,channel *text or command here}@* +where server and channel are optional, but if channel is here, server should be too.@* +@* +Some examples: +@table @asis +@item @bullet{} change your nick on freenode to "mynick|out": +@* +@command{echo "freenode */nick mynick|out" >~/.weechat/weechat_fifo_12345} +@item @bullet{} display text on #weechat channel: +@* +@command{echo "freenode,#weechat *hello everybody!" >~/.weechat/weechat_fifo_12345} +@item @bullet{} display text on current channel (buffer displayed by WeeChat): +@* +@command{echo "*hello!" >~/.weechat/weechat_fifo_12345}@* +@* +@b{Warning:} this is dangerous and you should not do that except if you know what you do! +@item @bullet{} send 2 commands to unload/reload Perl scripts (you have to separate them with \n): +@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} +@end table +@* +You can write a script to send command to all running WeeChat at same time, for example:@* +@verbatim + #!/bin/sh + if [ $# -eq 1 ]; then + for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do + echo -e "$1" >$fifo + done + fi +@end verbatim +@* +If the script is called "auto_weechat_command", you can run it with:@* +@command{./auto_weechat_command "freenode,#weechat *hello"} + @c ******************************* Extensions ********************************* diff --git a/doc/weechat_doc_fr.texi b/doc/weechat_doc_fr.texi index a887ddb62..8a225a7ee 100644 --- a/doc/weechat_doc_fr.texi +++ b/doc/weechat_doc_fr.texi @@ -35,7 +35,7 @@ @title WeeChat - Guide utilisateur @subtitle Client IRC rapide, l@'eger et extensible -@subtitle Documentation pour WeeChat v0.1.1-cvs - 11 Mars 2005 +@subtitle Documentation pour WeeChat v0.1.1 - 20 Mars 2005 @image{weechat_image} @@ -209,6 +209,7 @@ Suivez alors les instructions du paquet sources - @xref{Paquet source}. * Fichier de configuration::
* Raccourcis clavier::
* Commandes WeeChat:: +* Tube FIFO:: @end menu @node Lancer WeeChat, Fichier de configuration, Utilisation, Utilisation @@ -487,7 +488,7 @@ Message de fin par d@'efaut ('%v' sera remplac@'e par la version de WeeChat dans Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'WeeChat %v'@* @item irc_away_check Intervalle entre deux v@'erifications des absences (en minutes, 0 = ne jemais v@'erifier)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 1@* +Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 0@* @item irc_lag_check Intervalle entre deux mesures de lag (en secondes)@* Type: entier (valeurs: entre 30 et 2147483647), valeur par d@'efaut: 60@* @@ -497,6 +498,9 @@ Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 1@* @item irc_lag_disconnect D@'econnexion apr@`es un lag important (en minutes, 0 = ne jamais se d@'econnecter)@* Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 5@* +@item irc_fifo_pipe +Cr@'eer un tube FIFO pour le contr@^ole @`a distance@* +Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* @item dcc_auto_accept_files Accepte automatiquement les fichiers dcc entrants@* Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* @@ -693,7 +697,7 @@ Sauter au tampon avec ce num@'ero@* @* @end table -@node Commandes WeeChat, , Raccourcis clavier, Utilisation +@node Commandes WeeChat, Tube FIFO, Raccourcis clavier, Utilisation @section Commandes WeeChat Commandes internes WeeChat :@* @@ -710,7 +714,7 @@ param@`etres: param@`etres pour la commande@* @* @item buffer [action | nombre] @* -g@`ere les buffers@* +gestion des buffers@* @* action: action @`a effectuer:@* move: d@'eplacer le tampon dans la liste (peut @^etre relatif, par exemple -1)@* @@ -818,6 +822,13 @@ basculer le statut absent@* -all: basculer le statut absent sur tous les serveurs connect@'es@* message: message pour l'absence (si pas de message donn@'e, le statut d'absence est supprim@'e)@* @* +@item ban [canal] [pseudo [pseudo ...]] +@* +bannit des pseudos ou masques@* +@* +canal: nom du canal pour le bannissement@* +pseudo: pseudo ou masque pour le bannissement@* +@* @item ctcp pseudo type @* envoyer un message ctcp@* @@ -833,6 +844,10 @@ action: 'send' (envoi de fichier) ou 'chat' (discussion) ou 'close' (fermeture d pseudo: pseudo pour envoyer le fichier ou discuter@* fichier: nom du fichier (sur la machine locale)@* @* +@item dehalfop pseudo [pseudo] +@* +retire le statut de demi-op@'erateur du canal @`a/aux nick(s)@* +@* @item deop pseudo [pseudo] @* retire le statut d'op@'erateur du canal @`a/aux nick(s)@* @@ -845,6 +860,10 @@ retire la voix du/des pseudo(s)@* @* arr@^eter le serveur@* @* +@item halfop pseudo [pseudo] +@* +donner le statut de demi-op@'erateur @`a un/des utilisateur(s)@* +@* @item info [cible] @* voir les informations d@'ecrivant le serveur@* @@ -879,6 +898,14 @@ canal: canal o@`u l'utilisateur se trouve@* pseudo: utilisateur @`a @'eliminer@* commentaire: commentaire pour l'@'elimination@* @* +@item kickban [canal] pseudo [commentaire] +@* +retirer par la force un utilisateur d'un canal et le bannir@* +@* +canal: canal o@`u l'utilisateur se trouve@* +pseudo: utilisateur @`a @'eliminer et bannir@* +commentaire: commentaire pour l'@'elimination@* +@* @item kill pseudo commentaire @* fermer la connexion client-serveur@* @@ -1021,7 +1048,7 @@ donn@'ees: donn@'ees brutes @`a envoyer@* @* @item rehash @* -demander au serveur de recharger son fichier de config@* +demander au serveur de recharger son fichier de configuration@* @* @item restart @* @@ -1089,6 +1116,13 @@ trouver le chemin jusqu'@`a un serveur sp@'ecifique@* @* cible: serveur@* @* +@item unban [canal] pseudo [pseudo ...] +@* +supprime le bannissement sur des pseudos ou masques@* +@* +canal: nom du canal pour supprimer le bannissement@* +pseudo: pseudo ou masque pour supprimer le bannissement@* +@* @item userhost pseudo [pseudo ...] @* retourne une liste d'informations sur des utilisateurs@* @@ -1143,6 +1177,50 @@ cible: la r@'eponse doit correspondre @`a ce masque@* @end table +@node Tube FIFO, , Commandes WeeChat, Utilisation +@section Tube FIFO + +Vous pouvez contr@^oler WeeChat @`a distance, en envoyant des commandes ou du +texte dans un tube FIFO (l'option "irc_fifo_pipe" doit @^etre activ@'ee, elle +est d@'esactiv@'ee par d@'efaut).@* +Le tube FIFO est dans le r@'epertoire ~/.weechat/ et s'appelle "weechat_fifo_xxxxx" +(o@`u xxxxx est l'ID du processus (PID) du WeeChat qui tourne).@* +Donc si plusieurs WeeChat tournent, vous avez plusieurs tubes FIFO, un pour +chaque session.@* +@* +La syntaxe pour envoyer des commandes ou du texte dans le tube FIFO est la suivante :@* +@command{serveur,canal *texte ou commande ici}@* +o@`u le serveur et le canal sont facultatifs, mais si le canal est l@`a, le +serveur doit l'@^etre aussi.@* +@* +Quelques exemples : +@table @asis +@item @bullet{} changement du pseudo sur freenode en "pseudo|absent": +@command{echo "freenode */nick pseudo|absent" >~/.weechat/weechat_fifo_12345} +@item @bullet{} affichage de texte sur le canal #weechat : +@command{echo "freenode,#weechat *bonjour tout le monde !" >~/.weechat/weechat_fifo_12345} +@item @bullet{} affichage de texte sur le canal courant (le tampon affich@'e par WeeChat): +@command{echo "*bonjour !" >~/.weechat/weechat_fifo_12345}@* +@* +@b{Attention :} ceci est dangereux et vous ne devriez pas le faire sauf si vous savez ce que vous faites ! +@item @bullet{} envoyer deux commandes pour décharger/recharger les scripts Perl (vous devez les séparer par \n): +@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} +@end table +@* +Vous pouvez @'ecrire un script qui envoie les commandes @`a tous les WeeChat qui +tournent en m@^eme temps, par exemple :@* +@verbatim + #!/bin/sh + if [ $# -eq 1 ]; then + for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do + echo -e "$1" >$fifo + done + fi +@end verbatim +@* +Si le script s'appelle "auto_weechat_command", vous pouvez le lancer ainsi :@* +@command{./auto_weechat_command "freenode,#weechat *bonjour"} + @c ******************************* Extensions ********************************* diff --git a/doc/weechat_doc_pt.texi b/doc/weechat_doc_pt.texi index 186474291..e22710946 100644 --- a/doc/weechat_doc_pt.texi +++ b/doc/weechat_doc_pt.texi @@ -35,7 +35,7 @@ @title WeeChat - Guia do Utilizador @subtitle Cliente de IRC rapido, leve e extencivel -@subtitle Documenta@,{c}@~ao do WeeChat v0.1.1-cvs - 11 de Mar@,{c}o de 2005 +@subtitle Documenta@,{c}@~ao do WeeChat v0.1.1 - 20 de Mar@,{c}o de 2005 @image{weechat_image} @@ -206,6 +206,7 @@ Segue agora as instru@,{c}@~oes para compilar o c@'odigo fonte - @xref{Codigo Fo * Invocar o WeeChat:: * Recursos de teclado:: * Comandos do WeeChat:: +* FIFO pipe:: @end menu @node Invocar o WeeChat, Recursos de teclado, Utilizacao, Utilizacao @@ -309,11 +310,54 @@ Comute ao amortecedor pelo n@'umero@* @* @end table -@node Comandos do WeeChat, , Recursos de teclado, Utilizacao +@node Comandos do WeeChat, FIFO pipe, Recursos de teclado, Utilizacao @section Comandos do WeeChat N@~AO ESCRITO ! +@node FIFO pipe, , Comandos do WeeChat, Utilizacao +@section FIFO pipe + +You can remote control WeeChat, by sending commands or text to a FIFO pipe +(you have to enable option "irc_fifo_pipe", it is disabled by default).@* +The FIFO pipe is located in ~/.weechat/ and is called "weechat_fifo_xxxxx" +(where xxxxx is the process ID (PID) of running WeeChat).@* +So if many WeeChat are running, you have many FIFO pipe, one for each session.@* +@* +The syntax for the FIFO pipe commands/text is:@* +@command{server,channel *text or command here}@* +where server and channel are optional, but if channel is here, server should be too.@* +@* +Some examples: +@table @asis +@item @bullet{} change your nick on freenode to "mynick|out": +@* +@command{echo "freenode */nick mynick|out" >~/.weechat/weechat_fifo_12345} +@item @bullet{} display text on #weechat channel: +@* +@command{echo "freenode,#weechat *hello everybody!" >~/.weechat/weechat_fifo_12345} +@item @bullet{} display text on current channel (buffer displayed by WeeChat): +@* +@command{echo "*hello!" >~/.weechat/weechat_fifo_12345}@* +@* +@b{Warning:} this is dangerous and you should not do that except if you know what you do! +@item @bullet{} send 2 commands to unload/reload Perl scripts (you have to separate them with \n): +@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} +@end table +@* +You can write a script to send command to all running WeeChat at same time, for example:@* +@verbatim + #!/bin/sh + if [ $# -eq 1 ]; then + for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do + echo -e "$1" >$fifo + done + fi +@end verbatim +@* +If the script is called "auto_weechat_command", you can run it with:@* +@command{./auto_weechat_command "freenode,#weechat *hello"} + @c ******************************* Extencoes ********************************* diff --git a/doc/weechat_image.pdf b/doc/weechat_image.pdf Binary files differindex 16ca5c6b2..77ba2cca4 100644 --- a/doc/weechat_image.pdf +++ b/doc/weechat_image.pdf |