diff options
author | Sebastien Helleu <flashcode@flashtux.org> | 2003-11-23 13:15:27 +0000 |
---|---|---|
committer | Sebastien Helleu <flashcode@flashtux.org> | 2003-11-23 13:15:27 +0000 |
commit | e469f0ef48bbfcff074fa1ffeec196253e8cd55b (patch) | |
tree | 1f2e23637ce28480934b934811e68ce4eb616b36 | |
parent | ba65f5ec3056b73cbde03475b8b02463cc1a355f (diff) | |
download | weechat-e469f0ef48bbfcff074fa1ffeec196253e8cd55b.zip |
WeeChat documentation
-rw-r--r-- | doc/Makefile | 33 | ||||
-rw-r--r-- | doc/weechat_doc_en.texi | 495 | ||||
-rw-r--r-- | doc/weechat_doc_fr.texi | 496 | ||||
-rw-r--r-- | doc/weechat_doc_pt.texi | 364 | ||||
-rw-r--r-- | doc/weechat_image.pdf | bin | 0 -> 15499 bytes | |||
-rw-r--r-- | weechat/doc/Makefile | 33 | ||||
-rw-r--r-- | weechat/doc/weechat_doc_en.texi | 495 | ||||
-rw-r--r-- | weechat/doc/weechat_doc_fr.texi | 496 | ||||
-rw-r--r-- | weechat/doc/weechat_doc_pt.texi | 364 | ||||
-rw-r--r-- | weechat/doc/weechat_image.pdf | bin | 0 -> 15499 bytes |
10 files changed, 2776 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 000000000..657e3965f --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,33 @@ +# Copyright (c) 2003 FlashCode <flashcode@flashtux.org> +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# + +all: weechat_doc_fr.texi weechat_doc_en.texi weechat_doc_pt.texi + export LANG=fr_FR && makeinfo --html --no-split --number-sections weechat_doc_fr.texi + export LANG=fr_FR && makeinfo --no-headers --no-warn --no-split --number-sections weechat_doc_fr.texi >weechat_doc_fr.txt + export LANG=en_EN && makeinfo --html --no-split --number-sections weechat_doc_en.texi + export LANG=en_EN && makeinfo --no-headers --no-warn --no-split --number-sections weechat_doc_en.texi >weechat_doc_en.txt + export LANG=pt_PT && makeinfo --html --no-split --number-sections weechat_doc_pt.texi + export LANG=pt_PT && makeinfo --no-headers --no-warn --no-split --number-sections weechat_doc_pt.texi >weechat_doc_pt.txt + export LANG=fr_FR && texi2pdf weechat_doc_fr.texi + export LANG=en_EN && texi2pdf weechat_doc_en.texi + export LANG=pt_PT && texi2pdf weechat_doc_pt.texi + +clean: + rm -rf weechat_doc_*.aux weechat_doc_*.cp weechat_doc_*.fn \ + weechat_doc_*.html weechat_doc_*.ky weechat_doc_*.log \ + weechat_doc_*.pdf weechat_doc_*.pg weechat_doc_*.toc \ + weechat_doc_*.tp weechat_doc_*.txt weechat_doc_*.vr diff --git a/doc/weechat_doc_en.texi b/doc/weechat_doc_en.texi new file mode 100644 index 000000000..c2241a00a --- /dev/null +++ b/doc/weechat_doc_en.texi @@ -0,0 +1,495 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename weechat_doc_en.info +@settitle WeeChat - fast, light and extensible IRC client +@c %**end of header + +@c WeeChat documentation (english version) +@c +@c Copyright (c) 2003 by FlashCode <flashcode@flashtux.org> +@c +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.2 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". + +@c pdf : texi2pdf weechat_doc_en.texi +@c html: makeinfo --html --no-split --number-sections weechat_doc_en.texi + +@c tex +@c \overfullrule=0pt +@c end tex + +@documentlanguage en + +@titlepage + +@title WeeChat - User guide +@subtitle Fast, light and extensible IRC client +@subtitle Documentation for WeeChat v0.0.4 - November, 23 2003 + +@image{weechat_image} + +@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> + +@page + +This manual documents WeeChat IRC client, it is part of WeeChat.@* +@* +Latest version of this document can be found on this page:@* +@uref{http://weechat.flashtux.org/doc.php?lang=en}@* +@* +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +This document may be used under the terms the GNU General Public License +version 2 or higher. + +@end titlepage + +@everyheading @thischapter @| @| +@everyfooting @thistitle @| @| Page @thispage + +@contents + +@node Top, Introduction, (dir), (dir) +@menu +* Introduction:: What is WeeChat ? +* Installation:: WeeChat installation +* Usage:: WeeChat usage +* Extensions:: WeeChat extensions +* Authors / Support:: Contact authors and get support +@end menu + + +@c ******************************* Introduction ******************************* + +@node Introduction, Installation, Top, Top +@chapter Introduction + +@menu +* Description:: +* Pre-requisites:: +@end menu + +@node Description, Pre-requisites, Introduction, Introduction +@section Description + +WeeChat (Wee Enhanced Environment for Chat) is a free IRC client, fast and light,
+designed for many operating systems.@*
+@* +Main features are:
+@itemize @minus +@item
+multi-servers connection
+@item
+many GUI (Graphical User Interface): Curses, Gtk and Qt
+@item
+small, fast and light
+@item
+customizable and extensible with scripts
+@item
+compliant with RFCs 1459, 2810, 2811, 2812, and 2813
+@item
+multi-platform (Gnu/Linux, *BSD, Windows and other)
+@item
+100% GPL, free software +@end itemize
+
+@* +WeeChat homepage is here:@* +@uref{http://weechat.flashtux.org}@* + +@node Pre-requisites, , Description, Introduction +@section Pre-requisites + +In order to install WeeChat, you @b{need}:@* + +@itemize @bullet +@item +A running Gnu/Linux system (with compiler tools for source package)
+@item +"root" privileges (to install WeeChat) +@item +According to GUI, one of the following libraries:
+@itemize @minus
+@item
+Curses: ncurses library,
+@item
+Gtk: *** GUI not developed ***,
+@item
+Qt: *** GUI not developed ***,
+@end itemize +@end itemize
+ + +@c ******************************* Installation ******************************* + +@node Installation, Usage, Introduction, Top +@chapter Installation + +@menu +* Binary package:: +* Source package::
+* CVS sources:: +@end menu + +@node Binary package, Source package, Installation, Installation +@section Binary package + +Binary packages are available for these distributions:
+@itemize @bullet
+@item
+Debian (or any Debian compatible distribution)@*
+To install: @kbd{dpkg -i /path/weechat_x.y.z-1_i386.deb}
+@item
+Mandrake/Redhat (or any RPM compatible distribution)@*
+To install: @kbd{rpm -i /path/weechat-x.y.z-1.i386.rpm}
+@item
+Gentoo@*
+To install: see Gentoo documentation
+@item
+*BSD (not available!)
+@item
+Slackware (not available!)
+@item
+Windows (not available!)
+@end itemize
+ +where x.y.z is the version (for example 0.0.1) +@* + +@node Source package, CVS sources, Binary package, Installation +@section Source package + +All you have to do is to run in a console or a terminal:@* +@kbd{./configure}@* +@kbd{make}@* +Nota: to build only some interfaces, you can give parameters +to ./configure, type @kbd{./configure --help} for help about options.@* +
+Then get root privileges and install WeeChat:@*
+@kbd{su -}@*
+(enter root password)@*
+@kbd{make install}@*
+
+@node CVS sources, , Source package, Installation +@section CVS sources
+
+Warning: CVS sources are for advanced users: it may not compile or not be stable.
+You're warned!@*
+
+To get CVS sources, issue these commands:@*
+@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@*
+@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@*
+(when prompted for a password, just press Enter key)@*
+ +Execute this script:@* +@kbd{./autogen.sh}@* +
+Then follow instructions for source package - @xref{Source package}.
+ + +@c ********************************** Usage *********************************** + +@node Usage, Extensions, Installation, Top +@chapter Usage + +@menu +* Run WeeChat::
+* Key bindings::
+* WeeChat commands:: +@end menu + +@node Run WeeChat, Key bindings, Usage, Usage +@section Run WeeChat +
+@subsection Command line parameters
+
+@table @code +@item -h, --help +Display help screen@* +@item -l, --license +Display WeeChat license@* +@item -v, --version
+Display WeeChat version@* +@end table
+
+@subsection Run WeeChat
+
+Just issue this command to run WeeChat:@*
+@kbd{weechat}@* +or @kbd{weechat-gtk} (for Gtk front-end)@* +or @kbd{weechat-qt} (for Qt front-end)@*
+
+When you run WeeChat for the first time, a default configuration file is
+created, with default options.@*
+The default configuration file is: ~/.weechat/weechat.rc@*
+
+You can edit this file at your convenience to configure WeeChat, or you can
+set parameters with @kbd{/set} command in WeeChat - @xref{WeeChat commands}. + +@node Key bindings, WeeChat commands, Run WeeChat, Usage +@section Key bindings +
+@table @kbd +@item Left arrow / Right arrow +Go to previous / next char in command line@* +@*
+@item Ctrl + left arrow / Ctrl + right arrow +Go to previous / next word in command line@* +@* +@item Home / End +Go to the beginning / end of command line@* +@* +@item Backspace / Delete
+Erase previous / next char of command line@* +@*
+@item Ctrl + Backspace
+Erase previous word of command line@* +@*
+@item Tab
+Complete command or nick (@kbd{Tab} again: find next completion)@* +@*
+@item Any char
+Insert char to cursor position in the command line@*
+@*
+@item Enter
+Execute command or send message@* +@*
+@item Up arrow / Down arrow
+Call again last commands/messages@*
+@*
+@item PageUp / PageDown
+Show window history@* +@*
+@item F6 / F7
+Switch to previous / next window@* +@*
+@item Alt + left arrow / Alt + right arrow
+Same as F6 / F7@* +@* +@end table + +@node WeeChat commands, , Key bindings, Usage +@section WeeChat commands + +NOT WRITTEN! + + +@c ******************************* Extensions ********************************* + +@node Extensions, Authors / Support, Usage, Top +@chapter Extensions + +@menu +* Perl scripts:: +* Python scripts:: +* Ruby scripts:: +@end menu + +@node Perl scripts, Python scripts, Extensions, Extensions +@section Perl scripts + +@subsection Load/unload Perl scripts + +Perl scripts are loaded and unloaded with @command{/perl} command. +(type @kbd{/help perl} within WeeChat to get help about command).@* + +@itemize @bullet +@item +Perl script loading example:@* +@kbd{/perl load /tmp/sample.pl}@* +@item +Perl script unloading example:@* +@kbd{/perl unload sample}@* +Notice: "sample" is the first parameter of @command{IRC::register} function.@* +@item +List all Perl script loaded:@* +@kbd{/perl}@* +@end itemize + +@subsection WeeChat / Perl API + +@itemize @bullet +@item +@command{IRC::register ( name, version, shutdown_function, description );}@* +@* +This is first function to call in Perl script.@* +All Perl scripts for WeeChat should call this function.@* + +@emph{Arguments:} +@itemize @minus +@item @option{name}: unique name to identify script (each script must have +unique name) +@item @option{version}: script's version +@item @option{shutdown_function}: Perl function called when script is +unloaded (optional parameter, empty string means nothing is called at the end) +@item @option{description}: short description of script. +@end itemize +@* +@emph{Example:}@* +@code{IRC::register ("sample", "1.0", "sample_end", "Sample script!");}@* + +@item +@command{IRC::print ( message );}@* +@* +Print message in current window (channel or server).@* + +@emph{Arguments:} +@itemize @minus +@item @option{message}: message to display +@end itemize +@* +@emph{Example:}@* +@code{IRC::print ("message");}@* + +@item +@command{IRC::add_message_handler ( name, function );}@* +@* +Attach a Perl function to an IRC message.@* +Function will be called each time IRC message will be received.@* + +@emph{Arguments:} +@itemize @minus +@item @option{name}: name of IRC message@* +To know list of IRC messages, please refer to RFC 1459 and/or 2812:@* +RFC 1459: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@* +RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} +@item @option{function}: Perl function called when message is received +@end itemize +@* +@emph{Example:}@* +@code{IRC::add_message_handler ("privmsg", my_function);}@* +@code{sub my_function}@* +@code{@{ }@* +@code{@ @ @ @ ($null, $channel, $message) = split ":",@@_[0],3;}@* +@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* +@code{@ @ @ @ IRC::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* +@code{@} }@* + +@item +@command{IRC::add_command_handler ( name, function );}@* +@* +Create new WeeChat command, linked with Perl function.@* +Function will be called when user will launch command with @kbd{/name}.@* + +@emph{Arguments:} +@itemize @minus +@item @option{name}: name of new command@* +This name may be existing command, so that the command is overrided by +Perl function. Be careful when overriding WeeChat commands, they'll not be +available until your Perl script will be unloaded. +@item @option{function}: Perl function linked with command +@end itemize +@* +@emph{Example:}@* +@code{IRC::add_command_handler ("command", my_command);}@* +@code{sub my_command}@* +@code{@{ }@* +@code{@ @ @ @ IRC::print("Arguments: ".@@_[0]);}@* +@code{@ @ @ @ return 0;}@* +@code{@} }@* + +@end itemize + +@node Python scripts, Ruby scripts, Perl scripts, Extensions +@section Python scripts + +Not developed! + +@node Ruby scripts, , Python scripts, Extensions +@section Ruby scripts + +Not developed! + + +@c **************************** Authors / Support ***************************** + +@node Authors / Support, , Extensions, Top +@chapter Authors / Support + +@ifhtml +@menu +* Authors:: +* Get support:: +* Copyright:: +@end menu +@end ifhtml +@ifnothtml +@menu +* Authors:: +* Get support:: +@end menu +@end ifnothtml + +@node Authors, Get support, Authors / Support, Authors / Support +@section Authors + +WeeChat is developed by:@* + +@itemize @bullet +@item +FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> +@item +Bounga +<@email{bounga@@altern.org, bounga AT altern.org}> +@item +Xahlexx +<@email{xahlexx@@tuxfamily.org, xahlexx AT tuxfamily.org}> +@item +Crevetor +<@email{crevetor@@caramail.com, crevetor AT caramail.com}> + +@end itemize + +@ifhtml +@node Get support, Copyright, Authors, Authors / Support +@end ifhtml +@ifnothtml +@node Get support, , Authors, Authors / Support +@end ifnothtml +@section Get support + +Before asking for support, be sure you've read documentation and FAQ provided +with WeeChat.@* +(documentation is this document, if you don't read all lines until this sentence, +you can start again!)@* + +@itemize @bullet +@item +Support with IRC:@* +- server: @b{irc.freenode.net}@* +- channel: @b{#weechat}@*@* +@item +WeeChat forum: soon!@*@* +@item +Support with mailing list:@* +- to subscribe/unsubscribe:@*@uref{http://mail.nongnu.org/mailman/listinfo/weechat-support}.@* +- to send mail to all mailing list subscribers, send your mail to@*@email{weechat-support@@nongnu.org}.@* + +Mailing archives are available here:@* +@uref{http://mail.nongnu.org/archive/html/weechat-support}@*@* +@item +Look for WeeChat support page for detail:@* +@uref{http://weechat.flashtux.org/support.php?lang=en} + +@end itemize + +@ifhtml +@node Copyright, , Get support, Authors / Support +@section Copyright + +This manual documents WeeChat IRC client, it is part of WeeChat.@*
+ +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +This document may be used under the terms the GNU General Public License +version 2 or higher. +@end ifhtml + +@bye diff --git a/doc/weechat_doc_fr.texi b/doc/weechat_doc_fr.texi new file mode 100644 index 000000000..85f0ce587 --- /dev/null +++ b/doc/weechat_doc_fr.texi @@ -0,0 +1,496 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename weechat_doc_fr.info +@settitle WeeChat - Client IRC rapide, leger et extensible +@c %**end of header + +@c WeeChat documentation (french version) +@c +@c Copyright (c) 2003 by FlashCode <flashcode@flashtux.org> +@c +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.2 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". + +@c pdf : texi2pdf weechat_doc_fr.texi +@c html: makeinfo --html --no-split --number-sections weechat_doc_fr.texi + +@c tex +@c \overfullrule=0pt +@c end tex + +@documentlanguage fr + +@titlepage + +@title WeeChat - Guide utilisateur +@subtitle Client IRC rapide, l@'eger et extensible +@subtitle Documentation pour WeeChat v0.0.4 - 23 novembre 2003 + +@image{weechat_image} + +@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> + +@page + +Ce manuel documente le client IRC WeeChat, il fait partie de WeeChat.@* +@* +La derni@`ere version de ce document peut @^etre t@'el@'echarg@'ee sur cette page :@* +@uref{http://weechat.flashtux.org/doc.php}@* +@* +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +Ce document peut @^etre utilis@'e sous les termes de la licence GNU General Public +License version 2 ou plus. + +@end titlepage + +@everyheading @thischapter @| @| +@everyfooting @thistitle @| @| Page @thispage + +@contents + +@node Top, Introduction, (dir), (dir) +@menu +* Introduction:: Description de WeeChat +* Installation:: Installation de WeeChat +* Utilisation:: Utilisation de WeeChat +* Extensions:: Extensions de WeeChat +* Auteurs / Support:: Contacter les auteurs et obtenir du support +@end menu + + +@c ******************************* Introduction ******************************* + +@node Introduction, Installation, Top, Top +@chapter Introduction +@menu +* Description:: +* Pre-requis:: +@end menu + +@node Description, Pre-requis, Introduction, Introduction +@section Description + +WeeChat (Wee Enhanced Environment for Chat) est un client IRC libre, rapide et l@'eger,
+concu pour diff@'erents syst@`emes d'exploitation.@* +@*
+Ses principales caract@'eristiques sont les suivantes :
+@itemize @minus +@item
+connexion multi-serveurs
+@item
+plusieurs interfaces : Curses, Gtk et Qt
+@item
+petit, rapide et l@'eger
+@item
+param@'etrable et extensible avec des scripts
+@item
+conforme aux RFCs 1459, 2810, 2811, 2812, et 2813
+@item
+multi-plateformes (Gnu/Linux, *BSD, Windows et d'autres syst@`emes)
+@item
+100% GPL, logiciel libre +@end itemize
+
+@* +La page d'accueil de WeeChat est ici :@* +@uref{http://weechat.flashtux.org}@* + +@node Pre-requis, , Description, Introduction +@section Pr@'e-requis + +Pour installer WeeChat, vous @b{devez} avoir :@* + +@itemize @bullet +@item +Un syst@`eme Gnu/Linux (avec le compilateur et les outils associ@'es pour le paquet des sources)
+@item +Droits "root" (pour installer WeeChat) +@item +Selon l'interface, une des biblioth@`eques suivantes :
+@itemize @minus
+@item
+Curses: la librairie ncurses,
+@item
+Gtk: *** interface non d@'evelopp@'ee ***,
+@item
+Qt: *** interface non d@'evelopp@'ee ***,
+@end itemize +@end itemize
+ + +@c ******************************* Installation ******************************* + +@node Installation, Utilisation, Introduction, Top +@chapter Installation + +@menu +* Paquet binaire:: +* Paquet source::
+* Sources CVS:: +@end menu + +@node Paquet binaire, Paquet source, Installation, Installation +@section Paquet binaire + +Les paquets binaires sont disponibles pour les distributions suivantes :
+@itemize @bullet
+@item
+Debian (ou toute distribution compatible Debian)@*
+Pour installer : @kbd{dpkg -i /chemin/weechat_x.y.z-1_i386.deb}
+@item
+Mandrake/Redhat (ou toute distribution compatible avec les RPM)@*
+Pour installer : @kbd{rpm -i /chemin/weechat-x.y.z-1.i386.rpm}
+@item
+Gentoo@*
+Pour installer : voir la documentation Gentoo
+@item
+*BSD (non disponible !)
+@item
+Slackware (non disponible !)
+@item
+Windows (non disponible !)
+@end itemize
+ +o@`u x.y.z est la version (par exemple 0.0.1) +@* + +@node Paquet source, Sources CVS, Paquet binaire, Installation +@section Paquet source + +Tapez simplement dans une console ou un terminal :@* +@kbd{./configure}@* +@kbd{make}@* +Note: pour ne construire que certaines interfaces, vous pouvez passer des param@`etres +@`a ./configure, tapez @kbd{./configure --help} pour de l'aide sur ces options.@* +
+Obtenez les droits root et installez WeeChat :@*
+@kbd{su -}@*
+(entrez le mot de passe de root)@*
+@kbd{make install}@*
+
+@node Sources CVS, , Paquet source, Installation +@section Sources CVS
+
+Attention: les sources CVS sont r@'eserv@'es aux utilisateurs avanc@'es : il se peut +que WeeChat ne compile pas et qu'il soit tr@`s instable.
+Vous @^etes pr@'evenus !@*
+
+Pour r@'ecup@'erer les sources CVS, tapez ces commandes :@*
+@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@*
+@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@*
+(lorsqu'un mot de passe est demand@'e, tapez simplement sur Entr@'ee)@*
+ +Ex@'ecutez ce script :@* +@kbd{./autogen.sh}@* +
+Suivez alors les instructions du paquet sources - @xref{Paquet source}.
+ + +@c ******************************* Utilisation ******************************** + +@node Utilisation, Extensions, Installation, Top +@chapter Utilisation + +@menu +* Lancer WeeChat::
+* Raccourcis clavier::
+* Commandes WeeChat:: +@end menu + +@node Lancer WeeChat, Raccourcis clavier, Utilisation, Utilisation +@section Lancer WeeChat +
+@subsection Param@`etres de ligne de commande
+
+@table @code +@item -h, --help +Afficher l'aide@* +@item -l, --license +Afficher la licence de WeeChat@* +@item -v, --version
+Afficher la version de WeeChat@* +@end table
+
+@subsection Lancer WeeChat
+
+Tapez simplement cette commande pour lancer WeeChat :@*
+@kbd{weechat-curses}@* +ou @kbd{weechat-gtk} (pour l'interface Gtk)@* +ou @kbd{weechat-qt} (pour l'interface Qt)@*
+
+Lorsque vous lancez WeeChat pour la premi@`ere fois, un fichier de configuration +par d@'efaut est cr@'e@'e, avec les options par d@'efaut.@*
+Le fichier de configuration par d@'efaut est : ~/.weechat/weechat.rc@*
+
+Vous pouvez @'editer ce fichier pour configurer WeeChat @`a votre convenance, ou
+vous pouvez modifier les param@`etres dans WeeChat avec la commande @kbd{/set} - @xref{Commandes WeeChat}. + +@node Raccourcis clavier, Commandes WeeChat, Lancer WeeChat, Utilisation +@section Raccourcis clavier +
+@table @kbd +@item Fl@`eche gauche / Fl@`eche droite +Aller au caract@`ere pr@'ec@'edent / suivant sur la ligne de commande@* +@*
+@item Ctrl + fl@`eche gauche / Ctrl + fl@`eche droite +Aller au mot pr@'ec@'edent / suivant sur la ligne de commande@* +@* +@item Home / End +Aller au d@'ebut / @`a la fin de la ligne de commande@* +@* +@item Backspace / Delete
+Effacer le mot pr@'ec@'edent / suivant sur la ligne de commande@* +@*
+@item Ctrl + Backspace
+Effacer le mot pr@'ec@'edent sur la ligne de commande@* +@*
+@item Tab
+Compl@'eter la commande ou le pseudo (@kbd{Tab} @`a nouveau : trouver la compl@'etion suivante)@* +@*
+@item Tout caract@`ere
+Ins@'erer le caract@`ere @`a la position du curseur sur la ligne de commande@*
+@*
+@item Entr@'ee
+Ex@'ecuter la commande ou envoyer le message@* +@*
+@item Fl@`eche haut / Fl@`eche bas
+Rappeler les derni@`eres commandes/messages@*
+@*
+@item PageUp / PageDown
+Afficher l'historique de la fen@^etre@* +@*
+@item F6 / F7
+Aller @`a la fen@^etre pr@'ec@'edente / suivante@* +@*
+@item Alt + fl@`eche gauche / Alt + fl@`eche droite
+Identique @`a F6 / F7@* +@* +@end table + +@node Commandes WeeChat, , Raccourcis clavier, Utilisation +@section Commandes WeeChat + +NON ECRIT ! + + +@c ******************************* Extensions ********************************* + +@node Extensions, Auteurs / Support, Utilisation, Top +@chapter Extensions + +@menu +* Scripts Perl:: +* Scripts Python:: +* Scripts Ruby:: +@end menu + +@node Scripts Perl, Scripts Python, Extensions, Extensions +@section Scripts Perl + +@subsection Charger/d@'echarger des scripts Perl + +Les scripts Perl sont charg@'es et d@'echarg@'es avec la commande @command{/perl} +(tapez @kbd{/help perl} dans WeeChat pour obtenir de l'aide sur la commande).@* + +@itemize @bullet +@item +Exemple de chargement d'un script Perl :@* +@kbd{/perl load /tmp/essai.pl}@* +@item +Exemple de d@'echargement d'un script Perl :@* +@kbd{/perl unload essai}@* +A noter: le nom "essai" est le premier param@`etre de la fonction @command{IRC::register.}@* +@item +Liste des scripts Perl charg@'es :@* +@kbd{/perl}@* +@end itemize + +@subsection Interface WeeChat / Perl + +@itemize @bullet +@item +@command{IRC::register ( nom, version, fonction_de_fin, description );}@* +@* +C'est la premi@`ere fonction @`a appeler dans le script Perl.@* +Tout script Perl pour WeeChat doit appeler cette fonction.@* + +@emph{Param@`etres :} +@itemize @minus +@item @option{nom}: nom unique pour identifier le script (chaque script doit +avoir un nom diff@'erent) +@item @option{version}: version du script +@item @option{fonction_de_fin}: fonction Perl appel@'ee quand le script est +d@'echarg@'e (param@`etre facultatif, une cha@^ine vide signifiant qu'il n'y a pas +de fonction @`a appeler) +@item @option{description}: description br@`eve du script. +@end itemize +@* +@emph{Exemple :}@* +@code{IRC::register ("essai", "1.0", "fin_essai", "Script d'essai !");}@* + +@item +@command{IRC::print ( message );}@* +@* +Affiche un message dans la fen@^etre courante (canal ou serveur).@* + +@emph{Param@`etres :} +@itemize @minus +@item @option{message}: message @`a afficher +@end itemize +@* +@emph{Exemple :}@* +@code{IRC::print ("message");}@* + +@item +@command{IRC::add_message_handler ( nom, fonction );}@* +@* +Attache une fonction Perl @`a un message IRC particulier.@* +La fonction sera appel@'ee @`a chaque fois que le message IRC sera re@,{c}u.@* + +@emph{Param@`etres :} +@itemize @minus +@item @option{nom}: nom du message IRC pour lequel la fonction est appel@'ee@* +Pour conna@^itre la liste des messages IRC disponibles, merci de consulter les +RFC 1459 et/ou 2812 :@* +RFC 1459 : @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@* +RFC 2812 : @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} +@item @option{fonction}: fonction Perl appel@'ee lorsque le message est re@,{c}u +@end itemize +@* +@emph{Exemple :}@* +@code{IRC::add_message_handler ("privmsg", ma_fonction);}@* +@code{sub ma_fonction}@* +@code{@{ }@* +@code{@ @ @ @ ($null, $canal, $message) = split ":",@@_[0],3;}@* +@code{@ @ @ @ ($masque, $null, $canal) = split " ", $canal;}@* +@code{@ @ @ @ IRC::print ("masque=$masque, canal=$canal, message=$message\n");}@* +@code{@} }@* + +@item +@command{IRC::add_command_handler ( nom, fonction );}@* +@* +Cr@'e@'e une nouvelle commande WeeChat, associ@'ee @`a une fonction Perl.@* +La fonction sera appel@'ee lorsque l'utilisateur lancera la commande par @kbd{/nom}.@* + +@emph{Param@`etres :} +@itemize @minus +@item @option{nom}: nom de la nouvelle commande@* +Il peut s'agir d'une commande existante, auquel cas celle-ci est @'ecras@'ee par +la fonction Perl. Soyez prudent en @'ecrasant les commandes WeeChat, car elles +ne seront plus accessibles tant que le script Perl sera charg@'e. +@item @option{fonction}: fonction Perl associ@'ee @`a la commande +@end itemize +@* +@emph{Exemple :}@* +@code{IRC::add_command_handler ("commande", ma_commande);}@* +@code{sub ma_commande}@* +@code{@{ }@* +@code{@ @ @ @ IRC::print("Param@`etres : ".@@_[0]);}@* +@code{@ @ @ @ return 0;}@* +@code{@} }@* + +@end itemize + +@node Scripts Python, Scripts Ruby, Scripts Perl, Extensions +@section Scripts Python + +Non d@'evelopp@'e ! + +@node Scripts Ruby, , Scripts Python, Extensions +@section Scripts Ruby + +Non d@'evelopp@'e ! + +@c **************************** Auteurs / Support ***************************** + +@node Auteurs / Support, , Extensions, Top +@chapter Auteurs / Support + +@ifhtml +@menu +* Auteurs:: +* Obtenir du support:: +* Copyright:: +@end menu +@end ifhtml +@ifnothtml +@menu +* Auteurs:: +* Obtenir du support:: +@end menu +@end ifnothtml + +@node Auteurs, Obtenir du support, Auteurs / Support, Auteurs / Support +@section Auteurs + +WeeChat est d@'evelopp@'e par :@* + +@itemize @bullet +@item +FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> +@item +Bounga +<@email{bounga@@altern.org, bounga AT altern.org}> +@item +Xahlexx +<@email{xahlexx@@tuxfamily.org, xahlexx AT tuxfamily.org}> +@item +Crevetor +<@email{crevetor@@caramail.com, crevetor AT caramail.com}> + +@end itemize + +@ifhtml +@node Obtenir du support, Copyright, Auteurs, Auteurs / Support +@end ifhtml +@ifnothtml +@node Obtenir du support, , Auteurs, Auteurs / Support +@end ifnothtml +@section 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 @^etes en train de lire, si vous +n'avez pas tout lu jusqu'ici, il est encore temps de recommencer !)@* + +@itemize @bullet +@item +Support par IRC:@* +- serveur : @b{irc.freenode.net}@* +- canal : @b{#weechat}@*@* +@item +Forum WeeChat : bient@^ot !@*@* +@item +Support par la liste de diffusion :@* +- pour souscrire/d@'esinscrire :@*@uref{http://mail.nongnu.org/mailman/listinfo/weechat-support}.@* +- pour envoyer un mail @`a la liste de diffusion, envoyer @`a :@*@email{weechat-support@@nongnu.org}.@* + +Les archives de la liste de diffusion sont ici :@* +@uref{http://mail.nongnu.org/archive/html/weechat-support}@*@* +@item +Voir la page support WeeChat pour plus de d@'etails :@* +@uref{http://weechat.flashtux.org/support.php} + +@end itemize + +@ifhtml +@node Copyright, , Obtenir du support, Auteurs / Support +@section Copyright + +Ce manuel documente le client IRC WeeChat, il fait partie de WeeChat.@* + +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +Ce document peut @^etre utilis@'e sous les termes de la licence GNU General Public +License version 2 ou plus. +@end ifhtml + +@bye diff --git a/doc/weechat_doc_pt.texi b/doc/weechat_doc_pt.texi new file mode 100644 index 000000000..198da130c --- /dev/null +++ b/doc/weechat_doc_pt.texi @@ -0,0 +1,364 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename weechat_doc_pt.info +@settitle WeeChat - Um cliente de IRC r@'apido, leve e extenc@'ivel +@c %**end of header + +@c WeeChat documentation (vers@~ao partuguesa) +@c +@c Copyright (c) 2003 by FlashCode <flashcode@flashtux.org> +@c +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.2 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". + +@c pdf : texi2pdf weechat_doc_pt.texi +@c html: makeinfo --html --no-split --number-sections weechat_doc_pt.texi + +@c tex +@c \overfullrule=0pt +@c end tex + +@documentlanguage pt + +@titlepage + +@title WeeChat - Guia do Utilizador +@subtitle Cliente de IRC rapido, leve e extenc@'ivel +@subtitle Documenta@,{c}@~ao do WeeChat v0.0.3 - 26 de Outubro de 2003 + +@image{weechat_image} + +@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> + +@page + +Este manual documenta o cliente de IRC WeeChat, ele faz parte do WeeChat.@* +@* +A ultima versão deste documento pode ser descarregada de :@* +@uref{http://weechat.flashtux.org/doc.php}@* +@* +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +Este documento pode ser utilizado sobre os termos da Licença P@'ublica geral GNU (GNU General Public +License) vers@~ao 2 ou superior. + +@end titlepage + +@everyheading @thischapter @| @| +@everyfooting @thistitle @| @| Pagina @thispage + +@contents + +@node Top, Introduç@~ao, (dir), (dir) +@menu +* Introduç@~ao:: Descriç@~ao do WeeChat +* Instalaç@~ao:: Instalaç@~ao do WeeChat +* Utilizaç@~ao:: Utilizaç@~ao do WeeChat +* Autores / Suporte:: Contactar os autores e obter suporte +@end menu + + +@c ******************************* Introduç@~ao ******************************* + +@node Introduç@~ao, Instalaç@~ao, Top, Top +@chapter Introduç@~ao +@menu +* Descriç@~ao:: +* Pre-requisitos:: +@end menu + +@node Descriç@~ao, Pre-requisitos, Introduç@~ao, Introduç@~ao +@section Descriç@~ao + +O WeeChat (Wee Enhanced Environment for Chat) @'e um cliente de IRC livre, r@'apido e leve, +concebido para funcionar em diversos sistemas operativos.@* +@* +As suas caracter@'isticas prinicpais s@~ao as seguintes : +@itemize @minus +@item +liga@,{c}@~ao a m@'ultiplos servidores +@item +v@'arias interfaces : Curses, Gtk e Qt +@item +pequeno r@'apido e leve +@item +configuravel e extenc@'ivel com scripts +@item +compat@'ivel com RFCs 1459, 2810, 2811, 2812, e 2813 +@item +multiplataforma (Gnu/Linux, *BSD, Windows e outros) +@item +100% GPL, Software Livre +@end itemize + +@* +A p@'agina Web do Weechat @'e aqui :@* +@uref{http://weechat.flashtux.org}@* + +@node Pre-requisitos, ,Descriç@~ao, Introduç@~ao +@section Pr@'e-requisitos + +Para instalar o Weechat, vais @b{precisar} de ter :@* + +@itemize @bullet +@item +Um sistema Gnu/Linux (com um compilador e outros utilit@'arios associados aos pacotes de c@'odigo fonte) +@item +Direitos de "root" (para instalar) +@item +Consoante a interface escolhida, uma das seguintes bibliotecas : +@itemize @minus +@item +Curses: a biblioteca ncurses, +@item +Gtk: *** interface n@~ao desenvolvida ***, +@item +Qt: *** interface n@~ao desenvolvida ***, +@end itemize +@end itemize + + +@c ******************************* Instalaç@~ao ******************************* + +@node Instalaç@~ao, Utilizaç@~ao, Introduç@~ao, Top +@chapter Instalaç@~ao +@menu +* Binarios:: +* Codigo Fonte:: +* Codigo Fonte via CVS:: +@end menu + +@node Binarios, Codigo Fonte, Instalaç@~ao, Instalaç@~ao +@section Bin@'arios + +Os pacotes bin@'arios est@'ao dispon@'iveis para as seguintes distribui@,{c}@~oes : +@itemize @bullet +@item +Debian (ou compat@'ivel)@* +Instala@,{c}@~ao : @kbd{dpkg -i /chemin/weechat_x.y.z-1_i386.deb} +@item +Mandrake/Redhat (ou outra distro compat@'ivel com RPMs)@* +Instala@,{c}@~ao : @kbd{rpm -i /chemin/weechat-x.y.z-1.i386.rpm} +@item +Gentoo@* +Instala@,{c}@~ao : ver a documenta@,{c}@~ao da Gentoo +@item +*BSD (non disponible !) +@item +Slackware (n@~ao dispon@'ivel !) +@item +Windows (n@~ao dispon@'ivel !) +@end itemize + +Onde x.y.z @'e a vers@~ao (por exemplo 0.0.1) +@* + +@node Codigo Fonte, Codigo Fonte via CVS, Binarios, Instalaç@~ao +@section C@'odigo Fonte + +Escreve simplesmente numa consola ou num terminal :@* +@kbd{./configure}@* +@kbd{make}@* +Nota: Para compilar certas interfaces, podes passar par@^ametros +ao ./configure, escreve @kbd{./configure --help} para veres as op@,{c}@~oes.@* + +Obter os direitos do root e instalar o Weechat :@* +@kbd{su -}@* +(escreve aqui a palavra-passe do superutilizador)@* +@kbd{make install}@* + +@node Codigo Fonte via CVS, , Codigo Fonte, Instalaç@~ao +@section C@'odigo Fonte via CVS + +Aten@,{c}@~ao: o c@'odigo fonte CVS est@'a reservado aos utilizadores avan@,{c}ados : o WeeChat pode n@~ao compilar ou ficar inst@'avel.@* +Considera-te avisado !@* + +Para sacares o c@'odigo fonte via CVS, escreve estes comandos :@* +@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@* +@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@* +(quando te pedirem a palavra-passe, primen simplesmente Enter)@* + +Executa o script :@* +@kbd{./autogen.sh}@* + +Segue agora as instru@,{c}@~oes para compilar o c@'odigo fonte - @xref{Codigo Fonte}. + + +@c ******************************* Utilizaç@~ao ******************************** + +@node Utilizaç@~ao, Autores / Suporte, Instalaç@~ao, Top +@chapter Utilizaç@~ao + +@menu +* Invocar o WeeChat:: +* Recursos de teclado:: +* Comandos do WeeChat:: +@end menu + +@node Invocar o WeeChat, Recursos de teclado, Utilizaç@~ao, Utilizaç@~ao +@section Invocar o WeeChat + +@subsection Par@^ametros de linha de comandos + +@table @code +@item -h, --help +Mostrar a ajuda@* +@item -l, --license +Mostrar a licen@,{c}a do WeeChat@* +@item -v, --version +Mostrar a vers@~ao do WeeChat@* +@end table + +@subsection Invocar o WeeChat + +Escreve simplesmente este comando para invoceres o WeeChat :@* +@kbd{weechat-curses}@* +ou @kbd{weechat-gtk} (para a interface em Gtk)@* +ou @kbd{weechat-qt} (para a interface em Qt)@* + +Logo que lan@,{c}ares o WeeChat pela primeira vez, um ficheiro de configura@,{c}@~ao +por defeito @'e criado, com as configura@,{c}@~oes por defeito.@* +O ficheiro de configura@,{c}@~ao por defeito @'e : ~/.weechat/weechat.rc@* + +Podes editar esse ficheiro para configurar o WeeChat @`a tua maneira, man tamb@'em podes modificar os par@^ametros dentro do WeeChat utilizando o comando @kbd{/set} - @xref{Comandos do WeeChat}. + +@node Recursos de teclado, Comandos do WeeChat, Invocar o WeeChat, Utilizaç@~ao +@section Recursos de teclado + +@table @kbd +@item Seta esquerda / Seta direita +Ir um caractere para traz / para a frente na linha de comando@* +@* +@item Ctrl + Seta esquerda / Ctrl + Seta Direita +Ir uma palavra para traz / para a frente na linha de comando@* +@* +@item Home / End +Ir para o in@'icio / para o fim da linha de comando@* +@* +@item Backspace / Delete +Apagar o caractere anterior / seguinte na linha de comando@* +@* +@item Ctrl + Backspace +Apagar a palavra anterior na linha de comando +@* +@item Tab +Completar o comando ou o nick (@kbd{Tab} novamente : encontrar a pr@'oxima sugest@~ao)@* +@* +@item Qualquer caractere +Inserir o caractere na linha de comando, no s@'itio do cursor@* +@* +@item Enter +Executa o comando ou envia a mensagem@* +@* +@item Seta para cima / Seta para baixo +Repetir os ultimos comandos/mensagens@* +@* +@item PageUp / PageDown +Navegar no hist@'orico da janela@* +@* +@item F6 / F7 +Ir para a janela anterior/seguinte@* +@* +@item Alt + Seta da esquerda / Alt + Seta da direita +Identico a F6 / F7@* +@* +@end table + +@node Comandos do WeeChat, , Recursos de teclado, Utilizaç@~ao +@section Comandos do WeeChat + +N@~AO ESCRITO ! + + +@c **************************** Autores / Suporte ***************************** + +@node Autores / Suporte, , Utilizaç@~ao, Top +@chapter Autores / Suporte + +@ifhtml +@menu +* Autores:: +* Obter Suporte:: +* Copyright:: +@end menu +@end ifhtml +@ifnothtml +@menu +* Autores:: +* Obter Suporte:: +@end menu +@end ifnothtml + +@node Autores, Obter Suporte, Autores / Suporte, Autores / Suporte +@section Autores + +O WeeChat @'e desenvolvido por :@* + +@itemize @bullet +@item +FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> +@item +Bounga +<@email{bounga@@altern.org, bounga AT altern.org}> +@item +Xahlexx +<@email{xahlexx@@tuxfamily.org, xahlexx AT tuxfamily.org}> +@item +Crevetor +<@email{crevetor@@caramail.com, crevetor AT caramail.com}> + +@end itemize + +@ifhtml +@node Obter Suporte, Copyright, Autores, Autores / Suporte +@end ifhtml +@ifnothtml +@node Obter Suporte, , Autores, Autores / Suporte +@end ifnothtml +@section Obter Suporte + +Antes de pedires suporte, agradecemos se leres toda a documenta@,{c}@~ao e a FAQ.@* +(a documenta@,{c}@~ao @'e este documento que est@'as a ler, se n@~ao leste tudo at@'e aqui, est@'a na hora de come@,{c}ares do in@'icio !)@* + +@itemize @bullet +@item +Suporte por IRC:@* +- servidor : @b{irc.freenode.net}@* +- canal : @b{#weechat}@*@* +@item +Forum do WeeChat : mais tarde !@*@* +@item +Suporte por lista de correio-e :@* +- para te inscreveres/desinscreveres :@*@uref{http://mail.nongnu.org/mailman/listinfo/weechat-support}.@* +- para enviares uma mensagem para a lista :@*@email{weechat-support@@nongnu.org}.@* + +Os arquivos da lista est@~ao aqui :@* +@uref{http://mail.nongnu.org/archive/html/weechat-support}@*@* +@item +Para mais detalhes, v@^e tamb@'em a p@'agina de suporte do WeeChat :@* +@uref{http://weechat.flashtux.org/support.php} + +@end itemize + +@ifhtml +@node Copyright, , Obter Suporte, Autores / Suporte +@section Copyright + +Este manual documenta o cliente de IRC WeeChat, Ele faz parte do WeeChat.@* + +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +Tradu@,{c}@~ao portuguesa de Jo@~ao Jer@'onimo <@email{j_j_b_o@@sapo.pt, j_j_b_o AT sapo.pt}>@* +@* +A utiliza@,{c}@~ao deste documento @'e regida pela GNU General Public +License vers@~ao 2 ou posterior.@* + +@end ifhtml + +@bye diff --git a/doc/weechat_image.pdf b/doc/weechat_image.pdf Binary files differnew file mode 100644 index 000000000..16ca5c6b2 --- /dev/null +++ b/doc/weechat_image.pdf diff --git a/weechat/doc/Makefile b/weechat/doc/Makefile new file mode 100644 index 000000000..657e3965f --- /dev/null +++ b/weechat/doc/Makefile @@ -0,0 +1,33 @@ +# Copyright (c) 2003 FlashCode <flashcode@flashtux.org> +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# + +all: weechat_doc_fr.texi weechat_doc_en.texi weechat_doc_pt.texi + export LANG=fr_FR && makeinfo --html --no-split --number-sections weechat_doc_fr.texi + export LANG=fr_FR && makeinfo --no-headers --no-warn --no-split --number-sections weechat_doc_fr.texi >weechat_doc_fr.txt + export LANG=en_EN && makeinfo --html --no-split --number-sections weechat_doc_en.texi + export LANG=en_EN && makeinfo --no-headers --no-warn --no-split --number-sections weechat_doc_en.texi >weechat_doc_en.txt + export LANG=pt_PT && makeinfo --html --no-split --number-sections weechat_doc_pt.texi + export LANG=pt_PT && makeinfo --no-headers --no-warn --no-split --number-sections weechat_doc_pt.texi >weechat_doc_pt.txt + export LANG=fr_FR && texi2pdf weechat_doc_fr.texi + export LANG=en_EN && texi2pdf weechat_doc_en.texi + export LANG=pt_PT && texi2pdf weechat_doc_pt.texi + +clean: + rm -rf weechat_doc_*.aux weechat_doc_*.cp weechat_doc_*.fn \ + weechat_doc_*.html weechat_doc_*.ky weechat_doc_*.log \ + weechat_doc_*.pdf weechat_doc_*.pg weechat_doc_*.toc \ + weechat_doc_*.tp weechat_doc_*.txt weechat_doc_*.vr diff --git a/weechat/doc/weechat_doc_en.texi b/weechat/doc/weechat_doc_en.texi new file mode 100644 index 000000000..c2241a00a --- /dev/null +++ b/weechat/doc/weechat_doc_en.texi @@ -0,0 +1,495 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename weechat_doc_en.info +@settitle WeeChat - fast, light and extensible IRC client +@c %**end of header + +@c WeeChat documentation (english version) +@c +@c Copyright (c) 2003 by FlashCode <flashcode@flashtux.org> +@c +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.2 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". + +@c pdf : texi2pdf weechat_doc_en.texi +@c html: makeinfo --html --no-split --number-sections weechat_doc_en.texi + +@c tex +@c \overfullrule=0pt +@c end tex + +@documentlanguage en + +@titlepage + +@title WeeChat - User guide +@subtitle Fast, light and extensible IRC client +@subtitle Documentation for WeeChat v0.0.4 - November, 23 2003 + +@image{weechat_image} + +@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> + +@page + +This manual documents WeeChat IRC client, it is part of WeeChat.@* +@* +Latest version of this document can be found on this page:@* +@uref{http://weechat.flashtux.org/doc.php?lang=en}@* +@* +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +This document may be used under the terms the GNU General Public License +version 2 or higher. + +@end titlepage + +@everyheading @thischapter @| @| +@everyfooting @thistitle @| @| Page @thispage + +@contents + +@node Top, Introduction, (dir), (dir) +@menu +* Introduction:: What is WeeChat ? +* Installation:: WeeChat installation +* Usage:: WeeChat usage +* Extensions:: WeeChat extensions +* Authors / Support:: Contact authors and get support +@end menu + + +@c ******************************* Introduction ******************************* + +@node Introduction, Installation, Top, Top +@chapter Introduction + +@menu +* Description:: +* Pre-requisites:: +@end menu + +@node Description, Pre-requisites, Introduction, Introduction +@section Description + +WeeChat (Wee Enhanced Environment for Chat) is a free IRC client, fast and light,
+designed for many operating systems.@*
+@* +Main features are:
+@itemize @minus +@item
+multi-servers connection
+@item
+many GUI (Graphical User Interface): Curses, Gtk and Qt
+@item
+small, fast and light
+@item
+customizable and extensible with scripts
+@item
+compliant with RFCs 1459, 2810, 2811, 2812, and 2813
+@item
+multi-platform (Gnu/Linux, *BSD, Windows and other)
+@item
+100% GPL, free software +@end itemize
+
+@* +WeeChat homepage is here:@* +@uref{http://weechat.flashtux.org}@* + +@node Pre-requisites, , Description, Introduction +@section Pre-requisites + +In order to install WeeChat, you @b{need}:@* + +@itemize @bullet +@item +A running Gnu/Linux system (with compiler tools for source package)
+@item +"root" privileges (to install WeeChat) +@item +According to GUI, one of the following libraries:
+@itemize @minus
+@item
+Curses: ncurses library,
+@item
+Gtk: *** GUI not developed ***,
+@item
+Qt: *** GUI not developed ***,
+@end itemize +@end itemize
+ + +@c ******************************* Installation ******************************* + +@node Installation, Usage, Introduction, Top +@chapter Installation + +@menu +* Binary package:: +* Source package::
+* CVS sources:: +@end menu + +@node Binary package, Source package, Installation, Installation +@section Binary package + +Binary packages are available for these distributions:
+@itemize @bullet
+@item
+Debian (or any Debian compatible distribution)@*
+To install: @kbd{dpkg -i /path/weechat_x.y.z-1_i386.deb}
+@item
+Mandrake/Redhat (or any RPM compatible distribution)@*
+To install: @kbd{rpm -i /path/weechat-x.y.z-1.i386.rpm}
+@item
+Gentoo@*
+To install: see Gentoo documentation
+@item
+*BSD (not available!)
+@item
+Slackware (not available!)
+@item
+Windows (not available!)
+@end itemize
+ +where x.y.z is the version (for example 0.0.1) +@* + +@node Source package, CVS sources, Binary package, Installation +@section Source package + +All you have to do is to run in a console or a terminal:@* +@kbd{./configure}@* +@kbd{make}@* +Nota: to build only some interfaces, you can give parameters +to ./configure, type @kbd{./configure --help} for help about options.@* +
+Then get root privileges and install WeeChat:@*
+@kbd{su -}@*
+(enter root password)@*
+@kbd{make install}@*
+
+@node CVS sources, , Source package, Installation +@section CVS sources
+
+Warning: CVS sources are for advanced users: it may not compile or not be stable.
+You're warned!@*
+
+To get CVS sources, issue these commands:@*
+@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@*
+@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@*
+(when prompted for a password, just press Enter key)@*
+ +Execute this script:@* +@kbd{./autogen.sh}@* +
+Then follow instructions for source package - @xref{Source package}.
+ + +@c ********************************** Usage *********************************** + +@node Usage, Extensions, Installation, Top +@chapter Usage + +@menu +* Run WeeChat::
+* Key bindings::
+* WeeChat commands:: +@end menu + +@node Run WeeChat, Key bindings, Usage, Usage +@section Run WeeChat +
+@subsection Command line parameters
+
+@table @code +@item -h, --help +Display help screen@* +@item -l, --license +Display WeeChat license@* +@item -v, --version
+Display WeeChat version@* +@end table
+
+@subsection Run WeeChat
+
+Just issue this command to run WeeChat:@*
+@kbd{weechat}@* +or @kbd{weechat-gtk} (for Gtk front-end)@* +or @kbd{weechat-qt} (for Qt front-end)@*
+
+When you run WeeChat for the first time, a default configuration file is
+created, with default options.@*
+The default configuration file is: ~/.weechat/weechat.rc@*
+
+You can edit this file at your convenience to configure WeeChat, or you can
+set parameters with @kbd{/set} command in WeeChat - @xref{WeeChat commands}. + +@node Key bindings, WeeChat commands, Run WeeChat, Usage +@section Key bindings +
+@table @kbd +@item Left arrow / Right arrow +Go to previous / next char in command line@* +@*
+@item Ctrl + left arrow / Ctrl + right arrow +Go to previous / next word in command line@* +@* +@item Home / End +Go to the beginning / end of command line@* +@* +@item Backspace / Delete
+Erase previous / next char of command line@* +@*
+@item Ctrl + Backspace
+Erase previous word of command line@* +@*
+@item Tab
+Complete command or nick (@kbd{Tab} again: find next completion)@* +@*
+@item Any char
+Insert char to cursor position in the command line@*
+@*
+@item Enter
+Execute command or send message@* +@*
+@item Up arrow / Down arrow
+Call again last commands/messages@*
+@*
+@item PageUp / PageDown
+Show window history@* +@*
+@item F6 / F7
+Switch to previous / next window@* +@*
+@item Alt + left arrow / Alt + right arrow
+Same as F6 / F7@* +@* +@end table + +@node WeeChat commands, , Key bindings, Usage +@section WeeChat commands + +NOT WRITTEN! + + +@c ******************************* Extensions ********************************* + +@node Extensions, Authors / Support, Usage, Top +@chapter Extensions + +@menu +* Perl scripts:: +* Python scripts:: +* Ruby scripts:: +@end menu + +@node Perl scripts, Python scripts, Extensions, Extensions +@section Perl scripts + +@subsection Load/unload Perl scripts + +Perl scripts are loaded and unloaded with @command{/perl} command. +(type @kbd{/help perl} within WeeChat to get help about command).@* + +@itemize @bullet +@item +Perl script loading example:@* +@kbd{/perl load /tmp/sample.pl}@* +@item +Perl script unloading example:@* +@kbd{/perl unload sample}@* +Notice: "sample" is the first parameter of @command{IRC::register} function.@* +@item +List all Perl script loaded:@* +@kbd{/perl}@* +@end itemize + +@subsection WeeChat / Perl API + +@itemize @bullet +@item +@command{IRC::register ( name, version, shutdown_function, description );}@* +@* +This is first function to call in Perl script.@* +All Perl scripts for WeeChat should call this function.@* + +@emph{Arguments:} +@itemize @minus +@item @option{name}: unique name to identify script (each script must have +unique name) +@item @option{version}: script's version +@item @option{shutdown_function}: Perl function called when script is +unloaded (optional parameter, empty string means nothing is called at the end) +@item @option{description}: short description of script. +@end itemize +@* +@emph{Example:}@* +@code{IRC::register ("sample", "1.0", "sample_end", "Sample script!");}@* + +@item +@command{IRC::print ( message );}@* +@* +Print message in current window (channel or server).@* + +@emph{Arguments:} +@itemize @minus +@item @option{message}: message to display +@end itemize +@* +@emph{Example:}@* +@code{IRC::print ("message");}@* + +@item +@command{IRC::add_message_handler ( name, function );}@* +@* +Attach a Perl function to an IRC message.@* +Function will be called each time IRC message will be received.@* + +@emph{Arguments:} +@itemize @minus +@item @option{name}: name of IRC message@* +To know list of IRC messages, please refer to RFC 1459 and/or 2812:@* +RFC 1459: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@* +RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} +@item @option{function}: Perl function called when message is received +@end itemize +@* +@emph{Example:}@* +@code{IRC::add_message_handler ("privmsg", my_function);}@* +@code{sub my_function}@* +@code{@{ }@* +@code{@ @ @ @ ($null, $channel, $message) = split ":",@@_[0],3;}@* +@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* +@code{@ @ @ @ IRC::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* +@code{@} }@* + +@item +@command{IRC::add_command_handler ( name, function );}@* +@* +Create new WeeChat command, linked with Perl function.@* +Function will be called when user will launch command with @kbd{/name}.@* + +@emph{Arguments:} +@itemize @minus +@item @option{name}: name of new command@* +This name may be existing command, so that the command is overrided by +Perl function. Be careful when overriding WeeChat commands, they'll not be +available until your Perl script will be unloaded. +@item @option{function}: Perl function linked with command +@end itemize +@* +@emph{Example:}@* +@code{IRC::add_command_handler ("command", my_command);}@* +@code{sub my_command}@* +@code{@{ }@* +@code{@ @ @ @ IRC::print("Arguments: ".@@_[0]);}@* +@code{@ @ @ @ return 0;}@* +@code{@} }@* + +@end itemize + +@node Python scripts, Ruby scripts, Perl scripts, Extensions +@section Python scripts + +Not developed! + +@node Ruby scripts, , Python scripts, Extensions +@section Ruby scripts + +Not developed! + + +@c **************************** Authors / Support ***************************** + +@node Authors / Support, , Extensions, Top +@chapter Authors / Support + +@ifhtml +@menu +* Authors:: +* Get support:: +* Copyright:: +@end menu +@end ifhtml +@ifnothtml +@menu +* Authors:: +* Get support:: +@end menu +@end ifnothtml + +@node Authors, Get support, Authors / Support, Authors / Support +@section Authors + +WeeChat is developed by:@* + +@itemize @bullet +@item +FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> +@item +Bounga +<@email{bounga@@altern.org, bounga AT altern.org}> +@item +Xahlexx +<@email{xahlexx@@tuxfamily.org, xahlexx AT tuxfamily.org}> +@item +Crevetor +<@email{crevetor@@caramail.com, crevetor AT caramail.com}> + +@end itemize + +@ifhtml +@node Get support, Copyright, Authors, Authors / Support +@end ifhtml +@ifnothtml +@node Get support, , Authors, Authors / Support +@end ifnothtml +@section Get support + +Before asking for support, be sure you've read documentation and FAQ provided +with WeeChat.@* +(documentation is this document, if you don't read all lines until this sentence, +you can start again!)@* + +@itemize @bullet +@item +Support with IRC:@* +- server: @b{irc.freenode.net}@* +- channel: @b{#weechat}@*@* +@item +WeeChat forum: soon!@*@* +@item +Support with mailing list:@* +- to subscribe/unsubscribe:@*@uref{http://mail.nongnu.org/mailman/listinfo/weechat-support}.@* +- to send mail to all mailing list subscribers, send your mail to@*@email{weechat-support@@nongnu.org}.@* + +Mailing archives are available here:@* +@uref{http://mail.nongnu.org/archive/html/weechat-support}@*@* +@item +Look for WeeChat support page for detail:@* +@uref{http://weechat.flashtux.org/support.php?lang=en} + +@end itemize + +@ifhtml +@node Copyright, , Get support, Authors / Support +@section Copyright + +This manual documents WeeChat IRC client, it is part of WeeChat.@*
+ +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +This document may be used under the terms the GNU General Public License +version 2 or higher. +@end ifhtml + +@bye diff --git a/weechat/doc/weechat_doc_fr.texi b/weechat/doc/weechat_doc_fr.texi new file mode 100644 index 000000000..85f0ce587 --- /dev/null +++ b/weechat/doc/weechat_doc_fr.texi @@ -0,0 +1,496 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename weechat_doc_fr.info +@settitle WeeChat - Client IRC rapide, leger et extensible +@c %**end of header + +@c WeeChat documentation (french version) +@c +@c Copyright (c) 2003 by FlashCode <flashcode@flashtux.org> +@c +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.2 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". + +@c pdf : texi2pdf weechat_doc_fr.texi +@c html: makeinfo --html --no-split --number-sections weechat_doc_fr.texi + +@c tex +@c \overfullrule=0pt +@c end tex + +@documentlanguage fr + +@titlepage + +@title WeeChat - Guide utilisateur +@subtitle Client IRC rapide, l@'eger et extensible +@subtitle Documentation pour WeeChat v0.0.4 - 23 novembre 2003 + +@image{weechat_image} + +@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> + +@page + +Ce manuel documente le client IRC WeeChat, il fait partie de WeeChat.@* +@* +La derni@`ere version de ce document peut @^etre t@'el@'echarg@'ee sur cette page :@* +@uref{http://weechat.flashtux.org/doc.php}@* +@* +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +Ce document peut @^etre utilis@'e sous les termes de la licence GNU General Public +License version 2 ou plus. + +@end titlepage + +@everyheading @thischapter @| @| +@everyfooting @thistitle @| @| Page @thispage + +@contents + +@node Top, Introduction, (dir), (dir) +@menu +* Introduction:: Description de WeeChat +* Installation:: Installation de WeeChat +* Utilisation:: Utilisation de WeeChat +* Extensions:: Extensions de WeeChat +* Auteurs / Support:: Contacter les auteurs et obtenir du support +@end menu + + +@c ******************************* Introduction ******************************* + +@node Introduction, Installation, Top, Top +@chapter Introduction +@menu +* Description:: +* Pre-requis:: +@end menu + +@node Description, Pre-requis, Introduction, Introduction +@section Description + +WeeChat (Wee Enhanced Environment for Chat) est un client IRC libre, rapide et l@'eger,
+concu pour diff@'erents syst@`emes d'exploitation.@* +@*
+Ses principales caract@'eristiques sont les suivantes :
+@itemize @minus +@item
+connexion multi-serveurs
+@item
+plusieurs interfaces : Curses, Gtk et Qt
+@item
+petit, rapide et l@'eger
+@item
+param@'etrable et extensible avec des scripts
+@item
+conforme aux RFCs 1459, 2810, 2811, 2812, et 2813
+@item
+multi-plateformes (Gnu/Linux, *BSD, Windows et d'autres syst@`emes)
+@item
+100% GPL, logiciel libre +@end itemize
+
+@* +La page d'accueil de WeeChat est ici :@* +@uref{http://weechat.flashtux.org}@* + +@node Pre-requis, , Description, Introduction +@section Pr@'e-requis + +Pour installer WeeChat, vous @b{devez} avoir :@* + +@itemize @bullet +@item +Un syst@`eme Gnu/Linux (avec le compilateur et les outils associ@'es pour le paquet des sources)
+@item +Droits "root" (pour installer WeeChat) +@item +Selon l'interface, une des biblioth@`eques suivantes :
+@itemize @minus
+@item
+Curses: la librairie ncurses,
+@item
+Gtk: *** interface non d@'evelopp@'ee ***,
+@item
+Qt: *** interface non d@'evelopp@'ee ***,
+@end itemize +@end itemize
+ + +@c ******************************* Installation ******************************* + +@node Installation, Utilisation, Introduction, Top +@chapter Installation + +@menu +* Paquet binaire:: +* Paquet source::
+* Sources CVS:: +@end menu + +@node Paquet binaire, Paquet source, Installation, Installation +@section Paquet binaire + +Les paquets binaires sont disponibles pour les distributions suivantes :
+@itemize @bullet
+@item
+Debian (ou toute distribution compatible Debian)@*
+Pour installer : @kbd{dpkg -i /chemin/weechat_x.y.z-1_i386.deb}
+@item
+Mandrake/Redhat (ou toute distribution compatible avec les RPM)@*
+Pour installer : @kbd{rpm -i /chemin/weechat-x.y.z-1.i386.rpm}
+@item
+Gentoo@*
+Pour installer : voir la documentation Gentoo
+@item
+*BSD (non disponible !)
+@item
+Slackware (non disponible !)
+@item
+Windows (non disponible !)
+@end itemize
+ +o@`u x.y.z est la version (par exemple 0.0.1) +@* + +@node Paquet source, Sources CVS, Paquet binaire, Installation +@section Paquet source + +Tapez simplement dans une console ou un terminal :@* +@kbd{./configure}@* +@kbd{make}@* +Note: pour ne construire que certaines interfaces, vous pouvez passer des param@`etres +@`a ./configure, tapez @kbd{./configure --help} pour de l'aide sur ces options.@* +
+Obtenez les droits root et installez WeeChat :@*
+@kbd{su -}@*
+(entrez le mot de passe de root)@*
+@kbd{make install}@*
+
+@node Sources CVS, , Paquet source, Installation +@section Sources CVS
+
+Attention: les sources CVS sont r@'eserv@'es aux utilisateurs avanc@'es : il se peut +que WeeChat ne compile pas et qu'il soit tr@`s instable.
+Vous @^etes pr@'evenus !@*
+
+Pour r@'ecup@'erer les sources CVS, tapez ces commandes :@*
+@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@*
+@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@*
+(lorsqu'un mot de passe est demand@'e, tapez simplement sur Entr@'ee)@*
+ +Ex@'ecutez ce script :@* +@kbd{./autogen.sh}@* +
+Suivez alors les instructions du paquet sources - @xref{Paquet source}.
+ + +@c ******************************* Utilisation ******************************** + +@node Utilisation, Extensions, Installation, Top +@chapter Utilisation + +@menu +* Lancer WeeChat::
+* Raccourcis clavier::
+* Commandes WeeChat:: +@end menu + +@node Lancer WeeChat, Raccourcis clavier, Utilisation, Utilisation +@section Lancer WeeChat +
+@subsection Param@`etres de ligne de commande
+
+@table @code +@item -h, --help +Afficher l'aide@* +@item -l, --license +Afficher la licence de WeeChat@* +@item -v, --version
+Afficher la version de WeeChat@* +@end table
+
+@subsection Lancer WeeChat
+
+Tapez simplement cette commande pour lancer WeeChat :@*
+@kbd{weechat-curses}@* +ou @kbd{weechat-gtk} (pour l'interface Gtk)@* +ou @kbd{weechat-qt} (pour l'interface Qt)@*
+
+Lorsque vous lancez WeeChat pour la premi@`ere fois, un fichier de configuration +par d@'efaut est cr@'e@'e, avec les options par d@'efaut.@*
+Le fichier de configuration par d@'efaut est : ~/.weechat/weechat.rc@*
+
+Vous pouvez @'editer ce fichier pour configurer WeeChat @`a votre convenance, ou
+vous pouvez modifier les param@`etres dans WeeChat avec la commande @kbd{/set} - @xref{Commandes WeeChat}. + +@node Raccourcis clavier, Commandes WeeChat, Lancer WeeChat, Utilisation +@section Raccourcis clavier +
+@table @kbd +@item Fl@`eche gauche / Fl@`eche droite +Aller au caract@`ere pr@'ec@'edent / suivant sur la ligne de commande@* +@*
+@item Ctrl + fl@`eche gauche / Ctrl + fl@`eche droite +Aller au mot pr@'ec@'edent / suivant sur la ligne de commande@* +@* +@item Home / End +Aller au d@'ebut / @`a la fin de la ligne de commande@* +@* +@item Backspace / Delete
+Effacer le mot pr@'ec@'edent / suivant sur la ligne de commande@* +@*
+@item Ctrl + Backspace
+Effacer le mot pr@'ec@'edent sur la ligne de commande@* +@*
+@item Tab
+Compl@'eter la commande ou le pseudo (@kbd{Tab} @`a nouveau : trouver la compl@'etion suivante)@* +@*
+@item Tout caract@`ere
+Ins@'erer le caract@`ere @`a la position du curseur sur la ligne de commande@*
+@*
+@item Entr@'ee
+Ex@'ecuter la commande ou envoyer le message@* +@*
+@item Fl@`eche haut / Fl@`eche bas
+Rappeler les derni@`eres commandes/messages@*
+@*
+@item PageUp / PageDown
+Afficher l'historique de la fen@^etre@* +@*
+@item F6 / F7
+Aller @`a la fen@^etre pr@'ec@'edente / suivante@* +@*
+@item Alt + fl@`eche gauche / Alt + fl@`eche droite
+Identique @`a F6 / F7@* +@* +@end table + +@node Commandes WeeChat, , Raccourcis clavier, Utilisation +@section Commandes WeeChat + +NON ECRIT ! + + +@c ******************************* Extensions ********************************* + +@node Extensions, Auteurs / Support, Utilisation, Top +@chapter Extensions + +@menu +* Scripts Perl:: +* Scripts Python:: +* Scripts Ruby:: +@end menu + +@node Scripts Perl, Scripts Python, Extensions, Extensions +@section Scripts Perl + +@subsection Charger/d@'echarger des scripts Perl + +Les scripts Perl sont charg@'es et d@'echarg@'es avec la commande @command{/perl} +(tapez @kbd{/help perl} dans WeeChat pour obtenir de l'aide sur la commande).@* + +@itemize @bullet +@item +Exemple de chargement d'un script Perl :@* +@kbd{/perl load /tmp/essai.pl}@* +@item +Exemple de d@'echargement d'un script Perl :@* +@kbd{/perl unload essai}@* +A noter: le nom "essai" est le premier param@`etre de la fonction @command{IRC::register.}@* +@item +Liste des scripts Perl charg@'es :@* +@kbd{/perl}@* +@end itemize + +@subsection Interface WeeChat / Perl + +@itemize @bullet +@item +@command{IRC::register ( nom, version, fonction_de_fin, description );}@* +@* +C'est la premi@`ere fonction @`a appeler dans le script Perl.@* +Tout script Perl pour WeeChat doit appeler cette fonction.@* + +@emph{Param@`etres :} +@itemize @minus +@item @option{nom}: nom unique pour identifier le script (chaque script doit +avoir un nom diff@'erent) +@item @option{version}: version du script +@item @option{fonction_de_fin}: fonction Perl appel@'ee quand le script est +d@'echarg@'e (param@`etre facultatif, une cha@^ine vide signifiant qu'il n'y a pas +de fonction @`a appeler) +@item @option{description}: description br@`eve du script. +@end itemize +@* +@emph{Exemple :}@* +@code{IRC::register ("essai", "1.0", "fin_essai", "Script d'essai !");}@* + +@item +@command{IRC::print ( message );}@* +@* +Affiche un message dans la fen@^etre courante (canal ou serveur).@* + +@emph{Param@`etres :} +@itemize @minus +@item @option{message}: message @`a afficher +@end itemize +@* +@emph{Exemple :}@* +@code{IRC::print ("message");}@* + +@item +@command{IRC::add_message_handler ( nom, fonction );}@* +@* +Attache une fonction Perl @`a un message IRC particulier.@* +La fonction sera appel@'ee @`a chaque fois que le message IRC sera re@,{c}u.@* + +@emph{Param@`etres :} +@itemize @minus +@item @option{nom}: nom du message IRC pour lequel la fonction est appel@'ee@* +Pour conna@^itre la liste des messages IRC disponibles, merci de consulter les +RFC 1459 et/ou 2812 :@* +RFC 1459 : @uref{ftp://ftp.rfc-editor.org/in-notes/rfc1459.txt}@* +RFC 2812 : @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} +@item @option{fonction}: fonction Perl appel@'ee lorsque le message est re@,{c}u +@end itemize +@* +@emph{Exemple :}@* +@code{IRC::add_message_handler ("privmsg", ma_fonction);}@* +@code{sub ma_fonction}@* +@code{@{ }@* +@code{@ @ @ @ ($null, $canal, $message) = split ":",@@_[0],3;}@* +@code{@ @ @ @ ($masque, $null, $canal) = split " ", $canal;}@* +@code{@ @ @ @ IRC::print ("masque=$masque, canal=$canal, message=$message\n");}@* +@code{@} }@* + +@item +@command{IRC::add_command_handler ( nom, fonction );}@* +@* +Cr@'e@'e une nouvelle commande WeeChat, associ@'ee @`a une fonction Perl.@* +La fonction sera appel@'ee lorsque l'utilisateur lancera la commande par @kbd{/nom}.@* + +@emph{Param@`etres :} +@itemize @minus +@item @option{nom}: nom de la nouvelle commande@* +Il peut s'agir d'une commande existante, auquel cas celle-ci est @'ecras@'ee par +la fonction Perl. Soyez prudent en @'ecrasant les commandes WeeChat, car elles +ne seront plus accessibles tant que le script Perl sera charg@'e. +@item @option{fonction}: fonction Perl associ@'ee @`a la commande +@end itemize +@* +@emph{Exemple :}@* +@code{IRC::add_command_handler ("commande", ma_commande);}@* +@code{sub ma_commande}@* +@code{@{ }@* +@code{@ @ @ @ IRC::print("Param@`etres : ".@@_[0]);}@* +@code{@ @ @ @ return 0;}@* +@code{@} }@* + +@end itemize + +@node Scripts Python, Scripts Ruby, Scripts Perl, Extensions +@section Scripts Python + +Non d@'evelopp@'e ! + +@node Scripts Ruby, , Scripts Python, Extensions +@section Scripts Ruby + +Non d@'evelopp@'e ! + +@c **************************** Auteurs / Support ***************************** + +@node Auteurs / Support, , Extensions, Top +@chapter Auteurs / Support + +@ifhtml +@menu +* Auteurs:: +* Obtenir du support:: +* Copyright:: +@end menu +@end ifhtml +@ifnothtml +@menu +* Auteurs:: +* Obtenir du support:: +@end menu +@end ifnothtml + +@node Auteurs, Obtenir du support, Auteurs / Support, Auteurs / Support +@section Auteurs + +WeeChat est d@'evelopp@'e par :@* + +@itemize @bullet +@item +FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> +@item +Bounga +<@email{bounga@@altern.org, bounga AT altern.org}> +@item +Xahlexx +<@email{xahlexx@@tuxfamily.org, xahlexx AT tuxfamily.org}> +@item +Crevetor +<@email{crevetor@@caramail.com, crevetor AT caramail.com}> + +@end itemize + +@ifhtml +@node Obtenir du support, Copyright, Auteurs, Auteurs / Support +@end ifhtml +@ifnothtml +@node Obtenir du support, , Auteurs, Auteurs / Support +@end ifnothtml +@section 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 @^etes en train de lire, si vous +n'avez pas tout lu jusqu'ici, il est encore temps de recommencer !)@* + +@itemize @bullet +@item +Support par IRC:@* +- serveur : @b{irc.freenode.net}@* +- canal : @b{#weechat}@*@* +@item +Forum WeeChat : bient@^ot !@*@* +@item +Support par la liste de diffusion :@* +- pour souscrire/d@'esinscrire :@*@uref{http://mail.nongnu.org/mailman/listinfo/weechat-support}.@* +- pour envoyer un mail @`a la liste de diffusion, envoyer @`a :@*@email{weechat-support@@nongnu.org}.@* + +Les archives de la liste de diffusion sont ici :@* +@uref{http://mail.nongnu.org/archive/html/weechat-support}@*@* +@item +Voir la page support WeeChat pour plus de d@'etails :@* +@uref{http://weechat.flashtux.org/support.php} + +@end itemize + +@ifhtml +@node Copyright, , Obtenir du support, Auteurs / Support +@section Copyright + +Ce manuel documente le client IRC WeeChat, il fait partie de WeeChat.@* + +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +Ce document peut @^etre utilis@'e sous les termes de la licence GNU General Public +License version 2 ou plus. +@end ifhtml + +@bye diff --git a/weechat/doc/weechat_doc_pt.texi b/weechat/doc/weechat_doc_pt.texi new file mode 100644 index 000000000..198da130c --- /dev/null +++ b/weechat/doc/weechat_doc_pt.texi @@ -0,0 +1,364 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename weechat_doc_pt.info +@settitle WeeChat - Um cliente de IRC r@'apido, leve e extenc@'ivel +@c %**end of header + +@c WeeChat documentation (vers@~ao partuguesa) +@c +@c Copyright (c) 2003 by FlashCode <flashcode@flashtux.org> +@c +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.2 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". + +@c pdf : texi2pdf weechat_doc_pt.texi +@c html: makeinfo --html --no-split --number-sections weechat_doc_pt.texi + +@c tex +@c \overfullrule=0pt +@c end tex + +@documentlanguage pt + +@titlepage + +@title WeeChat - Guia do Utilizador +@subtitle Cliente de IRC rapido, leve e extenc@'ivel +@subtitle Documenta@,{c}@~ao do WeeChat v0.0.3 - 26 de Outubro de 2003 + +@image{weechat_image} + +@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> + +@page + +Este manual documenta o cliente de IRC WeeChat, ele faz parte do WeeChat.@* +@* +A ultima versão deste documento pode ser descarregada de :@* +@uref{http://weechat.flashtux.org/doc.php}@* +@* +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +@* +Este documento pode ser utilizado sobre os termos da Licença P@'ublica geral GNU (GNU General Public +License) vers@~ao 2 ou superior. + +@end titlepage + +@everyheading @thischapter @| @| +@everyfooting @thistitle @| @| Pagina @thispage + +@contents + +@node Top, Introduç@~ao, (dir), (dir) +@menu +* Introduç@~ao:: Descriç@~ao do WeeChat +* Instalaç@~ao:: Instalaç@~ao do WeeChat +* Utilizaç@~ao:: Utilizaç@~ao do WeeChat +* Autores / Suporte:: Contactar os autores e obter suporte +@end menu + + +@c ******************************* Introduç@~ao ******************************* + +@node Introduç@~ao, Instalaç@~ao, Top, Top +@chapter Introduç@~ao +@menu +* Descriç@~ao:: +* Pre-requisitos:: +@end menu + +@node Descriç@~ao, Pre-requisitos, Introduç@~ao, Introduç@~ao +@section Descriç@~ao + +O WeeChat (Wee Enhanced Environment for Chat) @'e um cliente de IRC livre, r@'apido e leve, +concebido para funcionar em diversos sistemas operativos.@* +@* +As suas caracter@'isticas prinicpais s@~ao as seguintes : +@itemize @minus +@item +liga@,{c}@~ao a m@'ultiplos servidores +@item +v@'arias interfaces : Curses, Gtk e Qt +@item +pequeno r@'apido e leve +@item +configuravel e extenc@'ivel com scripts +@item +compat@'ivel com RFCs 1459, 2810, 2811, 2812, e 2813 +@item +multiplataforma (Gnu/Linux, *BSD, Windows e outros) +@item +100% GPL, Software Livre +@end itemize + +@* +A p@'agina Web do Weechat @'e aqui :@* +@uref{http://weechat.flashtux.org}@* + +@node Pre-requisitos, ,Descriç@~ao, Introduç@~ao +@section Pr@'e-requisitos + +Para instalar o Weechat, vais @b{precisar} de ter :@* + +@itemize @bullet +@item +Um sistema Gnu/Linux (com um compilador e outros utilit@'arios associados aos pacotes de c@'odigo fonte) +@item +Direitos de "root" (para instalar) +@item +Consoante a interface escolhida, uma das seguintes bibliotecas : +@itemize @minus +@item +Curses: a biblioteca ncurses, +@item +Gtk: *** interface n@~ao desenvolvida ***, +@item +Qt: *** interface n@~ao desenvolvida ***, +@end itemize +@end itemize + + +@c ******************************* Instalaç@~ao ******************************* + +@node Instalaç@~ao, Utilizaç@~ao, Introduç@~ao, Top +@chapter Instalaç@~ao +@menu +* Binarios:: +* Codigo Fonte:: +* Codigo Fonte via CVS:: +@end menu + +@node Binarios, Codigo Fonte, Instalaç@~ao, Instalaç@~ao +@section Bin@'arios + +Os pacotes bin@'arios est@'ao dispon@'iveis para as seguintes distribui@,{c}@~oes : +@itemize @bullet +@item +Debian (ou compat@'ivel)@* +Instala@,{c}@~ao : @kbd{dpkg -i /chemin/weechat_x.y.z-1_i386.deb} +@item +Mandrake/Redhat (ou outra distro compat@'ivel com RPMs)@* +Instala@,{c}@~ao : @kbd{rpm -i /chemin/weechat-x.y.z-1.i386.rpm} +@item +Gentoo@* +Instala@,{c}@~ao : ver a documenta@,{c}@~ao da Gentoo +@item +*BSD (non disponible !) +@item +Slackware (n@~ao dispon@'ivel !) +@item +Windows (n@~ao dispon@'ivel !) +@end itemize + +Onde x.y.z @'e a vers@~ao (por exemplo 0.0.1) +@* + +@node Codigo Fonte, Codigo Fonte via CVS, Binarios, Instalaç@~ao +@section C@'odigo Fonte + +Escreve simplesmente numa consola ou num terminal :@* +@kbd{./configure}@* +@kbd{make}@* +Nota: Para compilar certas interfaces, podes passar par@^ametros +ao ./configure, escreve @kbd{./configure --help} para veres as op@,{c}@~oes.@* + +Obter os direitos do root e instalar o Weechat :@* +@kbd{su -}@* +(escreve aqui a palavra-passe do superutilizador)@* +@kbd{make install}@* + +@node Codigo Fonte via CVS, , Codigo Fonte, Instalaç@~ao +@section C@'odigo Fonte via CVS + +Aten@,{c}@~ao: o c@'odigo fonte CVS est@'a reservado aos utilizadores avan@,{c}ados : o WeeChat pode n@~ao compilar ou ficar inst@'avel.@* +Considera-te avisado !@* + +Para sacares o c@'odigo fonte via CVS, escreve estes comandos :@* +@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@* +@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@* +(quando te pedirem a palavra-passe, primen simplesmente Enter)@* + +Executa o script :@* +@kbd{./autogen.sh}@* + +Segue agora as instru@,{c}@~oes para compilar o c@'odigo fonte - @xref{Codigo Fonte}. + + +@c ******************************* Utilizaç@~ao ******************************** + +@node Utilizaç@~ao, Autores / Suporte, Instalaç@~ao, Top +@chapter Utilizaç@~ao + +@menu +* Invocar o WeeChat:: +* Recursos de teclado:: +* Comandos do WeeChat:: +@end menu + +@node Invocar o WeeChat, Recursos de teclado, Utilizaç@~ao, Utilizaç@~ao +@section Invocar o WeeChat + +@subsection Par@^ametros de linha de comandos + +@table @code +@item -h, --help +Mostrar a ajuda@* +@item -l, --license +Mostrar a licen@,{c}a do WeeChat@* +@item -v, --version +Mostrar a vers@~ao do WeeChat@* +@end table + +@subsection Invocar o WeeChat + +Escreve simplesmente este comando para invoceres o WeeChat :@* +@kbd{weechat-curses}@* +ou @kbd{weechat-gtk} (para a interface em Gtk)@* +ou @kbd{weechat-qt} (para a interface em Qt)@* + +Logo que lan@,{c}ares o WeeChat pela primeira vez, um ficheiro de configura@,{c}@~ao +por defeito @'e criado, com as configura@,{c}@~oes por defeito.@* +O ficheiro de configura@,{c}@~ao por defeito @'e : ~/.weechat/weechat.rc@* + +Podes editar esse ficheiro para configurar o WeeChat @`a tua maneira, man tamb@'em podes modificar os par@^ametros dentro do WeeChat utilizando o comando @kbd{/set} - @xref{Comandos do WeeChat}. + +@node Recursos de teclado, Comandos do WeeChat, Invocar o WeeChat, Utilizaç@~ao +@section Recursos de teclado + +@table @kbd +@item Seta esquerda / Seta direita +Ir um caractere para traz / para a frente na linha de comando@* +@* +@item Ctrl + Seta esquerda / Ctrl + Seta Direita +Ir uma palavra para traz / para a frente na linha de comando@* +@* +@item Home / End +Ir para o in@'icio / para o fim da linha de comando@* +@* +@item Backspace / Delete +Apagar o caractere anterior / seguinte na linha de comando@* +@* +@item Ctrl + Backspace +Apagar a palavra anterior na linha de comando +@* +@item Tab +Completar o comando ou o nick (@kbd{Tab} novamente : encontrar a pr@'oxima sugest@~ao)@* +@* +@item Qualquer caractere +Inserir o caractere na linha de comando, no s@'itio do cursor@* +@* +@item Enter +Executa o comando ou envia a mensagem@* +@* +@item Seta para cima / Seta para baixo +Repetir os ultimos comandos/mensagens@* +@* +@item PageUp / PageDown +Navegar no hist@'orico da janela@* +@* +@item F6 / F7 +Ir para a janela anterior/seguinte@* +@* +@item Alt + Seta da esquerda / Alt + Seta da direita +Identico a F6 / F7@* +@* +@end table + +@node Comandos do WeeChat, , Recursos de teclado, Utilizaç@~ao +@section Comandos do WeeChat + +N@~AO ESCRITO ! + + +@c **************************** Autores / Suporte ***************************** + +@node Autores / Suporte, , Utilizaç@~ao, Top +@chapter Autores / Suporte + +@ifhtml +@menu +* Autores:: +* Obter Suporte:: +* Copyright:: +@end menu +@end ifhtml +@ifnothtml +@menu +* Autores:: +* Obter Suporte:: +@end menu +@end ifnothtml + +@node Autores, Obter Suporte, Autores / Suporte, Autores / Suporte +@section Autores + +O WeeChat @'e desenvolvido por :@* + +@itemize @bullet +@item +FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> +@item +Bounga +<@email{bounga@@altern.org, bounga AT altern.org}> +@item +Xahlexx +<@email{xahlexx@@tuxfamily.org, xahlexx AT tuxfamily.org}> +@item +Crevetor +<@email{crevetor@@caramail.com, crevetor AT caramail.com}> + +@end itemize + +@ifhtml +@node Obter Suporte, Copyright, Autores, Autores / Suporte +@end ifhtml +@ifnothtml +@node Obter Suporte, , Autores, Autores / Suporte +@end ifnothtml +@section Obter Suporte + +Antes de pedires suporte, agradecemos se leres toda a documenta@,{c}@~ao e a FAQ.@* +(a documenta@,{c}@~ao @'e este documento que est@'as a ler, se n@~ao leste tudo at@'e aqui, est@'a na hora de come@,{c}ares do in@'icio !)@* + +@itemize @bullet +@item +Suporte por IRC:@* +- servidor : @b{irc.freenode.net}@* +- canal : @b{#weechat}@*@* +@item +Forum do WeeChat : mais tarde !@*@* +@item +Suporte por lista de correio-e :@* +- para te inscreveres/desinscreveres :@*@uref{http://mail.nongnu.org/mailman/listinfo/weechat-support}.@* +- para enviares uma mensagem para a lista :@*@email{weechat-support@@nongnu.org}.@* + +Os arquivos da lista est@~ao aqui :@* +@uref{http://mail.nongnu.org/archive/html/weechat-support}@*@* +@item +Para mais detalhes, v@^e tamb@'em a p@'agina de suporte do WeeChat :@* +@uref{http://weechat.flashtux.org/support.php} + +@end itemize + +@ifhtml +@node Copyright, , Obter Suporte, Autores / Suporte +@section Copyright + +Este manual documenta o cliente de IRC WeeChat, Ele faz parte do WeeChat.@* + +Copyright @copyright{} 2003 FlashCode +<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* +Tradu@,{c}@~ao portuguesa de Jo@~ao Jer@'onimo <@email{j_j_b_o@@sapo.pt, j_j_b_o AT sapo.pt}>@* +@* +A utiliza@,{c}@~ao deste documento @'e regida pela GNU General Public +License vers@~ao 2 ou posterior.@* + +@end ifhtml + +@bye diff --git a/weechat/doc/weechat_image.pdf b/weechat/doc/weechat_image.pdf Binary files differnew file mode 100644 index 000000000..16ca5c6b2 --- /dev/null +++ b/weechat/doc/weechat_image.pdf |