diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/weechat_doc_en.texi | 100 | ||||
| -rw-r--r-- | doc/weechat_doc_fr.texi | 104 |
2 files changed, 154 insertions, 50 deletions
diff --git a/doc/weechat_doc_en.texi b/doc/weechat_doc_en.texi index 20d19536c..1377ff978 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.0.7 - August, 27 2004 +@subtitle Documentation for WeeChat v0.0.8-pre2 - October, 03 2004 @image{weechat_image} @@ -292,6 +292,9 @@ Type: boolean (values: 'on' or 'off'), default value: 'off'@* @item look_nick_completor The string inserted after nick completion@* Type: string (any string), default value: ':'@* +@item look_display_away +Display message to all channels when (un)marking as away@* +Type: boolean (values: 'on' or 'off'), default value: 'on'@* @item look_infobar Enable info bar@* Type: boolean (values: 'on' or 'off'), default value: 'on'@* @@ -343,15 +346,18 @@ Type: color (Curses or Gtk color), default value: 'default'@* @item col_status Color for status bar@* Type: color (Curses or Gtk color), default value: 'gray'@* +@item col_status_delimiters +Color for status bar delimiters@* +Type: color (Curses or Gtk color), default value: 'cyan'@* @item col_status_data_msg Color for window with new messages (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightred'@* +Type: color (Curses or Gtk color), default value: 'yellow'@* @item col_status_highlight Color for window with highlight (status bar)@* -Type: color (Curses or Gtk color), default value: 'yellow'@* +Type: color (Curses or Gtk color), default value: 'lightmagenta'@* @item col_status_data_other Color for window with new data (not messages) (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* +Type: color (Curses or Gtk color), default value: 'gray'@* @item col_status_more Color for window with new data (status bar)@* Type: color (Curses or Gtk color), default value: 'white'@* @@ -403,13 +409,37 @@ Type: color (Curses or Gtk color), default value: 'gray'@* @item col_nick_bg Background for nicknames@* Type: color (Curses or Gtk color), default value: 'default'@* +@item col_chat_dcc_selected +Color for selected DCC (chat window)@* +Type: color (Curses or Gtk color), default value: 'white'@* +@item col_dcc_waiting +Color for "waiting" dcc status@* +Type: color (Curses or Gtk color), default value: 'white'@* +@item col_dcc_connecting +Color for "connecting" dcc status@* +Type: color (Curses or Gtk color), default value: 'yellow'@* +@item col_dcc_active +Color for "active" dcc status@* +Type: color (Curses or Gtk color), default value: 'lightblue'@* +@item col_dcc_done +Color for "done" dcc status@* +Type: color (Curses or Gtk color), default value: 'lightgreen'@* +@item col_dcc_failed +Color for "failed" dcc status@* +Type: color (Curses or Gtk color), default value: 'lightred'@* +@item col_dcc_aborted +Color for "aborted" dcc status@* +Type: color (Curses or Gtk color), default value: 'lightred'@* @item history_max_lines Maximum number of lines in history for one server/channel/private window (0 = unlimited)@* Type: integer (values: between 0 and 2147483647), default value: 4096@* @item history_max_commands Maximum number of user commands in history (0 = unlimited)@* Type: integer (values: between 0 and 2147483647), default value: 100@* -@item log_auto_channels +@item log_auto_server +Automatically log server messages@* +Type: boolean (values: 'on' or 'off'), default value: 'on'@* +@item log_auto_channel Automatically log channel chats@* Type: boolean (values: 'on' or 'off'), default value: 'on'@* @item log_auto_private @@ -418,30 +448,21 @@ Type: boolean (values: 'on' or 'off'), default value: 'on'@* @item log_path Path for WeeChat log files@* Type: string (any string), default value: '~/.weechat/logs/'@* -@item log_name -Name for log files (%S == irc server name, %N == channel name (or nickname if private chat)@* -Type: string (any string), default value: '%S,%N.weechatlog'@* @item log_timestamp Timestamp for log (see man strftime for date/time specifiers)@* -Type: string (any string), default value: '~'@* -@item log_start_string -Text written when starting new log file (see man strftime for date/time specifiers)@* -Type: string (any string), default value: '--- Log started %a %b %d %Y %H:%M:%s'@* -@item log_end_string -Text written when ending log file (see man strftime for date/time specifiers)@* -Type: string (any string), default value: '--- Log ended %a %b %d %Y %H:%M:%s'@* +Type: string (any string), default value: '%Y %b %d %H:%M:%S'@* @item dcc_auto_accept_files Automatically accept incoming dcc files@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_accept_max_size -Maximum size for incoming file when automatically accepted@* -Type: integer (values: between 0 and 2147483647), default value: 0@* +Type: boolean (values: 'on' or 'off'), default value: 'off'@* @item dcc_auto_accept_chats Automatically accept dcc chats (use carefully!)@* Type: boolean (values: 'on' or 'off'), default value: 'on'@* @item dcc_timeout Timeout for dcc request (in seconds)@* Type: integer (values: between 1 and 2147483647), default value: 300@* +@item dcc_blocksize +Block size for dcc packets in bytes (default: 1024)@* +Type: integer (values: between 1024 and 102400), default value: 1024@* @item dcc_download_path Path for writing incoming files with dcc (default: user home)@* Type: string (any string), default value: '~'@* @@ -579,6 +600,9 @@ Switch to previous / next buffer@* @* @item F8 Switch to next window@* +@* +@item F10 +Remove last infobar message@* @*
@item Alt + left arrow / Alt + right arrow
Same as F6 / F7@* @@ -586,12 +610,15 @@ Same as F6 / F7@* @item Alt + A Switch to next buffer with activity (with priority: highlight, message, other)@* @* +@item Alt + D +Display current DCC@* +@* +@item Alt + R +Clear hotlist (activity notification on other buffers)@* +@* @item Alt + digit (1-9) Switch to buffer by number@* @* -@item F10 -Remove last infobar message@* -@* @end table @node WeeChat commands, , Key bindings, Usage @@ -718,7 +745,8 @@ RFC 2812: @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} @code{IRC::add_message_handler ("privmsg", my_function);}@* @code{sub my_function}@* @code{@{ }@* -@code{@ @ @ @ ($null, $channel, $message) = split ":",@@_[0],3;}@* +@code{@ @ @ @ IRC::print ("server=$_[0]\n");}@* +@code{@ @ @ @ ($null, $channel, $message) = split ":",$_[1],3;}@* @code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* @code{@ @ @ @ IRC::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* @code{@} }@* @@ -743,11 +771,35 @@ available until your Perl script will be unloaded. @code{IRC::add_command_handler ("command", my_command);}@* @code{sub my_command}@* @code{@{ }@* -@code{@ @ @ @ IRC::print("Arguments: ".@@_[0]);}@* +@code{@ @ @ @ IRC::print("Server: $_[0], arguments: $_[1]\n");}@* @code{@ @ @ @ return 0;}@* @code{@} }@* @* +@item +@command{IRC::get_info ( [server,] name );}@* +@* +Get various info about WeeChat, server or user.@* + +@emph{Arguments:} +@itemize @minus +@item @option{server}: internal name of server +@item @option{name}: name of info to retrieve: +@itemize @minus +@item @option{0 or version}: get WeeChat version +@item @option{1 or nick}: get nickname +@item @option{2 or channel}: get channel name +@item @option{3 or server}: get server name +@item @option{4 or weechatdir}: get WeeChat home directory +@item @option{5 or away}: get away flag for server +@end itemize +@end itemize +@* +@emph{Examples:}@* +@code{$version = get_info("version");}@* +@code{$nick = get_info("freenode", "nick");}@* +@* + @end itemize @node Python scripts, Ruby scripts, Perl scripts, Extensions diff --git a/doc/weechat_doc_fr.texi b/doc/weechat_doc_fr.texi index 1e744baee..66557a707 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.0.7 - 27 ao@^ut 2004 +@subtitle Documentation pour WeeChat v0.0.8-pre2 - 03 Octobre 2004 @image{weechat_image} @@ -292,6 +292,9 @@ Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* @item look_nick_completor La cha@^ine affich@'ee apr@`es la compl@'etion des utilisateurs@* Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ':'@* +@item look_display_away +Affiche un message sur tous les canaux pour l'absence/le retour@* +Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* @item look_infobar Active la barre d'infos@* Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* @@ -343,15 +346,18 @@ Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* @item col_status Couleur pour la barre de statut@* Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'gray'@* +@item col_status_delimiters +Couleur pour les d@'elimiteurs de la barre de statut@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* @item col_status_data_msg Couleur pour une fen@^etre avec de nouvelles infos (barre de statut)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightred'@* -@item col_status_highlight -Color for window with highlight (status bar)@* Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'yellow'@* +@item col_status_highlight +Couleur pour une fen@^etre avec un highlight (barre de statut)@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* @item col_status_data_other Couleur pour une fen@^etre avec des nouvelles donn@'ees (pas des infos) (barre de statut)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'gray'@* @item col_status_more Couleur pour une fen@^etre avec des nouvelles donn@'ees (barre de statut)@* Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* @@ -403,13 +409,37 @@ Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'gray'@* @item col_nick_bg Couleur de fond pour les pseudos@* Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* +@item col_chat_dcc_selected +Couleur pour le DCC s@'electionn@'e (fen@^etre de discussion)@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* +@item col_dcc_waiting +Couleur pour le statut dcc "attente"@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* +@item col_dcc_connecting +Couleur pour le statut dcc "connexion"@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'yellow'@* +@item col_dcc_active +Couleur pour le statut dcc "actif"@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightblue'@* +@item col_dcc_done +Couleur pour le statut dcc "termin@'e"@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* +@item col_dcc_failed +Couleur pour le statut dcc "@'echou@'e"@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightred'@* +@item col_dcc_aborted +Couleur pour le statut dcc "interrompu"@* +Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightred'@* @item history_max_lines Nombre maximum de lignes dans l'historique pour un serveur/fen@^etre/fen@^etre priv@'ee (0 = sans limite)@* Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 4096@* @item history_max_commands Nombre maximum de commandes utilisateur dans l'historique (0 = sans limite)@* Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 100@* -@item log_auto_channels +@item log_auto_server +Enregistrer automatiquement les messages du serveur@* +Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* +@item log_auto_channel Enregistrer automatiquement les conversations des canaux@* Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* @item log_auto_private @@ -418,30 +448,21 @@ Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* @item log_path Chemin pour les conversations sauvegard@'ees par WeeChat@* Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '~/.weechat/logs/'@* -@item log_name -Nom des conversations saivegard@'ees (%S == nom du serveur irc, %N == nom du canal (ou pseudo si fen@^etre priv@'ee)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '%S,%N.weechatlog'@* @item log_timestamp Horodatage pour les conversations sauvegard@'ees (voir man strftime pour le format de date/heure)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '~'@* -@item log_start_string -Texte @'ecrit en d@'emarrant la sauvegarde d'une discussion (voir man strftime pour le format de date/heure)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '--- Log started %a %b %d %Y %H:%M:%s'@* -@item log_end_string -Texte @'ecrit @`a la fin d'une discussion sauvegard@'ees (voir man strftime pour le format de date/heure)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '--- Log ended %a %b %d %Y %H:%M:%s'@* +Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '%Y %b %d %H:%M:%S'@* @item dcc_auto_accept_files Accepte automatiquement les fichiers dcc entrants@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item dcc_auto_accept_max_size -Taille maximum pour un fichier entrant lorsqu'il est accept@'e automatiquement@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 0@* +Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* @item dcc_auto_accept_chats Accepte automatiquement les demandes de discussion dcc (@`a utiliser avec pr@'ecaution !)@* Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* @item dcc_timeout D@'elai d'attente pour les requ@^etes dcc (en secondes)@* Type: entier (valeurs: entre 1 et 2147483647), valeur par d@'efaut: 300@* +@item dcc_blocksize +Taille de bloc pour les paquets dcc en octets (d@'efaut: 1024)@* +Type: entier (valeurs: entre 1024 et 102400), valeur par d@'efaut: 1024@* @item dcc_download_path Chemin pour @'ecrire les fichiers re@,{c}us par dcc (par d@'efaut: r@'epertoire de l'utilisateur)@* Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '~'@* @@ -579,19 +600,25 @@ Aller au tampon pr@'ec@'edent@* @* @item F8 Aller @`a la fen@^etre suivante@* -@*
+@* +@item F10 +Effacer le dernier message de la barre d'infos@* +@* @item Alt + fl@`eche gauche / Alt + fl@`eche droite
Identique @`a F6 / F7@* @* @item Alt + A Sauter au tampon avec activit@'e (avec priorit@'e: highlight, message, autre)@* @* +@item Alt + D +Afficher les DCC en cours@* +@* +@item Alt + R +Vide la hotlist (notification d'activité sur les autres tampons)@* +@* @item Alt + chiffre (1-9) Sauter au tampon avec ce num@'ero@* @* -@item F10 -Effacer le dernier message de la barre d'infos@* -@* @end table @node Commandes WeeChat, , Raccourcis clavier, Utilisation @@ -719,7 +746,8 @@ RFC 2812 : @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2812.txt} @code{IRC::add_message_handler ("privmsg", ma_fonction);}@* @code{sub ma_fonction}@* @code{@{ }@* -@code{@ @ @ @ ($null, $canal, $message) = split ":",@@_[0],3;}@* +@code{@ @ @ @ IRC::print ("serveur=$_[0]\n");}@* +@code{@ @ @ @ ($null, $canal, $message) = split ":",$_[1],3;}@* @code{@ @ @ @ ($masque, $null, $canal) = split " ", $canal;}@* @code{@ @ @ @ IRC::print ("masque=$masque, canal=$canal, message=$message\n");}@* @code{@} }@* @@ -744,11 +772,35 @@ ne seront plus accessibles tant que le script Perl sera charg@'e. @code{IRC::add_command_handler ("commande", ma_commande);}@* @code{sub ma_commande}@* @code{@{ }@* -@code{@ @ @ @ IRC::print("Param@`etres : ".@@_[0]);}@* +@code{@ @ @ @ IRC::print("Serveur: $_[0], param@`etres: $_[1]\n");}@* @code{@ @ @ @ return 0;}@* @code{@} }@* @* +@item +@command{IRC::get_info ( [serveur,] nom );}@* +@* +Obtenir des informations vari@'ees sur WeeChat, le serveur ou l'utilisateur.@* + +@emph{Param@`etres :} +@itemize @minus +@item @option{serveur}: nom interne du serveur +@item @option{nom}: nom de l'info @`a obtenir : +@itemize @minus +@item @option{0 ou version}: obtenir la version de WeeChat +@item @option{1 ou nick}: obtenir le pseudo +@item @option{2 ou channel}: obtenir le nom du canal +@item @option{3 ou server}: obtenir le nom du serveur +@item @option{4 ou weechatdir}: obtenir le r@'epertoire maison de WeeChat +@item @option{5 ou away}: obtenir le drapeau "away" du serveur +@end itemize +@end itemize +@* +@emph{Exemples :}@* +@code{$version = get_info("version");}@* +@code{$nick = get_info("freenode", "nick");}@* +@* + @end itemize @node Scripts Python, Scripts Ruby, Scripts Perl, Extensions |